@randock/nameshift-api-client 0.0.530 → 0.0.531

package/README.md

@@ -1,4 +1,4 @@
-## @randock/nameshift-api-client@0.0.530
+## @randock/nameshift-api-client@0.0.531
 
 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.530 --save
+npm install @randock/nameshift-api-client@0.0.531 --save
 ```
 
 _unPublished (not recommended):_
@@ -44,4 +44,4 @@ _unPublished (not recommended):_
 ```
 npm install PATH_TO_GENERATED_PACKAGE --save
 ```
-bc8be612c6d5a701ec657ffc0a4e597afb899be42318cdc7f20715001830528ad7a5b4b8407b20b1ea14e7b7e09e581c
+e519a9375e36a3cbbc74292937535e361e1439fb5562d26fc6be5d468adbd871778762dcd5ec52ea93766c8e0412829f

package/dist/apis/DomainsApi.d.ts

@@ -136,12 +136,12 @@ 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. 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.
+     * Imports domains from an uploaded file or a list of domain names.  A list is imported whole or not at all, before the response is sent. It is checked before any of it is imported. When a name is not a domain that can be listed, or is one the account has already, nothing is imported, and the request is answered with a 400 `ValidationException` holding one error per such name. Its `property` is `domains.<index>`, the index in `domains` as sent, and its `code` one of: - `INVALID_DOMAIN_NAME`: not a domain name, such as a single word, an extension on its own, or characters or labels no domain name has. - `UNKNOWN_DOMAIN_EXTENSION`: the extension is on no public suffix list, ICANN or private. - `DOMAIN_NAME_HAS_SUBDOMAIN`: a name under a registrable domain, such as `www.example.com`. - `DOMAIN_ALREADY_IN_ACCOUNT`: the account has the domain already.  A name listed more than once, in whatever spelling, is imported once. When a domain of the list cannot be imported for any other reason, none of the list is, and the request is answered with a 400 whose `message` is `api.domains.import.error.unexpected`.  Otherwise the list is answered with 201, once every name of it has been saved for the account. A name another account has is saved as a hijack, pending verification of its ownership, after which the domain moves to this account.  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<ImportDomainsResponseDto>>;
     /**
-     * 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.
+     * Imports domains from an uploaded file or a list of domain names.  A list is imported whole or not at all, before the response is sent. It is checked before any of it is imported. When a name is not a domain that can be listed, or is one the account has already, nothing is imported, and the request is answered with a 400 `ValidationException` holding one error per such name. Its `property` is `domains.<index>`, the index in `domains` as sent, and its `code` one of: - `INVALID_DOMAIN_NAME`: not a domain name, such as a single word, an extension on its own, or characters or labels no domain name has. - `UNKNOWN_DOMAIN_EXTENSION`: the extension is on no public suffix list, ICANN or private. - `DOMAIN_NAME_HAS_SUBDOMAIN`: a name under a registrable domain, such as `www.example.com`. - `DOMAIN_ALREADY_IN_ACCOUNT`: the account has the domain already.  A name listed more than once, in whatever spelling, is imported once. When a domain of the list cannot be imported for any other reason, none of the list is, and the request is answered with a 400 whose `message` is `api.domains.import.error.unexpected`.  Otherwise the list is answered with 201, once every name of it has been saved for the account. A name another account has is saved as a hijack, pending verification of its ownership, after which the domain moves to this account.  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<ImportDomainsResponseDto>;

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. 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.
+     * Imports domains from an uploaded file or a list of domain names.  A list is imported whole or not at all, before the response is sent. It is checked before any of it is imported. When a name is not a domain that can be listed, or is one the account has already, nothing is imported, and the request is answered with a 400 `ValidationException` holding one error per such name. Its `property` is `domains.<index>`, the index in `domains` as sent, and its `code` one of: - `INVALID_DOMAIN_NAME`: not a domain name, such as a single word, an extension on its own, or characters or labels no domain name has. - `UNKNOWN_DOMAIN_EXTENSION`: the extension is on no public suffix list, ICANN or private. - `DOMAIN_NAME_HAS_SUBDOMAIN`: a name under a registrable domain, such as `www.example.com`. - `DOMAIN_ALREADY_IN_ACCOUNT`: the account has the domain already.  A name listed more than once, in whatever spelling, is imported once. When a domain of the list cannot be imported for any other reason, none of the list is, and the request is answered with a 400 whose `message` is `api.domains.import.error.unexpected`.  Otherwise the list is answered with 201, once every name of it has been saved for the account. A name another account has is saved as a hijack, pending verification of its ownership, after which the domain moves to this account.  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) {
@@ -213,7 +213,7 @@ var DomainsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * 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.
+     * Imports domains from an uploaded file or a list of domain names.  A list is imported whole or not at all, before the response is sent. It is checked before any of it is imported. When a name is not a domain that can be listed, or is one the account has already, nothing is imported, and the request is answered with a 400 `ValidationException` holding one error per such name. Its `property` is `domains.<index>`, the index in `domains` as sent, and its `code` one of: - `INVALID_DOMAIN_NAME`: not a domain name, such as a single word, an extension on its own, or characters or labels no domain name has. - `UNKNOWN_DOMAIN_EXTENSION`: the extension is on no public suffix list, ICANN or private. - `DOMAIN_NAME_HAS_SUBDOMAIN`: a name under a registrable domain, such as `www.example.com`. - `DOMAIN_ALREADY_IN_ACCOUNT`: the account has the domain already.  A name listed more than once, in whatever spelling, is imported once. When a domain of the list cannot be imported for any other reason, none of the list is, and the request is answered with a 400 whose `message` is `api.domains.import.error.unexpected`.  Otherwise the list is answered with 201, once every name of it has been saved for the account. A name another account has is saved as a hijack, pending verification of its ownership, after which the domain moves to this account.  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 () {

package/package.json

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

package/src/apis/DomainsApi.ts

@@ -290,7 +290,7 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 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.
+     * Imports domains from an uploaded file or a list of domain names.  A list is imported whole or not at all, before the response is sent. It is checked before any of it is imported. When a name is not a domain that can be listed, or is one the account has already, nothing is imported, and the request is answered with a 400 `ValidationException` holding one error per such name. Its `property` is `domains.<index>`, the index in `domains` as sent, and its `code` one of: - `INVALID_DOMAIN_NAME`: not a domain name, such as a single word, an extension on its own, or characters or labels no domain name has. - `UNKNOWN_DOMAIN_EXTENSION`: the extension is on no public suffix list, ICANN or private. - `DOMAIN_NAME_HAS_SUBDOMAIN`: a name under a registrable domain, such as `www.example.com`. - `DOMAIN_ALREADY_IN_ACCOUNT`: the account has the domain already.  A name listed more than once, in whatever spelling, is imported once. When a domain of the list cannot be imported for any other reason, none of the list is, and the request is answered with a 400 whose `message` is `api.domains.import.error.unexpected`.  Otherwise the list is answered with 201, once every name of it has been saved for the account. A name another account has is saved as a hijack, pending verification of its ownership, after which the domain moves to this account.  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<ImportDomainsResponseDto>> {
@@ -350,7 +350,7 @@ export class DomainsApi extends runtime.BaseAPI {
     }
 
     /**
-     * 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.
+     * Imports domains from an uploaded file or a list of domain names.  A list is imported whole or not at all, before the response is sent. It is checked before any of it is imported. When a name is not a domain that can be listed, or is one the account has already, nothing is imported, and the request is answered with a 400 `ValidationException` holding one error per such name. Its `property` is `domains.<index>`, the index in `domains` as sent, and its `code` one of: - `INVALID_DOMAIN_NAME`: not a domain name, such as a single word, an extension on its own, or characters or labels no domain name has. - `UNKNOWN_DOMAIN_EXTENSION`: the extension is on no public suffix list, ICANN or private. - `DOMAIN_NAME_HAS_SUBDOMAIN`: a name under a registrable domain, such as `www.example.com`. - `DOMAIN_ALREADY_IN_ACCOUNT`: the account has the domain already.  A name listed more than once, in whatever spelling, is imported once. When a domain of the list cannot be imported for any other reason, none of the list is, and the request is answered with a 400 whose `message` is `api.domains.import.error.unexpected`.  Otherwise the list is answered with 201, once every name of it has been saved for the account. A name another account has is saved as a hijack, pending verification of its ownership, after which the domain moves to this account.  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<ImportDomainsResponseDto> {