@stigg/typescript 0.1.0-alpha.4 → 0.1.0-alpha.8

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

@@ -5,17 +5,23 @@ export {
   type CustomerResponse,
   type CustomerListResponse,
   type CustomerImportResponse,
+  type CustomerListResourcesResponse,
   type CustomerUpdateParams,
   type CustomerListParams,
   type CustomerImportParams,
+  type CustomerListResourcesParams,
   type CustomerProvisionParams,
   type CustomerListResponsesMyCursorIDPage,
+  type CustomerListResourcesResponsesMyCursorIDPage,
 } from './customers';
 export { PaymentMethod, type PaymentMethodAttachParams } from './payment-method';
 export {
   PromotionalEntitlements,
-  type PromotionalEntitlementGrantResponse,
+  type PromotionalEntitlementCreateResponse,
+  type PromotionalEntitlementListResponse,
   type PromotionalEntitlementRevokeResponse,
-  type PromotionalEntitlementGrantParams,
+  type PromotionalEntitlementCreateParams,
+  type PromotionalEntitlementListParams,
   type PromotionalEntitlementRevokeParams,
+  type PromotionalEntitlementListResponsesMyCursorIDPage,
 } from './promotional-entitlements';

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

@@ -8,7 +8,8 @@ import { path } from '../../../internal/utils/path';
 
 export class PaymentMethod extends APIResource {
   /**
-   * Attach payment method
+   * Attaches a payment method to a customer for billing. Required for paid
+   * subscriptions when integrated with a billing provider.
    */
   attach(
     id: string,
@@ -19,7 +20,8 @@ export class PaymentMethod extends APIResource {
   }
 
   /**
-   * Detach payment method
+   * Removes the payment method from a customer. Ensure active paid subscriptions
+   * have an alternative payment method.
    */
   detach(id: string, options?: RequestOptions): APIPromise<CustomersAPI.CustomerResponse> {
     return this._client.delete(path`/api/v1/customers/${id}/payment-method`, options);

package/src/resources/v1/customers/promotional-entitlements.ts

@@ -2,42 +2,63 @@
 
 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 PromotionalEntitlements extends APIResource {
   /**
-   * Create a promotional entitlements
+   * Grants promotional entitlements to a customer, providing feature access outside
+   * their subscription. Entitlements can be time-limited or permanent.
    */
-  grant(
-    customerID: string,
-    body: PromotionalEntitlementGrantParams,
+  create(
+    id: string,
+    body: PromotionalEntitlementCreateParams,
     options?: RequestOptions,
-  ): APIPromise<PromotionalEntitlementGrantResponse> {
-    return this._client.post(path`/api/v1/customers/${customerID}/promotional`, { body, ...options });
+  ): APIPromise<PromotionalEntitlementCreateResponse> {
+    return this._client.post(path`/api/v1/customers/${id}/promotional-entitlements`, { body, ...options });
   }
 
   /**
-   * Revoke promotional entitlement
+   * Retrieves a paginated list of a customer's promotional entitlements.
+   */
+  list(
+    id: string,
+    query: PromotionalEntitlementListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PromotionalEntitlementListResponsesMyCursorIDPage, PromotionalEntitlementListResponse> {
+    return this._client.getAPIList(
+      path`/api/v1/customers/${id}/promotional-entitlements`,
+      MyCursorIDPage<PromotionalEntitlementListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Revokes a previously granted promotional entitlement from a customer for a
+   * specific feature.
    */
   revoke(
     featureID: string,
     params: PromotionalEntitlementRevokeParams,
     options?: RequestOptions,
   ): APIPromise<PromotionalEntitlementRevokeResponse> {
-    const { customerId } = params;
-    return this._client.delete(path`/api/v1/customers/${customerId}/promotional/${featureID}`, options);
+    const { id } = params;
+    return this._client.delete(path`/api/v1/customers/${id}/promotional-entitlements/${featureID}`, options);
   }
 }
 
+export type PromotionalEntitlementListResponsesMyCursorIDPage =
+  MyCursorIDPage<PromotionalEntitlementListResponse>;
+
 /**
  * Response object
  */
-export interface PromotionalEntitlementGrantResponse {
-  data: Array<PromotionalEntitlementGrantResponse.Data>;
+export interface PromotionalEntitlementCreateResponse {
+  data: Array<PromotionalEntitlementCreateResponse.Data>;
 }
 
-export namespace PromotionalEntitlementGrantResponse {
+export namespace PromotionalEntitlementCreateResponse {
   /**
    * Granted feature entitlement
    */
@@ -178,6 +199,145 @@ export namespace PromotionalEntitlementGrantResponse {
   }
 }
 
+/**
+ * Granted feature entitlement
+ */
+export interface PromotionalEntitlementListResponse {
+  /**
+   * Unique identifier for the entity
+   */
+  id: string;
+
+  /**
+   * Timestamp of when the record was created
+   */
+  createdAt: string;
+
+  /**
+   * The description of the entitlement
+   */
+  description: string | null;
+
+  /**
+   * The end date of the promotional entitlement
+   */
+  endDate: string | null;
+
+  /**
+   * The enum values of the entitlement
+   */
+  enumValues: Array<string> | null;
+
+  /**
+   * The unique identifier for the environment
+   */
+  environmentId: string;
+
+  /**
+   * Feature group IDs associated with this entitlement
+   */
+  featureGroupIds: Array<string> | null;
+
+  /**
+   * The unique identifier of the entitlement feature
+   */
+  featureId: string;
+
+  /**
+   * Whether the entitlement has a soft limit
+   */
+  hasSoftLimit: boolean | null;
+
+  /**
+   * Whether the entitlement has an unlimited usage
+   */
+  hasUnlimitedUsage: boolean | null;
+
+  /**
+   * Whether the entitlement is visible
+   */
+  isVisible: boolean;
+
+  /**
+   * The grant period of the promotional entitlement
+   */
+  period: '1 week' | '1 month' | '6 month' | '1 year' | 'lifetime' | 'custom';
+
+  /**
+   * The reset period of the entitlement
+   */
+  resetPeriod: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
+
+  /**
+   * The reset period configuration of the entitlement
+   */
+  resetPeriodConfiguration:
+    | PromotionalEntitlementListResponse.YearlyResetPeriodConfig
+    | PromotionalEntitlementListResponse.MonthlyResetPeriodConfig
+    | PromotionalEntitlementListResponse.WeeklyResetPeriodConfig
+    | null;
+
+  /**
+   * The start date of the entitlement
+   */
+  startDate: string;
+
+  /**
+   * The status of the entitlement
+   */
+  status: 'Active' | 'Expired' | 'Paused';
+
+  /**
+   * Timestamp of when the record was last updated
+   */
+  updatedAt: string;
+
+  /**
+   * The usage limit of the entitlement
+   */
+  usageLimit: number | null;
+}
+
+export namespace PromotionalEntitlementListResponse {
+  /**
+   * Yearly reset configuration
+   */
+  export interface YearlyResetPeriodConfig {
+    /**
+     * Reset anchor (SubscriptionStart)
+     */
+    accordingTo: 'SubscriptionStart';
+  }
+
+  /**
+   * Monthly reset configuration
+   */
+  export interface MonthlyResetPeriodConfig {
+    /**
+     * Reset anchor (SubscriptionStart or StartOfTheMonth)
+     */
+    accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
+  }
+
+  /**
+   * Weekly reset configuration
+   */
+  export interface WeeklyResetPeriodConfig {
+    /**
+     * Reset anchor (SubscriptionStart or specific day)
+     */
+    accordingTo:
+      | 'SubscriptionStart'
+      | 'EverySunday'
+      | 'EveryMonday'
+      | 'EveryTuesday'
+      | 'EveryWednesday'
+      | 'EveryThursday'
+      | 'EveryFriday'
+      | 'EverySaturday';
+  }
+}
+
 /**
  * Response object
  */
@@ -329,14 +489,14 @@ export namespace PromotionalEntitlementRevokeResponse {
   }
 }
 
-export interface PromotionalEntitlementGrantParams {
+export interface PromotionalEntitlementCreateParams {
   /**
    * Promotional entitlements to grant
    */
-  promotionalEntitlements: Array<PromotionalEntitlementGrantParams.PromotionalEntitlement>;
+  promotionalEntitlements: Array<PromotionalEntitlementCreateParams.PromotionalEntitlement>;
 }
 
-export namespace PromotionalEntitlementGrantParams {
+export namespace PromotionalEntitlementCreateParams {
   /**
    * Single entitlement grant config
    */
@@ -449,18 +609,61 @@ export namespace PromotionalEntitlementGrantParams {
   }
 }
 
+export interface PromotionalEntitlementListParams extends MyCursorIDPageParams {
+  /**
+   * Filter by creation date using range operators: gt, gte, lt, lte
+   */
+  createdAt?: PromotionalEntitlementListParams.CreatedAt;
+
+  /**
+   * Filter by promotional entitlement status. Supports comma-separated values for
+   * multiple statuses
+   */
+  status?: string;
+}
+
+export namespace PromotionalEntitlementListParams {
+  /**
+   * 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 PromotionalEntitlementRevokeParams {
   /**
    * The unique identifier of the customer
    */
-  customerId: string;
+  id: string;
 }
 
 export declare namespace PromotionalEntitlements {
   export {
-    type PromotionalEntitlementGrantResponse as PromotionalEntitlementGrantResponse,
+    type PromotionalEntitlementCreateResponse as PromotionalEntitlementCreateResponse,
+    type PromotionalEntitlementListResponse as PromotionalEntitlementListResponse,
     type PromotionalEntitlementRevokeResponse as PromotionalEntitlementRevokeResponse,
-    type PromotionalEntitlementGrantParams as PromotionalEntitlementGrantParams,
+    type PromotionalEntitlementListResponsesMyCursorIDPage as PromotionalEntitlementListResponsesMyCursorIDPage,
+    type PromotionalEntitlementCreateParams as PromotionalEntitlementCreateParams,
+    type PromotionalEntitlementListParams as PromotionalEntitlementListParams,
     type PromotionalEntitlementRevokeParams as PromotionalEntitlementRevokeParams,
   };
 }