orb-billing 1.19.5 → 1.20.0

package/docs/sdks/invoice/README.md

@@ -27,43 +27,43 @@ This endpoint is used to create a one-off invoice for a customer.
 
 ```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",
-      },
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
     },
-  ],
-  memo: "An optional memo for my invoice.",
-  netTerms: 0,
-  willAutoIssue: false,
-}).then((res: CreateInvoiceResponse) => {
+  });
+
+  const res = await 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: {
+          "online": "Configuration",
+        },
+      },
+    ],
+    memo: "An optional memo for my invoice.",
+    netTerms: 0,
+    willAutoIssue: false,
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -88,27 +88,28 @@ This can only be done for invoices that are in a `draft` status.
 
 ```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) => {
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await 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"),
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -132,29 +133,30 @@ This endpoint is used to fetch an [`Invoice`](../guides/concepts#invoice) given
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchInvoiceResponse } from "orb-billing/dist/sdk/models/operations";
+import { FetchInvoiceRequest } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const invoiceId: string = "grateful";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+  const res = await sdk.invoice.fetch(invoiceId);
 
-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.                                    |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `invoiceId`                                                  | *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
@@ -171,29 +173,30 @@ period given a subscription.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchUpcomingInvoiceResponse } from "orb-billing/dist/sdk/models/operations";
+import { FetchUpcomingInvoiceRequest } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const subscriptionId: string = "soluta";
+
+  const res = await sdk.invoice.fetchUpcoming(subscriptionId);
 
-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.                                                    |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `subscriptionId`                                             | *string*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 
 
 ### Response
@@ -212,29 +215,30 @@ syncing the invoice to external providers, etc).
 
 ```typescript
 import { Orb } from "orb-billing";
-import { IssueInvoiceResponse } from "orb-billing/dist/sdk/models/operations";
+import { IssueInvoiceRequest } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const invoiceId: string = "hazel";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+  const res = await sdk.invoice.issue(invoiceId);
 
-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.                                    |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `invoiceId`                                                  | *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
@@ -256,48 +260,26 @@ By default, this only returns invoices that are `issued`, `paid`, or `synced`.
 
 ```typescript
 import { Orb } from "orb-billing";
-import {
-  ListInvoicesDateTypeDateType,
-  ListInvoicesResponse,
-  ListInvoicesStatus,
-  ListInvoicesStatusStatus,
-} from "orb-billing/dist/sdk/models/operations";
+import { ListInvoicesDateTypeDateType, 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) => {
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.invoice.list({
+    statuses: [
+      ListInvoicesStatus.Synced,
+    ],
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -322,35 +304,38 @@ the `issued` status.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { MarkInvoiceAsPaidResponse } from "orb-billing/dist/sdk/models/operations";
+import { MarkInvoiceAsPaidRequest } from "orb-billing/dist/sdk/models/operations";
+import { MarkAsPaidRequestParams } from "orb-billing/dist/sdk/models/shared";
 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) => {
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const invoiceId: string = "Illinois";
+const markAsPaidRequestParams: MarkAsPaidRequestParams = {
+  externalId: "external_payment_id_123",
+  notes: "Fisher Roentgenium British",
+  paymentReceivedDate: new RFCDate("2023-09-22"),
+};
+
+  const res = await sdk.invoice.markInvoiceAsPaid(invoiceId, markAsPaidRequestParams);
+
   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.                                              |
+| Parameter                                                                        | Type                                                                             | Required                                                                         | Description                                                                      |
+| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| `invoiceId`                                                                      | *string*                                                                         | :heavy_check_mark:                                                               | N/A                                                                              |
+| `markAsPaidRequestParams`                                                        | [shared.MarkAsPaidRequestParams](../../models/shared/markaspaidrequestparams.md) | :heavy_minus_sign:                                                               | N/A                                                                              |
+| `config`                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                     | :heavy_minus_sign:                                                               | Available config options for making requests.                                    |
 
 
 ### Response
@@ -371,29 +356,30 @@ customer balance upon voiding.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { VoidInvoiceResponse } from "orb-billing/dist/sdk/models/operations";
+import { VoidInvoiceRequest } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const invoiceId: string = "turquoise";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+  const res = await sdk.invoice.void(invoiceId);
 
-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.                                  |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `invoiceId`                                                  | *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

package/docs/sdks/item/README.md

@@ -19,29 +19,30 @@ This endpoint returns an item identified by its item_id.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchItemResponse } from "orb-billing/dist/sdk/models/operations";
+import { FetchItemRequest } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const itemId: string = "grateful";
+
+  const res = await sdk.item.fetch(itemId);
 
-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.                              |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `itemId`                                                     | *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
@@ -57,30 +58,32 @@ This endpoint returns a list of all Items, ordered in descending order by creati
 
 ```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) => {
+import { ListItemsRequest } 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.item.list(cursor, limit);
+
   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.                              |
+| 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

package/docs/sdks/metric/README.md

@@ -22,25 +22,26 @@ for a description of constructing SQL queries with examples.
 
 ```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) => {
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await 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'",
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -65,29 +66,30 @@ It returns information about the metrics including its name, description, and it
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchMetricResponse } from "orb-billing/dist/sdk/models/operations";
+import { FetchMetricRequest } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const metricId: string = "grateful";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+  const res = await sdk.metric.fetch(metricId);
 
-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.                                  |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `metricId`                                                   | *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
@@ -104,26 +106,20 @@ It returns information about the metrics including its name, description, and it
 
 ```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) => {
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.metric.list({});
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters