feat(api): remove unsupported params (#24)

Author: stainless-bot

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.

src/resources/events/events.ts

@@ -2,7 +2,6 @@
 
 import * as Core from 'orb-billing/core';
 import { APIResource } from 'orb-billing/resource';
-import { isRequestOptions } from 'orb-billing/core';
 import * as EventsAPI from 'orb-billing/resources/events/events';
 import * as BackfillsAPI from 'orb-billing/resources/events/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 {

src/resources/subscriptions.ts

@@ -399,7 +399,7 @@ export class Subscriptions extends APIResource {
    * Orb supports invoicing for a subscription when a preconfigured usage threshold
    * is hit. To enable threshold billing, pass in an `invoicing_threshold`, which is
    * specified in the subscription's invoicing currency, when creating a
-   * subscription. Ex. pass in `10.00` to issue an invoice when usage amounts hit
+   * subscription. E.g. pass in `10.00` to issue an invoice when usage amounts hit
    * $10.00 for a subscription that invoices in USD.
    */
   create(body?: SubscriptionCreateParams, options?: Core.RequestOptions): Core.APIPromise<Subscription>;

tests/api-resources/events/events.test.ts

@@ -117,8 +117,8 @@ describe('resource events', () => {
     });
   });
 
-  test('search', async () => {
-    const responsePromise = orb.events.search();
+  test('search: only required params', async () => {
+    const responsePromise = orb.events.search({ event_ids: ['string', 'string', 'string'] });
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
     const response = await responsePromise;
@@ -128,27 +128,7 @@ describe('resource events', () => {
     expect(dataAndResponse.response).toBe(rawResponse);
   });
 
-  test('search: request options instead of params are passed correctly', async () => {
-    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
-    await expect(orb.events.search({ path: '/_stainless_unknown_path' })).rejects.toThrow(Orb.NotFoundError);
-  });
-
-  test('search: request options and params are passed correctly', async () => {
-    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
-    await expect(
-      orb.events.search(
-        {
-          cursor: 'string',
-          limit: 0,
-          'timestamp[gt]': '2019-12-27T18:11:19.117Z',
-          'timestamp[gte]': '2019-12-27T18:11:19.117Z',
-          'timestamp[lt]': '2019-12-27T18:11:19.117Z',
-          'timestamp[lte]': '2019-12-27T18:11:19.117Z',
-          event_ids: ['string', 'string', 'string'],
-          invoice_id: 'string',
-        },
-        { path: '/_stainless_unknown_path' },
-      ),
-    ).rejects.toThrow(Orb.NotFoundError);
+  test('search: required and optional params', async () => {
+    const response = await orb.events.search({ event_ids: ['string', 'string', 'string'] });
   });
 });