@randock/nameshift-api-client 0.0.505 → 0.0.506
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.
- package/.openapi-generator/FILES +9 -0
- package/README.md +3 -3
- package/dist/apis/AdminApi.d.ts +113 -1
- package/dist/apis/AdminApi.js +500 -0
- package/dist/models/AdminUserNewsletterInput.d.ts +41 -0
- package/dist/models/AdminUserNewsletterInput.js +60 -0
- package/dist/models/CreateNewsletterInput.d.ts +171 -0
- package/dist/models/CreateNewsletterInput.js +98 -0
- package/dist/models/NewsStoryDto.d.ts +80 -0
- package/dist/models/NewsStoryDto.js +83 -0
- package/dist/models/NewsletterDto.d.ts +251 -0
- package/dist/models/NewsletterDto.js +200 -0
- package/dist/models/NewsletterPreviewDto.d.ts +44 -0
- package/dist/models/NewsletterPreviewDto.js +59 -0
- package/dist/models/NewsletterSecondaryStoryDto.d.ts +44 -0
- package/dist/models/NewsletterSecondaryStoryDto.js +59 -0
- package/dist/models/NewsletterSecondaryStoryInput.d.ts +44 -0
- package/dist/models/NewsletterSecondaryStoryInput.js +59 -0
- package/dist/models/SendNewsletterPreviewInput.d.ts +32 -0
- package/dist/models/SendNewsletterPreviewInput.js +51 -0
- package/dist/models/UpdateNewsletterInput.d.ts +171 -0
- package/dist/models/UpdateNewsletterInput.js +96 -0
- package/dist/models/index.d.ts +9 -0
- package/dist/models/index.js +9 -0
- package/package.json +1 -1
- package/src/apis/AdminApi.ts +454 -0
- package/src/models/AdminUserNewsletterInput.ts +78 -0
- package/src/models/CreateNewsletterInput.ts +258 -0
- package/src/models/NewsStoryDto.ts +138 -0
- package/src/models/NewsletterDto.ts +400 -0
- package/src/models/NewsletterPreviewDto.ts +84 -0
- package/src/models/NewsletterSecondaryStoryDto.ts +84 -0
- package/src/models/NewsletterSecondaryStoryInput.ts +84 -0
- package/src/models/SendNewsletterPreviewInput.ts +66 -0
- package/src/models/UpdateNewsletterInput.ts +257 -0
- package/src/models/index.ts +9 -0
package/dist/apis/AdminApi.js
CHANGED
|
@@ -818,6 +818,63 @@ var AdminApi = /** @class */ (function (_super) {
|
|
|
818
818
|
});
|
|
819
819
|
});
|
|
820
820
|
};
|
|
821
|
+
/**
|
|
822
|
+
* Creates a draft issue with the default closing band and footer; everything can be edited afterwards.
|
|
823
|
+
* Start a newsletter
|
|
824
|
+
*/
|
|
825
|
+
AdminApi.prototype.createNewsletterRaw = function (requestParameters, initOverrides) {
|
|
826
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
827
|
+
var queryParameters, headerParameters, token, tokenString, response;
|
|
828
|
+
return __generator(this, function (_a) {
|
|
829
|
+
switch (_a.label) {
|
|
830
|
+
case 0:
|
|
831
|
+
if (requestParameters['createNewsletterInput'] == null) {
|
|
832
|
+
throw new runtime.RequiredError('createNewsletterInput', 'Required parameter "createNewsletterInput" was null or undefined when calling createNewsletter().');
|
|
833
|
+
}
|
|
834
|
+
queryParameters = {};
|
|
835
|
+
headerParameters = {};
|
|
836
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
837
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
838
|
+
token = this.configuration.accessToken;
|
|
839
|
+
return [4 /*yield*/, token("bearer", [])];
|
|
840
|
+
case 1:
|
|
841
|
+
tokenString = _a.sent();
|
|
842
|
+
if (tokenString) {
|
|
843
|
+
headerParameters["Authorization"] = "Bearer ".concat(tokenString);
|
|
844
|
+
}
|
|
845
|
+
_a.label = 2;
|
|
846
|
+
case 2: return [4 /*yield*/, this.request({
|
|
847
|
+
path: "/admin/newsletters",
|
|
848
|
+
method: 'POST',
|
|
849
|
+
headers: headerParameters,
|
|
850
|
+
query: queryParameters,
|
|
851
|
+
body: (0, index_1.CreateNewsletterInputToJSON)(requestParameters['createNewsletterInput']),
|
|
852
|
+
}, initOverrides)];
|
|
853
|
+
case 3:
|
|
854
|
+
response = _a.sent();
|
|
855
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.NewsletterDtoFromJSON)(jsonValue); })];
|
|
856
|
+
}
|
|
857
|
+
});
|
|
858
|
+
});
|
|
859
|
+
};
|
|
860
|
+
/**
|
|
861
|
+
* Creates a draft issue with the default closing band and footer; everything can be edited afterwards.
|
|
862
|
+
* Start a newsletter
|
|
863
|
+
*/
|
|
864
|
+
AdminApi.prototype.createNewsletter = function (requestParameters, initOverrides) {
|
|
865
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
866
|
+
var response;
|
|
867
|
+
return __generator(this, function (_a) {
|
|
868
|
+
switch (_a.label) {
|
|
869
|
+
case 0: return [4 /*yield*/, this.createNewsletterRaw(requestParameters, initOverrides)];
|
|
870
|
+
case 1:
|
|
871
|
+
response = _a.sent();
|
|
872
|
+
return [4 /*yield*/, response.value()];
|
|
873
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
874
|
+
}
|
|
875
|
+
});
|
|
876
|
+
});
|
|
877
|
+
};
|
|
821
878
|
/**
|
|
822
879
|
* Soft-deletes a note. Only its author, or a super admin, may do so.
|
|
823
880
|
* Delete account note
|
|
@@ -2436,6 +2493,59 @@ var AdminApi = /** @class */ (function (_super) {
|
|
|
2436
2493
|
});
|
|
2437
2494
|
});
|
|
2438
2495
|
};
|
|
2496
|
+
/**
|
|
2497
|
+
* Get a newsletter
|
|
2498
|
+
*/
|
|
2499
|
+
AdminApi.prototype.getNewsletterRaw = function (requestParameters, initOverrides) {
|
|
2500
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
2501
|
+
var queryParameters, headerParameters, token, tokenString, response;
|
|
2502
|
+
return __generator(this, function (_a) {
|
|
2503
|
+
switch (_a.label) {
|
|
2504
|
+
case 0:
|
|
2505
|
+
if (requestParameters['newsletterId'] == null) {
|
|
2506
|
+
throw new runtime.RequiredError('newsletterId', 'Required parameter "newsletterId" was null or undefined when calling getNewsletter().');
|
|
2507
|
+
}
|
|
2508
|
+
queryParameters = {};
|
|
2509
|
+
headerParameters = {};
|
|
2510
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
2511
|
+
token = this.configuration.accessToken;
|
|
2512
|
+
return [4 /*yield*/, token("bearer", [])];
|
|
2513
|
+
case 1:
|
|
2514
|
+
tokenString = _a.sent();
|
|
2515
|
+
if (tokenString) {
|
|
2516
|
+
headerParameters["Authorization"] = "Bearer ".concat(tokenString);
|
|
2517
|
+
}
|
|
2518
|
+
_a.label = 2;
|
|
2519
|
+
case 2: return [4 /*yield*/, this.request({
|
|
2520
|
+
path: "/admin/newsletters/{newsletterId}".replace("{".concat("newsletterId", "}"), encodeURIComponent(String(requestParameters['newsletterId']))),
|
|
2521
|
+
method: 'GET',
|
|
2522
|
+
headers: headerParameters,
|
|
2523
|
+
query: queryParameters,
|
|
2524
|
+
}, initOverrides)];
|
|
2525
|
+
case 3:
|
|
2526
|
+
response = _a.sent();
|
|
2527
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.NewsletterDtoFromJSON)(jsonValue); })];
|
|
2528
|
+
}
|
|
2529
|
+
});
|
|
2530
|
+
});
|
|
2531
|
+
};
|
|
2532
|
+
/**
|
|
2533
|
+
* Get a newsletter
|
|
2534
|
+
*/
|
|
2535
|
+
AdminApi.prototype.getNewsletter = function (requestParameters, initOverrides) {
|
|
2536
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
2537
|
+
var response;
|
|
2538
|
+
return __generator(this, function (_a) {
|
|
2539
|
+
switch (_a.label) {
|
|
2540
|
+
case 0: return [4 /*yield*/, this.getNewsletterRaw(requestParameters, initOverrides)];
|
|
2541
|
+
case 1:
|
|
2542
|
+
response = _a.sent();
|
|
2543
|
+
return [4 /*yield*/, response.value()];
|
|
2544
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
2545
|
+
}
|
|
2546
|
+
});
|
|
2547
|
+
});
|
|
2548
|
+
};
|
|
2439
2549
|
/**
|
|
2440
2550
|
* Returns subscription information.
|
|
2441
2551
|
* Get subscription details
|
|
@@ -3599,6 +3709,110 @@ var AdminApi = /** @class */ (function (_super) {
|
|
|
3599
3709
|
});
|
|
3600
3710
|
});
|
|
3601
3711
|
};
|
|
3712
|
+
/**
|
|
3713
|
+
* The published news articles, newest first.
|
|
3714
|
+
* List the blog posts a newsletter can pick
|
|
3715
|
+
*/
|
|
3716
|
+
AdminApi.prototype.listNewsletterStoriesRaw = function (initOverrides) {
|
|
3717
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
3718
|
+
var queryParameters, headerParameters, token, tokenString, response;
|
|
3719
|
+
return __generator(this, function (_a) {
|
|
3720
|
+
switch (_a.label) {
|
|
3721
|
+
case 0:
|
|
3722
|
+
queryParameters = {};
|
|
3723
|
+
headerParameters = {};
|
|
3724
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
3725
|
+
token = this.configuration.accessToken;
|
|
3726
|
+
return [4 /*yield*/, token("bearer", [])];
|
|
3727
|
+
case 1:
|
|
3728
|
+
tokenString = _a.sent();
|
|
3729
|
+
if (tokenString) {
|
|
3730
|
+
headerParameters["Authorization"] = "Bearer ".concat(tokenString);
|
|
3731
|
+
}
|
|
3732
|
+
_a.label = 2;
|
|
3733
|
+
case 2: return [4 /*yield*/, this.request({
|
|
3734
|
+
path: "/admin/newsletters/stories",
|
|
3735
|
+
method: 'GET',
|
|
3736
|
+
headers: headerParameters,
|
|
3737
|
+
query: queryParameters,
|
|
3738
|
+
}, initOverrides)];
|
|
3739
|
+
case 3:
|
|
3740
|
+
response = _a.sent();
|
|
3741
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.NewsStoryDtoFromJSON); })];
|
|
3742
|
+
}
|
|
3743
|
+
});
|
|
3744
|
+
});
|
|
3745
|
+
};
|
|
3746
|
+
/**
|
|
3747
|
+
* The published news articles, newest first.
|
|
3748
|
+
* List the blog posts a newsletter can pick
|
|
3749
|
+
*/
|
|
3750
|
+
AdminApi.prototype.listNewsletterStories = function (initOverrides) {
|
|
3751
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
3752
|
+
var response;
|
|
3753
|
+
return __generator(this, function (_a) {
|
|
3754
|
+
switch (_a.label) {
|
|
3755
|
+
case 0: return [4 /*yield*/, this.listNewsletterStoriesRaw(initOverrides)];
|
|
3756
|
+
case 1:
|
|
3757
|
+
response = _a.sent();
|
|
3758
|
+
return [4 /*yield*/, response.value()];
|
|
3759
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
3760
|
+
}
|
|
3761
|
+
});
|
|
3762
|
+
});
|
|
3763
|
+
};
|
|
3764
|
+
/**
|
|
3765
|
+
* Every newsletter issue, newest first.
|
|
3766
|
+
* List newsletters
|
|
3767
|
+
*/
|
|
3768
|
+
AdminApi.prototype.listNewslettersRaw = function (initOverrides) {
|
|
3769
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
3770
|
+
var queryParameters, headerParameters, token, tokenString, response;
|
|
3771
|
+
return __generator(this, function (_a) {
|
|
3772
|
+
switch (_a.label) {
|
|
3773
|
+
case 0:
|
|
3774
|
+
queryParameters = {};
|
|
3775
|
+
headerParameters = {};
|
|
3776
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
3777
|
+
token = this.configuration.accessToken;
|
|
3778
|
+
return [4 /*yield*/, token("bearer", [])];
|
|
3779
|
+
case 1:
|
|
3780
|
+
tokenString = _a.sent();
|
|
3781
|
+
if (tokenString) {
|
|
3782
|
+
headerParameters["Authorization"] = "Bearer ".concat(tokenString);
|
|
3783
|
+
}
|
|
3784
|
+
_a.label = 2;
|
|
3785
|
+
case 2: return [4 /*yield*/, this.request({
|
|
3786
|
+
path: "/admin/newsletters",
|
|
3787
|
+
method: 'GET',
|
|
3788
|
+
headers: headerParameters,
|
|
3789
|
+
query: queryParameters,
|
|
3790
|
+
}, initOverrides)];
|
|
3791
|
+
case 3:
|
|
3792
|
+
response = _a.sent();
|
|
3793
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.NewsletterDtoFromJSON); })];
|
|
3794
|
+
}
|
|
3795
|
+
});
|
|
3796
|
+
});
|
|
3797
|
+
};
|
|
3798
|
+
/**
|
|
3799
|
+
* Every newsletter issue, newest first.
|
|
3800
|
+
* List newsletters
|
|
3801
|
+
*/
|
|
3802
|
+
AdminApi.prototype.listNewsletters = function (initOverrides) {
|
|
3803
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
3804
|
+
var response;
|
|
3805
|
+
return __generator(this, function (_a) {
|
|
3806
|
+
switch (_a.label) {
|
|
3807
|
+
case 0: return [4 /*yield*/, this.listNewslettersRaw(initOverrides)];
|
|
3808
|
+
case 1:
|
|
3809
|
+
response = _a.sent();
|
|
3810
|
+
return [4 /*yield*/, response.value()];
|
|
3811
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
3812
|
+
}
|
|
3813
|
+
});
|
|
3814
|
+
});
|
|
3815
|
+
};
|
|
3602
3816
|
/**
|
|
3603
3817
|
* List the sign-ins of a user
|
|
3604
3818
|
*/
|
|
@@ -4057,6 +4271,116 @@ var AdminApi = /** @class */ (function (_super) {
|
|
|
4057
4271
|
});
|
|
4058
4272
|
});
|
|
4059
4273
|
};
|
|
4274
|
+
/**
|
|
4275
|
+
* Creates the Mailchimp draft campaign, or refreshes the existing one, with the current render. The campaign is never sent or scheduled from here.
|
|
4276
|
+
* Prepare the newsletter in Mailchimp
|
|
4277
|
+
*/
|
|
4278
|
+
AdminApi.prototype.prepareNewsletterRaw = function (requestParameters, initOverrides) {
|
|
4279
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
4280
|
+
var queryParameters, headerParameters, token, tokenString, response;
|
|
4281
|
+
return __generator(this, function (_a) {
|
|
4282
|
+
switch (_a.label) {
|
|
4283
|
+
case 0:
|
|
4284
|
+
if (requestParameters['newsletterId'] == null) {
|
|
4285
|
+
throw new runtime.RequiredError('newsletterId', 'Required parameter "newsletterId" was null or undefined when calling prepareNewsletter().');
|
|
4286
|
+
}
|
|
4287
|
+
queryParameters = {};
|
|
4288
|
+
headerParameters = {};
|
|
4289
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
4290
|
+
token = this.configuration.accessToken;
|
|
4291
|
+
return [4 /*yield*/, token("bearer", [])];
|
|
4292
|
+
case 1:
|
|
4293
|
+
tokenString = _a.sent();
|
|
4294
|
+
if (tokenString) {
|
|
4295
|
+
headerParameters["Authorization"] = "Bearer ".concat(tokenString);
|
|
4296
|
+
}
|
|
4297
|
+
_a.label = 2;
|
|
4298
|
+
case 2: return [4 /*yield*/, this.request({
|
|
4299
|
+
path: "/admin/newsletters/{newsletterId}/prepare".replace("{".concat("newsletterId", "}"), encodeURIComponent(String(requestParameters['newsletterId']))),
|
|
4300
|
+
method: 'POST',
|
|
4301
|
+
headers: headerParameters,
|
|
4302
|
+
query: queryParameters,
|
|
4303
|
+
}, initOverrides)];
|
|
4304
|
+
case 3:
|
|
4305
|
+
response = _a.sent();
|
|
4306
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.NewsletterDtoFromJSON)(jsonValue); })];
|
|
4307
|
+
}
|
|
4308
|
+
});
|
|
4309
|
+
});
|
|
4310
|
+
};
|
|
4311
|
+
/**
|
|
4312
|
+
* Creates the Mailchimp draft campaign, or refreshes the existing one, with the current render. The campaign is never sent or scheduled from here.
|
|
4313
|
+
* Prepare the newsletter in Mailchimp
|
|
4314
|
+
*/
|
|
4315
|
+
AdminApi.prototype.prepareNewsletter = function (requestParameters, initOverrides) {
|
|
4316
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
4317
|
+
var response;
|
|
4318
|
+
return __generator(this, function (_a) {
|
|
4319
|
+
switch (_a.label) {
|
|
4320
|
+
case 0: return [4 /*yield*/, this.prepareNewsletterRaw(requestParameters, initOverrides)];
|
|
4321
|
+
case 1:
|
|
4322
|
+
response = _a.sent();
|
|
4323
|
+
return [4 /*yield*/, response.value()];
|
|
4324
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
4325
|
+
}
|
|
4326
|
+
});
|
|
4327
|
+
});
|
|
4328
|
+
};
|
|
4329
|
+
/**
|
|
4330
|
+
* The email as it would go to Mailchimp, with the merge tags replaced by placeholders, for the live preview.
|
|
4331
|
+
* Render a newsletter
|
|
4332
|
+
*/
|
|
4333
|
+
AdminApi.prototype.previewNewsletterRaw = function (requestParameters, initOverrides) {
|
|
4334
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
4335
|
+
var queryParameters, headerParameters, token, tokenString, response;
|
|
4336
|
+
return __generator(this, function (_a) {
|
|
4337
|
+
switch (_a.label) {
|
|
4338
|
+
case 0:
|
|
4339
|
+
if (requestParameters['newsletterId'] == null) {
|
|
4340
|
+
throw new runtime.RequiredError('newsletterId', 'Required parameter "newsletterId" was null or undefined when calling previewNewsletter().');
|
|
4341
|
+
}
|
|
4342
|
+
queryParameters = {};
|
|
4343
|
+
headerParameters = {};
|
|
4344
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
4345
|
+
token = this.configuration.accessToken;
|
|
4346
|
+
return [4 /*yield*/, token("bearer", [])];
|
|
4347
|
+
case 1:
|
|
4348
|
+
tokenString = _a.sent();
|
|
4349
|
+
if (tokenString) {
|
|
4350
|
+
headerParameters["Authorization"] = "Bearer ".concat(tokenString);
|
|
4351
|
+
}
|
|
4352
|
+
_a.label = 2;
|
|
4353
|
+
case 2: return [4 /*yield*/, this.request({
|
|
4354
|
+
path: "/admin/newsletters/{newsletterId}/preview".replace("{".concat("newsletterId", "}"), encodeURIComponent(String(requestParameters['newsletterId']))),
|
|
4355
|
+
method: 'POST',
|
|
4356
|
+
headers: headerParameters,
|
|
4357
|
+
query: queryParameters,
|
|
4358
|
+
}, initOverrides)];
|
|
4359
|
+
case 3:
|
|
4360
|
+
response = _a.sent();
|
|
4361
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.NewsletterPreviewDtoFromJSON)(jsonValue); })];
|
|
4362
|
+
}
|
|
4363
|
+
});
|
|
4364
|
+
});
|
|
4365
|
+
};
|
|
4366
|
+
/**
|
|
4367
|
+
* The email as it would go to Mailchimp, with the merge tags replaced by placeholders, for the live preview.
|
|
4368
|
+
* Render a newsletter
|
|
4369
|
+
*/
|
|
4370
|
+
AdminApi.prototype.previewNewsletter = function (requestParameters, initOverrides) {
|
|
4371
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
4372
|
+
var response;
|
|
4373
|
+
return __generator(this, function (_a) {
|
|
4374
|
+
switch (_a.label) {
|
|
4375
|
+
case 0: return [4 /*yield*/, this.previewNewsletterRaw(requestParameters, initOverrides)];
|
|
4376
|
+
case 1:
|
|
4377
|
+
response = _a.sent();
|
|
4378
|
+
return [4 /*yield*/, response.value()];
|
|
4379
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
4380
|
+
}
|
|
4381
|
+
});
|
|
4382
|
+
});
|
|
4383
|
+
};
|
|
4060
4384
|
/**
|
|
4061
4385
|
* Tells what paying these invoices out together would do, without doing it: the bank account the transfer goes to, and the fee taken out of what the seller receives. Refuses what paying them would refuse.
|
|
4062
4386
|
* Preview a payout of seller invoices
|
|
@@ -4435,6 +4759,64 @@ var AdminApi = /** @class */ (function (_super) {
|
|
|
4435
4759
|
});
|
|
4436
4760
|
});
|
|
4437
4761
|
};
|
|
4762
|
+
/**
|
|
4763
|
+
* Sends the current render to one address through the normal mailer, subject prefixed with [Preview]. Not a Mailchimp send.
|
|
4764
|
+
* Mail a preview of the newsletter
|
|
4765
|
+
*/
|
|
4766
|
+
AdminApi.prototype.sendNewsletterTestRaw = function (requestParameters, initOverrides) {
|
|
4767
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
4768
|
+
var queryParameters, headerParameters, token, tokenString, response;
|
|
4769
|
+
return __generator(this, function (_a) {
|
|
4770
|
+
switch (_a.label) {
|
|
4771
|
+
case 0:
|
|
4772
|
+
if (requestParameters['newsletterId'] == null) {
|
|
4773
|
+
throw new runtime.RequiredError('newsletterId', 'Required parameter "newsletterId" was null or undefined when calling sendNewsletterTest().');
|
|
4774
|
+
}
|
|
4775
|
+
if (requestParameters['sendNewsletterPreviewInput'] == null) {
|
|
4776
|
+
throw new runtime.RequiredError('sendNewsletterPreviewInput', 'Required parameter "sendNewsletterPreviewInput" was null or undefined when calling sendNewsletterTest().');
|
|
4777
|
+
}
|
|
4778
|
+
queryParameters = {};
|
|
4779
|
+
headerParameters = {};
|
|
4780
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
4781
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
4782
|
+
token = this.configuration.accessToken;
|
|
4783
|
+
return [4 /*yield*/, token("bearer", [])];
|
|
4784
|
+
case 1:
|
|
4785
|
+
tokenString = _a.sent();
|
|
4786
|
+
if (tokenString) {
|
|
4787
|
+
headerParameters["Authorization"] = "Bearer ".concat(tokenString);
|
|
4788
|
+
}
|
|
4789
|
+
_a.label = 2;
|
|
4790
|
+
case 2: return [4 /*yield*/, this.request({
|
|
4791
|
+
path: "/admin/newsletters/{newsletterId}/send-test".replace("{".concat("newsletterId", "}"), encodeURIComponent(String(requestParameters['newsletterId']))),
|
|
4792
|
+
method: 'POST',
|
|
4793
|
+
headers: headerParameters,
|
|
4794
|
+
query: queryParameters,
|
|
4795
|
+
body: (0, index_1.SendNewsletterPreviewInputToJSON)(requestParameters['sendNewsletterPreviewInput']),
|
|
4796
|
+
}, initOverrides)];
|
|
4797
|
+
case 3:
|
|
4798
|
+
response = _a.sent();
|
|
4799
|
+
return [2 /*return*/, new runtime.VoidApiResponse(response)];
|
|
4800
|
+
}
|
|
4801
|
+
});
|
|
4802
|
+
});
|
|
4803
|
+
};
|
|
4804
|
+
/**
|
|
4805
|
+
* Sends the current render to one address through the normal mailer, subject prefixed with [Preview]. Not a Mailchimp send.
|
|
4806
|
+
* Mail a preview of the newsletter
|
|
4807
|
+
*/
|
|
4808
|
+
AdminApi.prototype.sendNewsletterTest = function (requestParameters, initOverrides) {
|
|
4809
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
4810
|
+
return __generator(this, function (_a) {
|
|
4811
|
+
switch (_a.label) {
|
|
4812
|
+
case 0: return [4 /*yield*/, this.sendNewsletterTestRaw(requestParameters, initOverrides)];
|
|
4813
|
+
case 1:
|
|
4814
|
+
_a.sent();
|
|
4815
|
+
return [2 /*return*/];
|
|
4816
|
+
}
|
|
4817
|
+
});
|
|
4818
|
+
});
|
|
4819
|
+
};
|
|
4438
4820
|
/**
|
|
4439
4821
|
* Picks the domain for the public showcase on the website. Idempotent: showcasing an already showcased domain keeps its original position in the showcase.
|
|
4440
4822
|
* Showcase domain
|
|
@@ -5108,6 +5490,66 @@ var AdminApi = /** @class */ (function (_super) {
|
|
|
5108
5490
|
});
|
|
5109
5491
|
});
|
|
5110
5492
|
};
|
|
5493
|
+
/**
|
|
5494
|
+
* Saves the given fields. Any edit puts a prepared issue back to draft until it is prepared again.
|
|
5495
|
+
* Update a newsletter
|
|
5496
|
+
*/
|
|
5497
|
+
AdminApi.prototype.updateNewsletterRaw = function (requestParameters, initOverrides) {
|
|
5498
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
5499
|
+
var queryParameters, headerParameters, token, tokenString, response;
|
|
5500
|
+
return __generator(this, function (_a) {
|
|
5501
|
+
switch (_a.label) {
|
|
5502
|
+
case 0:
|
|
5503
|
+
if (requestParameters['newsletterId'] == null) {
|
|
5504
|
+
throw new runtime.RequiredError('newsletterId', 'Required parameter "newsletterId" was null or undefined when calling updateNewsletter().');
|
|
5505
|
+
}
|
|
5506
|
+
if (requestParameters['updateNewsletterInput'] == null) {
|
|
5507
|
+
throw new runtime.RequiredError('updateNewsletterInput', 'Required parameter "updateNewsletterInput" was null or undefined when calling updateNewsletter().');
|
|
5508
|
+
}
|
|
5509
|
+
queryParameters = {};
|
|
5510
|
+
headerParameters = {};
|
|
5511
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
5512
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
5513
|
+
token = this.configuration.accessToken;
|
|
5514
|
+
return [4 /*yield*/, token("bearer", [])];
|
|
5515
|
+
case 1:
|
|
5516
|
+
tokenString = _a.sent();
|
|
5517
|
+
if (tokenString) {
|
|
5518
|
+
headerParameters["Authorization"] = "Bearer ".concat(tokenString);
|
|
5519
|
+
}
|
|
5520
|
+
_a.label = 2;
|
|
5521
|
+
case 2: return [4 /*yield*/, this.request({
|
|
5522
|
+
path: "/admin/newsletters/{newsletterId}".replace("{".concat("newsletterId", "}"), encodeURIComponent(String(requestParameters['newsletterId']))),
|
|
5523
|
+
method: 'PATCH',
|
|
5524
|
+
headers: headerParameters,
|
|
5525
|
+
query: queryParameters,
|
|
5526
|
+
body: (0, index_1.UpdateNewsletterInputToJSON)(requestParameters['updateNewsletterInput']),
|
|
5527
|
+
}, initOverrides)];
|
|
5528
|
+
case 3:
|
|
5529
|
+
response = _a.sent();
|
|
5530
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.NewsletterDtoFromJSON)(jsonValue); })];
|
|
5531
|
+
}
|
|
5532
|
+
});
|
|
5533
|
+
});
|
|
5534
|
+
};
|
|
5535
|
+
/**
|
|
5536
|
+
* Saves the given fields. Any edit puts a prepared issue back to draft until it is prepared again.
|
|
5537
|
+
* Update a newsletter
|
|
5538
|
+
*/
|
|
5539
|
+
AdminApi.prototype.updateNewsletter = function (requestParameters, initOverrides) {
|
|
5540
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
5541
|
+
var response;
|
|
5542
|
+
return __generator(this, function (_a) {
|
|
5543
|
+
switch (_a.label) {
|
|
5544
|
+
case 0: return [4 /*yield*/, this.updateNewsletterRaw(requestParameters, initOverrides)];
|
|
5545
|
+
case 1:
|
|
5546
|
+
response = _a.sent();
|
|
5547
|
+
return [4 /*yield*/, response.value()];
|
|
5548
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
5549
|
+
}
|
|
5550
|
+
});
|
|
5551
|
+
});
|
|
5552
|
+
};
|
|
5111
5553
|
/**
|
|
5112
5554
|
* Updates the buyer information stored on the subscription. The change is applied from the next renewal onwards: the already issued invoices, including the active one, are left untouched. Note that the emails related to the current invoice are still sent to the email of that invoice.
|
|
5113
5555
|
* Update subscription buyer information
|
|
@@ -5166,6 +5608,64 @@ var AdminApi = /** @class */ (function (_super) {
|
|
|
5166
5608
|
});
|
|
5167
5609
|
});
|
|
5168
5610
|
};
|
|
5611
|
+
/**
|
|
5612
|
+
* Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows on the next sync.
|
|
5613
|
+
* Update the seller newsletter consent of a user
|
|
5614
|
+
*/
|
|
5615
|
+
AdminApi.prototype.updateUserNewsletterStatusRaw = function (requestParameters, initOverrides) {
|
|
5616
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
5617
|
+
var queryParameters, headerParameters, token, tokenString, response;
|
|
5618
|
+
return __generator(this, function (_a) {
|
|
5619
|
+
switch (_a.label) {
|
|
5620
|
+
case 0:
|
|
5621
|
+
if (requestParameters['userId'] == null) {
|
|
5622
|
+
throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling updateUserNewsletterStatus().');
|
|
5623
|
+
}
|
|
5624
|
+
if (requestParameters['adminUserNewsletterInput'] == null) {
|
|
5625
|
+
throw new runtime.RequiredError('adminUserNewsletterInput', 'Required parameter "adminUserNewsletterInput" was null or undefined when calling updateUserNewsletterStatus().');
|
|
5626
|
+
}
|
|
5627
|
+
queryParameters = {};
|
|
5628
|
+
headerParameters = {};
|
|
5629
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
5630
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
5631
|
+
token = this.configuration.accessToken;
|
|
5632
|
+
return [4 /*yield*/, token("bearer", [])];
|
|
5633
|
+
case 1:
|
|
5634
|
+
tokenString = _a.sent();
|
|
5635
|
+
if (tokenString) {
|
|
5636
|
+
headerParameters["Authorization"] = "Bearer ".concat(tokenString);
|
|
5637
|
+
}
|
|
5638
|
+
_a.label = 2;
|
|
5639
|
+
case 2: return [4 /*yield*/, this.request({
|
|
5640
|
+
path: "/admin/users/{userId}/newsletter".replace("{".concat("userId", "}"), encodeURIComponent(String(requestParameters['userId']))),
|
|
5641
|
+
method: 'PATCH',
|
|
5642
|
+
headers: headerParameters,
|
|
5643
|
+
query: queryParameters,
|
|
5644
|
+
body: (0, index_1.AdminUserNewsletterInputToJSON)(requestParameters['adminUserNewsletterInput']),
|
|
5645
|
+
}, initOverrides)];
|
|
5646
|
+
case 3:
|
|
5647
|
+
response = _a.sent();
|
|
5648
|
+
return [2 /*return*/, new runtime.VoidApiResponse(response)];
|
|
5649
|
+
}
|
|
5650
|
+
});
|
|
5651
|
+
});
|
|
5652
|
+
};
|
|
5653
|
+
/**
|
|
5654
|
+
* Sets whether the user gets the seller newsletter, recorded as changed by the admin. The Mailchimp audience follows on the next sync.
|
|
5655
|
+
* Update the seller newsletter consent of a user
|
|
5656
|
+
*/
|
|
5657
|
+
AdminApi.prototype.updateUserNewsletterStatus = function (requestParameters, initOverrides) {
|
|
5658
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
5659
|
+
return __generator(this, function (_a) {
|
|
5660
|
+
switch (_a.label) {
|
|
5661
|
+
case 0: return [4 /*yield*/, this.updateUserNewsletterStatusRaw(requestParameters, initOverrides)];
|
|
5662
|
+
case 1:
|
|
5663
|
+
_a.sent();
|
|
5664
|
+
return [2 /*return*/];
|
|
5665
|
+
}
|
|
5666
|
+
});
|
|
5667
|
+
});
|
|
5668
|
+
};
|
|
5169
5669
|
/**
|
|
5170
5670
|
* Marks the account alias as verified, so it is shown on the landing pages instead of the official name. Also lifts a previous rejection.
|
|
5171
5671
|
* Verify account alias
|
|
@@ -0,0 +1,41 @@
|
|
|
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 AdminUserNewsletterInput
|
|
16
|
+
*/
|
|
17
|
+
export interface AdminUserNewsletterInput {
|
|
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.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof AdminUserNewsletterInput
|
|
22
|
+
*/
|
|
23
|
+
newsletterStatus: AdminUserNewsletterInputNewsletterStatusEnum;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* @export
|
|
27
|
+
*/
|
|
28
|
+
export declare const AdminUserNewsletterInputNewsletterStatusEnum: {
|
|
29
|
+
readonly SUBSCRIBED: "subscribed";
|
|
30
|
+
readonly UNSUBSCRIBED: "unsubscribed";
|
|
31
|
+
readonly NEVER_ASKED: "never_asked";
|
|
32
|
+
};
|
|
33
|
+
export type AdminUserNewsletterInputNewsletterStatusEnum = typeof AdminUserNewsletterInputNewsletterStatusEnum[keyof typeof AdminUserNewsletterInputNewsletterStatusEnum];
|
|
34
|
+
/**
|
|
35
|
+
* Check if a given object implements the AdminUserNewsletterInput interface.
|
|
36
|
+
*/
|
|
37
|
+
export declare function instanceOfAdminUserNewsletterInput(value: object): value is AdminUserNewsletterInput;
|
|
38
|
+
export declare function AdminUserNewsletterInputFromJSON(json: any): AdminUserNewsletterInput;
|
|
39
|
+
export declare function AdminUserNewsletterInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminUserNewsletterInput;
|
|
40
|
+
export declare function AdminUserNewsletterInputToJSON(json: any): AdminUserNewsletterInput;
|
|
41
|
+
export declare function AdminUserNewsletterInputToJSONTyped(value?: AdminUserNewsletterInput | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,60 @@
|
|
|
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.AdminUserNewsletterInputNewsletterStatusEnum = void 0;
|
|
17
|
+
exports.instanceOfAdminUserNewsletterInput = instanceOfAdminUserNewsletterInput;
|
|
18
|
+
exports.AdminUserNewsletterInputFromJSON = AdminUserNewsletterInputFromJSON;
|
|
19
|
+
exports.AdminUserNewsletterInputFromJSONTyped = AdminUserNewsletterInputFromJSONTyped;
|
|
20
|
+
exports.AdminUserNewsletterInputToJSON = AdminUserNewsletterInputToJSON;
|
|
21
|
+
exports.AdminUserNewsletterInputToJSONTyped = AdminUserNewsletterInputToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.AdminUserNewsletterInputNewsletterStatusEnum = {
|
|
26
|
+
SUBSCRIBED: 'subscribed',
|
|
27
|
+
UNSUBSCRIBED: 'unsubscribed',
|
|
28
|
+
NEVER_ASKED: 'never_asked'
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Check if a given object implements the AdminUserNewsletterInput interface.
|
|
32
|
+
*/
|
|
33
|
+
function instanceOfAdminUserNewsletterInput(value) {
|
|
34
|
+
if (!('newsletterStatus' in value) || value['newsletterStatus'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
return true;
|
|
37
|
+
}
|
|
38
|
+
function AdminUserNewsletterInputFromJSON(json) {
|
|
39
|
+
return AdminUserNewsletterInputFromJSONTyped(json, false);
|
|
40
|
+
}
|
|
41
|
+
function AdminUserNewsletterInputFromJSONTyped(json, ignoreDiscriminator) {
|
|
42
|
+
if (json == null) {
|
|
43
|
+
return json;
|
|
44
|
+
}
|
|
45
|
+
return {
|
|
46
|
+
'newsletterStatus': json['newsletterStatus'],
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
function AdminUserNewsletterInputToJSON(json) {
|
|
50
|
+
return AdminUserNewsletterInputToJSONTyped(json, false);
|
|
51
|
+
}
|
|
52
|
+
function AdminUserNewsletterInputToJSONTyped(value, ignoreDiscriminator) {
|
|
53
|
+
if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
|
|
54
|
+
if (value == null) {
|
|
55
|
+
return value;
|
|
56
|
+
}
|
|
57
|
+
return {
|
|
58
|
+
'newsletterStatus': value['newsletterStatus'],
|
|
59
|
+
};
|
|
60
|
+
}
|