@trycourier/courier 6.6.0 → 6.7.0-alpha2

package/src/internal/utils/values.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { CourierError } from '../../core/error';
+
+// https://url.spec.whatwg.org/#url-scheme-string
+const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
+
+export const isAbsoluteURL = (url: string): boolean => {
+  return startsWithSchemeRegexp.test(url);
+};
+
+export let isArray = (val: unknown): val is unknown[] => ((isArray = Array.isArray), isArray(val));
+export let isReadonlyArray = isArray as (val: unknown) => val is readonly unknown[];
+
+/** Returns an object if the given value isn't an object, otherwise returns as-is */
+export function maybeObj(x: unknown): object {
+  if (typeof x !== 'object') {
+    return {};
+  }
+
+  return x ?? {};
+}
+
+// https://stackoverflow.com/a/34491287
+export function isEmptyObj(obj: Object | null | undefined): boolean {
+  if (!obj) return true;
+  for (const _k in obj) return false;
+  return true;
+}
+
+// https://eslint.org/docs/latest/rules/no-prototype-builtins
+export function hasOwn<T extends object = object>(obj: T, key: PropertyKey): key is keyof T {
+  return Object.prototype.hasOwnProperty.call(obj, key);
+}
+
+export function isObj(obj: unknown): obj is Record<string, unknown> {
+  return obj != null && typeof obj === 'object' && !Array.isArray(obj);
+}
+
+export const ensurePresent = <T>(value: T | null | undefined): T => {
+  if (value == null) {
+    throw new CourierError(`Expected a value to be given but received ${value} instead.`);
+  }
+
+  return value;
+};
+
+export const validatePositiveInteger = (name: string, n: unknown): number => {
+  if (typeof n !== 'number' || !Number.isInteger(n)) {
+    throw new CourierError(`${name} must be an integer`);
+  }
+  if (n < 0) {
+    throw new CourierError(`${name} must be a positive integer`);
+  }
+  return n;
+};
+
+export const coerceInteger = (value: unknown): number => {
+  if (typeof value === 'number') return Math.round(value);
+  if (typeof value === 'string') return parseInt(value, 10);
+
+  throw new CourierError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceFloat = (value: unknown): number => {
+  if (typeof value === 'number') return value;
+  if (typeof value === 'string') return parseFloat(value);
+
+  throw new CourierError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceBoolean = (value: unknown): boolean => {
+  if (typeof value === 'boolean') return value;
+  if (typeof value === 'string') return value === 'true';
+  return Boolean(value);
+};
+
+export const maybeCoerceInteger = (value: unknown): number | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceInteger(value);
+};
+
+export const maybeCoerceFloat = (value: unknown): number | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceFloat(value);
+};
+
+export const maybeCoerceBoolean = (value: unknown): boolean | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceBoolean(value);
+};
+
+export const safeJSON = (text: string) => {
+  try {
+    return JSON.parse(text);
+  } catch (err) {
+    return undefined;
+  }
+};

package/src/internal/utils.ts

@@ -0,0 +1,8 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './utils/values';
+export * from './utils/base64';
+export * from './utils/env';
+export * from './utils/log';
+export * from './utils/uuid';
+export * from './utils/sleep';

package/src/lib/.keep

@@ -0,0 +1,4 @@
+File generated from our OpenAPI spec by Stainless.
+
+This directory can be used to store custom files to expand the SDK.
+It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.

package/src/resource.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/resource instead */
+export * from './core/resource';

package/src/resources/audiences.ts

@@ -0,0 +1,232 @@
+// 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 Audiences extends APIResource {
+  /**
+   * Returns the specified audience by id.
+   */
+  retrieve(audienceID: string, options?: RequestOptions): APIPromise<Audience> {
+    return this._client.get(path`/audiences/${audienceID}`, options);
+  }
+
+  /**
+   * Creates or updates audience.
+   */
+  update(
+    audienceID: string,
+    body: AudienceUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<AudienceUpdateResponse> {
+    return this._client.put(path`/audiences/${audienceID}`, { body, ...options });
+  }
+
+  /**
+   * Get the audiences associated with the authorization token.
+   */
+  list(
+    query: AudienceListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AudienceListResponse> {
+    return this._client.get('/audiences', { query, ...options });
+  }
+
+  /**
+   * Deletes the specified audience.
+   */
+  delete(audienceID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/audiences/${audienceID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get list of members of an audience.
+   */
+  listMembers(
+    audienceID: string,
+    query: AudienceListMembersParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AudienceListMembersResponse> {
+    return this._client.get(path`/audiences/${audienceID}/members`, { query, ...options });
+  }
+}
+
+export interface Audience {
+  /**
+   * A unique identifier representing the audience_id
+   */
+  id: string;
+
+  created_at: string;
+
+  /**
+   * A description of the audience
+   */
+  description: string;
+
+  /**
+   * A single filter to use for filtering
+   */
+  filter: Filter;
+
+  /**
+   * The name of the audience
+   */
+  name: string;
+
+  updated_at: string;
+}
+
+export interface Filter {
+  /**
+   * The operator to use for filtering
+   */
+  operator:
+    | 'ENDS_WITH'
+    | 'EQ'
+    | 'EXISTS'
+    | 'GT'
+    | 'GTE'
+    | 'INCLUDES'
+    | 'IS_AFTER'
+    | 'IS_BEFORE'
+    | 'LT'
+    | 'LTE'
+    | 'NEQ'
+    | 'OMIT'
+    | 'STARTS_WITH'
+    | 'AND'
+    | 'OR';
+
+  /**
+   * The attribe name from profile whose value will be operated against the filter
+   * value
+   */
+  path: string;
+
+  /**
+   * The value to use for filtering
+   */
+  value: string;
+}
+
+export interface FilterConfig {
+  /**
+   * The operator to use for filtering
+   */
+  operator:
+    | 'ENDS_WITH'
+    | 'EQ'
+    | 'EXISTS'
+    | 'GT'
+    | 'GTE'
+    | 'INCLUDES'
+    | 'IS_AFTER'
+    | 'IS_BEFORE'
+    | 'LT'
+    | 'LTE'
+    | 'NEQ'
+    | 'OMIT'
+    | 'STARTS_WITH'
+    | 'AND'
+    | 'OR';
+
+  /**
+   * The attribe name from profile whose value will be operated against the filter
+   * value
+   */
+  path: string;
+
+  /**
+   * The value to use for filtering
+   */
+  value: string;
+}
+
+export interface Paging {
+  more: boolean;
+
+  cursor?: string | null;
+}
+
+export interface AudienceUpdateResponse {
+  audience: Audience;
+}
+
+export interface AudienceListResponse {
+  items: Array<Audience>;
+
+  paging: Paging;
+}
+
+export interface AudienceListMembersResponse {
+  items: Array<AudienceListMembersResponse.Item>;
+
+  paging: Paging;
+}
+
+export namespace AudienceListMembersResponse {
+  export interface Item {
+    added_at: string;
+
+    audience_id: string;
+
+    audience_version: number;
+
+    member_id: string;
+
+    reason: string;
+  }
+}
+
+export interface AudienceUpdateParams {
+  /**
+   * A description of the audience
+   */
+  description?: string | null;
+
+  /**
+   * A single filter to use for filtering
+   */
+  filter?: Filter | null;
+
+  /**
+   * The name of the audience
+   */
+  name?: string | null;
+}
+
+export interface AudienceListParams {
+  /**
+   * A unique identifier that allows for fetching the next set of audiences
+   */
+  cursor?: string | null;
+}
+
+export interface AudienceListMembersParams {
+  /**
+   * A unique identifier that allows for fetching the next set of members
+   */
+  cursor?: string | null;
+}
+
+export declare namespace Audiences {
+  export {
+    type Audience as Audience,
+    type Filter as Filter,
+    type FilterConfig as FilterConfig,
+    type Paging as Paging,
+    type AudienceUpdateResponse as AudienceUpdateResponse,
+    type AudienceListResponse as AudienceListResponse,
+    type AudienceListMembersResponse as AudienceListMembersResponse,
+    type AudienceUpdateParams as AudienceUpdateParams,
+    type AudienceListParams as AudienceListParams,
+    type AudienceListMembersParams as AudienceListMembersParams,
+  };
+}

package/src/resources/audit-events.ts

@@ -0,0 +1,69 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as AudiencesAPI from './audiences';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class AuditEvents extends APIResource {
+  /**
+   * Fetch a specific audit event by ID.
+   */
+  retrieve(auditEventID: string, options?: RequestOptions): APIPromise<AuditEvent> {
+    return this._client.get(path`/audit-events/${auditEventID}`, options);
+  }
+
+  /**
+   * Fetch the list of audit events
+   */
+  list(
+    query: AuditEventListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AuditEventListResponse> {
+    return this._client.get('/audit-events', { query, ...options });
+  }
+}
+
+export interface AuditEvent {
+  actor: AuditEvent.Actor;
+
+  auditEventId: string;
+
+  source: string;
+
+  target: string;
+
+  timestamp: string;
+
+  type: string;
+}
+
+export namespace AuditEvent {
+  export interface Actor {
+    id: string;
+
+    email?: string | null;
+  }
+}
+
+export interface AuditEventListResponse {
+  paging: AudiencesAPI.Paging;
+
+  results: Array<AuditEvent>;
+}
+
+export interface AuditEventListParams {
+  /**
+   * A unique identifier that allows for fetching the next set of audit events.
+   */
+  cursor?: string | null;
+}
+
+export declare namespace AuditEvents {
+  export {
+    type AuditEvent as AuditEvent,
+    type AuditEventListResponse as AuditEventListResponse,
+    type AuditEventListParams as AuditEventListParams,
+  };
+}

package/src/resources/auth.ts

@@ -0,0 +1,31 @@
+// 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 { RequestOptions } from '../internal/request-options';
+
+export class Auth extends APIResource {
+  /**
+   * Returns a new access token.
+   */
+  issueToken(body: AuthIssueTokenParams, options?: RequestOptions): APIPromise<AuthIssueTokenResponse> {
+    return this._client.post('/auth/issue-token', { body, ...options });
+  }
+}
+
+export interface AuthIssueTokenResponse {
+  token: string;
+}
+
+export interface AuthIssueTokenParams {
+  expires_in: string;
+
+  scope: string;
+}
+
+export declare namespace Auth {
+  export {
+    type AuthIssueTokenResponse as AuthIssueTokenResponse,
+    type AuthIssueTokenParams as AuthIssueTokenParams,
+  };
+}

package/src/resources/automations/automations.ts

@@ -0,0 +1,25 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as InvokeAPI from './invoke';
+import {
+  AutomationInvokeResponse,
+  Invoke,
+  InvokeInvokeAdHocParams,
+  InvokeInvokeByTemplateParams,
+} from './invoke';
+
+export class Automations extends APIResource {
+  invoke: InvokeAPI.Invoke = new InvokeAPI.Invoke(this._client);
+}
+
+Automations.Invoke = Invoke;
+
+export declare namespace Automations {
+  export {
+    Invoke as Invoke,
+    type AutomationInvokeResponse as AutomationInvokeResponse,
+    type InvokeInvokeAdHocParams as InvokeInvokeAdHocParams,
+    type InvokeInvokeByTemplateParams as InvokeInvokeByTemplateParams,
+  };
+}

package/src/resources/automations/index.ts

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Automations } from './automations';
+export {
+  Invoke,
+  type AutomationInvokeResponse,
+  type InvokeInvokeAdHocParams,
+  type InvokeInvokeByTemplateParams,
+} from './invoke';

package/src/resources/automations/invoke.ts

@@ -0,0 +1,188 @@
+// 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 { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Invoke extends APIResource {
+  /**
+   * Invoke an ad hoc automation run. This endpoint accepts a JSON payload with a
+   * series of automation steps. For information about what steps are available,
+   * checkout the ad hoc automation guide
+   * [here](https://www.courier.com/docs/automations/steps/).
+   *
+   * @example
+   * ```ts
+   * const automationInvokeResponse =
+   *   await client.automations.invoke.invokeAdHoc({
+   *     automation: {
+   *       cancelation_token: 'delay-send--user-yes--abc-123',
+   *       steps: [
+   *         { action: 'delay', until: '20240408T080910.123' },
+   *         {
+   *           action: 'send',
+   *           template: '64TP5HKPFTM8VTK1Y75SJDQX9JK0',
+   *         },
+   *       ],
+   *     },
+   *     data: { name: 'Foo' },
+   *     profile: { tenant_id: 'abc-123' },
+   *     recipient: 'user-yes',
+   *   });
+   * ```
+   */
+  invokeAdHoc(body: InvokeInvokeAdHocParams, options?: RequestOptions): APIPromise<AutomationInvokeResponse> {
+    return this._client.post('/automations/invoke', { body, ...options });
+  }
+
+  /**
+   * Invoke an automation run from an automation template.
+   *
+   * @example
+   * ```ts
+   * const automationInvokeResponse =
+   *   await client.automations.invoke.invokeByTemplate(
+   *     'templateId',
+   *     { recipient: 'recipient' },
+   *   );
+   * ```
+   */
+  invokeByTemplate(
+    templateID: string,
+    body: InvokeInvokeByTemplateParams,
+    options?: RequestOptions,
+  ): APIPromise<AutomationInvokeResponse> {
+    return this._client.post(path`/automations/${templateID}/invoke`, { body, ...options });
+  }
+}
+
+export interface AutomationInvokeResponse {
+  runId: string;
+}
+
+export interface InvokeInvokeAdHocParams {
+  automation: InvokeInvokeAdHocParams.Automation;
+
+  brand?: string | null;
+
+  data?: { [key: string]: unknown } | null;
+
+  profile?: { [key: string]: unknown } | null;
+
+  recipient?: string | null;
+
+  template?: string | null;
+}
+
+export namespace InvokeInvokeAdHocParams {
+  export interface Automation {
+    steps: Array<
+      | Automation.AutomationDelayStep
+      | Automation.AutomationSendStep
+      | Automation.AutomationSendListStep
+      | Automation.AutomationUpdateProfileStep
+      | Automation.AutomationCancelStep
+      | Automation.AutomationFetchDataStep
+      | Automation.AutomationInvokeStep
+    >;
+
+    cancelation_token?: string | null;
+  }
+
+  export namespace Automation {
+    export interface AutomationDelayStep {
+      action: 'delay';
+
+      duration?: string | null;
+
+      until?: string | null;
+    }
+
+    export interface AutomationSendStep {
+      action: 'send';
+
+      brand?: string | null;
+
+      data?: { [key: string]: unknown } | null;
+
+      profile?: { [key: string]: unknown } | null;
+
+      recipient?: string | null;
+
+      template?: string | null;
+    }
+
+    export interface AutomationSendListStep {
+      action: 'send-list';
+
+      list: string;
+
+      brand?: string | null;
+
+      data?: { [key: string]: unknown } | null;
+    }
+
+    export interface AutomationUpdateProfileStep {
+      action: 'update-profile';
+
+      profile: { [key: string]: unknown };
+
+      merge?: 'none' | 'overwrite' | 'soft-merge' | 'replace' | null;
+
+      recipient_id?: string | null;
+    }
+
+    export interface AutomationCancelStep {
+      action: 'cancel';
+
+      cancelation_token: string;
+    }
+
+    export interface AutomationFetchDataStep {
+      action: 'fetch-data';
+
+      webhook: AutomationFetchDataStep.Webhook;
+
+      merge_strategy?: 'replace' | 'overwrite' | 'soft-merge' | null;
+    }
+
+    export namespace AutomationFetchDataStep {
+      export interface Webhook {
+        method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+
+        url: string;
+
+        body?: string | null;
+
+        headers?: { [key: string]: string } | null;
+      }
+    }
+
+    export interface AutomationInvokeStep {
+      action: 'invoke';
+
+      template: string;
+    }
+  }
+}
+
+export interface InvokeInvokeByTemplateParams {
+  recipient: string | null;
+
+  brand?: string | null;
+
+  data?: { [key: string]: unknown } | null;
+
+  profile?: { [key: string]: unknown } | null;
+
+  template?: string | null;
+}
+
+export declare namespace Invoke {
+  export {
+    type AutomationInvokeResponse as AutomationInvokeResponse,
+    type InvokeInvokeAdHocParams as InvokeInvokeAdHocParams,
+    type InvokeInvokeByTemplateParams as InvokeInvokeByTemplateParams,
+  };
+}

package/src/resources/automations.ts

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