@randock/nameshift-api-client 0.0.447 → 0.0.449

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 (87) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +3 -3
  3. package/dist/apis/APIKeysApi.d.ts +78 -0
  4. package/dist/apis/APIKeysApi.js +354 -0
  5. package/dist/apis/AccountsApi.d.ts +36 -36
  6. package/dist/apis/AccountsApi.js +360 -216
  7. package/dist/apis/AdminApi.d.ts +26 -0
  8. package/dist/apis/AdminApi.js +106 -0
  9. package/dist/apis/AuctionsApi.d.ts +4 -4
  10. package/dist/apis/AuctionsApi.js +40 -24
  11. package/dist/apis/BankAccountsApi.d.ts +10 -10
  12. package/dist/apis/BankAccountsApi.js +100 -60
  13. package/dist/apis/ChallengesApi.d.ts +6 -6
  14. package/dist/apis/ChallengesApi.js +60 -36
  15. package/dist/apis/DomainTransfersApi.d.ts +2 -2
  16. package/dist/apis/DomainTransfersApi.js +20 -12
  17. package/dist/apis/DomainsApi.d.ts +44 -44
  18. package/dist/apis/DomainsApi.js +440 -264
  19. package/dist/apis/EppApi.d.ts +2 -2
  20. package/dist/apis/EppApi.js +20 -12
  21. package/dist/apis/InvoicesApi.d.ts +6 -6
  22. package/dist/apis/InvoicesApi.js +60 -36
  23. package/dist/apis/LeadsApi.d.ts +38 -38
  24. package/dist/apis/LeadsApi.js +380 -228
  25. package/dist/apis/MarketApi.d.ts +2 -2
  26. package/dist/apis/MarketApi.js +2 -2
  27. package/dist/apis/NotificationsApi.d.ts +8 -8
  28. package/dist/apis/NotificationsApi.js +80 -48
  29. package/dist/apis/StatsApi.d.ts +14 -14
  30. package/dist/apis/StatsApi.js +140 -84
  31. package/dist/apis/SubscriptionsApi.d.ts +2 -2
  32. package/dist/apis/SubscriptionsApi.js +20 -12
  33. package/dist/apis/TasksApi.d.ts +6 -6
  34. package/dist/apis/TasksApi.js +60 -36
  35. package/dist/apis/UsersApi.d.ts +10 -10
  36. package/dist/apis/UsersApi.js +100 -60
  37. package/dist/apis/index.d.ts +1 -0
  38. package/dist/apis/index.js +1 -0
  39. package/dist/models/AdminDomainListItemDto.d.ts +6 -0
  40. package/dist/models/AdminDomainListItemDto.js +4 -0
  41. package/dist/models/ApiKeyDto.d.ts +107 -0
  42. package/dist/models/ApiKeyDto.js +114 -0
  43. package/dist/models/ApiKeyScopeDto.d.ts +83 -0
  44. package/dist/models/ApiKeyScopeDto.js +98 -0
  45. package/dist/models/CreateApiKeyInput.d.ts +83 -0
  46. package/dist/models/CreateApiKeyInput.js +96 -0
  47. package/dist/models/CreatedApiKeyDto.d.ts +113 -0
  48. package/dist/models/CreatedApiKeyDto.js +118 -0
  49. package/dist/models/IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto.d.ts +6 -0
  50. package/dist/models/IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto.js +4 -0
  51. package/dist/models/IntersectionDomainDtoWithHijackerDtoWithAccountDto.d.ts +6 -0
  52. package/dist/models/IntersectionDomainDtoWithHijackerDtoWithAccountDto.js +4 -0
  53. package/dist/models/IntersectionDomainDtoWithSeoMetricsDto.d.ts +6 -0
  54. package/dist/models/IntersectionDomainDtoWithSeoMetricsDto.js +4 -0
  55. package/dist/models/UpdateApiKeyInput.d.ts +77 -0
  56. package/dist/models/UpdateApiKeyInput.js +90 -0
  57. package/dist/models/index.d.ts +5 -0
  58. package/dist/models/index.js +5 -0
  59. package/package.json +1 -1
  60. package/src/apis/APIKeysApi.ts +271 -0
  61. package/src/apis/AccountsApi.ts +108 -36
  62. package/src/apis/AdminApi.ts +92 -0
  63. package/src/apis/AuctionsApi.ts +12 -4
  64. package/src/apis/BankAccountsApi.ts +30 -10
  65. package/src/apis/ChallengesApi.ts +18 -6
  66. package/src/apis/DomainTransfersApi.ts +6 -2
  67. package/src/apis/DomainsApi.ts +132 -44
  68. package/src/apis/EppApi.ts +6 -2
  69. package/src/apis/InvoicesApi.ts +18 -6
  70. package/src/apis/LeadsApi.ts +114 -38
  71. package/src/apis/MarketApi.ts +2 -2
  72. package/src/apis/NotificationsApi.ts +24 -8
  73. package/src/apis/StatsApi.ts +42 -14
  74. package/src/apis/SubscriptionsApi.ts +6 -2
  75. package/src/apis/TasksApi.ts +18 -6
  76. package/src/apis/UsersApi.ts +30 -10
  77. package/src/apis/index.ts +1 -0
  78. package/src/models/AdminDomainListItemDto.ts +9 -0
  79. package/src/models/ApiKeyDto.ts +162 -0
  80. package/src/models/ApiKeyScopeDto.ts +126 -0
  81. package/src/models/CreateApiKeyInput.ts +125 -0
  82. package/src/models/CreatedApiKeyDto.ts +171 -0
  83. package/src/models/IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto.ts +9 -0
  84. package/src/models/IntersectionDomainDtoWithHijackerDtoWithAccountDto.ts +9 -0
  85. package/src/models/IntersectionDomainDtoWithSeoMetricsDto.ts +9 -0
  86. package/src/models/UpdateApiKeyInput.ts +115 -0
  87. package/src/models/index.ts +5 -0
@@ -62,7 +62,7 @@ export interface NotificationsApiListNotificationsRequest {
62
62
  export class NotificationsApi extends runtime.BaseAPI {
63
63
 
64
64
  /**
65
- * Marks multiple seller notifications as read or unread based on the readStatus parameter.
65
+ * Marks multiple seller notifications as read or unread based on the readStatus parameter. **API key scope required:** `NOTIFICATIONS_WRITE`. Requests authenticated with a seller session do not need any scope.
66
66
  * Bulk mark notifications as read or unread
67
67
  */
68
68
  async bulkMarkNotificationsAsReadRaw(requestParameters: NotificationsApiBulkMarkNotificationsAsReadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -79,6 +79,10 @@ export class NotificationsApi extends runtime.BaseAPI {
79
79
 
80
80
  headerParameters['Content-Type'] = 'application/json';
81
81
 
82
+ if (this.configuration && this.configuration.apiKey) {
83
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
84
+ }
85
+
82
86
  if (this.configuration && this.configuration.accessToken) {
83
87
  const token = this.configuration.accessToken;
84
88
  const tokenString = await token("bearer", []);
@@ -99,7 +103,7 @@ export class NotificationsApi extends runtime.BaseAPI {
99
103
  }
100
104
 
101
105
  /**
102
- * Marks multiple seller notifications as read or unread based on the readStatus parameter.
106
+ * Marks multiple seller notifications as read or unread based on the readStatus parameter. **API key scope required:** `NOTIFICATIONS_WRITE`. Requests authenticated with a seller session do not need any scope.
103
107
  * Bulk mark notifications as read or unread
104
108
  */
105
109
  async bulkMarkNotificationsAsRead(requestParameters: NotificationsApiBulkMarkNotificationsAsReadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -107,7 +111,7 @@ export class NotificationsApi extends runtime.BaseAPI {
107
111
  }
108
112
 
109
113
  /**
110
- * Downloads a file attachment from a seller notification.
114
+ * Downloads a file attachment from a seller notification. **API key scope required:** `NOTIFICATIONS_READ`. Requests authenticated with a seller session do not need any scope.
111
115
  * Download notification attachment
112
116
  */
113
117
  async downloadNotificationAttachmentRaw(requestParameters: NotificationsApiDownloadNotificationAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
@@ -129,6 +133,10 @@ export class NotificationsApi extends runtime.BaseAPI {
129
133
 
130
134
  const headerParameters: runtime.HTTPHeaders = {};
131
135
 
136
+ if (this.configuration && this.configuration.apiKey) {
137
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
138
+ }
139
+
132
140
  if (this.configuration && this.configuration.accessToken) {
133
141
  const token = this.configuration.accessToken;
134
142
  const tokenString = await token("bearer", []);
@@ -148,7 +156,7 @@ export class NotificationsApi extends runtime.BaseAPI {
148
156
  }
149
157
 
150
158
  /**
151
- * Downloads a file attachment from a seller notification.
159
+ * Downloads a file attachment from a seller notification. **API key scope required:** `NOTIFICATIONS_READ`. Requests authenticated with a seller session do not need any scope.
152
160
  * Download notification attachment
153
161
  */
154
162
  async downloadNotificationAttachment(requestParameters: NotificationsApiDownloadNotificationAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
@@ -157,7 +165,7 @@ export class NotificationsApi extends runtime.BaseAPI {
157
165
  }
158
166
 
159
167
  /**
160
- * Returns notification information for the seller user.
168
+ * Returns notification information for the seller user. **API key scope required:** `NOTIFICATIONS_READ`. Requests authenticated with a seller session do not need any scope.
161
169
  * Get notification details
162
170
  */
163
171
  async getNotificationByIdRaw(requestParameters: NotificationsApiGetNotificationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserNotificationDto>> {
@@ -172,6 +180,10 @@ export class NotificationsApi extends runtime.BaseAPI {
172
180
 
173
181
  const headerParameters: runtime.HTTPHeaders = {};
174
182
 
183
+ if (this.configuration && this.configuration.apiKey) {
184
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
185
+ }
186
+
175
187
  if (this.configuration && this.configuration.accessToken) {
176
188
  const token = this.configuration.accessToken;
177
189
  const tokenString = await token("bearer", []);
@@ -191,7 +203,7 @@ export class NotificationsApi extends runtime.BaseAPI {
191
203
  }
192
204
 
193
205
  /**
194
- * Returns notification information for the seller user.
206
+ * Returns notification information for the seller user. **API key scope required:** `NOTIFICATIONS_READ`. Requests authenticated with a seller session do not need any scope.
195
207
  * Get notification details
196
208
  */
197
209
  async getNotificationById(requestParameters: NotificationsApiGetNotificationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserNotificationDto> {
@@ -200,7 +212,7 @@ export class NotificationsApi extends runtime.BaseAPI {
200
212
  }
201
213
 
202
214
  /**
203
- * Lists notifications for the seller user.
215
+ * Lists notifications for the seller user. **API key scope required:** `NOTIFICATIONS_READ`. Requests authenticated with a seller session do not need any scope.
204
216
  * List seller notifications
205
217
  */
206
218
  async listNotificationsRaw(requestParameters: NotificationsApiListNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListNotifications200Response>> {
@@ -232,6 +244,10 @@ export class NotificationsApi extends runtime.BaseAPI {
232
244
 
233
245
  const headerParameters: runtime.HTTPHeaders = {};
234
246
 
247
+ if (this.configuration && this.configuration.apiKey) {
248
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
249
+ }
250
+
235
251
  if (this.configuration && this.configuration.accessToken) {
236
252
  const token = this.configuration.accessToken;
237
253
  const tokenString = await token("bearer", []);
@@ -251,7 +267,7 @@ export class NotificationsApi extends runtime.BaseAPI {
251
267
  }
252
268
 
253
269
  /**
254
- * Lists notifications for the seller user.
270
+ * Lists notifications for the seller user. **API key scope required:** `NOTIFICATIONS_READ`. Requests authenticated with a seller session do not need any scope.
255
271
  * List seller notifications
256
272
  */
257
273
  async listNotifications(requestParameters: NotificationsApiListNotificationsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListNotifications200Response> {
@@ -66,7 +66,7 @@ export interface StatsApiGetTotalEarningsByCurrencyOverTimeRequest {
66
66
  export class StatsApi extends runtime.BaseAPI {
67
67
 
68
68
  /**
69
- * Returns the total pending payout amounts grouped by currency for the seller.
69
+ * Returns the total pending payout amounts grouped by currency for the seller. **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
70
70
  * Get pending payouts by currency
71
71
  */
72
72
  async getPendingPayoutsByCurrencyRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerPendingPayoutsByCurrencyStatsItemDto>>> {
@@ -74,6 +74,10 @@ export class StatsApi extends runtime.BaseAPI {
74
74
 
75
75
  const headerParameters: runtime.HTTPHeaders = {};
76
76
 
77
+ if (this.configuration && this.configuration.apiKey) {
78
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
79
+ }
80
+
77
81
  if (this.configuration && this.configuration.accessToken) {
78
82
  const token = this.configuration.accessToken;
79
83
  const tokenString = await token("bearer", []);
@@ -93,7 +97,7 @@ export class StatsApi extends runtime.BaseAPI {
93
97
  }
94
98
 
95
99
  /**
96
- * Returns the total pending payout amounts grouped by currency for the seller.
100
+ * Returns the total pending payout amounts grouped by currency for the seller. **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
97
101
  * Get pending payouts by currency
98
102
  */
99
103
  async getPendingPayoutsByCurrency(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerPendingPayoutsByCurrencyStatsItemDto>> {
@@ -102,7 +106,7 @@ export class StatsApi extends runtime.BaseAPI {
102
106
  }
103
107
 
104
108
  /**
105
- * Returns remaining versus total lease-to-own income grouped by currency for the seller.
109
+ * Returns remaining versus total lease-to-own income grouped by currency for the seller. **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
106
110
  * Get lease-to-own income comparison
107
111
  */
108
112
  async getRemainingVsTotalLeaseToOwnByCurrencyRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerRemainingAndTotalLeaseToOwnByCurrencyStatsItemDto>>> {
@@ -110,6 +114,10 @@ export class StatsApi extends runtime.BaseAPI {
110
114
 
111
115
  const headerParameters: runtime.HTTPHeaders = {};
112
116
 
117
+ if (this.configuration && this.configuration.apiKey) {
118
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
119
+ }
120
+
113
121
  if (this.configuration && this.configuration.accessToken) {
114
122
  const token = this.configuration.accessToken;
115
123
  const tokenString = await token("bearer", []);
@@ -129,7 +137,7 @@ export class StatsApi extends runtime.BaseAPI {
129
137
  }
130
138
 
131
139
  /**
132
- * Returns remaining versus total lease-to-own income grouped by currency for the seller.
140
+ * Returns remaining versus total lease-to-own income grouped by currency for the seller. **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
133
141
  * Get lease-to-own income comparison
134
142
  */
135
143
  async getRemainingVsTotalLeaseToOwnByCurrency(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerRemainingAndTotalLeaseToOwnByCurrencyStatsItemDto>> {
@@ -138,7 +146,7 @@ export class StatsApi extends runtime.BaseAPI {
138
146
  }
139
147
 
140
148
  /**
141
- * Returns sales statistics grouped by top-level domain for the seller within the specified date range and currency.
149
+ * Returns sales statistics grouped by top-level domain for the seller within the specified date range and currency. **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
142
150
  * Get sales by TLD
143
151
  */
144
152
  async getSalesByTldRaw(requestParameters: StatsApiGetSalesByTldRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerSalesByTldStatsItemDto>>> {
@@ -161,6 +169,10 @@ export class StatsApi extends runtime.BaseAPI {
161
169
 
162
170
  const headerParameters: runtime.HTTPHeaders = {};
163
171
 
172
+ if (this.configuration && this.configuration.apiKey) {
173
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
174
+ }
175
+
164
176
  if (this.configuration && this.configuration.accessToken) {
165
177
  const token = this.configuration.accessToken;
166
178
  const tokenString = await token("bearer", []);
@@ -180,7 +192,7 @@ export class StatsApi extends runtime.BaseAPI {
180
192
  }
181
193
 
182
194
  /**
183
- * Returns sales statistics grouped by top-level domain for the seller within the specified date range and currency.
195
+ * Returns sales statistics grouped by top-level domain for the seller within the specified date range and currency. **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
184
196
  * Get sales by TLD
185
197
  */
186
198
  async getSalesByTld(requestParameters: StatsApiGetSalesByTldRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerSalesByTldStatsItemDto>> {
@@ -189,7 +201,7 @@ export class StatsApi extends runtime.BaseAPI {
189
201
  }
190
202
 
191
203
  /**
192
- * Returns the number of sales for the current seller account within the specified date range.
204
+ * Returns the number of sales for the current seller account within the specified date range. **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
193
205
  * Get sales count stats
194
206
  */
195
207
  async getSalesCountRaw(requestParameters: StatsApiGetSalesCountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerSalesCountStatsItemDto>>> {
@@ -201,6 +213,10 @@ export class StatsApi extends runtime.BaseAPI {
201
213
 
202
214
  const headerParameters: runtime.HTTPHeaders = {};
203
215
 
216
+ if (this.configuration && this.configuration.apiKey) {
217
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
218
+ }
219
+
204
220
  if (this.configuration && this.configuration.accessToken) {
205
221
  const token = this.configuration.accessToken;
206
222
  const tokenString = await token("bearer", []);
@@ -220,7 +236,7 @@ export class StatsApi extends runtime.BaseAPI {
220
236
  }
221
237
 
222
238
  /**
223
- * Returns the number of sales for the current seller account within the specified date range.
239
+ * Returns the number of sales for the current seller account within the specified date range. **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
224
240
  * Get sales count stats
225
241
  */
226
242
  async getSalesCount(requestParameters: StatsApiGetSalesCountRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerSalesCountStatsItemDto>> {
@@ -229,7 +245,7 @@ export class StatsApi extends runtime.BaseAPI {
229
245
  }
230
246
 
231
247
  /**
232
- * Returns total earnings grouped by currency for the seller, optionally filtered by date range.
248
+ * Returns total earnings grouped by currency for the seller, optionally filtered by date range. **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
233
249
  * Get total earnings by currency
234
250
  */
235
251
  async getTotalEarningsByCurrencyRaw(requestParameters: StatsApiGetTotalEarningsByCurrencyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerTotalEarningsByCurrencyStatsItemDto>>> {
@@ -241,6 +257,10 @@ export class StatsApi extends runtime.BaseAPI {
241
257
 
242
258
  const headerParameters: runtime.HTTPHeaders = {};
243
259
 
260
+ if (this.configuration && this.configuration.apiKey) {
261
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
262
+ }
263
+
244
264
  if (this.configuration && this.configuration.accessToken) {
245
265
  const token = this.configuration.accessToken;
246
266
  const tokenString = await token("bearer", []);
@@ -260,7 +280,7 @@ export class StatsApi extends runtime.BaseAPI {
260
280
  }
261
281
 
262
282
  /**
263
- * Returns total earnings grouped by currency for the seller, optionally filtered by date range.
283
+ * Returns total earnings grouped by currency for the seller, optionally filtered by date range. **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
264
284
  * Get total earnings by currency
265
285
  */
266
286
  async getTotalEarningsByCurrency(requestParameters: StatsApiGetTotalEarningsByCurrencyRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerTotalEarningsByCurrencyStatsItemDto>> {
@@ -269,7 +289,7 @@ export class StatsApi extends runtime.BaseAPI {
269
289
  }
270
290
 
271
291
  /**
272
- * Returns total earnings over time grouped by currency for the seller within the specified date range.
292
+ * Returns total earnings over time grouped by currency for the seller within the specified date range. **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
273
293
  * Get earnings over time by currency
274
294
  */
275
295
  async getTotalEarningsByCurrencyOverTimeRaw(requestParameters: StatsApiGetTotalEarningsByCurrencyOverTimeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerTotalEarningsByCurrencyOverTimeStatsItemDto>>> {
@@ -281,6 +301,10 @@ export class StatsApi extends runtime.BaseAPI {
281
301
 
282
302
  const headerParameters: runtime.HTTPHeaders = {};
283
303
 
304
+ if (this.configuration && this.configuration.apiKey) {
305
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
306
+ }
307
+
284
308
  if (this.configuration && this.configuration.accessToken) {
285
309
  const token = this.configuration.accessToken;
286
310
  const tokenString = await token("bearer", []);
@@ -300,7 +324,7 @@ export class StatsApi extends runtime.BaseAPI {
300
324
  }
301
325
 
302
326
  /**
303
- * Returns total earnings over time grouped by currency for the seller within the specified date range.
327
+ * Returns total earnings over time grouped by currency for the seller within the specified date range. **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
304
328
  * Get earnings over time by currency
305
329
  */
306
330
  async getTotalEarningsByCurrencyOverTime(requestParameters: StatsApiGetTotalEarningsByCurrencyOverTimeRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerTotalEarningsByCurrencyOverTimeStatsItemDto>> {
@@ -309,7 +333,7 @@ export class StatsApi extends runtime.BaseAPI {
309
333
  }
310
334
 
311
335
  /**
312
- * Returns the total monthly rent income grouped by currency for the seller.
336
+ * Returns the total monthly rent income grouped by currency for the seller. **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
313
337
  * Get monthly rent income by currency
314
338
  */
315
339
  async getTotalMonthlyRentIncomeByCurrencyRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerTotalRentMonthlyIncomeByCurrencyStatsItemDto>>> {
@@ -317,6 +341,10 @@ export class StatsApi extends runtime.BaseAPI {
317
341
 
318
342
  const headerParameters: runtime.HTTPHeaders = {};
319
343
 
344
+ if (this.configuration && this.configuration.apiKey) {
345
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
346
+ }
347
+
320
348
  if (this.configuration && this.configuration.accessToken) {
321
349
  const token = this.configuration.accessToken;
322
350
  const tokenString = await token("bearer", []);
@@ -336,7 +364,7 @@ export class StatsApi extends runtime.BaseAPI {
336
364
  }
337
365
 
338
366
  /**
339
- * Returns the total monthly rent income grouped by currency for the seller.
367
+ * Returns the total monthly rent income grouped by currency for the seller. **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
340
368
  * Get monthly rent income by currency
341
369
  */
342
370
  async getTotalMonthlyRentIncomeByCurrency(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerTotalRentMonthlyIncomeByCurrencyStatsItemDto>> {
@@ -40,7 +40,7 @@ export interface SubscriptionsApiGetAllSubscriptionsRequest {
40
40
  export class SubscriptionsApi extends runtime.BaseAPI {
41
41
 
42
42
  /**
43
- * Lists subscriptions for the seller account.
43
+ * Lists subscriptions for the seller account. **API key scope required:** `SUBSCRIPTIONS_READ`. Requests authenticated with a seller session do not need any scope.
44
44
  * List seller subscriptions
45
45
  */
46
46
  async getAllSubscriptionsRaw(requestParameters: SubscriptionsApiGetAllSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAllSubscriptions200Response1>> {
@@ -72,6 +72,10 @@ export class SubscriptionsApi extends runtime.BaseAPI {
72
72
 
73
73
  const headerParameters: runtime.HTTPHeaders = {};
74
74
 
75
+ if (this.configuration && this.configuration.apiKey) {
76
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
77
+ }
78
+
75
79
  if (this.configuration && this.configuration.accessToken) {
76
80
  const token = this.configuration.accessToken;
77
81
  const tokenString = await token("bearer", []);
@@ -91,7 +95,7 @@ export class SubscriptionsApi extends runtime.BaseAPI {
91
95
  }
92
96
 
93
97
  /**
94
- * Lists subscriptions for the seller account.
98
+ * Lists subscriptions for the seller account. **API key scope required:** `SUBSCRIPTIONS_READ`. Requests authenticated with a seller session do not need any scope.
95
99
  * List seller subscriptions
96
100
  */
97
101
  async getAllSubscriptions(requestParameters: SubscriptionsApiGetAllSubscriptionsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllSubscriptions200Response1> {
@@ -55,7 +55,7 @@ export interface TasksApiUpdateTaskMuteStatusRequest {
55
55
  export class TasksApi extends runtime.BaseAPI {
56
56
 
57
57
  /**
58
- * Returns task information for the seller.
58
+ * Returns task information for the seller. **API key scope required:** `TASKS_READ`. Requests authenticated with a seller session do not need any scope.
59
59
  * Get task details
60
60
  */
61
61
  async getTaskRaw(requestParameters: TasksApiGetTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDetailsDto>> {
@@ -70,6 +70,10 @@ export class TasksApi extends runtime.BaseAPI {
70
70
 
71
71
  const headerParameters: runtime.HTTPHeaders = {};
72
72
 
73
+ if (this.configuration && this.configuration.apiKey) {
74
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
75
+ }
76
+
73
77
  if (this.configuration && this.configuration.accessToken) {
74
78
  const token = this.configuration.accessToken;
75
79
  const tokenString = await token("bearer", []);
@@ -89,7 +93,7 @@ export class TasksApi extends runtime.BaseAPI {
89
93
  }
90
94
 
91
95
  /**
92
- * Returns task information for the seller.
96
+ * Returns task information for the seller. **API key scope required:** `TASKS_READ`. Requests authenticated with a seller session do not need any scope.
93
97
  * Get task details
94
98
  */
95
99
  async getTask(requestParameters: TasksApiGetTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDetailsDto> {
@@ -98,7 +102,7 @@ export class TasksApi extends runtime.BaseAPI {
98
102
  }
99
103
 
100
104
  /**
101
- * Lists tasks for the seller account.
105
+ * Lists tasks for the seller account. **API key scope required:** `TASKS_READ`. Requests authenticated with a seller session do not need any scope.
102
106
  * List seller tasks
103
107
  */
104
108
  async listRaw(requestParameters: TasksApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<List200Response1>> {
@@ -130,6 +134,10 @@ export class TasksApi extends runtime.BaseAPI {
130
134
 
131
135
  const headerParameters: runtime.HTTPHeaders = {};
132
136
 
137
+ if (this.configuration && this.configuration.apiKey) {
138
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
139
+ }
140
+
133
141
  if (this.configuration && this.configuration.accessToken) {
134
142
  const token = this.configuration.accessToken;
135
143
  const tokenString = await token("bearer", []);
@@ -149,7 +157,7 @@ export class TasksApi extends runtime.BaseAPI {
149
157
  }
150
158
 
151
159
  /**
152
- * Lists tasks for the seller account.
160
+ * Lists tasks for the seller account. **API key scope required:** `TASKS_READ`. Requests authenticated with a seller session do not need any scope.
153
161
  * List seller tasks
154
162
  */
155
163
  async list(requestParameters: TasksApiListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<List200Response1> {
@@ -158,7 +166,7 @@ export class TasksApi extends runtime.BaseAPI {
158
166
  }
159
167
 
160
168
  /**
161
- * Mutes or unmutes task notifications for the seller.
169
+ * Mutes or unmutes task notifications for the seller. **API key scope required:** `TASKS_WRITE`. Requests authenticated with a seller session do not need any scope.
162
170
  * Update task mute status
163
171
  */
164
172
  async updateTaskMuteStatusRaw(requestParameters: TasksApiUpdateTaskMuteStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -182,6 +190,10 @@ export class TasksApi extends runtime.BaseAPI {
182
190
 
183
191
  headerParameters['Content-Type'] = 'application/json';
184
192
 
193
+ if (this.configuration && this.configuration.apiKey) {
194
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
195
+ }
196
+
185
197
  if (this.configuration && this.configuration.accessToken) {
186
198
  const token = this.configuration.accessToken;
187
199
  const tokenString = await token("bearer", []);
@@ -202,7 +214,7 @@ export class TasksApi extends runtime.BaseAPI {
202
214
  }
203
215
 
204
216
  /**
205
- * Mutes or unmutes task notifications for the seller.
217
+ * Mutes or unmutes task notifications for the seller. **API key scope required:** `TASKS_WRITE`. Requests authenticated with a seller session do not need any scope.
206
218
  * Update task mute status
207
219
  */
208
220
  async updateTaskMuteStatus(requestParameters: TasksApiUpdateTaskMuteStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -59,7 +59,7 @@ export interface UsersApiUpdateUserNotificationSettingsRequest {
59
59
  export class UsersApi extends runtime.BaseAPI {
60
60
 
61
61
  /**
62
- * Changes the seller user email after validating the OTP sent to the new address.
62
+ * Changes the seller user email after validating the OTP sent to the new address. **API key scope required:** `USER_EMAIL_WRITE`. Requests authenticated with a seller session do not need any scope.
63
63
  * Change user email with OTP
64
64
  */
65
65
  async changeUserEmailWithOtpRaw(requestParameters: UsersApiChangeUserEmailWithOtpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -76,6 +76,10 @@ export class UsersApi extends runtime.BaseAPI {
76
76
 
77
77
  headerParameters['Content-Type'] = 'application/json';
78
78
 
79
+ if (this.configuration && this.configuration.apiKey) {
80
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
81
+ }
82
+
79
83
  if (this.configuration && this.configuration.accessToken) {
80
84
  const token = this.configuration.accessToken;
81
85
  const tokenString = await token("bearer", []);
@@ -96,7 +100,7 @@ export class UsersApi extends runtime.BaseAPI {
96
100
  }
97
101
 
98
102
  /**
99
- * Changes the seller user email after validating the OTP sent to the new address.
103
+ * Changes the seller user email after validating the OTP sent to the new address. **API key scope required:** `USER_EMAIL_WRITE`. Requests authenticated with a seller session do not need any scope.
100
104
  * Change user email with OTP
101
105
  */
102
106
  async changeUserEmailWithOtp(requestParameters: UsersApiChangeUserEmailWithOtpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -104,7 +108,7 @@ export class UsersApi extends runtime.BaseAPI {
104
108
  }
105
109
 
106
110
  /**
107
- * Returns the notification preferences configured for the seller user.
111
+ * Returns the notification preferences configured for the seller user. **API key scope required:** `USERS_READ`. Requests authenticated with a seller session do not need any scope.
108
112
  * Get user notification settings
109
113
  */
110
114
  async getUserNotificationSettingsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserNotificationSettingsDto>> {
@@ -112,6 +116,10 @@ export class UsersApi extends runtime.BaseAPI {
112
116
 
113
117
  const headerParameters: runtime.HTTPHeaders = {};
114
118
 
119
+ if (this.configuration && this.configuration.apiKey) {
120
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
121
+ }
122
+
115
123
  if (this.configuration && this.configuration.accessToken) {
116
124
  const token = this.configuration.accessToken;
117
125
  const tokenString = await token("bearer", []);
@@ -131,7 +139,7 @@ export class UsersApi extends runtime.BaseAPI {
131
139
  }
132
140
 
133
141
  /**
134
- * Returns the notification preferences configured for the seller user.
142
+ * Returns the notification preferences configured for the seller user. **API key scope required:** `USERS_READ`. Requests authenticated with a seller session do not need any scope.
135
143
  * Get user notification settings
136
144
  */
137
145
  async getUserNotificationSettings(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserNotificationSettingsDto> {
@@ -140,7 +148,7 @@ export class UsersApi extends runtime.BaseAPI {
140
148
  }
141
149
 
142
150
  /**
143
- * Sends a one-time password to the new email address to verify ownership before changing the account email.
151
+ * Sends a one-time password to the new email address to verify ownership before changing the account email. **API key scope required:** `USER_EMAIL_WRITE`. Requests authenticated with a seller session do not need any scope.
144
152
  * Request email change OTP
145
153
  */
146
154
  async requestUserEmailChangeOtpRaw(requestParameters: UsersApiRequestUserEmailChangeOtpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -157,6 +165,10 @@ export class UsersApi extends runtime.BaseAPI {
157
165
 
158
166
  headerParameters['Content-Type'] = 'application/json';
159
167
 
168
+ if (this.configuration && this.configuration.apiKey) {
169
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
170
+ }
171
+
160
172
  if (this.configuration && this.configuration.accessToken) {
161
173
  const token = this.configuration.accessToken;
162
174
  const tokenString = await token("bearer", []);
@@ -177,7 +189,7 @@ export class UsersApi extends runtime.BaseAPI {
177
189
  }
178
190
 
179
191
  /**
180
- * Sends a one-time password to the new email address to verify ownership before changing the account email.
192
+ * Sends a one-time password to the new email address to verify ownership before changing the account email. **API key scope required:** `USER_EMAIL_WRITE`. Requests authenticated with a seller session do not need any scope.
181
193
  * Request email change OTP
182
194
  */
183
195
  async requestUserEmailChangeOtp(requestParameters: UsersApiRequestUserEmailChangeOtpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -185,7 +197,7 @@ export class UsersApi extends runtime.BaseAPI {
185
197
  }
186
198
 
187
199
  /**
188
- * Persists the seller user locale used for notifications and UI content.
200
+ * Persists the seller user locale used for notifications and UI content. **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
189
201
  * Store user locale preference
190
202
  */
191
203
  async setLocaleRaw(requestParameters: UsersApiSetLocaleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -202,6 +214,10 @@ export class UsersApi extends runtime.BaseAPI {
202
214
 
203
215
  headerParameters['Content-Type'] = 'application/json';
204
216
 
217
+ if (this.configuration && this.configuration.apiKey) {
218
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
219
+ }
220
+
205
221
  if (this.configuration && this.configuration.accessToken) {
206
222
  const token = this.configuration.accessToken;
207
223
  const tokenString = await token("bearer", []);
@@ -222,7 +238,7 @@ export class UsersApi extends runtime.BaseAPI {
222
238
  }
223
239
 
224
240
  /**
225
- * Persists the seller user locale used for notifications and UI content.
241
+ * Persists the seller user locale used for notifications and UI content. **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
226
242
  * Store user locale preference
227
243
  */
228
244
  async setLocale(requestParameters: UsersApiSetLocaleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -230,7 +246,7 @@ export class UsersApi extends runtime.BaseAPI {
230
246
  }
231
247
 
232
248
  /**
233
- * Updates one or more notification preferences for the seller user.
249
+ * Updates one or more notification preferences for the seller user. **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
234
250
  * Update user notification settings
235
251
  */
236
252
  async updateUserNotificationSettingsRaw(requestParameters: UsersApiUpdateUserNotificationSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -247,6 +263,10 @@ export class UsersApi extends runtime.BaseAPI {
247
263
 
248
264
  headerParameters['Content-Type'] = 'application/json';
249
265
 
266
+ if (this.configuration && this.configuration.apiKey) {
267
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
268
+ }
269
+
250
270
  if (this.configuration && this.configuration.accessToken) {
251
271
  const token = this.configuration.accessToken;
252
272
  const tokenString = await token("bearer", []);
@@ -267,7 +287,7 @@ export class UsersApi extends runtime.BaseAPI {
267
287
  }
268
288
 
269
289
  /**
270
- * Updates one or more notification preferences for the seller user.
290
+ * Updates one or more notification preferences for the seller user. **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
271
291
  * Update user notification settings
272
292
  */
273
293
  async updateUserNotificationSettings(requestParameters: UsersApiUpdateUserNotificationSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
package/src/apis/index.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
+ export * from './APIKeysApi';
3
4
  export * from './AccountsApi';
4
5
  export * from './AccountsPublicApi';
5
6
  export * from './AddressPublicApi';
@@ -243,6 +243,12 @@ export interface AdminDomainListItemDto {
243
243
  * @memberof AdminDomainListItemDto
244
244
  */
245
245
  lockedUntil: Date | null;
246
+ /**
247
+ * Whether an admin picked this domain for the public showcase on the website.
248
+ * @type {boolean}
249
+ * @memberof AdminDomainListItemDto
250
+ */
251
+ showcased: boolean;
246
252
  /**
247
253
  * Account that owns the domain.
248
254
  * @type {AccountDto}
@@ -305,6 +311,7 @@ export function instanceOfAdminDomainListItemDto(value: object): value is AdminD
305
311
  if (!('isDeleteable' in value) || value['isDeleteable'] === undefined) return false;
306
312
  if (!('isLocked' in value) || value['isLocked'] === undefined) return false;
307
313
  if (!('lockedUntil' in value) || value['lockedUntil'] === undefined) return false;
314
+ if (!('showcased' in value) || value['showcased'] === undefined) return false;
308
315
  if (!('account' in value) || value['account'] === undefined) return false;
309
316
  if (!('pointsToOurServerReason' in value) || value['pointsToOurServerReason'] === undefined) return false;
310
317
  return true;
@@ -349,6 +356,7 @@ export function AdminDomainListItemDtoFromJSONTyped(json: any, ignoreDiscriminat
349
356
  'isDeleteable': json['isDeleteable'],
350
357
  'isLocked': json['isLocked'],
351
358
  'lockedUntil': (json['lockedUntil'] == null ? null : new Date(json['lockedUntil'])),
359
+ 'showcased': json['showcased'],
352
360
  'account': AccountDtoFromJSON(json['account']),
353
361
  'pointsToOurServerReason': json['pointsToOurServerReason'],
354
362
  };
@@ -394,6 +402,7 @@ export function AdminDomainListItemDtoToJSONTyped(value?: AdminDomainListItemDto
394
402
  'isDeleteable': value['isDeleteable'],
395
403
  'isLocked': value['isLocked'],
396
404
  'lockedUntil': (value['lockedUntil'] == null ? null : (value['lockedUntil'] as any).toISOString()),
405
+ 'showcased': value['showcased'],
397
406
  'account': AccountDtoToJSON(value['account']),
398
407
  'pointsToOurServerReason': value['pointsToOurServerReason'],
399
408
  };