@stigg/typescript 0.1.0-alpha.9 → 0.1.0-beta.10

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

@@ -5,6 +5,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Operations related to subscriptions
+ */
 export class Usage extends APIResource {
   /**
    * Immediately charges usage for a subscription via the billing integration.

package/src/resources/v1/usage.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Operations related to usage & metering
+ */
 export class Usage extends APIResource {
   /**
    * Retrieves historical usage data for a customer's metered feature over time.
@@ -215,7 +218,7 @@ export interface UsageHistoryParams {
   endDate?: string;
 
   /**
-   * Query param
+   * Query param: Criteria by which to group the usage history
    */
   groupBy?: string;
 

package/src/resources/v1/v1.ts

@@ -11,19 +11,27 @@ import {
   CouponUpdateCouponParams,
   Coupons,
 } from './coupons';
+import * as EventsAPI from './events';
+import { EventReportParams, EventReportResponse, Events } from './events';
+import * as FeaturesAPI from './features';
+import {
+  Feature,
+  FeatureCreateFeatureParams,
+  FeatureListFeaturesParams,
+  FeatureListFeaturesResponse,
+  FeatureListFeaturesResponsesMyCursorIDPage,
+  FeatureUpdateFeatureParams,
+  Features,
+} from './features';
 import * as ProductsAPI from './products';
 import {
-  ProductArchiveProductResponse,
+  Product,
   ProductCreateProductParams,
-  ProductCreateProductResponse,
   ProductDuplicateProductParams,
-  ProductDuplicateProductResponse,
   ProductListProductsParams,
   ProductListProductsResponse,
   ProductListProductsResponsesMyCursorIDPage,
-  ProductUnarchiveProductResponse,
   ProductUpdateProductParams,
-  ProductUpdateProductResponse,
   Products,
 } from './products';
 import * as UsageAPI from './usage';
@@ -34,10 +42,40 @@ import {
   UsageReportParams,
   UsageReportResponse,
 } from './usage';
+import * as AddonsAPI from './addons/addons';
+import {
+  Addon,
+  AddonCreateParams,
+  AddonListChargesParams,
+  AddonListParams,
+  AddonListResponse,
+  AddonListResponsesMyCursorIDPage,
+  AddonPublishParams,
+  AddonPublishResponse,
+  AddonRemoveDraftResponse,
+  AddonUpdateParams,
+  Addons,
+  ChargeList,
+  ChargeListDataMyCursorIDPage,
+} from './addons/addons';
+import * as CreditsAPI from './credits/credits';
+import {
+  CreditGetAutoRechargeParams,
+  CreditGetAutoRechargeResponse,
+  CreditGetUsageParams,
+  CreditGetUsageResponse,
+  CreditListLedgerParams,
+  CreditListLedgerResponse,
+  CreditListLedgerResponsesMyCursorIDPage,
+  Credits,
+} from './credits/credits';
 import * as CustomersAPI from './customers/customers';
 import {
+  CustomerCheckEntitlementParams,
+  CustomerCheckEntitlementResponse,
   CustomerImportParams,
   CustomerImportResponse,
+  CustomerIntegrationResponse,
   CustomerListParams,
   CustomerListResourcesParams,
   CustomerListResourcesResponse,
@@ -46,11 +84,26 @@ import {
   CustomerListResponsesMyCursorIDPage,
   CustomerProvisionParams,
   CustomerResponse,
+  CustomerRetrieveEntitlementsParams,
+  CustomerRetrieveEntitlementsResponse,
   CustomerUpdateParams,
   Customers,
 } from './customers/customers';
-import * as EventsAPI from './events/events';
-import { EventReportParams, EventReportResponse, Events } from './events/events';
+import * as PlansAPI from './plans/plans';
+import {
+  Plan,
+  PlanCreateParams,
+  PlanListChargesParams,
+  PlanListOverageChargesParams,
+  PlanListParams,
+  PlanListResponse,
+  PlanListResponsesMyCursorIDPage,
+  PlanPublishParams,
+  PlanPublishResponse,
+  PlanRemoveDraftResponse,
+  PlanUpdateParams,
+  Plans,
+} from './plans/plans';
 import * as SubscriptionsAPI from './subscriptions/subscriptions';
 import {
   Subscription,
@@ -76,6 +129,10 @@ export class V1 extends APIResource {
   subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
   coupons: CouponsAPI.Coupons = new CouponsAPI.Coupons(this._client);
   events: EventsAPI.Events = new EventsAPI.Events(this._client);
+  credits: CreditsAPI.Credits = new CreditsAPI.Credits(this._client);
+  features: FeaturesAPI.Features = new FeaturesAPI.Features(this._client);
+  addons: AddonsAPI.Addons = new AddonsAPI.Addons(this._client);
+  plans: PlansAPI.Plans = new PlansAPI.Plans(this._client);
   usage: UsageAPI.Usage = new UsageAPI.Usage(this._client);
   products: ProductsAPI.Products = new ProductsAPI.Products(this._client);
 }
@@ -84,23 +141,32 @@ V1.Customers = Customers;
 V1.Subscriptions = Subscriptions;
 V1.Coupons = Coupons;
 V1.Events = Events;
+V1.Credits = Credits;
+V1.Features = Features;
+V1.Addons = Addons;
+V1.Plans = Plans;
 V1.Usage = Usage;
 V1.Products = Products;
 
 export declare namespace V1 {
   export {
     Customers as Customers,
+    type CustomerIntegrationResponse as CustomerIntegrationResponse,
     type CustomerResponse as CustomerResponse,
     type CustomerListResponse as CustomerListResponse,
+    type CustomerCheckEntitlementResponse as CustomerCheckEntitlementResponse,
     type CustomerImportResponse as CustomerImportResponse,
     type CustomerListResourcesResponse as CustomerListResourcesResponse,
+    type CustomerRetrieveEntitlementsResponse as CustomerRetrieveEntitlementsResponse,
     type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage,
     type CustomerListResourcesResponsesMyCursorIDPage as CustomerListResourcesResponsesMyCursorIDPage,
     type CustomerUpdateParams as CustomerUpdateParams,
     type CustomerListParams as CustomerListParams,
+    type CustomerCheckEntitlementParams as CustomerCheckEntitlementParams,
     type CustomerImportParams as CustomerImportParams,
     type CustomerListResourcesParams as CustomerListResourcesParams,
     type CustomerProvisionParams as CustomerProvisionParams,
+    type CustomerRetrieveEntitlementsParams as CustomerRetrieveEntitlementsParams,
   };
 
   export {
@@ -138,6 +204,58 @@ export declare namespace V1 {
     type EventReportParams as EventReportParams,
   };
 
+  export {
+    Credits as Credits,
+    type CreditGetAutoRechargeResponse as CreditGetAutoRechargeResponse,
+    type CreditGetUsageResponse as CreditGetUsageResponse,
+    type CreditListLedgerResponse as CreditListLedgerResponse,
+    type CreditListLedgerResponsesMyCursorIDPage as CreditListLedgerResponsesMyCursorIDPage,
+    type CreditGetAutoRechargeParams as CreditGetAutoRechargeParams,
+    type CreditGetUsageParams as CreditGetUsageParams,
+    type CreditListLedgerParams as CreditListLedgerParams,
+  };
+
+  export {
+    Features as Features,
+    type Feature as Feature,
+    type FeatureListFeaturesResponse as FeatureListFeaturesResponse,
+    type FeatureListFeaturesResponsesMyCursorIDPage as FeatureListFeaturesResponsesMyCursorIDPage,
+    type FeatureCreateFeatureParams as FeatureCreateFeatureParams,
+    type FeatureListFeaturesParams as FeatureListFeaturesParams,
+    type FeatureUpdateFeatureParams as FeatureUpdateFeatureParams,
+  };
+
+  export {
+    Addons as Addons,
+    type Addon as Addon,
+    type ChargeList as ChargeList,
+    type AddonListResponse as AddonListResponse,
+    type AddonPublishResponse as AddonPublishResponse,
+    type AddonRemoveDraftResponse as AddonRemoveDraftResponse,
+    type AddonListResponsesMyCursorIDPage as AddonListResponsesMyCursorIDPage,
+    type ChargeListDataMyCursorIDPage as ChargeListDataMyCursorIDPage,
+    type AddonCreateParams as AddonCreateParams,
+    type AddonUpdateParams as AddonUpdateParams,
+    type AddonListParams as AddonListParams,
+    type AddonListChargesParams as AddonListChargesParams,
+    type AddonPublishParams as AddonPublishParams,
+  };
+
+  export {
+    Plans as Plans,
+    type Plan as Plan,
+    type PlanListResponse as PlanListResponse,
+    type PlanPublishResponse as PlanPublishResponse,
+    type PlanRemoveDraftResponse as PlanRemoveDraftResponse,
+    type PlanListResponsesMyCursorIDPage as PlanListResponsesMyCursorIDPage,
+    type PlanCreateParams as PlanCreateParams,
+    type PlanUpdateParams as PlanUpdateParams,
+    type PlanListParams as PlanListParams,
+    type PlanListChargesParams as PlanListChargesParams,
+    type PlanListOverageChargesParams as PlanListOverageChargesParams,
+    type PlanPublishParams as PlanPublishParams,
+  };
+
   export {
     Usage as Usage,
     type UsageHistoryResponse as UsageHistoryResponse,
@@ -148,12 +266,8 @@ export declare namespace V1 {
 
   export {
     Products as Products,
-    type ProductArchiveProductResponse as ProductArchiveProductResponse,
-    type ProductCreateProductResponse as ProductCreateProductResponse,
-    type ProductDuplicateProductResponse as ProductDuplicateProductResponse,
+    type Product as Product,
     type ProductListProductsResponse as ProductListProductsResponse,
-    type ProductUnarchiveProductResponse as ProductUnarchiveProductResponse,
-    type ProductUpdateProductResponse as ProductUpdateProductResponse,
     type ProductListProductsResponsesMyCursorIDPage as ProductListProductsResponsesMyCursorIDPage,
     type ProductCreateProductParams as ProductCreateProductParams,
     type ProductDuplicateProductParams as ProductDuplicateProductParams,

package/src/resources/v1-beta/customers/assignments.ts

@@ -0,0 +1,225 @@
+// 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';
+
+export class Assignments extends APIResource {
+  /**
+   * Returns a cursor-paginated list of capability assignments for the given
+   * customer. An assignment ties an entity to a capability with a usage limit and
+   * reset cadence.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const assignmentListResponse of client.v1Beta.customers.assignments.list(
+   *   'id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    id: string,
+    query: AssignmentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<AssignmentListResponsesMyCursorIDPage, AssignmentListResponse> {
+    return this._client.getAPIList(
+      path`/api/v1-beta/customers/${id}/assignments`,
+      MyCursorIDPage<AssignmentListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Batched create-or-update of capability assignments. Existing assignments matched
+   * by (entityId, capabilityId) are updated; new pairs are created. On update,
+   * omitted fields (usageLimit, cadence) are preserved; on create both are required
+   * by the governance service.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1Beta.customers.assignments.upsert('id', {
+   *     assignments: [
+   *       {
+   *         entityId: 'workspace-001',
+   *         capabilityId: 'compute-minutes',
+   *         usageLimit: 1000,
+   *         cadence: 'MONTH',
+   *       },
+   *       {
+   *         entityId: 'workspace-002',
+   *         capabilityId: 'compute-minutes',
+   *         usageLimit: 2000,
+   *         cadence: 'MONTH',
+   *       },
+   *     ],
+   *   });
+   * ```
+   */
+  upsert(
+    id: string,
+    body: AssignmentUpsertParams,
+    options?: RequestOptions,
+  ): APIPromise<AssignmentUpsertResponse> {
+    return this._client.put(path`/api/v1-beta/customers/${id}/assignments`, { body, ...options });
+  }
+}
+
+export type AssignmentListResponsesMyCursorIDPage = MyCursorIDPage<AssignmentListResponse>;
+
+/**
+ * A capability assignment for an entity belonging to a customer. Defines how much
+ * of the capability the entity may consume (`usageLimit`) and how often the
+ * counter resets (`cadence`).
+ */
+export interface AssignmentListResponse {
+  /**
+   * Synthetic UUID identifier — also the cursor anchor for paginated lists
+   */
+  id: string;
+
+  /**
+   * Usage-reset cadence. Currently only `MONTH` is supported
+   */
+  cadence: 'MONTH';
+
+  /**
+   * The capability refId this assignment grants
+   */
+  capabilityId: string;
+
+  /**
+   * Timestamp of when the record was created
+   */
+  createdAt: string;
+
+  /**
+   * The entity refId this assignment is attached to
+   */
+  entityId: string;
+
+  /**
+   * Timestamp of when the record was last updated
+   */
+  updatedAt: string;
+
+  /**
+   * Maximum usage allowed within one cadence window
+   */
+  usageLimit: number;
+}
+
+/**
+ * Assignments after upsert.
+ */
+export interface AssignmentUpsertResponse {
+  data: Array<AssignmentUpsertResponse.Data>;
+}
+
+export namespace AssignmentUpsertResponse {
+  /**
+   * A capability assignment for an entity belonging to a customer. Defines how much
+   * of the capability the entity may consume (`usageLimit`) and how often the
+   * counter resets (`cadence`).
+   */
+  export interface Data {
+    /**
+     * Synthetic UUID identifier — also the cursor anchor for paginated lists
+     */
+    id: string;
+
+    /**
+     * Usage-reset cadence. Currently only `MONTH` is supported
+     */
+    cadence: 'MONTH';
+
+    /**
+     * The capability refId this assignment grants
+     */
+    capabilityId: string;
+
+    /**
+     * Timestamp of when the record was created
+     */
+    createdAt: string;
+
+    /**
+     * The entity refId this assignment is attached to
+     */
+    entityId: string;
+
+    /**
+     * Timestamp of when the record was last updated
+     */
+    updatedAt: string;
+
+    /**
+     * Maximum usage allowed within one cadence window
+     */
+    usageLimit: number;
+  }
+}
+
+export interface AssignmentListParams extends MyCursorIDPageParams {
+  /**
+   * Filter assignments to a specific capability refId
+   */
+  capabilityId?: string;
+
+  /**
+   * Filter assignments to a specific entity refId
+   */
+  entityId?: string;
+}
+
+export interface AssignmentUpsertParams {
+  /**
+   * Assignments to upsert (1–100 per request)
+   */
+  assignments: Array<AssignmentUpsertParams.Assignment>;
+}
+
+export namespace AssignmentUpsertParams {
+  /**
+   * A single assignment to create or update. The natural key is the
+   * `(entityId, capabilityId)` pair. On create both `usageLimit` and `cadence` are
+   * required; on update they may be omitted individually to preserve the existing
+   * value.
+   */
+  export interface Assignment {
+    /**
+     * The capability refId this assignment grants
+     */
+    capabilityId: string;
+
+    /**
+     * The entity refId this assignment is attached to
+     */
+    entityId: string;
+
+    /**
+     * Usage-reset cadence (required on create). Currently only `MONTH` is supported
+     */
+    cadence?: 'MONTH';
+
+    /**
+     * Maximum usage allowed within one cadence window (required on create)
+     */
+    usageLimit?: number;
+  }
+}
+
+export declare namespace Assignments {
+  export {
+    type AssignmentListResponse as AssignmentListResponse,
+    type AssignmentUpsertResponse as AssignmentUpsertResponse,
+    type AssignmentListResponsesMyCursorIDPage as AssignmentListResponsesMyCursorIDPage,
+    type AssignmentListParams as AssignmentListParams,
+    type AssignmentUpsertParams as AssignmentUpsertParams,
+  };
+}

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

@@ -0,0 +1,71 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as AssignmentsAPI from './assignments';
+import {
+  AssignmentListParams,
+  AssignmentListResponse,
+  AssignmentListResponsesMyCursorIDPage,
+  AssignmentUpsertParams,
+  AssignmentUpsertResponse,
+  Assignments,
+} from './assignments';
+import * as EntitiesAPI from './entities';
+import {
+  Entities,
+  EntityArchiveParams,
+  EntityIDsActionResponseDto,
+  EntityIDsRequestDto,
+  EntityListParams,
+  EntityListResponse,
+  EntityListResponsesMyCursorIDPage,
+  EntityRetrieveParams,
+  EntityRetrieveResponse,
+  EntityUnarchiveParams,
+  EntityUpsertParams,
+  EntityUpsertResponse,
+} from './entities';
+import * as EntitlementsAPI from './entitlements';
+import { EntitlementCheckParams, EntitlementCheckResponse, Entitlements } from './entitlements';
+
+export class Customers extends APIResource {
+  entitlements: EntitlementsAPI.Entitlements = new EntitlementsAPI.Entitlements(this._client);
+  entities: EntitiesAPI.Entities = new EntitiesAPI.Entities(this._client);
+  assignments: AssignmentsAPI.Assignments = new AssignmentsAPI.Assignments(this._client);
+}
+
+Customers.Entitlements = Entitlements;
+Customers.Entities = Entities;
+Customers.Assignments = Assignments;
+
+export declare namespace Customers {
+  export {
+    Entitlements as Entitlements,
+    type EntitlementCheckResponse as EntitlementCheckResponse,
+    type EntitlementCheckParams as EntitlementCheckParams,
+  };
+
+  export {
+    Entities as Entities,
+    type EntityIDsActionResponseDto as EntityIDsActionResponseDto,
+    type EntityIDsRequestDto as EntityIDsRequestDto,
+    type EntityRetrieveResponse as EntityRetrieveResponse,
+    type EntityListResponse as EntityListResponse,
+    type EntityUpsertResponse as EntityUpsertResponse,
+    type EntityListResponsesMyCursorIDPage as EntityListResponsesMyCursorIDPage,
+    type EntityRetrieveParams as EntityRetrieveParams,
+    type EntityListParams as EntityListParams,
+    type EntityArchiveParams as EntityArchiveParams,
+    type EntityUnarchiveParams as EntityUnarchiveParams,
+    type EntityUpsertParams as EntityUpsertParams,
+  };
+
+  export {
+    Assignments as Assignments,
+    type AssignmentListResponse as AssignmentListResponse,
+    type AssignmentUpsertResponse as AssignmentUpsertResponse,
+    type AssignmentListResponsesMyCursorIDPage as AssignmentListResponsesMyCursorIDPage,
+    type AssignmentListParams as AssignmentListParams,
+    type AssignmentUpsertParams as AssignmentUpsertParams,
+  };
+}