@commercetools/importapi-sdk 1.20.0 → 2.1.0

package/dist/declarations/src/generated/models/importcontainers.d.ts

@@ -1,114 +1,114 @@
-/**
- * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
- * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
- * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
- */
-import { ImportResourceType } from './common';
-/**
- *	Serves as the entry point of resources.
- *	An Import Container is not resource type-specific.
- *
- */
-export interface ImportContainer {
-    /**
-     *	User-defined unique identifier for the ImportContainer.
-     *	Keys can only contain alphanumeric characters (a-Z, 0-9), underscores and hyphens (_, -).
-     *
-     *
-     */
-    readonly key: string;
-    /**
-     *	The [resource type](#importresourcetype) the ImportContainer is able to handle.
-     *	If not present, the ImportContainer is able to import all of the supported [ImportResourceTypes](#importresourcetype).
-     *
-     *
-     */
-    readonly resourceType?: ImportResourceType;
-    /**
-     *	The version of the ImportContainer.
-     *
-     */
-    readonly version: number;
-    /**
-     *	The time when the ImportContainer was created.
-     *
-     */
-    readonly createdAt: string;
-    /**
-     *	The last time when the ImportContainer was modified.
-     *
-     */
-    readonly lastModifiedAt: string;
-}
-/**
- *	The representation sent to the server when creating an [ImportContainer](#importcontainer).
- *
- */
-export interface ImportContainerDraft {
-    /**
-     *	User-defined unique identifier of the ImportContainer.
-     *	Keys can only contain alphanumeric characters (a-Z, 0-9), underscores and hyphens (_, -).
-     *
-     *
-     */
-    readonly key: string;
-    /**
-     *	The [resource type](#importresourcetype) to be imported.
-     *	If not given, the ImportContainer is able to import all of the supported [ImportResourceTypes](#importresourcetype).
-     *
-     *
-     */
-    readonly resourceType?: ImportResourceType;
-}
-/**
- *	The representation sent to the server when updating an import container.
- *
- */
-export interface ImportContainerUpdateDraft {
-    /**
-     *	Current version of the ImportContainer.
-     *
-     */
-    readonly version: number;
-    /**
-     *	The [resource type](#importresourcetype) to be imported.
-     *	If not given, the ImportContainer is able to import all of the supported [ImportResourceTypes](#importresourcetype).
-     *
-     *
-     */
-    readonly resourceType?: ImportResourceType;
-}
-/**
- *	[PagedQueryResult](/../api/general-concepts#pagedqueryresult) for [ImportContainers](#importcontainer).
- *	Used as a response to a query request for [ImportContainers](#importcontainer).
- *
- */
-export interface ImportContainerPagedResponse {
-    /**
-     *	The number of results requested in the query request.
-     *
-     */
-    readonly limit: number;
-    /**
-     *	The number of elements skipped, not a page number.
-     *	Supplied by the client or the server default.
-     *
-     *
-     */
-    readonly offset: number;
-    /**
-     *	The actual number of results returned.
-     *
-     */
-    readonly count: number;
-    /**
-     *	The total number of results matching the query.
-     *
-     */
-    readonly total: number;
-    /**
-     *	The array of Import Containers matching the query.
-     *
-     */
-    readonly results: ImportContainer[];
-}
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+import { ImportResourceType } from './common';
+/**
+ *	Serves as the entry point of resources.
+ *	An Import Container is not resource type-specific.
+ *
+ */
+export interface ImportContainer {
+    /**
+     *	User-defined unique identifier for the ImportContainer.
+     *	Keys can only contain alphanumeric characters (a-Z, 0-9), underscores and hyphens (_, -).
+     *
+     *
+     */
+    readonly key: string;
+    /**
+     *	The [resource type](#importresourcetype) the ImportContainer is able to handle.
+     *	If not present, the ImportContainer is able to import all of the supported [ImportResourceTypes](#importresourcetype).
+     *
+     *
+     */
+    readonly resourceType?: ImportResourceType;
+    /**
+     *	The version of the ImportContainer.
+     *
+     */
+    readonly version: number;
+    /**
+     *	The time when the ImportContainer was created.
+     *
+     */
+    readonly createdAt: string;
+    /**
+     *	The last time when the ImportContainer was modified.
+     *
+     */
+    readonly lastModifiedAt: string;
+}
+/**
+ *	The representation sent to the server when creating an [ImportContainer](#importcontainer).
+ *
+ */
+export interface ImportContainerDraft {
+    /**
+     *	User-defined unique identifier of the ImportContainer.
+     *	Keys can only contain alphanumeric characters (a-Z, 0-9), underscores and hyphens (_, -).
+     *
+     *
+     */
+    readonly key: string;
+    /**
+     *	The [resource type](#importresourcetype) to be imported.
+     *	If not given, the ImportContainer is able to import all of the supported [ImportResourceTypes](#importresourcetype).
+     *
+     *
+     */
+    readonly resourceType?: ImportResourceType;
+}
+/**
+ *	The representation sent to the server when updating an import container.
+ *
+ */
+export interface ImportContainerUpdateDraft {
+    /**
+     *	Current version of the ImportContainer.
+     *
+     */
+    readonly version: number;
+    /**
+     *	The [resource type](#importresourcetype) to be imported.
+     *	If not given, the ImportContainer is able to import all of the supported [ImportResourceTypes](#importresourcetype).
+     *
+     *
+     */
+    readonly resourceType?: ImportResourceType;
+}
+/**
+ *	[PagedQueryResult](/../api/general-concepts#pagedqueryresult) for [ImportContainers](#importcontainer).
+ *	Used as a response to a query request for [ImportContainers](#importcontainer).
+ *
+ */
+export interface ImportContainerPagedResponse {
+    /**
+     *	The number of results requested in the query request.
+     *
+     */
+    readonly limit: number;
+    /**
+     *	The number of elements skipped, not a page number.
+     *	Supplied by the client or the server default.
+     *
+     *
+     */
+    readonly offset: number;
+    /**
+     *	The actual number of results returned.
+     *
+     */
+    readonly count: number;
+    /**
+     *	The total number of results matching the query.
+     *
+     */
+    readonly total: number;
+    /**
+     *	The array of Import Containers matching the query.
+     *
+     */
+    readonly results: ImportContainer[];
+}

package/dist/declarations/src/generated/models/importoperations.d.ts

@@ -1,128 +1,128 @@
-/**
- * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
- * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
- * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
- */
-import { ProcessingState, UnresolvedReferences } from './common';
-import { ErrorObject } from './errors';
-/**
- *	Shows the import status of a specific resource.
- *
- */
-export interface ImportOperation {
-    /**
-     *	The version of the ImportOperation.
-     *
-     */
-    readonly version: number;
-    /**
-     *	The key of the [importContainer](/import-container#importcontainer).
-     *
-     */
-    readonly importContainerKey: string;
-    /**
-     *	The key of the resource.
-     *
-     */
-    readonly resourceKey: string;
-    /**
-     *	The ID of the ImportOperation.
-     *
-     */
-    readonly id: string;
-    /**
-     *	The import status of the resource. Set to `rejected` or `validationFailed` if the import of the resource was not successful.
-     *
-     *
-     */
-    readonly state: ProcessingState;
-    /**
-     *	The version of the impmorted resource when the import was successful.
-     *
-     */
-    readonly resourceVersion?: number;
-    /**
-     *	Contains an error if the import of the resource was not successful. See [Errors](/error).
-     *
-     *
-     */
-    readonly errors?: ErrorObject[];
-    /**
-     *	In case of unresolved status this array will show the unresolved references
-     *
-     *
-     */
-    readonly unresolvedReferences?: UnresolvedReferences[];
-    /**
-     *	The time when the ImportOperation was created.
-     *
-     */
-    readonly createdAt: string;
-    /**
-     *	The last time When the ImportOperation was modified.
-     *
-     */
-    readonly lastModifiedAt: string;
-    /**
-     *	The expiration time of the ImportOperation.
-     *
-     */
-    readonly expiresAt: string;
-}
-/**
- *	[PagedQueryResult](/../api/general-concepts#pagedqueryresult) for Import Operations.
- *
- */
-export interface ImportOperationPagedResponse {
-    /**
-     *	The number of results requested in the query request.
-     *
-     */
-    readonly limit: number;
-    /**
-     *	The number of elements skipped, not a page number.
-     *	Supplied by the client or the server default.
-     *
-     *
-     */
-    readonly offset: number;
-    /**
-     *	The actual number of results returned.
-     *
-     */
-    readonly count: number;
-    /**
-     *	The total number of import operations matching the query.
-     *
-     */
-    readonly total: number;
-    /**
-     *	The array of Import Operations matching the query.
-     *
-     */
-    readonly results: ImportOperation[];
-}
-/**
- *	Describes the validation state of a newly created [ImportOperation](#importoperation).
- *
- */
-export declare type ImportOperationState = 'processing' | 'validationFailed';
-export interface ImportOperationStatus {
-    /**
-     *	The ID of the [ImportOperation](#importoperation).
-     *
-     */
-    readonly operationId?: string;
-    /**
-     *	The validation state of the [ImportOperation](#importoperation).
-     *
-     */
-    readonly state: ImportOperationState;
-    /**
-     *	The validation errors for the [ImportOperation](#importoperation).
-     *	See [Errors](/error).
-     *
-     *
-     */
-    readonly errors?: ErrorObject[];
-}
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+import { ProcessingState, UnresolvedReferences } from './common';
+import { ErrorObject } from './errors';
+/**
+ *	Import Operation describes the import status of a specific resource.
+ *
+ */
+export interface ImportOperation {
+    /**
+     *	The version of the ImportOperation.
+     *
+     */
+    readonly version: number;
+    /**
+     *	The key of the [importContainer](/import-container#importcontainer).
+     *
+     */
+    readonly importContainerKey: string;
+    /**
+     *	The key of the resource.
+     *
+     */
+    readonly resourceKey: string;
+    /**
+     *	The ID of the ImportOperation.
+     *
+     */
+    readonly id: string;
+    /**
+     *	The import status of the resource. Set to `rejected` or `validationFailed` if the import of the resource was not successful.
+     *
+     *
+     */
+    readonly state: ProcessingState;
+    /**
+     *	The version of the impmorted resource when the import was successful.
+     *
+     */
+    readonly resourceVersion?: number;
+    /**
+     *	Contains an error if the import of the resource was not successful. See [Errors](/error).
+     *
+     *
+     */
+    readonly errors?: ErrorObject[];
+    /**
+     *	In case of unresolved status this array will show the unresolved references
+     *
+     *
+     */
+    readonly unresolvedReferences?: UnresolvedReferences[];
+    /**
+     *	The time when the ImportOperation was created.
+     *
+     */
+    readonly createdAt: string;
+    /**
+     *	The last time When the ImportOperation was modified.
+     *
+     */
+    readonly lastModifiedAt: string;
+    /**
+     *	The expiration time of the ImportOperation.
+     *
+     */
+    readonly expiresAt: string;
+}
+/**
+ *	[PagedQueryResult](/../api/general-concepts#pagedqueryresult) for Import Operations.
+ *
+ */
+export interface ImportOperationPagedResponse {
+    /**
+     *	The number of results requested in the query request.
+     *
+     */
+    readonly limit: number;
+    /**
+     *	The number of elements skipped, not a page number.
+     *	Supplied by the client or the server default.
+     *
+     *
+     */
+    readonly offset: number;
+    /**
+     *	The actual number of results returned.
+     *
+     */
+    readonly count: number;
+    /**
+     *	The total number of import operations matching the query.
+     *
+     */
+    readonly total: number;
+    /**
+     *	The array of Import Operations matching the query.
+     *
+     */
+    readonly results: ImportOperation[];
+}
+/**
+ *	Describes the validation state of a newly created [ImportOperation](#importoperation).
+ *
+ */
+export declare type ImportOperationState = 'processing' | 'validationFailed';
+export interface ImportOperationStatus {
+    /**
+     *	The ID of the [ImportOperation](#importoperation).
+     *
+     */
+    readonly operationId?: string;
+    /**
+     *	The validation state of the [ImportOperation](#importoperation).
+     *
+     */
+    readonly state: ImportOperationState;
+    /**
+     *	The validation errors for the [ImportOperation](#importoperation).
+     *	See [Errors](/error).
+     *
+     *
+     */
+    readonly errors?: ErrorObject[];
+}