orb-billing 5.48.0 → 5.76.0

package/src/resources/customers/customers.ts

@@ -206,7 +206,7 @@ export class CustomersPage extends Page<Customer> {}
 export interface AccountingProviderConfig {
   external_provider_id: string;
 
-  provider_type: string;
+  provider_type: 'quickbooks' | 'netsuite';
 }
 
 export interface AddressInput {
@@ -315,7 +315,7 @@ export interface Customer {
     | 'stripe_charge'
     | 'stripe_invoice'
     | 'netsuite'
-    | 'netsuite_ampersand'
+    | 'adyen'
     | null;
 
   /**
@@ -324,6 +324,12 @@ export interface Customer {
    */
   payment_provider_id: string | null;
 
+  /**
+   * Deprecated. Returns the URL of the most recent non-expired portal link, or null.
+   * When the account has opted into customer portal sessions, this field always
+   * returns null. Use POST /v1/customers/{id}/portal_sessions to mint short-lived
+   * portal session URLs.
+   */
   portal_url: string | null;
 
   shipping_address: Shared.Address | null;
@@ -386,11 +392,13 @@ export interface Customer {
    * | Estonia                | `eu_vat`     | European VAT Number                                                                                     |
    * | Ethiopia               | `et_tin`     | Ethiopia Tax Identification Number                                                                      |
    * | European Union         | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
+   * | Faroe Islands          | `fo_vat`     | Faroe Islands VAT Number                                                                                |
    * | Finland                | `eu_vat`     | European VAT Number                                                                                     |
    * | France                 | `eu_vat`     | European VAT Number                                                                                     |
    * | Georgia                | `ge_vat`     | Georgian VAT                                                                                            |
    * | Germany                | `de_stn`     | German Tax Number (Steuernummer)                                                                        |
    * | Germany                | `eu_vat`     | European VAT Number                                                                                     |
+   * | Gibraltar              | `gi_tin`     | Gibraltar Tax Identification Number                                                                     |
    * | Greece                 | `eu_vat`     | European VAT Number                                                                                     |
    * | Guinea                 | `gn_nif`     | Guinea Tax Identification Number (Número de Identificação Fiscal)                                       |
    * | Hong Kong              | `hk_br`      | Hong Kong BR Number                                                                                     |
@@ -402,6 +410,7 @@ export interface Customer {
    * | Ireland                | `eu_vat`     | European VAT Number                                                                                     |
    * | Israel                 | `il_vat`     | Israel VAT                                                                                              |
    * | Italy                  | `eu_vat`     | European VAT Number                                                                                     |
+   * | Italy                  | `it_cf`      | Italian Codice Fiscale Number                                                                           |
    * | Japan                  | `jp_cn`      | Japanese Corporate Number (_Hōjin Bangō_)                                                               |
    * | Japan                  | `jp_rn`      | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
    * | Japan                  | `jp_trn`     | Japanese Tax Registration Number (_Tōroku Bangō_)                                                       |
@@ -432,6 +441,7 @@ export interface Customer {
    * | Norway                 | `no_vat`     | Norwegian VAT Number                                                                                    |
    * | Norway                 | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
    * | Oman                   | `om_vat`     | Omani VAT Number                                                                                        |
+   * | Paraguay               | `py_ruc`     | Paraguayan RUC Number                                                                                   |
    * | Peru                   | `pe_ruc`     | Peruvian RUC Number                                                                                     |
    * | Philippines            | `ph_tin`     | Philippines Tax Identification Number                                                                   |
    * | Poland                 | `eu_vat`     | European VAT Number                                                                                     |
@@ -453,6 +463,7 @@ export interface Customer {
    * | South Korea            | `kr_brn`     | Korean BRN                                                                                              |
    * | Spain                  | `es_cif`     | Spanish NIF Number (previously Spanish CIF Number)                                                      |
    * | Spain                  | `eu_vat`     | European VAT Number                                                                                     |
+   * | Sri Lanka              | `lk_vat`     | Sri Lanka VAT Number                                                                                    |
    * | Suriname               | `sr_fin`     | Suriname FIN Number                                                                                     |
    * | Sweden                 | `eu_vat`     | European VAT Number                                                                                     |
    * | Switzerland            | `ch_uid`     | Switzerland UID Number                                                                                  |
@@ -492,6 +503,15 @@ export interface Customer {
    */
   automatic_tax_enabled?: boolean | null;
 
+  /**
+   * A payment method represents a customer's stored payment instrument held with an
+   * external payment provider (such as Adyen or Stripe).
+   *
+   * The serialization is intentionally minimal for now; provider-pulled details
+   * (e.g. card display metadata) will be added over time.
+   */
+  default_payment_method?: Customer.DefaultPaymentMethod | null;
+
   /**
    * Payment configuration for the customer, applicable when using Orb Invoicing with
    * a supported payment provider such as Stripe.
@@ -521,10 +541,56 @@ export namespace Customer {
     export interface AccountingProvider {
       external_provider_id: string | null;
 
-      provider_type: 'quickbooks' | 'netsuite' | 'netsuite_ampersand';
+      provider_type: 'quickbooks' | 'netsuite';
     }
   }
 
+  /**
+   * A payment method represents a customer's stored payment instrument held with an
+   * external payment provider (such as Adyen or Stripe).
+   *
+   * The serialization is intentionally minimal for now; provider-pulled details
+   * (e.g. card display metadata) will be added over time.
+   */
+  export interface DefaultPaymentMethod {
+    /**
+     * The Orb-assigned unique identifier for the payment method.
+     */
+    id: string;
+
+    /**
+     * The time at which the payment method was created.
+     */
+    created_at: string;
+
+    /**
+     * The ID of the Orb customer this payment method is attached to.
+     */
+    customer_id: string;
+
+    /**
+     * Whether this is the customer's default payment method.
+     */
+    default: boolean;
+
+    /**
+     * The identifier of this payment method in the external payment provider.
+     */
+    external_payment_method_id: string;
+
+    /**
+     * The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
+     */
+    payment_method_type: 'card' | 'us_bank_account' | 'link' | 'amazon_pay' | 'crypto';
+
+    /**
+     * The external payment provider this method belongs to, derived from the linked
+     * payment gateway connection (e.g. `adyen` or `stripe`). Null if the connection
+     * has been removed.
+     */
+    provider_type: string | null;
+  }
+
   /**
    * Payment configuration for the customer, applicable when using Orb Invoicing with
    * a supported payment provider such as Stripe.
@@ -711,7 +777,7 @@ export interface CustomerCreateParams {
     | 'stripe_charge'
     | 'stripe_invoice'
     | 'netsuite'
-    | 'netsuite_ampersand'
+    | 'adyen'
     | null;
 
   /**
@@ -791,11 +857,13 @@ export interface CustomerCreateParams {
    * | Estonia                | `eu_vat`     | European VAT Number                                                                                     |
    * | Ethiopia               | `et_tin`     | Ethiopia Tax Identification Number                                                                      |
    * | European Union         | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
+   * | Faroe Islands          | `fo_vat`     | Faroe Islands VAT Number                                                                                |
    * | Finland                | `eu_vat`     | European VAT Number                                                                                     |
    * | France                 | `eu_vat`     | European VAT Number                                                                                     |
    * | Georgia                | `ge_vat`     | Georgian VAT                                                                                            |
    * | Germany                | `de_stn`     | German Tax Number (Steuernummer)                                                                        |
    * | Germany                | `eu_vat`     | European VAT Number                                                                                     |
+   * | Gibraltar              | `gi_tin`     | Gibraltar Tax Identification Number                                                                     |
    * | Greece                 | `eu_vat`     | European VAT Number                                                                                     |
    * | Guinea                 | `gn_nif`     | Guinea Tax Identification Number (Número de Identificação Fiscal)                                       |
    * | Hong Kong              | `hk_br`      | Hong Kong BR Number                                                                                     |
@@ -807,6 +875,7 @@ export interface CustomerCreateParams {
    * | Ireland                | `eu_vat`     | European VAT Number                                                                                     |
    * | Israel                 | `il_vat`     | Israel VAT                                                                                              |
    * | Italy                  | `eu_vat`     | European VAT Number                                                                                     |
+   * | Italy                  | `it_cf`      | Italian Codice Fiscale Number                                                                           |
    * | Japan                  | `jp_cn`      | Japanese Corporate Number (_Hōjin Bangō_)                                                               |
    * | Japan                  | `jp_rn`      | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
    * | Japan                  | `jp_trn`     | Japanese Tax Registration Number (_Tōroku Bangō_)                                                       |
@@ -837,6 +906,7 @@ export interface CustomerCreateParams {
    * | Norway                 | `no_vat`     | Norwegian VAT Number                                                                                    |
    * | Norway                 | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
    * | Oman                   | `om_vat`     | Omani VAT Number                                                                                        |
+   * | Paraguay               | `py_ruc`     | Paraguayan RUC Number                                                                                   |
    * | Peru                   | `pe_ruc`     | Peruvian RUC Number                                                                                     |
    * | Philippines            | `ph_tin`     | Philippines Tax Identification Number                                                                   |
    * | Poland                 | `eu_vat`     | European VAT Number                                                                                     |
@@ -858,6 +928,7 @@ export interface CustomerCreateParams {
    * | South Korea            | `kr_brn`     | Korean BRN                                                                                              |
    * | Spain                  | `es_cif`     | Spanish NIF Number (previously Spanish CIF Number)                                                      |
    * | Spain                  | `eu_vat`     | European VAT Number                                                                                     |
+   * | Sri Lanka              | `lk_vat`     | Sri Lanka VAT Number                                                                                    |
    * | Suriname               | `sr_fin`     | Suriname FIN Number                                                                                     |
    * | Sweden                 | `eu_vat`     | European VAT Number                                                                                     |
    * | Switzerland            | `ch_uid`     | Switzerland UID Number                                                                                  |
@@ -999,6 +1070,12 @@ export interface CustomerUpdateParams {
    */
   currency?: string | null;
 
+  /**
+   * The Orb ID of the payment method to set as this customer's default. Pass `null`
+   * to clear the customer's default payment method.
+   */
+  default_payment_method_id?: string | null;
+
   /**
    * A valid customer email, to be used for invoicing and notifications.
    */
@@ -1053,7 +1130,7 @@ export interface CustomerUpdateParams {
     | 'stripe_charge'
     | 'stripe_invoice'
     | 'netsuite'
-    | 'netsuite_ampersand'
+    | 'adyen'
     | null;
 
   /**
@@ -1133,11 +1210,13 @@ export interface CustomerUpdateParams {
    * | Estonia                | `eu_vat`     | European VAT Number                                                                                     |
    * | Ethiopia               | `et_tin`     | Ethiopia Tax Identification Number                                                                      |
    * | European Union         | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
+   * | Faroe Islands          | `fo_vat`     | Faroe Islands VAT Number                                                                                |
    * | Finland                | `eu_vat`     | European VAT Number                                                                                     |
    * | France                 | `eu_vat`     | European VAT Number                                                                                     |
    * | Georgia                | `ge_vat`     | Georgian VAT                                                                                            |
    * | Germany                | `de_stn`     | German Tax Number (Steuernummer)                                                                        |
    * | Germany                | `eu_vat`     | European VAT Number                                                                                     |
+   * | Gibraltar              | `gi_tin`     | Gibraltar Tax Identification Number                                                                     |
    * | Greece                 | `eu_vat`     | European VAT Number                                                                                     |
    * | Guinea                 | `gn_nif`     | Guinea Tax Identification Number (Número de Identificação Fiscal)                                       |
    * | Hong Kong              | `hk_br`      | Hong Kong BR Number                                                                                     |
@@ -1149,6 +1228,7 @@ export interface CustomerUpdateParams {
    * | Ireland                | `eu_vat`     | European VAT Number                                                                                     |
    * | Israel                 | `il_vat`     | Israel VAT                                                                                              |
    * | Italy                  | `eu_vat`     | European VAT Number                                                                                     |
+   * | Italy                  | `it_cf`      | Italian Codice Fiscale Number                                                                           |
    * | Japan                  | `jp_cn`      | Japanese Corporate Number (_Hōjin Bangō_)                                                               |
    * | Japan                  | `jp_rn`      | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
    * | Japan                  | `jp_trn`     | Japanese Tax Registration Number (_Tōroku Bangō_)                                                       |
@@ -1179,6 +1259,7 @@ export interface CustomerUpdateParams {
    * | Norway                 | `no_vat`     | Norwegian VAT Number                                                                                    |
    * | Norway                 | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
    * | Oman                   | `om_vat`     | Omani VAT Number                                                                                        |
+   * | Paraguay               | `py_ruc`     | Paraguayan RUC Number                                                                                   |
    * | Peru                   | `pe_ruc`     | Peruvian RUC Number                                                                                     |
    * | Philippines            | `ph_tin`     | Philippines Tax Identification Number                                                                   |
    * | Poland                 | `eu_vat`     | European VAT Number                                                                                     |
@@ -1200,6 +1281,7 @@ export interface CustomerUpdateParams {
    * | South Korea            | `kr_brn`     | Korean BRN                                                                                              |
    * | Spain                  | `es_cif`     | Spanish NIF Number (previously Spanish CIF Number)                                                      |
    * | Spain                  | `eu_vat`     | European VAT Number                                                                                     |
+   * | Sri Lanka              | `lk_vat`     | Sri Lanka VAT Number                                                                                    |
    * | Suriname               | `sr_fin`     | Suriname FIN Number                                                                                     |
    * | Sweden                 | `eu_vat`     | European VAT Number                                                                                     |
    * | Switzerland            | `ch_uid`     | Switzerland UID Number                                                                                  |
@@ -1344,6 +1426,12 @@ export interface CustomerUpdateByExternalIDParams {
    */
   currency?: string | null;
 
+  /**
+   * The Orb ID of the payment method to set as this customer's default. Pass `null`
+   * to clear the customer's default payment method.
+   */
+  default_payment_method_id?: string | null;
+
   /**
    * A valid customer email, to be used for invoicing and notifications.
    */
@@ -1398,7 +1486,7 @@ export interface CustomerUpdateByExternalIDParams {
     | 'stripe_charge'
     | 'stripe_invoice'
     | 'netsuite'
-    | 'netsuite_ampersand'
+    | 'adyen'
     | null;
 
   /**
@@ -1478,11 +1566,13 @@ export interface CustomerUpdateByExternalIDParams {
    * | Estonia                | `eu_vat`     | European VAT Number                                                                                     |
    * | Ethiopia               | `et_tin`     | Ethiopia Tax Identification Number                                                                      |
    * | European Union         | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
+   * | Faroe Islands          | `fo_vat`     | Faroe Islands VAT Number                                                                                |
    * | Finland                | `eu_vat`     | European VAT Number                                                                                     |
    * | France                 | `eu_vat`     | European VAT Number                                                                                     |
    * | Georgia                | `ge_vat`     | Georgian VAT                                                                                            |
    * | Germany                | `de_stn`     | German Tax Number (Steuernummer)                                                                        |
    * | Germany                | `eu_vat`     | European VAT Number                                                                                     |
+   * | Gibraltar              | `gi_tin`     | Gibraltar Tax Identification Number                                                                     |
    * | Greece                 | `eu_vat`     | European VAT Number                                                                                     |
    * | Guinea                 | `gn_nif`     | Guinea Tax Identification Number (Número de Identificação Fiscal)                                       |
    * | Hong Kong              | `hk_br`      | Hong Kong BR Number                                                                                     |
@@ -1494,6 +1584,7 @@ export interface CustomerUpdateByExternalIDParams {
    * | Ireland                | `eu_vat`     | European VAT Number                                                                                     |
    * | Israel                 | `il_vat`     | Israel VAT                                                                                              |
    * | Italy                  | `eu_vat`     | European VAT Number                                                                                     |
+   * | Italy                  | `it_cf`      | Italian Codice Fiscale Number                                                                           |
    * | Japan                  | `jp_cn`      | Japanese Corporate Number (_Hōjin Bangō_)                                                               |
    * | Japan                  | `jp_rn`      | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
    * | Japan                  | `jp_trn`     | Japanese Tax Registration Number (_Tōroku Bangō_)                                                       |
@@ -1524,6 +1615,7 @@ export interface CustomerUpdateByExternalIDParams {
    * | Norway                 | `no_vat`     | Norwegian VAT Number                                                                                    |
    * | Norway                 | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
    * | Oman                   | `om_vat`     | Omani VAT Number                                                                                        |
+   * | Paraguay               | `py_ruc`     | Paraguayan RUC Number                                                                                   |
    * | Peru                   | `pe_ruc`     | Peruvian RUC Number                                                                                     |
    * | Philippines            | `ph_tin`     | Philippines Tax Identification Number                                                                   |
    * | Poland                 | `eu_vat`     | European VAT Number                                                                                     |
@@ -1545,6 +1637,7 @@ export interface CustomerUpdateByExternalIDParams {
    * | South Korea            | `kr_brn`     | Korean BRN                                                                                              |
    * | Spain                  | `es_cif`     | Spanish NIF Number (previously Spanish CIF Number)                                                      |
    * | Spain                  | `eu_vat`     | European VAT Number                                                                                     |
+   * | Sri Lanka              | `lk_vat`     | Sri Lanka VAT Number                                                                                    |
    * | Suriname               | `sr_fin`     | Suriname FIN Number                                                                                     |
    * | Sweden                 | `eu_vat`     | European VAT Number                                                                                     |
    * | Switzerland            | `ch_uid`     | Switzerland UID Number                                                                                  |

package/src/resources/dimensional-price-groups/dimensional-price-groups.ts

@@ -24,6 +24,16 @@ export class DimensionalPriceGroups extends APIResource {
    * widgets used and we want to charge differently depending on the color of the
    * widget. We can create a price group with a dimension "color" and two prices: one
    * that charges \$10 per red widget and one that charges \$20 per blue widget.
+   *
+   * @example
+   * ```ts
+   * const dimensionalPriceGroup =
+   *   await client.dimensionalPriceGroups.create({
+   *     billable_metric_id: 'billable_metric_id',
+   *     dimensions: ['region', 'instance_type'],
+   *     name: 'name',
+   *   });
+   * ```
    */
   create(
     body: DimensionalPriceGroupCreateParams,
@@ -34,6 +44,14 @@ export class DimensionalPriceGroups extends APIResource {
 
   /**
    * Fetch dimensional price group
+   *
+   * @example
+   * ```ts
+   * const dimensionalPriceGroup =
+   *   await client.dimensionalPriceGroups.retrieve(
+   *     'dimensional_price_group_id',
+   *   );
+   * ```
    */
   retrieve(
     dimensionalPriceGroupId: string,
@@ -46,6 +64,14 @@ export class DimensionalPriceGroups extends APIResource {
    * This endpoint can be used to update the `external_dimensional_price_group_id`
    * and `metadata` of an existing dimensional price group. Other fields on a
    * dimensional price group are currently immutable.
+   *
+   * @example
+   * ```ts
+   * const dimensionalPriceGroup =
+   *   await client.dimensionalPriceGroups.update(
+   *     'dimensional_price_group_id',
+   *   );
+   * ```
    */
   update(
     dimensionalPriceGroupId: string,
@@ -57,6 +83,14 @@ export class DimensionalPriceGroups extends APIResource {
 
   /**
    * List dimensional price groups
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const dimensionalPriceGroup of client.dimensionalPriceGroups.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: DimensionalPriceGroupListParams,
@@ -81,7 +115,7 @@ export class DimensionalPriceGroupsPage extends Page<DimensionalPriceGroup> {}
 
 /**
  * A dimensional price group is used to partition the result of a billable metric
- * by a set of dimensions. Prices in a price group must specify the parition used
+ * by a set of dimensions. Prices in a price group must specify the partition used
  * to derive their usage.
  */
 export interface DimensionalPriceGroup {

package/src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts

@@ -7,6 +7,14 @@ import * as DimensionalPriceGroupsAPI from './dimensional-price-groups';
 export class ExternalDimensionalPriceGroupID extends APIResource {
   /**
    * Fetch dimensional price group by external ID
+   *
+   * @example
+   * ```ts
+   * const dimensionalPriceGroup =
+   *   await client.dimensionalPriceGroups.externalDimensionalPriceGroupId.retrieve(
+   *     'external_dimensional_price_group_id',
+   *   );
+   * ```
    */
   retrieve(
     externalDimensionalPriceGroupId: string,
@@ -22,6 +30,14 @@ export class ExternalDimensionalPriceGroupID extends APIResource {
    * This endpoint can be used to update the `external_dimensional_price_group_id`
    * and `metadata` of an existing dimensional price group. Other fields on a
    * dimensional price group are currently immutable.
+   *
+   * @example
+   * ```ts
+   * const dimensionalPriceGroup =
+   *   await client.dimensionalPriceGroups.externalDimensionalPriceGroupId.update(
+   *     'external_dimensional_price_group_id',
+   *   );
+   * ```
    */
   update(
     externalDimensionalPriceGroupId: string,

package/src/resources/events/backfills.ts

@@ -52,6 +52,14 @@ export class Backfills extends APIResource {
    *
    * You may not have multiple backfills in a pending or pending_revert state with
    * overlapping timeframes.
+   *
+   * @example
+   * ```ts
+   * const backfill = await client.events.backfills.create({
+   *   timeframe_end: '2019-12-27T18:11:19.117Z',
+   *   timeframe_start: '2019-12-27T18:11:19.117Z',
+   * });
+   * ```
    */
   create(body: BackfillCreateParams, options?: Core.RequestOptions): Core.APIPromise<BackfillCreateResponse> {
     return this._client.post('/events/backfills', { body, ...options });
@@ -64,6 +72,14 @@ export class Backfills extends APIResource {
    * backfill. The response also includes
    * [`pagination_metadata`](/api-reference/pagination), which lets the caller
    * retrieve the next page of results if they exist.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const backfillListResponse of client.events.backfills.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: BackfillListParams,
@@ -85,6 +101,13 @@ export class Backfills extends APIResource {
    * backfill, Orb will asynchronously reflect the updated usage in invoice amounts
    * and usage graphs. Once all of the updates are complete, the backfill's status
    * will transition to `reflected`.
+   *
+   * @example
+   * ```ts
+   * const response = await client.events.backfills.close(
+   *   'backfill_id',
+   * );
+   * ```
    */
   close(backfillId: string, options?: Core.RequestOptions): Core.APIPromise<BackfillCloseResponse> {
     return this._client.post(`/events/backfills/${backfillId}/close`, options);
@@ -92,6 +115,13 @@ export class Backfills extends APIResource {
 
   /**
    * This endpoint is used to fetch a backfill given an identifier.
+   *
+   * @example
+   * ```ts
+   * const response = await client.events.backfills.fetch(
+   *   'backfill_id',
+   * );
+   * ```
    */
   fetch(backfillId: string, options?: Core.RequestOptions): Core.APIPromise<BackfillFetchResponse> {
     return this._client.get(`/events/backfills/${backfillId}`, options);
@@ -105,6 +135,13 @@ export class Backfills extends APIResource {
    *
    * If a backfill is reverted before its closed, no usage will be updated as a
    * result of the backfill and it will immediately transition to `reverted`.
+   *
+   * @example
+   * ```ts
+   * const response = await client.events.backfills.revert(
+   *   'backfill_id',
+   * );
+   * ```
    */
   revert(backfillId: string, options?: Core.RequestOptions): Core.APIPromise<BackfillRevertResponse> {
     return this._client.post(`/events/backfills/${backfillId}/revert`, options);

package/src/resources/events/events.ts

@@ -72,6 +72,15 @@ export class Events extends APIResource {
    * - By default, no more than 100 events can be amended for a single customer in a
    *   100 day period. For higher volume updates, consider using the
    *   [event backfill](create-backfill) endpoint.
+   *
+   * @example
+   * ```ts
+   * const event = await client.events.update('event_id', {
+   *   event_name: 'event_name',
+   *   properties: { foo: 'bar' },
+   *   timestamp: '2020-12-09T16:09:53Z',
+   * });
+   * ```
    */
   update(
     eventId: string,
@@ -122,6 +131,11 @@ export class Events extends APIResource {
    * - By default, no more than 100 events can be deprecated for a single customer in
    *   a 100 day period. For higher volume updates, consider using the
    *   [event backfill](create-backfill) endpoint.
+   *
+   * @example
+   * ```ts
+   * const response = await client.events.deprecate('event_id');
+   * ```
    */
   deprecate(eventId: string, options?: Core.RequestOptions): Core.APIPromise<EventDeprecateResponse> {
     return this._client.put(`/events/${eventId}/deprecate`, options);
@@ -243,8 +257,8 @@ export class Events extends APIResource {
    * billed for in the corresponding billing period.
    *
    * In general, Orb does not expect events with future dated timestamps. In cases
-   * where the timestamp is at least 24 hours ahead of the current time, the event
-   * will not be accepted as a valid event, and will throw validation errors.
+   * where the timestamp is 5 minutes ahead of the current time, the event will not
+   * be accepted as a valid event, and will throw validation errors.
    *
    * ## Event validation
    *
@@ -259,9 +273,9 @@ export class Events extends APIResource {
    * - If the `external_customer_id` is specified, the customer in Orb does not need
    *   to exist. Events will be attributed to any future customers with the
    *   `external_customer_id` on subscription creation.
-   * - `timestamp` must conform to ISO 8601 and represent a timestamp at most 1 hour
-   *   in the future. This timestamp should be sent in UTC timezone (no timezone
-   *   offset).
+   * - `timestamp` must conform to ISO 8601 and represent a timestamp at most 5
+   *   minutes in the future. This timestamp should be sent in UTC timezone (no
+   *   timezone offset).
    *
    * ## Idempotency and retry semantics
    *
@@ -298,39 +312,26 @@ export class Events extends APIResource {
    * request payload size, but please give us a heads up if you’re changing either of
    * these factors by an order of magnitude from initial setup.
    *
-   * ## Testing in debug mode
-   *
-   * The ingestion API supports a debug mode, which returns additional verbose output
-   * to indicate which event idempotency keys were newly ingested or duplicates from
-   * previous requests. To enable this mode, mark `debug=true` as a query parameter.
-   *
-   * If `debug=true` is not specified, the response will only contain
-   * `validation_failed`. Orb will still honor the idempotency guarantees set
-   * [here](/events-and-metrics/event-ingestion#event-volume-and-concurrency) in all
-   * cases.
-   *
-   * We strongly recommend that you only use debug mode as part of testing your
-   * initial Orb integration. Once you're ready to switch to production, disable
-   * debug mode to take advantage of improved performance and maximal throughput.
-   *
-   * #### Example: ingestion response with `debug=true`
+   * #### Example: ingestion response
    *
    * ```json
    * {
-   *   "debug": {
-   *     "duplicate": [],
-   *     "ingested": ["B7E83HDMfJPAunXW", "SJs5DQJ3TnwSqEZE", "8SivfDsNKwCeAXim"]
-   *   },
    *   "validation_failed": []
    * }
    * ```
    *
-   * #### Example: ingestion response with `debug=false`
-   *
-   * ```json
-   * {
-   *   "validation_failed": []
-   * }
+   * @example
+   * ```ts
+   * const response = await client.events.ingest({
+   *   events: [
+   *     {
+   *       event_name: 'event_name',
+   *       idempotency_key: 'idempotency_key',
+   *       properties: { foo: 'bar' },
+   *       timestamp: '2020-12-09T16:09:53Z',
+   *     },
+   *   ],
+   * });
    * ```
    */
   ingest(params: EventIngestParams, options?: Core.RequestOptions): Core.APIPromise<EventIngestResponse> {
@@ -354,6 +355,13 @@ export class Events extends APIResource {
    *
    * By default, Orb will not throw a `404` if no events matched, Orb will return an
    * empty array for `data` instead.
+   *
+   * @example
+   * ```ts
+   * const response = await client.events.search({
+   *   event_ids: ['string'],
+   * });
+   * ```
    */
   search(body: EventSearchParams, options?: Core.RequestOptions): Core.APIPromise<EventSearchResponse> {
     return this._client.post('/events/search', { body, ...options });
@@ -511,8 +519,8 @@ export interface EventIngestParams {
   backfill_id?: string | null;
 
   /**
-   * Query param: Flag to enable additional debug information in the endpoint
-   * response
+   * @deprecated Query param: Pending Deprecation: Flag to enable additional debug
+   * information in the endpoint response
    */
   debug?: boolean;
 }

package/src/resources/events/volume.ts

@@ -23,6 +23,13 @@ export class Volume extends APIResource {
    * where the start and end time are hour-aligned and in UTC. When a specific
    * timestamp is passed in for either start or end time, the response includes the
    * hours the timestamp falls in.
+   *
+   * @example
+   * ```ts
+   * const eventVolumes = await client.events.volume.list({
+   *   timeframe_start: '2019-12-27T18:11:19.117Z',
+   * });
+   * ```
    */
   list(query: VolumeListParams, options?: Core.RequestOptions): Core.APIPromise<EventVolumes> {
     return this._client.get('/events/volume', { query, ...options });