orb-billing 1.19.2 → 1.20.0

package/docs/sdks/event/README.md

@@ -57,36 +57,37 @@ deletes ingested usage data.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { AmendEventResponse } from "orb-billing/dist/sdk/models/operations";
-
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.event.amend({
-  amendedEvent: {
-    customerId: "driver",
-    eventName: "bypass",
-    externalCustomerId: "Kids",
-    properties: {},
-    timestamp: new Date("2020-12-09T16:09:53Z"),
-  },
-  eventId: "previous enchanting",
-}).then((res: AmendEventResponse) => {
+import { AmendEventRequest } from "orb-billing/dist/sdk/models/operations";
+import { AmendedEvent, AmendedEventProperties } from "orb-billing/dist/sdk/models/shared";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const eventId: string = "Steel";
+const amendedEvent: AmendedEvent = {
+  eventName: "channels",
+  properties: {},
+  timestamp: new Date("2020-12-09T16:09:53Z"),
+};
+
+  const res = await sdk.event.amend(eventId, amendedEvent);
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                    | Type                                                                         | Required                                                                     | Description                                                                  |
-| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
-| `request`                                                                    | [operations.AmendEventRequest](../../models/operations/amendeventrequest.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                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `eventId`                                                    | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `amendedEvent`                                               | [shared.AmendedEvent](../../models/shared/amendedevent.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
@@ -104,29 +105,30 @@ will transition to `reflected`.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { CloseBackfillResponse } from "orb-billing/dist/sdk/models/operations";
+import { CloseBackfillRequest } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const backfillId: string = "olive";
+
+  const res = await sdk.event.closeBackfill(backfillId);
 
-sdk.event.closeBackfill({
-  backfillId: "Analyst HTTP where",
-}).then((res: CloseBackfillResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                          | Type                                                                               | Required                                                                           | Description                                                                        |
-| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
-| `request`                                                                          | [operations.CloseBackfillRequest](../../models/operations/closebackfillrequest.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                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `backfillId`                                                 | *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
@@ -161,26 +163,23 @@ events in the backfill's timeframe will be replaced with the newly ingested even
 
 ```typescript
 import { Orb } from "orb-billing";
-import { CreateBackfillResponse } from "orb-billing/dist/sdk/models/operations";
-
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.event.create({
-  closeTime: new Date("2022-06-17T19:34:14.348Z"),
-  customerId: "Configuration Money",
-  externalCustomerId: "Cambridgeshire grey technology",
-  replaceExistingEvents: false,
-  timeframeEnd: new Date("2021-01-01T02:16:34.216Z"),
-  timeframeStart: new Date("2022-05-14T11:13:20.233Z"),
-}).then((res: CreateBackfillResponse) => {
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.event.create({
+    timeframeEnd: new Date("2022-06-17T19:34:14.348Z"),
+    timeframeStart: new Date("2022-06-20T20:57:56.371Z"),
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -231,29 +230,30 @@ usage data.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { DeprecateEventResponse } from "orb-billing/dist/sdk/models/operations";
+import { DeprecateEventRequest } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const eventId: string = "CSS";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+  const res = await sdk.event.deprecateEvent(eventId);
 
-sdk.event.deprecateEvent({
-  eventId: "gold Northeast",
-}).then((res: DeprecateEventResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                            | Type                                                                                 | Required                                                                             | Description                                                                          |
-| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
-| `request`                                                                            | [operations.DeprecateEventRequest](../../models/operations/deprecateeventrequest.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                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `eventId`                                                    | *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
@@ -269,29 +269,30 @@ This endpoint is used to fetch a backfill given an identifier.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchBackfillResponse } from "orb-billing/dist/sdk/models/operations";
+import { FetchBackfillRequest } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const backfillId: string = "grateful";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+  const res = await sdk.event.fetch(backfillId);
 
-sdk.event.fetch({
-  backfillId: "Total Honda Southeast",
-}).then((res: FetchBackfillResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                          | Type                                                                               | Required                                                                           | Description                                                                        |
-| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
-| `request`                                                                          | [operations.FetchBackfillRequest](../../models/operations/fetchbackfillrequest.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                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `backfillId`                                                 | *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
@@ -481,41 +482,43 @@ switch to production, disable debug mode to take advantage of improved performan
 
 ```typescript
 import { Orb } from "orb-billing";
-import { IngestResponse } from "orb-billing/dist/sdk/models/operations";
-
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.event.ingest({
-  ingestRequestBody: {
-    events: [
-      {
-        customerId: "enim SMTP Rica",
-        eventName: "qui",
-        externalCustomerId: "Oman Bartell Industrial",
-        idempotencyKey: "aha Groves",
-        properties: {},
-        timestamp: new Date("2020-12-09T16:09:53Z"),
-      },
-    ],
-  },
-  backfillId: "Minivan index Frozen",
-  debug: false,
-}).then((res: IngestResponse) => {
+import { IngestRequest } from "orb-billing/dist/sdk/models/operations";
+import { IngestEvent, IngestEventProperties, IngestRequestBody } from "orb-billing/dist/sdk/models/shared";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const ingestRequestBody: IngestRequestBody = {
+  events: [
+    {
+      eventName: "enim SMTP Rica",
+      idempotencyKey: "qui",
+      properties: {},
+      timestamp: new Date("2020-12-09T16:09:53Z"),
+    },
+  ],
+};
+const backfillId: string = "green";
+const debug: boolean = false;
+
+  const res = await sdk.event.ingest(ingestRequestBody, backfillId, debug);
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
 | Parameter                                                            | Type                                                                 | Required                                                             | Description                                                          |
 | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
-| `request`                                                            | [operations.IngestRequest](../../models/operations/ingestrequest.md) | :heavy_check_mark:                                                   | The request object to use for the request.                           |
+| `ingestRequestBody`                                                  | [shared.IngestRequestBody](../../models/shared/ingestrequestbody.md) | :heavy_minus_sign:                                                   | N/A                                                                  |
+| `backfillId`                                                         | *string*                                                             | :heavy_minus_sign:                                                   | N/A                                                                  |
+| `debug`                                                              | *boolean*                                                            | :heavy_minus_sign:                                                   | N/A                                                                  |
 | `config`                                                             | [AxiosRequestConfig](https://axios-http.com/docs/req_config)         | :heavy_minus_sign:                                                   | Available config options for making requests.                        |
 
 
@@ -536,30 +539,32 @@ exist. More information about pagination can be found in the [Pagination-metadat
 
 ```typescript
 import { Orb } from "orb-billing";
-import { ListBackfillsResponse } from "orb-billing/dist/sdk/models/operations";
-
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.event.listBackfills({
-  cursor: "Borders Diesel Illinois",
-  limit: 663177,
-}).then((res: ListBackfillsResponse) => {
+import { ListBackfillsRequest } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const cursor: string = "bespatter";
+const limit: number = 556576;
+
+  const res = await sdk.event.listBackfills(cursor, limit);
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                          | Type                                                                               | Required                                                                           | Description                                                                        |
-| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
-| `request`                                                                          | [operations.ListBackfillsRequest](../../models/operations/listbackfillsrequest.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
@@ -580,29 +585,30 @@ immediately transition to `reverted`.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { RevertBackfillResponse } from "orb-billing/dist/sdk/models/operations";
+import { RevertBackfillRequest } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const backfillId: string = "Gasoline";
+
+  const res = await sdk.event.revertBackfill(backfillId);
 
-sdk.event.revertBackfill({
-  backfillId: "alarm Mercedes sugary",
-}).then((res: RevertBackfillResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                            | Type                                                                                 | Required                                                                             | Description                                                                          |
-| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
-| `request`                                                                            | [operations.RevertBackfillRequest](../../models/operations/revertbackfillrequest.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                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `backfillId`                                                 | *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
@@ -632,32 +638,26 @@ By default, Orb will not throw a `404` if no events matched, Orb will return an
 
 ```typescript
 import { Orb } from "orb-billing";
-import { SearchEventsResponse } from "orb-billing/dist/sdk/models/operations";
-
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.event.search({
-  eventSearchCriteria: {
-    eventIds: [
-      "incentivize",
-    ],
-    invoiceId: "overriding North",
-  },
-  cursor: "Ashburn Awesome",
-  limit: 570875,
-  timestampGt: new Date("2022-01-02T20:54:35.172Z"),
-  timestampGte: new Date("2022-08-27T12:42:36.561Z"),
-  timestampLt: new Date("2022-10-25T07:00:20.473Z"),
-  timestampLte: new Date("2022-12-12T15:03:00.566Z"),
-}).then((res: SearchEventsResponse) => {
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.event.search({
+    eventSearchCriteria: {
+      eventIds: [
+        "incentivize",
+      ],
+    },
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters