@augstash/sdk 0.2.0 → 0.3.0

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

@@ -0,0 +1,312 @@
+"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.ScimUserApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class ScimUserApi extends runtime.BaseAPI {
+    /**
+     * Writes < 300ms. userName must be an email (or emails[] must carry one). The user is created passwordless, provider SAML, with the connection\'s default role; active=false creates them already deactivated. An email that exists anywhere — this workspace or another — is 409 uniqueness. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: create a user
+     */
+    async createScimRaw(requestParameters, initOverrides) {
+        if (requestParameters['scimUserResource'] == null) {
+            throw new runtime.RequiredError('scimUserResource', 'Required parameter "scimUserResource" was null or undefined when calling createScim().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/scim+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 = `/scim/v2/Users`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.ScimUserResourceToJSON)(requestParameters['scimUserResource']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScimUserResourceFromJSON)(jsonValue));
+    }
+    /**
+     * Writes < 300ms. userName must be an email (or emails[] must carry one). The user is created passwordless, provider SAML, with the connection\'s default role; active=false creates them already deactivated. An email that exists anywhere — this workspace or another — is 409 uniqueness. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: create a user
+     */
+    async createScim(requestParameters, initOverrides) {
+        const response = await this.createScimRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Writes < 300ms. Deactivates (status INACTIVE) rather than erasing: sign-in and token refresh are refused from now on, and everything the person did stays attributed to them. Erasure is a governed act with its own retention rules (governance.deletion), never a side effect of a directory sync. Idempotent. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: deprovision a user
+     */
+    async deleteScimRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteScim().');
+        }
+        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 = `/scim/v2/Users/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Writes < 300ms. Deactivates (status INACTIVE) rather than erasing: sign-in and token refresh are refused from now on, and everything the person did stays attributed to them. Erasure is a governed act with its own retention rules (governance.deletion), never a side effect of a directory sync. Idempotent. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: deprovision a user
+     */
+    async deleteScim(requestParameters, initOverrides) {
+        await this.deleteScimRaw(requestParameters, initOverrides);
+    }
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: get a user
+     */
+    async getScimRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getScim().');
+        }
+        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 = `/scim/v2/Users/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScimUserResourceFromJSON)(jsonValue));
+    }
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: get a user
+     */
+    async getScim(requestParameters, initOverrides) {
+        const response = await this.getScimRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Reads < 300ms. Supports filter=userName eq \"…\", externalId eq \"…\" and id eq \"…\" (the lookups provisioning engines make before creating), plus startIndex / count paging (max 200) with no filter. Any other filter is 400 invalidFilter rather than silently wrong. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: list or filter users
+     */
+    async listScimRaw(requestParameters, initOverrides) {
+        const queryParameters = {};
+        if (requestParameters['filter'] != null) {
+            queryParameters['filter'] = requestParameters['filter'];
+        }
+        if (requestParameters['startIndex'] != null) {
+            queryParameters['startIndex'] = requestParameters['startIndex'];
+        }
+        if (requestParameters['count'] != null) {
+            queryParameters['count'] = requestParameters['count'];
+        }
+        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 = `/scim/v2/Users`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListResponseScimUserResourceFromJSON)(jsonValue));
+    }
+    /**
+     * Reads < 300ms. Supports filter=userName eq \"…\", externalId eq \"…\" and id eq \"…\" (the lookups provisioning engines make before creating), plus startIndex / count paging (max 200) with no filter. Any other filter is 400 invalidFilter rather than silently wrong. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: list or filter users
+     */
+    async listScim(requestParameters = {}, initOverrides) {
+        const response = await this.listScimRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Writes < 300ms. add / replace / remove on active, externalId, displayName, name (and its parts), userName / emails (must equal the current email). Both spellings are accepted: Okta\'s pathless {\"value\": {\"active\": false}} and Entra\'s {\"path\": \"active\", \"value\": \"False\"}. Paths this service has no column for are ignored, not refused — an Entra sync must not fail on \'department\'. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: patch a user
+     */
+    async patchScimRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling patchScim().');
+        }
+        if (requestParameters['patchRequest'] == null) {
+            throw new runtime.RequiredError('patchRequest', 'Required parameter "patchRequest" was null or undefined when calling patchScim().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/scim+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 = `/scim/v2/Users/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.PatchRequestToJSON)(requestParameters['patchRequest']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScimUserResourceFromJSON)(jsonValue));
+    }
+    /**
+     * Writes < 300ms. add / replace / remove on active, externalId, displayName, name (and its parts), userName / emails (must equal the current email). Both spellings are accepted: Okta\'s pathless {\"value\": {\"active\": false}} and Entra\'s {\"path\": \"active\", \"value\": \"False\"}. Paths this service has no column for are ignored, not refused — an Entra sync must not fail on \'department\'. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: patch a user
+     */
+    async patchScim(requestParameters, initOverrides) {
+        const response = await this.patchScimRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Writes < 300ms. Name, externalId and active are replaced; userName must equal the current email (it is the login identifier and cannot change through SCIM). Workspace owners are 403 SCIM_PROTECTED_USER. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: replace a user
+     */
+    async replaceScimRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling replaceScim().');
+        }
+        if (requestParameters['scimUserResource'] == null) {
+            throw new runtime.RequiredError('scimUserResource', 'Required parameter "scimUserResource" was null or undefined when calling replaceScim().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/scim+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 = `/scim/v2/Users/{id}`;
+        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.ScimUserResourceToJSON)(requestParameters['scimUserResource']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScimUserResourceFromJSON)(jsonValue));
+    }
+    /**
+     * Writes < 300ms. Name, externalId and active are replaced; userName must equal the current email (it is the login identifier and cannot change through SCIM). Workspace owners are 403 SCIM_PROTECTED_USER. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: replace a user
+     */
+    async replaceScim(requestParameters, initOverrides) {
+        const response = await this.replaceScimRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+exports.ScimUserApi = ScimUserApi;

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

@@ -414,7 +414,7 @@ export interface SettingsApiInterface {
     /**
      * Writes < 300ms. Requires API-key scope: notifications:write.
      * @summary Update the caller\'s own notification preference for one event type
-     * @param {'WALLET_LOW_BALANCE' | 'TOPUP_SUCCEEDED' | 'TOPUP_FAILED' | 'BUDGET_EXCEEDED' | 'SENDS_PAUSED_NO_FUNDS' | 'QUALITY_DOWNGRADED' | 'LIMIT_TIER_CHANGED' | 'NUMBER_FLAGGED' | 'TEMPLATE_APPROVED' | 'TEMPLATE_REJECTED' | 'WABA_DISCONNECTED' | 'WABA_REAUTH_REQUIRED' | 'BROADCAST_STARTED' | 'BROADCAST_FINISHED' | 'FLOW_ERROR' | 'ABTEST_WINNER_READY' | 'SCHEDULE_REMINDER' | 'CONVERSATION_ASSIGNED' | 'NOTE_MENTION' | 'SLA_BREACH' | 'QUEUE_BACKLOG' | 'BOT_HANDOFF_REQUESTED' | 'INBOX_MESSAGE_RECEIVED' | 'IVR_CALLBACK_REQUESTED' | 'ORDER_RECEIVED' | 'PAYMENT_RECEIVED' | 'ORDER_STATUS_CHANGED' | 'CART_ABANDONED' | 'INVOICE_ISSUED' | 'INVOICE_PAYMENT_FAILED' | 'VERIFICATION_DECISION' | 'GREENTICK_DECISION' | 'DOMAIN_VERIFIED' | 'SYNC_FAILED' | 'INVITE_ACCEPTED' | 'ROLE_CHANGED' | 'APPROVAL_PENDING' | 'CHANNEL_DELIVERY_FAILED' | 'CHANNEL_FALLBACK_USED' | 'DLT_REGISTRATION_EXPIRING' | 'DATA_EXPORT_READY' | 'API_KEY_IP_BLOCKED' | 'API_KEY_LEAK_DETECTED' | 'API_KEY_ANOMALY_DETECTED'} eventType
+     * @param {'WALLET_LOW_BALANCE' | 'TOPUP_SUCCEEDED' | 'TOPUP_FAILED' | 'BUDGET_EXCEEDED' | 'SENDS_PAUSED_NO_FUNDS' | 'QUALITY_DOWNGRADED' | 'LIMIT_TIER_CHANGED' | 'NUMBER_FLAGGED' | 'TEMPLATE_APPROVED' | 'TEMPLATE_REJECTED' | 'WABA_DISCONNECTED' | 'WABA_REAUTH_REQUIRED' | 'BROADCAST_STARTED' | 'BROADCAST_FINISHED' | 'FLOW_ERROR' | 'ABTEST_WINNER_READY' | 'SCHEDULE_REMINDER' | 'CONVERSATION_ASSIGNED' | 'NOTE_MENTION' | 'SLA_BREACH' | 'QUEUE_BACKLOG' | 'BOT_HANDOFF_REQUESTED' | 'INBOX_MESSAGE_RECEIVED' | 'IVR_CALLBACK_REQUESTED' | 'CALL_MISSED' | 'ORDER_RECEIVED' | 'PAYMENT_RECEIVED' | 'ORDER_STATUS_CHANGED' | 'CART_ABANDONED' | 'INVOICE_ISSUED' | 'INVOICE_PAYMENT_FAILED' | 'VERIFICATION_DECISION' | 'GREENTICK_DECISION' | 'DOMAIN_VERIFIED' | 'SYNC_FAILED' | 'INVITE_ACCEPTED' | 'ROLE_CHANGED' | 'APPROVAL_PENDING' | 'CHANNEL_DELIVERY_FAILED' | 'CHANNEL_FALLBACK_USED' | 'DLT_REGISTRATION_EXPIRING' | 'DATA_EXPORT_READY' | 'INTEGRATION_DEGRADED' | 'API_KEY_IP_BLOCKED' | 'API_KEY_LEAK_DETECTED' | 'API_KEY_ANOMALY_DETECTED' | 'PLAN_LIMIT_WARNING'} eventType
      * @param {UpdateNotificationPreferenceRequest} updateNotificationPreferenceRequest
      * @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.
@@ -761,6 +761,7 @@ export declare const UpdateNotificationEventTypeEnum: {
     readonly BotHandoffRequested: "BOT_HANDOFF_REQUESTED";
     readonly InboxMessageReceived: "INBOX_MESSAGE_RECEIVED";
     readonly IvrCallbackRequested: "IVR_CALLBACK_REQUESTED";
+    readonly CallMissed: "CALL_MISSED";
     readonly OrderReceived: "ORDER_RECEIVED";
     readonly PaymentReceived: "PAYMENT_RECEIVED";
     readonly OrderStatusChanged: "ORDER_STATUS_CHANGED";
@@ -778,8 +779,10 @@ export declare const UpdateNotificationEventTypeEnum: {
     readonly ChannelFallbackUsed: "CHANNEL_FALLBACK_USED";
     readonly DltRegistrationExpiring: "DLT_REGISTRATION_EXPIRING";
     readonly DataExportReady: "DATA_EXPORT_READY";
+    readonly IntegrationDegraded: "INTEGRATION_DEGRADED";
     readonly ApiKeyIpBlocked: "API_KEY_IP_BLOCKED";
     readonly ApiKeyLeakDetected: "API_KEY_LEAK_DETECTED";
     readonly ApiKeyAnomalyDetected: "API_KEY_ANOMALY_DETECTED";
+    readonly PlanLimitWarning: "PLAN_LIMIT_WARNING";
 };
 export type UpdateNotificationEventTypeEnum = typeof UpdateNotificationEventTypeEnum[keyof typeof UpdateNotificationEventTypeEnum];

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

@@ -1109,6 +1109,7 @@ exports.UpdateNotificationEventTypeEnum = {
     BotHandoffRequested: 'BOT_HANDOFF_REQUESTED',
     InboxMessageReceived: 'INBOX_MESSAGE_RECEIVED',
     IvrCallbackRequested: 'IVR_CALLBACK_REQUESTED',
+    CallMissed: 'CALL_MISSED',
     OrderReceived: 'ORDER_RECEIVED',
     PaymentReceived: 'PAYMENT_RECEIVED',
     OrderStatusChanged: 'ORDER_STATUS_CHANGED',
@@ -1126,7 +1127,9 @@ exports.UpdateNotificationEventTypeEnum = {
     ChannelFallbackUsed: 'CHANNEL_FALLBACK_USED',
     DltRegistrationExpiring: 'DLT_REGISTRATION_EXPIRING',
     DataExportReady: 'DATA_EXPORT_READY',
+    IntegrationDegraded: 'INTEGRATION_DEGRADED',
     ApiKeyIpBlocked: 'API_KEY_IP_BLOCKED',
     ApiKeyLeakDetected: 'API_KEY_LEAK_DETECTED',
-    ApiKeyAnomalyDetected: 'API_KEY_ANOMALY_DETECTED'
+    ApiKeyAnomalyDetected: 'API_KEY_ANOMALY_DETECTED',
+    PlanLimitWarning: 'PLAN_LIMIT_WARNING'
 };

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

@@ -0,0 +1,200 @@
+/**
+ * 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 { CarrierConnectionResponse, ConnectCarrierRequest, CursorPageShipmentSummaryResponse, ShipmentResponse, StopTrackingResponse, TrackShipmentRequest } from '../models/index';
+export interface ConnectIntegrationsShipmentsRequest {
+    carrier: string;
+    connectCarrierRequest: ConnectCarrierRequest;
+    xIdempotencyKey?: string;
+}
+export interface GetIntegrationsShipmentsRequest {
+    id: string;
+}
+export interface ListIntegrationsRequest {
+    orderId?: string;
+    carrier?: string;
+    status?: string;
+    cursor?: string;
+    limit?: number;
+}
+export interface StopTrackingRequest {
+    id: string;
+    xIdempotencyKey?: string;
+}
+export interface TrackRequest {
+    trackShipmentRequest: TrackShipmentRequest;
+    xIdempotencyKey?: string;
+}
+/**
+ * ShipmentApi - interface
+ *
+ * @export
+ * @interface ShipmentApiInterface
+ */
+export interface ShipmentApiInterface {
+    /**
+     * Health comes from the shared connection substrate, so a carrier\'s status here always matches GET /api/v1/integrations/{vendor}. Never returns a credential, and never returns the webhook URL -- that is shown once, at connect. Reads < 300ms. Requires API-key scope: integrations:read.
+     * @summary List every shipment carrier and whether this tenant has connected it
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ShipmentApiInterface
+     */
+    carriersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CarrierConnectionResponse>>>;
+    /**
+     * Health comes from the shared connection substrate, so a carrier\'s status here always matches GET /api/v1/integrations/{vendor}. Never returns a credential, and never returns the webhook URL -- that is shown once, at connect. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List every shipment carrier and whether this tenant has connected it
+     */
+    carriers(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CarrierConnectionResponse>>;
+    /**
+     * Verifies the credentials against the carrier before storing them, so a bad key is refused here rather than discovered later. Credentials are encrypted at rest and are never returned by any endpoint. The response carries the webhook URL to register with the carrier -- it embeds a live credential and is shown ONCE; reconnecting mints a new one and retires the old. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * @summary Connect a shipment carrier for this tenant
+     * @param {string} carrier
+     * @param {ConnectCarrierRequest} connectCarrierRequest
+     * @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 ShipmentApiInterface
+     */
+    connectIntegrationsShipmentsRaw(requestParameters: ConnectIntegrationsShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CarrierConnectionResponse>>;
+    /**
+     * Verifies the credentials against the carrier before storing them, so a bad key is refused here rather than discovered later. Credentials are encrypted at rest and are never returned by any endpoint. The response carries the webhook URL to register with the carrier -- it embeds a live credential and is shown ONCE; reconnecting mints a new one and retires the old. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * Connect a shipment carrier for this tenant
+     */
+    connectIntegrationsShipments(requestParameters: ConnectIntegrationsShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CarrierConnectionResponse>;
+    /**
+     * status is the normalised vocabulary and is what to branch on; each event also carries the carrier\'s own label for display. History is newest first and is short by nature -- a parcel has a handful of scans, not a page of them. Reads < 300ms. Requires API-key scope: integrations:read.
+     * @summary Get one tracked shipment and its scan history
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ShipmentApiInterface
+     */
+    getIntegrationsShipmentsRaw(requestParameters: GetIntegrationsShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShipmentResponse>>;
+    /**
+     * status is the normalised vocabulary and is what to branch on; each event also carries the carrier\'s own label for display. History is newest first and is short by nature -- a parcel has a handful of scans, not a page of them. Reads < 300ms. Requires API-key scope: integrations:read.
+     * Get one tracked shipment and its scan history
+     */
+    getIntegrationsShipments(requestParameters: GetIntegrationsShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShipmentResponse>;
+    /**
+     * Cursor-paginated, newest first by when tracking started here -- pass the previous response\'s nextCursor as ?cursor=; there is no page number and no total (AS-CODE-010). Filter by orderId to answer \"where are this order\'s parcels\", by status to find what is stuck, by carrier to see whether one is reporting. Rows carry each parcel\'s current state and no scan history: fetch GET /{id} for the history of one, which keeps this endpoint\'s cost independent of how often carriers scanned. Reads < 300ms. Requires API-key scope: integrations:read.
+     * @summary List tracked parcels
+     * @param {string} [orderId]
+     * @param {string} [carrier]
+     * @param {string} [status]
+     * @param {string} [cursor]
+     * @param {number} [limit]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ShipmentApiInterface
+     */
+    listIntegrationsRaw(requestParameters: ListIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CursorPageShipmentSummaryResponse>>;
+    /**
+     * Cursor-paginated, newest first by when tracking started here -- pass the previous response\'s nextCursor as ?cursor=; there is no page number and no total (AS-CODE-010). Filter by orderId to answer \"where are this order\'s parcels\", by status to find what is stuck, by carrier to see whether one is reporting. Rows carry each parcel\'s current state and no scan history: fetch GET /{id} for the history of one, which keeps this endpoint\'s cost independent of how often carriers scanned. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List tracked parcels
+     */
+    listIntegrations(requestParameters: ListIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CursorPageShipmentSummaryResponse>;
+    /**
+     * Removes the parcel and its scan history, so no further status message is sent for it. Use this to correct a mistyped tracking number: the same number can be attached again immediately afterwards, which a stopped-but-kept row would refuse. Where the carrier supports unsubscribing -- EasyPost alone of the four -- it is also told, and carrierNotified says whether that succeeded; for the others their scans keep arriving and are dropped on receipt. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * @summary Stop tracking one parcel
+     * @param {string} id
+     * @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 ShipmentApiInterface
+     */
+    stopTrackingRaw(requestParameters: StopTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StopTrackingResponse>>;
+    /**
+     * Removes the parcel and its scan history, so no further status message is sent for it. Use this to correct a mistyped tracking number: the same number can be attached again immediately afterwards, which a stopped-but-kept row would refuse. Where the carrier supports unsubscribing -- EasyPost alone of the four -- it is also told, and carrierNotified says whether that succeeded; for the others their scans keep arriving and are dropped on receipt. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * Stop tracking one parcel
+     */
+    stopTracking(requestParameters: StopTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StopTrackingResponse>;
+    /**
+     * Registers the number with the carrier and starts turning its scans into customer messages, using the tenant\'s existing order-notification rules. The order must belong to this tenant. One order may have several shipments -- a split consignment notifies per parcel. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * @summary Attach a tracking number to an order
+     * @param {TrackShipmentRequest} trackShipmentRequest
+     * @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 ShipmentApiInterface
+     */
+    trackRaw(requestParameters: TrackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShipmentResponse>>;
+    /**
+     * Registers the number with the carrier and starts turning its scans into customer messages, using the tenant\'s existing order-notification rules. The order must belong to this tenant. One order may have several shipments -- a split consignment notifies per parcel. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * Attach a tracking number to an order
+     */
+    track(requestParameters: TrackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShipmentResponse>;
+}
+/**
+ *
+ */
+export declare class ShipmentApi extends runtime.BaseAPI implements ShipmentApiInterface {
+    /**
+     * Health comes from the shared connection substrate, so a carrier\'s status here always matches GET /api/v1/integrations/{vendor}. Never returns a credential, and never returns the webhook URL -- that is shown once, at connect. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List every shipment carrier and whether this tenant has connected it
+     */
+    carriersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CarrierConnectionResponse>>>;
+    /**
+     * Health comes from the shared connection substrate, so a carrier\'s status here always matches GET /api/v1/integrations/{vendor}. Never returns a credential, and never returns the webhook URL -- that is shown once, at connect. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List every shipment carrier and whether this tenant has connected it
+     */
+    carriers(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CarrierConnectionResponse>>;
+    /**
+     * Verifies the credentials against the carrier before storing them, so a bad key is refused here rather than discovered later. Credentials are encrypted at rest and are never returned by any endpoint. The response carries the webhook URL to register with the carrier -- it embeds a live credential and is shown ONCE; reconnecting mints a new one and retires the old. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * Connect a shipment carrier for this tenant
+     */
+    connectIntegrationsShipmentsRaw(requestParameters: ConnectIntegrationsShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CarrierConnectionResponse>>;
+    /**
+     * Verifies the credentials against the carrier before storing them, so a bad key is refused here rather than discovered later. Credentials are encrypted at rest and are never returned by any endpoint. The response carries the webhook URL to register with the carrier -- it embeds a live credential and is shown ONCE; reconnecting mints a new one and retires the old. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * Connect a shipment carrier for this tenant
+     */
+    connectIntegrationsShipments(requestParameters: ConnectIntegrationsShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CarrierConnectionResponse>;
+    /**
+     * status is the normalised vocabulary and is what to branch on; each event also carries the carrier\'s own label for display. History is newest first and is short by nature -- a parcel has a handful of scans, not a page of them. Reads < 300ms. Requires API-key scope: integrations:read.
+     * Get one tracked shipment and its scan history
+     */
+    getIntegrationsShipmentsRaw(requestParameters: GetIntegrationsShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShipmentResponse>>;
+    /**
+     * status is the normalised vocabulary and is what to branch on; each event also carries the carrier\'s own label for display. History is newest first and is short by nature -- a parcel has a handful of scans, not a page of them. Reads < 300ms. Requires API-key scope: integrations:read.
+     * Get one tracked shipment and its scan history
+     */
+    getIntegrationsShipments(requestParameters: GetIntegrationsShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShipmentResponse>;
+    /**
+     * Cursor-paginated, newest first by when tracking started here -- pass the previous response\'s nextCursor as ?cursor=; there is no page number and no total (AS-CODE-010). Filter by orderId to answer \"where are this order\'s parcels\", by status to find what is stuck, by carrier to see whether one is reporting. Rows carry each parcel\'s current state and no scan history: fetch GET /{id} for the history of one, which keeps this endpoint\'s cost independent of how often carriers scanned. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List tracked parcels
+     */
+    listIntegrationsRaw(requestParameters: ListIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CursorPageShipmentSummaryResponse>>;
+    /**
+     * Cursor-paginated, newest first by when tracking started here -- pass the previous response\'s nextCursor as ?cursor=; there is no page number and no total (AS-CODE-010). Filter by orderId to answer \"where are this order\'s parcels\", by status to find what is stuck, by carrier to see whether one is reporting. Rows carry each parcel\'s current state and no scan history: fetch GET /{id} for the history of one, which keeps this endpoint\'s cost independent of how often carriers scanned. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List tracked parcels
+     */
+    listIntegrations(requestParameters?: ListIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CursorPageShipmentSummaryResponse>;
+    /**
+     * Removes the parcel and its scan history, so no further status message is sent for it. Use this to correct a mistyped tracking number: the same number can be attached again immediately afterwards, which a stopped-but-kept row would refuse. Where the carrier supports unsubscribing -- EasyPost alone of the four -- it is also told, and carrierNotified says whether that succeeded; for the others their scans keep arriving and are dropped on receipt. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * Stop tracking one parcel
+     */
+    stopTrackingRaw(requestParameters: StopTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StopTrackingResponse>>;
+    /**
+     * Removes the parcel and its scan history, so no further status message is sent for it. Use this to correct a mistyped tracking number: the same number can be attached again immediately afterwards, which a stopped-but-kept row would refuse. Where the carrier supports unsubscribing -- EasyPost alone of the four -- it is also told, and carrierNotified says whether that succeeded; for the others their scans keep arriving and are dropped on receipt. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * Stop tracking one parcel
+     */
+    stopTracking(requestParameters: StopTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StopTrackingResponse>;
+    /**
+     * Registers the number with the carrier and starts turning its scans into customer messages, using the tenant\'s existing order-notification rules. The order must belong to this tenant. One order may have several shipments -- a split consignment notifies per parcel. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * Attach a tracking number to an order
+     */
+    trackRaw(requestParameters: TrackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShipmentResponse>>;
+    /**
+     * Registers the number with the carrier and starts turning its scans into customer messages, using the tenant\'s existing order-notification rules. The order must belong to this tenant. One order may have several shipments -- a split consignment notifies per parcel. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * Attach a tracking number to an order
+     */
+    track(requestParameters: TrackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShipmentResponse>;
+}