@randock/nameshift-api-client 0.0.436 → 0.0.438

package/src/apis/DomainsPublicApi.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Nameshift
- * Nameshift API
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
  *
  * The version of the OpenAPI document: 1.0
  * 
@@ -21,7 +21,6 @@ import type {
   List200Response3,
   NotFoundException,
   RelatedDomainsDto,
-  SortDto,
   ValidationException,
 } from '../models/index';
 import {
@@ -37,8 +36,6 @@ import {
     NotFoundExceptionToJSON,
     RelatedDomainsDtoFromJSON,
     RelatedDomainsDtoToJSON,
-    SortDtoFromJSON,
-    SortDtoToJSON,
     ValidationExceptionFromJSON,
     ValidationExceptionToJSON,
 } from '../models/index';
@@ -63,12 +60,12 @@ export interface DomainsPublicApiGetDomainStatsRequest {
 }
 
 export interface DomainsPublicApiListRequest {
-    fuzzy: boolean;
+    fuzzy?: boolean;
     limit?: number;
-    sort?: Array<SortDto>;
+    cursor?: string;
+    sort?: Array<string>;
     filter?: string;
     search?: string;
-    cursor?: string;
 }
 
 /**
@@ -77,7 +74,8 @@ export interface DomainsPublicApiListRequest {
 export class DomainsPublicApi extends runtime.BaseAPI {
 
     /**
-     * 
+     * Returns all supported top-level domains, optionally filtered by seller.
+     * Get all TLDs
      */
     async getAllTldsRaw(requestParameters: DomainsPublicApiGetAllTldsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainTldsDto>> {
         const queryParameters: any = {};
@@ -99,7 +97,8 @@ export class DomainsPublicApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns all supported top-level domains, optionally filtered by seller.
+     * Get all TLDs
      */
     async getAllTlds(requestParameters: DomainsPublicApiGetAllTldsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainTldsDto> {
         const response = await this.getAllTldsRaw(requestParameters, initOverrides);
@@ -107,7 +106,8 @@ export class DomainsPublicApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns domains related to the specified domain for cross-selling.
+     * Get related domains
      */
     async getDomainRelatedDomainsRaw(requestParameters: DomainsPublicApiGetDomainRelatedDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RelatedDomainsDto>> {
         if (requestParameters['domainName'] == null) {
@@ -143,7 +143,8 @@ export class DomainsPublicApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns domains related to the specified domain for cross-selling.
+     * Get related domains
      */
     async getDomainRelatedDomains(requestParameters: DomainsPublicApiGetDomainRelatedDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RelatedDomainsDto> {
         const response = await this.getDomainRelatedDomainsRaw(requestParameters, initOverrides);
@@ -151,7 +152,8 @@ export class DomainsPublicApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns domain sales information for a domain.
+     * Get domain sales information
      */
     async getDomainSalesInformationRaw(requestParameters: DomainsPublicApiGetDomainSalesInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainSalesInformationDto>> {
         if (requestParameters['domainName'] == null) {
@@ -184,7 +186,8 @@ export class DomainsPublicApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns domain sales information for a domain.
+     * Get domain sales information
      */
     async getDomainSalesInformation(requestParameters: DomainsPublicApiGetDomainSalesInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainSalesInformationDto> {
         const response = await this.getDomainSalesInformationRaw(requestParameters, initOverrides);
@@ -192,7 +195,8 @@ export class DomainsPublicApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns visitor and sales statistics for a publicly listed domain.
+     * Get domain statistics
      */
     async getDomainStatsRaw(requestParameters: DomainsPublicApiGetDomainStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainStatsDto>> {
         if (requestParameters['domainName'] == null) {
@@ -217,7 +221,8 @@ export class DomainsPublicApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Returns visitor and sales statistics for a publicly listed domain.
+     * Get domain statistics
      */
     async getDomainStats(requestParameters: DomainsPublicApiGetDomainStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainStatsDto> {
         const response = await this.getDomainStatsRaw(requestParameters, initOverrides);
@@ -225,16 +230,10 @@ export class DomainsPublicApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Lists publicly available domains for sale.
+     * List public domains
      */
     async listRaw(requestParameters: DomainsPublicApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<List200Response3>> {
-        if (requestParameters['fuzzy'] == null) {
-            throw new runtime.RequiredError(
-                'fuzzy',
-                'Required parameter "fuzzy" was null or undefined when calling list().'
-            );
-        }
-
         const queryParameters: any = {};
 
         if (requestParameters['fuzzy'] != null) {
@@ -245,6 +244,10 @@ export class DomainsPublicApi extends runtime.BaseAPI {
             queryParameters['limit'] = requestParameters['limit'];
         }
 
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+
         if (requestParameters['sort'] != null) {
             queryParameters['sort'] = requestParameters['sort'];
         }
@@ -257,10 +260,6 @@ export class DomainsPublicApi extends runtime.BaseAPI {
             queryParameters['search'] = requestParameters['search'];
         }
 
-        if (requestParameters['cursor'] != null) {
-            queryParameters['cursor'] = requestParameters['cursor'];
-        }
-
         const headerParameters: runtime.HTTPHeaders = {};
 
         const response = await this.request({
@@ -274,9 +273,10 @@ export class DomainsPublicApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Lists publicly available domains for sale.
+     * List public domains
      */
-    async list(requestParameters: DomainsPublicApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<List200Response3> {
+    async list(requestParameters: DomainsPublicApiListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<List200Response3> {
         const response = await this.listRaw(requestParameters, initOverrides);
         return await response.value();
     }

package/src/apis/EppApi.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Nameshift
- * Nameshift API
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
  *
  * The version of the OpenAPI document: 1.0
  * 
@@ -32,7 +32,8 @@ export interface EppApiEppBatchUpdateDomainsRequest {
 export class EppApi extends runtime.BaseAPI {
 
     /**
-     * 
+     * Queues a batch EPP update to configure DNSSEC and/or nameservers for domains at a registry.
+     * Batch update domains via EPP
      */
     async eppBatchUpdateDomainsRaw(requestParameters: EppApiEppBatchUpdateDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         if (requestParameters['eppBatchUpdateInput'] == null) {
@@ -68,7 +69,8 @@ export class EppApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Queues a batch EPP update to configure DNSSEC and/or nameservers for domains at a registry.
+     * Batch update domains via EPP
      */
     async eppBatchUpdateDomains(requestParameters: EppApiEppBatchUpdateDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.eppBatchUpdateDomainsRaw(requestParameters, initOverrides);

package/src/apis/InvoicesApi.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Nameshift
- * Nameshift API
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
  *
  * The version of the OpenAPI document: 1.0
  * 
@@ -36,10 +36,13 @@ export interface InvoicesApiDownloadInvoiceRequest {
 }
 
 export interface InvoicesApiGetInvoicesRequest {
-    filter?: object;
+    filter?: { [key: string]: string; };
     page?: number;
     limit?: number;
     sortBy?: Array<string>;
+    filterDateFrom?: string;
+    filterDateTo?: string;
+    filterStatus?: string;
 }
 
 export interface InvoicesApiRequestBulkDownloadInvoicesRequest {
@@ -52,7 +55,8 @@ export interface InvoicesApiRequestBulkDownloadInvoicesRequest {
 export class InvoicesApi extends runtime.BaseAPI {
 
     /**
-     * 
+     * Downloads the PDF document for a specific invoice owned by the seller.
+     * Download seller invoice
      */
     async downloadInvoiceRaw(requestParameters: InvoicesApiDownloadInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
         if (requestParameters['invoiceId'] == null) {
@@ -85,7 +89,8 @@ export class InvoicesApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Downloads the PDF document for a specific invoice owned by the seller.
+     * Download seller invoice
      */
     async downloadInvoice(requestParameters: InvoicesApiDownloadInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
         const response = await this.downloadInvoiceRaw(requestParameters, initOverrides);
@@ -93,7 +98,8 @@ export class InvoicesApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Lists invoices for the seller account.
+     * List seller invoices
      */
     async getInvoicesRaw(requestParameters: InvoicesApiGetInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetInvoices200Response>> {
         const queryParameters: any = {};
@@ -114,6 +120,18 @@ export class InvoicesApi extends runtime.BaseAPI {
             queryParameters['sortBy'] = requestParameters['sortBy'];
         }
 
+        if (requestParameters['filterDateFrom'] != null) {
+            queryParameters['filter[dateFrom]'] = requestParameters['filterDateFrom'];
+        }
+
+        if (requestParameters['filterDateTo'] != null) {
+            queryParameters['filter[dateTo]'] = requestParameters['filterDateTo'];
+        }
+
+        if (requestParameters['filterStatus'] != null) {
+            queryParameters['filter[status]'] = requestParameters['filterStatus'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {
@@ -135,7 +153,8 @@ export class InvoicesApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Lists invoices for the seller account.
+     * List seller invoices
      */
     async getInvoices(requestParameters: InvoicesApiGetInvoicesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetInvoices200Response> {
         const response = await this.getInvoicesRaw(requestParameters, initOverrides);
@@ -143,7 +162,8 @@ export class InvoicesApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Queues a bulk download of seller invoices within the specified date range. The download link is sent via email.
+     * Request bulk invoice download
      */
     async requestBulkDownloadInvoicesRaw(requestParameters: InvoicesApiRequestBulkDownloadInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         if (requestParameters['bulkDownloadInvoicesInput'] == null) {
@@ -179,7 +199,8 @@ export class InvoicesApi extends runtime.BaseAPI {
     }
 
     /**
-     * 
+     * Queues a bulk download of seller invoices within the specified date range. The download link is sent via email.
+     * Request bulk invoice download
      */
     async requestBulkDownloadInvoices(requestParameters: InvoicesApiRequestBulkDownloadInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.requestBulkDownloadInvoicesRaw(requestParameters, initOverrides);