printful_client 1.0.1

data/docs/README.md

@@ -0,0 +1,410 @@
+# printful_client
+
+Printful - the Ruby gem for the API Documentation | Printful
+
+# About the Printful API
+
+The Printful API is a RESTful API, that uses an HTTP protocol for communication. HTTP GET, POST, PUT and DELETE methods are used to access the API resources.
+
+## Requests and responses
+
+### Request endpoint
+All API requests have to be sent to this URL:
+```
+https://api.printful.com/
+```
+If you are using a proxy, make sure that all requests have host header set to **api.printful.com**.
+
+### Request parameters
+Some mandatory parameters (like object identifiers) must be included in the request URL path
+```
+GET /orders/123
+```
+Additional parameters can be passed as GET variables:
+```
+GET /orders?offset=10&limit=5
+```
+For POST and PUT requests, a more complex data structure can be passed as JSON encoded data in the request body:
+```
+POST /orders
+
+{\"recipient\":{...},\"items\":[...]}
+```
+
+### Response body
+The response body is always a JSON object that contains a response status code (identical to the HTTP status code) and the result of the action. If the status code is 200, then the action was successful.
+```
+{
+   \"code\": 200, //Response status code
+   \"result\":{
+      //API method return data
+   //...
+   }
+}
+```
+
+Sometimes the response includes paging information to allow to browse larger result sets by adding offset and limit GET parameters to the request URL.
+```
+{
+   \"code\": 200, //Response status code
+   \"result\":[
+    {
+       //Item 11
+    },
+    {
+       //Item 12
+    }
+   ]
+   \"paging\": {
+      \"total\": 12,  //Total items available
+      \"offset\": 10, //Items skipped from the beginning
+      \"limit\": 20   //Number of items per page
+   }
+}
+```
+
+## Error response
+If the API call is not successful, then the response code is not in the 2xx range and the `result` attribute contains an error description.
+```
+{
+    \"code\": 404,
+    \"result\": \"Not Found\",
+    \"error\": {
+        \"reason\": \"NotFound\",
+        \"message\": \"Not Found\"
+    }
+}
+```
+
+In general, response codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, etc.), and codes in the 5xx range indicate an error with Printful's servers.
+
+### Timestamps
+All timestamps from the API are returned as integers in UNIX timestamp format.
+
+### Rate Limits
+Printful API has a general rate limit of 120 API calls per minute. Additionally, endpoints that perform resource intensive operations (such as mockup generator) have a lower allowed request limit.
+
+# Authentication
+
+<!-- ReDoc-Inject: <security-definitions> -->
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0
+- Package version: 1.0.1
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://www.printful.com/docs/support](https://www.printful.com/docs/support)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build printful_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./printful_client-1.0.1.gem
+```
+
+(for development, run `gem install --dev ./printful_client-1.0.1.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'printful_client', '~> 1.0.1'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'printful_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'printful_client'
+
+api_instance = Printful::ApprovalSheetsAPIClient.new
+confirm_hash = 'a14e51714be01f98487fcf5131727d31' # String | The confirm hash for the approval sheet you would like to approve.
+approval_sheet = Printful::ApprovalSheet.new({status: 'approved'}) # ApprovalSheet | 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
+  #Approve a design
+  result = api_instance.approve_design(confirm_hash, approval_sheet, opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Exception when calling ApprovalSheetsAPIClient->approve_design: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.printful.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Printful::ApprovalSheetsAPIClient* | [**approve_design**](docs/ApprovalSheetsAPIClient.md#approve_design) | **POST** /approval-sheets | Approve a design
+*Printful::ApprovalSheetsAPIClient* | [**get_approval_sheets**](docs/ApprovalSheetsAPIClient.md#get_approval_sheets) | **GET** /approval-sheets | Retrieve a list of approval sheets
+*Printful::ApprovalSheetsAPIClient* | [**submit_approval_sheet_changes**](docs/ApprovalSheetsAPIClient.md#submit_approval_sheet_changes) | **POST** /approval-sheets/changes | Submit changes to an approval sheet
+*Printful::CatalogAPIClient* | [**get_categories**](docs/CatalogAPIClient.md#get_categories) | **GET** /categories | Get Categories
+*Printful::CatalogAPIClient* | [**get_category_by_id**](docs/CatalogAPIClient.md#get_category_by_id) | **GET** /categories/{id} | Get Category
+*Printful::CatalogAPIClient* | [**get_product_by_id**](docs/CatalogAPIClient.md#get_product_by_id) | **GET** /products/{id} | Get Product
+*Printful::CatalogAPIClient* | [**get_product_size_guide_by_id**](docs/CatalogAPIClient.md#get_product_size_guide_by_id) | **GET** /products/{id}/sizes | Get Product Size Guide
+*Printful::CatalogAPIClient* | [**get_products**](docs/CatalogAPIClient.md#get_products) | **GET** /products | Get Products
+*Printful::CatalogAPIClient* | [**get_variant_by_id**](docs/CatalogAPIClient.md#get_variant_by_id) | **GET** /products/variant/{id} | Get Variant
+*Printful::CountryStateCodeAPIClient* | [**get_countries**](docs/CountryStateCodeAPIClient.md#get_countries) | **GET** /countries | Retrieve country list
+*Printful::EcommercePlatformSyncAPIClient* | [**delete_store_sync_product**](docs/EcommercePlatformSyncAPIClient.md#delete_store_sync_product) | **DELETE** /sync/products/{id} | Delete a Sync Product
+*Printful::EcommercePlatformSyncAPIClient* | [**delete_store_sync_variant**](docs/EcommercePlatformSyncAPIClient.md#delete_store_sync_variant) | **DELETE** /sync/variant/{id} | Delete a Sync Variant
+*Printful::EcommercePlatformSyncAPIClient* | [**get_store_sync_product_by_id**](docs/EcommercePlatformSyncAPIClient.md#get_store_sync_product_by_id) | **GET** /sync/products/{id} | Get a Sync Product
+*Printful::EcommercePlatformSyncAPIClient* | [**get_store_sync_products**](docs/EcommercePlatformSyncAPIClient.md#get_store_sync_products) | **GET** /sync/products | Get list of Sync Products
+*Printful::EcommercePlatformSyncAPIClient* | [**get_store_sync_variant_by_id**](docs/EcommercePlatformSyncAPIClient.md#get_store_sync_variant_by_id) | **GET** /sync/variant/{id} | Get a Sync Variant
+*Printful::EcommercePlatformSyncAPIClient* | [**update_store_sync_variant**](docs/EcommercePlatformSyncAPIClient.md#update_store_sync_variant) | **PUT** /sync/variant/{id} | Modify a Sync Variant
+*Printful::FileLibraryAPIClient* | [**add_file**](docs/FileLibraryAPIClient.md#add_file) | **POST** /files | Add a new file
+*Printful::FileLibraryAPIClient* | [**get_file**](docs/FileLibraryAPIClient.md#get_file) | **GET** /files/{id} | Get file
+*Printful::FileLibraryAPIClient* | [**thread_colors**](docs/FileLibraryAPIClient.md#thread_colors) | **POST** /files/thread-colors | Return available thread colors from provided image URL
+*Printful::MockupGeneratorAPIClient* | [**create_generator_task**](docs/MockupGeneratorAPIClient.md#create_generator_task) | **POST** /mockup-generator/create-task/{id} | Create a mockup generation task
+*Printful::MockupGeneratorAPIClient* | [**get_printfiles**](docs/MockupGeneratorAPIClient.md#get_printfiles) | **GET** /mockup-generator/printfiles/{id} | Retrieve product variant printfiles
+*Printful::MockupGeneratorAPIClient* | [**get_task**](docs/MockupGeneratorAPIClient.md#get_task) | **GET** /mockup-generator/task | Mockup generation task result
+*Printful::MockupGeneratorAPIClient* | [**get_templates**](docs/MockupGeneratorAPIClient.md#get_templates) | **GET** /mockup-generator/templates/{id} | Layout templates
+*Printful::OAuthAPIClient* | [**get_scopes**](docs/OAuthAPIClient.md#get_scopes) | **GET** /oauth/scopes | Get scopes for token
+*Printful::OrdersAPIClient* | [**cancel_order_by_id**](docs/OrdersAPIClient.md#cancel_order_by_id) | **DELETE** /orders/{id} | Cancel an order
+*Printful::OrdersAPIClient* | [**confirm_order_by_id**](docs/OrdersAPIClient.md#confirm_order_by_id) | **POST** /orders/{id}/confirm | Confirm draft for fulfillment
+*Printful::OrdersAPIClient* | [**create_order**](docs/OrdersAPIClient.md#create_order) | **POST** /orders | Create a new order
+*Printful::OrdersAPIClient* | [**estimate_order_costs**](docs/OrdersAPIClient.md#estimate_order_costs) | **POST** /orders/estimate-costs | Estimate order costs
+*Printful::OrdersAPIClient* | [**get_order_by_id**](docs/OrdersAPIClient.md#get_order_by_id) | **GET** /orders/{id} | Get order data
+*Printful::OrdersAPIClient* | [**get_orders**](docs/OrdersAPIClient.md#get_orders) | **GET** /orders | Get list of orders
+*Printful::OrdersAPIClient* | [**update_order_by_id**](docs/OrdersAPIClient.md#update_order_by_id) | **PUT** /orders/{id} | Update order data
+*Printful::ProductTemplatesAPIClient* | [**delete_product_template**](docs/ProductTemplatesAPIClient.md#delete_product_template) | **DELETE** /product-templates/{id} | Delete product template
+*Printful::ProductTemplatesAPIClient* | [**get_product_template_by_id**](docs/ProductTemplatesAPIClient.md#get_product_template_by_id) | **GET** /product-templates/{id} | Get product template
+*Printful::ProductTemplatesAPIClient* | [**get_product_templates**](docs/ProductTemplatesAPIClient.md#get_product_templates) | **GET** /product-templates | Get product template list
+*Printful::ProductsAPIClient* | [**create_sync_product**](docs/ProductsAPIClient.md#create_sync_product) | **POST** /store/products | Create a new Sync Product
+*Printful::ProductsAPIClient* | [**create_sync_variant**](docs/ProductsAPIClient.md#create_sync_variant) | **POST** /store/products/{id}/variants | Create a new Sync Variant
+*Printful::ProductsAPIClient* | [**delete_sync_product**](docs/ProductsAPIClient.md#delete_sync_product) | **DELETE** /store/products/{id} | Delete a Sync Product
+*Printful::ProductsAPIClient* | [**delete_sync_variant**](docs/ProductsAPIClient.md#delete_sync_variant) | **DELETE** /store/variants/{id} | Delete a Sync Variant
+*Printful::ProductsAPIClient* | [**get_sync_product_by_id**](docs/ProductsAPIClient.md#get_sync_product_by_id) | **GET** /store/products/{id} | Get a Sync Product
+*Printful::ProductsAPIClient* | [**get_sync_products**](docs/ProductsAPIClient.md#get_sync_products) | **GET** /store/products | Get Sync Products
+*Printful::ProductsAPIClient* | [**get_sync_variant_by_id**](docs/ProductsAPIClient.md#get_sync_variant_by_id) | **GET** /store/variants/{id} | Get a Sync Variant
+*Printful::ProductsAPIClient* | [**update_sync_product**](docs/ProductsAPIClient.md#update_sync_product) | **PUT** /store/products/{id} | Modify a Sync Product
+*Printful::ProductsAPIClient* | [**update_sync_variant**](docs/ProductsAPIClient.md#update_sync_variant) | **PUT** /store/variants/{id} | Modify a Sync Variant
+*Printful::ReportsAPIClient* | [**get_statistics**](docs/ReportsAPIClient.md#get_statistics) | **GET** /reports/statistics | Get statistics
+*Printful::ShippingRateAPIClient* | [**calculate_shipping_rates**](docs/ShippingRateAPIClient.md#calculate_shipping_rates) | **POST** /shipping/rates | Calculate shipping rates
+*Printful::StoreInformationAPIClient* | [**change_packing_slip**](docs/StoreInformationAPIClient.md#change_packing_slip) | **POST** /store/packing-slip | Change packing slip
+*Printful::StoreInformationAPIClient* | [**get_store**](docs/StoreInformationAPIClient.md#get_store) | **GET** /stores/{id} | Get basic information about a store
+*Printful::StoreInformationAPIClient* | [**get_stores**](docs/StoreInformationAPIClient.md#get_stores) | **GET** /stores | Get basic information about stores
+*Printful::TaxRateAPIClient* | [**calculate_tax_rates**](docs/TaxRateAPIClient.md#calculate_tax_rates) | **POST** /tax/rates | Calculate tax rate
+*Printful::TaxRateAPIClient* | [**get_tax_countries**](docs/TaxRateAPIClient.md#get_tax_countries) | **GET** /tax/countries | Get a list of countries for tax calculation
+*Printful::WarehouseProductsAPIClient* | [**get_warehouse_product**](docs/WarehouseProductsAPIClient.md#get_warehouse_product) | **GET** /warehouse/products/{id} | Get warehouse product data
+*Printful::WarehouseProductsAPIClient* | [**get_warehouse_products**](docs/WarehouseProductsAPIClient.md#get_warehouse_products) | **GET** /warehouse/products | Get a list of your warehouse products
+*Printful::WebhookAPIClient* | [**create_webhook**](docs/WebhookAPIClient.md#create_webhook) | **POST** /webhooks | Set up webhook configuration
+*Printful::WebhookAPIClient* | [**disable_webhook**](docs/WebhookAPIClient.md#disable_webhook) | **DELETE** /webhooks | Disable webhook support
+*Printful::WebhookAPIClient* | [**get_webhooks**](docs/WebhookAPIClient.md#get_webhooks) | **GET** /webhooks | Get webhook configuration
+
+
+## Documentation for Models
+
+ - [Printful::AddFile200Response](docs/AddFile200Response.md)
+ - [Printful::Address](docs/Address.md)
+ - [Printful::AddressInfo](docs/AddressInfo.md)
+ - [Printful::ApprovalSheet](docs/ApprovalSheet.md)
+ - [Printful::ApprovalSheetChanges](docs/ApprovalSheetChanges.md)
+ - [Printful::ApprovalSheetChangesFilesInner](docs/ApprovalSheetChangesFilesInner.md)
+ - [Printful::ApprovalSheetWebhookFile](docs/ApprovalSheetWebhookFile.md)
+ - [Printful::ApproveDesign200Response](docs/ApproveDesign200Response.md)
+ - [Printful::ApproveDesign200ResponseAllOfResult](docs/ApproveDesign200ResponseAllOfResult.md)
+ - [Printful::AvailabilityStatus](docs/AvailabilityStatus.md)
+ - [Printful::AvailableTechnique](docs/AvailableTechnique.md)
+ - [Printful::AverageFulfillmentTime](docs/AverageFulfillmentTime.md)
+ - [Printful::CalculateShippingRates](docs/CalculateShippingRates.md)
+ - [Printful::CalculateShippingRates200Response](docs/CalculateShippingRates200Response.md)
+ - [Printful::CalculateTaxRates200Response](docs/CalculateTaxRates200Response.md)
+ - [Printful::CatalogFileOption](docs/CatalogFileOption.md)
+ - [Printful::Category](docs/Category.md)
+ - [Printful::ChangePackingSlip200Response](docs/ChangePackingSlip200Response.md)
+ - [Printful::ChangePackingSlip200ResponseResult](docs/ChangePackingSlip200ResponseResult.md)
+ - [Printful::Costs](docs/Costs.md)
+ - [Printful::CostsByAmountInner](docs/CostsByAmountInner.md)
+ - [Printful::CostsByProductInner](docs/CostsByProductInner.md)
+ - [Printful::CostsByVariantInner](docs/CostsByVariantInner.md)
+ - [Printful::Country](docs/Country.md)
+ - [Printful::CreateGenerationTask](docs/CreateGenerationTask.md)
+ - [Printful::CreateGeneratorTask200Response](docs/CreateGeneratorTask200Response.md)
+ - [Printful::CreateOrder200Response](docs/CreateOrder200Response.md)
+ - [Printful::CreateSyncProduct200Response](docs/CreateSyncProduct200Response.md)
+ - [Printful::CreateSyncProduct400Response](docs/CreateSyncProduct400Response.md)
+ - [Printful::CreateSyncProduct400ResponseError](docs/CreateSyncProduct400ResponseError.md)
+ - [Printful::CreateWebhookRequest](docs/CreateWebhookRequest.md)
+ - [Printful::DeleteProductTemplate200Response](docs/DeleteProductTemplate200Response.md)
+ - [Printful::DeleteProductTemplate200ResponseAllOfResult](docs/DeleteProductTemplate200ResponseAllOfResult.md)
+ - [Printful::DeleteSyncVariant200Response](docs/DeleteSyncVariant200Response.md)
+ - [Printful::EstimateOrderCosts200Response](docs/EstimateOrderCosts200Response.md)
+ - [Printful::EstimateOrderCosts200ResponseAllOfResult](docs/EstimateOrderCosts200ResponseAllOfResult.md)
+ - [Printful::File](docs/File.md)
+ - [Printful::FileOption](docs/FileOption.md)
+ - [Printful::FileType](docs/FileType.md)
+ - [Printful::GenerationTask](docs/GenerationTask.md)
+ - [Printful::GenerationTaskExtraMockup](docs/GenerationTaskExtraMockup.md)
+ - [Printful::GenerationTaskFile](docs/GenerationTaskFile.md)
+ - [Printful::GenerationTaskFilePosition](docs/GenerationTaskFilePosition.md)
+ - [Printful::GenerationTaskMockup](docs/GenerationTaskMockup.md)
+ - [Printful::GenerationTaskTemplateFile](docs/GenerationTaskTemplateFile.md)
+ - [Printful::GetApprovalSheets200Response](docs/GetApprovalSheets200Response.md)
+ - [Printful::GetCategories200Response](docs/GetCategories200Response.md)
+ - [Printful::GetCategoryById200Response](docs/GetCategoryById200Response.md)
+ - [Printful::GetCountries200Response](docs/GetCountries200Response.md)
+ - [Printful::GetOrderByIdIdParameter](docs/GetOrderByIdIdParameter.md)
+ - [Printful::GetOrders200Response](docs/GetOrders200Response.md)
+ - [Printful::GetPrintfiles200Response](docs/GetPrintfiles200Response.md)
+ - [Printful::GetProductById200Response](docs/GetProductById200Response.md)
+ - [Printful::GetProductSizeGuideById200Response](docs/GetProductSizeGuideById200Response.md)
+ - [Printful::GetProductSizeGuideById404Response](docs/GetProductSizeGuideById404Response.md)
+ - [Printful::GetProductSizeGuideById404ResponseError](docs/GetProductSizeGuideById404ResponseError.md)
+ - [Printful::GetProductTemplateById200Response](docs/GetProductTemplateById200Response.md)
+ - [Printful::GetProductTemplates200Response](docs/GetProductTemplates200Response.md)
+ - [Printful::GetProducts200Response](docs/GetProducts200Response.md)
+ - [Printful::GetProducts401Response](docs/GetProducts401Response.md)
+ - [Printful::GetProducts401ResponseError](docs/GetProducts401ResponseError.md)
+ - [Printful::GetScopes200Response](docs/GetScopes200Response.md)
+ - [Printful::GetScopes200ResponseAllOfResult](docs/GetScopes200ResponseAllOfResult.md)
+ - [Printful::GetScopes200ResponseAllOfResultScopesInner](docs/GetScopes200ResponseAllOfResultScopesInner.md)
+ - [Printful::GetStatistics200Response](docs/GetStatistics200Response.md)
+ - [Printful::GetStore200Response](docs/GetStore200Response.md)
+ - [Printful::GetStoreSyncVariantById200Response](docs/GetStoreSyncVariantById200Response.md)
+ - [Printful::GetStores200Response](docs/GetStores200Response.md)
+ - [Printful::GetStores403Response](docs/GetStores403Response.md)
+ - [Printful::GetStores403ResponseError](docs/GetStores403ResponseError.md)
+ - [Printful::GetSyncProductById200Response](docs/GetSyncProductById200Response.md)
+ - [Printful::GetSyncProductByIdIdParameter](docs/GetSyncProductByIdIdParameter.md)
+ - [Printful::GetSyncProducts200Response](docs/GetSyncProducts200Response.md)
+ - [Printful::GetSyncVariantById200Response](docs/GetSyncVariantById200Response.md)
+ - [Printful::GetTaxCountries200Response](docs/GetTaxCountries200Response.md)
+ - [Printful::GetTaxCountries200ResponseResultInner](docs/GetTaxCountries200ResponseResultInner.md)
+ - [Printful::GetTaxCountries200ResponseResultInnerAllOfStatesInner](docs/GetTaxCountries200ResponseResultInnerAllOfStatesInner.md)
+ - [Printful::GetTemplates200Response](docs/GetTemplates200Response.md)
+ - [Printful::GetVariantById200Response](docs/GetVariantById200Response.md)
+ - [Printful::GetWarehouseProduct200Response](docs/GetWarehouseProduct200Response.md)
+ - [Printful::GetWarehouseProducts200Response](docs/GetWarehouseProducts200Response.md)
+ - [Printful::GetWebhooks200Response](docs/GetWebhooks200Response.md)
+ - [Printful::Gift](docs/Gift.md)
+ - [Printful::IncompleteItem](docs/IncompleteItem.md)
+ - [Printful::Item](docs/Item.md)
+ - [Printful::ItemFilesInner](docs/ItemFilesInner.md)
+ - [Printful::ItemFilesInnerAllOfPosition](docs/ItemFilesInnerAllOfPosition.md)
+ - [Printful::ItemInfo](docs/ItemInfo.md)
+ - [Printful::ItemOption](docs/ItemOption.md)
+ - [Printful::Material](docs/Material.md)
+ - [Printful::Measurement](docs/Measurement.md)
+ - [Printful::MeasurementValue](docs/MeasurementValue.md)
+ - [Printful::Option](docs/Option.md)
+ - [Printful::OptionType](docs/OptionType.md)
+ - [Printful::Order](docs/Order.md)
+ - [Printful::OrderCosts](docs/OrderCosts.md)
+ - [Printful::OrderEstimateCosts](docs/OrderEstimateCosts.md)
+ - [Printful::OrderEstimateRetailCosts](docs/OrderEstimateRetailCosts.md)
+ - [Printful::OrderEvent](docs/OrderEvent.md)
+ - [Printful::OrderShipmentItem](docs/OrderShipmentItem.md)
+ - [Printful::PackingSlip](docs/PackingSlip.md)
+ - [Printful::Paging](docs/Paging.md)
+ - [Printful::PricingBreakdown](docs/PricingBreakdown.md)
+ - [Printful::Printfile](docs/Printfile.md)
+ - [Printful::PrintfileInfo](docs/PrintfileInfo.md)
+ - [Printful::PrintfulCosts](docs/PrintfulCosts.md)
+ - [Printful::Product](docs/Product.md)
+ - [Printful::Product1](docs/Product1.md)
+ - [Printful::Product1SyncVariantsInner](docs/Product1SyncVariantsInner.md)
+ - [Printful::ProductInfo](docs/ProductInfo.md)
+ - [Printful::ProductSizeGuide](docs/ProductSizeGuide.md)
+ - [Printful::ProductTemplate](docs/ProductTemplate.md)
+ - [Printful::ProductVariant](docs/ProductVariant.md)
+ - [Printful::Profit](docs/Profit.md)
+ - [Printful::Response200](docs/Response200.md)
+ - [Printful::Response200Paginated](docs/Response200Paginated.md)
+ - [Printful::RetailCosts](docs/RetailCosts.md)
+ - [Printful::SalesAndCostsInner](docs/SalesAndCostsInner.md)
+ - [Printful::SalesAndCostsSummaryInner](docs/SalesAndCostsSummaryInner.md)
+ - [Printful::Shipment](docs/Shipment.md)
+ - [Printful::ShippingInfo](docs/ShippingInfo.md)
+ - [Printful::SizeTable](docs/SizeTable.md)
+ - [Printful::State](docs/State.md)
+ - [Printful::Statistics](docs/Statistics.md)
+ - [Printful::Store](docs/Store.md)
+ - [Printful::StoreStatistics](docs/StoreStatistics.md)
+ - [Printful::SubmitApprovalSheetChanges200Response](docs/SubmitApprovalSheetChanges200Response.md)
+ - [Printful::SyncProduct](docs/SyncProduct.md)
+ - [Printful::SyncProductDeleted](docs/SyncProductDeleted.md)
+ - [Printful::SyncProductEvent](docs/SyncProductEvent.md)
+ - [Printful::SyncProductInfo](docs/SyncProductInfo.md)
+ - [Printful::SyncVariant](docs/SyncVariant.md)
+ - [Printful::SyncVariantInfo](docs/SyncVariantInfo.md)
+ - [Printful::SyncVariantProduct](docs/SyncVariantProduct.md)
+ - [Printful::TaxAddressInfo](docs/TaxAddressInfo.md)
+ - [Printful::TaxInfo](docs/TaxInfo.md)
+ - [Printful::TaxRequest](docs/TaxRequest.md)
+ - [Printful::Template](docs/Template.md)
+ - [Printful::TemplateById](docs/TemplateById.md)
+ - [Printful::TemplateByIdColorsInner](docs/TemplateByIdColorsInner.md)
+ - [Printful::TemplateByIdOptionDataInner](docs/TemplateByIdOptionDataInner.md)
+ - [Printful::TemplateByIdPlacementOptionDataInner](docs/TemplateByIdPlacementOptionDataInner.md)
+ - [Printful::TemplateByIdPlacementOptionDataInnerOptionsInner](docs/TemplateByIdPlacementOptionDataInnerOptionsInner.md)
+ - [Printful::TemplateByIdPlacementsInner](docs/TemplateByIdPlacementsInner.md)
+ - [Printful::TemplatePlacementConflict](docs/TemplatePlacementConflict.md)
+ - [Printful::TemplateVariantMapping](docs/TemplateVariantMapping.md)
+ - [Printful::TemplateVariantMappingItem](docs/TemplateVariantMappingItem.md)
+ - [Printful::Templates](docs/Templates.md)
+ - [Printful::ThreadColors200Response](docs/ThreadColors200Response.md)
+ - [Printful::ThreadColorsRequest](docs/ThreadColorsRequest.md)
+ - [Printful::TotalPaidOrders](docs/TotalPaidOrders.md)
+ - [Printful::UpdateSyncProductRequest](docs/UpdateSyncProductRequest.md)
+ - [Printful::UpdateSyncProductRequestSyncVariantsInner](docs/UpdateSyncProductRequestSyncVariantsInner.md)
+ - [Printful::UpdateSyncVariantRequest](docs/UpdateSyncVariantRequest.md)
+ - [Printful::Variant](docs/Variant.md)
+ - [Printful::VariantInfo](docs/VariantInfo.md)
+ - [Printful::VariantPrintfile](docs/VariantPrintfile.md)
+ - [Printful::WarehouseProduct](docs/WarehouseProduct.md)
+ - [Printful::WarehouseProductVariant](docs/WarehouseProductVariant.md)
+ - [Printful::Webhook](docs/Webhook.md)
+ - [Printful::WebhookInfo](docs/WebhookInfo.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### OAuth
+
+
+- **Type**: OAuth
+- **Flow**: accessCode
+- **Authorization URL**: https://www.printful.com/oauth/token
+- **Scopes**: 
+  - orders: Read and Write access to Orders
+  - orders/read: Read access to Orders
+  - stores_list: Read and Write access to Stores
+  - stores_list/read: Read access to Stores
+  - sync_products: Read and Write access to SyncProducts
+  - sync_products/read: Read access to SyncProducts
+  - file_library: Read and Write access to File library
+  - file_library/read: Read access to File library
+  - webhooks: Read and Write access to Webhooks
+  - webhooks/read: Read access to Webhooks
+

data/docs/ReportsAPIClient.md

@@ -0,0 +1,87 @@
+# Printful::ReportsAPIClient
+
+All URIs are relative to *https://api.printful.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_statistics**](ReportsAPIClient.md#get_statistics) | **GET** /reports/statistics | Get statistics |
+
+
+## get_statistics
+
+> <GetStatistics200Response> get_statistics(date_from, date_to, report_types, opts)
+
+Get statistics
+
+Returns statistics for specified report types.  You need to specify the report types you want to retrieve in the `report_types` query parameter as a comma-separated list, e.g. `report_types=sales_and_costs,profit`.  **Note**: You cannot get statistics for a period longer than 6 months.  #### Example  To get statistics in the default currency of a store for `sales_and_costs` and `profit` reports for August 2022, you can use the following URL: https://api.printful.com/reports/statistics?report_types=sales_and_costs,profit&date_from=2022-08-01&date_to=2022-08-31.  ### Report types  Currently, the following report types are available:  | Report type                | Description                                              | |----------------------------|----------------------------------------------------------| | `sales_and_costs`          | Detailed information on sales and costs grouped by date. | | `sales_and_costs_summary`  | Short information on sales and costs grouped by date.    | | `printful_costs`           | Amount paid to Printful for fulfillment and shipping.    | | `profit`                   | Profit in the specified period.                          | | `total_paid_orders`        | The number of paid orders in the specified period.       | | `costs_by_amount`          | Information on costs by amount grouped by date.          | | `costs_by_product`         | Information on costs grouped by product.                 | | `costs_by_variant`         | Information on costs grouped by variant.                 | | `average_fulfillment_time` | Average time it took Printful to fulfill Your orders.    |  The response structure for the specific reports is documented in the response schema (`result.store_statistics.[reportName]`). 
+
+### 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::ReportsAPIClient.new
+date_from = Date.parse('Mon Aug 01 00:00:00 UTC 2022') # Date | The beginning of the period to get the statistics from (date in `Y-m-d` format).
+date_to = Date.parse('Wed Aug 31 00:00:00 UTC 2022') # Date | The end of the period to get the statistics from (date in `Y-m-d` format).
+report_types = 'sales_and_costs,profit' # String | A comma-separated list of report types to be retrieved.
+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)
+  currency: 'USD' # String | The currency (3-letter code) to return the statistics in. You can also specify `display_currency` as the value to get the statistics in the account's display currency. The store currency will be used by default.
+}
+
+begin
+  # Get statistics
+  result = api_instance.get_statistics(date_from, date_to, report_types, opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling ReportsAPIClient->get_statistics: #{e}"
+end
+```
+
+#### Using the get_statistics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetStatistics200Response>, Integer, Hash)> get_statistics_with_http_info(date_from, date_to, report_types, opts)
+
+```ruby
+begin
+  # Get statistics
+  data, status_code, headers = api_instance.get_statistics_with_http_info(date_from, date_to, report_types, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetStatistics200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling ReportsAPIClient->get_statistics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date_from** | **Date** | The beginning of the period to get the statistics from (date in &#x60;Y-m-d&#x60; format). |  |
+| **date_to** | **Date** | The end of the period to get the statistics from (date in &#x60;Y-m-d&#x60; format). |  |
+| **report_types** | **String** | A comma-separated list of report types to be retrieved. |  |
+| **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
+| **currency** | **String** | The currency (3-letter code) to return the statistics in. You can also specify &#x60;display_currency&#x60; as the value to get the statistics in the account&#39;s display currency. The store currency will be used by default. | [optional] |
+
+### Return type
+
+[**GetStatistics200Response**](GetStatistics200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Response200.md

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

data/docs/Response200Paginated.md

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

data/docs/RetailCosts.md

@@ -0,0 +1,30 @@
+# Printful::RetailCosts
+
+## 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] |
+| **tax** | **String** | Sum of taxes (not included in the item price) | [optional] |
+| **vat** | **String** | Sum of VAT (not included in the item price) | [optional][readonly] |
+| **total** | **String** | Grand Total (subtotal-discount+tax+vat+shipping) | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::RetailCosts.new(
+  currency: USD,
+  subtotal: 10.00,
+  discount: 0.00,
+  shipping: 5.00,
+  tax: 0.00,
+  vat: 0.00,
+  total: 15.00
+)
+```
+

data/docs/SalesAndCostsInner.md

@@ -0,0 +1,32 @@
+# Printful::SalesAndCostsInner
+
+## 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] |
+| **sales** | **Float** | Order retail price data. Available only if retail price fields are properly set up on the integration's side | [optional] |
+| **fulfillment** | **Float** | Product fulfillment, digitization, branding, shipping costs and taxes that are charged by Printful | [optional] |
+| **profit** | **Float** | The difference between Sales and Fulfillment. If retail price data is not available, profit might be negative | [optional] |
+| **sales_discount** | **Float** | Any retail price discounts set up on the integration's side | [optional] |
+| **fulfillment_discount** | **Float** | Any fulfillment discounts (such as the monthly discount) set up on Printful's side | [optional] |
+| **sales_shipping** | **Float** | The retail shipping price that was paid by the buyer | [optional] |
+| **fulfillment_shipping** | **Float** | Shipping costs that were charged by Printful | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::SalesAndCostsInner.new(
+  date: null,
+  sales: null,
+  fulfillment: null,
+  profit: null,
+  sales_discount: null,
+  fulfillment_discount: null,
+  sales_shipping: null,
+  fulfillment_shipping: null
+)
+```
+

data/docs/SalesAndCostsSummaryInner.md

@@ -0,0 +1,24 @@
+# Printful::SalesAndCostsSummaryInner
+
+## 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] |
+| **order_count** | **Float** | The order count in the aggregation period | [optional] |
+| **costs** | **Float** | Product fulfillment, digitization, branding, shipping costs and taxes that are charged by Printful | [optional] |
+| **profit** | **Float** | The difference between Sales and Fulfillment. If retail price data is not available, profit might be negative | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::SalesAndCostsSummaryInner.new(
+  date: null,
+  order_count: null,
+  costs: null,
+  profit: null
+)
+```
+