@metronome/sdk 0.3.0 → 2.0.0

package/src/resources/v1/plans.ts

@@ -1,11 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource.js";
-import { isRequestOptions } from "../../core.js";
-import * as Core from "../../core.js";
-import * as Shared from "../shared.js";
-import * as CustomersAPI from "./customers/customers.js";
-import { CursorPage, type CursorPageParams } from "../../pagination.js";
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import * as CustomersAPI from './customers/customers';
+import { APIPromise } from '../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 export class Plans extends APIResource {
   /**
@@ -20,18 +21,10 @@ export class Plans extends APIResource {
    * ```
    */
   list(
-    query?: PlanListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PlanListResponsesCursorPage, PlanListResponse>;
-  list(options?: Core.RequestOptions): Core.PagePromise<PlanListResponsesCursorPage, PlanListResponse>;
-  list(
-    query: PlanListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PlanListResponsesCursorPage, PlanListResponse> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
-    return this._client.getAPIList('/v1/plans', PlanListResponsesCursorPage, { query, ...options });
+    query: PlanListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PlanListResponsesCursorPage, PlanListResponse> {
+    return this._client.getAPIList('/v1/plans', CursorPage<PlanListResponse>, { query, ...options });
   }
 
   /**
@@ -44,12 +37,9 @@ export class Plans extends APIResource {
    * });
    * ```
    */
-  getDetails(
-    params: PlanGetDetailsParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<PlanGetDetailsResponse> {
+  getDetails(params: PlanGetDetailsParams, options?: RequestOptions): APIPromise<PlanGetDetailsResponse> {
     const { plan_id } = params;
-    return this._client.get(`/v1/planDetails/${plan_id}`, options);
+    return this._client.get(path`/v1/planDetails/${plan_id}`, options);
   }
 
   /**
@@ -67,13 +57,14 @@ export class Plans extends APIResource {
    */
   listCharges(
     params: PlanListChargesParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PlanListChargesResponsesCursorPage, PlanListChargesResponse> {
+    options?: RequestOptions,
+  ): PagePromise<PlanListChargesResponsesCursorPage, PlanListChargesResponse> {
     const { plan_id, ...query } = params;
-    return this._client.getAPIList(`/v1/planDetails/${plan_id}/charges`, PlanListChargesResponsesCursorPage, {
-      query,
-      ...options,
-    });
+    return this._client.getAPIList(
+      path`/v1/planDetails/${plan_id}/charges`,
+      CursorPage<PlanListChargesResponse>,
+      { query, ...options },
+    );
   }
 
   /**
@@ -92,26 +83,29 @@ export class Plans extends APIResource {
    */
   listCustomers(
     params: PlanListCustomersParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PlanListCustomersResponsesCursorPage, PlanListCustomersResponse> {
+    options?: RequestOptions,
+  ): PagePromise<PlanListCustomersResponsesCursorPage, PlanListCustomersResponse> {
     const { plan_id, ...query } = params;
     return this._client.getAPIList(
-      `/v1/planDetails/${plan_id}/customers`,
-      PlanListCustomersResponsesCursorPage,
+      path`/v1/planDetails/${plan_id}/customers`,
+      CursorPage<PlanListCustomersResponse>,
       { query, ...options },
     );
   }
 }
 
-export class PlanListResponsesCursorPage extends CursorPage<PlanListResponse> {}
+export type PlanListResponsesCursorPage = CursorPage<PlanListResponse>;
 
-export class PlanListChargesResponsesCursorPage extends CursorPage<PlanListChargesResponse> {}
+export type PlanListChargesResponsesCursorPage = CursorPage<PlanListChargesResponse>;
 
-export class PlanListCustomersResponsesCursorPage extends CursorPage<PlanListCustomersResponse> {}
+export type PlanListCustomersResponsesCursorPage = CursorPage<PlanListCustomersResponse>;
 
 export interface PlanDetail {
   id: string;
 
+  /**
+   * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+   */
   custom_fields: { [key: string]: string };
 
   name: string;
@@ -186,6 +180,9 @@ export interface PlanListResponse {
 
   name: string;
 
+  /**
+   * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+   */
   custom_fields?: { [key: string]: string };
 }
 
@@ -200,6 +197,9 @@ export interface PlanListChargesResponse {
 
   credit_type: Shared.CreditTypeData;
 
+  /**
+   * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+   */
   custom_fields: { [key: string]: string };
 
   name: string;
@@ -273,6 +273,9 @@ export namespace PlanListCustomersResponse {
   export interface PlanDetails {
     id: string;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields: { [key: string]: string };
 
     customer_plan_id: string;
@@ -324,10 +327,6 @@ export interface PlanListCustomersParams extends CursorPageParams {
   status?: 'all' | 'active' | 'ended' | 'upcoming';
 }
 
-Plans.PlanListResponsesCursorPage = PlanListResponsesCursorPage;
-Plans.PlanListChargesResponsesCursorPage = PlanListChargesResponsesCursorPage;
-Plans.PlanListCustomersResponsesCursorPage = PlanListCustomersResponsesCursorPage;
-
 export declare namespace Plans {
   export {
     type PlanDetail as PlanDetail,
@@ -335,9 +334,9 @@ export declare namespace Plans {
     type PlanGetDetailsResponse as PlanGetDetailsResponse,
     type PlanListChargesResponse as PlanListChargesResponse,
     type PlanListCustomersResponse as PlanListCustomersResponse,
-    PlanListResponsesCursorPage as PlanListResponsesCursorPage,
-    PlanListChargesResponsesCursorPage as PlanListChargesResponsesCursorPage,
-    PlanListCustomersResponsesCursorPage as PlanListCustomersResponsesCursorPage,
+    type PlanListResponsesCursorPage as PlanListResponsesCursorPage,
+    type PlanListChargesResponsesCursorPage as PlanListChargesResponsesCursorPage,
+    type PlanListCustomersResponsesCursorPage as PlanListCustomersResponsesCursorPage,
     type PlanListParams as PlanListParams,
     type PlanGetDetailsParams as PlanGetDetailsParams,
     type PlanListChargesParams as PlanListChargesParams,

package/src/resources/v1/pricing-units.ts

@@ -1,13 +1,17 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource.js";
-import { isRequestOptions } from "../../core.js";
-import * as Core from "../../core.js";
-import { CursorPage, type CursorPageParams } from "../../pagination.js";
+import { APIResource } from '../../core/resource';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
 
 export class PricingUnits extends APIResource {
   /**
-   * List all pricing units (known in the API by the legacy term "credit types").
+   * List all pricing units. All fiat currency types (for example, USD or GBP) will
+   * be included, as well as any custom pricing units that were configured. Custom
+   * pricing units can be used to charge for usage in a non-fiat pricing unit, for
+   * example AI credits.
+   *
+   * Note: The USD (cents) pricing unit is 2714e483-4ff1-48e4-9e25-ac732e8f24f2.
    *
    * @example
    * ```ts
@@ -18,27 +22,17 @@ export class PricingUnits extends APIResource {
    * ```
    */
   list(
-    query?: PricingUnitListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PricingUnitListResponsesCursorPage, PricingUnitListResponse>;
-  list(
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PricingUnitListResponsesCursorPage, PricingUnitListResponse>;
-  list(
-    query: PricingUnitListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PricingUnitListResponsesCursorPage, PricingUnitListResponse> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
-    return this._client.getAPIList('/v1/credit-types/list', PricingUnitListResponsesCursorPage, {
+    query: PricingUnitListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PricingUnitListResponsesCursorPage, PricingUnitListResponse> {
+    return this._client.getAPIList('/v1/credit-types/list', CursorPage<PricingUnitListResponse>, {
       query,
       ...options,
     });
   }
 }
 
-export class PricingUnitListResponsesCursorPage extends CursorPage<PricingUnitListResponse> {}
+export type PricingUnitListResponsesCursorPage = CursorPage<PricingUnitListResponse>;
 
 export interface PricingUnitListResponse {
   id?: string;
@@ -50,12 +44,10 @@ export interface PricingUnitListResponse {
 
 export interface PricingUnitListParams extends CursorPageParams {}
 
-PricingUnits.PricingUnitListResponsesCursorPage = PricingUnitListResponsesCursorPage;
-
 export declare namespace PricingUnits {
   export {
     type PricingUnitListResponse as PricingUnitListResponse,
-    PricingUnitListResponsesCursorPage as PricingUnitListResponsesCursorPage,
+    type PricingUnitListResponsesCursorPage as PricingUnitListResponsesCursorPage,
     type PricingUnitListParams as PricingUnitListParams,
   };
 }

package/src/resources/v1/services.ts

@@ -1,21 +1,24 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource.js";
-import * as Core from "../../core.js";
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
 
 export class Services extends APIResource {
   /**
-   * Fetches a list of services used by Metronome and the associated IP addresses. IP
-   * addresses are not necessarily unique between services. In most cases, IP
-   * addresses will appear in the list at least 30 days before they are used for the
-   * first time.
+   * Gets Metronome's service registry with associated IP addresses for security
+   * allowlisting and firewall configuration. Use this endpoint to maintain an
+   * up-to-date list of IPs that your systems should trust for Metronome
+   * communications. Returns service names and their current IP ranges, with new IPs
+   * typically appearing 30+ days before first use to ensure smooth allowlist
+   * updates.
    *
    * @example
    * ```ts
    * const services = await client.v1.services.list();
    * ```
    */
-  list(options?: Core.RequestOptions): Core.APIPromise<ServiceListResponse> {
+  list(options?: RequestOptions): APIPromise<ServiceListResponse> {
     return this._client.get('/v1/services', options);
   }
 }