printful_client 1.0.1

data/docs/FileLibraryAPIClient.md

@@ -0,0 +1,220 @@
+# Printful::FileLibraryAPIClient
+
+All URIs are relative to *https://api.printful.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_file**](FileLibraryAPIClient.md#add_file) | **POST** /files | Add a new file |
+| [**get_file**](FileLibraryAPIClient.md#get_file) | **GET** /files/{id} | Get file |
+| [**thread_colors**](FileLibraryAPIClient.md#thread_colors) | **POST** /files/thread-colors | Return available thread colors from provided image URL |
+
+
+## add_file
+
+> <AddFile200Response> add_file(file, opts)
+
+Add a new file
+
+Adds a new File to the library by providing URL of the file.  If a file with identical URL already exists, then the original file is returned. If a file does not exist, a new file is created.  [See examples](#section/File-Library-API-examples/Add-a-new-file) 
+
+### 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::FileLibraryAPIClient.new
+file = Printful::File.new({url: 'https://www.example.com/files/tshirts/example.png'}) # File | 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
+  # Add a new file
+  result = api_instance.add_file(file, opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling FileLibraryAPIClient->add_file: #{e}"
+end
+```
+
+#### Using the add_file_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AddFile200Response>, Integer, Hash)> add_file_with_http_info(file, opts)
+
+```ruby
+begin
+  # Add a new file
+  data, status_code, headers = api_instance.add_file_with_http_info(file, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AddFile200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling FileLibraryAPIClient->add_file_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | [**File**](File.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
+
+[**AddFile200Response**](AddFile200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_file
+
+> <AddFile200Response> get_file(id, opts)
+
+Get file
+
+Returns information about the given file.
+
+### 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::FileLibraryAPIClient.new
+id = 56 # Integer | File ID.
+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
+  # Get file
+  result = api_instance.get_file(id, opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling FileLibraryAPIClient->get_file: #{e}"
+end
+```
+
+#### Using the get_file_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AddFile200Response>, Integer, Hash)> get_file_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get file
+  data, status_code, headers = api_instance.get_file_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AddFile200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling FileLibraryAPIClient->get_file_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | File ID. |  |
+| **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
+
+### Return type
+
+[**AddFile200Response**](AddFile200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## thread_colors
+
+> <ThreadColors200Response> thread_colors(thread_colors_request)
+
+Return available thread colors from provided image URL
+
+Returns colors in hexadecimal format.  Returned thread colors are matched as closely as possible to provided image colors.  [See examples](#section/File-Library-API-examples/Suggest-thread-colors) 
+
+### Examples
+
+```ruby
+require 'time'
+require 'printful_client'
+
+api_instance = Printful::FileLibraryAPIClient.new
+thread_colors_request = Printful::ThreadColorsRequest.new # ThreadColorsRequest | POST request body
+
+begin
+  # Return available thread colors from provided image URL
+  result = api_instance.thread_colors(thread_colors_request)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling FileLibraryAPIClient->thread_colors: #{e}"
+end
+```
+
+#### Using the thread_colors_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ThreadColors200Response>, Integer, Hash)> thread_colors_with_http_info(thread_colors_request)
+
+```ruby
+begin
+  # Return available thread colors from provided image URL
+  data, status_code, headers = api_instance.thread_colors_with_http_info(thread_colors_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ThreadColors200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling FileLibraryAPIClient->thread_colors_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **thread_colors_request** | [**ThreadColorsRequest**](ThreadColorsRequest.md) | POST request body |  |
+
+### Return type
+
+[**ThreadColors200Response**](ThreadColors200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/FileOption.md

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

data/docs/FileType.md

@@ -0,0 +1,26 @@
+# Printful::FileType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Deprecated file type identifier. Please use type field instead! | [optional] |
+| **type** | **String** | File type identifier - use this to specify a file's purpose when creating an order [See examples](#section/Placements) | [optional] |
+| **title** | **String** | Display name | [optional] |
+| **additional_price** | **String** | Additional price when this print file type is used | [optional] |
+| **options** | [**Array<CatalogFileOption>**](CatalogFileOption.md) | Additional options available to product files | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::FileType.new(
+  id: default,
+  type: front,
+  title: Front print,
+  additional_price: 2.22,
+  options: null
+)
+```
+

data/docs/GenerationTask.md

@@ -0,0 +1,26 @@
+# Printful::GenerationTask
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_key** | **String** | Task identifier you will use to retrieve generated mockups. | [optional] |
+| **status** | **String** | Status of the generation task. | [optional] |
+| **error** | **String** | If task has failed, reason will be provided here. | [optional] |
+| **mockups** | [**Array<GenerationTaskMockup>**](GenerationTaskMockup.md) | If task is completed, list of mockups will be provided here. | [optional] |
+| **printfiles** | [**Array<GenerationTaskTemplateFile>**](GenerationTaskTemplateFile.md) | If task is completed, list of printfiles will be provided here. | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::GenerationTask.new(
+  task_key: 123456,
+  status: completed,
+  error: null,
+  mockups: null,
+  printfiles: null
+)
+```
+

data/docs/GenerationTaskExtraMockup.md

@@ -0,0 +1,24 @@
+# Printful::GenerationTaskExtraMockup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | Display name of the extra mockup. | [optional] |
+| **url** | **String** | Temporary URL of the mockup. | [optional] |
+| **option** | **String** | Style option name | [optional] |
+| **option_group** | **String** | Style option group name | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::GenerationTaskExtraMockup.new(
+  title: null,
+  url: https://url-to/extra-mockup.png,
+  option: null,
+  option_group: null
+)
+```
+

data/docs/GenerationTaskFile.md

@@ -0,0 +1,24 @@
+# Printful::GenerationTaskFile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **placement** | **String** | Placement identifier (front, back, etc.). | [optional] |
+| **image_url** | **String** | Public URL where your file is stored. | [optional] |
+| **position** | [**GenerationTaskFilePosition**](GenerationTaskFilePosition.md) |  | [optional] |
+| **options** | [**Array<FileOption>**](FileOption.md) | Array of additional options for this file [See examples](#section/Options) | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::GenerationTaskFile.new(
+  placement: front,
+  image_url: http://your-site/path-to-front-printfile.jpg,
+  position: null,
+  options: null
+)
+```
+

data/docs/GenerationTaskFilePosition.md

@@ -0,0 +1,28 @@
+# Printful::GenerationTaskFilePosition
+
+## 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] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::GenerationTaskFilePosition.new(
+  area_width: 1800,
+  area_height: 2400,
+  width: 1800,
+  height: 1800,
+  top: 300,
+  left: 0
+)
+```
+

data/docs/GenerationTaskMockup.md

@@ -0,0 +1,24 @@
+# Printful::GenerationTaskMockup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **placement** | **String** | Placement identifier. | [optional] |
+| **variant_ids** | **Array<Integer>** | List of variant ids this mockup is used for. One mockup can be used for multiple variants. | [optional] |
+| **mockup_url** | **String** | Temporary URL of the primary mockup. | [optional] |
+| **extra** | [**Array<GenerationTaskExtraMockup>**](GenerationTaskExtraMockup.md) | Optional extra mockups. | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::GenerationTaskMockup.new(
+  placement: front,
+  variant_ids: [4011,4012,4013],
+  mockup_url: https://url-to/front-mockup.png,
+  extra: null
+)
+```
+

data/docs/GenerationTaskTemplateFile.md

@@ -0,0 +1,22 @@
+# Printful::GenerationTaskTemplateFile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **variant_ids** | **Array<Integer>** | List of variant IDs associated with printfiles. | [optional] |
+| **placement** | **String** | Placement identifier (front, back, etc.). | [optional] |
+| **url** | **String** | Public URL where your file is stored. | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::GenerationTaskTemplateFile.new(
+  variant_ids: [4012,4013,4014,4017,4018,4019],
+  placement: front,
+  url: https://url-to/printfile.png
+)
+```
+

data/docs/GetApprovalSheets200Response.md

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

data/docs/GetCategories200Response.md

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

data/docs/GetCategoryById200Response.md

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

data/docs/GetCountries200Response.md

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

data/docs/GetOrderByIdIdParameter.md

@@ -0,0 +1,49 @@
+# Printful::GetOrderByIdIdParameter
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'printful_client'
+
+Printful::GetOrderByIdIdParameter.openapi_one_of
+# =>
+# [
+#   :'Integer',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'printful_client'
+
+Printful::GetOrderByIdIdParameter.build(data)
+# => #<Integer:0x00007fdd4aab02a0>
+
+Printful::GetOrderByIdIdParameter.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Integer`
+- `String`
+- `nil` (if no type matches)
+

data/docs/GetOrders200Response.md

@@ -0,0 +1,22 @@
+# Printful::GetOrders200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** | Response status code `200` | [optional] |
+| **paging** | [**Paging**](Paging.md) |  | [optional] |
+| **result** | [**Array<Order>**](Order.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::GetOrders200Response.new(
+  code: 200,
+  paging: null,
+  result: null
+)
+```
+

data/docs/GetPrintfiles200Response.md

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

data/docs/GetProductById200Response.md

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

data/docs/GetProductSizeGuideById200Response.md

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

data/docs/GetProductSizeGuideById404Response.md

@@ -0,0 +1,22 @@
+# Printful::GetProductSizeGuideById404Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** | Response status code `404` | [optional] |
+| **result** | **String** | Actual error message | [optional] |
+| **error** | [**GetProductSizeGuideById404ResponseError**](GetProductSizeGuideById404ResponseError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::GetProductSizeGuideById404Response.new(
+  code: 404,
+  result: Not found,
+  error: null
+)
+```
+

data/docs/GetProductSizeGuideById404ResponseError.md

@@ -0,0 +1,20 @@
+# Printful::GetProductSizeGuideById404ResponseError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reason** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::GetProductSizeGuideById404ResponseError.new(
+  reason: NotFound,
+  message: Not found
+)
+```
+