orb-billing 1.0.1 → 1.19.2

package/docs/models/shared/validationerror.md

@@ -0,0 +1,9 @@
+# ValidationError
+
+
+## Fields
+
+| Field                                                                              | Type                                                                               | Required                                                                           | Description                                                                        |
+| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `idempotencyKey`                                                                   | *string*                                                                           | :heavy_check_mark:                                                                 | The passed idempotency_key corresponding to the validation_errors                  |
+| `validationErrors`                                                                 | *string*[]                                                                         | :heavy_check_mark:                                                                 | An array of strings corresponding to validation failures for this idempotency_key. |

package/docs/models/shared/voidinitiatedledgerentry.md

@@ -0,0 +1,24 @@
+# VoidInitiatedLedgerEntry
+
+The [Credit Ledger Entry resource](/guides/product-catalog/prepurchase) models prepaid credits within Orb.
+
+
+## Fields
+
+| Field                                                                                             | Type                                                                                              | Required                                                                                          | Description                                                                                       |
+| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
+| `amount`                                                                                          | *any*                                                                                             | :heavy_check_mark:                                                                                | N/A                                                                                               |
+| `createdAt`                                                                                       | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)     | :heavy_check_mark:                                                                                | N/A                                                                                               |
+| `creditBlock`                                                                                     | [AffectedBlock](../../models/shared/affectedblock.md)                                             | :heavy_check_mark:                                                                                | N/A                                                                                               |
+| `customer`                                                                                        | [CustomerMinified](../../models/shared/customerminified.md)                                       | :heavy_check_mark:                                                                                | N/A                                                                                               |
+| `description`                                                                                     | *string*                                                                                          | :heavy_check_mark:                                                                                | N/A                                                                                               |
+| `endingBalance`                                                                                   | *any*                                                                                             | :heavy_check_mark:                                                                                | N/A                                                                                               |
+| `entryStatus`                                                                                     | [VoidInitiatedLedgerEntryEntryStatus](../../models/shared/voidinitiatedledgerentryentrystatus.md) | :heavy_check_mark:                                                                                | N/A                                                                                               |
+| `entryType`                                                                                       | [VoidInitiatedLedgerEntryEntryType](../../models/shared/voidinitiatedledgerentryentrytype.md)     | :heavy_check_mark:                                                                                | N/A                                                                                               |
+| `id`                                                                                              | *string*                                                                                          | :heavy_check_mark:                                                                                | N/A                                                                                               |
+| `ledgerSequenceNumber`                                                                            | *number*                                                                                          | :heavy_check_mark:                                                                                | N/A                                                                                               |
+| `metadata`                                                                                        | Record<string, *string*>                                                                          | :heavy_check_mark:                                                                                | N/A                                                                                               |
+| `newBlockExpiryDate`                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)     | :heavy_check_mark:                                                                                | N/A                                                                                               |
+| `startingBalance`                                                                                 | *any*                                                                                             | :heavy_check_mark:                                                                                | N/A                                                                                               |
+| `voidAmount`                                                                                      | *any*                                                                                             | :heavy_check_mark:                                                                                | N/A                                                                                               |
+| `voidReason`                                                                                      | *string*                                                                                          | :heavy_check_mark:                                                                                | N/A                                                                                               |

package/docs/models/shared/voidinitiatedledgerentryentrystatus.md

@@ -0,0 +1,9 @@
+# VoidInitiatedLedgerEntryEntryStatus
+
+
+## Values
+
+| Name        | Value       |
+| ----------- | ----------- |
+| `Committed` | committed   |
+| `Pending`   | pending     |

package/docs/models/shared/voidinitiatedledgerentryentrytype.md

@@ -0,0 +1,8 @@
+# VoidInitiatedLedgerEntryEntryType
+
+
+## Values
+
+| Name            | Value           |
+| --------------- | --------------- |
+| `VoidInitiated` | void_initiated  |

package/docs/models/shared/voidledgerentry.md

@@ -0,0 +1,23 @@
+# VoidLedgerEntry
+
+The [Credit Ledger Entry resource](/guides/product-catalog/prepurchase) models prepaid credits within Orb.
+
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `amount`                                                                                      | *any*                                                                                         | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `createdAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `creditBlock`                                                                                 | [AffectedBlock](../../models/shared/affectedblock.md)                                         | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `customer`                                                                                    | [CustomerMinified](../../models/shared/customerminified.md)                                   | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `description`                                                                                 | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `endingBalance`                                                                               | *any*                                                                                         | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `entryStatus`                                                                                 | [VoidLedgerEntryEntryStatus](../../models/shared/voidledgerentryentrystatus.md)               | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `entryType`                                                                                   | [VoidLedgerEntryEntryType](../../models/shared/voidledgerentryentrytype.md)                   | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `id`                                                                                          | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `ledgerSequenceNumber`                                                                        | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `metadata`                                                                                    | Record<string, *string*>                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `startingBalance`                                                                             | *any*                                                                                         | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `voidAmount`                                                                                  | *any*                                                                                         | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `voidReason`                                                                                  | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |

package/docs/models/shared/voidledgerentryentrystatus.md

@@ -0,0 +1,9 @@
+# VoidLedgerEntryEntryStatus
+
+
+## Values
+
+| Name        | Value       |
+| ----------- | ----------- |
+| `Committed` | committed   |
+| `Pending`   | pending     |

package/docs/models/shared/voidledgerentryentrytype.md

@@ -0,0 +1,8 @@
+# VoidLedgerEntryEntryType
+
+
+## Values
+
+| Name   | Value  |
+| ------ | ------ |
+| `Void` | void   |

package/docs/sdks/availability/README.md

@@ -0,0 +1,45 @@
+# Availability
+(*availability*)
+
+### Available Operations
+
+* [ping](#ping) - Check availability
+
+## ping
+
+This endpoint allows you to test your connection to the Orb API and check the validity of your API key, passed in
+the Authorization header. This is particularly useful for checking that your environment is set up properly, and is
+a great choice for connectors and integrations.
+
+This API does not have any side-effects or return any Orb resources.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { PingResponse } from "orb-billing/dist/sdk/models/operations";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.availability.ping().then((res: PingResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
+
+
+### Response
+
+**Promise<[operations.PingResponse](../../models/operations/pingresponse.md)>**
+

package/docs/sdks/coupon/README.md

@@ -0,0 +1,226 @@
+# Coupon
+(*coupon*)
+
+## Overview
+
+A coupon represents a reusable discount configuration, and have an attached redemption code that can be issued to
+your end users. Coupons are most often used in self-serve signup or upgrade flows in your checkout experience or
+billing portal.
+
+To redeem a coupon, pass the `redemption_code` property in the [create subscription](create-subscription.api.mdx)
+or [schedule plan change](schedule-plan-change.api.mdx) request.
+
+### Available Operations
+
+* [archive](#archive) - Archive coupon
+* [create](#create) - Create coupon
+* [fetch](#fetch) - Fetch coupon
+* [list](#list) - List coupons
+* [listSubscriptions](#listsubscriptions) - List coupon subscriptions
+
+## archive
+
+This endpoint allows a coupon to be archived. Archived coupons can no longer be redeemed, and
+will be hidden from lists of active coupons. Additionally, once a coupon is archived, its redemption
+code can be reused for a different coupon.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { ArchiveCouponResponse } from "orb-billing/dist/sdk/models/operations";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.coupon.archive({
+  couponId: "system Israeli farad",
+}).then((res: ArchiveCouponResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                          | Type                                                                               | Required                                                                           | Description                                                                        |
+| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `request`                                                                          | [operations.ArchiveCouponRequest](../../models/operations/archivecouponrequest.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.                                      |
+
+
+### Response
+
+**Promise<[operations.ArchiveCouponResponse](../../models/operations/archivecouponresponse.md)>**
+
+
+## create
+
+This endpoint allows the creation of coupons, which can then be redeemed at subscription creation or plan change.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { CreateCouponResponse } from "orb-billing/dist/sdk/models/operations";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.coupon.create({
+  discount: {},
+  durationInMonths: 12,
+  maxRedemptions: 486589,
+  redemptionCode: "HALFOFF",
+}).then((res: CreateCouponResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `request`                                                    | [shared.NewCoupon](../../models/shared/newcoupon.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.                |
+
+
+### Response
+
+**Promise<[operations.CreateCouponResponse](../../models/operations/createcouponresponse.md)>**
+
+
+## fetch
+
+This endpoint retrieves a coupon by its ID. To fetch coupons by their redemption code, use the
+[List coupons](list-coupons) endpoint with the redemption_code parameter.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { FetchCouponResponse } from "orb-billing/dist/sdk/models/operations";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.coupon.fetch({
+  couponId: "Total Honda Southeast",
+}).then((res: FetchCouponResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                      | Type                                                                           | Required                                                                       | Description                                                                    |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| `request`                                                                      | [operations.FetchCouponRequest](../../models/operations/fetchcouponrequest.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.                                  |
+
+
+### Response
+
+**Promise<[operations.FetchCouponResponse](../../models/operations/fetchcouponresponse.md)>**
+
+
+## list
+
+This endpoint returns a list of all coupons for an account in a list format.
+
+The list of coupons is ordered starting from the most recently created coupon. The response also includes
+`pagination_metadata`, which lets the caller retrieve the next page of results if they exist. More information
+about pagination can be found in the Pagination-metadata schema.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { ListCouponsResponse } from "orb-billing/dist/sdk/models/operations";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.coupon.list({
+  cursor: "Northeast Metal Canada",
+  limit: 917416,
+  redemptionCode: "orchid Van",
+  showArchived: false,
+}).then((res: ListCouponsResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                      | Type                                                                           | Required                                                                       | Description                                                                    |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| `request`                                                                      | [operations.ListCouponsRequest](../../models/operations/listcouponsrequest.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.                                  |
+
+
+### Response
+
+**Promise<[operations.ListCouponsResponse](../../models/operations/listcouponsresponse.md)>**
+
+
+## listSubscriptions
+
+This endpoint returns a list of all subscriptions that have redeemed a given coupon as a
+[paginated](../reference/pagination) list, ordered starting from the most recently created subscription. For a full
+discussion of the subscription resource, see [Subscription](../guides/concepts#subscription).
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { ListCouponSubscriptionsResponse } from "orb-billing/dist/sdk/models/operations";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.coupon.listSubscriptions({
+  couponId: "Crossroad Bacon portal",
+  cursor: "enzyme",
+  limit: 231233,
+}).then((res: ListCouponSubscriptionsResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                              | Type                                                                                                   | Required                                                                                               | Description                                                                                            |
+| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                              | [operations.ListCouponSubscriptionsRequest](../../models/operations/listcouponsubscriptionsrequest.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.                                                          |
+
+
+### Response
+
+**Promise<[operations.ListCouponSubscriptionsResponse](../../models/operations/listcouponsubscriptionsresponse.md)>**
+