All URIs are relative to https://api.bombbomb.com/v2
Method | HTTP request | Description |
---|---|---|
docHostDelete | DELETE /files/{docId} | Delete file |
docHostGet | GET /files/{docId} | Get file |
docHostList | GET /files | List all files |
docHostUploadV2 | POST /files | Upload a file |
getHostedImagesPaged | GET /files/images/paged | Get paged hosted images |
docHostDelete($docId)
Delete file
Deletes a users file
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: BBOAuth2
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Swagger\Client\Api\FilesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$docId = "docId_example"; // string | Id of document
try {
$apiInstance->docHostDelete($docId);
} catch (Exception $e) {
echo 'Exception when calling FilesApi->docHostDelete: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
docId | string | Id of document |
void (empty response body)
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\HostedDoc docHostGet($docId)
Get file
Get a single file by id
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: BBOAuth2
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Swagger\Client\Api\FilesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$docId = "docId_example"; // string | Id of document
try {
$result = $apiInstance->docHostGet($docId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling FilesApi->docHostGet: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
docId | string | Id of document |
\Swagger\Client\Model\HostedDoc
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\HostedDoc[] docHostList()
List all files
List all uploaded user files
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: BBOAuth2
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Swagger\Client\Api\FilesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->docHostList();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling FilesApi->docHostList: ', $e->getMessage(), PHP_EOL;
}
?>
This endpoint does not need any parameter.
\Swagger\Client\Model\HostedDoc[]
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\HostedDoc[] docHostUploadV2($file)
Upload a file
Upload a new file
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: BBOAuth2
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Swagger\Client\Api\FilesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$file = "file_example"; // string | The file being uploaded
try {
$result = $apiInstance->docHostUploadV2($file);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling FilesApi->docHostUploadV2: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
file | string | The file being uploaded |
\Swagger\Client\Model\HostedDoc[]
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getHostedImagesPaged($pageSize, $page, $search)
Get paged hosted images
Get a specific page of uploaded images available to the user.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: BBOAuth2
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Swagger\Client\Api\FilesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$pageSize = "pageSize_example"; // string | The number of items to retrieve in a single db query.
$page = "page_example"; // string | Zero-based index of the page of data to retrieve from the db.
$search = "search_example"; // string | Filter results with names that match the search term.
try {
$apiInstance->getHostedImagesPaged($pageSize, $page, $search);
} catch (Exception $e) {
echo 'Exception when calling FilesApi->getHostedImagesPaged: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
pageSize | string | The number of items to retrieve in a single db query. | |
page | string | Zero-based index of the page of data to retrieve from the db. | |
search | string | Filter results with names that match the search term. | [optional] |
void (empty response body)
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]