@randock/nameshift-api-client 0.0.485 → 0.0.486

package/.openapi-generator/FILES

@@ -315,6 +315,7 @@ src/models/GetSellerChallengesListDto.ts
 src/models/GetSellerChallengesListDtoChallengesInner.ts
 src/models/HistoricalMetrics.ts
 src/models/HttpException.ts
+src/models/ImportDomainsResponseDto.ts
 src/models/IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto.ts
 src/models/IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto.ts
 src/models/IntersectionDomainDtoWithHijackerDtoWithAccountDto.ts

package/README.md

@@ -1,4 +1,4 @@
-## @randock/nameshift-api-client@0.0.485
+## @randock/nameshift-api-client@0.0.486
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @randock/nameshift-api-client@0.0.485 --save
+npm install @randock/nameshift-api-client@0.0.486 --save
 ```
 
 _unPublished (not recommended):_
@@ -44,4 +44,4 @@ _unPublished (not recommended):_
 ```
 npm install PATH_TO_GENERATED_PACKAGE --save
 ```
-b341a19b31c15865c8f475c67ff6b199f5ae86c79742266463fb285c8ff53ec84c2d9d9be8c392df664c51fd787f993a
+f29b6d7edb528b035bf08f552355713baff1d1d22e2e249d91eb6ba0095797383a73fb4181bcdd194c893a86f7ace1c2

package/dist/apis/DomainsApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { ApplyDomainEditInput, BatchImportPreviewDto, BatchUpdateDomainsInput, BulkUpdateDomainsWithFiltersInput, CheckDomainsNsInput, DeleteDomainsInput, DomainEditPreviewDto, DomainExchangeRateDto, DomainFiltersDto, DomainSearchTranslationDto, DomainUrlDto, DomainVerificationStatusDto, GetAllDomainTransfers200Response, IntersectionDomainDtoWithHijackerDtoWithAccountDto, JobDto, List200Response2, PreviewDomainEditInput, SellerDomainAffiliateCommissionDto, SellerDomainTransferDto, StartAuctionInput, TranslateDomainSearchInput, UpdateDomainInput, UpdateDomainTransferAuthCodeInput, UpdateDomainTransferIpsTagInput } from '../models/index';
+import type { ApplyDomainEditInput, BatchImportPreviewDto, BatchUpdateDomainsInput, BulkUpdateDomainsWithFiltersInput, CheckDomainsNsInput, DeleteDomainsInput, DomainEditPreviewDto, DomainExchangeRateDto, DomainFiltersDto, DomainSearchTranslationDto, DomainUrlDto, DomainVerificationStatusDto, GetAllDomainTransfers200Response, ImportDomainsResponseDto, IntersectionDomainDtoWithHijackerDtoWithAccountDto, JobDto, List200Response2, PreviewDomainEditInput, SellerDomainAffiliateCommissionDto, SellerDomainTransferDto, StartAuctionInput, TranslateDomainSearchInput, UpdateDomainInput, UpdateDomainTransferAuthCodeInput, UpdateDomainTransferIpsTagInput } from '../models/index';
 export interface DomainsApiApplyDomainEditRequest {
     applyDomainEditInput: ApplyDomainEditInput;
     searchFilter?: string;
@@ -21,6 +21,7 @@ export interface DomainsApiApplyDomainEditRequest {
 export interface DomainsApiBatchImportRequest {
     domains?: Array<string>;
     file?: Blob | null;
+    notifyByEmail?: boolean;
 }
 export interface DomainsApiBatchImportPreviewRequest {
     file?: Blob | null;
@@ -135,15 +136,15 @@ export declare class DomainsApi extends runtime.BaseAPI {
      */
     applyDomainEdit(requestParameters: DomainsApiApplyDomainEditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobDto>;
     /**
-     * Imports domains from an uploaded file or a list of domain names and queues them for processing.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Imports domains from an uploaded file or a list of domain names. A list is imported before the response is sent, and answered with 201.  A file is imported in the background: 1. The upload is answered with 202 and the job, which the `Location` header points at as well. The id to poll is at `job.id`. 2. Poll `GET /private/jobs/{jobId}` until its `status` is `finished` or `failed`. 3. Download the outcome of every row from `GET /private/jobs/{jobId}/result`, which redirects to a CSV on a public host. Follow the redirect without the `apikey` header, which the file does not need.  With an API key, starting an import needs the `DOMAINS_WRITE` scope, while polling the job and downloading its result need `DOMAINS_READ`. Scopes are matched exactly, so a key that imports files needs both.  `notifyByEmail` decides whether the user who started a file import is emailed about how it ended: when it has failed, or when it has finished after running for longer than 30 seconds. It defaults to true. An integration that polls the job usually sets it to false, which skips both emails.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Import domains
      */
-    batchImportRaw(requestParameters: DomainsApiBatchImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    batchImportRaw(requestParameters: DomainsApiBatchImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImportDomainsResponseDto>>;
     /**
-     * Imports domains from an uploaded file or a list of domain names and queues them for processing.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Imports domains from an uploaded file or a list of domain names. A list is imported before the response is sent, and answered with 201.  A file is imported in the background: 1. The upload is answered with 202 and the job, which the `Location` header points at as well. The id to poll is at `job.id`. 2. Poll `GET /private/jobs/{jobId}` until its `status` is `finished` or `failed`. 3. Download the outcome of every row from `GET /private/jobs/{jobId}/result`, which redirects to a CSV on a public host. Follow the redirect without the `apikey` header, which the file does not need.  With an API key, starting an import needs the `DOMAINS_WRITE` scope, while polling the job and downloading its result need `DOMAINS_READ`. Scopes are matched exactly, so a key that imports files needs both.  `notifyByEmail` decides whether the user who started a file import is emailed about how it ended: when it has failed, or when it has finished after running for longer than 30 seconds. It defaults to true. An integration that polls the job usually sets it to false, which skips both emails.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Import domains
      */
-    batchImport(requestParameters?: DomainsApiBatchImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    batchImport(requestParameters?: DomainsApiBatchImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImportDomainsResponseDto>;
     /**
      * Uploads a domain import file and returns a preview of parsed domains before import.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Preview domain import

package/dist/apis/DomainsApi.js

@@ -147,7 +147,7 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Imports domains from an uploaded file or a list of domain names and queues them for processing.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Imports domains from an uploaded file or a list of domain names. A list is imported before the response is sent, and answered with 201.  A file is imported in the background: 1. The upload is answered with 202 and the job, which the `Location` header points at as well. The id to poll is at `job.id`. 2. Poll `GET /private/jobs/{jobId}` until its `status` is `finished` or `failed`. 3. Download the outcome of every row from `GET /private/jobs/{jobId}/result`, which redirects to a CSV on a public host. Follow the redirect without the `apikey` header, which the file does not need.  With an API key, starting an import needs the `DOMAINS_WRITE` scope, while polling the job and downloading its result need `DOMAINS_READ`. Scopes are matched exactly, so a key that imports files needs both.  `notifyByEmail` decides whether the user who started a file import is emailed about how it ended: when it has failed, or when it has finished after running for longer than 30 seconds. It defaults to true. An integration that polls the job usually sets it to false, which skips both emails.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Import domains
      */
     DomainsApi.prototype.batchImportRaw = function (requestParameters, initOverrides) {
@@ -195,6 +195,9 @@ var DomainsApi = /** @class */ (function (_super) {
                         if (requestParameters['file'] != null) {
                             formParams.append('file', requestParameters['file']);
                         }
+                        if (requestParameters['notifyByEmail'] != null) {
+                            formParams.append('notifyByEmail', requestParameters['notifyByEmail']);
+                        }
                         return [4 /*yield*/, this.request({
                                 path: "/private/domains",
                                 method: 'POST',
@@ -204,24 +207,26 @@ var DomainsApi = /** @class */ (function (_super) {
                             }, initOverrides)];
                     case 5:
                         response = _c.sent();
-                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.ImportDomainsResponseDtoFromJSON)(jsonValue); })];
                 }
             });
         });
     };
     /**
-     * Imports domains from an uploaded file or a list of domain names and queues them for processing.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Imports domains from an uploaded file or a list of domain names. A list is imported before the response is sent, and answered with 201.  A file is imported in the background: 1. The upload is answered with 202 and the job, which the `Location` header points at as well. The id to poll is at `job.id`. 2. Poll `GET /private/jobs/{jobId}` until its `status` is `finished` or `failed`. 3. Download the outcome of every row from `GET /private/jobs/{jobId}/result`, which redirects to a CSV on a public host. Follow the redirect without the `apikey` header, which the file does not need.  With an API key, starting an import needs the `DOMAINS_WRITE` scope, while polling the job and downloading its result need `DOMAINS_READ`. Scopes are matched exactly, so a key that imports files needs both.  `notifyByEmail` decides whether the user who started a file import is emailed about how it ended: when it has failed, or when it has finished after running for longer than 30 seconds. It defaults to true. An integration that polls the job usually sets it to false, which skips both emails.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Import domains
      */
     DomainsApi.prototype.batchImport = function () {
         return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
+            var response;
             if (requestParameters === void 0) { requestParameters = {}; }
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, this.batchImportRaw(requestParameters, initOverrides)];
                     case 1:
-                        _a.sent();
-                        return [2 /*return*/];
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
                 }
             });
         });

package/dist/apis/JobsApi.d.ts

@@ -14,6 +14,9 @@ import type { JobDto, ListJobs200Response } from '../models/index';
 export interface JobsApiGetJobRequest {
     jobId: string;
 }
+export interface JobsApiGetJobResultRequest {
+    jobId: string;
+}
 export interface JobsApiListJobsRequest {
     filter?: {
         [key: string]: string;
@@ -29,22 +32,32 @@ export interface JobsApiListJobsRequest {
  */
 export declare 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.
+     * Progress and result of one job belonging to the account. A finished import links the outcome of every row in `resultFileUrl`.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get a background job
      */
     getJobRaw(requestParameters: JobsApiGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobDto>>;
     /**
-     * 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.
+     * Progress and result of one job belonging to the account. A finished import links the outcome of every row in `resultFileUrl`.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get a background job
      */
     getJob(requestParameters: JobsApiGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobDto>;
     /**
-     * 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.
+     * Redirects to the CSV with the outcome of every row of a finished import: the file the job\'s `resultFileUrl` links, which anyone who has the link can download. Follow the redirect without the `apikey` header: the file does not need it, and most HTTP clients, `curl -L` among them, keep sending a custom header when a redirect takes them to another host. Downloading `resultFileUrl` itself avoids the redirect altogether. The file can expire: when the bucket has a retention rule, the file is removed once it has run out, and the link then answers 404.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Download the result file of a background job
+     */
+    getJobResultRaw(requestParameters: JobsApiGetJobResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Redirects to the CSV with the outcome of every row of a finished import: the file the job\'s `resultFileUrl` links, which anyone who has the link can download. Follow the redirect without the `apikey` header: the file does not need it, and most HTTP clients, `curl -L` among them, keep sending a custom header when a redirect takes them to another host. Downloading `resultFileUrl` itself avoids the redirect altogether. The file can expire: when the bucket has a retention rule, the file is removed once it has run out, and the link then answers 404.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Download the result file of a background job
+     */
+    getJobResult(requestParameters: JobsApiGetJobResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * The account\'s own background jobs, newest first. Filter on status while polling, so watching a run costs nothing however long the history is. A finished job that wrote a result file links it in `resultFileUrl`.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * List background jobs
      */
     listJobsRaw(requestParameters: JobsApiListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListJobs200Response>>;
     /**
-     * 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.
+     * The account\'s own background jobs, newest first. Filter on status while polling, so watching a run costs nothing however long the history is. A finished job that wrote a result file links it in `resultFileUrl`.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * List background jobs
      */
     listJobs(requestParameters?: JobsApiListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListJobs200Response>;

package/dist/apis/JobsApi.js

@@ -76,7 +76,7 @@ var JobsApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     * 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.
+     * Progress and result of one job belonging to the account. A finished import links the outcome of every row in `resultFileUrl`.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get a background job
      */
     JobsApi.prototype.getJobRaw = function (requestParameters, initOverrides) {
@@ -121,7 +121,7 @@ var JobsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * 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.
+     * Progress and result of one job belonging to the account. A finished import links the outcome of every row in `resultFileUrl`.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get a background job
      */
     JobsApi.prototype.getJob = function (requestParameters, initOverrides) {
@@ -139,7 +139,68 @@ var JobsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * 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.
+     * Redirects to the CSV with the outcome of every row of a finished import: the file the job\'s `resultFileUrl` links, which anyone who has the link can download. Follow the redirect without the `apikey` header: the file does not need it, and most HTTP clients, `curl -L` among them, keep sending a custom header when a redirect takes them to another host. Downloading `resultFileUrl` itself avoids the redirect altogether. The file can expire: when the bucket has a retention rule, the file is removed once it has run out, and the link then answers 404.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Download the result file of a background job
+     */
+    JobsApi.prototype.getJobResultRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, token, tokenString, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters['jobId'] == null) {
+                            throw new runtime.RequiredError('jobId', 'Required parameter "jobId" was null or undefined when calling getJobResult().');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
+                        _a = headerParameters;
+                        _b = "apikey";
+                        return [4 /*yield*/, this.configuration.apiKey("apikey")];
+                    case 1:
+                        _a[_b] = _c.sent(); // api_key authentication
+                        _c.label = 2;
+                    case 2:
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearer", [])];
+                    case 3:
+                        tokenString = _c.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _c.label = 4;
+                    case 4: return [4 /*yield*/, this.request({
+                            path: "/private/jobs/{jobId}/result".replace("{".concat("jobId", "}"), encodeURIComponent(String(requestParameters['jobId']))),
+                            method: 'GET',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 5:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Redirects to the CSV with the outcome of every row of a finished import: the file the job\'s `resultFileUrl` links, which anyone who has the link can download. Follow the redirect without the `apikey` header: the file does not need it, and most HTTP clients, `curl -L` among them, keep sending a custom header when a redirect takes them to another host. Downloading `resultFileUrl` itself avoids the redirect altogether. The file can expire: when the bucket has a retention rule, the file is removed once it has run out, and the link then answers 404.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Download the result file of a background job
+     */
+    JobsApi.prototype.getJobResult = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getJobResultRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * The account\'s own background jobs, newest first. Filter on status while polling, so watching a run costs nothing however long the history is. A finished job that wrote a result file links it in `resultFileUrl`.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * List background jobs
      */
     JobsApi.prototype.listJobsRaw = function (requestParameters, initOverrides) {
@@ -199,7 +260,7 @@ var JobsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * 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.
+     * The account\'s own background jobs, newest first. Filter on status while polling, so watching a run costs nothing however long the history is. A finished job that wrote a result file links it in `resultFileUrl`.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
      * List background jobs
      */
     JobsApi.prototype.listJobs = function () {

package/dist/models/BuyerNotificationDto.d.ts

@@ -95,6 +95,7 @@ export declare const BuyerNotificationDtoTypeEnum: {
     readonly REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: "request_ips_tag_to_seller_ips_tag_invalid";
     readonly EXPORT_COMPLETED: "export_completed";
     readonly DOMAIN_IMPORT_FINISHED: "domain_import_finished";
+    readonly DOMAIN_IMPORT_FAILED: "domain_import_failed";
     readonly DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: "domain_offer_verified_buyer_access_link_email";
     readonly DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: "domain_offer_received_buyer_access_link_email";
     readonly DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: "domain_offer_accepted_continue_order_email";

package/dist/models/BuyerNotificationDto.js

@@ -56,6 +56,7 @@ exports.BuyerNotificationDtoTypeEnum = {
     REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: 'request_ips_tag_to_seller_ips_tag_invalid',
     EXPORT_COMPLETED: 'export_completed',
     DOMAIN_IMPORT_FINISHED: 'domain_import_finished',
+    DOMAIN_IMPORT_FAILED: 'domain_import_failed',
     DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_verified_buyer_access_link_email',
     DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_received_buyer_access_link_email',
     DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: 'domain_offer_accepted_continue_order_email',

package/dist/models/BuyerNotificationListItemDto.d.ts

@@ -88,6 +88,7 @@ export declare const BuyerNotificationListItemDtoTypeEnum: {
     readonly REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: "request_ips_tag_to_seller_ips_tag_invalid";
     readonly EXPORT_COMPLETED: "export_completed";
     readonly DOMAIN_IMPORT_FINISHED: "domain_import_finished";
+    readonly DOMAIN_IMPORT_FAILED: "domain_import_failed";
     readonly DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: "domain_offer_verified_buyer_access_link_email";
     readonly DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: "domain_offer_received_buyer_access_link_email";
     readonly DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: "domain_offer_accepted_continue_order_email";

package/dist/models/BuyerNotificationListItemDto.js

@@ -55,6 +55,7 @@ exports.BuyerNotificationListItemDtoTypeEnum = {
     REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: 'request_ips_tag_to_seller_ips_tag_invalid',
     EXPORT_COMPLETED: 'export_completed',
     DOMAIN_IMPORT_FINISHED: 'domain_import_finished',
+    DOMAIN_IMPORT_FAILED: 'domain_import_failed',
     DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_verified_buyer_access_link_email',
     DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_received_buyer_access_link_email',
     DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: 'domain_offer_accepted_continue_order_email',

package/dist/models/ImportDomainsResponseDto.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 type { JobDto } from './JobDto';
+/**
+ *
+ * @export
+ * @interface ImportDomainsResponseDto
+ */
+export interface ImportDomainsResponseDto {
+    /**
+     * The background job importing the uploaded file. Null for a list of domain names, which is imported before the response is sent.
+     * @type {JobDto}
+     * @memberof ImportDomainsResponseDto
+     */
+    job: JobDto | null;
+}
+/**
+ * Check if a given object implements the ImportDomainsResponseDto interface.
+ */
+export declare function instanceOfImportDomainsResponseDto(value: object): value is ImportDomainsResponseDto;
+export declare function ImportDomainsResponseDtoFromJSON(json: any): ImportDomainsResponseDto;
+export declare function ImportDomainsResponseDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ImportDomainsResponseDto;
+export declare function ImportDomainsResponseDtoToJSON(json: any): ImportDomainsResponseDto;
+export declare function ImportDomainsResponseDtoToJSONTyped(value?: ImportDomainsResponseDto | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ImportDomainsResponseDto.js

@@ -0,0 +1,52 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfImportDomainsResponseDto = instanceOfImportDomainsResponseDto;
+exports.ImportDomainsResponseDtoFromJSON = ImportDomainsResponseDtoFromJSON;
+exports.ImportDomainsResponseDtoFromJSONTyped = ImportDomainsResponseDtoFromJSONTyped;
+exports.ImportDomainsResponseDtoToJSON = ImportDomainsResponseDtoToJSON;
+exports.ImportDomainsResponseDtoToJSONTyped = ImportDomainsResponseDtoToJSONTyped;
+var JobDto_1 = require("./JobDto");
+/**
+ * Check if a given object implements the ImportDomainsResponseDto interface.
+ */
+function instanceOfImportDomainsResponseDto(value) {
+    if (!('job' in value) || value['job'] === undefined)
+        return false;
+    return true;
+}
+function ImportDomainsResponseDtoFromJSON(json) {
+    return ImportDomainsResponseDtoFromJSONTyped(json, false);
+}
+function ImportDomainsResponseDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'job': (0, JobDto_1.JobDtoFromJSON)(json['job']),
+    };
+}
+function ImportDomainsResponseDtoToJSON(json) {
+    return ImportDomainsResponseDtoToJSONTyped(json, false);
+}
+function ImportDomainsResponseDtoToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'job': (0, JobDto_1.JobDtoToJSON)(value['job']),
+    };
+}

package/dist/models/JobDto.d.ts

@@ -66,12 +66,32 @@ export interface JobDto {
      * @memberof JobDto
      */
     failures: Array<JobFailureDto>;
+    /**
+     * How many items ended which way, for a kind of job whose items can end in more than two ways. An import counts created, updated, unchanged, deleted, hijack, ignored and error. Unchanged is a domain the account already had exactly as its row describes it, which the import leaves as it was. Null for a job that keeps no breakdown.
+     * @type {{ [key: string]: number; }}
+     * @memberof JobDto
+     */
+    result: {
+        [key: string]: number;
+    } | null;
+    /**
+     * A CSV with the outcome of every item, once a job that writes one has finished. The link is public: anyone who has it can download the file.
+     * @type {string}
+     * @memberof JobDto
+     */
+    resultFileUrl: string | null;
     /**
      * Why the job as a whole stopped. Never a per-item problem.
      * @type {string}
      * @memberof JobDto
      */
     failureReason: string | null;
+    /**
+     * Whether the user who started the job is emailed when it has failed, or when it has finished after running for longer than 30 seconds. False for a file import started with `notifyByEmail` set to false; true for every other job.
+     * @type {boolean}
+     * @memberof JobDto
+     */
+    readonly notifyByEmail: boolean;
     /**
      *
      * @type {Date}
@@ -98,4 +118,4 @@ export declare function instanceOfJobDto(value: object): value is JobDto;
 export declare function JobDtoFromJSON(json: any): JobDto;
 export declare function JobDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobDto;
 export declare function JobDtoToJSON(json: any): JobDto;
-export declare function JobDtoToJSONTyped(value?: JobDto | null, ignoreDiscriminator?: boolean): any;
+export declare function JobDtoToJSONTyped(value?: Omit<JobDto, 'notifyByEmail'> | null, ignoreDiscriminator?: boolean): any;

package/dist/models/JobDto.js

@@ -41,8 +41,14 @@ function instanceOfJobDto(value) {
         return false;
     if (!('failures' in value) || value['failures'] === undefined)
         return false;
+    if (!('result' in value) || value['result'] === undefined)
+        return false;
+    if (!('resultFileUrl' in value) || value['resultFileUrl'] === undefined)
+        return false;
     if (!('failureReason' in value) || value['failureReason'] === undefined)
         return false;
+    if (!('notifyByEmail' in value) || value['notifyByEmail'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     if (!('startedAt' in value) || value['startedAt'] === undefined)
@@ -67,7 +73,10 @@ function JobDtoFromJSONTyped(json, ignoreDiscriminator) {
         'succeeded': json['succeeded'],
         'failed': json['failed'],
         'failures': (json['failures'].map(JobFailureDto_1.JobFailureDtoFromJSON)),
+        'result': json['result'],
+        'resultFileUrl': json['resultFileUrl'],
         'failureReason': json['failureReason'],
+        'notifyByEmail': json['notifyByEmail'],
         'createdAt': (new Date(json['createdAt'])),
         'startedAt': (json['startedAt'] == null ? null : new Date(json['startedAt'])),
         'finishedAt': (json['finishedAt'] == null ? null : new Date(json['finishedAt'])),
@@ -90,6 +99,8 @@ function JobDtoToJSONTyped(value, ignoreDiscriminator) {
         'succeeded': value['succeeded'],
         'failed': value['failed'],
         'failures': (value['failures'].map(JobFailureDto_1.JobFailureDtoToJSON)),
+        'result': value['result'],
+        'resultFileUrl': value['resultFileUrl'],
         'failureReason': value['failureReason'],
         'createdAt': ((value['createdAt']).toISOString()),
         'startedAt': (value['startedAt'] == null ? null : value['startedAt'].toISOString()),

package/dist/models/JobFailureDto.d.ts

@@ -16,7 +16,7 @@
  */
 export interface JobFailureDto {
     /**
-     * What the failure was about — a domain name, for a bulk edit.
+     * What the failure was about, usually a domain name: the domain a bulk edit refused, or an import row as it was uploaded.
      * @type {string}
      * @memberof JobFailureDto
      */

package/dist/models/JobType.d.ts

@@ -15,6 +15,7 @@
  */
 export declare const JobType: {
     readonly BULK_EDIT_DOMAINS: "bulk_edit_domains";
+    readonly IMPORT_DOMAINS: "import_domains";
 };
 export type JobType = typeof JobType[keyof typeof JobType];
 export declare function instanceOfJobType(value: any): boolean;

package/dist/models/JobType.js

@@ -24,7 +24,8 @@ exports.JobTypeToJSONTyped = JobTypeToJSONTyped;
  * @export
  */
 exports.JobType = {
-    BULK_EDIT_DOMAINS: 'bulk_edit_domains'
+    BULK_EDIT_DOMAINS: 'bulk_edit_domains',
+    IMPORT_DOMAINS: 'import_domains'
 };
 function instanceOfJobType(value) {
     for (var key in exports.JobType) {

package/dist/models/UserNotificationDto.d.ts

@@ -95,6 +95,7 @@ export declare const UserNotificationDtoTypeEnum: {
     readonly REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: "request_ips_tag_to_seller_ips_tag_invalid";
     readonly EXPORT_COMPLETED: "export_completed";
     readonly DOMAIN_IMPORT_FINISHED: "domain_import_finished";
+    readonly DOMAIN_IMPORT_FAILED: "domain_import_failed";
     readonly DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: "domain_offer_verified_buyer_access_link_email";
     readonly DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: "domain_offer_received_buyer_access_link_email";
     readonly DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: "domain_offer_accepted_continue_order_email";

package/dist/models/UserNotificationDto.js

@@ -56,6 +56,7 @@ exports.UserNotificationDtoTypeEnum = {
     REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: 'request_ips_tag_to_seller_ips_tag_invalid',
     EXPORT_COMPLETED: 'export_completed',
     DOMAIN_IMPORT_FINISHED: 'domain_import_finished',
+    DOMAIN_IMPORT_FAILED: 'domain_import_failed',
     DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_verified_buyer_access_link_email',
     DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_received_buyer_access_link_email',
     DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: 'domain_offer_accepted_continue_order_email',

package/dist/models/UserNotificationListItemDto.d.ts

@@ -88,6 +88,7 @@ export declare const UserNotificationListItemDtoTypeEnum: {
     readonly REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: "request_ips_tag_to_seller_ips_tag_invalid";
     readonly EXPORT_COMPLETED: "export_completed";
     readonly DOMAIN_IMPORT_FINISHED: "domain_import_finished";
+    readonly DOMAIN_IMPORT_FAILED: "domain_import_failed";
     readonly DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: "domain_offer_verified_buyer_access_link_email";
     readonly DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: "domain_offer_received_buyer_access_link_email";
     readonly DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: "domain_offer_accepted_continue_order_email";

package/dist/models/UserNotificationListItemDto.js

@@ -55,6 +55,7 @@ exports.UserNotificationListItemDtoTypeEnum = {
     REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: 'request_ips_tag_to_seller_ips_tag_invalid',
     EXPORT_COMPLETED: 'export_completed',
     DOMAIN_IMPORT_FINISHED: 'domain_import_finished',
+    DOMAIN_IMPORT_FAILED: 'domain_import_failed',
     DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_verified_buyer_access_link_email',
     DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_received_buyer_access_link_email',
     DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: 'domain_offer_accepted_continue_order_email',

package/dist/models/index.d.ts

@@ -274,6 +274,7 @@ export * from './GetSellerChallengesListDto';
 export * from './GetSellerChallengesListDtoChallengesInner';
 export * from './HistoricalMetrics';
 export * from './HttpException';
+export * from './ImportDomainsResponseDto';
 export * from './IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto';
 export * from './IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto';
 export * from './IntersectionDomainDtoWithHijackerDtoWithAccountDto';

package/dist/models/index.js

@@ -292,6 +292,7 @@ __exportStar(require("./GetSellerChallengesListDto"), exports);
 __exportStar(require("./GetSellerChallengesListDtoChallengesInner"), exports);
 __exportStar(require("./HistoricalMetrics"), exports);
 __exportStar(require("./HttpException"), exports);
+__exportStar(require("./ImportDomainsResponseDto"), exports);
 __exportStar(require("./IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto"), exports);
 __exportStar(require("./IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto"), exports);
 __exportStar(require("./IntersectionDomainDtoWithHijackerDtoWithAccountDto"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@randock/nameshift-api-client",
-  "version": "0.0.485",
+  "version": "0.0.486",
   "description": "OpenAPI client for @randock/nameshift-api-client",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/DomainsApi.ts

@@ -30,6 +30,7 @@ import type {
   DomainVerificationStatusDto,
   ForbiddenException,
   GetAllDomainTransfers200Response,
+  ImportDomainsResponseDto,
   IntersectionDomainDtoWithHijackerDtoWithAccountDto,
   JobDto,
   List200Response2,
@@ -75,6 +76,8 @@ import {
     ForbiddenExceptionToJSON,
     GetAllDomainTransfers200ResponseFromJSON,
     GetAllDomainTransfers200ResponseToJSON,
+    ImportDomainsResponseDtoFromJSON,
+    ImportDomainsResponseDtoToJSON,
     IntersectionDomainDtoWithHijackerDtoWithAccountDtoFromJSON,
     IntersectionDomainDtoWithHijackerDtoWithAccountDtoToJSON,
     JobDtoFromJSON,
@@ -112,6 +115,7 @@ export interface DomainsApiApplyDomainEditRequest {
 export interface DomainsApiBatchImportRequest {
     domains?: Array<string>;
     file?: Blob | null;
+    notifyByEmail?: boolean;
 }
 
 export interface DomainsApiBatchImportPreviewRequest {
@@ -292,10 +296,10 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Imports domains from an uploaded file or a list of domain names and queues them for processing.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Imports domains from an uploaded file or a list of domain names. A list is imported before the response is sent, and answered with 201.  A file is imported in the background: 1. The upload is answered with 202 and the job, which the `Location` header points at as well. The id to poll is at `job.id`. 2. Poll `GET /private/jobs/{jobId}` until its `status` is `finished` or `failed`. 3. Download the outcome of every row from `GET /private/jobs/{jobId}/result`, which redirects to a CSV on a public host. Follow the redirect without the `apikey` header, which the file does not need.  With an API key, starting an import needs the `DOMAINS_WRITE` scope, while polling the job and downloading its result need `DOMAINS_READ`. Scopes are matched exactly, so a key that imports files needs both.  `notifyByEmail` decides whether the user who started a file import is emailed about how it ended: when it has failed, or when it has finished after running for longer than 30 seconds. It defaults to true. An integration that polls the job usually sets it to false, which skips both emails.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Import domains
      */
-    async batchImportRaw(requestParameters: DomainsApiBatchImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async batchImportRaw(requestParameters: DomainsApiBatchImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImportDomainsResponseDto>> {
         const queryParameters: any = {};
 
         const headerParameters: runtime.HTTPHeaders = {};
@@ -336,6 +340,10 @@ export class DomainsApi extends runtime.BaseAPI {
             formParams.append('file', requestParameters['file'] as any);
         }
 
+        if (requestParameters['notifyByEmail'] != null) {
+            formParams.append('notifyByEmail', requestParameters['notifyByEmail'] as any);
+        }
+
         const response = await this.request({
             path: `/private/domains`,
             method: 'POST',
@@ -344,15 +352,16 @@ export class DomainsApi extends runtime.BaseAPI {
             body: formParams,
         }, initOverrides);
 
-        return new runtime.VoidApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => ImportDomainsResponseDtoFromJSON(jsonValue));
     }
 
     /**
-     * Imports domains from an uploaded file or a list of domain names and queues them for processing.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
+     * Imports domains from an uploaded file or a list of domain names. A list is imported before the response is sent, and answered with 201.  A file is imported in the background: 1. The upload is answered with 202 and the job, which the `Location` header points at as well. The id to poll is at `job.id`. 2. Poll `GET /private/jobs/{jobId}` until its `status` is `finished` or `failed`. 3. Download the outcome of every row from `GET /private/jobs/{jobId}/result`, which redirects to a CSV on a public host. Follow the redirect without the `apikey` header, which the file does not need.  With an API key, starting an import needs the `DOMAINS_WRITE` scope, while polling the job and downloading its result need `DOMAINS_READ`. Scopes are matched exactly, so a key that imports files needs both.  `notifyByEmail` decides whether the user who started a file import is emailed about how it ended: when it has failed, or when it has finished after running for longer than 30 seconds. It defaults to true. An integration that polls the job usually sets it to false, which skips both emails.  **API key scope required:** `DOMAINS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Import domains
      */
-    async batchImport(requestParameters: DomainsApiBatchImportRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
-        await this.batchImportRaw(requestParameters, initOverrides);
+    async batchImport(requestParameters: DomainsApiBatchImportRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImportDomainsResponseDto> {
+        const response = await this.batchImportRaw(requestParameters, initOverrides);
+        return await response.value();
     }
 
     /**

package/src/apis/JobsApi.ts

@@ -15,12 +15,15 @@
 
 import * as runtime from '../runtime';
 import type {
+  ConflictException,
   JobDto,
   ListJobs200Response,
   NotFoundException,
   ValidationException,
 } from '../models/index';
 import {
+    ConflictExceptionFromJSON,
+    ConflictExceptionToJSON,
     JobDtoFromJSON,
     JobDtoToJSON,
     ListJobs200ResponseFromJSON,
@@ -35,6 +38,10 @@ export interface JobsApiGetJobRequest {
     jobId: string;
 }
 
+export interface JobsApiGetJobResultRequest {
+    jobId: string;
+}
+
 export interface JobsApiListJobsRequest {
     filter?: { [key: string]: string; };
     page?: number;
@@ -50,7 +57,7 @@ export interface JobsApiListJobsRequest {
 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.
+     * Progress and result of one job belonging to the account. A finished import links the outcome of every row in `resultFileUrl`.  **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>> {
@@ -88,7 +95,7 @@ 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.
+     * Progress and result of one job belonging to the account. A finished import links the outcome of every row in `resultFileUrl`.  **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> {
@@ -97,7 +104,53 @@ export class JobsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 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.
+     * Redirects to the CSV with the outcome of every row of a finished import: the file the job\'s `resultFileUrl` links, which anyone who has the link can download. Follow the redirect without the `apikey` header: the file does not need it, and most HTTP clients, `curl -L` among them, keep sending a custom header when a redirect takes them to another host. Downloading `resultFileUrl` itself avoids the redirect altogether. The file can expire: when the bucket has a retention rule, the file is removed once it has run out, and the link then answers 404.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Download the result file of a background job
+     */
+    async getJobResultRaw(requestParameters: JobsApiGetJobResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['jobId'] == null) {
+            throw new runtime.RequiredError(
+                'jobId',
+                'Required parameter "jobId" was null or undefined when calling getJobResult().'
+            );
+        }
+
+        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}/result`.replace(`{${"jobId"}}`, encodeURIComponent(String(requestParameters['jobId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Redirects to the CSV with the outcome of every row of a finished import: the file the job\'s `resultFileUrl` links, which anyone who has the link can download. Follow the redirect without the `apikey` header: the file does not need it, and most HTTP clients, `curl -L` among them, keep sending a custom header when a redirect takes them to another host. Downloading `resultFileUrl` itself avoids the redirect altogether. The file can expire: when the bucket has a retention rule, the file is removed once it has run out, and the link then answers 404.  **API key scope required:** `DOMAINS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Download the result file of a background job
+     */
+    async getJobResult(requestParameters: JobsApiGetJobResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getJobResultRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * The account\'s own background jobs, newest first. Filter on status while polling, so watching a run costs nothing however long the history is. A finished job that wrote a result file links it in `resultFileUrl`.  **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>> {
@@ -152,7 +205,7 @@ export class JobsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 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.
+     * The account\'s own background jobs, newest first. Filter on status while polling, so watching a run costs nothing however long the history is. A finished job that wrote a result file links it in `resultFileUrl`.  **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> {

package/src/models/BuyerNotificationDto.ts

@@ -108,6 +108,7 @@ export const BuyerNotificationDtoTypeEnum = {
     REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: 'request_ips_tag_to_seller_ips_tag_invalid',
     EXPORT_COMPLETED: 'export_completed',
     DOMAIN_IMPORT_FINISHED: 'domain_import_finished',
+    DOMAIN_IMPORT_FAILED: 'domain_import_failed',
     DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_verified_buyer_access_link_email',
     DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_received_buyer_access_link_email',
     DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: 'domain_offer_accepted_continue_order_email',

package/src/models/BuyerNotificationListItemDto.ts

@@ -94,6 +94,7 @@ export const BuyerNotificationListItemDtoTypeEnum = {
     REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: 'request_ips_tag_to_seller_ips_tag_invalid',
     EXPORT_COMPLETED: 'export_completed',
     DOMAIN_IMPORT_FINISHED: 'domain_import_finished',
+    DOMAIN_IMPORT_FAILED: 'domain_import_failed',
     DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_verified_buyer_access_link_email',
     DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_received_buyer_access_link_email',
     DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: 'domain_offer_accepted_continue_order_email',

package/src/models/ImportDomainsResponseDto.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';
+import type { JobDto } from './JobDto';
+import {
+    JobDtoFromJSON,
+    JobDtoFromJSONTyped,
+    JobDtoToJSON,
+    JobDtoToJSONTyped,
+} from './JobDto';
+
+/**
+ * 
+ * @export
+ * @interface ImportDomainsResponseDto
+ */
+export interface ImportDomainsResponseDto {
+    /**
+     * The background job importing the uploaded file. Null for a list of domain names, which is imported before the response is sent.
+     * @type {JobDto}
+     * @memberof ImportDomainsResponseDto
+     */
+    job: JobDto | null;
+}
+
+/**
+ * Check if a given object implements the ImportDomainsResponseDto interface.
+ */
+export function instanceOfImportDomainsResponseDto(value: object): value is ImportDomainsResponseDto {
+    if (!('job' in value) || value['job'] === undefined) return false;
+    return true;
+}
+
+export function ImportDomainsResponseDtoFromJSON(json: any): ImportDomainsResponseDto {
+    return ImportDomainsResponseDtoFromJSONTyped(json, false);
+}
+
+export function ImportDomainsResponseDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ImportDomainsResponseDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'job': JobDtoFromJSON(json['job']),
+    };
+}
+
+export function ImportDomainsResponseDtoToJSON(json: any): ImportDomainsResponseDto {
+    return ImportDomainsResponseDtoToJSONTyped(json, false);
+}
+
+export function ImportDomainsResponseDtoToJSONTyped(value?: ImportDomainsResponseDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'job': JobDtoToJSON(value['job']),
+    };
+}
+

package/src/models/JobDto.ts

@@ -89,12 +89,30 @@ export interface JobDto {
      * @memberof JobDto
      */
     failures: Array<JobFailureDto>;
+    /**
+     * How many items ended which way, for a kind of job whose items can end in more than two ways. An import counts created, updated, unchanged, deleted, hijack, ignored and error. Unchanged is a domain the account already had exactly as its row describes it, which the import leaves as it was. Null for a job that keeps no breakdown.
+     * @type {{ [key: string]: number; }}
+     * @memberof JobDto
+     */
+    result: { [key: string]: number; } | null;
+    /**
+     * A CSV with the outcome of every item, once a job that writes one has finished. The link is public: anyone who has it can download the file.
+     * @type {string}
+     * @memberof JobDto
+     */
+    resultFileUrl: string | null;
     /**
      * Why the job as a whole stopped. Never a per-item problem.
      * @type {string}
      * @memberof JobDto
      */
     failureReason: string | null;
+    /**
+     * Whether the user who started the job is emailed when it has failed, or when it has finished after running for longer than 30 seconds. False for a file import started with `notifyByEmail` set to false; true for every other job.
+     * @type {boolean}
+     * @memberof JobDto
+     */
+    readonly notifyByEmail: boolean;
     /**
      * 
      * @type {Date}
@@ -129,7 +147,10 @@ export function instanceOfJobDto(value: object): value is JobDto {
     if (!('succeeded' in value) || value['succeeded'] === undefined) return false;
     if (!('failed' in value) || value['failed'] === undefined) return false;
     if (!('failures' in value) || value['failures'] === undefined) return false;
+    if (!('result' in value) || value['result'] === undefined) return false;
+    if (!('resultFileUrl' in value) || value['resultFileUrl'] === undefined) return false;
     if (!('failureReason' in value) || value['failureReason'] === undefined) return false;
+    if (!('notifyByEmail' in value) || value['notifyByEmail'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('startedAt' in value) || value['startedAt'] === undefined) return false;
     if (!('finishedAt' in value) || value['finishedAt'] === undefined) return false;
@@ -154,7 +175,10 @@ export function JobDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): Jo
         'succeeded': json['succeeded'],
         'failed': json['failed'],
         'failures': ((json['failures'] as Array<any>).map(JobFailureDtoFromJSON)),
+        'result': json['result'],
+        'resultFileUrl': json['resultFileUrl'],
         'failureReason': json['failureReason'],
+        'notifyByEmail': json['notifyByEmail'],
         'createdAt': (new Date(json['createdAt'])),
         'startedAt': (json['startedAt'] == null ? null : new Date(json['startedAt'])),
         'finishedAt': (json['finishedAt'] == null ? null : new Date(json['finishedAt'])),
@@ -165,7 +189,7 @@ export function JobDtoToJSON(json: any): JobDto {
     return JobDtoToJSONTyped(json, false);
 }
 
-export function JobDtoToJSONTyped(value?: JobDto | null, ignoreDiscriminator: boolean = false): any {
+export function JobDtoToJSONTyped(value?: Omit<JobDto, 'notifyByEmail'> | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
@@ -180,6 +204,8 @@ export function JobDtoToJSONTyped(value?: JobDto | null, ignoreDiscriminator: bo
         'succeeded': value['succeeded'],
         'failed': value['failed'],
         'failures': ((value['failures'] as Array<any>).map(JobFailureDtoToJSON)),
+        'result': value['result'],
+        'resultFileUrl': value['resultFileUrl'],
         'failureReason': value['failureReason'],
         'createdAt': ((value['createdAt']).toISOString()),
         'startedAt': (value['startedAt'] == null ? null : (value['startedAt'] as any).toISOString()),

package/src/models/JobFailureDto.ts

@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
  */
 export interface JobFailureDto {
     /**
-     * What the failure was about — a domain name, for a bulk edit.
+     * What the failure was about, usually a domain name: the domain a bulk edit refused, or an import row as it was uploaded.
      * @type {string}
      * @memberof JobFailureDto
      */

package/src/models/JobType.ts

@@ -18,7 +18,8 @@
  * @export
  */
 export const JobType = {
-    BULK_EDIT_DOMAINS: 'bulk_edit_domains'
+    BULK_EDIT_DOMAINS: 'bulk_edit_domains',
+    IMPORT_DOMAINS: 'import_domains'
 } as const;
 export type JobType = typeof JobType[keyof typeof JobType];
 

package/src/models/UserNotificationDto.ts

@@ -108,6 +108,7 @@ export const UserNotificationDtoTypeEnum = {
     REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: 'request_ips_tag_to_seller_ips_tag_invalid',
     EXPORT_COMPLETED: 'export_completed',
     DOMAIN_IMPORT_FINISHED: 'domain_import_finished',
+    DOMAIN_IMPORT_FAILED: 'domain_import_failed',
     DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_verified_buyer_access_link_email',
     DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_received_buyer_access_link_email',
     DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: 'domain_offer_accepted_continue_order_email',

package/src/models/UserNotificationListItemDto.ts

@@ -94,6 +94,7 @@ export const UserNotificationListItemDtoTypeEnum = {
     REQUEST_IPS_TAG_TO_SELLER_IPS_TAG_INVALID: 'request_ips_tag_to_seller_ips_tag_invalid',
     EXPORT_COMPLETED: 'export_completed',
     DOMAIN_IMPORT_FINISHED: 'domain_import_finished',
+    DOMAIN_IMPORT_FAILED: 'domain_import_failed',
     DOMAIN_OFFER_VERIFIED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_verified_buyer_access_link_email',
     DOMAIN_OFFER_RECEIVED_BUYER_ACCESS_LINK_EMAIL: 'domain_offer_received_buyer_access_link_email',
     DOMAIN_OFFER_ACCEPTED_CONTINUE_ORDER_EMAIL: 'domain_offer_accepted_continue_order_email',

package/src/models/index.ts

@@ -276,6 +276,7 @@ export * from './GetSellerChallengesListDto';
 export * from './GetSellerChallengesListDtoChallengesInner';
 export * from './HistoricalMetrics';
 export * from './HttpException';
+export * from './ImportDomainsResponseDto';
 export * from './IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto';
 export * from './IntersectionDomainDtoWithAccountDtoWithAuctionInfoDto';
 export * from './IntersectionDomainDtoWithHijackerDtoWithAccountDto';