printful_client 1.0.1

data/docs/Product.md

@@ -0,0 +1,50 @@
+# Printful::Product
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Product ID | [optional] |
+| **main_category_id** | **Integer** | Main category of product | [optional] |
+| **type** | **String** | Product type identifier | [optional] |
+| **type_name** | **String** | Product type name | [optional] |
+| **title** | **String** | Product title | [optional] |
+| **brand** | **String** | Brand name | [optional] |
+| **model** | **String** | Model name | [optional] |
+| **image** | **String** | URL of a sample image for this product | [optional] |
+| **variant_count** | **Integer** | Number of available variants for this product | [optional] |
+| **currency** | **String** | Currency in which prices are returned | [optional] |
+| **files** | [**Array<FileType>**](FileType.md) | Definitions of Print/Mockup file categories that can be attached to this product | [optional] |
+| **options** | [**Array<OptionType>**](OptionType.md) | Definitions of additional options that are available for this product [See examples](#section/Options) | [optional] |
+| **is_discontinued** | **Boolean** | If product is disabled in push | [optional] |
+| **avg_fulfillment_time** | **Float** | Average number of days for order to be fulfilled | [optional] |
+| **description** | **String** | Product description | [optional] |
+| **techniques** | [**Array<AvailableTechnique>**](AvailableTechnique.md) | Available techniques | [optional] |
+| **origin_country** | **String** | The origin country for inside label | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Product.new(
+  id: 13,
+  main_category_id: 24,
+  type: T-SHIRT,
+  type_name: T-Shirt,
+  title: Unisex Staple T-Shirt | Bella + Canvas 3001,
+  brand: Gildan,
+  model: 2200 Ultra Cotton Tank Top,
+  image: https://files.cdn.printful.com/products/12/product_1550594502.jpg,
+  variant_count: 30,
+  currency: EUR,
+  files: null,
+  options: null,
+  is_discontinued: false,
+  avg_fulfillment_time: 4.3,
+  description: null,
+  techniques: null,
+  origin_country: Nicaragua
+)
+```
+

data/docs/Product1.md

@@ -0,0 +1,20 @@
+# Printful::Product1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sync_product** | [**SyncProduct**](SyncProduct.md) |  |  |
+| **sync_variants** | [**Array<Product1SyncVariantsInner>**](Product1SyncVariantsInner.md) | Information about the Sync Variants |  |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Product1.new(
+  sync_product: null,
+  sync_variants: null
+)
+```
+

data/docs/Product1SyncVariantsInner.md

@@ -0,0 +1,46 @@
+# Printful::Product1SyncVariantsInner
+
+## 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 |  |
+| **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 |  |
+| **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::Product1SyncVariantsInner.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
+)
+```
+

data/docs/ProductInfo.md

@@ -0,0 +1,20 @@
+# Printful::ProductInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product** | [**Product**](Product.md) |  | [optional] |
+| **variants** | [**Array<Variant>**](Variant.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::ProductInfo.new(
+  product: null,
+  variants: null
+)
+```
+

data/docs/ProductSizeGuide.md

@@ -0,0 +1,22 @@
+# Printful::ProductSizeGuide
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_id** | **Integer** | Product ID |  |
+| **available_sizes** | **Array<String>** | The sizes available for the Product |  |
+| **size_tables** | [**Array<SizeTable>**](SizeTable.md) | Size tables for the product |  |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::ProductSizeGuide.new(
+  product_id: 13,
+  available_sizes: ["S","M","L"],
+  size_tables: [{"type":"measure_yourself","unit":"inches","description":"<p>Measurements are provided by suppliers.<br /><br />US customers should order a size up as the EU sizes for this supplier correspond to a smaller size in the US market.</p>\\n<p>Product measurements may vary by up to 2\\\" (5 cm). </p>","image_url":"https://s3.staging.printful.com/upload/measure-yourself/6a/6a4fe322f592f2b91d5a735d7ff8d1c0_t?v=1652962720","image_description":"<h6><strong>A Length</strong></h6>\\n<p dir=\\\"ltr\\\"><span id=\\\"docs-internal-guid-a3ac3082-7fff-5f98-2623-3eb38d5f43a1\\\">Place the end of the tape beside the collar at the top of the tee (Highest Point Shoulder). Pull the tape measure t</span><span id=\\\"docs-internal-guid-a3ac3082-7fff-5f98-2623-3eb38d5f43a1\\\">o the bottom of the shirt.</span></p>\\n<h6>B Chest</h6>\\n<p dir=\\\"ltr\\\">Measure yourself around the fullest part of your chest. Keep the tape measure horizontal.</p>","measurements":[{"type_label":"Length","values":[{"size":"S","value":"24"},{"size":"M","value":"26"},{"size":"L","value":"28"}]},{"type_label":"Chest","values":[{"size":"S","min_value":"14","max_value":"16"},{"size":"M","min_value":"18","max_value":"20"},{"size":"L","min_value":"22","max_value":"24"}]}]},{"type":"product_measure","unit":"inches","description":"<p dir=\\\"ltr\\\">Measurements are provided by our suppliers. Product measurements may vary by up to 2\\\" (5 cm).</p>\\n<p dir=\\\"ltr\\\">US customers should order a size up as the EU sizes for this supplier correspond to a smaller size in the US market.</p>\\n<p dir=\\\"ltr\\\">Pro tip! Measure one of your products at home and compare with the measurements you see in this guide.</p>","image_url":"https://s3.staging.printful.com/upload/product-measure/85/857e7cc8b802da216e7f1a6114075a72_t?v=1652962720","image_description":"<h6><strong>A Length</strong></h6>\\n<p dir=\\\"ltr\\\"><span id=\\\"docs-internal-guid-a3ac3082-7fff-5f98-2623-3eb38d5f43a1\\\">Place the end of the tape beside the collar at the top of the tee (Highest Point Shoulder). Pull the tape measure t</span><span id=\\\"docs-internal-guid-a3ac3082-7fff-5f98-2623-3eb38d5f43a1\\\">o the bottom of the shirt.</span></p>\\n<h6>B Width</h6>\\n<p dir=\\\"ltr\\\">Place the end of the tape at the seam under the sleeve and pull the tape measure across the shirt to the seam under the opposite sleeve.</p>","measurements":[{"type_label":"Length","values":[{"size":"S","value":"24"},{"size":"M","value":"26"},{"size":"L","value":"28"}]},{"type_label":"Width","values":[{"size":"S","min_value":"14","max_value":"16"},{"size":"M","min_value":"18","max_value":"20"},{"size":"L","min_value":"22","max_value":"24"}]}]},{"type":"measure_yourself","unit":"cm","description":"<p>Measurements are provided by suppliers.<br /><br />US customers should order a size up as the EU sizes for this supplier correspond to a smaller size in the US market.</p>\\n<p>Product measurements may vary by up to 2\\\" (5 cm). </p>","image_url":"https://s3.staging.printful.com/upload/measure-yourself/6a/6a4fe322f592f2b91d5a735d7ff8d1c0_t?v=1652962720","image_description":"<h6><strong>A Length</strong></h6>\\n<p dir=\\\"ltr\\\"><span id=\\\"docs-internal-guid-a3ac3082-7fff-5f98-2623-3eb38d5f43a1\\\">Place the end of the tape beside the collar at the top of the tee (Highest Point Shoulder). Pull the tape measure t</span><span id=\\\"docs-internal-guid-a3ac3082-7fff-5f98-2623-3eb38d5f43a1\\\">o the bottom of the shirt.</span></p>\\n<h6>B Chest</h6>\\n<p dir=\\\"ltr\\\">Measure yourself around the fullest part of your chest. Keep the tape measure horizontal.</p>","measurements":[{"type_label":"Length","values":[{"size":"S","value":"60.96"},{"size":"M","value":"66.04"},{"size":"L","value":"71.12"}]},{"type_label":"Chest","values":[{"size":"S","min_value":"35.56","max_value":"40.64"},{"size":"M","min_value":"45.72","max_value":"50.80"},{"size":"L","min_value":"55.88","max_value":"60.96"}]}]},{"type":"product_measure","unit":"cm","description":"<p dir=\\\"ltr\\\">Measurements are provided by our suppliers. Product measurements may vary by up to 2\\\" (5 cm).</p>\\n<p dir=\\\"ltr\\\">US customers should order a size up as the EU sizes for this supplier correspond to a smaller size in the US market.</p>\\n<p dir=\\\"ltr\\\">Pro tip! Measure one of your products at home and compare with the measurements you see in this guide.</p>","image_url":"https://s3.staging.printful.com/upload/product-measure/85/857e7cc8b802da216e7f1a6114075a72_t?v=1652962720","image_description":"<h6><strong>A Length</strong></h6>\\n<p dir=\\\"ltr\\\"><span id=\\\"docs-internal-guid-a3ac3082-7fff-5f98-2623-3eb38d5f43a1\\\">Place the end of the tape beside the collar at the top of the tee (Highest Point Shoulder). Pull the tape measure t</span><span id=\\\"docs-internal-guid-a3ac3082-7fff-5f98-2623-3eb38d5f43a1\\\">o the bottom of the shirt.</span></p>\\n<h6>B Width</h6>\\n<p dir=\\\"ltr\\\">Place the end of the tape at the seam under the sleeve and pull the tape measure across the shirt to the seam under the opposite sleeve.</p>","measurements":[{"type_label":"Length","values":[{"size":"S","value":"60.96"},{"size":"M","value":"66.04"},{"size":"L","value":"71.12"}]},{"type_label":"Width","values":[{"size":"S","min_value":"35.56","max_value":"40.64"},{"size":"M","min_value":"45.72","max_value":"50.80"},{"size":"L","min_value":"55.88","max_value":"60.96"}]}]},{"type":"international","unit":"none","measurements":[{"type_label":"US size","values":[{"size":"S","min_value":"8","max_value":"10"},{"size":"M","min_value":"12","max_value":"14"},{"size":"L","min_value":"16","max_value":"18"}]},{"type_label":"EU size","values":[{"size":"S","min_value":"38","max_value":"39"},{"size":"M","min_value":"40","max_value":"41"},{"size":"L","min_value":"42","max_value":"43"}]},{"type_label":"UK size","values":[{"size":"S","min_value":"4","max_value":"6"},{"size":"M","min_value":"8","max_value":"10"},{"size":"L","min_value":"12","max_value":"14"}]}]}]
+)
+```
+

data/docs/ProductTemplate.md

@@ -0,0 +1,26 @@
+# Printful::ProductTemplate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **Integer** | Resource version. If this changes, resources (positions, images, etc.) should be re-cached. | [optional] |
+| **min_dpi** | **Integer** | Recommended minimum DPI for given product. | [optional] |
+| **variant_mapping** | [**Array<TemplateVariantMapping>**](TemplateVariantMapping.md) | List of product variants mapped to templates. From this information you can determine which template should be used for a variant. | [optional] |
+| **templates** | [**Array<Template>**](Template.md) | List of templates. Use variant_mapping to determine which template corresponds to which product variant. | [optional] |
+| **conflicting_placements** | [**Array<TemplatePlacementConflict>**](TemplatePlacementConflict.md) | List of conflicting placements. Used to determine which placements can be used together. | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::ProductTemplate.new(
+  version: 1,
+  min_dpi: 300,
+  variant_mapping: null,
+  templates: null,
+  conflicting_placements: null
+)
+```
+

data/docs/ProductTemplatesAPIClient.md

@@ -0,0 +1,221 @@
+# Printful::ProductTemplatesAPIClient
+
+All URIs are relative to *https://api.printful.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_product_template**](ProductTemplatesAPIClient.md#delete_product_template) | **DELETE** /product-templates/{id} | Delete product template |
+| [**get_product_template_by_id**](ProductTemplatesAPIClient.md#get_product_template_by_id) | **GET** /product-templates/{id} | Get product template |
+| [**get_product_templates**](ProductTemplatesAPIClient.md#get_product_templates) | **GET** /product-templates | Get product template list |
+
+
+## delete_product_template
+
+> <DeleteProductTemplate200Response> delete_product_template(id)
+
+Delete product template
+
+Delete product template by ID or External Product 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::ProductTemplatesAPIClient.new
+id = nil # GetSyncProductByIdIdParameter | Template ID (integer) or External Product ID (if prefixed with @)
+
+begin
+  # Delete product template
+  result = api_instance.delete_product_template(id)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling ProductTemplatesAPIClient->delete_product_template: #{e}"
+end
+```
+
+#### Using the delete_product_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteProductTemplate200Response>, Integer, Hash)> delete_product_template_with_http_info(id)
+
+```ruby
+begin
+  # Delete product template
+  data, status_code, headers = api_instance.delete_product_template_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteProductTemplate200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling ProductTemplatesAPIClient->delete_product_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | [**GetSyncProductByIdIdParameter**](.md) | Template ID (integer) or External Product ID (if prefixed with @) |  |
+
+### Return type
+
+[**DeleteProductTemplate200Response**](DeleteProductTemplate200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_product_template_by_id
+
+> <GetProductTemplateById200Response> get_product_template_by_id(id)
+
+Get product template
+
+Get information about a single product template
+
+### 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::ProductTemplatesAPIClient.new
+id = nil # GetSyncProductByIdIdParameter | Template ID (integer) or External Product ID (if prefixed with @)
+
+begin
+  # Get product template
+  result = api_instance.get_product_template_by_id(id)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling ProductTemplatesAPIClient->get_product_template_by_id: #{e}"
+end
+```
+
+#### Using the get_product_template_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetProductTemplateById200Response>, Integer, Hash)> get_product_template_by_id_with_http_info(id)
+
+```ruby
+begin
+  # Get product template
+  data, status_code, headers = api_instance.get_product_template_by_id_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetProductTemplateById200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling ProductTemplatesAPIClient->get_product_template_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | [**GetSyncProductByIdIdParameter**](.md) | Template ID (integer) or External Product ID (if prefixed with @) |  |
+
+### Return type
+
+[**GetProductTemplateById200Response**](GetProductTemplateById200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_product_templates
+
+> <GetProductTemplates200Response> get_product_templates(opts)
+
+Get product template list
+
+Returns a list of templates.
+
+### 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::ProductTemplatesAPIClient.new
+opts = {
+  offset: 56, # Integer | Result set offset
+  limit: 56 # Integer | Number of items per page (max 100)
+}
+
+begin
+  # Get product template list
+  result = api_instance.get_product_templates(opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling ProductTemplatesAPIClient->get_product_templates: #{e}"
+end
+```
+
+#### Using the get_product_templates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetProductTemplates200Response>, Integer, Hash)> get_product_templates_with_http_info(opts)
+
+```ruby
+begin
+  # Get product template list
+  data, status_code, headers = api_instance.get_product_templates_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetProductTemplates200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling ProductTemplatesAPIClient->get_product_templates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **offset** | **Integer** | Result set offset | [optional] |
+| **limit** | **Integer** | Number of items per page (max 100) | [optional] |
+
+### Return type
+
+[**GetProductTemplates200Response**](GetProductTemplates200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ProductVariant.md

@@ -0,0 +1,24 @@
+# Printful::ProductVariant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **variant_id** | **Integer** | Variant ID | [optional] |
+| **product_id** | **Integer** | Product ID of this variant | [optional] |
+| **image** | **String** | URL of a sample image for this variant | [optional] |
+| **name** | **String** | Display name of this variant | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::ProductVariant.new(
+  variant_id: 3001,
+  product_id: 301,
+  image: https://files.cdn.printful.com/products/71/5309_1581412541.jpg,
+  name: Bella + Canvas 3001 Unisex Short Sleeve Jersey T-Shirt with Tear Away Label (White / 4XL)
+)
+```
+