orb-billing 1.27.0 → 1.28.1

package/src/resources/coupons/coupons.ts

@@ -8,14 +8,14 @@ import * as SubscriptionsAPI from "./subscriptions";
 import { Page, type PageParams } from "../../pagination";
 
 export class Coupons extends APIResource {
-  subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this.client);
+  subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
 
   /**
    * This endpoint allows the creation of coupons, which can then be redeemed at
    * subscription creation or plan change.
    */
   create(body: CouponCreateParams, options?: Core.RequestOptions): Core.APIPromise<Coupon> {
-    return this.post('/coupons', { body, ...options });
+    return this._client.post('/coupons', { body, ...options });
   }
 
   /**
@@ -35,7 +35,7 @@ export class Coupons extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this.getAPIList('/coupons', CouponsPage, { query, ...options });
+    return this._client.getAPIList('/coupons', CouponsPage, { query, ...options });
   }
 
   /**
@@ -44,7 +44,7 @@ export class Coupons extends APIResource {
    * coupon is archived, its redemption code can be reused for a different coupon.
    */
   archive(couponId: string, options?: Core.RequestOptions): Core.APIPromise<Coupon> {
-    return this.post(`/coupons/${couponId}/archive`, options);
+    return this._client.post(`/coupons/${couponId}/archive`, options);
   }
 
   /**
@@ -53,7 +53,7 @@ export class Coupons extends APIResource {
    * parameter.
    */
   fetch(couponId: string, options?: Core.RequestOptions): Core.APIPromise<Coupon> {
-    return this.get(`/coupons/${couponId}`, options);
+    return this._client.get(`/coupons/${couponId}`, options);
   }
 }
 

package/src/resources/coupons/subscriptions.ts

@@ -32,7 +32,10 @@ export class Subscriptions extends APIResource {
     if (isRequestOptions(query)) {
       return this.list(couponId, {}, query);
     }
-    return this.getAPIList(`/coupons/${couponId}/subscriptions`, SubscriptionsPage, { query, ...options });
+    return this._client.getAPIList(`/coupons/${couponId}/subscriptions`, SubscriptionsPage, {
+      query,
+      ...options,
+    });
   }
 }
 

package/src/resources/credit-notes.ts

@@ -24,7 +24,7 @@ export class CreditNotes extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this.getAPIList('/credit_notes', CreditNotesPage, { query, ...options });
+    return this._client.getAPIList('/credit_notes', CreditNotesPage, { query, ...options });
   }
 
   /**
@@ -32,7 +32,7 @@ export class CreditNotes extends APIResource {
    * [`Credit Note`](../guides/invoicing/credit-notes) given an identifier.
    */
   fetch(creditNoteId: string, options?: Core.RequestOptions): Core.APIPromise<CreditNote> {
-    return this.get(`/credit_notes/${creditNoteId}`, options);
+    return this._client.get(`/credit_notes/${creditNoteId}`, options);
   }
 }
 

package/src/resources/customers/balance-transactions.ts

@@ -16,7 +16,7 @@ export class BalanceTransactions extends APIResource {
     body: BalanceTransactionCreateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<BalanceTransactionCreateResponse> {
-    return this.post(`/customers/${customerId}/balance_transactions`, { body, ...options });
+    return this._client.post(`/customers/${customerId}/balance_transactions`, { body, ...options });
   }
 
   /**
@@ -66,7 +66,7 @@ export class BalanceTransactions extends APIResource {
     if (isRequestOptions(query)) {
       return this.list(customerId, {}, query);
     }
-    return this.getAPIList(
+    return this._client.getAPIList(
       `/customers/${customerId}/balance_transactions`,
       BalanceTransactionListResponsesPage,
       { query, ...options },

package/src/resources/customers/costs.ts

@@ -157,7 +157,7 @@ export class Costs extends APIResource {
     if (isRequestOptions(query)) {
       return this.list(customerId, {}, query);
     }
-    return this.get(`/customers/${customerId}/costs`, { query, ...options });
+    return this._client.get(`/customers/${customerId}/costs`, { query, ...options });
   }
 
   /**
@@ -313,7 +313,10 @@ export class Costs extends APIResource {
     if (isRequestOptions(query)) {
       return this.listByExternalId(externalCustomerId, {}, query);
     }
-    return this.get(`/customers/external_customer_id/${externalCustomerId}/costs`, { query, ...options });
+    return this._client.get(`/customers/external_customer_id/${externalCustomerId}/costs`, {
+      query,
+      ...options,
+    });
   }
 }
 

package/src/resources/customers/credits/credits.ts

@@ -8,7 +8,7 @@ import * as LedgerAPI from "./ledger";
 import { Page, type PageParams } from "../../../pagination";
 
 export class Credits extends APIResource {
-  ledger: LedgerAPI.Ledger = new LedgerAPI.Ledger(this.client);
+  ledger: LedgerAPI.Ledger = new LedgerAPI.Ledger(this._client);
 
   /**
    * Returns a paginated list of unexpired, non-zero credit blocks for a customer.
@@ -30,7 +30,7 @@ export class Credits extends APIResource {
     if (isRequestOptions(query)) {
       return this.list(customerId, {}, query);
     }
-    return this.getAPIList(`/customers/${customerId}/credits`, CreditListResponsesPage, {
+    return this._client.getAPIList(`/customers/${customerId}/credits`, CreditListResponsesPage, {
       query,
       ...options,
     });
@@ -56,7 +56,7 @@ export class Credits extends APIResource {
     if (isRequestOptions(query)) {
       return this.listByExternalId(externalCustomerId, {}, query);
     }
-    return this.getAPIList(
+    return this._client.getAPIList(
       `/customers/external_customer_id/${externalCustomerId}/credits`,
       CreditListByExternalIDResponsesPage,
       { query, ...options },

package/src/resources/customers/credits/ledger.ts

@@ -107,7 +107,7 @@ export class Ledger extends APIResource {
     if (isRequestOptions(query)) {
       return this.list(customerId, {}, query);
     }
-    return this.getAPIList(`/customers/${customerId}/credits/ledger`, LedgerListResponsesPage, {
+    return this._client.getAPIList(`/customers/${customerId}/credits/ledger`, LedgerListResponsesPage, {
       query,
       ...options,
     });
@@ -229,7 +229,7 @@ export class Ledger extends APIResource {
     body: LedgerCreateEntryParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<LedgerCreateEntryResponse> {
-    return this.post(`/customers/${customerId}/credits/ledger_entry`, { body, ...options });
+    return this._client.post(`/customers/${customerId}/credits/ledger_entry`, { body, ...options });
   }
 
   /**
@@ -348,7 +348,7 @@ export class Ledger extends APIResource {
     body: LedgerCreateEntryByExternalIDParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<LedgerCreateEntryByExternalIDResponse> {
-    return this.post(`/customers/external_customer_id/${externalCustomerId}/credits/ledger_entry`, {
+    return this._client.post(`/customers/external_customer_id/${externalCustomerId}/credits/ledger_entry`, {
       body,
       ...options,
     });
@@ -454,7 +454,7 @@ export class Ledger extends APIResource {
     if (isRequestOptions(query)) {
       return this.listByExternalId(externalCustomerId, {}, query);
     }
-    return this.getAPIList(
+    return this._client.getAPIList(
       `/customers/external_customer_id/${externalCustomerId}/credits/ledger`,
       LedgerListByExternalIDResponsesPage,
       { query, ...options },
@@ -501,6 +501,10 @@ export namespace LedgerListResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -543,6 +547,10 @@ export namespace LedgerListResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -591,6 +599,10 @@ export namespace LedgerListResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     new_block_expiry_date: string;
@@ -635,6 +647,10 @@ export namespace LedgerListResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -677,6 +693,10 @@ export namespace LedgerListResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -723,6 +743,10 @@ export namespace LedgerListResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     new_block_expiry_date: string;
@@ -771,6 +795,10 @@ export namespace LedgerListResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -828,6 +856,10 @@ export namespace LedgerCreateEntryResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -870,6 +902,10 @@ export namespace LedgerCreateEntryResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -918,6 +954,10 @@ export namespace LedgerCreateEntryResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     new_block_expiry_date: string;
@@ -962,6 +1002,10 @@ export namespace LedgerCreateEntryResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -1004,6 +1048,10 @@ export namespace LedgerCreateEntryResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -1050,6 +1098,10 @@ export namespace LedgerCreateEntryResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     new_block_expiry_date: string;
@@ -1098,6 +1150,10 @@ export namespace LedgerCreateEntryResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -1155,6 +1211,10 @@ export namespace LedgerCreateEntryByExternalIDResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -1197,6 +1257,10 @@ export namespace LedgerCreateEntryByExternalIDResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -1245,6 +1309,10 @@ export namespace LedgerCreateEntryByExternalIDResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     new_block_expiry_date: string;
@@ -1289,6 +1357,10 @@ export namespace LedgerCreateEntryByExternalIDResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -1331,6 +1403,10 @@ export namespace LedgerCreateEntryByExternalIDResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -1377,6 +1453,10 @@ export namespace LedgerCreateEntryByExternalIDResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     new_block_expiry_date: string;
@@ -1425,6 +1505,10 @@ export namespace LedgerCreateEntryByExternalIDResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -1482,6 +1566,10 @@ export namespace LedgerListByExternalIDResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -1524,6 +1612,10 @@ export namespace LedgerListByExternalIDResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -1572,6 +1664,10 @@ export namespace LedgerListByExternalIDResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     new_block_expiry_date: string;
@@ -1616,6 +1712,10 @@ export namespace LedgerListByExternalIDResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -1658,6 +1758,10 @@ export namespace LedgerListByExternalIDResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -1704,6 +1808,10 @@ export namespace LedgerListByExternalIDResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     new_block_expiry_date: string;
@@ -1752,6 +1860,10 @@ export namespace LedgerListByExternalIDResponse {
 
     ledger_sequence_number: number;
 
+    /**
+     * User specified key-value pairs. If not provided, this defaults to an empty
+     * dictionary.
+     */
     metadata: Record<string, string>;
 
     starting_balance: number;
@@ -1845,9 +1957,9 @@ export namespace LedgerCreateEntryParams {
     invoice_settings?: LedgerCreateEntryParams.AddIncrementCreditLedgerEntryRequestParams.InvoiceSettings | null;
 
     /**
-     * User-specified key/value pairs for the ledger entry resource.
+     * User-specified key/value pairs for the resource.
      */
-    metadata?: unknown;
+    metadata?: Record<string, string | null> | null;
 
     /**
      * Can only be specified when entry_type=increment. How much, in USD, a customer
@@ -1901,9 +2013,9 @@ export namespace LedgerCreateEntryParams {
     description?: string | null;
 
     /**
-     * User-specified key/value pairs for the ledger entry resource.
+     * User-specified key/value pairs for the resource.
      */
-    metadata?: unknown;
+    metadata?: Record<string, string | null> | null;
   }
 
   export interface AddExpirationChangeCreditLedgerEntryRequestParams {
@@ -1942,9 +2054,9 @@ export namespace LedgerCreateEntryParams {
     description?: string | null;
 
     /**
-     * User-specified key/value pairs for the ledger entry resource.
+     * User-specified key/value pairs for the resource.
      */
-    metadata?: unknown;
+    metadata?: Record<string, string | null> | null;
   }
 
   export interface AddVoidCreditLedgerEntryRequestParams {
@@ -1969,9 +2081,9 @@ export namespace LedgerCreateEntryParams {
     description?: string | null;
 
     /**
-     * User-specified key/value pairs for the ledger entry resource.
+     * User-specified key/value pairs for the resource.
      */
-    metadata?: unknown;
+    metadata?: Record<string, string | null> | null;
 
     /**
      * Can only be specified when `entry_type=void`. The reason for the void.
@@ -2001,9 +2113,9 @@ export namespace LedgerCreateEntryParams {
     description?: string | null;
 
     /**
-     * User-specified key/value pairs for the ledger entry resource.
+     * User-specified key/value pairs for the resource.
      */
-    metadata?: unknown;
+    metadata?: Record<string, string | null> | null;
   }
 }
 
@@ -2052,9 +2164,9 @@ export namespace LedgerCreateEntryByExternalIDParams {
     invoice_settings?: LedgerCreateEntryByExternalIDParams.AddIncrementCreditLedgerEntryRequestParams.InvoiceSettings | null;
 
     /**
-     * User-specified key/value pairs for the ledger entry resource.
+     * User-specified key/value pairs for the resource.
      */
-    metadata?: unknown;
+    metadata?: Record<string, string | null> | null;
 
     /**
      * Can only be specified when entry_type=increment. How much, in USD, a customer
@@ -2108,9 +2220,9 @@ export namespace LedgerCreateEntryByExternalIDParams {
     description?: string | null;
 
     /**
-     * User-specified key/value pairs for the ledger entry resource.
+     * User-specified key/value pairs for the resource.
      */
-    metadata?: unknown;
+    metadata?: Record<string, string | null> | null;
   }
 
   export interface AddExpirationChangeCreditLedgerEntryRequestParams {
@@ -2149,9 +2261,9 @@ export namespace LedgerCreateEntryByExternalIDParams {
     description?: string | null;
 
     /**
-     * User-specified key/value pairs for the ledger entry resource.
+     * User-specified key/value pairs for the resource.
      */
-    metadata?: unknown;
+    metadata?: Record<string, string | null> | null;
   }
 
   export interface AddVoidCreditLedgerEntryRequestParams {
@@ -2176,9 +2288,9 @@ export namespace LedgerCreateEntryByExternalIDParams {
     description?: string | null;
 
     /**
-     * User-specified key/value pairs for the ledger entry resource.
+     * User-specified key/value pairs for the resource.
      */
-    metadata?: unknown;
+    metadata?: Record<string, string | null> | null;
 
     /**
      * Can only be specified when `entry_type=void`. The reason for the void.
@@ -2208,9 +2320,9 @@ export namespace LedgerCreateEntryByExternalIDParams {
     description?: string | null;
 
     /**
-     * User-specified key/value pairs for the ledger entry resource.
+     * User-specified key/value pairs for the resource.
      */
-    metadata?: unknown;
+    metadata?: Record<string, string | null> | null;
   }
 }