@trycourier/courier 6.7.0-alpha3 → 7.0.0

package/src/resources/lists/lists.ts

@@ -1,12 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as AudiencesAPI from '../audiences';
+import * as Shared from '../shared';
 import * as SubscriptionsAPI from './subscriptions';
 import {
-  NotificationPreferenceDetails,
-  PutSubscriptionsRecipient,
-  RecipientPreferences,
   SubscriptionAddParams,
   SubscriptionListParams,
   SubscriptionListResponse,
@@ -26,7 +23,7 @@ export class Lists extends APIResource {
   /**
    * Returns a list based on the list ID provided.
    */
-  retrieve(listID: string, options?: RequestOptions): APIPromise<List> {
+  retrieve(listID: string, options?: RequestOptions): APIPromise<SubscriptionList> {
     return this._client.get(path`/lists/${listID}`, options);
   }
 
@@ -73,7 +70,13 @@ export class Lists extends APIResource {
   }
 }
 
-export interface List {
+export interface PutSubscriptionsRecipient {
+  recipientId: string;
+
+  preferences?: Shared.RecipientPreferences | null;
+}
+
+export interface SubscriptionList {
   id: string;
 
   name: string;
@@ -84,15 +87,15 @@ export interface List {
 }
 
 export interface ListListResponse {
-  items: Array<List>;
+  items: Array<SubscriptionList>;
 
-  paging: AudiencesAPI.Paging;
+  paging: Shared.Paging;
 }
 
 export interface ListUpdateParams {
   name: string;
 
-  preferences?: SubscriptionsAPI.RecipientPreferences | null;
+  preferences?: Shared.RecipientPreferences | null;
 }
 
 export interface ListListParams {
@@ -116,7 +119,8 @@ Lists.Subscriptions = Subscriptions;
 
 export declare namespace Lists {
   export {
-    type List as List,
+    type PutSubscriptionsRecipient as PutSubscriptionsRecipient,
+    type SubscriptionList as SubscriptionList,
     type ListListResponse as ListListResponse,
     type ListUpdateParams as ListUpdateParams,
     type ListListParams as ListListParams,
@@ -125,9 +129,6 @@ export declare namespace Lists {
 
   export {
     Subscriptions as Subscriptions,
-    type NotificationPreferenceDetails as NotificationPreferenceDetails,
-    type PutSubscriptionsRecipient as PutSubscriptionsRecipient,
-    type RecipientPreferences as RecipientPreferences,
     type SubscriptionListResponse as SubscriptionListResponse,
     type SubscriptionListParams as SubscriptionListParams,
     type SubscriptionAddParams as SubscriptionAddParams,

package/src/resources/lists/subscriptions.ts

@@ -1,10 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as SubscriptionsAPI from './subscriptions';
-import * as AudiencesAPI from '../audiences';
 import * as Shared from '../shared';
-import * as PreferencesAPI from '../users/preferences';
+import * as ListsAPI from './lists';
 import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
@@ -79,30 +77,10 @@ export class Subscriptions extends APIResource {
   }
 }
 
-export interface NotificationPreferenceDetails {
-  status: PreferencesAPI.PreferenceStatus;
-
-  channel_preferences?: Array<Shared.ChannelPreference> | null;
-
-  rules?: Array<Shared.Rule> | null;
-}
-
-export interface PutSubscriptionsRecipient {
-  recipientId: string;
-
-  preferences?: RecipientPreferences | null;
-}
-
-export interface RecipientPreferences {
-  categories?: { [key: string]: NotificationPreferenceDetails } | null;
-
-  notifications?: { [key: string]: NotificationPreferenceDetails } | null;
-}
-
 export interface SubscriptionListResponse {
   items: Array<SubscriptionListResponse.Item>;
 
-  paging: AudiencesAPI.Paging;
+  paging: Shared.Paging;
 }
 
 export namespace SubscriptionListResponse {
@@ -111,7 +89,7 @@ export namespace SubscriptionListResponse {
 
     created?: string | null;
 
-    preferences?: SubscriptionsAPI.RecipientPreferences | null;
+    preferences?: Shared.RecipientPreferences | null;
   }
 }
 
@@ -123,11 +101,11 @@ export interface SubscriptionListParams {
 }
 
 export interface SubscriptionAddParams {
-  recipients: Array<PutSubscriptionsRecipient>;
+  recipients: Array<ListsAPI.PutSubscriptionsRecipient>;
 }
 
 export interface SubscriptionSubscribeParams {
-  recipients: Array<PutSubscriptionsRecipient>;
+  recipients: Array<ListsAPI.PutSubscriptionsRecipient>;
 }
 
 export interface SubscriptionSubscribeUserParams {
@@ -139,7 +117,7 @@ export interface SubscriptionSubscribeUserParams {
   /**
    * Body param:
    */
-  preferences?: RecipientPreferences | null;
+  preferences?: Shared.RecipientPreferences | null;
 }
 
 export interface SubscriptionUnsubscribeUserParams {
@@ -151,9 +129,6 @@ export interface SubscriptionUnsubscribeUserParams {
 
 export declare namespace Subscriptions {
   export {
-    type NotificationPreferenceDetails as NotificationPreferenceDetails,
-    type PutSubscriptionsRecipient as PutSubscriptionsRecipient,
-    type RecipientPreferences as RecipientPreferences,
     type SubscriptionListResponse as SubscriptionListResponse,
     type SubscriptionListParams as SubscriptionListParams,
     type SubscriptionAddParams as SubscriptionAddParams,

package/src/resources/messages.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import * as AudiencesAPI from './audiences';
+import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
@@ -155,7 +155,7 @@ export interface MessageListResponse {
   /**
    * Paging information for the result set.
    */
-  paging: AudiencesAPI.Paging;
+  paging: Shared.Paging;
 
   /**
    * An array of messages with their details.

package/src/resources/notifications/checks.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as NotificationsAPI from './notifications';
 import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
@@ -34,24 +35,12 @@ export class Checks extends APIResource {
   }
 }
 
-export interface BaseCheck {
-  id: string;
-
-  status: 'RESOLVED' | 'FAILED' | 'PENDING';
-
-  type: 'custom';
-}
-
-export interface Check extends BaseCheck {
-  updated: number;
-}
-
 export interface CheckUpdateResponse {
-  checks: Array<Check>;
+  checks: Array<NotificationsAPI.Check>;
 }
 
 export interface CheckListResponse {
-  checks: Array<Check>;
+  checks: Array<NotificationsAPI.Check>;
 }
 
 export interface CheckUpdateParams {
@@ -63,7 +52,7 @@ export interface CheckUpdateParams {
   /**
    * Body param:
    */
-  checks: Array<BaseCheck>;
+  checks: Array<NotificationsAPI.BaseCheck>;
 }
 
 export interface CheckListParams {
@@ -76,8 +65,6 @@ export interface CheckDeleteParams {
 
 export declare namespace Checks {
   export {
-    type BaseCheck as BaseCheck,
-    type Check as Check,
     type CheckUpdateResponse as CheckUpdateResponse,
     type CheckListResponse as CheckListResponse,
     type CheckUpdateParams as CheckUpdateParams,

package/src/resources/notifications/index.ts

@@ -2,8 +2,6 @@
 
 export {
   Checks,
-  type BaseCheck,
-  type Check,
   type CheckUpdateResponse,
   type CheckListResponse,
   type CheckUpdateParams,
@@ -13,6 +11,8 @@ export {
 export { Draft } from './draft';
 export {
   Notifications,
+  type BaseCheck,
+  type Check,
   type NotificationGetContent,
   type NotificationListResponse,
   type NotificationListParams,

package/src/resources/notifications/notifications.ts

@@ -1,12 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as AudiencesAPI from '../audiences';
 import * as Shared from '../shared';
 import * as ChecksAPI from './checks';
 import {
-  BaseCheck,
-  Check,
   CheckDeleteParams,
   CheckListParams,
   CheckListResponse,
@@ -36,6 +33,18 @@ export class Notifications extends APIResource {
   }
 }
 
+export interface BaseCheck {
+  id: string;
+
+  status: 'RESOLVED' | 'FAILED' | 'PENDING';
+
+  type: 'custom';
+}
+
+export interface Check extends BaseCheck {
+  updated: number;
+}
+
 export interface NotificationGetContent {
   blocks?: Array<NotificationGetContent.Block> | null;
 
@@ -103,7 +112,7 @@ export namespace NotificationGetContent {
 }
 
 export interface NotificationListResponse {
-  paging: AudiencesAPI.Paging;
+  paging: Shared.Paging;
 
   results: Array<NotificationListResponse.Result>;
 }
@@ -156,6 +165,8 @@ Notifications.Checks = Checks;
 
 export declare namespace Notifications {
   export {
+    type BaseCheck as BaseCheck,
+    type Check as Check,
     type NotificationGetContent as NotificationGetContent,
     type NotificationListResponse as NotificationListResponse,
     type NotificationListParams as NotificationListParams,
@@ -165,8 +176,6 @@ export declare namespace Notifications {
 
   export {
     Checks as Checks,
-    type BaseCheck as BaseCheck,
-    type Check as Check,
     type CheckUpdateResponse as CheckUpdateResponse,
     type CheckListResponse as CheckListResponse,
     type CheckUpdateParams as CheckUpdateParams,

package/src/resources/profiles/index.ts

@@ -10,6 +10,7 @@ export {
 } from './lists';
 export {
   Profiles,
+  type SubscribeToListsRequestItem,
   type ProfileCreateResponse,
   type ProfileRetrieveResponse,
   type ProfileReplaceResponse,

package/src/resources/profiles/lists.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as AudiencesAPI from '../audiences';
-import * as SubscriptionsAPI from '../lists/subscriptions';
+import * as Shared from '../shared';
+import * as ProfilesAPI from './profiles';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -40,7 +40,7 @@ export class Lists extends APIResource {
 }
 
 export interface ListRetrieveResponse {
-  paging: AudiencesAPI.Paging;
+  paging: Shared.Paging;
 
   /**
    * An array of lists
@@ -69,7 +69,7 @@ export namespace ListRetrieveResponse {
      */
     updated: string;
 
-    preferences?: SubscriptionsAPI.RecipientPreferences | null;
+    preferences?: Shared.RecipientPreferences | null;
   }
 }
 
@@ -89,15 +89,7 @@ export interface ListRetrieveParams {
 }
 
 export interface ListSubscribeParams {
-  lists: Array<ListSubscribeParams.List>;
-}
-
-export namespace ListSubscribeParams {
-  export interface List {
-    listId: string;
-
-    preferences?: SubscriptionsAPI.RecipientPreferences | null;
-  }
+  lists: Array<ProfilesAPI.SubscribeToListsRequestItem>;
 }
 
 export declare namespace Lists {

package/src/resources/profiles/profiles.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as SubscriptionsAPI from '../lists/subscriptions';
+import * as Shared from '../shared';
 import * as ListsAPI from './lists';
 import {
   ListDeleteResponse,
@@ -75,6 +75,12 @@ export class Profiles extends APIResource {
   }
 }
 
+export interface SubscribeToListsRequestItem {
+  listId: string;
+
+  preferences?: Shared.RecipientPreferences | null;
+}
+
 export interface ProfileCreateResponse {
   status: 'SUCCESS';
 }
@@ -82,7 +88,7 @@ export interface ProfileCreateResponse {
 export interface ProfileRetrieveResponse {
   profile: { [key: string]: unknown };
 
-  preferences?: SubscriptionsAPI.RecipientPreferences | null;
+  preferences?: Shared.RecipientPreferences | null;
 }
 
 export interface ProfileReplaceResponse {
@@ -127,6 +133,7 @@ Profiles.Lists = Lists;
 
 export declare namespace Profiles {
   export {
+    type SubscribeToListsRequestItem as SubscribeToListsRequestItem,
     type ProfileCreateResponse as ProfileCreateResponse,
     type ProfileRetrieveResponse as ProfileRetrieveResponse,
     type ProfileReplaceResponse as ProfileReplaceResponse,

package/src/resources/send.ts

@@ -1,16 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import * as SendAPI from './send';
-import * as BulkAPI from './bulk';
 import * as Shared from './shared';
-import * as TemplatesAPI from './tenants/templates';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
 export class Send extends APIResource {
   /**
-   * Use the send API to send a message to one or more recipients.
+   * Send a message to one or more recipients.
    *
    * @example
    * ```ts
@@ -18,7 +15,7 @@ export class Send extends APIResource {
    *   message: {
    *     to: { user_id: 'example_user' },
    *     template: 'template_id',
-   *     data: { name: 'Example Name' },
+   *     data: { foo: 'bar' },
    *   },
    * });
    * ```
@@ -28,199 +25,6 @@ export class Send extends APIResource {
   }
 }
 
-/**
- * The channel element allows a notification to be customized based on which
- * channel it is sent through. For example, you may want to display a detailed
- * message when the notification is sent through email, and a more concise message
- * in a push notification. Channel elements are only valid as top-level elements;
- * you cannot nest channel elements. If there is a channel element specified at the
- * top-level of the document, all sibling elements must be channel elements. Note:
- * As an alternative, most elements support a `channel` property. Which allows you
- * to selectively display an individual element on a per channel basis. See the
- * [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/)
- * for more details.
- */
-export interface ElementalChannelNode extends Shared.ElementalBaseNode {
-  /**
-   * The channel the contents of this element should be applied to. Can be `email`,
-   * `push`, `direct_message`, `sms` or a provider such as slack
-   */
-  channel: string;
-
-  /**
-   * Raw data to apply to the channel. If `elements` has not been specified, `raw` is
-   * `required`.
-   */
-  raw?: { [key: string]: unknown } | null;
-}
-
-/**
- * The channel element allows a notification to be customized based on which
- * channel it is sent through. For example, you may want to display a detailed
- * message when the notification is sent through email, and a more concise message
- * in a push notification. Channel elements are only valid as top-level elements;
- * you cannot nest channel elements. If there is a channel element specified at the
- * top-level of the document, all sibling elements must be channel elements. Note:
- * As an alternative, most elements support a `channel` property. Which allows you
- * to selectively display an individual element on a per channel basis. See the
- * [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/)
- * for more details.
- */
-export type ElementalNode =
-  | ElementalNode.UnionMember0
-  | ElementalNode.UnionMember1
-  | ElementalNode.UnionMember2
-  | ElementalNode.UnionMember3
-  | ElementalNode.UnionMember4
-  | ElementalNode.UnionMember5
-  | ElementalNode.UnionMember6;
-
-export namespace ElementalNode {
-  export interface UnionMember0 extends Shared.ElementalBaseNode {
-    type?: 'text';
-  }
-
-  export interface UnionMember1 extends Shared.ElementalBaseNode {
-    type?: 'meta';
-  }
-
-  /**
-   * The channel element allows a notification to be customized based on which
-   * channel it is sent through. For example, you may want to display a detailed
-   * message when the notification is sent through email, and a more concise message
-   * in a push notification. Channel elements are only valid as top-level elements;
-   * you cannot nest channel elements. If there is a channel element specified at the
-   * top-level of the document, all sibling elements must be channel elements. Note:
-   * As an alternative, most elements support a `channel` property. Which allows you
-   * to selectively display an individual element on a per channel basis. See the
-   * [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/)
-   * for more details.
-   */
-  export interface UnionMember2 extends SendAPI.ElementalChannelNode {
-    type?: 'channel';
-  }
-
-  export interface UnionMember3 extends Shared.ElementalBaseNode {
-    type?: 'image';
-  }
-
-  export interface UnionMember4 {
-    /**
-     * A unique id used to identify the action when it is executed.
-     */
-    action_id?: string | null;
-
-    /**
-     * The alignment of the action button. Defaults to "center".
-     */
-    align?: Shared.Alignment | null;
-
-    /**
-     * The background color of the action button.
-     */
-    background_color?: string | null;
-
-    /**
-     * The text content of the action shown to the user.
-     */
-    content?: string;
-
-    /**
-     * The target URL of the action.
-     */
-    href?: string;
-
-    /**
-     * Region specific content. See
-     * [locales docs](https://www.courier.com/docs/platform/content/elemental/locales/)
-     * for more details.
-     */
-    locales?: { [key: string]: UnionMember4.Locales } | null;
-
-    /**
-     * Defaults to `button`.
-     */
-    style?: 'button' | 'link' | null;
-
-    type?: 'action';
-  }
-
-  export namespace UnionMember4 {
-    export interface Locales {
-      content: string;
-    }
-  }
-
-  export interface UnionMember5 extends Shared.ElementalBaseNode {
-    type?: 'divider';
-  }
-
-  export interface UnionMember6 extends Shared.ElementalBaseNode {
-    type?: 'quote';
-  }
-}
-
-export interface MessageContext {
-  /**
-   * Tenant id used to load brand/default preferences/context.
-   */
-  tenant_id?: string | null;
-}
-
-export interface Recipient {
-  /**
-   * Use `tenant_id` instead.
-   */
-  account_id?: string | null;
-
-  /**
-   * Context such as tenant_id to send the notification with.
-   */
-  context?: MessageContext | null;
-
-  data?: { [key: string]: unknown } | null;
-
-  email?: string | null;
-
-  /**
-   * The user's preferred ISO 639-1 language code.
-   */
-  locale?: string | null;
-
-  phone_number?: string | null;
-
-  preferences?: Recipient.Preferences | null;
-
-  /**
-   * Tenant id. Will load brand, default preferences and base context data.
-   */
-  tenant_id?: string | null;
-
-  user_id?: string | null;
-}
-
-export namespace Recipient {
-  export interface Preferences {
-    notifications: { [key: string]: Shared.Preference };
-
-    categories?: { [key: string]: Shared.Preference } | null;
-
-    templateId?: string | null;
-  }
-}
-
-export interface Utm {
-  campaign?: string | null;
-
-  content?: string | null;
-
-  medium?: string | null;
-
-  source?: string | null;
-
-  term?: string | null;
-}
-
 export interface SendMessageResponse {
   /**
    * A successful call to `POST /send` returns a `202` status code along with a
@@ -257,9 +61,9 @@ export namespace SendMessageParams {
      * Describes content that will work for email, inbox, push, chat, or any channel
      * id.
      */
-    content?: Shared.ElementalContentSugar | TemplatesAPI.ElementalContent;
+    content?: Shared.ElementalContentSugar | Shared.ElementalContent;
 
-    context?: SendAPI.MessageContext | null;
+    context?: Shared.MessageContext | null;
 
     data?: { [key: string]: unknown } | null;
 
@@ -278,9 +82,6 @@ export namespace SendMessageParams {
      */
     routing?: Message.Routing | null;
 
-    /**
-     * The id of the template you want to send
-     */
     template?: string | null;
 
     timeout?: Message.Timeout | null;
@@ -288,7 +89,7 @@ export namespace SendMessageParams {
     /**
      * The recipient or a list of recipients of the message
      */
-    to?: BulkAPI.UserRecipient | Array<SendAPI.Recipient> | null;
+    to?: Shared.UserRecipient | Array<Shared.Recipient> | null;
   }
 
   export namespace Message {
@@ -325,7 +126,7 @@ export namespace SendMessageParams {
 
     export namespace Channels {
       export interface Metadata {
-        utm?: SendAPI.Utm | null;
+        utm?: Shared.Utm | null;
       }
 
       export interface Timeouts {
@@ -366,7 +167,7 @@ export namespace SendMessageParams {
 
       trace_id?: string | null;
 
-      utm?: SendAPI.Utm | null;
+      utm?: Shared.Utm | null;
     }
 
     export interface Preferences {
@@ -394,7 +195,7 @@ export namespace SendMessageParams {
 
     export namespace Providers {
       export interface Metadata {
-        utm?: SendAPI.Utm | null;
+        utm?: Shared.Utm | null;
       }
     }
 
@@ -425,13 +226,5 @@ export namespace SendMessageParams {
 }
 
 export declare namespace Send {
-  export {
-    type ElementalChannelNode as ElementalChannelNode,
-    type ElementalNode as ElementalNode,
-    type MessageContext as MessageContext,
-    type Recipient as Recipient,
-    type Utm as Utm,
-    type SendMessageResponse as SendMessageResponse,
-    type SendMessageParams as SendMessageParams,
-  };
+  export { type SendMessageResponse as SendMessageResponse, type SendMessageParams as SendMessageParams };
 }