printful_client 1.0.1

data/docs/Shipment.md

@@ -0,0 +1,36 @@
+# Printful::Shipment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Shipment ID | [optional] |
+| **carrier** | **String** | Carrier name | [optional] |
+| **service** | **String** | Delivery service name | [optional] |
+| **tracking_number** | **String** | Shipment tracking number | [optional] |
+| **tracking_url** | **String** | Shipment tracking URL | [optional] |
+| **created** | **Integer** | Shipping time | [optional] |
+| **ship_date** | **String** | Ship date | [optional] |
+| **shipped_at** | **String** | Ship time in unix timestamp | [optional] |
+| **reshipment** | **Boolean** | Whether this is a reshipment | [optional] |
+| **items** | [**Array<OrderShipmentItem>**](OrderShipmentItem.md) | Array of items in this shipment | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Shipment.new(
+  id: 10,
+  carrier: FEDEX,
+  service: FedEx SmartPost,
+  tracking_number: 0,
+  tracking_url: https://www.fedex.com/fedextrack/?tracknumbers=0000000000,
+  created: 1588716060,
+  ship_date: 2020-05-05,
+  shipped_at: 1588716060,
+  reshipment: false,
+  items: null
+)
+```
+

data/docs/ShippingInfo.md

@@ -0,0 +1,32 @@
+# Printful::ShippingInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Shipping method ID | [optional] |
+| **name** | **String** | Shipping method name | [optional] |
+| **rate** | **String** | Shipping rate | [optional] |
+| **currency** | **String** | Currency code in which the rate is returned | [optional] |
+| **min_delivery_days** | **Integer** | Estimated minimum delivery days. <span style=\"color:orange\">Warning! This value may not be present in response.</span> | [optional] |
+| **max_delivery_days** | **Integer** | Estimated maximum delivery days. <span style=\"color:orange\">Warning! This value may not be present in response.</span> | [optional] |
+| **min_delivery_date** | **Integer** | Estimated minimum delivery date. <span style=\"color:orange\">Warning! This value may not be present in response.</span> | [optional] |
+| **max_delivery_date** | **Integer** | Estimated maximum delivery date. <span style=\"color:orange\">Warning! This value may not be present in response.</span> | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::ShippingInfo.new(
+  id: STANDARD,
+  name: Flat Rate (Estimated delivery: May 19–24) ,
+  rate: 13.60,
+  currency: EUR,
+  min_delivery_days: 4,
+  max_delivery_days: 7,
+  min_delivery_date: null,
+  max_delivery_date: null
+)
+```
+

data/docs/ShippingRateAPIClient.md

@@ -0,0 +1,81 @@
+# Printful::ShippingRateAPIClient
+
+All URIs are relative to *https://api.printful.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**calculate_shipping_rates**](ShippingRateAPIClient.md#calculate_shipping_rates) | **POST** /shipping/rates | Calculate shipping rates |
+
+
+## calculate_shipping_rates
+
+> <CalculateShippingRates200Response> calculate_shipping_rates(calculate_shipping_rates, opts)
+
+Calculate shipping rates
+
+Returns available shipping options and rates for the given list of products.
+
+### Examples
+
+```ruby
+require 'time'
+require 'printful_client'
+# setup authorization
+Printful.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Printful::ShippingRateAPIClient.new
+calculate_shipping_rates = Printful::CalculateShippingRates.new({recipient: Printful::AddressInfo.new({address1: '19749 Dearborn St', city: 'Chatsworth', country_code: 'US'}), items: [Printful::ItemInfo.new({quantity: 10})]}) # CalculateShippingRates | POST request body
+opts = {
+  x_pf_store_id: 'x_pf_store_id_example' # String | Use this to specify which store you want to use (required only for account level token)
+}
+
+begin
+  # Calculate shipping rates
+  result = api_instance.calculate_shipping_rates(calculate_shipping_rates, opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling ShippingRateAPIClient->calculate_shipping_rates: #{e}"
+end
+```
+
+#### Using the calculate_shipping_rates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CalculateShippingRates200Response>, Integer, Hash)> calculate_shipping_rates_with_http_info(calculate_shipping_rates, opts)
+
+```ruby
+begin
+  # Calculate shipping rates
+  data, status_code, headers = api_instance.calculate_shipping_rates_with_http_info(calculate_shipping_rates, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CalculateShippingRates200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling ShippingRateAPIClient->calculate_shipping_rates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **calculate_shipping_rates** | [**CalculateShippingRates**](CalculateShippingRates.md) | POST request body |  |
+| **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
+
+### Return type
+
+[**CalculateShippingRates200Response**](CalculateShippingRates200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/SizeTable.md

@@ -0,0 +1,28 @@
+# Printful::SizeTable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Size table type |  |
+| **unit** | **String** | The unit the size table values are in | [optional] |
+| **description** | **String** | The size table description (HTML) | [optional] |
+| **image_url** | **String** | The URL of an image showing the measurements | [optional] |
+| **image_description** | **String** | The description of the measurement image (HTML) | [optional] |
+| **measurements** | [**Array<Measurement>**](Measurement.md) | The size table measurements |  |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::SizeTable.new(
+  type: null,
+  unit: null,
+  description: null,
+  image_url: null,
+  image_description: null,
+  measurements: null
+)
+```
+

data/docs/State.md

@@ -0,0 +1,20 @@
+# Printful::State
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | State code | [optional] |
+| **name** | **String** | State name | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::State.new(
+  code: ACT,
+  name: Australian Capital Territory
+)
+```
+

data/docs/Statistics.md

@@ -0,0 +1,18 @@
+# Printful::Statistics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **store_statistics** | [**Array<StoreStatistics>**](StoreStatistics.md) | The statistics for each store (currently only a single store is supported). | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Statistics.new(
+  store_statistics: null
+)
+```
+

data/docs/Store.md

@@ -0,0 +1,22 @@
+# Printful::Store
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Store ID | [optional] |
+| **type** | **String** | Store type | [optional] |
+| **name** | **String** | Store name | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Store.new(
+  id: 10,
+  type: native,
+  name: My Store
+)
+```
+

data/docs/StoreInformationAPIClient.md

@@ -0,0 +1,218 @@
+# Printful::StoreInformationAPIClient
+
+All URIs are relative to *https://api.printful.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**change_packing_slip**](StoreInformationAPIClient.md#change_packing_slip) | **POST** /store/packing-slip | Change packing slip |
+| [**get_store**](StoreInformationAPIClient.md#get_store) | **GET** /stores/{id} | Get basic information about a store |
+| [**get_stores**](StoreInformationAPIClient.md#get_stores) | **GET** /stores | Get basic information about stores |
+
+
+## change_packing_slip
+
+> <ChangePackingSlip200Response> change_packing_slip(packing_slip, opts)
+
+Change packing slip
+
+Modifies packing slip information of the currently authorized Printful store.
+
+### Examples
+
+```ruby
+require 'time'
+require 'printful_client'
+# setup authorization
+Printful.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Printful::StoreInformationAPIClient.new
+packing_slip = Printful::PackingSlip.new # PackingSlip | POST request body
+opts = {
+  x_pf_store_id: 'x_pf_store_id_example' # String | Use this to specify which store you want to use (required only for account level token)
+}
+
+begin
+  # Change packing slip
+  result = api_instance.change_packing_slip(packing_slip, opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling StoreInformationAPIClient->change_packing_slip: #{e}"
+end
+```
+
+#### Using the change_packing_slip_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ChangePackingSlip200Response>, Integer, Hash)> change_packing_slip_with_http_info(packing_slip, opts)
+
+```ruby
+begin
+  # Change packing slip
+  data, status_code, headers = api_instance.change_packing_slip_with_http_info(packing_slip, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ChangePackingSlip200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling StoreInformationAPIClient->change_packing_slip_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **packing_slip** | [**PackingSlip**](PackingSlip.md) | POST request body |  |
+| **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
+
+### Return type
+
+[**ChangePackingSlip200Response**](ChangePackingSlip200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_store
+
+> <GetStore200Response> get_store(id)
+
+Get basic information about a store
+
+Get basic information about a store based on provided ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'printful_client'
+# setup authorization
+Printful.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Printful::StoreInformationAPIClient.new
+id = 56 # Integer | Store ID
+
+begin
+  # Get basic information about a store
+  result = api_instance.get_store(id)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling StoreInformationAPIClient->get_store: #{e}"
+end
+```
+
+#### Using the get_store_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetStore200Response>, Integer, Hash)> get_store_with_http_info(id)
+
+```ruby
+begin
+  # Get basic information about a store
+  data, status_code, headers = api_instance.get_store_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetStore200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling StoreInformationAPIClient->get_store_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Store ID |  |
+
+### Return type
+
+[**GetStore200Response**](GetStore200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_stores
+
+> <GetStores200Response> get_stores
+
+Get basic information about stores
+
+Get basic information about stores depending on the token access level
+
+### Examples
+
+```ruby
+require 'time'
+require 'printful_client'
+# setup authorization
+Printful.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Printful::StoreInformationAPIClient.new
+
+begin
+  # Get basic information about stores
+  result = api_instance.get_stores
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling StoreInformationAPIClient->get_stores: #{e}"
+end
+```
+
+#### Using the get_stores_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetStores200Response>, Integer, Hash)> get_stores_with_http_info
+
+```ruby
+begin
+  # Get basic information about stores
+  data, status_code, headers = api_instance.get_stores_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetStores200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling StoreInformationAPIClient->get_stores_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetStores200Response**](GetStores200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/StoreStatistics.md

@@ -0,0 +1,38 @@
+# Printful::StoreStatistics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **store_id** | **Integer** | The ID of the store for which the statistics are returned | [optional] |
+| **currency** | **String** | The code of the currency in which the statistics are returned | [optional] |
+| **sales_and_costs** | [**Array<SalesAndCostsInner>**](SalesAndCostsInner.md) | Sales and costs report | [optional] |
+| **sales_and_costs_summary** | [**Array<SalesAndCostsSummaryInner>**](SalesAndCostsSummaryInner.md) | Sales and costs summary report | [optional] |
+| **printful_costs** | [**PrintfulCosts**](PrintfulCosts.md) |  | [optional] |
+| **profit** | [**Profit**](Profit.md) |  | [optional] |
+| **total_paid_orders** | [**TotalPaidOrders**](TotalPaidOrders.md) |  | [optional] |
+| **costs_by_amount** | [**Array<CostsByAmountInner>**](CostsByAmountInner.md) | Costs by amount report | [optional] |
+| **costs_by_product** | [**Array<CostsByProductInner>**](CostsByProductInner.md) | Costs by product report | [optional] |
+| **costs_by_variant** | [**Array<CostsByVariantInner>**](CostsByVariantInner.md) | Costs by variant report | [optional] |
+| **average_fulfillment_time** | [**AverageFulfillmentTime**](AverageFulfillmentTime.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::StoreStatistics.new(
+  store_id: null,
+  currency: USD,
+  sales_and_costs: null,
+  sales_and_costs_summary: null,
+  printful_costs: null,
+  profit: null,
+  total_paid_orders: null,
+  costs_by_amount: null,
+  costs_by_product: null,
+  costs_by_variant: null,
+  average_fulfillment_time: null
+)
+```
+

data/docs/SubmitApprovalSheetChanges200Response.md

@@ -0,0 +1,20 @@
+# Printful::SubmitApprovalSheetChanges200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** | Response status code `200` | [optional] |
+| **result** | [**ApprovalSheet**](ApprovalSheet.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::SubmitApprovalSheetChanges200Response.new(
+  code: 200,
+  result: null
+)
+```
+

data/docs/SyncProduct.md

@@ -0,0 +1,32 @@
+# Printful::SyncProduct
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | SyncProduct ID | [optional][readonly] |
+| **external_id** | **String** | Product ID from the Ecommerce platform | [optional] |
+| **name** | **String** | Product name |  |
+| **variants** | **Integer** | Total number of Sync Variants belonging to this product | [optional][readonly] |
+| **synced** | **Integer** | Number of synced Sync Variants belonging to this product | [optional][readonly] |
+| **thumbnail** | **String** | Thumbnail image URL. Although we do not limit thumbnail image size, we recommend to keep it reasonably small. | [optional] |
+| **thumbnail_url** | **String** | Thumbnail image for the product | [optional][readonly] |
+| **is_ignored** | **Boolean** | Indicates if this Sync Product is ignored | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::SyncProduct.new(
+  id: 13,
+  external_id: 4235234213,
+  name: T-shirt,
+  variants: 10,
+  synced: 10,
+  thumbnail: *http://your-domain.com/path/to/thumbnail.png,
+  thumbnail_url: *https://your-domain.com/path/to/image.png,
+  is_ignored: null
+)
+```
+

data/docs/SyncProductDeleted.md

@@ -0,0 +1,22 @@
+# Printful::SyncProductDeleted
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | SyncProduct ID |  |
+| **external_id** | **String** | Product ID from the Ecommerce platform |  |
+| **name** | **String** | Product name |  |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::SyncProductDeleted.new(
+  id: 13,
+  external_id: 42352342133,
+  name: T-shirt
+)
+```
+

data/docs/SyncProductEvent.md

@@ -0,0 +1,32 @@
+# Printful::SyncProductEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | SyncProduct ID | [optional] |
+| **external_id** | **String** | Product ID from the Ecommerce platform | [optional] |
+| **name** | **String** | Product name |  |
+| **variants** | **Integer** | Total number of Sync Variants belonging to this product | [optional][readonly] |
+| **synced** | **Integer** | Number of synced Sync Variants belonging to this product | [optional][readonly] |
+| **thumbnail** | **String** | Thumbnail image URL. Although we do not limit thumbnail image size, we recommend to keep it reasonably small. | [optional] |
+| **thumbnail_url** | **String** | Thumbnail image for the product | [optional][readonly] |
+| **is_ignored** | **Boolean** | Indicates if this Sync Product is ignored | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::SyncProductEvent.new(
+  id: 13,
+  external_id: 4235234213,
+  name: T-shirt,
+  variants: 10,
+  synced: 10,
+  thumbnail: *http://your-domain.com/path/to/thumbnail.png,
+  thumbnail_url: *https://your-domain.com/path/to/image.png,
+  is_ignored: null
+)
+```
+

data/docs/SyncProductInfo.md

@@ -0,0 +1,20 @@
+# Printful::SyncProductInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sync_product** | [**SyncProduct**](SyncProduct.md) |  | [optional] |
+| **sync_variants** | [**Array<SyncVariant>**](SyncVariant.md) | Array of Sync Variants available for the selected product | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::SyncProductInfo.new(
+  sync_product: null,
+  sync_variants: null
+)
+```
+

data/docs/SyncVariant.md

@@ -0,0 +1,46 @@
+# Printful::SyncVariant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Sync Variant ID | [optional][readonly] |
+| **external_id** | **String** | Variant ID from the Ecommerce platform | [optional] |
+| **sync_product_id** | **Integer** | Sync Product ID that this variant belongs to | [optional][readonly] |
+| **name** | **String** | Sync Variant name | [optional][readonly] |
+| **synced** | **Boolean** | Indicates if this Sync Variant is properly linked with Printful product | [optional][readonly] |
+| **variant_id** | **Integer** | Printful Variant ID that this Sync Variant is synced to | [optional] |
+| **retail_price** | **String** | Retail price that this item is sold for | [optional] |
+| **currency** | **String** | Currency in which prices are returned | [optional][readonly] |
+| **is_ignored** | **Boolean** | Indicates if this Sync Variant is ignored | [optional] |
+| **sku** | **String** | SKU of this Sync Variant | [optional] |
+| **product** | [**SyncVariantProduct**](SyncVariantProduct.md) |  | [optional] |
+| **files** | **Array<File>** | Array of attached printfiles / preview images | [optional] |
+| **options** | [**Array<ItemOption>**](ItemOption.md) | Array of additional options for the configured product/variant [See examples](#section/Options) | [optional] |
+| **main_category_id** | **Integer** | Printful Variant catalog category ID | [optional][readonly] |
+| **warehouse_product_variant_id** | **Integer** | Warehousing variant ID. If sync variant is connected with a warehousing item, this is its ID | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::SyncVariant.new(
+  id: 10,
+  external_id: 12312414,
+  sync_product_id: 71,
+  name: Red T-Shirt,
+  synced: true,
+  variant_id: 3001,
+  retail_price: 29.99,
+  currency: USD,
+  is_ignored: true,
+  sku: SKU1234,
+  product: null,
+  files: null,
+  options: null,
+  main_category_id: 24,
+  warehouse_product_variant_id: 3002
+)
+```
+