@commercelayer/sdk 5.0.0-alpha.3 → 5.0.0-alpha.4

package/README.md

@@ -1,8 +1,13 @@
 # Commerce Layer JS SDK
 
+[![Version](https://img.shields.io/npm/v/@commercelayer/sdk.svg)](https://npmjs.org/package/@commercelayer/sdk)
+[![Downloads/week](https://img.shields.io/npm/dw/@commercelayer/sdk.svg)](https://npmjs.org/package/@commercelayer/sdk)
+[![License](https://img.shields.io/npm/l/@commercelayer/sdk.svg)](https://github.com/commercelayer/commercelayer-sdk/blob/master/package.json)
 [![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
+[![Release](https://github.com/commercelayer/commercelayer-sdk/actions/workflows/semantic-release.yml/badge.svg)](https://github.com/commercelayer/commercelayer-sdk/actions/workflows/semantic-release.yml)
+[![CodeQL](https://github.com/commercelayer/commercelayer-cli/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/commercelayer/commercelayer-cli/actions/workflows/codeql-analysis.yml)
 
-A JavaScript Library wrapper that makes it quick and easy to interact with the [Commerce Layer API](https://docs.commercelayer.io/api/).
+A JavaScript Library wrapper that makes it quick and easy to interact with the [Commerce Layer API](https://docs.commercelayer.io/developers/).
 
 ### What is Commerce Layer?
 
@@ -20,7 +25,7 @@ To get started with Commerce Layer JS SDK you need to install it and then get th
 
 Commerce Layer JS SDK is available as an [npm package](https://www.npmjs.com/package/@commercelayer/sdk):
 
-```
+```shell
 // npm
 npm install @commercelayer/sdk
 
@@ -30,7 +35,9 @@ yarn add @commercelayer/sdk
 
 ## Authentication
 
-All requests to Commerce Layer API must be authenticated with an [OAuth2](https://oauth.net/2/) bearer token. Hence, before starting to use this SDK you need to get a valid access token. Check [our documentation](https://docs.commercelayer.io/api/authentication) for more information about the available authorization flows.
+All requests to Commerce Layer API must be authenticated with an [OAuth2](https://oauth.net/2/) bearer token.
+Hence, before starting to use this SDK you need to get a valid access token.
+Check [our documentation](https://docs.commercelayer.io/developers/authentication) for more information about the available authorization flows.
 
 > Feel free to use [Commerce Layer JS Auth](https://github.com/commercelayer/commercelayer-js-auth), a JavaScript library that helps you wrap our authentication API.
 
@@ -38,7 +45,7 @@ All requests to Commerce Layer API must be authenticated with an [OAuth2](https:
 
 You can use the ES6 default import with the SDK as follow:
 
-```
+```typescript
 import CommerceLayer from '@commercelayer/sdk'
 
 const cl = CommerceLayer({
@@ -47,49 +54,59 @@ const cl = CommerceLayer({
 })
 ```
 
-> In the following examples, we will use only the the specific resources we're going to access (SKUs and shipping categories). Check our [API reference](https://docs.commercelayer.io/api/) for the complete list of available resources and their attributes.
+> In the following examples, we will use only the the specific resources we're going to access (SKUs and shipping categories).
+Check our [API reference](https://docs.commercelayer.io/developers/v/api-reference/) for the complete list of available  
+resources and their attributes.
 
 # Usage
 
 The code snippets below show how to use the Commerce Layer JS SDK when performing the standard CRUD operations provided by our REST API on the SKU resource.
 
 - ### Create
+
   - [How to create an SKU](#how-to-create-an-sku)
-- ### Retrieve
+
+- ### Retrieve / List
+
   - [How to fetch a single SKU](#how-to-fetch-a-single-sku)
   - [How to fetch a collection of SKUs](#how-to-fetch-a-collection-of-skus)
   - [How to paginate a collection of SKUs](#how-to-paginate-a-collection-of-skus)
   - [How to iterate through a collection of SKUs](#how-to-iterate-through-a-collection-of-skus)
-  - [How to build complex queries](#how-to-build-complex-queries)
+  <!-- - [How to build complex queries](#how-to-build-complex-queries) -->
+  - [How to fetch resource relationships](#how-to-fetch-resource-relationships)
+
 - ### Update
+
   - [How to update an existing SKU](#how-to-update-an-existing-sku)
+
 - ### Delete
+
   - [How to delete an existing SKU](#how-to-delete-an-existing-sku)
 
 ## Create
 
 ### How to create an SKU
 
-```
+```typescript
   // selects the shipping category (it's a required relationship for the SKU resource)
   const shippingCategories = await cl.shipping_categories.list({ filters: { name_eq: 'Merchandising' } })
 
   const attributes = {
-	  code: 'TSHIRTMM000000FFFFFFXL',
-	  name: 'Black Men T-shirt with White Logo (XL)',
-	  shipping_category: cl.shipping_categories.relationship(shippingCategories[0].id), // assigns the relationship
+    code: 'TSHIRTMM000000FFFFFFXL',
+    name: 'Black Men T-shirt with White Logo (XL)',
+    shipping_category: cl.shipping_categories.relationship(shippingCategories[0].id), // assigns the relationship
   }
 
   const newSku = await cl.skus.create(attributes)
 ```
 
-Check our API reference for more information on how to [create an SKU](https://docs.commercelayer.io/api/resources/skus/create_sku).
+Check our API reference for more information on how to [create an SKU](https://docs.commercelayer.io/developers/v/api-reference/skus/create).
 
-## Retrieve
+## Retrieve / List
 
 ### How to fetch a single SKU
 
-```
+```typescript
   // Fetches the SKU by ID
   const sku = await cl.skus.retrieve('BxAkSVqKEn')
 
@@ -103,11 +120,11 @@ Check our API reference for more information on how to [create an SKU](https://d
   const sku = (await cl.skus.list()).last()
 ```
 
-Check our API reference for more information on how to [retrieve an SKU](https://docs.commercelayer.io/api/resources/skus/retrieve_sku).
+Check our API reference for more information on how to [retrieve an SKU](https://docs.commercelayer.io/developers/v/api-reference/skus/retrieve).
 
 ### How to fetch a collection of SKUs
 
-```
+```typescript
   // LISTING RESULTS
 
   // Fetches all the SKUs
@@ -146,29 +163,32 @@ Check our API reference for more information on how to [retrieve an SKU](https:/
   const skus = await cl.skus.list({ filters: { name_cont: 'White Logo' } })
 
   // Filters all the SKUs fetching only the ones created between two specific dates
-  const skus = await cl.skus.list({ filters: { created_at_gt: '2018-01-01', created_at_lt: '2018-01-31'} }) // filters combined according to an AND logic
+  // (filters combined according to an AND logic)
+  const skus = await cl.skus.list({ filters: { created_at_gt: '2018-01-01', created_at_lt: '2018-01-31'} })
 
   // Filters all the SKUs fetching only the ones created or updated after a specific date
-  const skus = await cl.skus.list({ filters: { updated_at_or_created_at_gt: '2019-10-10' } }) // attributes combined according to an OR logic
+  // (attributes combined according to an OR logic)
+  const skus = await cl.skus.list({ filters: { updated_at_or_created_at_gt: '2019-10-10' } })
 
-  // Filters all the SKUs fetching only the ones whose name contains the string "Black" and whose shipping category name starts with the string "MERCH"
+  // Filters all the SKUs fetching only the ones whose name contains the string "Black" and whose shipping category 
+  // name starts with the string "MERCH"
   const skus = await cl.skus.list({ filters: { name_cont: 'Black', shipping_category_name_start: 'MERCH'} })
 ```
 
 When fetching a collection of resources you can leverage the `meta` attribute to get its `meta` information:
 
-```
+```typescript
   const skus = await cl.skus.list()
   const meta = skus.meta
 ```
 
-Check our API reference for more information on how to [list all SKUs](https://docs.commercelayer.io/api/resources/skus/list_skus), [sort the results](https://docs.commercelayer.io/api/sorting-results), use [sparse fieldsets](https://docs.commercelayer.io/api/sparse-fieldsets), [include associations](https://docs.commercelayer.io/api/including-associations), and [filter data](https://docs.commercelayer.io/api/filtering-data).
+Check our API reference for more information on how to [list all SKUs](https://docs.commercelayer.io/developers/v/api-reference/skus/list), [sort the results](https://docs.commercelayer.io/developers/sorting-results), use [sparse fieldsets](https://docs.commercelayer.io/developers/sparse-fieldsets), [include associations](https://docs.commercelayer.io/developers/including-associations), and [filter data](https://docs.commercelayer.io/developers/filtering-data).
 
 ### How to paginate a collection of SKUs
 
 When you fetch a collection of resources, you get paginated results:
 
-```
+```typescript
   // Fetches the SKUs, setting the page number to 3 and the page size to 5
   const skus = await cl.skus.list({ pageNumber: 3, pageSize: 5 })
 
@@ -181,23 +201,36 @@ When you fetch a collection of resources, you get paginated results:
 
 > The default page number is **1**. The default page size is **10**. The maximum page size allowed is **25**.
 
-Check our API reference for more information on how [pagination](https://docs.commercelayer.io/api/pagination) works.
+Check our API reference for more information on how [pagination](https://docs.commercelayer.io/developers/pagination) works.
 
 ### How to iterate through a collection of SKUs
 
 To execute a function for every item of a collection, use the `map()` method:
 
-```
-  // Fetches the whole list of SKUs and prints their names and codes to console
+```typescript
+  // Fetches the whole list of SKUs (1st page) and prints their names and codes to console
   const skus = await cl.skus.list()
   skus.map(p => console.log('Product: ' + p.name + ' - Code: ' + p.code))
 ```
 
+### How to fetch resource relationships
+
+Many resources have relationships with other resources and instead of including these associations as seen above, you can fetch them directly.
+In this way, in case of 1-to-N relationship, you can filter or sort the resulting collection as for standard resources.
+
+```typescript
+// Fetches 1-to-1 related resource: billing address of an order
+const billingAddress = cl.orders.billing_address('xYZkjABcde')
+
+// Fetches 1-to-N related resources: orders associated to a customer
+const orders = cl.customers.orders('XyzKjAbCDe', { fields: ['status', 'number'] })
+```
+
 ## Update
 
 ### How to update an existing SKU
 
-```
+```typescript
   const sku = {
     id: 'xYZkjABcde',
     description: 'Updated description.',
@@ -207,23 +240,24 @@ To execute a function for every item of a collection, use the `map()` method:
   cl.skus.update(sku) // updates the SKU on the server
 ```
 
-Check our API reference for more information on how to [update an SKU](https://docs.commercelayer.io/api/resources/skus/update_sku).
+Check our API reference for more information on how to [update an SKU](https://docs.commercelayer.io/developers/v/api-reference/skus/update).
 
 ## Delete
 
 ### How to delete an existing SKU
 
-```
+```typescript
   cl.skus.delete('xYZkjABcde') // persisted deletion
 ```
 
-Check our API reference for more information on how to [delete an SKU](https://docs.commercelayer.io/api/resources/skus/delete_sku).
+Check our API reference for more information on how to [delete an SKU](https://docs.commercelayer.io/developers/v/api-reference/skus/delete).
 
 # Overriding credentials
 
-If needed, Commerce Layer JS SDK lets you change the client configuration set it at a request level. To do that, just use the `config()` method or pass the `options` parameter and authenticate the API call with the desired credentials:
+If needed, Commerce Layer JS SDK lets you change the client configuration set it at a request level.
+To do that, just use the `config()` method or pass the `options` parameter and authenticate the API call with the desired credentials:
 
-```
+```typescript
   // Permanently change configuration at client level
   cl.config({ organization: 'you-organization-slug', accessToken: 'your-access-token' })
   const skus = await cl.skus.list()
@@ -238,7 +272,7 @@ If needed, Commerce Layer JS SDK lets you change the client configuration set it
 
 Commerce Layer API returns specific errors (with extra information) on each attribute of a single resource. You can inspect them to properly handle validation errors (if any). To do that, use the `errors` attribute of the catched error:
 
-```
+```typescript
   // logs error messages to console:
 
   const attributes = { code: 'TSHIRTMM000000FFFFFFXL', name: '' }
@@ -276,7 +310,7 @@ Commerce Layer API returns specific errors (with extra information) on each attr
 
 ```
 
-Check our API reference for more information about the [errors](https://docs.commercelayer.io/api/handling-errors) returned by the API.
+Check our API reference for more information about the [errors](https://docs.commercelayer.io/developers/handling-errors) returned by the API.
 
 ---
 

package/lib/api.d.ts

@@ -1,103 +1 @@
-/**
- * ©2022 Commerce Layer Inc.
- * OpenAPI schema, version 2.8.1
- **/
-export { default as Addresses } from './resources/addresses';
-export { default as Adjustments } from './resources/adjustments';
-export { default as AdyenGateways } from './resources/adyen_gateways';
-export { default as AdyenPayments } from './resources/adyen_payments';
-export { default as Applications } from './resources/application';
-export { default as Attachments } from './resources/attachments';
-export { default as Authorizations } from './resources/authorizations';
-export { default as AvalaraAccounts } from './resources/avalara_accounts';
-export { default as BillingInfoValidationRules } from './resources/billing_info_validation_rules';
-export { default as BingGeocoders } from './resources/bing_geocoders';
-export { default as BraintreeGateways } from './resources/braintree_gateways';
-export { default as BraintreePayments } from './resources/braintree_payments';
-export { default as Bundles } from './resources/bundles';
-export { default as Captures } from './resources/captures';
-export { default as CarrierAccounts } from './resources/carrier_accounts';
-export { default as CheckoutComGateways } from './resources/checkout_com_gateways';
-export { default as CheckoutComPayments } from './resources/checkout_com_payments';
-export { default as CouponCodesPromotionRules } from './resources/coupon_codes_promotion_rules';
-export { default as CouponRecipients } from './resources/coupon_recipients';
-export { default as Coupons } from './resources/coupons';
-export { default as CustomerAddresses } from './resources/customer_addresses';
-export { default as CustomerGroups } from './resources/customer_groups';
-export { default as CustomerPasswordResets } from './resources/customer_password_resets';
-export { default as CustomerPaymentSources } from './resources/customer_payment_sources';
-export { default as CustomerSubscriptions } from './resources/customer_subscriptions';
-export { default as Customers } from './resources/customers';
-export { default as DeliveryLeadTimes } from './resources/delivery_lead_times';
-export { default as EventCallbacks } from './resources/event_callbacks';
-export { default as ExternalGateways } from './resources/external_gateways';
-export { default as ExternalPayments } from './resources/external_payments';
-export { default as ExternalPromotions } from './resources/external_promotions';
-export { default as ExternalTaxCalculators } from './resources/external_tax_calculators';
-export { default as FixedAmountPromotions } from './resources/fixed_amount_promotions';
-export { default as FixedPricePromotions } from './resources/fixed_price_promotions';
-export { default as FreeGiftPromotions } from './resources/free_gift_promotions';
-export { default as FreeShippingPromotions } from './resources/free_shipping_promotions';
-export { default as Geocoders } from './resources/geocoders';
-export { default as GiftCardRecipients } from './resources/gift_card_recipients';
-export { default as GiftCards } from './resources/gift_cards';
-export { default as GoogleGeocoders } from './resources/google_geocoders';
-export { default as Imports } from './resources/imports';
-export { default as InStockSubscriptions } from './resources/in_stock_subscriptions';
-export { default as InventoryModels } from './resources/inventory_models';
-export { default as InventoryReturnLocations } from './resources/inventory_return_locations';
-export { default as InventoryStockLocations } from './resources/inventory_stock_locations';
-export { default as KlarnaGateways } from './resources/klarna_gateways';
-export { default as KlarnaPayments } from './resources/klarna_payments';
-export { default as LineItemOptions } from './resources/line_item_options';
-export { default as LineItems } from './resources/line_items';
-export { default as ManualGateways } from './resources/manual_gateways';
-export { default as ManualTaxCalculators } from './resources/manual_tax_calculators';
-export { default as Markets } from './resources/markets';
-export { default as Merchants } from './resources/merchants';
-export { default as OrderAmountPromotionRules } from './resources/order_amount_promotion_rules';
-export { default as OrderCopies } from './resources/order_copies';
-export { default as OrderSubscriptions } from './resources/order_subscriptions';
-export { default as OrderValidationRules } from './resources/order_validation_rules';
-export { default as Orders } from './resources/orders';
-export { default as Organizations } from './resources/organization';
-export { default as Packages } from './resources/packages';
-export { default as ParcelLineItems } from './resources/parcel_line_items';
-export { default as Parcels } from './resources/parcels';
-export { default as PaymentGateways } from './resources/payment_gateways';
-export { default as PaymentMethods } from './resources/payment_methods';
-export { default as PaypalGateways } from './resources/paypal_gateways';
-export { default as PaypalPayments } from './resources/paypal_payments';
-export { default as PercentageDiscountPromotions } from './resources/percentage_discount_promotions';
-export { default as PriceLists } from './resources/price_lists';
-export { default as Prices } from './resources/prices';
-export { default as PromotionRules } from './resources/promotion_rules';
-export { default as Promotions } from './resources/promotions';
-export { default as Refunds } from './resources/refunds';
-export { default as ReturnLineItems } from './resources/return_line_items';
-export { default as Returns } from './resources/returns';
-export { default as Shipments } from './resources/shipments';
-export { default as ShippingCategories } from './resources/shipping_categories';
-export { default as ShippingMethods } from './resources/shipping_methods';
-export { default as ShippingZones } from './resources/shipping_zones';
-export { default as SkuListItems } from './resources/sku_list_items';
-export { default as SkuListPromotionRules } from './resources/sku_list_promotion_rules';
-export { default as SkuLists } from './resources/sku_lists';
-export { default as SkuOptions } from './resources/sku_options';
-export { default as Skus } from './resources/skus';
-export { default as StockItems } from './resources/stock_items';
-export { default as StockLineItems } from './resources/stock_line_items';
-export { default as StockLocations } from './resources/stock_locations';
-export { default as StockTransfers } from './resources/stock_transfers';
-export { default as StripeGateways } from './resources/stripe_gateways';
-export { default as StripePayments } from './resources/stripe_payments';
-export { default as TaxCalculators } from './resources/tax_calculators';
-export { default as TaxCategories } from './resources/tax_categories';
-export { default as TaxRules } from './resources/tax_rules';
-export { default as TaxjarAccounts } from './resources/taxjar_accounts';
-export { default as Transactions } from './resources/transactions';
-export { default as Voids } from './resources/voids';
-export { default as Webhooks } from './resources/webhooks';
-export { default as WireTransfers } from './resources/wire_transfers';
-export declare type ResourceTypeLock = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'application' | 'attachments' | 'authorizations' | 'avalara_accounts' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'captures' | 'carrier_accounts' | 'checkout_com_gateways' | 'checkout_com_payments' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'event_callbacks' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'geocoders' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_subscriptions' | 'order_validation_rules' | 'orders' | 'organization' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_gateways' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_lists' | 'prices' | 'promotion_rules' | 'promotions' | 'refunds' | 'return_line_items' | 'returns' | 'shipments' | 'shipping_categories' | 'shipping_methods' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_line_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'tax_calculators' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'transactions' | 'voids' | 'webhooks' | 'wire_transfers';
-export declare const resourceList: readonly ["addresses", "adjustments", "adyen_gateways", "adyen_payments", "application", "attachments", "authorizations", "avalara_accounts", "billing_info_validation_rules", "bing_geocoders", "braintree_gateways", "braintree_payments", "bundles", "captures", "carrier_accounts", "checkout_com_gateways", "checkout_com_payments", "coupon_codes_promotion_rules", "coupon_recipients", "coupons", "customer_addresses", "customer_groups", "customer_password_resets", "customer_payment_sources", "customer_subscriptions", "customers", "delivery_lead_times", "event_callbacks", "external_gateways", "external_payments", "external_promotions", "external_tax_calculators", "fixed_amount_promotions", "fixed_price_promotions", "free_gift_promotions", "free_shipping_promotions", "geocoders", "gift_card_recipients", "gift_cards", "google_geocoders", "imports", "in_stock_subscriptions", "inventory_models", "inventory_return_locations", "inventory_stock_locations", "klarna_gateways", "klarna_payments", "line_item_options", "line_items", "manual_gateways", "manual_tax_calculators", "markets", "merchants", "order_amount_promotion_rules", "order_copies", "order_subscriptions", "order_validation_rules", "orders", "organization", "packages", "parcel_line_items", "parcels", "payment_gateways", "payment_methods", "paypal_gateways", "paypal_payments", "percentage_discount_promotions", "price_lists", "prices", "promotion_rules", "promotions", "refunds", "return_line_items", "returns", "shipments", "shipping_categories", "shipping_methods", "shipping_zones", "sku_list_items", "sku_list_promotion_rules", "sku_lists", "sku_options", "skus", "stock_items", "stock_line_items", "stock_locations", "stock_transfers", "stripe_gateways", "stripe_payments", "tax_calculators", "tax_categories", "tax_rules", "taxjar_accounts", "transactions", "voids", "webhooks", "wire_transfers"];
+export{default as Addresses}from'./resources/addresses';export{default as Adjustments}from'./resources/adjustments';export{default as AdyenGateways}from'./resources/adyen_gateways';export{default as AdyenPayments}from'./resources/adyen_payments';export{default as Applications}from'./resources/application';export{default as Attachments}from'./resources/attachments';export{default as Authorizations}from'./resources/authorizations';export{default as AvalaraAccounts}from'./resources/avalara_accounts';export{default as BillingInfoValidationRules}from'./resources/billing_info_validation_rules';export{default as BingGeocoders}from'./resources/bing_geocoders';export{default as BraintreeGateways}from'./resources/braintree_gateways';export{default as BraintreePayments}from'./resources/braintree_payments';export{default as Bundles}from'./resources/bundles';export{default as Captures}from'./resources/captures';export{default as CarrierAccounts}from'./resources/carrier_accounts';export{default as CheckoutComGateways}from'./resources/checkout_com_gateways';export{default as CheckoutComPayments}from'./resources/checkout_com_payments';export{default as CouponCodesPromotionRules}from'./resources/coupon_codes_promotion_rules';export{default as CouponRecipients}from'./resources/coupon_recipients';export{default as Coupons}from'./resources/coupons';export{default as CustomerAddresses}from'./resources/customer_addresses';export{default as CustomerGroups}from'./resources/customer_groups';export{default as CustomerPasswordResets}from'./resources/customer_password_resets';export{default as CustomerPaymentSources}from'./resources/customer_payment_sources';export{default as CustomerSubscriptions}from'./resources/customer_subscriptions';export{default as Customers}from'./resources/customers';export{default as DeliveryLeadTimes}from'./resources/delivery_lead_times';export{default as EventCallbacks}from'./resources/event_callbacks';export{default as ExternalGateways}from'./resources/external_gateways';export{default as ExternalPayments}from'./resources/external_payments';export{default as ExternalPromotions}from'./resources/external_promotions';export{default as ExternalTaxCalculators}from'./resources/external_tax_calculators';export{default as FixedAmountPromotions}from'./resources/fixed_amount_promotions';export{default as FixedPricePromotions}from'./resources/fixed_price_promotions';export{default as FreeGiftPromotions}from'./resources/free_gift_promotions';export{default as FreeShippingPromotions}from'./resources/free_shipping_promotions';export{default as Geocoders}from'./resources/geocoders';export{default as GiftCardRecipients}from'./resources/gift_card_recipients';export{default as GiftCards}from'./resources/gift_cards';export{default as GoogleGeocoders}from'./resources/google_geocoders';export{default as Imports}from'./resources/imports';export{default as InStockSubscriptions}from'./resources/in_stock_subscriptions';export{default as InventoryModels}from'./resources/inventory_models';export{default as InventoryReturnLocations}from'./resources/inventory_return_locations';export{default as InventoryStockLocations}from'./resources/inventory_stock_locations';export{default as KlarnaGateways}from'./resources/klarna_gateways';export{default as KlarnaPayments}from'./resources/klarna_payments';export{default as LineItemOptions}from'./resources/line_item_options';export{default as LineItems}from'./resources/line_items';export{default as ManualGateways}from'./resources/manual_gateways';export{default as ManualTaxCalculators}from'./resources/manual_tax_calculators';export{default as Markets}from'./resources/markets';export{default as Merchants}from'./resources/merchants';export{default as OrderAmountPromotionRules}from'./resources/order_amount_promotion_rules';export{default as OrderCopies}from'./resources/order_copies';export{default as OrderSubscriptions}from'./resources/order_subscriptions';export{default as OrderValidationRules}from'./resources/order_validation_rules';export{default as Orders}from'./resources/orders';export{default as Organizations}from'./resources/organization';export{default as Packages}from'./resources/packages';export{default as ParcelLineItems}from'./resources/parcel_line_items';export{default as Parcels}from'./resources/parcels';export{default as PaymentGateways}from'./resources/payment_gateways';export{default as PaymentMethods}from'./resources/payment_methods';export{default as PaypalGateways}from'./resources/paypal_gateways';export{default as PaypalPayments}from'./resources/paypal_payments';export{default as PercentageDiscountPromotions}from'./resources/percentage_discount_promotions';export{default as PriceLists}from'./resources/price_lists';export{default as Prices}from'./resources/prices';export{default as PromotionRules}from'./resources/promotion_rules';export{default as Promotions}from'./resources/promotions';export{default as Refunds}from'./resources/refunds';export{default as ReturnLineItems}from'./resources/return_line_items';export{default as Returns}from'./resources/returns';export{default as Shipments}from'./resources/shipments';export{default as ShippingCategories}from'./resources/shipping_categories';export{default as ShippingMethods}from'./resources/shipping_methods';export{default as ShippingZones}from'./resources/shipping_zones';export{default as SkuListItems}from'./resources/sku_list_items';export{default as SkuListPromotionRules}from'./resources/sku_list_promotion_rules';export{default as SkuLists}from'./resources/sku_lists';export{default as SkuOptions}from'./resources/sku_options';export{default as Skus}from'./resources/skus';export{default as StockItems}from'./resources/stock_items';export{default as StockLineItems}from'./resources/stock_line_items';export{default as StockLocations}from'./resources/stock_locations';export{default as StockTransfers}from'./resources/stock_transfers';export{default as StripeGateways}from'./resources/stripe_gateways';export{default as StripePayments}from'./resources/stripe_payments';export{default as TaxCalculators}from'./resources/tax_calculators';export{default as TaxCategories}from'./resources/tax_categories';export{default as TaxRules}from'./resources/tax_rules';export{default as TaxjarAccounts}from'./resources/taxjar_accounts';export{default as Transactions}from'./resources/transactions';export{default as Voids}from'./resources/voids';export{default as Webhooks}from'./resources/webhooks';export{default as WireTransfers}from'./resources/wire_transfers';export declare type ResourceTypeLock='addresses'|'adjustments'|'adyen_gateways'|'adyen_payments'|'application'|'attachments'|'authorizations'|'avalara_accounts'|'billing_info_validation_rules'|'bing_geocoders'|'braintree_gateways'|'braintree_payments'|'bundles'|'captures'|'carrier_accounts'|'checkout_com_gateways'|'checkout_com_payments'|'coupon_codes_promotion_rules'|'coupon_recipients'|'coupons'|'customer_addresses'|'customer_groups'|'customer_password_resets'|'customer_payment_sources'|'customer_subscriptions'|'customers'|'delivery_lead_times'|'event_callbacks'|'external_gateways'|'external_payments'|'external_promotions'|'external_tax_calculators'|'fixed_amount_promotions'|'fixed_price_promotions'|'free_gift_promotions'|'free_shipping_promotions'|'geocoders'|'gift_card_recipients'|'gift_cards'|'google_geocoders'|'imports'|'in_stock_subscriptions'|'inventory_models'|'inventory_return_locations'|'inventory_stock_locations'|'klarna_gateways'|'klarna_payments'|'line_item_options'|'line_items'|'manual_gateways'|'manual_tax_calculators'|'markets'|'merchants'|'order_amount_promotion_rules'|'order_copies'|'order_subscriptions'|'order_validation_rules'|'orders'|'organization'|'packages'|'parcel_line_items'|'parcels'|'payment_gateways'|'payment_methods'|'paypal_gateways'|'paypal_payments'|'percentage_discount_promotions'|'price_lists'|'prices'|'promotion_rules'|'promotions'|'refunds'|'return_line_items'|'returns'|'shipments'|'shipping_categories'|'shipping_methods'|'shipping_zones'|'sku_list_items'|'sku_list_promotion_rules'|'sku_lists'|'sku_options'|'skus'|'stock_items'|'stock_line_items'|'stock_locations'|'stock_transfers'|'stripe_gateways'|'stripe_payments'|'tax_calculators'|'tax_categories'|'tax_rules'|'taxjar_accounts'|'transactions'|'voids'|'webhooks'|'wire_transfers';export declare const resourceList:readonly["addresses","adjustments","adyen_gateways","adyen_payments","application","attachments","authorizations","avalara_accounts","billing_info_validation_rules","bing_geocoders","braintree_gateways","braintree_payments","bundles","captures","carrier_accounts","checkout_com_gateways","checkout_com_payments","coupon_codes_promotion_rules","coupon_recipients","coupons","customer_addresses","customer_groups","customer_password_resets","customer_payment_sources","customer_subscriptions","customers","delivery_lead_times","event_callbacks","external_gateways","external_payments","external_promotions","external_tax_calculators","fixed_amount_promotions","fixed_price_promotions","free_gift_promotions","free_shipping_promotions","geocoders","gift_card_recipients","gift_cards","google_geocoders","imports","in_stock_subscriptions","inventory_models","inventory_return_locations","inventory_stock_locations","klarna_gateways","klarna_payments","line_item_options","line_items","manual_gateways","manual_tax_calculators","markets","merchants","order_amount_promotion_rules","order_copies","order_subscriptions","order_validation_rules","orders","organization","packages","parcel_line_items","parcels","payment_gateways","payment_methods","paypal_gateways","paypal_payments","percentage_discount_promotions","price_lists","prices","promotion_rules","promotions","refunds","return_line_items","returns","shipments","shipping_categories","shipping_methods","shipping_zones","sku_list_items","sku_list_promotion_rules","sku_lists","sku_options","skus","stock_items","stock_line_items","stock_locations","stock_transfers","stripe_gateways","stripe_payments","tax_calculators","tax_categories","tax_rules","taxjar_accounts","transactions","voids","webhooks","wire_transfers"];

package/lib/client.d.ts

@@ -1,32 +1,2 @@
 /// <reference types="node" />
-import { AxiosProxyConfig, Method } from 'axios';
-import type { InterceptorManager } from './interceptor';
-import type { Agent as HttpAgent } from 'http';
-import type { Agent as HttpsAgent } from 'https';
-declare type ProxyConfig = AxiosProxyConfig | false;
-declare type RequestConfig = {
-    timeout?: number;
-    params?: {
-        [key: string]: string | number | boolean;
-    };
-    httpAgent?: HttpAgent;
-    httpsAgent?: HttpsAgent;
-    proxy?: ProxyConfig;
-};
-declare type ApiClientInitConfig = {
-    organization: string;
-    domain?: string;
-    accessToken: string;
-} & RequestConfig;
-declare type ApiClientConfig = Partial<ApiClientInitConfig>;
-declare class ApiClient {
-    #private;
-    static create(options: ApiClientInitConfig): ApiClient;
-    baseUrl: string;
-    interceptors: InterceptorManager;
-    private constructor();
-    config(config: ApiClientConfig): void;
-    request(method: Method, path: string, body?: any, options?: ApiClientConfig): Promise<any>;
-}
-export default ApiClient;
-export { ApiClientInitConfig, ApiClientConfig, RequestConfig };
+import{AxiosProxyConfig,Method}from'axios';import type{InterceptorManager}from'./interceptor';import type{Agent as HttpAgent}from'http';import type{Agent as HttpsAgent}from'https';declare type ProxyConfig=AxiosProxyConfig|false;declare type RequestConfig={timeout?:number;params?:{[key:string]:string|number|boolean;};httpAgent?:HttpAgent;httpsAgent?:HttpsAgent;proxy?:ProxyConfig;};declare type ApiClientInitConfig={organization:string;domain?:string;accessToken:string;}&RequestConfig;declare type ApiClientConfig=Partial<ApiClientInitConfig>;declare class ApiClient{#private;static create(options:ApiClientInitConfig):ApiClient;baseUrl:string;interceptors:InterceptorManager;private constructor();config(config:ApiClientConfig):void;request(method:Method,path:string,body?:any,options?:ApiClientConfig):Promise<any>;}export default ApiClient;export{ApiClientInitConfig,ApiClientConfig,RequestConfig};

package/lib/client.js

@@ -1 +1 @@
-var d=this&&this.__classPrivateFieldSet||function(r,t,e,s,a){if(s==="m")throw new TypeError("Private method is not writable");if(s==="a"&&!a)throw new TypeError("Private accessor was defined without a setter");if(typeof t=="function"?r!==t||!a:!t.has(r))throw new TypeError("Cannot write private member to an object whose class did not declare it");return s==="a"?a.call(r,e):a?a.value=e:t.set(r,e),e},n=this&&this.__classPrivateFieldGet||function(r,t,e,s){if(e==="a"&&!s)throw new TypeError("Private accessor was defined without a getter");if(typeof t=="function"?r!==t||!s:!t.has(r))throw new TypeError("Cannot read private member from an object whose class did not declare it");return e==="m"?s:e==="a"?s.call(r):s?s.value:t.get(r)},o,i;import u from"axios";import{SdkError as T,ApiError as b,ErrorType as c}from"./error";import f from"./config";import z from"./debug";const p=z(),m=(r,t)=>`https://${r.toLowerCase()}.${t||f.default.domain}/api`,C=r=>{let t=new T({message:r.message,type:c.GENERIC});if(u.isAxiosError(r))if(r.response){const e=new b(t);e.type=c.RESPONSE,e.status=r.response.status,e.code=String(e.status),e.errors=r.response.data.errors,t=e}else r.request?(t.type=c.REQUEST,t.request=r.request):t.type=c.CLIENT;else u.isCancel(r)?t.type=c.CANCEL:t.source=r;throw t};class l{constructor(t){o.set(this,void 0),i.set(this,void 0),p("new client instance %O",t),this.baseUrl=m(t.organization,t.domain),d(this,o,t.accessToken,"f");const e={timeout:t.timeout||f.client.timeout,proxy:t.proxy,httpAgent:t.httpAgent,httpsAgent:t.httpsAgent},s={baseURL:this.baseUrl,timeout:f.client.timeout,headers:{Accept:"application/vnd.api+json","Content-Type":"application/vnd.api+json",Authorization:"Bearer "+n(this,o,"f")},...e};p("axios options: %O",s),d(this,i,u.create(s),"f"),this.interceptors=n(this,i,"f").interceptors}static create(t){if(!t?.organization)throw new Error("Undefined 'organization' parameter");if(!t?.accessToken)throw new Error("Undefined 'accessToken' parameter");return new l(t)}config(t){p("config %o",t);const e=n(this,i,"f").defaults;t.timeout&&(e.timeout=t.timeout),t.proxy&&(e.proxy=t.proxy),t.httpAgent&&(e.httpAgent=t.httpAgent),t.httpsAgent&&(e.httpsAgent=t.httpsAgent),t.organization&&(this.baseUrl=m(t.organization,t.domain)),t.accessToken&&(d(this,o,t.accessToken,"f"),e.headers.common.Authorization="Bearer "+n(this,o,"f"))}async request(t,e,s,a){p("request %s %s, %O, %O",t,e,s||{},a||{});const y=s?{data:s}:void 0,E=e,v=a?.organization?m(a.organization,a.domain):void 0,w=a?.accessToken||n(this,o,"f"),A=w?{Authorization:"Bearer "+w}:void 0,g={method:t,baseURL:v,url:E,data:y,headers:A,...a};return p("request params: %O",g),n(this,i,"f").request(g).then(h=>h.data).catch(h=>C(h))}}o=new WeakMap,i=new WeakMap;export default l;
+import p from"axios";import{SdkError as E,ApiError as y,ErrorType as i}from"./error";import c from"./config";import w from"./debug";const n=w("client"),h=(r,e)=>`https://${r.toLowerCase()}.${e||c.default.domain}/api`,T=r=>{let e=new E({message:r.message,type:i.GENERIC});if(p.isAxiosError(r))if(r.response){const t=new y(e);t.type=i.RESPONSE,t.status=r.response.status,t.code=String(t.status),t.errors=r.response.data.errors,e=t}else r.request?(e.type=i.REQUEST,e.request=r.request):e.type=i.CLIENT;else p.isCancel(r)?e.type=i.CANCEL:e.source=r;throw e};class m{static create(e){if(!e?.organization)throw new Error("Undefined 'organization' parameter");if(!e?.accessToken)throw new Error("Undefined 'accessToken' parameter");return new m(e)}baseUrl;#e;#t;interceptors;constructor(e){n("new client instance %O",e),this.baseUrl=h(e.organization,e.domain),this.#e=e.accessToken;const t={timeout:e.timeout||c.client.timeout,proxy:e.proxy,httpAgent:e.httpAgent,httpsAgent:e.httpsAgent},s={baseURL:this.baseUrl,timeout:c.client.timeout,headers:{Accept:"application/vnd.api+json","Content-Type":"application/vnd.api+json",Authorization:"Bearer "+this.#e},...t};n("axios options: %O",s),this.#t=p.create(s),this.interceptors=this.#t.interceptors}config(e){n("config %o",e);const t=this.#t.defaults;e.timeout&&(t.timeout=e.timeout),e.proxy&&(t.proxy=e.proxy),e.httpAgent&&(t.httpAgent=e.httpAgent),e.httpsAgent&&(t.httpsAgent=e.httpsAgent),e.organization&&(this.baseUrl=h(e.organization,e.domain)),e.accessToken&&(this.#e=e.accessToken,t.headers.common.Authorization="Bearer "+this.#e)}async request(e,t,s,o){n("request %s %s, %O, %O",e,t,s||{},o||{});const g=s?{data:s}:void 0,l=t,A=o?.organization?h(o.organization,o.domain):void 0,u=o?.accessToken||this.#e,f=u?{Authorization:"Bearer "+u}:void 0,d={method:e,baseURL:A,url:l,data:g,headers:f,...o};return n("request params: %O",d),this.#t.request(d).then(a=>a.data).catch(a=>T(a))}}export default m;

package/lib/commercelayer.d.ts

@@ -1,122 +1 @@
-import * as api from './api';
-import { ApiError } from './error';
-import type { ErrorInterceptor, InterceptorType, RawResponseReader, RequestInterceptor, ResponseInterceptor } from './interceptor';
-import { ResourcesInitConfig } from './resource';
-declare type SdkConfig = {};
-declare type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
-declare type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
-declare class CommerceLayerClient {
-    #private;
-    static get openApiSchemaVersion(): string;
-    addresses: api.Addresses;
-    adjustments: api.Adjustments;
-    adyen_gateways: api.AdyenGateways;
-    adyen_payments: api.AdyenPayments;
-    application: api.Applications;
-    attachments: api.Attachments;
-    authorizations: api.Authorizations;
-    avalara_accounts: api.AvalaraAccounts;
-    billing_info_validation_rules: api.BillingInfoValidationRules;
-    bing_geocoders: api.BingGeocoders;
-    braintree_gateways: api.BraintreeGateways;
-    braintree_payments: api.BraintreePayments;
-    bundles: api.Bundles;
-    captures: api.Captures;
-    carrier_accounts: api.CarrierAccounts;
-    checkout_com_gateways: api.CheckoutComGateways;
-    checkout_com_payments: api.CheckoutComPayments;
-    coupon_codes_promotion_rules: api.CouponCodesPromotionRules;
-    coupon_recipients: api.CouponRecipients;
-    coupons: api.Coupons;
-    customer_addresses: api.CustomerAddresses;
-    customer_groups: api.CustomerGroups;
-    customer_password_resets: api.CustomerPasswordResets;
-    customer_payment_sources: api.CustomerPaymentSources;
-    customer_subscriptions: api.CustomerSubscriptions;
-    customers: api.Customers;
-    delivery_lead_times: api.DeliveryLeadTimes;
-    event_callbacks: api.EventCallbacks;
-    external_gateways: api.ExternalGateways;
-    external_payments: api.ExternalPayments;
-    external_promotions: api.ExternalPromotions;
-    external_tax_calculators: api.ExternalTaxCalculators;
-    fixed_amount_promotions: api.FixedAmountPromotions;
-    fixed_price_promotions: api.FixedPricePromotions;
-    free_gift_promotions: api.FreeGiftPromotions;
-    free_shipping_promotions: api.FreeShippingPromotions;
-    geocoders: api.Geocoders;
-    gift_card_recipients: api.GiftCardRecipients;
-    gift_cards: api.GiftCards;
-    google_geocoders: api.GoogleGeocoders;
-    imports: api.Imports;
-    in_stock_subscriptions: api.InStockSubscriptions;
-    inventory_models: api.InventoryModels;
-    inventory_return_locations: api.InventoryReturnLocations;
-    inventory_stock_locations: api.InventoryStockLocations;
-    klarna_gateways: api.KlarnaGateways;
-    klarna_payments: api.KlarnaPayments;
-    line_item_options: api.LineItemOptions;
-    line_items: api.LineItems;
-    manual_gateways: api.ManualGateways;
-    manual_tax_calculators: api.ManualTaxCalculators;
-    markets: api.Markets;
-    merchants: api.Merchants;
-    order_amount_promotion_rules: api.OrderAmountPromotionRules;
-    order_copies: api.OrderCopies;
-    order_subscriptions: api.OrderSubscriptions;
-    order_validation_rules: api.OrderValidationRules;
-    orders: api.Orders;
-    organization: api.Organizations;
-    packages: api.Packages;
-    parcel_line_items: api.ParcelLineItems;
-    parcels: api.Parcels;
-    payment_gateways: api.PaymentGateways;
-    payment_methods: api.PaymentMethods;
-    paypal_gateways: api.PaypalGateways;
-    paypal_payments: api.PaypalPayments;
-    percentage_discount_promotions: api.PercentageDiscountPromotions;
-    price_lists: api.PriceLists;
-    prices: api.Prices;
-    promotion_rules: api.PromotionRules;
-    promotions: api.Promotions;
-    refunds: api.Refunds;
-    return_line_items: api.ReturnLineItems;
-    returns: api.Returns;
-    shipments: api.Shipments;
-    shipping_categories: api.ShippingCategories;
-    shipping_methods: api.ShippingMethods;
-    shipping_zones: api.ShippingZones;
-    sku_list_items: api.SkuListItems;
-    sku_list_promotion_rules: api.SkuListPromotionRules;
-    sku_lists: api.SkuLists;
-    sku_options: api.SkuOptions;
-    skus: api.Skus;
-    stock_items: api.StockItems;
-    stock_line_items: api.StockLineItems;
-    stock_locations: api.StockLocations;
-    stock_transfers: api.StockTransfers;
-    stripe_gateways: api.StripeGateways;
-    stripe_payments: api.StripePayments;
-    tax_calculators: api.TaxCalculators;
-    tax_categories: api.TaxCategories;
-    tax_rules: api.TaxRules;
-    taxjar_accounts: api.TaxjarAccounts;
-    transactions: api.Transactions;
-    voids: api.Voids;
-    webhooks: api.Webhooks;
-    wire_transfers: api.WireTransfers;
-    constructor(config: CommerceLayerInitConfig);
-    get currentOrganization(): string;
-    private localConfig;
-    config(config: CommerceLayerConfig): void;
-    resources(): readonly string[];
-    isApiError(error: any): error is ApiError;
-    addRequestInterceptor(onFulfilled?: RequestInterceptor, onRejected?: ErrorInterceptor): number;
-    addResponseInterceptor(onFulfilled?: ResponseInterceptor, onRejected?: ErrorInterceptor): number;
-    removeInterceptor(type: InterceptorType, id: number): void;
-    addRawResponseReader(): RawResponseReader;
-    removeRawResponseReader(reader: number | RawResponseReader): void;
-}
-declare const CommerceLayer: (config: CommerceLayerInitConfig) => CommerceLayerClient;
-export default CommerceLayer;
-export type { CommerceLayerClient, CommerceLayerConfig, CommerceLayerInitConfig };
+import*as api from'./api';import{ApiError}from'./error';import type{ErrorInterceptor,InterceptorType,RawResponseReader,RequestInterceptor,ResponseInterceptor}from'./interceptor';import{ResourcesInitConfig}from'./resource';declare type SdkConfig={};declare type CommerceLayerInitConfig=SdkConfig&ResourcesInitConfig;declare type CommerceLayerConfig=Partial<CommerceLayerInitConfig>;declare class CommerceLayerClient{#private;static get openApiSchemaVersion():string;addresses:api.Addresses;adjustments:api.Adjustments;adyen_gateways:api.AdyenGateways;adyen_payments:api.AdyenPayments;application:api.Applications;attachments:api.Attachments;authorizations:api.Authorizations;avalara_accounts:api.AvalaraAccounts;billing_info_validation_rules:api.BillingInfoValidationRules;bing_geocoders:api.BingGeocoders;braintree_gateways:api.BraintreeGateways;braintree_payments:api.BraintreePayments;bundles:api.Bundles;captures:api.Captures;carrier_accounts:api.CarrierAccounts;checkout_com_gateways:api.CheckoutComGateways;checkout_com_payments:api.CheckoutComPayments;coupon_codes_promotion_rules:api.CouponCodesPromotionRules;coupon_recipients:api.CouponRecipients;coupons:api.Coupons;customer_addresses:api.CustomerAddresses;customer_groups:api.CustomerGroups;customer_password_resets:api.CustomerPasswordResets;customer_payment_sources:api.CustomerPaymentSources;customer_subscriptions:api.CustomerSubscriptions;customers:api.Customers;delivery_lead_times:api.DeliveryLeadTimes;event_callbacks:api.EventCallbacks;external_gateways:api.ExternalGateways;external_payments:api.ExternalPayments;external_promotions:api.ExternalPromotions;external_tax_calculators:api.ExternalTaxCalculators;fixed_amount_promotions:api.FixedAmountPromotions;fixed_price_promotions:api.FixedPricePromotions;free_gift_promotions:api.FreeGiftPromotions;free_shipping_promotions:api.FreeShippingPromotions;geocoders:api.Geocoders;gift_card_recipients:api.GiftCardRecipients;gift_cards:api.GiftCards;google_geocoders:api.GoogleGeocoders;imports:api.Imports;in_stock_subscriptions:api.InStockSubscriptions;inventory_models:api.InventoryModels;inventory_return_locations:api.InventoryReturnLocations;inventory_stock_locations:api.InventoryStockLocations;klarna_gateways:api.KlarnaGateways;klarna_payments:api.KlarnaPayments;line_item_options:api.LineItemOptions;line_items:api.LineItems;manual_gateways:api.ManualGateways;manual_tax_calculators:api.ManualTaxCalculators;markets:api.Markets;merchants:api.Merchants;order_amount_promotion_rules:api.OrderAmountPromotionRules;order_copies:api.OrderCopies;order_subscriptions:api.OrderSubscriptions;order_validation_rules:api.OrderValidationRules;orders:api.Orders;organization:api.Organizations;packages:api.Packages;parcel_line_items:api.ParcelLineItems;parcels:api.Parcels;payment_gateways:api.PaymentGateways;payment_methods:api.PaymentMethods;paypal_gateways:api.PaypalGateways;paypal_payments:api.PaypalPayments;percentage_discount_promotions:api.PercentageDiscountPromotions;price_lists:api.PriceLists;prices:api.Prices;promotion_rules:api.PromotionRules;promotions:api.Promotions;refunds:api.Refunds;return_line_items:api.ReturnLineItems;returns:api.Returns;shipments:api.Shipments;shipping_categories:api.ShippingCategories;shipping_methods:api.ShippingMethods;shipping_zones:api.ShippingZones;sku_list_items:api.SkuListItems;sku_list_promotion_rules:api.SkuListPromotionRules;sku_lists:api.SkuLists;sku_options:api.SkuOptions;skus:api.Skus;stock_items:api.StockItems;stock_line_items:api.StockLineItems;stock_locations:api.StockLocations;stock_transfers:api.StockTransfers;stripe_gateways:api.StripeGateways;stripe_payments:api.StripePayments;tax_calculators:api.TaxCalculators;tax_categories:api.TaxCategories;tax_rules:api.TaxRules;taxjar_accounts:api.TaxjarAccounts;transactions:api.Transactions;voids:api.Voids;webhooks:api.Webhooks;wire_transfers:api.WireTransfers;constructor(config:CommerceLayerInitConfig);get currentOrganization():string;private localConfig;config(config:CommerceLayerConfig):void;resources():readonly string[];isApiError(error:any):error is ApiError;addRequestInterceptor(onFulfilled?:RequestInterceptor,onRejected?:ErrorInterceptor):number;addResponseInterceptor(onFulfilled?:ResponseInterceptor,onRejected?:ErrorInterceptor):number;removeInterceptor(type:InterceptorType,id:number):void;addRawResponseReader():RawResponseReader;removeRawResponseReader(reader:number|RawResponseReader):void;}declare const CommerceLayer:(config:CommerceLayerInitConfig)=>CommerceLayerClient;export default CommerceLayer;export type{CommerceLayerClient,CommerceLayerConfig,CommerceLayerInitConfig};