@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
@@ -55,7 +55,7 @@ export interface InvoicesApiRequestBulkDownloadInvoicesRequest {
55
55
  export class InvoicesApi extends runtime.BaseAPI {
56
56
 
57
57
  /**
58
- * Downloads the PDF document for a specific invoice owned by the seller.
58
+ * Downloads the PDF document for a specific invoice owned by the seller. **API key scope required:** `INVOICES_READ`. Requests authenticated with a seller session do not need any scope.
59
59
  * Download seller invoice
60
60
  */
61
61
  async downloadInvoiceRaw(requestParameters: InvoicesApiDownloadInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
@@ -70,6 +70,10 @@ export class InvoicesApi 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 InvoicesApi extends runtime.BaseAPI {
89
93
  }
90
94
 
91
95
  /**
92
- * Downloads the PDF document for a specific invoice owned by the seller.
96
+ * Downloads the PDF document for a specific invoice owned by the seller. **API key scope required:** `INVOICES_READ`. Requests authenticated with a seller session do not need any scope.
93
97
  * Download seller invoice
94
98
  */
95
99
  async downloadInvoice(requestParameters: InvoicesApiDownloadInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
@@ -98,7 +102,7 @@ export class InvoicesApi extends runtime.BaseAPI {
98
102
  }
99
103
 
100
104
  /**
101
- * Lists invoices for the seller account.
105
+ * Lists invoices for the seller account. **API key scope required:** `INVOICES_READ`. Requests authenticated with a seller session do not need any scope.
102
106
  * List seller invoices
103
107
  */
104
108
  async getInvoicesRaw(requestParameters: InvoicesApiGetInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetInvoices200Response>> {
@@ -134,6 +138,10 @@ export class InvoicesApi extends runtime.BaseAPI {
134
138
 
135
139
  const headerParameters: runtime.HTTPHeaders = {};
136
140
 
141
+ if (this.configuration && this.configuration.apiKey) {
142
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
143
+ }
144
+
137
145
  if (this.configuration && this.configuration.accessToken) {
138
146
  const token = this.configuration.accessToken;
139
147
  const tokenString = await token("bearer", []);
@@ -153,7 +161,7 @@ export class InvoicesApi extends runtime.BaseAPI {
153
161
  }
154
162
 
155
163
  /**
156
- * Lists invoices for the seller account.
164
+ * Lists invoices for the seller account. **API key scope required:** `INVOICES_READ`. Requests authenticated with a seller session do not need any scope.
157
165
  * List seller invoices
158
166
  */
159
167
  async getInvoices(requestParameters: InvoicesApiGetInvoicesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetInvoices200Response> {
@@ -162,7 +170,7 @@ export class InvoicesApi extends runtime.BaseAPI {
162
170
  }
163
171
 
164
172
  /**
165
- * Queues a bulk download of seller invoices within the specified date range. The download link is sent via email.
173
+ * Queues a bulk download of seller invoices within the specified date range. The download link is sent via email. **API key scope required:** `INVOICES_READ`. Requests authenticated with a seller session do not need any scope.
166
174
  * Request bulk invoice download
167
175
  */
168
176
  async requestBulkDownloadInvoicesRaw(requestParameters: InvoicesApiRequestBulkDownloadInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -179,6 +187,10 @@ export class InvoicesApi extends runtime.BaseAPI {
179
187
 
180
188
  headerParameters['Content-Type'] = 'application/json';
181
189
 
190
+ if (this.configuration && this.configuration.apiKey) {
191
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
192
+ }
193
+
182
194
  if (this.configuration && this.configuration.accessToken) {
183
195
  const token = this.configuration.accessToken;
184
196
  const tokenString = await token("bearer", []);
@@ -199,7 +211,7 @@ export class InvoicesApi extends runtime.BaseAPI {
199
211
  }
200
212
 
201
213
  /**
202
- * Queues a bulk download of seller invoices within the specified date range. The download link is sent via email.
214
+ * Queues a bulk download of seller invoices within the specified date range. The download link is sent via email. **API key scope required:** `INVOICES_READ`. Requests authenticated with a seller session do not need any scope.
203
215
  * Request bulk invoice download
204
216
  */
205
217
  async requestBulkDownloadInvoices(requestParameters: InvoicesApiRequestBulkDownloadInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -162,7 +162,7 @@ export interface LeadsApiUpdateLeadOfferExpirationConfigurationRequest {
162
162
  export class LeadsApi extends runtime.BaseAPI {
163
163
 
164
164
  /**
165
- * Accepts the current buyer offer on the lead and advances the negotiation.
165
+ * Accepts the current buyer offer on the lead and advances the negotiation. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
166
166
  * Accept the buyer offer
167
167
  */
168
168
  async acceptLeadOfferRaw(requestParameters: LeadsApiAcceptLeadOfferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -177,6 +177,10 @@ export class LeadsApi extends runtime.BaseAPI {
177
177
 
178
178
  const headerParameters: runtime.HTTPHeaders = {};
179
179
 
180
+ if (this.configuration && this.configuration.apiKey) {
181
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
182
+ }
183
+
180
184
  if (this.configuration && this.configuration.accessToken) {
181
185
  const token = this.configuration.accessToken;
182
186
  const tokenString = await token("bearer", []);
@@ -196,7 +200,7 @@ export class LeadsApi extends runtime.BaseAPI {
196
200
  }
197
201
 
198
202
  /**
199
- * Accepts the current buyer offer on the lead and advances the negotiation.
203
+ * Accepts the current buyer offer on the lead and advances the negotiation. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
200
204
  * Accept the buyer offer
201
205
  */
202
206
  async acceptLeadOffer(requestParameters: LeadsApiAcceptLeadOfferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -204,7 +208,7 @@ export class LeadsApi extends runtime.BaseAPI {
204
208
  }
205
209
 
206
210
  /**
207
- * Archives the lead for the seller, hiding it from the active leads list.
211
+ * Archives the lead for the seller, hiding it from the active leads list. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
208
212
  * Archive a lead
209
213
  */
210
214
  async archiveLeadRaw(requestParameters: LeadsApiArchiveLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -219,6 +223,10 @@ export class LeadsApi extends runtime.BaseAPI {
219
223
 
220
224
  const headerParameters: runtime.HTTPHeaders = {};
221
225
 
226
+ if (this.configuration && this.configuration.apiKey) {
227
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
228
+ }
229
+
222
230
  if (this.configuration && this.configuration.accessToken) {
223
231
  const token = this.configuration.accessToken;
224
232
  const tokenString = await token("bearer", []);
@@ -238,7 +246,7 @@ export class LeadsApi extends runtime.BaseAPI {
238
246
  }
239
247
 
240
248
  /**
241
- * Archives the lead for the seller, hiding it from the active leads list.
249
+ * Archives the lead for the seller, hiding it from the active leads list. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
242
250
  * Archive a lead
243
251
  */
244
252
  async archiveLead(requestParameters: LeadsApiArchiveLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -246,7 +254,7 @@ export class LeadsApi extends runtime.BaseAPI {
246
254
  }
247
255
 
248
256
  /**
249
- * Marks multiple lead messages as read for the seller account.
257
+ * Marks multiple lead messages as read for the seller account. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
250
258
  * Mark lead messages as read
251
259
  */
252
260
  async bulkReadSellerLeadMessageRaw(requestParameters: LeadsApiBulkReadSellerLeadMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -270,6 +278,10 @@ export class LeadsApi extends runtime.BaseAPI {
270
278
 
271
279
  headerParameters['Content-Type'] = 'application/json';
272
280
 
281
+ if (this.configuration && this.configuration.apiKey) {
282
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
283
+ }
284
+
273
285
  if (this.configuration && this.configuration.accessToken) {
274
286
  const token = this.configuration.accessToken;
275
287
  const tokenString = await token("bearer", []);
@@ -290,7 +302,7 @@ export class LeadsApi extends runtime.BaseAPI {
290
302
  }
291
303
 
292
304
  /**
293
- * Marks multiple lead messages as read for the seller account.
305
+ * Marks multiple lead messages as read for the seller account. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
294
306
  * Mark lead messages as read
295
307
  */
296
308
  async bulkReadSellerLeadMessage(requestParameters: LeadsApiBulkReadSellerLeadMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -298,7 +310,7 @@ export class LeadsApi extends runtime.BaseAPI {
298
310
  }
299
311
 
300
312
  /**
301
- * Closes an active lead negotiation. Cannot close a lead accepted too recently.
313
+ * Closes an active lead negotiation. Cannot close a lead accepted too recently. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
302
314
  * Close an active lead
303
315
  */
304
316
  async closeLeadRaw(requestParameters: LeadsApiCloseLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -313,6 +325,10 @@ export class LeadsApi extends runtime.BaseAPI {
313
325
 
314
326
  const headerParameters: runtime.HTTPHeaders = {};
315
327
 
328
+ if (this.configuration && this.configuration.apiKey) {
329
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
330
+ }
331
+
316
332
  if (this.configuration && this.configuration.accessToken) {
317
333
  const token = this.configuration.accessToken;
318
334
  const tokenString = await token("bearer", []);
@@ -332,7 +348,7 @@ export class LeadsApi extends runtime.BaseAPI {
332
348
  }
333
349
 
334
350
  /**
335
- * Closes an active lead negotiation. Cannot close a lead accepted too recently.
351
+ * Closes an active lead negotiation. Cannot close a lead accepted too recently. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
336
352
  * Close an active lead
337
353
  */
338
354
  async closeLead(requestParameters: LeadsApiCloseLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -340,7 +356,7 @@ export class LeadsApi extends runtime.BaseAPI {
340
356
  }
341
357
 
342
358
  /**
343
- * Creates a lead manually on behalf of a buyer for a domain in the seller account.
359
+ * Creates a lead manually on behalf of a buyer for a domain in the seller account. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
344
360
  * Create a manual lead
345
361
  */
346
362
  async createManualLeadRaw(requestParameters: LeadsApiCreateManualLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -357,6 +373,10 @@ export class LeadsApi extends runtime.BaseAPI {
357
373
 
358
374
  headerParameters['Content-Type'] = 'application/json';
359
375
 
376
+ if (this.configuration && this.configuration.apiKey) {
377
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
378
+ }
379
+
360
380
  if (this.configuration && this.configuration.accessToken) {
361
381
  const token = this.configuration.accessToken;
362
382
  const tokenString = await token("bearer", []);
@@ -377,7 +397,7 @@ export class LeadsApi extends runtime.BaseAPI {
377
397
  }
378
398
 
379
399
  /**
380
- * Creates a lead manually on behalf of a buyer for a domain in the seller account.
400
+ * Creates a lead manually on behalf of a buyer for a domain in the seller account. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
381
401
  * Create a manual lead
382
402
  */
383
403
  async createManualLead(requestParameters: LeadsApiCreateManualLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -385,7 +405,7 @@ export class LeadsApi extends runtime.BaseAPI {
385
405
  }
386
406
 
387
407
  /**
388
- * Sends a message from the seller in the lead conversation thread.
408
+ * Sends a message from the seller in the lead conversation thread. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
389
409
  * Create a lead message
390
410
  */
391
411
  async createMessageRaw(requestParameters: LeadsApiCreateMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ObjectId>> {
@@ -409,6 +429,10 @@ export class LeadsApi extends runtime.BaseAPI {
409
429
 
410
430
  headerParameters['Content-Type'] = 'application/json';
411
431
 
432
+ if (this.configuration && this.configuration.apiKey) {
433
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
434
+ }
435
+
412
436
  if (this.configuration && this.configuration.accessToken) {
413
437
  const token = this.configuration.accessToken;
414
438
  const tokenString = await token("bearer", []);
@@ -429,7 +453,7 @@ export class LeadsApi extends runtime.BaseAPI {
429
453
  }
430
454
 
431
455
  /**
432
- * Sends a message from the seller in the lead conversation thread.
456
+ * Sends a message from the seller in the lead conversation thread. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
433
457
  * Create a lead message
434
458
  */
435
459
  async createMessage(requestParameters: LeadsApiCreateMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectId> {
@@ -438,7 +462,7 @@ export class LeadsApi extends runtime.BaseAPI {
438
462
  }
439
463
 
440
464
  /**
441
- * Returns lead information. Requires account ownership.
465
+ * Returns lead information. Requires account ownership. **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
442
466
  * Get lead details
443
467
  */
444
468
  async getLeadRaw(requestParameters: LeadsApiGetLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SellerLeadDetails>> {
@@ -453,6 +477,10 @@ export class LeadsApi extends runtime.BaseAPI {
453
477
 
454
478
  const headerParameters: runtime.HTTPHeaders = {};
455
479
 
480
+ if (this.configuration && this.configuration.apiKey) {
481
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
482
+ }
483
+
456
484
  if (this.configuration && this.configuration.accessToken) {
457
485
  const token = this.configuration.accessToken;
458
486
  const tokenString = await token("bearer", []);
@@ -472,7 +500,7 @@ export class LeadsApi extends runtime.BaseAPI {
472
500
  }
473
501
 
474
502
  /**
475
- * Returns lead information. Requires account ownership.
503
+ * Returns lead information. Requires account ownership. **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
476
504
  * Get lead details
477
505
  */
478
506
  async getLead(requestParameters: LeadsApiGetLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SellerLeadDetails> {
@@ -481,7 +509,7 @@ export class LeadsApi extends runtime.BaseAPI {
481
509
  }
482
510
 
483
511
  /**
484
- * Returns configuration presets for lead offers.
512
+ * Returns configuration presets for lead offers. **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
485
513
  * Get lease-to-own configuration presets
486
514
  */
487
515
  async getLeadLeaseToOwnConfigurationPresetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LeadLeaseToOwnAndRentConfigurationPresetsDto>> {
@@ -489,6 +517,10 @@ export class LeadsApi extends runtime.BaseAPI {
489
517
 
490
518
  const headerParameters: runtime.HTTPHeaders = {};
491
519
 
520
+ if (this.configuration && this.configuration.apiKey) {
521
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
522
+ }
523
+
492
524
  if (this.configuration && this.configuration.accessToken) {
493
525
  const token = this.configuration.accessToken;
494
526
  const tokenString = await token("bearer", []);
@@ -508,7 +540,7 @@ export class LeadsApi extends runtime.BaseAPI {
508
540
  }
509
541
 
510
542
  /**
511
- * Returns configuration presets for lead offers.
543
+ * Returns configuration presets for lead offers. **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
512
544
  * Get lease-to-own configuration presets
513
545
  */
514
546
  async getLeadLeaseToOwnConfigurationPresets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LeadLeaseToOwnAndRentConfigurationPresetsDto> {
@@ -517,7 +549,7 @@ export class LeadsApi extends runtime.BaseAPI {
517
549
  }
518
550
 
519
551
  /**
520
- * Returns manual lead information. Requires account ownership.
552
+ * Returns manual lead information. Requires account ownership. **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
521
553
  * Get manual lead details
522
554
  */
523
555
  async getManualLeadRaw(requestParameters: LeadsApiGetManualLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntersectionLeadDtoWithLeadDetailsDtoWithManualLeadBuyerDetailsDto>> {
@@ -532,6 +564,10 @@ export class LeadsApi extends runtime.BaseAPI {
532
564
 
533
565
  const headerParameters: runtime.HTTPHeaders = {};
534
566
 
567
+ if (this.configuration && this.configuration.apiKey) {
568
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
569
+ }
570
+
535
571
  if (this.configuration && this.configuration.accessToken) {
536
572
  const token = this.configuration.accessToken;
537
573
  const tokenString = await token("bearer", []);
@@ -551,7 +587,7 @@ export class LeadsApi extends runtime.BaseAPI {
551
587
  }
552
588
 
553
589
  /**
554
- * Returns manual lead information. Requires account ownership.
590
+ * Returns manual lead information. Requires account ownership. **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
555
591
  * Get manual lead details
556
592
  */
557
593
  async getManualLead(requestParameters: LeadsApiGetManualLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntersectionLeadDtoWithLeadDetailsDtoWithManualLeadBuyerDetailsDto> {
@@ -560,7 +596,7 @@ export class LeadsApi extends runtime.BaseAPI {
560
596
  }
561
597
 
562
598
  /**
563
- * Lists messages in the lead conversation. Requires account ownership.
599
+ * Lists messages in the lead conversation. Requires account ownership. **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
564
600
  * List lead messages
565
601
  */
566
602
  async getMessagesRaw(requestParameters: LeadsApiGetMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListLeadMessagesDto>> {
@@ -575,6 +611,10 @@ export class LeadsApi extends runtime.BaseAPI {
575
611
 
576
612
  const headerParameters: runtime.HTTPHeaders = {};
577
613
 
614
+ if (this.configuration && this.configuration.apiKey) {
615
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
616
+ }
617
+
578
618
  if (this.configuration && this.configuration.accessToken) {
579
619
  const token = this.configuration.accessToken;
580
620
  const tokenString = await token("bearer", []);
@@ -594,7 +634,7 @@ export class LeadsApi extends runtime.BaseAPI {
594
634
  }
595
635
 
596
636
  /**
597
- * Lists messages in the lead conversation. Requires account ownership.
637
+ * Lists messages in the lead conversation. Requires account ownership. **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
598
638
  * List lead messages
599
639
  */
600
640
  async getMessages(requestParameters: LeadsApiGetMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListLeadMessagesDto> {
@@ -603,7 +643,7 @@ export class LeadsApi extends runtime.BaseAPI {
603
643
  }
604
644
 
605
645
  /**
606
- * Lists leads for the seller account.
646
+ * Lists leads for the seller account. **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
607
647
  * List seller leads
608
648
  */
609
649
  async listRaw(requestParameters: LeadsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<List200Response>> {
@@ -639,6 +679,10 @@ export class LeadsApi extends runtime.BaseAPI {
639
679
 
640
680
  const headerParameters: runtime.HTTPHeaders = {};
641
681
 
682
+ if (this.configuration && this.configuration.apiKey) {
683
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
684
+ }
685
+
642
686
  if (this.configuration && this.configuration.accessToken) {
643
687
  const token = this.configuration.accessToken;
644
688
  const tokenString = await token("bearer", []);
@@ -658,7 +702,7 @@ export class LeadsApi extends runtime.BaseAPI {
658
702
  }
659
703
 
660
704
  /**
661
- * Lists leads for the seller account.
705
+ * Lists leads for the seller account. **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
662
706
  * List seller leads
663
707
  */
664
708
  async list(requestParameters: LeadsApiListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<List200Response> {
@@ -667,7 +711,7 @@ export class LeadsApi extends runtime.BaseAPI {
667
711
  }
668
712
 
669
713
  /**
670
- * Lists leads related to the specified lead.
714
+ * Lists leads related to the specified lead. **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
671
715
  * List related leads
672
716
  */
673
717
  async listRelatedLeadsRaw(requestParameters: LeadsApiListRelatedLeadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListRelatedLeads200Response>> {
@@ -702,6 +746,10 @@ export class LeadsApi extends runtime.BaseAPI {
702
746
 
703
747
  const headerParameters: runtime.HTTPHeaders = {};
704
748
 
749
+ if (this.configuration && this.configuration.apiKey) {
750
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
751
+ }
752
+
705
753
  if (this.configuration && this.configuration.accessToken) {
706
754
  const token = this.configuration.accessToken;
707
755
  const tokenString = await token("bearer", []);
@@ -721,7 +769,7 @@ export class LeadsApi extends runtime.BaseAPI {
721
769
  }
722
770
 
723
771
  /**
724
- * Lists leads related to the specified lead.
772
+ * Lists leads related to the specified lead. **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
725
773
  * List related leads
726
774
  */
727
775
  async listRelatedLeads(requestParameters: LeadsApiListRelatedLeadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListRelatedLeads200Response> {
@@ -730,7 +778,7 @@ export class LeadsApi extends runtime.BaseAPI {
730
778
  }
731
779
 
732
780
  /**
733
- * Pauses the AI price negotiator agent for the lead.
781
+ * Pauses the AI price negotiator agent for the lead. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
734
782
  * Pause AI price negotiator
735
783
  */
736
784
  async pauseLeadPriceNegotiatorAgentRaw(requestParameters: LeadsApiPauseLeadPriceNegotiatorAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -745,6 +793,10 @@ export class LeadsApi extends runtime.BaseAPI {
745
793
 
746
794
  const headerParameters: runtime.HTTPHeaders = {};
747
795
 
796
+ if (this.configuration && this.configuration.apiKey) {
797
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
798
+ }
799
+
748
800
  if (this.configuration && this.configuration.accessToken) {
749
801
  const token = this.configuration.accessToken;
750
802
  const tokenString = await token("bearer", []);
@@ -764,7 +816,7 @@ export class LeadsApi extends runtime.BaseAPI {
764
816
  }
765
817
 
766
818
  /**
767
- * Pauses the AI price negotiator agent for the lead.
819
+ * Pauses the AI price negotiator agent for the lead. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
768
820
  * Pause AI price negotiator
769
821
  */
770
822
  async pauseLeadPriceNegotiatorAgent(requestParameters: LeadsApiPauseLeadPriceNegotiatorAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -772,7 +824,7 @@ export class LeadsApi extends runtime.BaseAPI {
772
824
  }
773
825
 
774
826
  /**
775
- * Sets or updates the seller counter-offer on a lead.
827
+ * Sets or updates the seller counter-offer on a lead. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
776
828
  * Submit a seller counter-offer
777
829
  */
778
830
  async putOfferRaw(requestParameters: LeadsApiPutOfferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -796,6 +848,10 @@ export class LeadsApi extends runtime.BaseAPI {
796
848
 
797
849
  headerParameters['Content-Type'] = 'application/json';
798
850
 
851
+ if (this.configuration && this.configuration.apiKey) {
852
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
853
+ }
854
+
799
855
  if (this.configuration && this.configuration.accessToken) {
800
856
  const token = this.configuration.accessToken;
801
857
  const tokenString = await token("bearer", []);
@@ -816,7 +872,7 @@ export class LeadsApi extends runtime.BaseAPI {
816
872
  }
817
873
 
818
874
  /**
819
- * Sets or updates the seller counter-offer on a lead.
875
+ * Sets or updates the seller counter-offer on a lead. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
820
876
  * Submit a seller counter-offer
821
877
  */
822
878
  async putOffer(requestParameters: LeadsApiPutOfferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -824,7 +880,7 @@ export class LeadsApi extends runtime.BaseAPI {
824
880
  }
825
881
 
826
882
  /**
827
- * Resumes a paused AI price negotiator agent for the lead.
883
+ * Resumes a paused AI price negotiator agent for the lead. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
828
884
  * Resume AI price negotiator
829
885
  */
830
886
  async resumeLeadPriceNegotiatorAgentRaw(requestParameters: LeadsApiResumeLeadPriceNegotiatorAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -839,6 +895,10 @@ export class LeadsApi extends runtime.BaseAPI {
839
895
 
840
896
  const headerParameters: runtime.HTTPHeaders = {};
841
897
 
898
+ if (this.configuration && this.configuration.apiKey) {
899
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
900
+ }
901
+
842
902
  if (this.configuration && this.configuration.accessToken) {
843
903
  const token = this.configuration.accessToken;
844
904
  const tokenString = await token("bearer", []);
@@ -858,7 +918,7 @@ export class LeadsApi extends runtime.BaseAPI {
858
918
  }
859
919
 
860
920
  /**
861
- * Resumes a paused AI price negotiator agent for the lead.
921
+ * Resumes a paused AI price negotiator agent for the lead. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
862
922
  * Resume AI price negotiator
863
923
  */
864
924
  async resumeLeadPriceNegotiatorAgent(requestParameters: LeadsApiResumeLeadPriceNegotiatorAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -866,7 +926,7 @@ export class LeadsApi extends runtime.BaseAPI {
866
926
  }
867
927
 
868
928
  /**
869
- * Restores a previously archived lead to the seller active leads list.
929
+ * Restores a previously archived lead to the seller active leads list. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
870
930
  * Unarchive a lead
871
931
  */
872
932
  async unarchiveLeadRaw(requestParameters: LeadsApiUnarchiveLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -881,6 +941,10 @@ export class LeadsApi extends runtime.BaseAPI {
881
941
 
882
942
  const headerParameters: runtime.HTTPHeaders = {};
883
943
 
944
+ if (this.configuration && this.configuration.apiKey) {
945
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
946
+ }
947
+
884
948
  if (this.configuration && this.configuration.accessToken) {
885
949
  const token = this.configuration.accessToken;
886
950
  const tokenString = await token("bearer", []);
@@ -900,7 +964,7 @@ export class LeadsApi extends runtime.BaseAPI {
900
964
  }
901
965
 
902
966
  /**
903
- * Restores a previously archived lead to the seller active leads list.
967
+ * Restores a previously archived lead to the seller active leads list. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
904
968
  * Unarchive a lead
905
969
  */
906
970
  async unarchiveLead(requestParameters: LeadsApiUnarchiveLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -908,7 +972,7 @@ export class LeadsApi extends runtime.BaseAPI {
908
972
  }
909
973
 
910
974
  /**
911
- * Updates the domain lock settings applied while the lead is active.
975
+ * Updates the domain lock settings applied while the lead is active. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
912
976
  * Update domain lock configuration
913
977
  */
914
978
  async updateLeadDomainLockConfigurationRaw(requestParameters: LeadsApiUpdateLeadDomainLockConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -932,6 +996,10 @@ export class LeadsApi extends runtime.BaseAPI {
932
996
 
933
997
  headerParameters['Content-Type'] = 'application/json';
934
998
 
999
+ if (this.configuration && this.configuration.apiKey) {
1000
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
1001
+ }
1002
+
935
1003
  if (this.configuration && this.configuration.accessToken) {
936
1004
  const token = this.configuration.accessToken;
937
1005
  const tokenString = await token("bearer", []);
@@ -952,7 +1020,7 @@ export class LeadsApi extends runtime.BaseAPI {
952
1020
  }
953
1021
 
954
1022
  /**
955
- * Updates the domain lock settings applied while the lead is active.
1023
+ * Updates the domain lock settings applied while the lead is active. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
956
1024
  * Update domain lock configuration
957
1025
  */
958
1026
  async updateLeadDomainLockConfiguration(requestParameters: LeadsApiUpdateLeadDomainLockConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -960,7 +1028,7 @@ export class LeadsApi extends runtime.BaseAPI {
960
1028
  }
961
1029
 
962
1030
  /**
963
- * Updates whether the lead is muted for the seller user.
1031
+ * Updates whether the lead is muted for the seller user. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
964
1032
  * Mute or unmute a lead
965
1033
  */
966
1034
  async updateLeadMuteStatusRaw(requestParameters: LeadsApiUpdateLeadMuteStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -984,6 +1052,10 @@ export class LeadsApi extends runtime.BaseAPI {
984
1052
 
985
1053
  headerParameters['Content-Type'] = 'application/json';
986
1054
 
1055
+ if (this.configuration && this.configuration.apiKey) {
1056
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
1057
+ }
1058
+
987
1059
  if (this.configuration && this.configuration.accessToken) {
988
1060
  const token = this.configuration.accessToken;
989
1061
  const tokenString = await token("bearer", []);
@@ -1004,7 +1076,7 @@ export class LeadsApi extends runtime.BaseAPI {
1004
1076
  }
1005
1077
 
1006
1078
  /**
1007
- * Updates whether the lead is muted for the seller user.
1079
+ * Updates whether the lead is muted for the seller user. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
1008
1080
  * Mute or unmute a lead
1009
1081
  */
1010
1082
  async updateLeadMuteStatus(requestParameters: LeadsApiUpdateLeadMuteStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -1012,7 +1084,7 @@ export class LeadsApi extends runtime.BaseAPI {
1012
1084
  }
1013
1085
 
1014
1086
  /**
1015
- * Updates when unanswered offers on the lead automatically expire.
1087
+ * Updates when unanswered offers on the lead automatically expire. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
1016
1088
  * Update offer expiration configuration
1017
1089
  */
1018
1090
  async updateLeadOfferExpirationConfigurationRaw(requestParameters: LeadsApiUpdateLeadOfferExpirationConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -1036,6 +1108,10 @@ export class LeadsApi extends runtime.BaseAPI {
1036
1108
 
1037
1109
  headerParameters['Content-Type'] = 'application/json';
1038
1110
 
1111
+ if (this.configuration && this.configuration.apiKey) {
1112
+ headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
1113
+ }
1114
+
1039
1115
  if (this.configuration && this.configuration.accessToken) {
1040
1116
  const token = this.configuration.accessToken;
1041
1117
  const tokenString = await token("bearer", []);
@@ -1056,7 +1132,7 @@ export class LeadsApi extends runtime.BaseAPI {
1056
1132
  }
1057
1133
 
1058
1134
  /**
1059
- * Updates when unanswered offers on the lead automatically expire.
1135
+ * Updates when unanswered offers on the lead automatically expire. **API key scope required:** `LEADS_WRITE`. Requests authenticated with a seller session do not need any scope.
1060
1136
  * Update offer expiration configuration
1061
1137
  */
1062
1138
  async updateLeadOfferExpirationConfiguration(requestParameters: LeadsApiUpdateLeadOfferExpirationConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -126,7 +126,7 @@ export class MarketApi extends runtime.BaseAPI {
126
126
  }
127
127
 
128
128
  /**
129
- * Returns a showcase of listed domains: the public catalogue in its default ranking (domain authority).
129
+ * Returns the domains an admin picked for the showcase, most recently picked first. Sold and deleted domains are left out; an empty array means nothing is picked.
130
130
  * List showcase domains
131
131
  */
132
132
  async listShowcaseDomainsRaw(requestParameters: MarketApiListShowcaseDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<PublicDomainDto>>> {
@@ -153,7 +153,7 @@ export class MarketApi extends runtime.BaseAPI {
153
153
  }
154
154
 
155
155
  /**
156
- * Returns a showcase of listed domains: the public catalogue in its default ranking (domain authority).
156
+ * Returns the domains an admin picked for the showcase, most recently picked first. Sold and deleted domains are left out; an empty array means nothing is picked.
157
157
  * List showcase domains
158
158
  */
159
159
  async listShowcaseDomains(requestParameters: MarketApiListShowcaseDomainsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<PublicDomainDto>> {