@trycourier/courier 6.6.1-alpha0 → 6.7.0-alpha10

package/src/resources/lists/lists.ts

@@ -1,11 +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 {
-  PutSubscriptionsRecipient,
-  RecipientPreferences,
   SubscriptionAddParams,
   SubscriptionListParams,
   SubscriptionListResponse,
@@ -25,15 +23,19 @@ 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);
   }
 
   /**
    * Create or replace an existing list with the supplied values.
    */
-  update(listID: string, body: ListUpdateParams, options?: RequestOptions): APIPromise<List> {
-    return this._client.put(path`/lists/${listID}`, { body, ...options });
+  update(listID: string, body: ListUpdateParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.put(path`/lists/${listID}`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
   }
 
   /**
@@ -59,34 +61,41 @@ export class Lists extends APIResource {
   /**
    * Restore a previously deleted list.
    */
-  restore(listID: string, options?: RequestOptions): APIPromise<void> {
+  restore(listID: string, body: ListRestoreParams, options?: RequestOptions): APIPromise<void> {
     return this._client.put(path`/lists/${listID}/restore`, {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 }
 
-export interface List {
+export interface PutSubscriptionsRecipient {
+  recipientId: string;
+
+  preferences?: Shared.RecipientPreferences | null;
+}
+
+export interface SubscriptionList {
   id: string;
 
   name: string;
 
-  created?: number | null;
+  created?: string | null;
 
-  updated?: number | null;
+  updated?: string | null;
 }
 
 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 {
@@ -104,20 +113,22 @@ export interface ListListParams {
   pattern?: string | null;
 }
 
+export interface ListRestoreParams {}
+
 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,
+    type ListRestoreParams as ListRestoreParams,
   };
 
   export {
     Subscriptions as Subscriptions,
-    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 PreferencesAPI from '../users/preferences';
-import * as ItemsAPI from '../tenants/default-preferences/items';
+import * as Shared from '../shared';
+import * as ListsAPI from './lists';
 import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
@@ -79,64 +77,10 @@ export class Subscriptions extends APIResource {
   }
 }
 
-export interface PutSubscriptionsRecipient {
-  recipientId: string;
-
-  preferences?: RecipientPreferences | null;
-}
-
-export interface RecipientPreferences {
-  categories?: { [key: string]: RecipientPreferences.Categories } | null;
-
-  notifications?: { [key: string]: RecipientPreferences.Notifications } | null;
-}
-
-export namespace RecipientPreferences {
-  export interface Categories {
-    status: PreferencesAPI.PreferenceStatus;
-
-    channel_preferences?: Array<Categories.ChannelPreference> | null;
-
-    rules?: Array<Categories.Rule> | null;
-  }
-
-  export namespace Categories {
-    export interface ChannelPreference {
-      channel: ItemsAPI.ChannelClassification;
-    }
-
-    export interface Rule {
-      until: string;
-
-      start?: string | null;
-    }
-  }
-
-  export interface Notifications {
-    status: PreferencesAPI.PreferenceStatus;
-
-    channel_preferences?: Array<Notifications.ChannelPreference> | null;
-
-    rules?: Array<Notifications.Rule> | null;
-  }
-
-  export namespace Notifications {
-    export interface ChannelPreference {
-      channel: ItemsAPI.ChannelClassification;
-    }
-
-    export interface Rule {
-      until: string;
-
-      start?: string | null;
-    }
-  }
-}
-
 export interface SubscriptionListResponse {
   items: Array<SubscriptionListResponse.Item>;
 
-  paging: AudiencesAPI.Paging;
+  paging: Shared.Paging;
 }
 
 export namespace SubscriptionListResponse {
@@ -145,7 +89,7 @@ export namespace SubscriptionListResponse {
 
     created?: string | null;
 
-    preferences?: SubscriptionsAPI.RecipientPreferences | null;
+    preferences?: Shared.RecipientPreferences | null;
   }
 }
 
@@ -157,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 {
@@ -173,7 +117,7 @@ export interface SubscriptionSubscribeUserParams {
   /**
    * Body param:
    */
-  preferences?: RecipientPreferences | null;
+  preferences?: Shared.RecipientPreferences | null;
 }
 
 export interface SubscriptionUnsubscribeUserParams {
@@ -185,8 +129,6 @@ export interface SubscriptionUnsubscribeUserParams {
 
 export declare namespace Subscriptions {
   export {
-    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';
@@ -38,7 +38,7 @@ export class Messages extends APIResource {
   /**
    * Get message content
    */
-  getContent(messageID: string, options?: RequestOptions): APIPromise<MessageGetContentResponse> {
+  content(messageID: string, options?: RequestOptions): APIPromise<MessageContentResponse> {
     return this._client.get(path`/messages/${messageID}/output`, options);
   }
 
@@ -135,9 +135,12 @@ export interface MessageDetails {
    * The reason for the current status of the message.
    */
   reason?:
+    | 'BOUNCED'
+    | 'FAILED'
     | 'FILTERED'
     | 'NO_CHANNELS'
     | 'NO_PROVIDERS'
+    | 'OPT_IN_REQUIRED'
     | 'PROVIDER_ERROR'
     | 'UNPUBLISHED'
     | 'UNSUBSCRIBED'
@@ -152,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.
@@ -160,14 +163,14 @@ export interface MessageListResponse {
   results: Array<MessageDetails>;
 }
 
-export interface MessageGetContentResponse {
+export interface MessageContentResponse {
   /**
    * An array of render output of a previously sent message.
    */
-  results: Array<MessageGetContentResponse.Result>;
+  results: Array<MessageContentResponse.Result>;
 }
 
-export namespace MessageGetContentResponse {
+export namespace MessageContentResponse {
   export interface Result {
     /**
      * The channel used for rendering the message.
@@ -334,7 +337,7 @@ export declare namespace Messages {
     type MessageDetails as MessageDetails,
     type MessageRetrieveResponse as MessageRetrieveResponse,
     type MessageListResponse as MessageListResponse,
-    type MessageGetContentResponse as MessageGetContentResponse,
+    type MessageContentResponse as MessageContentResponse,
     type MessageHistoryResponse as MessageHistoryResponse,
     type MessageListParams as MessageListParams,
     type MessageHistoryParams as MessageHistoryParams,

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,8 +11,8 @@ export {
 export { Draft } from './draft';
 export {
   Notifications,
-  type MessageRouting,
-  type MessageRoutingChannel,
+  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 NotificationsAPI from './notifications';
-import * as AudiencesAPI from '../audiences';
+import * as Shared from '../shared';
 import * as ChecksAPI from './checks';
 import {
-  BaseCheck,
-  Check,
   CheckDeleteParams,
   CheckListParams,
   CheckListResponse,
@@ -36,13 +33,17 @@ export class Notifications extends APIResource {
   }
 }
 
-export interface MessageRouting {
-  channels: Array<MessageRoutingChannel>;
+export interface BaseCheck {
+  id: string;
 
-  method: 'all' | 'single';
+  status: 'RESOLVED' | 'FAILED' | 'PENDING';
+
+  type: 'custom';
 }
 
-export type MessageRoutingChannel = string | MessageRouting;
+export interface Check extends BaseCheck {
+  updated: number;
+}
 
 export interface NotificationGetContent {
   blocks?: Array<NotificationGetContent.Block> | null;
@@ -111,7 +112,7 @@ export namespace NotificationGetContent {
 }
 
 export interface NotificationListResponse {
-  paging: AudiencesAPI.Paging;
+  paging: Shared.Paging;
 
   results: Array<NotificationListResponse.Result>;
 }
@@ -124,7 +125,7 @@ export namespace NotificationListResponse {
 
     note: string;
 
-    routing: NotificationsAPI.MessageRouting;
+    routing: Shared.MessageRouting;
 
     topic_id: string;
 
@@ -164,8 +165,8 @@ Notifications.Checks = Checks;
 
 export declare namespace Notifications {
   export {
-    type MessageRouting as MessageRouting,
-    type MessageRoutingChannel as MessageRoutingChannel,
+    type BaseCheck as BaseCheck,
+    type Check as Check,
     type NotificationGetContent as NotificationGetContent,
     type NotificationListResponse as NotificationListResponse,
     type NotificationListParams as NotificationListParams,
@@ -175,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,