From 14ae4396d076281141de485b663ff88799312241 Mon Sep 17 00:00:00 2001
From: Jarrod Swift
Date: Tue, 13 Apr 2021 20:31:14 +0930
Subject: [PATCH] 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>
= []
-
@@ -555,7 +556,7 @@ Get all brands, fetching multiple pages
@@ -574,7 +575,8 @@ Parameters
: array<string|int, mixed>
= []
-
@@ -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');
+
+
+
+
+ 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();
+
+
+
+
+ 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();
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ __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
+ —
+
+
+
+
+
+
+ batchCreate()
+
+
+
+
+
+
+ public
+ batchCreate ( array<string|int, ChannelCurrencyAssignment > $resources ) : ChannelCurrencyAssignmentsResponse
+
+
+
+ Parameters
+
+
+ $resources
+ : array<string|int, ChannelCurrencyAssignment >
+
+
+
+
+
+
+
+
+
+ Return values
+ ChannelCurrencyAssignmentsResponse
+ —
+
+
+
+
+
+
+ batchUpdate()
+
+
+
+
+
+
+ public
+ batchUpdate ( array<string|int, ChannelCurrencyAssignment > $resources ) : ChannelCurrencyAssignmentsResponse
+
+
+
+ Parameters
+
+
+ $resources
+ : array<string|int, ChannelCurrencyAssignment >
+
+
+
+
+
+
+
+
+
+ Return values
+ ChannelCurrencyAssignmentsResponse
+ —
+
+
+
+
+
+
+ create()
+
+
+
+
+
+
+ public
+ create ( ChannelCurrencyAssignment $currencyAssignment ) : ChannelCurrencyAssignmentsResponse
+
+
+ Parameters
+
+
+ $currencyAssignment
+ : ChannelCurrencyAssignment
+
+
+
+
+
+
+
+
+ Return values
+ ChannelCurrencyAssignmentsResponse
+ —
+
+
+
+
+
+
+ getAll()
+
+
+
+
+
+
+ public
+ getAll ( [ array<string|int, mixed> $filters = [] ] [ , int $page = 1 ] [ , int $limit = 250 ] ) : ChannelCurrencyAssignmentsResponse
+
+
+ Parameters
+
+
+ $filters
+ : array<string|int, mixed>
+ = []
+
+
+
+
+ $page
+ : int
+ = 1
+
+
+
+
+ $limit
+ : int
+ = 250
+
+
+
+
+
+
+
+ Return values
+ ChannelCurrencyAssignmentsResponse
+ —
+
+
+
+
+
+
+ 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
+ —
+
+
+
+
+
+
+ update()
+
+
+
+
+
+
+ public
+ update ( ChannelCurrencyAssignment $currencyAssignment ) : ChannelCurrencyAssignmentsResponse
+
+
+ Parameters
+
+
+ $currencyAssignment
+ : ChannelCurrencyAssignment
+
+
+
+
+
+
+
+
+ Return values
+ ChannelCurrencyAssignmentsResponse
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ __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
+ —
+
+
+
+
+
+
+ create()
+
+
+
+
+
+
+ public
+ create ( ChannelListing $channelListing ) : ChannelListingResponse
+
+
+ Parameters
+
+
+ $channelListing
+ : ChannelListing
+
+
+
+
+
+
+
+
+ Return values
+ ChannelListingResponse
+ —
+
+
+
+
+
+
+ delete()
+
+
+
+
+
+
+ public
+ delete ( ) : ResponseInterface
+
+
+
+
+
+ Return values
+ ResponseInterface
+ —
+
+
+
+
+
+
+ get()
+
+
+
+
+
+
+ public
+ get ( ) : ChannelListingResponse
+
+
+
+
+
+ Return values
+ ChannelListingResponse
+ —
+
+
+
+
+
+
+ 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
+ —
+
+
+
+
+
+
+ update()
+
+
+
+
+
+
+ public
+ update ( ChannelListing $channelListing ) : ChannelListingResponse
+
+
+ Parameters
+
+
+ $channelListing
+ : ChannelListing
+
+
+
+
+
+
+
+
+ Return values
+ ChannelListingResponse
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ __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
+ —
+
+
+
+
+
+
+ create()
+
+
+
+
+
+
+ public
+ create ( ChannelSite $site ) : ChannelSiteResponse
+
+
+ Parameters
+
+
+ $site
+ : ChannelSite
+
+
+
+
+
+
+
+
+ Return values
+ ChannelSiteResponse
+ —
+
+
+
+
+
+
+ get()
+
+
+
+
+
+
+ public
+ get ( ) : ChannelSiteResponse
+
+
+
+
+
+ Return values
+ ChannelSiteResponse
+ —
+
+
+
+
+
+
+ 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
+ —
+
+
+
+
+
+
+ update()
+
+
+
+
+
+
+ public
+ update ( ChannelSite $site ) : ChannelSiteResponse
+
+
+ Parameters
+
+
+ $site
+ : ChannelSite
+
+
+
+
+
+
+
+
+ Return values
+ ChannelSiteResponse
+ —
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
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 @@
@@ -497,7 +511,7 @@
@@ -539,7 +553,7 @@
+
+
+
+ channel()
+
+ : ChannelsApi
+
+
+
+
+ channels()
+
+ : ChannelsApi
+
@@ -325,7 +339,7 @@
@@ -350,7 +364,7 @@
@@ -375,7 +389,7 @@
@@ -400,7 +414,7 @@