@randock/nameshift-api-client 0.0.448 → 0.0.450

package/src/models/ApiKeyDto.ts

@@ -0,0 +1,162 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ApiKeyDto
+ */
+export interface ApiKeyDto {
+    /**
+     * API key identifier.
+     * @type {string}
+     * @memberof ApiKeyDto
+     */
+    id: string;
+    /**
+     * Human readable name given to the key on creation.
+     * @type {string}
+     * @memberof ApiKeyDto
+     */
+    name: string;
+    /**
+     * Authorization scopes granted to this API key.
+     * @type {Array<string>}
+     * @memberof ApiKeyDto
+     */
+    scope: Array<ApiKeyDtoScopeEnum>;
+    /**
+     * Masked fragment of the token, for recognising the key in a list. The full token is only returned once, at creation.
+     * @type {string}
+     * @memberof ApiKeyDto
+     */
+    displayPrefix: string | null;
+    /**
+     * When the key was last used to authenticate. Accurate to within 15 minutes; null if never used.
+     * @type {Date}
+     * @memberof ApiKeyDto
+     */
+    lastUsedAt: Date | null;
+    /**
+     * When the key stops being accepted. Null if it never expires.
+     * @type {Date}
+     * @memberof ApiKeyDto
+     */
+    expiresAt: Date | null;
+    /**
+     * When the key was created.
+     * @type {Date}
+     * @memberof ApiKeyDto
+     */
+    createdAt: Date;
+}
+
+
+/**
+ * @export
+ */
+export const ApiKeyDtoScopeEnum = {
+    DOMAIN_BUY_NOW_PRICES_UPDATES: 'DOMAIN_BUY_NOW_PRICES_UPDATES',
+    DOMAINS_FIND: 'DOMAINS_FIND',
+    AUCTION_LIST: 'AUCTION_LIST',
+    MARKET_DATA: 'MARKET_DATA',
+    DOMAINS_READ: 'DOMAINS_READ',
+    DOMAINS_WRITE: 'DOMAINS_WRITE',
+    EPP_WRITE: 'EPP_WRITE',
+    TRANSFERS_READ: 'TRANSFERS_READ',
+    TRANSFERS_WRITE: 'TRANSFERS_WRITE',
+    LEADS_READ: 'LEADS_READ',
+    LEADS_WRITE: 'LEADS_WRITE',
+    AUCTIONS_READ: 'AUCTIONS_READ',
+    AUCTIONS_WRITE: 'AUCTIONS_WRITE',
+    STATS_READ: 'STATS_READ',
+    INVOICES_READ: 'INVOICES_READ',
+    SUBSCRIPTIONS_READ: 'SUBSCRIPTIONS_READ',
+    COMMISSIONS_READ: 'COMMISSIONS_READ',
+    TASKS_READ: 'TASKS_READ',
+    TASKS_WRITE: 'TASKS_WRITE',
+    NOTIFICATIONS_READ: 'NOTIFICATIONS_READ',
+    NOTIFICATIONS_WRITE: 'NOTIFICATIONS_WRITE',
+    CHALLENGES_READ: 'CHALLENGES_READ',
+    CHALLENGES_WRITE: 'CHALLENGES_WRITE',
+    ACCOUNT_READ: 'ACCOUNT_READ',
+    ACCOUNT_WRITE: 'ACCOUNT_WRITE',
+    ACCOUNT_DELETE: 'ACCOUNT_DELETE',
+    PAYOUTS_READ: 'PAYOUTS_READ',
+    PAYOUTS_WRITE: 'PAYOUTS_WRITE',
+    PAYMENTS_READ: 'PAYMENTS_READ',
+    PAYMENTS_WRITE: 'PAYMENTS_WRITE',
+    USERS_READ: 'USERS_READ',
+    USERS_WRITE: 'USERS_WRITE',
+    USER_EMAIL_WRITE: 'USER_EMAIL_WRITE'
+} as const;
+export type ApiKeyDtoScopeEnum = typeof ApiKeyDtoScopeEnum[keyof typeof ApiKeyDtoScopeEnum];
+
+
+/**
+ * Check if a given object implements the ApiKeyDto interface.
+ */
+export function instanceOfApiKeyDto(value: object): value is ApiKeyDto {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('scope' in value) || value['scope'] === undefined) return false;
+    if (!('displayPrefix' in value) || value['displayPrefix'] === undefined) return false;
+    if (!('lastUsedAt' in value) || value['lastUsedAt'] === undefined) return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function ApiKeyDtoFromJSON(json: any): ApiKeyDto {
+    return ApiKeyDtoFromJSONTyped(json, false);
+}
+
+export function ApiKeyDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiKeyDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'scope': json['scope'],
+        'displayPrefix': json['displayPrefix'],
+        'lastUsedAt': (json['lastUsedAt'] == null ? null : new Date(json['lastUsedAt'])),
+        'expiresAt': (json['expiresAt'] == null ? null : new Date(json['expiresAt'])),
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+
+export function ApiKeyDtoToJSON(json: any): ApiKeyDto {
+    return ApiKeyDtoToJSONTyped(json, false);
+}
+
+export function ApiKeyDtoToJSONTyped(value?: ApiKeyDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'scope': value['scope'],
+        'displayPrefix': value['displayPrefix'],
+        'lastUsedAt': (value['lastUsedAt'] == null ? null : (value['lastUsedAt'] as any).toISOString()),
+        'expiresAt': (value['expiresAt'] == null ? null : (value['expiresAt'] as any).toISOString()),
+        'createdAt': ((value['createdAt']).toISOString()),
+    };
+}
+

package/src/models/ApiKeyScopeDto.ts

@@ -0,0 +1,126 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ApiKeyScopeDto
+ */
+export interface ApiKeyScopeDto {
+    /**
+     * Scope value to send when creating or updating a key.
+     * @type {string}
+     * @memberof ApiKeyScopeDto
+     */
+    scope: ApiKeyScopeDtoScopeEnum;
+    /**
+     * What holding this scope allows the key to do.
+     * @type {string}
+     * @memberof ApiKeyScopeDto
+     */
+    description: string;
+    /**
+     * Whether the scope grants irreversible or account-takeover adjacent access, and should therefore be confirmed separately before being granted.
+     * @type {boolean}
+     * @memberof ApiKeyScopeDto
+     */
+    sensitive: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const ApiKeyScopeDtoScopeEnum = {
+    DOMAIN_BUY_NOW_PRICES_UPDATES: 'DOMAIN_BUY_NOW_PRICES_UPDATES',
+    DOMAINS_FIND: 'DOMAINS_FIND',
+    AUCTION_LIST: 'AUCTION_LIST',
+    MARKET_DATA: 'MARKET_DATA',
+    DOMAINS_READ: 'DOMAINS_READ',
+    DOMAINS_WRITE: 'DOMAINS_WRITE',
+    EPP_WRITE: 'EPP_WRITE',
+    TRANSFERS_READ: 'TRANSFERS_READ',
+    TRANSFERS_WRITE: 'TRANSFERS_WRITE',
+    LEADS_READ: 'LEADS_READ',
+    LEADS_WRITE: 'LEADS_WRITE',
+    AUCTIONS_READ: 'AUCTIONS_READ',
+    AUCTIONS_WRITE: 'AUCTIONS_WRITE',
+    STATS_READ: 'STATS_READ',
+    INVOICES_READ: 'INVOICES_READ',
+    SUBSCRIPTIONS_READ: 'SUBSCRIPTIONS_READ',
+    COMMISSIONS_READ: 'COMMISSIONS_READ',
+    TASKS_READ: 'TASKS_READ',
+    TASKS_WRITE: 'TASKS_WRITE',
+    NOTIFICATIONS_READ: 'NOTIFICATIONS_READ',
+    NOTIFICATIONS_WRITE: 'NOTIFICATIONS_WRITE',
+    CHALLENGES_READ: 'CHALLENGES_READ',
+    CHALLENGES_WRITE: 'CHALLENGES_WRITE',
+    ACCOUNT_READ: 'ACCOUNT_READ',
+    ACCOUNT_WRITE: 'ACCOUNT_WRITE',
+    ACCOUNT_DELETE: 'ACCOUNT_DELETE',
+    PAYOUTS_READ: 'PAYOUTS_READ',
+    PAYOUTS_WRITE: 'PAYOUTS_WRITE',
+    PAYMENTS_READ: 'PAYMENTS_READ',
+    PAYMENTS_WRITE: 'PAYMENTS_WRITE',
+    USERS_READ: 'USERS_READ',
+    USERS_WRITE: 'USERS_WRITE',
+    USER_EMAIL_WRITE: 'USER_EMAIL_WRITE'
+} as const;
+export type ApiKeyScopeDtoScopeEnum = typeof ApiKeyScopeDtoScopeEnum[keyof typeof ApiKeyScopeDtoScopeEnum];
+
+
+/**
+ * Check if a given object implements the ApiKeyScopeDto interface.
+ */
+export function instanceOfApiKeyScopeDto(value: object): value is ApiKeyScopeDto {
+    if (!('scope' in value) || value['scope'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('sensitive' in value) || value['sensitive'] === undefined) return false;
+    return true;
+}
+
+export function ApiKeyScopeDtoFromJSON(json: any): ApiKeyScopeDto {
+    return ApiKeyScopeDtoFromJSONTyped(json, false);
+}
+
+export function ApiKeyScopeDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiKeyScopeDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'scope': json['scope'],
+        'description': json['description'],
+        'sensitive': json['sensitive'],
+    };
+}
+
+export function ApiKeyScopeDtoToJSON(json: any): ApiKeyScopeDto {
+    return ApiKeyScopeDtoToJSONTyped(json, false);
+}
+
+export function ApiKeyScopeDtoToJSONTyped(value?: ApiKeyScopeDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'scope': value['scope'],
+        'description': value['description'],
+        'sensitive': value['sensitive'],
+    };
+}
+

package/src/models/CommissionDto.ts

@@ -130,6 +130,7 @@ export type CommissionDtoTypeEnum = typeof CommissionDtoTypeEnum[keyof typeof Co
 export const CommissionDtoSubtypeEnum = {
     POINTING: 'pointing',
     NOT_POINTING: 'not_pointing',
+    ROUTED: 'routed',
     MANUAL_LEAD: 'manual_lead',
     AUCTION: 'auction'
 } as const;

package/src/models/CommissionPayloadInput.ts

@@ -111,6 +111,7 @@ export type CommissionPayloadInputTypeEnum = typeof CommissionPayloadInputTypeEn
 export const CommissionPayloadInputSubtypeEnum = {
     POINTING: 'pointing',
     NOT_POINTING: 'not_pointing',
+    ROUTED: 'routed',
     MANUAL_LEAD: 'manual_lead',
     AUCTION: 'auction'
 } as const;

package/src/models/CommissionReasonDto.ts

@@ -148,6 +148,7 @@ export type CommissionReasonDtoTypeEnum = typeof CommissionReasonDtoTypeEnum[key
 export const CommissionReasonDtoSubtypeEnum = {
     POINTING: 'pointing',
     NOT_POINTING: 'not_pointing',
+    ROUTED: 'routed',
     MANUAL_LEAD: 'manual_lead',
     AUCTION: 'auction'
 } as const;

package/src/models/CommissionSimulationItemInput.ts

@@ -123,6 +123,7 @@ export type CommissionSimulationItemInputTypeEnum = typeof CommissionSimulationI
 export const CommissionSimulationItemInputSubtypeEnum = {
     POINTING: 'pointing',
     NOT_POINTING: 'not_pointing',
+    ROUTED: 'routed',
     MANUAL_LEAD: 'manual_lead',
     AUCTION: 'auction'
 } as const;

package/src/models/CreateApiKeyInput.ts

@@ -0,0 +1,125 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface CreateApiKeyInput
+ */
+export interface CreateApiKeyInput {
+    /**
+     * Name to recognise the key by, for example the integration that will use it.
+     * @type {string}
+     * @memberof CreateApiKeyInput
+     */
+    name: string;
+    /**
+     * Scopes to grant. Must be a subset of the scopes returned by the available-scopes endpoint; a key can only reach endpoints covered by its scopes.
+     * @type {Array<string>}
+     * @memberof CreateApiKeyInput
+     */
+    scope: Array<CreateApiKeyInputScopeEnum>;
+    /**
+     * When the key should stop working. Omit for a key that never expires.
+     * @type {Date}
+     * @memberof CreateApiKeyInput
+     */
+    expiresAt?: Date;
+}
+
+
+/**
+ * @export
+ */
+export const CreateApiKeyInputScopeEnum = {
+    DOMAIN_BUY_NOW_PRICES_UPDATES: 'DOMAIN_BUY_NOW_PRICES_UPDATES',
+    DOMAINS_FIND: 'DOMAINS_FIND',
+    AUCTION_LIST: 'AUCTION_LIST',
+    MARKET_DATA: 'MARKET_DATA',
+    DOMAINS_READ: 'DOMAINS_READ',
+    DOMAINS_WRITE: 'DOMAINS_WRITE',
+    EPP_WRITE: 'EPP_WRITE',
+    TRANSFERS_READ: 'TRANSFERS_READ',
+    TRANSFERS_WRITE: 'TRANSFERS_WRITE',
+    LEADS_READ: 'LEADS_READ',
+    LEADS_WRITE: 'LEADS_WRITE',
+    AUCTIONS_READ: 'AUCTIONS_READ',
+    AUCTIONS_WRITE: 'AUCTIONS_WRITE',
+    STATS_READ: 'STATS_READ',
+    INVOICES_READ: 'INVOICES_READ',
+    SUBSCRIPTIONS_READ: 'SUBSCRIPTIONS_READ',
+    COMMISSIONS_READ: 'COMMISSIONS_READ',
+    TASKS_READ: 'TASKS_READ',
+    TASKS_WRITE: 'TASKS_WRITE',
+    NOTIFICATIONS_READ: 'NOTIFICATIONS_READ',
+    NOTIFICATIONS_WRITE: 'NOTIFICATIONS_WRITE',
+    CHALLENGES_READ: 'CHALLENGES_READ',
+    CHALLENGES_WRITE: 'CHALLENGES_WRITE',
+    ACCOUNT_READ: 'ACCOUNT_READ',
+    ACCOUNT_WRITE: 'ACCOUNT_WRITE',
+    ACCOUNT_DELETE: 'ACCOUNT_DELETE',
+    PAYOUTS_READ: 'PAYOUTS_READ',
+    PAYOUTS_WRITE: 'PAYOUTS_WRITE',
+    PAYMENTS_READ: 'PAYMENTS_READ',
+    PAYMENTS_WRITE: 'PAYMENTS_WRITE',
+    USERS_READ: 'USERS_READ',
+    USERS_WRITE: 'USERS_WRITE',
+    USER_EMAIL_WRITE: 'USER_EMAIL_WRITE'
+} as const;
+export type CreateApiKeyInputScopeEnum = typeof CreateApiKeyInputScopeEnum[keyof typeof CreateApiKeyInputScopeEnum];
+
+
+/**
+ * Check if a given object implements the CreateApiKeyInput interface.
+ */
+export function instanceOfCreateApiKeyInput(value: object): value is CreateApiKeyInput {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('scope' in value) || value['scope'] === undefined) return false;
+    return true;
+}
+
+export function CreateApiKeyInputFromJSON(json: any): CreateApiKeyInput {
+    return CreateApiKeyInputFromJSONTyped(json, false);
+}
+
+export function CreateApiKeyInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateApiKeyInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'scope': json['scope'],
+        'expiresAt': json['expiresAt'] == null ? undefined : (new Date(json['expiresAt'])),
+    };
+}
+
+export function CreateApiKeyInputToJSON(json: any): CreateApiKeyInput {
+    return CreateApiKeyInputToJSONTyped(json, false);
+}
+
+export function CreateApiKeyInputToJSONTyped(value?: CreateApiKeyInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'scope': value['scope'],
+        'expiresAt': value['expiresAt'] == null ? undefined : ((value['expiresAt']).toISOString()),
+    };
+}
+

package/src/models/CreateOrderInput.ts

@@ -99,6 +99,12 @@ export interface CreateOrderInput {
      * @memberof CreateOrderInput
      */
     selfDeclaredTaxCountry?: string;
+    /**
+     * Controls payment methods cache refresh. true: force recalculation even if the fingerprint is still valid. false: never refresh payment methods on this update. omit/undefined: refresh only when the cache is missing or the fingerprint changed.
+     * @type {boolean}
+     * @memberof CreateOrderInput
+     */
+    forceUpdatePaymentMethods?: boolean;
     /**
      * Full domain name to purchase
      * @type {string}
@@ -149,6 +155,7 @@ export function CreateOrderInputFromJSONTyped(json: any, ignoreDiscriminator: bo
         'addressCity': json['addressCity'] == null ? undefined : json['addressCity'],
         'companyInfo': json['companyInfo'] == null ? undefined : OrderCompanyInfoDtoFromJSON(json['companyInfo']),
         'selfDeclaredTaxCountry': json['selfDeclaredTaxCountry'] == null ? undefined : json['selfDeclaredTaxCountry'],
+        'forceUpdatePaymentMethods': json['forceUpdatePaymentMethods'] == null ? undefined : json['forceUpdatePaymentMethods'],
         'domainName': json['domainName'],
         'leadId': json['leadId'] == null ? undefined : json['leadId'],
         'affiliateId': json['affiliateId'] == null ? undefined : json['affiliateId'],
@@ -178,6 +185,7 @@ export function CreateOrderInputToJSONTyped(value?: CreateOrderInput | null, ign
         'addressCity': value['addressCity'],
         'companyInfo': OrderCompanyInfoDtoToJSON(value['companyInfo']),
         'selfDeclaredTaxCountry': value['selfDeclaredTaxCountry'],
+        'forceUpdatePaymentMethods': value['forceUpdatePaymentMethods'],
         'domainName': value['domainName'],
         'leadId': value['leadId'],
         'affiliateId': value['affiliateId'],

package/src/models/CreateSubscriptionInput.ts

@@ -118,6 +118,12 @@ export interface CreateSubscriptionInput {
      * @memberof CreateSubscriptionInput
      */
     selfDeclaredTaxCountry?: string;
+    /**
+     * Controls payment methods cache refresh. true: force recalculation even if the fingerprint is still valid. false: never refresh payment methods on this update. omit/undefined: refresh only when the cache is missing or the fingerprint changed.
+     * @type {boolean}
+     * @memberof CreateSubscriptionInput
+     */
+    forceUpdatePaymentMethods?: boolean;
     /**
      * Full domain name for the subscription
      * @type {string}
@@ -182,6 +188,7 @@ export function CreateSubscriptionInputFromJSONTyped(json: any, ignoreDiscrimina
         'addressCity': json['addressCity'] == null ? undefined : json['addressCity'],
         'companyInfo': json['companyInfo'] == null ? undefined : SubscriptionCompanyInfoDtoFromJSON(json['companyInfo']),
         'selfDeclaredTaxCountry': json['selfDeclaredTaxCountry'] == null ? undefined : json['selfDeclaredTaxCountry'],
+        'forceUpdatePaymentMethods': json['forceUpdatePaymentMethods'] == null ? undefined : json['forceUpdatePaymentMethods'],
         'domainName': json['domainName'],
         'subscriptionType': json['subscriptionType'],
         'affiliateId': json['affiliateId'] == null ? undefined : json['affiliateId'],
@@ -213,6 +220,7 @@ export function CreateSubscriptionInputToJSONTyped(value?: CreateSubscriptionInp
         'addressCity': value['addressCity'],
         'companyInfo': SubscriptionCompanyInfoDtoToJSON(value['companyInfo']),
         'selfDeclaredTaxCountry': value['selfDeclaredTaxCountry'],
+        'forceUpdatePaymentMethods': value['forceUpdatePaymentMethods'],
         'domainName': value['domainName'],
         'subscriptionType': value['subscriptionType'],
         'affiliateId': value['affiliateId'],

package/src/models/CreatedApiKeyDto.ts

@@ -0,0 +1,171 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface CreatedApiKeyDto
+ */
+export interface CreatedApiKeyDto {
+    /**
+     * API key identifier.
+     * @type {string}
+     * @memberof CreatedApiKeyDto
+     */
+    id: string;
+    /**
+     * Human readable name given to the key on creation.
+     * @type {string}
+     * @memberof CreatedApiKeyDto
+     */
+    name: string;
+    /**
+     * Authorization scopes granted to this API key.
+     * @type {Array<string>}
+     * @memberof CreatedApiKeyDto
+     */
+    scope: Array<CreatedApiKeyDtoScopeEnum>;
+    /**
+     * Masked fragment of the token, for recognising the key in a list. The full token is only returned once, at creation.
+     * @type {string}
+     * @memberof CreatedApiKeyDto
+     */
+    displayPrefix: string | null;
+    /**
+     * When the key was last used to authenticate. Accurate to within 15 minutes; null if never used.
+     * @type {Date}
+     * @memberof CreatedApiKeyDto
+     */
+    lastUsedAt: Date | null;
+    /**
+     * When the key stops being accepted. Null if it never expires.
+     * @type {Date}
+     * @memberof CreatedApiKeyDto
+     */
+    expiresAt: Date | null;
+    /**
+     * When the key was created.
+     * @type {Date}
+     * @memberof CreatedApiKeyDto
+     */
+    createdAt: Date;
+    /**
+     * The API key token. Shown only once, on creation, and unrecoverable afterwards. Send it in the `apikey` request header.
+     * @type {string}
+     * @memberof CreatedApiKeyDto
+     */
+    token: string;
+}
+
+
+/**
+ * @export
+ */
+export const CreatedApiKeyDtoScopeEnum = {
+    DOMAIN_BUY_NOW_PRICES_UPDATES: 'DOMAIN_BUY_NOW_PRICES_UPDATES',
+    DOMAINS_FIND: 'DOMAINS_FIND',
+    AUCTION_LIST: 'AUCTION_LIST',
+    MARKET_DATA: 'MARKET_DATA',
+    DOMAINS_READ: 'DOMAINS_READ',
+    DOMAINS_WRITE: 'DOMAINS_WRITE',
+    EPP_WRITE: 'EPP_WRITE',
+    TRANSFERS_READ: 'TRANSFERS_READ',
+    TRANSFERS_WRITE: 'TRANSFERS_WRITE',
+    LEADS_READ: 'LEADS_READ',
+    LEADS_WRITE: 'LEADS_WRITE',
+    AUCTIONS_READ: 'AUCTIONS_READ',
+    AUCTIONS_WRITE: 'AUCTIONS_WRITE',
+    STATS_READ: 'STATS_READ',
+    INVOICES_READ: 'INVOICES_READ',
+    SUBSCRIPTIONS_READ: 'SUBSCRIPTIONS_READ',
+    COMMISSIONS_READ: 'COMMISSIONS_READ',
+    TASKS_READ: 'TASKS_READ',
+    TASKS_WRITE: 'TASKS_WRITE',
+    NOTIFICATIONS_READ: 'NOTIFICATIONS_READ',
+    NOTIFICATIONS_WRITE: 'NOTIFICATIONS_WRITE',
+    CHALLENGES_READ: 'CHALLENGES_READ',
+    CHALLENGES_WRITE: 'CHALLENGES_WRITE',
+    ACCOUNT_READ: 'ACCOUNT_READ',
+    ACCOUNT_WRITE: 'ACCOUNT_WRITE',
+    ACCOUNT_DELETE: 'ACCOUNT_DELETE',
+    PAYOUTS_READ: 'PAYOUTS_READ',
+    PAYOUTS_WRITE: 'PAYOUTS_WRITE',
+    PAYMENTS_READ: 'PAYMENTS_READ',
+    PAYMENTS_WRITE: 'PAYMENTS_WRITE',
+    USERS_READ: 'USERS_READ',
+    USERS_WRITE: 'USERS_WRITE',
+    USER_EMAIL_WRITE: 'USER_EMAIL_WRITE'
+} as const;
+export type CreatedApiKeyDtoScopeEnum = typeof CreatedApiKeyDtoScopeEnum[keyof typeof CreatedApiKeyDtoScopeEnum];
+
+
+/**
+ * Check if a given object implements the CreatedApiKeyDto interface.
+ */
+export function instanceOfCreatedApiKeyDto(value: object): value is CreatedApiKeyDto {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('scope' in value) || value['scope'] === undefined) return false;
+    if (!('displayPrefix' in value) || value['displayPrefix'] === undefined) return false;
+    if (!('lastUsedAt' in value) || value['lastUsedAt'] === undefined) return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('token' in value) || value['token'] === undefined) return false;
+    return true;
+}
+
+export function CreatedApiKeyDtoFromJSON(json: any): CreatedApiKeyDto {
+    return CreatedApiKeyDtoFromJSONTyped(json, false);
+}
+
+export function CreatedApiKeyDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatedApiKeyDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'scope': json['scope'],
+        'displayPrefix': json['displayPrefix'],
+        'lastUsedAt': (json['lastUsedAt'] == null ? null : new Date(json['lastUsedAt'])),
+        'expiresAt': (json['expiresAt'] == null ? null : new Date(json['expiresAt'])),
+        'createdAt': (new Date(json['createdAt'])),
+        'token': json['token'],
+    };
+}
+
+export function CreatedApiKeyDtoToJSON(json: any): CreatedApiKeyDto {
+    return CreatedApiKeyDtoToJSONTyped(json, false);
+}
+
+export function CreatedApiKeyDtoToJSONTyped(value?: CreatedApiKeyDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'scope': value['scope'],
+        'displayPrefix': value['displayPrefix'],
+        'lastUsedAt': (value['lastUsedAt'] == null ? null : (value['lastUsedAt'] as any).toISOString()),
+        'expiresAt': (value['expiresAt'] == null ? null : (value['expiresAt'] as any).toISOString()),
+        'createdAt': ((value['createdAt']).toISOString()),
+        'token': value['token'],
+    };
+}
+