@randock/nameshift-api-client 0.0.531 → 0.0.533

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/.openapi-generator/FILES +3 -0
  2. package/README.md +3 -3
  3. package/dist/apis/AdminApi.d.ts +2 -2
  4. package/dist/apis/AdminApi.js +2 -2
  5. package/dist/apis/UsersApi.d.ts +34 -1
  6. package/dist/apis/UsersApi.js +185 -0
  7. package/dist/models/AccountSettingsDto.d.ts +14 -0
  8. package/dist/models/AccountSettingsDto.js +12 -1
  9. package/dist/models/AccountSettingsInput.d.ts +14 -0
  10. package/dist/models/AccountSettingsInput.js +10 -1
  11. package/dist/models/AdminUserNewsletterInput.d.ts +3 -1
  12. package/dist/models/AdminUserNewsletterInput.js +3 -1
  13. package/dist/models/LeadDto.d.ts +6 -0
  14. package/dist/models/LeadDto.js +4 -0
  15. package/dist/models/ListLeadsResultItem.d.ts +6 -0
  16. package/dist/models/ListLeadsResultItem.js +4 -0
  17. package/dist/models/ManualLeadDetails.d.ts +6 -0
  18. package/dist/models/ManualLeadDetails.js +4 -0
  19. package/dist/models/NewsletterSubscriptionState.d.ts +28 -0
  20. package/dist/models/NewsletterSubscriptionState.js +54 -0
  21. package/dist/models/SellerLeadDetails.d.ts +6 -0
  22. package/dist/models/SellerLeadDetails.js +4 -0
  23. package/dist/models/UpdateUserNewsletterSubscriptionInput.d.ts +32 -0
  24. package/dist/models/UpdateUserNewsletterSubscriptionInput.js +51 -0
  25. package/dist/models/UserNewsletterSubscriptionDto.d.ts +51 -0
  26. package/dist/models/UserNewsletterSubscriptionDto.js +64 -0
  27. package/dist/models/index.d.ts +3 -0
  28. package/dist/models/index.js +3 -0
  29. package/package.json +1 -1
  30. package/src/apis/AdminApi.ts +2 -2
  31. package/src/apis/UsersApi.ts +140 -0
  32. package/src/models/AccountSettingsDto.ts +18 -0
  33. package/src/models/AccountSettingsInput.ts +17 -0
  34. package/src/models/AdminUserNewsletterInput.ts +4 -2
  35. package/src/models/LeadDto.ts +9 -0
  36. package/src/models/ListLeadsResultItem.ts +9 -0
  37. package/src/models/ManualLeadDetails.ts +9 -0
  38. package/src/models/NewsletterSubscriptionState.ts +56 -0
  39. package/src/models/SellerLeadDetails.ts +9 -0
  40. package/src/models/UpdateUserNewsletterSubscriptionInput.ts +66 -0
  41. package/src/models/UserNewsletterSubscriptionDto.ts +103 -0
  42. package/src/models/index.ts +3 -0
@@ -482,6 +482,7 @@ src/models/NewsletterEventInput.ts
482
482
  src/models/NewsletterPreviewDto.ts
483
483
  src/models/NewsletterSecondaryStoryDto.ts
484
484
  src/models/NewsletterSecondaryStoryInput.ts
485
+ src/models/NewsletterSubscriptionState.ts
485
486
  src/models/NotificationsUnsubscribeResultDto.ts
486
487
  src/models/ObjectId.ts
487
488
  src/models/OrderCompanyInfoDto.ts
@@ -676,11 +677,13 @@ src/models/UpdateSubscriptionDomainRecordInput.ts
676
677
  src/models/UpdateSubscriptionInput.ts
677
678
  src/models/UpdateTaskMuteStatusForBuyerInput.ts
678
679
  src/models/UpdateTaskMuteStatusInput.ts
680
+ src/models/UpdateUserNewsletterSubscriptionInput.ts
679
681
  src/models/UpdateUserNotificationSettingsInput.ts
680
682
  src/models/UserLoginAttemptDto.ts
681
683
  src/models/UserLoginAttemptMethod.ts
682
684
  src/models/UserLoginAttemptResult.ts
683
685
  src/models/UserLoginLocationConfirmationDetailsDto.ts
686
+ src/models/UserNewsletterSubscriptionDto.ts
684
687
  src/models/UserNotificationAttachmentDto.ts
685
688
  src/models/UserNotificationDto.ts
686
689
  src/models/UserNotificationListItemDto.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @randock/nameshift-api-client@0.0.531
1
+ ## @randock/nameshift-api-client@0.0.533
2
2
 
3
3
  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:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @randock/nameshift-api-client@0.0.531 --save
39
+ npm install @randock/nameshift-api-client@0.0.533 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -44,4 +44,4 @@ _unPublished (not recommended):_
44
44
  ```
45
45
  npm install PATH_TO_GENERATED_PACKAGE --save
46
46
  ```
47
- e519a9375e36a3cbbc74292937535e361e1439fb5562d26fc6be5d468adbd871778762dcd5ec52ea93766c8e0412829f
47
+ 87e2468b13db492f18d393622150bb57a4658eb3d611938ae1542906889f41a32b917ba5144da75aaf21180053dc42f0
@@ -1484,12 +1484,12 @@ export declare class AdminApi extends runtime.BaseAPI {
1484
1484
  */
1485
1485
  updateSubscriptionBuyerInformation(requestParameters: AdminApiUpdateSubscriptionBuyerInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1486
1486
  /**
1487
- * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows on the next sync.
1487
+ * 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.
1488
1488
  * Update the seller newsletter consent of a user
1489
1489
  */
1490
1490
  updateUserNewsletterStatusRaw(requestParameters: AdminApiUpdateUserNewsletterStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
1491
1491
  /**
1492
- * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows on the next sync.
1492
+ * 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.
1493
1493
  * Update the seller newsletter consent of a user
1494
1494
  */
1495
1495
  updateUserNewsletterStatus(requestParameters: AdminApiUpdateUserNewsletterStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -6025,7 +6025,7 @@ var AdminApi = /** @class */ (function (_super) {
6025
6025
  });
6026
6026
  };
6027
6027
  /**
6028
- * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows on the next sync.
6028
+ * 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.
6029
6029
  * Update the seller newsletter consent of a user
6030
6030
  */
6031
6031
  AdminApi.prototype.updateUserNewsletterStatusRaw = function (requestParameters, initOverrides) {
@@ -6067,7 +6067,7 @@ var AdminApi = /** @class */ (function (_super) {
6067
6067
  });
6068
6068
  };
6069
6069
  /**
6070
- * Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows on the next sync.
6070
+ * 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.
6071
6071
  * Update the seller newsletter consent of a user
6072
6072
  */
6073
6073
  AdminApi.prototype.updateUserNewsletterStatus = function (requestParameters, initOverrides) {
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- 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';
13
+ 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';
14
14
  export interface UsersApiActivateUserTotpRequest {
15
15
  activateUserTotpInput: ActivateUserTotpInput;
16
16
  }
@@ -98,6 +98,9 @@ export interface UsersApiStartUserTotpEnrolmentRequest {
98
98
  export interface UsersApiStartUserTotpReplacementRequest {
99
99
  totpCodeInput: TotpCodeInput;
100
100
  }
101
+ export interface UsersApiUpdateUserNewsletterSubscriptionRequest {
102
+ updateUserNewsletterSubscriptionInput: UpdateUserNewsletterSubscriptionInput;
103
+ }
101
104
  export interface UsersApiUpdateUserNotificationSettingsRequest {
102
105
  updateUserNotificationSettingsInput: UpdateUserNotificationSettingsInput;
103
106
  }
@@ -201,6 +204,16 @@ export declare class UsersApi extends runtime.BaseAPI {
201
204
  * Start confirming it is you with a passkey
202
205
  */
203
206
  getReauthenticationPasskeyOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasskeyOptionsDto>;
207
+ /**
208
+ * 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.
209
+ * Get the newsletter switch
210
+ */
211
+ getUserNewsletterSubscriptionRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserNewsletterSubscriptionDto>>;
212
+ /**
213
+ * 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.
214
+ * Get the newsletter switch
215
+ */
216
+ getUserNewsletterSubscription(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserNewsletterSubscriptionDto>;
204
217
  /**
205
218
  * 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.
206
219
  * Get user notification settings
@@ -347,6 +360,16 @@ export declare class UsersApi extends runtime.BaseAPI {
347
360
  * Request email change OTP
348
361
  */
349
362
  requestUserEmailChangeOtp(requestParameters: UsersApiRequestUserEmailChangeOtpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
363
+ /**
364
+ * 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.
365
+ * Send the newsletter confirmation email again
366
+ */
367
+ resendUserNewsletterConfirmationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserNewsletterSubscriptionDto>>;
368
+ /**
369
+ * 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.
370
+ * Send the newsletter confirmation email again
371
+ */
372
+ resendUserNewsletterConfirmation(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserNewsletterSubscriptionDto>;
350
373
  /**
351
374
  * 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.
352
375
  * Store user locale preference
@@ -377,6 +400,16 @@ export declare class UsersApi extends runtime.BaseAPI {
377
400
  * Start moving to another authenticator app
378
401
  */
379
402
  startUserTotpReplacement(requestParameters: UsersApiStartUserTotpReplacementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TotpEnrolmentDto>;
403
+ /**
404
+ * 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.
405
+ * Switch the newsletter on or off
406
+ */
407
+ updateUserNewsletterSubscriptionRaw(requestParameters: UsersApiUpdateUserNewsletterSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserNewsletterSubscriptionDto>>;
408
+ /**
409
+ * 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.
410
+ * Switch the newsletter on or off
411
+ */
412
+ updateUserNewsletterSubscription(requestParameters: UsersApiUpdateUserNewsletterSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserNewsletterSubscriptionDto>;
380
413
  /**
381
414
  * 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.
382
415
  * Update user notification settings
@@ -643,6 +643,66 @@ var UsersApi = /** @class */ (function (_super) {
643
643
  });
644
644
  });
645
645
  };
646
+ /**
647
+ * 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.
648
+ * Get the newsletter switch
649
+ */
650
+ UsersApi.prototype.getUserNewsletterSubscriptionRaw = function (initOverrides) {
651
+ return __awaiter(this, void 0, void 0, function () {
652
+ var queryParameters, headerParameters, _a, _b, token, tokenString, response;
653
+ return __generator(this, function (_c) {
654
+ switch (_c.label) {
655
+ case 0:
656
+ queryParameters = {};
657
+ headerParameters = {};
658
+ if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
659
+ _a = headerParameters;
660
+ _b = "apikey";
661
+ return [4 /*yield*/, this.configuration.apiKey("apikey")];
662
+ case 1:
663
+ _a[_b] = _c.sent(); // api_key authentication
664
+ _c.label = 2;
665
+ case 2:
666
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
667
+ token = this.configuration.accessToken;
668
+ return [4 /*yield*/, token("bearer", [])];
669
+ case 3:
670
+ tokenString = _c.sent();
671
+ if (tokenString) {
672
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
673
+ }
674
+ _c.label = 4;
675
+ case 4: return [4 /*yield*/, this.request({
676
+ path: "/private/users/newsletter",
677
+ method: 'GET',
678
+ headers: headerParameters,
679
+ query: queryParameters,
680
+ }, initOverrides)];
681
+ case 5:
682
+ response = _c.sent();
683
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.UserNewsletterSubscriptionDtoFromJSON)(jsonValue); })];
684
+ }
685
+ });
686
+ });
687
+ };
688
+ /**
689
+ * 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.
690
+ * Get the newsletter switch
691
+ */
692
+ UsersApi.prototype.getUserNewsletterSubscription = function (initOverrides) {
693
+ return __awaiter(this, void 0, void 0, function () {
694
+ var response;
695
+ return __generator(this, function (_a) {
696
+ switch (_a.label) {
697
+ case 0: return [4 /*yield*/, this.getUserNewsletterSubscriptionRaw(initOverrides)];
698
+ case 1:
699
+ response = _a.sent();
700
+ return [4 /*yield*/, response.value()];
701
+ case 2: return [2 /*return*/, _a.sent()];
702
+ }
703
+ });
704
+ });
705
+ };
646
706
  /**
647
707
  * 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.
648
708
  * Get user notification settings
@@ -1512,6 +1572,66 @@ var UsersApi = /** @class */ (function (_super) {
1512
1572
  });
1513
1573
  });
1514
1574
  };
1575
+ /**
1576
+ * 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.
1577
+ * Send the newsletter confirmation email again
1578
+ */
1579
+ UsersApi.prototype.resendUserNewsletterConfirmationRaw = function (initOverrides) {
1580
+ return __awaiter(this, void 0, void 0, function () {
1581
+ var queryParameters, headerParameters, _a, _b, token, tokenString, response;
1582
+ return __generator(this, function (_c) {
1583
+ switch (_c.label) {
1584
+ case 0:
1585
+ queryParameters = {};
1586
+ headerParameters = {};
1587
+ if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
1588
+ _a = headerParameters;
1589
+ _b = "apikey";
1590
+ return [4 /*yield*/, this.configuration.apiKey("apikey")];
1591
+ case 1:
1592
+ _a[_b] = _c.sent(); // api_key authentication
1593
+ _c.label = 2;
1594
+ case 2:
1595
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
1596
+ token = this.configuration.accessToken;
1597
+ return [4 /*yield*/, token("bearer", [])];
1598
+ case 3:
1599
+ tokenString = _c.sent();
1600
+ if (tokenString) {
1601
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
1602
+ }
1603
+ _c.label = 4;
1604
+ case 4: return [4 /*yield*/, this.request({
1605
+ path: "/private/users/newsletter/resend-confirmation",
1606
+ method: 'POST',
1607
+ headers: headerParameters,
1608
+ query: queryParameters,
1609
+ }, initOverrides)];
1610
+ case 5:
1611
+ response = _c.sent();
1612
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.UserNewsletterSubscriptionDtoFromJSON)(jsonValue); })];
1613
+ }
1614
+ });
1615
+ });
1616
+ };
1617
+ /**
1618
+ * 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.
1619
+ * Send the newsletter confirmation email again
1620
+ */
1621
+ UsersApi.prototype.resendUserNewsletterConfirmation = function (initOverrides) {
1622
+ return __awaiter(this, void 0, void 0, function () {
1623
+ var response;
1624
+ return __generator(this, function (_a) {
1625
+ switch (_a.label) {
1626
+ case 0: return [4 /*yield*/, this.resendUserNewsletterConfirmationRaw(initOverrides)];
1627
+ case 1:
1628
+ response = _a.sent();
1629
+ return [4 /*yield*/, response.value()];
1630
+ case 2: return [2 /*return*/, _a.sent()];
1631
+ }
1632
+ });
1633
+ });
1634
+ };
1515
1635
  /**
1516
1636
  * 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.
1517
1637
  * Store user locale preference
@@ -1690,6 +1810,71 @@ var UsersApi = /** @class */ (function (_super) {
1690
1810
  });
1691
1811
  });
1692
1812
  };
1813
+ /**
1814
+ * 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.
1815
+ * Switch the newsletter on or off
1816
+ */
1817
+ UsersApi.prototype.updateUserNewsletterSubscriptionRaw = function (requestParameters, initOverrides) {
1818
+ return __awaiter(this, void 0, void 0, function () {
1819
+ var queryParameters, headerParameters, _a, _b, token, tokenString, response;
1820
+ return __generator(this, function (_c) {
1821
+ switch (_c.label) {
1822
+ case 0:
1823
+ if (requestParameters['updateUserNewsletterSubscriptionInput'] == null) {
1824
+ throw new runtime.RequiredError('updateUserNewsletterSubscriptionInput', 'Required parameter "updateUserNewsletterSubscriptionInput" was null or undefined when calling updateUserNewsletterSubscription().');
1825
+ }
1826
+ queryParameters = {};
1827
+ headerParameters = {};
1828
+ headerParameters['Content-Type'] = 'application/json';
1829
+ if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
1830
+ _a = headerParameters;
1831
+ _b = "apikey";
1832
+ return [4 /*yield*/, this.configuration.apiKey("apikey")];
1833
+ case 1:
1834
+ _a[_b] = _c.sent(); // api_key authentication
1835
+ _c.label = 2;
1836
+ case 2:
1837
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
1838
+ token = this.configuration.accessToken;
1839
+ return [4 /*yield*/, token("bearer", [])];
1840
+ case 3:
1841
+ tokenString = _c.sent();
1842
+ if (tokenString) {
1843
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
1844
+ }
1845
+ _c.label = 4;
1846
+ case 4: return [4 /*yield*/, this.request({
1847
+ path: "/private/users/newsletter",
1848
+ method: 'PUT',
1849
+ headers: headerParameters,
1850
+ query: queryParameters,
1851
+ body: (0, index_1.UpdateUserNewsletterSubscriptionInputToJSON)(requestParameters['updateUserNewsletterSubscriptionInput']),
1852
+ }, initOverrides)];
1853
+ case 5:
1854
+ response = _c.sent();
1855
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.UserNewsletterSubscriptionDtoFromJSON)(jsonValue); })];
1856
+ }
1857
+ });
1858
+ });
1859
+ };
1860
+ /**
1861
+ * 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.
1862
+ * Switch the newsletter on or off
1863
+ */
1864
+ UsersApi.prototype.updateUserNewsletterSubscription = function (requestParameters, initOverrides) {
1865
+ return __awaiter(this, void 0, void 0, function () {
1866
+ var response;
1867
+ return __generator(this, function (_a) {
1868
+ switch (_a.label) {
1869
+ case 0: return [4 /*yield*/, this.updateUserNewsletterSubscriptionRaw(requestParameters, initOverrides)];
1870
+ case 1:
1871
+ response = _a.sent();
1872
+ return [4 /*yield*/, response.value()];
1873
+ case 2: return [2 /*return*/, _a.sent()];
1874
+ }
1875
+ });
1876
+ });
1877
+ };
1693
1878
  /**
1694
1879
  * 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.
1695
1880
  * Update user notification settings
@@ -114,6 +114,12 @@ export interface AccountSettingsDto {
114
114
  * @memberof AccountSettingsDto
115
115
  */
116
116
  leadVerification: LeadVerificationSettingsDto;
117
+ /**
118
+ * When the buyer of an information request (a lead opened to ask for the price) may write and make offers: immediately, or only after the seller has written or made an offer.
119
+ * @type {string}
120
+ * @memberof AccountSettingsDto
121
+ */
122
+ informationRequestCommunication: AccountSettingsDtoInformationRequestCommunicationEnum;
117
123
  }
118
124
  /**
119
125
  * @export
@@ -127,6 +133,14 @@ export declare const AccountSettingsDtoMarketplaceEnum: {
127
133
  readonly NAMECLUB: "nameclub";
128
134
  };
129
135
  export type AccountSettingsDtoMarketplaceEnum = typeof AccountSettingsDtoMarketplaceEnum[keyof typeof AccountSettingsDtoMarketplaceEnum];
136
+ /**
137
+ * @export
138
+ */
139
+ export declare const AccountSettingsDtoInformationRequestCommunicationEnum: {
140
+ readonly IMMEDIATELY: "immediately";
141
+ readonly AFTER_SELLER_FIRST_MESSAGE: "after_seller_first_message";
142
+ };
143
+ export type AccountSettingsDtoInformationRequestCommunicationEnum = typeof AccountSettingsDtoInformationRequestCommunicationEnum[keyof typeof AccountSettingsDtoInformationRequestCommunicationEnum];
130
144
  /**
131
145
  * Check if a given object implements the AccountSettingsDto interface.
132
146
  */
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.AccountSettingsDtoMarketplaceEnum = void 0;
16
+ exports.AccountSettingsDtoInformationRequestCommunicationEnum = exports.AccountSettingsDtoMarketplaceEnum = void 0;
17
17
  exports.instanceOfAccountSettingsDto = instanceOfAccountSettingsDto;
18
18
  exports.AccountSettingsDtoFromJSON = AccountSettingsDtoFromJSON;
19
19
  exports.AccountSettingsDtoFromJSONTyped = AccountSettingsDtoFromJSONTyped;
@@ -39,6 +39,13 @@ exports.AccountSettingsDtoMarketplaceEnum = {
39
39
  SPACESHIP: 'spaceship',
40
40
  NAMECLUB: 'nameclub'
41
41
  };
42
+ /**
43
+ * @export
44
+ */
45
+ exports.AccountSettingsDtoInformationRequestCommunicationEnum = {
46
+ IMMEDIATELY: 'immediately',
47
+ AFTER_SELLER_FIRST_MESSAGE: 'after_seller_first_message'
48
+ };
42
49
  /**
43
50
  * Check if a given object implements the AccountSettingsDto interface.
44
51
  */
@@ -73,6 +80,8 @@ function instanceOfAccountSettingsDto(value) {
73
80
  return false;
74
81
  if (!('leadVerification' in value) || value['leadVerification'] === undefined)
75
82
  return false;
83
+ if (!('informationRequestCommunication' in value) || value['informationRequestCommunication'] === undefined)
84
+ return false;
76
85
  return true;
77
86
  }
78
87
  function AccountSettingsDtoFromJSON(json) {
@@ -98,6 +107,7 @@ function AccountSettingsDtoFromJSONTyped(json, ignoreDiscriminator) {
98
107
  'leadOfferExpirationConfiguration': (0, LeadOfferExpirationConfigurationDto_1.LeadOfferExpirationConfigurationDtoFromJSON)(json['leadOfferExpirationConfiguration']),
99
108
  'marketplace': json['marketplace'],
100
109
  'leadVerification': (0, LeadVerificationSettingsDto_1.LeadVerificationSettingsDtoFromJSON)(json['leadVerification']),
110
+ 'informationRequestCommunication': json['informationRequestCommunication'],
101
111
  };
102
112
  }
103
113
  function AccountSettingsDtoToJSON(json) {
@@ -124,5 +134,6 @@ function AccountSettingsDtoToJSONTyped(value, ignoreDiscriminator) {
124
134
  'leadOfferExpirationConfiguration': (0, LeadOfferExpirationConfigurationDto_1.LeadOfferExpirationConfigurationDtoToJSON)(value['leadOfferExpirationConfiguration']),
125
135
  'marketplace': value['marketplace'],
126
136
  'leadVerification': (0, LeadVerificationSettingsDto_1.LeadVerificationSettingsDtoToJSON)(value['leadVerification']),
137
+ 'informationRequestCommunication': value['informationRequestCommunication'],
127
138
  };
128
139
  }
@@ -119,6 +119,12 @@ export interface AccountSettingsInput {
119
119
  * @memberof AccountSettingsInput
120
120
  */
121
121
  leadVerification?: LeadVerificationInput;
122
+ /**
123
+ * When the buyer of an information request (a lead opened to ask for the price) may write and make offers: immediately, or only after the seller has written or made an offer. Applies to information requests opened after the change.
124
+ * @type {string}
125
+ * @memberof AccountSettingsInput
126
+ */
127
+ informationRequestCommunication?: AccountSettingsInputInformationRequestCommunicationEnum;
122
128
  }
123
129
  /**
124
130
  * @export
@@ -132,6 +138,14 @@ export declare const AccountSettingsInputMarketplaceEnum: {
132
138
  readonly NAMECLUB: "nameclub";
133
139
  };
134
140
  export type AccountSettingsInputMarketplaceEnum = typeof AccountSettingsInputMarketplaceEnum[keyof typeof AccountSettingsInputMarketplaceEnum];
141
+ /**
142
+ * @export
143
+ */
144
+ export declare const AccountSettingsInputInformationRequestCommunicationEnum: {
145
+ readonly IMMEDIATELY: "immediately";
146
+ readonly AFTER_SELLER_FIRST_MESSAGE: "after_seller_first_message";
147
+ };
148
+ export type AccountSettingsInputInformationRequestCommunicationEnum = typeof AccountSettingsInputInformationRequestCommunicationEnum[keyof typeof AccountSettingsInputInformationRequestCommunicationEnum];
135
149
  /**
136
150
  * Check if a given object implements the AccountSettingsInput interface.
137
151
  */
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.AccountSettingsInputMarketplaceEnum = void 0;
16
+ exports.AccountSettingsInputInformationRequestCommunicationEnum = exports.AccountSettingsInputMarketplaceEnum = void 0;
17
17
  exports.instanceOfAccountSettingsInput = instanceOfAccountSettingsInput;
18
18
  exports.AccountSettingsInputFromJSON = AccountSettingsInputFromJSON;
19
19
  exports.AccountSettingsInputFromJSONTyped = AccountSettingsInputFromJSONTyped;
@@ -38,6 +38,13 @@ exports.AccountSettingsInputMarketplaceEnum = {
38
38
  SPACESHIP: 'spaceship',
39
39
  NAMECLUB: 'nameclub'
40
40
  };
41
+ /**
42
+ * @export
43
+ */
44
+ exports.AccountSettingsInputInformationRequestCommunicationEnum = {
45
+ IMMEDIATELY: 'immediately',
46
+ AFTER_SELLER_FIRST_MESSAGE: 'after_seller_first_message'
47
+ };
41
48
  /**
42
49
  * Check if a given object implements the AccountSettingsInput interface.
43
50
  */
@@ -68,6 +75,7 @@ function AccountSettingsInputFromJSONTyped(json, ignoreDiscriminator) {
68
75
  'domainLockConfiguration': json['domainLockConfiguration'] == null ? undefined : (0, LockConfigurationInput_1.LockConfigurationInputFromJSON)(json['domainLockConfiguration']),
69
76
  'leadOfferExpirationConfiguration': json['leadOfferExpirationConfiguration'] == null ? undefined : (0, LockConfigurationInput_1.LockConfigurationInputFromJSON)(json['leadOfferExpirationConfiguration']),
70
77
  'leadVerification': json['leadVerification'] == null ? undefined : (0, LeadVerificationInput_1.LeadVerificationInputFromJSON)(json['leadVerification']),
78
+ 'informationRequestCommunication': json['informationRequestCommunication'] == null ? undefined : json['informationRequestCommunication'],
71
79
  };
72
80
  }
73
81
  function AccountSettingsInputToJSON(json) {
@@ -95,5 +103,6 @@ function AccountSettingsInputToJSONTyped(value, ignoreDiscriminator) {
95
103
  'domainLockConfiguration': (0, LockConfigurationInput_1.LockConfigurationInputToJSON)(value['domainLockConfiguration']),
96
104
  'leadOfferExpirationConfiguration': (0, LockConfigurationInput_1.LockConfigurationInputToJSON)(value['leadOfferExpirationConfiguration']),
97
105
  'leadVerification': (0, LeadVerificationInput_1.LeadVerificationInputToJSON)(value['leadVerification']),
106
+ 'informationRequestCommunication': value['informationRequestCommunication'],
98
107
  };
99
108
  }
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface AdminUserNewsletterInput {
18
18
  /**
19
- * 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.
19
+ * 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.
20
20
  * @type {string}
21
21
  * @memberof AdminUserNewsletterInput
22
22
  */
@@ -29,6 +29,8 @@ export declare const AdminUserNewsletterInputNewsletterStatusEnum: {
29
29
  readonly SUBSCRIBED: "subscribed";
30
30
  readonly UNSUBSCRIBED: "unsubscribed";
31
31
  readonly NEVER_ASKED: "never_asked";
32
+ readonly PENDING: "pending";
33
+ readonly BOUNCED: "bounced";
32
34
  };
33
35
  export type AdminUserNewsletterInputNewsletterStatusEnum = typeof AdminUserNewsletterInputNewsletterStatusEnum[keyof typeof AdminUserNewsletterInputNewsletterStatusEnum];
34
36
  /**
@@ -25,7 +25,9 @@ exports.AdminUserNewsletterInputToJSONTyped = AdminUserNewsletterInputToJSONType
25
25
  exports.AdminUserNewsletterInputNewsletterStatusEnum = {
26
26
  SUBSCRIBED: 'subscribed',
27
27
  UNSUBSCRIBED: 'unsubscribed',
28
- NEVER_ASKED: 'never_asked'
28
+ NEVER_ASKED: 'never_asked',
29
+ PENDING: 'pending',
30
+ BOUNCED: 'bounced'
29
31
  };
30
32
  /**
31
33
  * Check if a given object implements the AdminUserNewsletterInput interface.
@@ -159,6 +159,12 @@ export interface LeadDto {
159
159
  * @memberof LeadDto
160
160
  */
161
161
  acceptedAt: Date | null;
162
+ /**
163
+ * Whether the buyer has to wait for the seller to write first. Only an information request can wait, when the seller chose to reply first; the buyer can neither write nor make an offer until the seller has written or made an offer.
164
+ * @type {boolean}
165
+ * @memberof LeadDto
166
+ */
167
+ awaitingSellerFirstMessage: boolean;
162
168
  }
163
169
  /**
164
170
  * @export
@@ -113,6 +113,8 @@ function instanceOfLeadDto(value) {
113
113
  return false;
114
114
  if (!('acceptedAt' in value) || value['acceptedAt'] === undefined)
115
115
  return false;
116
+ if (!('awaitingSellerFirstMessage' in value) || value['awaitingSellerFirstMessage'] === undefined)
117
+ return false;
116
118
  return true;
117
119
  }
118
120
  function LeadDtoFromJSON(json) {
@@ -146,6 +148,7 @@ function LeadDtoFromJSONTyped(json, ignoreDiscriminator) {
146
148
  'leadOfferExpirationConfiguration': (0, LeadOfferExpirationConfigurationDto_1.LeadOfferExpirationConfigurationDtoFromJSON)(json['leadOfferExpirationConfiguration']),
147
149
  'canBeClosedBySeller': json['canBeClosedBySeller'],
148
150
  'acceptedAt': (json['acceptedAt'] == null ? null : new Date(json['acceptedAt'])),
151
+ 'awaitingSellerFirstMessage': json['awaitingSellerFirstMessage'],
149
152
  };
150
153
  }
151
154
  function LeadDtoToJSON(json) {
@@ -180,5 +183,6 @@ function LeadDtoToJSONTyped(value, ignoreDiscriminator) {
180
183
  'leadOfferExpirationConfiguration': (0, LeadOfferExpirationConfigurationDto_1.LeadOfferExpirationConfigurationDtoToJSON)(value['leadOfferExpirationConfiguration']),
181
184
  'canBeClosedBySeller': value['canBeClosedBySeller'],
182
185
  'acceptedAt': (value['acceptedAt'] == null ? null : value['acceptedAt'].toISOString()),
186
+ 'awaitingSellerFirstMessage': value['awaitingSellerFirstMessage'],
183
187
  };
184
188
  }
@@ -160,6 +160,12 @@ export interface ListLeadsResultItem {
160
160
  * @memberof ListLeadsResultItem
161
161
  */
162
162
  acceptedAt: Date | null;
163
+ /**
164
+ * Whether the buyer has to wait for the seller to write first. Only an information request can wait, when the seller chose to reply first; the buyer can neither write nor make an offer until the seller has written or made an offer.
165
+ * @type {boolean}
166
+ * @memberof ListLeadsResultItem
167
+ */
168
+ awaitingSellerFirstMessage: boolean;
163
169
  /**
164
170
  * Buyer initials derived from the buyer name.
165
171
  * @type {string}
@@ -134,6 +134,8 @@ function instanceOfListLeadsResultItem(value) {
134
134
  return false;
135
135
  if (!('acceptedAt' in value) || value['acceptedAt'] === undefined)
136
136
  return false;
137
+ if (!('awaitingSellerFirstMessage' in value) || value['awaitingSellerFirstMessage'] === undefined)
138
+ return false;
137
139
  if (!('buyerInitials' in value) || value['buyerInitials'] === undefined)
138
140
  return false;
139
141
  if (!('buyerIpCountryCode' in value) || value['buyerIpCountryCode'] === undefined)
@@ -183,6 +185,7 @@ function ListLeadsResultItemFromJSONTyped(json, ignoreDiscriminator) {
183
185
  'leadOfferExpirationConfiguration': (0, LeadOfferExpirationConfigurationDto_1.LeadOfferExpirationConfigurationDtoFromJSON)(json['leadOfferExpirationConfiguration']),
184
186
  'canBeClosedBySeller': json['canBeClosedBySeller'],
185
187
  'acceptedAt': (json['acceptedAt'] == null ? null : new Date(json['acceptedAt'])),
188
+ 'awaitingSellerFirstMessage': json['awaitingSellerFirstMessage'],
186
189
  'buyerInitials': json['buyerInitials'],
187
190
  'buyerIpCountryCode': json['buyerIpCountryCode'],
188
191
  'lastMessageFrom': json['lastMessageFrom'],
@@ -225,6 +228,7 @@ function ListLeadsResultItemToJSONTyped(value, ignoreDiscriminator) {
225
228
  'leadOfferExpirationConfiguration': (0, LeadOfferExpirationConfigurationDto_1.LeadOfferExpirationConfigurationDtoToJSON)(value['leadOfferExpirationConfiguration']),
226
229
  'canBeClosedBySeller': value['canBeClosedBySeller'],
227
230
  'acceptedAt': (value['acceptedAt'] == null ? null : value['acceptedAt'].toISOString()),
231
+ 'awaitingSellerFirstMessage': value['awaitingSellerFirstMessage'],
228
232
  'buyerInitials': value['buyerInitials'],
229
233
  'buyerIpCountryCode': value['buyerIpCountryCode'],
230
234
  'lastMessageFrom': value['lastMessageFrom'],
@@ -161,6 +161,12 @@ export interface ManualLeadDetails {
161
161
  * @memberof ManualLeadDetails
162
162
  */
163
163
  acceptedAt: Date | null;
164
+ /**
165
+ * Whether the buyer has to wait for the seller to write first. Only an information request can wait, when the seller chose to reply first; the buyer can neither write nor make an offer until the seller has written or made an offer.
166
+ * @type {boolean}
167
+ * @memberof ManualLeadDetails
168
+ */
169
+ awaitingSellerFirstMessage: boolean;
164
170
  /**
165
171
  * Buyer details for the manually created lead.
166
172
  * @type {ManualLeadBuyerDto}