printful_client 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '057873a0ee4a4268d53bdd79ce9ec67b028ebac7c17c458c7311718cf4dadac8'
+  data.tar.gz: 46c34a64fcf9362704c448a9d65ab67ca9e8d674ae9e51a55f744d6dd5394ca7
+SHA512:
+  metadata.gz: deb9b92405853e431160a098d5adf2f344be52ae8ea3ec7753dc7fa412e0f22ced6b3ee1b2b62eabc4a593a29ecb50359f8b4b08eab4ba1025ed6e4ad41bb798
+  data.tar.gz: 233e0474acfdb5cc6b54798a4d5cee23bc4ea4b44624711915d61bf3554410337440a564a68c73676fb50e1585ea06bc8d20acca29597f83216c9a44501f9e5d

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    printful_client (1.0.1)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.5)
+    jaro_winkler (1.5.6)
+    method_source (1.0.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    psych (5.1.0)
+      stringio
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.13.0)
+    stringio (3.0.8)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  printful_client!
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Mindprint.ai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# printful-client
+
+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.
+
+## Installation
+
+To use the client as-is, add it to your project's Gemfile:
+
+```sh
+gem 'printful_client'
+```
+
+If you're not using a Gemfile, you can install the gem directly:
+
+```sh
+gem install printful_client
+```
+
+You can also build it from source:
+
+```sh
+gem build printful_client.gemspec
+```
+
+## Usage
+
+See the [README in docs/](/mindprintai/printful_client/tree/master/docs/README.md) for
+detailed usage documentation generated from the Swagger spec for this client.
+
+## Contributing
+
+### Generating a client for the latest spec
+
+1. Install Docker: https://docs.docker.com/engine/install/
+1. Open https://developers.printful.com/docs/
+1. Click the "Download" button next to "Download the OpenAPI specification"
+1. Save the downloaded file to `swagger.json` in this directory
+1. Run the following script to generate the ruby client:
+    ```sh
+    ./generate.sh
+    ```
+1. Commit all changes and open a pull request

data/docs/AddFile200Response.md

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

data/docs/Address.md

@@ -0,0 +1,42 @@
+# Printful::Address
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Full name | [optional] |
+| **company** | **String** | Company name | [optional] |
+| **address1** | **String** | Address line 1 | [optional] |
+| **address2** | **String** | Address line 2 | [optional] |
+| **city** | **String** | City | [optional] |
+| **state_code** | **String** | State code | [optional] |
+| **state_name** | **String** | State name | [optional] |
+| **country_code** | **String** | Country code | [optional] |
+| **country_name** | **String** | Country name | [optional] |
+| **zip** | **String** | ZIP/Postal code | [optional] |
+| **phone** | **String** | Phone number | [optional] |
+| **email** | **String** | Email address | [optional] |
+| **tax_number** | **String** | TAX number (`optional`, but in case of Brazil country this field becomes `required` and will be used as CPF/CNPJ number)<br> CPF format is 000.000.000-00 (14 characters);<br> CNPJ format is 00.000.000/0000-00 (18 characters). | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::Address.new(
+  name: John Smith,
+  company: John Smith Inc,
+  address1: 19749 Dearborn St,
+  address2: null,
+  city: Chatsworth,
+  state_code: CA,
+  state_name: California,
+  country_code: US,
+  country_name: United States,
+  zip: 91311,
+  phone: null,
+  email: null,
+  tax_number: 123.456.789-10
+)
+```
+

data/docs/AddressInfo.md

@@ -0,0 +1,28 @@
+# Printful::AddressInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address1** | **String** | Address line 1 |  |
+| **city** | **String** | City |  |
+| **country_code** | **String** | Country code |  |
+| **state_code** | **String** | State code (optional, required for United States, Australia and Canada) | [optional] |
+| **zip** | **String** | ZIP or postal code (optional, required for some countries to calculate expedited shipping rates) | [optional] |
+| **phone** | **String** | Phone number (optional) | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::AddressInfo.new(
+  address1: 19749 Dearborn St,
+  city: Chatsworth,
+  country_code: US,
+  state_code: CA,
+  zip: 91311,
+  phone: null
+)
+```
+

data/docs/ApprovalSheet.md

@@ -0,0 +1,18 @@
+# Printful::ApprovalSheet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::ApprovalSheet.new(
+  status: approved
+)
+```
+

data/docs/ApprovalSheetChanges.md

@@ -0,0 +1,20 @@
+# Printful::ApprovalSheetChanges
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | A message to send to Printful designers. Customers should use this to describe the changes they want. |  |
+| **files** | [**Array<ApprovalSheetChangesFilesInner>**](ApprovalSheetChangesFilesInner.md) | An array of images to help describe the requested changes. Consider using the mockup generator to generate these images. The array is required but can be empty if you do not want to email any images. |  |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::ApprovalSheetChanges.new(
+  message: The design needs to be aligned to the left,
+  files: null
+)
+```
+

data/docs/ApprovalSheetChangesFilesInner.md

@@ -0,0 +1,18 @@
+# Printful::ApprovalSheetChangesFilesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | A url to an image, consider using the mockup generator to generate this image. |  |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::ApprovalSheetChangesFilesInner.new(
+  url: example.com
+)
+```
+

data/docs/ApprovalSheetWebhookFile.md

@@ -0,0 +1,24 @@
+# Printful::ApprovalSheetWebhookFile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **confirm_hash** | **String** |  | [optional] |
+| **submitted_design** | **String** |  | [optional] |
+| **recommended_design** | **String** |  | [optional] |
+| **approval_sheet** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::ApprovalSheetWebhookFile.new(
+  confirm_hash: a14e51714be01f98487fcf5131727d31,
+  submitted_design: https://s3.staging.printful.com/upload/approval-design/ae/ae7b3d3e965c238b3e5c1a4e15696f07_l,
+  recommended_design: https://s3.staging.printful.com/upload/approval-design/aa/aaf9e1c6b32cb7a2c04d2746108d4124_l,
+  approval_sheet: https://www.printful.test/dashboard/order/download-approval-sheet-pdf?confirmationHash=13aa35854bfc67a85b7ce231aef2ae8
+)
+```
+

data/docs/ApprovalSheetsAPIClient.md

@@ -0,0 +1,216 @@
+# Printful::ApprovalSheetsAPIClient
+
+All URIs are relative to *https://api.printful.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**approve_design**](ApprovalSheetsAPIClient.md#approve_design) | **POST** /approval-sheets | Approve a design |
+| [**get_approval_sheets**](ApprovalSheetsAPIClient.md#get_approval_sheets) | **GET** /approval-sheets | Retrieve a list of approval sheets |
+| [**submit_approval_sheet_changes**](ApprovalSheetsAPIClient.md#submit_approval_sheet_changes) | **POST** /approval-sheets/changes | Submit changes to an approval sheet |
+
+
+## approve_design
+
+> <ApproveDesign200Response> approve_design(confirm_hash, approval_sheet, opts)
+
+Approve a design
+
+Uses the confirm hash of an approval sheet to approve a design and remove the hold on an order
+
+### Examples
+
+```ruby
+require 'time'
+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 "Error when calling ApprovalSheetsAPIClient->approve_design: #{e}"
+end
+```
+
+#### Using the approve_design_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApproveDesign200Response>, Integer, Hash)> approve_design_with_http_info(confirm_hash, approval_sheet, opts)
+
+```ruby
+begin
+  # Approve a design
+  data, status_code, headers = api_instance.approve_design_with_http_info(confirm_hash, approval_sheet, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApproveDesign200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling ApprovalSheetsAPIClient->approve_design_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **confirm_hash** | **String** | The confirm hash for the approval sheet you would like to approve. |  |
+| **approval_sheet** | [**ApprovalSheet**](ApprovalSheet.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
+
+[**ApproveDesign200Response**](ApproveDesign200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_approval_sheets
+
+> <GetApprovalSheets200Response> get_approval_sheets(opts)
+
+Retrieve a list of approval sheets
+
+Retrieve a list of approval sheets confirming suggested changes to files of on hold orders.
+
+### Examples
+
+```ruby
+require 'time'
+require 'printful_client'
+
+api_instance = Printful::ApprovalSheetsAPIClient.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
+  # Retrieve a list of approval sheets
+  result = api_instance.get_approval_sheets(opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling ApprovalSheetsAPIClient->get_approval_sheets: #{e}"
+end
+```
+
+#### Using the get_approval_sheets_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetApprovalSheets200Response>, Integer, Hash)> get_approval_sheets_with_http_info(opts)
+
+```ruby
+begin
+  # Retrieve a list of approval sheets
+  data, status_code, headers = api_instance.get_approval_sheets_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetApprovalSheets200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling ApprovalSheetsAPIClient->get_approval_sheets_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
+
+[**GetApprovalSheets200Response**](GetApprovalSheets200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## submit_approval_sheet_changes
+
+> <SubmitApprovalSheetChanges200Response> submit_approval_sheet_changes(confirm_hash, approval_sheet_changes, opts)
+
+Submit changes to an approval sheet
+
+Use this to submit alternative changes to a design that has an approval sheet
+
+### Examples
+
+```ruby
+require 'time'
+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_changes = Printful::ApprovalSheetChanges.new({message: 'The design needs to be aligned to the left', files: [Printful::ApprovalSheetChangesFilesInner.new({url: 'example.com'})]}) # ApprovalSheetChanges | 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
+  # Submit changes to an approval sheet
+  result = api_instance.submit_approval_sheet_changes(confirm_hash, approval_sheet_changes, opts)
+  p result
+rescue Printful::ApiError => e
+  puts "Error when calling ApprovalSheetsAPIClient->submit_approval_sheet_changes: #{e}"
+end
+```
+
+#### Using the submit_approval_sheet_changes_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubmitApprovalSheetChanges200Response>, Integer, Hash)> submit_approval_sheet_changes_with_http_info(confirm_hash, approval_sheet_changes, opts)
+
+```ruby
+begin
+  # Submit changes to an approval sheet
+  data, status_code, headers = api_instance.submit_approval_sheet_changes_with_http_info(confirm_hash, approval_sheet_changes, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SubmitApprovalSheetChanges200Response>
+rescue Printful::ApiError => e
+  puts "Error when calling ApprovalSheetsAPIClient->submit_approval_sheet_changes_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **confirm_hash** | **String** | The confirm hash for the approval sheet you would like to approve. |  |
+| **approval_sheet_changes** | [**ApprovalSheetChanges**](ApprovalSheetChanges.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
+
+[**SubmitApprovalSheetChanges200Response**](SubmitApprovalSheetChanges200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ApproveDesign200Response.md

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

data/docs/ApproveDesign200ResponseAllOfResult.md

@@ -0,0 +1,18 @@
+# Printful::ApproveDesign200ResponseAllOfResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::ApproveDesign200ResponseAllOfResult.new(
+  message: Design approval submitted successfully
+)
+```
+

data/docs/AvailabilityStatus.md

@@ -0,0 +1,20 @@
+# Printful::AvailabilityStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **region** | **String** | Region code | [optional] |
+| **status** | **String** | Stock status. Possible values include: 'in_stock' - available for fulfillment, 'stocked_on_demand' - available for fulfillment, 'discontinued' - permanently unavailable, 'out_of_stock' - temporarily unavailable | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::AvailabilityStatus.new(
+  region: US,
+  status: in_stock
+)
+```
+

data/docs/AvailableTechnique.md

@@ -0,0 +1,22 @@
+# Printful::AvailableTechnique
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The technique key to be used in the API | [optional] |
+| **display_name** | **String** | The human-readable technique name | [optional] |
+| **is_default** | **Boolean** | Whether the technique is the default one | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::AvailableTechnique.new(
+  key: DTG,
+  display_name: DTG printing,
+  is_default: null
+)
+```
+

data/docs/AverageFulfillmentTime.md

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

data/docs/CalculateShippingRates.md

@@ -0,0 +1,24 @@
+# Printful::CalculateShippingRates
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recipient** | [**AddressInfo**](AddressInfo.md) |  |  |
+| **items** | [**Array<ItemInfo>**](ItemInfo.md) | Array of order items |  |
+| **currency** | **String** | 3 letter currency code (optional), required if the rates need to be converted to another currency instead of store default currency | [optional] |
+| **locale** | **String** | Locale in which shipping rate names will be returned. Available options: `en_US` (default), `es_ES` | [optional] |
+
+## Example
+
+```ruby
+require 'printful_client'
+
+instance = Printful::CalculateShippingRates.new(
+  recipient: null,
+  items: null,
+  currency: USD,
+  locale: en_US
+)
+```
+