@commercelayer/sdk 5.0.0-alpha.4 → 5.0.0-beta.1

package/README.md

@@ -7,45 +7,56 @@
 [![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/developers/).
+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?
+## What is Commerce Layer?
 
 [Commerce Layer](https://commercelayer.io) is a multi-market commerce API and order management system that lets you add global shopping capabilities to any website, mobile app, chatbot, wearable, voice, or IoT device, with ease. Compose your stack with the best-of-breed tools you already mastered and love. Make any experience shoppable, anywhere, through a blazing-fast, enterprise-grade, and secure API.
 
-# Getting started
-
-To get started with Commerce Layer JS SDK you need to install it and then get the credentials that will allow you to perform your API calls.
+## Table of contents
 
+- [Getting started](#getting-started)
 - [Installation](#installation)
 - [Authentication](#authentication)
 - [Import](#import)
+- [SDK usage](#sdk-usage)
+- [Overriding credentials](#overriding-credentials)
+- [Handling validation errors](#handling-validation-errors)
+- [Contributors guide](#contributors-guide)
+- [Need help?](#need-help)
+- [License](#license)
+
+---
+
+## Getting started
+
+To get started with Commerce Layer JS SDK you need to install it, get the credentials that will allow you to perform your API calls, and import the SDK into your application's code. The sections below explain how to achieve this.
+
+> If you want, you can also read [this tutorial](https://commercelayer.io/blog/getting-started-with-commerce-layer-javascript-sdk) from Commerce Layer's blog.
 
-## Installation
+### Installation
 
-Commerce Layer JS SDK is available as an [npm package](https://www.npmjs.com/package/@commercelayer/sdk):
+Commerce Layer JS SDK is available as an [npm](https://www.npmjs.com/package/@commercelayer/sdk) and [yarn](https://yarnpkg.com/package/@commercelayer/sdk) package that you can install with the command below:
 
 ```shell
-// npm
 npm install @commercelayer/sdk
 
-// yarn
+// or
+
 yarn add @commercelayer/sdk
 ```
 
-## Authentication
+### 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/developers/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. Kindly 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.
 
-## Import
+### Import
 
-You can use the ES6 default import with the SDK as follow:
+You can use the ES6 default import with the SDK like so:
 
-```typescript
+```javascript
 import CommerceLayer from '@commercelayer/sdk'
 
 const cl = CommerceLayer({
@@ -54,210 +65,257 @@ 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/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 / List
+## SDK usage
 
-  - [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 fetch resource relationships](#how-to-fetch-resource-relationships)
+The JavaScript SDK is a wrapper around Commerce Layer API which means you would still be making API requests but with a different syntax. For now, we don't have comprehensive SDK documentation for every single resource our API supports (about 400+ endpoints), hence you will need to rely on our comprehensive [API Reference](https://docs.commercelayer.io/core/v/api-reference) as you go about using this SDK. So for example, if you want to create an order, take a look at the [Order object](https://docs.commercelayer.io/core/v/api-reference/orders/object) or the [Create an order](https://docs.commercelayer.io/core/v/api-reference/orders/create) documentation to see the required attributes and/or relationships. The same goes for every other supported resource.
 
-- ### Update
+To show you how things work, we will use the [SKUs](https://docs.commercelayer.io/core/v/api-reference/skus) and [Shipping Categories](https://docs.commercelayer.io/core/v/api-reference/shipping_categories) resource in the following examples. The code snippets below show how to use the SDK when performing the standard CRUD operations provided by our REST API. Kindly check our [API reference](https://docs.commercelayer.io/core/v/api-reference) for the complete list of available **resources** and their **attributes**.
 
-  - [How to update an existing SKU](#how-to-update-an-existing-sku)
+### Create
 
-- ### Delete
+<details>
+<summary>How to create an SKU</summary>
+<br />
 
-  - [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)
+```javascript
+  // Select 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)',
+    description: "A very beautiful and cozy mens t-shirt",
+    weight: "500",
+    unit_of_weight: "gr"
     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/developers/v/api-reference/skus/create).
+ℹ️ Check our API reference for more information on how to [create an SKU](https://docs.commercelayer.io/developers/v/api-reference/skus/create).
+</details>
 
-## Retrieve / List
+### Retrieve / List
 
-### How to fetch a single SKU
+<details>
+<summary>How to fetch a single SKU</summary>
+<br />
 
-```typescript
-  // Fetches the SKU by ID
+```javascript
+  // Fetch the SKU by ID
   const sku = await cl.skus.retrieve('BxAkSVqKEn')
 
-  // Fetches the SKU by code
+  // Fetch all SKUs and filter by code
   const sku = await cl.skus.list({ filters: { code_eq: 'TSHIRTMM000000FFFFFFXLXX' } })
 
-  // Fetches the first SKU of the list
+  // Fetch the first SKU of the list
   const sku = (await cl.skus.list()).first()
 
-  // Fetches the last SKU of the list
+  // Fetch the last SKU of the list
   const sku = (await cl.skus.list()).last()
 ```
 
-Check our API reference for more information on how to [retrieve an SKU](https://docs.commercelayer.io/developers/v/api-reference/skus/retrieve).
+ℹ️ Check our API reference for more information on how to [retrieve an SKU](https://docs.commercelayer.io/developers/v/api-reference/skus/retrieve).
+</details>
 
-### How to fetch a collection of SKUs
+<details>
+<summary>How to fetch a collection of SKUs</summary>
+<br />
+
+```javascript
+  // Fetch all the SKUs
+  const skus = await cl.skus.list()
+```
 
-```typescript
-  // LISTING RESULTS
+When fetching a collection of resources you can leverage the `meta` attribute to get its `meta` information like so:
 
-  // Fetches all the SKUs
+```javascript
   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/developers/v/api-reference/skus/list).
+</details>
 
-  // SORTING RESULTS
+<details>
+<summary>How to fetch a collection of SKUs and sort the results</summary>
+<br />
 
-  // Sorts the results by creation date in ascending order (default)
+```javascript
+  // Sort the results by creation date in ascending order (default)
   const skus = await cl.skus.list({ sort: { created_at: 'asc' } })
 
-  // Sorts the results by creation date in descending order
+  // Sort the results by creation date in descending order
   const skus = await cl.skus.list({ sort: { created_at: 'desc' } })
+  ```
 
-  // INCLUDING ASSOCIATIONS
+ℹ️ Check our API reference for more information on how to [sort results](https://docs.commercelayer.io/developers/sorting-results).
+</details>
 
-  // Includes an association (prices)
+<details>
+<summary>How to fetch a collection of SKUs and include associations</summary>
+<br />
+
+```javascript
+  // Include an association (prices)
   const skus = await cl.skus.list({ include: [ 'prices' ] })
 
-  // SPARSE FIELDSETS
+  // Include an association (stock items)
+  const skus = await cl.skus.list({ include: [ 'stock_items' ] })
+  ```
+
+ℹ️ Check our API reference for more information on how to [include associations](https://docs.commercelayer.io/developers/including-associations).
+</details>
+
+<details>
+<summary>How to fetch a collection of SKUs and return specific fields (sparse fieldsets)</summary>
+<br />
 
-  // Requests the API to return only specific fields
+```javascript
+  // Request the API to return only specific fields
   const skus = await cl.skus.list({ fields: { skus: [ 'name', 'metadata' ] } })
 
-  // Requests the API to return only specific fields of the included resource
+  // Request the API to return only specific fields of the included resource
   const skus = await cl.skus.list({ include: [ 'prices' ], fields: { prices: [ 'currency_code', 'formatted_amount' ] } })
+  ```
 
-  // FILTERING DATA
+ℹ️ Check our API reference for more information on how to [use sparse fieldsets](https://docs.commercelayer.io/developers/sparse-fieldsets).
+</details>
 
-  // Filters all the SKUs fetching only the ones whose code starts with the string "TSHIRT"
+<details>
+<summary>How to fetch a collection of SKUs and filter data</summary>
+<br />
+
+```javascript
+  // Filter all the SKUs fetching only the ones whose code starts with the string "TSHIRT"
   const skus = await cl.skus.list({ filters: { code_start: 'TSHIRT' } })
 
-  // Filters all the SKUs fetching only the ones whose code ends with the string "XLXX"
+  // Filter all the SKUs fetching only the ones whose code ends with the string "XLXX"
   const skus = await cl.skus.list({ filters: { code_end: 'XLXX' } })
 
-  // Filters all the SKUs fetching only the ones whose name contains the string "White Logo"
+  // Filter all the SKUs fetching only the ones whose name contains the string "White Logo"
   const skus = await cl.skus.list({ filters: { name_cont: 'White Logo' } })
 
-  // Filters all the SKUs fetching only the ones created between two specific dates
-  // (filters combined according to an AND logic)
+  // Filter all the SKUs fetching only the ones created between two specific dates
+  // (filters combined according to the 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
-  // (attributes combined according to an OR logic)
+  // (attributes combined according to the 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/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).
+ℹ️ Check our API reference for more information on how to [filter data](https://docs.commercelayer.io/developers/filtering-data).
+</details>
 
-### How to paginate a collection of SKUs
+<details>
+<summary>How to paginate a collection of SKUs</summary>
+<br />
 
-When you fetch a collection of resources, you get paginated results:
+When you fetch a collection of resources, you get paginated results. You can request specific pages or items in a page like so:
 
-```typescript
-  // Fetches the SKUs, setting the page number to 3 and the page size to 5
+```javascript
+  // Fetch the SKUs, setting the page number to 3 and the page size to 5
   const skus = await cl.skus.list({ pageNumber: 3, pageSize: 5 })
 
-  // Gets the total number of SKUs in the collection
+  // Get the total number of SKUs in the collection
   const skuCount = skus.meta.recordCount
 
-  // Gets the total number of pages
+  // Get the total number of pages
   const pageCount = skus.meta.pageCount
 ```
 
-> The default page number is **1**. The default page size is **10**. The maximum page size allowed is **25**.
+> PS: the default page number is **1**, the default page size is **10**, and the maximum page size allowed is **25**.
 
-Check our API reference for more information on how [pagination](https://docs.commercelayer.io/developers/pagination) works.
+ℹ️ Check our API reference for more information on how [pagination](https://docs.commercelayer.io/developers/pagination) works.
+</details>
 
-### How to iterate through a collection of SKUs
+<details>
+<summary>How to iterate through a collection of SKUs</summary>
+<br />
 
-To execute a function for every item of a collection, use the `map()` method:
+To execute a function for every item of a collection, use the `map()` method like so:
 
-```typescript
-  // Fetches the whole list of SKUs (1st page) and prints their names and codes to console
+```javascript
+  // Fetch the whole list of SKUs (1st page) and print 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
+</details>
+
+<!-- <details>
+<summary>How to build complex queries</summary>
+<br />
+
+Coming soon...
+</details> -->
 
-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.
+<details>
+<summary>How to fetch resource relationships</summary>
+<br />
 
-```typescript
-// Fetches 1-to-1 related resource: billing address of an order
+Many resources have relationships with other resources and instead of including these associations as seen above, you can fetch them directly. This way, in the case of 1-to-N relationships, you can filter or sort the resulting collection as standard resources.
+
+```javascript
+// Fetch 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
+// Fetch 1-to-N related resources: orders associated to a customer
 const orders = cl.customers.orders('XyzKjAbCDe', { fields: ['status', 'number'] })
 ```
 
-## Update
+In general:
+
+- An API endpoint like `/api/customers` or `/api/customers/<customerId>` translates to `cl.customers` or `cl.customers('<customerId>')` with the SDK.
+- 1-to-1 relationship API endpoints like `/api/orders/<orderId>/shipping_address` translates to `cl.orders('<orderId>', { include: ['shipping_address'] }}` with the SDK.
+- 1-to-N relationship API endpoints like  `/api/customers/<customerId>?include=orders` or `/api/customers/<customerId>/orders` translates to `cl.customers.retrieve('customerId', { include: ['orders'] })` or `cl.customers.orders('<customerId>')` with the SDK.
+
+ℹ️ Check our API reference for more information on how to [fetch relationships](https://docs.commercelayer.io/core/fetching-relationships).
+</details>
 
-### How to update an existing SKU
+### Update
 
-```typescript
+<details>
+<summary>How to update an existing SKU</summary>
+<br />
+
+```javascript
   const sku = {
     id: 'xYZkjABcde',
-    description: 'Updated description.',
+    description: 'Updated description...',
     imageUrl: 'https://img.yourdomain.com/skus/new-image.png'
   }
 
   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/developers/v/api-reference/skus/update).
+ℹ️ Check our API reference for more information on how to [update an SKU](https://docs.commercelayer.io/developers/v/api-reference/skus/update).
+</details>
 
-## Delete
+### Delete
 
-### How to delete an existing SKU
+<details>
+<summary>How to delete an existing SKU</summary>
+<br />
 
-```typescript
+```javascript
   cl.skus.delete('xYZkjABcde') // persisted deletion
 ```
 
-Check our API reference for more information on how to [delete an SKU](https://docs.commercelayer.io/developers/v/api-reference/skus/delete).
+ℹ️ Check our API reference for more information on how to [delete an SKU](https://docs.commercelayer.io/developers/v/api-reference/skus/delete).
+</details>
 
-# Overriding credentials
+## 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 and 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
+```javascript
   // Permanently change configuration at client level
   cl.config({ organization: 'you-organization-slug', accessToken: 'your-access-token' })
   const skus = await cl.skus.list()
@@ -268,17 +326,17 @@ To do that, just use the `config()` method or pass the `options` parameter and a
   cl.skus.list({}, { organization: 'you-organization-slug', accessToken: 'your-access-token' })
 ```
 
-# Handling validation errors
+## Handling validation errors
 
 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:
-
+```javascript
+  // Log error messages to console:
   const attributes = { code: 'TSHIRTMM000000FFFFFFXL', name: '' }
 
   const newSku = await cl.skus.create(attributes).catch(error => console.log(error.errors))
 
+  // Logged errors
   /*
   [
     {
@@ -310,10 +368,30 @@ 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/developers/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.
 
----
+## Contributors guide
+
+1. Fork [this repository](https://github.com/commercelayer/commercelayer-sdk) (learn how to do this [here](https://help.github.com/articles/fork-a-repo)).
+
+2. Clone the forked repository like so:
+
+    ```shell
+    git clone https://github.com/<your username>/commercelayer-sdk.git && cd commercelayer-sdk
+    ```
+
+3. Make your changes and create a pull request ([learn how to do this](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)).
+
+4. Someone will attend to your pull request and provide some feedback.
+
+## Need help?
+
+1. Join [Commerce Layer's Slack community](https://slack.commercelayer.app).
+
+2. Create an [issue](https://github.com/commercelayer/commercelayer-cli/issues) in this repository.
+
+3. Ping us [on Twitter](https://twitter.com/commercelayer).
 
-### License
+## License
 
 This repository is published under the [MIT](LICENSE) license.

package/lib/cjs/api.d.ts

@@ -0,0 +1,113 @@
+/**
+ * ©2023 Commerce Layer Inc.
+ **/
+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 AxerveGateways } from './resources/axerve_gateways';
+export { default as AxervePayments } from './resources/axerve_payments';
+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 Cleanups } from './resources/cleanups';
+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 Events } from './resources/events';
+export { default as Exports } from './resources/exports';
+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 PriceTiers } from './resources/price_tiers';
+export { default as PriceVolumeTiers } from './resources/price_volume_tiers';
+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 SatispayGateways } from './resources/satispay_gateways';
+export { default as SatispayPayments } from './resources/satispay_payments';
+export { default as Shipments } from './resources/shipments';
+export { default as ShippingCategories } from './resources/shipping_categories';
+export { default as ShippingMethodTiers } from './resources/shipping_method_tiers';
+export { default as ShippingMethods } from './resources/shipping_methods';
+export { default as ShippingWeightTiers } from './resources/shipping_weight_tiers';
+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 type ResourceTypeLock = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'application' | 'attachments' | 'authorizations' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'captures' | 'carrier_accounts' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | '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' | 'events' | 'exports' | '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' | 'price_tiers' | 'price_volume_tiers' | 'prices' | 'promotion_rules' | 'promotions' | 'refunds' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | 'shipping_method_tiers' | 'shipping_methods' | 'shipping_weight_tiers' | '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", "axerve_gateways", "axerve_payments", "billing_info_validation_rules", "bing_geocoders", "braintree_gateways", "braintree_payments", "bundles", "captures", "carrier_accounts", "checkout_com_gateways", "checkout_com_payments", "cleanups", "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", "events", "exports", "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", "price_tiers", "price_volume_tiers", "prices", "promotion_rules", "promotions", "refunds", "return_line_items", "returns", "satispay_gateways", "satispay_payments", "shipments", "shipping_categories", "shipping_method_tiers", "shipping_methods", "shipping_weight_tiers", "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"];