builtbybit/api-wrapper-codegen-php

All operations not tagged 'free' require an active Ultimate subscription or invite-only permissions.

V2 documentation: https://builtbybit.com/wiki/api-v2/ \ OAuth2 documentation: https://builtbybit.com/wiki/oauth2/

For more information, please visit https://builtbybit.com/ticket.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/BuiltByBit/api-wrapper-codegen-php.git"
    }
  ],
  "require": {
    "BuiltByBit/api-wrapper-codegen-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/builtbybit/api-wrapper-codegen-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?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\AnalyticsApi(
    // 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->getV2Analytics();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getV2Analytics: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.builtbybit.com

Class	Method	HTTP request	Description
AnalyticsApi	getV2Analytics	GET /v2/analytics	Fetch a list of analytics definitions
AnalyticsApi	getV2AnalyticsGraph	GET /v2/analytics/graph	Fetch analytics graph data
AnalyticsApi	getV2AnalyticsSingle	GET /v2/analytics/single	Fetch a single analytics value
DeploymentsApi	postV2DeploymentsUpgrade	POST /v2/deployments/upgrade	Upgrade a short-lived token
EventsApi	getV2Events	GET /v2/events	Fetch a list of pending events
EventsApi	postV2EventsComplete	POST /v2/events/complete	Mark events as complete
HealthApi	getV2Health	GET /v2/health	Retrieve a health status
Oauth2Api	getOauth2Token	POST /oauth2/token	Request an access token using an existing grant
Oauth2Api	getOauth2TokenRevoke	POST /oauth2/token/revoke	Revoke an existing access or refresh token
ResourcesCreatorApi	getV2ResourcesCreatorAddons	GET /v2/resources/creator/addons	Fetch a list of your resources' addons
ResourcesCreatorApi	getV2ResourcesCreatorLicenses	GET /v2/resources/creator/licenses	Fetch a list of your resources' licenses
ResourcesCreatorApi	getV2ResourcesCreatorPurchases	GET /v2/resources/creator/purchases	Fetch a list of your resources' purchases
ResourcesCreatorApi	getV2ResourcesCreatorResources	GET /v2/resources/creator/resources	Fetch a list of your resources
ResourcesCreatorApi	getV2ResourcesCreatorReviews	GET /v2/resources/creator/reviews	Fetch a list of your resources' reviews
ResourcesCreatorApi	getV2ResourcesCreatorStores	GET /v2/resources/creator/stores	Fetch a list of your stores
ResourcesCreatorApi	getV2ResourcesCreatorUpdates	GET /v2/resources/creator/updates	Fetch a list of your resource's updates
ResourcesCreatorApi	getV2ResourcesCreatorVersions	GET /v2/resources/creator/versions	Fetch a list of your resources' versions
ResourcesCreatorApi	postV2ResourcesCreatorAddonsUpdate	POST /v2/resources/creator/addons/update	Post an addon update
ResourcesCreatorApi	postV2ResourcesCreatorApiAssetsUpdate	POST /v2/resources/creator/api-assets/update	Post an API asset update
ResourcesCreatorApi	postV2ResourcesCreatorUpdate	POST /v2/resources/creator/update	Post a resource update
ResourcesCreatorBatchApi	getV2ResourcesCreatorBatch	GET /v2/resources/creator/batch	Fetch a list of your batches edits
ResourcesCreatorBatchApi	postV2ResourcesCreatorBatch	POST /v2/resources/creator/batch	Submit a new batch edit
ResourcesCreatorBundlesApi	getV2ResourcesCreatorBundles	GET /v2/resources/creator/bundles	Fetch a list of your bundles
ResourcesCreatorBundlesApi	getV2ResourcesCreatorBundlesEntries	GET /v2/resources/creator/bundles/entries	Fetch a list of your bundle entries
ResourcesCreatorCouponsApi	getV2ResourcesCreatorCoupons	GET /v2/resources/creator/coupons	Fetch a list of your coupons
ResourcesCreatorCouponsApi	getV2ResourcesCreatorCouponsEntries	GET /v2/resources/creator/coupons/entries	Fetch a list of your coupon entries
ResourcesCreatorCouponsApi	postV2ResourcesCreatorCoupons	POST /v2/resources/creator/coupons	Create a new coupon
ResourcesCreatorSaleEventsApi	getV2ResourcesCreatorSaleEvents	GET /v2/resources/creator/sale-events	Fetch a list of your sale events
ResourcesCreatorSaleEventsApi	getV2ResourcesCreatorSaleEventsEntries	GET /v2/resources/creator/sale-events/entries	Fetch a list of your sale event entries
ResourcesDiscoverApi	getResourcesDiscoverCategories	GET /v2/resources/discover/categories	Fetch a list of categories
ResourcesDiscoverApi	getResourcesDiscoverResources	GET /v2/resources/discover/resources	Fetch a list of resources
ResourcesDiscoverApi	getV2ResourcesDiscoverDownloadDirectInitiate	GET /v2/resources/discover/download/direct/initiate	Initiate a direct download request
ResourcesDiscoverApi	getV2ResourcesDiscoverDownloadDirectPoll	GET /v2/resources/discover/download/direct/status	Fetch the status of a direct download request
ResourcesDiscoverApi	getV2ResourcesDiscoverDownloadPlan	GET /v2/resources/discover/download/plan	Fetch a download plan
ResourcesDiscoverApi	getV2ResourcesDiscoverLicenses	GET /v2/resources/discover/licenses	Fetch a list of the user's licenses
ResourcesDiscoverCartApi	getV2ResourcesDiscoverCartView	GET /v2/resources/discover/cart/view	View the user's cart items
ResourcesDiscoverCartApi	postV2ResourcesDiscoverCartAdd	POST /v2/resources/discover/cart/add	Add items to a user's cart
ResourcesDiscoverCartApi	postV2ResourcesDiscoverCartCheckout	POST /v2/resources/discover/cart/checkout	Initiate a checkout of a user's cart
ResourcesDiscoverCartApi	postV2ResourcesDiscoverCartCouponAdd	POST /v2/resources/discover/cart/coupon/add	Add a coupon to the user's cart
ResourcesDiscoverCartApi	postV2ResourcesDiscoverCartCouponRemove	POST /v2/resources/discover/cart/coupon/remove	Remove a coupon from the user's cart
ResourcesDiscoverCartApi	postV2ResourcesDiscoverCartRemove	POST /v2/resources/discover/cart/remove	Remove an item from the user's cart
ResourcesEmbedApi	getV2ResourcesEmbedDownloadInitiate	GET /v2/resources/embed/download/initiate	Initiate a download request
ResourcesEmbedApi	getV2ResourcesEmbedDownloadStatus	GET /v2/resources/embed/download/status	Fetch the status of a download request
ResourcesEmbedApi	getV2ResourcesEmbedLatest	GET /v2/resources/embed/latest	Fetches the latest versions & license information

Models

• Addon
• Analytic
• AnalyticFiltersValue
• AnalyticGraphData
• AnalyticGraphDataPeriod
• AnalyticGraphDataPoint
• Batch
• Bundle
• BundleEntry
• CartItem
• CartSummary
• Category
• Coupon
• CouponEntry
• DownloadPlan
• DownloadPlanAction
• DownloadPlanNotice
• DownloadRequest
• DownloadStatus
• Event
• Filter
• FilterChoice
• FilterValue
• GetOauth2Token200Response
• GetOauth2TokenRevoke200Response
• GetResourcesDiscoverCategories200Response
• GetResourcesDiscoverCategories200ResponseData
• GetResourcesDiscoverResources200Response
• GetResourcesDiscoverResources200ResponseData
• GetResourcesDiscoverResources4XXResponse
• GetResourcesDiscoverResources4XXResponseError
• GetV2Analytics200Response
• GetV2Analytics200ResponseData
• GetV2AnalyticsGraph200Response
• GetV2AnalyticsSingle200Response
• GetV2AnalyticsSingle200ResponseData
• GetV2AnalyticsSingle200ResponseDataPeriod
• GetV2Events200Response
• GetV2Events200ResponseData
• GetV2Health200Response
• GetV2ResourcesCreatorAddons200Response
• GetV2ResourcesCreatorAddons200ResponseData
• GetV2ResourcesCreatorBatch200Response
• GetV2ResourcesCreatorBatch200ResponseData
• GetV2ResourcesCreatorBundles200Response
• GetV2ResourcesCreatorBundles200ResponseData
• GetV2ResourcesCreatorBundlesEntries200Response
• GetV2ResourcesCreatorBundlesEntries200ResponseData
• GetV2ResourcesCreatorCoupons200Response
• GetV2ResourcesCreatorCoupons200ResponseData
• GetV2ResourcesCreatorCouponsEntries200Response
• GetV2ResourcesCreatorCouponsEntries200ResponseData
• GetV2ResourcesCreatorLicenses200Response
• GetV2ResourcesCreatorLicenses200ResponseData
• GetV2ResourcesCreatorPurchases200Response
• GetV2ResourcesCreatorPurchases200ResponseData
• GetV2ResourcesCreatorResources200Response
• GetV2ResourcesCreatorResources200ResponseData
• GetV2ResourcesCreatorReviews200Response
• GetV2ResourcesCreatorReviews200ResponseData
• GetV2ResourcesCreatorSaleEvents200Response
• GetV2ResourcesCreatorSaleEvents200ResponseData
• GetV2ResourcesCreatorSaleEventsEntries200Response
• GetV2ResourcesCreatorSaleEventsEntries200ResponseData
• GetV2ResourcesCreatorStores200Response
• GetV2ResourcesCreatorStores200ResponseData
• GetV2ResourcesCreatorUpdates200Response
• GetV2ResourcesCreatorUpdates200ResponseData
• GetV2ResourcesCreatorVersions200Response
• GetV2ResourcesCreatorVersions200ResponseData
• GetV2ResourcesDiscoverCartView200Response
• GetV2ResourcesDiscoverCartView200ResponseData
• GetV2ResourcesDiscoverDownloadDirectInitiate200Response
• GetV2ResourcesDiscoverDownloadDirectInitiate200ResponseData
• GetV2ResourcesDiscoverDownloadDirectPoll200Response
• GetV2ResourcesDiscoverDownloadDirectPoll200ResponseData
• GetV2ResourcesDiscoverDownloadPlan200Response
• GetV2ResourcesDiscoverDownloadPlan200ResponseData
• GetV2ResourcesDiscoverLicenses200Response
• GetV2ResourcesDiscoverLicenses200ResponseData
• GetV2ResourcesEmbedDownloadInitiate200Response
• GetV2ResourcesEmbedDownloadInitiate200ResponseData
• GetV2ResourcesEmbedDownloadStatus200Response
• GetV2ResourcesEmbedDownloadStatus200ResponseData
• GetV2ResourcesEmbedLatest200Response
• GetV2ResourcesEmbedLatest200ResponseData
• License
• ListStats
• Member
• PostV2DeploymentsUpgrade200Response
• PostV2DeploymentsUpgrade200ResponseData
• PostV2DeploymentsUpgrade200ResponseDataPreauthorize
• PostV2DeploymentsUpgradeRequest
• PostV2EventsComplete200Response
• PostV2EventsCompleteRequest
• PostV2ResourcesCreatorAddonsUpdateRequest
• PostV2ResourcesCreatorAddonsUpdateRequestFile
• PostV2ResourcesCreatorApiAssetsUpdateRequest
• PostV2ResourcesCreatorApiAssetsUpdateRequestFile
• PostV2ResourcesCreatorBatch200Response
• PostV2ResourcesCreatorBatch200ResponseData
• PostV2ResourcesCreatorBatchRequest
• PostV2ResourcesCreatorBatchRequestChangesInner
• PostV2ResourcesCreatorCoupons200Response
• PostV2ResourcesCreatorCoupons200ResponseData
• PostV2ResourcesCreatorCouponsRequest
• PostV2ResourcesCreatorUpdate200Response
• PostV2ResourcesCreatorUpdate200ResponseData
• PostV2ResourcesCreatorUpdateRequest
• PostV2ResourcesCreatorUpdateRequestFile
• PostV2ResourcesCreatorUpdateRequestUpdate
• PostV2ResourcesDiscoverCartAdd2XXResponse
• PostV2ResourcesDiscoverCartAddRequest
• PostV2ResourcesDiscoverCartCheckout200Response
• PostV2ResourcesDiscoverCartCheckout200ResponseData
• PostV2ResourcesDiscoverCartCouponAdd200Response
• PostV2ResourcesDiscoverCartCouponAddRequest
• PostV2ResourcesDiscoverCartCouponRemove200Response
• PostV2ResourcesDiscoverCartCouponRemoveRequest
• PostV2ResourcesDiscoverCartRemove200Response
• PostV2ResourcesDiscoverCartRemoveRequest
• Price
• Purchase
• Resource
• Review
• RichText
• SaleEvent
• SaleEventEntry
• Store
• Update
• Version

Authorization

Authentication schemes defined for the API:

token

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

oauth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://builtbybit.com/account/external/authorize
• Scopes: N/A

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: v2
• Build package: org.openapitools.codegen.languages.PhpClientCodegen