printful_client 1.0.1

data/docs/Item.md

@@ -0,0 +1,52 @@
+# Printful::Item
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Line item ID | [optional] |
+| **external_id** | **String** | Line item ID from the external system | [optional] |
+| **variant_id** | **Integer** | Variant ID of the item ordered. See [Catalog API](#tag/Catalog-API) | [optional] |
+| **sync_variant_id** | **Integer** | Sync variant ID of the item ordered. [Example](#section/Orders-API-examples/Using-a-sync-variant). | [optional] |
+| **external_variant_id** | **String** | External variant ID of the item ordered. [Example](#section/Orders-API-examples/Using-sync-variant-with-external-ID). | [optional] |
+| **warehouse_product_variant_id** | **Integer** | Warehousing product variant ID of the item ordered. See Warehouse Products API | [optional] |
+| **product_template_id** | **Integer** | The ID of a Product Template to generate the printfiles from. The `variant_id` field must be passed as well. Can't be combined with following fields: `sync_variant_id`, `external_variant_id`, `warehouse_product_variant_id`, `files`, `options`, `external_product_id`. [Examples](#section/Orders-API-examples/Using-a-product-template).  | [optional] |
+| **external_product_id** | **String** | The External Product ID associated with a Product Template to generate the printfiles from. The `variant_id` field must be passed as well. Can't be combined with following fields: `sync_variant_id`, `external_variant_id`, `warehouse_product_variant_id`, `files`, `options`, `product_template_id`. [Examples](#section/Orders-API-examples/Using-a-product-template).  | [optional] |
+| **quantity** | **Integer** | Number of items ordered (Limited to 1000 for one item) | [optional] |
+| **price** | **String** | Printful price of the item | [optional] |
+| **retail_price** | **String** | Original retail price of the item to be displayed on the packing slip | [optional] |
+| **name** | **String** | Display name of the item. If not given, a name from the Printful system will be displayed on the packing slip | [optional] |
+| **product** | [**ProductVariant**](ProductVariant.md) |  | [optional] |
+| **files** | [**Array<ItemFilesInner>**](ItemFilesInner.md) | Array of attached printfiles / preview images | [optional] |
+| **options** | [**Array<Option>**](Option.md) | Array of additional options for this product [See examples](#section/Options) | [optional] |
+| **sku** | **String** | Product identifier (SKU) from the external system | [optional] |
+| **discontinued** | **Boolean** | Whether the item belongs to discontinued product i.e. it's permanently unavailable | [optional] |
+| **out_of_stock** | **Boolean** | Whether the item is out of stock i.e. temporarily unavailable | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Item.new(
+  id: 1,
+  external_id: item-1,
+  variant_id: 1,
+  sync_variant_id: 1,
+  external_variant_id: variant-1,
+  warehouse_product_variant_id: 1,
+  product_template_id: 1,
+  external_product_id: template-123,
+  quantity: 1,
+  price: 13.00,
+  retail_price: 13.00,
+  name: Enhanced Matte Paper Poster 18×24,
+  product: null,
+  files: null,
+  options: null,
+  sku: null,
+  discontinued: true,
+  out_of_stock: true
+)
+```
+

data/docs/ItemFilesInner.md

@@ -0,0 +1,52 @@
+# Printful::ItemFilesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Role of the file | [optional] |
+| **id** | **Integer** | File ID | [optional][readonly] |
+| **url** | **String** | Source URL where the file is downloaded from. The use of .ai .psd and .tiff files have been depreciated, if your application uses these file types or accepts these types from users you will need to add validation. |  |
+| **options** | [**Array<FileOption>**](FileOption.md) | Array of additional options for this file [See examples](#section/Options) | [optional] |
+| **hash** | **String** | MD5 checksum of the file | [optional][readonly] |
+| **filename** | **String** | File name | [optional] |
+| **mime_type** | **String** | MIME type of the file | [optional][readonly] |
+| **size** | **Integer** | Size in bytes | [optional][readonly] |
+| **width** | **Integer** | Width in pixels | [optional][readonly] |
+| **height** | **Integer** | Height in pixels | [optional][readonly] |
+| **dpi** | **Integer** | Resolution DPI.<br>**Note:** for vector files this may be indicated as only 72dpi, but it doesn't affect print quality since the vector files are resolution independent. | [optional][readonly] |
+| **status** | **String** | File processing status:<br>**ok** - file was processed successfuly<br>**waiting** - file is being processed<br>**failed** - file failed to be processed | [optional][readonly] |
+| **created** | **Integer** | File creation timestamp | [optional][readonly] |
+| **thumbnail_url** | **String** | Small thumbnail URL | [optional][readonly] |
+| **preview_url** | **String** | Medium preview image URL | [optional][readonly] |
+| **visible** | **Boolean** | Show file in the Printfile Library (default true) | [optional] |
+| **is_temporary** | **Boolean** | Whether it is a temporary printfile. | [optional][readonly] |
+| **position** | [**ItemFilesInnerAllOfPosition**](ItemFilesInnerAllOfPosition.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::ItemFilesInner.new(
+  type: default,
+  id: 10,
+  url: https://www.example.com/files/tshirts/example.png,
+  options: null,
+  hash: ea44330b887dfec278dbc4626a759547,
+  filename: shirt1.png,
+  mime_type: image/png,
+  size: 45582633,
+  width: 1000,
+  height: 1000,
+  dpi: 300,
+  status: ok,
+  created: 1590051937,
+  thumbnail_url: https://files.cdn.printful.com/files/ea4/ea44330b887dfec278dbc4626a759547_thumb.png,
+  preview_url: https://files.cdn.printful.com/files/ea4/ea44330b887dfec278dbc4626a759547_thumb.png,
+  visible: true,
+  is_temporary: false,
+  position: null
+)
+```
+

data/docs/ItemFilesInnerAllOfPosition.md

@@ -0,0 +1,30 @@
+# Printful::ItemFilesInnerAllOfPosition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **area_width** | **Integer** | Positioning area width on print area in pixels | [optional] |
+| **area_height** | **Integer** | Positioning area height on print area in pixels | [optional] |
+| **width** | **Integer** | Width of the image in given area in pixels | [optional] |
+| **height** | **Integer** | Height of the image in given area in pixels | [optional] |
+| **top** | **Integer** | Image top offset in given area in pixels | [optional] |
+| **left** | **Integer** | Image left offset in given area in pixels | [optional] |
+| **limit_to_print_area** | **Boolean** | Should limit printfile to print area | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::ItemFilesInnerAllOfPosition.new(
+  area_width: 1800,
+  area_height: 2400,
+  width: 1800,
+  height: 1800,
+  top: 300,
+  left: 0,
+  limit_to_print_area: null
+)
+```
+

data/docs/ItemInfo.md

@@ -0,0 +1,26 @@
+# Printful::ItemInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **variant_id** | **String** | Catalog Variant ID of the item ordered. See [Catalog API](#tag/Catalog-API) <span style=\"color:red\">*Required if no other IDs given</span> | [optional] |
+| **external_variant_id** | **String** | External Variant ID of the item ordered. See [Ecommerce Platform Sync API](#tag/Ecommerce-Platform-Sync-API). <span style=\"color:red\">*Required if no other IDs given</span> | [optional] |
+| **warehouse_product_variant_id** | **String** | Warehouse product variant ID of the item ordered. See [Warehouse Products API](#tag/Warehouse-Products-API). <span style=\"color:red\">*Required if no other IDs given</span> | [optional] |
+| **quantity** | **Integer** | Number of items ordered |  |
+| **value** | **String** | Item retail value - optional but can help to properly calculate | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::ItemInfo.new(
+  variant_id: 202,
+  external_variant_id: 1001,
+  warehouse_product_variant_id: 2,
+  quantity: 10,
+  value: 2.99
+)
+```
+

data/docs/ItemOption.md

@@ -0,0 +1,20 @@
+# Printful::ItemOption
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Option id |  |
+| **value** | **String** | Option value |  |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::ItemOption.new(
+  id: embroidery_type,
+  value: flat
+)
+```
+

data/docs/Material.md

@@ -0,0 +1,20 @@
+# Printful::Material
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Material name | [optional] |
+| **percentage** | **Float** | Percentage of the material in the product | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Material.new(
+  name: cotton,
+  percentage: 100
+)
+```
+

data/docs/Measurement.md

@@ -0,0 +1,22 @@
+# Printful::Measurement
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type_label** | **String** | Measurement type | [optional] |
+| **unit** | **String** | The measurement unit if it's not defined on the size table level or is different | [optional] |
+| **values** | [**Array<MeasurementValue>**](MeasurementValue.md) | The measurement values for each size |  |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Measurement.new(
+  type_label: Length,
+  unit: none,
+  values: null
+)
+```
+

data/docs/MeasurementValue.md

@@ -0,0 +1,24 @@
+# Printful::MeasurementValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **size** | **String** | The size with which the value is associated |  |
+| **value** | **String** | The single value associated with a size (whether this or `min_value` and `max_value` will be present) | [optional] |
+| **min_value** | **String** | The lower boundary of the value range (whether this and `max_value` or `value` will be present) | [optional] |
+| **max_value** | **String** | The upper boundary of the value range (whether this and `min_value` or `value` will be present) | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::MeasurementValue.new(
+  size: S,
+  value: 23.5,
+  min_value: 20,
+  max_value: 20
+)
+```
+

data/docs/MockupGeneratorAPIClient.md

@@ -0,0 +1,313 @@
+# Printful::MockupGeneratorAPIClient
+
+All URIs are relative to *https://api.printful.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_generator_task**](MockupGeneratorAPIClient.md#create_generator_task) | **POST** /mockup-generator/create-task/{id} | Create a mockup generation task |
+| [**get_printfiles**](MockupGeneratorAPIClient.md#get_printfiles) | **GET** /mockup-generator/printfiles/{id} | Retrieve product variant printfiles |
+| [**get_task**](MockupGeneratorAPIClient.md#get_task) | **GET** /mockup-generator/task | Mockup generation task result |
+| [**get_templates**](MockupGeneratorAPIClient.md#get_templates) | **GET** /mockup-generator/templates/{id} | Layout templates |
+
+
+## create_generator_task
+
+> <CreateGeneratorTask200Response> create_generator_task(id, create_generation_task, opts)
+
+Create a mockup generation task
+
+Creates an asynchronous mockup generation task. Generation result can be retrieved using mockup generation task retrieval endpoint.<br> **Rate limiting**: Up to 10 requests per 60 seconds for established stores; 2 requests per 60 seconds for new stores. Currently available rate is returned in response headers. A 60 seconds lockout is applied if request count is exceeded. We also limit the number of files that may be generated to 20,000 files per account in a 24-hour period. 
+
+### 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::MockupGeneratorAPIClient.new
+id = 56 # Integer | Product ID.
+create_generation_task = Printful::CreateGenerationTask.new # CreateGenerationTask | 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
+  # Create a mockup generation task
+  result = api_instance.create_generator_task(id, create_generation_task, opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling MockupGeneratorAPIClient->create_generator_task: #{e}"
+end
+```
+
+#### Using the create_generator_task_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateGeneratorTask200Response>, Integer, Hash)> create_generator_task_with_http_info(id, create_generation_task, opts)
+
+```ruby
+begin
+  # Create a mockup generation task
+  data, status_code, headers = api_instance.create_generator_task_with_http_info(id, create_generation_task, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateGeneratorTask200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling MockupGeneratorAPIClient->create_generator_task_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Product ID. |  |
+| **create_generation_task** | [**CreateGenerationTask**](CreateGenerationTask.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
+
+[**CreateGeneratorTask200Response**](CreateGeneratorTask200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_printfiles
+
+> <GetPrintfiles200Response> get_printfiles(id, opts)
+
+Retrieve product variant printfiles
+
+List of printfiles available for products variants. Printfile indicates what file resolution should be used to create a mockup or submit an order.  <div class=\"alert alert-info\"> This endpoint uses DTG as a default printing technique for products with more than one technique available. For products with DTG and more techniques available please specify the correct technique in query by using the `technique` parameter. For more information read the <a href=\"#section/Mockup-Generator-API-examples\">examples</a>. </div> 
+
+### 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::MockupGeneratorAPIClient.new
+id = 56 # Integer | Product ID.
+opts = {
+  orientation: 'horizontal', # String | 
+  technique: 'technique_example', # String | 
+  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
+  # Retrieve product variant printfiles
+  result = api_instance.get_printfiles(id, opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling MockupGeneratorAPIClient->get_printfiles: #{e}"
+end
+```
+
+#### Using the get_printfiles_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetPrintfiles200Response>, Integer, Hash)> get_printfiles_with_http_info(id, opts)
+
+```ruby
+begin
+  # Retrieve product variant printfiles
+  data, status_code, headers = api_instance.get_printfiles_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetPrintfiles200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling MockupGeneratorAPIClient->get_printfiles_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Product ID. |  |
+| **orientation** | **String** |  | [optional] |
+| **technique** | **String** |  | [optional] |
+| **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
+
+### Return type
+
+[**GetPrintfiles200Response**](GetPrintfiles200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_task
+
+> <CreateGeneratorTask200Response> get_task(task_key, opts)
+
+Mockup generation task result
+
+Returns asynchronous mockup generation task result. If generation task is completed, it will contain a list of generated mockups.
+
+### 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::MockupGeneratorAPIClient.new
+task_key = 'task_key_example' # String | Task key retrieved when creating the generation task.
+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
+  # Mockup generation task result
+  result = api_instance.get_task(task_key, opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling MockupGeneratorAPIClient->get_task: #{e}"
+end
+```
+
+#### Using the get_task_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateGeneratorTask200Response>, Integer, Hash)> get_task_with_http_info(task_key, opts)
+
+```ruby
+begin
+  # Mockup generation task result
+  data, status_code, headers = api_instance.get_task_with_http_info(task_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateGeneratorTask200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling MockupGeneratorAPIClient->get_task_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_key** | **String** | Task key retrieved when creating the generation task. |  |
+| **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
+
+### Return type
+
+[**CreateGeneratorTask200Response**](CreateGeneratorTask200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_templates
+
+> <GetTemplates200Response> get_templates(id, opts)
+
+Layout templates
+
+Retrieve list of templates that can be used for client-side positioning.  <div class=\"alert alert-info\"> This endpoint uses DTG as a default printing technique for product layouts with more than one technique available. For products with DTG and more techniques available please specify the correct technique in query by using the `technique` parameter. For more information read the <a href=\"#section/Mockup-Generator-API-examples\">examples</a>. </div> 
+
+### 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::MockupGeneratorAPIClient.new
+id = 56 # Integer | Product ID.
+opts = {
+  orientation: 'horizontal', # String | 
+  technique: 'technique_example', # String | 
+  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
+  # Layout templates
+  result = api_instance.get_templates(id, opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling MockupGeneratorAPIClient->get_templates: #{e}"
+end
+```
+
+#### Using the get_templates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetTemplates200Response>, Integer, Hash)> get_templates_with_http_info(id, opts)
+
+```ruby
+begin
+  # Layout templates
+  data, status_code, headers = api_instance.get_templates_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetTemplates200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling MockupGeneratorAPIClient->get_templates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Product ID. |  |
+| **orientation** | **String** |  | [optional] |
+| **technique** | **String** |  | [optional] |
+| **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
+
+### Return type
+
+[**GetTemplates200Response**](GetTemplates200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/OAuthAPIClient.md

@@ -0,0 +1,74 @@
+# Printful::OAuthAPIClient
+
+All URIs are relative to *https://api.printful.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_scopes**](OAuthAPIClient.md#get_scopes) | **GET** /oauth/scopes | Get scopes for token |
+
+
+## get_scopes
+
+> <GetScopes200Response> get_scopes
+
+Get scopes for token
+
+Returns a list of scopes associated with the token
+
+### 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::OAuthAPIClient.new
+
+begin
+  # Get scopes for token
+  result = api_instance.get_scopes
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling OAuthAPIClient->get_scopes: #{e}"
+end
+```
+
+#### Using the get_scopes_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetScopes200Response>, Integer, Hash)> get_scopes_with_http_info
+
+```ruby
+begin
+  # Get scopes for token
+  data, status_code, headers = api_instance.get_scopes_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetScopes200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling OAuthAPIClient->get_scopes_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetScopes200Response**](GetScopes200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Option.md

@@ -0,0 +1,20 @@
+# Printful::Option
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Option ID | [optional] |
+| **value** | **String** | Option value | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Option.new(
+  id: OptionKey,
+  value: OptionValue
+)
+```
+