@randock/nameshift-api-client 0.0.532 → 0.0.533

package/.openapi-generator/FILES

@@ -482,6 +482,7 @@ src/models/NewsletterEventInput.ts
 src/models/NewsletterPreviewDto.ts
 src/models/NewsletterSecondaryStoryDto.ts
 src/models/NewsletterSecondaryStoryInput.ts
+src/models/NewsletterSubscriptionState.ts
 src/models/NotificationsUnsubscribeResultDto.ts
 src/models/ObjectId.ts
 src/models/OrderCompanyInfoDto.ts
@@ -676,11 +677,13 @@ src/models/UpdateSubscriptionDomainRecordInput.ts
 src/models/UpdateSubscriptionInput.ts
 src/models/UpdateTaskMuteStatusForBuyerInput.ts
 src/models/UpdateTaskMuteStatusInput.ts
+src/models/UpdateUserNewsletterSubscriptionInput.ts
 src/models/UpdateUserNotificationSettingsInput.ts
 src/models/UserLoginAttemptDto.ts
 src/models/UserLoginAttemptMethod.ts
 src/models/UserLoginAttemptResult.ts
 src/models/UserLoginLocationConfirmationDetailsDto.ts
+src/models/UserNewsletterSubscriptionDto.ts
 src/models/UserNotificationAttachmentDto.ts
 src/models/UserNotificationDto.ts
 src/models/UserNotificationListItemDto.ts

package/README.md

@@ -1,4 +1,4 @@
-## @randock/nameshift-api-client@0.0.532
+## @randock/nameshift-api-client@0.0.533
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @randock/nameshift-api-client@0.0.532 --save
+npm install @randock/nameshift-api-client@0.0.533 --save
 ```
 
 _unPublished (not recommended):_
@@ -44,4 +44,4 @@ _unPublished (not recommended):_
 ```
 npm install PATH_TO_GENERATED_PACKAGE --save
 ```
-98a4b7dd7b6b416e508c4c1cee5fffb463f02a05bb7582a4fe5fd476f6a8bd29690936f2a02e744e646d6a2c85dc5e7d
+87e2468b13db492f18d393622150bb57a4658eb3d611938ae1542906889f41a32b917ba5144da75aaf21180053dc42f0

package/dist/apis/AdminApi.d.ts

@@ -1484,12 +1484,12 @@ export declare class AdminApi extends runtime.BaseAPI {
      */
     updateSubscriptionBuyerInformation(requestParameters: AdminApiUpdateSubscriptionBuyerInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows on the next sync.
+     * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows right away, or with the nightly sync if that fails.
      * Update the seller newsletter consent of a user
      */
     updateUserNewsletterStatusRaw(requestParameters: AdminApiUpdateUserNewsletterStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows on the next sync.
+     * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows right away, or with the nightly sync if that fails.
      * Update the seller newsletter consent of a user
      */
     updateUserNewsletterStatus(requestParameters: AdminApiUpdateUserNewsletterStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;

package/dist/apis/AdminApi.js

@@ -6025,7 +6025,7 @@ var AdminApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows on the next sync.
+     * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows right away, or with the nightly sync if that fails.
      * Update the seller newsletter consent of a user
      */
     AdminApi.prototype.updateUserNewsletterStatusRaw = function (requestParameters, initOverrides) {
@@ -6067,7 +6067,7 @@ var AdminApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows on the next sync.
+     * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows right away, or with the nightly sync if that fails.
      * Update the seller newsletter consent of a user
      */
     AdminApi.prototype.updateUserNewsletterStatus = function (requestParameters, initOverrides) {

package/dist/apis/UsersApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { ActivateUserTotpInput, ChangeUserEmailWithOtpInput, ChangeUserLoginLocationVerificationInput, ChangeUserPasswordInput, ChangeUserSignInStepsInput, CurrentPasswordInput, ListUserLoginAttempts200Response, PasskeyOptionsDto, ReauthenticateWithPasskeyInput, ReauthenticationDto, RecoveryCodesDto, RegisterUserPasskeyInput, RegisterUserPushTokenInput, RemoveUserPasskeyInput, RenameUserPasskeyInput, RequestUserEmailChangeOtpInput, StoreUserLocaleInput, TotpCodeInput, TotpEnrolmentDto, UpdateUserNotificationSettingsInput, UserNotificationSettingsDto, UserSecurityDto } from '../models/index';
+import type { ActivateUserTotpInput, ChangeUserEmailWithOtpInput, ChangeUserLoginLocationVerificationInput, ChangeUserPasswordInput, ChangeUserSignInStepsInput, CurrentPasswordInput, ListUserLoginAttempts200Response, PasskeyOptionsDto, ReauthenticateWithPasskeyInput, ReauthenticationDto, RecoveryCodesDto, RegisterUserPasskeyInput, RegisterUserPushTokenInput, RemoveUserPasskeyInput, RenameUserPasskeyInput, RequestUserEmailChangeOtpInput, StoreUserLocaleInput, TotpCodeInput, TotpEnrolmentDto, UpdateUserNewsletterSubscriptionInput, UpdateUserNotificationSettingsInput, UserNewsletterSubscriptionDto, UserNotificationSettingsDto, UserSecurityDto } from '../models/index';
 export interface UsersApiActivateUserTotpRequest {
     activateUserTotpInput: ActivateUserTotpInput;
 }
@@ -98,6 +98,9 @@ export interface UsersApiStartUserTotpEnrolmentRequest {
 export interface UsersApiStartUserTotpReplacementRequest {
     totpCodeInput: TotpCodeInput;
 }
+export interface UsersApiUpdateUserNewsletterSubscriptionRequest {
+    updateUserNewsletterSubscriptionInput: UpdateUserNewsletterSubscriptionInput;
+}
 export interface UsersApiUpdateUserNotificationSettingsRequest {
     updateUserNotificationSettingsInput: UpdateUserNotificationSettingsInput;
 }
@@ -201,6 +204,16 @@ export declare class UsersApi extends runtime.BaseAPI {
      * Start confirming it is you with a passkey
      */
     getReauthenticationPasskeyOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasskeyOptionsDto>;
+    /**
+     * Returns the seller newsletter as the user\'s newsletter switch shows it: on, switched off, unsubscribed by email, waiting for the user to confirm by email, or bounced.  **API key scope required:** `USERS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Get the newsletter switch
+     */
+    getUserNewsletterSubscriptionRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserNewsletterSubscriptionDto>>;
+    /**
+     * Returns the seller newsletter as the user\'s newsletter switch shows it: on, switched off, unsubscribed by email, waiting for the user to confirm by email, or bounced.  **API key scope required:** `USERS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Get the newsletter switch
+     */
+    getUserNewsletterSubscription(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserNewsletterSubscriptionDto>;
     /**
      * Returns the notification preferences configured for the seller user.  **API key scope required:** `USERS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get user notification settings
@@ -347,6 +360,16 @@ export declare class UsersApi extends runtime.BaseAPI {
      * Request email change OTP
      */
     requestUserEmailChangeOtp(requestParameters: UsersApiRequestUserEmailChangeOtpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Has Mailchimp email the newsletter confirmation link again, while the switch waits for the user to confirm. Refused with NEWSLETTER_CONFIRMATION_NOT_PENDING when nothing waits, and with NEWSLETTER_CONFIRMATION_RESENT_TOO_SOON within ten minutes of the last email.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Send the newsletter confirmation email again
+     */
+    resendUserNewsletterConfirmationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserNewsletterSubscriptionDto>>;
+    /**
+     * Has Mailchimp email the newsletter confirmation link again, while the switch waits for the user to confirm. Refused with NEWSLETTER_CONFIRMATION_NOT_PENDING when nothing waits, and with NEWSLETTER_CONFIRMATION_RESENT_TOO_SOON within ten minutes of the last email.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Send the newsletter confirmation email again
+     */
+    resendUserNewsletterConfirmation(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserNewsletterSubscriptionDto>;
     /**
      * Persists the seller user locale used for notifications and UI content.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Store user locale preference
@@ -377,6 +400,16 @@ export declare class UsersApi extends runtime.BaseAPI {
      * Start moving to another authenticator app
      */
     startUserTotpReplacement(requestParameters: UsersApiStartUserTotpReplacementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TotpEnrolmentDto>;
+    /**
+     * Switches the seller newsletter on or off for the user. Off takes the user out of the newsletter audience. On brings them back; a user who unsubscribed with the link in a newsletter may first have to confirm with a link Mailchimp emails them, and the result says so. Refused with NEWSLETTER_EMAIL_BOUNCED while mail to the user\'s email bounces.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Switch the newsletter on or off
+     */
+    updateUserNewsletterSubscriptionRaw(requestParameters: UsersApiUpdateUserNewsletterSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserNewsletterSubscriptionDto>>;
+    /**
+     * Switches the seller newsletter on or off for the user. Off takes the user out of the newsletter audience. On brings them back; a user who unsubscribed with the link in a newsletter may first have to confirm with a link Mailchimp emails them, and the result says so. Refused with NEWSLETTER_EMAIL_BOUNCED while mail to the user\'s email bounces.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Switch the newsletter on or off
+     */
+    updateUserNewsletterSubscription(requestParameters: UsersApiUpdateUserNewsletterSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserNewsletterSubscriptionDto>;
     /**
      * Updates one or more notification preferences for the seller user.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Update user notification settings

package/dist/apis/UsersApi.js

@@ -643,6 +643,66 @@ var UsersApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Returns the seller newsletter as the user\'s newsletter switch shows it: on, switched off, unsubscribed by email, waiting for the user to confirm by email, or bounced.  **API key scope required:** `USERS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Get the newsletter switch
+     */
+    UsersApi.prototype.getUserNewsletterSubscriptionRaw = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, token, tokenString, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
+                        _a = headerParameters;
+                        _b = "apikey";
+                        return [4 /*yield*/, this.configuration.apiKey("apikey")];
+                    case 1:
+                        _a[_b] = _c.sent(); // api_key authentication
+                        _c.label = 2;
+                    case 2:
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearer", [])];
+                    case 3:
+                        tokenString = _c.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _c.label = 4;
+                    case 4: return [4 /*yield*/, this.request({
+                            path: "/private/users/newsletter",
+                            method: 'GET',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 5:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.UserNewsletterSubscriptionDtoFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Returns the seller newsletter as the user\'s newsletter switch shows it: on, switched off, unsubscribed by email, waiting for the user to confirm by email, or bounced.  **API key scope required:** `USERS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Get the newsletter switch
+     */
+    UsersApi.prototype.getUserNewsletterSubscription = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getUserNewsletterSubscriptionRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Returns the notification preferences configured for the seller user.  **API key scope required:** `USERS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get user notification settings
@@ -1512,6 +1572,66 @@ var UsersApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Has Mailchimp email the newsletter confirmation link again, while the switch waits for the user to confirm. Refused with NEWSLETTER_CONFIRMATION_NOT_PENDING when nothing waits, and with NEWSLETTER_CONFIRMATION_RESENT_TOO_SOON within ten minutes of the last email.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Send the newsletter confirmation email again
+     */
+    UsersApi.prototype.resendUserNewsletterConfirmationRaw = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, token, tokenString, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
+                        _a = headerParameters;
+                        _b = "apikey";
+                        return [4 /*yield*/, this.configuration.apiKey("apikey")];
+                    case 1:
+                        _a[_b] = _c.sent(); // api_key authentication
+                        _c.label = 2;
+                    case 2:
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearer", [])];
+                    case 3:
+                        tokenString = _c.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _c.label = 4;
+                    case 4: return [4 /*yield*/, this.request({
+                            path: "/private/users/newsletter/resend-confirmation",
+                            method: 'POST',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 5:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.UserNewsletterSubscriptionDtoFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Has Mailchimp email the newsletter confirmation link again, while the switch waits for the user to confirm. Refused with NEWSLETTER_CONFIRMATION_NOT_PENDING when nothing waits, and with NEWSLETTER_CONFIRMATION_RESENT_TOO_SOON within ten minutes of the last email.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Send the newsletter confirmation email again
+     */
+    UsersApi.prototype.resendUserNewsletterConfirmation = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.resendUserNewsletterConfirmationRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Persists the seller user locale used for notifications and UI content.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Store user locale preference
@@ -1690,6 +1810,71 @@ var UsersApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Switches the seller newsletter on or off for the user. Off takes the user out of the newsletter audience. On brings them back; a user who unsubscribed with the link in a newsletter may first have to confirm with a link Mailchimp emails them, and the result says so. Refused with NEWSLETTER_EMAIL_BOUNCED while mail to the user\'s email bounces.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Switch the newsletter on or off
+     */
+    UsersApi.prototype.updateUserNewsletterSubscriptionRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, token, tokenString, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters['updateUserNewsletterSubscriptionInput'] == null) {
+                            throw new runtime.RequiredError('updateUserNewsletterSubscriptionInput', 'Required parameter "updateUserNewsletterSubscriptionInput" was null or undefined when calling updateUserNewsletterSubscription().');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
+                        _a = headerParameters;
+                        _b = "apikey";
+                        return [4 /*yield*/, this.configuration.apiKey("apikey")];
+                    case 1:
+                        _a[_b] = _c.sent(); // api_key authentication
+                        _c.label = 2;
+                    case 2:
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearer", [])];
+                    case 3:
+                        tokenString = _c.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _c.label = 4;
+                    case 4: return [4 /*yield*/, this.request({
+                            path: "/private/users/newsletter",
+                            method: 'PUT',
+                            headers: headerParameters,
+                            query: queryParameters,
+                            body: (0, index_1.UpdateUserNewsletterSubscriptionInputToJSON)(requestParameters['updateUserNewsletterSubscriptionInput']),
+                        }, initOverrides)];
+                    case 5:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.UserNewsletterSubscriptionDtoFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Switches the seller newsletter on or off for the user. Off takes the user out of the newsletter audience. On brings them back; a user who unsubscribed with the link in a newsletter may first have to confirm with a link Mailchimp emails them, and the result says so. Refused with NEWSLETTER_EMAIL_BOUNCED while mail to the user\'s email bounces.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Switch the newsletter on or off
+     */
+    UsersApi.prototype.updateUserNewsletterSubscription = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.updateUserNewsletterSubscriptionRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Updates one or more notification preferences for the seller user.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Update user notification settings

package/dist/models/AdminUserNewsletterInput.d.ts

@@ -16,7 +16,7 @@
  */
 export interface AdminUserNewsletterInput {
     /**
-     * Seller newsletter consent of the user. An admin change is recorded as such; it never overrides an unsubscribe the user made in Mailchimp, which the audience sync keeps.
+     * Seller newsletter consent of the user: subscribed, unsubscribed or never_asked; pending and bounced follow from Mailchimp and are refused. An admin change is recorded as such; it never overrides an unsubscribe the user made in Mailchimp, which the audience sync keeps.
      * @type {string}
      * @memberof AdminUserNewsletterInput
      */
@@ -29,6 +29,8 @@ export declare const AdminUserNewsletterInputNewsletterStatusEnum: {
     readonly SUBSCRIBED: "subscribed";
     readonly UNSUBSCRIBED: "unsubscribed";
     readonly NEVER_ASKED: "never_asked";
+    readonly PENDING: "pending";
+    readonly BOUNCED: "bounced";
 };
 export type AdminUserNewsletterInputNewsletterStatusEnum = typeof AdminUserNewsletterInputNewsletterStatusEnum[keyof typeof AdminUserNewsletterInputNewsletterStatusEnum];
 /**

package/dist/models/AdminUserNewsletterInput.js

@@ -25,7 +25,9 @@ exports.AdminUserNewsletterInputToJSONTyped = AdminUserNewsletterInputToJSONType
 exports.AdminUserNewsletterInputNewsletterStatusEnum = {
     SUBSCRIBED: 'subscribed',
     UNSUBSCRIBED: 'unsubscribed',
-    NEVER_ASKED: 'never_asked'
+    NEVER_ASKED: 'never_asked',
+    PENDING: 'pending',
+    BOUNCED: 'bounced'
 };
 /**
  * Check if a given object implements the AdminUserNewsletterInput interface.

package/dist/models/NewsletterSubscriptionState.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * subscribed: getting the newsletter (the switch is on). switched_off: switched off by the user, by "Disable all notifications" or by an admin; switching on brings them back right away. unsubscribed_by_email: unsubscribed with the link in a newsletter; switching on may send a confirmation email. pending_confirmation: a confirmation email was sent; back once the user opens its link. bounced: mail to the email bounced; a new email address is needed.
+ * @export
+ */
+export declare const NewsletterSubscriptionState: {
+    readonly SUBSCRIBED: "subscribed";
+    readonly SWITCHED_OFF: "switched_off";
+    readonly UNSUBSCRIBED_BY_EMAIL: "unsubscribed_by_email";
+    readonly PENDING_CONFIRMATION: "pending_confirmation";
+    readonly BOUNCED: "bounced";
+};
+export type NewsletterSubscriptionState = typeof NewsletterSubscriptionState[keyof typeof NewsletterSubscriptionState];
+export declare function instanceOfNewsletterSubscriptionState(value: any): boolean;
+export declare function NewsletterSubscriptionStateFromJSON(json: any): NewsletterSubscriptionState;
+export declare function NewsletterSubscriptionStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): NewsletterSubscriptionState;
+export declare function NewsletterSubscriptionStateToJSON(value?: NewsletterSubscriptionState | null): any;
+export declare function NewsletterSubscriptionStateToJSONTyped(value: any, ignoreDiscriminator: boolean): NewsletterSubscriptionState;

package/dist/models/NewsletterSubscriptionState.js

@@ -0,0 +1,54 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NewsletterSubscriptionState = void 0;
+exports.instanceOfNewsletterSubscriptionState = instanceOfNewsletterSubscriptionState;
+exports.NewsletterSubscriptionStateFromJSON = NewsletterSubscriptionStateFromJSON;
+exports.NewsletterSubscriptionStateFromJSONTyped = NewsletterSubscriptionStateFromJSONTyped;
+exports.NewsletterSubscriptionStateToJSON = NewsletterSubscriptionStateToJSON;
+exports.NewsletterSubscriptionStateToJSONTyped = NewsletterSubscriptionStateToJSONTyped;
+/**
+ * subscribed: getting the newsletter (the switch is on). switched_off: switched off by the user, by "Disable all notifications" or by an admin; switching on brings them back right away. unsubscribed_by_email: unsubscribed with the link in a newsletter; switching on may send a confirmation email. pending_confirmation: a confirmation email was sent; back once the user opens its link. bounced: mail to the email bounced; a new email address is needed.
+ * @export
+ */
+exports.NewsletterSubscriptionState = {
+    SUBSCRIBED: 'subscribed',
+    SWITCHED_OFF: 'switched_off',
+    UNSUBSCRIBED_BY_EMAIL: 'unsubscribed_by_email',
+    PENDING_CONFIRMATION: 'pending_confirmation',
+    BOUNCED: 'bounced'
+};
+function instanceOfNewsletterSubscriptionState(value) {
+    for (var key in exports.NewsletterSubscriptionState) {
+        if (Object.prototype.hasOwnProperty.call(exports.NewsletterSubscriptionState, key)) {
+            if (exports.NewsletterSubscriptionState[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function NewsletterSubscriptionStateFromJSON(json) {
+    return NewsletterSubscriptionStateFromJSONTyped(json, false);
+}
+function NewsletterSubscriptionStateFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function NewsletterSubscriptionStateToJSON(value) {
+    return value;
+}
+function NewsletterSubscriptionStateToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/UpdateUserNewsletterSubscriptionInput.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface UpdateUserNewsletterSubscriptionInput
+ */
+export interface UpdateUserNewsletterSubscriptionInput {
+    /**
+     * Whether the user wants the seller newsletter: the newsletter switch.
+     * @type {boolean}
+     * @memberof UpdateUserNewsletterSubscriptionInput
+     */
+    subscribed: boolean;
+}
+/**
+ * Check if a given object implements the UpdateUserNewsletterSubscriptionInput interface.
+ */
+export declare function instanceOfUpdateUserNewsletterSubscriptionInput(value: object): value is UpdateUserNewsletterSubscriptionInput;
+export declare function UpdateUserNewsletterSubscriptionInputFromJSON(json: any): UpdateUserNewsletterSubscriptionInput;
+export declare function UpdateUserNewsletterSubscriptionInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateUserNewsletterSubscriptionInput;
+export declare function UpdateUserNewsletterSubscriptionInputToJSON(json: any): UpdateUserNewsletterSubscriptionInput;
+export declare function UpdateUserNewsletterSubscriptionInputToJSONTyped(value?: UpdateUserNewsletterSubscriptionInput | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UpdateUserNewsletterSubscriptionInput.js

@@ -0,0 +1,51 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfUpdateUserNewsletterSubscriptionInput = instanceOfUpdateUserNewsletterSubscriptionInput;
+exports.UpdateUserNewsletterSubscriptionInputFromJSON = UpdateUserNewsletterSubscriptionInputFromJSON;
+exports.UpdateUserNewsletterSubscriptionInputFromJSONTyped = UpdateUserNewsletterSubscriptionInputFromJSONTyped;
+exports.UpdateUserNewsletterSubscriptionInputToJSON = UpdateUserNewsletterSubscriptionInputToJSON;
+exports.UpdateUserNewsletterSubscriptionInputToJSONTyped = UpdateUserNewsletterSubscriptionInputToJSONTyped;
+/**
+ * Check if a given object implements the UpdateUserNewsletterSubscriptionInput interface.
+ */
+function instanceOfUpdateUserNewsletterSubscriptionInput(value) {
+    if (!('subscribed' in value) || value['subscribed'] === undefined)
+        return false;
+    return true;
+}
+function UpdateUserNewsletterSubscriptionInputFromJSON(json) {
+    return UpdateUserNewsletterSubscriptionInputFromJSONTyped(json, false);
+}
+function UpdateUserNewsletterSubscriptionInputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'subscribed': json['subscribed'],
+    };
+}
+function UpdateUserNewsletterSubscriptionInputToJSON(json) {
+    return UpdateUserNewsletterSubscriptionInputToJSONTyped(json, false);
+}
+function UpdateUserNewsletterSubscriptionInputToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'subscribed': value['subscribed'],
+    };
+}

package/dist/models/UserNewsletterSubscriptionDto.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { NewsletterSubscriptionState } from './NewsletterSubscriptionState';
+/**
+ *
+ * @export
+ * @interface UserNewsletterSubscriptionDto
+ */
+export interface UserNewsletterSubscriptionDto {
+    /**
+     * subscribed: getting the newsletter (the switch is on). switched_off: switched off by the user, by "Disable all notifications" or by an admin; switching on brings them back right away. unsubscribed_by_email: unsubscribed with the link in a newsletter; switching on may send a confirmation email. pending_confirmation: a confirmation email was sent; back once the user opens its link. bounced: mail to the email bounced; a new email address is needed.
+     * @type {NewsletterSubscriptionState}
+     * @memberof UserNewsletterSubscriptionDto
+     */
+    state: NewsletterSubscriptionState;
+    /**
+     * The email address the newsletter goes to.
+     * @type {string}
+     * @memberof UserNewsletterSubscriptionDto
+     */
+    email: string;
+    /**
+     * When the confirmation email was last sent; null unless pending_confirmation.
+     * @type {Date}
+     * @memberof UserNewsletterSubscriptionDto
+     */
+    confirmationRequestedAt: Date | null;
+    /**
+     * From when the confirmation email can be sent again; null unless pending_confirmation.
+     * @type {Date}
+     * @memberof UserNewsletterSubscriptionDto
+     */
+    confirmationCanBeResentAt: Date | null;
+}
+/**
+ * Check if a given object implements the UserNewsletterSubscriptionDto interface.
+ */
+export declare function instanceOfUserNewsletterSubscriptionDto(value: object): value is UserNewsletterSubscriptionDto;
+export declare function UserNewsletterSubscriptionDtoFromJSON(json: any): UserNewsletterSubscriptionDto;
+export declare function UserNewsletterSubscriptionDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserNewsletterSubscriptionDto;
+export declare function UserNewsletterSubscriptionDtoToJSON(json: any): UserNewsletterSubscriptionDto;
+export declare function UserNewsletterSubscriptionDtoToJSONTyped(value?: UserNewsletterSubscriptionDto | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UserNewsletterSubscriptionDto.js

@@ -0,0 +1,64 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfUserNewsletterSubscriptionDto = instanceOfUserNewsletterSubscriptionDto;
+exports.UserNewsletterSubscriptionDtoFromJSON = UserNewsletterSubscriptionDtoFromJSON;
+exports.UserNewsletterSubscriptionDtoFromJSONTyped = UserNewsletterSubscriptionDtoFromJSONTyped;
+exports.UserNewsletterSubscriptionDtoToJSON = UserNewsletterSubscriptionDtoToJSON;
+exports.UserNewsletterSubscriptionDtoToJSONTyped = UserNewsletterSubscriptionDtoToJSONTyped;
+var NewsletterSubscriptionState_1 = require("./NewsletterSubscriptionState");
+/**
+ * Check if a given object implements the UserNewsletterSubscriptionDto interface.
+ */
+function instanceOfUserNewsletterSubscriptionDto(value) {
+    if (!('state' in value) || value['state'] === undefined)
+        return false;
+    if (!('email' in value) || value['email'] === undefined)
+        return false;
+    if (!('confirmationRequestedAt' in value) || value['confirmationRequestedAt'] === undefined)
+        return false;
+    if (!('confirmationCanBeResentAt' in value) || value['confirmationCanBeResentAt'] === undefined)
+        return false;
+    return true;
+}
+function UserNewsletterSubscriptionDtoFromJSON(json) {
+    return UserNewsletterSubscriptionDtoFromJSONTyped(json, false);
+}
+function UserNewsletterSubscriptionDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'state': (0, NewsletterSubscriptionState_1.NewsletterSubscriptionStateFromJSON)(json['state']),
+        'email': json['email'],
+        'confirmationRequestedAt': (json['confirmationRequestedAt'] == null ? null : new Date(json['confirmationRequestedAt'])),
+        'confirmationCanBeResentAt': (json['confirmationCanBeResentAt'] == null ? null : new Date(json['confirmationCanBeResentAt'])),
+    };
+}
+function UserNewsletterSubscriptionDtoToJSON(json) {
+    return UserNewsletterSubscriptionDtoToJSONTyped(json, false);
+}
+function UserNewsletterSubscriptionDtoToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'state': (0, NewsletterSubscriptionState_1.NewsletterSubscriptionStateToJSON)(value['state']),
+        'email': value['email'],
+        'confirmationRequestedAt': (value['confirmationRequestedAt'] == null ? null : value['confirmationRequestedAt'].toISOString()),
+        'confirmationCanBeResentAt': (value['confirmationCanBeResentAt'] == null ? null : value['confirmationCanBeResentAt'].toISOString()),
+    };
+}

package/dist/models/index.d.ts

@@ -438,6 +438,7 @@ export * from './NewsletterEventInput';
 export * from './NewsletterPreviewDto';
 export * from './NewsletterSecondaryStoryDto';
 export * from './NewsletterSecondaryStoryInput';
+export * from './NewsletterSubscriptionState';
 export * from './NotificationsUnsubscribeResultDto';
 export * from './ObjectId';
 export * from './OrderCompanyInfoDto';
@@ -632,11 +633,13 @@ export * from './UpdateSubscriptionDomainRecordInput';
 export * from './UpdateSubscriptionInput';
 export * from './UpdateTaskMuteStatusForBuyerInput';
 export * from './UpdateTaskMuteStatusInput';
+export * from './UpdateUserNewsletterSubscriptionInput';
 export * from './UpdateUserNotificationSettingsInput';
 export * from './UserLoginAttemptDto';
 export * from './UserLoginAttemptMethod';
 export * from './UserLoginAttemptResult';
 export * from './UserLoginLocationConfirmationDetailsDto';
+export * from './UserNewsletterSubscriptionDto';
 export * from './UserNotificationAttachmentDto';
 export * from './UserNotificationDto';
 export * from './UserNotificationListItemDto';

package/dist/models/index.js

@@ -456,6 +456,7 @@ __exportStar(require("./NewsletterEventInput"), exports);
 __exportStar(require("./NewsletterPreviewDto"), exports);
 __exportStar(require("./NewsletterSecondaryStoryDto"), exports);
 __exportStar(require("./NewsletterSecondaryStoryInput"), exports);
+__exportStar(require("./NewsletterSubscriptionState"), exports);
 __exportStar(require("./NotificationsUnsubscribeResultDto"), exports);
 __exportStar(require("./ObjectId"), exports);
 __exportStar(require("./OrderCompanyInfoDto"), exports);
@@ -650,11 +651,13 @@ __exportStar(require("./UpdateSubscriptionDomainRecordInput"), exports);
 __exportStar(require("./UpdateSubscriptionInput"), exports);
 __exportStar(require("./UpdateTaskMuteStatusForBuyerInput"), exports);
 __exportStar(require("./UpdateTaskMuteStatusInput"), exports);
+__exportStar(require("./UpdateUserNewsletterSubscriptionInput"), exports);
 __exportStar(require("./UpdateUserNotificationSettingsInput"), exports);
 __exportStar(require("./UserLoginAttemptDto"), exports);
 __exportStar(require("./UserLoginAttemptMethod"), exports);
 __exportStar(require("./UserLoginAttemptResult"), exports);
 __exportStar(require("./UserLoginLocationConfirmationDetailsDto"), exports);
+__exportStar(require("./UserNewsletterSubscriptionDto"), exports);
 __exportStar(require("./UserNotificationAttachmentDto"), exports);
 __exportStar(require("./UserNotificationDto"), exports);
 __exportStar(require("./UserNotificationListItemDto"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@randock/nameshift-api-client",
-  "version": "0.0.532",
+  "version": "0.0.533",
   "description": "OpenAPI client for @randock/nameshift-api-client",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/AdminApi.ts

@@ -5659,7 +5659,7 @@ export class AdminApi extends runtime.BaseAPI {
     }
 
     /**
-     * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows on the next sync.
+     * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows right away, or with the nightly sync if that fails.
      * Update the seller newsletter consent of a user
      */
     async updateUserNewsletterStatusRaw(requestParameters: AdminApiUpdateUserNewsletterStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -5703,7 +5703,7 @@ export class AdminApi extends runtime.BaseAPI {
     }
 
     /**
-     * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows on the next sync.
+     * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows right away, or with the nightly sync if that fails.
      * Update the seller newsletter consent of a user
      */
     async updateUserNewsletterStatus(requestParameters: AdminApiUpdateUserNewsletterStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {

package/src/apis/UsersApi.ts

@@ -34,7 +34,9 @@ import type {
   StoreUserLocaleInput,
   TotpCodeInput,
   TotpEnrolmentDto,
+  UpdateUserNewsletterSubscriptionInput,
   UpdateUserNotificationSettingsInput,
+  UserNewsletterSubscriptionDto,
   UserNotificationSettingsDto,
   UserSecurityDto,
   ValidationException,
@@ -78,8 +80,12 @@ import {
     TotpCodeInputToJSON,
     TotpEnrolmentDtoFromJSON,
     TotpEnrolmentDtoToJSON,
+    UpdateUserNewsletterSubscriptionInputFromJSON,
+    UpdateUserNewsletterSubscriptionInputToJSON,
     UpdateUserNotificationSettingsInputFromJSON,
     UpdateUserNotificationSettingsInputToJSON,
+    UserNewsletterSubscriptionDtoFromJSON,
+    UserNewsletterSubscriptionDtoToJSON,
     UserNotificationSettingsDtoFromJSON,
     UserNotificationSettingsDtoToJSON,
     UserSecurityDtoFromJSON,
@@ -198,6 +204,10 @@ export interface UsersApiStartUserTotpReplacementRequest {
     totpCodeInput: TotpCodeInput;
 }
 
+export interface UsersApiUpdateUserNewsletterSubscriptionRequest {
+    updateUserNewsletterSubscriptionInput: UpdateUserNewsletterSubscriptionInput;
+}
+
 export interface UsersApiUpdateUserNotificationSettingsRequest {
     updateUserNotificationSettingsInput: UpdateUserNotificationSettingsInput;
 }
@@ -668,6 +678,46 @@ export class UsersApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Returns the seller newsletter as the user\'s newsletter switch shows it: on, switched off, unsubscribed by email, waiting for the user to confirm by email, or bounced.  **API key scope required:** `USERS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Get the newsletter switch
+     */
+    async getUserNewsletterSubscriptionRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserNewsletterSubscriptionDto>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/users/newsletter`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => UserNewsletterSubscriptionDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the seller newsletter as the user\'s newsletter switch shows it: on, switched off, unsubscribed by email, waiting for the user to confirm by email, or bounced.  **API key scope required:** `USERS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Get the newsletter switch
+     */
+    async getUserNewsletterSubscription(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserNewsletterSubscriptionDto> {
+        const response = await this.getUserNewsletterSubscriptionRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Returns the notification preferences configured for the seller user.  **API key scope required:** `USERS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get user notification settings
@@ -1371,6 +1421,46 @@ export class UsersApi extends runtime.BaseAPI {
         await this.requestUserEmailChangeOtpRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Has Mailchimp email the newsletter confirmation link again, while the switch waits for the user to confirm. Refused with NEWSLETTER_CONFIRMATION_NOT_PENDING when nothing waits, and with NEWSLETTER_CONFIRMATION_RESENT_TOO_SOON within ten minutes of the last email.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Send the newsletter confirmation email again
+     */
+    async resendUserNewsletterConfirmationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserNewsletterSubscriptionDto>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/users/newsletter/resend-confirmation`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => UserNewsletterSubscriptionDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Has Mailchimp email the newsletter confirmation link again, while the switch waits for the user to confirm. Refused with NEWSLETTER_CONFIRMATION_NOT_PENDING when nothing waits, and with NEWSLETTER_CONFIRMATION_RESENT_TOO_SOON within ten minutes of the last email.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Send the newsletter confirmation email again
+     */
+    async resendUserNewsletterConfirmation(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserNewsletterSubscriptionDto> {
+        const response = await this.resendUserNewsletterConfirmationRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Persists the seller user locale used for notifications and UI content.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Store user locale preference
@@ -1513,6 +1603,56 @@ export class UsersApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Switches the seller newsletter on or off for the user. Off takes the user out of the newsletter audience. On brings them back; a user who unsubscribed with the link in a newsletter may first have to confirm with a link Mailchimp emails them, and the result says so. Refused with NEWSLETTER_EMAIL_BOUNCED while mail to the user\'s email bounces.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Switch the newsletter on or off
+     */
+    async updateUserNewsletterSubscriptionRaw(requestParameters: UsersApiUpdateUserNewsletterSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserNewsletterSubscriptionDto>> {
+        if (requestParameters['updateUserNewsletterSubscriptionInput'] == null) {
+            throw new runtime.RequiredError(
+                'updateUserNewsletterSubscriptionInput',
+                'Required parameter "updateUserNewsletterSubscriptionInput" was null or undefined when calling updateUserNewsletterSubscription().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/users/newsletter`,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateUserNewsletterSubscriptionInputToJSON(requestParameters['updateUserNewsletterSubscriptionInput']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => UserNewsletterSubscriptionDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Switches the seller newsletter on or off for the user. Off takes the user out of the newsletter audience. On brings them back; a user who unsubscribed with the link in a newsletter may first have to confirm with a link Mailchimp emails them, and the result says so. Refused with NEWSLETTER_EMAIL_BOUNCED while mail to the user\'s email bounces.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Switch the newsletter on or off
+     */
+    async updateUserNewsletterSubscription(requestParameters: UsersApiUpdateUserNewsletterSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserNewsletterSubscriptionDto> {
+        const response = await this.updateUserNewsletterSubscriptionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Updates one or more notification preferences for the seller user.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Update user notification settings

package/src/models/AdminUserNewsletterInput.ts

@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
  */
 export interface AdminUserNewsletterInput {
     /**
-     * Seller newsletter consent of the user. An admin change is recorded as such; it never overrides an unsubscribe the user made in Mailchimp, which the audience sync keeps.
+     * Seller newsletter consent of the user: subscribed, unsubscribed or never_asked; pending and bounced follow from Mailchimp and are refused. An admin change is recorded as such; it never overrides an unsubscribe the user made in Mailchimp, which the audience sync keeps.
      * @type {string}
      * @memberof AdminUserNewsletterInput
      */
@@ -34,7 +34,9 @@ export interface AdminUserNewsletterInput {
 export const AdminUserNewsletterInputNewsletterStatusEnum = {
     SUBSCRIBED: 'subscribed',
     UNSUBSCRIBED: 'unsubscribed',
-    NEVER_ASKED: 'never_asked'
+    NEVER_ASKED: 'never_asked',
+    PENDING: 'pending',
+    BOUNCED: 'bounced'
 } as const;
 export type AdminUserNewsletterInputNewsletterStatusEnum = typeof AdminUserNewsletterInputNewsletterStatusEnum[keyof typeof AdminUserNewsletterInputNewsletterStatusEnum];
 

package/src/models/NewsletterSubscriptionState.ts

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * subscribed: getting the newsletter (the switch is on). switched_off: switched off by the user, by "Disable all notifications" or by an admin; switching on brings them back right away. unsubscribed_by_email: unsubscribed with the link in a newsletter; switching on may send a confirmation email. pending_confirmation: a confirmation email was sent; back once the user opens its link. bounced: mail to the email bounced; a new email address is needed.
+ * @export
+ */
+export const NewsletterSubscriptionState = {
+    SUBSCRIBED: 'subscribed',
+    SWITCHED_OFF: 'switched_off',
+    UNSUBSCRIBED_BY_EMAIL: 'unsubscribed_by_email',
+    PENDING_CONFIRMATION: 'pending_confirmation',
+    BOUNCED: 'bounced'
+} as const;
+export type NewsletterSubscriptionState = typeof NewsletterSubscriptionState[keyof typeof NewsletterSubscriptionState];
+
+
+export function instanceOfNewsletterSubscriptionState(value: any): boolean {
+    for (const key in NewsletterSubscriptionState) {
+        if (Object.prototype.hasOwnProperty.call(NewsletterSubscriptionState, key)) {
+            if (NewsletterSubscriptionState[key as keyof typeof NewsletterSubscriptionState] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function NewsletterSubscriptionStateFromJSON(json: any): NewsletterSubscriptionState {
+    return NewsletterSubscriptionStateFromJSONTyped(json, false);
+}
+
+export function NewsletterSubscriptionStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): NewsletterSubscriptionState {
+    return json as NewsletterSubscriptionState;
+}
+
+export function NewsletterSubscriptionStateToJSON(value?: NewsletterSubscriptionState | null): any {
+    return value as any;
+}
+
+export function NewsletterSubscriptionStateToJSONTyped(value: any, ignoreDiscriminator: boolean): NewsletterSubscriptionState {
+    return value as NewsletterSubscriptionState;
+}
+

package/src/models/UpdateUserNewsletterSubscriptionInput.ts

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface UpdateUserNewsletterSubscriptionInput
+ */
+export interface UpdateUserNewsletterSubscriptionInput {
+    /**
+     * Whether the user wants the seller newsletter: the newsletter switch.
+     * @type {boolean}
+     * @memberof UpdateUserNewsletterSubscriptionInput
+     */
+    subscribed: boolean;
+}
+
+/**
+ * Check if a given object implements the UpdateUserNewsletterSubscriptionInput interface.
+ */
+export function instanceOfUpdateUserNewsletterSubscriptionInput(value: object): value is UpdateUserNewsletterSubscriptionInput {
+    if (!('subscribed' in value) || value['subscribed'] === undefined) return false;
+    return true;
+}
+
+export function UpdateUserNewsletterSubscriptionInputFromJSON(json: any): UpdateUserNewsletterSubscriptionInput {
+    return UpdateUserNewsletterSubscriptionInputFromJSONTyped(json, false);
+}
+
+export function UpdateUserNewsletterSubscriptionInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateUserNewsletterSubscriptionInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'subscribed': json['subscribed'],
+    };
+}
+
+export function UpdateUserNewsletterSubscriptionInputToJSON(json: any): UpdateUserNewsletterSubscriptionInput {
+    return UpdateUserNewsletterSubscriptionInputToJSONTyped(json, false);
+}
+
+export function UpdateUserNewsletterSubscriptionInputToJSONTyped(value?: UpdateUserNewsletterSubscriptionInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'subscribed': value['subscribed'],
+    };
+}
+

package/src/models/UserNewsletterSubscriptionDto.ts

@@ -0,0 +1,103 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { NewsletterSubscriptionState } from './NewsletterSubscriptionState';
+import {
+    NewsletterSubscriptionStateFromJSON,
+    NewsletterSubscriptionStateFromJSONTyped,
+    NewsletterSubscriptionStateToJSON,
+    NewsletterSubscriptionStateToJSONTyped,
+} from './NewsletterSubscriptionState';
+
+/**
+ * 
+ * @export
+ * @interface UserNewsletterSubscriptionDto
+ */
+export interface UserNewsletterSubscriptionDto {
+    /**
+     * subscribed: getting the newsletter (the switch is on). switched_off: switched off by the user, by "Disable all notifications" or by an admin; switching on brings them back right away. unsubscribed_by_email: unsubscribed with the link in a newsletter; switching on may send a confirmation email. pending_confirmation: a confirmation email was sent; back once the user opens its link. bounced: mail to the email bounced; a new email address is needed.
+     * @type {NewsletterSubscriptionState}
+     * @memberof UserNewsletterSubscriptionDto
+     */
+    state: NewsletterSubscriptionState;
+    /**
+     * The email address the newsletter goes to.
+     * @type {string}
+     * @memberof UserNewsletterSubscriptionDto
+     */
+    email: string;
+    /**
+     * When the confirmation email was last sent; null unless pending_confirmation.
+     * @type {Date}
+     * @memberof UserNewsletterSubscriptionDto
+     */
+    confirmationRequestedAt: Date | null;
+    /**
+     * From when the confirmation email can be sent again; null unless pending_confirmation.
+     * @type {Date}
+     * @memberof UserNewsletterSubscriptionDto
+     */
+    confirmationCanBeResentAt: Date | null;
+}
+
+
+
+/**
+ * Check if a given object implements the UserNewsletterSubscriptionDto interface.
+ */
+export function instanceOfUserNewsletterSubscriptionDto(value: object): value is UserNewsletterSubscriptionDto {
+    if (!('state' in value) || value['state'] === undefined) return false;
+    if (!('email' in value) || value['email'] === undefined) return false;
+    if (!('confirmationRequestedAt' in value) || value['confirmationRequestedAt'] === undefined) return false;
+    if (!('confirmationCanBeResentAt' in value) || value['confirmationCanBeResentAt'] === undefined) return false;
+    return true;
+}
+
+export function UserNewsletterSubscriptionDtoFromJSON(json: any): UserNewsletterSubscriptionDto {
+    return UserNewsletterSubscriptionDtoFromJSONTyped(json, false);
+}
+
+export function UserNewsletterSubscriptionDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserNewsletterSubscriptionDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'state': NewsletterSubscriptionStateFromJSON(json['state']),
+        'email': json['email'],
+        'confirmationRequestedAt': (json['confirmationRequestedAt'] == null ? null : new Date(json['confirmationRequestedAt'])),
+        'confirmationCanBeResentAt': (json['confirmationCanBeResentAt'] == null ? null : new Date(json['confirmationCanBeResentAt'])),
+    };
+}
+
+export function UserNewsletterSubscriptionDtoToJSON(json: any): UserNewsletterSubscriptionDto {
+    return UserNewsletterSubscriptionDtoToJSONTyped(json, false);
+}
+
+export function UserNewsletterSubscriptionDtoToJSONTyped(value?: UserNewsletterSubscriptionDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'state': NewsletterSubscriptionStateToJSON(value['state']),
+        'email': value['email'],
+        'confirmationRequestedAt': (value['confirmationRequestedAt'] == null ? null : (value['confirmationRequestedAt'] as any).toISOString()),
+        'confirmationCanBeResentAt': (value['confirmationCanBeResentAt'] == null ? null : (value['confirmationCanBeResentAt'] as any).toISOString()),
+    };
+}
+

package/src/models/index.ts

@@ -440,6 +440,7 @@ export * from './NewsletterEventInput';
 export * from './NewsletterPreviewDto';
 export * from './NewsletterSecondaryStoryDto';
 export * from './NewsletterSecondaryStoryInput';
+export * from './NewsletterSubscriptionState';
 export * from './NotificationsUnsubscribeResultDto';
 export * from './ObjectId';
 export * from './OrderCompanyInfoDto';
@@ -634,11 +635,13 @@ export * from './UpdateSubscriptionDomainRecordInput';
 export * from './UpdateSubscriptionInput';
 export * from './UpdateTaskMuteStatusForBuyerInput';
 export * from './UpdateTaskMuteStatusInput';
+export * from './UpdateUserNewsletterSubscriptionInput';
 export * from './UpdateUserNotificationSettingsInput';
 export * from './UserLoginAttemptDto';
 export * from './UserLoginAttemptMethod';
 export * from './UserLoginAttemptResult';
 export * from './UserLoginLocationConfirmationDetailsDto';
+export * from './UserNewsletterSubscriptionDto';
 export * from './UserNotificationAttachmentDto';
 export * from './UserNotificationDto';
 export * from './UserNotificationListItemDto';