@augstash/sdk 0.2.0 → 0.3.0

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

@@ -0,0 +1,176 @@
+"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.IntegrationConnectionApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class IntegrationConnectionApi extends runtime.BaseAPI {
+    /**
+     * Idempotent: 204 whether or not a connection existed. Revokes the grant upstream where the vendor supports it, and clears whatever the connector stored of its own. Data already imported is kept — it is the customer\'s history, not the connector\'s. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * Disconnect the tenant from one vendor
+     */
+    async disconnectIntegrationsRaw(requestParameters, initOverrides) {
+        if (requestParameters['vendor'] == null) {
+            throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling disconnectIntegrations().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        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/integrations/{vendor}`;
+        urlPath = urlPath.replace(`{${"vendor"}}`, encodeURIComponent(String(requestParameters['vendor'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Idempotent: 204 whether or not a connection existed. Revokes the grant upstream where the vendor supports it, and clears whatever the connector stored of its own. Data already imported is kept — it is the customer\'s history, not the connector\'s. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * Disconnect the tenant from one vendor
+     */
+    async disconnectIntegrations(requestParameters, initOverrides) {
+        await this.disconnectIntegrationsRaw(requestParameters, initOverrides);
+    }
+    /**
+     * Never returns a credential value — credentialKeys carries the stored credential\'s field NAMES only. Reads < 300ms. Requires API-key scope: integrations:read.
+     * Get the tenant\'s connection to one vendor
+     */
+    async getIntegrationsRaw(requestParameters, initOverrides) {
+        if (requestParameters['vendor'] == null) {
+            throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling getIntegrations().');
+        }
+        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/{vendor}`;
+        urlPath = urlPath.replace(`{${"vendor"}}`, encodeURIComponent(String(requestParameters['vendor'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.IntegrationConnectionResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Never returns a credential value — credentialKeys carries the stored credential\'s field NAMES only. Reads < 300ms. Requires API-key scope: integrations:read.
+     * Get the tenant\'s connection to one vendor
+     */
+    async getIntegrations(requestParameters, initOverrides) {
+        const response = await this.getIntegrationsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Asks the vendor now and records the verdict. A vendor that refuses or does not answer is reported as status DEGRADED (or REVOKED, when the credential itself is finished) with a lastErrorCode — not as an error response. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * Re-check the tenant\'s connection to one vendor
+     */
+    async healthIntegrationsRaw(requestParameters, initOverrides) {
+        if (requestParameters['vendor'] == null) {
+            throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling healthIntegrations().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        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/integrations/{vendor}/health`;
+        urlPath = urlPath.replace(`{${"vendor"}}`, encodeURIComponent(String(requestParameters['vendor'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.IntegrationConnectionResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Asks the vendor now and records the verdict. A vendor that refuses or does not answer is reported as status DEGRADED (or REVOKED, when the credential itself is finished) with a lastErrorCode — not as an error response. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * Re-check the tenant\'s connection to one vendor
+     */
+    async healthIntegrations(requestParameters, initOverrides) {
+        const response = await this.healthIntegrationsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+exports.IntegrationConnectionApi = IntegrationConnectionApi;

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

@@ -58,7 +58,7 @@ export interface MessageAnalyticsApiInterface {
      */
     exportAnalytics(requestParameters: ExportAnalyticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
     /**
-     * Reads < 300ms.
+     * Reads < 300ms. Requires API-key scope: analytics:read.
      * @summary List every message\'s current delivery state
      * @param {Pageable} pageable
      * @param {string} [contactId]
@@ -73,7 +73,7 @@ export interface MessageAnalyticsApiInterface {
      */
     listAnalyticsMessagesRaw(requestParameters: ListAnalyticsMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseMessageDeliveryLogResponse>>;
     /**
-     * Reads < 300ms.
+     * Reads < 300ms. Requires API-key scope: analytics:read.
      * List every message\'s current delivery state
      */
     listAnalyticsMessages(requestParameters: ListAnalyticsMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseMessageDeliveryLogResponse>;
@@ -107,12 +107,12 @@ export declare class MessageAnalyticsApi extends runtime.BaseAPI implements Mess
      */
     exportAnalytics(requestParameters?: ExportAnalyticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
     /**
-     * Reads < 300ms.
+     * Reads < 300ms. Requires API-key scope: analytics:read.
      * List every message\'s current delivery state
      */
     listAnalyticsMessagesRaw(requestParameters: ListAnalyticsMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseMessageDeliveryLogResponse>>;
     /**
-     * Reads < 300ms.
+     * Reads < 300ms. Requires API-key scope: analytics:read.
      * List every message\'s current delivery state
      */
     listAnalyticsMessages(requestParameters: ListAnalyticsMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseMessageDeliveryLogResponse>;

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

@@ -111,7 +111,7 @@ class MessageAnalyticsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Reads < 300ms.
+     * Reads < 300ms. Requires API-key scope: analytics:read.
      * List every message\'s current delivery state
      */
     async listAnalyticsMessagesRaw(requestParameters, initOverrides) {
@@ -161,7 +161,7 @@ class MessageAnalyticsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PageResponseMessageDeliveryLogResponseFromJSON)(jsonValue));
     }
     /**
-     * Reads < 300ms.
+     * Reads < 300ms. Requires API-key scope: analytics:read.
      * List every message\'s current delivery state
      */
     async listAnalyticsMessages(requestParameters, initOverrides) {