@randock/nameshift-api-client 0.0.459 → 0.0.460

package/src/apis/JobsApi.ts

@@ -0,0 +1,163 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  JobDto,
+  ListJobs200Response,
+  NotFoundException,
+  ValidationException,
+} from '../models/index';
+import {
+    JobDtoFromJSON,
+    JobDtoToJSON,
+    ListJobs200ResponseFromJSON,
+    ListJobs200ResponseToJSON,
+    NotFoundExceptionFromJSON,
+    NotFoundExceptionToJSON,
+    ValidationExceptionFromJSON,
+    ValidationExceptionToJSON,
+} from '../models/index';
+
+export interface JobsApiGetJobRequest {
+    jobId: string;
+}
+
+export interface JobsApiListJobsRequest {
+    filter?: { [key: string]: string; };
+    page?: number;
+    limit?: number;
+    sortBy?: Array<string>;
+    filterStatus?: string;
+    filterType?: string;
+}
+
+/**
+ * 
+ */
+export class JobsApi extends runtime.BaseAPI {
+
+    /**
+     * Progress and result of one job belonging to the account.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Get a background job
+     */
+    async getJobRaw(requestParameters: JobsApiGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobDto>> {
+        if (requestParameters['jobId'] == null) {
+            throw new runtime.RequiredError(
+                'jobId',
+                'Required parameter "jobId" was null or undefined when calling getJob().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/jobs/{jobId}`.replace(`{${"jobId"}}`, encodeURIComponent(String(requestParameters['jobId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => JobDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Progress and result of one job belonging to the account.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Get a background job
+     */
+    async getJob(requestParameters: JobsApiGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobDto> {
+        const response = await this.getJobRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * The account\'s own background jobs, newest first. Filter on status while polling, so watching a run costs nothing however long the history is.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
+     * List background jobs
+     */
+    async listJobsRaw(requestParameters: JobsApiListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListJobs200Response>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['filter'] != null) {
+            queryParameters['filter'] = requestParameters['filter'];
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['sortBy'] != null) {
+            queryParameters['sortBy'] = requestParameters['sortBy'];
+        }
+
+        if (requestParameters['filterStatus'] != null) {
+            queryParameters['filter[status]'] = requestParameters['filterStatus'];
+        }
+
+        if (requestParameters['filterType'] != null) {
+            queryParameters['filter[type]'] = requestParameters['filterType'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/jobs`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListJobs200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * The account\'s own background jobs, newest first. Filter on status while polling, so watching a run costs nothing however long the history is.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
+     * List background jobs
+     */
+    async listJobs(requestParameters: JobsApiListJobsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListJobs200Response> {
+        const response = await this.listJobsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -16,6 +16,7 @@ export * from './DomainsApi';
 export * from './DomainsPublicApi';
 export * from './EppApi';
 export * from './InvoicesApi';
+export * from './JobsApi';
 export * from './LeadsApi';
 export * from './LeadsPublicApi';
 export * from './MarketApi';

package/src/models/ApplyDomainEditInput.ts

@@ -0,0 +1,74 @@
+/* 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 ApplyDomainEditInput
+ */
+export interface ApplyDomainEditInput {
+    /**
+     * The selected domains. Omit to apply to everything the filter and searchFilter match.
+     * @type {Array<string>}
+     * @memberof ApplyDomainEditInput
+     */
+    domainIds?: Array<string>;
+    /**
+     * The operations returned by the preview, sent back unchanged. Validated again here.
+     * @type {Array<{ [key: string]: any; }>}
+     * @memberof ApplyDomainEditInput
+     */
+    operations: Array<{ [key: string]: any; }>;
+}
+
+/**
+ * Check if a given object implements the ApplyDomainEditInput interface.
+ */
+export function instanceOfApplyDomainEditInput(value: object): value is ApplyDomainEditInput {
+    if (!('operations' in value) || value['operations'] === undefined) return false;
+    return true;
+}
+
+export function ApplyDomainEditInputFromJSON(json: any): ApplyDomainEditInput {
+    return ApplyDomainEditInputFromJSONTyped(json, false);
+}
+
+export function ApplyDomainEditInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApplyDomainEditInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'domainIds': json['domainIds'] == null ? undefined : json['domainIds'],
+        'operations': json['operations'],
+    };
+}
+
+export function ApplyDomainEditInputToJSON(json: any): ApplyDomainEditInput {
+    return ApplyDomainEditInputToJSONTyped(json, false);
+}
+
+export function ApplyDomainEditInputToJSONTyped(value?: ApplyDomainEditInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'domainIds': value['domainIds'],
+        'operations': value['operations'],
+    };
+}
+

package/src/models/BuyerNotificationDto.ts

@@ -133,6 +133,7 @@ export const BuyerNotificationDtoTypeEnum = {
     SELLER_BULK_DOWNLOAD_INVOICES_COMPLETED: 'seller_bulk_download_invoices_completed',
     SELLER_BULK_DOWNLOAD_INVOICES_FAILED: 'seller_bulk_download_invoices_failed',
     EPP_BATCH_UPDATE_DOMAINS_RESULTS: 'epp.batch.update.domains.results',
+    BULK_EDIT_DOMAINS_FINISHED: 'bulk_edit_domains_finished',
     ORDER_HAS_BEEN_PAID: 'order_has_been_paid',
     PURCHASES_ARE_CLOSED_DUE_DOMAINS_IS_SOLD_OR_DELETED: 'purchases_are_closed_due_domains_is_sold_or_deleted',
     DOMAIN_OWNER_CHANGED: 'domain_owner_changed',

package/src/models/BuyerNotificationListItemDto.ts

@@ -119,6 +119,7 @@ export const BuyerNotificationListItemDtoTypeEnum = {
     SELLER_BULK_DOWNLOAD_INVOICES_COMPLETED: 'seller_bulk_download_invoices_completed',
     SELLER_BULK_DOWNLOAD_INVOICES_FAILED: 'seller_bulk_download_invoices_failed',
     EPP_BATCH_UPDATE_DOMAINS_RESULTS: 'epp.batch.update.domains.results',
+    BULK_EDIT_DOMAINS_FINISHED: 'bulk_edit_domains_finished',
     ORDER_HAS_BEEN_PAID: 'order_has_been_paid',
     PURCHASES_ARE_CLOSED_DUE_DOMAINS_IS_SOLD_OR_DELETED: 'purchases_are_closed_due_domains_is_sold_or_deleted',
     DOMAIN_OWNER_CHANGED: 'domain_owner_changed',

package/src/models/DomainEditPreviewDto.ts

@@ -0,0 +1,146 @@
+/* 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 { DomainEditPreviewRowDto } from './DomainEditPreviewRowDto';
+import {
+    DomainEditPreviewRowDtoFromJSON,
+    DomainEditPreviewRowDtoFromJSONTyped,
+    DomainEditPreviewRowDtoToJSON,
+    DomainEditPreviewRowDtoToJSONTyped,
+} from './DomainEditPreviewRowDto';
+
+/**
+ * 
+ * @export
+ * @interface DomainEditPreviewDto
+ */
+export interface DomainEditPreviewDto {
+    /**
+     * False when the request could not be expressed. No operations are returned and nothing may be applied.
+     * @type {boolean}
+     * @memberof DomainEditPreviewDto
+     */
+    understood: boolean;
+    /**
+     * One sentence describing the change, for the seller.
+     * @type {string}
+     * @memberof DomainEditPreviewDto
+     */
+    summary: string;
+    /**
+     * True when the request applies to only some of the selected domains. An edit has no conditions, so the seller narrows the list with search or filters first and then edits what is left.
+     * @type {boolean}
+     * @memberof DomainEditPreviewDto
+     */
+    needsFilter: boolean;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof DomainEditPreviewDto
+     */
+    unresolved: Array<string>;
+    /**
+     * The operations to send back when the seller accepts. Opaque to the client; validated server-side.
+     * @type {Array<{ [key: string]: any; }>}
+     * @memberof DomainEditPreviewDto
+     */
+    operations: Array<{ [key: string]: any; }>;
+    /**
+     * How many domains the edit would change.
+     * @type {number}
+     * @memberof DomainEditPreviewDto
+     */
+    count: number;
+    /**
+     * 
+     * @type {Array<DomainEditPreviewRowDto>}
+     * @memberof DomainEditPreviewDto
+     */
+    sample: Array<DomainEditPreviewRowDto>;
+    /**
+     * The currency every price moves to, when the edit changes it. Null otherwise.
+     * @type {string}
+     * @memberof DomainEditPreviewDto
+     */
+    toCurrencyCode: string | null;
+    /**
+     * Whether prices the edit does not replace are converted at the exchange rate, or kept at their current number under the new currency. Only meaningful alongside toCurrencyCode.
+     * @type {boolean}
+     * @memberof DomainEditPreviewDto
+     */
+    convertsPrices: boolean;
+}
+
+/**
+ * Check if a given object implements the DomainEditPreviewDto interface.
+ */
+export function instanceOfDomainEditPreviewDto(value: object): value is DomainEditPreviewDto {
+    if (!('understood' in value) || value['understood'] === undefined) return false;
+    if (!('summary' in value) || value['summary'] === undefined) return false;
+    if (!('needsFilter' in value) || value['needsFilter'] === undefined) return false;
+    if (!('unresolved' in value) || value['unresolved'] === undefined) return false;
+    if (!('operations' in value) || value['operations'] === undefined) return false;
+    if (!('count' in value) || value['count'] === undefined) return false;
+    if (!('sample' in value) || value['sample'] === undefined) return false;
+    if (!('toCurrencyCode' in value) || value['toCurrencyCode'] === undefined) return false;
+    if (!('convertsPrices' in value) || value['convertsPrices'] === undefined) return false;
+    return true;
+}
+
+export function DomainEditPreviewDtoFromJSON(json: any): DomainEditPreviewDto {
+    return DomainEditPreviewDtoFromJSONTyped(json, false);
+}
+
+export function DomainEditPreviewDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): DomainEditPreviewDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'understood': json['understood'],
+        'summary': json['summary'],
+        'needsFilter': json['needsFilter'],
+        'unresolved': json['unresolved'],
+        'operations': json['operations'],
+        'count': json['count'],
+        'sample': ((json['sample'] as Array<any>).map(DomainEditPreviewRowDtoFromJSON)),
+        'toCurrencyCode': json['toCurrencyCode'],
+        'convertsPrices': json['convertsPrices'],
+    };
+}
+
+export function DomainEditPreviewDtoToJSON(json: any): DomainEditPreviewDto {
+    return DomainEditPreviewDtoToJSONTyped(json, false);
+}
+
+export function DomainEditPreviewDtoToJSONTyped(value?: DomainEditPreviewDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'understood': value['understood'],
+        'summary': value['summary'],
+        'needsFilter': value['needsFilter'],
+        'unresolved': value['unresolved'],
+        'operations': value['operations'],
+        'count': value['count'],
+        'sample': ((value['sample'] as Array<any>).map(DomainEditPreviewRowDtoToJSON)),
+        'toCurrencyCode': value['toCurrencyCode'],
+        'convertsPrices': value['convertsPrices'],
+    };
+}
+

package/src/models/DomainEditPreviewRowDto.ts

@@ -0,0 +1,102 @@
+/* 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 DomainEditPreviewRowDto
+ */
+export interface DomainEditPreviewRowDto {
+    /**
+     * 
+     * @type {string}
+     * @memberof DomainEditPreviewRowDto
+     */
+    domainName: string;
+    /**
+     * The currency the before values are in.
+     * @type {string}
+     * @memberof DomainEditPreviewRowDto
+     */
+    currencyCode: string;
+    /**
+     * The currency the after values are in. Differs from currencyCode when the edit changes it.
+     * @type {string}
+     * @memberof DomainEditPreviewRowDto
+     */
+    toCurrencyCode: string;
+    /**
+     * Current value per changed field, keyed by field name.
+     * @type {{ [key: string]: any; }}
+     * @memberof DomainEditPreviewRowDto
+     */
+    before: { [key: string]: any; };
+    /**
+     * Resulting value per changed field, keyed by field name.
+     * @type {{ [key: string]: any; }}
+     * @memberof DomainEditPreviewRowDto
+     */
+    after: { [key: string]: any; };
+}
+
+/**
+ * Check if a given object implements the DomainEditPreviewRowDto interface.
+ */
+export function instanceOfDomainEditPreviewRowDto(value: object): value is DomainEditPreviewRowDto {
+    if (!('domainName' in value) || value['domainName'] === undefined) return false;
+    if (!('currencyCode' in value) || value['currencyCode'] === undefined) return false;
+    if (!('toCurrencyCode' in value) || value['toCurrencyCode'] === undefined) return false;
+    if (!('before' in value) || value['before'] === undefined) return false;
+    if (!('after' in value) || value['after'] === undefined) return false;
+    return true;
+}
+
+export function DomainEditPreviewRowDtoFromJSON(json: any): DomainEditPreviewRowDto {
+    return DomainEditPreviewRowDtoFromJSONTyped(json, false);
+}
+
+export function DomainEditPreviewRowDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): DomainEditPreviewRowDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'domainName': json['domainName'],
+        'currencyCode': json['currencyCode'],
+        'toCurrencyCode': json['toCurrencyCode'],
+        'before': json['before'],
+        'after': json['after'],
+    };
+}
+
+export function DomainEditPreviewRowDtoToJSON(json: any): DomainEditPreviewRowDto {
+    return DomainEditPreviewRowDtoToJSONTyped(json, false);
+}
+
+export function DomainEditPreviewRowDtoToJSONTyped(value?: DomainEditPreviewRowDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'domainName': value['domainName'],
+        'currencyCode': value['currencyCode'],
+        'toCurrencyCode': value['toCurrencyCode'],
+        'before': value['before'],
+        'after': value['after'],
+    };
+}
+

package/src/models/FeatureFlagListItemDto.ts

@@ -94,7 +94,8 @@ export const FeatureFlagListItemDtoNameEnum = {
     USE_MAILER_FALLBACK_URL: 'USE_MAILER_FALLBACK_URL',
     USE_MAILER_FALLBACK_FOR_MANUAL_OTP_REQUEST: 'USE_MAILER_FALLBACK_FOR_MANUAL_OTP_REQUEST',
     AIRWALLEX_BANK_TRANSFER_PAYMENT_METHOD: 'AIRWALLEX_BANK_TRANSFER_PAYMENT_METHOD',
-    MARKETPLACE_ROUTING: 'MARKETPLACE_ROUTING'
+    MARKETPLACE_ROUTING: 'MARKETPLACE_ROUTING',
+    AI_DOMAIN_EDIT: 'AI_DOMAIN_EDIT'
 } as const;
 export type FeatureFlagListItemDtoNameEnum = typeof FeatureFlagListItemDtoNameEnum[keyof typeof FeatureFlagListItemDtoNameEnum];
 

package/src/models/IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto.ts

@@ -180,7 +180,8 @@ export const IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatur
     USE_MAILER_FALLBACK_URL: 'USE_MAILER_FALLBACK_URL',
     USE_MAILER_FALLBACK_FOR_MANUAL_OTP_REQUEST: 'USE_MAILER_FALLBACK_FOR_MANUAL_OTP_REQUEST',
     AIRWALLEX_BANK_TRANSFER_PAYMENT_METHOD: 'AIRWALLEX_BANK_TRANSFER_PAYMENT_METHOD',
-    MARKETPLACE_ROUTING: 'MARKETPLACE_ROUTING'
+    MARKETPLACE_ROUTING: 'MARKETPLACE_ROUTING',
+    AI_DOMAIN_EDIT: 'AI_DOMAIN_EDIT'
 } as const;
 export type IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDtoEnabledFeaturesEnum = typeof IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDtoEnabledFeaturesEnum[keyof typeof IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDtoEnabledFeaturesEnum];