@trycourier/courier 7.8.0 → 7.9.0

package/resources/notifications/notifications.mjs

@@ -4,6 +4,7 @@ import * as ChecksAPI from "./checks.mjs";
 import { Checks, } from "./checks.mjs";
 import * as DraftAPI from "./draft.mjs";
 import { Draft } from "./draft.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
 import { path } from "../../internal/utils/path.mjs";
 export class Notifications extends APIResource {
     constructor() {
@@ -11,9 +12,130 @@ export class Notifications extends APIResource {
         this.draft = new DraftAPI.Draft(this._client);
         this.checks = new ChecksAPI.Checks(this._client);
     }
+    /**
+     * Create a notification template. Requires all fields in the notification object.
+     * Templates are created in draft state by default.
+     *
+     * @example
+     * ```ts
+     * const notificationTemplateMutationResponse =
+     *   await client.notifications.create({
+     *     notification: {
+     *       name: 'Welcome Email',
+     *       tags: ['onboarding', 'welcome'],
+     *       brand: { id: 'brand_abc' },
+     *       subscription: { topic_id: 'marketing' },
+     *       routing: { strategy_id: 'rs_123' },
+     *       content: {
+     *         version: '2022-01-01',
+     *         elements: [{ type: 'channel' }],
+     *       },
+     *     },
+     *     state: 'DRAFT',
+     *   });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/notifications', { body, ...options });
+    }
+    /**
+     * Retrieve a notification template by ID. Returns the published version by
+     * default. Pass version=draft to retrieve an unpublished template.
+     *
+     * @example
+     * ```ts
+     * const notificationTemplateGetResponse =
+     *   await client.notifications.retrieve('id');
+     * ```
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get(path `/notifications/${id}`, { query, ...options });
+    }
+    /**
+     * List notification templates in your workspace.
+     *
+     * @example
+     * ```ts
+     * const notifications = await client.notifications.list();
+     * ```
+     */
     list(query = {}, options) {
         return this._client.get('/notifications', { query, ...options });
     }
+    /**
+     * Archive a notification template.
+     *
+     * @example
+     * ```ts
+     * await client.notifications.archive('id');
+     * ```
+     */
+    archive(id, options) {
+        return this._client.delete(path `/notifications/${id}`, {
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * List versions of a notification template.
+     *
+     * @example
+     * ```ts
+     * const notificationTemplateVersionListResponse =
+     *   await client.notifications.listVersions('id');
+     * ```
+     */
+    listVersions(id, query = {}, options) {
+        return this._client.get(path `/notifications/${id}/versions`, { query, ...options });
+    }
+    /**
+     * Publish a notification template. Publishes the current draft by default. Pass a
+     * version in the request body to publish a specific historical version.
+     *
+     * @example
+     * ```ts
+     * await client.notifications.publish('id');
+     * ```
+     */
+    publish(id, body = {}, options) {
+        return this._client.post(path `/notifications/${id}/publish`, {
+            body,
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Replace a notification template. All fields are required.
+     *
+     * @example
+     * ```ts
+     * const notificationTemplateMutationResponse =
+     *   await client.notifications.replace('id', {
+     *     notification: {
+     *       name: 'Updated Name',
+     *       tags: ['updated'],
+     *       brand: null,
+     *       subscription: null,
+     *       routing: null,
+     *       content: {
+     *         version: '2022-01-01',
+     *         elements: [{ type: 'channel' }],
+     *       },
+     *     },
+     *     state: 'PUBLISHED',
+     *   });
+     * ```
+     */
+    replace(id, body, options) {
+        return this._client.put(path `/notifications/${id}`, { body, ...options });
+    }
+    /**
+     * @example
+     * ```ts
+     * const notificationGetContent =
+     *   await client.notifications.retrieveContent('id');
+     * ```
+     */
     retrieveContent(id, options) {
         return this._client.get(path `/notifications/${id}/content`, options);
     }

package/resources/notifications/notifications.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"notifications.mjs","sourceRoot":"","sources":["../../src/resources/notifications/notifications.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,SAAS;OACd,EAML,MAAM,GACP;OACM,KAAK,QAAQ;OACb,EAAE,KAAK,EAAE;OAGT,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAA9C;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAYhE,CAAC;IAVC,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,eAAe,CAAC,EAAU,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AAsID,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC;AAC5B,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC"}
+{"version":3,"file":"notifications.mjs","sourceRoot":"","sources":["../../src/resources/notifications/notifications.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,SAAS;OACd,EAML,MAAM,GACP;OACM,KAAK,QAAQ;OACb,EAAE,KAAK,EAAE;OAET,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAA9C;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA8JhE,CAAC;IA5JC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CACJ,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,kBAAkB,EAAE,EAAE,EAAE;YACrD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,CACV,EAAU,EACV,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CACL,EAAU,EACV,OAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,EAAE,UAAU,EAAE;YAC3D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CACL,EAAU,EACV,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;OAMG;IACH,eAAe,CAAC,EAAU,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AAybD,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC;AAC5B,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC"}

package/resources/providers/catalog.d.mts

@@ -0,0 +1,40 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as Shared from "../shared.mjs";
+import * as ProvidersAPI from "./providers.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Catalog extends APIResource {
+    /**
+     * Returns the catalog of available provider types with their display names,
+     * descriptions, and configuration schema fields (snake_case, with `type` and
+     * `required`). Providers with no configurable schema return only `provider`,
+     * `name`, and `description`.
+     */
+    list(query?: CatalogListParams | null | undefined, options?: RequestOptions): APIPromise<CatalogListResponse>;
+}
+/**
+ * Paginated list of available provider types with their configuration schemas.
+ */
+export interface CatalogListResponse {
+    paging: Shared.Paging;
+    results: Array<ProvidersAPI.ProvidersCatalogEntry>;
+}
+export interface CatalogListParams {
+    /**
+     * Exact match (case-insensitive) against the provider channel taxonomy (e.g.
+     * `email`, `sms`, `push`).
+     */
+    channel?: string;
+    /**
+     * Comma-separated provider keys to filter by (e.g. `sendgrid,twilio`).
+     */
+    keys?: string;
+    /**
+     * Case-insensitive substring match against the provider display name.
+     */
+    name?: string;
+}
+export declare namespace Catalog {
+    export { type CatalogListResponse as CatalogListResponse, type CatalogListParams as CatalogListParams };
+}
+//# sourceMappingURL=catalog.d.mts.map

package/resources/providers/catalog.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.d.mts","sourceRoot":"","sources":["../../src/resources/providers/catalog.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;OAKG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAGnC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IAEtB,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC;CACpD;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CACzG"}

package/resources/providers/catalog.d.ts

@@ -0,0 +1,40 @@
+import { APIResource } from "../../core/resource.js";
+import * as Shared from "../shared.js";
+import * as ProvidersAPI from "./providers.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Catalog extends APIResource {
+    /**
+     * Returns the catalog of available provider types with their display names,
+     * descriptions, and configuration schema fields (snake_case, with `type` and
+     * `required`). Providers with no configurable schema return only `provider`,
+     * `name`, and `description`.
+     */
+    list(query?: CatalogListParams | null | undefined, options?: RequestOptions): APIPromise<CatalogListResponse>;
+}
+/**
+ * Paginated list of available provider types with their configuration schemas.
+ */
+export interface CatalogListResponse {
+    paging: Shared.Paging;
+    results: Array<ProvidersAPI.ProvidersCatalogEntry>;
+}
+export interface CatalogListParams {
+    /**
+     * Exact match (case-insensitive) against the provider channel taxonomy (e.g.
+     * `email`, `sms`, `push`).
+     */
+    channel?: string;
+    /**
+     * Comma-separated provider keys to filter by (e.g. `sendgrid,twilio`).
+     */
+    keys?: string;
+    /**
+     * Case-insensitive substring match against the provider display name.
+     */
+    name?: string;
+}
+export declare namespace Catalog {
+    export { type CatalogListResponse as CatalogListResponse, type CatalogListParams as CatalogListParams };
+}
+//# sourceMappingURL=catalog.d.ts.map

package/resources/providers/catalog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../../src/resources/providers/catalog.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;OAKG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAGnC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IAEtB,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC;CACpD;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CACzG"}

package/resources/providers/catalog.js

@@ -0,0 +1,18 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Catalog = void 0;
+const resource_1 = require("../../core/resource.js");
+class Catalog extends resource_1.APIResource {
+    /**
+     * Returns the catalog of available provider types with their display names,
+     * descriptions, and configuration schema fields (snake_case, with `type` and
+     * `required`). Providers with no configurable schema return only `provider`,
+     * `name`, and `description`.
+     */
+    list(query = {}, options) {
+        return this._client.get('/providers/catalog', { query, ...options });
+    }
+}
+exports.Catalog = Catalog;
+//# sourceMappingURL=catalog.js.map

package/resources/providers/catalog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.js","sourceRoot":"","sources":["../../src/resources/providers/catalog.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;OAKG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AAbD,0BAaC"}

package/resources/providers/catalog.mjs

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+export class Catalog extends APIResource {
+    /**
+     * Returns the catalog of available provider types with their display names,
+     * descriptions, and configuration schema fields (snake_case, with `type` and
+     * `required`). Providers with no configurable schema return only `provider`,
+     * `name`, and `description`.
+     */
+    list(query = {}, options) {
+        return this._client.get('/providers/catalog', { query, ...options });
+    }
+}
+//# sourceMappingURL=catalog.mjs.map

package/resources/providers/catalog.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.mjs","sourceRoot":"","sources":["../../src/resources/providers/catalog.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAMtB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;OAKG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF"}

package/resources/providers/index.d.mts

@@ -0,0 +1,3 @@
+export { Catalog, type CatalogListResponse, type CatalogListParams } from "./catalog.mjs";
+export { Providers, type Provider, type ProvidersCatalogEntry, type ProviderListResponse, type ProviderCreateParams, type ProviderUpdateParams, type ProviderListParams, } from "./providers.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/providers/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/providers/index.ts"],"names":[],"mappings":"OAEO,EAAE,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,iBAAiB,EAAE;OAC7D,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,GACxB"}

package/resources/providers/index.d.ts

@@ -0,0 +1,3 @@
+export { Catalog, type CatalogListResponse, type CatalogListParams } from "./catalog.js";
+export { Providers, type Provider, type ProvidersCatalogEntry, type ProviderListResponse, type ProviderCreateParams, type ProviderUpdateParams, type ProviderListParams, } from "./providers.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/providers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/providers/index.ts"],"names":[],"mappings":"OAEO,EAAE,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,iBAAiB,EAAE;OAC7D,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,GACxB"}

package/resources/providers/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Providers = exports.Catalog = void 0;
+var catalog_1 = require("./catalog.js");
+Object.defineProperty(exports, "Catalog", { enumerable: true, get: function () { return catalog_1.Catalog; } });
+var providers_1 = require("./providers.js");
+Object.defineProperty(exports, "Providers", { enumerable: true, get: function () { return providers_1.Providers; } });
+//# sourceMappingURL=index.js.map

package/resources/providers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/providers/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wCAAsF;AAA7E,kGAAA,OAAO,OAAA;AAChB,4CAQqB;AAPnB,sGAAA,SAAS,OAAA"}

package/resources/providers/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Catalog } from "./catalog.mjs";
+export { Providers, } from "./providers.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/providers/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/providers/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,OAAO,EAAoD;OAC7D,EACL,SAAS,GAOV"}

package/resources/providers/providers.d.mts

@@ -0,0 +1,182 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as Shared from "../shared.mjs";
+import * as CatalogAPI from "./catalog.mjs";
+import { Catalog, CatalogListParams, CatalogListResponse } from "./catalog.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Providers extends APIResource {
+    catalog: CatalogAPI.Catalog;
+    /**
+     * Create a new provider configuration. The `provider` field must be a known
+     * Courier provider key (see catalog).
+     */
+    create(body: ProviderCreateParams, options?: RequestOptions): APIPromise<Provider>;
+    /**
+     * Fetch a single provider configuration by ID.
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<Provider>;
+    /**
+     * Update an existing provider configuration. The `provider` key is required. All
+     * other fields are optional — omitted fields are cleared from the stored
+     * configuration (this is a full replacement, not a partial merge).
+     */
+    update(id: string, body: ProviderUpdateParams, options?: RequestOptions): APIPromise<Provider>;
+    /**
+     * List configured provider integrations for the current workspace. Supports
+     * cursor-based pagination.
+     */
+    list(query?: ProviderListParams | null | undefined, options?: RequestOptions): APIPromise<ProviderListResponse>;
+    /**
+     * Delete a provider configuration. Returns 409 if the provider is still referenced
+     * by routing or notifications.
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
+}
+/**
+ * A configured provider in the workspace.
+ */
+export interface Provider {
+    /**
+     * A unique identifier for the provider configuration.
+     */
+    id: string;
+    /**
+     * Unix timestamp (ms) of when the provider was created.
+     */
+    created: number;
+    /**
+     * The provider key (e.g. "sendgrid", "twilio", "slack").
+     */
+    provider: string;
+    /**
+     * Provider-specific settings (snake_case keys on the wire).
+     */
+    settings: {
+        [key: string]: unknown;
+    };
+    /**
+     * Display title. Defaults to "Default Configuration" when not explicitly set.
+     */
+    title: string;
+    /**
+     * Optional alias for this configuration.
+     */
+    alias?: string;
+    /**
+     * Unix timestamp (ms) of when the provider was last updated.
+     */
+    updated?: number | null;
+}
+/**
+ * A provider type from the catalog. Contains the key, display name, description,
+ * and a `settings` object describing configuration schema fields.
+ */
+export interface ProvidersCatalogEntry {
+    /**
+     * Courier taxonomy channel (e.g. email, push, sms, direct_message, inbox,
+     * webhook).
+     */
+    channel: string;
+    /**
+     * Short description of the provider.
+     */
+    description: string;
+    /**
+     * Human-readable display name.
+     */
+    name: string;
+    /**
+     * The provider key (e.g. "sendgrid", "twilio").
+     */
+    provider: string;
+    /**
+     * Map of setting field names (snake_case) to their schema descriptors. Each
+     * descriptor has `type` and `required`. Empty when the provider has no
+     * configurable schema.
+     */
+    settings: {
+        [key: string]: ProvidersCatalogEntry.Settings;
+    };
+}
+export declare namespace ProvidersCatalogEntry {
+    /**
+     * Describes a single configuration field in the provider catalog.
+     */
+    interface Settings {
+        /**
+         * Whether this field is required when configuring the provider.
+         */
+        required: boolean;
+        /**
+         * The field's data type (e.g. "string", "boolean", "enum").
+         */
+        type: string;
+        /**
+         * Allowed values when `type` is "enum".
+         */
+        values?: Array<string>;
+    }
+}
+/**
+ * Paginated list of provider configurations.
+ */
+export interface ProviderListResponse {
+    paging: Shared.Paging;
+    results: Array<Provider>;
+}
+export interface ProviderCreateParams {
+    /**
+     * The provider key identifying the type (e.g. "sendgrid", "twilio"). Must be a
+     * known Courier provider — see the catalog endpoint for valid keys.
+     */
+    provider: string;
+    /**
+     * Optional alias for this configuration.
+     */
+    alias?: string;
+    /**
+     * Provider-specific settings (snake_case keys). Defaults to an empty object when
+     * omitted. Use the catalog endpoint to discover required fields for a given
+     * provider — omitting a required field returns a 400 validation error.
+     */
+    settings?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Optional display title. Omit to use "Default Configuration".
+     */
+    title?: string;
+}
+export interface ProviderUpdateParams {
+    /**
+     * The provider key identifying the type.
+     */
+    provider: string;
+    /**
+     * Updated alias. Omit to clear.
+     */
+    alias?: string;
+    /**
+     * Provider-specific settings (snake_case keys). Replaces the full settings object
+     * — omitted settings fields are removed. Use the catalog endpoint to check
+     * required fields.
+     */
+    settings?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Updated display title.
+     */
+    title?: string;
+}
+export interface ProviderListParams {
+    /**
+     * Opaque cursor for fetching the next page.
+     */
+    cursor?: string;
+}
+export declare namespace Providers {
+    export { type Provider as Provider, type ProvidersCatalogEntry as ProvidersCatalogEntry, type ProviderListResponse as ProviderListResponse, type ProviderCreateParams as ProviderCreateParams, type ProviderUpdateParams as ProviderUpdateParams, type ProviderListParams as ProviderListParams, };
+    export { Catalog as Catalog, type CatalogListResponse as CatalogListResponse, type CatalogListParams as CatalogListParams, };
+}
+//# sourceMappingURL=providers.d.mts.map

package/resources/providers/providers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.d.mts","sourceRoot":"","sources":["../../src/resources/providers/providers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,UAAU;OACf,EAAE,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE;OACnD,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIlF;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIpE;;;;OAIG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAI9F;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/D;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,CAAC,QAAQ,CAAA;KAAE,CAAC;CAC7D;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACxB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IAEtB,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}