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

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

@@ -0,0 +1,466 @@
+// 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 PromotionalEntitlements extends APIResource {
+  /**
+   * Create a promotional entitlements
+   */
+  grant(
+    customerID: string,
+    body: PromotionalEntitlementGrantParams,
+    options?: RequestOptions,
+  ): APIPromise<PromotionalEntitlementGrantResponse> {
+    return this._client.post(path`/api/v1/customers/${customerID}/promotional`, { body, ...options });
+  }
+
+  /**
+   * Revoke promotional entitlement
+   */
+  revoke(
+    featureID: string,
+    params: PromotionalEntitlementRevokeParams,
+    options?: RequestOptions,
+  ): APIPromise<PromotionalEntitlementRevokeResponse> {
+    const { customerId } = params;
+    return this._client.delete(path`/api/v1/customers/${customerId}/promotional/${featureID}`, options);
+  }
+}
+
+/**
+ * Response object
+ */
+export interface PromotionalEntitlementGrantResponse {
+  data: Array<PromotionalEntitlementGrantResponse.Data>;
+}
+
+export namespace PromotionalEntitlementGrantResponse {
+  /**
+   * 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';
+    }
+  }
+}
+
+/**
+ * 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 PromotionalEntitlementGrantParams {
+  /**
+   * Promotional entitlements to grant
+   */
+  promotionalEntitlements: Array<PromotionalEntitlementGrantParams.PromotionalEntitlement>;
+}
+
+export namespace PromotionalEntitlementGrantParams {
+  /**
+   * 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 PromotionalEntitlementRevokeParams {
+  /**
+   * The unique identifier of the customer
+   */
+  customerId: string;
+}
+
+export declare namespace PromotionalEntitlements {
+  export {
+    type PromotionalEntitlementGrantResponse as PromotionalEntitlementGrantResponse,
+    type PromotionalEntitlementRevokeResponse as PromotionalEntitlementRevokeResponse,
+    type PromotionalEntitlementGrantParams as PromotionalEntitlementGrantParams,
+    type PromotionalEntitlementRevokeParams as PromotionalEntitlementRevokeParams,
+  };
+}

package/src/resources/v1/events.ts

@@ -0,0 +1,73 @@
+// 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';
+
+export class Events extends APIResource {
+  /**
+   * Report usage events
+   */
+  report(body: EventReportParams, options?: RequestOptions): APIPromise<EventReportResponse> {
+    return this._client.post('/api/v1/events', { body, ...options });
+  }
+}
+
+/**
+ * Response object
+ */
+export interface EventReportResponse {
+  /**
+   * Empty success response confirming that events were successfully ingested and
+   * queued for processing by Stigg's metering system.
+   */
+  data: unknown;
+}
+
+export interface EventReportParams {
+  /**
+   * A list of usage events to report
+   */
+  events: Array<EventReportParams.Event>;
+}
+
+export namespace EventReportParams {
+  /**
+   * Raw usage event
+   */
+  export interface Event {
+    /**
+     * Customer id
+     */
+    customerId: string;
+
+    /**
+     * The name of the usage event
+     */
+    eventName: string;
+
+    /**
+     * Idempotency key
+     */
+    idempotencyKey: string;
+
+    /**
+     * Dimensions associated with the usage event
+     */
+    dimensions?: { [key: string]: string | number | boolean };
+
+    /**
+     * Resource id
+     */
+    resourceId?: string | null;
+
+    /**
+     * Timestamp
+     */
+    timestamp?: string;
+  }
+}
+
+export declare namespace Events {
+  export { type EventReportResponse as EventReportResponse, type EventReportParams as EventReportParams };
+}

package/src/resources/v1/index.ts

@@ -2,8 +2,7 @@
 
 export {
   Coupons,
-  type CouponCreateResponse,
-  type CouponRetrieveResponse,
+  type Coupon,
   type CouponListResponse,
   type CouponCreateParams,
   type CouponListParams,
@@ -13,32 +12,37 @@ export {
   Customers,
   type CustomerResponse,
   type CustomerListResponse,
-  type CustomerCreateParams,
+  type CustomerImportResponse,
   type CustomerUpdateParams,
   type CustomerListParams,
+  type CustomerImportParams,
+  type CustomerProvisionParams,
   type CustomerListResponsesMyCursorIDPage,
 } from './customers/index';
+export { Events, type EventReportResponse, type EventReportParams } from './events';
 export {
   Subscriptions,
-  type SubscriptionCreateResponse,
-  type SubscriptionRetrieveResponse,
+  type Subscription,
   type SubscriptionListResponse,
-  type SubscriptionDelegateResponse,
-  type SubscriptionMigrateResponse,
+  type SubscriptionImportResponse,
   type SubscriptionPreviewResponse,
-  type SubscriptionTransferResponse,
-  type SubscriptionCreateParams,
+  type SubscriptionProvisionResponse,
+  type SubscriptionUpdateParams,
   type SubscriptionListParams,
+  type SubscriptionCancelParams,
   type SubscriptionDelegateParams,
+  type SubscriptionImportParams,
   type SubscriptionMigrateParams,
   type SubscriptionPreviewParams,
+  type SubscriptionProvisionParams,
   type SubscriptionTransferParams,
   type SubscriptionListResponsesMyCursorIDPage,
 } from './subscriptions/index';
 export {
-  V1,
-  type V1CreateEventResponse,
-  type V1CreateUsageResponse,
-  type V1CreateEventParams,
-  type V1CreateUsageParams,
-} from './v1';
+  Usage,
+  type UsageHistoryResponse,
+  type UsageReportResponse,
+  type UsageHistoryParams,
+  type UsageReportParams,
+} from './usage';
+export { V1 } from './v1';

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

@@ -7,41 +7,28 @@ 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,
-    options?: RequestOptions,
-  ): APIPromise<FutureUpdateCancelPendingPaymentResponse> {
+  cancelPendingPayment(id: string, options?: RequestOptions): APIPromise<CancelSubscription> {
     return this._client.delete(path`/api/v1/subscriptions/${id}/future-update/pending-payment`, options);
   }
 
   /**
-   * Perform cancel future update on a Subscription
+   * Cancel scheduled update
    */
-  cancelSchedule(id: string, options?: RequestOptions): APIPromise<FutureUpdateCancelScheduleResponse> {
+  cancelSchedule(id: string, options?: RequestOptions): APIPromise<CancelSubscription> {
     return this._client.delete(path`/api/v1/subscriptions/${id}/future-update/schedule`, options);
   }
 }
 
-export interface FutureUpdateCancelPendingPaymentResponse {
-  data: FutureUpdateCancelPendingPaymentResponse.Data;
+/**
+ * Response object
+ */
+export interface CancelSubscription {
+  data: CancelSubscription.Data;
 }
 
-export namespace FutureUpdateCancelPendingPaymentResponse {
-  export interface Data {
-    /**
-     * Subscription ID
-     */
-    id: string;
-  }
-}
-
-export interface FutureUpdateCancelScheduleResponse {
-  data: FutureUpdateCancelScheduleResponse.Data;
-}
-
-export namespace FutureUpdateCancelScheduleResponse {
+export namespace CancelSubscription {
   export interface Data {
     /**
      * Subscription ID
@@ -51,8 +38,5 @@ export namespace FutureUpdateCancelScheduleResponse {
 }
 
 export declare namespace FutureUpdate {
-  export {
-    type FutureUpdateCancelPendingPaymentResponse as FutureUpdateCancelPendingPaymentResponse,
-    type FutureUpdateCancelScheduleResponse as FutureUpdateCancelScheduleResponse,
-  };
+  export { type CancelSubscription as CancelSubscription };
 }

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

@@ -1,24 +1,21 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export {
-  FutureUpdate,
-  type FutureUpdateCancelPendingPaymentResponse,
-  type FutureUpdateCancelScheduleResponse,
-} from './future-update';
+export { FutureUpdate, type CancelSubscription } from './future-update';
 export {
   Subscriptions,
-  type SubscriptionCreateResponse,
-  type SubscriptionRetrieveResponse,
+  type Subscription,
   type SubscriptionListResponse,
-  type SubscriptionDelegateResponse,
-  type SubscriptionMigrateResponse,
+  type SubscriptionImportResponse,
   type SubscriptionPreviewResponse,
-  type SubscriptionTransferResponse,
-  type SubscriptionCreateParams,
+  type SubscriptionProvisionResponse,
+  type SubscriptionUpdateParams,
   type SubscriptionListParams,
+  type SubscriptionCancelParams,
   type SubscriptionDelegateParams,
+  type SubscriptionImportParams,
   type SubscriptionMigrateParams,
   type SubscriptionPreviewParams,
+  type SubscriptionProvisionParams,
   type SubscriptionTransferParams,
   type SubscriptionListResponsesMyCursorIDPage,
 } from './subscriptions';