🌿 Fern Regeneration -- updates to tenants, brands, and `notificat…

…ions` resources (#167) * SDK regeneration * update README * typos * remove note that v6 is unstable * update userPreferences -> users.preferences --------- Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: dsinghvi <dsinghvi@umich.edu>
trycourier · Jan 3, 2024 · 67ccdd4 · 67ccdd4
1 parent 5fd5d50
commit 67ccdd4
Show file tree

Hide file tree

Showing 143 changed files with 1,900 additions and 462 deletions.
diff --git a/README.md b/README.md
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@trycourier/courier",
-    "version": "6.0.1",
+    "version": "v6.0.2",
     "private": false,
     "repository": "https://github.com/trycourier/courier-node",
     "main": "./index.js",
@@ -12,13 +12,15 @@
     },
     "dependencies": {
         "url-join": "4.0.1",
-        "@types/url-join": "4.0.1",
-        "axios": "0.27.2",
+        "form-data": "4.0.0",
+        "node-fetch": "2.7.0",
         "qs": "6.11.2",
-        "@types/qs": "6.9.8",
         "js-base64": "3.7.2"
     },
     "devDependencies": {
+        "@types/url-join": "4.0.1",
+        "@types/qs": "6.9.8",
+        "@types/node-fetch": "2.6.9",
         "@types/node": "17.0.33",
         "prettier": "2.7.1",
         "typescript": "4.6.4"

diff --git a/src/Client.ts b/src/Client.ts
@@ -15,17 +15,17 @@ import { Brands } from "./api/resources/brands/client/Client";
 import { Bulk } from "./api/resources/bulk/client/Client";
 import { Lists } from "./api/resources/lists/client/Client";
 import { Messages } from "./api/resources/messages/client/Client";
+import { Notifications } from "./api/resources/notifications/client/Client";
 import { Profiles } from "./api/resources/profiles/client/Client";
 import { Templates } from "./api/resources/templates/client/Client";
 import { Tenants } from "./api/resources/tenants/client/Client";
-import { TokenManagement } from "./api/resources/tokenManagement/client/Client";
 import { Translations } from "./api/resources/translations/client/Client";
-import { UserPreferences } from "./api/resources/userPreferences/client/Client";
+import { Users } from "./api/resources/users/client/Client";
 
 export declare namespace CourierClient {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
-        authorizationToken: core.Supplier<core.BearerToken | undefined>;
+        authorizationToken?: core.Supplier<core.BearerToken | undefined>;
     }
 
     interface RequestOptions {
@@ -40,7 +40,7 @@ export declare namespace CourierClient {
 }
 
 export class CourierClient {
-    constructor(protected readonly _options: CourierClient.Options) {}
+    constructor(protected readonly _options: CourierClient.Options = {}) {}
 
     /**
      * Use the send API to send a message to one or more recipients.
@@ -59,7 +59,7 @@ export class CourierClient {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@trycourier/courier",
-                "X-Fern-SDK-Version": "6.0.1",
+                "X-Fern-SDK-Version": "v6.0.2",
                 "Idempotency-Key": requestOptions?.idempotencyKey != null ? requestOptions?.idempotencyKey : undefined,
                 "X-Idempotency-Expiration":
                     requestOptions?.idempotencyExpiry != null
@@ -145,6 +145,12 @@ export class CourierClient {
         return (this._messages ??= new Messages(this._options));
     }
 
+    protected _notifications: Notifications | undefined;
+
+    public get notifications(): Notifications {
+        return (this._notifications ??= new Notifications(this._options));
+    }
+
     protected _profiles: Profiles | undefined;
 
     public get profiles(): Profiles {
@@ -163,22 +169,16 @@ export class CourierClient {
         return (this._tenants ??= new Tenants(this._options));
     }
 
-    protected _tokenManagement: TokenManagement | undefined;
-
-    public get tokenManagement(): TokenManagement {
-        return (this._tokenManagement ??= new TokenManagement(this._options));
-    }
-
     protected _translations: Translations | undefined;
 
     public get translations(): Translations {
         return (this._translations ??= new Translations(this._options));
     }
 
-    protected _userPreferences: UserPreferences | undefined;
+    protected _users: Users | undefined;
 
-    public get userPreferences(): UserPreferences {
-        return (this._userPreferences ??= new UserPreferences(this._options));
+    public get users(): Users {
+        return (this._users ??= new Users(this._options));
     }
 
     protected async _getAuthorizationHeader() {

diff --git a/src/api/resources/audiences/client/Client.ts b/src/api/resources/audiences/client/Client.ts
@@ -11,7 +11,7 @@ import * as errors from "../../../../errors";
 export declare namespace Audiences {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
-        authorizationToken: core.Supplier<core.BearerToken | undefined>;
+        authorizationToken?: core.Supplier<core.BearerToken | undefined>;
     }
 
     interface RequestOptions {
@@ -21,7 +21,7 @@ export declare namespace Audiences {
 }
 
 export class Audiences {
-    constructor(protected readonly _options: Audiences.Options) {}
+    constructor(protected readonly _options: Audiences.Options = {}) {}
 
     /**
      * Returns the specified audience by id.
@@ -37,7 +37,7 @@ export class Audiences {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@trycourier/courier",
-                "X-Fern-SDK-Version": "6.0.1",
+                "X-Fern-SDK-Version": "v6.0.2",
             },
             contentType: "application/json",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -74,9 +74,9 @@ export class Audiences {
      */
     public async update(
         audienceId: string,
-        request: Courier.AudienceRequest,
+        request: Courier.AudienceUpdateParams = {},
         requestOptions?: Audiences.RequestOptions
-    ): Promise<Courier.Audience> {
+    ): Promise<Courier.AudienceUpdateResponse> {
         const _response = await core.fetcher({
             url: urlJoin(
                 (await core.Supplier.get(this._options.environment)) ?? environments.CourierEnvironment.Production,
@@ -87,15 +87,15 @@ export class Audiences {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@trycourier/courier",
-                "X-Fern-SDK-Version": "6.0.1",
+                "X-Fern-SDK-Version": "v6.0.2",
             },
             contentType: "application/json",
             body: request,
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
         });
         if (_response.ok) {
-            return _response.body as Courier.Audience;
+            return _response.body as Courier.AudienceUpdateResponse;
         }
 
         if (_response.error.reason === "status-code") {
@@ -134,7 +134,7 @@ export class Audiences {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@trycourier/courier",
-                "X-Fern-SDK-Version": "6.0.1",
+                "X-Fern-SDK-Version": "v6.0.2",
             },
             contentType: "application/json",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -172,7 +172,7 @@ export class Audiences {
      */
     public async listMembers(
         audienceId: string,
-        request: Courier.ListAudienceMembersRequest = {},
+        request: Courier.AudienceMembersListParams = {},
         requestOptions?: Audiences.RequestOptions
     ): Promise<Courier.AudienceMemberListResponse> {
         const { cursor } = request;
@@ -191,7 +191,7 @@ export class Audiences {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@trycourier/courier",
-                "X-Fern-SDK-Version": "6.0.1",
+                "X-Fern-SDK-Version": "v6.0.2",
             },
             contentType: "application/json",
             queryParameters: _queryParams,
@@ -234,7 +234,7 @@ export class Audiences {
      * @throws {@link Courier.BadRequestError}
      */
     public async listAudiences(
-        request: Courier.ListAudiencesRequest = {},
+        request: Courier.AudiencesListParams = {},
         requestOptions?: Audiences.RequestOptions
     ): Promise<Courier.AudienceListResponse> {
         const { cursor } = request;
@@ -253,7 +253,7 @@ export class Audiences {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@trycourier/courier",
-                "X-Fern-SDK-Version": "6.0.1",
+                "X-Fern-SDK-Version": "v6.0.2",
             },
             contentType: "application/json",
             queryParameters: _queryParams,

diff --git a/...nt/requests/ListAudienceMembersRequest.ts → ...ent/requests/AudienceMembersListParams.ts b/...nt/requests/ListAudienceMembersRequest.ts → ...ent/requests/AudienceMembersListParams.ts
@@ -2,10 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-export interface ListAudienceMembersRequest {
+export interface AudienceMembersListParams {
     /**
      * A unique identifier that allows for fetching the next set of members
-     *
      */
     cursor?: string;
 }
diff --git a/...ources/audiences/types/AudienceRequest.ts → ...s/client/requests/AudienceUpdateParams.ts b/...ources/audiences/types/AudienceRequest.ts → ...s/client/requests/AudienceUpdateParams.ts
@@ -2,11 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as Courier from "../../..";
+import * as Courier from "../../../..";
 
-export interface AudienceRequest {
-    /** A unique identifier representing the audience_id */
-    id?: string;
+export interface AudienceUpdateParams {
     /** The name of the audience */
     name?: string;
     /** A description of the audience */

diff --git a/...s/client/requests/ListAudiencesRequest.ts → ...es/client/requests/AudiencesListParams.ts b/...s/client/requests/ListAudiencesRequest.ts → ...es/client/requests/AudiencesListParams.ts
@@ -2,10 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-export interface ListAudiencesRequest {
+export interface AudiencesListParams {
     /**
      * A unique identifier that allows for fetching the next set of audiences
-     *
      */
     cursor?: string;
 }
diff --git a/src/api/resources/audiences/client/requests/index.ts b/src/api/resources/audiences/client/requests/index.ts
@@ -1,2 +1,3 @@
-export { ListAudienceMembersRequest } from "./ListAudienceMembersRequest";
-export { ListAudiencesRequest } from "./ListAudiencesRequest";
+export { AudienceUpdateParams } from "./AudienceUpdateParams";
+export { AudienceMembersListParams } from "./AudienceMembersListParams";
+export { AudiencesListParams } from "./AudiencesListParams";
diff --git a/...es/audiences/types/AudiencePutResponse.ts → ...audiences/types/AudienceUpdateResponse.ts b/...es/audiences/types/AudiencePutResponse.ts → ...audiences/types/AudienceUpdateResponse.ts
@@ -4,6 +4,6 @@
 
 import * as Courier from "../../..";
 
-export interface AudiencePutResponse {
+export interface AudienceUpdateResponse {
     audience: Courier.Audience;
 }
diff --git a/src/api/resources/audiences/types/BaseFilterConfig.ts b/src/api/resources/audiences/types/BaseFilterConfig.ts
@@ -5,9 +5,6 @@
 import * as Courier from "../../..";
 
 export interface BaseFilterConfig {
-    /**
-     * The operator to use for filtering
-     *
-     */
+    /** The operator to use for filtering */
     operator: Courier.Operator;
 }
diff --git a/src/api/resources/audiences/types/index.ts b/src/api/resources/audiences/types/index.ts
@@ -1,4 +1,3 @@
-export * from "./AudienceRequest";
 export * from "./Filter";
 export * from "./Operator";
 export * from "./BaseFilterConfig";
@@ -12,4 +11,4 @@ export * from "./AudienceMember";
 export * from "./AudienceListResponse";
 export * from "./AudienceMemberGetResponse";
 export * from "./AudienceMemberListResponse";
-export * from "./AudiencePutResponse";
+export * from "./AudienceUpdateResponse";
diff --git a/src/api/resources/auditEvents/client/Client.ts b/src/api/resources/auditEvents/client/Client.ts
@@ -11,7 +11,7 @@ import * as errors from "../../../../errors";
 export declare namespace AuditEvents {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
-        authorizationToken: core.Supplier<core.BearerToken | undefined>;
+        authorizationToken?: core.Supplier<core.BearerToken | undefined>;
     }
 
     interface RequestOptions {
@@ -21,7 +21,7 @@ export declare namespace AuditEvents {
 }
 
 export class AuditEvents {
-    constructor(protected readonly _options: AuditEvents.Options) {}
+    constructor(protected readonly _options: AuditEvents.Options = {}) {}
 
     /**
      * Fetch the list of audit events
@@ -46,7 +46,7 @@ export class AuditEvents {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@trycourier/courier",
-                "X-Fern-SDK-Version": "6.0.1",
+                "X-Fern-SDK-Version": "v6.0.2",
             },
             contentType: "application/json",
             queryParameters: _queryParams,
@@ -93,7 +93,7 @@ export class AuditEvents {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@trycourier/courier",
-                "X-Fern-SDK-Version": "6.0.1",
+                "X-Fern-SDK-Version": "v6.0.2",
             },
             contentType: "application/json",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

diff --git a/src/api/resources/auditEvents/client/requests/ListAuditEventsRequest.ts b/src/api/resources/auditEvents/client/requests/ListAuditEventsRequest.ts
@@ -5,7 +5,6 @@
 export interface ListAuditEventsRequest {
     /**
      * A unique identifier that allows for fetching the next set of audit events.
-     *
      */
     cursor?: string;
 }
diff --git a/src/api/resources/authTokens/client/Client.ts b/src/api/resources/authTokens/client/Client.ts
@@ -11,7 +11,7 @@ import * as errors from "../../../../errors";
 export declare namespace AuthTokens {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
-        authorizationToken: core.Supplier<core.BearerToken | undefined>;
+        authorizationToken?: core.Supplier<core.BearerToken | undefined>;
     }
 
     interface RequestOptions {
@@ -26,15 +26,15 @@ export declare namespace AuthTokens {
 }
 
 export class AuthTokens {
-    constructor(protected readonly _options: AuthTokens.Options) {}
+    constructor(protected readonly _options: AuthTokens.Options = {}) {}
 
     /**
      * Returns a new access token.
      */
     public async issueToken(
-        request: Courier.AuthIssueTokenParameters,
+        request: Courier.IssueTokenParams,
         requestOptions?: AuthTokens.IdempotentRequestOptions
-    ): Promise<Courier.AuthIssueTokenResponse> {
+    ): Promise<Courier.IssueTokenResponse> {
         const _response = await core.fetcher({
             url: urlJoin(
                 (await core.Supplier.get(this._options.environment)) ?? environments.CourierEnvironment.Production,
@@ -45,7 +45,7 @@ export class AuthTokens {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@trycourier/courier",
-                "X-Fern-SDK-Version": "6.0.1",
+                "X-Fern-SDK-Version": "v6.0.2",
                 "Idempotency-Key": requestOptions?.idempotencyKey != null ? requestOptions?.idempotencyKey : undefined,
                 "X-Idempotency-Expiration":
                     requestOptions?.idempotencyExpiry != null
@@ -58,7 +58,7 @@ export class AuthTokens {
             maxRetries: requestOptions?.maxRetries,
         });
         if (_response.ok) {
-            return _response.body as Courier.AuthIssueTokenResponse;
+            return _response.body as Courier.IssueTokenResponse;
         }
 
         if (_response.error.reason === "status-code") {

diff --git a/src/api/resources/authTokens/client/index.ts b/src/api/resources/authTokens/client/index.ts
@@ -1 +1 @@
-export {};
+export * from "./requests";
diff --git a/...hTokens/types/AuthIssueTokenParameters.ts → ...okens/client/requests/IssueTokenParams.ts b/...hTokens/types/AuthIssueTokenParameters.ts → ...okens/client/requests/IssueTokenParams.ts
@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-export interface AuthIssueTokenParameters {
+export interface IssueTokenParams {
     scope: string;
-    expiresIn: string;
+    expires_in: string;
 }
diff --git a/src/api/resources/authTokens/client/requests/index.ts b/src/api/resources/authTokens/client/requests/index.ts
@@ -0,0 +1 @@
+export { IssueTokenParams } from "./IssueTokenParams";
diff --git a/...uthTokens/types/AuthIssueTokenResponse.ts → ...es/authTokens/types/IssueTokenResponse.ts b/...uthTokens/types/AuthIssueTokenResponse.ts → ...es/authTokens/types/IssueTokenResponse.ts
@@ -2,6 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-export interface AuthIssueTokenResponse {
+export interface IssueTokenResponse {
     token?: string;
 }
diff --git a/src/api/resources/authTokens/types/index.ts b/src/api/resources/authTokens/types/index.ts
@@ -1,2 +1 @@
-export * from "./AuthIssueTokenParameters";
-export * from "./AuthIssueTokenResponse";
+export * from "./IssueTokenResponse";