@trycourier/courier 6.6.1-alpha0 → 6.7.0-alpha2

package/src/resources/shared.ts

@@ -0,0 +1,61 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as PreferencesAPI from './users/preferences';
+import * as ItemsAPI from './tenants/default-preferences/items';
+
+export type Alignment = 'center' | 'left' | 'right' | 'full';
+
+export interface ChannelPreference {
+  channel: ItemsAPI.ChannelClassification;
+}
+
+export interface ElementalBaseNode {
+  channels?: Array<string> | null;
+
+  if?: string | null;
+
+  loop?: string | null;
+
+  ref?: string | null;
+}
+
+/**
+ * Syntactic sugar to provide a fast shorthand for Courier Elemental Blocks.
+ */
+export interface ElementalContentSugar {
+  /**
+   * The text content displayed in the notification.
+   */
+  body: string;
+
+  /**
+   * Title/subject displayed by supported channels.
+   */
+  title: string;
+}
+
+export interface MessageRouting {
+  channels: Array<MessageRoutingChannel>;
+
+  method: 'all' | 'single';
+}
+
+export type MessageRoutingChannel = string | MessageRouting;
+
+export interface Preference {
+  status: PreferencesAPI.PreferenceStatus;
+
+  channel_preferences?: Array<ChannelPreference> | null;
+
+  rules?: Array<Rule> | null;
+
+  source?: 'subscription' | 'list' | 'recipient' | null;
+}
+
+export interface Rule {
+  until: string;
+
+  start?: string | null;
+}
+
+export type TextStyle = 'text' | 'h1' | 'h2' | 'subtext';

package/src/resources/tenants/index.ts

@@ -1,5 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  Templates,
+  type BaseTemplateTenantAssociation,
+  type ElementalContent,
+  type TemplateListResponse,
+  type TemplateRetrieveParams,
+  type TemplateListParams,
+} from './templates';
 export {
   Tenants,
   type DefaultPreferences,

package/src/resources/tenants/templates.ts

@@ -0,0 +1,165 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as TemplatesAPI from './templates';
+import * as SendAPI from '../send';
+import * as Shared from '../shared';
+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<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 BaseTemplateTenantAssociation {
+  /**
+   * The template's id
+   */
+  id: string;
+
+  /**
+   * The timestamp at which the template was created
+   */
+  created_at: string;
+
+  /**
+   * The timestamp at which the template was published
+   */
+  published_at: string;
+
+  /**
+   * The timestamp at which the template was last updated
+   */
+  updated_at: string;
+
+  /**
+   * The version of the template
+   */
+  version: string;
+}
+
+export interface ElementalContent {
+  elements: Array<SendAPI.ElementalNode>;
+
+  /**
+   * For example, "2022-01-01"
+   */
+  version: string;
+
+  brand?: string | null;
+}
+
+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 TemplatesAPI.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 BaseTemplateTenantAssociation as BaseTemplateTenantAssociation,
+    type ElementalContent as ElementalContent,
+    type TemplateListResponse as TemplateListResponse,
+    type TemplateRetrieveParams as TemplateRetrieveParams,
+    type TemplateListParams as TemplateListParams,
+  };
+}

package/src/resources/tenants/tenants.ts

@@ -1,6 +1,15 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as TemplatesAPI from './templates';
+import {
+  BaseTemplateTenantAssociation,
+  ElementalContent,
+  TemplateListParams,
+  TemplateListResponse,
+  TemplateRetrieveParams,
+  Templates,
+} from './templates';
 import * as UsersTenantsAPI from '../users/tenants';
 import * as DefaultPreferencesAPI from './default-preferences/default-preferences';
 import * as ItemsAPI from './default-preferences/items';
@@ -13,6 +22,7 @@ export class Tenants extends APIResource {
   defaultPreferences: DefaultPreferencesAPI.DefaultPreferences = new DefaultPreferencesAPI.DefaultPreferences(
     this._client,
   );
+  templates: TemplatesAPI.Templates = new TemplatesAPI.Templates(this._client);
 
   /**
    * Get a Tenant
@@ -267,6 +277,8 @@ export interface TenantListUsersParams {
   limit?: number | null;
 }
 
+Tenants.Templates = Templates;
+
 export declare namespace Tenants {
   export {
     type DefaultPreferences as DefaultPreferences,
@@ -277,4 +289,13 @@ export declare namespace Tenants {
     type TenantListParams as TenantListParams,
     type TenantListUsersParams as TenantListUsersParams,
   };
+
+  export {
+    Templates as Templates,
+    type BaseTemplateTenantAssociation as BaseTemplateTenantAssociation,
+    type ElementalContent as ElementalContent,
+    type TemplateListResponse as TemplateListResponse,
+    type TemplateRetrieveParams as TemplateRetrieveParams,
+    type TemplateListParams as TemplateListParams,
+  };
 }

package/src/resources/users/index.ts

@@ -23,11 +23,11 @@ export {
 export {
   Tokens,
   type UserToken,
+  type TokenRetrieveResponse,
   type TokenListResponse,
-  type TokenRetrieveSingleResponse,
+  type TokenRetrieveParams,
   type TokenUpdateParams,
   type TokenDeleteParams,
   type TokenAddSingleParams,
-  type TokenRetrieveSingleParams,
 } from './tokens';
 export { Users } from './users';

package/src/resources/users/tokens.ts

@@ -7,6 +7,25 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class Tokens extends APIResource {
+  /**
+   * Get single token available for a `:token`
+   *
+   * @example
+   * ```ts
+   * const token = await client.users.tokens.retrieve('token', {
+   *   user_id: 'user_id',
+   * });
+   * ```
+   */
+  retrieve(
+    token: string,
+    params: TokenRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<TokenRetrieveResponse> {
+    const { user_id } = params;
+    return this._client.get(path`/users/${user_id}/tokens/${token}`, options);
+  }
+
   /**
    * Apply a JSON Patch (RFC 6902) to the specified token.
    *
@@ -93,26 +112,6 @@ export class Tokens extends APIResource {
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
-
-  /**
-   * Get single token available for a `:token`
-   *
-   * @example
-   * ```ts
-   * const response = await client.users.tokens.retrieveSingle(
-   *   'token',
-   *   { user_id: 'user_id' },
-   * );
-   * ```
-   */
-  retrieveSingle(
-    token: string,
-    params: TokenRetrieveSingleParams,
-    options?: RequestOptions,
-  ): APIPromise<TokenRetrieveSingleResponse> {
-    const { user_id } = params;
-    return this._client.get(path`/users/${user_id}/tokens/${token}`, options);
-  }
 }
 
 export interface UserToken {
@@ -207,18 +206,25 @@ export namespace UserToken {
   }
 }
 
+export interface TokenRetrieveResponse extends UserToken {
+  status?: 'active' | 'unknown' | 'failed' | 'revoked' | null;
+
+  /**
+   * The reason for the token status.
+   */
+  status_reason?: string | null;
+}
+
 /**
  * A list of tokens registered with the user.
  */
 export type TokenListResponse = Array<UserToken>;
 
-export interface TokenRetrieveSingleResponse extends UserToken {
-  status?: 'active' | 'unknown' | 'failed' | 'revoked' | null;
-
+export interface TokenRetrieveParams {
   /**
-   * The reason for the token status.
+   * The user's ID. This can be any uniquely identifiable string.
    */
-  status_reason?: string | null;
+  user_id: string;
 }
 
 export interface TokenUpdateParams {
@@ -359,21 +365,14 @@ export namespace TokenAddSingleParams {
   }
 }
 
-export interface TokenRetrieveSingleParams {
-  /**
-   * The user's ID. This can be any uniquely identifiable string.
-   */
-  user_id: string;
-}
-
 export declare namespace Tokens {
   export {
     type UserToken as UserToken,
+    type TokenRetrieveResponse as TokenRetrieveResponse,
     type TokenListResponse as TokenListResponse,
-    type TokenRetrieveSingleResponse as TokenRetrieveSingleResponse,
+    type TokenRetrieveParams as TokenRetrieveParams,
     type TokenUpdateParams as TokenUpdateParams,
     type TokenDeleteParams as TokenDeleteParams,
     type TokenAddSingleParams as TokenAddSingleParams,
-    type TokenRetrieveSingleParams as TokenRetrieveSingleParams,
   };
 }

package/src/resources/users/users.ts

@@ -28,8 +28,8 @@ import {
   TokenAddSingleParams,
   TokenDeleteParams,
   TokenListResponse,
-  TokenRetrieveSingleParams,
-  TokenRetrieveSingleResponse,
+  TokenRetrieveParams,
+  TokenRetrieveResponse,
   TokenUpdateParams,
   Tokens,
   UserToken,
@@ -71,11 +71,11 @@ export declare namespace Users {
   export {
     Tokens as Tokens,
     type UserToken as UserToken,
+    type TokenRetrieveResponse as TokenRetrieveResponse,
     type TokenListResponse as TokenListResponse,
-    type TokenRetrieveSingleResponse as TokenRetrieveSingleResponse,
+    type TokenRetrieveParams as TokenRetrieveParams,
     type TokenUpdateParams as TokenUpdateParams,
     type TokenDeleteParams as TokenDeleteParams,
     type TokenAddSingleParams as TokenAddSingleParams,
-    type TokenRetrieveSingleParams as TokenRetrieveSingleParams,
   };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '6.6.1-alpha0'; // x-release-please-version
+export const VERSION = '6.7.0-alpha2'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.6.1-alpha0";
+export declare const VERSION = "6.7.0-alpha2";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.6.1-alpha0";
+export declare const VERSION = "6.7.0-alpha2";
 //# 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 = '6.6.1-alpha0'; // x-release-please-version
+exports.VERSION = '6.7.0-alpha2'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '6.6.1-alpha0'; // x-release-please-version
+export const VERSION = '6.7.0-alpha2'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map