@augstash/sdk 0.2.0 → 0.3.0

package/dist/generated/src/apis/ApiKeyApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { ApiKeyResponse, ApiKeyUsageResponse, CreateApiKeyRequest, CreateApiKeyResponse, PageResponseApiKeyResponse, PageResponseApiKeySecurityEventResponse, Pageable, UpdateApiKeySecurityRequest } from '../models/index';
+import type { ApiKeyResponse, ApiKeyUsageResponse, CreateApiKeyRequest, CreateApiKeyResponse, PageResponseApiKeyResponse, PageResponseApiKeySecurityEventResponse, Pageable, UpdateApiKeyChannelAccountsRequest, UpdateApiKeySecurityRequest } from '../models/index';
 export interface CreateAuthRequest {
     createApiKeyRequest: CreateApiKeyRequest;
     xIdempotencyKey?: string;
@@ -30,6 +30,11 @@ export interface SecurityEventsRequest {
     id: string;
     pageable: Pageable;
 }
+export interface UpdateChannelAccountsRequest {
+    id: string;
+    updateApiKeyChannelAccountsRequest: UpdateApiKeyChannelAccountsRequest;
+    xIdempotencyKey?: string;
+}
 export interface UpdateSecurityAuthRequest {
     id: string;
     updateApiKeySecurityRequest: UpdateApiKeySecurityRequest;
@@ -120,6 +125,22 @@ export interface ApiKeyApiInterface {
      * List an API key\'s security events
      */
     securityEvents(requestParameters: SecurityEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseApiKeySecurityEventResponse>;
+    /**
+     * Writes < 300ms. Full replace: a channel omitted from the body is unrestricted for this key, not denied, so an empty body unbinds it from everything and widens it back to every connected account. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * @summary Replace an API key\'s channel-account bindings
+     * @param {string} id
+     * @param {UpdateApiKeyChannelAccountsRequest} updateApiKeyChannelAccountsRequest
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ApiKeyApiInterface
+     */
+    updateChannelAccountsRaw(requestParameters: UpdateChannelAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKeyResponse>>;
+    /**
+     * Writes < 300ms. Full replace: a channel omitted from the body is unrestricted for this key, not denied, so an empty body unbinds it from everything and widens it back to every connected account. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * Replace an API key\'s channel-account bindings
+     */
+    updateChannelAccounts(requestParameters: UpdateChannelAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeyResponse>;
     /**
      * Writes < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
      * @summary Replace an API key\'s security hardening config
@@ -206,6 +227,16 @@ export declare class ApiKeyApi extends runtime.BaseAPI implements ApiKeyApiInter
      * List an API key\'s security events
      */
     securityEvents(requestParameters: SecurityEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseApiKeySecurityEventResponse>;
+    /**
+     * Writes < 300ms. Full replace: a channel omitted from the body is unrestricted for this key, not denied, so an empty body unbinds it from everything and widens it back to every connected account. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * Replace an API key\'s channel-account bindings
+     */
+    updateChannelAccountsRaw(requestParameters: UpdateChannelAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKeyResponse>>;
+    /**
+     * Writes < 300ms. Full replace: a channel omitted from the body is unrestricted for this key, not denied, so an empty body unbinds it from everything and widens it back to every connected account. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * Replace an API key\'s channel-account bindings
+     */
+    updateChannelAccounts(requestParameters: UpdateChannelAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeyResponse>;
     /**
      * Writes < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
      * Replace an API key\'s security hardening config

package/dist/generated/src/apis/ApiKeyApi.js

@@ -261,6 +261,52 @@ class ApiKeyApi extends runtime.BaseAPI {
         const response = await this.securityEventsRaw(requestParameters, initOverrides);
         return await response.value();
     }
+    /**
+     * Writes < 300ms. Full replace: a channel omitted from the body is unrestricted for this key, not denied, so an empty body unbinds it from everything and widens it back to every connected account. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * Replace an API key\'s channel-account bindings
+     */
+    async updateChannelAccountsRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling updateChannelAccounts().');
+        }
+        if (requestParameters['updateApiKeyChannelAccountsRequest'] == null) {
+            throw new runtime.RequiredError('updateApiKeyChannelAccountsRequest', 'Required parameter "updateApiKeyChannelAccountsRequest" was null or undefined when calling updateChannelAccounts().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['xIdempotencyKey'] != null) {
+            headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/auth/api-keys/{id}/channel-accounts`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.UpdateApiKeyChannelAccountsRequestToJSON)(requestParameters['updateApiKeyChannelAccountsRequest']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ApiKeyResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Writes < 300ms. Full replace: a channel omitted from the body is unrestricted for this key, not denied, so an empty body unbinds it from everything and widens it back to every connected account. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * Replace an API key\'s channel-account bindings
+     */
+    async updateChannelAccounts(requestParameters, initOverrides) {
+        const response = await this.updateChannelAccountsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
     /**
      * Writes < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
      * Replace an API key\'s security hardening config

package/dist/generated/src/apis/AuditApi.d.ts

@@ -36,7 +36,7 @@ export interface ListAuditRequest {
  */
 export interface AuditApiInterface {
     /**
-     * Reads < 300ms.
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
      * @summary Export audit log entries as CSV
      * @param {string} [tenantId]
      * @param {string} [actorUserId]
@@ -50,7 +50,7 @@ export interface AuditApiInterface {
      */
     exportAuditRaw(requestParameters: ExportAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
     /**
-     * Reads < 300ms.
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
      * Export audit log entries as CSV
      */
     exportAudit(requestParameters: ExportAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
@@ -93,12 +93,12 @@ export interface AuditApiInterface {
  */
 export declare class AuditApi extends runtime.BaseAPI implements AuditApiInterface {
     /**
-     * Reads < 300ms.
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
      * Export audit log entries as CSV
      */
     exportAuditRaw(requestParameters: ExportAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
     /**
-     * Reads < 300ms.
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
      * Export audit log entries as CSV
      */
     exportAudit(requestParameters?: ExportAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;

package/dist/generated/src/apis/AuditApi.js

@@ -54,7 +54,7 @@ const index_1 = require("../models/index");
  */
 class AuditApi extends runtime.BaseAPI {
     /**
-     * Reads < 300ms.
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
      * Export audit log entries as CSV
      */
     async exportAuditRaw(requestParameters, initOverrides) {
@@ -103,7 +103,7 @@ class AuditApi extends runtime.BaseAPI {
         }
     }
     /**
-     * Reads < 300ms.
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
      * Export audit log entries as CSV
      */
     async exportAudit(requestParameters = {}, initOverrides) {

package/dist/generated/src/apis/AuthMeApi.d.ts

@@ -25,12 +25,12 @@ export interface AuthMeApiInterface {
      * @throws {RequiredError}
      * @memberof AuthMeApiInterface
      */
-    meRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthMeResponse>>;
+    meAuthRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthMeResponse>>;
     /**
      * Reads < 300ms.
      * Get the current session\'s user + tenant
      */
-    me(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthMeResponse>;
+    meAuth(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthMeResponse>;
 }
 /**
  *
@@ -40,10 +40,10 @@ export declare class AuthMeApi extends runtime.BaseAPI implements AuthMeApiInter
      * Reads < 300ms.
      * Get the current session\'s user + tenant
      */
-    meRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthMeResponse>>;
+    meAuthRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthMeResponse>>;
     /**
      * Reads < 300ms.
      * Get the current session\'s user + tenant
      */
-    me(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthMeResponse>;
+    meAuth(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthMeResponse>;
 }

package/dist/generated/src/apis/AuthMeApi.js

@@ -57,7 +57,7 @@ class AuthMeApi extends runtime.BaseAPI {
      * Reads < 300ms.
      * Get the current session\'s user + tenant
      */
-    async meRaw(initOverrides) {
+    async meAuthRaw(initOverrides) {
         const queryParameters = {};
         const headerParameters = {};
         if (this.configuration && this.configuration.apiKey) {
@@ -83,8 +83,8 @@ class AuthMeApi extends runtime.BaseAPI {
      * Reads < 300ms.
      * Get the current session\'s user + tenant
      */
-    async me(initOverrides) {
-        const response = await this.meRaw(initOverrides);
+    async meAuth(initOverrides) {
+        const response = await this.meAuthRaw(initOverrides);
         return await response.value();
     }
 }

package/dist/generated/src/apis/AutomationApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { ApprovalResponse, AutomationCreateFlowRequest, AutomationEnrollRequest, AutomationEnrollmentResponse, AutomationFlowAnalyticsResponse, AutomationFlowResponse, AutomationNodeTypeResponse, AutomationSimulateRequest, AutomationSimulateResponse, AutomationUpdateFlowRequest, FlowVersionResponse, ImportFlowRequest, PageResponseAutomationEnrollmentResponse, PageResponseAutomationFlowSummaryResponse, PageResponseFlowVersionSummaryResponse, Pageable, PublishFlowRequest, TriggerTypeResponse } from '../models/index';
+import type { ApprovalResponse, AutomationApiTriggerRequest, AutomationApiTriggerResponse, AutomationCreateFlowRequest, AutomationEnrollRequest, AutomationEnrollmentResponse, AutomationFlowAnalyticsResponse, AutomationFlowResponse, AutomationNodeTypeResponse, AutomationSimulateRequest, AutomationSimulateResponse, AutomationUpdateFlowRequest, FlowVersionResponse, ImportFlowRequest, PageResponseAutomationEnrollmentResponse, PageResponseAutomationFlowSummaryResponse, PageResponseFlowVersionSummaryResponse, Pageable, PublishFlowRequest, TriggerTypeResponse } from '../models/index';
 export interface AnalyticsAutomationsRequest {
     id: string;
 }
@@ -36,6 +36,10 @@ export interface EnrollAutomationsRequest {
     automationEnrollRequest: AutomationEnrollRequest;
     xIdempotencyKey?: string;
 }
+export interface FireApiTriggerRequest {
+    automationApiTriggerRequest: AutomationApiTriggerRequest;
+    xIdempotencyKey?: string;
+}
 export interface GetAutomationsRequest {
     id: string;
 }
@@ -197,6 +201,21 @@ export interface AutomationApiInterface {
      * Enroll a contact into an active automation flow
      */
     enrollAutomations(requestParameters: EnrollAutomationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutomationEnrollmentResponse>;
+    /**
+     * Writes < 300ms. Enrols the contact into every active flow whose trigger is API and whose configured event (if any) matches. Idempotent under X-Idempotency-Key. Requires API-key scope: automations:write.
+     * @summary Fire the API trigger for a contact
+     * @param {AutomationApiTriggerRequest} automationApiTriggerRequest
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AutomationApiInterface
+     */
+    fireApiTriggerRaw(requestParameters: FireApiTriggerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutomationApiTriggerResponse>>;
+    /**
+     * Writes < 300ms. Enrols the contact into every active flow whose trigger is API and whose configured event (if any) matches. Idempotent under X-Idempotency-Key. Requires API-key scope: automations:write.
+     * Fire the API trigger for a contact
+     */
+    fireApiTrigger(requestParameters: FireApiTriggerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutomationApiTriggerResponse>;
     /**
      * Reads < 300ms. Requires API-key scope: automations:read.
      * @summary Get a single automation flow
@@ -516,6 +535,16 @@ export declare class AutomationApi extends runtime.BaseAPI implements Automation
      * Enroll a contact into an active automation flow
      */
     enrollAutomations(requestParameters: EnrollAutomationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutomationEnrollmentResponse>;
+    /**
+     * Writes < 300ms. Enrols the contact into every active flow whose trigger is API and whose configured event (if any) matches. Idempotent under X-Idempotency-Key. Requires API-key scope: automations:write.
+     * Fire the API trigger for a contact
+     */
+    fireApiTriggerRaw(requestParameters: FireApiTriggerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutomationApiTriggerResponse>>;
+    /**
+     * Writes < 300ms. Enrols the contact into every active flow whose trigger is API and whose configured event (if any) matches. Idempotent under X-Idempotency-Key. Requires API-key scope: automations:write.
+     * Fire the API trigger for a contact
+     */
+    fireApiTrigger(requestParameters: FireApiTriggerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutomationApiTriggerResponse>;
     /**
      * Reads < 300ms. Requires API-key scope: automations:read.
      * Get a single automation flow

package/dist/generated/src/apis/AutomationApi.js

@@ -305,6 +305,48 @@ class AutomationApi extends runtime.BaseAPI {
         const response = await this.enrollAutomationsRaw(requestParameters, initOverrides);
         return await response.value();
     }
+    /**
+     * Writes < 300ms. Enrols the contact into every active flow whose trigger is API and whose configured event (if any) matches. Idempotent under X-Idempotency-Key. Requires API-key scope: automations:write.
+     * Fire the API trigger for a contact
+     */
+    async fireApiTriggerRaw(requestParameters, initOverrides) {
+        if (requestParameters['automationApiTriggerRequest'] == null) {
+            throw new runtime.RequiredError('automationApiTriggerRequest', 'Required parameter "automationApiTriggerRequest" was null or undefined when calling fireApiTrigger().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['xIdempotencyKey'] != null) {
+            headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/automations/triggers/api`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.AutomationApiTriggerRequestToJSON)(requestParameters['automationApiTriggerRequest']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AutomationApiTriggerResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Writes < 300ms. Enrols the contact into every active flow whose trigger is API and whose configured event (if any) matches. Idempotent under X-Idempotency-Key. Requires API-key scope: automations:write.
+     * Fire the API trigger for a contact
+     */
+    async fireApiTrigger(requestParameters, initOverrides) {
+        const response = await this.fireApiTriggerRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
     /**
      * Reads < 300ms. Requires API-key scope: automations:read.
      * Get a single automation flow

package/dist/generated/src/apis/AutomationEventApi.d.ts

@@ -0,0 +1,102 @@
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { IntegrationEventPage, IntegrationEventTypeResponse } from '../models/index';
+export interface PollRequest {
+    type?: PollTypeEnum;
+    since?: string;
+    limit?: number;
+}
+/**
+ * AutomationEventApi - interface
+ *
+ * @export
+ * @interface AutomationEventApiInterface
+ */
+export interface AutomationEventApiInterface {
+    /**
+     * Keyset-paginated and always oldest-first. Call it with no cursor to get the tail of the stream — the most recent events, which is what a trigger test screen wants — then pass the returned nextCursor as ?since= to receive everything after it, in order, with no gaps and no repeats. hasMore true means a full page came back and you should poll again now rather than wait for your next tick. A cursor that will not decode is treated as absent rather than as an error, so a stale token replayed by a paused workflow resumes at the head. Events are retained for a short window only (7 days by default). Reads < 300ms. Requires API-key scope: integrations:read.
+     * @summary Poll this workspace\'s event stream
+     * @param {'MESSAGE_DELIVERED' | 'MESSAGE_READ' | 'MESSAGE_REPLIED' | 'CAMPAIGN_COMPLETED' | 'CONTACT_OPTED_IN' | 'CONTACT_OPTED_OUT' | 'CONTACT_CREATED' | 'AGENT_ASSIGNED' | 'ORDER_CREATED' | 'ORDER_PAID' | 'IVR_CALL_COMPLETED' | 'NOTIFICATION_RAISED' | 'WA_CALL_COMPLETED' | 'WA_CALL_MISSED' | 'WA_FLOW_SUBMITTED' | 'PING'} [type]
+     * @param {string} [since]
+     * @param {number} [limit]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AutomationEventApiInterface
+     */
+    pollRaw(requestParameters: PollRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntegrationEventPage>>;
+    /**
+     * Keyset-paginated and always oldest-first. Call it with no cursor to get the tail of the stream — the most recent events, which is what a trigger test screen wants — then pass the returned nextCursor as ?since= to receive everything after it, in order, with no gaps and no repeats. hasMore true means a full page came back and you should poll again now rather than wait for your next tick. A cursor that will not decode is treated as absent rather than as an error, so a stale token replayed by a paused workflow resumes at the head. Events are retained for a short window only (7 days by default). Reads < 300ms. Requires API-key scope: integrations:read.
+     * Poll this workspace\'s event stream
+     */
+    poll(requestParameters: PollRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntegrationEventPage>;
+    /**
+     * The mapping catalogue an automation tool reads while the customer is building a trigger. Each sample is a fully-formed event of that type with plausible values, in exactly the shape a real one arrives in — so a mapping built against a sample keeps working when real events start. Static: no tenant data is read. Reads < 300ms. Requires API-key scope: integrations:read.
+     * @summary List every subscribable event type, with a sample of each
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AutomationEventApiInterface
+     */
+    typesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IntegrationEventTypeResponse>>>;
+    /**
+     * The mapping catalogue an automation tool reads while the customer is building a trigger. Each sample is a fully-formed event of that type with plausible values, in exactly the shape a real one arrives in — so a mapping built against a sample keeps working when real events start. Static: no tenant data is read. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List every subscribable event type, with a sample of each
+     */
+    types(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IntegrationEventTypeResponse>>;
+}
+/**
+ *
+ */
+export declare class AutomationEventApi extends runtime.BaseAPI implements AutomationEventApiInterface {
+    /**
+     * Keyset-paginated and always oldest-first. Call it with no cursor to get the tail of the stream — the most recent events, which is what a trigger test screen wants — then pass the returned nextCursor as ?since= to receive everything after it, in order, with no gaps and no repeats. hasMore true means a full page came back and you should poll again now rather than wait for your next tick. A cursor that will not decode is treated as absent rather than as an error, so a stale token replayed by a paused workflow resumes at the head. Events are retained for a short window only (7 days by default). Reads < 300ms. Requires API-key scope: integrations:read.
+     * Poll this workspace\'s event stream
+     */
+    pollRaw(requestParameters: PollRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntegrationEventPage>>;
+    /**
+     * Keyset-paginated and always oldest-first. Call it with no cursor to get the tail of the stream — the most recent events, which is what a trigger test screen wants — then pass the returned nextCursor as ?since= to receive everything after it, in order, with no gaps and no repeats. hasMore true means a full page came back and you should poll again now rather than wait for your next tick. A cursor that will not decode is treated as absent rather than as an error, so a stale token replayed by a paused workflow resumes at the head. Events are retained for a short window only (7 days by default). Reads < 300ms. Requires API-key scope: integrations:read.
+     * Poll this workspace\'s event stream
+     */
+    poll(requestParameters?: PollRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntegrationEventPage>;
+    /**
+     * The mapping catalogue an automation tool reads while the customer is building a trigger. Each sample is a fully-formed event of that type with plausible values, in exactly the shape a real one arrives in — so a mapping built against a sample keeps working when real events start. Static: no tenant data is read. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List every subscribable event type, with a sample of each
+     */
+    typesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IntegrationEventTypeResponse>>>;
+    /**
+     * The mapping catalogue an automation tool reads while the customer is building a trigger. Each sample is a fully-formed event of that type with plausible values, in exactly the shape a real one arrives in — so a mapping built against a sample keeps working when real events start. Static: no tenant data is read. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List every subscribable event type, with a sample of each
+     */
+    types(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IntegrationEventTypeResponse>>;
+}
+/**
+ * @export
+ */
+export declare const PollTypeEnum: {
+    readonly MessageDelivered: "MESSAGE_DELIVERED";
+    readonly MessageRead: "MESSAGE_READ";
+    readonly MessageReplied: "MESSAGE_REPLIED";
+    readonly CampaignCompleted: "CAMPAIGN_COMPLETED";
+    readonly ContactOptedIn: "CONTACT_OPTED_IN";
+    readonly ContactOptedOut: "CONTACT_OPTED_OUT";
+    readonly ContactCreated: "CONTACT_CREATED";
+    readonly AgentAssigned: "AGENT_ASSIGNED";
+    readonly OrderCreated: "ORDER_CREATED";
+    readonly OrderPaid: "ORDER_PAID";
+    readonly IvrCallCompleted: "IVR_CALL_COMPLETED";
+    readonly NotificationRaised: "NOTIFICATION_RAISED";
+    readonly WaCallCompleted: "WA_CALL_COMPLETED";
+    readonly WaCallMissed: "WA_CALL_MISSED";
+    readonly WaFlowSubmitted: "WA_FLOW_SUBMITTED";
+    readonly Ping: "PING";
+};
+export type PollTypeEnum = typeof PollTypeEnum[keyof typeof PollTypeEnum];

package/dist/generated/src/apis/AutomationEventApi.js

@@ -0,0 +1,155 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PollTypeEnum = exports.AutomationEventApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class AutomationEventApi extends runtime.BaseAPI {
+    /**
+     * Keyset-paginated and always oldest-first. Call it with no cursor to get the tail of the stream — the most recent events, which is what a trigger test screen wants — then pass the returned nextCursor as ?since= to receive everything after it, in order, with no gaps and no repeats. hasMore true means a full page came back and you should poll again now rather than wait for your next tick. A cursor that will not decode is treated as absent rather than as an error, so a stale token replayed by a paused workflow resumes at the head. Events are retained for a short window only (7 days by default). Reads < 300ms. Requires API-key scope: integrations:read.
+     * Poll this workspace\'s event stream
+     */
+    async pollRaw(requestParameters, initOverrides) {
+        const queryParameters = {};
+        if (requestParameters['type'] != null) {
+            queryParameters['type'] = requestParameters['type'];
+        }
+        if (requestParameters['since'] != null) {
+            queryParameters['since'] = requestParameters['since'];
+        }
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/integrations/events`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.IntegrationEventPageFromJSON)(jsonValue));
+    }
+    /**
+     * Keyset-paginated and always oldest-first. Call it with no cursor to get the tail of the stream — the most recent events, which is what a trigger test screen wants — then pass the returned nextCursor as ?since= to receive everything after it, in order, with no gaps and no repeats. hasMore true means a full page came back and you should poll again now rather than wait for your next tick. A cursor that will not decode is treated as absent rather than as an error, so a stale token replayed by a paused workflow resumes at the head. Events are retained for a short window only (7 days by default). Reads < 300ms. Requires API-key scope: integrations:read.
+     * Poll this workspace\'s event stream
+     */
+    async poll(requestParameters = {}, initOverrides) {
+        const response = await this.pollRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * The mapping catalogue an automation tool reads while the customer is building a trigger. Each sample is a fully-formed event of that type with plausible values, in exactly the shape a real one arrives in — so a mapping built against a sample keeps working when real events start. Static: no tenant data is read. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List every subscribable event type, with a sample of each
+     */
+    async typesRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/integrations/events/types`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.IntegrationEventTypeResponseFromJSON));
+    }
+    /**
+     * The mapping catalogue an automation tool reads while the customer is building a trigger. Each sample is a fully-formed event of that type with plausible values, in exactly the shape a real one arrives in — so a mapping built against a sample keeps working when real events start. Static: no tenant data is read. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List every subscribable event type, with a sample of each
+     */
+    async types(initOverrides) {
+        const response = await this.typesRaw(initOverrides);
+        return await response.value();
+    }
+}
+exports.AutomationEventApi = AutomationEventApi;
+/**
+ * @export
+ */
+exports.PollTypeEnum = {
+    MessageDelivered: 'MESSAGE_DELIVERED',
+    MessageRead: 'MESSAGE_READ',
+    MessageReplied: 'MESSAGE_REPLIED',
+    CampaignCompleted: 'CAMPAIGN_COMPLETED',
+    ContactOptedIn: 'CONTACT_OPTED_IN',
+    ContactOptedOut: 'CONTACT_OPTED_OUT',
+    ContactCreated: 'CONTACT_CREATED',
+    AgentAssigned: 'AGENT_ASSIGNED',
+    OrderCreated: 'ORDER_CREATED',
+    OrderPaid: 'ORDER_PAID',
+    IvrCallCompleted: 'IVR_CALL_COMPLETED',
+    NotificationRaised: 'NOTIFICATION_RAISED',
+    WaCallCompleted: 'WA_CALL_COMPLETED',
+    WaCallMissed: 'WA_CALL_MISSED',
+    WaFlowSubmitted: 'WA_FLOW_SUBMITTED',
+    Ping: 'PING'
+};

package/dist/generated/src/apis/AutomationIdentityApi.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { AutomationIdentityResponse } from '../models/index';
+/**
+ * AutomationIdentityApi - interface
+ *
+ * @export
+ * @interface AutomationIdentityApiInterface
+ */
+export interface AutomationIdentityApiInterface {
+    /**
+     * Returns the workspace this credential belongs to and the scopes it carries, so an automation tool can label the connection and grey out actions the key cannot perform. Nothing here is secret — it is the caller\'s own identity, echoed back. Reads < 300ms. Requires API-key scope: integrations:read.
+     * @summary Identify the calling credential
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AutomationIdentityApiInterface
+     */
+    meIntegrationsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutomationIdentityResponse>>;
+    /**
+     * Returns the workspace this credential belongs to and the scopes it carries, so an automation tool can label the connection and grey out actions the key cannot perform. Nothing here is secret — it is the caller\'s own identity, echoed back. Reads < 300ms. Requires API-key scope: integrations:read.
+     * Identify the calling credential
+     */
+    meIntegrations(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutomationIdentityResponse>;
+}
+/**
+ *
+ */
+export declare class AutomationIdentityApi extends runtime.BaseAPI implements AutomationIdentityApiInterface {
+    /**
+     * Returns the workspace this credential belongs to and the scopes it carries, so an automation tool can label the connection and grey out actions the key cannot perform. Nothing here is secret — it is the caller\'s own identity, echoed back. Reads < 300ms. Requires API-key scope: integrations:read.
+     * Identify the calling credential
+     */
+    meIntegrationsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutomationIdentityResponse>>;
+    /**
+     * Returns the workspace this credential belongs to and the scopes it carries, so an automation tool can label the connection and grey out actions the key cannot perform. Nothing here is secret — it is the caller\'s own identity, echoed back. Reads < 300ms. Requires API-key scope: integrations:read.
+     * Identify the calling credential
+     */
+    meIntegrations(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutomationIdentityResponse>;
+}