@stigg/typescript 0.1.0-beta.1 → 0.1.0-beta.10

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

@@ -0,0 +1,360 @@
+// 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 Entities extends APIResource {
+  /**
+   * Retrieves a single entity for the given customer by its identifier.
+   *
+   * @example
+   * ```ts
+   * const entity =
+   *   await client.v1Beta.customers.entities.retrieve('x', {
+   *     id: 'id',
+   *   });
+   * ```
+   */
+  retrieve(
+    entityID: string,
+    params: EntityRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<EntityRetrieveResponse> {
+    const { id } = params;
+    return this._client.get(path`/api/v1-beta/customers/${id}/entities/${entityID}`, options);
+  }
+
+  /**
+   * Retrieves a paginated list of entities for the given customer.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const entityListResponse of client.v1Beta.customers.entities.list(
+   *   'id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    id: string,
+    query: EntityListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<EntityListResponsesMyCursorIDPage, EntityListResponse> {
+    return this._client.getAPIList(
+      path`/api/v1-beta/customers/${id}/entities`,
+      MyCursorIDPage<EntityListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Archives entities in bulk for the given customer by id.
+   *
+   * @example
+   * ```ts
+   * const entityIDsActionResponseDto =
+   *   await client.v1Beta.customers.entities.archive('id', {
+   *     ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
+   *   });
+   * ```
+   */
+  archive(
+    id: string,
+    body: EntityArchiveParams,
+    options?: RequestOptions,
+  ): APIPromise<EntityIDsActionResponseDto> {
+    return this._client.post(path`/api/v1-beta/customers/${id}/entities/archive`, { body, ...options });
+  }
+
+  /**
+   * Restores previously archived entities in bulk for the given customer by id.
+   *
+   * @example
+   * ```ts
+   * const entityIDsActionResponseDto =
+   *   await client.v1Beta.customers.entities.unarchive('id', {
+   *     ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
+   *   });
+   * ```
+   */
+  unarchive(
+    id: string,
+    body: EntityUnarchiveParams,
+    options?: RequestOptions,
+  ): APIPromise<EntityIDsActionResponseDto> {
+    return this._client.post(path`/api/v1-beta/customers/${id}/entities/unarchive`, { body, ...options });
+  }
+
+  /**
+   * Creates or updates entities in bulk for the given customer. Existing entities
+   * matched by id are updated; new ids are created.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1Beta.customers.entities.upsert('id', {
+   *     entities: [
+   *       {
+   *         id: 'user-7f3a0c1d',
+   *         typeRefId: 'user',
+   *         metadata: { email: 'jane@acme.com', role: 'admin' },
+   *       },
+   *       {
+   *         id: 'user-c4d1b2e9',
+   *         typeRefId: 'user',
+   *         metadata: { email: 'john@acme.com' },
+   *       },
+   *     ],
+   *   });
+   * ```
+   */
+  upsert(id: string, body: EntityUpsertParams, options?: RequestOptions): APIPromise<EntityUpsertResponse> {
+    return this._client.put(path`/api/v1-beta/customers/${id}/entities`, { body, ...options });
+  }
+}
+
+export type EntityListResponsesMyCursorIDPage = MyCursorIDPage<EntityListResponse>;
+
+/**
+ * Wrapped response echoing the ids that were acted on by an archive/unarchive call
+ */
+export interface EntityIDsActionResponseDto {
+  /**
+   * List of entity identifiers that were acted on
+   */
+  data: EntityIDsActionResponseDto.Data;
+}
+
+export namespace EntityIDsActionResponseDto {
+  /**
+   * List of entity identifiers that were acted on
+   */
+  export interface Data {
+    /**
+     * Entity identifiers to act on
+     */
+    ids: Array<string>;
+  }
+}
+
+/**
+ * List of entity identifiers to act on in bulk (1-100 entries)
+ */
+export interface EntityIDsRequestDto {
+  /**
+   * Entity identifiers to act on
+   */
+  ids: Array<string>;
+}
+
+/**
+ * Response object
+ */
+export interface EntityRetrieveResponse {
+  /**
+   * A stored entity instance tracked by the governance service for a given customer
+   */
+  data: EntityRetrieveResponse.Data;
+}
+
+export namespace EntityRetrieveResponse {
+  /**
+   * A stored entity instance tracked by the governance service for a given customer
+   */
+  export interface Data {
+    /**
+     * The unique identifier for the entity
+     */
+    id: string;
+
+    /**
+     * Timestamp of when the record was deleted
+     */
+    archivedAt: string | null;
+
+    /**
+     * Timestamp of when the record was created
+     */
+    createdAt: string;
+
+    /**
+     * Free-form key/value metadata attached to the entity
+     */
+    metadata: { [key: string]: string };
+
+    /**
+     * The entity type identifier this entity instantiates
+     */
+    typeId: string;
+
+    /**
+     * Timestamp of when the record was last updated
+     */
+    updatedAt: string;
+  }
+}
+
+/**
+ * A stored entity instance tracked by the governance service for a given customer
+ */
+export interface EntityListResponse {
+  /**
+   * The unique identifier for the entity
+   */
+  id: string;
+
+  /**
+   * Timestamp of when the record was deleted
+   */
+  archivedAt: string | null;
+
+  /**
+   * Timestamp of when the record was created
+   */
+  createdAt: string;
+
+  /**
+   * Free-form key/value metadata attached to the entity
+   */
+  metadata: { [key: string]: string };
+
+  /**
+   * The entity type identifier this entity instantiates
+   */
+  typeId: string;
+
+  /**
+   * Timestamp of when the record was last updated
+   */
+  updatedAt: string;
+}
+
+/**
+ * List of entities created or updated by an upsert request
+ */
+export interface EntityUpsertResponse {
+  data: Array<EntityUpsertResponse.Data>;
+}
+
+export namespace EntityUpsertResponse {
+  /**
+   * A stored entity instance tracked by the governance service for a given customer
+   */
+  export interface Data {
+    /**
+     * The unique identifier for the entity
+     */
+    id: string;
+
+    /**
+     * Timestamp of when the record was deleted
+     */
+    archivedAt: string | null;
+
+    /**
+     * Timestamp of when the record was created
+     */
+    createdAt: string;
+
+    /**
+     * Free-form key/value metadata attached to the entity
+     */
+    metadata: { [key: string]: string };
+
+    /**
+     * The entity type identifier this entity instantiates
+     */
+    typeId: string;
+
+    /**
+     * Timestamp of when the record was last updated
+     */
+    updatedAt: string;
+  }
+}
+
+export interface EntityRetrieveParams {
+  /**
+   * The customer identifier (owner) the entity belongs to
+   */
+  id: string;
+}
+
+export interface EntityListParams extends MyCursorIDPageParams {
+  /**
+   * Whether to include archived entities. One of: true, false
+   */
+  includeArchived?: 'true' | 'false';
+
+  /**
+   * Filter results to entities of a specific entity type, by the type's refId
+   */
+  typeRefId?: string;
+}
+
+export interface EntityArchiveParams {
+  /**
+   * Entity identifiers to act on
+   */
+  ids: Array<string>;
+}
+
+export interface EntityUnarchiveParams {
+  /**
+   * Entity identifiers to act on
+   */
+  ids: Array<string>;
+}
+
+export interface EntityUpsertParams {
+  /**
+   * List of entities to create or update (1-100 entries)
+   */
+  entities: Array<EntityUpsertParams.Entity>;
+}
+
+export namespace EntityUpsertParams {
+  /**
+   * A single entity to create or update.
+   */
+  export interface Entity {
+    /**
+     * The unique identifier for the entity
+     */
+    id: string;
+
+    /**
+     * Free-form key/value metadata. Patch semantics: empty-string value removes a key,
+     * omitted keys are preserved.
+     */
+    metadata?: { [key: string]: string };
+
+    /**
+     * The entity type refId this entity instantiates. Required when creating a new
+     * entity; on a re-upsert may be omitted to preserve the existing type. Governance
+     * returns 400 if missing on create.
+     */
+    typeRefId?: string;
+  }
+}
+
+export declare namespace Entities {
+  export {
+    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,
+  };
+}

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

@@ -0,0 +1,325 @@
+// 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 Entitlements extends APIResource {
+  /**
+   * Experimental — request and response shapes may change without notice. Same
+   * semantics as `Check entitlement`, plus an optional `dimensions` query param that
+   * resolves to per-entity governance limits surfaced as `chains` on the response.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1Beta.customers.entitlements.check('x');
+   * ```
+   */
+  check(
+    id: string,
+    query: EntitlementCheckParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EntitlementCheckResponse> {
+    return this._client.get(path`/api/v1-beta/customers/${id}/entitlements/check`, { query, ...options });
+  }
+}
+
+/**
+ * Response object
+ */
+export interface EntitlementCheckResponse {
+  /**
+   * Feature entitlement with optional governance chains attached.
+   */
+  data: EntitlementCheckResponse.Feature | EntitlementCheckResponse.Credit;
+}
+
+export namespace EntitlementCheckResponse {
+  /**
+   * Feature entitlement with optional governance chains attached.
+   */
+  export interface Feature {
+    accessDeniedReason:
+      | 'FeatureNotFound'
+      | 'CustomerNotFound'
+      | 'CustomerIsArchived'
+      | 'CustomerResourceNotFound'
+      | 'NoActiveSubscription'
+      | 'NoFeatureEntitlementInSubscription'
+      | 'RequestedUsageExceedingLimit'
+      | 'RequestedValuesMismatch'
+      | 'BudgetExceeded'
+      | 'Unknown'
+      | 'FeatureTypeMismatch'
+      | 'Revoked'
+      | 'InsufficientCredits'
+      | 'EntitlementNotFound'
+      | null;
+
+    isGranted: boolean;
+
+    type: 'FEATURE';
+
+    /**
+     * Per-entity rollups, one chain per resolved dimension. Omitted when dimensions
+     * was not provided.
+     */
+    chains?: Array<Array<Feature.Chain>>;
+
+    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 {
+    /**
+     * Per-entity governance node — limit and current usage for a single resolved
+     * entity.
+     */
+    export interface Chain {
+      /**
+       * Amount consumed by this entity in the current cadence period.
+       */
+      currentUsage: number;
+
+      /**
+       * External id of the entity within the customer.
+       */
+      entityId: string;
+
+      /**
+       * Whether this node alone permits the requested usage.
+       */
+      isGranted: boolean;
+
+      /**
+       * Hard usage limit for this node; null when no assignment is configured.
+       */
+      usageLimit: number | null;
+    }
+
+    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';
+    }
+  }
+
+  /**
+   * Credit entitlement with optional governance chains attached.
+   */
+  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;
+
+    /**
+     * Per-entity rollups, one chain per resolved dimension. Omitted when dimensions
+     * was not provided.
+     */
+    chains?: Array<Array<Credit.Chain>>;
+
+    /**
+     * 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;
+    }
+
+    /**
+     * Per-entity governance node — limit and current usage for a single resolved
+     * entity.
+     */
+    export interface Chain {
+      /**
+       * Amount consumed by this entity in the current cadence period.
+       */
+      currentUsage: number;
+
+      /**
+       * External id of the entity within the customer.
+       */
+      entityId: string;
+
+      /**
+       * Whether this node alone permits the requested usage.
+       */
+      isGranted: boolean;
+
+      /**
+       * Hard usage limit for this node; null when no assignment is configured.
+       */
+      usageLimit: number | null;
+    }
+  }
+}
+
+export interface EntitlementCheckParams {
+  /**
+   * Currency ID (refId) to check for credit entitlements. Mutually exclusive with
+   * `featureId`.
+   */
+  currencyId?: string;
+
+  /**
+   * Optional attribution map (e.g. `dimensions[userId]=u1`). When provided, the
+   * response includes a `chains` array with per-entity governance limits.
+   */
+  dimensions?: { [key: string]: string };
+
+  /**
+   * Feature ID (refId) to check. Mutually exclusive with `currencyId`.
+   */
+  featureId?: string;
+
+  /**
+   * Requested usage amount to evaluate against the entitlement limit (numeric
+   * features only)
+   */
+  requestedUsage?: number;
+
+  /**
+   * Requested values to evaluate against allowed values (enum features only)
+   */
+  requestedValues?: Array<string>;
+
+  /**
+   * Resource ID to scope the entitlement check to a specific resource
+   */
+  resourceId?: string;
+}
+
+export declare namespace Entitlements {
+  export {
+    type EntitlementCheckResponse as EntitlementCheckResponse,
+    type EntitlementCheckParams as EntitlementCheckParams,
+  };
+}

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

@@ -0,0 +1,26 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Assignments,
+  type AssignmentListResponse,
+  type AssignmentUpsertResponse,
+  type AssignmentListParams,
+  type AssignmentUpsertParams,
+  type AssignmentListResponsesMyCursorIDPage,
+} from './assignments';
+export { Customers } from './customers';
+export {
+  Entities,
+  type EntityIDsActionResponseDto,
+  type EntityIDsRequestDto,
+  type EntityRetrieveResponse,
+  type EntityListResponse,
+  type EntityUpsertResponse,
+  type EntityRetrieveParams,
+  type EntityListParams,
+  type EntityArchiveParams,
+  type EntityUnarchiveParams,
+  type EntityUpsertParams,
+  type EntityListResponsesMyCursorIDPage,
+} from './entities';
+export { Entitlements, type EntitlementCheckResponse, type EntitlementCheckParams } from './entitlements';

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

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './customers/index';