@trycourier/courier 7.25.0 → 7.25.2

package/src/resources/send.ts

@@ -12,7 +12,8 @@ import { RequestOptions } from '../internal/request-options';
 export class Send extends APIResource {
   /**
    * Sends a message to one or more recipients and returns a requestId. Courier
-   * routes it to email, SMS, push, chat, or in-app based on your rules.
+   * routes it to email, SMS, push, chat, or in-app based on your rules. Use the
+   * returned requestId to look up delivery status via the Messages API.
    *
    * @example
    * ```ts

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

@@ -84,6 +84,7 @@ export class Templates extends APIResource {
    * const postTenantTemplatePublishResponse =
    *   await client.tenants.templates.publish('template_id', {
    *     tenant_id: 'tenant_id',
+   *     version: 'latest',
    *   });
    * ```
    */
@@ -109,8 +110,13 @@ export class Templates extends APIResource {
    *   await client.tenants.templates.replace('template_id', {
    *     tenant_id: 'tenant_id',
    *     template: {
-   *       content: { elements: [{}], version: 'version' },
+   *       content: {
+   *         version: '2022-01-01',
+   *         elements: [{ type: 'text' }],
+   *       },
+   *       routing: { method: 'single', channels: ['email'] },
    *     },
+   *     published: true,
    *   });
    * ```
    */

package/src/resources/tenants/tenants.ts

@@ -47,7 +47,9 @@ export class Tenants extends APIResource {
    * @example
    * ```ts
    * const tenant = await client.tenants.update('tenant_id', {
-   *   name: 'name',
+   *   name: 'Acme Corp',
+   *   brand_id: 'bnd_01kx4mrd0pfzw8wt7pn7p2fzag',
+   *   properties: { plan: 'enterprise' },
    * });
    * ```
    */

package/src/resources/translations.ts

@@ -13,6 +13,14 @@ export class Translations extends APIResource {
   /**
    * Returns the translation strings stored for one domain and locale, for use in
    * localized notification content.
+   *
+   * @example
+   * ```ts
+   * const translation = await client.translations.retrieve(
+   *   'locale',
+   *   { domain: 'domain' },
+   * );
+   * ```
    */
   retrieve(locale: string, params: TranslationRetrieveParams, options?: RequestOptions): APIPromise<string> {
     const { domain } = params;
@@ -22,6 +30,14 @@ export class Translations extends APIResource {
   /**
    * Uploads the translation strings for one domain and locale. Courier uses them to
    * render localized content for recipients in that locale.
+   *
+   * @example
+   * ```ts
+   * await client.translations.update('locale', {
+   *   domain: 'domain',
+   *   body: 'msgid "Hello"\nmsgstr "Hola"',
+   * });
+   * ```
    */
   update(locale: string, params: TranslationUpdateParams, options?: RequestOptions): APIPromise<void> {
     const { domain, body } = params;

package/src/resources/users/tenants.ts

@@ -35,7 +35,10 @@ export class Tenants extends APIResource {
    * @example
    * ```ts
    * await client.users.tenants.addMultiple('user_id', {
-   *   tenants: [{ tenant_id: 'tenant_id' }],
+   *   tenants: [
+   *     { tenant_id: 'tenant_abc' },
+   *     { tenant_id: 'tenant_def' },
+   *   ],
    * });
    * ```
    */
@@ -55,6 +58,7 @@ export class Tenants extends APIResource {
    * ```ts
    * await client.users.tenants.addSingle('tenant_id', {
    *   user_id: 'user_id',
+   *   profile: { role: 'admin' },
    * });
    * ```
    */

package/src/resources/users/tokens.ts

@@ -38,7 +38,13 @@ export class Tokens extends APIResource {
    * ```ts
    * await client.users.tokens.update('token', {
    *   user_id: 'user_id',
-   *   patch: [{ op: 'op', path: 'path' }],
+   *   patch: [
+   *     {
+   *       op: 'replace',
+   *       path: '/expiry_date',
+   *       value: '2024-12-31T00:00:00.000Z',
+   *     },
+   *   ],
    * });
    * ```
    */
@@ -108,6 +114,7 @@ export class Tokens extends APIResource {
    * await client.users.tokens.addSingle('token', {
    *   user_id: 'user_id',
    *   provider_key: 'firebase-fcm',
+   *   device: { app_id: 'com.example.app' },
    * });
    * ```
    */

package/src/resources/workspace-preferences/topics.ts

@@ -122,8 +122,11 @@ export class Topics extends APIResource {
    *     'topic_id',
    *     {
    *       section_id: 'section_id',
-   *       default_status: 'OPTED_OUT',
-   *       name: 'name',
+   *       default_status: 'OPTED_IN',
+   *       name: 'Product Updates',
+   *       allowed_preferences: ['channel_preferences'],
+   *       include_unsubscribe_header: true,
+   *       routing_options: ['email', 'inbox'],
    *     },
    *   );
    * ```

package/src/resources/workspace-preferences/workspace-preferences.ts

@@ -108,7 +108,11 @@ export class WorkspacePreferences extends APIResource {
    * @example
    * ```ts
    * const publishPreferencesResponse =
-   *   await client.workspacePreferences.publish();
+   *   await client.workspacePreferences.publish({
+   *     brand_id: 'bnd_01kx4mrd0pfzw8wt7pn7p2fzag',
+   *     description: 'Choose what you hear from us about.',
+   *     heading: 'Notification Preferences',
+   *   });
    * ```
    */
   publish(
@@ -143,7 +147,9 @@ export class WorkspacePreferences extends APIResource {
    * ```ts
    * const workspacePreferenceGetResponse =
    *   await client.workspacePreferences.replace('section_id', {
-   *     name: 'name',
+   *     name: 'Account Notifications',
+   *     has_custom_routing: true,
+   *     routing_options: ['email', 'push'],
    *   });
    * ```
    */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '7.25.0'; // x-release-please-version
+export const VERSION = '7.25.2'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "7.25.0";
+export declare const VERSION = "7.25.2";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "7.25.0";
+export declare const VERSION = "7.25.2";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '7.25.0'; // x-release-please-version
+exports.VERSION = '7.25.2'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '7.25.0'; // x-release-please-version
+export const VERSION = '7.25.2'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map