@randock/nameshift-api-client 0.0.480 → 0.0.481

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.
@@ -423,6 +423,7 @@ src/models/MoneyDto.ts
423
423
  src/models/MoneyInput.ts
424
424
  src/models/MozMetrics.ts
425
425
  src/models/NotFoundException.ts
426
+ src/models/NotificationsUnsubscribeResultDto.ts
426
427
  src/models/NzBankAccountDetails.ts
427
428
  src/models/ObjectId.ts
428
429
  src/models/OrderCompanyInfoDto.ts
@@ -595,6 +596,7 @@ src/models/UserNotificationDto.ts
595
596
  src/models/UserNotificationListItemDto.ts
596
597
  src/models/UserNotificationSettingsDto.ts
597
598
  src/models/UserPasswordResetDto.ts
599
+ src/models/UserSignedTokenInput.ts
598
600
  src/models/ValidateTaxNumberDto.ts
599
601
  src/models/ValidateTaxNumberInput.ts
600
602
  src/models/ValidationError.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @randock/nameshift-api-client@0.0.480
1
+ ## @randock/nameshift-api-client@0.0.481
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.480 --save
39
+ npm install @randock/nameshift-api-client@0.0.481 --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
- 09f44cc499eb87d00be9e86f9597e504c7341ab237ae3a2f0ec0cecc96d0f1f8e8531560d9bb02b1f112ace16642b220
47
+ 79cf49af01cfc60025b24287635d70fd0d6029bb0b310f6d54257b9a8c5e65006136d8dd2f1c643492395f14f188ecf6
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { ForgotPasswordRequestInput, LoginDto, LoginInput, SetNewPasswordInput, UserPasswordResetDto } from '../models/index';
13
+ import type { ForgotPasswordRequestInput, LoginDto, LoginInput, NotificationsUnsubscribeResultDto, SetNewPasswordInput, UserPasswordResetDto, UserSignedTokenInput } from '../models/index';
14
14
  export interface UsersPublicApiForgotPasswordRequestRequest {
15
15
  forgotPasswordRequestInput: ForgotPasswordRequestInput;
16
16
  }
@@ -24,6 +24,9 @@ export interface UsersPublicApiPostNewPasswordRequest {
24
24
  passwordRequestId: string;
25
25
  setNewPasswordInput: SetNewPasswordInput;
26
26
  }
27
+ export interface UsersPublicApiUnsubscribeFromNotificationsByTokenRequest {
28
+ userSignedTokenInput: UserSignedTokenInput;
29
+ }
27
30
  /**
28
31
  *
29
32
  */
@@ -68,4 +71,14 @@ export declare class UsersPublicApi extends runtime.BaseAPI {
68
71
  * Set a new password from reset request
69
72
  */
70
73
  postNewPassword(requestParameters: UsersPublicApiPostNewPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
74
+ /**
75
+ * Applies the unsubscription carried by the signed token of an email footer link, without a session: mutes the notifications of a task or a lead, or disables one notification setting.
76
+ * Unsubscribe from notifications with an email link token
77
+ */
78
+ unsubscribeFromNotificationsByTokenRaw(requestParameters: UsersPublicApiUnsubscribeFromNotificationsByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NotificationsUnsubscribeResultDto>>;
79
+ /**
80
+ * Applies the unsubscription carried by the signed token of an email footer link, without a session: mutes the notifications of a task or a lead, or disables one notification setting.
81
+ * Unsubscribe from notifications with an email link token
82
+ */
83
+ unsubscribeFromNotificationsByToken(requestParameters: UsersPublicApiUnsubscribeFromNotificationsByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NotificationsUnsubscribeResultDto>;
71
84
  }
@@ -264,6 +264,54 @@ var UsersPublicApi = /** @class */ (function (_super) {
264
264
  });
265
265
  });
266
266
  };
267
+ /**
268
+ * Applies the unsubscription carried by the signed token of an email footer link, without a session: mutes the notifications of a task or a lead, or disables one notification setting.
269
+ * Unsubscribe from notifications with an email link token
270
+ */
271
+ UsersPublicApi.prototype.unsubscribeFromNotificationsByTokenRaw = function (requestParameters, initOverrides) {
272
+ return __awaiter(this, void 0, void 0, function () {
273
+ var queryParameters, headerParameters, response;
274
+ return __generator(this, function (_a) {
275
+ switch (_a.label) {
276
+ case 0:
277
+ if (requestParameters['userSignedTokenInput'] == null) {
278
+ throw new runtime.RequiredError('userSignedTokenInput', 'Required parameter "userSignedTokenInput" was null or undefined when calling unsubscribeFromNotificationsByToken().');
279
+ }
280
+ queryParameters = {};
281
+ headerParameters = {};
282
+ headerParameters['Content-Type'] = 'application/json';
283
+ return [4 /*yield*/, this.request({
284
+ path: "/users/notifications/unsubscribe",
285
+ method: 'POST',
286
+ headers: headerParameters,
287
+ query: queryParameters,
288
+ body: (0, index_1.UserSignedTokenInputToJSON)(requestParameters['userSignedTokenInput']),
289
+ }, initOverrides)];
290
+ case 1:
291
+ response = _a.sent();
292
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.NotificationsUnsubscribeResultDtoFromJSON)(jsonValue); })];
293
+ }
294
+ });
295
+ });
296
+ };
297
+ /**
298
+ * Applies the unsubscription carried by the signed token of an email footer link, without a session: mutes the notifications of a task or a lead, or disables one notification setting.
299
+ * Unsubscribe from notifications with an email link token
300
+ */
301
+ UsersPublicApi.prototype.unsubscribeFromNotificationsByToken = function (requestParameters, initOverrides) {
302
+ return __awaiter(this, void 0, void 0, function () {
303
+ var response;
304
+ return __generator(this, function (_a) {
305
+ switch (_a.label) {
306
+ case 0: return [4 /*yield*/, this.unsubscribeFromNotificationsByTokenRaw(requestParameters, initOverrides)];
307
+ case 1:
308
+ response = _a.sent();
309
+ return [4 /*yield*/, response.value()];
310
+ case 2: return [2 /*return*/, _a.sent()];
311
+ }
312
+ });
313
+ });
314
+ };
267
315
  return UsersPublicApi;
268
316
  }(runtime.BaseAPI));
269
317
  exports.UsersPublicApi = UsersPublicApi;
@@ -0,0 +1,70 @@
1
+ /**
2
+ * Nameshift
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface NotificationsUnsubscribeResultDto
16
+ */
17
+ export interface NotificationsUnsubscribeResultDto {
18
+ /**
19
+ * What was unsubscribed: the notifications of one task, of one lead, or one notification setting.
20
+ * @type {string}
21
+ * @memberof NotificationsUnsubscribeResultDto
22
+ */
23
+ scope: NotificationsUnsubscribeResultDtoScopeEnum;
24
+ /**
25
+ * The notification setting that was disabled, when the scope is a setting.
26
+ * @type {string}
27
+ * @memberof NotificationsUnsubscribeResultDto
28
+ */
29
+ setting: NotificationsUnsubscribeResultDtoSettingEnum | null;
30
+ /**
31
+ * Whether the unsubscription was already in place before this request.
32
+ * @type {boolean}
33
+ * @memberof NotificationsUnsubscribeResultDto
34
+ */
35
+ alreadyUnsubscribed: boolean;
36
+ }
37
+ /**
38
+ * @export
39
+ */
40
+ export declare const NotificationsUnsubscribeResultDtoScopeEnum: {
41
+ readonly TASK: "task";
42
+ readonly LEAD: "lead";
43
+ readonly SETTING: "setting";
44
+ };
45
+ export type NotificationsUnsubscribeResultDtoScopeEnum = typeof NotificationsUnsubscribeResultDtoScopeEnum[keyof typeof NotificationsUnsubscribeResultDtoScopeEnum];
46
+ /**
47
+ * @export
48
+ */
49
+ export declare const NotificationsUnsubscribeResultDtoSettingEnum: {
50
+ readonly DOMAIN_SOLD: "domainSold";
51
+ readonly DOMAIN_TRANSFER_COMPLETED: "domainTransferCompleted";
52
+ readonly LEAD_CLOSED: "leadClosed";
53
+ readonly INVOICES: "invoices";
54
+ readonly PAYOUTS: "payouts";
55
+ readonly LEAD_TASKS: "leadTasks";
56
+ readonly DOMAIN_TRANSFER_TASKS: "domainTransferTasks";
57
+ readonly CHALLENGE_REWARD_TASKS: "challengeRewardTasks";
58
+ readonly LEAD_NEW_OFFER: "leadNewOffer";
59
+ readonly LEAD_NEW_MESSAGE: "leadNewMessage";
60
+ readonly LEAD_STATUS_CHANGED: "leadStatusChanged";
61
+ };
62
+ export type NotificationsUnsubscribeResultDtoSettingEnum = typeof NotificationsUnsubscribeResultDtoSettingEnum[keyof typeof NotificationsUnsubscribeResultDtoSettingEnum];
63
+ /**
64
+ * Check if a given object implements the NotificationsUnsubscribeResultDto interface.
65
+ */
66
+ export declare function instanceOfNotificationsUnsubscribeResultDto(value: object): value is NotificationsUnsubscribeResultDto;
67
+ export declare function NotificationsUnsubscribeResultDtoFromJSON(json: any): NotificationsUnsubscribeResultDto;
68
+ export declare function NotificationsUnsubscribeResultDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationsUnsubscribeResultDto;
69
+ export declare function NotificationsUnsubscribeResultDtoToJSON(json: any): NotificationsUnsubscribeResultDto;
70
+ export declare function NotificationsUnsubscribeResultDtoToJSONTyped(value?: NotificationsUnsubscribeResultDto | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,84 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Nameshift
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.NotificationsUnsubscribeResultDtoSettingEnum = exports.NotificationsUnsubscribeResultDtoScopeEnum = void 0;
17
+ exports.instanceOfNotificationsUnsubscribeResultDto = instanceOfNotificationsUnsubscribeResultDto;
18
+ exports.NotificationsUnsubscribeResultDtoFromJSON = NotificationsUnsubscribeResultDtoFromJSON;
19
+ exports.NotificationsUnsubscribeResultDtoFromJSONTyped = NotificationsUnsubscribeResultDtoFromJSONTyped;
20
+ exports.NotificationsUnsubscribeResultDtoToJSON = NotificationsUnsubscribeResultDtoToJSON;
21
+ exports.NotificationsUnsubscribeResultDtoToJSONTyped = NotificationsUnsubscribeResultDtoToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.NotificationsUnsubscribeResultDtoScopeEnum = {
26
+ TASK: 'task',
27
+ LEAD: 'lead',
28
+ SETTING: 'setting'
29
+ };
30
+ /**
31
+ * @export
32
+ */
33
+ exports.NotificationsUnsubscribeResultDtoSettingEnum = {
34
+ DOMAIN_SOLD: 'domainSold',
35
+ DOMAIN_TRANSFER_COMPLETED: 'domainTransferCompleted',
36
+ LEAD_CLOSED: 'leadClosed',
37
+ INVOICES: 'invoices',
38
+ PAYOUTS: 'payouts',
39
+ LEAD_TASKS: 'leadTasks',
40
+ DOMAIN_TRANSFER_TASKS: 'domainTransferTasks',
41
+ CHALLENGE_REWARD_TASKS: 'challengeRewardTasks',
42
+ LEAD_NEW_OFFER: 'leadNewOffer',
43
+ LEAD_NEW_MESSAGE: 'leadNewMessage',
44
+ LEAD_STATUS_CHANGED: 'leadStatusChanged'
45
+ };
46
+ /**
47
+ * Check if a given object implements the NotificationsUnsubscribeResultDto interface.
48
+ */
49
+ function instanceOfNotificationsUnsubscribeResultDto(value) {
50
+ if (!('scope' in value) || value['scope'] === undefined)
51
+ return false;
52
+ if (!('setting' in value) || value['setting'] === undefined)
53
+ return false;
54
+ if (!('alreadyUnsubscribed' in value) || value['alreadyUnsubscribed'] === undefined)
55
+ return false;
56
+ return true;
57
+ }
58
+ function NotificationsUnsubscribeResultDtoFromJSON(json) {
59
+ return NotificationsUnsubscribeResultDtoFromJSONTyped(json, false);
60
+ }
61
+ function NotificationsUnsubscribeResultDtoFromJSONTyped(json, ignoreDiscriminator) {
62
+ if (json == null) {
63
+ return json;
64
+ }
65
+ return {
66
+ 'scope': json['scope'],
67
+ 'setting': json['setting'],
68
+ 'alreadyUnsubscribed': json['alreadyUnsubscribed'],
69
+ };
70
+ }
71
+ function NotificationsUnsubscribeResultDtoToJSON(json) {
72
+ return NotificationsUnsubscribeResultDtoToJSONTyped(json, false);
73
+ }
74
+ function NotificationsUnsubscribeResultDtoToJSONTyped(value, ignoreDiscriminator) {
75
+ if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
76
+ if (value == null) {
77
+ return value;
78
+ }
79
+ return {
80
+ 'scope': value['scope'],
81
+ 'setting': value['setting'],
82
+ 'alreadyUnsubscribed': value['alreadyUnsubscribed'],
83
+ };
84
+ }
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Nameshift
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface UserSignedTokenInput
16
+ */
17
+ export interface UserSignedTokenInput {
18
+ /**
19
+ * Signed token carried by the link in the email
20
+ * @type {string}
21
+ * @memberof UserSignedTokenInput
22
+ */
23
+ token: string;
24
+ }
25
+ /**
26
+ * Check if a given object implements the UserSignedTokenInput interface.
27
+ */
28
+ export declare function instanceOfUserSignedTokenInput(value: object): value is UserSignedTokenInput;
29
+ export declare function UserSignedTokenInputFromJSON(json: any): UserSignedTokenInput;
30
+ export declare function UserSignedTokenInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserSignedTokenInput;
31
+ export declare function UserSignedTokenInputToJSON(json: any): UserSignedTokenInput;
32
+ export declare function UserSignedTokenInputToJSONTyped(value?: UserSignedTokenInput | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,51 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Nameshift
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfUserSignedTokenInput = instanceOfUserSignedTokenInput;
17
+ exports.UserSignedTokenInputFromJSON = UserSignedTokenInputFromJSON;
18
+ exports.UserSignedTokenInputFromJSONTyped = UserSignedTokenInputFromJSONTyped;
19
+ exports.UserSignedTokenInputToJSON = UserSignedTokenInputToJSON;
20
+ exports.UserSignedTokenInputToJSONTyped = UserSignedTokenInputToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the UserSignedTokenInput interface.
23
+ */
24
+ function instanceOfUserSignedTokenInput(value) {
25
+ if (!('token' in value) || value['token'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ function UserSignedTokenInputFromJSON(json) {
30
+ return UserSignedTokenInputFromJSONTyped(json, false);
31
+ }
32
+ function UserSignedTokenInputFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'token': json['token'],
38
+ };
39
+ }
40
+ function UserSignedTokenInputToJSON(json) {
41
+ return UserSignedTokenInputToJSONTyped(json, false);
42
+ }
43
+ function UserSignedTokenInputToJSONTyped(value, ignoreDiscriminator) {
44
+ if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
45
+ if (value == null) {
46
+ return value;
47
+ }
48
+ return {
49
+ 'token': value['token'],
50
+ };
51
+ }
@@ -382,6 +382,7 @@ export * from './MoneyDto';
382
382
  export * from './MoneyInput';
383
383
  export * from './MozMetrics';
384
384
  export * from './NotFoundException';
385
+ export * from './NotificationsUnsubscribeResultDto';
385
386
  export * from './NzBankAccountDetails';
386
387
  export * from './ObjectId';
387
388
  export * from './OrderCompanyInfoDto';
@@ -554,6 +555,7 @@ export * from './UserNotificationDto';
554
555
  export * from './UserNotificationListItemDto';
555
556
  export * from './UserNotificationSettingsDto';
556
557
  export * from './UserPasswordResetDto';
558
+ export * from './UserSignedTokenInput';
557
559
  export * from './ValidateTaxNumberDto';
558
560
  export * from './ValidateTaxNumberInput';
559
561
  export * from './ValidationError';
@@ -400,6 +400,7 @@ __exportStar(require("./MoneyDto"), exports);
400
400
  __exportStar(require("./MoneyInput"), exports);
401
401
  __exportStar(require("./MozMetrics"), exports);
402
402
  __exportStar(require("./NotFoundException"), exports);
403
+ __exportStar(require("./NotificationsUnsubscribeResultDto"), exports);
403
404
  __exportStar(require("./NzBankAccountDetails"), exports);
404
405
  __exportStar(require("./ObjectId"), exports);
405
406
  __exportStar(require("./OrderCompanyInfoDto"), exports);
@@ -572,6 +573,7 @@ __exportStar(require("./UserNotificationDto"), exports);
572
573
  __exportStar(require("./UserNotificationListItemDto"), exports);
573
574
  __exportStar(require("./UserNotificationSettingsDto"), exports);
574
575
  __exportStar(require("./UserPasswordResetDto"), exports);
576
+ __exportStar(require("./UserSignedTokenInput"), exports);
575
577
  __exportStar(require("./ValidateTaxNumberDto"), exports);
576
578
  __exportStar(require("./ValidateTaxNumberInput"), exports);
577
579
  __exportStar(require("./ValidationError"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@randock/nameshift-api-client",
3
- "version": "0.0.480",
3
+ "version": "0.0.481",
4
4
  "description": "OpenAPI client for @randock/nameshift-api-client",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -19,8 +19,10 @@ import type {
19
19
  LoginDto,
20
20
  LoginInput,
21
21
  NotFoundException,
22
+ NotificationsUnsubscribeResultDto,
22
23
  SetNewPasswordInput,
23
24
  UserPasswordResetDto,
25
+ UserSignedTokenInput,
24
26
  ValidationException,
25
27
  } from '../models/index';
26
28
  import {
@@ -32,10 +34,14 @@ import {
32
34
  LoginInputToJSON,
33
35
  NotFoundExceptionFromJSON,
34
36
  NotFoundExceptionToJSON,
37
+ NotificationsUnsubscribeResultDtoFromJSON,
38
+ NotificationsUnsubscribeResultDtoToJSON,
35
39
  SetNewPasswordInputFromJSON,
36
40
  SetNewPasswordInputToJSON,
37
41
  UserPasswordResetDtoFromJSON,
38
42
  UserPasswordResetDtoToJSON,
43
+ UserSignedTokenInputFromJSON,
44
+ UserSignedTokenInputToJSON,
39
45
  ValidationExceptionFromJSON,
40
46
  ValidationExceptionToJSON,
41
47
  } from '../models/index';
@@ -57,6 +63,10 @@ export interface UsersPublicApiPostNewPasswordRequest {
57
63
  setNewPasswordInput: SetNewPasswordInput;
58
64
  }
59
65
 
66
+ export interface UsersPublicApiUnsubscribeFromNotificationsByTokenRequest {
67
+ userSignedTokenInput: UserSignedTokenInput;
68
+ }
69
+
60
70
  /**
61
71
  *
62
72
  */
@@ -216,4 +226,42 @@ export class UsersPublicApi extends runtime.BaseAPI {
216
226
  await this.postNewPasswordRaw(requestParameters, initOverrides);
217
227
  }
218
228
 
229
+ /**
230
+ * Applies the unsubscription carried by the signed token of an email footer link, without a session: mutes the notifications of a task or a lead, or disables one notification setting.
231
+ * Unsubscribe from notifications with an email link token
232
+ */
233
+ async unsubscribeFromNotificationsByTokenRaw(requestParameters: UsersPublicApiUnsubscribeFromNotificationsByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NotificationsUnsubscribeResultDto>> {
234
+ if (requestParameters['userSignedTokenInput'] == null) {
235
+ throw new runtime.RequiredError(
236
+ 'userSignedTokenInput',
237
+ 'Required parameter "userSignedTokenInput" was null or undefined when calling unsubscribeFromNotificationsByToken().'
238
+ );
239
+ }
240
+
241
+ const queryParameters: any = {};
242
+
243
+ const headerParameters: runtime.HTTPHeaders = {};
244
+
245
+ headerParameters['Content-Type'] = 'application/json';
246
+
247
+ const response = await this.request({
248
+ path: `/users/notifications/unsubscribe`,
249
+ method: 'POST',
250
+ headers: headerParameters,
251
+ query: queryParameters,
252
+ body: UserSignedTokenInputToJSON(requestParameters['userSignedTokenInput']),
253
+ }, initOverrides);
254
+
255
+ return new runtime.JSONApiResponse(response, (jsonValue) => NotificationsUnsubscribeResultDtoFromJSON(jsonValue));
256
+ }
257
+
258
+ /**
259
+ * Applies the unsubscription carried by the signed token of an email footer link, without a session: mutes the notifications of a task or a lead, or disables one notification setting.
260
+ * Unsubscribe from notifications with an email link token
261
+ */
262
+ async unsubscribeFromNotificationsByToken(requestParameters: UsersPublicApiUnsubscribeFromNotificationsByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NotificationsUnsubscribeResultDto> {
263
+ const response = await this.unsubscribeFromNotificationsByTokenRaw(requestParameters, initOverrides);
264
+ return await response.value();
265
+ }
266
+
219
267
  }
@@ -0,0 +1,114 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Nameshift
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface NotificationsUnsubscribeResultDto
20
+ */
21
+ export interface NotificationsUnsubscribeResultDto {
22
+ /**
23
+ * What was unsubscribed: the notifications of one task, of one lead, or one notification setting.
24
+ * @type {string}
25
+ * @memberof NotificationsUnsubscribeResultDto
26
+ */
27
+ scope: NotificationsUnsubscribeResultDtoScopeEnum;
28
+ /**
29
+ * The notification setting that was disabled, when the scope is a setting.
30
+ * @type {string}
31
+ * @memberof NotificationsUnsubscribeResultDto
32
+ */
33
+ setting: NotificationsUnsubscribeResultDtoSettingEnum | null;
34
+ /**
35
+ * Whether the unsubscription was already in place before this request.
36
+ * @type {boolean}
37
+ * @memberof NotificationsUnsubscribeResultDto
38
+ */
39
+ alreadyUnsubscribed: boolean;
40
+ }
41
+
42
+
43
+ /**
44
+ * @export
45
+ */
46
+ export const NotificationsUnsubscribeResultDtoScopeEnum = {
47
+ TASK: 'task',
48
+ LEAD: 'lead',
49
+ SETTING: 'setting'
50
+ } as const;
51
+ export type NotificationsUnsubscribeResultDtoScopeEnum = typeof NotificationsUnsubscribeResultDtoScopeEnum[keyof typeof NotificationsUnsubscribeResultDtoScopeEnum];
52
+
53
+ /**
54
+ * @export
55
+ */
56
+ export const NotificationsUnsubscribeResultDtoSettingEnum = {
57
+ DOMAIN_SOLD: 'domainSold',
58
+ DOMAIN_TRANSFER_COMPLETED: 'domainTransferCompleted',
59
+ LEAD_CLOSED: 'leadClosed',
60
+ INVOICES: 'invoices',
61
+ PAYOUTS: 'payouts',
62
+ LEAD_TASKS: 'leadTasks',
63
+ DOMAIN_TRANSFER_TASKS: 'domainTransferTasks',
64
+ CHALLENGE_REWARD_TASKS: 'challengeRewardTasks',
65
+ LEAD_NEW_OFFER: 'leadNewOffer',
66
+ LEAD_NEW_MESSAGE: 'leadNewMessage',
67
+ LEAD_STATUS_CHANGED: 'leadStatusChanged'
68
+ } as const;
69
+ export type NotificationsUnsubscribeResultDtoSettingEnum = typeof NotificationsUnsubscribeResultDtoSettingEnum[keyof typeof NotificationsUnsubscribeResultDtoSettingEnum];
70
+
71
+
72
+ /**
73
+ * Check if a given object implements the NotificationsUnsubscribeResultDto interface.
74
+ */
75
+ export function instanceOfNotificationsUnsubscribeResultDto(value: object): value is NotificationsUnsubscribeResultDto {
76
+ if (!('scope' in value) || value['scope'] === undefined) return false;
77
+ if (!('setting' in value) || value['setting'] === undefined) return false;
78
+ if (!('alreadyUnsubscribed' in value) || value['alreadyUnsubscribed'] === undefined) return false;
79
+ return true;
80
+ }
81
+
82
+ export function NotificationsUnsubscribeResultDtoFromJSON(json: any): NotificationsUnsubscribeResultDto {
83
+ return NotificationsUnsubscribeResultDtoFromJSONTyped(json, false);
84
+ }
85
+
86
+ export function NotificationsUnsubscribeResultDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationsUnsubscribeResultDto {
87
+ if (json == null) {
88
+ return json;
89
+ }
90
+ return {
91
+
92
+ 'scope': json['scope'],
93
+ 'setting': json['setting'],
94
+ 'alreadyUnsubscribed': json['alreadyUnsubscribed'],
95
+ };
96
+ }
97
+
98
+ export function NotificationsUnsubscribeResultDtoToJSON(json: any): NotificationsUnsubscribeResultDto {
99
+ return NotificationsUnsubscribeResultDtoToJSONTyped(json, false);
100
+ }
101
+
102
+ export function NotificationsUnsubscribeResultDtoToJSONTyped(value?: NotificationsUnsubscribeResultDto | null, ignoreDiscriminator: boolean = false): any {
103
+ if (value == null) {
104
+ return value;
105
+ }
106
+
107
+ return {
108
+
109
+ 'scope': value['scope'],
110
+ 'setting': value['setting'],
111
+ 'alreadyUnsubscribed': value['alreadyUnsubscribed'],
112
+ };
113
+ }
114
+
@@ -0,0 +1,66 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Nameshift
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface UserSignedTokenInput
20
+ */
21
+ export interface UserSignedTokenInput {
22
+ /**
23
+ * Signed token carried by the link in the email
24
+ * @type {string}
25
+ * @memberof UserSignedTokenInput
26
+ */
27
+ token: string;
28
+ }
29
+
30
+ /**
31
+ * Check if a given object implements the UserSignedTokenInput interface.
32
+ */
33
+ export function instanceOfUserSignedTokenInput(value: object): value is UserSignedTokenInput {
34
+ if (!('token' in value) || value['token'] === undefined) return false;
35
+ return true;
36
+ }
37
+
38
+ export function UserSignedTokenInputFromJSON(json: any): UserSignedTokenInput {
39
+ return UserSignedTokenInputFromJSONTyped(json, false);
40
+ }
41
+
42
+ export function UserSignedTokenInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserSignedTokenInput {
43
+ if (json == null) {
44
+ return json;
45
+ }
46
+ return {
47
+
48
+ 'token': json['token'],
49
+ };
50
+ }
51
+
52
+ export function UserSignedTokenInputToJSON(json: any): UserSignedTokenInput {
53
+ return UserSignedTokenInputToJSONTyped(json, false);
54
+ }
55
+
56
+ export function UserSignedTokenInputToJSONTyped(value?: UserSignedTokenInput | null, ignoreDiscriminator: boolean = false): any {
57
+ if (value == null) {
58
+ return value;
59
+ }
60
+
61
+ return {
62
+
63
+ 'token': value['token'],
64
+ };
65
+ }
66
+
@@ -384,6 +384,7 @@ export * from './MoneyDto';
384
384
  export * from './MoneyInput';
385
385
  export * from './MozMetrics';
386
386
  export * from './NotFoundException';
387
+ export * from './NotificationsUnsubscribeResultDto';
387
388
  export * from './NzBankAccountDetails';
388
389
  export * from './ObjectId';
389
390
  export * from './OrderCompanyInfoDto';
@@ -556,6 +557,7 @@ export * from './UserNotificationDto';
556
557
  export * from './UserNotificationListItemDto';
557
558
  export * from './UserNotificationSettingsDto';
558
559
  export * from './UserPasswordResetDto';
560
+ export * from './UserSignedTokenInput';
559
561
  export * from './ValidateTaxNumberDto';
560
562
  export * from './ValidateTaxNumberInput';
561
563
  export * from './ValidationError';