@teemill/orders 1.24.1 → 1.26.0

package/docs/PaymentMethod.md

@@ -1,11 +1,12 @@
 # PaymentMethod
 
+The payment method used for this order.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **string** |  | [optional] [default to undefined]
+**type** | **string** | The type of payment method used. | [optional] [default to undefined]
 
 ## Example
 

package/docs/Price.md

@@ -1,13 +1,13 @@
 # Price
 
-Standard price definition that defines the amount and currency.
+A monetary value with its currency.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**amount** | **string** | Price including tax in the specified currency. | [optional] [default to undefined]
-**currencyCode** | **string** | Currency code for the currency the price is valued in. | [optional] [default to undefined]
+**amount** | **string** | The monetary amount as a decimal string. | [optional] [default to undefined]
+**currencyCode** | **string** | ISO 4217 currency code. | [optional] [default to undefined]
 
 ## Example
 

package/docs/ProductUnavailableError.md

@@ -0,0 +1,35 @@
+# ProductUnavailableError
+
+The item cannot be fulfilled at all — either it is out of stock entirely, or the assigned fulfiller cannot produce it (e.g. missing machinery or variant not configured).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [default to undefined]
+**message** | **string** | Human-readable description including the product name. | [default to undefined]
+**productTitle** | **string** | Display name of the product. | [default to undefined]
+**variantId** | **string** | Unique object identifier | [default to undefined]
+**variantRef** | **string** | A reference to the variant being ordered | [default to undefined]
+**requestedQuantity** | **number** | The quantity that was requested in the order. | [default to undefined]
+**availableQuantity** | **number** | Always 0 for this error type. | [default to undefined]
+**shortage** | **number** | The full requested quantity, representing the total unfulfillable amount. | [default to undefined]
+
+## Example
+
+```typescript
+import { ProductUnavailableError } from '@teemill/orders';
+
+const instance: ProductUnavailableError = {
+    code,
+    message,
+    productTitle,
+    variantId,
+    variantRef,
+    requestedQuantity,
+    availableQuantity,
+    shortage,
+};
+```
+
+[[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/RecipientCost.md

@@ -0,0 +1,23 @@
+# RecipientCost
+
+The price you charged the end customer for this item. Highly recommended for international orders as it is used for customs declarations.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **string** | The monetary amount as a decimal string. | [default to undefined]
+**currencyCode** | **string** | ISO 4217 currency code. | [default to undefined]
+
+## Example
+
+```typescript
+import { RecipientCost } from '@teemill/orders';
+
+const instance: RecipientCost = {
+    amount,
+    currencyCode,
+};
+```
+
+[[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/Shipment.md

@@ -0,0 +1,21 @@
+# Shipment
+
+Your own shipping label details.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image** | **string** | A URL to the shipping label image or PDF. | [default to undefined]
+
+## Example
+
+```typescript
+import { Shipment } from '@teemill/orders';
+
+const instance: Shipment = {
+    image,
+};
+```
+
+[[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/ShippingMethod.md

@@ -1,18 +1,19 @@
 # ShippingMethod
 
+A shipping option available for a fulfillment, including delivery estimates and pricing.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [optional] [default to undefined]
-**name** | **string** |  | [optional] [default to undefined]
-**description** | **string** |  | [optional] [default to undefined]
+**id** | **string** | Unique identifier for this shipping method. Use this when confirming a fulfillment. | [optional] [default to undefined]
+**name** | **string** | The display name of the shipping method. | [optional] [default to undefined]
+**description** | **string** | A brief description of the shipping method\'s service level. | [optional] [default to undefined]
 **deliveryEstimates** | [**DeliveryEstimates**](DeliveryEstimates.md) |  | [optional] [default to undefined]
-**totalPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
-**taxPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
-**subtotalPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
-**discountPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**totalPrice** | [**Price**](Price.md) | The total shipping cost including tax. | [optional] [default to undefined]
+**taxPrice** | [**Price**](Price.md) | The tax portion of the shipping cost. | [optional] [default to undefined]
+**subtotalPrice** | [**Price**](Price.md) | The net shipping cost, excluding tax and before discounts. | [optional] [default to undefined]
+**discountPrice** | [**Price**](Price.md) | Any discount applied to the shipping cost. | [optional] [default to undefined]
 
 ## Example
 

package/docs/Status.md

@@ -1,5 +1,6 @@
 # Status
 
+The lifecycle status of an order or fulfillment: - `new` — Order has been created but not yet confirmed or paid - `paid` — Payment has been received, awaiting fulfillment - `processing` — Order is being produced or packed - `complete` — Order has been shipped - `refunded` — Order has been refunded - `quote` — Order is a draft quote, not yet submitted - `moderation` — Order is held for review 
 
 ## Enum
 

package/docs/StockConflictError.md

@@ -0,0 +1,34 @@
+# StockConflictError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [default to undefined]
+**message** | **string** | Human-readable description including the product name. | [default to undefined]
+**productTitle** | **string** | Display name of the product. | [default to undefined]
+**variantId** | **string** | Unique object identifier | [default to undefined]
+**variantRef** | **string** | A reference to the variant being ordered | [default to undefined]
+**requestedQuantity** | **number** | The quantity that was requested in the order. | [default to undefined]
+**availableQuantity** | **number** | Always 0 for this error type. | [default to undefined]
+**shortage** | **number** | The full requested quantity, representing the total unfulfillable amount. | [default to undefined]
+
+## Example
+
+```typescript
+import { StockConflictError } from '@teemill/orders';
+
+const instance: StockConflictError = {
+    code,
+    message,
+    productTitle,
+    variantId,
+    variantRef,
+    requestedQuantity,
+    availableQuantity,
+    shortage,
+};
+```
+
+[[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/StockUnavailableError.md

@@ -0,0 +1,35 @@
+# StockUnavailableError
+
+The requested quantity exceeds available stock. The item can still be ordered in a smaller quantity.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [default to undefined]
+**message** | **string** | Human-readable description including the product name and available quantity. | [default to undefined]
+**productTitle** | **string** | Display name of the product. | [default to undefined]
+**variantId** | **string** | Unique object identifier | [default to undefined]
+**variantRef** | **string** | A reference to the variant being ordered | [default to undefined]
+**requestedQuantity** | **number** | The quantity that was requested in the order. | [default to undefined]
+**availableQuantity** | **number** | The quantity currently available for fulfillment. | [default to undefined]
+**shortage** | **number** | The difference between requested and available quantity (positive value indicating the deficit). | [default to undefined]
+
+## Example
+
+```typescript
+import { StockUnavailableError } from '@teemill/orders';
+
+const instance: StockUnavailableError = {
+    code,
+    message,
+    productTitle,
+    variantId,
+    variantRef,
+    requestedQuantity,
+    availableQuantity,
+    shortage,
+};
+```
+
+[[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/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.24.1
+ * The version of the OpenAPI document: 1.26.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.24.1",
+  "version": "1.26.0",
   "description": "OpenAPI client for @teemill/orders",
   "author": "OpenAPI-Generator Contributors",
   "repository": {