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

package/src/resources/v1/coupons.ts

@@ -2,448 +2,70 @@
 
 import { APIResource } from '../../core/resource';
 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';
 
 export class Coupons extends APIResource {
   /**
-   * Create a new Coupon
+   * Creates a new discount coupon with percentage or fixed amount off, applicable to
+   * customer subscriptions.
    */
-  create(body: CouponCreateParams, options?: RequestOptions): APIPromise<CouponCreateResponse> {
+  create(body: CouponCreateParams, options?: RequestOptions): APIPromise<Coupon> {
     return this._client.post('/api/v1/coupons', { body, ...options });
   }
 
   /**
-   * Get a single Coupon by id
+   * Retrieves a coupon by its unique identifier.
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<CouponRetrieveResponse> {
+  retrieve(id: string, options?: RequestOptions): APIPromise<Coupon> {
     return this._client.get(path`/api/v1/coupons/${id}`, options);
   }
 
   /**
-   * Get a list of Coupons
+   * Retrieves a paginated list of coupons in the environment.
    */
   list(
     query: CouponListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CouponListResponse> {
-    return this._client.get('/api/v1/coupons', { query, ...options });
+  ): PagePromise<CouponListResponsesMyCursorIDPage, CouponListResponse> {
+    return this._client.getAPIList('/api/v1/coupons', MyCursorIDPage<CouponListResponse>, {
+      query,
+      ...options,
+    });
   }
-}
-
-export interface CouponCreateResponse {
-  data: CouponCreateResponse.Data;
-}
-
-export namespace CouponCreateResponse {
-  export interface Data {
-    /**
-     * The unique identifier for the entity
-     */
-    id: string;
-
-    /**
-     * Fixed amount discounts in different currencies
-     */
-    amountsOff: Array<Data.AmountsOff> | null;
-
-    /**
-     * The unique identifier for the entity in the billing provider
-     */
-    billingId: string | null;
-
-    /**
-     * The URL to the entity in the billing provider
-     */
-    billingLinkUrl: string | null;
-
-    /**
-     * Timestamp of when the record was created
-     */
-    createdAt: string;
-
-    /**
-     * Description of the coupon
-     */
-    description: string | null;
-
-    /**
-     * Duration of the coupon validity in months
-     */
-    durationInMonths: number | null;
-
-    /**
-     * Name of the coupon
-     */
-    name: string;
-
-    /**
-     * Percentage discount off the original price
-     */
-    percentOff: number | null;
-
-    /**
-     * The source of the coupon
-     */
-    source: 'STIGG' | 'STIGG_ADHOC' | 'STRIPE' | null;
-
-    /**
-     * Current status of the coupon
-     */
-    status: 'ACTIVE' | 'ARCHIVED';
-
-    /**
-     * Type of the coupon (percentage or fixed amount)
-     */
-    type: 'FIXED' | 'PERCENTAGE';
-
-    /**
-     * Timestamp of when the record was last updated
-     */
-    updatedAt: string;
-  }
-
-  export namespace Data {
-    export interface AmountsOff {
-      /**
-       * The price amount
-       */
-      amount: number;
-
-      /**
-       * The price currency
-       */
-      currency:
-        | 'usd'
-        | 'aed'
-        | 'all'
-        | 'amd'
-        | 'ang'
-        | 'aud'
-        | 'awg'
-        | 'azn'
-        | 'bam'
-        | 'bbd'
-        | 'bdt'
-        | 'bgn'
-        | 'bif'
-        | 'bmd'
-        | 'bnd'
-        | 'bsd'
-        | 'bwp'
-        | 'byn'
-        | 'bzd'
-        | 'brl'
-        | 'cad'
-        | 'cdf'
-        | 'chf'
-        | 'cny'
-        | 'czk'
-        | 'dkk'
-        | 'dop'
-        | 'dzd'
-        | 'egp'
-        | 'etb'
-        | 'eur'
-        | 'fjd'
-        | 'gbp'
-        | 'gel'
-        | 'gip'
-        | 'gmd'
-        | 'gyd'
-        | 'hkd'
-        | 'hrk'
-        | 'htg'
-        | 'idr'
-        | 'ils'
-        | 'inr'
-        | 'isk'
-        | 'jmd'
-        | 'jpy'
-        | 'kes'
-        | 'kgs'
-        | 'khr'
-        | 'kmf'
-        | 'krw'
-        | 'kyd'
-        | 'kzt'
-        | 'lbp'
-        | 'lkr'
-        | 'lrd'
-        | 'lsl'
-        | 'mad'
-        | 'mdl'
-        | 'mga'
-        | 'mkd'
-        | 'mmk'
-        | 'mnt'
-        | 'mop'
-        | 'mro'
-        | 'mvr'
-        | 'mwk'
-        | 'mxn'
-        | 'myr'
-        | 'mzn'
-        | 'nad'
-        | 'ngn'
-        | 'nok'
-        | 'npr'
-        | 'nzd'
-        | 'pgk'
-        | 'php'
-        | 'pkr'
-        | 'pln'
-        | 'qar'
-        | 'ron'
-        | 'rsd'
-        | 'rub'
-        | 'rwf'
-        | 'sar'
-        | 'sbd'
-        | 'scr'
-        | 'sek'
-        | 'sgd'
-        | 'sle'
-        | 'sll'
-        | 'sos'
-        | 'szl'
-        | 'thb'
-        | 'tjs'
-        | 'top'
-        | 'try'
-        | 'ttd'
-        | 'tzs'
-        | 'uah'
-        | 'uzs'
-        | 'vnd'
-        | 'vuv'
-        | 'wst'
-        | 'xaf'
-        | 'xcd'
-        | 'yer'
-        | 'zar'
-        | 'zmw'
-        | 'clp'
-        | 'djf'
-        | 'gnf'
-        | 'ugx'
-        | 'pyg'
-        | 'xof'
-        | 'xpf'
-        | null;
-    }
-  }
-}
-
-export interface CouponRetrieveResponse {
-  data: CouponRetrieveResponse.Data;
-}
-
-export namespace CouponRetrieveResponse {
-  export interface Data {
-    /**
-     * The unique identifier for the entity
-     */
-    id: string;
-
-    /**
-     * Fixed amount discounts in different currencies
-     */
-    amountsOff: Array<Data.AmountsOff> | null;
-
-    /**
-     * The unique identifier for the entity in the billing provider
-     */
-    billingId: string | null;
-
-    /**
-     * The URL to the entity in the billing provider
-     */
-    billingLinkUrl: string | null;
-
-    /**
-     * Timestamp of when the record was created
-     */
-    createdAt: string;
-
-    /**
-     * Description of the coupon
-     */
-    description: string | null;
-
-    /**
-     * Duration of the coupon validity in months
-     */
-    durationInMonths: number | null;
-
-    /**
-     * Name of the coupon
-     */
-    name: string;
-
-    /**
-     * Percentage discount off the original price
-     */
-    percentOff: number | null;
-
-    /**
-     * The source of the coupon
-     */
-    source: 'STIGG' | 'STIGG_ADHOC' | 'STRIPE' | null;
-
-    /**
-     * Current status of the coupon
-     */
-    status: 'ACTIVE' | 'ARCHIVED';
-
-    /**
-     * Type of the coupon (percentage or fixed amount)
-     */
-    type: 'FIXED' | 'PERCENTAGE';
-
-    /**
-     * Timestamp of when the record was last updated
-     */
-    updatedAt: string;
-  }
-
-  export namespace Data {
-    export interface AmountsOff {
-      /**
-       * The price amount
-       */
-      amount: number;
-
-      /**
-       * The price currency
-       */
-      currency:
-        | 'usd'
-        | 'aed'
-        | 'all'
-        | 'amd'
-        | 'ang'
-        | 'aud'
-        | 'awg'
-        | 'azn'
-        | 'bam'
-        | 'bbd'
-        | 'bdt'
-        | 'bgn'
-        | 'bif'
-        | 'bmd'
-        | 'bnd'
-        | 'bsd'
-        | 'bwp'
-        | 'byn'
-        | 'bzd'
-        | 'brl'
-        | 'cad'
-        | 'cdf'
-        | 'chf'
-        | 'cny'
-        | 'czk'
-        | 'dkk'
-        | 'dop'
-        | 'dzd'
-        | 'egp'
-        | 'etb'
-        | 'eur'
-        | 'fjd'
-        | 'gbp'
-        | 'gel'
-        | 'gip'
-        | 'gmd'
-        | 'gyd'
-        | 'hkd'
-        | 'hrk'
-        | 'htg'
-        | 'idr'
-        | 'ils'
-        | 'inr'
-        | 'isk'
-        | 'jmd'
-        | 'jpy'
-        | 'kes'
-        | 'kgs'
-        | 'khr'
-        | 'kmf'
-        | 'krw'
-        | 'kyd'
-        | 'kzt'
-        | 'lbp'
-        | 'lkr'
-        | 'lrd'
-        | 'lsl'
-        | 'mad'
-        | 'mdl'
-        | 'mga'
-        | 'mkd'
-        | 'mmk'
-        | 'mnt'
-        | 'mop'
-        | 'mro'
-        | 'mvr'
-        | 'mwk'
-        | 'mxn'
-        | 'myr'
-        | 'mzn'
-        | 'nad'
-        | 'ngn'
-        | 'nok'
-        | 'npr'
-        | 'nzd'
-        | 'pgk'
-        | 'php'
-        | 'pkr'
-        | 'pln'
-        | 'qar'
-        | 'ron'
-        | 'rsd'
-        | 'rub'
-        | 'rwf'
-        | 'sar'
-        | 'sbd'
-        | 'scr'
-        | 'sek'
-        | 'sgd'
-        | 'sle'
-        | 'sll'
-        | 'sos'
-        | 'szl'
-        | 'thb'
-        | 'tjs'
-        | 'top'
-        | 'try'
-        | 'ttd'
-        | 'tzs'
-        | 'uah'
-        | 'uzs'
-        | 'vnd'
-        | 'vuv'
-        | 'wst'
-        | 'xaf'
-        | 'xcd'
-        | 'yer'
-        | 'zar'
-        | 'zmw'
-        | 'clp'
-        | 'djf'
-        | 'gnf'
-        | 'ugx'
-        | 'pyg'
-        | 'xof'
-        | 'xpf'
-        | null;
-    }
+
+  /**
+   * Archives a coupon, preventing it from being applied to new subscriptions.
+   */
+  archiveCoupon(id: string, options?: RequestOptions): APIPromise<Coupon> {
+    return this._client.post(path`/api/v1/coupons/${id}/archive`, options);
+  }
+
+  /**
+   * Updates an existing coupon's properties such as name, description, and metadata.
+   */
+  updateCoupon(id: string, body: CouponUpdateCouponParams, options?: RequestOptions): APIPromise<Coupon> {
+    return this._client.patch(path`/api/v1/coupons/${id}`, { body, ...options });
   }
 }
 
-export interface CouponListResponse {
-  data: Array<CouponListResponse.Data>;
+export type CouponListResponsesMyCursorIDPage = MyCursorIDPage<CouponListResponse>;
+
+/**
+ * Response object
+ */
+export interface Coupon {
+  /**
+   * Discount instrument with percentage or fixed amount
+   */
+  data: Coupon.Data;
 }
 
-export namespace CouponListResponse {
+export namespace Coupon {
+  /**
+   * Discount instrument with percentage or fixed amount
+   */
   export interface Data {
     /**
      * The unique identifier for the entity
@@ -470,11 +92,6 @@ export namespace CouponListResponse {
      */
     createdAt: string;
 
-    /**
-     * Cursor ID for query pagination
-     */
-    cursorId: string;
-
     /**
      * Description of the coupon
      */
@@ -517,6 +134,9 @@ export namespace CouponListResponse {
   }
 
   export namespace Data {
+    /**
+     * Monetary amount with currency
+     */
     export interface AmountsOff {
       /**
        * The price amount
@@ -642,13 +262,15 @@ export namespace CouponListResponse {
         | 'ugx'
         | 'pyg'
         | 'xof'
-        | 'xpf'
-        | null;
+        | 'xpf';
     }
   }
 }
 
-export interface CouponCreateParams {
+/**
+ * Discount instrument with percentage or fixed amount
+ */
+export interface CouponListResponse {
   /**
    * The unique identifier for the entity
    */
@@ -657,7 +279,22 @@ export interface CouponCreateParams {
   /**
    * Fixed amount discounts in different currencies
    */
-  amountsOff: Array<CouponCreateParams.AmountsOff> | null;
+  amountsOff: Array<CouponListResponse.AmountsOff> | null;
+
+  /**
+   * The unique identifier for the entity in the billing provider
+   */
+  billingId: string | null;
+
+  /**
+   * The URL to the entity in the billing provider
+   */
+  billingLinkUrl: string | null;
+
+  /**
+   * Timestamp of when the record was created
+   */
+  createdAt: string;
 
   /**
    * Description of the coupon
@@ -679,13 +316,201 @@ export interface CouponCreateParams {
    */
   percentOff: number | null;
 
+  /**
+   * The source of the coupon
+   */
+  source: 'STIGG' | 'STIGG_ADHOC' | 'STRIPE' | null;
+
+  /**
+   * Current status of the coupon
+   */
+  status: 'ACTIVE' | 'ARCHIVED';
+
+  /**
+   * Type of the coupon (percentage or fixed amount)
+   */
+  type: 'FIXED' | 'PERCENTAGE';
+
+  /**
+   * Timestamp of when the record was last updated
+   */
+  updatedAt: string;
+}
+
+export namespace CouponListResponse {
+  /**
+   * Monetary amount with currency
+   */
+  export interface AmountsOff {
+    /**
+     * The price amount
+     */
+    amount: number;
+
+    /**
+     * The price currency
+     */
+    currency:
+      | 'usd'
+      | 'aed'
+      | 'all'
+      | 'amd'
+      | 'ang'
+      | 'aud'
+      | 'awg'
+      | 'azn'
+      | 'bam'
+      | 'bbd'
+      | 'bdt'
+      | 'bgn'
+      | 'bif'
+      | 'bmd'
+      | 'bnd'
+      | 'bsd'
+      | 'bwp'
+      | 'byn'
+      | 'bzd'
+      | 'brl'
+      | 'cad'
+      | 'cdf'
+      | 'chf'
+      | 'cny'
+      | 'czk'
+      | 'dkk'
+      | 'dop'
+      | 'dzd'
+      | 'egp'
+      | 'etb'
+      | 'eur'
+      | 'fjd'
+      | 'gbp'
+      | 'gel'
+      | 'gip'
+      | 'gmd'
+      | 'gyd'
+      | 'hkd'
+      | 'hrk'
+      | 'htg'
+      | 'idr'
+      | 'ils'
+      | 'inr'
+      | 'isk'
+      | 'jmd'
+      | 'jpy'
+      | 'kes'
+      | 'kgs'
+      | 'khr'
+      | 'kmf'
+      | 'krw'
+      | 'kyd'
+      | 'kzt'
+      | 'lbp'
+      | 'lkr'
+      | 'lrd'
+      | 'lsl'
+      | 'mad'
+      | 'mdl'
+      | 'mga'
+      | 'mkd'
+      | 'mmk'
+      | 'mnt'
+      | 'mop'
+      | 'mro'
+      | 'mvr'
+      | 'mwk'
+      | 'mxn'
+      | 'myr'
+      | 'mzn'
+      | 'nad'
+      | 'ngn'
+      | 'nok'
+      | 'npr'
+      | 'nzd'
+      | 'pgk'
+      | 'php'
+      | 'pkr'
+      | 'pln'
+      | 'qar'
+      | 'ron'
+      | 'rsd'
+      | 'rub'
+      | 'rwf'
+      | 'sar'
+      | 'sbd'
+      | 'scr'
+      | 'sek'
+      | 'sgd'
+      | 'sle'
+      | 'sll'
+      | 'sos'
+      | 'szl'
+      | 'thb'
+      | 'tjs'
+      | 'top'
+      | 'try'
+      | 'ttd'
+      | 'tzs'
+      | 'uah'
+      | 'uzs'
+      | 'vnd'
+      | 'vuv'
+      | 'wst'
+      | 'xaf'
+      | 'xcd'
+      | 'yer'
+      | 'zar'
+      | 'zmw'
+      | 'clp'
+      | 'djf'
+      | 'gnf'
+      | 'ugx'
+      | 'pyg'
+      | 'xof'
+      | 'xpf';
+  }
+}
+
+export interface CouponCreateParams {
+  /**
+   * The unique identifier for the entity
+   */
+  id: string;
+
+  /**
+   * Fixed amount discounts in different currencies
+   */
+  amountsOff: Array<CouponCreateParams.AmountsOff> | null;
+
+  /**
+   * Description of the coupon
+   */
+  description: string | null;
+
+  /**
+   * Duration of the coupon validity in months
+   */
+  durationInMonths: number | null;
+
   /**
    * Metadata associated with the entity
    */
-  additionalMetaData?: unknown;
+  metadata: { [key: string]: string } | null;
+
+  /**
+   * Name of the coupon
+   */
+  name: string;
+
+  /**
+   * Percentage discount off the original price
+   */
+  percentOff: number | null;
 }
 
 export namespace CouponCreateParams {
+  /**
+   * Monetary amount with currency
+   */
   export interface AmountsOff {
     /**
      * The price amount
@@ -815,29 +640,79 @@ export namespace CouponCreateParams {
   }
 }
 
-export interface CouponListParams {
+export interface CouponListParams extends MyCursorIDPageParams {
   /**
-   * Ending before this UUID for pagination
+   * Filter by entity ID
    */
-  endingBefore?: string;
+  id?: string;
 
   /**
-   * Items per page
+   * Filter by creation date using range operators: gt, gte, lt, lte
    */
-  limit?: number;
+  createdAt?: CouponListParams.CreatedAt;
 
   /**
-   * Starting after this UUID for pagination
+   * Filter by coupon status. Supports comma-separated values for multiple statuses
+   */
+  status?: string;
+
+  /**
+   * Filter by coupon type (FIXED or PERCENTAGE)
+   */
+  type?: 'FIXED' | 'PERCENTAGE';
+}
+
+export namespace CouponListParams {
+  /**
+   * Filter by creation date using range operators: gt, gte, lt, lte
+   */
+  export interface CreatedAt {
+    /**
+     * Greater than the specified createdAt value
+     */
+    gt?: string;
+
+    /**
+     * Greater than or equal to the specified createdAt value
+     */
+    gte?: string;
+
+    /**
+     * Less than the specified createdAt value
+     */
+    lt?: string;
+
+    /**
+     * Less than or equal to the specified createdAt value
+     */
+    lte?: string;
+  }
+}
+
+export interface CouponUpdateCouponParams {
+  /**
+   * Description of the coupon
+   */
+  description?: string | null;
+
+  /**
+   * Metadata associated with the entity
+   */
+  metadata?: { [key: string]: string } | null;
+
+  /**
+   * Name of the coupon
    */
-  startingAfter?: string;
+  name?: string;
 }
 
 export declare namespace Coupons {
   export {
-    type CouponCreateResponse as CouponCreateResponse,
-    type CouponRetrieveResponse as CouponRetrieveResponse,
+    type Coupon as Coupon,
     type CouponListResponse as CouponListResponse,
+    type CouponListResponsesMyCursorIDPage as CouponListResponsesMyCursorIDPage,
     type CouponCreateParams as CouponCreateParams,
     type CouponListParams as CouponListParams,
+    type CouponUpdateCouponParams as CouponUpdateCouponParams,
   };
 }