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

package/src/resources/v1/events/addons/draft.ts

@@ -0,0 +1,151 @@
+// 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 Draft extends APIResource {
+  /**
+   * Creates a draft version of an existing addon for modification before publishing.
+   */
+  createAddonDraft(id: string, options?: RequestOptions): APIPromise<DraftCreateAddonDraftResponse> {
+    return this._client.post(path`/api/v1/addons/${id}/draft`, options);
+  }
+
+  /**
+   * Removes a draft version of an addon.
+   */
+  removeAddonDraft(id: string, options?: RequestOptions): APIPromise<DraftRemoveAddonDraftResponse> {
+    return this._client.delete(path`/api/v1/addons/${id}/draft`, options);
+  }
+}
+
+/**
+ * Response object
+ */
+export interface DraftCreateAddonDraftResponse {
+  /**
+   * Addon configuration object
+   */
+  data: DraftCreateAddonDraftResponse.Data;
+}
+
+export namespace DraftCreateAddonDraftResponse {
+  /**
+   * Addon configuration object
+   */
+  export interface Data {
+    /**
+     * The unique identifier for the entity
+     */
+    id: string;
+
+    /**
+     * The unique identifier for the entity in the billing provider
+     */
+    billingId: string | null;
+
+    /**
+     * Timestamp of when the record was created
+     */
+    createdAt: string;
+
+    /**
+     * List of addons the addon is dependant on
+     */
+    dependencies: Array<string> | null;
+
+    /**
+     * The description of the package
+     */
+    description: string | null;
+
+    /**
+     * The display name of the package
+     */
+    displayName: string;
+
+    /**
+     * List of entitlements of the package
+     */
+    entitlements: Array<Data.Entitlement>;
+
+    /**
+     * Indicates if the package is the latest version
+     */
+    isLatest: boolean | null;
+
+    /**
+     * The maximum quantity of this addon that can be added to a subscription
+     */
+    maxQuantity: number | null;
+
+    /**
+     * Metadata associated with the entity
+     */
+    metadata: { [key: string]: string };
+
+    /**
+     * The pricing type of the package
+     */
+    pricingType: 'FREE' | 'PAID' | 'CUSTOM' | null;
+
+    /**
+     * The product id of the package
+     */
+    productId: string;
+
+    /**
+     * The status of the package
+     */
+    status: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
+
+    /**
+     * Timestamp of when the record was last updated
+     */
+    updatedAt: string;
+
+    /**
+     * The version number of the package
+     */
+    versionNumber: number;
+  }
+
+  export namespace Data {
+    /**
+     * Entitlement reference with type and identifier
+     */
+    export interface Entitlement {
+      /**
+       * The unique identifier for the entity
+       */
+      id: string;
+
+      type: 'FEATURE' | 'CREDIT';
+    }
+  }
+}
+
+/**
+ * Response confirming the addon draft was removed.
+ */
+export interface DraftRemoveAddonDraftResponse {
+  data: DraftRemoveAddonDraftResponse.Data;
+}
+
+export namespace DraftRemoveAddonDraftResponse {
+  export interface Data {
+    /**
+     * The unique identifier for the entity
+     */
+    id: string;
+  }
+}
+
+export declare namespace Draft {
+  export {
+    type DraftCreateAddonDraftResponse as DraftCreateAddonDraftResponse,
+    type DraftRemoveAddonDraftResponse as DraftRemoveAddonDraftResponse,
+  };
+}

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

@@ -0,0 +1,17 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Addons,
+  type AddonArchiveAddonResponse,
+  type AddonCreateAddonResponse,
+  type AddonListAddonsResponse,
+  type AddonPublishAddonResponse,
+  type AddonRetrieveAddonResponse,
+  type AddonUpdateAddonResponse,
+  type AddonCreateAddonParams,
+  type AddonListAddonsParams,
+  type AddonPublishAddonParams,
+  type AddonUpdateAddonParams,
+  type AddonListAddonsResponsesMyCursorIDPage,
+} from './addons';
+export { Draft, type DraftCreateAddonDraftResponse, type DraftRemoveAddonDraftResponse } from './draft';

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

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

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

@@ -0,0 +1,160 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as FeaturesAPI from './features';
+import {
+  FeatureArchiveFeatureResponse,
+  FeatureCreateFeatureParams,
+  FeatureCreateFeatureResponse,
+  FeatureListFeaturesParams,
+  FeatureListFeaturesResponse,
+  FeatureListFeaturesResponsesMyCursorIDPage,
+  FeatureRetrieveFeatureResponse,
+  FeatureUnarchiveFeatureResponse,
+  FeatureUpdateFeatureParams,
+  FeatureUpdateFeatureResponse,
+  Features,
+} from './features';
+import * as PlansAPI from './plans';
+import {
+  PlanCreateParams,
+  PlanCreateResponse,
+  PlanListParams,
+  PlanListResponse,
+  PlanListResponsesMyCursorIDPage,
+  PlanRetrieveResponse,
+  Plans,
+} from './plans';
+import * as AddonsAPI from './addons/addons';
+import {
+  AddonArchiveAddonResponse,
+  AddonCreateAddonParams,
+  AddonCreateAddonResponse,
+  AddonListAddonsParams,
+  AddonListAddonsResponse,
+  AddonListAddonsResponsesMyCursorIDPage,
+  AddonPublishAddonParams,
+  AddonPublishAddonResponse,
+  AddonRetrieveAddonResponse,
+  AddonUpdateAddonParams,
+  AddonUpdateAddonResponse,
+  Addons,
+} from './addons/addons';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class Events extends APIResource {
+  features: FeaturesAPI.Features = new FeaturesAPI.Features(this._client);
+  addons: AddonsAPI.Addons = new AddonsAPI.Addons(this._client);
+  plans: PlansAPI.Plans = new PlansAPI.Plans(this._client);
+
+  /**
+   * Reports raw usage events for event-based metering. Events are ingested
+   * asynchronously and aggregated into usage totals.
+   */
+  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;
+  }
+}
+
+Events.Features = Features;
+Events.Addons = Addons;
+Events.Plans = Plans;
+
+export declare namespace Events {
+  export { type EventReportResponse as EventReportResponse, type EventReportParams as EventReportParams };
+
+  export {
+    Features as Features,
+    type FeatureArchiveFeatureResponse as FeatureArchiveFeatureResponse,
+    type FeatureCreateFeatureResponse as FeatureCreateFeatureResponse,
+    type FeatureListFeaturesResponse as FeatureListFeaturesResponse,
+    type FeatureRetrieveFeatureResponse as FeatureRetrieveFeatureResponse,
+    type FeatureUnarchiveFeatureResponse as FeatureUnarchiveFeatureResponse,
+    type FeatureUpdateFeatureResponse as FeatureUpdateFeatureResponse,
+    type FeatureListFeaturesResponsesMyCursorIDPage as FeatureListFeaturesResponsesMyCursorIDPage,
+    type FeatureCreateFeatureParams as FeatureCreateFeatureParams,
+    type FeatureListFeaturesParams as FeatureListFeaturesParams,
+    type FeatureUpdateFeatureParams as FeatureUpdateFeatureParams,
+  };
+
+  export {
+    Addons as Addons,
+    type AddonArchiveAddonResponse as AddonArchiveAddonResponse,
+    type AddonCreateAddonResponse as AddonCreateAddonResponse,
+    type AddonListAddonsResponse as AddonListAddonsResponse,
+    type AddonPublishAddonResponse as AddonPublishAddonResponse,
+    type AddonRetrieveAddonResponse as AddonRetrieveAddonResponse,
+    type AddonUpdateAddonResponse as AddonUpdateAddonResponse,
+    type AddonListAddonsResponsesMyCursorIDPage as AddonListAddonsResponsesMyCursorIDPage,
+    type AddonCreateAddonParams as AddonCreateAddonParams,
+    type AddonListAddonsParams as AddonListAddonsParams,
+    type AddonPublishAddonParams as AddonPublishAddonParams,
+    type AddonUpdateAddonParams as AddonUpdateAddonParams,
+  };
+
+  export {
+    Plans as Plans,
+    type PlanCreateResponse as PlanCreateResponse,
+    type PlanRetrieveResponse as PlanRetrieveResponse,
+    type PlanListResponse as PlanListResponse,
+    type PlanListResponsesMyCursorIDPage as PlanListResponsesMyCursorIDPage,
+    type PlanCreateParams as PlanCreateParams,
+    type PlanListParams as PlanListParams,
+  };
+}