@teemill/orders 1.25.0 → 1.27.0

package/docs/OrderImportError.md

@@ -0,0 +1,30 @@
+# OrderImportError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | [**OrderImportErrorCode**](OrderImportErrorCode.md) |  | [default to undefined]
+**message** | **string** | A human-readable description of the error. | [default to undefined]
+**fieldPath** | **string** | Dot-notation path to the field that caused the error (e.g. `items.sku`). | [optional] [default to undefined]
+**sku** | **string** | The SKU that triggered the error, if applicable. | [optional] [default to undefined]
+**suggestedFix** | **string** | A human-readable suggestion for how to resolve the error. | [optional] [default to undefined]
+**referenceCode** | **string** | A unique reference code for this error occurrence, useful for support enquiries. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderImportError } from '@teemill/orders';
+
+const instance: OrderImportError = {
+    code,
+    message,
+    fieldPath,
+    sku,
+    suggestedFix,
+    referenceCode,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OrderImportErrorCode.md

@@ -0,0 +1,17 @@
+# OrderImportErrorCode
+
+Machine-readable error code identifying the type of import failure: - `VARIANT_NOT_FOUND` — The SKU does not match any variant in the project\'s catalog - `MISSING_SKU` — A required SKU field was empty or missing - `SHIPPING_METHOD_UNAVAILABLE` — No shipping methods are available for the fulfillment - `TRANSIENT_SYSTEM_ERROR` — A temporary system issue occurred; the import may succeed on retry - `IMPORT_FAILED` — A general import failure that does not match a more specific code 
+
+## Enum
+
+* `VariantNotFound` (value: `'VARIANT_NOT_FOUND'`)
+
+* `MissingSku` (value: `'MISSING_SKU'`)
+
+* `ShippingMethodUnavailable` (value: `'SHIPPING_METHOD_UNAVAILABLE'`)
+
+* `TransientSystemError` (value: `'TRANSIENT_SYSTEM_ERROR'`)
+
+* `ImportFailed` (value: `'IMPORT_FAILED'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OrderImportGroup.md

@@ -0,0 +1,40 @@
+# OrderImportGroup
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**status** | [**OrderImportGroupStatus**](OrderImportGroupStatus.md) |  | [default to undefined]
+**merchantReference** | **string** | The merchant reference from the CSV rows belonging to this group. | [optional] [default to undefined]
+**resultReference** | **string** | A URI reference to the order created by this group. Only present when the group status is `success`. | [optional] [default to undefined]
+**message** | **string** | A human-readable message describing the outcome of this group. | [optional] [default to undefined]
+**rowsCount** | **number** | The number of CSV rows that belong to this group. | [default to undefined]
+**skus** | **Array<string>** | The distinct SKUs referenced by rows in this group. | [default to undefined]
+**errors** | [**Array<OrderImportError>**](OrderImportError.md) | Errors encountered while processing this group. Empty when the group succeeded. | [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**startedAt** | **string** |  | [optional] [default to undefined]
+**finishedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderImportGroup } from '@teemill/orders';
+
+const instance: OrderImportGroup = {
+    id,
+    status,
+    merchantReference,
+    resultReference,
+    message,
+    rowsCount,
+    skus,
+    errors,
+    createdAt,
+    startedAt,
+    finishedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OrderImportGroupStatus.md

@@ -0,0 +1,17 @@
+# OrderImportGroupStatus
+
+The lifecycle status of a single group (order) within an import: - `pending` — Group is queued and has not started processing - `processing` — Group is currently being processed - `success` — Order was created and confirmed successfully - `failed` — Order creation or confirmation failed - `cancelled` — Group was cancelled (e.g. parent import was cancelled) 
+
+## Enum
+
+* `Pending` (value: `'pending'`)
+
+* `Processing` (value: `'processing'`)
+
+* `Success` (value: `'success'`)
+
+* `Failed` (value: `'failed'`)
+
+* `Cancelled` (value: `'cancelled'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OrderImportGroupsResponse.md

@@ -0,0 +1,22 @@
+# OrderImportGroupsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**groups** | [**Array<OrderImportGroup>**](OrderImportGroup.md) |  | [optional] [default to undefined]
+**nextPageToken** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderImportGroupsResponse } from '@teemill/orders';
+
+const instance: OrderImportGroupsResponse = {
+    groups,
+    nextPageToken,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OrderImportStatus.md

@@ -0,0 +1,19 @@
+# OrderImportStatus
+
+The lifecycle status of an order import: - `queued` — Import has been accepted but no groups have started processing yet - `processing` — One or more groups are currently being processed - `completedSuccess` — All groups were imported successfully - `completedPartial` — Some groups succeeded but others failed or were cancelled - `completedFailed` — All groups failed or were cancelled, with none succeeding - `cancelled` — The entire import was cancelled before completion 
+
+## Enum
+
+* `Queued` (value: `'queued'`)
+
+* `Processing` (value: `'processing'`)
+
+* `CompletedSuccess` (value: `'completedSuccess'`)
+
+* `CompletedPartial` (value: `'completedPartial'`)
+
+* `CompletedFailed` (value: `'completedFailed'`)
+
+* `Cancelled` (value: `'cancelled'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OrderImportsResponse.md

@@ -0,0 +1,22 @@
+# OrderImportsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**imports** | [**Array<OrderImport>**](OrderImport.md) |  | [optional] [default to undefined]
+**nextPageToken** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderImportsResponse } from '@teemill/orders';
+
+const instance: OrderImportsResponse = {
+    imports,
+    nextPageToken,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OrderPaymentMethod.md

@@ -0,0 +1,21 @@
+# OrderPaymentMethod
+
+The payment method used for this order.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** | The type of payment method used. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderPaymentMethod } from '@teemill/orders';
+
+const instance: OrderPaymentMethod = {
+    type,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OrdersApi.md

@@ -10,7 +10,11 @@ All URIs are relative to *https://api.localhost:8080*
 |[**downloadInvoice**](#downloadinvoice) | **GET** /v1/orders/{orderId}/invoice | Download order invoice|
 |[**exportOrders**](#exportorders) | **GET** /v1/orders/export | Export orders|
 |[**getOrder**](#getorder) | **GET** /v1/orders/{orderId} | Get order|
+|[**getOrderImport**](#getorderimport) | **GET** /v1/orders/imports/{importId} | Get order import|
 |[**getOrders**](#getorders) | **GET** /v1/orders | List orders|
+|[**importOrders**](#importorders) | **POST** /v1/orders/imports | Import orders|
+|[**listOrderImportGroups**](#listorderimportgroups) | **GET** /v1/orders/imports/{importId}/groups | List order import groups|
+|[**listOrderImports**](#listorderimports) | **GET** /v1/orders/imports | List order imports|
 |[**retryPlatformPayment**](#retryplatformpayment) | **POST** /v1/orders/{orderId}/retryPlatformPayment | Retry|
 
 # **cancelOrder**
@@ -390,6 +394,65 @@ const { status, data } = await apiInstance.getOrder(
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **getOrderImport**
+> OrderImport getOrderImport()
+
+Gets the latest status and summary for an order import.
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from '@teemill/orders';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let project: string; //The project identifier to scope the request to. (default to undefined)
+let importId: string; //Unique identifier of an order import (default to undefined)
+
+const { status, data } = await apiInstance.getOrderImport(
+    project,
+    importId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
+| **importId** | [**string**] | Unique identifier of an order import | defaults to undefined|
+
+
+### Return type
+
+**OrderImport**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Summary status for a single order import. |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **getOrders**
 > OrdersResponse getOrders()
 
@@ -472,6 +535,191 @@ const { status, data } = await apiInstance.getOrders(
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **importOrders**
+> ImportOrders202Response importOrders()
+
+Initiates an order import from a CSV file. The import is processed asynchronously. Use the returned `importId` with the GET endpoints to track progress.
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from '@teemill/orders';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let project: string; //The project identifier to scope the request to. (default to undefined)
+let file: File; //CSV file containing order data (default to undefined)
+
+const { status, data } = await apiInstance.importOrders(
+    project,
+    file
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
+| **file** | [**File**] | CSV file containing order data | defaults to undefined|
+
+
+### Return type
+
+**ImportOrders202Response**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**202** | CSV file was accepted; orders will be imported asynchronously. |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listOrderImportGroups**
+> OrderImportGroupsResponse listOrderImportGroups()
+
+Lists group-level outcomes for a specific order import. Each group represents one order from the CSV (grouped by merchant reference).
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from '@teemill/orders';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let project: string; //The project identifier to scope the request to. (default to undefined)
+let importId: string; //Unique identifier of an order import (default to undefined)
+let pageToken: number; //Page reference token (optional) (default to 1)
+let pageSize: number; //Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller. (optional) (default to 25)
+
+const { status, data } = await apiInstance.listOrderImportGroups(
+    project,
+    importId,
+    pageToken,
+    pageSize
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
+| **importId** | [**string**] | Unique identifier of an order import | defaults to undefined|
+| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
+| **pageSize** | [**number**] | Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller. | (optional) defaults to 25|
+
+
+### Return type
+
+**OrderImportGroupsResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Paginated group-level outcomes for an order import. |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listOrderImports**
+> OrderImportsResponse listOrderImports()
+
+Lists recent order imports for this project, ordered by most recent first.
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from '@teemill/orders';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let project: string; //The project identifier to scope the request to. (default to undefined)
+let pageToken: number; //Page reference token (optional) (default to 1)
+let pageSize: number; //Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller. (optional) (default to 25)
+
+const { status, data } = await apiInstance.listOrderImports(
+    project,
+    pageToken,
+    pageSize
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
+| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
+| **pageSize** | [**number**] | Max page size for import endpoints. This is the maximum that will be returned, but it might be smaller. | (optional) defaults to 25|
+
+
+### Return type
+
+**OrderImportsResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Paginated list of order imports and their status summaries. |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **retryPlatformPayment**
 > Order retryPlatformPayment()
 

package/index.ts

@@ -4,7 +4,7 @@
  * Orders API
  * Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
  *
- * The version of the OpenAPI document: 1.25.0
+ * The version of the OpenAPI document: 1.27.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/orders",
-  "version": "1.25.0",
+  "version": "1.27.0",
   "description": "OpenAPI client for @teemill/orders",
   "author": "OpenAPI-Generator Contributors",
   "repository": {