@augstash/sdk 0.2.0 → 0.3.0

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

@@ -0,0 +1,352 @@
+"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.ContactSyncApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class ContactSyncApi extends runtime.BaseAPI {
+    /**
+     * Both take a private API key the customer generates in their own account, as credentials.apiKey, and it is verified against the vendor before it is stored. A Mailchimp key must keep its datacenter suffix (ending -us14): that suffix is the API hostname, so a key without one is refused before any call is made. Credentials are encrypted at rest and are never returned by any endpoint. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * Connect Klaviyo or Mailchimp for this tenant
+     */
+    async connectIntegrationsContactsyncRaw(requestParameters, initOverrides) {
+        if (requestParameters['vendor'] == null) {
+            throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling connectIntegrationsContactsync().');
+        }
+        if (requestParameters['connectContactSyncRequest'] == null) {
+            throw new runtime.RequiredError('connectContactSyncRequest', 'Required parameter "connectContactSyncRequest" was null or undefined when calling connectIntegrationsContactsync().');
+        }
+        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/integrations/contact-sync/{vendor}`;
+        urlPath = urlPath.replace(`{${"vendor"}}`, encodeURIComponent(String(requestParameters['vendor'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.ConnectContactSyncRequestToJSON)(requestParameters['connectContactSyncRequest']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ContactSyncVendorResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Both take a private API key the customer generates in their own account, as credentials.apiKey, and it is verified against the vendor before it is stored. A Mailchimp key must keep its datacenter suffix (ending -us14): that suffix is the API hostname, so a key without one is refused before any call is made. Credentials are encrypted at rest and are never returned by any endpoint. Vendor round-trips < 2s. Requires API-key scope: integrations:write.
+     * Connect Klaviyo or Mailchimp for this tenant
+     */
+    async connectIntegrationsContactsync(requestParameters, initOverrides) {
+        const response = await this.connectIntegrationsContactsyncRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Every member imported from this list carries the tag, which makes the audience usable by every segment, campaign and report that already understands tags. pullEnabled defaults true. pushEnabled defaults FALSE and must be asked for: it writes into the customer\'s own marketing audience, and only contacts opted in to email here are ever sent. The vendor must already be connected. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Map one vendor list to an Augstash tag
+     */
+    async createMappingRaw(requestParameters, initOverrides) {
+        if (requestParameters['vendor'] == null) {
+            throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling createMapping().');
+        }
+        if (requestParameters['listId'] == null) {
+            throw new runtime.RequiredError('listId', 'Required parameter "listId" was null or undefined when calling createMapping().');
+        }
+        if (requestParameters['upsertListMappingRequest'] == null) {
+            throw new runtime.RequiredError('upsertListMappingRequest', 'Required parameter "upsertListMappingRequest" was null or undefined when calling createMapping().');
+        }
+        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/integrations/contact-sync/{vendor}/lists/{listId}/mapping`;
+        urlPath = urlPath.replace(`{${"vendor"}}`, encodeURIComponent(String(requestParameters['vendor'])));
+        urlPath = urlPath.replace(`{${"listId"}}`, encodeURIComponent(String(requestParameters['listId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.UpsertListMappingRequestToJSON)(requestParameters['upsertListMappingRequest']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ContactSyncListResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Every member imported from this list carries the tag, which makes the audience usable by every segment, campaign and report that already understands tags. pullEnabled defaults true. pushEnabled defaults FALSE and must be asked for: it writes into the customer\'s own marketing audience, and only contacts opted in to email here are ever sent. The vendor must already be connected. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Map one vendor list to an Augstash tag
+     */
+    async createMapping(requestParameters, initOverrides) {
+        const response = await this.createMappingRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Deletes the mapping only. The tag stays on the contacts it applied — it is the tenant\'s own label and may have been applied by an import or by hand, so removing it would be deleting somebody else\'s data to tidy up after ourselves. Contacts, consent records and identity links are untouched; disconnecting the vendor through DELETE /api/v1/integrations/{vendor} clears the links. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Stop syncing one list
+     */
+    async deleteMappingRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteMapping().');
+        }
+        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/contact-sync/mappings/{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);
+    }
+    /**
+     * Deletes the mapping only. The tag stays on the contacts it applied — it is the tenant\'s own label and may have been applied by an import or by hand, so removing it would be deleting somebody else\'s data to tidy up after ourselves. Contacts, consent records and identity links are untouched; disconnecting the vendor through DELETE /api/v1/integrations/{vendor} clears the links. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Stop syncing one list
+     */
+    async deleteMapping(requestParameters, initOverrides) {
+        await this.deleteMappingRaw(requestParameters, initOverrides);
+    }
+    /**
+     * One collection, not two: every list the account holds, with mappingId non-null on the ones this tenant has mapped. A mapped list the vendor no longer reports is still included — that is the only signal that a mapping is importing nobody because the list was deleted upstream, which otherwise looks identical to a quiet list. memberCount is what the vendor reports and may be null. Vendor round-trips < 2s. Requires API-key scope: integrations:read.
+     * List this vendor\'s lists and segments, with this tenant\'s mappings marked
+     */
+    async listsRaw(requestParameters, initOverrides) {
+        if (requestParameters['vendor'] == null) {
+            throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling lists().');
+        }
+        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/contact-sync/{vendor}/lists`;
+        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) => jsonValue.map(index_1.ContactSyncListResponseFromJSON));
+    }
+    /**
+     * One collection, not two: every list the account holds, with mappingId non-null on the ones this tenant has mapped. A mapped list the vendor no longer reports is still included — that is the only signal that a mapping is importing nobody because the list was deleted upstream, which otherwise looks identical to a quiet list. memberCount is what the vendor reports and may be null. Vendor round-trips < 2s. Requires API-key scope: integrations:read.
+     * List this vendor\'s lists and segments, with this tenant\'s mappings marked
+     */
+    async lists(requestParameters, initOverrides) {
+        const response = await this.listsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Pulls every mapped list, decides each contact\'s EMAIL consent from everything it saw, pushes contacts into any list with push enabled, then propagates Augstash email opt-outs upstream. An email subscription is recorded as EMAIL consent and never as consent on any other channel. Bounded per run, so a large first import arrives over several syncs and each resumes where the last stopped. Runs synchronously and returns what it did, which is why this is the longest budget in the API and is bounded rather than open-ended: < 60s. Requires API-key scope: integrations:write.
+     * Run this tenant\'s sync with one marketing tool now
+     */
+    async syncNowIntegrationsContactsyncRaw(requestParameters, initOverrides) {
+        if (requestParameters['vendor'] == null) {
+            throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling syncNowIntegrationsContactsync().');
+        }
+        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/contact-sync/{vendor}/sync`;
+        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.ContactSyncRunResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Pulls every mapped list, decides each contact\'s EMAIL consent from everything it saw, pushes contacts into any list with push enabled, then propagates Augstash email opt-outs upstream. An email subscription is recorded as EMAIL consent and never as consent on any other channel. Bounded per run, so a large first import arrives over several syncs and each resumes where the last stopped. Runs synchronously and returns what it did, which is why this is the longest budget in the API and is bounded rather than open-ended: < 60s. Requires API-key scope: integrations:write.
+     * Run this tenant\'s sync with one marketing tool now
+     */
+    async syncNowIntegrationsContactsync(requestParameters, initOverrides) {
+        const response = await this.syncNowIntegrationsContactsyncRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * A genuine partial update: send only the fields to change. Pausing an import is {\"pullEnabled\": false}, and because the two direction flags are independent it does not disturb a push somebody else turned on. The list is immutable — changing it would be a different mapping and would slip past the uniqueness check a create is subject to. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Retag or pause one list mapping
+     */
+    async updateMappingRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling updateMapping().');
+        }
+        if (requestParameters['upsertListMappingRequest'] == null) {
+            throw new runtime.RequiredError('upsertListMappingRequest', 'Required parameter "upsertListMappingRequest" was null or undefined when calling updateMapping().');
+        }
+        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/integrations/contact-sync/mappings/{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.UpsertListMappingRequestToJSON)(requestParameters['upsertListMappingRequest']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ContactSyncListResponseFromJSON)(jsonValue));
+    }
+    /**
+     * A genuine partial update: send only the fields to change. Pausing an import is {\"pullEnabled\": false}, and because the two direction flags are independent it does not disturb a push somebody else turned on. The list is immutable — changing it would be a different mapping and would slip past the uniqueness check a create is subject to. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Retag or pause one list mapping
+     */
+    async updateMapping(requestParameters, initOverrides) {
+        const response = await this.updateMappingRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Health comes from the shared connection substrate, so a vendor\'s status here always matches GET /api/v1/integrations/{vendor}. The three counters are from the last run and are zero before the first one: contactsPulled is audience imported, contactsPushed is what was written into the customer\'s own account, and suppressionsApplied is how many Augstash email opt-outs were propagated upstream. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List both marketing tools and what this tenant\'s last sync did
+     */
+    async vendorsIntegrationsContactsyncRaw(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/contact-sync/vendors`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.ContactSyncVendorResponseFromJSON));
+    }
+    /**
+     * Health comes from the shared connection substrate, so a vendor\'s status here always matches GET /api/v1/integrations/{vendor}. The three counters are from the last run and are zero before the first one: contactsPulled is audience imported, contactsPushed is what was written into the customer\'s own account, and suppressionsApplied is how many Augstash email opt-outs were propagated upstream. Never returns a credential. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List both marketing tools and what this tenant\'s last sync did
+     */
+    async vendorsIntegrationsContactsync(initOverrides) {
+        const response = await this.vendorsIntegrationsContactsyncRaw(initOverrides);
+        return await response.value();
+    }
+}
+exports.ContactSyncApi = ContactSyncApi;

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

@@ -0,0 +1,87 @@
+/**
+ * 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';
+export interface CheckRequest {
+    vendor: string;
+    token: string;
+}
+export interface ReceiveWebhooksContactsyncRequest {
+    vendor: string;
+    token: string;
+    xIdempotencyKey?: string;
+    body?: string;
+}
+/**
+ * ContactSyncWebhookApi - interface
+ *
+ * @export
+ * @interface ContactSyncWebhookApiInterface
+ */
+export interface ContactSyncWebhookApiInterface {
+    /**
+     * Mailchimp GETs the URL when a webhook is created and will not save one that does not answer 200. Returns 401 for an unknown path token, so this cannot be used to confirm a guessed URL. Reads < 300ms.
+     * @summary Consent webhook endpoint check (Mailchimp)
+     * @param {string} vendor
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ContactSyncWebhookApiInterface
+     */
+    checkRaw(requestParameters: CheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Mailchimp GETs the URL when a webhook is created and will not save one that does not answer 200. Returns 401 for an unknown path token, so this cannot be used to confirm a guessed URL. Reads < 300ms.
+     * Consent webhook endpoint check (Mailchimp)
+     */
+    check(requestParameters: CheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Where an unsubscribe, a suppression or a hard bounce arrives, so it lands in seconds rather than within the hour the sweep takes. Authenticated by the unguessable path token plus, for Klaviyo, its own signature over the raw body -- never by a bearer token. Answers 401 to a delivery that does not authenticate and 200 to everything else, including payloads we cannot parse and addresses this tenant does not hold: a vendor disables an endpoint that answers non-2xx. Idempotent -- a replayed event is recognised by its own id (or, for Mailchimp, a stable composite) and changes nothing. This endpoint can only opt a contact OUT; a subscribe is recorded and left to the sweep, which is the only thing that can see the whole account. Webhook ingest < 1s.
+     * @summary Marketing consent webhook (Klaviyo, Mailchimp)
+     * @param {string} vendor
+     * @param {string} token
+     * @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 {string} [body]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ContactSyncWebhookApiInterface
+     */
+    receiveWebhooksContactsyncRaw(requestParameters: ReceiveWebhooksContactsyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Where an unsubscribe, a suppression or a hard bounce arrives, so it lands in seconds rather than within the hour the sweep takes. Authenticated by the unguessable path token plus, for Klaviyo, its own signature over the raw body -- never by a bearer token. Answers 401 to a delivery that does not authenticate and 200 to everything else, including payloads we cannot parse and addresses this tenant does not hold: a vendor disables an endpoint that answers non-2xx. Idempotent -- a replayed event is recognised by its own id (or, for Mailchimp, a stable composite) and changes nothing. This endpoint can only opt a contact OUT; a subscribe is recorded and left to the sweep, which is the only thing that can see the whole account. Webhook ingest < 1s.
+     * Marketing consent webhook (Klaviyo, Mailchimp)
+     */
+    receiveWebhooksContactsync(requestParameters: ReceiveWebhooksContactsyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class ContactSyncWebhookApi extends runtime.BaseAPI implements ContactSyncWebhookApiInterface {
+    /**
+     * Mailchimp GETs the URL when a webhook is created and will not save one that does not answer 200. Returns 401 for an unknown path token, so this cannot be used to confirm a guessed URL. Reads < 300ms.
+     * Consent webhook endpoint check (Mailchimp)
+     */
+    checkRaw(requestParameters: CheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Mailchimp GETs the URL when a webhook is created and will not save one that does not answer 200. Returns 401 for an unknown path token, so this cannot be used to confirm a guessed URL. Reads < 300ms.
+     * Consent webhook endpoint check (Mailchimp)
+     */
+    check(requestParameters: CheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Where an unsubscribe, a suppression or a hard bounce arrives, so it lands in seconds rather than within the hour the sweep takes. Authenticated by the unguessable path token plus, for Klaviyo, its own signature over the raw body -- never by a bearer token. Answers 401 to a delivery that does not authenticate and 200 to everything else, including payloads we cannot parse and addresses this tenant does not hold: a vendor disables an endpoint that answers non-2xx. Idempotent -- a replayed event is recognised by its own id (or, for Mailchimp, a stable composite) and changes nothing. This endpoint can only opt a contact OUT; a subscribe is recorded and left to the sweep, which is the only thing that can see the whole account. Webhook ingest < 1s.
+     * Marketing consent webhook (Klaviyo, Mailchimp)
+     */
+    receiveWebhooksContactsyncRaw(requestParameters: ReceiveWebhooksContactsyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Where an unsubscribe, a suppression or a hard bounce arrives, so it lands in seconds rather than within the hour the sweep takes. Authenticated by the unguessable path token plus, for Klaviyo, its own signature over the raw body -- never by a bearer token. Answers 401 to a delivery that does not authenticate and 200 to everything else, including payloads we cannot parse and addresses this tenant does not hold: a vendor disables an endpoint that answers non-2xx. Idempotent -- a replayed event is recognised by its own id (or, for Mailchimp, a stable composite) and changes nothing. This endpoint can only opt a contact OUT; a subscribe is recorded and left to the sweep, which is the only thing that can see the whole account. Webhook ingest < 1s.
+     * Marketing consent webhook (Klaviyo, Mailchimp)
+     */
+    receiveWebhooksContactsync(requestParameters: ReceiveWebhooksContactsyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}

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

@@ -0,0 +1,143 @@
+"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.ContactSyncWebhookApi = void 0;
+const runtime = __importStar(require("../runtime"));
+/**
+ *
+ */
+class ContactSyncWebhookApi extends runtime.BaseAPI {
+    /**
+     * Mailchimp GETs the URL when a webhook is created and will not save one that does not answer 200. Returns 401 for an unknown path token, so this cannot be used to confirm a guessed URL. Reads < 300ms.
+     * Consent webhook endpoint check (Mailchimp)
+     */
+    async checkRaw(requestParameters, initOverrides) {
+        if (requestParameters['vendor'] == null) {
+            throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling check().');
+        }
+        if (requestParameters['token'] == null) {
+            throw new runtime.RequiredError('token', 'Required parameter "token" was null or undefined when calling check().');
+        }
+        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 = `/webhooks/contact-sync/{vendor}/{token}`;
+        urlPath = urlPath.replace(`{${"vendor"}}`, encodeURIComponent(String(requestParameters['vendor'])));
+        urlPath = urlPath.replace(`{${"token"}}`, encodeURIComponent(String(requestParameters['token'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Mailchimp GETs the URL when a webhook is created and will not save one that does not answer 200. Returns 401 for an unknown path token, so this cannot be used to confirm a guessed URL. Reads < 300ms.
+     * Consent webhook endpoint check (Mailchimp)
+     */
+    async check(requestParameters, initOverrides) {
+        await this.checkRaw(requestParameters, initOverrides);
+    }
+    /**
+     * Where an unsubscribe, a suppression or a hard bounce arrives, so it lands in seconds rather than within the hour the sweep takes. Authenticated by the unguessable path token plus, for Klaviyo, its own signature over the raw body -- never by a bearer token. Answers 401 to a delivery that does not authenticate and 200 to everything else, including payloads we cannot parse and addresses this tenant does not hold: a vendor disables an endpoint that answers non-2xx. Idempotent -- a replayed event is recognised by its own id (or, for Mailchimp, a stable composite) and changes nothing. This endpoint can only opt a contact OUT; a subscribe is recorded and left to the sweep, which is the only thing that can see the whole account. Webhook ingest < 1s.
+     * Marketing consent webhook (Klaviyo, Mailchimp)
+     */
+    async receiveWebhooksContactsyncRaw(requestParameters, initOverrides) {
+        if (requestParameters['vendor'] == null) {
+            throw new runtime.RequiredError('vendor', 'Required parameter "vendor" was null or undefined when calling receiveWebhooksContactsync().');
+        }
+        if (requestParameters['token'] == null) {
+            throw new runtime.RequiredError('token', 'Required parameter "token" was null or undefined when calling receiveWebhooksContactsync().');
+        }
+        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 = `/webhooks/contact-sync/{vendor}/{token}`;
+        urlPath = urlPath.replace(`{${"vendor"}}`, encodeURIComponent(String(requestParameters['vendor'])));
+        urlPath = urlPath.replace(`{${"token"}}`, encodeURIComponent(String(requestParameters['token'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['body'],
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Where an unsubscribe, a suppression or a hard bounce arrives, so it lands in seconds rather than within the hour the sweep takes. Authenticated by the unguessable path token plus, for Klaviyo, its own signature over the raw body -- never by a bearer token. Answers 401 to a delivery that does not authenticate and 200 to everything else, including payloads we cannot parse and addresses this tenant does not hold: a vendor disables an endpoint that answers non-2xx. Idempotent -- a replayed event is recognised by its own id (or, for Mailchimp, a stable composite) and changes nothing. This endpoint can only opt a contact OUT; a subscribe is recorded and left to the sweep, which is the only thing that can see the whole account. Webhook ingest < 1s.
+     * Marketing consent webhook (Klaviyo, Mailchimp)
+     */
+    async receiveWebhooksContactsync(requestParameters, initOverrides) {
+        await this.receiveWebhooksContactsyncRaw(requestParameters, initOverrides);
+    }
+}
+exports.ContactSyncWebhookApi = ContactSyncWebhookApi;

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

@@ -11,7 +11,7 @@
  */
 import * as runtime from '../runtime';
 import type { FlowDataExchangeRequest } from '../models/index';
-export interface ExchangeRequest {
+export interface ExchangeWebhooksRequest {
     xIdempotencyKey?: string;
     flowDataExchangeRequest?: FlowDataExchangeRequest;
 }
@@ -31,12 +31,12 @@ export interface FlowDataExchangeApiInterface {
      * @throws {RequiredError}
      * @memberof FlowDataExchangeApiInterface
      */
-    exchangeRaw(requestParameters: ExchangeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    exchangeWebhooksRaw(requestParameters: ExchangeWebhooksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
     /**
      * Decrypts Meta\'s request, answers it, and returns the re-encrypted response as base64 text. Authenticated by the encryption itself, not by a token. Webhook ingest < 1s.
      * Meta WhatsApp Flows data-exchange callback
      */
-    exchange(requestParameters: ExchangeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    exchangeWebhooks(requestParameters: ExchangeWebhooksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
 }
 /**
  *
@@ -46,10 +46,10 @@ export declare class FlowDataExchangeApi extends runtime.BaseAPI implements Flow
      * Decrypts Meta\'s request, answers it, and returns the re-encrypted response as base64 text. Authenticated by the encryption itself, not by a token. Webhook ingest < 1s.
      * Meta WhatsApp Flows data-exchange callback
      */
-    exchangeRaw(requestParameters: ExchangeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    exchangeWebhooksRaw(requestParameters: ExchangeWebhooksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
     /**
      * Decrypts Meta\'s request, answers it, and returns the re-encrypted response as base64 text. Authenticated by the encryption itself, not by a token. Webhook ingest < 1s.
      * Meta WhatsApp Flows data-exchange callback
      */
-    exchange(requestParameters?: ExchangeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    exchangeWebhooks(requestParameters?: ExchangeWebhooksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
 }

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

@@ -57,7 +57,7 @@ class FlowDataExchangeApi extends runtime.BaseAPI {
      * Decrypts Meta\'s request, answers it, and returns the re-encrypted response as base64 text. Authenticated by the encryption itself, not by a token. Webhook ingest < 1s.
      * Meta WhatsApp Flows data-exchange callback
      */
-    async exchangeRaw(requestParameters, initOverrides) {
+    async exchangeWebhooksRaw(requestParameters, initOverrides) {
         const queryParameters = {};
         const headerParameters = {};
         headerParameters['Content-Type'] = 'application/json';
@@ -93,8 +93,8 @@ class FlowDataExchangeApi extends runtime.BaseAPI {
      * Decrypts Meta\'s request, answers it, and returns the re-encrypted response as base64 text. Authenticated by the encryption itself, not by a token. Webhook ingest < 1s.
      * Meta WhatsApp Flows data-exchange callback
      */
-    async exchange(requestParameters = {}, initOverrides) {
-        const response = await this.exchangeRaw(requestParameters, initOverrides);
+    async exchangeWebhooks(requestParameters = {}, initOverrides) {
+        const response = await this.exchangeWebhooksRaw(requestParameters, initOverrides);
         return await response.value();
     }
 }