@randock/nameshift-api-client 0.0.448 → 0.0.450

package/dist/apis/DomainsApi.d.ts

@@ -100,222 +100,222 @@ export interface DomainsApiUpdateDomainTransferIpsTagRequest {
  */
 export declare class DomainsApi extends runtime.BaseAPI {
     /**
-     * Imports domains from an uploaded file or a list of domain names and queues them for processing.
+     * Imports domains from an uploaded file or a list of domain names and queues them for processing.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Import domains
      */
     batchImportRaw(requestParameters: DomainsApiBatchImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Imports domains from an uploaded file or a list of domain names and queues them for processing.
+     * Imports domains from an uploaded file or a list of domain names and queues them for processing.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Import domains
      */
     batchImport(requestParameters?: DomainsApiBatchImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Uploads a domain import file and returns a preview of parsed domains before import.
+     * Uploads a domain import file and returns a preview of parsed domains before import.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Preview domain import
      */
     batchImportPreviewRaw(requestParameters: DomainsApiBatchImportPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BatchImportPreviewDto>>;
     /**
-     * Uploads a domain import file and returns a preview of parsed domains before import.
+     * Uploads a domain import file and returns a preview of parsed domains before import.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Preview domain import
      */
     batchImportPreview(requestParameters?: DomainsApiBatchImportPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BatchImportPreviewDto>;
     /**
-     * Applies the same settings update to multiple domains by ID.
+     * Applies the same settings update to multiple domains by ID.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Batch update domains
      */
     batchUpdateRaw(requestParameters: DomainsApiBatchUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Applies the same settings update to multiple domains by ID.
+     * Applies the same settings update to multiple domains by ID.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Batch update domains
      */
     batchUpdate(requestParameters: DomainsApiBatchUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Applies pricing and configuration updates to all domains matching the provided filter criteria.
+     * Applies pricing and configuration updates to all domains matching the provided filter criteria.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Bulk update domains with filters
      */
     bulkUpdateDomainsWithFiltersRaw(requestParameters: DomainsApiBulkUpdateDomainsWithFiltersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Applies pricing and configuration updates to all domains matching the provided filter criteria.
+     * Applies pricing and configuration updates to all domains matching the provided filter criteria.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Bulk update domains with filters
      */
     bulkUpdateDomainsWithFilters(requestParameters: DomainsApiBulkUpdateDomainsWithFiltersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Starts a nameserver verification check for a single domain.
+     * Starts a nameserver verification check for a single domain.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Check domain nameservers
      */
     checkDnsRaw(requestParameters: DomainsApiCheckDnsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Starts a nameserver verification check for a single domain.
+     * Starts a nameserver verification check for a single domain.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Check domain nameservers
      */
     checkDns(requestParameters: DomainsApiCheckDnsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Starts a nameserver verification check for the specified domain IDs.
+     * Starts a nameserver verification check for the specified domain IDs.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Check nameservers for multiple domains
      */
     checkDnsBatchRaw(requestParameters: DomainsApiCheckDnsBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Starts a nameserver verification check for the specified domain IDs.
+     * Starts a nameserver verification check for the specified domain IDs.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Check nameservers for multiple domains
      */
     checkDnsBatch(requestParameters: DomainsApiCheckDnsBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Checks and updates the verification status of a domain owned by the seller.
+     * Checks and updates the verification status of a domain owned by the seller.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Check domain verification
      */
     checkDomainVerificationRaw(requestParameters: DomainsApiCheckDomainVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainVerificationStatusDto>>;
     /**
-     * Checks and updates the verification status of a domain owned by the seller.
+     * Checks and updates the verification status of a domain owned by the seller.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Check domain verification
      */
     checkDomainVerification(requestParameters: DomainsApiCheckDomainVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainVerificationStatusDto>;
     /**
-     * Deletes multiple domains by ID. Domains with open leads or active auctions cannot be deleted.
+     * Deletes multiple domains by ID. Domains with open leads or active auctions cannot be deleted.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Delete domains
      */
     deleteDomainsRaw(requestParameters: DomainsApiDeleteDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Deletes multiple domains by ID. Domains with open leads or active auctions cannot be deleted.
+     * Deletes multiple domains by ID. Domains with open leads or active auctions cannot be deleted.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Delete domains
      */
     deleteDomains(requestParameters: DomainsApiDeleteDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Queues an export of all domains for the current seller account.
+     * Queues an export of all domains for the current seller account.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Export domains
      */
     exportDomainsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Queues an export of all domains for the current seller account.
+     * Queues an export of all domains for the current seller account.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Export domains
      */
     exportDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Returns the affiliate commission information for a domain owned by the seller.
+     * Returns the affiliate commission information for a domain owned by the seller.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get domain affiliate commission
      */
     getAffiliateCommissionRaw(requestParameters: DomainsApiGetAffiliateCommissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SellerDomainAffiliateCommissionDto>>;
     /**
-     * Returns the affiliate commission information for a domain owned by the seller.
+     * Returns the affiliate commission information for a domain owned by the seller.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get domain affiliate commission
      */
     getAffiliateCommission(requestParameters: DomainsApiGetAffiliateCommissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SellerDomainAffiliateCommissionDto>;
     /**
-     * Lists domain transfers for the seller account.
+     * Lists domain transfers for the seller account.  **API key scope required:** `TRANSFERS_READ`. Requests authenticated with a seller session do not need any scope.
      * List domain transfers
      */
     getAllDomainTransfersRaw(requestParameters: DomainsApiGetAllDomainTransfersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAllDomainTransfers200Response>>;
     /**
-     * Lists domain transfers for the seller account.
+     * Lists domain transfers for the seller account.  **API key scope required:** `TRANSFERS_READ`. Requests authenticated with a seller session do not need any scope.
      * List domain transfers
      */
     getAllDomainTransfers(requestParameters?: DomainsApiGetAllDomainTransfersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllDomainTransfers200Response>;
     /**
-     * Returns domain information.
+     * Returns domain information.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get domain
      */
     getDomainRaw(requestParameters: DomainsApiGetDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntersectionDomainDtoWithHijackerDtoWithAccountDto>>;
     /**
-     * Returns domain information.
+     * Returns domain information.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get domain
      */
     getDomain(requestParameters: DomainsApiGetDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntersectionDomainDtoWithHijackerDtoWithAccountDto>;
     /**
-     * Returns the currency exchange rate applicable to the specified domain.
+     * Returns the currency exchange rate applicable to the specified domain.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get domain exchange rate
      */
     getDomainExchangeRateRaw(requestParameters: DomainsApiGetDomainExchangeRateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainExchangeRateDto>>;
     /**
-     * Returns the currency exchange rate applicable to the specified domain.
+     * Returns the currency exchange rate applicable to the specified domain.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get domain exchange rate
      */
     getDomainExchangeRate(requestParameters: DomainsApiGetDomainExchangeRateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainExchangeRateDto>;
     /**
-     * Returns available filter options for the seller domain inventory.
+     * Returns available filter options for the seller domain inventory.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get domain filters
      */
     getDomainFiltersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainFiltersDto>>;
     /**
-     * Returns available filter options for the seller domain inventory.
+     * Returns available filter options for the seller domain inventory.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get domain filters
      */
     getDomainFilters(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainFiltersDto>;
     /**
-     * Returns the list of currencies available for the current domain filter selection.
+     * Returns the list of currencies available for the current domain filter selection.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get domain filter currencies
      */
     getDomainFiltersCurrenciesRaw(requestParameters: DomainsApiGetDomainFiltersCurrenciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
     /**
-     * Returns the list of currencies available for the current domain filter selection.
+     * Returns the list of currencies available for the current domain filter selection.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get domain filter currencies
      */
     getDomainFiltersCurrencies(requestParameters?: DomainsApiGetDomainFiltersCurrenciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
     /**
-     * Returns domain transfer information.
+     * Returns domain transfer information.  **API key scope required:** `TRANSFERS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get domain transfer
      */
     getDomainTransferRaw(requestParameters: DomainsApiGetDomainTransferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SellerDomainTransferDto>>;
     /**
-     * Returns domain transfer information.
+     * Returns domain transfer information.  **API key scope required:** `TRANSFERS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get domain transfer
      */
     getDomainTransfer(requestParameters: DomainsApiGetDomainTransferRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SellerDomainTransferDto>;
     /**
-     * Returns the public landing page URL for the specified domain.
+     * Returns the public landing page URL for the specified domain.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get domain URL
      */
     getDomainUrlRaw(requestParameters: DomainsApiGetDomainUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainUrlDto>>;
     /**
-     * Returns the public landing page URL for the specified domain.
+     * Returns the public landing page URL for the specified domain.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get domain URL
      */
     getDomainUrl(requestParameters: DomainsApiGetDomainUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainUrlDto>;
     /**
-     * Lists domains for the seller account.
+     * Lists domains for the seller account.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * List domains
      */
     listRaw(requestParameters: DomainsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<List200Response2>>;
     /**
-     * Lists domains for the seller account.
+     * Lists domains for the seller account.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * List domains
      */
     list(requestParameters?: DomainsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<List200Response2>;
     /**
-     * Creates and starts an auction for the specified verified domain.
+     * Creates and starts an auction for the specified verified domain.  **API key scope required:** `AUCTIONS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Start domain auction
      */
     startAuctionRaw(requestParameters: DomainsApiStartAuctionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Creates and starts an auction for the specified verified domain.
+     * Creates and starts an auction for the specified verified domain.  **API key scope required:** `AUCTIONS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Start domain auction
      */
     startAuction(requestParameters: DomainsApiStartAuctionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Updates pricing, landing page, and other settings for a single domain.
+     * Updates pricing, landing page, and other settings for a single domain.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Update domain
      */
     updateRaw(requestParameters: DomainsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Updates pricing, landing page, and other settings for a single domain.
+     * Updates pricing, landing page, and other settings for a single domain.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Update domain
      */
     update(requestParameters: DomainsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Updates the authorization code for a domain transfer in progress.
+     * Updates the authorization code for a domain transfer in progress.  **API key scope required:** `TRANSFERS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Update domain transfer auth code
      */
     updateDomainTransferAuthCodeRaw(requestParameters: DomainsApiUpdateDomainTransferAuthCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Updates the authorization code for a domain transfer in progress.
+     * Updates the authorization code for a domain transfer in progress.  **API key scope required:** `TRANSFERS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Update domain transfer auth code
      */
     updateDomainTransferAuthCode(requestParameters: DomainsApiUpdateDomainTransferAuthCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Updates the IPS tag for a .uk domain transfer in progress.
+     * Updates the IPS tag for a .uk domain transfer in progress.  **API key scope required:** `TRANSFERS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Update domain transfer IPS tag
      */
     updateDomainTransferIpsTagRaw(requestParameters: DomainsApiUpdateDomainTransferIpsTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Updates the IPS tag for a .uk domain transfer in progress.
+     * Updates the IPS tag for a .uk domain transfer in progress.  **API key scope required:** `TRANSFERS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Update domain transfer IPS tag
      */
     updateDomainTransferIpsTag(requestParameters: DomainsApiUpdateDomainTransferIpsTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;