printful_client 1.0.1

data/docs/UpdateSyncVariantRequest.md

@@ -0,0 +1,46 @@
+# Printful::UpdateSyncVariantRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Sync Variant ID. Please specify the IDs of all Sync Variants you wish to keep. | [optional] |
+| **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::UpdateSyncVariantRequest.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/Variant.md

@@ -0,0 +1,42 @@
+# Printful::Variant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Variant ID, use this to specify the product when creating orders | [optional] |
+| **product_id** | **Integer** | ID of the product that this variant belongs to | [optional] |
+| **name** | **String** | Display name | [optional] |
+| **size** | **String** | Item size | [optional] |
+| **color** | **String** | Item color | [optional] |
+| **color_code** | **String** | Hexadecimal RGB color code. May not exactly reflect the real-world color | [optional] |
+| **color_code2** | **String** | Secondary hexadecimal RGB color code. May not exactly reflect the real-world color | [optional] |
+| **image** | **String** | URL of a preview image for this variant | [optional] |
+| **price** | **String** | Variant's price (can change depending on print files and optional settings) | [optional] |
+| **in_stock** | **Boolean** | Stock availability of this variant | [optional] |
+| **availability_regions** | **Hash<String, Object>** | Map of [region code, region name] of regions where the variant is available for fulfillment | [optional] |
+| **availability_status** | [**Array<AvailabilityStatus>**](AvailabilityStatus.md) | Detailed stock status per region | [optional] |
+| **material** | [**Array<Material>**](Material.md) | A list of materials this Variant is composed of | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Variant.new(
+  id: 100,
+  product_id: 12,
+  name: Gildan 64000 Unisex Softstyle T-Shirt with Tear Away (Black / 2XL),
+  size: 2XL,
+  color: Black,
+  color_code: #14191e,
+  color_code2: null,
+  image: https://files.cdn.printful.com/products/12/629_1517916489.jpg,
+  price: 9.85,
+  in_stock: true,
+  availability_regions: {"US":"USA","EU":"Europe"},
+  availability_status: null,
+  material: null
+)
+```
+

data/docs/VariantInfo.md

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

data/docs/VariantPrintfile.md

@@ -0,0 +1,20 @@
+# Printful::VariantPrintfile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **variant_id** | **Integer** |  | [optional] |
+| **placements** | **Object** | A key-value object mapping placement identifiers to printfile IDs. | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::VariantPrintfile.new(
+  variant_id: 4012,
+  placements: {"front":1,"back":1,"label_outside":1}
+)
+```
+

data/docs/WarehouseProduct.md

@@ -0,0 +1,30 @@
+# Printful::WarehouseProduct
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Product ID | [optional] |
+| **name** | **String** | Product name | [optional] |
+| **status** | **String** | Product status:   **created** - product request created,   **active** - product request approved   **suspended** - product suspended   **declined** - product request declined   **draft** - product created as a draft | [optional] |
+| **currency** | **String** | Currency | [optional] |
+| **image_url** | **String** | Image URL of product | [optional] |
+| **retail_price** | **Float** | Retail price of product | [optional] |
+| **variants** | [**Array<WarehouseProductVariant>**](WarehouseProductVariant.md) | Array of product variants | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::WarehouseProduct.new(
+  id: 12,
+  name: Some product name,
+  status: draft,
+  currency: USD,
+  image_url: url.to/your/image/location.png,
+  retail_price: 12.99,
+  variants: null
+)
+```
+

data/docs/WarehouseProductVariant.md

@@ -0,0 +1,36 @@
+# Printful::WarehouseProductVariant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Product variant ID | [optional] |
+| **name** | **String** | Name of product variant | [optional] |
+| **sku** | **String** | SKU of product variant | [optional] |
+| **image_url** | **String** | Image URL of product variant | [optional] |
+| **retail_price** | **Float** | Retail price of product variant | [optional] |
+| **quantity** | **Integer** | Quantity of product variant in our stock | [optional] |
+| **length** | **Float** | Length of product variant | [optional] |
+| **width** | **Float** | Width of product variant | [optional] |
+| **height** | **Float** | Height of product variant | [optional] |
+| **weight** | **Float** | Weight of product variant | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::WarehouseProductVariant.new(
+  id: 12,
+  name: SomeName,
+  sku: some-sku-12,
+  image_url: url.to/image/variant.png,
+  retail_price: 1.1,
+  quantity: 10,
+  length: 3.21,
+  width: 2.13,
+  height: 3.11,
+  weight: 1.11
+)
+```
+

data/docs/WarehouseProductsAPIClient.md

@@ -0,0 +1,159 @@
+# Printful::WarehouseProductsAPIClient
+
+All URIs are relative to *https://api.printful.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_warehouse_product**](WarehouseProductsAPIClient.md#get_warehouse_product) | **GET** /warehouse/products/{id} | Get warehouse product data |
+| [**get_warehouse_products**](WarehouseProductsAPIClient.md#get_warehouse_products) | **GET** /warehouse/products | Get a list of your warehouse products |
+
+
+## get_warehouse_product
+
+> <GetWarehouseProduct200Response> get_warehouse_product(id, opts)
+
+Get warehouse product data
+
+Returns warehouse product data by 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::WarehouseProductsAPIClient.new
+id = nil # GetSyncProductByIdIdParameter | Product 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 warehouse product data
+  result = api_instance.get_warehouse_product(id, opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling WarehouseProductsAPIClient->get_warehouse_product: #{e}"
+end
+```
+
+#### Using the get_warehouse_product_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetWarehouseProduct200Response>, Integer, Hash)> get_warehouse_product_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get warehouse product data
+  data, status_code, headers = api_instance.get_warehouse_product_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetWarehouseProduct200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling WarehouseProductsAPIClient->get_warehouse_product_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | [**GetSyncProductByIdIdParameter**](.md) | Product 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
+
+[**GetWarehouseProduct200Response**](GetWarehouseProduct200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_warehouse_products
+
+> <GetWarehouseProducts200Response> get_warehouse_products(opts)
+
+Get a list of your warehouse products
+
+Returns a list of warehouse products from your store
+
+### 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::WarehouseProductsAPIClient.new
+opts = {
+  query: 'query_example', # String | Filter by partial or full product name
+  limit: 56, # Integer | Number of items per page (max 100)
+  offset: 56, # Integer | Result set offset
+  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 a list of your warehouse products
+  result = api_instance.get_warehouse_products(opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling WarehouseProductsAPIClient->get_warehouse_products: #{e}"
+end
+```
+
+#### Using the get_warehouse_products_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetWarehouseProducts200Response>, Integer, Hash)> get_warehouse_products_with_http_info(opts)
+
+```ruby
+begin
+  # Get a list of your warehouse products
+  data, status_code, headers = api_instance.get_warehouse_products_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetWarehouseProducts200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling WarehouseProductsAPIClient->get_warehouse_products_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query** | **String** | Filter by partial or full product name | [optional] |
+| **limit** | **Integer** | Number of items per page (max 100) | [optional] |
+| **offset** | **Integer** | Result set offset | [optional] |
+| **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
+
+### Return type
+
+[**GetWarehouseProducts200Response**](GetWarehouseProducts200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Webhook.md

@@ -0,0 +1,24 @@
+# Printful::Webhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Event type | [optional] |
+| **created** | **Integer** | Event time | [optional] |
+| **retries** | **Integer** | Number of previous attempts to deliver this webhook event | [optional] |
+| **store** | **Integer** | ID of the store that the event occured to | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Webhook.new(
+  type: null,
+  created: 1622456737,
+  retries: 2,
+  store: 12
+)
+```
+

data/docs/WebhookAPIClient.md

@@ -0,0 +1,225 @@
+# Printful::WebhookAPIClient
+
+All URIs are relative to *https://api.printful.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_webhook**](WebhookAPIClient.md#create_webhook) | **POST** /webhooks | Set up webhook configuration |
+| [**disable_webhook**](WebhookAPIClient.md#disable_webhook) | **DELETE** /webhooks | Disable webhook support |
+| [**get_webhooks**](WebhookAPIClient.md#get_webhooks) | **GET** /webhooks | Get webhook configuration |
+
+
+## create_webhook
+
+> <GetWebhooks200Response> create_webhook(create_webhook_request, opts)
+
+Set up webhook configuration
+
+Use this endpoint to enable a webhook URL for a store and select webhook event types that will be sent to this URL.   Note that only one webhook URL can be active for a store, so calling this method disables all existing webhook configuration.   Setting up the [Stock updated](#operation/stockUpdated) webhook requires passing IDs for products that need to be monitored for changes. Stock update webhook will only include information for specified products. These product IDs need to be set up using the params property.
+
+### 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::WebhookAPIClient.new
+create_webhook_request = Printful::CreateWebhookRequest.new({url: '*https://www.example.com/printful/webhook', types: ["package_shipped", "stock_updated"]}) # CreateWebhookRequest | 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
+  # Set up webhook configuration
+  result = api_instance.create_webhook(create_webhook_request, opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling WebhookAPIClient->create_webhook: #{e}"
+end
+```
+
+#### Using the create_webhook_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetWebhooks200Response>, Integer, Hash)> create_webhook_with_http_info(create_webhook_request, opts)
+
+```ruby
+begin
+  # Set up webhook configuration
+  data, status_code, headers = api_instance.create_webhook_with_http_info(create_webhook_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetWebhooks200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling WebhookAPIClient->create_webhook_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_webhook_request** | [**CreateWebhookRequest**](CreateWebhookRequest.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
+
+[**GetWebhooks200Response**](GetWebhooks200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## disable_webhook
+
+> <GetWebhooks200Response> disable_webhook(opts)
+
+Disable webhook support
+
+Removes the webhook URL and all event types from the store.
+
+### 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::WebhookAPIClient.new
+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
+  # Disable webhook support
+  result = api_instance.disable_webhook(opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling WebhookAPIClient->disable_webhook: #{e}"
+end
+```
+
+#### Using the disable_webhook_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetWebhooks200Response>, Integer, Hash)> disable_webhook_with_http_info(opts)
+
+```ruby
+begin
+  # Disable webhook support
+  data, status_code, headers = api_instance.disable_webhook_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetWebhooks200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling WebhookAPIClient->disable_webhook_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
+
+### Return type
+
+[**GetWebhooks200Response**](GetWebhooks200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_webhooks
+
+> <GetWebhooks200Response> get_webhooks(opts)
+
+Get webhook configuration
+
+Returns configured webhook URL and list of webhook event types enabled for the store
+
+### 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::WebhookAPIClient.new
+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 webhook configuration
+  result = api_instance.get_webhooks(opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling WebhookAPIClient->get_webhooks: #{e}"
+end
+```
+
+#### Using the get_webhooks_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetWebhooks200Response>, Integer, Hash)> get_webhooks_with_http_info(opts)
+
+```ruby
+begin
+  # Get webhook configuration
+  data, status_code, headers = api_instance.get_webhooks_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetWebhooks200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling WebhookAPIClient->get_webhooks_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
+
+### Return type
+
+[**GetWebhooks200Response**](GetWebhooks200Response.md)
+
+### Authorization
+
+[OAuth](../README.md#OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/WebhookInfo.md

@@ -0,0 +1,22 @@
+# Printful::WebhookInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Webhook URL that will receive store's event notifications | [optional] |
+| **types** | **Array<String>** | Array of enabled webhook event types | [optional] |
+| **params** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::WebhookInfo.new(
+  url: *https://www.example.com/printful/webhook,
+  types: ["package_shipped","stock_updated"],
+  params: {"stock_updated":{"product_ids":[5,12]}}
+)
+```
+

data/generate.sh

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+SCRIPT_DIR="$(dirname "$(realpath "$0")")"
+cd "${SCRIPT_DIR}"
+
+GENERATOR="ruby"
+OUTPUT_DIR="generated"
+
+echo "Generating API client..."
+rm -rf "${OUTPUT_DIR}"
+docker run --rm -v ${PWD}:/local \
+  openapitools/openapi-generator-cli generate \
+    --skip-validate-spec \
+    -i "/local/swagger.json" \
+    -g "${GENERATOR}" \
+    -o "/local/${OUTPUT_DIR}" \
+    --api-name-suffix 'Client' \
+    --ignore-file-override "/local/.openapi-generator-ignore" \
+    --additional-properties=gemName="printful_client" \
+    --additional-properties=gemVersion="1.0.1" \
+    --additional-properties=gemAuthor="Mindprint.ai" \
+    --additional-properties=gemAuthorEmail="tech@mindprint.ai" \
+    --additional-properties=gemSummary="A Ruby client for the [Printful.com API" \
+    --additional-properties=gemDescription="A Ruby client for the [Printful.com API](https://developers.printful.com/docs/) generated using their OpenAPI/Swagger spec and the [OpenAPI Generator](https://openapi-generator.tech/) tool." \
+    --additional-properties=gemHomepage="https://github.com/mindprintai/printful_client" \
+    --additional-properties=gemLicense="MIT" \
+    --additional-properties=moduleName="Printful"
+
+echo "Applying post-processing operations on generated files..."
+sudo chown -R "${USER}:${USER}" "${OUTPUT_DIR}"
+cd "${SCRIPT_DIR}/${OUTPUT_DIR}"
+sed -i 's#^README.md$#docs/README.md#' ".openapi-generator/FILES"
+sed -r 's#^(.*)$#\1 linguist-generated=true#' ".openapi-generator/FILES" > ".gitattributes"
+echo "swagger.json linguist-generated=true" >> ".gitattributes"
+rm -rf ".openapi-generator"
+mv "README.md" "docs/"
+
+echo "Running post-generate tests..."
+bundle install
+bundle exec rspec
+
+echo "Overwriting existing files with generator output..."
+cd "${SCRIPT_DIR}"
+for fn in $(ls "${OUTPUT_DIR}") ; do
+  if [[ -d "${OUTPUT_DIR}/${fn}" ]] ; then
+    rm -rf "${fn}"
+  fi
+
+  mv "${OUTPUT_DIR}/${fn}" "${fn}"
+done
+
+rm -rf "${OUTPUT_DIR}"