@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
|
@@ -0,0 +1,171 @@
|
|
|
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
|
+
import type { NewsletterSecondaryStoryInput } from './NewsletterSecondaryStoryInput';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface CreateNewsletterInput
|
|
17
|
+
*/
|
|
18
|
+
export interface CreateNewsletterInput {
|
|
19
|
+
/**
|
|
20
|
+
* Subject line.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof CreateNewsletterInput
|
|
23
|
+
*/
|
|
24
|
+
subject?: string;
|
|
25
|
+
/**
|
|
26
|
+
* Preheader, 40 to 90 characters.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof CreateNewsletterInput
|
|
29
|
+
*/
|
|
30
|
+
preheader?: string;
|
|
31
|
+
/**
|
|
32
|
+
* Issue label in the header; may carry HTML entities.
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof CreateNewsletterInput
|
|
35
|
+
*/
|
|
36
|
+
issueLabel?: string;
|
|
37
|
+
/**
|
|
38
|
+
* utm_campaign on every link, e.g. nl-2026-10.
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof CreateNewsletterInput
|
|
41
|
+
*/
|
|
42
|
+
campaignSlug?: string;
|
|
43
|
+
/**
|
|
44
|
+
* Lead story UUID.
|
|
45
|
+
* @type {string}
|
|
46
|
+
* @memberof CreateNewsletterInput
|
|
47
|
+
*/
|
|
48
|
+
leadStoryUuid?: string | null;
|
|
49
|
+
/**
|
|
50
|
+
* Lead teaser, 30 to 60 words.
|
|
51
|
+
* @type {string}
|
|
52
|
+
* @memberof CreateNewsletterInput
|
|
53
|
+
*/
|
|
54
|
+
leadTeaser?: string;
|
|
55
|
+
/**
|
|
56
|
+
* Lead button text, 2 to 5 words.
|
|
57
|
+
* @type {string}
|
|
58
|
+
* @memberof CreateNewsletterInput
|
|
59
|
+
*/
|
|
60
|
+
leadCta?: string;
|
|
61
|
+
/**
|
|
62
|
+
* Secondary stories, in order.
|
|
63
|
+
* @type {Array<NewsletterSecondaryStoryInput>}
|
|
64
|
+
* @memberof CreateNewsletterInput
|
|
65
|
+
*/
|
|
66
|
+
secondaryStories?: Array<NewsletterSecondaryStoryInput>;
|
|
67
|
+
/**
|
|
68
|
+
* Feature story UUID.
|
|
69
|
+
* @type {string}
|
|
70
|
+
* @memberof CreateNewsletterInput
|
|
71
|
+
*/
|
|
72
|
+
featureStoryUuid?: string | null;
|
|
73
|
+
/**
|
|
74
|
+
* Feature text, 1 to 2 sentences.
|
|
75
|
+
* @type {string}
|
|
76
|
+
* @memberof CreateNewsletterInput
|
|
77
|
+
*/
|
|
78
|
+
featureText?: string;
|
|
79
|
+
/**
|
|
80
|
+
* Feature link text.
|
|
81
|
+
* @type {string}
|
|
82
|
+
* @memberof CreateNewsletterInput
|
|
83
|
+
*/
|
|
84
|
+
featureLink?: string;
|
|
85
|
+
/**
|
|
86
|
+
* Event lead line.
|
|
87
|
+
* @type {string}
|
|
88
|
+
* @memberof CreateNewsletterInput
|
|
89
|
+
*/
|
|
90
|
+
eventLead?: string | null;
|
|
91
|
+
/**
|
|
92
|
+
* Event text.
|
|
93
|
+
* @type {string}
|
|
94
|
+
* @memberof CreateNewsletterInput
|
|
95
|
+
*/
|
|
96
|
+
eventText?: string | null;
|
|
97
|
+
/**
|
|
98
|
+
* Event link URL.
|
|
99
|
+
* @type {string}
|
|
100
|
+
* @memberof CreateNewsletterInput
|
|
101
|
+
*/
|
|
102
|
+
eventUrl?: string | null;
|
|
103
|
+
/**
|
|
104
|
+
* Event link text.
|
|
105
|
+
* @type {string}
|
|
106
|
+
* @memberof CreateNewsletterInput
|
|
107
|
+
*/
|
|
108
|
+
eventLink?: string | null;
|
|
109
|
+
/**
|
|
110
|
+
* Whether the recent-sales module is in the issue.
|
|
111
|
+
* @type {boolean}
|
|
112
|
+
* @memberof CreateNewsletterInput
|
|
113
|
+
*/
|
|
114
|
+
salesEnabled?: boolean;
|
|
115
|
+
/**
|
|
116
|
+
* First day of the sales period (YYYY-MM-DD).
|
|
117
|
+
* @type {string}
|
|
118
|
+
* @memberof CreateNewsletterInput
|
|
119
|
+
*/
|
|
120
|
+
salesFrom?: string | null;
|
|
121
|
+
/**
|
|
122
|
+
* Last day of the sales period (YYYY-MM-DD).
|
|
123
|
+
* @type {string}
|
|
124
|
+
* @memberof CreateNewsletterInput
|
|
125
|
+
*/
|
|
126
|
+
salesTo?: string | null;
|
|
127
|
+
/**
|
|
128
|
+
* Closing band line.
|
|
129
|
+
* @type {string}
|
|
130
|
+
* @memberof CreateNewsletterInput
|
|
131
|
+
*/
|
|
132
|
+
closingLine?: string;
|
|
133
|
+
/**
|
|
134
|
+
* Closing button text.
|
|
135
|
+
* @type {string}
|
|
136
|
+
* @memberof CreateNewsletterInput
|
|
137
|
+
*/
|
|
138
|
+
closingCta?: string;
|
|
139
|
+
/**
|
|
140
|
+
* Closing button URL.
|
|
141
|
+
* @type {string}
|
|
142
|
+
* @memberof CreateNewsletterInput
|
|
143
|
+
*/
|
|
144
|
+
closingUrl?: string;
|
|
145
|
+
/**
|
|
146
|
+
* Closing note under the button.
|
|
147
|
+
* @type {string}
|
|
148
|
+
* @memberof CreateNewsletterInput
|
|
149
|
+
*/
|
|
150
|
+
closingNote?: string;
|
|
151
|
+
/**
|
|
152
|
+
* Why the reader receives the email.
|
|
153
|
+
* @type {string}
|
|
154
|
+
* @memberof CreateNewsletterInput
|
|
155
|
+
*/
|
|
156
|
+
footerReason?: string;
|
|
157
|
+
/**
|
|
158
|
+
* Internal title, also the Mailchimp campaign name.
|
|
159
|
+
* @type {string}
|
|
160
|
+
* @memberof CreateNewsletterInput
|
|
161
|
+
*/
|
|
162
|
+
title: string;
|
|
163
|
+
}
|
|
164
|
+
/**
|
|
165
|
+
* Check if a given object implements the CreateNewsletterInput interface.
|
|
166
|
+
*/
|
|
167
|
+
export declare function instanceOfCreateNewsletterInput(value: object): value is CreateNewsletterInput;
|
|
168
|
+
export declare function CreateNewsletterInputFromJSON(json: any): CreateNewsletterInput;
|
|
169
|
+
export declare function CreateNewsletterInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateNewsletterInput;
|
|
170
|
+
export declare function CreateNewsletterInputToJSON(json: any): CreateNewsletterInput;
|
|
171
|
+
export declare function CreateNewsletterInputToJSONTyped(value?: CreateNewsletterInput | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,98 @@
|
|
|
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.instanceOfCreateNewsletterInput = instanceOfCreateNewsletterInput;
|
|
17
|
+
exports.CreateNewsletterInputFromJSON = CreateNewsletterInputFromJSON;
|
|
18
|
+
exports.CreateNewsletterInputFromJSONTyped = CreateNewsletterInputFromJSONTyped;
|
|
19
|
+
exports.CreateNewsletterInputToJSON = CreateNewsletterInputToJSON;
|
|
20
|
+
exports.CreateNewsletterInputToJSONTyped = CreateNewsletterInputToJSONTyped;
|
|
21
|
+
var NewsletterSecondaryStoryInput_1 = require("./NewsletterSecondaryStoryInput");
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the CreateNewsletterInput interface.
|
|
24
|
+
*/
|
|
25
|
+
function instanceOfCreateNewsletterInput(value) {
|
|
26
|
+
if (!('title' in value) || value['title'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
return true;
|
|
29
|
+
}
|
|
30
|
+
function CreateNewsletterInputFromJSON(json) {
|
|
31
|
+
return CreateNewsletterInputFromJSONTyped(json, false);
|
|
32
|
+
}
|
|
33
|
+
function CreateNewsletterInputFromJSONTyped(json, ignoreDiscriminator) {
|
|
34
|
+
if (json == null) {
|
|
35
|
+
return json;
|
|
36
|
+
}
|
|
37
|
+
return {
|
|
38
|
+
'subject': json['subject'] == null ? undefined : json['subject'],
|
|
39
|
+
'preheader': json['preheader'] == null ? undefined : json['preheader'],
|
|
40
|
+
'issueLabel': json['issueLabel'] == null ? undefined : json['issueLabel'],
|
|
41
|
+
'campaignSlug': json['campaignSlug'] == null ? undefined : json['campaignSlug'],
|
|
42
|
+
'leadStoryUuid': json['leadStoryUuid'] == null ? undefined : json['leadStoryUuid'],
|
|
43
|
+
'leadTeaser': json['leadTeaser'] == null ? undefined : json['leadTeaser'],
|
|
44
|
+
'leadCta': json['leadCta'] == null ? undefined : json['leadCta'],
|
|
45
|
+
'secondaryStories': json['secondaryStories'] == null ? undefined : (json['secondaryStories'].map(NewsletterSecondaryStoryInput_1.NewsletterSecondaryStoryInputFromJSON)),
|
|
46
|
+
'featureStoryUuid': json['featureStoryUuid'] == null ? undefined : json['featureStoryUuid'],
|
|
47
|
+
'featureText': json['featureText'] == null ? undefined : json['featureText'],
|
|
48
|
+
'featureLink': json['featureLink'] == null ? undefined : json['featureLink'],
|
|
49
|
+
'eventLead': json['eventLead'] == null ? undefined : json['eventLead'],
|
|
50
|
+
'eventText': json['eventText'] == null ? undefined : json['eventText'],
|
|
51
|
+
'eventUrl': json['eventUrl'] == null ? undefined : json['eventUrl'],
|
|
52
|
+
'eventLink': json['eventLink'] == null ? undefined : json['eventLink'],
|
|
53
|
+
'salesEnabled': json['salesEnabled'] == null ? undefined : json['salesEnabled'],
|
|
54
|
+
'salesFrom': json['salesFrom'] == null ? undefined : json['salesFrom'],
|
|
55
|
+
'salesTo': json['salesTo'] == null ? undefined : json['salesTo'],
|
|
56
|
+
'closingLine': json['closingLine'] == null ? undefined : json['closingLine'],
|
|
57
|
+
'closingCta': json['closingCta'] == null ? undefined : json['closingCta'],
|
|
58
|
+
'closingUrl': json['closingUrl'] == null ? undefined : json['closingUrl'],
|
|
59
|
+
'closingNote': json['closingNote'] == null ? undefined : json['closingNote'],
|
|
60
|
+
'footerReason': json['footerReason'] == null ? undefined : json['footerReason'],
|
|
61
|
+
'title': json['title'],
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
function CreateNewsletterInputToJSON(json) {
|
|
65
|
+
return CreateNewsletterInputToJSONTyped(json, false);
|
|
66
|
+
}
|
|
67
|
+
function CreateNewsletterInputToJSONTyped(value, ignoreDiscriminator) {
|
|
68
|
+
if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
|
|
69
|
+
if (value == null) {
|
|
70
|
+
return value;
|
|
71
|
+
}
|
|
72
|
+
return {
|
|
73
|
+
'subject': value['subject'],
|
|
74
|
+
'preheader': value['preheader'],
|
|
75
|
+
'issueLabel': value['issueLabel'],
|
|
76
|
+
'campaignSlug': value['campaignSlug'],
|
|
77
|
+
'leadStoryUuid': value['leadStoryUuid'],
|
|
78
|
+
'leadTeaser': value['leadTeaser'],
|
|
79
|
+
'leadCta': value['leadCta'],
|
|
80
|
+
'secondaryStories': value['secondaryStories'] == null ? undefined : (value['secondaryStories'].map(NewsletterSecondaryStoryInput_1.NewsletterSecondaryStoryInputToJSON)),
|
|
81
|
+
'featureStoryUuid': value['featureStoryUuid'],
|
|
82
|
+
'featureText': value['featureText'],
|
|
83
|
+
'featureLink': value['featureLink'],
|
|
84
|
+
'eventLead': value['eventLead'],
|
|
85
|
+
'eventText': value['eventText'],
|
|
86
|
+
'eventUrl': value['eventUrl'],
|
|
87
|
+
'eventLink': value['eventLink'],
|
|
88
|
+
'salesEnabled': value['salesEnabled'],
|
|
89
|
+
'salesFrom': value['salesFrom'],
|
|
90
|
+
'salesTo': value['salesTo'],
|
|
91
|
+
'closingLine': value['closingLine'],
|
|
92
|
+
'closingCta': value['closingCta'],
|
|
93
|
+
'closingUrl': value['closingUrl'],
|
|
94
|
+
'closingNote': value['closingNote'],
|
|
95
|
+
'footerReason': value['footerReason'],
|
|
96
|
+
'title': value['title'],
|
|
97
|
+
};
|
|
98
|
+
}
|
|
@@ -0,0 +1,80 @@
|
|
|
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 NewsStoryDto
|
|
16
|
+
*/
|
|
17
|
+
export interface NewsStoryDto {
|
|
18
|
+
/**
|
|
19
|
+
* Storyblok story UUID.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof NewsStoryDto
|
|
22
|
+
*/
|
|
23
|
+
uuid: string;
|
|
24
|
+
/**
|
|
25
|
+
* Headline of the post.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof NewsStoryDto
|
|
28
|
+
*/
|
|
29
|
+
title: string;
|
|
30
|
+
/**
|
|
31
|
+
* Public URL of the post.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof NewsStoryDto
|
|
34
|
+
*/
|
|
35
|
+
url: string;
|
|
36
|
+
/**
|
|
37
|
+
* Category key, e.g. articles.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof NewsStoryDto
|
|
40
|
+
*/
|
|
41
|
+
category: string;
|
|
42
|
+
/**
|
|
43
|
+
* Category as the email shows it, e.g. Article.
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof NewsStoryDto
|
|
46
|
+
*/
|
|
47
|
+
categoryLabel: string;
|
|
48
|
+
/**
|
|
49
|
+
* Publication date (YYYY-MM-DD).
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof NewsStoryDto
|
|
52
|
+
*/
|
|
53
|
+
date: string;
|
|
54
|
+
/**
|
|
55
|
+
* Intro paragraph of the post.
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof NewsStoryDto
|
|
58
|
+
*/
|
|
59
|
+
intro: string;
|
|
60
|
+
/**
|
|
61
|
+
* Hero image on the image CDN, without crop parameters.
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof NewsStoryDto
|
|
64
|
+
*/
|
|
65
|
+
heroImageUrl: string | null;
|
|
66
|
+
/**
|
|
67
|
+
* Alt text of the hero image.
|
|
68
|
+
* @type {string}
|
|
69
|
+
* @memberof NewsStoryDto
|
|
70
|
+
*/
|
|
71
|
+
heroImageAlt: string;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Check if a given object implements the NewsStoryDto interface.
|
|
75
|
+
*/
|
|
76
|
+
export declare function instanceOfNewsStoryDto(value: object): value is NewsStoryDto;
|
|
77
|
+
export declare function NewsStoryDtoFromJSON(json: any): NewsStoryDto;
|
|
78
|
+
export declare function NewsStoryDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): NewsStoryDto;
|
|
79
|
+
export declare function NewsStoryDtoToJSON(json: any): NewsStoryDto;
|
|
80
|
+
export declare function NewsStoryDtoToJSONTyped(value?: NewsStoryDto | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,83 @@
|
|
|
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.instanceOfNewsStoryDto = instanceOfNewsStoryDto;
|
|
17
|
+
exports.NewsStoryDtoFromJSON = NewsStoryDtoFromJSON;
|
|
18
|
+
exports.NewsStoryDtoFromJSONTyped = NewsStoryDtoFromJSONTyped;
|
|
19
|
+
exports.NewsStoryDtoToJSON = NewsStoryDtoToJSON;
|
|
20
|
+
exports.NewsStoryDtoToJSONTyped = NewsStoryDtoToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the NewsStoryDto interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfNewsStoryDto(value) {
|
|
25
|
+
if (!('uuid' in value) || value['uuid'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('title' in value) || value['title'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('url' in value) || value['url'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('category' in value) || value['category'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('categoryLabel' in value) || value['categoryLabel'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
if (!('date' in value) || value['date'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('intro' in value) || value['intro'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('heroImageUrl' in value) || value['heroImageUrl'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('heroImageAlt' in value) || value['heroImageAlt'] === undefined)
|
|
42
|
+
return false;
|
|
43
|
+
return true;
|
|
44
|
+
}
|
|
45
|
+
function NewsStoryDtoFromJSON(json) {
|
|
46
|
+
return NewsStoryDtoFromJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
function NewsStoryDtoFromJSONTyped(json, ignoreDiscriminator) {
|
|
49
|
+
if (json == null) {
|
|
50
|
+
return json;
|
|
51
|
+
}
|
|
52
|
+
return {
|
|
53
|
+
'uuid': json['uuid'],
|
|
54
|
+
'title': json['title'],
|
|
55
|
+
'url': json['url'],
|
|
56
|
+
'category': json['category'],
|
|
57
|
+
'categoryLabel': json['categoryLabel'],
|
|
58
|
+
'date': json['date'],
|
|
59
|
+
'intro': json['intro'],
|
|
60
|
+
'heroImageUrl': json['heroImageUrl'],
|
|
61
|
+
'heroImageAlt': json['heroImageAlt'],
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
function NewsStoryDtoToJSON(json) {
|
|
65
|
+
return NewsStoryDtoToJSONTyped(json, false);
|
|
66
|
+
}
|
|
67
|
+
function NewsStoryDtoToJSONTyped(value, ignoreDiscriminator) {
|
|
68
|
+
if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
|
|
69
|
+
if (value == null) {
|
|
70
|
+
return value;
|
|
71
|
+
}
|
|
72
|
+
return {
|
|
73
|
+
'uuid': value['uuid'],
|
|
74
|
+
'title': value['title'],
|
|
75
|
+
'url': value['url'],
|
|
76
|
+
'category': value['category'],
|
|
77
|
+
'categoryLabel': value['categoryLabel'],
|
|
78
|
+
'date': value['date'],
|
|
79
|
+
'intro': value['intro'],
|
|
80
|
+
'heroImageUrl': value['heroImageUrl'],
|
|
81
|
+
'heroImageAlt': value['heroImageAlt'],
|
|
82
|
+
};
|
|
83
|
+
}
|
|
@@ -0,0 +1,251 @@
|
|
|
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
|
+
import type { NewsletterSecondaryStoryDto } from './NewsletterSecondaryStoryDto';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface NewsletterDto
|
|
17
|
+
*/
|
|
18
|
+
export interface NewsletterDto {
|
|
19
|
+
/**
|
|
20
|
+
* Newsletter ID.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof NewsletterDto
|
|
23
|
+
*/
|
|
24
|
+
id: string;
|
|
25
|
+
/**
|
|
26
|
+
* Internal title, also the Mailchimp campaign name.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof NewsletterDto
|
|
29
|
+
*/
|
|
30
|
+
title: string;
|
|
31
|
+
/**
|
|
32
|
+
* Subject line.
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof NewsletterDto
|
|
35
|
+
*/
|
|
36
|
+
subject: string;
|
|
37
|
+
/**
|
|
38
|
+
* Preheader, 40 to 90 characters.
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof NewsletterDto
|
|
41
|
+
*/
|
|
42
|
+
preheader: string;
|
|
43
|
+
/**
|
|
44
|
+
* Issue label in the header; may carry HTML entities.
|
|
45
|
+
* @type {string}
|
|
46
|
+
* @memberof NewsletterDto
|
|
47
|
+
*/
|
|
48
|
+
issueLabel: string;
|
|
49
|
+
/**
|
|
50
|
+
* utm_campaign on every link, e.g. nl-2026-10.
|
|
51
|
+
* @type {string}
|
|
52
|
+
* @memberof NewsletterDto
|
|
53
|
+
*/
|
|
54
|
+
campaignSlug: string;
|
|
55
|
+
/**
|
|
56
|
+
* draft, or prepared in Mailchimp.
|
|
57
|
+
* @type {string}
|
|
58
|
+
* @memberof NewsletterDto
|
|
59
|
+
*/
|
|
60
|
+
status: NewsletterDtoStatusEnum;
|
|
61
|
+
/**
|
|
62
|
+
* Lead story UUID.
|
|
63
|
+
* @type {string}
|
|
64
|
+
* @memberof NewsletterDto
|
|
65
|
+
*/
|
|
66
|
+
leadStoryUuid: string | null;
|
|
67
|
+
/**
|
|
68
|
+
* Lead teaser, 30 to 60 words.
|
|
69
|
+
* @type {string}
|
|
70
|
+
* @memberof NewsletterDto
|
|
71
|
+
*/
|
|
72
|
+
leadTeaser: string;
|
|
73
|
+
/**
|
|
74
|
+
* Lead button text, 2 to 5 words.
|
|
75
|
+
* @type {string}
|
|
76
|
+
* @memberof NewsletterDto
|
|
77
|
+
*/
|
|
78
|
+
leadCta: string;
|
|
79
|
+
/**
|
|
80
|
+
* Secondary stories, in order.
|
|
81
|
+
* @type {Array<NewsletterSecondaryStoryDto>}
|
|
82
|
+
* @memberof NewsletterDto
|
|
83
|
+
*/
|
|
84
|
+
secondaryStories: Array<NewsletterSecondaryStoryDto>;
|
|
85
|
+
/**
|
|
86
|
+
* Feature story UUID.
|
|
87
|
+
* @type {string}
|
|
88
|
+
* @memberof NewsletterDto
|
|
89
|
+
*/
|
|
90
|
+
featureStoryUuid: string | null;
|
|
91
|
+
/**
|
|
92
|
+
* Feature text, 1 to 2 sentences.
|
|
93
|
+
* @type {string}
|
|
94
|
+
* @memberof NewsletterDto
|
|
95
|
+
*/
|
|
96
|
+
featureText: string;
|
|
97
|
+
/**
|
|
98
|
+
* Feature link text.
|
|
99
|
+
* @type {string}
|
|
100
|
+
* @memberof NewsletterDto
|
|
101
|
+
*/
|
|
102
|
+
featureLink: string;
|
|
103
|
+
/**
|
|
104
|
+
* Event lead, e.g. "NamesCon Global, Miami, 11–12 November."
|
|
105
|
+
* @type {string}
|
|
106
|
+
* @memberof NewsletterDto
|
|
107
|
+
*/
|
|
108
|
+
eventLead: string | null;
|
|
109
|
+
/**
|
|
110
|
+
* Event text, e.g. "We are at booth 214."
|
|
111
|
+
* @type {string}
|
|
112
|
+
* @memberof NewsletterDto
|
|
113
|
+
*/
|
|
114
|
+
eventText: string | null;
|
|
115
|
+
/**
|
|
116
|
+
* Event link URL.
|
|
117
|
+
* @type {string}
|
|
118
|
+
* @memberof NewsletterDto
|
|
119
|
+
*/
|
|
120
|
+
eventUrl: string | null;
|
|
121
|
+
/**
|
|
122
|
+
* Event link text.
|
|
123
|
+
* @type {string}
|
|
124
|
+
* @memberof NewsletterDto
|
|
125
|
+
*/
|
|
126
|
+
eventLink: string | null;
|
|
127
|
+
/**
|
|
128
|
+
* Whether the recent-sales module is in the issue.
|
|
129
|
+
* @type {boolean}
|
|
130
|
+
* @memberof NewsletterDto
|
|
131
|
+
*/
|
|
132
|
+
salesEnabled: boolean;
|
|
133
|
+
/**
|
|
134
|
+
* First day of the sales period (YYYY-MM-DD).
|
|
135
|
+
* @type {string}
|
|
136
|
+
* @memberof NewsletterDto
|
|
137
|
+
*/
|
|
138
|
+
salesFrom: string | null;
|
|
139
|
+
/**
|
|
140
|
+
* Last day of the sales period (YYYY-MM-DD).
|
|
141
|
+
* @type {string}
|
|
142
|
+
* @memberof NewsletterDto
|
|
143
|
+
*/
|
|
144
|
+
salesTo: string | null;
|
|
145
|
+
/**
|
|
146
|
+
* First day of the period the sales module uses when salesFrom is empty: 14 days ago (YYYY-MM-DD).
|
|
147
|
+
* @type {string}
|
|
148
|
+
* @memberof NewsletterDto
|
|
149
|
+
*/
|
|
150
|
+
defaultSalesFrom: string;
|
|
151
|
+
/**
|
|
152
|
+
* Last day of the period the sales module uses when salesTo is empty: today (YYYY-MM-DD).
|
|
153
|
+
* @type {string}
|
|
154
|
+
* @memberof NewsletterDto
|
|
155
|
+
*/
|
|
156
|
+
defaultSalesTo: string;
|
|
157
|
+
/**
|
|
158
|
+
* Closing band line as typed by the editor; empty means the computed line is used.
|
|
159
|
+
* @type {string}
|
|
160
|
+
* @memberof NewsletterDto
|
|
161
|
+
*/
|
|
162
|
+
closingLine: string;
|
|
163
|
+
/**
|
|
164
|
+
* The closing line the email gets when closingLine is empty: "Over N domains are being offered on our platform." from the live listing count. Null in the list.
|
|
165
|
+
* @type {string}
|
|
166
|
+
* @memberof NewsletterDto
|
|
167
|
+
*/
|
|
168
|
+
defaultClosingLine: string | null;
|
|
169
|
+
/**
|
|
170
|
+
* Closing button text.
|
|
171
|
+
* @type {string}
|
|
172
|
+
* @memberof NewsletterDto
|
|
173
|
+
*/
|
|
174
|
+
closingCta: string;
|
|
175
|
+
/**
|
|
176
|
+
* Closing button URL.
|
|
177
|
+
* @type {string}
|
|
178
|
+
* @memberof NewsletterDto
|
|
179
|
+
*/
|
|
180
|
+
closingUrl: string;
|
|
181
|
+
/**
|
|
182
|
+
* Closing note under the button.
|
|
183
|
+
* @type {string}
|
|
184
|
+
* @memberof NewsletterDto
|
|
185
|
+
*/
|
|
186
|
+
closingNote: string;
|
|
187
|
+
/**
|
|
188
|
+
* Why the reader receives the email.
|
|
189
|
+
* @type {string}
|
|
190
|
+
* @memberof NewsletterDto
|
|
191
|
+
*/
|
|
192
|
+
footerReason: string;
|
|
193
|
+
/**
|
|
194
|
+
* Mailchimp campaign ID once prepared.
|
|
195
|
+
* @type {string}
|
|
196
|
+
* @memberof NewsletterDto
|
|
197
|
+
*/
|
|
198
|
+
mailchimpCampaignId: string | null;
|
|
199
|
+
/**
|
|
200
|
+
* Mailchimp web ID once prepared.
|
|
201
|
+
* @type {string}
|
|
202
|
+
* @memberof NewsletterDto
|
|
203
|
+
*/
|
|
204
|
+
mailchimpWebId: string | null;
|
|
205
|
+
/**
|
|
206
|
+
* Where to open the draft in Mailchimp.
|
|
207
|
+
* @type {string}
|
|
208
|
+
* @memberof NewsletterDto
|
|
209
|
+
*/
|
|
210
|
+
mailchimpCampaignUrl: string | null;
|
|
211
|
+
/**
|
|
212
|
+
* Last prepare in Mailchimp.
|
|
213
|
+
* @type {Date}
|
|
214
|
+
* @memberof NewsletterDto
|
|
215
|
+
*/
|
|
216
|
+
preparedAt: Date | null;
|
|
217
|
+
/**
|
|
218
|
+
* Name of the admin who started the issue.
|
|
219
|
+
* @type {string}
|
|
220
|
+
* @memberof NewsletterDto
|
|
221
|
+
*/
|
|
222
|
+
createdByName: string;
|
|
223
|
+
/**
|
|
224
|
+
*
|
|
225
|
+
* @type {Date}
|
|
226
|
+
* @memberof NewsletterDto
|
|
227
|
+
*/
|
|
228
|
+
createdAt: Date;
|
|
229
|
+
/**
|
|
230
|
+
*
|
|
231
|
+
* @type {Date}
|
|
232
|
+
* @memberof NewsletterDto
|
|
233
|
+
*/
|
|
234
|
+
updatedAt: Date;
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* @export
|
|
238
|
+
*/
|
|
239
|
+
export declare const NewsletterDtoStatusEnum: {
|
|
240
|
+
readonly DRAFT: "draft";
|
|
241
|
+
readonly PREPARED: "prepared";
|
|
242
|
+
};
|
|
243
|
+
export type NewsletterDtoStatusEnum = typeof NewsletterDtoStatusEnum[keyof typeof NewsletterDtoStatusEnum];
|
|
244
|
+
/**
|
|
245
|
+
* Check if a given object implements the NewsletterDto interface.
|
|
246
|
+
*/
|
|
247
|
+
export declare function instanceOfNewsletterDto(value: object): value is NewsletterDto;
|
|
248
|
+
export declare function NewsletterDtoFromJSON(json: any): NewsletterDto;
|
|
249
|
+
export declare function NewsletterDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): NewsletterDto;
|
|
250
|
+
export declare function NewsletterDtoToJSON(json: any): NewsletterDto;
|
|
251
|
+
export declare function NewsletterDtoToJSONTyped(value?: NewsletterDto | null, ignoreDiscriminator?: boolean): any;
|