orb-billing 1.19.2 → 1.20.0

package/docs/sdks/credit/README.md

@@ -16,50 +16,126 @@ The [Credit Ledger Entry resource](/guides/product-catalog/prepurchase) models p
 
 ## addByExternalId
 
-Create ledger entry by external ID
+This endpoint allows you to create a new ledger entry for a specified customer's balance. This can be used to
+increment balance, deduct credits, and change the expiry date of existing credits.
+
+## Effects of adding a ledger entry
+1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) will return a credit block that
+  represents the changes (i.e. balance changes or transfers).
+2. A ledger entry will be added to the credits ledger for this customer, and therefore returned in the
+  [View Credits Ledger](fetch-customer-credits) response as well as serialized in the response to this request. In
+  the case of deductions without a specified block, multiple ledger entries may be created if the deduction spans
+  credit blocks.
+3. If `invoice_settings` is specified, an invoice will be created that reflects the cost of the credits (based on
+  `amount` and `per_unit_cost_basis`).
+
+## Adding credits
+  Adding credits is done by creating an entry of type `increment`. This requires the caller to specify a number of
+  credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb also recommends specifying a description
+  to assist with auditing. When adding credits, the caller can also specify a cost basis per-credit, to indicate
+  how much in USD a customer paid for a single credit in a block. This can later be used for revenue recognition.
+
+The following snippet illustrates a sample request body to increment credits which will expire in January of 2022.
+
+```json
+{
+  "entry_type": "increment",
+  "amount": 100,
+  "expiry_date": "2022-12-28",
+  "per_unit_cost_basis": "0.20",
+  "description": "Purchased 100 credits"
+}
+```
+
+Note that by default, Orb will always first increment any _negative_ balance in existing blocks before adding the
+remaining amount to the desired credit block.
+
+### Invoicing for credits
+By default, Orb manipulates the credit ledger but does not charge for credits. However, if you pass
+`invoice_settings` in the body of this request, Orb will also generate a one-off invoice for the customer for the
+credits pre-purchase. Note that you _must_ provide the `per_unit_cost_basis`, since the total charges on the
+invoice are calculated by multiplying the cost basis with the number of credit units added.
+
+## Deducting Credits
+Orb allows you to deduct credits from a customer by creating an entry of type `decrement`. Orb matches the
+algorithm for automatic deductions for determining which credit blocks to decrement from. In the case that the
+deduction leads to multiple ledger entries, the response from this endpoint will be the final deduction. Orb also
+optionally allows specifying a description to assist with auditing.
+
+The following snippet illustrates a sample request body to decrement credits.
+
+```json
+{
+  "entry_type": "decrement",
+  "amount": 20,
+  "description": "Removing excess credits"
+}
+```
+
+## Changing credits expiry
+If you'd like to change when existing credits expire, you should create a ledger entry of type `expiration_change`.
+For this entry, the required parameter `expiry_date` identifies the _originating_ block, and the required parameter
+`target_expiry_date` identifies when the transferred credits should now expire. A new credit block will be created
+with expiry date `target_expiry_date`, with the same cost basis data as the original credit block, if present.
+
+Note that the balance of the block with the given `expiry_date` must be at least equal to the desired transfer
+amount determined by the `amount` parameter.
+
+The following snippet illustrates a sample request body to extend the expiration date of credits by one year:
+
+```json
+{
+  "entry_type": "expiration_change",
+  "amount": 10,
+  "expiry_date": "2022-12-28",
+  "block_id": "UiUhFWeLHPrBY4Ad",
+  "target_expiry_date": "2023-12-28",
+  "description": "Extending credit validity"
+}
+```
+
+## Voiding credits
+
+If you'd like to void a credit block, create a ledger entry of type `void`. For this entry, `block_id` is required
+to identify the block, and `amount` indicates how many credits to void, up to the block's initial balance. Pass
+in a `void_reason` of `refund` if the void is due to a refund.
+
+## Amendment
+
+If you'd like to undo a decrement on a credit block, create a ledger entry of type `amendment`. For this entry, `block_id`
+is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return
+to the customer, up to the block's initial balance.
 
 ### Example Usage
 
 ```typescript
 import { Orb } from "orb-billing";
-import { CreateLedgerEntryExternalIdResponse } from "orb-billing/dist/sdk/models/operations";
-import {
-  AddDecrementCreditLedgerEntryRequestParamsEntryType,
-  AddExpirationChangeCreditLedgerEntryRequestParamsEntryType,
-  AddIncrementCreditLedgerEntryRequestParamsEntryType,
-  AddVoidCreditLedgerEntryRequestParamsEntryType,
-  AddVoidCreditLedgerEntryRequestParamsVoidReason,
-} from "orb-billing/dist/sdk/models/shared";
-import { RFCDate } from "orb-billing/dist/sdk/types";
-
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.credit.addByExternalId({
-  requestBody: {
-    blockId: "navigate Southwest Silver",
-    description: "Fully-configurable object-oriented projection",
-    entryType: AddVoidCreditLedgerEntryRequestParamsEntryType.Void,
-    metadata: {},
-    voidReason: AddVoidCreditLedgerEntryRequestParamsVoidReason.Refund,
-  },
-  externalCustomerId: "misspend Rubidium",
-}).then((res: CreateLedgerEntryExternalIdResponse) => {
+import { CreateLedgerEntryExternalIdRequest } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const externalCustomerId: string = "walnut";
+const requestBody: any = "navigate";
+
+  const res = await sdk.credit.addByExternalId(externalCustomerId, requestBody);
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                                      | Type                                                                                                           | Required                                                                                                       | Description                                                                                                    |
-| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                      | [operations.CreateLedgerEntryExternalIdRequest](../../models/operations/createledgerentryexternalidrequest.md) | :heavy_check_mark:                                                                                             | The request object to use for the request.                                                                     |
-| `config`                                                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                   | :heavy_minus_sign:                                                                                             | Available config options for making requests.                                                                  |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `externalCustomerId`                                         | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `requestBody`                                                | *any*                                                        | :heavy_minus_sign:                                           | N/A                                                          |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 
 
 ### Response
@@ -69,49 +145,126 @@ sdk.credit.addByExternalId({
 
 ## create
 
-Create ledger entry
+This endpoint allows you to create a new ledger entry for a specified customer's balance. This can be used to
+increment balance, deduct credits, and change the expiry date of existing credits.
+
+## Effects of adding a ledger entry
+1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) will return a credit block that
+  represents the changes (i.e. balance changes or transfers).
+2. A ledger entry will be added to the credits ledger for this customer, and therefore returned in the
+  [View Credits Ledger](fetch-customer-credits) response as well as serialized in the response to this request. In
+  the case of deductions without a specified block, multiple ledger entries may be created if the deduction spans
+  credit blocks.
+3. If `invoice_settings` is specified, an invoice will be created that reflects the cost of the credits (based on
+  `amount` and `per_unit_cost_basis`).
+
+## Adding credits
+  Adding credits is done by creating an entry of type `increment`. This requires the caller to specify a number of
+  credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb also recommends specifying a description
+  to assist with auditing. When adding credits, the caller can also specify a cost basis per-credit, to indicate
+  how much in USD a customer paid for a single credit in a block. This can later be used for revenue recognition.
+
+The following snippet illustrates a sample request body to increment credits which will expire in January of 2022.
+
+```json
+{
+  "entry_type": "increment",
+  "amount": 100,
+  "expiry_date": "2022-12-28",
+  "per_unit_cost_basis": "0.20",
+  "description": "Purchased 100 credits"
+}
+```
+
+Note that by default, Orb will always first increment any _negative_ balance in existing blocks before adding the
+remaining amount to the desired credit block.
+
+### Invoicing for credits
+By default, Orb manipulates the credit ledger but does not charge for credits. However, if you pass
+`invoice_settings` in the body of this request, Orb will also generate a one-off invoice for the customer for the
+credits pre-purchase. Note that you _must_ provide the `per_unit_cost_basis`, since the total charges on the
+invoice are calculated by multiplying the cost basis with the number of credit units added.
+
+## Deducting Credits
+Orb allows you to deduct credits from a customer by creating an entry of type `decrement`. Orb matches the
+algorithm for automatic deductions for determining which credit blocks to decrement from. In the case that the
+deduction leads to multiple ledger entries, the response from this endpoint will be the final deduction. Orb also
+optionally allows specifying a description to assist with auditing.
+
+The following snippet illustrates a sample request body to decrement credits.
+
+```json
+{
+  "entry_type": "decrement",
+  "amount": 20,
+  "description": "Removing excess credits"
+}
+```
+
+## Changing credits expiry
+If you'd like to change when existing credits expire, you should create a ledger entry of type `expiration_change`.
+For this entry, the required parameter `expiry_date` identifies the _originating_ block, and the required parameter
+`target_expiry_date` identifies when the transferred credits should now expire. A new credit block will be created
+with expiry date `target_expiry_date`, with the same cost basis data as the original credit block, if present.
+
+Note that the balance of the block with the given `expiry_date` must be at least equal to the desired transfer
+amount determined by the `amount` parameter.
+
+The following snippet illustrates a sample request body to extend the expiration date of credits by one year:
+
+```json
+{
+  "entry_type": "expiration_change",
+  "amount": 10,
+  "expiry_date": "2022-12-28",
+  "block_id": "UiUhFWeLHPrBY4Ad",
+  "target_expiry_date": "2023-12-28",
+  "description": "Extending credit validity"
+}
+```
+
+## Voiding credits
+
+If you'd like to void a credit block, create a ledger entry of type `void`. For this entry, `block_id` is required
+to identify the block, and `amount` indicates how many credits to void, up to the block's initial balance. Pass
+in a `void_reason` of `refund` if the void is due to a refund.
+
+## Amendment
+
+If you'd like to undo a decrement on a credit block, create a ledger entry of type `amendment`. For this entry, `block_id`
+is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return
+to the customer, up to the block's initial balance.
 
 ### Example Usage
 
 ```typescript
 import { Orb } from "orb-billing";
-import { CreateLedgerEntryResponse } from "orb-billing/dist/sdk/models/operations";
-import {
-  AddDecrementCreditLedgerEntryRequestParamsEntryType,
-  AddExpirationChangeCreditLedgerEntryRequestParamsEntryType,
-  AddIncrementCreditLedgerEntryRequestParamsEntryType,
-  AddVoidCreditLedgerEntryRequestParamsEntryType,
-  AddVoidCreditLedgerEntryRequestParamsVoidReason,
-} from "orb-billing/dist/sdk/models/shared";
-import { RFCDate } from "orb-billing/dist/sdk/types";
-
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.credit.create({
-  requestBody: {
-    amount: 6384.24,
-    description: "Synchronised full-range emulation",
-    entryType: AddDecrementCreditLedgerEntryRequestParamsEntryType.Decrement,
-    metadata: {},
-  },
-  customerId: "blue",
-}).then((res: CreateLedgerEntryResponse) => {
+import { CreateLedgerEntryRequest } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const customerId: string = "online";
+const requestBody: any = "Configuration";
+
+  const res = await sdk.credit.create(customerId, requestBody);
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                  | Type                                                                                       | Required                                                                                   | Description                                                                                |
-| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `request`                                                                                  | [operations.CreateLedgerEntryRequest](../../models/operations/createledgerentryrequest.md) | :heavy_check_mark:                                                                         | The request object to use for the request.                                                 |
-| `config`                                                                                   | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                               | :heavy_minus_sign:                                                                         | Available config options for making requests.                                              |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `customerId`                                                 | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `requestBody`                                                | *any*                                                        | :heavy_minus_sign:                                           | N/A                                                          |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 
 
 ### Response
@@ -127,31 +280,34 @@ Returns a paginated list of unexpired, non-zero credit blocks for a customer.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchCustomerCreditsResponse } from "orb-billing/dist/sdk/models/operations";
-
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.credit.fetchBalance({
-  cursor: "leverage quantifying",
-  customerId: "throughput",
-  limit: 957442,
-}).then((res: FetchCustomerCreditsResponse) => {
+import { FetchCustomerCreditsRequest } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const customerId: string = "dynamic";
+const cursor: string = "tan";
+const limit: number = 641912;
+
+  const res = await sdk.credit.fetchBalance(customerId, cursor, limit);
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `request`                                                                                        | [operations.FetchCustomerCreditsRequest](../../models/operations/fetchcustomercreditsrequest.md) | :heavy_check_mark:                                                                               | The request object to use for the request.                                                       |
-| `config`                                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                     | :heavy_minus_sign:                                                                               | Available config options for making requests.                                                    |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `customerId`                                                 | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `cursor`                                                     | *string*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
+| `limit`                                                      | *number*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 
 
 ### Response
@@ -167,31 +323,34 @@ Returns a paginated list of unexpired, non-zero credit blocks for a customer.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchCustomerCreditsExternalIdResponse } from "orb-billing/dist/sdk/models/operations";
-
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.credit.fetchBalanceByExternalId({
-  cursor: "politely libero bad",
-  externalCustomerId: "Plastic Tactics bus",
-  limit: 292281,
-}).then((res: FetchCustomerCreditsExternalIdResponse) => {
+import { FetchCustomerCreditsExternalIdRequest } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const externalCustomerId: string = "while";
+const cursor: string = "Hop";
+const limit: number = 874650;
+
+  const res = await sdk.credit.fetchBalanceByExternalId(externalCustomerId, cursor, limit);
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                                            | Type                                                                                                                 | Required                                                                                                             | Description                                                                                                          |
-| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                            | [operations.FetchCustomerCreditsExternalIdRequest](../../models/operations/fetchcustomercreditsexternalidrequest.md) | :heavy_check_mark:                                                                                                   | The request object to use for the request.                                                                           |
-| `config`                                                                                                             | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                         | :heavy_minus_sign:                                                                                                   | Available config options for making requests.                                                                        |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `externalCustomerId`                                         | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `cursor`                                                     | *string*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
+| `limit`                                                      | *number*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 
 
 ### Response
@@ -270,32 +429,23 @@ import { Orb } from "orb-billing";
 import {
   FetchCustomerCreditsLedgerEntryStatusEntryStatus,
   FetchCustomerCreditsLedgerEntryTypeEntryType,
-  FetchCustomerCreditsLedgerResponse,
 } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.credit.fetchLedger({
-  createdAtGt: new Date("2021-08-07T05:53:42.253Z"),
-  createdAtGte: new Date("2021-03-04T16:26:59.995Z"),
-  createdAtLt: new Date("2022-05-17T01:56:00.143Z"),
-  createdAtLte: new Date("2023-09-07T22:52:03.052Z"),
-  currency: "Guarani",
-  cursor: "District",
-  customerId: "along hertz",
-  entryStatus: FetchCustomerCreditsLedgerEntryStatusEntryStatus.Committed,
-  entryType: FetchCustomerCreditsLedgerEntryTypeEntryType.CreditBlockExpiry,
-  limit: 267714,
-  minimumAmount: "ADP",
-}).then((res: FetchCustomerCreditsLedgerResponse) => {
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.credit.fetchLedger({
+    customerId: "Kenya",
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -382,32 +532,23 @@ import { Orb } from "orb-billing";
 import {
   FetchCustomerCreditsLedgerExternalIdEntryStatusEntryStatus,
   FetchCustomerCreditsLedgerExternalIdEntryTypeEntryType,
-  FetchCustomerCreditsLedgerExternalIdResponse,
 } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.credit.fetchLedgerByExternalId({
-  createdAtGt: new Date("2021-07-28T22:32:03.001Z"),
-  createdAtGte: new Date("2021-10-24T11:02:25.013Z"),
-  createdAtLt: new Date("2023-03-21T02:37:36.068Z"),
-  createdAtLte: new Date("2022-05-04T02:33:27.807Z"),
-  currency: "Pound Sterling",
-  cursor: "OCR back",
-  entryStatus: FetchCustomerCreditsLedgerExternalIdEntryStatusEntryStatus.Pending,
-  entryType: FetchCustomerCreditsLedgerExternalIdEntryTypeEntryType.ExpirationChange,
-  externalCustomerId: "Account",
-  limit: 672484,
-  minimumAmount: "Account Assimilated transition",
-}).then((res: FetchCustomerCreditsLedgerExternalIdResponse) => {
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.credit.fetchLedgerByExternalId({
+    externalCustomerId: "Cotton",
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters

package/docs/sdks/creditnote/README.md

@@ -19,29 +19,30 @@ This endpoint is used to fetch a single [`Credit Note`](../guides/invoicing/cred
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchCreditNoteResponse } from "orb-billing/dist/sdk/models/operations";
+import { FetchCreditNoteRequest } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const creditNoteId: string = "grateful";
+
+  const res = await sdk.creditNote.fetch(creditNoteId);
 
-sdk.creditNote.fetch({
-  creditNoteId: "Total Honda Southeast",
-}).then((res: FetchCreditNoteResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                              | Type                                                                                   | Required                                                                               | Description                                                                            |
-| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
-| `request`                                                                              | [operations.FetchCreditNoteRequest](../../models/operations/fetchcreditnoterequest.md) | :heavy_check_mark:                                                                     | The request object to use for the request.                                             |
-| `config`                                                                               | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                           | :heavy_minus_sign:                                                                     | Available config options for making requests.                                          |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `creditNoteId`                                               | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 
 
 ### Response
@@ -59,30 +60,32 @@ in reverse chronological order by `creation_time`.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { ListCreditNotesResponse } from "orb-billing/dist/sdk/models/operations";
-
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.creditNote.list({
-  cursor: "Northeast Metal Canada",
-  limit: 917416,
-}).then((res: ListCreditNotesResponse) => {
+import { ListCreditNotesRequest } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const cursor: string = "Bicycle";
+const limit: number = 257649;
+
+  const res = await sdk.creditNote.list(cursor, limit);
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                              | Type                                                                                   | Required                                                                               | Description                                                                            |
-| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
-| `request`                                                                              | [operations.ListCreditNotesRequest](../../models/operations/listcreditnotesrequest.md) | :heavy_check_mark:                                                                     | The request object to use for the request.                                             |
-| `config`                                                                               | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                           | :heavy_minus_sign:                                                                     | Available config options for making requests.                                          |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `cursor`                                                     | *string*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
+| `limit`                                                      | *number*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 
 
 ### Response