@stigg/typescript 0.1.0-alpha.2 → 0.1.0-alpha.21

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

@@ -0,0 +1,672 @@
+// 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 { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Operations related to promotional entitlements
+ */
+export class PromotionalEntitlements extends APIResource {
+  /**
+   * Grants promotional entitlements to a customer, providing feature access outside
+   * their subscription. Entitlements can be time-limited or permanent.
+   */
+  create(
+    id: string,
+    body: PromotionalEntitlementCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<PromotionalEntitlementCreateResponse> {
+    return this._client.post(path`/api/v1/customers/${id}/promotional-entitlements`, { body, ...options });
+  }
+
+  /**
+   * 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 { id } = params;
+    return this._client.delete(path`/api/v1/customers/${id}/promotional-entitlements/${featureID}`, options);
+  }
+}
+
+export type PromotionalEntitlementListResponsesMyCursorIDPage =
+  MyCursorIDPage<PromotionalEntitlementListResponse>;
+
+/**
+ * Response object
+ */
+export interface PromotionalEntitlementCreateResponse {
+  data: Array<PromotionalEntitlementCreateResponse.Data>;
+}
+
+export namespace PromotionalEntitlementCreateResponse {
+  /**
+   * Granted feature entitlement
+   */
+  export interface Data {
+    /**
+     * 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:
+      | Data.YearlyResetPeriodConfig
+      | Data.MonthlyResetPeriodConfig
+      | Data.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 Data {
+    /**
+     * 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';
+    }
+  }
+}
+
+/**
+ * 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
+ */
+export interface PromotionalEntitlementRevokeResponse {
+  /**
+   * Granted feature entitlement
+   */
+  data: PromotionalEntitlementRevokeResponse.Data;
+}
+
+export namespace PromotionalEntitlementRevokeResponse {
+  /**
+   * Granted feature entitlement
+   */
+  export interface Data {
+    /**
+     * 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:
+      | Data.YearlyResetPeriodConfig
+      | Data.MonthlyResetPeriodConfig
+      | Data.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 Data {
+    /**
+     * 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';
+    }
+  }
+}
+
+export interface PromotionalEntitlementCreateParams {
+  /**
+   * Promotional entitlements to grant
+   */
+  promotionalEntitlements: Array<PromotionalEntitlementCreateParams.PromotionalEntitlement>;
+}
+
+export namespace PromotionalEntitlementCreateParams {
+  /**
+   * Single entitlement grant config
+   */
+  export interface PromotionalEntitlement {
+    /**
+     * The custom end date of the promotional entitlement
+     */
+    customEndDate: string | null;
+
+    /**
+     * The enum values of the entitlement
+     */
+    enumValues: 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 | null;
+
+    /**
+     * The monthly reset period configuration of the entitlement, defined when reset
+     * period is monthly
+     */
+    monthlyResetPeriodConfiguration: PromotionalEntitlement.MonthlyResetPeriodConfiguration | null;
+
+    /**
+     * 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 usage limit of the entitlement
+     */
+    usageLimit: number | null;
+
+    /**
+     * The weekly reset period configuration of the entitlement, defined when reset
+     * period is weekly
+     */
+    weeklyResetPeriodConfiguration: PromotionalEntitlement.WeeklyResetPeriodConfiguration | null;
+
+    /**
+     * The yearly reset period configuration of the entitlement, defined when reset
+     * period is yearly
+     */
+    yearlyResetPeriodConfiguration: PromotionalEntitlement.YearlyResetPeriodConfiguration | null;
+  }
+
+  export namespace PromotionalEntitlement {
+    /**
+     * The monthly reset period configuration of the entitlement, defined when reset
+     * period is monthly
+     */
+    export interface MonthlyResetPeriodConfiguration {
+      /**
+       * Reset anchor (SubscriptionStart or StartOfTheMonth)
+       */
+      accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
+    }
+
+    /**
+     * The weekly reset period configuration of the entitlement, defined when reset
+     * period is weekly
+     */
+    export interface WeeklyResetPeriodConfiguration {
+      /**
+       * Reset anchor (SubscriptionStart or specific day)
+       */
+      accordingTo:
+        | 'SubscriptionStart'
+        | 'EverySunday'
+        | 'EveryMonday'
+        | 'EveryTuesday'
+        | 'EveryWednesday'
+        | 'EveryThursday'
+        | 'EveryFriday'
+        | 'EverySaturday';
+    }
+
+    /**
+     * The yearly reset period configuration of the entitlement, defined when reset
+     * period is yearly
+     */
+    export interface YearlyResetPeriodConfiguration {
+      /**
+       * Reset anchor (SubscriptionStart)
+       */
+      accordingTo: 'SubscriptionStart';
+    }
+  }
+}
+
+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
+   */
+  id: string;
+}
+
+export declare namespace PromotionalEntitlements {
+  export {
+    type PromotionalEntitlementCreateResponse as PromotionalEntitlementCreateResponse,
+    type PromotionalEntitlementListResponse as PromotionalEntitlementListResponse,
+    type PromotionalEntitlementRevokeResponse as PromotionalEntitlementRevokeResponse,
+    type PromotionalEntitlementListResponsesMyCursorIDPage as PromotionalEntitlementListResponsesMyCursorIDPage,
+    type PromotionalEntitlementCreateParams as PromotionalEntitlementCreateParams,
+    type PromotionalEntitlementListParams as PromotionalEntitlementListParams,
+    type PromotionalEntitlementRevokeParams as PromotionalEntitlementRevokeParams,
+  };
+}