@randock/nameshift-api-client 0.0.436 → 0.0.438

package/src/models/SubscriptionDto.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
  * 
@@ -89,175 +89,175 @@ export interface SubscriptionDto {
      */
     invoiceId: string;
     /**
-     * 
+     * Buyer invoice status.
      * @type {string}
      * @memberof SubscriptionDto
      */
     invoiceStatus: SubscriptionDtoInvoiceStatusEnum;
     /**
-     * 
+     * Subscription status.
      * @type {string}
      * @memberof SubscriptionDto
      */
     status: SubscriptionDtoStatusEnum;
     /**
-     * Self-declared tax country code (ISO 3166-1 alpha-2).
-     * @type {string}
-     * @memberof SubscriptionDto
-     */
-    selfDeclaredTaxCountry: string | null;
-    /**
-     * Decided tax country code (ISO 3166-1 alpha-2).
-     * @type {string}
-     * @memberof SubscriptionDto
-     */
-    decidedCountry: string;
-    /**
-     * Available payment methods per gateway (canonical ids), keyed by PaymentGateway
-     * @type {object}
-     * @memberof SubscriptionDto
-     */
-    availablePaymentMethods: object;
-    /**
-     * Selected payment method on the active transaction (canonical)
-     * @type {string}
-     * @memberof SubscriptionDto
-     */
-    selectedPaymentMethod: SubscriptionDtoSelectedPaymentMethodEnum | null;
-    /**
-     * 
+     * Subscription base price.
      * @type {MoneyDto}
      * @memberof SubscriptionDto
      */
     basePrice: MoneyDto;
     /**
-     * 
+     * Recurring price on the active buyer invoice.
      * @type {MoneyDto}
      * @memberof SubscriptionDto
      */
     recurringPrice: MoneyDto;
     /**
-     * 
+     * Total price including tax.
      * @type {MoneyDto}
      * @memberof SubscriptionDto
      */
     totalPrice: MoneyDto;
     /**
-     * 
+     * Invoice line items.
      * @type {Array<InvoiceItemDto>}
      * @memberof SubscriptionDto
      */
     items: Array<InvoiceItemDto>;
     /**
-     * 
+     * Buyer first name.
      * @type {string}
      * @memberof SubscriptionDto
      */
     firstName: string;
     /**
-     * 
+     * Buyer last name.
      * @type {string}
      * @memberof SubscriptionDto
      */
     lastName: string;
     /**
-     * 
+     * Buyer email address.
      * @type {string}
      * @memberof SubscriptionDto
      */
     email: string;
     /**
-     * 
+     * Buyer phone number.
      * @type {string}
      * @memberof SubscriptionDto
      */
     phone: string | null;
     /**
-     * 
+     * Buyer address.
      * @type {AddressDto}
      * @memberof SubscriptionDto
      */
     address: AddressDto | null;
     /**
-     * 
+     * Buyer locale (e.g. en, nl).
      * @type {string}
      * @memberof SubscriptionDto
      */
     locale: string;
     /**
-     * 
+     * Buyer company information.
      * @type {SubscriptionCompanyInfoDto}
      * @memberof SubscriptionDto
      */
     companyInfo: SubscriptionCompanyInfoDto | null;
     /**
-     * 
+     * Self-declared tax country code (ISO 3166-1 alpha-2).
+     * @type {string}
+     * @memberof SubscriptionDto
+     */
+    selfDeclaredTaxCountry: string | null;
+    /**
+     * Decided tax country code (ISO 3166-1 alpha-2).
+     * @type {string}
+     * @memberof SubscriptionDto
+     */
+    decidedCountry: string;
+    /**
+     * Active invoice transaction, if any.
      * @type {InvoiceTransactionDto}
      * @memberof SubscriptionDto
      */
     transaction: InvoiceTransactionDto | null;
     /**
-     * 
+     * Whether the buyer invoice has a pending transaction.
      * @type {boolean}
      * @memberof SubscriptionDto
      */
     hasPendingTransaction: boolean;
     /**
-     * 
+     * Available payment methods per gateway (canonical ids), keyed by PaymentGateway
+     * @type {object}
+     * @memberof SubscriptionDto
+     */
+    availablePaymentMethods: object;
+    /**
+     * Selected payment method on the active transaction (canonical)
+     * @type {string}
+     * @memberof SubscriptionDto
+     */
+    selectedPaymentMethod: SubscriptionDtoSelectedPaymentMethodEnum | null;
+    /**
+     * Subscribed domain.
      * @type {SubscriptionDomainDto}
      * @memberof SubscriptionDto
      */
     domain: SubscriptionDomainDto;
     /**
-     * 
+     * Subscription type.
      * @type {string}
      * @memberof SubscriptionDto
      */
     type: SubscriptionDtoTypeEnum;
     /**
-     * 
+     * Total number of installments (lease-to-own).
      * @type {number}
      * @memberof SubscriptionDto
      */
     installments: number | null;
     /**
-     * 
+     * Current installment number (1-based).
      * @type {number}
      * @memberof SubscriptionDto
      */
     currentInstallment: number;
     /**
-     * 
+     * Expected total installments for lease-to-own.
      * @type {number}
      * @memberof SubscriptionDto
      */
     expectedInstallmentsNumber: number | null;
     /**
-     * 
+     * Billing periodicity.
      * @type {SubscriptionBillingPeriodicityDto}
      * @memberof SubscriptionDto
      */
     billingPeriodicity: SubscriptionBillingPeriodicityDto;
     /**
-     * 
+     * Whether the subscription has an associated lead.
      * @type {boolean}
      * @memberof SubscriptionDto
      */
     hasLead: boolean;
     /**
-     * 
+     * Lead status, if a lead exists.
      * @type {string}
      * @memberof SubscriptionDto
      */
     leadStatus: SubscriptionDtoLeadStatusEnum | null;
     /**
-     * 
+     * Lease-to-own configuration, if applicable.
      * @type {SubscriptionLeaseToOwnConfigurationDto}
      * @memberof SubscriptionDto
      */
     leaseToOwn: SubscriptionLeaseToOwnConfigurationDto | null;
     /**
-     * 
+     * Whether the buyer invoice can be issued as proforma.
      * @type {boolean}
      * @memberof SubscriptionDto
      */
@@ -391,10 +391,6 @@ export function instanceOfSubscriptionDto(value: object): value is SubscriptionD
     if (!('invoiceId' in value) || value['invoiceId'] === undefined) return false;
     if (!('invoiceStatus' in value) || value['invoiceStatus'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
-    if (!('selfDeclaredTaxCountry' in value) || value['selfDeclaredTaxCountry'] === undefined) return false;
-    if (!('decidedCountry' in value) || value['decidedCountry'] === undefined) return false;
-    if (!('availablePaymentMethods' in value) || value['availablePaymentMethods'] === undefined) return false;
-    if (!('selectedPaymentMethod' in value) || value['selectedPaymentMethod'] === undefined) return false;
     if (!('basePrice' in value) || value['basePrice'] === undefined) return false;
     if (!('recurringPrice' in value) || value['recurringPrice'] === undefined) return false;
     if (!('totalPrice' in value) || value['totalPrice'] === undefined) return false;
@@ -406,8 +402,12 @@ export function instanceOfSubscriptionDto(value: object): value is SubscriptionD
     if (!('address' in value) || value['address'] === undefined) return false;
     if (!('locale' in value) || value['locale'] === undefined) return false;
     if (!('companyInfo' in value) || value['companyInfo'] === undefined) return false;
+    if (!('selfDeclaredTaxCountry' in value) || value['selfDeclaredTaxCountry'] === undefined) return false;
+    if (!('decidedCountry' in value) || value['decidedCountry'] === undefined) return false;
     if (!('transaction' in value) || value['transaction'] === undefined) return false;
     if (!('hasPendingTransaction' in value) || value['hasPendingTransaction'] === undefined) return false;
+    if (!('availablePaymentMethods' in value) || value['availablePaymentMethods'] === undefined) return false;
+    if (!('selectedPaymentMethod' in value) || value['selectedPaymentMethod'] === undefined) return false;
     if (!('domain' in value) || value['domain'] === undefined) return false;
     if (!('type' in value) || value['type'] === undefined) return false;
     if (!('installments' in value) || value['installments'] === undefined) return false;
@@ -435,10 +435,6 @@ export function SubscriptionDtoFromJSONTyped(json: any, ignoreDiscriminator: boo
         'invoiceId': json['invoiceId'],
         'invoiceStatus': json['invoiceStatus'],
         'status': json['status'],
-        'selfDeclaredTaxCountry': json['selfDeclaredTaxCountry'],
-        'decidedCountry': json['decidedCountry'],
-        'availablePaymentMethods': json['availablePaymentMethods'],
-        'selectedPaymentMethod': json['selectedPaymentMethod'],
         'basePrice': MoneyDtoFromJSON(json['basePrice']),
         'recurringPrice': MoneyDtoFromJSON(json['recurringPrice']),
         'totalPrice': MoneyDtoFromJSON(json['totalPrice']),
@@ -450,8 +446,12 @@ export function SubscriptionDtoFromJSONTyped(json: any, ignoreDiscriminator: boo
         'address': AddressDtoFromJSON(json['address']),
         'locale': json['locale'],
         'companyInfo': SubscriptionCompanyInfoDtoFromJSON(json['companyInfo']),
+        'selfDeclaredTaxCountry': json['selfDeclaredTaxCountry'],
+        'decidedCountry': json['decidedCountry'],
         'transaction': InvoiceTransactionDtoFromJSON(json['transaction']),
         'hasPendingTransaction': json['hasPendingTransaction'],
+        'availablePaymentMethods': json['availablePaymentMethods'],
+        'selectedPaymentMethod': json['selectedPaymentMethod'],
         'domain': SubscriptionDomainDtoFromJSON(json['domain']),
         'type': json['type'],
         'installments': json['installments'],
@@ -480,10 +480,6 @@ export function SubscriptionDtoToJSONTyped(value?: SubscriptionDto | null, ignor
         'invoiceId': value['invoiceId'],
         'invoiceStatus': value['invoiceStatus'],
         'status': value['status'],
-        'selfDeclaredTaxCountry': value['selfDeclaredTaxCountry'],
-        'decidedCountry': value['decidedCountry'],
-        'availablePaymentMethods': value['availablePaymentMethods'],
-        'selectedPaymentMethod': value['selectedPaymentMethod'],
         'basePrice': MoneyDtoToJSON(value['basePrice']),
         'recurringPrice': MoneyDtoToJSON(value['recurringPrice']),
         'totalPrice': MoneyDtoToJSON(value['totalPrice']),
@@ -495,8 +491,12 @@ export function SubscriptionDtoToJSONTyped(value?: SubscriptionDto | null, ignor
         'address': AddressDtoToJSON(value['address']),
         'locale': value['locale'],
         'companyInfo': SubscriptionCompanyInfoDtoToJSON(value['companyInfo']),
+        'selfDeclaredTaxCountry': value['selfDeclaredTaxCountry'],
+        'decidedCountry': value['decidedCountry'],
         'transaction': InvoiceTransactionDtoToJSON(value['transaction']),
         'hasPendingTransaction': value['hasPendingTransaction'],
+        'availablePaymentMethods': value['availablePaymentMethods'],
+        'selectedPaymentMethod': value['selectedPaymentMethod'],
         'domain': SubscriptionDomainDtoToJSON(value['domain']),
         'type': value['type'],
         'installments': value['installments'],

package/src/models/SubscriptionLeaseToOwnConfigurationDto.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 SubscriptionLeaseToOwnConfigurationDto {
     /**
-     * Minimum months option
+     * Minimum months option.
      * @type {number}
      * @memberof SubscriptionLeaseToOwnConfigurationDto
      */
     minMonths: number;
     /**
-     * Maximum months option
+     * Maximum months option.
      * @type {number}
      * @memberof SubscriptionLeaseToOwnConfigurationDto
      */
     maxMonths: number;
     /**
-     * Total lease to own total subscription price
+     * Total lease-to-own subscription base price.
      * @type {MoneyDto}
      * @memberof SubscriptionLeaseToOwnConfigurationDto
      */
     basePrice: MoneyDto;
     /**
-     * Total lease to own recurring price
+     * Total lease-to-own recurring price.
      * @type {MoneyDto}
      * @memberof SubscriptionLeaseToOwnConfigurationDto
      */

package/src/models/SubscriptionListItemBillingPeriodicityDto.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 SubscriptionListItemBillingPeriodicityDto {
     /**
-     * 
+     * Billing period amount.
      * @type {number}
      * @memberof SubscriptionListItemBillingPeriodicityDto
      */
     amount: number;
     /**
-     * 
+     * Billing period unit.
      * @type {string}
      * @memberof SubscriptionListItemBillingPeriodicityDto
      */

package/src/models/SubscriptionListItemDto.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
  * 
@@ -70,151 +70,151 @@ import {
  */
 export interface SubscriptionListItemDto {
     /**
-     * The subscription ID
-     * @type {object}
+     * The subscription ID.
+     * @type {string}
      * @memberof SubscriptionListItemDto
      */
-    id: object;
+    id: string;
     /**
-     * The subscription status
+     * The subscription status.
      * @type {string}
      * @memberof SubscriptionListItemDto
      */
     status: SubscriptionListItemDtoStatusEnum;
     /**
-     * The subscription type
+     * The subscription type.
      * @type {string}
      * @memberof SubscriptionListItemDto
      */
     type: SubscriptionListItemDtoTypeEnum;
     /**
-     * The subscription start date
+     * The subscription start date.
      * @type {Date}
      * @memberof SubscriptionListItemDto
      */
     startedAt: Date | null;
     /**
-     * The subscription creation date
+     * The subscription creation date.
      * @type {Date}
      * @memberof SubscriptionListItemDto
      */
     createdAt: Date;
     /**
-     * The subscription schedule cancellation date
+     * The subscription schedule cancellation date.
      * @type {Date}
      * @memberof SubscriptionListItemDto
      */
     scheduledCancellationAt: Date | null;
     /**
-     * The subscription schedule cancellation reason
+     * The subscription schedule cancellation reason.
      * @type {string}
      * @memberof SubscriptionListItemDto
      */
     scheduledCancellationReason: SubscriptionListItemDtoScheduledCancellationReasonEnum | null;
     /**
-     * The subscription domain information
+     * The subscription domain information.
      * @type {SubscriptionListItemDtoDomainInformation}
      * @memberof SubscriptionListItemDto
      */
     domain: SubscriptionListItemDtoDomainInformation;
     /**
-     * The subscription seller information
+     * The subscription seller information.
      * @type {SubscriptionListItemDtoSellerAccount}
      * @memberof SubscriptionListItemDto
      */
     sellerAccount: SubscriptionListItemDtoSellerAccount;
     /**
-     * The subscription buyer information
+     * The subscription buyer information.
      * @type {SubscriptionListItemDtoBuyerInformation}
      * @memberof SubscriptionListItemDto
      */
     buyerInformation: SubscriptionListItemDtoBuyerInformation;
     /**
-     * The subscription base price
+     * The subscription base price.
      * @type {MoneyDto}
      * @memberof SubscriptionListItemDto
      */
     basePrice: MoneyDto;
     /**
-     * The subscription recurring price
+     * The subscription buyer recurring price.
      * @type {MoneyDto}
      * @memberof SubscriptionListItemDto
      */
     buyerRecurringPrice: MoneyDto;
     /**
-     * The subscription seller recurring price
+     * The subscription seller recurring price.
      * @type {MoneyDto}
      * @memberof SubscriptionListItemDto
      */
     sellerRecurringPrice: MoneyDto;
     /**
-     * The subscription installments number
+     * The subscription installments number.
      * @type {number}
      * @memberof SubscriptionListItemDto
      */
     installments: number | null;
     /**
-     * The subscription paid installments number
+     * The subscription paid buyer installments number.
      * @type {number}
      * @memberof SubscriptionListItemDto
      */
     paidBuyerInstallmentsNumber: number;
     /**
-     * The subscription paid seller installments number
+     * The subscription paid seller installments number.
      * @type {number}
      * @memberof SubscriptionListItemDto
      */
     paidSellerInstallmentsNumber: number;
     /**
-     * The subscription renew date
+     * The subscription renew date.
      * @type {Date}
      * @memberof SubscriptionListItemDto
      */
     renewAt: Date;
     /**
-     * The subscription renew retry date
+     * The subscription renew retry date.
      * @type {Date}
      * @memberof SubscriptionListItemDto
      */
     renewRetryAt: Date;
     /**
-     * The subscription renew status
+     * The subscription renew status.
      * @type {string}
      * @memberof SubscriptionListItemDto
      */
     renewStatus: SubscriptionListItemDtoRenewStatusEnum | null;
     /**
-     * The subscription renew status reason
+     * The subscription renew status reason.
      * @type {string}
      * @memberof SubscriptionListItemDto
      */
     renewStatusReason: SubscriptionListItemDtoRenewStatusReasonEnum | null;
     /**
-     * The number of failed renew intents
+     * The number of failed renew intents.
      * @type {number}
      * @memberof SubscriptionListItemDto
      */
     failedRenewIntents: number;
     /**
-     * The subscription recurring markup percentage
+     * The subscription recurring markup percentage.
      * @type {number}
      * @memberof SubscriptionListItemDto
      */
     recurringMarkupPercentage: number;
     /**
-     * The subscription recurring markup price
+     * The subscription recurring markup price.
      * @type {MoneyDto}
      * @memberof SubscriptionListItemDto
      */
     recurringMarkupPrice: MoneyDto;
     /**
-     * The subscription billing periodicity
+     * The subscription billing periodicity.
      * @type {SubscriptionListItemBillingPeriodicityDto}
      * @memberof SubscriptionListItemDto
      */
     billingPeriodicity: SubscriptionListItemBillingPeriodicityDto;
     /**
-     * The subscription seller lease to own kickback percentage
+     * The subscription seller lease-to-own kickback percentage.
      * @type {number}
      * @memberof SubscriptionListItemDto
      */
@@ -227,10 +227,10 @@ export interface SubscriptionListItemDto {
     isLeadImported: boolean;
     /**
      * The subscription lead ID.
-     * @type {object}
+     * @type {string}
      * @memberof SubscriptionListItemDto
      */
-    leadId: object | null;
+    leadId: string | null;
     /**
      * The selected invoice transaction data (paid one or latest fallback).
      * @type {SubscriptionListItemDtoTransaction}
@@ -238,41 +238,41 @@ export interface SubscriptionListItemDto {
      */
     transaction: SubscriptionListItemDtoTransaction | null;
     /**
-     * 
+     * Last rent indexation details.
      * @type {RentIndexationDto}
      * @memberof SubscriptionListItemDto
      */
     lastRentIndexation: RentIndexationDto | null;
     /**
-     * 
+     * Next eligible rent indexation date.
      * @type {Date}
      * @memberof SubscriptionListItemDto
      */
     nextEligibleRentIndexationDate: Date | null;
     /**
-     * 
+     * Rent indexation status.
      * @type {string}
      * @memberof SubscriptionListItemDto
      */
-    rentIndexationStatus: SubscriptionListItemDtoRentIndexationStatusEnum;
+    rentIndexationStatus: SubscriptionListItemDtoRentIndexationStatusEnum | null;
     /**
-     * 
+     * Rent indexation skip reason.
      * @type {string}
      * @memberof SubscriptionListItemDto
      */
-    rentIndexationSkipReason: SubscriptionListItemDtoRentIndexationSkipReasonEnum;
+    rentIndexationSkipReason: SubscriptionListItemDtoRentIndexationSkipReasonEnum | null;
     /**
-     * 
+     * Rent indexation advance notification date.
      * @type {Date}
      * @memberof SubscriptionListItemDto
      */
-    rentIndexationAdvanceNotifiedAt: Date;
+    rentIndexationAdvanceNotifiedAt: Date | null;
     /**
-     * 
+     * Inflation year for which advance notification was sent.
      * @type {number}
      * @memberof SubscriptionListItemDto
      */
-    rentIndexationAdvanceNotifiedForYear: number;
+    rentIndexationAdvanceNotifiedForYear: number | null;
 }
 
 
@@ -440,7 +440,7 @@ export function SubscriptionListItemDtoFromJSONTyped(json: any, ignoreDiscrimina
         'nextEligibleRentIndexationDate': (json['nextEligibleRentIndexationDate'] == null ? null : new Date(json['nextEligibleRentIndexationDate'])),
         'rentIndexationStatus': json['rentIndexationStatus'],
         'rentIndexationSkipReason': json['rentIndexationSkipReason'],
-        'rentIndexationAdvanceNotifiedAt': (new Date(json['rentIndexationAdvanceNotifiedAt'])),
+        'rentIndexationAdvanceNotifiedAt': (json['rentIndexationAdvanceNotifiedAt'] == null ? null : new Date(json['rentIndexationAdvanceNotifiedAt'])),
         'rentIndexationAdvanceNotifiedForYear': json['rentIndexationAdvanceNotifiedForYear'],
     };
 }
@@ -488,7 +488,7 @@ export function SubscriptionListItemDtoToJSONTyped(value?: SubscriptionListItemD
         'nextEligibleRentIndexationDate': (value['nextEligibleRentIndexationDate'] == null ? null : (value['nextEligibleRentIndexationDate'] as any).toISOString()),
         'rentIndexationStatus': value['rentIndexationStatus'],
         'rentIndexationSkipReason': value['rentIndexationSkipReason'],
-        'rentIndexationAdvanceNotifiedAt': ((value['rentIndexationAdvanceNotifiedAt']).toISOString()),
+        'rentIndexationAdvanceNotifiedAt': (value['rentIndexationAdvanceNotifiedAt'] == null ? null : (value['rentIndexationAdvanceNotifiedAt'] as any).toISOString()),
         'rentIndexationAdvanceNotifiedForYear': value['rentIndexationAdvanceNotifiedForYear'],
     };
 }