[DE-248] DE-252 Typescript SDK - regenerating code (#3)

* Automated commit message * Automated commit message * Automated commit message --------- Co-authored-by: maxio-sdk <maxio-sdk@maxio.com>
maxio-com · Oct 26, 2023 · 9ad1f55 · 9ad1f55
1 parent 84b3b4d
commit 9ad1f55
Show file tree

Hide file tree

Showing 371 changed files with 3,112 additions and 4,706 deletions.
diff --git a/README.md b/README.md
@@ -332,7 +332,7 @@ npm install
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
@@ -396,40 +396,40 @@ This API uses `Basic Authentication`.
 
 ## List of APIs
 
-* [API Exports](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/api-exports.md)
-* [Advance Invoice](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/advance-invoice.md)
-* [Billing Portal](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/billing-portal.md)
-* [Custom Fields](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/custom-fields.md)
-* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/events-based-billing-segments.md)
-* [Payment Profiles](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/payment-profiles.md)
-* [Product Families](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/product-families.md)
-* [Product Price Points](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/product-price-points.md)
-* [Proforma Invoices](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/proforma-invoices.md)
-* [Reason Codes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/reason-codes.md)
-* [Referral Codes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/referral-codes.md)
-* [Sales Commissions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/sales-commissions.md)
-* [Subscription Components](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/subscription-components.md)
-* [Subscription Groups](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/subscription-groups.md)
-* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/subscription-group-invoice-account.md)
-* [Subscription Group Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/subscription-group-status.md)
-* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/subscription-invoice-account.md)
-* [Subscription Notes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/subscription-notes.md)
-* [Subscription Products](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/subscription-products.md)
-* [Subscription Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/subscription-status.md)
-* [Coupons](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/coupons.md)
-* [Components](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/components.md)
-* [Customers](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/customers.md)
-* [Events](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/events.md)
-* [Insights](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/insights.md)
-* [Invoices](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/invoices.md)
-* [Offers](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/offers.md)
-* [Products](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/products.md)
-* [Sites](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/sites.md)
-* [Subscriptions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/subscriptions.md)
-* [Webhooks](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/controllers/webhooks.md)
+* [API Exports](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/api-exports.md)
+* [Advance Invoice](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/advance-invoice.md)
+* [Billing Portal](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/billing-portal.md)
+* [Custom Fields](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/custom-fields.md)
+* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/events-based-billing-segments.md)
+* [Payment Profiles](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/payment-profiles.md)
+* [Product Families](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/product-families.md)
+* [Product Price Points](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/product-price-points.md)
+* [Proforma Invoices](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/proforma-invoices.md)
+* [Reason Codes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/reason-codes.md)
+* [Referral Codes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/referral-codes.md)
+* [Sales Commissions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/sales-commissions.md)
+* [Subscription Components](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/subscription-components.md)
+* [Subscription Groups](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/subscription-groups.md)
+* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/subscription-group-invoice-account.md)
+* [Subscription Group Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/subscription-group-status.md)
+* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/subscription-invoice-account.md)
+* [Subscription Notes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/subscription-notes.md)
+* [Subscription Products](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/subscription-products.md)
+* [Subscription Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/subscription-status.md)
+* [Coupons](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/coupons.md)
+* [Components](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/components.md)
+* [Customers](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/customers.md)
+* [Events](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/events.md)
+* [Insights](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/insights.md)
+* [Invoices](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/invoices.md)
+* [Offers](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/offers.md)
+* [Products](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/products.md)
+* [Sites](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/sites.md)
+* [Subscriptions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/subscriptions.md)
+* [Webhooks](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/controllers/webhooks.md)
 
 ## Classes Documentation
 
-* [ApiResponse](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/api-response.md)
-* [ApiError](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.1/doc/api-error.md)
+* [ApiResponse](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/api-response.md)
+* [ApiError](https://www.github.com/maxio-com/ab-typescript-sdk/tree/0.0.4/doc/api-error.md)
 
diff --git a/doc/controllers/components.md b/doc/controllers/components.md
@@ -979,15 +979,20 @@ const componentId = 222;
 
 const body: CreateComponentPricePointRequest = {
   pricePoint: {
-    name: 'Special Pricing',
-    pricingScheme: 'per_unit',
+    name: 'Wholesale',
+    pricingScheme: 'stairstep',
     prices: [
       {
-        startingQuantity: 1,
-        unitPrice: 5,
+        startingQuantity: '1',
+        unitPrice: '5.00',
+        endingQuantity: '100',
+      },
+      {
+        startingQuantity: '101',
+        unitPrice: '4.00',
       }
     ],
-    handle: 'special',
+    handle: 'wholesale-handle',
   },
 };
 

diff --git a/doc/controllers/custom-fields.md b/doc/controllers/custom-fields.md
@@ -107,6 +107,39 @@ try {
 }
 ```
 
+## Example Response *(as JSON)*
+
+```json
+[
+  {
+    "name": "Color",
+    "scope": {
+      "hosted": [],
+      "csv": "0",
+      "statements": "0",
+      "invoices": "0",
+      "portal": "0"
+    },
+    "data_count": 0,
+    "input_type": "text",
+    "enum": null
+  },
+  {
+    "name": "Brand",
+    "scope": {
+      "hosted": [],
+      "csv": "0",
+      "statements": "0",
+      "invoices": "0",
+      "portal": "0"
+    },
+    "data_count": 0,
+    "input_type": "text",
+    "enum": null
+  }
+]
+```
+
 
 # List Metafields
 
@@ -168,6 +201,34 @@ try {
 }
 ```
 
+## Example Response *(as JSON)*
+
+```json
+{
+  "total_count": 0,
+  "current_page": 0,
+  "total_pages": 0,
+  "per_page": 0,
+  "metafields": [
+    {
+      "id": 0,
+      "name": "string",
+      "scope": {
+        "csv": "0",
+        "statements": "0",
+        "invoices": "0",
+        "portal": "0",
+        "public_show": "0",
+        "public_edit": "0"
+      },
+      "data_count": 0,
+      "input_type": "string",
+      "enum": null
+    }
+  ]
+}
+```
+
 
 # Update Metafield
 

diff --git a/doc/controllers/customers.md b/doc/controllers/customers.md
@@ -164,6 +164,7 @@ To retrieve a single, exact match by reference, please use the [lookup endpoint]
 
 ```ts
 async listCustomers(
+  direction?: ListCustomersDirection,
   page?: number,
   perPage?: number,
   dateField?: BasicDateField,
@@ -180,6 +181,7 @@ async listCustomers(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
+| `direction` | [`ListCustomersDirection \| undefined`](../../doc/models/containers/list-customers-direction.md) | Query, Optional | This is a container for one-of cases. |
 | `page` | `number \| undefined` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.<br>Use in query `page=1`.<br>**Default**: `1`<br>**Constraints**: `>= 1` |
 | `perPage` | `number \| undefined` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 50. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.<br>Use in query `per_page=200`.<br>**Default**: `50`<br>**Constraints**: `<= 200` |
 | `dateField` | [`BasicDateField \| undefined`](../../doc/models/basic-date-field.md) | Query, Optional | The type of filter you would like to apply to your search.<br>Use in query: `date_field=created_at`. |
@@ -207,6 +209,7 @@ try {
   // @ts-expect-error: unused variables
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   const { result, ...httpResponse } = await customersController.listCustomers(
+  undefined,
   page,
   perPage,
   dateField

diff --git a/doc/controllers/events.md b/doc/controllers/events.md
@@ -158,6 +158,68 @@ try {
 }
 ```
 
+## Example Response *(as JSON)*
+
+```json
+[
+  {
+    "event": {
+      "id": 343087780,
+      "key": "subscription_state_change",
+      "message": "State changed on Test subscription to Monthly Product from active to past_due",
+      "subscription_id": 14950962,
+      "customer_id": 12345678,
+      "created_at": "2016-10-27T16:42:22-04:00",
+      "event_specific_data": {
+        "previous_subscription_state": "active",
+        "new_subscription_state": "past_due"
+      }
+    }
+  },
+  {
+    "event": {
+      "id": 343087742,
+      "key": "billing_date_change",
+      "message": "Billing date changed on Test's subscription to Monthly Product from 11/27/2016 to 10/27/2016",
+      "subscription_id": 14950962,
+      "customer_id": 12345678,
+      "created_at": "2016-10-27T16:42:19-04:00",
+      "event_specific_data": null
+    }
+  },
+  {
+    "event": {
+      "id": 343085267,
+      "key": "statement_closed",
+      "message": "Statement 79401838 closed (but not settled) for Test's subscription to ANNUAL product",
+      "subscription_id": 14950975,
+      "customer_id": 87654321,
+      "created_at": "2016-10-27T16:40:40-04:00",
+      "event_specific_data": null
+    }
+  },
+  {
+    "event": {
+      "id": 4481,
+      "key": "custom_field_value_change",
+      "message": "Custom field (Extra support included) changed for Subscription 117 from 'Yes' to 'No'.",
+      "subscription_id": 117,
+      "customer_id": 22334455,
+      "created_at": "2022-03-24T07:55:06-04:00",
+      "event_specific_data": {
+        "event_type": "updated",
+        "metafield_name": "Extra support included",
+        "metafield_id": 2,
+        "old_value": "Yes",
+        "new_value": "No",
+        "resource_type": "Subscription",
+        "resource_id": 117
+      }
+    }
+  }
+]
+```
+
 
 # List Subscription Events
 
@@ -235,6 +297,49 @@ try {
 }
 ```
 
+## Example Response *(as JSON)*
+
+```json
+[
+  {
+    "event": {
+      "id": 344799837,
+      "key": "statement_settled",
+      "message": "Statement 79702531 settled successfully for Amelia Example's subscription to Basic Plan",
+      "subscription_id": 14900541,
+      "customer_id": 77223344,
+      "created_at": "2016-11-01T12:41:29-04:00",
+      "event_specific_data": null
+    }
+  },
+  {
+    "event": {
+      "id": 344799815,
+      "key": "renewal_success",
+      "message": "Successful renewal for Amelia Example's subscription to Basic Plan",
+      "subscription_id": 14900541,
+      "customer_id": 77223344,
+      "created_at": "2016-11-01T12:41:28-04:00",
+      "event_specific_data": {
+        "product_id": 3792003,
+        "account_transaction_id": 7590246
+      }
+    }
+  },
+  {
+    "event": {
+      "id": 344799705,
+      "key": "billing_date_change",
+      "message": "Billing date changed on Amelia Example's subscription to Basic Plan from 11/26/2016 to 11/01/2016",
+      "subscription_id": 14900541,
+      "customer_id": 77223344,
+      "created_at": "2016-11-01T12:41:25-04:00",
+      "event_specific_data": null
+    }
+  }
+]
+```
+
 
 # Read Events Count
 
@@ -249,7 +354,7 @@ async readEventsCount(
   direction?: Direction,
   filter?: EventType[],
   requestOptions?: RequestOptions
-): Promise<ApiResponse<Count>>
+): Promise<ApiResponse<CountResponse>>
 ```
 
 ## Parameters
@@ -266,7 +371,7 @@ async readEventsCount(
 
 ## Response Type
 
-[`Count`](../../doc/models/count.md)
+[`CountResponse`](../../doc/models/count-response.md)
 
 ## Example Usage