@randock/nameshift-api-client 0.0.436 → 0.0.438

package/src/models/AccountNameshiftCommissionReasonDto.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
  * 
@@ -35,67 +35,67 @@ import {
  */
 export interface AccountNameshiftCommissionReasonDto {
     /**
-     * 
+     * Commission rule identifier that produced this reason.
      * @type {string}
      * @memberof AccountNameshiftCommissionReasonDto
      */
     commissionId?: string;
     /**
-     * 
+     * Human-readable explanation of the commission reason.
      * @type {string}
      * @memberof AccountNameshiftCommissionReasonDto
      */
     text?: string;
     /**
-     * 
+     * Commission type associated with the reason.
      * @type {string}
      * @memberof AccountNameshiftCommissionReasonDto
      */
     type?: AccountNameshiftCommissionReasonDtoTypeEnum;
     /**
-     * 
+     * Commission subtype associated with the reason.
      * @type {string}
      * @memberof AccountNameshiftCommissionReasonDto
      */
     subtype?: AccountNameshiftCommissionReasonDtoSubtypeEnum;
     /**
-     * 
+     * Display label for the commission reason.
      * @type {string}
      * @memberof AccountNameshiftCommissionReasonDto
      */
     label?: string;
     /**
-     * 
+     * Configuration details for factor-based commission rules.
      * @type {CommissionReasonConfigDto}
      * @memberof AccountNameshiftCommissionReasonDto
      */
     config?: CommissionReasonConfigDto | null;
     /**
-     * 
+     * Start date of the commission period (ISO 8601).
      * @type {string}
      * @memberof AccountNameshiftCommissionReasonDto
      */
     dateStart?: string;
     /**
-     * 
+     * End date of the commission period (ISO 8601), or null if ongoing.
      * @type {string}
      * @memberof AccountNameshiftCommissionReasonDto
      */
     dateEnd?: string | null;
     /**
-     * 
+     * Selected fixed commission percentage value, if applicable.
      * @type {number}
      * @memberof AccountNameshiftCommissionReasonDto
      */
     selectedValue?: number;
     /**
-     * 
+     * Selected tier from a sales-count-based commission rule.
      * @type {CommissionPercentageRangeDto}
      * @memberof AccountNameshiftCommissionReasonDto
      */
     selectedTier?: CommissionPercentageRangeDto | null;
     /**
-     * 
+     * Computed factor count used to determine the commission tier.
      * @type {number}
      * @memberof AccountNameshiftCommissionReasonDto
      */

package/src/models/AccountNameshiftCommissionSubtypeCurrentDto.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
  * 

package/src/models/AccountNotificationDto.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
  * 
@@ -28,25 +28,25 @@ import {
  */
 export interface AccountNotificationDto {
     /**
-     * 
+     * Unique notification identifier.
      * @type {string}
      * @memberof AccountNotificationDto
      */
     id: string;
     /**
-     * 
+     * Severity level of the notification.
      * @type {string}
      * @memberof AccountNotificationDto
      */
     level: AccountNotificationDtoLevelEnum;
     /**
-     * 
+     * Type of account notification.
      * @type {string}
      * @memberof AccountNotificationDto
      */
     type: AccountNotificationDtoTypeEnum;
     /**
-     * 
+     * Read status of the notification.
      * @type {AccountNotificationReadStatusDto}
      * @memberof AccountNotificationDto
      */

package/src/models/AccountNotificationReadStatusDto.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
  * 
@@ -20,19 +20,19 @@ import { mapValues } from '../runtime';
  */
 export interface AccountNotificationReadStatusDto {
     /**
-     * 
+     * Whether the notification has been read.
      * @type {boolean}
      * @memberof AccountNotificationReadStatusDto
      */
     value: boolean;
     /**
-     * 
-     * @type {object}
+     * User who marked the notification as read.
+     * @type {string}
      * @memberof AccountNotificationReadStatusDto
      */
-    by: object;
+    by: string;
     /**
-     * 
+     * Timestamp when the notification was marked as read.
      * @type {Date}
      * @memberof AccountNotificationReadStatusDto
      */

package/src/models/AccountOnboardingDto.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
  * 
@@ -20,25 +20,25 @@ import { mapValues } from '../runtime';
  */
 export interface AccountOnboardingDto {
     /**
-     * 
+     * External account ID at the payment provider, if assigned.
      * @type {string}
      * @memberof AccountOnboardingDto
      */
     accountId: string | null;
     /**
-     * 
+     * Current onboarding status with the payment provider.
      * @type {string}
      * @memberof AccountOnboardingDto
      */
     status: AccountOnboardingDtoStatusEnum;
     /**
-     * 
+     * Whether onboarding has been completed successfully.
      * @type {boolean}
      * @memberof AccountOnboardingDto
      */
     finished: boolean;
     /**
-     * 
+     * Payment provider handling account onboarding.
      * @type {string}
      * @memberof AccountOnboardingDto
      */

package/src/models/AccountOnboardingSessionDto.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
  * 

package/src/models/AccountPaymentDto.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
  * 
@@ -55,55 +55,55 @@ export interface AccountPaymentDto {
      */
     id: string;
     /**
-     * 
+     * Current invoice status for this payment.
      * @type {string}
      * @memberof AccountPaymentDto
      */
     status: AccountPaymentDtoStatusEnum;
     /**
-     * 
-     * @type {Array<AccountPaymentMethodProfileDto>}
-     * @memberof AccountPaymentDto
-     */
-    paymentMethodProfiles: Array<AccountPaymentMethodProfileDto>;
-    /**
-     * 
+     * Base price before tax.
      * @type {MoneyDto}
      * @memberof AccountPaymentDto
      */
     basePrice: MoneyDto;
     /**
-     * 
+     * Total price including tax.
      * @type {MoneyDto}
      * @memberof AccountPaymentDto
      */
     totalPrice: MoneyDto;
     /**
-     * 
+     * Total tax amount.
      * @type {MoneyDto}
      * @memberof AccountPaymentDto
      */
     totalTaxPrice: MoneyDto;
     /**
-     * 
+     * Line items on the invoice.
      * @type {Array<InvoiceItemDto>}
      * @memberof AccountPaymentDto
      */
     items: Array<InvoiceItemDto>;
     /**
-     * 
+     * Payment method types allowed for this payment.
      * @type {Array<string>}
      * @memberof AccountPaymentDto
      */
     allowedPaymentMethods: Array<string>;
     /**
-     * 
+     * Saved payment method profiles available for this payment.
+     * @type {Array<AccountPaymentMethodProfileDto>}
+     * @memberof AccountPaymentDto
+     */
+    paymentMethodProfiles: Array<AccountPaymentMethodProfileDto>;
+    /**
+     * Latest transaction for this payment, if any.
      * @type {InvoiceTransactionDto}
      * @memberof AccountPaymentDto
      */
-    transaction: InvoiceTransactionDto;
+    transaction: InvoiceTransactionDto | null;
     /**
-     * 
+     * Whether there is a pending transaction for this payment.
      * @type {boolean}
      * @memberof AccountPaymentDto
      */
@@ -129,12 +129,12 @@ export type AccountPaymentDtoStatusEnum = typeof AccountPaymentDtoStatusEnum[key
 export function instanceOfAccountPaymentDto(value: object): value is AccountPaymentDto {
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
-    if (!('paymentMethodProfiles' in value) || value['paymentMethodProfiles'] === undefined) return false;
     if (!('basePrice' in value) || value['basePrice'] === undefined) return false;
     if (!('totalPrice' in value) || value['totalPrice'] === undefined) return false;
     if (!('totalTaxPrice' in value) || value['totalTaxPrice'] === undefined) return false;
     if (!('items' in value) || value['items'] === undefined) return false;
     if (!('allowedPaymentMethods' in value) || value['allowedPaymentMethods'] === undefined) return false;
+    if (!('paymentMethodProfiles' in value) || value['paymentMethodProfiles'] === undefined) return false;
     if (!('transaction' in value) || value['transaction'] === undefined) return false;
     if (!('hasPendingTransaction' in value) || value['hasPendingTransaction'] === undefined) return false;
     return true;
@@ -152,12 +152,12 @@ export function AccountPaymentDtoFromJSONTyped(json: any, ignoreDiscriminator: b
         
         'id': json['id'],
         'status': json['status'],
-        'paymentMethodProfiles': ((json['paymentMethodProfiles'] as Array<any>).map(AccountPaymentMethodProfileDtoFromJSON)),
         'basePrice': MoneyDtoFromJSON(json['basePrice']),
         'totalPrice': MoneyDtoFromJSON(json['totalPrice']),
         'totalTaxPrice': MoneyDtoFromJSON(json['totalTaxPrice']),
         'items': ((json['items'] as Array<any>).map(InvoiceItemDtoFromJSON)),
         'allowedPaymentMethods': json['allowedPaymentMethods'],
+        'paymentMethodProfiles': ((json['paymentMethodProfiles'] as Array<any>).map(AccountPaymentMethodProfileDtoFromJSON)),
         'transaction': InvoiceTransactionDtoFromJSON(json['transaction']),
         'hasPendingTransaction': json['hasPendingTransaction'],
     };
@@ -176,12 +176,12 @@ export function AccountPaymentDtoToJSONTyped(value?: AccountPaymentDto | null, i
         
         'id': value['id'],
         'status': value['status'],
-        'paymentMethodProfiles': ((value['paymentMethodProfiles'] as Array<any>).map(AccountPaymentMethodProfileDtoToJSON)),
         'basePrice': MoneyDtoToJSON(value['basePrice']),
         'totalPrice': MoneyDtoToJSON(value['totalPrice']),
         'totalTaxPrice': MoneyDtoToJSON(value['totalTaxPrice']),
         'items': ((value['items'] as Array<any>).map(InvoiceItemDtoToJSON)),
         'allowedPaymentMethods': value['allowedPaymentMethods'],
+        'paymentMethodProfiles': ((value['paymentMethodProfiles'] as Array<any>).map(AccountPaymentMethodProfileDtoToJSON)),
         'transaction': InvoiceTransactionDtoToJSON(value['transaction']),
         'hasPendingTransaction': value['hasPendingTransaction'],
     };

package/src/models/AccountPaymentMethodDto.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
  * 
@@ -20,55 +20,55 @@ import { mapValues } from '../runtime';
  */
 export interface AccountPaymentMethodDto {
     /**
-     * 
+     * Unique payment method identifier.
      * @type {string}
      * @memberof AccountPaymentMethodDto
      */
     id: string;
     /**
-     * 
+     * External gateway identifier for the payment method.
      * @type {string}
      * @memberof AccountPaymentMethodDto
      */
     gatewayId: string;
     /**
-     * 
+     * Creation timestamp.
      * @type {Date}
      * @memberof AccountPaymentMethodDto
      */
     createdAt: Date;
     /**
-     * 
+     * Last update timestamp.
      * @type {Date}
      * @memberof AccountPaymentMethodDto
      */
     updatedAt: Date;
     /**
-     * 
+     * Last four digits of the card number.
      * @type {string}
      * @memberof AccountPaymentMethodDto
      */
     lastFourDigits: string;
     /**
-     * 
+     * Card expiration year.
      * @type {number}
      * @memberof AccountPaymentMethodDto
      */
     expirationYear: number;
     /**
-     * 
+     * Card expiration month.
      * @type {number}
      * @memberof AccountPaymentMethodDto
      */
     expirationMonth: number;
     /**
-     * 
+     * ISO country code of the card issuer.
      * @type {string}
      * @memberof AccountPaymentMethodDto
      */
     country: string;
     /**
-     * 
+     * Card brand (e.g. Visa, Mastercard).
      * @type {string}
      * @memberof AccountPaymentMethodDto
      */

package/src/models/AccountPaymentMethodProfileDto.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
  * 
@@ -28,37 +28,37 @@ import {
  */
 export interface AccountPaymentMethodProfileDto {
     /**
-     * 
+     * Unique payment method profile identifier.
      * @type {string}
      * @memberof AccountPaymentMethodProfileDto
      */
     id: string;
     /**
-     * 
+     * Payment gateway provider.
      * @type {string}
      * @memberof AccountPaymentMethodProfileDto
      */
     gateway: AccountPaymentMethodProfileDtoGatewayEnum;
     /**
-     * 
+     * External customer identifier at the payment gateway.
      * @type {string}
      * @memberof AccountPaymentMethodProfileDto
      */
     gatewayId: string;
     /**
-     * 
+     * Creation timestamp.
      * @type {Date}
      * @memberof AccountPaymentMethodProfileDto
      */
     createdAt: Date;
     /**
-     * 
+     * Last update timestamp.
      * @type {Date}
      * @memberof AccountPaymentMethodProfileDto
      */
     updatedAt: Date;
     /**
-     * 
+     * Active (non-expired) payment methods in this profile.
      * @type {Array<AccountPaymentMethodDto>}
      * @memberof AccountPaymentMethodProfileDto
      */

package/src/models/AccountPayoutDto.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
  * 
@@ -20,13 +20,13 @@ import { mapValues } from '../runtime';
  */
 export interface AccountPayoutDto {
     /**
-     * 
+     * Whether payouts are processed automatically.
      * @type {boolean}
      * @memberof AccountPayoutDto
      */
     automatic: boolean;
     /**
-     * 
+     * Payment provider used for payouts.
      * @type {string}
      * @memberof AccountPayoutDto
      */

package/src/models/AccountSettingsAffiliateCommissionDto.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
  * 
@@ -20,31 +20,31 @@ import { mapValues } from '../runtime';
  */
 export interface AccountSettingsAffiliateCommissionDto {
     /**
-     * 
+     * Start date of the commission period.
      * @type {Date}
      * @memberof AccountSettingsAffiliateCommissionDto
      */
     start: Date;
     /**
-     * 
+     * End date of the commission period, or null if ongoing.
      * @type {Date}
      * @memberof AccountSettingsAffiliateCommissionDto
      */
     end: Date | null;
     /**
-     * 
+     * Lease-to-own commission percentage during this period.
      * @type {number}
      * @memberof AccountSettingsAffiliateCommissionDto
      */
     leaseToOwnPercentage: number;
     /**
-     * 
+     * Rent commission percentage during this period.
      * @type {number}
      * @memberof AccountSettingsAffiliateCommissionDto
      */
     rentPercentage: number;
     /**
-     * 
+     * Order commission percentage during this period.
      * @type {number}
      * @memberof AccountSettingsAffiliateCommissionDto
      */

package/src/models/AccountSettingsAffiliateCommissionReferralDuration.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
  * 
@@ -20,13 +20,13 @@ import { mapValues } from '../runtime';
  */
 export interface AccountSettingsAffiliateCommissionReferralDuration {
     /**
-     * 
+     * Unit of time for the referral duration.
      * @type {string}
      * @memberof AccountSettingsAffiliateCommissionReferralDuration
      */
     unit: AccountSettingsAffiliateCommissionReferralDurationUnitEnum;
     /**
-     * 
+     * Amount of time units for the referral duration.
      * @type {number}
      * @memberof AccountSettingsAffiliateCommissionReferralDuration
      */

package/src/models/AccountSettingsAffiliateDto.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
  * 
@@ -35,37 +35,37 @@ import {
  */
 export interface AccountSettingsAffiliateDto {
     /**
-     * 
+     * Whether the affiliate program is enabled.
      * @type {boolean}
      * @memberof AccountSettingsAffiliateDto
      */
     enabled: boolean;
     /**
-     * 
+     * Default lease-to-own commission percentage.
      * @type {number}
      * @memberof AccountSettingsAffiliateDto
      */
     defaultCommissionLeaseToOwn: number;
     /**
-     * 
+     * Default rent commission percentage.
      * @type {number}
      * @memberof AccountSettingsAffiliateDto
      */
     defaultCommissionRent: number;
     /**
-     * 
+     * Default order commission percentage.
      * @type {number}
      * @memberof AccountSettingsAffiliateDto
      */
     defaultCommissionOrder: number;
     /**
-     * 
+     * Commission rates by date range.
      * @type {Array<AccountSettingsAffiliateCommissionDto>}
      * @memberof AccountSettingsAffiliateDto
      */
     commissions: Array<AccountSettingsAffiliateCommissionDto>;
     /**
-     * 
+     * How long referred accounts remain linked.
      * @type {AccountSettingsAffiliateCommissionReferralDuration}
      * @memberof AccountSettingsAffiliateDto
      */

package/src/models/AccountSettingsAliasDto.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
  * 
@@ -20,13 +20,13 @@ import { mapValues } from '../runtime';
  */
 export interface AccountSettingsAliasDto {
     /**
-     * 
+     * Account alias string.
      * @type {string}
      * @memberof AccountSettingsAliasDto
      */
     alias: string;
     /**
-     * 
+     * Whether the alias has been verified.
      * @type {boolean}
      * @memberof AccountSettingsAliasDto
      */