OpenAPI\Client\ResourcesCreatorApi

All URIs are relative to https://api.builtbybit.com, except if the operation defines another base path.

Method	HTTP request	Description
getV2ResourcesCreatorAddons()	GET /v2/resources/creator/addons	Fetch a list of your resources' addons
getV2ResourcesCreatorBundles()	GET /v2/resources/creator/bundles	Fetch a list of your bundles
getV2ResourcesCreatorLicenses()	GET /v2/resources/creator/licenses	Fetch a list of your resources' licenses
getV2ResourcesCreatorPurchases()	GET /v2/resources/creator/purchases	Fetch a list of your resources' purchases
getV2ResourcesCreatorResources()	GET /v2/resources/creator/resources	Fetch a list of your resources
getV2ResourcesCreatorReviews()	GET /v2/resources/creator/reviews	Fetch a list of your resources' reviews
getV2ResourcesCreatorSaleEvents()	GET /v2/resources/creator/sale-events	Fetch a list of your sale events
getV2ResourcesCreatorUpdates()	GET /v2/resources/creator/updates	Fetch a list of your resource's updates
getV2ResourcesCreatorVersions()	GET /v2/resources/creator/versions	Fetch a list of your resources' versions
postV2ResourcesCreatorUpdate()	POST /v2/resources/creator/update	Post a resource update

`getV2ResourcesCreatorAddons()`

getV2ResourcesCreatorAddons($resource_ids): \OpenAPI\Client\Model\GetV2ResourcesCreatorAddons200Response

Fetch a list of your resources' addons

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ResourcesCreatorApi(
    // 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
);
$resource_ids = NULL; // array | A comma-separated list of resource IDs to filter on. No filter is applied if empty.

try {
    $result = $apiInstance->getV2ResourcesCreatorAddons($resource_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesCreatorApi->getV2ResourcesCreatorAddons: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
resource_ids	array	A comma-separated list of resource IDs to filter on. No filter is applied if empty.	[optional]

Return type

\OpenAPI\Client\Model\GetV2ResourcesCreatorAddons200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getV2ResourcesCreatorBundles()`

getV2ResourcesCreatorBundles(): \OpenAPI\Client\Model\GetV2ResourcesCreatorBundles200Response

Fetch a list of your bundles

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ResourcesCreatorApi(
    // 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->getV2ResourcesCreatorBundles();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesCreatorApi->getV2ResourcesCreatorBundles: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\GetV2ResourcesCreatorBundles200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getV2ResourcesCreatorLicenses()`

getV2ResourcesCreatorLicenses($resource_ids): \OpenAPI\Client\Model\GetV2ResourcesCreatorLicenses200Response

Fetch a list of your resources' licenses

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ResourcesCreatorApi(
    // 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
);
$resource_ids = NULL; // array | A comma-separated list of resource IDs to filter on. No filter is applied if empty.

try {
    $result = $apiInstance->getV2ResourcesCreatorLicenses($resource_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesCreatorApi->getV2ResourcesCreatorLicenses: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
resource_ids	array	A comma-separated list of resource IDs to filter on. No filter is applied if empty.	[optional]

Return type

\OpenAPI\Client\Model\GetV2ResourcesCreatorLicenses200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getV2ResourcesCreatorPurchases()`

getV2ResourcesCreatorPurchases($resource_ids): \OpenAPI\Client\Model\GetV2ResourcesCreatorPurchases200Response

Fetch a list of your resources' purchases

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ResourcesCreatorApi(
    // 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
);
$resource_ids = NULL; // array | A comma-separated list of resource IDs to filter on. No filter is applied if empty.

try {
    $result = $apiInstance->getV2ResourcesCreatorPurchases($resource_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesCreatorApi->getV2ResourcesCreatorPurchases: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
resource_ids	array	A comma-separated list of resource IDs to filter on. No filter is applied if empty.	[optional]

Return type

\OpenAPI\Client\Model\GetV2ResourcesCreatorPurchases200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getV2ResourcesCreatorResources()`

getV2ResourcesCreatorResources($resource_ids): \OpenAPI\Client\Model\GetV2ResourcesCreatorResources200Response

Fetch a list of your resources

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ResourcesCreatorApi(
    // 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
);
$resource_ids = NULL; // array | A comma-separated list of resource IDs to filter on. No filter is applied if empty.

try {
    $result = $apiInstance->getV2ResourcesCreatorResources($resource_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesCreatorApi->getV2ResourcesCreatorResources: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
resource_ids	array	A comma-separated list of resource IDs to filter on. No filter is applied if empty.	[optional]

Return type

\OpenAPI\Client\Model\GetV2ResourcesCreatorResources200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getV2ResourcesCreatorReviews()`

getV2ResourcesCreatorReviews($resource_ids): \OpenAPI\Client\Model\GetV2ResourcesCreatorReviews200Response

Fetch a list of your resources' reviews

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\ResourcesCreatorApi(
    // 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()
);
$resource_ids = NULL; // array | A comma-separated list of resource IDs to filter on. No filter is applied if empty.

try {
    $result = $apiInstance->getV2ResourcesCreatorReviews($resource_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesCreatorApi->getV2ResourcesCreatorReviews: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
resource_ids	array	A comma-separated list of resource IDs to filter on. No filter is applied if empty.	[optional]

Return type

\OpenAPI\Client\Model\GetV2ResourcesCreatorReviews200Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getV2ResourcesCreatorSaleEvents()`

getV2ResourcesCreatorSaleEvents(): \OpenAPI\Client\Model\GetV2ResourcesCreatorSaleEvents200Response

Fetch a list of your sale events

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ResourcesCreatorApi(
    // 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->getV2ResourcesCreatorSaleEvents();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesCreatorApi->getV2ResourcesCreatorSaleEvents: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\GetV2ResourcesCreatorSaleEvents200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getV2ResourcesCreatorUpdates()`

getV2ResourcesCreatorUpdates($resource_ids): \OpenAPI\Client\Model\GetV2ResourcesCreatorUpdates200Response

Fetch a list of your resource's updates

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ResourcesCreatorApi(
    // 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
);
$resource_ids = NULL; // array | A comma-separated list of resource IDs to filter on. No filter is applied if empty.

try {
    $result = $apiInstance->getV2ResourcesCreatorUpdates($resource_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesCreatorApi->getV2ResourcesCreatorUpdates: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
resource_ids	array	A comma-separated list of resource IDs to filter on. No filter is applied if empty.	[optional]

Return type

\OpenAPI\Client\Model\GetV2ResourcesCreatorUpdates200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getV2ResourcesCreatorVersions()`

getV2ResourcesCreatorVersions($resource_ids): \OpenAPI\Client\Model\GetV2ResourcesCreatorVersions200Response

Fetch a list of your resources' versions

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ResourcesCreatorApi(
    // 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
);
$resource_ids = NULL; // array | A comma-separated list of resource IDs to filter on. No filter is applied if empty.

try {
    $result = $apiInstance->getV2ResourcesCreatorVersions($resource_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesCreatorApi->getV2ResourcesCreatorVersions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
resource_ids	array	A comma-separated list of resource IDs to filter on. No filter is applied if empty.	[optional]

Return type

\OpenAPI\Client\Model\GetV2ResourcesCreatorVersions200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postV2ResourcesCreatorUpdate()`

postV2ResourcesCreatorUpdate($post_v2_resources_creator_update_request): \OpenAPI\Client\Model\PostV2ResourcesCreatorUpdate200Response

Post a resource update

Creates a new version for the resource and optionally posts a public update message. The uploaded file must be encoded using base64 as part of the JSON request body shown below. The request body (including the base64 encoded file data) cannot exceed 100MB. This roughly equates to a 67MB upload limit for the raw file when taking into account base64 encoding losses.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ResourcesCreatorApi(
    // 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
);
$post_v2_resources_creator_update_request = new \OpenAPI\Client\Model\PostV2ResourcesCreatorUpdateRequest(); // \OpenAPI\Client\Model\PostV2ResourcesCreatorUpdateRequest

try {
    $result = $apiInstance->postV2ResourcesCreatorUpdate($post_v2_resources_creator_update_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesCreatorApi->postV2ResourcesCreatorUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
post_v2_resources_creator_update_request	\OpenAPI\Client\Model\PostV2ResourcesCreatorUpdateRequest		[optional]

Return type

\OpenAPI\Client\Model\PostV2ResourcesCreatorUpdate200Response

Authorization

token

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

ResourcesCreatorApi.md

Latest commit

History

ResourcesCreatorApi.md

File metadata and controls

OpenAPI\Client\ResourcesCreatorApi

getV2ResourcesCreatorAddons()

Example

Parameters

Return type

Authorization

HTTP request headers

getV2ResourcesCreatorBundles()

Example

Parameters

Return type

Authorization

HTTP request headers

getV2ResourcesCreatorLicenses()

Example

Parameters

Return type

Authorization

HTTP request headers

getV2ResourcesCreatorPurchases()

Example

Parameters

Return type

Authorization

HTTP request headers

getV2ResourcesCreatorResources()

Example

Parameters

Return type

Authorization

HTTP request headers

getV2ResourcesCreatorReviews()

Example

Parameters

Return type

Authorization

HTTP request headers

getV2ResourcesCreatorSaleEvents()

Example

Parameters

Return type

Authorization

HTTP request headers

getV2ResourcesCreatorUpdates()

Example

Parameters

Return type

Authorization

HTTP request headers

getV2ResourcesCreatorVersions()

Example

Parameters

Return type

Authorization

HTTP request headers

postV2ResourcesCreatorUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

`getV2ResourcesCreatorAddons()`

`getV2ResourcesCreatorBundles()`

`getV2ResourcesCreatorLicenses()`

`getV2ResourcesCreatorPurchases()`

`getV2ResourcesCreatorResources()`

`getV2ResourcesCreatorReviews()`

`getV2ResourcesCreatorSaleEvents()`

`getV2ResourcesCreatorUpdates()`

`getV2ResourcesCreatorVersions()`

`postV2ResourcesCreatorUpdate()`