@randock/nameshift-api-client 0.0.444 → 0.0.446

package/src/models/CommissionReasonDto.ts

@@ -88,6 +88,18 @@ export interface CommissionReasonDto {
      * @memberof CommissionReasonDto
      */
     excludedAccountIds?: Array<string>;
+    /**
+     * Domain extensions this commission applies to. When empty, the commission applies to all extensions.
+     * @type {Array<string>}
+     * @memberof CommissionReasonDto
+     */
+    tlds?: Array<string>;
+    /**
+     * Domain extensions excluded from this commission.
+     * @type {Array<string>}
+     * @memberof CommissionReasonDto
+     */
+    excludedTlds?: Array<string>;
     /**
      * Selected commission percentage value.
      * @type {number}
@@ -106,6 +118,18 @@ export interface CommissionReasonDto {
      * @memberof CommissionReasonDto
      */
     factorCountResult?: number | null;
+    /**
+     * How the commission was selected for the domain extension.
+     * @type {string}
+     * @memberof CommissionReasonDto
+     */
+    tldMatchType?: CommissionReasonDtoTldMatchTypeEnum;
+    /**
+     * Domain extension used to select the commission, if any.
+     * @type {string}
+     * @memberof CommissionReasonDto
+     */
+    tldMatchedValue?: string | null;
 }
 
 
@@ -129,6 +153,16 @@ export const CommissionReasonDtoSubtypeEnum = {
 } as const;
 export type CommissionReasonDtoSubtypeEnum = typeof CommissionReasonDtoSubtypeEnum[keyof typeof CommissionReasonDtoSubtypeEnum];
 
+/**
+ * @export
+ */
+export const CommissionReasonDtoTldMatchTypeEnum = {
+    NULL_TLD_DEFAULT: 'null_tld_default',
+    INCLUDED_TLD_LIST: 'included_tld_list',
+    ALL_TLDS_DEFAULT: 'all_tlds_default'
+} as const;
+export type CommissionReasonDtoTldMatchTypeEnum = typeof CommissionReasonDtoTldMatchTypeEnum[keyof typeof CommissionReasonDtoTldMatchTypeEnum];
+
 
 /**
  * Check if a given object implements the CommissionReasonDto interface.
@@ -156,9 +190,13 @@ export function CommissionReasonDtoFromJSONTyped(json: any, ignoreDiscriminator:
         'dateStart': json['dateStart'] == null ? undefined : json['dateStart'],
         'dateEnd': json['dateEnd'] == null ? undefined : json['dateEnd'],
         'excludedAccountIds': json['excludedAccountIds'] == null ? undefined : json['excludedAccountIds'],
+        'tlds': json['tlds'] == null ? undefined : json['tlds'],
+        'excludedTlds': json['excludedTlds'] == null ? undefined : json['excludedTlds'],
         'selectedValue': json['selectedValue'] == null ? undefined : json['selectedValue'],
         'selectedTier': json['selectedTier'] == null ? undefined : CommissionPercentageRangeDtoFromJSON(json['selectedTier']),
         'factorCountResult': json['factorCountResult'] == null ? undefined : json['factorCountResult'],
+        'tldMatchType': json['tldMatchType'] == null ? undefined : json['tldMatchType'],
+        'tldMatchedValue': json['tldMatchedValue'] == null ? undefined : json['tldMatchedValue'],
     };
 }
 
@@ -182,9 +220,13 @@ export function CommissionReasonDtoToJSONTyped(value?: CommissionReasonDto | nul
         'dateStart': value['dateStart'],
         'dateEnd': value['dateEnd'],
         'excludedAccountIds': value['excludedAccountIds'],
+        'tlds': value['tlds'],
+        'excludedTlds': value['excludedTlds'],
         'selectedValue': value['selectedValue'],
         'selectedTier': CommissionPercentageRangeDtoToJSON(value['selectedTier']),
         'factorCountResult': value['factorCountResult'],
+        'tldMatchType': value['tldMatchType'],
+        'tldMatchedValue': value['tldMatchedValue'],
     };
 }
 

package/src/models/CommissionSimulationItemInput.ts

@@ -0,0 +1,202 @@
+/* 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';
+import type { CommissionConfigurationSimulationInput } from './CommissionConfigurationSimulationInput';
+import {
+    CommissionConfigurationSimulationInputFromJSON,
+    CommissionConfigurationSimulationInputFromJSONTyped,
+    CommissionConfigurationSimulationInputToJSON,
+    CommissionConfigurationSimulationInputToJSONTyped,
+} from './CommissionConfigurationSimulationInput';
+
+/**
+ * 
+ * @export
+ * @interface CommissionSimulationItemInput
+ */
+export interface CommissionSimulationItemInput {
+    /**
+     * Commission ID.
+     * @type {string}
+     * @memberof CommissionSimulationItemInput
+     */
+    id: string;
+    /**
+     * Account ID this commission applies to, or null for global rules.
+     * @type {string}
+     * @memberof CommissionSimulationItemInput
+     */
+    account: string | null;
+    /**
+     * Commission type.
+     * @type {string}
+     * @memberof CommissionSimulationItemInput
+     */
+    type: CommissionSimulationItemInputTypeEnum;
+    /**
+     * Commission subtype.
+     * @type {string}
+     * @memberof CommissionSimulationItemInput
+     */
+    subtype: CommissionSimulationItemInputSubtypeEnum;
+    /**
+     * Commission label.
+     * @type {string}
+     * @memberof CommissionSimulationItemInput
+     */
+    label: string;
+    /**
+     * Commission configuration, or null.
+     * @type {CommissionConfigurationSimulationInput}
+     * @memberof CommissionSimulationItemInput
+     */
+    config: CommissionConfigurationSimulationInput | null;
+    /**
+     * Commission effective start date.
+     * @type {Date}
+     * @memberof CommissionSimulationItemInput
+     */
+    dateStart: Date;
+    /**
+     * Commission effective end date, or null.
+     * @type {Date}
+     * @memberof CommissionSimulationItemInput
+     */
+    dateEnd: Date | null;
+    /**
+     * Account IDs excluded from this commission.
+     * @type {Array<string>}
+     * @memberof CommissionSimulationItemInput
+     */
+    excludedAccountIds: Array<string>;
+    /**
+     * Domain extensions this commission applies to. When empty, the commission applies to all extensions.
+     * @type {Array<string>}
+     * @memberof CommissionSimulationItemInput
+     */
+    tlds: Array<string>;
+    /**
+     * Domain extensions excluded from this commission.
+     * @type {Array<string>}
+     * @memberof CommissionSimulationItemInput
+     */
+    excludedTlds: Array<string>;
+    /**
+     * Commission creation date.
+     * @type {Date}
+     * @memberof CommissionSimulationItemInput
+     */
+    createdAt?: Date | null;
+    /**
+     * Commission last update date.
+     * @type {Date}
+     * @memberof CommissionSimulationItemInput
+     */
+    updatedAt?: Date | null;
+}
+
+
+/**
+ * @export
+ */
+export const CommissionSimulationItemInputTypeEnum = {
+    NAMESHIFT_COMMISSIONS: 'nameshift_commissions',
+    AFFILIATE_COMMISSIONS: 'affiliate_commissions'
+} as const;
+export type CommissionSimulationItemInputTypeEnum = typeof CommissionSimulationItemInputTypeEnum[keyof typeof CommissionSimulationItemInputTypeEnum];
+
+/**
+ * @export
+ */
+export const CommissionSimulationItemInputSubtypeEnum = {
+    POINTING: 'pointing',
+    NOT_POINTING: 'not_pointing',
+    MANUAL_LEAD: 'manual_lead',
+    AUCTION: 'auction'
+} as const;
+export type CommissionSimulationItemInputSubtypeEnum = typeof CommissionSimulationItemInputSubtypeEnum[keyof typeof CommissionSimulationItemInputSubtypeEnum];
+
+
+/**
+ * Check if a given object implements the CommissionSimulationItemInput interface.
+ */
+export function instanceOfCommissionSimulationItemInput(value: object): value is CommissionSimulationItemInput {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('account' in value) || value['account'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('subtype' in value) || value['subtype'] === undefined) return false;
+    if (!('label' in value) || value['label'] === undefined) return false;
+    if (!('config' in value) || value['config'] === undefined) return false;
+    if (!('dateStart' in value) || value['dateStart'] === undefined) return false;
+    if (!('dateEnd' in value) || value['dateEnd'] === undefined) return false;
+    if (!('excludedAccountIds' in value) || value['excludedAccountIds'] === undefined) return false;
+    if (!('tlds' in value) || value['tlds'] === undefined) return false;
+    if (!('excludedTlds' in value) || value['excludedTlds'] === undefined) return false;
+    return true;
+}
+
+export function CommissionSimulationItemInputFromJSON(json: any): CommissionSimulationItemInput {
+    return CommissionSimulationItemInputFromJSONTyped(json, false);
+}
+
+export function CommissionSimulationItemInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommissionSimulationItemInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'account': json['account'],
+        'type': json['type'],
+        'subtype': json['subtype'],
+        'label': json['label'],
+        'config': CommissionConfigurationSimulationInputFromJSON(json['config']),
+        'dateStart': (new Date(json['dateStart'])),
+        'dateEnd': (json['dateEnd'] == null ? null : new Date(json['dateEnd'])),
+        'excludedAccountIds': json['excludedAccountIds'],
+        'tlds': json['tlds'],
+        'excludedTlds': json['excludedTlds'],
+        'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
+        'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
+    };
+}
+
+export function CommissionSimulationItemInputToJSON(json: any): CommissionSimulationItemInput {
+    return CommissionSimulationItemInputToJSONTyped(json, false);
+}
+
+export function CommissionSimulationItemInputToJSONTyped(value?: CommissionSimulationItemInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'account': value['account'],
+        'type': value['type'],
+        'subtype': value['subtype'],
+        'label': value['label'],
+        'config': CommissionConfigurationSimulationInputToJSON(value['config']),
+        'dateStart': ((value['dateStart']).toISOString()),
+        'dateEnd': (value['dateEnd'] == null ? null : (value['dateEnd'] as any).toISOString()),
+        'excludedAccountIds': value['excludedAccountIds'],
+        'tlds': value['tlds'],
+        'excludedTlds': value['excludedTlds'],
+        'createdAt': value['createdAt'] == null ? undefined : ((value['createdAt'] as any).toISOString()),
+        'updatedAt': value['updatedAt'] == null ? undefined : ((value['updatedAt'] as any).toISOString()),
+    };
+}
+

package/src/models/CommissionSimulationResultDto.ts

@@ -0,0 +1,83 @@
+/* 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';
+import type { CommissionReasonDto } from './CommissionReasonDto';
+import {
+    CommissionReasonDtoFromJSON,
+    CommissionReasonDtoFromJSONTyped,
+    CommissionReasonDtoToJSON,
+    CommissionReasonDtoToJSONTyped,
+} from './CommissionReasonDto';
+
+/**
+ * 
+ * @export
+ * @interface CommissionSimulationResultDto
+ */
+export interface CommissionSimulationResultDto {
+    /**
+     * Resolved commission percentage for the given scenario.
+     * @type {number}
+     * @memberof CommissionSimulationResultDto
+     */
+    percentage: number;
+    /**
+     * Commission selection reason.
+     * @type {CommissionReasonDto}
+     * @memberof CommissionSimulationResultDto
+     */
+    reason: CommissionReasonDto | null;
+}
+
+/**
+ * Check if a given object implements the CommissionSimulationResultDto interface.
+ */
+export function instanceOfCommissionSimulationResultDto(value: object): value is CommissionSimulationResultDto {
+    if (!('percentage' in value) || value['percentage'] === undefined) return false;
+    if (!('reason' in value) || value['reason'] === undefined) return false;
+    return true;
+}
+
+export function CommissionSimulationResultDtoFromJSON(json: any): CommissionSimulationResultDto {
+    return CommissionSimulationResultDtoFromJSONTyped(json, false);
+}
+
+export function CommissionSimulationResultDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommissionSimulationResultDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'percentage': json['percentage'],
+        'reason': CommissionReasonDtoFromJSON(json['reason']),
+    };
+}
+
+export function CommissionSimulationResultDtoToJSON(json: any): CommissionSimulationResultDto {
+    return CommissionSimulationResultDtoToJSONTyped(json, false);
+}
+
+export function CommissionSimulationResultDtoToJSONTyped(value?: CommissionSimulationResultDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'percentage': value['percentage'],
+        'reason': CommissionReasonDtoToJSON(value['reason']),
+    };
+}
+

package/src/models/FixedCommissionPayloadSimulationInput.ts

@@ -0,0 +1,85 @@
+/* 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';
+import type { CommissionFactor } from './CommissionFactor';
+import {
+    CommissionFactorFromJSON,
+    CommissionFactorFromJSONTyped,
+    CommissionFactorToJSON,
+    CommissionFactorToJSONTyped,
+} from './CommissionFactor';
+
+/**
+ * 
+ * @export
+ * @interface FixedCommissionPayloadSimulationInput
+ */
+export interface FixedCommissionPayloadSimulationInput {
+    /**
+     * 
+     * @type {CommissionFactor}
+     * @memberof FixedCommissionPayloadSimulationInput
+     */
+    factor: CommissionFactor;
+    /**
+     * Fixed commission percentage
+     * @type {number}
+     * @memberof FixedCommissionPayloadSimulationInput
+     */
+    value: number;
+}
+
+
+
+/**
+ * Check if a given object implements the FixedCommissionPayloadSimulationInput interface.
+ */
+export function instanceOfFixedCommissionPayloadSimulationInput(value: object): value is FixedCommissionPayloadSimulationInput {
+    if (!('factor' in value) || value['factor'] === undefined) return false;
+    if (!('value' in value) || value['value'] === undefined) return false;
+    return true;
+}
+
+export function FixedCommissionPayloadSimulationInputFromJSON(json: any): FixedCommissionPayloadSimulationInput {
+    return FixedCommissionPayloadSimulationInputFromJSONTyped(json, false);
+}
+
+export function FixedCommissionPayloadSimulationInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): FixedCommissionPayloadSimulationInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'factor': CommissionFactorFromJSON(json['factor']),
+        'value': json['value'],
+    };
+}
+
+export function FixedCommissionPayloadSimulationInputToJSON(json: any): FixedCommissionPayloadSimulationInput {
+    return FixedCommissionPayloadSimulationInputToJSONTyped(json, false);
+}
+
+export function FixedCommissionPayloadSimulationInputToJSONTyped(value?: FixedCommissionPayloadSimulationInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'factor': CommissionFactorToJSON(value['factor']),
+        'value': value['value'],
+    };
+}
+

package/src/models/GetAccountNameshiftCommissionsResponseDto.ts

@@ -41,7 +41,7 @@ export interface GetAccountNameshiftCommissionsResponseDto {
      */
     current: AccountNameshiftCommissionBySubtypePercentagesDto;
     /**
-     * List of nameshift commissions (not expired or not yet started)
+     * Commission schedules for the account.
      * @type {Array<AccountNameshiftCommissionItemDto>}
      * @memberof GetAccountNameshiftCommissionsResponseDto
      */

package/src/models/MozMetrics.ts

@@ -49,6 +49,12 @@ export interface MozMetrics {
      * @memberof MozMetrics
      */
     spamScore: number | null;
+    /**
+     * Timestamp when Moz metrics were last fetched, when available.
+     * @type {Date}
+     * @memberof MozMetrics
+     */
+    updatedAt: Date | null;
 }
 
 /**
@@ -60,6 +66,7 @@ export function instanceOfMozMetrics(value: object): value is MozMetrics {
     if (!('backlinks' in value) || value['backlinks'] === undefined) return false;
     if (!('rootDomains' in value) || value['rootDomains'] === undefined) return false;
     if (!('spamScore' in value) || value['spamScore'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
     return true;
 }
 
@@ -78,6 +85,7 @@ export function MozMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'backlinks': json['backlinks'],
         'rootDomains': json['rootDomains'],
         'spamScore': json['spamScore'],
+        'updatedAt': (json['updatedAt'] == null ? null : new Date(json['updatedAt'])),
     };
 }
 
@@ -97,6 +105,7 @@ export function MozMetricsToJSONTyped(value?: MozMetrics | null, ignoreDiscrimin
         'backlinks': value['backlinks'],
         'rootDomains': value['rootDomains'],
         'spamScore': value['spamScore'],
+        'updatedAt': (value['updatedAt'] == null ? null : (value['updatedAt'] as any).toISOString()),
     };
 }
 

package/src/models/SalesCountCommissionPayloadSimulationInput.ts

@@ -0,0 +1,92 @@
+/* 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';
+import type { CommissionFactor } from './CommissionFactor';
+import {
+    CommissionFactorFromJSON,
+    CommissionFactorFromJSONTyped,
+    CommissionFactorToJSON,
+    CommissionFactorToJSONTyped,
+} from './CommissionFactor';
+import type { CommissionPercentageRangeInput } from './CommissionPercentageRangeInput';
+import {
+    CommissionPercentageRangeInputFromJSON,
+    CommissionPercentageRangeInputFromJSONTyped,
+    CommissionPercentageRangeInputToJSON,
+    CommissionPercentageRangeInputToJSONTyped,
+} from './CommissionPercentageRangeInput';
+
+/**
+ * 
+ * @export
+ * @interface SalesCountCommissionPayloadSimulationInput
+ */
+export interface SalesCountCommissionPayloadSimulationInput {
+    /**
+     * 
+     * @type {CommissionFactor}
+     * @memberof SalesCountCommissionPayloadSimulationInput
+     */
+    factor: CommissionFactor;
+    /**
+     * Commission tiers based on monthly sales count
+     * @type {Array<CommissionPercentageRangeInput>}
+     * @memberof SalesCountCommissionPayloadSimulationInput
+     */
+    value: Array<CommissionPercentageRangeInput>;
+}
+
+
+
+/**
+ * Check if a given object implements the SalesCountCommissionPayloadSimulationInput interface.
+ */
+export function instanceOfSalesCountCommissionPayloadSimulationInput(value: object): value is SalesCountCommissionPayloadSimulationInput {
+    if (!('factor' in value) || value['factor'] === undefined) return false;
+    if (!('value' in value) || value['value'] === undefined) return false;
+    return true;
+}
+
+export function SalesCountCommissionPayloadSimulationInputFromJSON(json: any): SalesCountCommissionPayloadSimulationInput {
+    return SalesCountCommissionPayloadSimulationInputFromJSONTyped(json, false);
+}
+
+export function SalesCountCommissionPayloadSimulationInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SalesCountCommissionPayloadSimulationInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'factor': CommissionFactorFromJSON(json['factor']),
+        'value': ((json['value'] as Array<any>).map(CommissionPercentageRangeInputFromJSON)),
+    };
+}
+
+export function SalesCountCommissionPayloadSimulationInputToJSON(json: any): SalesCountCommissionPayloadSimulationInput {
+    return SalesCountCommissionPayloadSimulationInputToJSONTyped(json, false);
+}
+
+export function SalesCountCommissionPayloadSimulationInputToJSONTyped(value?: SalesCountCommissionPayloadSimulationInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'factor': CommissionFactorToJSON(value['factor']),
+        'value': ((value['value'] as Array<any>).map(CommissionPercentageRangeInputToJSON)),
+    };
+}
+