orb-billing 1.0.1 → 1.19.5

package/docs/sdks/invoice/README.md

@@ -0,0 +1,402 @@
+# Invoice
+(*invoice*)
+
+## Overview
+
+An [`Invoice`](../guides/concepts#invoice) is a fundamental billing entity, representing the request for payment for
+a single subscription. This includes a set of line items, which correspond to prices in the subscription's plan and
+can represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as
+the result of an action, such as a cancellation.
+
+### Available Operations
+
+* [create](#create) - Create a one-off invoice
+* [createLineItem](#createlineitem) - Create invoice line item
+* [fetch](#fetch) - Fetch invoice
+* [fetchUpcoming](#fetchupcoming) - Fetch upcoming invoice
+* [issue](#issue) - Issue invoice
+* [list](#list) - List invoices
+* [markInvoiceAsPaid](#markinvoiceaspaid) - Mark invoice as paid
+* [void](#void) - Void invoice
+
+## create
+
+This endpoint is used to create a one-off invoice for a customer.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { CreateInvoiceResponse } from "orb-billing/dist/sdk/models/operations";
+import { InvoiceLineItemParamsModelType } from "orb-billing/dist/sdk/models/shared";
+import { RFCDate } from "orb-billing/dist/sdk/types";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.invoice.create({
+  currency: "USD",
+  customerId: "4khy3nwzktxv7",
+  externalCustomerId: "external-customer-id",
+  invoiceDate: new Date("2023-09-22"),
+  lineItems: [
+    {
+      endDate: new RFCDate("2023-09-22"),
+      itemId: "4khy3nwzktxv7",
+      modelType: InvoiceLineItemParamsModelType.Unit,
+      name: "Line Item Name",
+      quantity: 1,
+      startDate: new RFCDate("2023-09-22"),
+      unitConfig: {
+        scalingFactor: 6384.24,
+        unitAmount: "Money blue shred",
+      },
+    },
+  ],
+  memo: "An optional memo for my invoice.",
+  netTerms: 0,
+  willAutoIssue: false,
+}).then((res: CreateInvoiceResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                            | Type                                                                                 | Required                                                                             | Description                                                                          |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
+| `request`                                                                            | [shared.CreateOneOffInvoiceParams](../../models/shared/createoneoffinvoiceparams.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.CreateInvoiceResponse](../../models/operations/createinvoiceresponse.md)>**
+
+
+## createLineItem
+
+This creates a one-off fixed fee invoice line item on an Invoice.
+This can only be done for invoices that are in a `draft` status.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { CreateInvoiceLineItemResponse } from "orb-billing/dist/sdk/models/operations";
+import { RFCDate } from "orb-billing/dist/sdk/types";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.invoice.createLineItem({
+  amount: "12.00",
+  endDate: new RFCDate("2023-09-22"),
+  invoiceId: "4khy3nwzktxv7",
+  name: "Item Name",
+  quantity: "1",
+  startDate: new RFCDate("2023-09-22"),
+}).then((res: CreateInvoiceLineItemResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                | Type                                                                                     | Required                                                                                 | Description                                                                              |
+| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `request`                                                                                | [shared.CreateInvoiceLineItemParams](../../models/shared/createinvoicelineitemparams.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.CreateInvoiceLineItemResponse](../../models/operations/createinvoicelineitemresponse.md)>**
+
+
+## fetch
+
+This endpoint is used to fetch an [`Invoice`](../guides/concepts#invoice) given an identifier.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { FetchInvoiceResponse } from "orb-billing/dist/sdk/models/operations";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.invoice.fetch({
+  invoiceId: "Total Honda Southeast",
+}).then((res: FetchInvoiceResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                        | Type                                                                             | Required                                                                         | Description                                                                      |
+| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| `request`                                                                        | [operations.FetchInvoiceRequest](../../models/operations/fetchinvoicerequest.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.FetchInvoiceResponse](../../models/operations/fetchinvoiceresponse.md)>**
+
+
+## fetchUpcoming
+
+This endpoint can be used to fetch the upcoming [invoice](../guides/concepts#invoice) for the current billing
+period given a subscription.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { FetchUpcomingInvoiceResponse } from "orb-billing/dist/sdk/models/operations";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.invoice.fetchUpcoming({
+  subscriptionId: "volt scale",
+}).then((res: FetchUpcomingInvoiceResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `request`                                                                                        | [operations.FetchUpcomingInvoiceRequest](../../models/operations/fetchupcominginvoicerequest.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.FetchUpcomingInvoiceResponse](../../models/operations/fetchupcominginvoiceresponse.md)>**
+
+
+## issue
+
+This endpoint allows an eligible invoice to be issued manually. This is only possible with invoices where status is `draft`,
+`will_auto_issue` is true, and an `eligible_to_issue_at` is a time in the past. Issuing an invoice could possibly trigger
+side effects, some of which could be customer-visible (e.g. sending emails, auto-collecting payment,
+syncing the invoice to external providers, etc).
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { IssueInvoiceResponse } from "orb-billing/dist/sdk/models/operations";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.invoice.issue({
+  invoiceId: "Checking access gray",
+}).then((res: IssueInvoiceResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                        | Type                                                                             | Required                                                                         | Description                                                                      |
+| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| `request`                                                                        | [operations.IssueInvoiceRequest](../../models/operations/issueinvoicerequest.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.IssueInvoiceResponse](../../models/operations/issueinvoiceresponse.md)>**
+
+
+## list
+
+This endpoint returns a list of all [`Invoice`](../guides/concepts#invoice)s for an account in a list format.
+
+The list of invoices is ordered starting from the most recently issued invoice date. The response also includes
+[`pagination_metadata`](../reference/pagination), which lets the caller retrieve the next page of results if they
+exist.
+
+By default, this only returns invoices that are `issued`, `paid`, or `synced`.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import {
+  ListInvoicesDateTypeDateType,
+  ListInvoicesResponse,
+  ListInvoicesStatus,
+  ListInvoicesStatusStatus,
+} from "orb-billing/dist/sdk/models/operations";
+import { RFCDate } from "orb-billing/dist/sdk/types";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.invoice.list({
+  amount: "768.58",
+  amountGt: "compress",
+  amountLt: "Canada that orchid",
+  cursor: "West",
+  customerId: "boil primary synthesize",
+  dateType: ListInvoicesDateTypeDateType.InvoiceDate,
+  dueDate: new RFCDate("2022-07-13"),
+  dueDateGt: new RFCDate("2021-07-02"),
+  dueDateLt: new RFCDate("2022-11-26"),
+  dueDateWindow: "South",
+  externalCustomerId: "explicit",
+  invoiceDateGt: new Date("2021-12-24T22:58:01.395Z"),
+  invoiceDateGte: new Date("2022-06-16T20:57:25.031Z"),
+  invoiceDateLt: new Date("2021-12-06T18:55:39.498Z"),
+  invoiceDateLte: new Date("2021-03-22T04:25:28.253Z"),
+  isRecurring: false,
+  limit: 571691,
+  status: ListInvoicesStatusStatus.Void,
+  statuses: [
+    ListInvoicesStatus.Paid,
+  ],
+  subscriptionId: "Surprise tan",
+}).then((res: ListInvoicesResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                        | Type                                                                             | Required                                                                         | Description                                                                      |
+| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| `request`                                                                        | [operations.ListInvoicesRequest](../../models/operations/listinvoicesrequest.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.ListInvoicesResponse](../../models/operations/listinvoicesresponse.md)>**
+
+
+## markInvoiceAsPaid
+
+This endpoint allows an invoice's status to be set the `paid` status. This can only be done to invoices that are in
+the `issued` status.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { MarkInvoiceAsPaidResponse } from "orb-billing/dist/sdk/models/operations";
+import { RFCDate } from "orb-billing/dist/sdk/types";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.invoice.markInvoiceAsPaid({
+  markAsPaidRequestParams: {
+    externalId: "external_payment_id_123",
+    notes: "Fresh",
+    paymentReceivedDate: new RFCDate("2023-09-22"),
+  },
+  invoiceId: "yowza",
+}).then((res: MarkInvoiceAsPaidResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                  | Type                                                                                       | Required                                                                                   | Description                                                                                |
+| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
+| `request`                                                                                  | [operations.MarkInvoiceAsPaidRequest](../../models/operations/markinvoiceaspaidrequest.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.MarkInvoiceAsPaidResponse](../../models/operations/markinvoiceaspaidresponse.md)>**
+
+
+## void
+
+This endpoint allows an invoice's status to be set the `void` status. This can only be done to invoices that are in
+the `issued` status.
+
+If the associated invoice has used the customer balance to change the amount due, the customer balance operation
+will be reverted. For example, if the invoice used $10 of customer balance, that amount will be added back to the
+customer balance upon voiding.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { VoidInvoiceResponse } from "orb-billing/dist/sdk/models/operations";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.invoice.void({
+  invoiceId: "JBOD",
+}).then((res: VoidInvoiceResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                      | Type                                                                           | Required                                                                       | Description                                                                    |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| `request`                                                                      | [operations.VoidInvoiceRequest](../../models/operations/voidinvoicerequest.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.VoidInvoiceResponse](../../models/operations/voidinvoiceresponse.md)>**
+

package/docs/sdks/item/README.md

@@ -0,0 +1,89 @@
+# Item
+(*item*)
+
+## Overview
+
+The Item resource represents a sellable product or good. Items are associated with all line items, billable metrics,
+and prices and are used for defining external sync behavior for invoices and tax calculation purposes.
+
+### Available Operations
+
+* [fetch](#fetch) - Fetch item
+* [list](#list) - List items
+
+## fetch
+
+This endpoint returns an item identified by its item_id.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { FetchItemResponse } from "orb-billing/dist/sdk/models/operations";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.item.fetch({
+  itemId: "Total Honda Southeast",
+}).then((res: FetchItemResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                  | Type                                                                       | Required                                                                   | Description                                                                |
+| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
+| `request`                                                                  | [operations.FetchItemRequest](../../models/operations/fetchitemrequest.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.FetchItemResponse](../../models/operations/fetchitemresponse.md)>**
+
+
+## list
+
+This endpoint returns a list of all Items, ordered in descending order by creation time.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { ListItemsResponse } from "orb-billing/dist/sdk/models/operations";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.item.list({
+  cursor: "Northeast Metal Canada",
+  limit: 917416,
+}).then((res: ListItemsResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                  | Type                                                                       | Required                                                                   | Description                                                                |
+| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
+| `request`                                                                  | [operations.ListItemsRequest](../../models/operations/listitemsrequest.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.ListItemsResponse](../../models/operations/listitemsresponse.md)>**
+

package/docs/sdks/metric/README.md

@@ -0,0 +1,140 @@
+# Metric
+(*metric*)
+
+## Overview
+
+The Metric resource represents a calculation of a quantity based on events.
+Metrics are defined by the query that transforms raw usage events into meaningful values for your customers.
+
+### Available Operations
+
+* [create](#create) - Create metric
+* [fetch](#fetch) - Get metric
+* [list](#list) - List metrics
+
+## create
+
+This endpoint is used to create a [metric](../guides/concepts##metric) using a SQL string.
+See [SQL support](../guides/extensibility/advanced-metrics#sql-support)
+for a description of constructing SQL queries with examples.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { CreateMetricResponse } from "orb-billing/dist/sdk/models/operations";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.metric.create({
+  description: "Sum of bytes downloaded in fast mode",
+  itemId: "bluetooth Extended",
+  metadata: {},
+  name: "Bytes downloaded",
+  sql: "SELECT sum(bytes_downloaded) FROM events WHERE download_speed = 'fast'",
+}).then((res: CreateMetricResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                            | Type                                                                 | Required                                                             | Description                                                          |
+| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| `request`                                                            | [shared.NewBillableMetric](../../models/shared/newbillablemetric.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.CreateMetricResponse](../../models/operations/createmetricresponse.md)>**
+
+
+## fetch
+
+This endpoint is used to list [metrics](../guides/concepts##metric).
+It returns information about the metrics including its name, description, and item.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { FetchMetricResponse } from "orb-billing/dist/sdk/models/operations";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.metric.fetch({
+  metricId: "Total Honda Southeast",
+}).then((res: FetchMetricResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                      | Type                                                                           | Required                                                                       | Description                                                                    |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| `request`                                                                      | [operations.FetchMetricRequest](../../models/operations/fetchmetricrequest.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.FetchMetricResponse](../../models/operations/fetchmetricresponse.md)>**
+
+
+## list
+
+This endpoint is used to fetch [metric](../guides/concepts#metric) details given a metric identifier.
+It returns information about the metrics including its name, description, and item.
+
+### Example Usage
+
+```typescript
+import { Orb } from "orb-billing";
+import { ListMetricsResponse } from "orb-billing/dist/sdk/models/operations";
+
+const sdk = new Orb({
+  security: {
+    apiKeyAuth: "",
+  },
+});
+
+sdk.metric.list({
+  createdAtGt: new Date("2023-04-22T14:13:10.937Z"),
+  createdAtGte: new Date("2021-04-20T09:15:20.369Z"),
+  createdAtLt: new Date("2022-08-23T06:18:16.401Z"),
+  createdAtLte: new Date("2021-10-10T03:01:48.624Z"),
+  cursor: "Canada that orchid",
+  limit: 282238,
+}).then((res: ListMetricsResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                      | Type                                                                           | Required                                                                       | Description                                                                    |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| `request`                                                                      | [operations.ListMetricsRequest](../../models/operations/listmetricsrequest.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.ListMetricsResponse](../../models/operations/listmetricsresponse.md)>**
+

package/docs/sdks/orb/README.md

@@ -0,0 +1,21 @@
+# Orb SDK
+
+
+## Overview
+
+API Reference: Orb's API is built with the following principles in mind:
+
+1. **Predictable developer experience**: Where applicable, the Orb API uses industry-standard patterns such as
+cursor-based pagination and standardized error output. To help with debugging in critical API
+actions, the API always strives to provide detailed and actionable error messages. Aliases
+such as external customer IDs aid in fast integration times.
+2. **Reliably real time**: Orb's event-based APIs, such as event ingestion are designed to handle extremely high
+throughput and scale with concurrent load. Orb also provides a real-time event-level credits
+ledger and a highly performant webhooks architecture.
+3. **Flexibility at the forefront**: Features like timezone localization and the ability to amend historical usage
+show the flexible nature of the platform.
+
+You can download the latest OpenAPI spec [here](pathname:///spec.json).
+
+### Available Operations
+