printful_client 1.0.1

data/docs/CalculateShippingRates200Response.md

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

data/docs/CalculateTaxRates200Response.md

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

data/docs/CatalogAPIClient.md

@@ -0,0 +1,400 @@
+# Printful::CatalogAPIClient
+
+All URIs are relative to *https://api.printful.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_categories**](CatalogAPIClient.md#get_categories) | **GET** /categories | Get Categories |
+| [**get_category_by_id**](CatalogAPIClient.md#get_category_by_id) | **GET** /categories/{id} | Get Category |
+| [**get_product_by_id**](CatalogAPIClient.md#get_product_by_id) | **GET** /products/{id} | Get Product |
+| [**get_product_size_guide_by_id**](CatalogAPIClient.md#get_product_size_guide_by_id) | **GET** /products/{id}/sizes | Get Product Size Guide |
+| [**get_products**](CatalogAPIClient.md#get_products) | **GET** /products | Get Products |
+| [**get_variant_by_id**](CatalogAPIClient.md#get_variant_by_id) | **GET** /products/variant/{id} | Get Variant |
+
+
+## get_categories
+
+> <GetCategories200Response> get_categories
+
+Get Categories
+
+Returns list of Catalog Categories available in the Printful
+
+### Examples
+
+```ruby
+require 'time'
+require 'printful_client'
+
+api_instance = Printful::CatalogAPIClient.new
+
+begin
+  # Get Categories
+  result = api_instance.get_categories
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling CatalogAPIClient->get_categories: #{e}"
+end
+```
+
+#### Using the get_categories_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCategories200Response>, Integer, Hash)> get_categories_with_http_info
+
+```ruby
+begin
+  # Get Categories
+  data, status_code, headers = api_instance.get_categories_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCategories200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling CatalogAPIClient->get_categories_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetCategories200Response**](GetCategories200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_category_by_id
+
+> <GetCategoryById200Response> get_category_by_id(id)
+
+Get Category
+
+Returns information about a specific category.
+
+### Examples
+
+```ruby
+require 'time'
+require 'printful_client'
+
+api_instance = Printful::CatalogAPIClient.new
+id = 56 # Integer | Category ID
+
+begin
+  # Get Category
+  result = api_instance.get_category_by_id(id)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling CatalogAPIClient->get_category_by_id: #{e}"
+end
+```
+
+#### Using the get_category_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCategoryById200Response>, Integer, Hash)> get_category_by_id_with_http_info(id)
+
+```ruby
+begin
+  # Get Category
+  data, status_code, headers = api_instance.get_category_by_id_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCategoryById200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling CatalogAPIClient->get_category_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Category ID |  |
+
+### Return type
+
+[**GetCategoryById200Response**](GetCategoryById200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_product_by_id
+
+> <GetProductById200Response> get_product_by_id(id)
+
+Get Product
+
+Returns information about a specific product and a list of variants for this product.
+
+### Examples
+
+```ruby
+require 'time'
+require 'printful_client'
+
+api_instance = Printful::CatalogAPIClient.new
+id = 56 # Integer | Product ID.
+
+begin
+  # Get Product
+  result = api_instance.get_product_by_id(id)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling CatalogAPIClient->get_product_by_id: #{e}"
+end
+```
+
+#### Using the get_product_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetProductById200Response>, Integer, Hash)> get_product_by_id_with_http_info(id)
+
+```ruby
+begin
+  # Get Product
+  data, status_code, headers = api_instance.get_product_by_id_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetProductById200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling CatalogAPIClient->get_product_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Product ID. |  |
+
+### Return type
+
+[**GetProductById200Response**](GetProductById200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_product_size_guide_by_id
+
+> <GetProductSizeGuideById200Response> get_product_size_guide_by_id(id, opts)
+
+Get Product Size Guide
+
+Returns information about the size guide for a specific product.
+
+### Examples
+
+```ruby
+require 'time'
+require 'printful_client'
+
+api_instance = Printful::CatalogAPIClient.new
+id = 56 # Integer | Product ID.
+opts = {
+  unit: 'inches,cm' # String | A comma-separated list of measurement unit in which size tables are to be returned (`inches` or `cm`). The default value is determined based on the locale country. The inches are used for United States, Liberia and Myanmar, for other countries the unit defaults to centimeters. 
+}
+
+begin
+  # Get Product Size Guide
+  result = api_instance.get_product_size_guide_by_id(id, opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling CatalogAPIClient->get_product_size_guide_by_id: #{e}"
+end
+```
+
+#### Using the get_product_size_guide_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetProductSizeGuideById200Response>, Integer, Hash)> get_product_size_guide_by_id_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get Product Size Guide
+  data, status_code, headers = api_instance.get_product_size_guide_by_id_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetProductSizeGuideById200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling CatalogAPIClient->get_product_size_guide_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Product ID. |  |
+| **unit** | **String** | A comma-separated list of measurement unit in which size tables are to be returned (&#x60;inches&#x60; or &#x60;cm&#x60;). The default value is determined based on the locale country. The inches are used for United States, Liberia and Myanmar, for other countries the unit defaults to centimeters.  | [optional] |
+
+### Return type
+
+[**GetProductSizeGuideById200Response**](GetProductSizeGuideById200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_products
+
+> <GetProducts200Response> get_products(opts)
+
+Get Products
+
+Returns list of Products available in the Printful
+
+### Examples
+
+```ruby
+require 'time'
+require 'printful_client'
+
+api_instance = Printful::CatalogAPIClient.new
+opts = {
+  category_id: 'category_id_example' # String | A comma-separated list of Category IDs of the Products that are to be returned
+}
+
+begin
+  # Get Products
+  result = api_instance.get_products(opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling CatalogAPIClient->get_products: #{e}"
+end
+```
+
+#### Using the get_products_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetProducts200Response>, Integer, Hash)> get_products_with_http_info(opts)
+
+```ruby
+begin
+  # Get Products
+  data, status_code, headers = api_instance.get_products_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetProducts200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling CatalogAPIClient->get_products_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category_id** | **String** | A comma-separated list of Category IDs of the Products that are to be returned | [optional] |
+
+### Return type
+
+[**GetProducts200Response**](GetProducts200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_variant_by_id
+
+> <GetVariantById200Response> get_variant_by_id(id)
+
+Get Variant
+
+Returns information about a specific Variant and its Product
+
+### Examples
+
+```ruby
+require 'time'
+require 'printful_client'
+
+api_instance = Printful::CatalogAPIClient.new
+id = 56 # Integer | Variant id
+
+begin
+  # Get Variant
+  result = api_instance.get_variant_by_id(id)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling CatalogAPIClient->get_variant_by_id: #{e}"
+end
+```
+
+#### Using the get_variant_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetVariantById200Response>, Integer, Hash)> get_variant_by_id_with_http_info(id)
+
+```ruby
+begin
+  # Get Variant
+  data, status_code, headers = api_instance.get_variant_by_id_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetVariantById200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling CatalogAPIClient->get_variant_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Variant id |  |
+
+### Return type
+
+[**GetVariantById200Response**](GetVariantById200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CatalogFileOption.md

@@ -0,0 +1,24 @@
+# Printful::CatalogFileOption
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | File option identifier. Use this to specify which option you are adding to your file in a request. | [optional] |
+| **type** | **String** | The type of the value property when using this option in a request. | [optional] |
+| **title** | **String** |  | [optional] |
+| **additional_price** | **Float** | Additional cost this will add to the item. | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::CatalogFileOption.new(
+  id: full_color,
+  type: bool,
+  title: Unlimited color,
+  additional_price: 3.25
+)
+```
+

data/docs/Category.md

@@ -0,0 +1,26 @@
+# Printful::Category
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Category ID | [optional] |
+| **parent_id** | **Integer** | ID of the parent Category. If there is no parent Category, 0 is returned. | [optional] |
+| **image_url** | **String** | The URL of the Category image | [optional] |
+| **size** | **String** | The size of the category image | [optional] |
+| **title** | **String** | Category title | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Category.new(
+  id: 24,
+  parent_id: 6,
+  image_url: https://s3.staging.printful.com/upload/catalog_category/b1/b1513c82696405fcc316fc611c57f132_t?v=1646395980,
+  size: null,
+  title: T-Shirts
+)
+```
+

data/docs/ChangePackingSlip200Response.md

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

data/docs/ChangePackingSlip200ResponseResult.md

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

data/docs/Costs.md

@@ -0,0 +1,38 @@
+# Printful::Costs
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | **String** | 3 letter currency code | [optional] |
+| **subtotal** | **String** | Total cost of all items | [optional] |
+| **discount** | **String** | Discount sum | [optional] |
+| **shipping** | **String** | Shipping costs | [optional] |
+| **digitization** | **String** | Digitization costs | [optional] |
+| **additional_fee** | **String** | Additional fee for custom product | [optional] |
+| **fulfillment_fee** | **String** | Custom product fulfillment fee | [optional] |
+| **retail_delivery_fee** | **String** | Retail delivery fee | [optional] |
+| **tax** | **String** | Sum of taxes (not included in the item price) | [optional] |
+| **vat** | **String** | Sum of vat (not included in the item price) | [optional] |
+| **total** | **String** | Grand Total (subtotal-discount+tax+vat+shipping) | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Costs.new(
+  currency: USD,
+  subtotal: 10.00,
+  discount: 0.00,
+  shipping: 5.00,
+  digitization: 0.00,
+  additional_fee: 0.00,
+  fulfillment_fee: 0.00,
+  retail_delivery_fee: 0.00,
+  tax: 0.00,
+  vat: 0.00,
+  total: 15.00
+)
+```
+

data/docs/CostsByAmountInner.md

@@ -0,0 +1,34 @@
+# Printful::CostsByAmountInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **String** | The date of the value: day in `Y-m-d` format, month in `Y-m` format or \"Total\" for the first element of the list which shows the total values for the whole requested period | [optional] |
+| **product_amount** | **Float** | Product & fulfillment costs | [optional] |
+| **digitization** | **Float** | Embroidery digitization costs | [optional] |
+| **branding** | **Float** | Pack-in costs | [optional] |
+| **vat** | **Float** | Tax amounts. If not applicable, it will be 0. | [optional] |
+| **sales_tax** | **Float** | Tax amounts. If not applicable, it will be 0. | [optional] |
+| **shipping** | **Float** | Shipping costs that were charged by Printful | [optional] |
+| **discount** | **Float** | Any fulfillment discounts (such as the monthly discount) set up on Printful's side | [optional] |
+| **total** | **Float** | Summary of all costs | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::CostsByAmountInner.new(
+  date: null,
+  product_amount: null,
+  digitization: null,
+  branding: null,
+  vat: null,
+  sales_tax: null,
+  shipping: null,
+  discount: null,
+  total: null
+)
+```
+

data/docs/CostsByProductInner.md

@@ -0,0 +1,26 @@
+# Printful::CostsByProductInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_id** | **Integer** | Product ID. See [Catalog API](#tag/Catalog-API). | [optional] |
+| **product_name** | **String** | Product name. | [optional] |
+| **fulfillment** | **Float** | All fulfillment costs that are charged by Printful, excluding shipping. | [optional] |
+| **sales** | **Float** | Order retail price data. Available only if retail price fields are properly set up on the integration's side. | [optional] |
+| **quantity** | **Integer** | Total quantity of items ordered from this product in the selected period. | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::CostsByProductInner.new(
+  product_id: null,
+  product_name: null,
+  fulfillment: null,
+  sales: null,
+  quantity: null
+)
+```
+

data/docs/CostsByVariantInner.md

@@ -0,0 +1,28 @@
+# Printful::CostsByVariantInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **variant_id** | **Integer** | Variant ID. See [Catalog API](#tag/Catalog-API). | [optional] |
+| **variant_name** | **String** | Variant name. | [optional] |
+| **product_id** | **Integer** | Product ID. See [Catalog API](#tag/Catalog-API). | [optional] |
+| **fulfillment** | **Float** | All fulfillment costs that are charged by Printful, excluding shipping. | [optional] |
+| **sales** | **Float** | Order retail price data. Available only if retail price fields are properly set up on the integration's side. | [optional] |
+| **quantity** | **Integer** | Total quantity of items ordered from this product in the selected period. | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::CostsByVariantInner.new(
+  variant_id: null,
+  variant_name: null,
+  product_id: null,
+  fulfillment: null,
+  sales: null,
+  quantity: null
+)
+```
+

data/docs/Country.md

@@ -0,0 +1,24 @@
+# Printful::Country
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Country code | [optional] |
+| **name** | **String** | Country name | [optional] |
+| **states** | [**Array<State>**](State.md) |  | [optional] |
+| **region** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Country.new(
+  code: Australia,
+  name: AU,
+  states: null,
+  region: oceania
+)
+```
+