@trycourier/courier 6.3.1 → 6.4.1

package/dist/api/resources/brands/client/requests/BrandUpdateParameters.d.ts

@@ -5,32 +5,9 @@ import * as Courier from "../../../../index";
 /**
  * @example
  *     {
- *         name: "string",
- *         settings: {
- *             colors: {
- *                 primary: "string",
- *                 secondary: "string",
- *                 tertiary: "string"
- *             },
- *             inapp: {
- *                 "key": "value"
- *             },
- *             email: {
- *                 footer: {
- *                     "key": "value"
- *                 },
- *                 header: {
- *                     "key": "value"
- *                 }
- *             }
- *         },
- *         snippets: {
- *             items: [{
- *                     format: "handlebars",
- *                     name: "string",
- *                     value: "string"
- *                 }]
- *         }
+ *         name: "name",
+ *         settings: undefined,
+ *         snippets: undefined
  *     }
  */
 export interface BrandUpdateParameters {

package/dist/api/resources/brands/client/requests/ListBrandsRequest.d.ts

@@ -3,9 +3,7 @@
  */
 /**
  * @example
- *     {
- *         cursor: "string"
- *     }
+ *     {}
  */
 export interface ListBrandsRequest {
     /**

package/dist/api/resources/bulk/client/Client.d.ts

@@ -7,12 +7,20 @@ import * as Courier from "../../../index";
 export declare namespace Bulk {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         authorizationToken?: core.Supplier<core.BearerToken | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
     interface IdempotentRequestOptions extends RequestOptions {
         idempotencyKey?: string | undefined;
@@ -29,98 +37,19 @@ export declare class Bulk {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.bulk.createJob({
+     *     await client.bulk.createJob({
      *         message: {
-     *             message: {
-     *                 template: "string",
-     *                 data: {
-     *                     "string": {
-     *                         "key": "value"
-     *                     }
-     *                 },
-     *                 brand_id: "string",
-     *                 channels: {
-     *                     "string": {
-     *                         brand_id: undefined,
-     *                         providers: undefined,
-     *                         routing_method: undefined,
-     *                         if: undefined,
-     *                         timeouts: undefined,
-     *                         override: undefined,
-     *                         metadata: undefined
-     *                     }
-     *                 },
-     *                 context: {
-     *                     tenant_id: "string"
-     *                 },
-     *                 metadata: {
-     *                     event: "string",
-     *                     tags: [],
-     *                     utm: {
-     *                         source: undefined,
-     *                         medium: undefined,
-     *                         campaign: undefined,
-     *                         term: undefined,
-     *                         content: undefined
-     *                     },
-     *                     trace_id: "string"
-     *                 },
-     *                 preferences: {
-     *                     subscription_topic_id: "string"
-     *                 },
-     *                 providers: {
-     *                     "string": {
-     *                         override: undefined,
-     *                         if: undefined,
-     *                         timeouts: undefined,
-     *                         metadata: undefined
-     *                     }
-     *                 },
-     *                 routing: {
-     *                     method: Courier.RoutingMethod.All,
-     *                     channels: [{
-     *                             channel: "string",
-     *                             config: undefined,
-     *                             method: undefined,
-     *                             providers: undefined,
-     *                             if: undefined
-     *                         }]
-     *                 },
-     *                 timeout: {
-     *                     provider: {},
-     *                     channel: {},
-     *                     message: 1,
-     *                     escalation: 1,
-     *                     criteria: Courier.Criteria.NoEscalation
-     *                 },
-     *                 delay: {
-     *                     duration: 1,
-     *                     until: "string"
-     *                 },
-     *                 expiry: {
-     *                     expires_at: "string",
-     *                     expires_in: "string"
-     *                 }
-     *             },
-     *             brand: "string",
-     *             data: {
-     *                 "string": {
-     *                     "key": "value"
-     *                 }
-     *             },
-     *             event: "string",
-     *             locale: {
-     *                 "string": {
-     *                     "key": "value"
-     *                 }
-     *             },
-     *             override: {
-     *                 "key": "value"
-     *             }
+     *             brand: undefined,
+     *             data: undefined,
+     *             event: undefined,
+     *             locale: undefined,
+     *             override: undefined,
+     *             message: undefined
      *         }
      *     })
      */
-    createJob(request: Courier.BulkCreateJobParams, requestOptions?: Bulk.IdempotentRequestOptions): Promise<Courier.BulkCreateJobResponse>;
+    createJob(request: Courier.BulkCreateJobParams, requestOptions?: Bulk.IdempotentRequestOptions): core.HttpResponsePromise<Courier.BulkCreateJobResponse>;
+    private __createJob;
     /**
      * Ingest user data into a Bulk Job
      *
@@ -129,40 +58,24 @@ export declare class Bulk {
      * @param {Bulk.IdempotentRequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.bulk.ingestUsers("string", {
+     *     await client.bulk.ingestUsers("job_id", {
      *         users: [{
-     *                 preferences: {
-     *                     categories: {},
-     *                     notifications: {}
-     *                 },
-     *                 profile: {
-     *                     "key": "value"
-     *                 },
-     *                 recipient: "string",
-     *                 data: {
-     *                     "key": "value"
-     *                 },
-     *                 to: {
-     *                     account_id: "string",
-     *                     context: {
-     *                         tenant_id: "string"
-     *                     },
-     *                     data: {},
-     *                     email: "string",
-     *                     locale: "string",
-     *                     user_id: "string",
-     *                     phone_number: "string",
-     *                     preferences: {
-     *                         categories: undefined,
-     *                         notifications: {},
-     *                         templateId: undefined
-     *                     },
-     *                     tenant_id: "string"
-     *                 }
+     *                 preferences: undefined,
+     *                 profile: undefined,
+     *                 recipient: undefined,
+     *                 data: undefined,
+     *                 to: undefined
+     *             }, {
+     *                 preferences: undefined,
+     *                 profile: undefined,
+     *                 recipient: undefined,
+     *                 data: undefined,
+     *                 to: undefined
      *             }]
      *     })
      */
-    ingestUsers(jobId: string, request: Courier.BulkIngestUsersParams, requestOptions?: Bulk.IdempotentRequestOptions): Promise<void>;
+    ingestUsers(jobId: string, request: Courier.BulkIngestUsersParams, requestOptions?: Bulk.IdempotentRequestOptions): core.HttpResponsePromise<void>;
+    private __ingestUsers;
     /**
      * Run a bulk job
      *
@@ -172,9 +85,10 @@ export declare class Bulk {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.bulk.runJob("string")
+     *     await client.bulk.runJob("job_id")
      */
-    runJob(jobId: string, requestOptions?: Bulk.IdempotentRequestOptions): Promise<void>;
+    runJob(jobId: string, requestOptions?: Bulk.IdempotentRequestOptions): core.HttpResponsePromise<void>;
+    private __runJob;
     /**
      * Get a bulk job
      *
@@ -184,9 +98,10 @@ export declare class Bulk {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.bulk.getJob("string")
+     *     await client.bulk.getJob("job_id")
      */
-    getJob(jobId: string, requestOptions?: Bulk.RequestOptions): Promise<Courier.BulkGetJobResponse>;
+    getJob(jobId: string, requestOptions?: Bulk.RequestOptions): core.HttpResponsePromise<Courier.BulkGetJobResponse>;
+    private __getJob;
     /**
      * Get Bulk Job Users
      *
@@ -197,10 +112,9 @@ export declare class Bulk {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.bulk.getUsers("string", {
-     *         cursor: "string"
-     *     })
+     *     await client.bulk.getUsers("job_id")
      */
-    getUsers(jobId: string, request?: Courier.BulkGetUsersParams, requestOptions?: Bulk.RequestOptions): Promise<Courier.BulkGetJobUsersResponse>;
+    getUsers(jobId: string, request?: Courier.BulkGetUsersParams, requestOptions?: Bulk.RequestOptions): core.HttpResponsePromise<Courier.BulkGetJobUsersResponse>;
+    private __getUsers;
     protected _getAuthorizationHeader(): Promise<string>;
 }