@randock/nameshift-api-client 0.0.430 → 0.0.432

package/src/models/GetMarketingSales200Response.ts

@@ -0,0 +1,106 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift API
+ *
+ * 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 { PaginateResponseLinks } from './PaginateResponseLinks';
+import {
+    PaginateResponseLinksFromJSON,
+    PaginateResponseLinksFromJSONTyped,
+    PaginateResponseLinksToJSON,
+    PaginateResponseLinksToJSONTyped,
+} from './PaginateResponseLinks';
+import type { MarketingOrderListItemDto } from './MarketingOrderListItemDto';
+import {
+    MarketingOrderListItemDtoFromJSON,
+    MarketingOrderListItemDtoFromJSONTyped,
+    MarketingOrderListItemDtoToJSON,
+    MarketingOrderListItemDtoToJSONTyped,
+} from './MarketingOrderListItemDto';
+import type { PaginateResponseMeta } from './PaginateResponseMeta';
+import {
+    PaginateResponseMetaFromJSON,
+    PaginateResponseMetaFromJSONTyped,
+    PaginateResponseMetaToJSON,
+    PaginateResponseMetaToJSONTyped,
+} from './PaginateResponseMeta';
+
+/**
+ * 
+ * @export
+ * @interface GetMarketingSales200Response
+ */
+export interface GetMarketingSales200Response {
+    /**
+     * 
+     * @type {Array<MarketingOrderListItemDto>}
+     * @memberof GetMarketingSales200Response
+     */
+    data: Array<MarketingOrderListItemDto>;
+    /**
+     * 
+     * @type {PaginateResponseMeta}
+     * @memberof GetMarketingSales200Response
+     */
+    meta: PaginateResponseMeta;
+    /**
+     * 
+     * @type {PaginateResponseLinks}
+     * @memberof GetMarketingSales200Response
+     */
+    links: PaginateResponseLinks;
+}
+
+/**
+ * Check if a given object implements the GetMarketingSales200Response interface.
+ */
+export function instanceOfGetMarketingSales200Response(value: object): value is GetMarketingSales200Response {
+    if (!('data' in value) || value['data'] === undefined) return false;
+    if (!('meta' in value) || value['meta'] === undefined) return false;
+    if (!('links' in value) || value['links'] === undefined) return false;
+    return true;
+}
+
+export function GetMarketingSales200ResponseFromJSON(json: any): GetMarketingSales200Response {
+    return GetMarketingSales200ResponseFromJSONTyped(json, false);
+}
+
+export function GetMarketingSales200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetMarketingSales200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': ((json['data'] as Array<any>).map(MarketingOrderListItemDtoFromJSON)),
+        'meta': PaginateResponseMetaFromJSON(json['meta']),
+        'links': PaginateResponseLinksFromJSON(json['links']),
+    };
+}
+
+export function GetMarketingSales200ResponseToJSON(json: any): GetMarketingSales200Response {
+    return GetMarketingSales200ResponseToJSONTyped(json, false);
+}
+
+export function GetMarketingSales200ResponseToJSONTyped(value?: GetMarketingSales200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': ((value['data'] as Array<any>).map(MarketingOrderListItemDtoToJSON)),
+        'meta': PaginateResponseMetaToJSON(value['meta']),
+        'links': PaginateResponseLinksToJSON(value['links']),
+    };
+}
+

package/src/models/MarketingOrderListItemDto.ts

@@ -0,0 +1,110 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift API
+ *
+ * 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 { MoneyDto } from './MoneyDto';
+import {
+    MoneyDtoFromJSON,
+    MoneyDtoFromJSONTyped,
+    MoneyDtoToJSON,
+    MoneyDtoToJSONTyped,
+} from './MoneyDto';
+
+/**
+ * 
+ * @export
+ * @interface MarketingOrderListItemDto
+ */
+export interface MarketingOrderListItemDto {
+    /**
+     * The order domain ID
+     * @type {string}
+     * @memberof MarketingOrderListItemDto
+     */
+    domainId: string;
+    /**
+     * The order domain name
+     * @type {string}
+     * @memberof MarketingOrderListItemDto
+     */
+    domainName: string;
+    /**
+     * The order base price
+     * @type {MoneyDto}
+     * @memberof MarketingOrderListItemDto
+     */
+    basePrice: MoneyDto;
+    /**
+     * The order base price converted to EUR
+     * @type {MoneyDto}
+     * @memberof MarketingOrderListItemDto
+     */
+    basePriceEur: MoneyDto | null;
+    /**
+     * The buyer invoice paid date
+     * @type {Date}
+     * @memberof MarketingOrderListItemDto
+     */
+    paidAt: Date;
+}
+
+/**
+ * Check if a given object implements the MarketingOrderListItemDto interface.
+ */
+export function instanceOfMarketingOrderListItemDto(value: object): value is MarketingOrderListItemDto {
+    if (!('domainId' in value) || value['domainId'] === undefined) return false;
+    if (!('domainName' in value) || value['domainName'] === undefined) return false;
+    if (!('basePrice' in value) || value['basePrice'] === undefined) return false;
+    if (!('basePriceEur' in value) || value['basePriceEur'] === undefined) return false;
+    if (!('paidAt' in value) || value['paidAt'] === undefined) return false;
+    return true;
+}
+
+export function MarketingOrderListItemDtoFromJSON(json: any): MarketingOrderListItemDto {
+    return MarketingOrderListItemDtoFromJSONTyped(json, false);
+}
+
+export function MarketingOrderListItemDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): MarketingOrderListItemDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'domainId': json['domainId'],
+        'domainName': json['domainName'],
+        'basePrice': MoneyDtoFromJSON(json['basePrice']),
+        'basePriceEur': MoneyDtoFromJSON(json['basePriceEur']),
+        'paidAt': (new Date(json['paidAt'])),
+    };
+}
+
+export function MarketingOrderListItemDtoToJSON(json: any): MarketingOrderListItemDto {
+    return MarketingOrderListItemDtoToJSONTyped(json, false);
+}
+
+export function MarketingOrderListItemDtoToJSONTyped(value?: MarketingOrderListItemDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'domainId': value['domainId'],
+        'domainName': value['domainName'],
+        'basePrice': MoneyDtoToJSON(value['basePrice']),
+        'basePriceEur': MoneyDtoToJSON(value['basePriceEur']),
+        'paidAt': ((value['paidAt']).toISOString()),
+    };
+}
+

package/src/models/MarketingSalesFiltersDto.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift API
+ *
+ * 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 MarketingSalesFiltersDto
+ */
+export interface MarketingSalesFiltersDto {
+    /**
+     * List of existing TLDs in marketing sales
+     * @type {Array<string>}
+     * @memberof MarketingSalesFiltersDto
+     */
+    existingTldList: Array<string>;
+    /**
+     * List of existing currencies in marketing sales
+     * @type {Array<string>}
+     * @memberof MarketingSalesFiltersDto
+     */
+    existingCurrencies: Array<string>;
+}
+
+/**
+ * Check if a given object implements the MarketingSalesFiltersDto interface.
+ */
+export function instanceOfMarketingSalesFiltersDto(value: object): value is MarketingSalesFiltersDto {
+    if (!('existingTldList' in value) || value['existingTldList'] === undefined) return false;
+    if (!('existingCurrencies' in value) || value['existingCurrencies'] === undefined) return false;
+    return true;
+}
+
+export function MarketingSalesFiltersDtoFromJSON(json: any): MarketingSalesFiltersDto {
+    return MarketingSalesFiltersDtoFromJSONTyped(json, false);
+}
+
+export function MarketingSalesFiltersDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): MarketingSalesFiltersDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'existingTldList': json['existingTldList'],
+        'existingCurrencies': json['existingCurrencies'],
+    };
+}
+
+export function MarketingSalesFiltersDtoToJSON(json: any): MarketingSalesFiltersDto {
+    return MarketingSalesFiltersDtoToJSONTyped(json, false);
+}
+
+export function MarketingSalesFiltersDtoToJSONTyped(value?: MarketingSalesFiltersDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'existingTldList': value['existingTldList'],
+        'existingCurrencies': value['existingCurrencies'],
+    };
+}
+

package/src/models/RentIndexationDto.ts

@@ -0,0 +1,102 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift API
+ *
+ * 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 RentIndexationDto
+ */
+export interface RentIndexationDto {
+    /**
+     * 
+     * @type {Date}
+     * @memberof RentIndexationDto
+     */
+    appliedAt: Date | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof RentIndexationDto
+     */
+    appliedRate: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof RentIndexationDto
+     */
+    inflationYear: number | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof RentIndexationDto
+     */
+    advanceNotifiedAt: Date | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof RentIndexationDto
+     */
+    advanceNotifiedForYear: number | null;
+}
+
+/**
+ * Check if a given object implements the RentIndexationDto interface.
+ */
+export function instanceOfRentIndexationDto(value: object): value is RentIndexationDto {
+    if (!('appliedAt' in value) || value['appliedAt'] === undefined) return false;
+    if (!('appliedRate' in value) || value['appliedRate'] === undefined) return false;
+    if (!('inflationYear' in value) || value['inflationYear'] === undefined) return false;
+    if (!('advanceNotifiedAt' in value) || value['advanceNotifiedAt'] === undefined) return false;
+    if (!('advanceNotifiedForYear' in value) || value['advanceNotifiedForYear'] === undefined) return false;
+    return true;
+}
+
+export function RentIndexationDtoFromJSON(json: any): RentIndexationDto {
+    return RentIndexationDtoFromJSONTyped(json, false);
+}
+
+export function RentIndexationDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): RentIndexationDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'appliedAt': (json['appliedAt'] == null ? null : new Date(json['appliedAt'])),
+        'appliedRate': json['appliedRate'],
+        'inflationYear': json['inflationYear'],
+        'advanceNotifiedAt': (json['advanceNotifiedAt'] == null ? null : new Date(json['advanceNotifiedAt'])),
+        'advanceNotifiedForYear': json['advanceNotifiedForYear'],
+    };
+}
+
+export function RentIndexationDtoToJSON(json: any): RentIndexationDto {
+    return RentIndexationDtoToJSONTyped(json, false);
+}
+
+export function RentIndexationDtoToJSONTyped(value?: RentIndexationDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'appliedAt': (value['appliedAt'] == null ? null : (value['appliedAt'] as any).toISOString()),
+        'appliedRate': value['appliedRate'],
+        'inflationYear': value['inflationYear'],
+        'advanceNotifiedAt': (value['advanceNotifiedAt'] == null ? null : (value['advanceNotifiedAt'] as any).toISOString()),
+        'advanceNotifiedForYear': value['advanceNotifiedForYear'],
+    };
+}
+

package/src/models/SubscriptionDetailsDto.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { RentIndexationDto } from './RentIndexationDto';
+import {
+    RentIndexationDtoFromJSON,
+    RentIndexationDtoFromJSONTyped,
+    RentIndexationDtoToJSON,
+    RentIndexationDtoToJSONTyped,
+} from './RentIndexationDto';
 import type { InvoiceItemDto } from './InvoiceItemDto';
 import {
     InvoiceItemDtoFromJSON,
@@ -268,6 +275,30 @@ export interface SubscriptionDetailsDto {
      * @memberof SubscriptionDetailsDto
      */
     scheduledCancellationReason: string | null;
+    /**
+     * 
+     * @type {RentIndexationDto}
+     * @memberof SubscriptionDetailsDto
+     */
+    lastRentIndexation: RentIndexationDto | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof SubscriptionDetailsDto
+     */
+    nextEligibleRentIndexationDate: Date | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SubscriptionDetailsDto
+     */
+    rentIndexationStatus: SubscriptionDetailsDtoRentIndexationStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof SubscriptionDetailsDto
+     */
+    rentIndexationSkipReason: SubscriptionDetailsDtoRentIndexationSkipReasonEnum;
 }
 
 
@@ -311,6 +342,36 @@ export const SubscriptionDetailsDtoRenewStatusReasonEnum = {
 } as const;
 export type SubscriptionDetailsDtoRenewStatusReasonEnum = typeof SubscriptionDetailsDtoRenewStatusReasonEnum[keyof typeof SubscriptionDetailsDtoRenewStatusReasonEnum];
 
+/**
+ * @export
+ */
+export const SubscriptionDetailsDtoRentIndexationStatusEnum = {
+    ELIGIBLE: 'eligible',
+    NOT_ELIGIBLE: 'not_eligible',
+    INDEXED: 'indexed',
+    FAILED: 'failed',
+    PENDING_DATA: 'pending_data'
+} as const;
+export type SubscriptionDetailsDtoRentIndexationStatusEnum = typeof SubscriptionDetailsDtoRentIndexationStatusEnum[keyof typeof SubscriptionDetailsDtoRentIndexationStatusEnum];
+
+/**
+ * @export
+ */
+export const SubscriptionDetailsDtoRentIndexationSkipReasonEnum = {
+    NOT_RENT: 'not_rent',
+    CONTRACT_TOO_OLD: 'contract_too_old',
+    NOT_ACTIVE: 'not_active',
+    SCHEDULED_CANCELLATION: 'scheduled_cancellation',
+    INSUFFICIENT_TENURE: 'insufficient_tenure',
+    ALREADY_INDEXED: 'already_indexed',
+    MISSING_COUNTRY: 'missing_country',
+    UNMAPPED_COUNTRY: 'unmapped_country',
+    MISSING_IMF_DATA: 'missing_imf_data',
+    OUTSIDE_INDEXATION_WINDOW: 'outside_indexation_window',
+    ADVANCE_ALREADY_NOTIFIED: 'advance_already_notified'
+} as const;
+export type SubscriptionDetailsDtoRentIndexationSkipReasonEnum = typeof SubscriptionDetailsDtoRentIndexationSkipReasonEnum[keyof typeof SubscriptionDetailsDtoRentIndexationSkipReasonEnum];
+
 
 /**
  * Check if a given object implements the SubscriptionDetailsDto interface.
@@ -348,6 +409,10 @@ export function instanceOfSubscriptionDetailsDto(value: object): value is Subscr
     if (!('renewStatusReason' in value) || value['renewStatusReason'] === undefined) return false;
     if (!('scheduledCancellationAt' in value) || value['scheduledCancellationAt'] === undefined) return false;
     if (!('scheduledCancellationReason' in value) || value['scheduledCancellationReason'] === undefined) return false;
+    if (!('lastRentIndexation' in value) || value['lastRentIndexation'] === undefined) return false;
+    if (!('nextEligibleRentIndexationDate' in value) || value['nextEligibleRentIndexationDate'] === undefined) return false;
+    if (!('rentIndexationStatus' in value) || value['rentIndexationStatus'] === undefined) return false;
+    if (!('rentIndexationSkipReason' in value) || value['rentIndexationSkipReason'] === undefined) return false;
     return true;
 }
 
@@ -393,6 +458,10 @@ export function SubscriptionDetailsDtoFromJSONTyped(json: any, ignoreDiscriminat
         'renewStatusReason': json['renewStatusReason'],
         'scheduledCancellationAt': (json['scheduledCancellationAt'] == null ? null : new Date(json['scheduledCancellationAt'])),
         'scheduledCancellationReason': json['scheduledCancellationReason'],
+        'lastRentIndexation': RentIndexationDtoFromJSON(json['lastRentIndexation']),
+        'nextEligibleRentIndexationDate': (json['nextEligibleRentIndexationDate'] == null ? null : new Date(json['nextEligibleRentIndexationDate'])),
+        'rentIndexationStatus': json['rentIndexationStatus'],
+        'rentIndexationSkipReason': json['rentIndexationSkipReason'],
     };
 }
 
@@ -439,6 +508,10 @@ export function SubscriptionDetailsDtoToJSONTyped(value?: SubscriptionDetailsDto
         'renewStatusReason': value['renewStatusReason'],
         'scheduledCancellationAt': (value['scheduledCancellationAt'] == null ? null : (value['scheduledCancellationAt'] as any).toISOString()),
         'scheduledCancellationReason': value['scheduledCancellationReason'],
+        'lastRentIndexation': RentIndexationDtoToJSON(value['lastRentIndexation']),
+        'nextEligibleRentIndexationDate': (value['nextEligibleRentIndexationDate'] == null ? null : (value['nextEligibleRentIndexationDate'] as any).toISOString()),
+        'rentIndexationStatus': value['rentIndexationStatus'],
+        'rentIndexationSkipReason': value['rentIndexationSkipReason'],
     };
 }
 

package/src/models/UserNotificationDto.ts

@@ -123,6 +123,8 @@ export const UserNotificationDtoTypeEnum = {
     SELLER_RENT_SUBSCRIPTION_CANCELLED: 'seller_rent_subscription_cancelled',
     LEASE_TO_OWN_SUBSCRIPTION_HAS_BEEN_ACTIVATED_FOR_FIRST_TIME: 'lease_to_own_subscription_has_been_activated_for_first_time',
     RENT_SUBSCRIPTION_HAS_BEEN_ACTIVATED_FOR_FIRST_TIME: 'rent_subscription_has_been_activated_for_first_time',
+    RENT_SUBSCRIPTION_RENT_INDEXATION_ADVANCE_NOTICE: 'rent_subscription_rent_indexation_advance_notice',
+    RENT_SUBSCRIPTION_RENT_INDEXATION_APPLIED: 'rent_subscription_rent_indexation_applied',
     PASSWORD_RESET: 'password_reset',
     USER_EMAIL_CHANGED: 'user_email_changed',
     BUYER_INVOICE: 'buyer_invoice',

package/src/models/UserNotificationListItemDto.ts

@@ -109,6 +109,8 @@ export const UserNotificationListItemDtoTypeEnum = {
     SELLER_RENT_SUBSCRIPTION_CANCELLED: 'seller_rent_subscription_cancelled',
     LEASE_TO_OWN_SUBSCRIPTION_HAS_BEEN_ACTIVATED_FOR_FIRST_TIME: 'lease_to_own_subscription_has_been_activated_for_first_time',
     RENT_SUBSCRIPTION_HAS_BEEN_ACTIVATED_FOR_FIRST_TIME: 'rent_subscription_has_been_activated_for_first_time',
+    RENT_SUBSCRIPTION_RENT_INDEXATION_ADVANCE_NOTICE: 'rent_subscription_rent_indexation_advance_notice',
+    RENT_SUBSCRIPTION_RENT_INDEXATION_APPLIED: 'rent_subscription_rent_indexation_applied',
     PASSWORD_RESET: 'password_reset',
     USER_EMAIL_CHANGED: 'user_email_changed',
     BUYER_INVOICE: 'buyer_invoice',

package/src/models/index.ts

@@ -229,6 +229,7 @@ export * from './GetBuyerLeads200Response';
 export * from './GetBuyerSubscriptions200Response';
 export * from './GetBuyerTransfers200Response';
 export * from './GetInvoices200Response';
+export * from './GetMarketingSales200Response';
 export * from './GetSellerChallengesListDto';
 export * from './GetSellerChallengesListDtoChallengesInner';
 export * from './HistoricalMetrics';
@@ -300,6 +301,8 @@ export * from './MajesticMetrics';
 export * from './MajesticTopicTrustFlow';
 export * from './ManualLeadBuyerDto';
 export * from './ManualLeadLeaseToOwnDto';
+export * from './MarketingOrderListItemDto';
+export * from './MarketingSalesFiltersDto';
 export * from './MoneyDecimalDto';
 export * from './MoneyDto';
 export * from './MoneyInput';
@@ -354,6 +357,7 @@ export * from './RentConfigurationDto';
 export * from './RentConfigurationInput';
 export * from './RentConfigurationPresetsDto';
 export * from './RentDto';
+export * from './RentIndexationDto';
 export * from './RequestAccessTokenInput';
 export * from './RequestEmailOtpInput';
 export * from './RequestUserEmailChangeOtpInput';