@randock/nameshift-api-client 0.0.447 → 0.0.449

package/dist/apis/EppApi.d.ts

@@ -19,12 +19,12 @@ export interface EppApiEppBatchUpdateDomainsRequest {
  */
 export declare class EppApi extends runtime.BaseAPI {
     /**
-     * Queues a batch EPP update to configure DNSSEC and/or nameservers for domains at a registry.
+     * Queues a batch EPP update to configure DNSSEC and/or nameservers for domains at a registry.  **API key scope required:** `EPP_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Batch update domains via EPP
      */
     eppBatchUpdateDomainsRaw(requestParameters: EppApiEppBatchUpdateDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Queues a batch EPP update to configure DNSSEC and/or nameservers for domains at a registry.
+     * Queues a batch EPP update to configure DNSSEC and/or nameservers for domains at a registry.  **API key scope required:** `EPP_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Batch update domains via EPP
      */
     eppBatchUpdateDomains(requestParameters: EppApiEppBatchUpdateDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;

package/dist/apis/EppApi.js

@@ -76,14 +76,14 @@ var EppApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     * Queues a batch EPP update to configure DNSSEC and/or nameservers for domains at a registry.
+     * Queues a batch EPP update to configure DNSSEC and/or nameservers for domains at a registry.  **API key scope required:** `EPP_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Batch update domains via EPP
      */
     EppApi.prototype.eppBatchUpdateDomainsRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
-            var queryParameters, headerParameters, token, tokenString, response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var queryParameters, headerParameters, _a, _b, token, tokenString, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
                         if (requestParameters['eppBatchUpdateInput'] == null) {
                             throw new runtime.RequiredError('eppBatchUpdateInput', 'Required parameter "eppBatchUpdateInput" was null or undefined when calling eppBatchUpdateDomains().');
@@ -91,31 +91,39 @@ var EppApi = /** @class */ (function (_super) {
                         queryParameters = {};
                         headerParameters = {};
                         headerParameters['Content-Type'] = 'application/json';
-                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
+                        _a = headerParameters;
+                        _b = "apikey";
+                        return [4 /*yield*/, this.configuration.apiKey("apikey")];
+                    case 1:
+                        _a[_b] = _c.sent(); // api_key authentication
+                        _c.label = 2;
+                    case 2:
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
                         token = this.configuration.accessToken;
                         return [4 /*yield*/, token("bearer", [])];
-                    case 1:
-                        tokenString = _a.sent();
+                    case 3:
+                        tokenString = _c.sent();
                         if (tokenString) {
                             headerParameters["Authorization"] = "Bearer ".concat(tokenString);
                         }
-                        _a.label = 2;
-                    case 2: return [4 /*yield*/, this.request({
+                        _c.label = 4;
+                    case 4: return [4 /*yield*/, this.request({
                             path: "/private/epp",
                             method: 'POST',
                             headers: headerParameters,
                             query: queryParameters,
                             body: (0, index_1.EppBatchUpdateInputToJSON)(requestParameters['eppBatchUpdateInput']),
                         }, initOverrides)];
-                    case 3:
-                        response = _a.sent();
+                    case 5:
+                        response = _c.sent();
                         return [2 /*return*/, new runtime.VoidApiResponse(response)];
                 }
             });
         });
     };
     /**
-     * Queues a batch EPP update to configure DNSSEC and/or nameservers for domains at a registry.
+     * Queues a batch EPP update to configure DNSSEC and/or nameservers for domains at a registry.  **API key scope required:** `EPP_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Batch update domains via EPP
      */
     EppApi.prototype.eppBatchUpdateDomains = function (requestParameters, initOverrides) {

package/dist/apis/InvoicesApi.d.ts

@@ -33,32 +33,32 @@ export interface InvoicesApiRequestBulkDownloadInvoicesRequest {
  */
 export declare class InvoicesApi extends runtime.BaseAPI {
     /**
-     * Downloads the PDF document for a specific invoice owned by the seller.
+     * 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.
      * Download seller invoice
      */
     downloadInvoiceRaw(requestParameters: InvoicesApiDownloadInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
     /**
-     * Downloads the PDF document for a specific invoice owned by the seller.
+     * 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.
      * Download seller invoice
      */
     downloadInvoice(requestParameters: InvoicesApiDownloadInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
     /**
-     * Lists invoices for the seller account.
+     * Lists invoices for the seller account.  **API key scope required:** `INVOICES_READ`. Requests authenticated with a seller session do not need any scope.
      * List seller invoices
      */
     getInvoicesRaw(requestParameters: InvoicesApiGetInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetInvoices200Response>>;
     /**
-     * Lists invoices for the seller account.
+     * Lists invoices for the seller account.  **API key scope required:** `INVOICES_READ`. Requests authenticated with a seller session do not need any scope.
      * List seller invoices
      */
     getInvoices(requestParameters?: InvoicesApiGetInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetInvoices200Response>;
     /**
-     * Queues a bulk download of seller invoices within the specified date range. The download link is sent via email.
+     * 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.
      * Request bulk invoice download
      */
     requestBulkDownloadInvoicesRaw(requestParameters: InvoicesApiRequestBulkDownloadInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Queues a bulk download of seller invoices within the specified date range. The download link is sent via email.
+     * 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.
      * Request bulk invoice download
      */
     requestBulkDownloadInvoices(requestParameters: InvoicesApiRequestBulkDownloadInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;

package/dist/apis/InvoicesApi.js

@@ -76,44 +76,52 @@ var InvoicesApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     * Downloads the PDF document for a specific invoice owned by the seller.
+     * 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.
      * Download seller invoice
      */
     InvoicesApi.prototype.downloadInvoiceRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
-            var queryParameters, headerParameters, token, tokenString, response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var queryParameters, headerParameters, _a, _b, token, tokenString, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
                         if (requestParameters['invoiceId'] == null) {
                             throw new runtime.RequiredError('invoiceId', 'Required parameter "invoiceId" was null or undefined when calling downloadInvoice().');
                         }
                         queryParameters = {};
                         headerParameters = {};
-                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
+                        _a = headerParameters;
+                        _b = "apikey";
+                        return [4 /*yield*/, this.configuration.apiKey("apikey")];
+                    case 1:
+                        _a[_b] = _c.sent(); // api_key authentication
+                        _c.label = 2;
+                    case 2:
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
                         token = this.configuration.accessToken;
                         return [4 /*yield*/, token("bearer", [])];
-                    case 1:
-                        tokenString = _a.sent();
+                    case 3:
+                        tokenString = _c.sent();
                         if (tokenString) {
                             headerParameters["Authorization"] = "Bearer ".concat(tokenString);
                         }
-                        _a.label = 2;
-                    case 2: return [4 /*yield*/, this.request({
+                        _c.label = 4;
+                    case 4: return [4 /*yield*/, this.request({
                             path: "/private/invoices/{invoiceId}/download".replace("{".concat("invoiceId", "}"), encodeURIComponent(String(requestParameters['invoiceId']))),
                             method: 'GET',
                             headers: headerParameters,
                             query: queryParameters,
                         }, initOverrides)];
-                    case 3:
-                        response = _a.sent();
+                    case 5:
+                        response = _c.sent();
                         return [2 /*return*/, new runtime.BlobApiResponse(response)];
                 }
             });
         });
     };
     /**
-     * Downloads the PDF document for a specific invoice owned by the seller.
+     * 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.
      * Download seller invoice
      */
     InvoicesApi.prototype.downloadInvoice = function (requestParameters, initOverrides) {
@@ -131,14 +139,14 @@ var InvoicesApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Lists invoices for the seller account.
+     * Lists invoices for the seller account.  **API key scope required:** `INVOICES_READ`. Requests authenticated with a seller session do not need any scope.
      * List seller invoices
      */
     InvoicesApi.prototype.getInvoicesRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
-            var queryParameters, headerParameters, token, tokenString, response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var queryParameters, headerParameters, _a, _b, token, tokenString, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
                         queryParameters = {};
                         if (requestParameters['filter'] != null) {
@@ -163,30 +171,38 @@ var InvoicesApi = /** @class */ (function (_super) {
                             queryParameters['filter[status]'] = requestParameters['filterStatus'];
                         }
                         headerParameters = {};
-                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
+                        _a = headerParameters;
+                        _b = "apikey";
+                        return [4 /*yield*/, this.configuration.apiKey("apikey")];
+                    case 1:
+                        _a[_b] = _c.sent(); // api_key authentication
+                        _c.label = 2;
+                    case 2:
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
                         token = this.configuration.accessToken;
                         return [4 /*yield*/, token("bearer", [])];
-                    case 1:
-                        tokenString = _a.sent();
+                    case 3:
+                        tokenString = _c.sent();
                         if (tokenString) {
                             headerParameters["Authorization"] = "Bearer ".concat(tokenString);
                         }
-                        _a.label = 2;
-                    case 2: return [4 /*yield*/, this.request({
+                        _c.label = 4;
+                    case 4: return [4 /*yield*/, this.request({
                             path: "/private/invoices",
                             method: 'GET',
                             headers: headerParameters,
                             query: queryParameters,
                         }, initOverrides)];
-                    case 3:
-                        response = _a.sent();
+                    case 5:
+                        response = _c.sent();
                         return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.GetInvoices200ResponseFromJSON)(jsonValue); })];
                 }
             });
         });
     };
     /**
-     * Lists invoices for the seller account.
+     * Lists invoices for the seller account.  **API key scope required:** `INVOICES_READ`. Requests authenticated with a seller session do not need any scope.
      * List seller invoices
      */
     InvoicesApi.prototype.getInvoices = function () {
@@ -205,14 +221,14 @@ var InvoicesApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Queues a bulk download of seller invoices within the specified date range. The download link is sent via email.
+     * 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.
      * Request bulk invoice download
      */
     InvoicesApi.prototype.requestBulkDownloadInvoicesRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
-            var queryParameters, headerParameters, token, tokenString, response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var queryParameters, headerParameters, _a, _b, token, tokenString, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
                         if (requestParameters['bulkDownloadInvoicesInput'] == null) {
                             throw new runtime.RequiredError('bulkDownloadInvoicesInput', 'Required parameter "bulkDownloadInvoicesInput" was null or undefined when calling requestBulkDownloadInvoices().');
@@ -220,31 +236,39 @@ var InvoicesApi = /** @class */ (function (_super) {
                         queryParameters = {};
                         headerParameters = {};
                         headerParameters['Content-Type'] = 'application/json';
-                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
+                        _a = headerParameters;
+                        _b = "apikey";
+                        return [4 /*yield*/, this.configuration.apiKey("apikey")];
+                    case 1:
+                        _a[_b] = _c.sent(); // api_key authentication
+                        _c.label = 2;
+                    case 2:
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
                         token = this.configuration.accessToken;
                         return [4 /*yield*/, token("bearer", [])];
-                    case 1:
-                        tokenString = _a.sent();
+                    case 3:
+                        tokenString = _c.sent();
                         if (tokenString) {
                             headerParameters["Authorization"] = "Bearer ".concat(tokenString);
                         }
-                        _a.label = 2;
-                    case 2: return [4 /*yield*/, this.request({
+                        _c.label = 4;
+                    case 4: return [4 /*yield*/, this.request({
                             path: "/private/invoices/bulk-download",
                             method: 'POST',
                             headers: headerParameters,
                             query: queryParameters,
                             body: (0, index_1.BulkDownloadInvoicesInputToJSON)(requestParameters['bulkDownloadInvoicesInput']),
                         }, initOverrides)];
-                    case 3:
-                        response = _a.sent();
+                    case 5:
+                        response = _c.sent();
                         return [2 /*return*/, new runtime.VoidApiResponse(response)];
                 }
             });
         });
     };
     /**
-     * Queues a bulk download of seller invoices within the specified date range. The download link is sent via email.
+     * 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.
      * Request bulk invoice download
      */
     InvoicesApi.prototype.requestBulkDownloadInvoices = function (requestParameters, initOverrides) {

package/dist/apis/LeadsApi.d.ts

@@ -91,192 +91,192 @@ export interface LeadsApiUpdateLeadOfferExpirationConfigurationRequest {
  */
 export declare class LeadsApi extends runtime.BaseAPI {
     /**
-     * Accepts the current buyer offer on the lead and advances the negotiation.
+     * 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.
      * Accept the buyer offer
      */
     acceptLeadOfferRaw(requestParameters: LeadsApiAcceptLeadOfferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Accepts the current buyer offer on the lead and advances the negotiation.
+     * 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.
      * Accept the buyer offer
      */
     acceptLeadOffer(requestParameters: LeadsApiAcceptLeadOfferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Archives the lead for the seller, hiding it from the active leads list.
+     * 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.
      * Archive a lead
      */
     archiveLeadRaw(requestParameters: LeadsApiArchiveLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Archives the lead for the seller, hiding it from the active leads list.
+     * 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.
      * Archive a lead
      */
     archiveLead(requestParameters: LeadsApiArchiveLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Marks multiple lead messages as read for the seller account.
+     * 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.
      * Mark lead messages as read
      */
     bulkReadSellerLeadMessageRaw(requestParameters: LeadsApiBulkReadSellerLeadMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Marks multiple lead messages as read for the seller account.
+     * 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.
      * Mark lead messages as read
      */
     bulkReadSellerLeadMessage(requestParameters: LeadsApiBulkReadSellerLeadMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Closes an active lead negotiation. Cannot close a lead accepted too recently.
+     * 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.
      * Close an active lead
      */
     closeLeadRaw(requestParameters: LeadsApiCloseLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Closes an active lead negotiation. Cannot close a lead accepted too recently.
+     * 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.
      * Close an active lead
      */
     closeLead(requestParameters: LeadsApiCloseLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Creates a lead manually on behalf of a buyer for a domain in the seller account.
+     * 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.
      * Create a manual lead
      */
     createManualLeadRaw(requestParameters: LeadsApiCreateManualLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Creates a lead manually on behalf of a buyer for a domain in the seller account.
+     * 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.
      * Create a manual lead
      */
     createManualLead(requestParameters: LeadsApiCreateManualLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Sends a message from the seller in the lead conversation thread.
+     * 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.
      * Create a lead message
      */
     createMessageRaw(requestParameters: LeadsApiCreateMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ObjectId>>;
     /**
-     * Sends a message from the seller in the lead conversation thread.
+     * 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.
      * Create a lead message
      */
     createMessage(requestParameters: LeadsApiCreateMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectId>;
     /**
-     * Returns lead information. Requires account ownership.
+     * Returns lead information. Requires account ownership.  **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get lead details
      */
     getLeadRaw(requestParameters: LeadsApiGetLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SellerLeadDetails>>;
     /**
-     * Returns lead information. Requires account ownership.
+     * Returns lead information. Requires account ownership.  **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get lead details
      */
     getLead(requestParameters: LeadsApiGetLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SellerLeadDetails>;
     /**
-     * Returns configuration presets for lead offers.
+     * Returns configuration presets for lead offers.  **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get lease-to-own configuration presets
      */
     getLeadLeaseToOwnConfigurationPresetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LeadLeaseToOwnAndRentConfigurationPresetsDto>>;
     /**
-     * Returns configuration presets for lead offers.
+     * Returns configuration presets for lead offers.  **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get lease-to-own configuration presets
      */
     getLeadLeaseToOwnConfigurationPresets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LeadLeaseToOwnAndRentConfigurationPresetsDto>;
     /**
-     * Returns manual lead information. Requires account ownership.
+     * Returns manual lead information. Requires account ownership.  **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get manual lead details
      */
     getManualLeadRaw(requestParameters: LeadsApiGetManualLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntersectionLeadDtoWithLeadDetailsDtoWithManualLeadBuyerDetailsDto>>;
     /**
-     * Returns manual lead information. Requires account ownership.
+     * Returns manual lead information. Requires account ownership.  **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get manual lead details
      */
     getManualLead(requestParameters: LeadsApiGetManualLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntersectionLeadDtoWithLeadDetailsDtoWithManualLeadBuyerDetailsDto>;
     /**
-     * Lists messages in the lead conversation. Requires account ownership.
+     * 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.
      * List lead messages
      */
     getMessagesRaw(requestParameters: LeadsApiGetMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListLeadMessagesDto>>;
     /**
-     * Lists messages in the lead conversation. Requires account ownership.
+     * 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.
      * List lead messages
      */
     getMessages(requestParameters: LeadsApiGetMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListLeadMessagesDto>;
     /**
-     * Lists leads for the seller account.
+     * Lists leads for the seller account.  **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
      * List seller leads
      */
     listRaw(requestParameters: LeadsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<List200Response>>;
     /**
-     * Lists leads for the seller account.
+     * Lists leads for the seller account.  **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
      * List seller leads
      */
     list(requestParameters?: LeadsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<List200Response>;
     /**
-     * Lists leads related to the specified lead.
+     * Lists leads related to the specified lead.  **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
      * List related leads
      */
     listRelatedLeadsRaw(requestParameters: LeadsApiListRelatedLeadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListRelatedLeads200Response>>;
     /**
-     * Lists leads related to the specified lead.
+     * Lists leads related to the specified lead.  **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
      * List related leads
      */
     listRelatedLeads(requestParameters: LeadsApiListRelatedLeadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListRelatedLeads200Response>;
     /**
-     * Pauses the AI price negotiator agent for the lead.
+     * 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.
      * Pause AI price negotiator
      */
     pauseLeadPriceNegotiatorAgentRaw(requestParameters: LeadsApiPauseLeadPriceNegotiatorAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Pauses the AI price negotiator agent for the lead.
+     * 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.
      * Pause AI price negotiator
      */
     pauseLeadPriceNegotiatorAgent(requestParameters: LeadsApiPauseLeadPriceNegotiatorAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Sets or updates the seller counter-offer on a lead.
+     * 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.
      * Submit a seller counter-offer
      */
     putOfferRaw(requestParameters: LeadsApiPutOfferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Sets or updates the seller counter-offer on a lead.
+     * 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.
      * Submit a seller counter-offer
      */
     putOffer(requestParameters: LeadsApiPutOfferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Resumes a paused AI price negotiator agent for the lead.
+     * 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.
      * Resume AI price negotiator
      */
     resumeLeadPriceNegotiatorAgentRaw(requestParameters: LeadsApiResumeLeadPriceNegotiatorAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Resumes a paused AI price negotiator agent for the lead.
+     * 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.
      * Resume AI price negotiator
      */
     resumeLeadPriceNegotiatorAgent(requestParameters: LeadsApiResumeLeadPriceNegotiatorAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Restores a previously archived lead to the seller active leads list.
+     * 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.
      * Unarchive a lead
      */
     unarchiveLeadRaw(requestParameters: LeadsApiUnarchiveLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Restores a previously archived lead to the seller active leads list.
+     * 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.
      * Unarchive a lead
      */
     unarchiveLead(requestParameters: LeadsApiUnarchiveLeadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Updates the domain lock settings applied while the lead is active.
+     * 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.
      * Update domain lock configuration
      */
     updateLeadDomainLockConfigurationRaw(requestParameters: LeadsApiUpdateLeadDomainLockConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Updates the domain lock settings applied while the lead is active.
+     * 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.
      * Update domain lock configuration
      */
     updateLeadDomainLockConfiguration(requestParameters: LeadsApiUpdateLeadDomainLockConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Updates whether the lead is muted for the seller user.
+     * 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.
      * Mute or unmute a lead
      */
     updateLeadMuteStatusRaw(requestParameters: LeadsApiUpdateLeadMuteStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Updates whether the lead is muted for the seller user.
+     * 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.
      * Mute or unmute a lead
      */
     updateLeadMuteStatus(requestParameters: LeadsApiUpdateLeadMuteStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Updates when unanswered offers on the lead automatically expire.
+     * 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.
      * Update offer expiration configuration
      */
     updateLeadOfferExpirationConfigurationRaw(requestParameters: LeadsApiUpdateLeadOfferExpirationConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Updates when unanswered offers on the lead automatically expire.
+     * 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.
      * Update offer expiration configuration
      */
     updateLeadOfferExpirationConfiguration(requestParameters: LeadsApiUpdateLeadOfferExpirationConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;