@stigg/typescript 0.1.0-alpha.1 → 0.1.0-alpha.3

package/src/resources/v1/customers/customers.ts

@@ -4,8 +4,9 @@ import { APIResource } from '../../../core/resource';
 import * as PaymentMethodAPI from './payment-method';
 import { PaymentMethod, PaymentMethodAttachParams } from './payment-method';
 import * as UsageAPI from './usage';
-import { Usage, UsageRetrieveParams, UsageRetrieveResponse } from './usage';
+import { Usage } from './usage';
 import { APIPromise } from '../../../core/api-promise';
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
@@ -14,56 +15,70 @@ export class Customers extends APIResource {
   usage: UsageAPI.Usage = new UsageAPI.Usage(this._client);
 
   /**
-   * Create a new Customer
+   * Provision customer
    */
   create(body: CustomerCreateParams, options?: RequestOptions): APIPromise<CustomerResponse> {
     return this._client.post('/api/v1/customers', { body, ...options });
   }
 
   /**
-   * Get a single Customer by id
+   * Get a single customer by ID
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<CustomerResponse> {
     return this._client.get(path`/api/v1/customers/${id}`, options);
   }
 
   /**
-   * Update an existing Customer
+   * Update a customer
    */
   update(id: string, body: CustomerUpdateParams, options?: RequestOptions): APIPromise<CustomerResponse> {
     return this._client.patch(path`/api/v1/customers/${id}`, { body, ...options });
   }
 
   /**
-   * Get a list of Customers
+   * Get a list of customers
    */
   list(
     query: CustomerListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CustomerListResponse> {
-    return this._client.get('/api/v1/customers', { query, ...options });
+  ): PagePromise<CustomerListResponsesMyCursorIDPage, CustomerListResponse> {
+    return this._client.getAPIList('/api/v1/customers', MyCursorIDPage<CustomerListResponse>, {
+      query,
+      ...options,
+    });
   }
 
   /**
-   * Perform archive on a Customer
+   * Archive customer
    */
   archive(id: string, options?: RequestOptions): APIPromise<CustomerResponse> {
     return this._client.post(path`/api/v1/customers/${id}/archive`, options);
   }
 
   /**
-   * Perform unarchive on a Customer
+   * Unarchive customer
    */
   unarchive(id: string, options?: RequestOptions): APIPromise<CustomerResponse> {
     return this._client.post(path`/api/v1/customers/${id}/unarchive`, options);
   }
 }
 
+export type CustomerListResponsesMyCursorIDPage = MyCursorIDPage<CustomerListResponse>;
+
+/**
+ * Response object
+ */
 export interface CustomerResponse {
+  /**
+   * A customer can be either an organization or an individual
+   */
   data: CustomerResponse.Data;
 }
 
 export namespace CustomerResponse {
+  /**
+   * A customer can be either an organization or an individual
+   */
   export interface Data {
     /**
      * Customer slug
@@ -147,6 +162,9 @@ export namespace CustomerResponse {
       type: 'CARD' | 'BANK' | 'CASH_APP';
     }
 
+    /**
+     * External billing or CRM integration link
+     */
     export interface Integration {
       /**
        * Integration details
@@ -176,125 +194,120 @@ export namespace CustomerResponse {
   }
 }
 
+/**
+ * A customer can be either an organization or an individual
+ */
 export interface CustomerListResponse {
-  data: Array<CustomerListResponse.Data>;
-}
+  /**
+   * Customer slug
+   */
+  id: string;
 
-export namespace CustomerListResponse {
-  export interface Data {
-    /**
-     * Customer slug
-     */
-    id: string;
+  /**
+   * Timestamp of when the record was deleted
+   */
+  archivedAt: string | null;
 
-    /**
-     * Timestamp of when the record was deleted
-     */
-    archivedAt: string | null;
+  /**
+   * Timestamp of when the record was created
+   */
+  createdAt: string;
 
-    /**
-     * Timestamp of when the record was created
-     */
-    createdAt: string;
+  /**
+   * Timestamp of when the record was last updated
+   */
+  updatedAt: string;
 
-    /**
-     * Cursor ID for query pagination
-     */
-    cursorId: string;
+  /**
+   * Customer level coupon
+   */
+  couponId?: string | null;
 
+  /**
+   * The default payment method details
+   */
+  defaultPaymentMethod?: CustomerListResponse.DefaultPaymentMethod | null;
+
+  /**
+   * The email of the customer
+   */
+  email?: string | null;
+
+  /**
+   * List of integrations
+   */
+  integrations?: Array<CustomerListResponse.Integration>;
+
+  /**
+   * Additional metadata
+   */
+  metadata?: { [key: string]: string };
+
+  /**
+   * The name of the customer
+   */
+  name?: string | null;
+}
+
+export namespace CustomerListResponse {
+  /**
+   * The default payment method details
+   */
+  export interface DefaultPaymentMethod {
     /**
-     * Timestamp of when the record was last updated
+     * The default payment method id
      */
-    updatedAt: string;
+    billingId: string | null;
 
     /**
-     * Customer level coupon
+     * The expiration month of the default payment method
      */
-    couponId?: string | null;
+    cardExpiryMonth: number | null;
 
     /**
-     * The default payment method details
+     * The expiration year of the default payment method
      */
-    defaultPaymentMethod?: Data.DefaultPaymentMethod | null;
+    cardExpiryYear: number | null;
 
     /**
-     * The email of the customer
+     * The last 4 digits of the default payment method
      */
-    email?: string | null;
+    cardLast4Digits: string | null;
 
     /**
-     * List of integrations
+     * The default payment method type
      */
-    integrations?: Array<Data.Integration>;
+    type: 'CARD' | 'BANK' | 'CASH_APP';
+  }
 
+  /**
+   * External billing or CRM integration link
+   */
+  export interface Integration {
     /**
-     * Additional metadata
+     * Integration details
      */
-    metadata?: { [key: string]: string };
+    id: string;
 
     /**
-     * The name of the customer
+     * Synced entity id
      */
-    name?: string | null;
-  }
+    syncedEntityId: string | null;
 
-  export namespace Data {
     /**
-     * The default payment method details
+     * The vendor identifier of integration
      */
-    export interface DefaultPaymentMethod {
-      /**
-       * The default payment method id
-       */
-      billingId: string | null;
-
-      /**
-       * The expiration month of the default payment method
-       */
-      cardExpiryMonth: number | null;
-
-      /**
-       * The expiration year of the default payment method
-       */
-      cardExpiryYear: number | null;
-
-      /**
-       * The last 4 digits of the default payment method
-       */
-      cardLast4Digits: string | null;
-
-      /**
-       * The default payment method type
-       */
-      type: 'CARD' | 'BANK' | 'CASH_APP';
-    }
-
-    export interface Integration {
-      /**
-       * Integration details
-       */
-      id: string;
-
-      /**
-       * Synced entity id
-       */
-      syncedEntityId: string | null;
-
-      /**
-       * The vendor identifier of integration
-       */
-      vendorIdentifier:
-        | 'AUTH0'
-        | 'ZUORA'
-        | 'STRIPE'
-        | 'HUBSPOT'
-        | 'AWS_MARKETPLACE'
-        | 'SNOWFLAKE'
-        | 'SALESFORCE'
-        | 'BIG_QUERY'
-        | 'OPEN_FGA'
-        | 'APP_STORE';
-    }
+    vendorIdentifier:
+      | 'AUTH0'
+      | 'ZUORA'
+      | 'STRIPE'
+      | 'HUBSPOT'
+      | 'AWS_MARKETPLACE'
+      | 'SNOWFLAKE'
+      | 'SALESFORCE'
+      | 'BIG_QUERY'
+      | 'OPEN_FGA'
+      | 'APP_STORE';
   }
 }
 
@@ -366,6 +379,9 @@ export namespace CustomerCreateParams {
     type: 'CARD' | 'BANK' | 'CASH_APP';
   }
 
+  /**
+   * External billing or CRM integration link
+   */
   export interface Integration {
     /**
      * Integration details
@@ -422,6 +438,9 @@ export interface CustomerUpdateParams {
 }
 
 export namespace CustomerUpdateParams {
+  /**
+   * External billing or CRM integration link
+   */
   export interface Integration {
     /**
      * Integration details
@@ -450,22 +469,7 @@ export namespace CustomerUpdateParams {
   }
 }
 
-export interface CustomerListParams {
-  /**
-   * Ending before this UUID for pagination
-   */
-  endingBefore?: string;
-
-  /**
-   * Items per page
-   */
-  limit?: number;
-
-  /**
-   * Starting after this UUID for pagination
-   */
-  startingAfter?: string;
-}
+export interface CustomerListParams extends MyCursorIDPageParams {}
 
 Customers.PaymentMethod = PaymentMethod;
 Customers.Usage = Usage;
@@ -474,6 +478,7 @@ export declare namespace Customers {
   export {
     type CustomerResponse as CustomerResponse,
     type CustomerListResponse as CustomerListResponse,
+    type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage,
     type CustomerCreateParams as CustomerCreateParams,
     type CustomerUpdateParams as CustomerUpdateParams,
     type CustomerListParams as CustomerListParams,
@@ -481,9 +486,5 @@ export declare namespace Customers {
 
   export { PaymentMethod as PaymentMethod, type PaymentMethodAttachParams as PaymentMethodAttachParams };
 
-  export {
-    Usage as Usage,
-    type UsageRetrieveResponse as UsageRetrieveResponse,
-    type UsageRetrieveParams as UsageRetrieveParams,
-  };
+  export { Usage as Usage };
 }

package/src/resources/v1/customers/index.ts

@@ -7,6 +7,7 @@ export {
   type CustomerCreateParams,
   type CustomerUpdateParams,
   type CustomerListParams,
+  type CustomerListResponsesMyCursorIDPage,
 } from './customers';
 export { PaymentMethod, type PaymentMethodAttachParams } from './payment-method';
-export { Usage, type UsageRetrieveResponse, type UsageRetrieveParams } from './usage';
+export { Usage } from './usage';

package/src/resources/v1/customers/payment-method.ts

@@ -8,7 +8,7 @@ import { path } from '../../../internal/utils/path';
 
 export class PaymentMethod extends APIResource {
   /**
-   * Perform payment-method attachment on a Customer
+   * Attach payment method
    */
   attach(
     id: string,
@@ -19,7 +19,7 @@ export class PaymentMethod extends APIResource {
   }
 
   /**
-   * Perform payment-method detachment on a Customer
+   * Detach payment method
    */
   detach(id: string, options?: RequestOptions): APIPromise<CustomersAPI.CustomerResponse> {
     return this._client.delete(path`/api/v1/customers/${id}/payment-method`, options);
@@ -52,6 +52,9 @@ export interface PaymentMethodAttachParams {
     | 'OPEN_FGA'
     | 'APP_STORE';
 
+  /**
+   * Customers selected currency
+   */
   billingCurrency?:
     | 'usd'
     | 'aed'

package/src/resources/v1/customers/usage.ts

@@ -1,132 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
-import { APIPromise } from '../../../core/api-promise';
-import { RequestOptions } from '../../../internal/request-options';
-import { path } from '../../../internal/utils/path';
 
-export class Usage extends APIResource {
-  /**
-   * Perform retrieval on a Usage history
-   */
-  retrieve(
-    featureID: string,
-    params: UsageRetrieveParams,
-    options?: RequestOptions,
-  ): APIPromise<UsageRetrieveResponse> {
-    const { customerId, ...query } = params;
-    return this._client.get(path`/api/v1/customers/${customerId}/usage/features/${featureID}`, {
-      query,
-      ...options,
-    });
-  }
-}
-
-export interface UsageRetrieveResponse {
-  data: UsageRetrieveResponse.Data;
-}
-
-export namespace UsageRetrieveResponse {
-  export interface Data {
-    /**
-     * Markers for events that affecting feature usage
-     */
-    markers: Array<Data.Marker>;
-
-    /**
-     * Series of usage history
-     */
-    series: Array<Data.Series>;
-  }
-
-  export namespace Data {
-    export interface Marker {
-      /**
-       * Timestamp of the marker
-       */
-      timestamp: string;
-
-      /**
-       * Type of marker for a usage history point
-       */
-      type: 'PERIODIC_RESET' | 'SUBSCRIPTION_CHANGE_RESET';
-    }
-
-    export interface Series {
-      /**
-       * Points in the usage history series
-       */
-      points: Array<Series.Point>;
-
-      /**
-       * Tags for the usage history series
-       */
-      tags: Array<Series.Tag>;
-    }
-
-    export namespace Series {
-      export interface Point {
-        /**
-         * Indicates whether there was usage reset in this point, see `markers` for details
-         */
-        isResetPoint: boolean;
-
-        /**
-         * Timestamp of the usage history point
-         */
-        timestamp: string;
-
-        /**
-         * Value of the usage history point
-         */
-        value: number;
-      }
-
-      export interface Tag {
-        /**
-         * Key of the tag
-         */
-        key: string;
-
-        /**
-         * Value of the tag
-         */
-        value: string;
-      }
-    }
-  }
-}
-
-export interface UsageRetrieveParams {
-  /**
-   * Path param: Customer id
-   */
-  customerId: string;
-
-  /**
-   * Query param: The start date of the range
-   */
-  startDate: string;
-
-  /**
-   * Query param: The end date of the range
-   */
-  endDate?: string;
-
-  /**
-   * Query param
-   */
-  groupBy?: string;
-
-  /**
-   * Query param: Resource id
-   */
-  resourceId?: string | null;
-}
-
-export declare namespace Usage {
-  export {
-    type UsageRetrieveResponse as UsageRetrieveResponse,
-    type UsageRetrieveParams as UsageRetrieveParams,
-  };
-}
+export class Usage extends APIResource {}

package/src/resources/v1/index.ts

@@ -7,6 +7,7 @@ export {
   type CouponListResponse,
   type CouponCreateParams,
   type CouponListParams,
+  type CouponListResponsesMyCursorIDPage,
 } from './coupons';
 export {
   Customers,
@@ -15,6 +16,7 @@ export {
   type CustomerCreateParams,
   type CustomerUpdateParams,
   type CustomerListParams,
+  type CustomerListResponsesMyCursorIDPage,
 } from './customers/index';
 export {
   Subscriptions,
@@ -31,6 +33,7 @@ export {
   type SubscriptionMigrateParams,
   type SubscriptionPreviewParams,
   type SubscriptionTransferParams,
+  type SubscriptionListResponsesMyCursorIDPage,
 } from './subscriptions/index';
 export {
   V1,

package/src/resources/v1/subscriptions/future-update.ts

@@ -7,7 +7,7 @@ import { path } from '../../../internal/utils/path';
 
 export class FutureUpdate extends APIResource {
   /**
-   * Perform cancel future update on a Subscription
+   * Cancel pending payment update
    */
   cancelPendingPayment(
     id: string,
@@ -17,13 +17,16 @@ export class FutureUpdate extends APIResource {
   }
 
   /**
-   * Perform cancel future update on a Subscription
+   * Cancel scheduled update
    */
   cancelSchedule(id: string, options?: RequestOptions): APIPromise<FutureUpdateCancelScheduleResponse> {
     return this._client.delete(path`/api/v1/subscriptions/${id}/future-update/schedule`, options);
   }
 }
 
+/**
+ * Response object
+ */
 export interface FutureUpdateCancelPendingPaymentResponse {
   data: FutureUpdateCancelPendingPaymentResponse.Data;
 }
@@ -37,6 +40,9 @@ export namespace FutureUpdateCancelPendingPaymentResponse {
   }
 }
 
+/**
+ * Response object
+ */
 export interface FutureUpdateCancelScheduleResponse {
   data: FutureUpdateCancelScheduleResponse.Data;
 }

package/src/resources/v1/subscriptions/index.ts

@@ -20,4 +20,5 @@ export {
   type SubscriptionMigrateParams,
   type SubscriptionPreviewParams,
   type SubscriptionTransferParams,
+  type SubscriptionListResponsesMyCursorIDPage,
 } from './subscriptions';