@codat/lending 0.1.0 → 1.2.0

package/docs/sdks/salescustomers/README.md

@@ -0,0 +1,103 @@
+# Sales.Customers
+
+### Available Operations
+
+* [get](#get) - Get customer
+* [list](#list) - List customers
+
+## get
+
+The *Get customer* endpoint returns a single customer for a given customerId.
+
+[Customers](https://docs.codat.io/commerce-api#/schemas/Customer) are people or organizations that place orders, make payments and receive goods and/or services from the SMB.
+
+Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-customers) for integrations that support getting a specific customer.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { GetCommerceCustomerResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.sales.customers.get({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+  customerId: "iure",
+}).then((res: GetCommerceCustomerResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
+| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `request`                                                                                      | [operations.GetCommerceCustomerRequest](../../models/operations/getcommercecustomerrequest.md) | :heavy_check_mark:                                                                             | The request object to use for the request.                                                     |
+| `retries`                                                                                      | [utils.RetryConfig](../../models/utils/retryconfig.md)                                         | :heavy_minus_sign:                                                                             | Configuration to override the default retry behavior of the client.                            |
+| `config`                                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                   | :heavy_minus_sign:                                                                             | Available config options for making requests.                                                  |
+
+
+### Response
+
+**Promise<[operations.GetCommerceCustomerResponse](../../models/operations/getcommercecustomerresponse.md)>**
+
+
+## list
+
+The *List customers* endpoint returns a list of [customers](https://docs.codat.io/commerce-api#/schemas/Customer) for a given company's connection.
+
+[Customers](https://docs.codat.io/commerce-api#/schemas/Customer) are people or organizations that place orders, make payments and recieve goods and/or services from the SMB.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+    
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { ListCommerceCustomersResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.sales.customers.list({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+  orderBy: "-modifiedDate",
+  page: 1,
+  pageSize: 100,
+  query: "culpa",
+}).then((res: ListCommerceCustomersResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                          | Type                                                                                               | Required                                                                                           | Description                                                                                        |
+| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| `request`                                                                                          | [operations.ListCommerceCustomersRequest](../../models/operations/listcommercecustomersrequest.md) | :heavy_check_mark:                                                                                 | The request object to use for the request.                                                         |
+| `retries`                                                                                          | [utils.RetryConfig](../../models/utils/retryconfig.md)                                             | :heavy_minus_sign:                                                                                 | Configuration to override the default retry behavior of the client.                                |
+| `config`                                                                                           | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                       | :heavy_minus_sign:                                                                                 | Available config options for making requests.                                                      |
+
+
+### Response
+
+**Promise<[operations.ListCommerceCustomersResponse](../../models/operations/listcommercecustomersresponse.md)>**
+

package/docs/sdks/salesdisputes/README.md

@@ -0,0 +1,103 @@
+# Sales.Disputes
+
+### Available Operations
+
+* [get](#get) - Get dispute
+* [list](#list) - List disputes
+
+## get
+
+The *Get dispute* endpoint returns a single dispute for a given disputeId.
+
+[Disputes](https://docs.codat.io/commerce-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly.
+
+Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-disputes) for integrations that support getting a specific dispute.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { GetCommerceDisputeResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.sales.disputes.get({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+  disputeId: "doloribus",
+}).then((res: GetCommerceDisputeResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                    | Type                                                                                         | Required                                                                                     | Description                                                                                  |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `request`                                                                                    | [operations.GetCommerceDisputeRequest](../../models/operations/getcommercedisputerequest.md) | :heavy_check_mark:                                                                           | The request object to use for the request.                                                   |
+| `retries`                                                                                    | [utils.RetryConfig](../../models/utils/retryconfig.md)                                       | :heavy_minus_sign:                                                                           | Configuration to override the default retry behavior of the client.                          |
+| `config`                                                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                 | :heavy_minus_sign:                                                                           | Available config options for making requests.                                                |
+
+
+### Response
+
+**Promise<[operations.GetCommerceDisputeResponse](../../models/operations/getcommercedisputeresponse.md)>**
+
+
+## list
+
+The *List disputes* endpoint returns a list of [disputes](https://docs.codat.io/commerce-api#/schemas/Dispute) for a given company's connection.
+
+[Disputes](https://docs.codat.io/commerce-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+    
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { ListCommerceDisputesResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.sales.disputes.list({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+  orderBy: "-modifiedDate",
+  page: 1,
+  pageSize: 100,
+  query: "sapiente",
+}).then((res: ListCommerceDisputesResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `request`                                                                                        | [operations.ListCommerceDisputesRequest](../../models/operations/listcommercedisputesrequest.md) | :heavy_check_mark:                                                                               | The request object to use for the request.                                                       |
+| `retries`                                                                                        | [utils.RetryConfig](../../models/utils/retryconfig.md)                                           | :heavy_minus_sign:                                                                               | Configuration to override the default retry behavior of the client.                              |
+| `config`                                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                     | :heavy_minus_sign:                                                                               | Available config options for making requests.                                                    |
+
+
+### Response
+
+**Promise<[operations.ListCommerceDisputesResponse](../../models/operations/listcommercedisputesresponse.md)>**
+

package/docs/sdks/saleslocations/README.md

@@ -0,0 +1,99 @@
+# Sales.Locations
+
+### Available Operations
+
+* [get](#get) - Get location
+* [list](#list) - List locations
+
+## get
+
+The *Get location* endpoint returns a single location for a given locationId.
+
+[Locations](https://docs.codat.io/commerce-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/commerce-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/commerce-api#/schemas/Order) were placed.
+
+Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-locations) for integrations that support getting a specific location.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { GetCommerceLocationResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.sales.locations.get({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+  locationId: "architecto",
+}).then((res: GetCommerceLocationResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
+| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `request`                                                                                      | [operations.GetCommerceLocationRequest](../../models/operations/getcommercelocationrequest.md) | :heavy_check_mark:                                                                             | The request object to use for the request.                                                     |
+| `retries`                                                                                      | [utils.RetryConfig](../../models/utils/retryconfig.md)                                         | :heavy_minus_sign:                                                                             | Configuration to override the default retry behavior of the client.                            |
+| `config`                                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                   | :heavy_minus_sign:                                                                             | Available config options for making requests.                                                  |
+
+
+### Response
+
+**Promise<[operations.GetCommerceLocationResponse](../../models/operations/getcommercelocationresponse.md)>**
+
+
+## list
+
+The *List locations* endpoint returns a list of [locations](https://docs.codat.io/commerce-api#/schemas/Location) for a given company's connection.
+
+[Locations](https://docs.codat.io/commerce-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/commerce-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/commerce-api#/schemas/Order) were placed.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+    
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { ListCommerceLocationsResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.sales.locations.list({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+}).then((res: ListCommerceLocationsResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                          | Type                                                                                               | Required                                                                                           | Description                                                                                        |
+| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| `request`                                                                                          | [operations.ListCommerceLocationsRequest](../../models/operations/listcommercelocationsrequest.md) | :heavy_check_mark:                                                                                 | The request object to use for the request.                                                         |
+| `retries`                                                                                          | [utils.RetryConfig](../../models/utils/retryconfig.md)                                             | :heavy_minus_sign:                                                                                 | Configuration to override the default retry behavior of the client.                                |
+| `config`                                                                                           | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                       | :heavy_minus_sign:                                                                                 | Available config options for making requests.                                                      |
+
+
+### Response
+
+**Promise<[operations.ListCommerceLocationsResponse](../../models/operations/listcommercelocationsresponse.md)>**
+

package/docs/sdks/salesmetrics/README.md

@@ -0,0 +1,218 @@
+# Sales.Metrics
+
+### Available Operations
+
+* [getCustomerRetention](#getcustomerretention) - Get customer retention metrics
+* [getLifetimeValue](#getlifetimevalue) - Get lifetime value metrics
+* [getRevenue](#getrevenue) - Get commerce revenue metrics
+
+## getCustomerRetention
+
+The *Get customer retention metrics* endpoint returns customer retention insights for a specific company's commerce connection over one or more periods of time.
+
+This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. 
+
+#### Customer retention metrics
+
+- __Existing customers__: the number of unique customers that have placed an order(s) in the specified period and any previous period. 
+- __New customers__: the number of unique customers that have placed an order(s) in the specified period and none in any previous period.
+- __Total customers__: the total number of existing and new customers within the specified period.
+- __Retention rate__: the ratio of existing customers within the specified period compared to the total customers at the end of the previous period represented as a percentage.
+- __Repeat rate__: the ratio of existing customers to total customers over the specified period represented as a percentage.
+
+Learn more about the formulas used to calculate customer retention metrics [here](https://docs.codat.io/lending/commerce-metrics/overview#what-metrics-are-available).
+
+#### Response structure
+
+The Customer retention report's dimensions and measures are:
+
+| Index                       | Dimensions                 |
+|-----------------------------|----------------------------|
+| `index` = 0                 | Period                     |
+| `index` = 1                 | Customer retention metrics |
+
+| Index                | Measures    |
+|----------------------|------------|
+| `index` = 0          | Count      |
+| `index` = 1          | Percentage |
+
+The report data then combines multiple reporting dimensions and measures and outputs the value of each combination.
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { GetCommerceCustomerRetentionMetricsResponse } from "@codat/lending/dist/sdk/models/operations";
+import { PeriodUnit } from "@codat/lending/dist/sdk/models/shared";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.sales.metrics.getCustomerRetention({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+  includeDisplayNames: false,
+  numberOfPeriods: 652790,
+  periodLength: 208876,
+  periodUnit: PeriodUnit.Month,
+  reportDate: "29-09-2020",
+}).then((res: GetCommerceCustomerRetentionMetricsResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                                                      | Type                                                                                                                           | Required                                                                                                                       | Description                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                      | [operations.GetCommerceCustomerRetentionMetricsRequest](../../models/operations/getcommercecustomerretentionmetricsrequest.md) | :heavy_check_mark:                                                                                                             | The request object to use for the request.                                                                                     |
+| `retries`                                                                                                                      | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                                         | :heavy_minus_sign:                                                                                                             | Configuration to override the default retry behavior of the client.                                                            |
+| `config`                                                                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                                   | :heavy_minus_sign:                                                                                                             | Available config options for making requests.                                                                                  |
+
+
+### Response
+
+**Promise<[operations.GetCommerceCustomerRetentionMetricsResponse](../../models/operations/getcommercecustomerretentionmetricsresponse.md)>**
+
+
+## getLifetimeValue
+
+The *Get lifetime value metrics* endpoint returns the average revenue that a specific company will generate throughout its lifespan over one or more periods of time.
+
+This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.
+
+Learn more about the formulas used to calculate the lifetime value metrics [here](https://docs.codat.io/lending/commerce-metrics/overview#what-metrics-are-available).
+
+Refer to the [commerce reporting structure](https://docs.codat.io/lending/commerce-metrics/reporting-structure) page for more detail on commerce reports in Lending.
+
+#### Response structure
+
+The Lifetime value report's dimensions and measures are:
+
+| Index         | Dimensions             |
+|---------------|------------------------|
+| `index` = 0   | Period                 |
+| `index` = 1   | Lifetime value metrics |
+
+| Index             | Measures |
+|-------------------|---------|
+|   `index` = 1     | Value   |
+
+The report data then combines multiple reporting dimensions and measures and outputs the value of each combination.
+
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { GetCommerceLifetimeValueMetricsResponse } from "@codat/lending/dist/sdk/models/operations";
+import { PeriodUnit } from "@codat/lending/dist/sdk/models/shared";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.sales.metrics.getLifetimeValue({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+  includeDisplayNames: false,
+  numberOfPeriods: 161309,
+  periodLength: 995300,
+  periodUnit: PeriodUnit.Month,
+  reportDate: "29-09-2020",
+}).then((res: GetCommerceLifetimeValueMetricsResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                                              | Type                                                                                                                   | Required                                                                                                               | Description                                                                                                            |
+| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| `request`                                                                                                              | [operations.GetCommerceLifetimeValueMetricsRequest](../../models/operations/getcommercelifetimevaluemetricsrequest.md) | :heavy_check_mark:                                                                                                     | The request object to use for the request.                                                                             |
+| `retries`                                                                                                              | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                                 | :heavy_minus_sign:                                                                                                     | Configuration to override the default retry behavior of the client.                                                    |
+| `config`                                                                                                               | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                           | :heavy_minus_sign:                                                                                                     | Available config options for making requests.                                                                          |
+
+
+### Response
+
+**Promise<[operations.GetCommerceLifetimeValueMetricsResponse](../../models/operations/getcommercelifetimevaluemetricsresponse.md)>**
+
+
+## getRevenue
+
+The *Get revenue report* endpoint returns the revenue and revenue growth for a specific company connection over one or more periods of time.
+
+This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. 
+
+Learn more about the formulas used to calculate the revenue metrics [here](https://docs.codat.io/lending/commerce-metrics/overview#what-metrics-are-available).
+
+Refer to the [commerce reporting structure](https://docs.codat.io/lending/commerce-metrics/reporting-structure) page for more details on commerce reports in Lending.
+
+#### Response structure
+
+The Revenue report's dimensions and measures are:
+
+| Index         | Dimensions |
+|---------------|------------|
+|   `index` = 0 | Period     |
+|   `index` = 1 | Revenue    |
+
+| Index         | Measures                                                                                                                 |
+|---------------|--------------------------------------------------------------------------------------------------------------------------|
+| `index` = 0   | Value                                                                                                                    |
+| `index` = 1   | Percentage change, defined as the change between the current and previous periods' values and expressed as a percentage. |
+
+The report data then combines multiple reporting dimensions and measures and outputs the value of each combination.
+
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { GetCommerceRevenueMetricsResponse } from "@codat/lending/dist/sdk/models/operations";
+import { PeriodUnit } from "@codat/lending/dist/sdk/models/shared";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.sales.metrics.getRevenue({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+  includeDisplayNames: false,
+  numberOfPeriods: 581850,
+  periodLength: 253291,
+  periodUnit: PeriodUnit.Week,
+  reportDate: "29-09-2020",
+}).then((res: GetCommerceRevenueMetricsResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                                  | Type                                                                                                       | Required                                                                                                   | Description                                                                                                |
+| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `request`                                                                                                  | [operations.GetCommerceRevenueMetricsRequest](../../models/operations/getcommercerevenuemetricsrequest.md) | :heavy_check_mark:                                                                                         | The request object to use for the request.                                                                 |
+| `retries`                                                                                                  | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                     | :heavy_minus_sign:                                                                                         | Configuration to override the default retry behavior of the client.                                        |
+| `config`                                                                                                   | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                               | :heavy_minus_sign:                                                                                         | Available config options for making requests.                                                              |
+
+
+### Response
+
+**Promise<[operations.GetCommerceRevenueMetricsResponse](../../models/operations/getcommercerevenuemetricsresponse.md)>**
+

package/docs/sdks/salesorders/README.md

@@ -0,0 +1,103 @@
+# Sales.Orders
+
+### Available Operations
+
+* [get](#get) - Get order
+* [list](#list) - List orders
+
+## get
+
+The *Get order* endpoint returns a single order for a given orderId.
+
+[Orders](https://docs.codat.io/commerce-api#/schemas/Order) contain the transaction details for all products sold by the company.
+
+Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-orders) for integrations that support getting a specific order.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { GetCommerceOrderResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.sales.orders.get({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+  orderId: "quam",
+}).then((res: GetCommerceOrderResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                | Type                                                                                     | Required                                                                                 | Description                                                                              |
+| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `request`                                                                                | [operations.GetCommerceOrderRequest](../../models/operations/getcommerceorderrequest.md) | :heavy_check_mark:                                                                       | The request object to use for the request.                                               |
+| `retries`                                                                                | [utils.RetryConfig](../../models/utils/retryconfig.md)                                   | :heavy_minus_sign:                                                                       | Configuration to override the default retry behavior of the client.                      |
+| `config`                                                                                 | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                             | :heavy_minus_sign:                                                                       | Available config options for making requests.                                            |
+
+
+### Response
+
+**Promise<[operations.GetCommerceOrderResponse](../../models/operations/getcommerceorderresponse.md)>**
+
+
+## list
+
+The *List orders* endpoint returns a list of [orders](https://docs.codat.io/commerce-api#/schemas/Order) for a given company's connection.
+
+[Orders](https://docs.codat.io/commerce-api#/schemas/Order) contain the transaction details for all products sold by the company.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+    
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { ListCommerceOrdersResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.sales.orders.list({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+  orderBy: "-modifiedDate",
+  page: 1,
+  pageSize: 100,
+  query: "molestiae",
+}).then((res: ListCommerceOrdersResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                    | Type                                                                                         | Required                                                                                     | Description                                                                                  |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `request`                                                                                    | [operations.ListCommerceOrdersRequest](../../models/operations/listcommerceordersrequest.md) | :heavy_check_mark:                                                                           | The request object to use for the request.                                                   |
+| `retries`                                                                                    | [utils.RetryConfig](../../models/utils/retryconfig.md)                                       | :heavy_minus_sign:                                                                           | Configuration to override the default retry behavior of the client.                          |
+| `config`                                                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                 | :heavy_minus_sign:                                                                           | Available config options for making requests.                                                |
+
+
+### Response
+
+**Promise<[operations.ListCommerceOrdersResponse](../../models/operations/listcommerceordersresponse.md)>**
+