@stigg/typescript 0.1.0-alpha.22 → 0.1.0-alpha.23

package/src/resources/v1/addons/entitlements.ts

@@ -262,6 +262,13 @@ export namespace AddonPackageEntitlement {
      * Timestamp of when the record was last updated
      */
     updatedAt: string;
+
+    /**
+     * The feature ID this entitlement depends on (for credit entitlements). The
+     * entitlement value will be calculated as: base amount × dependency feature usage
+     * limit
+     */
+    dependencyFeatureId?: string | null;
   }
 }
 
@@ -475,6 +482,13 @@ export namespace EntitlementCreateResponse {
      * Timestamp of when the record was last updated
      */
     updatedAt: string;
+
+    /**
+     * The feature ID this entitlement depends on (for credit entitlements). The
+     * entitlement value will be calculated as: base amount × dependency feature usage
+     * limit
+     */
+    dependencyFeatureId?: string | null;
   }
 }
 
@@ -693,6 +707,13 @@ export namespace EntitlementListResponse {
      * Timestamp of when the record was last updated
      */
     updatedAt: string;
+
+    /**
+     * The feature ID this entitlement depends on (for credit entitlements). The
+     * entitlement value will be calculated as: base amount × dependency feature usage
+     * limit
+     */
+    dependencyFeatureId?: string | null;
   }
 
   /**
@@ -879,6 +900,12 @@ export namespace EntitlementCreateParams {
      */
     behavior?: 'Increment' | 'Override';
 
+    /**
+     * The feature ID this entitlement depends on. The entitlement value will be
+     * calculated as: base amount × dependency feature usage limit
+     */
+    dependencyFeatureId?: string;
+
     /**
      * Description of the entitlement
      */
@@ -1069,6 +1096,12 @@ export declare namespace EntitlementUpdateParams {
      */
     cadence?: 'MONTH' | 'YEAR';
 
+    /**
+     * Body param: The feature ID this entitlement depends on. The entitlement value
+     * will be calculated as: base amount × dependency feature usage limit
+     */
+    dependencyFeatureId?: string | null;
+
     /**
      * Body param: Description of the entitlement
      */

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

@@ -3,8 +3,6 @@
 export {
   Addons,
   type Addon,
-  type SetPackagePricing,
-  type SetPackagePricingResponse,
   type AddonListResponse,
   type AddonPublishResponse,
   type AddonRemoveDraftResponse,
@@ -12,7 +10,6 @@ export {
   type AddonUpdateParams,
   type AddonListParams,
   type AddonPublishParams,
-  type AddonSetPricingParams,
   type AddonListResponsesMyCursorIDPage,
 } from './addons';
 export {

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

@@ -92,6 +92,18 @@ export class Customers extends APIResource {
     return this._client.post('/api/v1/customers', { body, ...options });
   }
 
+  /**
+   * Retrieves the effective entitlements for a customer or resource, including
+   * feature and credit entitlements.
+   */
+  retrieveEntitlements(
+    id: string,
+    query: CustomerRetrieveEntitlementsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomerRetrieveEntitlementsResponse> {
+    return this._client.get(path`/api/v1/customers/${id}/entitlements`, { query, ...options });
+  }
+
   /**
    * Restores an archived customer, allowing them to create new subscriptions again.
    */
@@ -269,7 +281,7 @@ export namespace CustomerResponse {
     /**
      * Customer level coupon
      */
-    couponId?: string | null;
+    couponId?: (string & {}) | '' | null;
 
     /**
      * The default payment method details
@@ -851,7 +863,7 @@ export interface CustomerListResponse {
   /**
    * Customer level coupon
    */
-  couponId?: string | null;
+  couponId?: (string & {}) | '' | null;
 
   /**
    * The default payment method details
@@ -1320,6 +1332,209 @@ export interface CustomerListResourcesResponse {
   updatedAt: string;
 }
 
+/**
+ * Response object
+ */
+export interface CustomerRetrieveEntitlementsResponse {
+  /**
+   * The effective entitlements state for a customer or resource.
+   */
+  data: CustomerRetrieveEntitlementsResponse.Data;
+}
+
+export namespace CustomerRetrieveEntitlementsResponse {
+  /**
+   * The effective entitlements state for a customer or resource.
+   */
+  export interface Data {
+    /**
+     * Reason why entitlements access was denied, if applicable
+     */
+    accessDeniedReason: 'CustomerNotFound' | 'NoActiveSubscription' | 'CustomerIsArchived' | null;
+
+    /**
+     * List of effective feature and credit entitlements
+     */
+    entitlements: Array<Data.Feature | Data.Credit>;
+  }
+
+  export namespace Data {
+    export interface Feature {
+      accessDeniedReason:
+        | 'FeatureNotFound'
+        | 'CustomerNotFound'
+        | 'CustomerIsArchived'
+        | 'CustomerResourceNotFound'
+        | 'NoActiveSubscription'
+        | 'NoFeatureEntitlementInSubscription'
+        | 'RequestedUsageExceedingLimit'
+        | 'RequestedValuesMismatch'
+        | 'BudgetExceeded'
+        | 'Unknown'
+        | 'FeatureTypeMismatch'
+        | 'Revoked'
+        | 'InsufficientCredits'
+        | 'EntitlementNotFound'
+        | null;
+
+      isGranted: boolean;
+
+      type: 'FEATURE';
+
+      currentUsage?: number;
+
+      /**
+       * Timestamp of the last update to the entitlement grant or configuration.
+       */
+      entitlementUpdatedAt?: string;
+
+      feature?: Feature.Feature;
+
+      hasUnlimitedUsage?: boolean;
+
+      resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
+
+      usageLimit?: number | null;
+
+      /**
+       * The anchor for calculating the usage period for metered entitlements with a
+       * reset period configured
+       */
+      usagePeriodAnchor?: string;
+
+      /**
+       * The end date of the usage period for metered entitlements with a reset period
+       * configured
+       */
+      usagePeriodEnd?: string;
+
+      /**
+       * The start date of the usage period for metered entitlements with a reset period
+       * configured
+       */
+      usagePeriodStart?: string;
+
+      /**
+       * The next time the entitlement should be recalculated
+       */
+      validUntil?: string;
+    }
+
+    export namespace Feature {
+      export interface Feature {
+        /**
+         * The unique reference ID of the entitlement.
+         */
+        id: string;
+
+        /**
+         * The human-readable name of the entitlement, shown in UI elements.
+         */
+        displayName: string;
+
+        /**
+         * The current status of the feature.
+         */
+        featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE';
+
+        /**
+         * The type of feature associated with the entitlement.
+         */
+        featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
+      }
+    }
+
+    export interface Credit {
+      accessDeniedReason:
+        | 'FeatureNotFound'
+        | 'CustomerNotFound'
+        | 'CustomerIsArchived'
+        | 'CustomerResourceNotFound'
+        | 'NoActiveSubscription'
+        | 'NoFeatureEntitlementInSubscription'
+        | 'RequestedUsageExceedingLimit'
+        | 'RequestedValuesMismatch'
+        | 'BudgetExceeded'
+        | 'Unknown'
+        | 'FeatureTypeMismatch'
+        | 'Revoked'
+        | 'InsufficientCredits'
+        | 'EntitlementNotFound'
+        | null;
+
+      /**
+       * The currency associated with a credit entitlement.
+       */
+      currency: Credit.Currency;
+
+      currentUsage: number;
+
+      isGranted: boolean;
+
+      type: 'CREDIT';
+
+      usageLimit: number;
+
+      /**
+       * Timestamp of the last update to the credit usage.
+       */
+      usageUpdatedAt: string;
+
+      /**
+       * Timestamp of the last update to the entitlement grant or configuration.
+       */
+      entitlementUpdatedAt?: string;
+
+      /**
+       * The end date of the current billing period for recurring credit grants.
+       */
+      usagePeriodEnd?: string;
+
+      /**
+       * The next time the entitlement should be recalculated
+       */
+      validUntil?: string;
+    }
+
+    export namespace Credit {
+      /**
+       * The currency associated with a credit entitlement.
+       */
+      export interface Currency {
+        /**
+         * The unique identifier of the custom currency.
+         */
+        currencyId: string;
+
+        /**
+         * The display name of the currency.
+         */
+        displayName: string;
+
+        /**
+         * A description of the currency.
+         */
+        description?: string | null;
+
+        /**
+         * Additional metadata associated with the currency.
+         */
+        metadata?: { [key: string]: string } | null;
+
+        /**
+         * The plural form of the currency unit.
+         */
+        unitPlural?: string | null;
+
+        /**
+         * The singular form of the currency unit.
+         */
+        unitSingular?: string | null;
+      }
+    }
+  }
+}
+
 export interface CustomerUpdateParams {
   /**
    * The billing currency of the customer
@@ -1451,7 +1666,7 @@ export interface CustomerUpdateParams {
   /**
    * Customer level coupon
    */
-  couponId?: string | null;
+  couponId?: (string & {}) | '' | null;
 
   /**
    * The email of the customer
@@ -2081,7 +2296,7 @@ export interface CustomerProvisionParams {
   /**
    * Customer level coupon
    */
-  couponId?: string | null;
+  couponId?: (string & {}) | '' | null;
 
   /**
    * The default payment method details
@@ -2508,6 +2723,13 @@ export namespace CustomerProvisionParams {
   }
 }
 
+export interface CustomerRetrieveEntitlementsParams {
+  /**
+   * Resource ID to scope entitlements to a specific resource
+   */
+  resourceId?: string;
+}
+
 Customers.PaymentMethod = PaymentMethod;
 Customers.PromotionalEntitlements = PromotionalEntitlements;
 
@@ -2517,6 +2739,7 @@ export declare namespace Customers {
     type CustomerListResponse as CustomerListResponse,
     type CustomerImportResponse as CustomerImportResponse,
     type CustomerListResourcesResponse as CustomerListResourcesResponse,
+    type CustomerRetrieveEntitlementsResponse as CustomerRetrieveEntitlementsResponse,
     type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage,
     type CustomerListResourcesResponsesMyCursorIDPage as CustomerListResourcesResponsesMyCursorIDPage,
     type CustomerUpdateParams as CustomerUpdateParams,
@@ -2524,6 +2747,7 @@ export declare namespace Customers {
     type CustomerImportParams as CustomerImportParams,
     type CustomerListResourcesParams as CustomerListResourcesParams,
     type CustomerProvisionParams as CustomerProvisionParams,
+    type CustomerRetrieveEntitlementsParams as CustomerRetrieveEntitlementsParams,
   };
 
   export { PaymentMethod as PaymentMethod, type PaymentMethodAttachParams as PaymentMethodAttachParams };

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

@@ -6,11 +6,13 @@ export {
   type CustomerListResponse,
   type CustomerImportResponse,
   type CustomerListResourcesResponse,
+  type CustomerRetrieveEntitlementsResponse,
   type CustomerUpdateParams,
   type CustomerListParams,
   type CustomerImportParams,
   type CustomerListResourcesParams,
   type CustomerProvisionParams,
+  type CustomerRetrieveEntitlementsParams,
   type CustomerListResponsesMyCursorIDPage,
   type CustomerListResourcesResponsesMyCursorIDPage,
 } from './customers';

package/src/resources/v1/events/credits/credits.ts

@@ -262,7 +262,9 @@ export interface CreditListLedgerResponse {
     | 'CREDITS_EXPIRED'
     | 'CREDITS_CONSUMED'
     | 'CREDITS_VOIDED'
-    | 'CREDITS_UPDATED';
+    | 'CREDITS_UPDATED'
+    | 'CREDITS_CONSUMPTION_TRANSFER_SOURCE'
+    | 'CREDITS_CONSUMPTION_TRANSFER_TARGET';
 
   /**
    * The feature ID associated with this event

package/src/resources/v1/features.ts

@@ -504,6 +504,9 @@ export namespace FeatureUpdateFeatureParams {
     export interface Aggregation {
       function: 'SUM' | 'MAX' | 'MIN' | 'AVG' | 'COUNT' | 'UNIQUE';
 
+      /**
+       * Aggregation field name
+       */
       field?: string;
     }
 
@@ -513,6 +516,9 @@ export namespace FeatureUpdateFeatureParams {
 
     export namespace Filter {
       export interface Condition {
+        /**
+         * Condition field name
+         */
         field: string;
 
         operation:
@@ -529,6 +535,9 @@ export namespace FeatureUpdateFeatureParams {
           | 'ENDS_WITH'
           | 'IN';
 
+        /**
+         * Condition value
+         */
         value?: string;
 
         values?: Array<string>;

package/src/resources/v1/index.ts

@@ -3,8 +3,6 @@
 export {
   Addons,
   type Addon,
-  type SetPackagePricing,
-  type SetPackagePricingResponse,
   type AddonListResponse,
   type AddonPublishResponse,
   type AddonRemoveDraftResponse,
@@ -12,7 +10,6 @@ export {
   type AddonUpdateParams,
   type AddonListParams,
   type AddonPublishParams,
-  type AddonSetPricingParams,
   type AddonListResponsesMyCursorIDPage,
 } from './addons/index';
 export {
@@ -30,11 +27,13 @@ export {
   type CustomerListResponse,
   type CustomerImportResponse,
   type CustomerListResourcesResponse,
+  type CustomerRetrieveEntitlementsResponse,
   type CustomerUpdateParams,
   type CustomerListParams,
   type CustomerImportParams,
   type CustomerListResourcesParams,
   type CustomerProvisionParams,
+  type CustomerRetrieveEntitlementsParams,
   type CustomerListResponsesMyCursorIDPage,
   type CustomerListResourcesResponsesMyCursorIDPage,
 } from './customers/index';
@@ -58,7 +57,6 @@ export {
   type PlanUpdateParams,
   type PlanListParams,
   type PlanPublishParams,
-  type PlanSetPricingParams,
   type PlanListResponsesMyCursorIDPage,
 } from './plans/index';
 export {

package/src/resources/v1/plans/entitlements.ts

@@ -254,6 +254,13 @@ export namespace PlanEntitlement {
      * Timestamp of when the record was last updated
      */
     updatedAt: string;
+
+    /**
+     * The feature ID this entitlement depends on (for credit entitlements). The
+     * entitlement value will be calculated as: base amount × dependency feature usage
+     * limit
+     */
+    dependencyFeatureId?: string | null;
   }
 }
 
@@ -467,6 +474,13 @@ export namespace EntitlementCreateResponse {
      * Timestamp of when the record was last updated
      */
     updatedAt: string;
+
+    /**
+     * The feature ID this entitlement depends on (for credit entitlements). The
+     * entitlement value will be calculated as: base amount × dependency feature usage
+     * limit
+     */
+    dependencyFeatureId?: string | null;
   }
 }
 
@@ -685,6 +699,13 @@ export namespace EntitlementListResponse {
      * Timestamp of when the record was last updated
      */
     updatedAt: string;
+
+    /**
+     * The feature ID this entitlement depends on (for credit entitlements). The
+     * entitlement value will be calculated as: base amount × dependency feature usage
+     * limit
+     */
+    dependencyFeatureId?: string | null;
   }
 
   /**
@@ -871,6 +892,12 @@ export namespace EntitlementCreateParams {
      */
     behavior?: 'Increment' | 'Override';
 
+    /**
+     * The feature ID this entitlement depends on. The entitlement value will be
+     * calculated as: base amount × dependency feature usage limit
+     */
+    dependencyFeatureId?: string;
+
     /**
      * Description of the entitlement
      */
@@ -1061,6 +1088,12 @@ export declare namespace EntitlementUpdateParams {
      */
     cadence?: 'MONTH' | 'YEAR';
 
+    /**
+     * Body param: The feature ID this entitlement depends on. The entitlement value
+     * will be calculated as: base amount × dependency feature usage limit
+     */
+    dependencyFeatureId?: string | null;
+
     /**
      * Body param: Description of the entitlement
      */

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

@@ -19,6 +19,5 @@ export {
   type PlanUpdateParams,
   type PlanListParams,
   type PlanPublishParams,
-  type PlanSetPricingParams,
   type PlanListResponsesMyCursorIDPage,
 } from './plans';