orb-billing 1.25.0 → 1.27.0

package/src/core.ts

@@ -43,6 +43,10 @@ async function defaultParseResponse<T>(props: APIResponseProps): Promise<T> {
     return null as T;
   }
 
+  if (props.options.__binaryResponse) {
+    return response as unknown as T;
+  }
+
   const contentType = response.headers.get('content-type');
   if (contentType?.includes('application/json')) {
     const json = await response.json();
@@ -52,10 +56,11 @@ async function defaultParseResponse<T>(props: APIResponseProps): Promise<T> {
     return json as T;
   }
 
-  // TODO handle blob, arraybuffer, other content types, etc.
   const text = await response.text();
   debug('response', response.status, response.url, response.headers, text);
-  return text as any as T;
+
+  // TODO handle blob, arraybuffer, other content types, etc.
+  return text as unknown as T;
 }
 
 /**
@@ -720,6 +725,8 @@ export type RequestOptions<Req extends {} = Record<string, unknown> | Readable>
   httpAgent?: Agent;
   signal?: AbortSignal | undefined | null;
   idempotencyKey?: string;
+
+  __binaryResponse?: boolean | undefined;
 };
 
 // This is required so that we can determine if a given object matches the RequestOptions
@@ -738,6 +745,8 @@ const requestOptionsKeys: KeysEnum<RequestOptions> = {
   httpAgent: true,
   signal: true,
   idempotencyKey: true,
+
+  __binaryResponse: true,
 };
 
 export const isRequestOptions = (obj: unknown): obj is RequestOptions<Record<string, unknown> | Readable> => {

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

@@ -46,7 +46,7 @@ export class Ledger extends APIResource {
    * deductions take place from a non-expiring credit block.
    *
    * If there are multiple blocks with the same expiration date, Orb will deduct from
-   * the block with the _lower cost basis_ first (ex. trial credits with a $0 cost
+   * the block with the _lower cost basis_ first (e.g. trial credits with a $0 cost
    * basis before paid credits with a $5.00 cost basis).
    *
    * It's also possible for a single usage event's deduction to _span_ credit blocks.
@@ -393,7 +393,7 @@ export class Ledger extends APIResource {
    * deductions take place from a non-expiring credit block.
    *
    * If there are multiple blocks with the same expiration date, Orb will deduct from
-   * the block with the _lower cost basis_ first (ex. trial credits with a $0 cost
+   * the block with the _lower cost basis_ first (e.g. trial credits with a $0 cost
    * basis before paid credits with a $5.00 cost basis).
    *
    * It's also possible for a single usage event's deduction to _span_ credit blocks.

package/src/resources/customers/customers.ts

@@ -39,7 +39,7 @@ export class Customers extends APIResource {
    * This endpoint can be used to update the `payment_provider`,
    * `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`,
    * `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and
-   * `additional_emails` of an existing customer. "Other fields on a customer are
+   * `additional_emails` of an existing customer. Other fields on a customer are
    * currently immutable.
    */
   update(
@@ -1030,13 +1030,6 @@ export interface CustomerUpdateParams {
 
   email_delivery?: boolean | null;
 
-  /**
-   * An optional user-defined ID for this customer resource, used throughout the
-   * system as an alias for this Customer. Use this field to identify a customer by
-   * an existing identifier in your system.
-   */
-  external_customer_id?: string | null;
-
   /**
    * User-specified key value pairs, often useful for referencing internal resources
    * or IDs. Returned as-is in the customer resource.
@@ -1452,13 +1445,6 @@ export interface CustomerUpdateByExternalIDParams {
 
   email_delivery?: boolean | null;
 
-  /**
-   * An optional user-defined ID for this customer resource, used throughout the
-   * system as an alias for this Customer. Use this field to identify a customer by
-   * an existing identifier in your system.
-   */
-  external_customer_id?: string | null;
-
   /**
    * User-specified key value pairs, often useful for referencing internal resources
    * or IDs. Returned as-is in the customer resource.

package/src/resources/events/events.ts

@@ -2,7 +2,6 @@
 
 import * as Core from "../../core";
 import { APIResource } from "../../resource";
-import { isRequestOptions } from "../../core";
 import * as EventsAPI from "./events";
 import * as BackfillsAPI from "./backfills";
 
@@ -26,7 +25,7 @@ export class Events extends APIResource {
    * event in cases where you need to:
    *
    * - update an event with new metadata as you iterate on your pricing model
-   * - update an event based on the result of an external API call (ex. call to a
+   * - update an event based on the result of an external API call (e.g. call to a
    *   payment gateway succeeded or failed)
    *
    * This amendment API is always audit-safe. The process will still retain the
@@ -74,7 +73,7 @@ export class Events extends APIResource {
    * event in cases where you need to:
    *
    * - no longer bill for an event that was improperly reported
-   * - no longer bill for an event based on the result of an external API call (ex.
+   * - no longer bill for an event based on the result of an external API call (e.g.
    *   call to a payment gateway failed and the user should not be billed)
    *
    * If you want to only change specific properties of an event, but keep the event
@@ -323,46 +322,14 @@ export class Events extends APIResource {
    *
    * - `event_ids`: This is an explicit array of IDs to filter by. Note that an
    *   event's ID is the `idempotency_key` that was originally used for ingestion.
-   * - `invoice_id`: This is an issued Orb invoice ID (see also
-   *   [List Invoices](list-invoices)). Orb will fetch all events that were used to
-   *   calculate the invoice. In the common case, this will be a list of events whose
-   *   `timestamp` property falls within the billing period specified by the invoice.
    *
    * By default, Orb does not return _deprecated_ events in this endpoint.
    *
    * By default, Orb will not throw a `404` if no events matched, Orb will return an
    * empty array for `data` instead.
    */
-  search(params?: EventSearchParams, options?: Core.RequestOptions): Core.APIPromise<EventSearchResponse>;
-  search(options?: Core.RequestOptions): Core.APIPromise<EventSearchResponse>;
-  search(
-    params: EventSearchParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<EventSearchResponse> {
-    if (isRequestOptions(params)) {
-      return this.search({}, params);
-    }
-    const {
-      cursor,
-      limit,
-      'timestamp[gt]': timestampGt,
-      'timestamp[gte]': timestampGte,
-      'timestamp[lt]': timestampLt,
-      'timestamp[lte]': timestampLte,
-      ...body
-    } = params;
-    return this.post('/events/search', {
-      query: {
-        cursor,
-        limit,
-        'timestamp[gt]': timestampGt,
-        'timestamp[gte]': timestampGte,
-        'timestamp[lt]': timestampLt,
-        'timestamp[lte]': timestampLte,
-      },
-      body,
-      ...options,
-    });
+  search(body: EventSearchParams, options?: Core.RequestOptions): Core.APIPromise<EventSearchResponse> {
+    return this.post('/events/search', { body, ...options });
   }
 }
 
@@ -421,8 +388,6 @@ export namespace EventIngestResponse {
 
 export interface EventSearchResponse {
   data: Array<EventSearchResponse.Data>;
-
-  pagination_metadata: EventSearchResponse.PaginationMetadata;
 }
 
 export namespace EventSearchResponse {
@@ -469,12 +434,6 @@ export namespace EventSearchResponse {
      */
     timestamp: string;
   }
-
-  export interface PaginationMetadata {
-    has_more: boolean;
-
-    next_cursor: string | null;
-  }
 }
 
 export interface EventUpdateParams {
@@ -569,50 +528,11 @@ export namespace EventIngestParams {
 
 export interface EventSearchParams {
   /**
-   * Query param: Cursor for pagination. This can be populated by the `next_cursor`
-   * value returned from the initial request.
-   */
-  cursor?: string | null;
-
-  /**
-   * Query param: The number of items to fetch. Defaults to 20.
-   */
-  limit?: number;
-
-  /**
-   * Query param:
-   */
-  'timestamp[gt]'?: string | null;
-
-  /**
-   * Query param:
-   */
-  'timestamp[gte]'?: string | null;
-
-  /**
-   * Query param:
-   */
-  'timestamp[lt]'?: string | null;
-
-  /**
-   * Query param:
-   */
-  'timestamp[lte]'?: string | null;
-
-  /**
-   * Body param: This is an explicit array of IDs to filter by. Note that an event's
-   * ID is the idempotency_key that was originally used for ingestion. Values in this
-   * array will be treated case sensitively.
-   */
-  event_ids?: Array<string> | null;
-
-  /**
-   * Body param: This is an issued Orb invoice ID (see also List Invoices). Orb will
-   * fetch all events that were used to calculate the invoice. In the common case,
-   * this will be a list of events whose timestamp property falls within the billing
-   * period specified by the invoice.
+   * This is an explicit array of IDs to filter by. Note that an event's ID is the
+   * idempotency_key that was originally used for ingestion. Values in this array
+   * will be treated case sensitively.
    */
-  invoice_id?: string | null;
+  event_ids: Array<string>;
 }
 
 export namespace Events {