printful_client 1.0.1

data/docs/SyncVariantInfo.md

@@ -0,0 +1,20 @@
+# Printful::SyncVariantInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sync_variant** | [**SyncVariant**](SyncVariant.md) |  | [optional] |
+| **sync_product** | [**SyncProduct**](SyncProduct.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::SyncVariantInfo.new(
+  sync_variant: null,
+  sync_product: null
+)
+```
+

data/docs/SyncVariantProduct.md

@@ -0,0 +1,24 @@
+# Printful::SyncVariantProduct
+
+## 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::SyncVariantProduct.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)
+)
+```
+

data/docs/TaxAddressInfo.md

@@ -0,0 +1,24 @@
+# Printful::TaxAddressInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **country_code** | **String** | Country code |  |
+| **state_code** | **String** | State code |  |
+| **city** | **String** | City |  |
+| **zip** | **String** | ZIP or postal code |  |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::TaxAddressInfo.new(
+  country_code: US,
+  state_code: CA,
+  city: Chatsworth,
+  zip: 91311
+)
+```
+

data/docs/TaxInfo.md

@@ -0,0 +1,22 @@
+# Printful::TaxInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **required** | **Boolean** | Whether sales tax is required for the given address | [optional] |
+| **rate** | **Float** | Tax rate | [optional] |
+| **shipping_taxable** | **Boolean** | Whether shipping is taxable | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::TaxInfo.new(
+  required: true,
+  rate: 0.095,
+  shipping_taxable: false
+)
+```
+

data/docs/TaxRateAPIClient.md

@@ -0,0 +1,134 @@
+# Printful::TaxRateAPIClient
+
+All URIs are relative to *https://api.printful.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**calculate_tax_rates**](TaxRateAPIClient.md#calculate_tax_rates) | **POST** /tax/rates | Calculate tax rate |
+| [**get_tax_countries**](TaxRateAPIClient.md#get_tax_countries) | **GET** /tax/countries | Get a list of countries for tax calculation |
+
+
+## calculate_tax_rates
+
+> <CalculateTaxRates200Response> calculate_tax_rates(tax_request)
+
+Calculate tax rate
+
+Calculates sales tax rate for given address if required
+
+### Examples
+
+```ruby
+require 'time'
+require 'printful_client'
+
+api_instance = Printful::TaxRateAPIClient.new
+tax_request = Printful::TaxRequest.new({recipient: Printful::TaxAddressInfo.new({country_code: 'US', state_code: 'CA', city: 'Chatsworth', zip: '91311'})}) # TaxRequest | POST request body
+
+begin
+  # Calculate tax rate
+  result = api_instance.calculate_tax_rates(tax_request)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling TaxRateAPIClient->calculate_tax_rates: #{e}"
+end
+```
+
+#### Using the calculate_tax_rates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CalculateTaxRates200Response>, Integer, Hash)> calculate_tax_rates_with_http_info(tax_request)
+
+```ruby
+begin
+  # Calculate tax rate
+  data, status_code, headers = api_instance.calculate_tax_rates_with_http_info(tax_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CalculateTaxRates200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling TaxRateAPIClient->calculate_tax_rates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tax_request** | [**TaxRequest**](TaxRequest.md) | POST request body |  |
+
+### Return type
+
+[**CalculateTaxRates200Response**](CalculateTaxRates200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_tax_countries
+
+> <GetTaxCountries200Response> get_tax_countries
+
+Get a list of countries for tax calculation
+
+Retrieve state list that requires sales tax calculation
+
+### Examples
+
+```ruby
+require 'time'
+require 'printful_client'
+
+api_instance = Printful::TaxRateAPIClient.new
+
+begin
+  # Get a list of countries for tax calculation
+  result = api_instance.get_tax_countries
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling TaxRateAPIClient->get_tax_countries: #{e}"
+end
+```
+
+#### Using the get_tax_countries_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetTaxCountries200Response>, Integer, Hash)> get_tax_countries_with_http_info
+
+```ruby
+begin
+  # Get a list of countries for tax calculation
+  data, status_code, headers = api_instance.get_tax_countries_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetTaxCountries200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling TaxRateAPIClient->get_tax_countries_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetTaxCountries200Response**](GetTaxCountries200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/TaxRequest.md

@@ -0,0 +1,18 @@
+# Printful::TaxRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recipient** | [**TaxAddressInfo**](TaxAddressInfo.md) |  |  |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::TaxRequest.new(
+  recipient: null
+)
+```
+

data/docs/Template.md

@@ -0,0 +1,42 @@
+# Printful::Template
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **Integer** | Template ID. | [optional] |
+| **image_url** | **String** | Main template image URL. | [optional] |
+| **background_url** | **String** | Background image URL (optional). | [optional] |
+| **background_color** | **Integer** | HEX color code that should be used as a background color. | [optional] |
+| **printfile_id** | **Integer** | Printfile ID that should be generated for this template. See [printfile API endpoint](#operation/getPrintfiles) for list of Printfiles. | [optional] |
+| **template_width** | **Integer** | Width of the whole template in pixels. | [optional] |
+| **template_height** | **Integer** | Height of the whole template in pixels. | [optional] |
+| **print_area_width** | **Integer** | Print area width (image is positioned in this area). | [optional] |
+| **print_area_height** | **Integer** | Print area height (image is positioned in this area). | [optional] |
+| **print_area_top** | **Integer** | Print area top offset (offset in template). | [optional] |
+| **print_area_left** | **Integer** | Print area left offset (offset in template). | [optional] |
+| **is_template_on_front** | **Boolean** | Should the main template image (image_url) be used as an overlay or as a background. | [optional] |
+| **orientation** | **String** | Wall art product orientation. Possible values: horizontal, vertical, any | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Template.new(
+  template_id: 919,
+  image_url: https://www.printful.com/files/generator/40/11oz_template.png,
+  background_url: null,
+  background_color: null,
+  printfile_id: 43,
+  template_width: 560,
+  template_height: 295,
+  print_area_width: 520,
+  print_area_height: 202,
+  print_area_top: 18,
+  print_area_left: 20,
+  is_template_on_front: true,
+  orientation: any
+)
+```
+

data/docs/TemplateById.md

@@ -0,0 +1,42 @@
+# Printful::TemplateById
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **product_id** | **Integer** |  | [optional] |
+| **external_product_id** | **String** |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **available_variant_ids** | **Array<Integer>** |  | [optional] |
+| **option_data** | [**Array<TemplateByIdOptionDataInner>**](TemplateByIdOptionDataInner.md) |  | [optional] |
+| **colors** | [**Array<TemplateByIdColorsInner>**](TemplateByIdColorsInner.md) |  | [optional] |
+| **sizes** | **Array<String>** |  | [optional] |
+| **mockup_file_url** | **String** |  | [optional] |
+| **placements** | [**Array<TemplateByIdPlacementsInner>**](TemplateByIdPlacementsInner.md) |  | [optional] |
+| **created_at** | **Integer** |  | [optional] |
+| **updated_at** | **Integer** |  | [optional] |
+| **placement_option_data** | [**Array<TemplateByIdPlacementOptionDataInner>**](TemplateByIdPlacementOptionDataInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::TemplateById.new(
+  id: null,
+  product_id: null,
+  external_product_id: null,
+  title: null,
+  available_variant_ids: null,
+  option_data: null,
+  colors: null,
+  sizes: null,
+  mockup_file_url: null,
+  placements: null,
+  created_at: null,
+  updated_at: null,
+  placement_option_data: null
+)
+```
+

data/docs/TemplateByIdColorsInner.md

@@ -0,0 +1,20 @@
+# Printful::TemplateByIdColorsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **color_name** | **String** |  | [optional] |
+| **color_codes** | **Array** |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::TemplateByIdColorsInner.new(
+  color_name: null,
+  color_codes: null
+)
+```
+

data/docs/TemplateByIdOptionDataInner.md

@@ -0,0 +1,20 @@
+# Printful::TemplateByIdOptionDataInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **value** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::TemplateByIdOptionDataInner.new(
+  id: null,
+  value: null
+)
+```
+

data/docs/TemplateByIdPlacementOptionDataInner.md

@@ -0,0 +1,20 @@
+# Printful::TemplateByIdPlacementOptionDataInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **options** | [**Array<TemplateByIdPlacementOptionDataInnerOptionsInner>**](TemplateByIdPlacementOptionDataInnerOptionsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::TemplateByIdPlacementOptionDataInner.new(
+  id: embroidery_chest_left,
+  options: null
+)
+```
+

data/docs/TemplateByIdPlacementOptionDataInnerOptionsInner.md

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

data/docs/TemplateByIdPlacementsInner.md

@@ -0,0 +1,24 @@
+# Printful::TemplateByIdPlacementsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **placement** | **String** |  | [optional] |
+| **display_name** | **String** |  | [optional] |
+| **technique_key** | **String** |  | [optional] |
+| **technique_display_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::TemplateByIdPlacementsInner.new(
+  placement: null,
+  display_name: null,
+  technique_key: SUBLIMATION,
+  technique_display_name: Sublimation
+)
+```
+

data/docs/TemplatePlacementConflict.md

@@ -0,0 +1,20 @@
+# Printful::TemplatePlacementConflict
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **placement** | **String** | Placement ID | [optional] |
+| **conflicts** | **Array<String>** | List Placement IDs that are conflicting with given placement | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::TemplatePlacementConflict.new(
+  placement: label_outside,
+  conflicts: ["back","label_inside"]
+)
+```
+

data/docs/TemplateVariantMapping.md

@@ -0,0 +1,20 @@
+# Printful::TemplateVariantMapping
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **variant_id** | **Integer** | Product variant ID. | [optional] |
+| **templates** | [**Array<TemplateVariantMappingItem>**](TemplateVariantMappingItem.md) | Array of Template Variant Mapping items | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::TemplateVariantMapping.new(
+  variant_id: 1,
+  templates: null
+)
+```
+

data/docs/TemplateVariantMappingItem.md

@@ -0,0 +1,20 @@
+# Printful::TemplateVariantMappingItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **placement** | **String** | Placement ID. | [optional] |
+| **template_id** | **Integer** | Corresponding template id which should be used for this variant and placement combination. | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::TemplateVariantMappingItem.new(
+  placement: front,
+  template_id: 1
+)
+```
+

data/docs/Templates.md

@@ -0,0 +1,18 @@
+# Printful::Templates
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<TemplateById>**](TemplateById.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Templates.new(
+  items: null
+)
+```
+

data/docs/ThreadColors200Response.md

@@ -0,0 +1,20 @@
+# Printful::ThreadColors200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** | Response status code `200` | [optional] |
+| **thread_colors** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::ThreadColors200Response.new(
+  code: 200,
+  thread_colors: null
+)
+```
+

data/docs/ThreadColorsRequest.md

@@ -0,0 +1,18 @@
+# Printful::ThreadColorsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_url** | **String** | URL to file | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::ThreadColorsRequest.new(
+  file_url: https://example.com/image.jpg
+)
+```
+

data/docs/TotalPaidOrders.md

@@ -0,0 +1,20 @@
+# Printful::TotalPaidOrders
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **Float** | Number of unique orders for period | [optional] |
+| **relative_difference** | **Float** | Relative difference from the value from the previous period. -1 means 100% decrease, 1 means 100% increase. 0 is returned if there is no change or the previous value was 0. | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::TotalPaidOrders.new(
+  value: null,
+  relative_difference: null
+)
+```
+

data/docs/UpdateSyncProductRequest.md

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

data/docs/UpdateSyncProductRequestSyncVariantsInner.md

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