printful_client 1.0.1

data/docs/OptionType.md

@@ -0,0 +1,28 @@
+# Printful::OptionType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Option identifier - use this to specify the option when creating an order | [optional] |
+| **title** | **String** | Display name | [optional] |
+| **type** | **String** | Data type of this option (currently only 'bool' is supported) | [optional] |
+| **values** | **Hash<String, Object>** | Possible option values - [key, value] map | [optional] |
+| **additional_price** | **String** | Additional price when this option is used | [optional] |
+| **additional_price_breakdown** | **Hash<String, Object>** | Additional price breakdown by type - [key, value] map | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::OptionType.new(
+  id: embroidery_type,
+  title: Embroidery type,
+  type: radio,
+  values: {"flat":"Flat Embroidery","3d":"3D Puff","both":"Partial 3D Puff"},
+  additional_price: null,
+  additional_price_breakdown: {"flat":"0.00","3d":"0.00","both":"0.00"}
+)
+```
+

data/docs/Order.md

@@ -0,0 +1,52 @@
+# Printful::Order
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Order ID | [optional][readonly] |
+| **external_id** | **String** | Order ID from the external system | [optional] |
+| **store** | **Integer** | Store ID | [optional][readonly] |
+| **status** | **String** |  Order status:<br /> **draft** - order is not submitted for fulfillment<br /> **failed** - order was submitted for fulfillment but was not accepted because of an error (problem with address, printfiles, charging, etc.)<br /> **pending** - order has been submitted for fulfillment<br /> **canceled** - order is canceled<br /> **onhold** - order has encountered a problem during the fulfillment that needs to be resolved together with the Printful customer service **inprocess** - order is being fulfilled and is no longer cancellable<br /> **partial** - order is partially fulfilled (some items are shipped already, the rest will follow)<br /> **fulfilled** - all items are shipped<br />  | [optional][readonly] |
+| **shipping** | **String** | Shipping method. Defaults to 'STANDARD' | [optional] |
+| **shipping_service_name** | **String** | Human readable shipping method name. | [optional][readonly] |
+| **created** | **Integer** | Time when the order was created | [optional][readonly] |
+| **updated** | **Integer** | Time when the order was updated | [optional][readonly] |
+| **recipient** | [**Address**](Address.md) |  |  |
+| **items** | [**Array<Item>**](Item.md) | Array of items in the order |  |
+| **branding_items** | [**Array<Item>**](Item.md) | Array of branding items in the order | [optional][readonly] |
+| **incomplete_items** | [**Array<IncompleteItem>**](IncompleteItem.md) | Array of incomplete items in the order | [optional][readonly] |
+| **costs** | [**OrderCosts**](OrderCosts.md) |  | [optional] |
+| **retail_costs** | [**RetailCosts**](RetailCosts.md) |  | [optional] |
+| **pricing_breakdown** | [**Array<PricingBreakdown>**](PricingBreakdown.md) | Difference between order price and retail costs. Will be shown only if order is completed. | [optional][readonly] |
+| **shipments** | [**Array<Shipment>**](Shipment.md) | Array of shipments already shipped for this order | [optional][readonly] |
+| **gift** | [**Gift**](Gift.md) |  | [optional] |
+| **packing_slip** | [**PackingSlip**](PackingSlip.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Order.new(
+  id: 13,
+  external_id: 4235234213,
+  store: 10,
+  status: draft,
+  shipping: STANDARD,
+  shipping_service_name: Flat Rate (3-4 business days after fulfillment),
+  created: 1602607640,
+  updated: 1602607640,
+  recipient: null,
+  items: null,
+  branding_items: null,
+  incomplete_items: null,
+  costs: null,
+  retail_costs: null,
+  pricing_breakdown: null,
+  shipments: null,
+  gift: null,
+  packing_slip: null
+)
+```
+

data/docs/OrderCosts.md

@@ -0,0 +1,38 @@
+# Printful::OrderCosts
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | **String** | 3 letter currency code | [optional] |
+| **subtotal** | **String** | Total cost of all items | [optional] |
+| **discount** | **String** | Discount sum | [optional] |
+| **shipping** | **String** | Shipping costs | [optional] |
+| **digitization** | **String** | Digitization costs | [optional] |
+| **additional_fee** | **String** | Additional fee for custom product | [optional] |
+| **fulfillment_fee** | **String** | Custom product fulfillment fee | [optional] |
+| **retail_delivery_fee** | **String** | Retail delivery fee | [optional] |
+| **tax** | **String** | Sum of taxes (not included in the item price) | [optional] |
+| **vat** | **String** | Sum of vat (not included in the item price) | [optional] |
+| **total** | **String** | Grand Total (subtotal-discount+tax+vat+shipping) | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::OrderCosts.new(
+  currency: USD,
+  subtotal: 10.00,
+  discount: 0.00,
+  shipping: 5.00,
+  digitization: 0.00,
+  additional_fee: 0.00,
+  fulfillment_fee: 0.00,
+  retail_delivery_fee: 0.00,
+  tax: 0.00,
+  vat: 0.00,
+  total: 15.00
+)
+```
+

data/docs/OrderEstimateCosts.md

@@ -0,0 +1,36 @@
+# Printful::OrderEstimateCosts
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | **String** | 3 letter currency code | [optional] |
+| **subtotal** | **Float** | Total cost of all items | [optional] |
+| **discount** | **Float** | Discount sum | [optional] |
+| **shipping** | **Float** | Shipping costs | [optional] |
+| **digitization** | **String** | Digitization costs | [optional] |
+| **additional_fee** | **Float** | Additional fee for custom product | [optional] |
+| **fulfillment_fee** | **Float** | Custom product fulfillment fee | [optional] |
+| **tax** | **Float** | Sum of taxes (not included in the item price) | [optional] |
+| **vat** | **Float** | Sum of vat (not included in the item price) | [optional] |
+| **total** | **Float** | Grand Total (subtotal-discount+tax+vat+shipping) | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::OrderEstimateCosts.new(
+  currency: USD,
+  subtotal: 10,
+  discount: 0,
+  shipping: 5,
+  digitization: 0,
+  additional_fee: 0,
+  fulfillment_fee: 0,
+  tax: 0,
+  vat: 0,
+  total: 15
+)
+```
+

data/docs/OrderEstimateRetailCosts.md

@@ -0,0 +1,30 @@
+# Printful::OrderEstimateRetailCosts
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | **String** | 3 letter currency code | [optional] |
+| **subtotal** | **Float** | Total cost of all items | [optional] |
+| **discount** | **Float** | Discount sum | [optional] |
+| **shipping** | **Float** | Shipping costs | [optional] |
+| **tax** | **Float** | Sum of taxes (not included in the item price) | [optional] |
+| **vat** | **Float** | Sum of VAT (not included in the item price) | [optional][readonly] |
+| **total** | **Float** | Grand Total (subtotal-discount+tax+vat+shipping) | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::OrderEstimateRetailCosts.new(
+  currency: USD,
+  subtotal: 10,
+  discount: 0,
+  shipping: 5,
+  tax: 0,
+  vat: 0,
+  total: 15
+)
+```
+

data/docs/OrderEvent.md

@@ -0,0 +1,52 @@
+# Printful::OrderEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Object** |  | [optional] |
+| **external_id** | **Object** |  | [optional] |
+| **store** | **Object** |  | [optional] |
+| **status** | **Object** |  | [optional] |
+| **shipping** | **Object** |  | [optional] |
+| **shipping_service_name** | **Object** |  | [optional] |
+| **created** | **Object** |  | [optional] |
+| **updated** | **Object** |  | [optional] |
+| **recipient** | **Object** |  |  |
+| **items** | **Object** |  |  |
+| **branding_items** | **Object** |  | [optional] |
+| **incomplete_items** | **Object** |  | [optional] |
+| **costs** | **Object** |  | [optional] |
+| **retail_costs** | **Object** |  | [optional] |
+| **pricing_breakdown** | **Object** |  | [optional] |
+| **shipments** | **Object** |  | [optional] |
+| **gift** | **Object** |  | [optional] |
+| **packing_slip** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::OrderEvent.new(
+  id: null,
+  external_id: null,
+  store: null,
+  status: null,
+  shipping: null,
+  shipping_service_name: null,
+  created: null,
+  updated: null,
+  recipient: null,
+  items: null,
+  branding_items: null,
+  incomplete_items: null,
+  costs: null,
+  retail_costs: null,
+  pricing_breakdown: null,
+  shipments: null,
+  gift: null,
+  packing_slip: null
+)
+```
+

data/docs/OrderShipmentItem.md

@@ -0,0 +1,24 @@
+# Printful::OrderShipmentItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item_id** | **Integer** | Line item ID | [optional] |
+| **quantity** | **Integer** | Quantity of items in this shipment | [optional] |
+| **picked** | **Integer** | A boolean indicating that the pickup stage of this item's fulfillment has been completed | [optional] |
+| **printed** | **Integer** | A boolean indicting that the item has been printed, sublimated or sewed. | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::OrderShipmentItem.new(
+  item_id: 1,
+  quantity: 1,
+  picked: 1,
+  printed: 1
+)
+```
+