From 622920bc63b35c2e21ebfdcaaced9d1682eceae9 Mon Sep 17 00:00:00 2001 From: Jarrod Swift Date: Tue, 13 Apr 2021 19:36:35 +0930 Subject: [PATCH 1/4] Inital boilerplate for implementing channel currency assignments #53 --- RELEASE_NOTES.md | 10 +--- .../ChannelCurrencyAssignmentsApi.php | 54 +++++++++++++++++++ .../Channel/ChannelCurrencyAssignment.php | 12 +++++ .../ChannelCurrencyAssignmentResponse.php | 22 ++++++++ .../ChannelCurrencyAssignmentsResponse.php | 22 ++++++++ .../ChannelCurrencyAssignmentsApiTest.php | 18 +++++++ 6 files changed, 129 insertions(+), 9 deletions(-) create mode 100644 src/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApi.php create mode 100644 src/BigCommerce/ResourceModels/Channel/ChannelCurrencyAssignment.php create mode 100644 src/BigCommerce/ResponseModels/Channel/ChannelCurrencyAssignmentResponse.php create mode 100644 src/BigCommerce/ResponseModels/Channel/ChannelCurrencyAssignmentsResponse.php create mode 100644 tests/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApiTest.php diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 35223e2b..132f151d 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,15 +1,7 @@ ### New Features -- Implement the missing _create_ and _update_ endpoints for Brands. -- Implement [Channels APIs](https://developer.bigcommerce.com/api-reference/store-management/channels): - - [Channels](https://developer.bigcommerce.com/api-reference/store-management/channels/channels/listchannels) - - [Active Theme](https://developer.bigcommerce.com/api-reference/store-management/channels/channel-active-theme/get-channel-active-theme) - - [Listings](https://developer.bigcommerce.com/api-reference/store-management/channels/channel-listings/listchannellistings) - - [Site](https://developer.bigcommerce.com/api-reference/store-management/channels/channel-site/get-channel-site) +- Implement the [Channel Currency Assignments API](https://developer.bigcommerce.com/api-reference/store-management/channels/channel-currency-assignments/post-channels-currency-assignments) ### Fixed Issues -- Fixed 404 errors on scripts api (#55), thanks to @kishan93 -- Fixed issue where subscribers API was not accessible -- Fixed issue where Widget Template endpoints were incorrect diff --git a/src/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApi.php b/src/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApi.php new file mode 100644 index 00000000..a3de98a9 --- /dev/null +++ b/src/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApi.php @@ -0,0 +1,54 @@ +currencyAssignment; + } + + protected function addData(stdClass $rawData): void + { + $this->currencyAssignment = new ChannelCurrencyAssignment($rawData); + } +} diff --git a/src/BigCommerce/ResponseModels/Channel/ChannelCurrencyAssignmentsResponse.php b/src/BigCommerce/ResponseModels/Channel/ChannelCurrencyAssignmentsResponse.php new file mode 100644 index 00000000..203cee46 --- /dev/null +++ b/src/BigCommerce/ResponseModels/Channel/ChannelCurrencyAssignmentsResponse.php @@ -0,0 +1,22 @@ +getData(); + } + + protected function resourceClass(): string + { + return ChannelCurrencyAssignment::class; + } +} diff --git a/tests/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApiTest.php b/tests/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApiTest.php new file mode 100644 index 00000000..a0ba6acf --- /dev/null +++ b/tests/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApiTest.php @@ -0,0 +1,18 @@ +markTestIncomplete(); + } + + public function testCanGetAllCurrencyAssignments() + { + $this->markTestIncomplete(); + } +} From 32a2852a6d2abcd205e5841ca75f5bdb32a9973c Mon Sep 17 00:00:00 2001 From: Jarrod Swift Date: Tue, 13 Apr 2021 19:59:54 +0930 Subject: [PATCH 2/4] Implement the get all and get all for channel currency assignments endpoints #53 --- .../ChannelCurrencyAssignmentsApi.php | 54 ++++++++++++------- src/BigCommerce/Api/Channels/ChannelsApi.php | 5 ++ .../ChannelCurrencyAssignmentResponse.php | 4 ++ .../ChannelCurrencyAssignmentsApiTest.php | 15 ++++-- .../channel_currency_assignments.json | 12 +++++ 5 files changed, 69 insertions(+), 21 deletions(-) create mode 100644 tests/BigCommerce/responses/channel_currency_assignments.json diff --git a/src/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApi.php b/src/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApi.php index a3de98a9..9dbc24d4 100644 --- a/src/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApi.php +++ b/src/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApi.php @@ -2,7 +2,13 @@ namespace BigCommerce\ApiV3\Api\Channels; -use BigCommerce\ApiV3\Api\Generic\ResourceWithBatchUpdateApi; +use BigCommerce\ApiV3\Api\Generic\BatchUpdateResource; +use BigCommerce\ApiV3\Api\Generic\CreateResource; +use BigCommerce\ApiV3\Api\Generic\DeleteResource; +use BigCommerce\ApiV3\Api\Generic\GetAllResources; +use BigCommerce\ApiV3\Api\Generic\UpdateResource; +use BigCommerce\ApiV3\Api\Generic\V3ApiBase; +use BigCommerce\ApiV3\ResponseModels\Channel\ChannelCurrencyAssignmentsResponse; use BigCommerce\ApiV3\ResponseModels\PaginatedResponse; use BigCommerce\ApiV3\ResponseModels\SingleResourceResponse; @@ -11,44 +17,56 @@ * * */ -class ChannelCurrencyAssignmentsApi extends ResourceWithBatchUpdateApi +class ChannelCurrencyAssignmentsApi extends V3ApiBase { + use GetAllResources; + use DeleteResource; + use UpdateResource; + use CreateResource; + use BatchUpdateResource; - public function batchUpdate(array $resources): PaginatedResponse - { - // TODO: Implement batchUpdate() method. - } +// batchcreate? - protected function multipleResourcesEndpoint(): string + private const CURRENCY_ASSIGNMENTS_ENDPOINT = 'channels/currency-assignments'; + private const CURRENCY_ASSIGNMENT_ENDPOINT = 'channels/%d/currency-assignments'; + + + public function create(): ChannelCurrencyAssignmentsResponse { - // TODO: Implement multipleResourcesEndpoint() method. } - protected function singleResourceEndpoint(): string + public function update(): ChannelCurrencyAssignmentsResponse { - // TODO: Implement singleResourceEndpoint() method. } - protected function resourceName(): string + public function batchUpdate(array $resources): ChannelCurrencyAssignmentsResponse { - // TODO: Implement resourceName() method. + // TODO: Implement batchUpdate() method. } - public function get(): SingleResourceResponse + public function getAll(array $filters = [], int $page = 1, int $limit = 250): ChannelCurrencyAssignmentsResponse { - // TODO: Implement get() method. + return new ChannelCurrencyAssignmentsResponse($this->getAllResources($filters, $page, $limit)); } - public function getAll(array $filters = [], int $page = 1, int $limit = 250): PaginatedResponse + protected function multipleResourcesEndpoint(): string { - // TODO: Implement getAll() method. + return self::CURRENCY_ASSIGNMENTS_ENDPOINT; } - public function create(): SingleResourceResponse + /** + * Currency Assignment endpoints are different, they are all multiple resource endpoints, that may or may not + * be filtered by channel id. + * + * @return string + */ + public function multipleResourceUrl(): string { + return $this->getParentResourceId() ? $this->singleResourceUrl() : $this->multipleResourcesEndpoint(); } - public function update(): SingleResourceResponse + public function singleResourceUrl(): string { + return sprintf(self::CURRENCY_ASSIGNMENT_ENDPOINT, $this->getParentResourceId()); } } diff --git a/src/BigCommerce/Api/Channels/ChannelsApi.php b/src/BigCommerce/Api/Channels/ChannelsApi.php index 0a6a2bc3..0c8a79bf 100644 --- a/src/BigCommerce/Api/Channels/ChannelsApi.php +++ b/src/BigCommerce/Api/Channels/ChannelsApi.php @@ -85,4 +85,9 @@ public function site(): ChannelSitesApi { return new ChannelSitesApi($this->getClient(), null, $this->getResourceId()); } + + public function currencyAssignments(): ChannelCurrencyAssignmentsApi + { + return new ChannelCurrencyAssignmentsApi($this->getClient(), null, $this->getResourceId()); + } } diff --git a/src/BigCommerce/ResponseModels/Channel/ChannelCurrencyAssignmentResponse.php b/src/BigCommerce/ResponseModels/Channel/ChannelCurrencyAssignmentResponse.php index c1ee73eb..bde67224 100644 --- a/src/BigCommerce/ResponseModels/Channel/ChannelCurrencyAssignmentResponse.php +++ b/src/BigCommerce/ResponseModels/Channel/ChannelCurrencyAssignmentResponse.php @@ -6,6 +6,10 @@ use BigCommerce\ApiV3\ResponseModels\SingleResourceResponse; use stdClass; +/** + * Note this doesn't seem to be used by the API currently, it returns an array of assignments always. This class + * is included for completeness + */ class ChannelCurrencyAssignmentResponse extends SingleResourceResponse { private ChannelCurrencyAssignment $currencyAssignment; diff --git a/tests/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApiTest.php b/tests/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApiTest.php index a0ba6acf..9846a01b 100644 --- a/tests/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApiTest.php +++ b/tests/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApiTest.php @@ -8,11 +8,20 @@ class ChannelCurrencyAssignmentsApiTest extends BigCommerceApiTest { public function testCanGetCurrencyAssignment() { - $this->markTestIncomplete(); + $this->setReturnData('channel_currency_assignments.json'); + $channelId = 1; + + $currencyAssignments = $this->getApi() + ->channel($channelId)->currencyAssignments()->getAll()->getCurrencyAssignments(); + $this->assertEquals("channels/$channelId/currency-assignments", $this->getLastRequestPath()); + $this->assertEquals('AUD', $currencyAssignments[0]->default_currency); } - public function testCanGetAllCurrencyAssignments() + public function testCanGetAllChannelsCurrencyAssignments() { - $this->markTestIncomplete(); + $this->setReturnData('channel_currency_assignments.json'); + $currencyAssignments = $this->getApi()->channels()->currencyAssignments()->getAll()->getCurrencyAssignments(); + $this->assertEquals('channels/currency-assignments', $this->getLastRequestPath()); + $this->assertEquals('AUD', $currencyAssignments[0]->default_currency); } } diff --git a/tests/BigCommerce/responses/channel_currency_assignments.json b/tests/BigCommerce/responses/channel_currency_assignments.json new file mode 100644 index 00000000..84026f25 --- /dev/null +++ b/tests/BigCommerce/responses/channel_currency_assignments.json @@ -0,0 +1,12 @@ +{ + "data": [ + { + "channel_id": 1, + "enabled_currencies": [ + "AUD" + ], + "default_currency": "AUD" + } + ], + "meta": {} +} From 5d13790a8a2b61e576af277889eb13b6b29e1e58 Mon Sep 17 00:00:00 2001 From: Jarrod Swift Date: Tue, 13 Apr 2021 20:24:14 +0930 Subject: [PATCH 3/4] Implement the batch create and update endpoints for Channel Currency Assignments #53 --- .../ChannelCurrencyAssignmentsApi.php | 35 ++++++++--- .../Api/Generic/BatchCreateResource.php | 40 ++++++++++++ .../ChannelCurrencyAssignmentsResponse.php | 3 +- .../ChannelCurrencyAssignmentsApiTest.php | 61 +++++++++++++++++++ 4 files changed, 131 insertions(+), 8 deletions(-) create mode 100644 src/BigCommerce/Api/Generic/BatchCreateResource.php diff --git a/src/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApi.php b/src/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApi.php index 9dbc24d4..44fa1571 100644 --- a/src/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApi.php +++ b/src/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApi.php @@ -2,20 +2,28 @@ namespace BigCommerce\ApiV3\Api\Channels; +use BigCommerce\ApiV3\Api\Generic\BatchCreateResource; use BigCommerce\ApiV3\Api\Generic\BatchUpdateResource; use BigCommerce\ApiV3\Api\Generic\CreateResource; use BigCommerce\ApiV3\Api\Generic\DeleteResource; use BigCommerce\ApiV3\Api\Generic\GetAllResources; use BigCommerce\ApiV3\Api\Generic\UpdateResource; use BigCommerce\ApiV3\Api\Generic\V3ApiBase; +use BigCommerce\ApiV3\ResourceModels\Channel\ChannelCurrencyAssignment; use BigCommerce\ApiV3\ResponseModels\Channel\ChannelCurrencyAssignmentsResponse; use BigCommerce\ApiV3\ResponseModels\PaginatedResponse; -use BigCommerce\ApiV3\ResponseModels\SingleResourceResponse; /** * Channel Currency Assignments API * + * Example for finding all the currency assignments. Note that the parent id is effectively just a filter. * + * ```php + * $api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']); + * + * $allCurrencyAssignments = $api->channels()->currencyAssignments()->getAll()->getCurrencyAssignments(); + * $channelCurrencyAssignments = $api->channel(1)->currencyAssignments()->getAll()->getCurrencyAssignments(); + * ``` */ class ChannelCurrencyAssignmentsApi extends V3ApiBase { @@ -24,24 +32,38 @@ class ChannelCurrencyAssignmentsApi extends V3ApiBase use UpdateResource; use CreateResource; use BatchUpdateResource; - -// batchcreate? + use BatchCreateResource; private const CURRENCY_ASSIGNMENTS_ENDPOINT = 'channels/currency-assignments'; private const CURRENCY_ASSIGNMENT_ENDPOINT = 'channels/%d/currency-assignments'; - public function create(): ChannelCurrencyAssignmentsResponse + public function create(ChannelCurrencyAssignment $currencyAssignment): ChannelCurrencyAssignmentsResponse + { + return new ChannelCurrencyAssignmentsResponse($this->createResource($currencyAssignment)); + } + + public function update(ChannelCurrencyAssignment $currencyAssignment): ChannelCurrencyAssignmentsResponse { + return new ChannelCurrencyAssignmentsResponse($this->updateResource($currencyAssignment)); } - public function update(): ChannelCurrencyAssignmentsResponse + /** + * @param ChannelCurrencyAssignment[] $resources + * @return ChannelCurrencyAssignmentsResponse + */ + public function batchCreate(array $resources): PaginatedResponse { + return ChannelCurrencyAssignmentsResponse::buildFromMultipleResponses($this->batchCreateResource($resources)); } + /** + * @param ChannelCurrencyAssignment[] $resources + * @return ChannelCurrencyAssignmentsResponse + */ public function batchUpdate(array $resources): ChannelCurrencyAssignmentsResponse { - // TODO: Implement batchUpdate() method. + return ChannelCurrencyAssignmentsResponse::buildFromMultipleResponses($this->batchUpdateResource($resources)); } public function getAll(array $filters = [], int $page = 1, int $limit = 250): ChannelCurrencyAssignmentsResponse @@ -64,7 +86,6 @@ public function multipleResourceUrl(): string { return $this->getParentResourceId() ? $this->singleResourceUrl() : $this->multipleResourcesEndpoint(); } - public function singleResourceUrl(): string { return sprintf(self::CURRENCY_ASSIGNMENT_ENDPOINT, $this->getParentResourceId()); diff --git a/src/BigCommerce/Api/Generic/BatchCreateResource.php b/src/BigCommerce/Api/Generic/BatchCreateResource.php new file mode 100644 index 00000000..03cc7d90 --- /dev/null +++ b/src/BigCommerce/Api/Generic/BatchCreateResource.php @@ -0,0 +1,40 @@ +maxCreateBatchSize()); + $responses = []; + foreach ($chunks as $chunk) { + $responses[] = $this->getClient()->getRestClient()->post( + $this->multipleResourcesEndpoint(), + [ + RequestOptions::JSON => $chunk, + ] + ); + } + + return $responses; + } +} diff --git a/src/BigCommerce/ResponseModels/Channel/ChannelCurrencyAssignmentsResponse.php b/src/BigCommerce/ResponseModels/Channel/ChannelCurrencyAssignmentsResponse.php index 203cee46..14b6531f 100644 --- a/src/BigCommerce/ResponseModels/Channel/ChannelCurrencyAssignmentsResponse.php +++ b/src/BigCommerce/ResponseModels/Channel/ChannelCurrencyAssignmentsResponse.php @@ -3,9 +3,10 @@ namespace BigCommerce\ApiV3\ResponseModels\Channel; use BigCommerce\ApiV3\ResourceModels\Channel\ChannelCurrencyAssignment; +use BigCommerce\ApiV3\ResponseModels\PaginatedBatchableResponse; use BigCommerce\ApiV3\ResponseModels\PaginatedResponse; -class ChannelCurrencyAssignmentsResponse extends PaginatedResponse +class ChannelCurrencyAssignmentsResponse extends PaginatedBatchableResponse { /** * @return ChannelCurrencyAssignment[] diff --git a/tests/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApiTest.php b/tests/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApiTest.php index 9846a01b..961c0b2a 100644 --- a/tests/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApiTest.php +++ b/tests/BigCommerce/Api/Channels/ChannelCurrencyAssignmentsApiTest.php @@ -2,6 +2,7 @@ namespace BigCommerce\Tests\Api\Channels; +use BigCommerce\ApiV3\ResourceModels\Channel\ChannelCurrencyAssignment; use BigCommerce\Tests\BigCommerceApiTest; class ChannelCurrencyAssignmentsApiTest extends BigCommerceApiTest @@ -24,4 +25,64 @@ public function testCanGetAllChannelsCurrencyAssignments() $this->assertEquals('channels/currency-assignments', $this->getLastRequestPath()); $this->assertEquals('AUD', $currencyAssignments[0]->default_currency); } + + /** + * @return ChannelCurrencyAssignment[] + */ + private function getCurrencyAssignments(): array + { + $currencyAssignments = [new ChannelCurrencyAssignment(), new ChannelCurrencyAssignment()]; + + $currencyAssignments[0]->channel_id = 1; + $currencyAssignments[0]->enabled_currencies = ['USD', 'AUD']; + $currencyAssignments[0]->default_currency = 'AUD'; + + $currencyAssignments[0]->channel_id = 2; + $currencyAssignments[0]->enabled_currencies = ['USD', 'AUD', 'NZD']; + $currencyAssignments[0]->default_currency = 'NZD'; + + return $currencyAssignments; + } + + private function getCurrencyAssignment(): ChannelCurrencyAssignment + { + $currencyAssignment = new ChannelCurrencyAssignment(); + $currencyAssignment->channel_id = 1; + $currencyAssignment->enabled_currencies = ['AUD', 'NZD', 'CAD']; + $currencyAssignment->default_currency = 'CAD'; + + return $currencyAssignment; + } + + public function testCanCreateMultipleCurrencyAssignments() + { + $this->setReturnData('channel_currency_assignments.json'); + + $this->getApi()->channels()->currencyAssignments()->batchCreate($this->getCurrencyAssignments()); + $this->assertEquals('channels/currency-assignments', $this->getLastRequestPath()); + } + + public function testCanUpdateMultipleCurrencyAssignments() + { + $this->setReturnData('channel_currency_assignments.json'); + + $this->getApi()->channels()->currencyAssignments()->batchUpdate($this->getCurrencyAssignments()); + $this->assertEquals('channels/currency-assignments', $this->getLastRequestPath()); + } + + public function testCanCreateCurrencyAssignment() + { + $this->setReturnData('channel_currency_assignments.json'); + $channelId = 1; + $this->getApi()->channel(1)->currencyAssignments()->create($this->getCurrencyAssignment()); + $this->assertEquals("channels/$channelId/currency-assignments", $this->getLastRequestPath()); + } + + public function testCanUpdateCurrencyAssignment() + { + $this->setReturnData('channel_currency_assignments.json'); + $channelId = 1; + $this->getApi()->channel(1)->currencyAssignments()->update($this->getCurrencyAssignment()); + $this->assertEquals("channels/$channelId/currency-assignments", $this->getLastRequestPath()); + } } From 14ae4396d076281141de485b663ff88799312241 Mon Sep 17 00:00:00 2001 From: Jarrod Swift Date: Tue, 13 Apr 2021 20:31:14 +0930 Subject: [PATCH 4/4] Regenerate documentation with the addition of Channels APIs --- ...Commerce-ApiV3-Api-Carts-CartItemsApi.html | 33 +- ...e-ApiV3-Api-Carts-CartRedirectUrlsApi.html | 27 +- .../BigCommerce-ApiV3-Api-Carts-CartsApi.html | 28 +- ...gCommerce-ApiV3-Api-Catalog-BrandsApi.html | 20 +- ...i-Catalog-Categories-CategoryImageApi.html | 37 +- ...alog-Categories-CategoryMetafieldsApi.html | 38 +- ...Catalog-Products-ProductMetafieldsApi.html | 34 +- ...hannels-ChannelCurrencyAssignmentsApi.html | 691 ++++++++ ...ApiV3-Api-Channels-ChannelListingsApi.html | 581 +++++++ ...ce-ApiV3-Api-Channels-ChannelSitesApi.html | 557 +++++++ ...mmerce-ApiV3-Api-Channels-ChannelsApi.html | 834 ++++++++++ ...erce-ApiV3-Api-Customers-CustomersApi.html | 114 +- ...ApiV3-Api-Generic-BatchCreateResource.html | 237 +++ ...ApiV3-Api-Generic-ResourceApiNoDelete.html | 444 +++++ docs/classes/BigCommerce-ApiV3-Client.html | 146 +- ...-ApiV3-ResourceModels-Channel-Channel.html | 1433 +++++++++++++++++ ...els-Channel-ChannelCurrencyAssignment.html | 363 +++++ ...ResourceModels-Channel-ChannelListing.html | 623 +++++++ ...eModels-Channel-ChannelListingVariant.html | 585 +++++++ ...V3-ResourceModels-Channel-ChannelSite.html | 475 ++++++ ...sourceModels-Channel-ChannelSiteRoute.html | 412 +++++ ...3-ResourceModels-Channel-ChannelTheme.html | 881 ++++++++++ ...ls-Channel-ChannelActiveThemeResponse.html | 246 +++ ...nel-ChannelCurrencyAssignmentResponse.html | 249 +++ ...el-ChannelCurrencyAssignmentsResponse.html | 337 ++++ ...Models-Channel-ChannelListingResponse.html | 246 +++ ...odels-Channel-ChannelListingsResponse.html | 286 ++++ ...esponseModels-Channel-ChannelResponse.html | 246 +++ ...nseModels-Channel-ChannelSiteResponse.html | 246 +++ ...sponseModels-Channel-ChannelsResponse.html | 286 ++++ .../bigcommerce-api-carts-cartitemsapi.html | 2 +- ...ommerce-api-carts-cartredirecturlsapi.html | 2 +- .../files/bigcommerce-api-carts-cartsapi.html | 2 +- ...i-catalog-categories-categoryimageapi.html | 2 +- ...alog-categories-categorymetafieldsapi.html | 2 +- ...catalog-products-productmetafieldsapi.html | 2 +- ...hannels-channelcurrencyassignmentsapi.html | 135 ++ ...merce-api-channels-channellistingsapi.html | 135 ++ .../bigcommerce-api-channels-channelsapi.html | 135 ++ ...commerce-api-channels-channelsitesapi.html | 135 ++ ...merce-api-generic-batchcreateresource.html | 135 ++ ...merce-api-generic-resourceapinodelete.html | 135 ++ ...mmerce-resourcemodels-channel-channel.html | 135 ++ ...els-channel-channelcurrencyassignment.html | 135 ++ ...resourcemodels-channel-channellisting.html | 135 ++ ...emodels-channel-channellistingvariant.html | 135 ++ ...ce-resourcemodels-channel-channelsite.html | 135 ++ ...sourcemodels-channel-channelsiteroute.html | 135 ++ ...e-resourcemodels-channel-channeltheme.html | 135 ++ ...ls-channel-channelactivethemeresponse.html | 135 ++ ...nel-channelcurrencyassignmentresponse.html | 136 ++ ...el-channelcurrencyassignmentsresponse.html | 135 ++ ...models-channel-channellistingresponse.html | 135 ++ ...odels-channel-channellistingsresponse.html | 135 ++ ...esponsemodels-channel-channelresponse.html | 135 ++ ...nsemodels-channel-channelsiteresponse.html | 135 ++ ...sponsemodels-channel-channelsresponse.html | 135 ++ docs/indices/files.html | 21 + docs/js/searchIndex.js | 782 ++++++++- .../bigcommerce-apiv3-api-carts.html | 6 +- ...commerce-apiv3-api-catalog-categories.html | 4 +- ...igcommerce-apiv3-api-catalog-products.html | 2 +- .../bigcommerce-apiv3-api-channels.html | 137 ++ .../bigcommerce-apiv3-api-generic.html | 4 + docs/namespaces/bigcommerce-apiv3-api.html | 1 + ...commerce-apiv3-resourcemodels-channel.html | 143 ++ .../bigcommerce-apiv3-resourcemodels.html | 1 + ...commerce-apiv3-responsemodels-channel.html | 146 ++ .../bigcommerce-apiv3-responsemodels.html | 1 + .../packages/BigCommerce-ApiV3-Api-Carts.html | 131 ++ docs/packages/BigCommerce-ApiV3-Api.html | 127 ++ docs/packages/BigCommerce-ApiV3.html | 1 + docs/packages/BigCommerce.html | 55 +- 73 files changed, 15021 insertions(+), 124 deletions(-) create mode 100644 docs/classes/BigCommerce-ApiV3-Api-Channels-ChannelCurrencyAssignmentsApi.html create mode 100644 docs/classes/BigCommerce-ApiV3-Api-Channels-ChannelListingsApi.html create mode 100644 docs/classes/BigCommerce-ApiV3-Api-Channels-ChannelSitesApi.html create mode 100644 docs/classes/BigCommerce-ApiV3-Api-Channels-ChannelsApi.html create mode 100644 docs/classes/BigCommerce-ApiV3-Api-Generic-BatchCreateResource.html create mode 100644 docs/classes/BigCommerce-ApiV3-Api-Generic-ResourceApiNoDelete.html create mode 100644 docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html create mode 100644 docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelCurrencyAssignment.html create mode 100644 docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListing.html create mode 100644 docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListingVariant.html create mode 100644 docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSite.html create mode 100644 docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSiteRoute.html create mode 100644 docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html create mode 100644 docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelActiveThemeResponse.html create mode 100644 docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelCurrencyAssignmentResponse.html create mode 100644 docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelCurrencyAssignmentsResponse.html create mode 100644 docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelListingResponse.html create mode 100644 docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelListingsResponse.html create mode 100644 docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelResponse.html create mode 100644 docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelSiteResponse.html create mode 100644 docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelsResponse.html create mode 100644 docs/files/bigcommerce-api-channels-channelcurrencyassignmentsapi.html create mode 100644 docs/files/bigcommerce-api-channels-channellistingsapi.html create mode 100644 docs/files/bigcommerce-api-channels-channelsapi.html create mode 100644 docs/files/bigcommerce-api-channels-channelsitesapi.html create mode 100644 docs/files/bigcommerce-api-generic-batchcreateresource.html create mode 100644 docs/files/bigcommerce-api-generic-resourceapinodelete.html create mode 100644 docs/files/bigcommerce-resourcemodels-channel-channel.html create mode 100644 docs/files/bigcommerce-resourcemodels-channel-channelcurrencyassignment.html create mode 100644 docs/files/bigcommerce-resourcemodels-channel-channellisting.html create mode 100644 docs/files/bigcommerce-resourcemodels-channel-channellistingvariant.html create mode 100644 docs/files/bigcommerce-resourcemodels-channel-channelsite.html create mode 100644 docs/files/bigcommerce-resourcemodels-channel-channelsiteroute.html create mode 100644 docs/files/bigcommerce-resourcemodels-channel-channeltheme.html create mode 100644 docs/files/bigcommerce-responsemodels-channel-channelactivethemeresponse.html create mode 100644 docs/files/bigcommerce-responsemodels-channel-channelcurrencyassignmentresponse.html create mode 100644 docs/files/bigcommerce-responsemodels-channel-channelcurrencyassignmentsresponse.html create mode 100644 docs/files/bigcommerce-responsemodels-channel-channellistingresponse.html create mode 100644 docs/files/bigcommerce-responsemodels-channel-channellistingsresponse.html create mode 100644 docs/files/bigcommerce-responsemodels-channel-channelresponse.html create mode 100644 docs/files/bigcommerce-responsemodels-channel-channelsiteresponse.html create mode 100644 docs/files/bigcommerce-responsemodels-channel-channelsresponse.html create mode 100644 docs/namespaces/bigcommerce-apiv3-api-channels.html create mode 100644 docs/namespaces/bigcommerce-apiv3-resourcemodels-channel.html create mode 100644 docs/namespaces/bigcommerce-apiv3-responsemodels-channel.html create mode 100644 docs/packages/BigCommerce-ApiV3-Api-Carts.html create mode 100644 docs/packages/BigCommerce-ApiV3-Api.html diff --git a/docs/classes/BigCommerce-ApiV3-Api-Carts-CartItemsApi.html b/docs/classes/BigCommerce-ApiV3-Api-Carts-CartItemsApi.html index 631ba221..4f44e5d5 100644 --- a/docs/classes/BigCommerce-ApiV3-Api-Carts-CartItemsApi.html +++ b/docs/classes/BigCommerce-ApiV3-Api-Carts-CartItemsApi.html @@ -97,13 +97,24 @@

-

V3ApiBase

+

Cart Items API

-

Add constructors and some basic scaffolding that will work for all API classes -regardless of which endpoints they implement

+

Example for adding a line item to a cart:

+
$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);
+
+$lineItem = new CartItem();
+$lineItem->line_items[] = [
+    "sku"        => "made-up",
+    "name"       => "My product",
+    "quantity"   => 33,
+    "list_price" => 55
+];
+
+$api()->cart($id)->items()->add($lineItem, CartItemsApi::INCLUDE_REDIRECT_URLS);
+
@@ -243,7 +254,7 @@

The Cart returns an abbreviated result. Use this to return digital items product options.

@@ -270,7 +281,7 @@

The Cart returns an abbreviated result. Use this to return physical items product options.

@@ -297,7 +308,7 @@

Create a direct link to a Cart.

@@ -393,7 +404,7 @@

@@ -602,7 +613,7 @@

@@ -718,7 +729,7 @@

@@ -750,7 +761,7 @@

diff --git a/docs/classes/BigCommerce-ApiV3-Api-Carts-CartRedirectUrlsApi.html b/docs/classes/BigCommerce-ApiV3-Api-Carts-CartRedirectUrlsApi.html index bdcfaa63..e0c3f523 100644 --- a/docs/classes/BigCommerce-ApiV3-Api-Carts-CartRedirectUrlsApi.html +++ b/docs/classes/BigCommerce-ApiV3-Api-Carts-CartRedirectUrlsApi.html @@ -97,13 +97,28 @@

-

V3ApiBase

- -

Add constructors and some basic scaffolding that will work for all API classes -regardless of which endpoints they implement

+

Cart Redirect URLS

+ +

Creates a Cart redirect URL for redirecting a shopper to an already created cart using the cartId.

+

Usage Notes

+
    +
  • Redirect URLs can also be created via Create a Cart requests by appending include=redirect_urls.
  • +
  • A Carts redirect URLs may only be used once.
  • +
  • Once a redirect URL has been visited, it will be invalidated and cannot be used again.
  • +
  • If your application requires URLs to be visited more than once, consider generating a fresh one each time you need +to restore a cart, and redirecting to the URL from your own application.
  • +
  • Redirect URLs can be generated only from carts created using the Server to Server Cart API.
  • +
  • To restore a cart that was created on the storefront, either by a shopper or the Storefront Cart API, first +recreate the cart using the Server to Server Cart API.
  • +
+

Example:

+ +$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']); +

$urls = $api->cart('sadfghj')->redirectUrls()->getRedirectUrls(); +

@@ -264,7 +279,7 @@

diff --git a/docs/classes/BigCommerce-ApiV3-Api-Carts-CartsApi.html b/docs/classes/BigCommerce-ApiV3-Api-Carts-CartsApi.html index 4cca0d36..a0effbb8 100644 --- a/docs/classes/BigCommerce-ApiV3-Api-Carts-CartsApi.html +++ b/docs/classes/BigCommerce-ApiV3-Api-Carts-CartsApi.html @@ -97,13 +97,17 @@

-

V3ApiBase

+

Carts API

-

Add constructors and some basic scaffolding that will work for all API classes -regardless of which endpoints they implement

+

The is the store management access for creating and viewing carts (not for customers to access carts)

+

Example fetching the contents of a cart:

+ +$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']); +

$cart = $api->carts('abcdefg;)->get()->getCart(); +

@@ -299,7 +303,7 @@

@@ -341,7 +345,7 @@

@@ -501,7 +505,7 @@

@@ -543,7 +547,7 @@

@@ -575,7 +579,7 @@

@@ -607,7 +611,7 @@

@@ -681,7 +685,7 @@

@@ -713,7 +717,7 @@

diff --git a/docs/classes/BigCommerce-ApiV3-Api-Catalog-BrandsApi.html b/docs/classes/BigCommerce-ApiV3-Api-Catalog-BrandsApi.html index 9cb2bb69..74dd0ab6 100644 --- a/docs/classes/BigCommerce-ApiV3-Api-Catalog-BrandsApi.html +++ b/docs/classes/BigCommerce-ApiV3-Api-Catalog-BrandsApi.html @@ -363,7 +363,7 @@

Creates a Brand.

@@ -475,7 +475,7 @@

Returns a list of Brands.

@@ -494,7 +494,8 @@

Parameters
: array<string, mixed> = []
-

Array of optional features. For available filters, see https://developer.bigcommerce.com/api-reference/store-management/catalog/brands/getbrands

+

Array of optional features. For available filters, +see https://developer.bigcommerce.com/api-reference/store-management/catalog/brands/getbrands

@@ -555,7 +556,7 @@

Get all brands, fetching multiple pages

@@ -574,7 +575,8 @@

Parameters
: array<string|int, mixed> = []
-

Array of optional features. For available filters, see https://developer.bigcommerce.com/api-reference/store-management/catalog/brands/getbrands

+

Array of optional features. For available filters, +see https://developer.bigcommerce.com/api-reference/store-management/catalog/brands/getbrands

@@ -713,7 +715,7 @@

Get the Brand Image API for this brand

@@ -767,7 +769,7 @@

Get the singular Brand Metafields API

@@ -828,7 +830,7 @@

Get the Plural BrandMetafields API

@@ -878,7 +880,7 @@

Update a Brand

diff --git a/docs/classes/BigCommerce-ApiV3-Api-Catalog-Categories-CategoryImageApi.html b/docs/classes/BigCommerce-ApiV3-Api-Catalog-Categories-CategoryImageApi.html index b64cbbf9..0fd4de23 100644 --- a/docs/classes/BigCommerce-ApiV3-Api-Catalog-Categories-CategoryImageApi.html +++ b/docs/classes/BigCommerce-ApiV3-Api-Catalog-Categories-CategoryImageApi.html @@ -98,16 +98,43 @@

-

V3ApiBase

+

Category Images API

+ +

Usage (creating an image for Category with ID of 1):

+
$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);
 
-    

Add constructors and some basic scaffolding that will work for all API classes -regardless of which endpoints they implement

+$api->catalog()->category(1)->image()->create('/path/to/image.png'); +
+

+ Tags + +
+
+
+ see +
+
+ https://developer.bigcommerce.com/api-reference/store-management/catalog/brand-images/createbrandimage + +
+ +
+
+ see +
+
+ CreateImage::create() + +
+ +
+
@@ -188,7 +215,7 @@

diff --git a/docs/classes/BigCommerce-ApiV3-Api-Catalog-Categories-CategoryMetafieldsApi.html b/docs/classes/BigCommerce-ApiV3-Api-Catalog-Categories-CategoryMetafieldsApi.html index 2269d7af..36235093 100644 --- a/docs/classes/BigCommerce-ApiV3-Api-Catalog-Categories-CategoryMetafieldsApi.html +++ b/docs/classes/BigCommerce-ApiV3-Api-Catalog-Categories-CategoryMetafieldsApi.html @@ -98,16 +98,38 @@

-

V3ApiBase

+

Category Metafields API

-

Add constructors and some basic scaffolding that will work for all API classes -regardless of which endpoints they implement

+

Usage:

+
$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);
+
+// Get All Metafields
+$metafields = $api->catalog()->category(1)->metafields();
+
+// Delete a single Metafield
+$api->catalog()->category(1)->metafield($metafields[0]->id)->delete();
+
+
+ Tags + +
+
+
+ see +
+
+ https://developer.bigcommerce.com/api-reference/store-management/catalog/category-metafields/getcategorymetafieldsbycategoryid + +
+ +
+
@@ -258,7 +280,7 @@

@@ -300,7 +322,7 @@

@@ -332,7 +354,7 @@

@@ -484,7 +506,7 @@

diff --git a/docs/classes/BigCommerce-ApiV3-Api-Catalog-Products-ProductMetafieldsApi.html b/docs/classes/BigCommerce-ApiV3-Api-Catalog-Products-ProductMetafieldsApi.html index a1e9d14d..a38370e0 100644 --- a/docs/classes/BigCommerce-ApiV3-Api-Catalog-Products-ProductMetafieldsApi.html +++ b/docs/classes/BigCommerce-ApiV3-Api-Catalog-Products-ProductMetafieldsApi.html @@ -98,16 +98,38 @@

-

V3ApiBase

+

Product Metafields API

-

Add constructors and some basic scaffolding that will work for all API classes -regardless of which endpoints they implement

+

Usage:

+
$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);
+
+// Get All Metafields
+$metafields = $api->catalog()->product(1)->metafields();
+
+// Delete a single Metafield
+$api->catalog()->product(1)->metafield($metafields[0]->id)->delete();
+
+
+ Tags + +
+
+
+ see +
+
+ https://developer.bigcommerce.com/api-reference/store-management/catalog/product-metafields/getproductmetafieldsbyproductid + +
+ +
+
@@ -244,7 +266,7 @@

@@ -276,7 +298,7 @@

diff --git a/docs/classes/BigCommerce-ApiV3-Api-Channels-ChannelCurrencyAssignmentsApi.html b/docs/classes/BigCommerce-ApiV3-Api-Channels-ChannelCurrencyAssignmentsApi.html new file mode 100644 index 00000000..62bfa451 --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-Api-Channels-ChannelCurrencyAssignmentsApi.html @@ -0,0 +1,691 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
+

Documentation

+ + + + + +
+ +
+
+ + + + +
+ + +
+

+ ChannelCurrencyAssignmentsApi + + + extends V3ApiBase + + + + +

+ + + +

Channel Currency Assignments API

+ +

Example for finding all the currency assignments. Note that the parent id is effectively just a filter.

+
$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);
+
+$allCurrencyAssignments = $api->channels()->currencyAssignments()->getAll()->getCurrencyAssignments();
+$channelCurrencyAssignments = $api->channel(1)->currencyAssignments()->getAll()->getCurrencyAssignments();
+
+
+ + + + + + + + +

+ Table of Contents + +

+ +
+
+ __construct() + +  : mixed +
+
+ +
+ batchCreate() + +  : ChannelCurrencyAssignmentsResponse +
+
+ +
+ batchUpdate() + +  : ChannelCurrencyAssignmentsResponse +
+
+ +
+ create() + +  : ChannelCurrencyAssignmentsResponse +
+
+ +
+ getAll() + +  : ChannelCurrencyAssignmentsResponse +
+
+ +
+ getClient() + +  : Client +
+
+ +
+ getParentResourceId() + +  : int|null +
+
+ +
+ getResourceId() + +  : int|null +
+
+ +
+ multipleResourceUrl() + +  : string +
+
Currency Assignment endpoints are different, they are all multiple resource endpoints, that may or may not +be filtered by channel id.
+ +
+ singleResourceUrl() + +  : string +
+
+ +
+ update() + +  : ChannelCurrencyAssignmentsResponse +
+
+ +
+ + + + + + + +
+

+ Methods + +

+
+

+ __construct() + +

+ + + + + public + __construct(Client $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed + + +
Parameters
+
+
+ $client + : Client +
+
+ +
+
+ $resourceId + : int|null + = null
+
+ +
+
+ $parentResourceId + : int|null + = null
+
+ +
+
+ + + +
Return values
+ mixed + — +
+ + +
+ + + + +
+

+ getClient() + +

+ + + + + public + getClient() : Client + + + + + +
Return values
+ Client + — +
+ + +
+
+

+ getParentResourceId() + +

+ + + + + public + getParentResourceId() : int|null + + + + + +
Return values
+ int|null + — +
+ + +
+
+

+ getResourceId() + +

+ + + + + public + getResourceId() : int|null + + + + + +
Return values
+ int|null + — +
+ + +
+
+

+ multipleResourceUrl() + +

+ + +

Currency Assignment endpoints are different, they are all multiple resource endpoints, that may or may not +be filtered by channel id.

+ + + public + multipleResourceUrl() : string + +
+ + + + +
Return values
+ string + — +
+ + +
+
+

+ singleResourceUrl() + +

+ + + + + public + singleResourceUrl() : string + + + + + +
Return values
+ string + — +
+ + +
+ +
+ +
+
+
+
+

Search results

+ +
+
+
    +
    +
    +
    +
    +
    + + +
    + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-Api-Channels-ChannelListingsApi.html b/docs/classes/BigCommerce-ApiV3-Api-Channels-ChannelListingsApi.html new file mode 100644 index 00000000..be3c4548 --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-Api-Channels-ChannelListingsApi.html @@ -0,0 +1,581 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
    +

    Documentation

    + + + + + +
    + +
    +
    + + + + +
    + + +
    +

    + ChannelListingsApi + + + extends ResourceApiNoDelete + + + + +

    + + + +

    V3ApiBase

    + +

    Add constructors and some basic scaffolding that will work for all API classes +regardless of which endpoints they implement

    +
    + + + + + + + + +

    + Table of Contents + +

    + +
    +
    + __construct() + +  : mixed +
    +
    + +
    + create() + +  : ChannelListingResponse +
    +
    + +
    + delete() + +  : ResponseInterface +
    +
    + +
    + get() + +  : ChannelListingResponse +
    +
    + +
    + getAll() + +  : ChannelListingsResponse +
    +
    + +
    + getClient() + +  : Client +
    +
    + +
    + getParentResourceId() + +  : int|null +
    +
    + +
    + getResourceId() + +  : int|null +
    +
    + +
    + update() + +  : ChannelListingResponse +
    +
    + +
    + + + + + + + +
    +

    + Methods + +

    +
    +

    + __construct() + +

    + + + + + public + __construct(Client $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed + + +
    Parameters
    +
    +
    + $client + : Client +
    +
    + +
    +
    + $resourceId + : int|null + = null
    +
    + +
    +
    + $parentResourceId + : int|null + = null
    +
    + +
    +
    + + + +
    Return values
    + mixed + — +
    + + +
    + +
    +

    + delete() + +

    + + + + + public + delete() : ResponseInterface + + + + + +
    Return values
    + ResponseInterface + — +
    + + +
    + +
    +

    + getAll() + +

    + + + + + public + getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : ChannelListingsResponse + + +
    Parameters
    +
    +
    + $filters + : array<string|int, mixed> + = []
    +
    + +
    +
    + $page + : int + = 1
    +
    + +
    +
    + $limit + : int + = 250
    +
    + +
    +
    + + + +
    Return values
    + ChannelListingsResponse + — +
    + + +
    +
    +

    + getClient() + +

    + + + + + public + getClient() : Client + + + + + +
    Return values
    + Client + — +
    + + +
    +
    +

    + getParentResourceId() + +

    + + + + + public + getParentResourceId() : int|null + + + + + +
    Return values
    + int|null + — +
    + + +
    +
    +

    + getResourceId() + +

    + + + + + public + getResourceId() : int|null + + + + + +
    Return values
    + int|null + — +
    + + +
    + +
    + +
    +
    +
    +
    +

    Search results

    + +
    +
    +
      +
      +
      +
      +
      +
      + + +
      + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-Api-Channels-ChannelSitesApi.html b/docs/classes/BigCommerce-ApiV3-Api-Channels-ChannelSitesApi.html new file mode 100644 index 00000000..a6d0381d --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-Api-Channels-ChannelSitesApi.html @@ -0,0 +1,557 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
      +

      Documentation

      + + + + + +
      + +
      +
      + + + + +
      + + +
      +

      + ChannelSitesApi + + + extends V3ApiBase + + + + +

      + + + +

      V3ApiBase

      + +

      Add constructors and some basic scaffolding that will work for all API classes +regardless of which endpoints they implement

      +
      + + + + + + + + +

      + Table of Contents + +

      + +
      +
      + __construct() + +  : mixed +
      +
      + +
      + create() + +  : ChannelSiteResponse +
      +
      + +
      + get() + +  : ChannelSiteResponse +
      +
      + +
      + getClient() + +  : Client +
      +
      + +
      + getParentResourceId() + +  : int|null +
      +
      + +
      + getResourceId() + +  : int|null +
      +
      + +
      + multipleResourceUrl() + +  : string +
      +
      + +
      + singleResourceUrl() + +  : string +
      +
      + +
      + update() + +  : ChannelSiteResponse +
      +
      + +
      + + + + + + + +
      +

      + Methods + +

      +
      +

      + __construct() + +

      + + + + + public + __construct(Client $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed + + +
      Parameters
      +
      +
      + $client + : Client +
      +
      + +
      +
      + $resourceId + : int|null + = null
      +
      + +
      +
      + $parentResourceId + : int|null + = null
      +
      + +
      +
      + + + +
      Return values
      + mixed + — +
      + + +
      + + +
      +

      + getClient() + +

      + + + + + public + getClient() : Client + + + + + +
      Return values
      + Client + — +
      + + +
      +
      +

      + getParentResourceId() + +

      + + + + + public + getParentResourceId() : int|null + + + + + +
      Return values
      + int|null + — +
      + + +
      +
      +

      + getResourceId() + +

      + + + + + public + getResourceId() : int|null + + + + + +
      Return values
      + int|null + — +
      + + +
      +
      +

      + multipleResourceUrl() + +

      + + + + + public + multipleResourceUrl() : string + + + + + +
      Return values
      + string + — +
      + + +
      +
      +

      + singleResourceUrl() + +

      + + + + + public + singleResourceUrl() : string + + + + + +
      Return values
      + string + — +
      + + +
      + +
      + +
      +
      +
      +
      +

      Search results

      + +
      +
      +
        +
        +
        +
        +
        +
        + + +
        + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-Api-Channels-ChannelsApi.html b/docs/classes/BigCommerce-ApiV3-Api-Channels-ChannelsApi.html new file mode 100644 index 00000000..2df1c647 --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-Api-Channels-ChannelsApi.html @@ -0,0 +1,834 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
        +

        Documentation

        + + + + + +
        + +
        +
        + + + + +
        + + +
        +

        + ChannelsApi + + + extends ResourceApiNoDelete + + + + +

        + + + +

        V3ApiBase

        + +

        Add constructors and some basic scaffolding that will work for all API classes +regardless of which endpoints they implement

        +
        + + + + + + + + +

        + Table of Contents + +

        + +
        +
        + INCLUDE__CURRENCIES + +  = 'currencies' +
        +
        + +
        + __construct() + +  : mixed +
        +
        + +
        + create() + +  : ChannelResponse +
        +
        + +
        + currencyAssignments() + +  : ChannelCurrencyAssignmentsApi +
        +
        + +
        + delete() + +  : ResponseInterface +
        +
        + +
        + get() + +  : ChannelResponse +
        +
        + +
        + getActiveTheme() + +  : ChannelActiveThemeResponse +
        +
        + +
        + getAll() + +  : ChannelsResponse +
        +
        + +
        + getClient() + +  : Client +
        +
        + +
        + getParentResourceId() + +  : int|null +
        +
        + +
        + getResourceId() + +  : int|null +
        +
        + +
        + listing() + +  : ChannelListingsApi +
        +
        + +
        + listings() + +  : ChannelListingsApi +
        +
        + +
        + site() + +  : ChannelSitesApi +
        +
        + +
        + update() + +  : ChannelResponse +
        +
        + +
        + + + + +
        +

        + Constants + +

        +
        +

        + INCLUDE__CURRENCIES + +

        + + + + + + public + mixed + INCLUDE__CURRENCIES + = 'currencies' + + + + + + +
        +
        + + + +
        +

        + Methods + +

        +
        +

        + __construct() + +

        + + + + + public + __construct(Client $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed + + +
        Parameters
        +
        +
        + $client + : Client +
        +
        + +
        +
        + $resourceId + : int|null + = null
        +
        + +
        +
        + $parentResourceId + : int|null + = null
        +
        + +
        +
        + + + +
        Return values
        + mixed + — +
        + + +
        + + +
        +

        + delete() + +

        + + + + + public + delete() : ResponseInterface + + + + + +
        Return values
        + ResponseInterface + — +
        + + +
        +
        +

        + get() + +

        + + + + + public + get([string|null $include = null ]) : ChannelResponse + + +
        Parameters
        +
        +
        + $include + : string|null + = null
        +
        + +
        +
        + + + +
        Return values
        + ChannelResponse + — +
        + + +
        + +
        +

        + getAll() + +

        + + + + + public + getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : ChannelsResponse + + +
        Parameters
        +
        +
        + $filters + : array<string|int, mixed> + = []
        +
        + +
        +
        + $page + : int + = 1
        +
        + +
        +
        + $limit + : int + = 250
        +
        + +
        +
        + + + +
        Return values
        + ChannelsResponse + — +
        + + +
        +
        +

        + getClient() + +

        + + + + + public + getClient() : Client + + + + + +
        Return values
        + Client + — +
        + + +
        +
        +

        + getParentResourceId() + +

        + + + + + public + getParentResourceId() : int|null + + + + + +
        Return values
        + int|null + — +
        + + +
        +
        +

        + getResourceId() + +

        + + + + + public + getResourceId() : int|null + + + + + +
        Return values
        + int|null + — +
        + + +
        + + + + +
        + +
        +
        +
        +
        +

        Search results

        + +
        +
        +
          +
          +
          +
          +
          +
          + + +
          + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-Api-Customers-CustomersApi.html b/docs/classes/BigCommerce-ApiV3-Api-Customers-CustomersApi.html index cb7edb80..9281d34c 100644 --- a/docs/classes/BigCommerce-ApiV3-Api-Customers-CustomersApi.html +++ b/docs/classes/BigCommerce-ApiV3-Api-Customers-CustomersApi.html @@ -97,7 +97,7 @@

          V3ApiBase

          @@ -222,6 +222,20 @@

           : int|null +
          + +
          + subscriber() + +  : SubscribersApi +
          +
          + +
          + subscribers() + +  : SubscribersApi +
          @@ -250,7 +264,7 @@

          @@ -275,7 +289,7 @@

          @@ -369,7 +383,7 @@

          @@ -401,7 +415,7 @@

          @@ -433,7 +447,7 @@

          @@ -465,7 +479,7 @@

          @@ -539,7 +553,7 @@

          @@ -571,7 +585,7 @@

          @@ -627,7 +641,7 @@

          @@ -669,7 +683,7 @@

          @@ -793,6 +807,80 @@

          Return values
          + + +
          diff --git a/docs/classes/BigCommerce-ApiV3-Api-Generic-BatchCreateResource.html b/docs/classes/BigCommerce-ApiV3-Api-Generic-BatchCreateResource.html new file mode 100644 index 00000000..dc8e19b2 --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-Api-Generic-BatchCreateResource.html @@ -0,0 +1,237 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
          +

          Documentation

          + + + + + +
          + +
          +
          + + + + +
          + + +
          +

          + BatchCreateResource +

          + + + + + + + + + + + + +

          + Table of Contents + +

          + +
          +
          + batchCreate() + +  : PaginatedResponse +
          +
          + +
          + getClient() + +  : Client +
          +
          + +
          + + + + + +
          +

          + Methods + +

          +
          +

          + batchCreate() + +

          + + + + + public + abstract batchCreate(array<string|int, mixed> $resources) : PaginatedResponse + + +
          Parameters
          +
          +
          + $resources + : array<string|int, mixed> +
          +
          + +
          +
          + + + +
          Return values
          + PaginatedResponse + — +
          + + +
          + +
          + +
          +
          +
          +
          +

          Search results

          + +
          +
          +
            +
            +
            +
            +
            +
            + + +
            + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-Api-Generic-ResourceApiNoDelete.html b/docs/classes/BigCommerce-ApiV3-Api-Generic-ResourceApiNoDelete.html new file mode 100644 index 00000000..0db2f462 --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-Api-Generic-ResourceApiNoDelete.html @@ -0,0 +1,444 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
            +

            Documentation

            + + + + + +
            + +
            +
            + + + + +
            + + +
            +

            + ResourceApiNoDelete + + + extends V3ApiBase + + + + +

            + + + +

            V3ApiBase

            + +

            Add constructors and some basic scaffolding that will work for all API classes +regardless of which endpoints they implement

            +
            + + + + + + + + +

            + Table of Contents + +

            + +
            +
            + __construct() + +  : mixed +
            +
            + +
            + get() + +  : SingleResourceResponse +
            +
            + +
            + getAll() + +  : PaginatedResponse +
            +
            + +
            + getClient() + +  : Client +
            +
            + +
            + getParentResourceId() + +  : int|null +
            +
            + +
            + getResourceId() + +  : int|null +
            +
            + +
            + + + + + + + +
            +

            + Methods + +

            +
            +

            + __construct() + +

            + + + + + public + __construct(Client $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed + + +
            Parameters
            +
            +
            + $client + : Client +
            +
            + +
            +
            + $resourceId + : int|null + = null
            +
            + +
            +
            + $parentResourceId + : int|null + = null
            +
            + +
            +
            + + + +
            Return values
            + mixed + — +
            + + +
            + +
            +

            + getAll() + +

            + + + + + public + abstract getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : PaginatedResponse + + +
            Parameters
            +
            +
            + $filters + : array<string|int, mixed> + = []
            +
            + +
            +
            + $page + : int + = 1
            +
            + +
            +
            + $limit + : int + = 250
            +
            + +
            +
            + + + +
            Return values
            + PaginatedResponse + — +
            + + +
            +
            +

            + getClient() + +

            + + + + + public + getClient() : Client + + + + + +
            Return values
            + Client + — +
            + + +
            +
            +

            + getParentResourceId() + +

            + + + + + public + getParentResourceId() : int|null + + + + + +
            Return values
            + int|null + — +
            + + +
            +
            +

            + getResourceId() + +

            + + + + + public + getResourceId() : int|null + + + + + +
            Return values
            + int|null + — +
            + + +
            +
            + +
            +
            +
            +
            +

            Search results

            + +
            +
            +
              +
              +
              +
              +
              +
              + + +
              + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-Client.html b/docs/classes/BigCommerce-ApiV3-Client.html index c673a65a..c136c634 100644 --- a/docs/classes/BigCommerce-ApiV3-Client.html +++ b/docs/classes/BigCommerce-ApiV3-Client.html @@ -92,7 +92,7 @@

              @@ -178,6 +178,20 @@

               : CatalogApi

              +
              + +
              + channel() + +  : ChannelsApi +
              +
              + +
              + channels() + +  : ChannelsApi +
              @@ -325,7 +339,7 @@

              @@ -350,7 +364,7 @@

              @@ -375,7 +389,7 @@

              @@ -400,7 +414,7 @@

              @@ -425,7 +439,7 @@

              @@ -450,7 +464,7 @@

              @@ -488,7 +502,7 @@

              @@ -551,7 +565,7 @@

              @@ -593,7 +607,7 @@

              @@ -625,7 +639,7 @@

              @@ -643,6 +657,80 @@

              Return values
              + +
              +

              + channel() + +

              + + + + + public + channel(int $id) : ChannelsApi + + +
              Parameters
              +
              +
              + $id + : int +
              +
              + +
              +
              + + + +
              Return values
              + ChannelsApi + — +
              + + +
              +
              @@ -689,7 +777,7 @@

              @@ -721,7 +809,7 @@

              @@ -753,7 +841,7 @@

              @@ -785,7 +873,7 @@

              @@ -817,7 +905,7 @@

              @@ -859,7 +947,7 @@

              @@ -891,7 +979,7 @@

              @@ -933,7 +1021,7 @@

              @@ -965,7 +1053,7 @@

              @@ -997,7 +1085,7 @@

              @@ -1029,7 +1117,7 @@

              @@ -1071,7 +1159,7 @@

              @@ -1103,7 +1191,7 @@

              @@ -1145,7 +1233,7 @@

              @@ -1187,7 +1275,7 @@

              @@ -1229,7 +1317,7 @@

              @@ -1261,7 +1349,7 @@

              diff --git a/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html b/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html new file mode 100644 index 00000000..b23f1b2c --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html @@ -0,0 +1,1433 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
              +

              Documentation

              + + + + + +
              + +
              +
              + + + + +
              + + +
              +

              + Channel + + + extends ResourceModel + + + + +

              + + + + + + + + + + + + +

              + Table of Contents + +

              + +
              +
              + PLATFORM__ACQUIA + +  = 'acquia' +
              +
              + +
              + PLATFORM__AMAZON + +  = 'amazon' +
              +
              + +
              + PLATFORM__BIGCOMMERCE + +  = 'bigcommerce' +
              +
              + +
              + PLATFORM__BLOOMREACH + +  = 'bloomreach' +
              +
              + +
              + PLATFORM__CLOVER + +  = 'clover' +
              +
              + +
              + PLATFORM__CUSTOM + +  = 'custom' +
              +
              + +
              + PLATFORM__DEITY + +  = 'deity' +
              +
              + +
              + PLATFORM__DRUPAL + +  = 'drupal' +
              +
              + +
              + PLATFORM__EBAY + +  = 'ebay' +
              +
              + +
              + PLATFORM__FACEBOOK + +  = 'facebook' +
              +
              + +
              + PLATFORM__GOOGLE_SHOPPING + +  = 'google_shopping' +
              +
              + +
              + PLATFORM__NEXT + +  = 'next' +
              +
              + +
              + PLATFORM__SQUARE + +  = 'square' +
              +
              + +
              + PLATFORM__VEND + +  = 'vend' +
              +
              + +
              + PLATFORM__WORDPRESS + +  = 'wordpress' +
              +
              + +
              + STATUS__ACTIVE + +  = 'active' +
              +
              + +
              + STATUS__CONNECTED + +  = 'connected' +
              +
              + +
              + STATUS__DISCONNECTED + +  = 'disconnected' +
              +
              + +
              + STATUS__INACTIVE + +  = 'inactive' +
              +
              + +
              + STATUS__PRELAUNCH + +  = 'prelaunch' +
              +
              + +
              + TYPE__MARKETING + +  = 'marketing' +
              +
              + +
              + TYPE__MARKETPLACE + +  = 'marketplace' +
              +
              + +
              + TYPE__POS + +  = 'pos' +
              +
              + +
              + TYPE__STOREFRONT + +  = 'storefront' +
              +
              + +
              + $config_meta + +  : object +
              +
              + +
              + $date_created + +  : string +
              +
              + +
              + $date_modified + +  : string +
              +
              + +
              + $external_id + +  : string +
              +
              + +
              + $id + +  : int +
              +
              + +
              + $is_listable_from_ui + +  : bool +
              +
              + +
              + $is_visible + +  : bool +
              +
              + +
              + $name + +  : string +
              +
              + +
              + $platform + +  : string +
              +
              + +
              + $status + +  : string +
              +
              + +
              + $type + +  : string +
              +
              + +
              + __construct() + +  : mixed +
              +
              + +
              + jsonSerialize() + +  : array<string|int, mixed> +
              +
              + +
              + + + + +
              +

              + Constants + +

              +
              +

              + PLATFORM__ACQUIA + +

              + + + + + + public + mixed + PLATFORM__ACQUIA + = 'acquia' + + + + + + +
              +
              +

              + PLATFORM__AMAZON + +

              + + + + + + public + mixed + PLATFORM__AMAZON + = 'amazon' + + + + + + +
              +
              +

              + PLATFORM__BIGCOMMERCE + +

              + + + + + + public + mixed + PLATFORM__BIGCOMMERCE + = 'bigcommerce' + + + + + + +
              +
              +

              + PLATFORM__BLOOMREACH + +

              + + + + + + public + mixed + PLATFORM__BLOOMREACH + = 'bloomreach' + + + + + + +
              +
              +

              + PLATFORM__CLOVER + +

              + + + + + + public + mixed + PLATFORM__CLOVER + = 'clover' + + + + + + +
              +
              +

              + PLATFORM__CUSTOM + +

              + + + + + + public + mixed + PLATFORM__CUSTOM + = 'custom' + + + + + + +
              +
              +

              + PLATFORM__DEITY + +

              + + + + + + public + mixed + PLATFORM__DEITY + = 'deity' + + + + + + +
              +
              +

              + PLATFORM__DRUPAL + +

              + + + + + + public + mixed + PLATFORM__DRUPAL + = 'drupal' + + + + + + +
              +
              +

              + PLATFORM__EBAY + +

              + + + + + + public + mixed + PLATFORM__EBAY + = 'ebay' + + + + + + +
              +
              +

              + PLATFORM__FACEBOOK + +

              + + + + + + public + mixed + PLATFORM__FACEBOOK + = 'facebook' + + + + + + +
              +
              +

              + PLATFORM__GOOGLE_SHOPPING + +

              + + + + + + public + mixed + PLATFORM__GOOGLE_SHOPPING + = 'google_shopping' + + + + + + +
              +
              +

              + PLATFORM__NEXT + +

              + + + + + + public + mixed + PLATFORM__NEXT + = 'next' + + + + + + +
              +
              +

              + PLATFORM__SQUARE + +

              + + + + + + public + mixed + PLATFORM__SQUARE + = 'square' + + + + + + +
              +
              +

              + PLATFORM__VEND + +

              + + + + + + public + mixed + PLATFORM__VEND + = 'vend' + + + + + + +
              +
              +

              + PLATFORM__WORDPRESS + +

              + + + + + + public + mixed + PLATFORM__WORDPRESS + = 'wordpress' + + + + + + +
              +
              +

              + STATUS__ACTIVE + +

              + + + + + + public + mixed + STATUS__ACTIVE + = 'active' + + + + + + +
              +
              +

              + STATUS__CONNECTED + +

              + + + + + + public + mixed + STATUS__CONNECTED + = 'connected' + + + + + + +
              +
              +

              + STATUS__DISCONNECTED + +

              + + + + + + public + mixed + STATUS__DISCONNECTED + = 'disconnected' + + + + + + +
              +
              +

              + STATUS__INACTIVE + +

              + + + + + + public + mixed + STATUS__INACTIVE + = 'inactive' + + + + + + +
              +
              +

              + STATUS__PRELAUNCH + +

              + + + + + + public + mixed + STATUS__PRELAUNCH + = 'prelaunch' + + + + + + +
              +
              +

              + TYPE__MARKETING + +

              + + + + + + public + mixed + TYPE__MARKETING + = 'marketing' + + + + + + +
              +
              +

              + TYPE__MARKETPLACE + +

              + + + + + + public + mixed + TYPE__MARKETPLACE + = 'marketplace' + + + + + + +
              +
              +

              + TYPE__POS + +

              + + + + + + public + mixed + TYPE__POS + = 'pos' + + + + + + +
              +
              +

              + TYPE__STOREFRONT + +

              + + + + + + public + mixed + TYPE__STOREFRONT + = 'storefront' + + + + + + +
              +
              + + +
              +

              + Properties + +

              +
              +

              + $config_meta + + + +

              + + + + + public + object + $config_meta + + + + + +
              +
              +

              + $date_created + + + +

              + + + + + public + string + $date_created + + + + + +
              +
              +

              + $date_modified + + + +

              + + + + + public + string + $date_modified + + + + + +
              +
              +

              + $external_id + + + +

              + + + + + public + string + $external_id + + + + + +
              +
              +

              + $id + + + +

              + + + + + public + int + $id + + + + + +
              +
              +

              + $is_listable_from_ui + + + +

              + + + + + public + bool + $is_listable_from_ui + + + + + +
              +
              +

              + $is_visible + + + +

              + + + + + public + bool + $is_visible + + + + + +
              +
              +

              + $name + + + +

              + + + + + public + string + $name + + + + + +
              +
              +

              + $platform + + + +

              + + + + + public + string + $platform + + + + + +
              +
              +

              + $status + + + +

              + + + + + public + string + $status + + + + + +
              +
              +

              + $type + + + +

              + + + + + public + string + $type + + + + + +
              +
              + +
              +

              + Methods + +

              +
              +

              + __construct() + +

              + + + + + public + __construct([stdClass|null $optionObject = null ]) : mixed + + +
              Parameters
              +
              +
              + $optionObject + : stdClass|null + = null
              +
              + +
              +
              + + + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + jsonSerialize() + +

              + + + + + public + jsonSerialize() : array<string|int, mixed> + + + + + +
              Return values
              + array<string|int, mixed> + — +
              + + +
              +
              + +
              +
              +
              +
              +

              Search results

              + +
              +
              +
                +
                +
                +
                +
                +
                + + +
                + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelCurrencyAssignment.html b/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelCurrencyAssignment.html new file mode 100644 index 00000000..c646cecc --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelCurrencyAssignment.html @@ -0,0 +1,363 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                +

                Documentation

                + + + + + +
                + +
                +
                + + + + +
                + + +
                +

                + ChannelCurrencyAssignment + + + extends ResourceModel + + + + +

                + + + + + + + + + + + + +

                + Table of Contents + +

                + +
                +
                + $channel_id + +  : int +
                +
                + +
                + $default_currency + +  : string +
                +
                + +
                + $enabled_currencies + +  : array<string|int, mixed> +
                +
                + +
                + __construct() + +  : mixed +
                +
                + +
                + jsonSerialize() + +  : array<string|int, mixed> +
                +
                + +
                + + + + + + +
                +

                + Properties + +

                + + +
                +

                + $enabled_currencies + + + +

                + + + + + public + array<string|int, mixed> + $enabled_currencies + + + + + +
                +
                + +
                +

                + Methods + +

                +
                +

                + __construct() + +

                + + + + + public + __construct([stdClass|null $optionObject = null ]) : mixed + + +
                Parameters
                +
                +
                + $optionObject + : stdClass|null + = null
                +
                + +
                +
                + + + +
                Return values
                + mixed + — +
                + + +
                +
                +

                + jsonSerialize() + +

                + + + + + public + jsonSerialize() : array<string|int, mixed> + + + + + +
                Return values
                + array<string|int, mixed> + — +
                + + +
                +
                + +
                +
                +
                +
                +

                Search results

                + +
                +
                +
                  +
                  +
                  +
                  +
                  +
                  + + +
                  + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListing.html b/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListing.html new file mode 100644 index 00000000..2bfab776 --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListing.html @@ -0,0 +1,623 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                  +

                  Documentation

                  + + + + + +
                  + +
                  +
                  + + + + +
                  + + +
                  +

                  + ChannelListing + + + extends ResourceModel + + + + +

                  + + + + + + + + + + + + +

                  + Table of Contents + +

                  + +
                  +
                  + $channel_id + +  : int +
                  +
                  + +
                  + $date_created + +  : string +
                  +
                  + +
                  + $date_modified + +  : string +
                  +
                  + +
                  + $description + +  : string +
                  +
                  + +
                  + $external_id + +  : string +
                  +
                  + +
                  + $listing_id + +  : int +
                  +
                  + +
                  + $name + +  : string +
                  +
                  + +
                  + $product_id + +  : int +
                  +
                  + +
                  + $state + +  : string +
                  +
                  + +
                  + $variants + +  : array<string|int, mixed> +
                  +
                  + +
                  + __construct() + +  : mixed +
                  +
                  + +
                  + jsonSerialize() + +  : array<string|int, mixed> +
                  +
                  + +
                  + + + + + + +
                  +

                  + Properties + +

                  +
                  +

                  + $channel_id + + + +

                  + + + + + public + int + $channel_id + + + + + +
                  +
                  +

                  + $date_created + + + +

                  + + + + + public + string + $date_created + + + + + +
                  +
                  +

                  + $date_modified + + + +

                  + + + + + public + string + $date_modified + + + + + +
                  +
                  +

                  + $description + + + +

                  + + + + + public + string + $description + + + + + +
                  +
                  +

                  + $external_id + + + +

                  + + + + + public + string + $external_id + + + + + +
                  +
                  +

                  + $listing_id + + + +

                  + + + + + public + int + $listing_id + + + + + +
                  +
                  +

                  + $name + + + +

                  + + + + + public + string + $name + + + + + +
                  +
                  +

                  + $product_id + + + +

                  + + + + + public + int + $product_id + + + + + +
                  +
                  +

                  + $state + + + +

                  + + + + + public + string + $state + + + + + +
                  +
                  +

                  + $variants + + + +

                  + + + + + public + array<string|int, mixed> + $variants + + +
                  + + + +
                  +
                  + +
                  +

                  + Methods + +

                  +
                  +

                  + __construct() + +

                  + + + + + public + __construct([stdClass|null $optionObject = null ]) : mixed + + +
                  Parameters
                  +
                  +
                  + $optionObject + : stdClass|null + = null
                  +
                  + +
                  +
                  + + + +
                  Return values
                  + mixed + — +
                  + + +
                  +
                  +

                  + jsonSerialize() + +

                  + + + + + public + jsonSerialize() : array<string|int, mixed> + + + + + +
                  Return values
                  + array<string|int, mixed> + — +
                  + + +
                  +
                  + +
                  +
                  +
                  +
                  +

                  Search results

                  + +
                  +
                  +
                    +
                    +
                    +
                    +
                    +
                    + + +
                    + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListingVariant.html b/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListingVariant.html new file mode 100644 index 00000000..176ea638 --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListingVariant.html @@ -0,0 +1,585 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                    +

                    Documentation

                    + + + + + +
                    + +
                    +
                    + + + + +
                    + + +
                    +

                    + ChannelListingVariant + + + extends ResourceModel + + + + +

                    + + + + + + + + + + + + +

                    + Table of Contents + +

                    + +
                    +
                    + $channel_id + +  : int +
                    +
                    + +
                    + $date_created + +  : string +
                    +
                    + +
                    + $date_modified + +  : string +
                    +
                    + +
                    + $description + +  : string +
                    +
                    + +
                    + $external_id + +  : string +
                    +
                    + +
                    + $name + +  : string +
                    +
                    + +
                    + $product_id + +  : int +
                    +
                    + +
                    + $state + +  : string +
                    +
                    + +
                    + $variant_id + +  : int +
                    +
                    + +
                    + __construct() + +  : mixed +
                    +
                    + +
                    + jsonSerialize() + +  : array<string|int, mixed> +
                    +
                    + +
                    + + + + + + +
                    +

                    + Properties + +

                    + + + + + + + + + +
                    + +
                    +

                    + Methods + +

                    +
                    +

                    + __construct() + +

                    + + + + + public + __construct([stdClass|null $optionObject = null ]) : mixed + + +
                    Parameters
                    +
                    +
                    + $optionObject + : stdClass|null + = null
                    +
                    + +
                    +
                    + + + +
                    Return values
                    + mixed + — +
                    + + +
                    +
                    +

                    + jsonSerialize() + +

                    + + + + + public + jsonSerialize() : array<string|int, mixed> + + + + + +
                    Return values
                    + array<string|int, mixed> + — +
                    + + +
                    +
                    + +
                    +
                    +
                    +
                    +

                    Search results

                    + +
                    +
                    +
                      +
                      +
                      +
                      +
                      +
                      + + +
                      + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSite.html b/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSite.html new file mode 100644 index 00000000..b8d1dd30 --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSite.html @@ -0,0 +1,475 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                      +

                      Documentation

                      + + + + + +
                      + +
                      +
                      + + + + +
                      + + +
                      +

                      + ChannelSite + + + extends ResourceModel + + + + +

                      + + + + + + + + + + + + +

                      + Table of Contents + +

                      + +
                      +
                      + $channel_id + +  : int +
                      +
                      + +
                      + $created_at + +  : string +
                      +
                      + +
                      + $id + +  : int +
                      +
                      + +
                      + $routes + +  : array<string|int, mixed>|null +
                      +
                      + +
                      + $updated_at + +  : string +
                      +
                      + +
                      + $url + +  : string +
                      +
                      + +
                      + __construct() + +  : mixed +
                      +
                      + +
                      + jsonSerialize() + +  : array<string|int, mixed> +
                      +
                      + +
                      + + + + + + +
                      +

                      + Properties + +

                      +
                      +

                      + $channel_id + + + +

                      + + + + + public + int + $channel_id + + + + + +
                      +
                      +

                      + $created_at + + + +

                      + + + + + public + string + $created_at + + + + + +
                      +
                      +

                      + $id + + + +

                      + + + + + public + int + $id + + + + + +
                      +
                      +

                      + $routes + + + +

                      + + + + + public + array<string|int, mixed>|null + $routes + + +
                      + + + +
                      +
                      +

                      + $updated_at + + + +

                      + + + + + public + string + $updated_at + + + + + +
                      +
                      +

                      + $url + + + +

                      + + + + + public + string + $url + + + + + +
                      +
                      + +
                      +

                      + Methods + +

                      +
                      +

                      + __construct() + +

                      + + + + + public + __construct([stdClass|null $optionObject = null ]) : mixed + + +
                      Parameters
                      +
                      +
                      + $optionObject + : stdClass|null + = null
                      +
                      + +
                      +
                      + + + +
                      Return values
                      + mixed + — +
                      + + +
                      +
                      +

                      + jsonSerialize() + +

                      + + + + + public + jsonSerialize() : array<string|int, mixed> + + + + + +
                      Return values
                      + array<string|int, mixed> + — +
                      + + +
                      +
                      + +
                      +
                      +
                      +
                      +

                      Search results

                      + +
                      +
                      +
                        +
                        +
                        +
                        +
                        +
                        + + +
                        + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSiteRoute.html b/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSiteRoute.html new file mode 100644 index 00000000..3c2d957a --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSiteRoute.html @@ -0,0 +1,412 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                        +

                        Documentation

                        + + + + + +
                        + +
                        +
                        + + + + +
                        + + +
                        +

                        + ChannelSiteRoute + + + extends ResourceModel + + + + +

                        + + + + + + + + + + + + +

                        + Table of Contents + +

                        + +
                        +
                        + $id + +  : int +
                        +
                        + +
                        + $matching + +  : string +
                        +
                        For a given type, which resources should match this route? e.g For a route with the type: “product” and matching: +“5” this route would be used for the product with the ID of 5.
                        + +
                        + $route + +  : string +
                        +
                        The route template that will be used to generate the URL for the requested resource.
                        + +
                        + $type + +  : string +
                        +
                        + +
                        + __construct() + +  : mixed +
                        +
                        + +
                        + jsonSerialize() + +  : array<string|int, mixed> +
                        +
                        + +
                        + + + + + + +
                        +

                        + Properties + +

                        + +
                        +

                        + $matching + + + +

                        + + +

                        For a given type, which resources should match this route? e.g For a route with the type: “product” and matching: +“5” this route would be used for the product with the ID of 5.

                        + + + public + string + $matching + + +

                        Depending on the type of resource, this may be an ID (matching a specific item), or a “*” wildcard matching all +items of that type.

                        +
                        + + + +
                        +
                        +

                        + $route + + + +

                        + + +

                        The route template that will be used to generate the URL for the requested resource.

                        + + + public + string + $route + + +

                        Supports several tokens:

                        +

                        {id} The ID of the requested item +{slug} The slug for the requested item (if available). Note: the slug value may contain / slash +{language} The language string that the client is using

                        +
                        + + + +
                        + +
                        + +
                        +

                        + Methods + +

                        +
                        +

                        + __construct() + +

                        + + + + + public + __construct([stdClass|null $optionObject = null ]) : mixed + + +
                        Parameters
                        +
                        +
                        + $optionObject + : stdClass|null + = null
                        +
                        + +
                        +
                        + + + +
                        Return values
                        + mixed + — +
                        + + +
                        +
                        +

                        + jsonSerialize() + +

                        + + + + + public + jsonSerialize() : array<string|int, mixed> + + + + + +
                        Return values
                        + array<string|int, mixed> + — +
                        + + +
                        +
                        + +
                        +
                        +
                        +
                        +

                        Search results

                        + +
                        +
                        +
                          +
                          +
                          +
                          +
                          +
                          + + +
                          + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html b/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html new file mode 100644 index 00000000..86056058 --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html @@ -0,0 +1,881 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                          +

                          Documentation

                          + + + + + +
                          + +
                          +
                          + + + + +
                          + + +
                          +

                          + ChannelTheme + + + extends ResourceModel + + + + +

                          + + + + + + + + + + + + +

                          + Table of Contents + +

                          + +
                          +
                          + $active_theme_configuration_uuid + +  : string +
                          +
                          + +
                          + $active_theme_display_version + +  : string +
                          +
                          + +
                          + $active_theme_documentation_url + +  : string +
                          +
                          + +
                          + $active_theme_is_private + +  : bool +
                          +
                          + +
                          + $active_theme_is_purchased + +  : bool +
                          +
                          + +
                          + $active_theme_name + +  : string +
                          +
                          + +
                          + $active_theme_partner + +  : object +
                          +
                          + +
                          + $active_theme_screenshot + +  : object +
                          +
                          + +
                          + $active_theme_style_editable + +  : bool +
                          +
                          + +
                          + $active_theme_type + +  : string +
                          +
                          + +
                          + $active_theme_update_available + +  : bool +
                          +
                          + +
                          + $active_theme_upgrade + +  : object|null +
                          +
                          + +
                          + $active_theme_uuid + +  : string +
                          +
                          + +
                          + $active_theme_variation_count + +  : int +
                          +
                          + +
                          + $active_theme_variation_name + +  : string +
                          +
                          + +
                          + $active_theme_version_uuid + +  : string +
                          +
                          + +
                          + $saved_theme_configuration_uuid + +  : string +
                          +
                          + +
                          + __construct() + +  : mixed +
                          +
                          + +
                          + jsonSerialize() + +  : array<string|int, mixed> +
                          +
                          + +
                          + + + + + + +
                          +

                          + Properties + +

                          +
                          +

                          + $active_theme_configuration_uuid + + + +

                          + + + + + public + string + $active_theme_configuration_uuid + + + + + +
                          +
                          +

                          + $active_theme_display_version + + + +

                          + + + + + public + string + $active_theme_display_version + + + + + +
                          +
                          +

                          + $active_theme_documentation_url + + + +

                          + + + + + public + string + $active_theme_documentation_url + + + + + +
                          +
                          +

                          + $active_theme_is_private + + + +

                          + + + + + public + bool + $active_theme_is_private + + + + + +
                          +
                          +

                          + $active_theme_is_purchased + + + +

                          + + + + + public + bool + $active_theme_is_purchased + + + + + +
                          +
                          +

                          + $active_theme_name + + + +

                          + + + + + public + string + $active_theme_name + + + + + +
                          +
                          +

                          + $active_theme_partner + + + +

                          + + + + + public + object + $active_theme_partner + + + + + +
                          +
                          +

                          + $active_theme_screenshot + + + +

                          + + + + + public + object + $active_theme_screenshot + + + + + +
                          +
                          +

                          + $active_theme_style_editable + + + +

                          + + + + + public + bool + $active_theme_style_editable + + + + + +
                          +
                          +

                          + $active_theme_type + + + +

                          + + + + + public + string + $active_theme_type + + + + + +
                          +
                          +

                          + $active_theme_update_available + + + +

                          + + + + + public + bool + $active_theme_update_available + + + + + +
                          +
                          +

                          + $active_theme_upgrade + + + +

                          + + + + + public + object|null + $active_theme_upgrade + + + + + +
                          +
                          +

                          + $active_theme_uuid + + + +

                          + + + + + public + string + $active_theme_uuid + + + + + +
                          +
                          +

                          + $active_theme_variation_count + + + +

                          + + + + + public + int + $active_theme_variation_count + + + + + +
                          +
                          +

                          + $active_theme_variation_name + + + +

                          + + + + + public + string + $active_theme_variation_name + + + + + +
                          +
                          +

                          + $active_theme_version_uuid + + + +

                          + + + + + public + string + $active_theme_version_uuid + + + + + +
                          +
                          +

                          + $saved_theme_configuration_uuid + + + +

                          + + + + + public + string + $saved_theme_configuration_uuid + + + + + +
                          +
                          + +
                          +

                          + Methods + +

                          +
                          +

                          + __construct() + +

                          + + + + + public + __construct([stdClass|null $optionObject = null ]) : mixed + + +
                          Parameters
                          +
                          +
                          + $optionObject + : stdClass|null + = null
                          +
                          + +
                          +
                          + + + +
                          Return values
                          + mixed + — +
                          + + +
                          +
                          +

                          + jsonSerialize() + +

                          + + + + + public + jsonSerialize() : array<string|int, mixed> + + + + + +
                          Return values
                          + array<string|int, mixed> + — +
                          + + +
                          +
                          + +
                          +
                          +
                          +
                          +

                          Search results

                          + +
                          +
                          +
                            +
                            +
                            +
                            +
                            +
                            + + +
                            + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelActiveThemeResponse.html b/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelActiveThemeResponse.html new file mode 100644 index 00000000..6d085ead --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelActiveThemeResponse.html @@ -0,0 +1,246 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                            +

                            Documentation

                            + + + + + +
                            + +
                            +
                            + + + + +
                            + + +
                            +

                            + ChannelActiveThemeResponse + + + extends SingleResourceResponse + + + + +

                            + + + + + + + + + + + + +

                            + Table of Contents + +

                            + +
                            +
                            + __construct() + +  : mixed +
                            +
                            + +
                            + getChannelTheme() + +  : ChannelTheme +
                            +
                            + +
                            + + + + + + + +
                            +

                            + Methods + +

                            +
                            +

                            + __construct() + +

                            + + + + + public + __construct(ResponseInterface $response) : mixed + + +
                            Parameters
                            +
                            +
                            + $response + : ResponseInterface +
                            +
                            + +
                            +
                            + + + +
                            Return values
                            + mixed + — +
                            + + +
                            + +
                            + +
                            +
                            +
                            +
                            +

                            Search results

                            + +
                            +
                            +
                              +
                              +
                              +
                              +
                              +
                              + + +
                              + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelCurrencyAssignmentResponse.html b/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelCurrencyAssignmentResponse.html new file mode 100644 index 00000000..bb8346f3 --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelCurrencyAssignmentResponse.html @@ -0,0 +1,249 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                              +

                              Documentation

                              + + + + + +
                              + +
                              +
                              + + + + +
                              + + +
                              +

                              + ChannelCurrencyAssignmentResponse + + + extends SingleResourceResponse + + + + +

                              + + + +

                              Note this doesn't seem to be used by the API currently, it returns an array of assignments always. This class +is included for completeness

                              + +
                              + + + + + + + + +

                              + Table of Contents + +

                              + +
                              +
                              + __construct() + +  : mixed +
                              +
                              + +
                              + getCurrencyAssignment() + +  : ChannelCurrencyAssignment +
                              +
                              + +
                              + + + + + + + +
                              +

                              + Methods + +

                              +
                              +

                              + __construct() + +

                              + + + + + public + __construct(ResponseInterface $response) : mixed + + +
                              Parameters
                              +
                              +
                              + $response + : ResponseInterface +
                              +
                              + +
                              +
                              + + + +
                              Return values
                              + mixed + — +
                              + + +
                              + +
                              + +
                              +
                              +
                              +
                              +

                              Search results

                              + +
                              +
                              +
                                +
                                +
                                +
                                +
                                +
                                + + +
                                + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelCurrencyAssignmentsResponse.html b/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelCurrencyAssignmentsResponse.html new file mode 100644 index 00000000..2ccd7309 --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelCurrencyAssignmentsResponse.html @@ -0,0 +1,337 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                +

                                Documentation

                                + + + + + +
                                + +
                                +
                                + + + + +
                                + + +
                                +

                                + ChannelCurrencyAssignmentsResponse + + + extends PaginatedBatchableResponse + + + + +

                                + + + + + + + + + + + + +

                                + Table of Contents + +

                                + +
                                +
                                + __construct() + +  : mixed +
                                +
                                + +
                                + buildFromMultipleResponses() + +  : static +
                                +
                                + +
                                + getCurrencyAssignments() + +  : array<string|int, ChannelCurrencyAssignment> +
                                +
                                + +
                                + getPagination() + +  : Pagination +
                                +
                                + +
                                + + + + + + + +
                                +

                                + Methods + +

                                +
                                +

                                + __construct() + +

                                + + + + + public + __construct(ResponseInterface $response) : mixed + + +
                                Parameters
                                +
                                +
                                + $response + : ResponseInterface +
                                +
                                + +
                                +
                                + + + +
                                Return values
                                + mixed + — +
                                + + +
                                +
                                +

                                + buildFromMultipleResponses() + +

                                + + + + + public + static buildFromMultipleResponses(array<string|int, ResponseInterface$responses) : static + +
                                + +
                                Parameters
                                +
                                +
                                + $responses + : array<string|int, ResponseInterface> +
                                +
                                +
                                + +
                                +
                                + + + +
                                Return values
                                + static + — +
                                + + +
                                + + +
                                + +
                                +
                                +
                                +
                                +

                                Search results

                                + +
                                +
                                +
                                  +
                                  +
                                  +
                                  +
                                  +
                                  + + +
                                  + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelListingResponse.html b/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelListingResponse.html new file mode 100644 index 00000000..0329ff05 --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelListingResponse.html @@ -0,0 +1,246 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                  +

                                  Documentation

                                  + + + + + +
                                  + +
                                  +
                                  + + + + +
                                  + + +
                                  +

                                  + ChannelListingResponse + + + extends SingleResourceResponse + + + + +

                                  + + + + + + + + + + + + +

                                  + Table of Contents + +

                                  + +
                                  +
                                  + __construct() + +  : mixed +
                                  +
                                  + +
                                  + getChannelListing() + +  : ChannelListing +
                                  +
                                  + +
                                  + + + + + + + +
                                  +

                                  + Methods + +

                                  +
                                  +

                                  + __construct() + +

                                  + + + + + public + __construct(ResponseInterface $response) : mixed + + +
                                  Parameters
                                  +
                                  +
                                  + $response + : ResponseInterface +
                                  +
                                  + +
                                  +
                                  + + + +
                                  Return values
                                  + mixed + — +
                                  + + +
                                  + +
                                  + +
                                  +
                                  +
                                  +
                                  +

                                  Search results

                                  + +
                                  +
                                  +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    + + +
                                    + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelListingsResponse.html b/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelListingsResponse.html new file mode 100644 index 00000000..1fdbf951 --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelListingsResponse.html @@ -0,0 +1,286 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                    +

                                    Documentation

                                    + + + + + +
                                    + +
                                    +
                                    + + + + +
                                    + + +
                                    +

                                    + ChannelListingsResponse + + + extends PaginatedResponse + + + + +

                                    + + + + + + + + + + + + +

                                    + Table of Contents + +

                                    + +
                                    +
                                    + __construct() + +  : mixed +
                                    +
                                    + +
                                    + getChannelListings() + +  : array<string|int, ChannelListing> +
                                    +
                                    + +
                                    + getPagination() + +  : Pagination +
                                    +
                                    + +
                                    + + + + + + + +
                                    +

                                    + Methods + +

                                    +
                                    +

                                    + __construct() + +

                                    + + + + + public + __construct(ResponseInterface $response) : mixed + + +
                                    Parameters
                                    +
                                    +
                                    + $response + : ResponseInterface +
                                    +
                                    + +
                                    +
                                    + + + +
                                    Return values
                                    + mixed + — +
                                    + + +
                                    + + +
                                    + +
                                    +
                                    +
                                    +
                                    +

                                    Search results

                                    + +
                                    +
                                    +
                                      +
                                      +
                                      +
                                      +
                                      +
                                      + + +
                                      + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelResponse.html b/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelResponse.html new file mode 100644 index 00000000..0e3799e3 --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelResponse.html @@ -0,0 +1,246 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                      +

                                      Documentation

                                      + + + + + +
                                      + +
                                      +
                                      + + + + +
                                      + + +
                                      +

                                      + ChannelResponse + + + extends SingleResourceResponse + + + + +

                                      + + + + + + + + + + + + +

                                      + Table of Contents + +

                                      + +
                                      +
                                      + __construct() + +  : mixed +
                                      +
                                      + +
                                      + getChannel() + +  : Channel +
                                      +
                                      + +
                                      + + + + + + + +
                                      +

                                      + Methods + +

                                      +
                                      +

                                      + __construct() + +

                                      + + + + + public + __construct(ResponseInterface $response) : mixed + + +
                                      Parameters
                                      +
                                      +
                                      + $response + : ResponseInterface +
                                      +
                                      + +
                                      +
                                      + + + +
                                      Return values
                                      + mixed + — +
                                      + + +
                                      + +
                                      + +
                                      +
                                      +
                                      +
                                      +

                                      Search results

                                      + +
                                      +
                                      +
                                        +
                                        +
                                        +
                                        +
                                        +
                                        + + +
                                        + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelSiteResponse.html b/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelSiteResponse.html new file mode 100644 index 00000000..19fc807c --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelSiteResponse.html @@ -0,0 +1,246 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                        +

                                        Documentation

                                        + + + + + +
                                        + +
                                        +
                                        + + + + +
                                        + + +
                                        +

                                        + ChannelSiteResponse + + + extends SingleResourceResponse + + + + +

                                        + + + + + + + + + + + + +

                                        + Table of Contents + +

                                        + +
                                        +
                                        + __construct() + +  : mixed +
                                        +
                                        + +
                                        + getSite() + +  : ChannelSite +
                                        +
                                        + +
                                        + + + + + + + +
                                        +

                                        + Methods + +

                                        +
                                        +

                                        + __construct() + +

                                        + + + + + public + __construct(ResponseInterface $response) : mixed + + +
                                        Parameters
                                        +
                                        +
                                        + $response + : ResponseInterface +
                                        +
                                        + +
                                        +
                                        + + + +
                                        Return values
                                        + mixed + — +
                                        + + +
                                        + +
                                        + +
                                        +
                                        +
                                        +
                                        +

                                        Search results

                                        + +
                                        +
                                        +
                                          +
                                          +
                                          +
                                          +
                                          +
                                          + + +
                                          + + + + + + + diff --git a/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelsResponse.html b/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelsResponse.html new file mode 100644 index 00000000..1480fa22 --- /dev/null +++ b/docs/classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelsResponse.html @@ -0,0 +1,286 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                          +

                                          Documentation

                                          + + + + + +
                                          + +
                                          +
                                          + + + + +
                                          + + +
                                          +

                                          + ChannelsResponse + + + extends PaginatedResponse + + + + +

                                          + + + + + + + + + + + + +

                                          + Table of Contents + +

                                          + +
                                          +
                                          + __construct() + +  : mixed +
                                          +
                                          + +
                                          + getChannels() + +  : array<string|int, Channel> +
                                          +
                                          + +
                                          + getPagination() + +  : Pagination +
                                          +
                                          + +
                                          + + + + + + + +
                                          +

                                          + Methods + +

                                          +
                                          +

                                          + __construct() + +

                                          + + + + + public + __construct(ResponseInterface $response) : mixed + + +
                                          Parameters
                                          +
                                          +
                                          + $response + : ResponseInterface +
                                          +
                                          + +
                                          +
                                          + + + +
                                          Return values
                                          + mixed + — +
                                          + + +
                                          +
                                          +

                                          + getChannels() + +

                                          + + + + + public + getChannels() : array<string|int, Channel> + +
                                          + + + + +
                                          Return values
                                          + array<string|int, Channel> + — +
                                          + + +
                                          + +
                                          + +
                                          +
                                          +
                                          +
                                          +

                                          Search results

                                          + +
                                          +
                                          +
                                            +
                                            +
                                            +
                                            +
                                            +
                                            + + +
                                            + + + + + + + diff --git a/docs/files/bigcommerce-api-carts-cartitemsapi.html b/docs/files/bigcommerce-api-carts-cartitemsapi.html index 35aa78d5..8ae40b94 100644 --- a/docs/files/bigcommerce-api-carts-cartitemsapi.html +++ b/docs/files/bigcommerce-api-carts-cartitemsapi.html @@ -96,7 +96,7 @@

                                            CartItemsApi
                                            -
                                            V3ApiBase
                                            +
                                            Cart Items API
                                            diff --git a/docs/files/bigcommerce-api-carts-cartredirecturlsapi.html b/docs/files/bigcommerce-api-carts-cartredirecturlsapi.html index 126e1f8d..7ecaea56 100644 --- a/docs/files/bigcommerce-api-carts-cartredirecturlsapi.html +++ b/docs/files/bigcommerce-api-carts-cartredirecturlsapi.html @@ -96,7 +96,7 @@

                                            CartRedirectUrlsApi
                                            -
                                            V3ApiBase
                                            +
                                            Cart Redirect URLS
                                            diff --git a/docs/files/bigcommerce-api-carts-cartsapi.html b/docs/files/bigcommerce-api-carts-cartsapi.html index b6818483..2a80f11c 100644 --- a/docs/files/bigcommerce-api-carts-cartsapi.html +++ b/docs/files/bigcommerce-api-carts-cartsapi.html @@ -96,7 +96,7 @@

                                            CartsApi
                                            -
                                            V3ApiBase
                                            +
                                            Carts API
                                            diff --git a/docs/files/bigcommerce-api-catalog-categories-categoryimageapi.html b/docs/files/bigcommerce-api-catalog-categories-categoryimageapi.html index 5e2ca524..e934d32a 100644 --- a/docs/files/bigcommerce-api-catalog-categories-categoryimageapi.html +++ b/docs/files/bigcommerce-api-catalog-categories-categoryimageapi.html @@ -96,7 +96,7 @@

                                            CategoryImageApi
                                            -
                                            V3ApiBase
                                            +
                                            Category Images API
                                            diff --git a/docs/files/bigcommerce-api-catalog-categories-categorymetafieldsapi.html b/docs/files/bigcommerce-api-catalog-categories-categorymetafieldsapi.html index 022e864a..30b9e0cd 100644 --- a/docs/files/bigcommerce-api-catalog-categories-categorymetafieldsapi.html +++ b/docs/files/bigcommerce-api-catalog-categories-categorymetafieldsapi.html @@ -96,7 +96,7 @@

                                            CategoryMetafieldsApi
                                            -
                                            V3ApiBase
                                            +
                                            Category Metafields API
                                            diff --git a/docs/files/bigcommerce-api-catalog-products-productmetafieldsapi.html b/docs/files/bigcommerce-api-catalog-products-productmetafieldsapi.html index 051b9abb..9d707cb9 100644 --- a/docs/files/bigcommerce-api-catalog-products-productmetafieldsapi.html +++ b/docs/files/bigcommerce-api-catalog-products-productmetafieldsapi.html @@ -96,7 +96,7 @@

                                            ProductMetafieldsApi
                                            -
                                            V3ApiBase
                                            +
                                            Product Metafields API
                                            diff --git a/docs/files/bigcommerce-api-channels-channelcurrencyassignmentsapi.html b/docs/files/bigcommerce-api-channels-channelcurrencyassignmentsapi.html new file mode 100644 index 00000000..8c8fdaca --- /dev/null +++ b/docs/files/bigcommerce-api-channels-channelcurrencyassignmentsapi.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                            +

                                            Documentation

                                            + + + + + +
                                            + +
                                            +
                                            + + + + +
                                            +
                                              +
                                            + +
                                            +

                                            ChannelCurrencyAssignmentsApi.php

                                            + + + + + + + + +

                                            + Interfaces, Classes and Traits + +

                                            + +
                                            + +
                                            ChannelCurrencyAssignmentsApi
                                            +
                                            Channel Currency Assignments API
                                            + +
                                            + + + + + + + + +
                                            +
                                            +
                                            +
                                            +

                                            Search results

                                            + +
                                            +
                                            +
                                              +
                                              +
                                              +
                                              +
                                              +
                                              + + +
                                              + + + + + + + diff --git a/docs/files/bigcommerce-api-channels-channellistingsapi.html b/docs/files/bigcommerce-api-channels-channellistingsapi.html new file mode 100644 index 00000000..b207d514 --- /dev/null +++ b/docs/files/bigcommerce-api-channels-channellistingsapi.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                              +

                                              Documentation

                                              + + + + + +
                                              + +
                                              +
                                              + + + + +
                                              +
                                                +
                                              + +
                                              +

                                              ChannelListingsApi.php

                                              + + + + + + + + +

                                              + Interfaces, Classes and Traits + +

                                              + +
                                              + +
                                              ChannelListingsApi
                                              +
                                              V3ApiBase
                                              + +
                                              + + + + + + + + +
                                              +
                                              +
                                              +
                                              +

                                              Search results

                                              + +
                                              +
                                              +
                                                +
                                                +
                                                +
                                                +
                                                +
                                                + + +
                                                + + + + + + + diff --git a/docs/files/bigcommerce-api-channels-channelsapi.html b/docs/files/bigcommerce-api-channels-channelsapi.html new file mode 100644 index 00000000..ecf0da29 --- /dev/null +++ b/docs/files/bigcommerce-api-channels-channelsapi.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                +

                                                Documentation

                                                + + + + + +
                                                + +
                                                +
                                                + + + + +
                                                +
                                                  +
                                                + +
                                                +

                                                ChannelsApi.php

                                                + + + + + + + + +

                                                + Interfaces, Classes and Traits + +

                                                + +
                                                + +
                                                ChannelsApi
                                                +
                                                V3ApiBase
                                                + +
                                                + + + + + + + + +
                                                +
                                                +
                                                +
                                                +

                                                Search results

                                                + +
                                                +
                                                +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  + + +
                                                  + + + + + + + diff --git a/docs/files/bigcommerce-api-channels-channelsitesapi.html b/docs/files/bigcommerce-api-channels-channelsitesapi.html new file mode 100644 index 00000000..a12854e8 --- /dev/null +++ b/docs/files/bigcommerce-api-channels-channelsitesapi.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                  +

                                                  Documentation

                                                  + + + + + +
                                                  + +
                                                  +
                                                  + + + + +
                                                  +
                                                    +
                                                  + +
                                                  +

                                                  ChannelSitesApi.php

                                                  + + + + + + + + +

                                                  + Interfaces, Classes and Traits + +

                                                  + +
                                                  + +
                                                  ChannelSitesApi
                                                  +
                                                  V3ApiBase
                                                  + +
                                                  + + + + + + + + +
                                                  +
                                                  +
                                                  +
                                                  +

                                                  Search results

                                                  + +
                                                  +
                                                  +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    + + +
                                                    + + + + + + + diff --git a/docs/files/bigcommerce-api-generic-batchcreateresource.html b/docs/files/bigcommerce-api-generic-batchcreateresource.html new file mode 100644 index 00000000..7518be2a --- /dev/null +++ b/docs/files/bigcommerce-api-generic-batchcreateresource.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                    +

                                                    Documentation

                                                    + + + + + +
                                                    + +
                                                    +
                                                    + + + + +
                                                    +
                                                      +
                                                    + +
                                                    +

                                                    BatchCreateResource.php

                                                    + + + + + + + + +

                                                    + Interfaces, Classes and Traits + +

                                                    + +
                                                    + + +
                                                    BatchCreateResource
                                                    +
                                                    +
                                                    + + + + + + + + +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Search results

                                                    + +
                                                    +
                                                    +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      + + +
                                                      + + + + + + + diff --git a/docs/files/bigcommerce-api-generic-resourceapinodelete.html b/docs/files/bigcommerce-api-generic-resourceapinodelete.html new file mode 100644 index 00000000..81d14b0e --- /dev/null +++ b/docs/files/bigcommerce-api-generic-resourceapinodelete.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                      +

                                                      Documentation

                                                      + + + + + +
                                                      + +
                                                      +
                                                      + + + + +
                                                      +
                                                        +
                                                      + +
                                                      +

                                                      ResourceApiNoDelete.php

                                                      + + + + + + + + +

                                                      + Interfaces, Classes and Traits + +

                                                      + +
                                                      + +
                                                      ResourceApiNoDelete
                                                      +
                                                      V3ApiBase
                                                      + +
                                                      + + + + + + + + +
                                                      +
                                                      +
                                                      +
                                                      +

                                                      Search results

                                                      + +
                                                      +
                                                      +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        + + +
                                                        + + + + + + + diff --git a/docs/files/bigcommerce-resourcemodels-channel-channel.html b/docs/files/bigcommerce-resourcemodels-channel-channel.html new file mode 100644 index 00000000..18e40adb --- /dev/null +++ b/docs/files/bigcommerce-resourcemodels-channel-channel.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                        +

                                                        Documentation

                                                        + + + + + +
                                                        + +
                                                        +
                                                        + + + + +
                                                        +
                                                          +
                                                        + +
                                                        +

                                                        Channel.php

                                                        + + + + + + + + +

                                                        + Interfaces, Classes and Traits + +

                                                        + +
                                                        + +
                                                        Channel
                                                        +
                                                        + +
                                                        + + + + + + + + +
                                                        +
                                                        +
                                                        +
                                                        +

                                                        Search results

                                                        + +
                                                        +
                                                        +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          + + +
                                                          + + + + + + + diff --git a/docs/files/bigcommerce-resourcemodels-channel-channelcurrencyassignment.html b/docs/files/bigcommerce-resourcemodels-channel-channelcurrencyassignment.html new file mode 100644 index 00000000..7368d959 --- /dev/null +++ b/docs/files/bigcommerce-resourcemodels-channel-channelcurrencyassignment.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                          +

                                                          Documentation

                                                          + + + + + +
                                                          + +
                                                          +
                                                          + + + + +
                                                          +
                                                            +
                                                          + +
                                                          +

                                                          ChannelCurrencyAssignment.php

                                                          + + + + + + + + +

                                                          + Interfaces, Classes and Traits + +

                                                          + +
                                                          + +
                                                          ChannelCurrencyAssignment
                                                          +
                                                          + +
                                                          + + + + + + + + +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Search results

                                                          + +
                                                          +
                                                          +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            + + +
                                                            + + + + + + + diff --git a/docs/files/bigcommerce-resourcemodels-channel-channellisting.html b/docs/files/bigcommerce-resourcemodels-channel-channellisting.html new file mode 100644 index 00000000..83d47959 --- /dev/null +++ b/docs/files/bigcommerce-resourcemodels-channel-channellisting.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                            +

                                                            Documentation

                                                            + + + + + +
                                                            + +
                                                            +
                                                            + + + + +
                                                            +
                                                              +
                                                            + +
                                                            +

                                                            ChannelListing.php

                                                            + + + + + + + + +

                                                            + Interfaces, Classes and Traits + +

                                                            + +
                                                            + +
                                                            ChannelListing
                                                            +
                                                            + +
                                                            + + + + + + + + +
                                                            +
                                                            +
                                                            +
                                                            +

                                                            Search results

                                                            + +
                                                            +
                                                            +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              + + +
                                                              + + + + + + + diff --git a/docs/files/bigcommerce-resourcemodels-channel-channellistingvariant.html b/docs/files/bigcommerce-resourcemodels-channel-channellistingvariant.html new file mode 100644 index 00000000..26592b35 --- /dev/null +++ b/docs/files/bigcommerce-resourcemodels-channel-channellistingvariant.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                              +

                                                              Documentation

                                                              + + + + + +
                                                              + +
                                                              +
                                                              + + + + +
                                                              +
                                                                +
                                                              + +
                                                              +

                                                              ChannelListingVariant.php

                                                              + + + + + + + + +

                                                              + Interfaces, Classes and Traits + +

                                                              + +
                                                              + +
                                                              ChannelListingVariant
                                                              +
                                                              + +
                                                              + + + + + + + + +
                                                              +
                                                              +
                                                              +
                                                              +

                                                              Search results

                                                              + +
                                                              +
                                                              +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                + + +
                                                                + + + + + + + diff --git a/docs/files/bigcommerce-resourcemodels-channel-channelsite.html b/docs/files/bigcommerce-resourcemodels-channel-channelsite.html new file mode 100644 index 00000000..4fb53656 --- /dev/null +++ b/docs/files/bigcommerce-resourcemodels-channel-channelsite.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                                +

                                                                Documentation

                                                                + + + + + +
                                                                + +
                                                                +
                                                                + + + + +
                                                                +
                                                                  +
                                                                + +
                                                                +

                                                                ChannelSite.php

                                                                + + + + + + + + +

                                                                + Interfaces, Classes and Traits + +

                                                                + +
                                                                + +
                                                                ChannelSite
                                                                +
                                                                + +
                                                                + + + + + + + + +
                                                                +
                                                                +
                                                                +
                                                                +

                                                                Search results

                                                                + +
                                                                +
                                                                +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + + + + + + + diff --git a/docs/files/bigcommerce-resourcemodels-channel-channelsiteroute.html b/docs/files/bigcommerce-resourcemodels-channel-channelsiteroute.html new file mode 100644 index 00000000..7184de90 --- /dev/null +++ b/docs/files/bigcommerce-resourcemodels-channel-channelsiteroute.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                                  +

                                                                  Documentation

                                                                  + + + + + +
                                                                  + +
                                                                  +
                                                                  + + + + +
                                                                  +
                                                                    +
                                                                  + +
                                                                  +

                                                                  ChannelSiteRoute.php

                                                                  + + + + + + + + +

                                                                  + Interfaces, Classes and Traits + +

                                                                  + +
                                                                  + +
                                                                  ChannelSiteRoute
                                                                  +
                                                                  + +
                                                                  + + + + + + + + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Search results

                                                                  + +
                                                                  +
                                                                  +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    + + +
                                                                    + + + + + + + diff --git a/docs/files/bigcommerce-resourcemodels-channel-channeltheme.html b/docs/files/bigcommerce-resourcemodels-channel-channeltheme.html new file mode 100644 index 00000000..efb2a971 --- /dev/null +++ b/docs/files/bigcommerce-resourcemodels-channel-channeltheme.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                                    +

                                                                    Documentation

                                                                    + + + + + +
                                                                    + +
                                                                    +
                                                                    + + + + +
                                                                    +
                                                                      +
                                                                    + +
                                                                    +

                                                                    ChannelTheme.php

                                                                    + + + + + + + + +

                                                                    + Interfaces, Classes and Traits + +

                                                                    + +
                                                                    + +
                                                                    ChannelTheme
                                                                    +
                                                                    + +
                                                                    + + + + + + + + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Search results

                                                                    + +
                                                                    +
                                                                    +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      + + +
                                                                      + + + + + + + diff --git a/docs/files/bigcommerce-responsemodels-channel-channelactivethemeresponse.html b/docs/files/bigcommerce-responsemodels-channel-channelactivethemeresponse.html new file mode 100644 index 00000000..25aa8f65 --- /dev/null +++ b/docs/files/bigcommerce-responsemodels-channel-channelactivethemeresponse.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                                      +

                                                                      Documentation

                                                                      + + + + + +
                                                                      + +
                                                                      +
                                                                      + + + + +
                                                                      +
                                                                        +
                                                                      + +
                                                                      +

                                                                      ChannelActiveThemeResponse.php

                                                                      + + + + + + + + +

                                                                      + Interfaces, Classes and Traits + +

                                                                      + +
                                                                      + +
                                                                      ChannelActiveThemeResponse
                                                                      +
                                                                      + +
                                                                      + + + + + + + + +
                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Search results

                                                                      + +
                                                                      +
                                                                      +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        + + +
                                                                        + + + + + + + diff --git a/docs/files/bigcommerce-responsemodels-channel-channelcurrencyassignmentresponse.html b/docs/files/bigcommerce-responsemodels-channel-channelcurrencyassignmentresponse.html new file mode 100644 index 00000000..bc689615 --- /dev/null +++ b/docs/files/bigcommerce-responsemodels-channel-channelcurrencyassignmentresponse.html @@ -0,0 +1,136 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                                        +

                                                                        Documentation

                                                                        + + + + + +
                                                                        + +
                                                                        +
                                                                        + + + + +
                                                                        +
                                                                          +
                                                                        + +
                                                                        +

                                                                        ChannelCurrencyAssignmentResponse.php

                                                                        + + + + + + + + +

                                                                        + Interfaces, Classes and Traits + +

                                                                        + +
                                                                        + +
                                                                        ChannelCurrencyAssignmentResponse
                                                                        +
                                                                        Note this doesn't seem to be used by the API currently, it returns an array of assignments always. This class +is included for completeness
                                                                        + +
                                                                        + + + + + + + + +
                                                                        +
                                                                        +
                                                                        +
                                                                        +

                                                                        Search results

                                                                        + +
                                                                        +
                                                                        +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          + + +
                                                                          + + + + + + + diff --git a/docs/files/bigcommerce-responsemodels-channel-channelcurrencyassignmentsresponse.html b/docs/files/bigcommerce-responsemodels-channel-channelcurrencyassignmentsresponse.html new file mode 100644 index 00000000..48f76589 --- /dev/null +++ b/docs/files/bigcommerce-responsemodels-channel-channelcurrencyassignmentsresponse.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                                          +

                                                                          Documentation

                                                                          + + + + + +
                                                                          + +
                                                                          +
                                                                          + + + + +
                                                                          +
                                                                            +
                                                                          + + +
                                                                          +
                                                                          +
                                                                          +

                                                                          Search results

                                                                          + +
                                                                          +
                                                                          +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            + + +
                                                                            + + + + + + + diff --git a/docs/files/bigcommerce-responsemodels-channel-channellistingresponse.html b/docs/files/bigcommerce-responsemodels-channel-channellistingresponse.html new file mode 100644 index 00000000..983ef835 --- /dev/null +++ b/docs/files/bigcommerce-responsemodels-channel-channellistingresponse.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                                            +

                                                                            Documentation

                                                                            + + + + + +
                                                                            + +
                                                                            +
                                                                            + + + + +
                                                                            +
                                                                              +
                                                                            + +
                                                                            +

                                                                            ChannelListingResponse.php

                                                                            + + + + + + + + +

                                                                            + Interfaces, Classes and Traits + +

                                                                            + +
                                                                            + +
                                                                            ChannelListingResponse
                                                                            +
                                                                            + +
                                                                            + + + + + + + + +
                                                                            +
                                                                            +
                                                                            +
                                                                            +

                                                                            Search results

                                                                            + +
                                                                            +
                                                                            +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              + + +
                                                                              + + + + + + + diff --git a/docs/files/bigcommerce-responsemodels-channel-channellistingsresponse.html b/docs/files/bigcommerce-responsemodels-channel-channellistingsresponse.html new file mode 100644 index 00000000..17ff0665 --- /dev/null +++ b/docs/files/bigcommerce-responsemodels-channel-channellistingsresponse.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                                              +

                                                                              Documentation

                                                                              + + + + + +
                                                                              + +
                                                                              +
                                                                              + + + + +
                                                                              +
                                                                                +
                                                                              + +
                                                                              +

                                                                              ChannelListingsResponse.php

                                                                              + + + + + + + + +

                                                                              + Interfaces, Classes and Traits + +

                                                                              + +
                                                                              + +
                                                                              ChannelListingsResponse
                                                                              +
                                                                              + +
                                                                              + + + + + + + + +
                                                                              +
                                                                              +
                                                                              +
                                                                              +

                                                                              Search results

                                                                              + +
                                                                              +
                                                                              +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                + + +
                                                                                + + + + + + + diff --git a/docs/files/bigcommerce-responsemodels-channel-channelresponse.html b/docs/files/bigcommerce-responsemodels-channel-channelresponse.html new file mode 100644 index 00000000..6247b35b --- /dev/null +++ b/docs/files/bigcommerce-responsemodels-channel-channelresponse.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                                                +

                                                                                Documentation

                                                                                + + + + + +
                                                                                + +
                                                                                +
                                                                                + + + + +
                                                                                +
                                                                                  +
                                                                                + +
                                                                                +

                                                                                ChannelResponse.php

                                                                                + + + + + + + + +

                                                                                + Interfaces, Classes and Traits + +

                                                                                + +
                                                                                + +
                                                                                ChannelResponse
                                                                                +
                                                                                + +
                                                                                + + + + + + + + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +

                                                                                Search results

                                                                                + +
                                                                                +
                                                                                +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  + + +
                                                                                  + + + + + + + diff --git a/docs/files/bigcommerce-responsemodels-channel-channelsiteresponse.html b/docs/files/bigcommerce-responsemodels-channel-channelsiteresponse.html new file mode 100644 index 00000000..a0b07824 --- /dev/null +++ b/docs/files/bigcommerce-responsemodels-channel-channelsiteresponse.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                                                  +

                                                                                  Documentation

                                                                                  + + + + + +
                                                                                  + +
                                                                                  +
                                                                                  + + + + +
                                                                                  +
                                                                                    +
                                                                                  + +
                                                                                  +

                                                                                  ChannelSiteResponse.php

                                                                                  + + + + + + + + +

                                                                                  + Interfaces, Classes and Traits + +

                                                                                  + +
                                                                                  + +
                                                                                  ChannelSiteResponse
                                                                                  +
                                                                                  + +
                                                                                  + + + + + + + + +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +

                                                                                  Search results

                                                                                  + +
                                                                                  +
                                                                                  +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    + + +
                                                                                    + + + + + + + diff --git a/docs/files/bigcommerce-responsemodels-channel-channelsresponse.html b/docs/files/bigcommerce-responsemodels-channel-channelsresponse.html new file mode 100644 index 00000000..9c5c327a --- /dev/null +++ b/docs/files/bigcommerce-responsemodels-channel-channelsresponse.html @@ -0,0 +1,135 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                                                    +

                                                                                    Documentation

                                                                                    + + + + + +
                                                                                    + +
                                                                                    +
                                                                                    + + + + +
                                                                                    +
                                                                                      +
                                                                                    + +
                                                                                    +

                                                                                    ChannelsResponse.php

                                                                                    + + + + + + + + +

                                                                                    + Interfaces, Classes and Traits + +

                                                                                    + +
                                                                                    + +
                                                                                    ChannelsResponse
                                                                                    +
                                                                                    + +
                                                                                    + + + + + + + + +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +

                                                                                    Search results

                                                                                    + +
                                                                                    +
                                                                                    +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + + +
                                                                                      + + + + + + + diff --git a/docs/indices/files.html b/docs/indices/files.html index 524ae177..c0156c2d 100644 --- a/docs/indices/files.html +++ b/docs/indices/files.html @@ -84,6 +84,7 @@

                                                                                      A

                                                                                      B

                                                                                        +
                                                                                      • BatchCreateResource.php
                                                                                      • BatchUpdateResource.php
                                                                                      • Brand.php
                                                                                      • BrandImageApi.php
                                                                                      • @@ -117,6 +118,25 @@

                                                                                        C

                                                                                      • CategoryResponse.php
                                                                                      • CategoryTreeBranch.php
                                                                                      • CategoryTreeResponse.php
                                                                                      • +
                                                                                      • Channel.php
                                                                                      • +
                                                                                      • ChannelActiveThemeResponse.php
                                                                                      • +
                                                                                      • ChannelCurrencyAssignment.php
                                                                                      • +
                                                                                      • ChannelCurrencyAssignmentResponse.php
                                                                                      • +
                                                                                      • ChannelCurrencyAssignmentsApi.php
                                                                                      • +
                                                                                      • ChannelCurrencyAssignmentsResponse.php
                                                                                      • +
                                                                                      • ChannelListing.php
                                                                                      • +
                                                                                      • ChannelListingResponse.php
                                                                                      • +
                                                                                      • ChannelListingVariant.php
                                                                                      • +
                                                                                      • ChannelListingsApi.php
                                                                                      • +
                                                                                      • ChannelListingsResponse.php
                                                                                      • +
                                                                                      • ChannelResponse.php
                                                                                      • +
                                                                                      • ChannelSite.php
                                                                                      • +
                                                                                      • ChannelSiteResponse.php
                                                                                      • +
                                                                                      • ChannelSiteRoute.php
                                                                                      • +
                                                                                      • ChannelSitesApi.php
                                                                                      • +
                                                                                      • ChannelTheme.php
                                                                                      • +
                                                                                      • ChannelsApi.php
                                                                                      • +
                                                                                      • ChannelsResponse.php
                                                                                      • Client.php
                                                                                      • ComplexRule.php
                                                                                      • ComplexRuleConditions.php
                                                                                      • @@ -277,6 +297,7 @@

                                                                                        R

                                                                                      • RegionApi.php
                                                                                      • RegionsResponse.php
                                                                                      • ResourceApi.php
                                                                                      • +
                                                                                      • ResourceApiNoDelete.php
                                                                                      • ResourceImageApi.php
                                                                                      • ResourceModel.php
                                                                                      • ResourceWithBatchUpdateApi.php
                                                                                      • diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js index 9f8d693b..4f0265b8 100644 --- a/docs/js/searchIndex.js +++ b/docs/js/searchIndex.js @@ -3,7 +3,7 @@ Search.appendIndex( { "fqsen": "\\BigCommerce\\ApiV3\\Api\\Carts\\CartItemsApi", "name": "CartItemsApi", - "summary": "V3ApiBase", + "summary": "Cart\u0020Items\u0020API", "url": "classes/BigCommerce-ApiV3-Api-Carts-CartItemsApi.html" }, { "fqsen": "\\BigCommerce\\ApiV3\\Api\\Carts\\CartItemsApi\u003A\u003Aadd\u0028\u0029", @@ -43,7 +43,7 @@ Search.appendIndex( }, { "fqsen": "\\BigCommerce\\ApiV3\\Api\\Carts\\CartRedirectUrlsApi", "name": "CartRedirectUrlsApi", - "summary": "V3ApiBase", + "summary": "Cart\u0020Redirect\u0020URLS", "url": "classes/BigCommerce-ApiV3-Api-Carts-CartRedirectUrlsApi.html" }, { "fqsen": "\\BigCommerce\\ApiV3\\Api\\Carts\\CartRedirectUrlsApi\u003A\u003Acreate\u0028\u0029", @@ -53,7 +53,7 @@ Search.appendIndex( }, { "fqsen": "\\BigCommerce\\ApiV3\\Api\\Carts\\CartsApi", "name": "CartsApi", - "summary": "V3ApiBase", + "summary": "Carts\u0020API", "url": "classes/BigCommerce-ApiV3-Api-Carts-CartsApi.html" }, { "fqsen": "\\BigCommerce\\ApiV3\\Api\\Carts\\CartsApi\u003A\u003Aget\u0028\u0029", @@ -228,7 +228,7 @@ Search.appendIndex( }, { "fqsen": "\\BigCommerce\\ApiV3\\Api\\Catalog\\Categories\\CategoryImageApi", "name": "CategoryImageApi", - "summary": "V3ApiBase", + "summary": "Category\u0020Images\u0020API", "url": "classes/BigCommerce-ApiV3-Api-Catalog-Categories-CategoryImageApi.html" }, { "fqsen": "\\BigCommerce\\ApiV3\\Api\\Catalog\\Categories\\CategoryImageApi\u003A\u003ACATEGORY_IMAGE_ENDPOINT", @@ -238,7 +238,7 @@ Search.appendIndex( }, { "fqsen": "\\BigCommerce\\ApiV3\\Api\\Catalog\\Categories\\CategoryMetafieldsApi", "name": "CategoryMetafieldsApi", - "summary": "V3ApiBase", + "summary": "Category\u0020Metafields\u0020API", "url": "classes/BigCommerce-ApiV3-Api-Catalog-Categories-CategoryMetafieldsApi.html" }, { "fqsen": "\\BigCommerce\\ApiV3\\Api\\Catalog\\Categories\\CategoryMetafieldsApi\u003A\u003Aget\u0028\u0029", @@ -563,7 +563,7 @@ Search.appendIndex( }, { "fqsen": "\\BigCommerce\\ApiV3\\Api\\Catalog\\Products\\ProductMetafieldsApi", "name": "ProductMetafieldsApi", - "summary": "V3ApiBase", + "summary": "Product\u0020Metafields\u0020API", "url": "classes/BigCommerce-ApiV3-Api-Catalog-Products-ProductMetafieldsApi.html" }, { "fqsen": "\\BigCommerce\\ApiV3\\Api\\Catalog\\Products\\ProductMetafieldsApi\u003A\u003Aget\u0028\u0029", @@ -1220,6 +1220,16 @@ Search.appendIndex( "name": "consent", "summary": "", "url": "classes/BigCommerce-ApiV3-Api-Customers-CustomersApi.html#method_consent" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Customers\\CustomersApi\u003A\u003Asubscriber\u0028\u0029", + "name": "subscriber", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Customers-CustomersApi.html#method_subscriber" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Customers\\CustomersApi\u003A\u003Asubscribers\u0028\u0029", + "name": "subscribers", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Customers-CustomersApi.html#method_subscribers" }, { "fqsen": "\\BigCommerce\\ApiV3\\Api\\Customers\\CustomersApi\u003A\u003AFILTER__EMAIL_IN", "name": "FILTER__EMAIL_IN", @@ -2275,6 +2285,16 @@ Search.appendIndex( "name": "customTemplateAssociations", "summary": "", "url": "classes/BigCommerce-ApiV3-Client.html#method_customTemplateAssociations" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Client\u003A\u003Achannel\u0028\u0029", + "name": "channel", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Client.html#method_channel" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Client\u003A\u003Achannels\u0028\u0029", + "name": "channels", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Client.html#method_channels" }, { "fqsen": "\\BigCommerce\\ApiV3\\Client\u003A\u003ADEFAULT_HANDLER", "name": "DEFAULT_HANDLER", @@ -6050,6 +6070,741 @@ Search.appendIndex( "name": "getTemplates", "summary": "", "url": "classes/BigCommerce-ApiV3-ResponseModels-Widget-WidgetTemplatesResponse.html#method_getTemplates" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelCurrencyAssignmentsApi", + "name": "ChannelCurrencyAssignmentsApi", + "summary": "Channel\u0020Currency\u0020Assignments\u0020API", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelCurrencyAssignmentsApi.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelCurrencyAssignmentsApi\u003A\u003Acreate\u0028\u0029", + "name": "create", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelCurrencyAssignmentsApi.html#method_create" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelCurrencyAssignmentsApi\u003A\u003Aupdate\u0028\u0029", + "name": "update", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelCurrencyAssignmentsApi.html#method_update" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelCurrencyAssignmentsApi\u003A\u003AbatchCreate\u0028\u0029", + "name": "batchCreate", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelCurrencyAssignmentsApi.html#method_batchCreate" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelCurrencyAssignmentsApi\u003A\u003AbatchUpdate\u0028\u0029", + "name": "batchUpdate", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelCurrencyAssignmentsApi.html#method_batchUpdate" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelCurrencyAssignmentsApi\u003A\u003AgetAll\u0028\u0029", + "name": "getAll", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelCurrencyAssignmentsApi.html#method_getAll" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelCurrencyAssignmentsApi\u003A\u003AmultipleResourceUrl\u0028\u0029", + "name": "multipleResourceUrl", + "summary": "Currency\u0020Assignment\u0020endpoints\u0020are\u0020different,\u0020they\u0020are\u0020all\u0020multiple\u0020resource\u0020endpoints,\u0020that\u0020may\u0020or\u0020may\u0020not\nbe\u0020filtered\u0020by\u0020channel\u0020id.", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelCurrencyAssignmentsApi.html#method_multipleResourceUrl" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelCurrencyAssignmentsApi\u003A\u003AsingleResourceUrl\u0028\u0029", + "name": "singleResourceUrl", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelCurrencyAssignmentsApi.html#method_singleResourceUrl" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelListingsApi", + "name": "ChannelListingsApi", + "summary": "V3ApiBase", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelListingsApi.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelListingsApi\u003A\u003Aget\u0028\u0029", + "name": "get", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelListingsApi.html#method_get" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelListingsApi\u003A\u003AgetAll\u0028\u0029", + "name": "getAll", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelListingsApi.html#method_getAll" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelListingsApi\u003A\u003Adelete\u0028\u0029", + "name": "delete", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelListingsApi.html#method_delete" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelListingsApi\u003A\u003Acreate\u0028\u0029", + "name": "create", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelListingsApi.html#method_create" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelListingsApi\u003A\u003Aupdate\u0028\u0029", + "name": "update", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelListingsApi.html#method_update" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelsApi", + "name": "ChannelsApi", + "summary": "V3ApiBase", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelsApi.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelsApi\u003A\u003Aget\u0028\u0029", + "name": "get", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelsApi.html#method_get" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelsApi\u003A\u003AgetAll\u0028\u0029", + "name": "getAll", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelsApi.html#method_getAll" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelsApi\u003A\u003Adelete\u0028\u0029", + "name": "delete", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelsApi.html#method_delete" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelsApi\u003A\u003AgetActiveTheme\u0028\u0029", + "name": "getActiveTheme", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelsApi.html#method_getActiveTheme" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelsApi\u003A\u003Acreate\u0028\u0029", + "name": "create", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelsApi.html#method_create" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelsApi\u003A\u003Aupdate\u0028\u0029", + "name": "update", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelsApi.html#method_update" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelsApi\u003A\u003Alisting\u0028\u0029", + "name": "listing", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelsApi.html#method_listing" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelsApi\u003A\u003Alistings\u0028\u0029", + "name": "listings", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelsApi.html#method_listings" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelsApi\u003A\u003Asite\u0028\u0029", + "name": "site", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelsApi.html#method_site" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelsApi\u003A\u003AcurrencyAssignments\u0028\u0029", + "name": "currencyAssignments", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelsApi.html#method_currencyAssignments" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelsApi\u003A\u003AINCLUDE__CURRENCIES", + "name": "INCLUDE__CURRENCIES", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelsApi.html#constant_INCLUDE__CURRENCIES" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelSitesApi", + "name": "ChannelSitesApi", + "summary": "V3ApiBase", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelSitesApi.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelSitesApi\u003A\u003Aget\u0028\u0029", + "name": "get", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelSitesApi.html#method_get" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelSitesApi\u003A\u003Acreate\u0028\u0029", + "name": "create", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelSitesApi.html#method_create" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelSitesApi\u003A\u003Aupdate\u0028\u0029", + "name": "update", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelSitesApi.html#method_update" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelSitesApi\u003A\u003AmultipleResourceUrl\u0028\u0029", + "name": "multipleResourceUrl", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelSitesApi.html#method_multipleResourceUrl" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels\\ChannelSitesApi\u003A\u003AsingleResourceUrl\u0028\u0029", + "name": "singleResourceUrl", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Channels-ChannelSitesApi.html#method_singleResourceUrl" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Generic\\BatchCreateResource", + "name": "BatchCreateResource", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Generic-BatchCreateResource.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Generic\\BatchCreateResource\u003A\u003AbatchCreate\u0028\u0029", + "name": "batchCreate", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Generic-BatchCreateResource.html#method_batchCreate" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Generic\\BatchCreateResource\u003A\u003AgetClient\u0028\u0029", + "name": "getClient", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Generic-BatchCreateResource.html#method_getClient" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Generic\\ResourceApiNoDelete", + "name": "ResourceApiNoDelete", + "summary": "V3ApiBase", + "url": "classes/BigCommerce-ApiV3-Api-Generic-ResourceApiNoDelete.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Generic\\ResourceApiNoDelete\u003A\u003Aget\u0028\u0029", + "name": "get", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Generic-ResourceApiNoDelete.html#method_get" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Generic\\ResourceApiNoDelete\u003A\u003AgetAll\u0028\u0029", + "name": "getAll", + "summary": "", + "url": "classes/BigCommerce-ApiV3-Api-Generic-ResourceApiNoDelete.html#method_getAll" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel", + "name": "Channel", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003ATYPE__POS", + "name": "TYPE__POS", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_TYPE__POS" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003ATYPE__MARKETPLACE", + "name": "TYPE__MARKETPLACE", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_TYPE__MARKETPLACE" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003ATYPE__STOREFRONT", + "name": "TYPE__STOREFRONT", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_TYPE__STOREFRONT" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003ATYPE__MARKETING", + "name": "TYPE__MARKETING", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_TYPE__MARKETING" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003APLATFORM__BIGCOMMERCE", + "name": "PLATFORM__BIGCOMMERCE", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_PLATFORM__BIGCOMMERCE" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003APLATFORM__ACQUIA", + "name": "PLATFORM__ACQUIA", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_PLATFORM__ACQUIA" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003APLATFORM__BLOOMREACH", + "name": "PLATFORM__BLOOMREACH", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_PLATFORM__BLOOMREACH" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003APLATFORM__DEITY", + "name": "PLATFORM__DEITY", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_PLATFORM__DEITY" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003APLATFORM__DRUPAL", + "name": "PLATFORM__DRUPAL", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_PLATFORM__DRUPAL" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003APLATFORM__NEXT", + "name": "PLATFORM__NEXT", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_PLATFORM__NEXT" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003APLATFORM__WORDPRESS", + "name": "PLATFORM__WORDPRESS", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_PLATFORM__WORDPRESS" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003APLATFORM__AMAZON", + "name": "PLATFORM__AMAZON", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_PLATFORM__AMAZON" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003APLATFORM__EBAY", + "name": "PLATFORM__EBAY", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_PLATFORM__EBAY" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003APLATFORM__FACEBOOK", + "name": "PLATFORM__FACEBOOK", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_PLATFORM__FACEBOOK" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003APLATFORM__GOOGLE_SHOPPING", + "name": "PLATFORM__GOOGLE_SHOPPING", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_PLATFORM__GOOGLE_SHOPPING" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003APLATFORM__CLOVER", + "name": "PLATFORM__CLOVER", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_PLATFORM__CLOVER" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003APLATFORM__SQUARE", + "name": "PLATFORM__SQUARE", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_PLATFORM__SQUARE" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003APLATFORM__VEND", + "name": "PLATFORM__VEND", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_PLATFORM__VEND" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003APLATFORM__CUSTOM", + "name": "PLATFORM__CUSTOM", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_PLATFORM__CUSTOM" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003ASTATUS__ACTIVE", + "name": "STATUS__ACTIVE", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_STATUS__ACTIVE" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003ASTATUS__PRELAUNCH", + "name": "STATUS__PRELAUNCH", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_STATUS__PRELAUNCH" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003ASTATUS__INACTIVE", + "name": "STATUS__INACTIVE", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_STATUS__INACTIVE" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003ASTATUS__CONNECTED", + "name": "STATUS__CONNECTED", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_STATUS__CONNECTED" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003ASTATUS__DISCONNECTED", + "name": "STATUS__DISCONNECTED", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#constant_STATUS__DISCONNECTED" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003A\u0024id", + "name": "id", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#property_id" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003A\u0024type", + "name": "type", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#property_type" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003A\u0024platform", + "name": "platform", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#property_platform" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003A\u0024date_created", + "name": "date_created", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#property_date_created" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003A\u0024date_modified", + "name": "date_modified", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#property_date_modified" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003A\u0024config_meta", + "name": "config_meta", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#property_config_meta" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003A\u0024external_id", + "name": "external_id", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#property_external_id" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003A\u0024is_listable_from_ui", + "name": "is_listable_from_ui", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#property_is_listable_from_ui" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003A\u0024is_visible", + "name": "is_visible", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#property_is_visible" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003A\u0024name", + "name": "name", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#property_name" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\Channel\u003A\u003A\u0024status", + "name": "status", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-Channel.html#property_status" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelCurrencyAssignment", + "name": "ChannelCurrencyAssignment", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelCurrencyAssignment.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelCurrencyAssignment\u003A\u003A\u0024channel_id", + "name": "channel_id", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelCurrencyAssignment.html#property_channel_id" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelCurrencyAssignment\u003A\u003A\u0024enabled_currencies", + "name": "enabled_currencies", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelCurrencyAssignment.html#property_enabled_currencies" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelCurrencyAssignment\u003A\u003A\u0024default_currency", + "name": "default_currency", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelCurrencyAssignment.html#property_default_currency" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListing", + "name": "ChannelListing", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListing.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListing\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListing.html#method___construct" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListing\u003A\u003A\u0024channel_id", + "name": "channel_id", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListing.html#property_channel_id" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListing\u003A\u003A\u0024product_id", + "name": "product_id", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListing.html#property_product_id" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListing\u003A\u003A\u0024listing_id", + "name": "listing_id", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListing.html#property_listing_id" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListing\u003A\u003A\u0024external_id", + "name": "external_id", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListing.html#property_external_id" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListing\u003A\u003A\u0024name", + "name": "name", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListing.html#property_name" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListing\u003A\u003A\u0024description", + "name": "description", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListing.html#property_description" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListing\u003A\u003A\u0024state", + "name": "state", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListing.html#property_state" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListing\u003A\u003A\u0024date_created", + "name": "date_created", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListing.html#property_date_created" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListing\u003A\u003A\u0024date_modified", + "name": "date_modified", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListing.html#property_date_modified" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListing\u003A\u003A\u0024variants", + "name": "variants", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListing.html#property_variants" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListingVariant", + "name": "ChannelListingVariant", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListingVariant.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListingVariant\u003A\u003A\u0024channel_id", + "name": "channel_id", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListingVariant.html#property_channel_id" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListingVariant\u003A\u003A\u0024product_id", + "name": "product_id", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListingVariant.html#property_product_id" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListingVariant\u003A\u003A\u0024variant_id", + "name": "variant_id", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListingVariant.html#property_variant_id" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListingVariant\u003A\u003A\u0024external_id", + "name": "external_id", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListingVariant.html#property_external_id" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListingVariant\u003A\u003A\u0024name", + "name": "name", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListingVariant.html#property_name" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListingVariant\u003A\u003A\u0024description", + "name": "description", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListingVariant.html#property_description" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListingVariant\u003A\u003A\u0024state", + "name": "state", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListingVariant.html#property_state" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListingVariant\u003A\u003A\u0024date_created", + "name": "date_created", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListingVariant.html#property_date_created" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelListingVariant\u003A\u003A\u0024date_modified", + "name": "date_modified", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelListingVariant.html#property_date_modified" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelSite", + "name": "ChannelSite", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSite.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelSite\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSite.html#method___construct" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelSite\u003A\u003A\u0024id", + "name": "id", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSite.html#property_id" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelSite\u003A\u003A\u0024url", + "name": "url", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSite.html#property_url" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelSite\u003A\u003A\u0024channel_id", + "name": "channel_id", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSite.html#property_channel_id" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelSite\u003A\u003A\u0024created_at", + "name": "created_at", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSite.html#property_created_at" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelSite\u003A\u003A\u0024updated_at", + "name": "updated_at", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSite.html#property_updated_at" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelSite\u003A\u003A\u0024routes", + "name": "routes", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSite.html#property_routes" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelSiteRoute", + "name": "ChannelSiteRoute", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSiteRoute.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelSiteRoute\u003A\u003A\u0024id", + "name": "id", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSiteRoute.html#property_id" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelSiteRoute\u003A\u003A\u0024type", + "name": "type", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSiteRoute.html#property_type" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelSiteRoute\u003A\u003A\u0024matching", + "name": "matching", + "summary": "For\u0020a\u0020given\u0020type,\u0020which\u0020resources\u0020should\u0020match\u0020this\u0020route\u003F\u0020e.g\u0020For\u0020a\u0020route\u0020with\u0020the\u0020type\u003A\u0020\u201Cproduct\u201D\u0020and\u0020matching\u003A\n\u201C5\u201D\u0020this\u0020route\u0020would\u0020be\u0020used\u0020for\u0020the\u0020product\u0020with\u0020the\u0020ID\u0020of\u00205.", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSiteRoute.html#property_matching" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelSiteRoute\u003A\u003A\u0024route", + "name": "route", + "summary": "The\u0020route\u0020template\u0020that\u0020will\u0020be\u0020used\u0020to\u0020generate\u0020the\u0020URL\u0020for\u0020the\u0020requested\u0020resource.", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelSiteRoute.html#property_route" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme", + "name": "ChannelTheme", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024active_theme_uuid", + "name": "active_theme_uuid", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_active_theme_uuid" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024active_theme_configuration_uuid", + "name": "active_theme_configuration_uuid", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_active_theme_configuration_uuid" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024active_theme_version_uuid", + "name": "active_theme_version_uuid", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_active_theme_version_uuid" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024saved_theme_configuration_uuid", + "name": "saved_theme_configuration_uuid", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_saved_theme_configuration_uuid" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024active_theme_display_version", + "name": "active_theme_display_version", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_active_theme_display_version" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024active_theme_documentation_url", + "name": "active_theme_documentation_url", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_active_theme_documentation_url" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024active_theme_is_private", + "name": "active_theme_is_private", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_active_theme_is_private" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024active_theme_is_purchased", + "name": "active_theme_is_purchased", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_active_theme_is_purchased" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024active_theme_partner", + "name": "active_theme_partner", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_active_theme_partner" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024active_theme_style_editable", + "name": "active_theme_style_editable", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_active_theme_style_editable" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024active_theme_name", + "name": "active_theme_name", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_active_theme_name" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024active_theme_type", + "name": "active_theme_type", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_active_theme_type" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024active_theme_upgrade", + "name": "active_theme_upgrade", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_active_theme_upgrade" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024active_theme_update_available", + "name": "active_theme_update_available", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_active_theme_update_available" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024active_theme_screenshot", + "name": "active_theme_screenshot", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_active_theme_screenshot" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024active_theme_variation_count", + "name": "active_theme_variation_count", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_active_theme_variation_count" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel\\ChannelTheme\u003A\u003A\u0024active_theme_variation_name", + "name": "active_theme_variation_name", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResourceModels-Channel-ChannelTheme.html#property_active_theme_variation_name" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel\\ChannelActiveThemeResponse", + "name": "ChannelActiveThemeResponse", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelActiveThemeResponse.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel\\ChannelActiveThemeResponse\u003A\u003AgetChannelTheme\u0028\u0029", + "name": "getChannelTheme", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelActiveThemeResponse.html#method_getChannelTheme" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel\\ChannelCurrencyAssignmentResponse", + "name": "ChannelCurrencyAssignmentResponse", + "summary": "Note\u0020this\u0020doesn\u0027t\u0020seem\u0020to\u0020be\u0020used\u0020by\u0020the\u0020API\u0020currently,\u0020it\u0020returns\u0020an\u0020array\u0020of\u0020assignments\u0020always.\u0020This\u0020class\nis\u0020included\u0020for\u0020completeness", + "url": "classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelCurrencyAssignmentResponse.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel\\ChannelCurrencyAssignmentResponse\u003A\u003AgetCurrencyAssignment\u0028\u0029", + "name": "getCurrencyAssignment", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelCurrencyAssignmentResponse.html#method_getCurrencyAssignment" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel\\ChannelCurrencyAssignmentsResponse", + "name": "ChannelCurrencyAssignmentsResponse", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelCurrencyAssignmentsResponse.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel\\ChannelCurrencyAssignmentsResponse\u003A\u003AgetCurrencyAssignments\u0028\u0029", + "name": "getCurrencyAssignments", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelCurrencyAssignmentsResponse.html#method_getCurrencyAssignments" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel\\ChannelListingResponse", + "name": "ChannelListingResponse", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelListingResponse.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel\\ChannelListingResponse\u003A\u003AgetChannelListing\u0028\u0029", + "name": "getChannelListing", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelListingResponse.html#method_getChannelListing" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel\\ChannelListingsResponse", + "name": "ChannelListingsResponse", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelListingsResponse.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel\\ChannelListingsResponse\u003A\u003AgetChannelListings\u0028\u0029", + "name": "getChannelListings", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelListingsResponse.html#method_getChannelListings" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel\\ChannelResponse", + "name": "ChannelResponse", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelResponse.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel\\ChannelResponse\u003A\u003AgetChannel\u0028\u0029", + "name": "getChannel", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelResponse.html#method_getChannel" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel\\ChannelSiteResponse", + "name": "ChannelSiteResponse", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelSiteResponse.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel\\ChannelSiteResponse\u003A\u003AgetSite\u0028\u0029", + "name": "getSite", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelSiteResponse.html#method_getSite" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel\\ChannelsResponse", + "name": "ChannelsResponse", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelsResponse.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel\\ChannelsResponse\u003A\u003AgetChannels\u0028\u0029", + "name": "getChannels", + "summary": "", + "url": "classes/BigCommerce-ApiV3-ResponseModels-Channel-ChannelsResponse.html#method_getChannels" }, { "fqsen": "\\", "name": "\\", @@ -6100,6 +6855,11 @@ Search.appendIndex( "name": "ProductVariant", "summary": "", "url": "namespaces/bigcommerce-apiv3-api-catalog-products-productvariant.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\Api\\Channels", + "name": "Channels", + "summary": "", + "url": "namespaces/bigcommerce-apiv3-api-channels.html" }, { "fqsen": "\\BigCommerce\\ApiV3\\Api\\Customers", "name": "Customers", @@ -6185,6 +6945,11 @@ Search.appendIndex( "name": "Catalog", "summary": "", "url": "namespaces/bigcommerce-apiv3-resourcemodels-catalog.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Channel", + "name": "Channel", + "summary": "", + "url": "namespaces/bigcommerce-apiv3-resourcemodels-channel.html" }, { "fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Customer", "name": "Customer", @@ -6245,6 +7010,11 @@ Search.appendIndex( "name": "Category", "summary": "", "url": "namespaces/bigcommerce-apiv3-responsemodels-category.html" + }, { + "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels\\Channel", + "name": "Channel", + "summary": "", + "url": "namespaces/bigcommerce-apiv3-responsemodels-channel.html" }, { "fqsen": "\\BigCommerce\\ApiV3\\ResponseModels", "name": "ResponseModels", diff --git a/docs/namespaces/bigcommerce-apiv3-api-carts.html b/docs/namespaces/bigcommerce-apiv3-api-carts.html index 30f6a350..13b0eed9 100644 --- a/docs/namespaces/bigcommerce-apiv3-api-carts.html +++ b/docs/namespaces/bigcommerce-apiv3-api-carts.html @@ -94,11 +94,11 @@

                                                                                        CartItemsApi
                                                                                        -
                                                                                        V3ApiBase
                                                                                        +
                                                                                        Cart Items API
                                                                                        CartRedirectUrlsApi
                                                                                        -
                                                                                        V3ApiBase
                                                                                        +
                                                                                        Cart Redirect URLS
                                                                                        CartsApi
                                                                                        -
                                                                                        V3ApiBase
                                                                                        +
                                                                                        Carts API
                                                                                        diff --git a/docs/namespaces/bigcommerce-apiv3-api-catalog-categories.html b/docs/namespaces/bigcommerce-apiv3-api-catalog-categories.html index 34dbe6e6..cb9625ee 100644 --- a/docs/namespaces/bigcommerce-apiv3-api-catalog-categories.html +++ b/docs/namespaces/bigcommerce-apiv3-api-catalog-categories.html @@ -95,9 +95,9 @@

                                                                                        CategoryImageApi
                                                                                        -
                                                                                        V3ApiBase
                                                                                        +
                                                                                        Category Images API
                                                                                        CategoryMetafieldsApi
                                                                                        -
                                                                                        V3ApiBase
                                                                                        +
                                                                                        Category Metafields API
                                                                                        diff --git a/docs/namespaces/bigcommerce-apiv3-api-catalog-products.html b/docs/namespaces/bigcommerce-apiv3-api-catalog-products.html index ebea39ee..15f00d51 100644 --- a/docs/namespaces/bigcommerce-apiv3-api-catalog-products.html +++ b/docs/namespaces/bigcommerce-apiv3-api-catalog-products.html @@ -117,7 +117,7 @@

                                                                                        ProductImagesApi
                                                                                        V3ApiBase
                                                                                        ProductMetafieldsApi
                                                                                        -
                                                                                        V3ApiBase
                                                                                        +
                                                                                        Product Metafields API
                                                                                        ProductReviewsApi
                                                                                        V3ApiBase
                                                                                        ProductVideosApi
                                                                                        diff --git a/docs/namespaces/bigcommerce-apiv3-api-channels.html b/docs/namespaces/bigcommerce-apiv3-api-channels.html new file mode 100644 index 00000000..f9627319 --- /dev/null +++ b/docs/namespaces/bigcommerce-apiv3-api-channels.html @@ -0,0 +1,137 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                                                        +

                                                                                        Documentation

                                                                                        + + + + + +
                                                                                        + +
                                                                                        +
                                                                                        + + + + +
                                                                                        + + + +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Search results

                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          + + +
                                                                                          + + + + + + + diff --git a/docs/namespaces/bigcommerce-apiv3-api-generic.html b/docs/namespaces/bigcommerce-apiv3-api-generic.html index 422e3dc4..b1530a35 100644 --- a/docs/namespaces/bigcommerce-apiv3-api-generic.html +++ b/docs/namespaces/bigcommerce-apiv3-api-generic.html @@ -111,6 +111,8 @@

                                                                                          V3ApiBase
                                                                                          V3ApiBase
                                                                                          V3ApiBase
                                                                                          +
                                                                                          ResourceApiNoDelete
                                                                                          +
                                                                                          V3ApiBase
                                                                                          BatchUpdateResource
                                                                                          @@ -130,6 +132,8 @@

                                                                                          UpdateResource
                                                                                          +
                                                                                          BatchCreateResource
                                                                                          +
                                                                                          diff --git a/docs/namespaces/bigcommerce-apiv3-api.html b/docs/namespaces/bigcommerce-apiv3-api.html index f7446cbf..6cff5003 100644 --- a/docs/namespaces/bigcommerce-apiv3-api.html +++ b/docs/namespaces/bigcommerce-apiv3-api.html @@ -92,6 +92,7 @@

                                                                                          Carts
                                                                                          Catalog
                                                                                          +
                                                                                          Channels
                                                                                          Customers
                                                                                          CustomTemplateAssociations
                                                                                          Generic
                                                                                          diff --git a/docs/namespaces/bigcommerce-apiv3-resourcemodels-channel.html b/docs/namespaces/bigcommerce-apiv3-resourcemodels-channel.html new file mode 100644 index 00000000..5a5bd424 --- /dev/null +++ b/docs/namespaces/bigcommerce-apiv3-resourcemodels-channel.html @@ -0,0 +1,143 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                                                          +

                                                                                          Documentation

                                                                                          + + + + + +
                                                                                          + +
                                                                                          +
                                                                                          + + + + +
                                                                                          + + + +
                                                                                          +
                                                                                          +
                                                                                          +

                                                                                          Search results

                                                                                          + +
                                                                                          +
                                                                                          +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            + + +
                                                                                            + + + + + + + diff --git a/docs/namespaces/bigcommerce-apiv3-resourcemodels.html b/docs/namespaces/bigcommerce-apiv3-resourcemodels.html index 3d15ad48..4e54dba2 100644 --- a/docs/namespaces/bigcommerce-apiv3-resourcemodels.html +++ b/docs/namespaces/bigcommerce-apiv3-resourcemodels.html @@ -92,6 +92,7 @@

                                                                                            Cart
                                                                                            Catalog
                                                                                            +
                                                                                            Channel
                                                                                            Customer
                                                                                            CustomTemplateAssociation
                                                                                            Order
                                                                                            diff --git a/docs/namespaces/bigcommerce-apiv3-responsemodels-channel.html b/docs/namespaces/bigcommerce-apiv3-responsemodels-channel.html new file mode 100644 index 00000000..be39fc8f --- /dev/null +++ b/docs/namespaces/bigcommerce-apiv3-responsemodels-channel.html @@ -0,0 +1,146 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                                                            +

                                                                                            Documentation

                                                                                            + + + + + +
                                                                                            + +
                                                                                            +
                                                                                            + + + + +
                                                                                            + + + +
                                                                                            +
                                                                                            +
                                                                                            +

                                                                                            Search results

                                                                                            + +
                                                                                            +
                                                                                            +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              + + +
                                                                                              + + + + + + + diff --git a/docs/namespaces/bigcommerce-apiv3-responsemodels.html b/docs/namespaces/bigcommerce-apiv3-responsemodels.html index 0a1599d2..b2be38bd 100644 --- a/docs/namespaces/bigcommerce-apiv3-responsemodels.html +++ b/docs/namespaces/bigcommerce-apiv3-responsemodels.html @@ -93,6 +93,7 @@

                                                                                              Brand
                                                                                              Cart
                                                                                              Category
                                                                                              +
                                                                                              Channel
                                                                                              Customer
                                                                                              CustomTemplateAssociation
                                                                                              Meta
                                                                                              diff --git a/docs/packages/BigCommerce-ApiV3-Api-Carts.html b/docs/packages/BigCommerce-ApiV3-Api-Carts.html new file mode 100644 index 00000000..94f3df94 --- /dev/null +++ b/docs/packages/BigCommerce-ApiV3-Api-Carts.html @@ -0,0 +1,131 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                                                              +

                                                                                              Documentation

                                                                                              + + + + + +
                                                                                              + +
                                                                                              +
                                                                                              + + + + +
                                                                                              + + +
                                                                                              +

                                                                                              Carts

                                                                                              + + + +

                                                                                              + Interfaces, Classes and Traits + +

                                                                                              + +
                                                                                              + +
                                                                                              CartsApi
                                                                                              +
                                                                                              Carts API
                                                                                              + +
                                                                                              + + + + + + +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +

                                                                                              Search results

                                                                                              + +
                                                                                              +
                                                                                              +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                + + +
                                                                                                + + + + + + + diff --git a/docs/packages/BigCommerce-ApiV3-Api.html b/docs/packages/BigCommerce-ApiV3-Api.html new file mode 100644 index 00000000..99d1a737 --- /dev/null +++ b/docs/packages/BigCommerce-ApiV3-Api.html @@ -0,0 +1,127 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + +
                                                                                                +

                                                                                                Documentation

                                                                                                + + + + + +
                                                                                                + +
                                                                                                +
                                                                                                + + + + +
                                                                                                + + +
                                                                                                +

                                                                                                Api

                                                                                                + +

                                                                                                + Packages + +

                                                                                                + +
                                                                                                +
                                                                                                Carts
                                                                                                +
                                                                                                + + + + + + + + +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +

                                                                                                Search results

                                                                                                + +
                                                                                                +
                                                                                                +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  + + +
                                                                                                  + + + + + + + diff --git a/docs/packages/BigCommerce-ApiV3.html b/docs/packages/BigCommerce-ApiV3.html index f86e8f1f..0651b16f 100644 --- a/docs/packages/BigCommerce-ApiV3.html +++ b/docs/packages/BigCommerce-ApiV3.html @@ -88,6 +88,7 @@

                                                                                                  +
                                                                                                  Api
                                                                                                  ResourceModels
                                                                                                  diff --git a/docs/packages/BigCommerce.html b/docs/packages/BigCommerce.html index bd049721..9907e7ef 100644 --- a/docs/packages/BigCommerce.html +++ b/docs/packages/BigCommerce.html @@ -101,11 +101,9 @@

                                                                                                  CartItemsApi
                                                                                                  -
                                                                                                  V3ApiBase
                                                                                                  +
                                                                                                  Cart Items API
                                                                                                  CartRedirectUrlsApi
                                                                                                  -
                                                                                                  V3ApiBase
                                                                                                  -
                                                                                                  CartsApi
                                                                                                  -
                                                                                                  V3ApiBase
                                                                                                  +
                                                                                                  Cart Redirect URLS
                                                                                                  BrandImageApi
                                                                                                  Brand Images API
                                                                                                  BrandMetafieldsApi
                                                                                                  @@ -115,9 +113,9 @@

                                                                                                  CatalogApi
                                                                                                  CategoryImageApi
                                                                                                  -
                                                                                                  V3ApiBase
                                                                                                  +
                                                                                                  Category Images API
                                                                                                  CategoryMetafieldsApi
                                                                                                  -
                                                                                                  V3ApiBase
                                                                                                  +
                                                                                                  Category Metafields API
                                                                                                  CategoriesApi
                                                                                                  V3ApiBase
                                                                                                  ComplexRulesApi
                                                                                                  @@ -133,7 +131,7 @@

                                                                                                  ProductImagesApi
                                                                                                  V3ApiBase
                                                                                                  ProductMetafieldsApi
                                                                                                  -
                                                                                                  V3ApiBase
                                                                                                  +
                                                                                                  Product Metafields API
                                                                                                  ProductModifierImagesApi
                                                                                                  V3ApiBase
                                                                                                  ProductModifierValuesApi
                                                                                                  @@ -502,6 +500,47 @@

                                                                                                  WidgetTemplatesResponse
                                                                                                  +
                                                                                                  ChannelCurrencyAssignmentsApi
                                                                                                  +
                                                                                                  Channel Currency Assignments API
                                                                                                  +
                                                                                                  ChannelListingsApi
                                                                                                  +
                                                                                                  V3ApiBase
                                                                                                  +
                                                                                                  ChannelsApi
                                                                                                  +
                                                                                                  V3ApiBase
                                                                                                  +
                                                                                                  ChannelSitesApi
                                                                                                  +
                                                                                                  V3ApiBase
                                                                                                  +
                                                                                                  ResourceApiNoDelete
                                                                                                  +
                                                                                                  V3ApiBase
                                                                                                  +
                                                                                                  Channel
                                                                                                  +
                                                                                                  +
                                                                                                  ChannelCurrencyAssignment
                                                                                                  +
                                                                                                  +
                                                                                                  ChannelListing
                                                                                                  +
                                                                                                  +
                                                                                                  ChannelListingVariant
                                                                                                  +
                                                                                                  +
                                                                                                  ChannelSite
                                                                                                  +
                                                                                                  +
                                                                                                  ChannelSiteRoute
                                                                                                  +
                                                                                                  +
                                                                                                  ChannelTheme
                                                                                                  +
                                                                                                  +
                                                                                                  ChannelActiveThemeResponse
                                                                                                  +
                                                                                                  +
                                                                                                  ChannelCurrencyAssignmentResponse
                                                                                                  +
                                                                                                  Note this doesn't seem to be used by the API currently, it returns an array of assignments always. This class +is included for completeness
                                                                                                  +
                                                                                                  ChannelCurrencyAssignmentsResponse
                                                                                                  +
                                                                                                  +
                                                                                                  ChannelListingResponse
                                                                                                  +
                                                                                                  +
                                                                                                  ChannelListingsResponse
                                                                                                  +
                                                                                                  +
                                                                                                  ChannelResponse
                                                                                                  +
                                                                                                  +
                                                                                                  ChannelSiteResponse
                                                                                                  +
                                                                                                  +
                                                                                                  ChannelsResponse
                                                                                                  +
                                                                                                  ProductsSubResourceApi
                                                                                                  @@ -523,6 +562,8 @@

                                                                                                  UpdateResource
                                                                                                  +
                                                                                                  BatchCreateResource
                                                                                                  +