@trycourier/courier 6.6.0 → 6.7.0-alpha2

package/src/resources/notifications/checks.ts

@@ -0,0 +1,87 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Checks extends APIResource {
+  update(
+    submissionID: string,
+    params: CheckUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<CheckUpdateResponse> {
+    const { id, ...body } = params;
+    return this._client.put(path`/notifications/${id}/${submissionID}/checks`, { body, ...options });
+  }
+
+  list(
+    submissionID: string,
+    params: CheckListParams,
+    options?: RequestOptions,
+  ): APIPromise<CheckListResponse> {
+    const { id } = params;
+    return this._client.get(path`/notifications/${id}/${submissionID}/checks`, options);
+  }
+
+  delete(submissionID: string, params: CheckDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { id } = params;
+    return this._client.delete(path`/notifications/${id}/${submissionID}/checks`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface BaseCheck {
+  id: string;
+
+  status: 'RESOLVED' | 'FAILED' | 'PENDING';
+
+  type: 'custom';
+}
+
+export interface Check extends BaseCheck {
+  updated: number;
+}
+
+export interface CheckUpdateResponse {
+  checks: Array<Check>;
+}
+
+export interface CheckListResponse {
+  checks: Array<Check>;
+}
+
+export interface CheckUpdateParams {
+  /**
+   * Path param:
+   */
+  id: string;
+
+  /**
+   * Body param:
+   */
+  checks: Array<BaseCheck>;
+}
+
+export interface CheckListParams {
+  id: string;
+}
+
+export interface CheckDeleteParams {
+  id: string;
+}
+
+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,
+    type CheckListParams as CheckListParams,
+    type CheckDeleteParams as CheckDeleteParams,
+  };
+}

package/src/resources/notifications/draft.ts

@@ -0,0 +1,13 @@
+// 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 { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Draft extends APIResource {
+  retrieveContent(id: string, options?: RequestOptions): APIPromise<NotificationsAPI.NotificationGetContent> {
+    return this._client.get(path`/notifications/${id}/draft/content`, options);
+  }
+}

package/src/resources/notifications/index.ts

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Checks,
+  type BaseCheck,
+  type Check,
+  type CheckUpdateResponse,
+  type CheckListResponse,
+  type CheckUpdateParams,
+  type CheckListParams,
+  type CheckDeleteParams,
+} from './checks';
+export { Draft } from './draft';
+export {
+  Notifications,
+  type NotificationGetContent,
+  type NotificationListResponse,
+  type NotificationListParams,
+} from './notifications';

package/src/resources/notifications/notifications.ts

@@ -0,0 +1,176 @@
+// 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,
+  CheckUpdateParams,
+  CheckUpdateResponse,
+  Checks,
+} from './checks';
+import * as DraftAPI from './draft';
+import { Draft } from './draft';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Notifications extends APIResource {
+  draft: DraftAPI.Draft = new DraftAPI.Draft(this._client);
+  checks: ChecksAPI.Checks = new ChecksAPI.Checks(this._client);
+
+  list(
+    query: NotificationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<NotificationListResponse> {
+    return this._client.get('/notifications', { query, ...options });
+  }
+
+  retrieveContent(id: string, options?: RequestOptions): APIPromise<NotificationGetContent> {
+    return this._client.get(path`/notifications/${id}/content`, options);
+  }
+}
+
+export interface NotificationGetContent {
+  blocks?: Array<NotificationGetContent.Block> | null;
+
+  channels?: Array<NotificationGetContent.Channel> | null;
+
+  checksum?: string | null;
+}
+
+export namespace NotificationGetContent {
+  export interface Block {
+    id: string;
+
+    type: 'action' | 'divider' | 'image' | 'jsonnet' | 'list' | 'markdown' | 'quote' | 'template' | 'text';
+
+    alias?: string | null;
+
+    checksum?: string | null;
+
+    content?: string | Block.NotificationContentHierarchy | null;
+
+    context?: string | null;
+
+    locales?: { [key: string]: string | Block.NotificationContentHierarchy } | null;
+  }
+
+  export namespace Block {
+    export interface NotificationContentHierarchy {
+      children?: string | null;
+
+      parent?: string | null;
+    }
+
+    export interface NotificationContentHierarchy {
+      children?: string | null;
+
+      parent?: string | null;
+    }
+  }
+
+  export interface Channel {
+    id: string;
+
+    checksum?: string | null;
+
+    content?: Channel.Content | null;
+
+    locales?: { [key: string]: Channel.Locales } | null;
+
+    type?: string | null;
+  }
+
+  export namespace Channel {
+    export interface Content {
+      subject?: string | null;
+
+      title?: string | null;
+    }
+
+    export interface Locales {
+      subject?: string | null;
+
+      title?: string | null;
+    }
+  }
+}
+
+export interface NotificationListResponse {
+  paging: AudiencesAPI.Paging;
+
+  results: Array<NotificationListResponse.Result>;
+}
+
+export namespace NotificationListResponse {
+  export interface Result {
+    id: string;
+
+    created_at: number;
+
+    note: string;
+
+    routing: Shared.MessageRouting;
+
+    topic_id: string;
+
+    updated_at: number;
+
+    tags?: Result.Tags | null;
+
+    title?: string | null;
+  }
+
+  export namespace Result {
+    export interface Tags {
+      data: Array<Tags.Data>;
+    }
+
+    export namespace Tags {
+      export interface Data {
+        id: string;
+
+        name: string;
+      }
+    }
+  }
+}
+
+export interface NotificationListParams {
+  cursor?: string | null;
+
+  /**
+   * Retrieve the notes from the Notification template settings.
+   */
+  notes?: boolean | null;
+}
+
+Notifications.Draft = Draft;
+Notifications.Checks = Checks;
+
+export declare namespace Notifications {
+  export {
+    type NotificationGetContent as NotificationGetContent,
+    type NotificationListResponse as NotificationListResponse,
+    type NotificationListParams as NotificationListParams,
+  };
+
+  export { Draft as Draft };
+
+  export {
+    Checks as Checks,
+    type BaseCheck as BaseCheck,
+    type Check as Check,
+    type CheckUpdateResponse as CheckUpdateResponse,
+    type CheckListResponse as CheckListResponse,
+    type CheckUpdateParams as CheckUpdateParams,
+    type CheckListParams as CheckListParams,
+    type CheckDeleteParams as CheckDeleteParams,
+  };
+}

package/src/resources/notifications.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './notifications/index';

package/src/resources/profiles/index.ts

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Lists,
+  type ListRetrieveResponse,
+  type ListDeleteResponse,
+  type ListSubscribeResponse,
+  type ListRetrieveParams,
+  type ListSubscribeParams,
+} from './lists';
+export {
+  Profiles,
+  type ProfileCreateResponse,
+  type ProfileRetrieveResponse,
+  type ProfileReplaceResponse,
+  type ProfileCreateParams,
+  type ProfileUpdateParams,
+  type ProfileReplaceParams,
+} from './profiles';

package/src/resources/profiles/lists.ts

@@ -0,0 +1,111 @@
+// 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 { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Lists extends APIResource {
+  /**
+   * Returns the subscribed lists for a specified user.
+   */
+  retrieve(
+    userID: string,
+    query: ListRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListRetrieveResponse> {
+    return this._client.get(path`/profiles/${userID}/lists`, { query, ...options });
+  }
+
+  /**
+   * Removes all list subscriptions for given user.
+   */
+  delete(userID: string, options?: RequestOptions): APIPromise<ListDeleteResponse> {
+    return this._client.delete(path`/profiles/${userID}/lists`, options);
+  }
+
+  /**
+   * Subscribes the given user to one or more lists. If the list does not exist, it
+   * will be created.
+   */
+  subscribe(
+    userID: string,
+    body: ListSubscribeParams,
+    options?: RequestOptions,
+  ): APIPromise<ListSubscribeResponse> {
+    return this._client.post(path`/profiles/${userID}/lists`, { body, ...options });
+  }
+}
+
+export interface ListRetrieveResponse {
+  paging: AudiencesAPI.Paging;
+
+  /**
+   * An array of lists
+   */
+  results: Array<ListRetrieveResponse.Result>;
+}
+
+export namespace ListRetrieveResponse {
+  export interface Result {
+    id: string;
+
+    /**
+     * The date/time of when the list was created. Represented as a string in ISO
+     * format.
+     */
+    created: string;
+
+    /**
+     * List name
+     */
+    name: string;
+
+    /**
+     * The date/time of when the list was updated. Represented as a string in ISO
+     * format.
+     */
+    updated: string;
+
+    preferences?: SubscriptionsAPI.RecipientPreferences | null;
+  }
+}
+
+export interface ListDeleteResponse {
+  status: 'SUCCESS';
+}
+
+export interface ListSubscribeResponse {
+  status: 'SUCCESS';
+}
+
+export interface ListRetrieveParams {
+  /**
+   * A unique identifier that allows for fetching the next set of message statuses.
+   */
+  cursor?: string | null;
+}
+
+export interface ListSubscribeParams {
+  lists: Array<ListSubscribeParams.List>;
+}
+
+export namespace ListSubscribeParams {
+  export interface List {
+    listId: string;
+
+    preferences?: SubscriptionsAPI.RecipientPreferences | null;
+  }
+}
+
+export declare namespace Lists {
+  export {
+    type ListRetrieveResponse as ListRetrieveResponse,
+    type ListDeleteResponse as ListDeleteResponse,
+    type ListSubscribeResponse as ListSubscribeResponse,
+    type ListRetrieveParams as ListRetrieveParams,
+    type ListSubscribeParams as ListSubscribeParams,
+  };
+}

package/src/resources/profiles/profiles.ts

@@ -0,0 +1,146 @@
+// 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 ListsAPI from './lists';
+import {
+  ListDeleteResponse,
+  ListRetrieveParams,
+  ListRetrieveResponse,
+  ListSubscribeParams,
+  ListSubscribeResponse,
+  Lists,
+} from './lists';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Profiles extends APIResource {
+  lists: ListsAPI.Lists = new ListsAPI.Lists(this._client);
+
+  /**
+   * Merge the supplied values with an existing profile or create a new profile if
+   * one doesn't already exist.
+   */
+  create(
+    userID: string,
+    body: ProfileCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<ProfileCreateResponse> {
+    return this._client.post(path`/profiles/${userID}`, { body, ...options });
+  }
+
+  /**
+   * Returns the specified user profile.
+   */
+  retrieve(userID: string, options?: RequestOptions): APIPromise<ProfileRetrieveResponse> {
+    return this._client.get(path`/profiles/${userID}`, options);
+  }
+
+  /**
+   * Update a profile
+   */
+  update(userID: string, body: ProfileUpdateParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.patch(path`/profiles/${userID}`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Deletes the specified user profile.
+   */
+  delete(userID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/profiles/${userID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * When using `PUT`, be sure to include all the key-value pairs required by the
+   * recipient's profile. Any key-value pairs that exist in the profile but fail to
+   * be included in the `PUT` request will be removed from the profile. Remember, a
+   * `PUT` update is a full replacement of the data. For partial updates, use the
+   * [Patch](https://www.courier.com/docs/reference/profiles/patch/) request.
+   */
+  replace(
+    userID: string,
+    body: ProfileReplaceParams,
+    options?: RequestOptions,
+  ): APIPromise<ProfileReplaceResponse> {
+    return this._client.put(path`/profiles/${userID}`, { body, ...options });
+  }
+}
+
+export interface ProfileCreateResponse {
+  status: 'SUCCESS';
+}
+
+export interface ProfileRetrieveResponse {
+  profile: { [key: string]: unknown };
+
+  preferences?: SubscriptionsAPI.RecipientPreferences | null;
+}
+
+export interface ProfileReplaceResponse {
+  status: 'SUCCESS';
+}
+
+export interface ProfileCreateParams {
+  profile: { [key: string]: unknown };
+}
+
+export interface ProfileUpdateParams {
+  /**
+   * List of patch operations to apply to the profile.
+   */
+  patch: Array<ProfileUpdateParams.Patch>;
+}
+
+export namespace ProfileUpdateParams {
+  export interface Patch {
+    /**
+     * The operation to perform.
+     */
+    op: string;
+
+    /**
+     * The JSON path specifying the part of the profile to operate on.
+     */
+    path: string;
+
+    /**
+     * The value for the operation.
+     */
+    value: string;
+  }
+}
+
+export interface ProfileReplaceParams {
+  profile: { [key: string]: unknown };
+}
+
+Profiles.Lists = Lists;
+
+export declare namespace Profiles {
+  export {
+    type ProfileCreateResponse as ProfileCreateResponse,
+    type ProfileRetrieveResponse as ProfileRetrieveResponse,
+    type ProfileReplaceResponse as ProfileReplaceResponse,
+    type ProfileCreateParams as ProfileCreateParams,
+    type ProfileUpdateParams as ProfileUpdateParams,
+    type ProfileReplaceParams as ProfileReplaceParams,
+  };
+
+  export {
+    Lists as Lists,
+    type ListRetrieveResponse as ListRetrieveResponse,
+    type ListDeleteResponse as ListDeleteResponse,
+    type ListSubscribeResponse as ListSubscribeResponse,
+    type ListRetrieveParams as ListRetrieveParams,
+    type ListSubscribeParams as ListSubscribeParams,
+  };
+}

package/src/resources/profiles.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './profiles/index';

package/src/resources/requests.ts

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Requests extends APIResource {
+  /**
+   * Archive message
+   */
+  archive(requestID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.put(path`/requests/${requestID}/archive`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}