orb-billing 1.19.5 → 1.20.0

package/docs/sdks/credit/README.md

@@ -110,45 +110,32 @@ to the customer, up to the block's initial balance.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { CreateLedgerEntryExternalIdResponse } from "orb-billing/dist/sdk/models/operations";
-import {
-  AddAmendmentCreditLedgerEntryRequestParamsEntryType,
-  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: {
-    amount: "543.93",
-    blockId: "Southwest Silver",
-    description: "Fully-configurable object-oriented projection",
-    entryType: AddAmendmentCreditLedgerEntryRequestParamsEntryType.Amendment,
-    metadata: {},
-  },
-  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
@@ -252,47 +239,32 @@ to the customer, up to the block's initial balance.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { CreateLedgerEntryResponse } from "orb-billing/dist/sdk/models/operations";
-import {
-  AddAmendmentCreditLedgerEntryRequestParamsEntryType,
-  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,
-    blockId: "Money blue shred",
-    description: "Implemented web-enabled success",
-    entryType: AddExpirationChangeCreditLedgerEntryRequestParamsEntryType.ExpirationChange,
-    expiryDate: new RFCDate("2021-01-01"),
-    metadata: {},
-    targetExpiryDate: new RFCDate("2022-05-14"),
-  },
-  customerId: "evolve",
-}).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
@@ -308,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
@@ -348,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
@@ -451,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
@@ -563,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