@trycourier/courier 7.2.0 → 7.7.1

package/src/resources/tenants/templates/templates.ts

@@ -0,0 +1,222 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as Shared from '../../shared';
+import * as TenantsAPI from '../tenants';
+import * as VersionsAPI from './versions';
+import { VersionRetrieveParams, Versions } from './versions';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Templates extends APIResource {
+  versions: VersionsAPI.Versions = new VersionsAPI.Versions(this._client);
+
+  /**
+   * Get a Template in Tenant
+   *
+   * @example
+   * ```ts
+   * const baseTemplateTenantAssociation =
+   *   await client.tenants.templates.retrieve('template_id', {
+   *     tenant_id: 'tenant_id',
+   *   });
+   * ```
+   */
+  retrieve(
+    templateID: string,
+    params: TemplateRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<TenantsAPI.BaseTemplateTenantAssociation> {
+    const { tenant_id } = params;
+    return this._client.get(path`/tenants/${tenant_id}/templates/${templateID}`, options);
+  }
+
+  /**
+   * List Templates in Tenant
+   *
+   * @example
+   * ```ts
+   * const templates = await client.tenants.templates.list(
+   *   'tenant_id',
+   * );
+   * ```
+   */
+  list(
+    tenantID: string,
+    query: TemplateListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TemplateListResponse> {
+    return this._client.get(path`/tenants/${tenantID}/templates`, { query, ...options });
+  }
+
+  /**
+   * Publishes a specific version of a notification template for a tenant.
+   *
+   * The template must already exist in the tenant's notification map. If no version
+   * is specified, defaults to publishing the "latest" version.
+   *
+   * @example
+   * ```ts
+   * const postTenantTemplatePublishResponse =
+   *   await client.tenants.templates.publish('template_id', {
+   *     tenant_id: 'tenant_id',
+   *   });
+   * ```
+   */
+  publish(
+    templateID: string,
+    params: TemplatePublishParams,
+    options?: RequestOptions,
+  ): APIPromise<TenantsAPI.PostTenantTemplatePublishResponse> {
+    const { tenant_id, ...body } = params;
+    return this._client.post(path`/tenants/${tenant_id}/templates/${templateID}/publish`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Creates or updates a notification template for a tenant.
+   *
+   * If the template already exists for the tenant, it will be updated (200).
+   * Otherwise, a new template is created (201).
+   *
+   * Optionally publishes the template immediately if the `published` flag is set to
+   * true.
+   *
+   * @example
+   * ```ts
+   * const putTenantTemplateResponse =
+   *   await client.tenants.templates.replace('template_id', {
+   *     tenant_id: 'tenant_id',
+   *     template: {
+   *       content: { elements: [{}], version: 'version' },
+   *     },
+   *   });
+   * ```
+   */
+  replace(
+    templateID: string,
+    params: TemplateReplaceParams,
+    options?: RequestOptions,
+  ): APIPromise<TenantsAPI.PutTenantTemplateResponse> {
+    const { tenant_id, ...body } = params;
+    return this._client.put(path`/tenants/${tenant_id}/templates/${templateID}`, { body, ...options });
+  }
+}
+
+export interface TemplateListResponse {
+  /**
+   * Set to true when there are more pages that can be retrieved.
+   */
+  has_more: boolean;
+
+  /**
+   * Always set to `list`. Represents the type of this object.
+   */
+  type: 'list';
+
+  /**
+   * A url that may be used to generate these results.
+   */
+  url: string;
+
+  /**
+   * A pointer to the next page of results. Defined only when `has_more` is set to
+   * true
+   */
+  cursor?: string | null;
+
+  items?: Array<TemplateListResponse.Item> | null;
+
+  /**
+   * A url that may be used to generate fetch the next set of results. Defined only
+   * when `has_more` is set to true
+   */
+  next_url?: string | null;
+}
+
+export namespace TemplateListResponse {
+  export interface Item extends TenantsAPI.BaseTemplateTenantAssociation {
+    /**
+     * The template's data containing it's routing configs
+     */
+    data: Item.Data;
+  }
+
+  export namespace Item {
+    /**
+     * The template's data containing it's routing configs
+     */
+    export interface Data {
+      routing: Shared.MessageRouting;
+    }
+  }
+}
+
+export interface TemplateRetrieveParams {
+  /**
+   * Id of the tenant for which to retrieve the template.
+   */
+  tenant_id: string;
+}
+
+export interface TemplateListParams {
+  /**
+   * Continue the pagination with the next cursor
+   */
+  cursor?: string | null;
+
+  /**
+   * The number of templates to return (defaults to 20, maximum value of 100)
+   */
+  limit?: number | null;
+}
+
+export interface TemplatePublishParams {
+  /**
+   * Path param: Id of the tenant that owns the template.
+   */
+  tenant_id: string;
+
+  /**
+   * Body param: The version of the template to publish (e.g., "v1", "v2", "latest").
+   * If not provided, defaults to "latest".
+   */
+  version?: string;
+}
+
+export interface TemplateReplaceParams {
+  /**
+   * Path param: Id of the tenant for which to create or update the template.
+   */
+  tenant_id: string;
+
+  /**
+   * Body param: Template configuration for creating or updating a tenant
+   * notification template
+   */
+  template: TenantsAPI.TenantTemplateInput;
+
+  /**
+   * Body param: Whether to publish the template immediately after saving. When true,
+   * the template becomes the active/published version. When false (default), the
+   * template is saved as a draft.
+   */
+  published?: boolean;
+}
+
+Templates.Versions = Versions;
+
+export declare namespace Templates {
+  export {
+    type TemplateListResponse as TemplateListResponse,
+    type TemplateRetrieveParams as TemplateRetrieveParams,
+    type TemplateListParams as TemplateListParams,
+    type TemplatePublishParams as TemplatePublishParams,
+    type TemplateReplaceParams as TemplateReplaceParams,
+  };
+
+  export { Versions as Versions, type VersionRetrieveParams as VersionRetrieveParams };
+}

package/src/resources/tenants/templates/versions.ts

@@ -0,0 +1,55 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as TenantsAPI from '../tenants';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Versions extends APIResource {
+  /**
+   * Fetches a specific version of a tenant template.
+   *
+   * Supports the following version formats:
+   *
+   * - `latest` - The most recent version of the template
+   * - `published` - The currently published version
+   * - `v{version}` - A specific version (e.g., "v1", "v2", "v1.0.0")
+   *
+   * @example
+   * ```ts
+   * const baseTemplateTenantAssociation =
+   *   await client.tenants.templates.versions.retrieve(
+   *     'version',
+   *     { tenant_id: 'tenant_id', template_id: 'template_id' },
+   *   );
+   * ```
+   */
+  retrieve(
+    version: string,
+    params: VersionRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<TenantsAPI.BaseTemplateTenantAssociation> {
+    const { tenant_id, template_id } = params;
+    return this._client.get(
+      path`/tenants/${tenant_id}/templates/${template_id}/versions/${version}`,
+      options,
+    );
+  }
+}
+
+export interface VersionRetrieveParams {
+  /**
+   * Id of the tenant for which to retrieve the template.
+   */
+  tenant_id: string;
+
+  /**
+   * Id of the template to be retrieved.
+   */
+  template_id: string;
+}
+
+export declare namespace Versions {
+  export { type VersionRetrieveParams as VersionRetrieveParams };
+}

package/src/resources/tenants/templates.ts

@@ -1,124 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../core/resource';
-import * as Shared from '../shared';
-import * as TenantsAPI from './tenants';
-import { APIPromise } from '../../core/api-promise';
-import { RequestOptions } from '../../internal/request-options';
-import { path } from '../../internal/utils/path';
-
-export class Templates extends APIResource {
-  /**
-   * Get a Template in Tenant
-   *
-   * @example
-   * ```ts
-   * const baseTemplateTenantAssociation =
-   *   await client.tenants.templates.retrieve('template_id', {
-   *     tenant_id: 'tenant_id',
-   *   });
-   * ```
-   */
-  retrieve(
-    templateID: string,
-    params: TemplateRetrieveParams,
-    options?: RequestOptions,
-  ): APIPromise<TenantsAPI.BaseTemplateTenantAssociation> {
-    const { tenant_id } = params;
-    return this._client.get(path`/tenants/${tenant_id}/templates/${templateID}`, options);
-  }
-
-  /**
-   * List Templates in Tenant
-   *
-   * @example
-   * ```ts
-   * const templates = await client.tenants.templates.list(
-   *   'tenant_id',
-   * );
-   * ```
-   */
-  list(
-    tenantID: string,
-    query: TemplateListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<TemplateListResponse> {
-    return this._client.get(path`/tenants/${tenantID}/templates`, { query, ...options });
-  }
-}
-
-export interface TemplateListResponse {
-  /**
-   * Set to true when there are more pages that can be retrieved.
-   */
-  has_more: boolean;
-
-  /**
-   * Always set to `list`. Represents the type of this object.
-   */
-  type: 'list';
-
-  /**
-   * A url that may be used to generate these results.
-   */
-  url: string;
-
-  /**
-   * A pointer to the next page of results. Defined only when `has_more` is set to
-   * true
-   */
-  cursor?: string | null;
-
-  items?: Array<TemplateListResponse.Item> | null;
-
-  /**
-   * A url that may be used to generate fetch the next set of results. Defined only
-   * when `has_more` is set to true
-   */
-  next_url?: string | null;
-}
-
-export namespace TemplateListResponse {
-  export interface Item extends TenantsAPI.BaseTemplateTenantAssociation {
-    /**
-     * The template's data containing it's routing configs
-     */
-    data: Item.Data;
-  }
-
-  export namespace Item {
-    /**
-     * The template's data containing it's routing configs
-     */
-    export interface Data {
-      routing: Shared.MessageRouting;
-    }
-  }
-}
-
-export interface TemplateRetrieveParams {
-  /**
-   * Id of the tenant for which to retrieve the template.
-   */
-  tenant_id: string;
-}
-
-export interface TemplateListParams {
-  /**
-   * Continue the pagination with the next cursor
-   */
-  cursor?: string | null;
-
-  /**
-   * The number of templates to return (defaults to 20, maximum value of 100)
-   */
-  limit?: number | null;
-}
-
-export declare namespace Templates {
-  export {
-    type TemplateListResponse as TemplateListResponse,
-    type TemplateRetrieveParams as TemplateRetrieveParams,
-    type TemplateListParams as TemplateListParams,
-  };
-}
+export * from './templates/index';

package/src/resources/tenants/tenants.ts

@@ -3,10 +3,17 @@
 import { APIResource } from '../../core/resource';
 import * as TenantsAPI from './tenants';
 import * as Shared from '../shared';
-import * as TemplatesAPI from './templates';
-import { TemplateListParams, TemplateListResponse, TemplateRetrieveParams, Templates } from './templates';
 import * as PreferencesAPI from './preferences/preferences';
 import { Preferences } from './preferences/preferences';
+import * as TemplatesAPI from './templates/templates';
+import {
+  TemplateListParams,
+  TemplateListResponse,
+  TemplatePublishParams,
+  TemplateReplaceParams,
+  TemplateRetrieveParams,
+  Templates,
+} from './templates/templates';
 import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
@@ -131,6 +138,75 @@ export namespace DefaultPreferences {
   }
 }
 
+/**
+ * Request body for publishing a tenant template version
+ */
+export interface PostTenantTemplatePublishRequest {
+  /**
+   * The version of the template to publish (e.g., "v1", "v2", "latest"). If not
+   * provided, defaults to "latest".
+   */
+  version?: string;
+}
+
+/**
+ * Response from publishing a tenant template
+ */
+export interface PostTenantTemplatePublishResponse {
+  /**
+   * The template ID
+   */
+  id: string;
+
+  /**
+   * The timestamp when the template was published
+   */
+  published_at: string;
+
+  /**
+   * The published version of the template
+   */
+  version: string;
+}
+
+/**
+ * Request body for creating or updating a tenant notification template
+ */
+export interface PutTenantTemplateRequest {
+  /**
+   * Template configuration for creating or updating a tenant notification template
+   */
+  template: TenantTemplateInput;
+
+  /**
+   * Whether to publish the template immediately after saving. When true, the
+   * template becomes the active/published version. When false (default), the
+   * template is saved as a draft.
+   */
+  published?: boolean;
+}
+
+/**
+ * Response from creating or updating a tenant notification template
+ */
+export interface PutTenantTemplateResponse {
+  /**
+   * The template ID
+   */
+  id: string;
+
+  /**
+   * The version of the saved template
+   */
+  version: string;
+
+  /**
+   * The timestamp when the template was published. Only present if the template was
+   * published as part of this request.
+   */
+  published_at?: string | null;
+}
+
 export interface SubscriptionTopicNew {
   status: 'OPTED_OUT' | 'OPTED_IN' | 'REQUIRED';
 
@@ -141,7 +217,7 @@ export interface SubscriptionTopicNew {
 
   /**
    * Override channel routing with custom preferences. This will override any
-   * template prefernces that are set, but a user can still customize their
+   * template preferences that are set, but a user can still customize their
    * preferences
    */
   has_custom_routing?: boolean | null;
@@ -205,6 +281,99 @@ export interface TenantAssociation {
   user_id?: string | null;
 }
 
+/**
+ * Template configuration for creating or updating a tenant notification template
+ */
+export interface TenantTemplateInput {
+  /**
+   * Template content configuration including blocks, elements, and message structure
+   */
+  content: Shared.ElementalContent;
+
+  /**
+   * Channel-specific delivery configuration (email, SMS, push, etc.)
+   */
+  channels?: { [key: string]: TenantTemplateInput.Channels };
+
+  /**
+   * Provider-specific delivery configuration for routing to specific email/SMS
+   * providers
+   */
+  providers?: { [key: string]: TenantTemplateInput.Providers };
+
+  /**
+   * Message routing configuration for multi-channel delivery strategies
+   */
+  routing?: Shared.MessageRouting;
+}
+
+export namespace TenantTemplateInput {
+  export interface Channels {
+    /**
+     * Brand id used for rendering.
+     */
+    brand_id?: string | null;
+
+    /**
+     * JS conditional with access to data/profile.
+     */
+    if?: string | null;
+
+    metadata?: Channels.Metadata | null;
+
+    /**
+     * Channel specific overrides.
+     */
+    override?: { [key: string]: unknown } | null;
+
+    /**
+     * Providers enabled for this channel.
+     */
+    providers?: Array<string> | null;
+
+    /**
+     * Defaults to `single`.
+     */
+    routing_method?: 'all' | 'single' | null;
+
+    timeouts?: Channels.Timeouts | null;
+  }
+
+  export namespace Channels {
+    export interface Metadata {
+      utm?: Shared.Utm | null;
+    }
+
+    export interface Timeouts {
+      channel?: number | null;
+
+      provider?: number | null;
+    }
+  }
+
+  export interface Providers {
+    /**
+     * JS conditional with access to data/profile.
+     */
+    if?: string | null;
+
+    metadata?: Providers.Metadata | null;
+
+    /**
+     * Provider-specific overrides.
+     */
+    override?: { [key: string]: unknown } | null;
+
+    timeouts?: number | null;
+  }
+
+  export namespace Providers {
+    export interface Metadata {
+      utm?: Shared.Utm | null;
+    }
+  }
+}
+
 export interface TenantListResponse {
   /**
    * Set to true when there are more pages that can be retrieved.
@@ -339,9 +508,14 @@ export declare namespace Tenants {
   export {
     type BaseTemplateTenantAssociation as BaseTemplateTenantAssociation,
     type DefaultPreferences as DefaultPreferences,
+    type PostTenantTemplatePublishRequest as PostTenantTemplatePublishRequest,
+    type PostTenantTemplatePublishResponse as PostTenantTemplatePublishResponse,
+    type PutTenantTemplateRequest as PutTenantTemplateRequest,
+    type PutTenantTemplateResponse as PutTenantTemplateResponse,
     type SubscriptionTopicNew as SubscriptionTopicNew,
     type Tenant as Tenant,
     type TenantAssociation as TenantAssociation,
+    type TenantTemplateInput as TenantTemplateInput,
     type TenantListResponse as TenantListResponse,
     type TenantListUsersResponse as TenantListUsersResponse,
     type TenantUpdateParams as TenantUpdateParams,
@@ -356,5 +530,7 @@ export declare namespace Tenants {
     type TemplateListResponse as TemplateListResponse,
     type TemplateRetrieveParams as TemplateRetrieveParams,
     type TemplateListParams as TemplateListParams,
+    type TemplatePublishParams as TemplatePublishParams,
+    type TemplateReplaceParams as TemplateReplaceParams,
   };
 }

package/src/resources/translations.ts

@@ -46,7 +46,7 @@ export interface TranslationUpdateParams {
   domain: string;
 
   /**
-   * Body param:
+   * Body param
    */
   body: string;
 }

package/src/resources/users/preferences.ts

@@ -143,7 +143,7 @@ export interface PreferenceUpdateOrCreateTopicParams {
   user_id: string;
 
   /**
-   * Body param:
+   * Body param
    */
   topic: PreferenceUpdateOrCreateTopicParams.Topic;
 

package/src/resources/users/tenants.ts

@@ -158,7 +158,7 @@ export interface TenantAddSingleParams {
   user_id: string;
 
   /**
-   * Body param:
+   * Body param
    */
   profile?: { [key: string]: unknown } | null;
 }