@randock/nameshift-api-client 0.0.505 → 0.0.507

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/.openapi-generator/FILES +9 -0
  2. package/README.md +3 -3
  3. package/dist/apis/AdminApi.d.ts +113 -1
  4. package/dist/apis/AdminApi.js +500 -0
  5. package/dist/models/AdminUserNewsletterInput.d.ts +41 -0
  6. package/dist/models/AdminUserNewsletterInput.js +60 -0
  7. package/dist/models/BankAccountFormatFieldDto.d.ts +6 -0
  8. package/dist/models/BankAccountFormatFieldDto.js +4 -0
  9. package/dist/models/CreateNewsletterInput.d.ts +171 -0
  10. package/dist/models/CreateNewsletterInput.js +98 -0
  11. package/dist/models/NewsStoryDto.d.ts +80 -0
  12. package/dist/models/NewsStoryDto.js +83 -0
  13. package/dist/models/NewsletterDto.d.ts +251 -0
  14. package/dist/models/NewsletterDto.js +200 -0
  15. package/dist/models/NewsletterPreviewDto.d.ts +44 -0
  16. package/dist/models/NewsletterPreviewDto.js +59 -0
  17. package/dist/models/NewsletterSecondaryStoryDto.d.ts +44 -0
  18. package/dist/models/NewsletterSecondaryStoryDto.js +59 -0
  19. package/dist/models/NewsletterSecondaryStoryInput.d.ts +44 -0
  20. package/dist/models/NewsletterSecondaryStoryInput.js +59 -0
  21. package/dist/models/SendNewsletterPreviewInput.d.ts +32 -0
  22. package/dist/models/SendNewsletterPreviewInput.js +51 -0
  23. package/dist/models/UpdateNewsletterInput.d.ts +171 -0
  24. package/dist/models/UpdateNewsletterInput.js +96 -0
  25. package/dist/models/index.d.ts +9 -0
  26. package/dist/models/index.js +9 -0
  27. package/package.json +1 -1
  28. package/src/apis/AdminApi.ts +454 -0
  29. package/src/models/AdminUserNewsletterInput.ts +78 -0
  30. package/src/models/BankAccountFormatFieldDto.ts +9 -0
  31. package/src/models/CreateNewsletterInput.ts +258 -0
  32. package/src/models/NewsStoryDto.ts +138 -0
  33. package/src/models/NewsletterDto.ts +400 -0
  34. package/src/models/NewsletterPreviewDto.ts +84 -0
  35. package/src/models/NewsletterSecondaryStoryDto.ts +84 -0
  36. package/src/models/NewsletterSecondaryStoryInput.ts +84 -0
  37. package/src/models/SendNewsletterPreviewInput.ts +66 -0
  38. package/src/models/UpdateNewsletterInput.ts +257 -0
  39. package/src/models/index.ts +9 -0
@@ -82,6 +82,12 @@ export interface BankAccountFormatFieldDto {
82
82
  * @memberof BankAccountFormatFieldDto
83
83
  */
84
84
  options: Array<BankAccountFormatFieldOptionDto> | null;
85
+ /**
86
+ * The option to preselect, for SELECT fields that have one. It is also what is stored when the field is left out.
87
+ * @type {string}
88
+ * @memberof BankAccountFormatFieldDto
89
+ */
90
+ defaultValue: string | null;
85
91
  }
86
92
 
87
93
 
@@ -98,6 +104,7 @@ export function instanceOfBankAccountFormatFieldDto(value: object): value is Ban
98
104
  if (!('description' in value) || value['description'] === undefined) return false;
99
105
  if (!('example' in value) || value['example'] === undefined) return false;
100
106
  if (!('options' in value) || value['options'] === undefined) return false;
107
+ if (!('defaultValue' in value) || value['defaultValue'] === undefined) return false;
101
108
  return true;
102
109
  }
103
110
 
@@ -119,6 +126,7 @@ export function BankAccountFormatFieldDtoFromJSONTyped(json: any, ignoreDiscrimi
119
126
  'description': json['description'],
120
127
  'example': json['example'],
121
128
  'options': (json['options'] == null ? null : (json['options'] as Array<any>).map(BankAccountFormatFieldOptionDtoFromJSON)),
129
+ 'defaultValue': json['defaultValue'],
122
130
  };
123
131
  }
124
132
 
@@ -141,6 +149,7 @@ export function BankAccountFormatFieldDtoToJSONTyped(value?: BankAccountFormatFi
141
149
  'description': value['description'],
142
150
  'example': value['example'],
143
151
  'options': (value['options'] == null ? null : (value['options'] as Array<any>).map(BankAccountFormatFieldOptionDtoToJSON)),
152
+ 'defaultValue': value['defaultValue'],
144
153
  };
145
154
  }
146
155
 
@@ -0,0 +1,258 @@
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
+ import type { NewsletterSecondaryStoryInput } from './NewsletterSecondaryStoryInput';
17
+ import {
18
+ NewsletterSecondaryStoryInputFromJSON,
19
+ NewsletterSecondaryStoryInputFromJSONTyped,
20
+ NewsletterSecondaryStoryInputToJSON,
21
+ NewsletterSecondaryStoryInputToJSONTyped,
22
+ } from './NewsletterSecondaryStoryInput';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface CreateNewsletterInput
28
+ */
29
+ export interface CreateNewsletterInput {
30
+ /**
31
+ * Subject line.
32
+ * @type {string}
33
+ * @memberof CreateNewsletterInput
34
+ */
35
+ subject?: string;
36
+ /**
37
+ * Preheader, 40 to 90 characters.
38
+ * @type {string}
39
+ * @memberof CreateNewsletterInput
40
+ */
41
+ preheader?: string;
42
+ /**
43
+ * Issue label in the header; may carry HTML entities.
44
+ * @type {string}
45
+ * @memberof CreateNewsletterInput
46
+ */
47
+ issueLabel?: string;
48
+ /**
49
+ * utm_campaign on every link, e.g. nl-2026-10.
50
+ * @type {string}
51
+ * @memberof CreateNewsletterInput
52
+ */
53
+ campaignSlug?: string;
54
+ /**
55
+ * Lead story UUID.
56
+ * @type {string}
57
+ * @memberof CreateNewsletterInput
58
+ */
59
+ leadStoryUuid?: string | null;
60
+ /**
61
+ * Lead teaser, 30 to 60 words.
62
+ * @type {string}
63
+ * @memberof CreateNewsletterInput
64
+ */
65
+ leadTeaser?: string;
66
+ /**
67
+ * Lead button text, 2 to 5 words.
68
+ * @type {string}
69
+ * @memberof CreateNewsletterInput
70
+ */
71
+ leadCta?: string;
72
+ /**
73
+ * Secondary stories, in order.
74
+ * @type {Array<NewsletterSecondaryStoryInput>}
75
+ * @memberof CreateNewsletterInput
76
+ */
77
+ secondaryStories?: Array<NewsletterSecondaryStoryInput>;
78
+ /**
79
+ * Feature story UUID.
80
+ * @type {string}
81
+ * @memberof CreateNewsletterInput
82
+ */
83
+ featureStoryUuid?: string | null;
84
+ /**
85
+ * Feature text, 1 to 2 sentences.
86
+ * @type {string}
87
+ * @memberof CreateNewsletterInput
88
+ */
89
+ featureText?: string;
90
+ /**
91
+ * Feature link text.
92
+ * @type {string}
93
+ * @memberof CreateNewsletterInput
94
+ */
95
+ featureLink?: string;
96
+ /**
97
+ * Event lead line.
98
+ * @type {string}
99
+ * @memberof CreateNewsletterInput
100
+ */
101
+ eventLead?: string | null;
102
+ /**
103
+ * Event text.
104
+ * @type {string}
105
+ * @memberof CreateNewsletterInput
106
+ */
107
+ eventText?: string | null;
108
+ /**
109
+ * Event link URL.
110
+ * @type {string}
111
+ * @memberof CreateNewsletterInput
112
+ */
113
+ eventUrl?: string | null;
114
+ /**
115
+ * Event link text.
116
+ * @type {string}
117
+ * @memberof CreateNewsletterInput
118
+ */
119
+ eventLink?: string | null;
120
+ /**
121
+ * Whether the recent-sales module is in the issue.
122
+ * @type {boolean}
123
+ * @memberof CreateNewsletterInput
124
+ */
125
+ salesEnabled?: boolean;
126
+ /**
127
+ * First day of the sales period (YYYY-MM-DD).
128
+ * @type {string}
129
+ * @memberof CreateNewsletterInput
130
+ */
131
+ salesFrom?: string | null;
132
+ /**
133
+ * Last day of the sales period (YYYY-MM-DD).
134
+ * @type {string}
135
+ * @memberof CreateNewsletterInput
136
+ */
137
+ salesTo?: string | null;
138
+ /**
139
+ * Closing band line.
140
+ * @type {string}
141
+ * @memberof CreateNewsletterInput
142
+ */
143
+ closingLine?: string;
144
+ /**
145
+ * Closing button text.
146
+ * @type {string}
147
+ * @memberof CreateNewsletterInput
148
+ */
149
+ closingCta?: string;
150
+ /**
151
+ * Closing button URL.
152
+ * @type {string}
153
+ * @memberof CreateNewsletterInput
154
+ */
155
+ closingUrl?: string;
156
+ /**
157
+ * Closing note under the button.
158
+ * @type {string}
159
+ * @memberof CreateNewsletterInput
160
+ */
161
+ closingNote?: string;
162
+ /**
163
+ * Why the reader receives the email.
164
+ * @type {string}
165
+ * @memberof CreateNewsletterInput
166
+ */
167
+ footerReason?: string;
168
+ /**
169
+ * Internal title, also the Mailchimp campaign name.
170
+ * @type {string}
171
+ * @memberof CreateNewsletterInput
172
+ */
173
+ title: string;
174
+ }
175
+
176
+ /**
177
+ * Check if a given object implements the CreateNewsletterInput interface.
178
+ */
179
+ export function instanceOfCreateNewsletterInput(value: object): value is CreateNewsletterInput {
180
+ if (!('title' in value) || value['title'] === undefined) return false;
181
+ return true;
182
+ }
183
+
184
+ export function CreateNewsletterInputFromJSON(json: any): CreateNewsletterInput {
185
+ return CreateNewsletterInputFromJSONTyped(json, false);
186
+ }
187
+
188
+ export function CreateNewsletterInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateNewsletterInput {
189
+ if (json == null) {
190
+ return json;
191
+ }
192
+ return {
193
+
194
+ 'subject': json['subject'] == null ? undefined : json['subject'],
195
+ 'preheader': json['preheader'] == null ? undefined : json['preheader'],
196
+ 'issueLabel': json['issueLabel'] == null ? undefined : json['issueLabel'],
197
+ 'campaignSlug': json['campaignSlug'] == null ? undefined : json['campaignSlug'],
198
+ 'leadStoryUuid': json['leadStoryUuid'] == null ? undefined : json['leadStoryUuid'],
199
+ 'leadTeaser': json['leadTeaser'] == null ? undefined : json['leadTeaser'],
200
+ 'leadCta': json['leadCta'] == null ? undefined : json['leadCta'],
201
+ 'secondaryStories': json['secondaryStories'] == null ? undefined : ((json['secondaryStories'] as Array<any>).map(NewsletterSecondaryStoryInputFromJSON)),
202
+ 'featureStoryUuid': json['featureStoryUuid'] == null ? undefined : json['featureStoryUuid'],
203
+ 'featureText': json['featureText'] == null ? undefined : json['featureText'],
204
+ 'featureLink': json['featureLink'] == null ? undefined : json['featureLink'],
205
+ 'eventLead': json['eventLead'] == null ? undefined : json['eventLead'],
206
+ 'eventText': json['eventText'] == null ? undefined : json['eventText'],
207
+ 'eventUrl': json['eventUrl'] == null ? undefined : json['eventUrl'],
208
+ 'eventLink': json['eventLink'] == null ? undefined : json['eventLink'],
209
+ 'salesEnabled': json['salesEnabled'] == null ? undefined : json['salesEnabled'],
210
+ 'salesFrom': json['salesFrom'] == null ? undefined : json['salesFrom'],
211
+ 'salesTo': json['salesTo'] == null ? undefined : json['salesTo'],
212
+ 'closingLine': json['closingLine'] == null ? undefined : json['closingLine'],
213
+ 'closingCta': json['closingCta'] == null ? undefined : json['closingCta'],
214
+ 'closingUrl': json['closingUrl'] == null ? undefined : json['closingUrl'],
215
+ 'closingNote': json['closingNote'] == null ? undefined : json['closingNote'],
216
+ 'footerReason': json['footerReason'] == null ? undefined : json['footerReason'],
217
+ 'title': json['title'],
218
+ };
219
+ }
220
+
221
+ export function CreateNewsletterInputToJSON(json: any): CreateNewsletterInput {
222
+ return CreateNewsletterInputToJSONTyped(json, false);
223
+ }
224
+
225
+ export function CreateNewsletterInputToJSONTyped(value?: CreateNewsletterInput | null, ignoreDiscriminator: boolean = false): any {
226
+ if (value == null) {
227
+ return value;
228
+ }
229
+
230
+ return {
231
+
232
+ 'subject': value['subject'],
233
+ 'preheader': value['preheader'],
234
+ 'issueLabel': value['issueLabel'],
235
+ 'campaignSlug': value['campaignSlug'],
236
+ 'leadStoryUuid': value['leadStoryUuid'],
237
+ 'leadTeaser': value['leadTeaser'],
238
+ 'leadCta': value['leadCta'],
239
+ 'secondaryStories': value['secondaryStories'] == null ? undefined : ((value['secondaryStories'] as Array<any>).map(NewsletterSecondaryStoryInputToJSON)),
240
+ 'featureStoryUuid': value['featureStoryUuid'],
241
+ 'featureText': value['featureText'],
242
+ 'featureLink': value['featureLink'],
243
+ 'eventLead': value['eventLead'],
244
+ 'eventText': value['eventText'],
245
+ 'eventUrl': value['eventUrl'],
246
+ 'eventLink': value['eventLink'],
247
+ 'salesEnabled': value['salesEnabled'],
248
+ 'salesFrom': value['salesFrom'],
249
+ 'salesTo': value['salesTo'],
250
+ 'closingLine': value['closingLine'],
251
+ 'closingCta': value['closingCta'],
252
+ 'closingUrl': value['closingUrl'],
253
+ 'closingNote': value['closingNote'],
254
+ 'footerReason': value['footerReason'],
255
+ 'title': value['title'],
256
+ };
257
+ }
258
+
@@ -0,0 +1,138 @@
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 NewsStoryDto
20
+ */
21
+ export interface NewsStoryDto {
22
+ /**
23
+ * Storyblok story UUID.
24
+ * @type {string}
25
+ * @memberof NewsStoryDto
26
+ */
27
+ uuid: string;
28
+ /**
29
+ * Headline of the post.
30
+ * @type {string}
31
+ * @memberof NewsStoryDto
32
+ */
33
+ title: string;
34
+ /**
35
+ * Public URL of the post.
36
+ * @type {string}
37
+ * @memberof NewsStoryDto
38
+ */
39
+ url: string;
40
+ /**
41
+ * Category key, e.g. articles.
42
+ * @type {string}
43
+ * @memberof NewsStoryDto
44
+ */
45
+ category: string;
46
+ /**
47
+ * Category as the email shows it, e.g. Article.
48
+ * @type {string}
49
+ * @memberof NewsStoryDto
50
+ */
51
+ categoryLabel: string;
52
+ /**
53
+ * Publication date (YYYY-MM-DD).
54
+ * @type {string}
55
+ * @memberof NewsStoryDto
56
+ */
57
+ date: string;
58
+ /**
59
+ * Intro paragraph of the post.
60
+ * @type {string}
61
+ * @memberof NewsStoryDto
62
+ */
63
+ intro: string;
64
+ /**
65
+ * Hero image on the image CDN, without crop parameters.
66
+ * @type {string}
67
+ * @memberof NewsStoryDto
68
+ */
69
+ heroImageUrl: string | null;
70
+ /**
71
+ * Alt text of the hero image.
72
+ * @type {string}
73
+ * @memberof NewsStoryDto
74
+ */
75
+ heroImageAlt: string;
76
+ }
77
+
78
+ /**
79
+ * Check if a given object implements the NewsStoryDto interface.
80
+ */
81
+ export function instanceOfNewsStoryDto(value: object): value is NewsStoryDto {
82
+ if (!('uuid' in value) || value['uuid'] === undefined) return false;
83
+ if (!('title' in value) || value['title'] === undefined) return false;
84
+ if (!('url' in value) || value['url'] === undefined) return false;
85
+ if (!('category' in value) || value['category'] === undefined) return false;
86
+ if (!('categoryLabel' in value) || value['categoryLabel'] === undefined) return false;
87
+ if (!('date' in value) || value['date'] === undefined) return false;
88
+ if (!('intro' in value) || value['intro'] === undefined) return false;
89
+ if (!('heroImageUrl' in value) || value['heroImageUrl'] === undefined) return false;
90
+ if (!('heroImageAlt' in value) || value['heroImageAlt'] === undefined) return false;
91
+ return true;
92
+ }
93
+
94
+ export function NewsStoryDtoFromJSON(json: any): NewsStoryDto {
95
+ return NewsStoryDtoFromJSONTyped(json, false);
96
+ }
97
+
98
+ export function NewsStoryDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): NewsStoryDto {
99
+ if (json == null) {
100
+ return json;
101
+ }
102
+ return {
103
+
104
+ 'uuid': json['uuid'],
105
+ 'title': json['title'],
106
+ 'url': json['url'],
107
+ 'category': json['category'],
108
+ 'categoryLabel': json['categoryLabel'],
109
+ 'date': json['date'],
110
+ 'intro': json['intro'],
111
+ 'heroImageUrl': json['heroImageUrl'],
112
+ 'heroImageAlt': json['heroImageAlt'],
113
+ };
114
+ }
115
+
116
+ export function NewsStoryDtoToJSON(json: any): NewsStoryDto {
117
+ return NewsStoryDtoToJSONTyped(json, false);
118
+ }
119
+
120
+ export function NewsStoryDtoToJSONTyped(value?: NewsStoryDto | null, ignoreDiscriminator: boolean = false): any {
121
+ if (value == null) {
122
+ return value;
123
+ }
124
+
125
+ return {
126
+
127
+ 'uuid': value['uuid'],
128
+ 'title': value['title'],
129
+ 'url': value['url'],
130
+ 'category': value['category'],
131
+ 'categoryLabel': value['categoryLabel'],
132
+ 'date': value['date'],
133
+ 'intro': value['intro'],
134
+ 'heroImageUrl': value['heroImageUrl'],
135
+ 'heroImageAlt': value['heroImageAlt'],
136
+ };
137
+ }
138
+