@randock/nameshift-api-client 0.0.436 → 0.0.438

package/dist/models/BuyerLeadListItemDto.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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
  *
@@ -49,43 +49,43 @@ export interface BuyerLeadListItemDto {
      */
     lastOfferType: BuyerLeadListItemDtoLastOfferTypeEnum | null;
     /**
-     * Lease to own configuration
+     * Lease-to-own configuration for the lead, if applicable.
      * @type {LeaseToOwnConfigurationDto}
      * @memberof BuyerLeadListItemDto
      */
     leaseToOwn: LeaseToOwnConfigurationDto | null;
     /**
-     * Created at date
+     * Date and time when the lead was created.
      * @type {Date}
      * @memberof BuyerLeadListItemDto
      */
     createdAt: Date;
     /**
-     * The lead domain information
+     * Domain information associated with the lead.
      * @type {BuyerLeadListItemDomainDto}
      * @memberof BuyerLeadListItemDto
      */
     domain: BuyerLeadListItemDomainDto;
     /**
-     * Buyer unread messages number *
+     * Number of unread messages for the buyer.
      * @type {number}
      * @memberof BuyerLeadListItemDto
      */
     unreadMessages: number;
     /**
-     * Lead order payment URL
+     * URL for the buyer to complete order payment, if available.
      * @type {string}
      * @memberof BuyerLeadListItemDto
      */
     orderPaymentUrl: string | null;
     /**
-     *
+     * Whether the lead is muted for the buyer.
      * @type {boolean}
      * @memberof BuyerLeadListItemDto
      */
     isMuted: boolean;
     /**
-     * The lead is offer expired
+     * Whether the active offer on the lead has expired.
      * @type {boolean}
      * @memberof BuyerLeadListItemDto
      */

package/dist/models/BuyerLeadListItemDto.js

@@ -3,7 +3,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/dist/models/BuyerNotificationAttachmentDto.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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
  *
@@ -16,19 +16,19 @@
  */
 export interface BuyerNotificationAttachmentDto {
     /**
-     *
+     * Attachment ID.
      * @type {string}
      * @memberof BuyerNotificationAttachmentDto
      */
     id: string;
     /**
-     *
+     * Attachment filename.
      * @type {string}
      * @memberof BuyerNotificationAttachmentDto
      */
     filename: string;
     /**
-     *
+     * Attachment MIME type.
      * @type {string}
      * @memberof BuyerNotificationAttachmentDto
      */

package/dist/models/BuyerNotificationAttachmentDto.js

@@ -3,7 +3,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/dist/models/BuyerNotificationDto.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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
  *
@@ -17,43 +17,43 @@ import type { BuyerNotificationAttachmentDto } from './BuyerNotificationAttachme
  */
 export interface BuyerNotificationDto {
     /**
-     *
+     * Notification ID.
      * @type {string}
      * @memberof BuyerNotificationDto
      */
     id: string;
     /**
-     *
+     * Notification type.
      * @type {string}
      * @memberof BuyerNotificationDto
      */
     type: BuyerNotificationDtoTypeEnum;
     /**
-     *
+     * Whether the notification has been read.
      * @type {boolean}
      * @memberof BuyerNotificationDto
      */
     isRead: boolean;
     /**
-     *
+     * Date when the notification was sent.
      * @type {Date}
      * @memberof BuyerNotificationDto
      */
     sentAt: Date;
     /**
-     *
+     * Notification email subject.
      * @type {string}
      * @memberof BuyerNotificationDto
      */
     subject: string;
     /**
-     *
+     * Notification email body.
      * @type {string}
      * @memberof BuyerNotificationDto
      */
     body: string;
     /**
-     *
+     * Notification attachments.
      * @type {Array<BuyerNotificationAttachmentDto>}
      * @memberof BuyerNotificationDto
      */

package/dist/models/BuyerNotificationDto.js

@@ -3,7 +3,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/dist/models/BuyerNotificationListItemDto.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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
  *
@@ -16,37 +16,37 @@
  */
 export interface BuyerNotificationListItemDto {
     /**
-     *
+     * Notification ID.
      * @type {string}
      * @memberof BuyerNotificationListItemDto
      */
     id: string;
     /**
-     *
+     * Notification type.
      * @type {string}
      * @memberof BuyerNotificationListItemDto
      */
     type: BuyerNotificationListItemDtoTypeEnum;
     /**
-     *
+     * Whether the notification has been read.
      * @type {boolean}
      * @memberof BuyerNotificationListItemDto
      */
     isRead: boolean;
     /**
-     *
+     * Date when the notification was sent.
      * @type {Date}
      * @memberof BuyerNotificationListItemDto
      */
     sentAt: Date;
     /**
-     *
+     * Notification email subject.
      * @type {string}
      * @memberof BuyerNotificationListItemDto
      */
     subject: string;
     /**
-     *
+     * Whether the notification has attachments.
      * @type {boolean}
      * @memberof BuyerNotificationListItemDto
      */

package/dist/models/BuyerNotificationListItemDto.js

@@ -3,7 +3,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/dist/models/BuyerNotificationSettingsDto.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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
  *
@@ -16,7 +16,7 @@
  */
 export interface BuyerNotificationSettingsDto {
     /**
-     *
+     * Whether all buyer notifications are disabled globally.
      * @type {boolean}
      * @memberof BuyerNotificationSettingsDto
      */

package/dist/models/BuyerNotificationSettingsDto.js

@@ -3,7 +3,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/dist/models/BuyerSecurityUserDto.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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
  *
@@ -16,37 +16,37 @@
  */
 export interface BuyerSecurityUserDto {
     /**
-     *
+     * Buyer ID.
      * @type {string}
      * @memberof BuyerSecurityUserDto
      */
     id: string;
     /**
-     *
+     * User email address.
      * @type {string}
      * @memberof BuyerSecurityUserDto
      */
     email: string;
     /**
-     *
+     * Intercom identity verification hash.
      * @type {string}
      * @memberof BuyerSecurityUserDto
      */
     intercomHash: string;
     /**
-     *
+     * User locale (e.g. en, nl).
      * @type {string}
      * @memberof BuyerSecurityUserDto
      */
     locale: string;
     /**
-     *
+     * Assigned security roles.
      * @type {Array<string>}
      * @memberof BuyerSecurityUserDto
      */
     roles: Array<string>;
     /**
-     *
+     * Security user type: buyer.
      * @type {string}
      * @memberof BuyerSecurityUserDto
      */

package/dist/models/BuyerSecurityUserDto.js

@@ -3,7 +3,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/dist/models/BuyerSessionDto.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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
  *
@@ -16,55 +16,55 @@
  */
 export interface BuyerSessionDto {
     /**
-     *
+     * Buyer ID.
      * @type {string}
      * @memberof BuyerSessionDto
      */
     id: string;
     /**
-     *
+     * User email address.
      * @type {string}
      * @memberof BuyerSessionDto
      */
     email: string;
     /**
-     *
+     * Intercom identity verification hash.
      * @type {string}
      * @memberof BuyerSessionDto
      */
     intercomHash: string;
     /**
-     *
+     * User locale (e.g. en, nl).
      * @type {string}
      * @memberof BuyerSessionDto
      */
     locale: string;
     /**
-     *
+     * Assigned security roles.
      * @type {Array<string>}
      * @memberof BuyerSessionDto
      */
     roles: Array<string>;
     /**
-     *
+     * Security user type: buyer.
      * @type {string}
      * @memberof BuyerSessionDto
      */
     type: BuyerSessionDtoTypeEnum;
     /**
-     *
+     * Whether the buyer has active subscriptions
      * @type {boolean}
      * @memberof BuyerSessionDto
      */
     hasSubscriptions: boolean;
     /**
-     *
+     * Count of unread notifications for the buyer
      * @type {number}
      * @memberof BuyerSessionDto
      */
     unreadNotificationsNumber: number;
     /**
-     *
+     * Whether the buyer has active auction participations
      * @type {boolean}
      * @memberof BuyerSessionDto
      */

package/dist/models/BuyerSessionDto.js

@@ -3,7 +3,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/dist/models/BuyerSubscriptionListItemDto.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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
  *
@@ -18,91 +18,91 @@ import type { MoneyDto } from './MoneyDto';
  */
 export interface BuyerSubscriptionListItemDto {
     /**
-     * The subscription ID
-     * @type {object}
+     * The subscription ID.
+     * @type {string}
      * @memberof BuyerSubscriptionListItemDto
      */
-    id: object;
+    id: string;
     /**
-     * The subscription status
+     * The subscription status.
      * @type {string}
      * @memberof BuyerSubscriptionListItemDto
      */
     status: BuyerSubscriptionListItemDtoStatusEnum;
     /**
-     * The subscription type
+     * The subscription type.
      * @type {string}
      * @memberof BuyerSubscriptionListItemDto
      */
     type: BuyerSubscriptionListItemDtoTypeEnum;
     /**
-     * The subscription start date
+     * The subscription start date.
      * @type {Date}
      * @memberof BuyerSubscriptionListItemDto
      */
     startedAt: Date | null;
     /**
-     * The subscription creation date
+     * The subscription creation date.
      * @type {Date}
      * @memberof BuyerSubscriptionListItemDto
      */
     createdAt: Date;
     /**
-     * The subscription schedule cancellation date
+     * The subscription schedule cancellation date.
      * @type {Date}
      * @memberof BuyerSubscriptionListItemDto
      */
     scheduledCancellationAt: Date | null;
     /**
-     * The subscription schedule cancellation reason
+     * The subscription schedule cancellation reason.
      * @type {string}
      * @memberof BuyerSubscriptionListItemDto
      */
     scheduledCancellationReason: BuyerSubscriptionListItemDtoScheduledCancellationReasonEnum | null;
     /**
-     * The subscription domain information
+     * The subscription domain information.
      * @type {BuyerSubscriptionListItemDtoDomainInformation}
      * @memberof BuyerSubscriptionListItemDto
      */
     domain: BuyerSubscriptionListItemDtoDomainInformation;
     /**
-     * The subscription base price
+     * The subscription base price.
      * @type {MoneyDto}
      * @memberof BuyerSubscriptionListItemDto
      */
     basePrice: MoneyDto;
     /**
-     * The subscription buyer recurring price
+     * The subscription buyer recurring price.
      * @type {MoneyDto}
      * @memberof BuyerSubscriptionListItemDto
      */
     recurringPrice: MoneyDto;
     /**
-     * The subscription buyer installments number
+     * The subscription buyer installments number.
      * @type {number}
      * @memberof BuyerSubscriptionListItemDto
      */
     installments: number | null;
     /**
-     * The subscription buyer paid installments number
+     * The subscription buyer paid installments number.
      * @type {number}
      * @memberof BuyerSubscriptionListItemDto
      */
     paidInstallmentsNumber: number;
     /**
-     * The subscription renew date
+     * The subscription renew date.
      * @type {Date}
      * @memberof BuyerSubscriptionListItemDto
      */
     renewAt: Date;
     /**
-     * The subscription payment URL
+     * The subscription payment URL for overdue installments.
      * @type {string}
      * @memberof BuyerSubscriptionListItemDto
      */
     paymentUrl: string | null;
     /**
-     * Whether the user can manage domain DNSs (subscription active, owned domain has externalId and status finished)
+     * Whether the user can manage domain DNS (subscription active, owned domain has externalId and status finished).
      * @type {boolean}
      * @memberof BuyerSubscriptionListItemDto
      */

package/dist/models/BuyerSubscriptionListItemDto.js

@@ -3,7 +3,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/dist/models/BuyerSubscriptionListItemDtoDomainInformation.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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
  *
@@ -16,19 +16,19 @@
  */
 export interface BuyerSubscriptionListItemDtoDomainInformation {
     /**
-     * The subscription domain TLD
+     * The subscription domain TLD.
      * @type {string}
      * @memberof BuyerSubscriptionListItemDtoDomainInformation
      */
     tld: string;
     /**
-     * The subscription domain name
+     * The subscription domain name.
      * @type {string}
      * @memberof BuyerSubscriptionListItemDtoDomainInformation
      */
     name: string;
     /**
-     * The subscription domain name
+     * The subscription domain display name.
      * @type {string}
      * @memberof BuyerSubscriptionListItemDtoDomainInformation
      */

package/dist/models/BuyerSubscriptionListItemDtoDomainInformation.js

@@ -3,7 +3,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/dist/models/BuyerTaskDetailsDto.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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
  *
@@ -79,13 +79,13 @@ export interface BuyerTaskDetailsDto {
      */
     domainTransfer: TaskListDomainTransferDto | null;
     /**
-     * Whether the task is muted for the buyer
+     * Whether the task is muted for the buyer.
      * @type {boolean}
      * @memberof BuyerTaskDetailsDto
      */
     isMutedForBuyer: boolean;
     /**
-     * The buyer this task belongs to
+     * The buyer this task belongs to.
      * @type {string}
      * @memberof BuyerTaskDetailsDto
      */

package/dist/models/BuyerTaskDetailsDto.js

@@ -3,7 +3,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/dist/models/CaBankAccountDetails.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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
  *
@@ -16,31 +16,31 @@
  */
 export interface CaBankAccountDetails {
     /**
-     *
+     * Discriminator identifying the bank account details schema.
      * @type {string}
      * @memberof CaBankAccountDetails
      */
     type: CaBankAccountDetailsTypeEnum;
     /**
-     *
+     * ISO country code (CA).
      * @type {string}
      * @memberof CaBankAccountDetails
      */
     countryCode: string;
     /**
-     *
+     * Canadian financial institution number.
      * @type {string}
      * @memberof CaBankAccountDetails
      */
     financialInstitutionNumber: string;
     /**
-     *
+     * Canadian transit number.
      * @type {string}
      * @memberof CaBankAccountDetails
      */
     transitNumber: string;
     /**
-     *
+     * Canadian account number.
      * @type {string}
      * @memberof CaBankAccountDetails
      */