printful_client 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (549) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/Gemfile.lock +72 -0
  4. data/LICENSE +21 -0
  5. data/README.md +43 -0
  6. data/docs/AddFile200Response.md +20 -0
  7. data/docs/Address.md +42 -0
  8. data/docs/AddressInfo.md +28 -0
  9. data/docs/ApprovalSheet.md +18 -0
  10. data/docs/ApprovalSheetChanges.md +20 -0
  11. data/docs/ApprovalSheetChangesFilesInner.md +18 -0
  12. data/docs/ApprovalSheetWebhookFile.md +24 -0
  13. data/docs/ApprovalSheetsAPIClient.md +216 -0
  14. data/docs/ApproveDesign200Response.md +20 -0
  15. data/docs/ApproveDesign200ResponseAllOfResult.md +18 -0
  16. data/docs/AvailabilityStatus.md +20 -0
  17. data/docs/AvailableTechnique.md +22 -0
  18. data/docs/AverageFulfillmentTime.md +20 -0
  19. data/docs/CalculateShippingRates.md +24 -0
  20. data/docs/CalculateShippingRates200Response.md +20 -0
  21. data/docs/CalculateTaxRates200Response.md +20 -0
  22. data/docs/CatalogAPIClient.md +400 -0
  23. data/docs/CatalogFileOption.md +24 -0
  24. data/docs/Category.md +26 -0
  25. data/docs/ChangePackingSlip200Response.md +20 -0
  26. data/docs/ChangePackingSlip200ResponseResult.md +18 -0
  27. data/docs/Costs.md +38 -0
  28. data/docs/CostsByAmountInner.md +34 -0
  29. data/docs/CostsByProductInner.md +26 -0
  30. data/docs/CostsByVariantInner.md +28 -0
  31. data/docs/Country.md +24 -0
  32. data/docs/CountryStateCodeAPIClient.md +69 -0
  33. data/docs/CreateGenerationTask.md +32 -0
  34. data/docs/CreateGeneratorTask200Response.md +20 -0
  35. data/docs/CreateOrder200Response.md +20 -0
  36. data/docs/CreateSyncProduct200Response.md +20 -0
  37. data/docs/CreateSyncProduct400Response.md +22 -0
  38. data/docs/CreateSyncProduct400ResponseError.md +20 -0
  39. data/docs/CreateWebhookRequest.md +22 -0
  40. data/docs/DeleteProductTemplate200Response.md +20 -0
  41. data/docs/DeleteProductTemplate200ResponseAllOfResult.md +18 -0
  42. data/docs/DeleteSyncVariant200Response.md +20 -0
  43. data/docs/EcommercePlatformSyncAPIClient.md +459 -0
  44. data/docs/EstimateOrderCosts200Response.md +20 -0
  45. data/docs/EstimateOrderCosts200ResponseAllOfResult.md +20 -0
  46. data/docs/File.md +50 -0
  47. data/docs/FileLibraryAPIClient.md +220 -0
  48. data/docs/FileOption.md +20 -0
  49. data/docs/FileType.md +26 -0
  50. data/docs/GenerationTask.md +26 -0
  51. data/docs/GenerationTaskExtraMockup.md +24 -0
  52. data/docs/GenerationTaskFile.md +24 -0
  53. data/docs/GenerationTaskFilePosition.md +28 -0
  54. data/docs/GenerationTaskMockup.md +24 -0
  55. data/docs/GenerationTaskTemplateFile.md +22 -0
  56. data/docs/GetApprovalSheets200Response.md +20 -0
  57. data/docs/GetCategories200Response.md +20 -0
  58. data/docs/GetCategoryById200Response.md +20 -0
  59. data/docs/GetCountries200Response.md +20 -0
  60. data/docs/GetOrderByIdIdParameter.md +49 -0
  61. data/docs/GetOrders200Response.md +22 -0
  62. data/docs/GetPrintfiles200Response.md +20 -0
  63. data/docs/GetProductById200Response.md +20 -0
  64. data/docs/GetProductSizeGuideById200Response.md +20 -0
  65. data/docs/GetProductSizeGuideById404Response.md +22 -0
  66. data/docs/GetProductSizeGuideById404ResponseError.md +20 -0
  67. data/docs/GetProductTemplateById200Response.md +20 -0
  68. data/docs/GetProductTemplates200Response.md +22 -0
  69. data/docs/GetProducts200Response.md +20 -0
  70. data/docs/GetProducts401Response.md +22 -0
  71. data/docs/GetProducts401ResponseError.md +20 -0
  72. data/docs/GetScopes200Response.md +20 -0
  73. data/docs/GetScopes200ResponseAllOfResult.md +18 -0
  74. data/docs/GetScopes200ResponseAllOfResultScopesInner.md +20 -0
  75. data/docs/GetStatistics200Response.md +20 -0
  76. data/docs/GetStore200Response.md +20 -0
  77. data/docs/GetStoreSyncVariantById200Response.md +20 -0
  78. data/docs/GetStores200Response.md +22 -0
  79. data/docs/GetStores403Response.md +22 -0
  80. data/docs/GetStores403ResponseError.md +20 -0
  81. data/docs/GetSyncProductById200Response.md +20 -0
  82. data/docs/GetSyncProductByIdIdParameter.md +49 -0
  83. data/docs/GetSyncProducts200Response.md +22 -0
  84. data/docs/GetSyncVariantById200Response.md +20 -0
  85. data/docs/GetTaxCountries200Response.md +20 -0
  86. data/docs/GetTaxCountries200ResponseResultInner.md +24 -0
  87. data/docs/GetTaxCountries200ResponseResultInnerAllOfStatesInner.md +18 -0
  88. data/docs/GetTemplates200Response.md +20 -0
  89. data/docs/GetVariantById200Response.md +20 -0
  90. data/docs/GetWarehouseProduct200Response.md +20 -0
  91. data/docs/GetWarehouseProducts200Response.md +22 -0
  92. data/docs/GetWebhooks200Response.md +20 -0
  93. data/docs/Gift.md +20 -0
  94. data/docs/IncompleteItem.md +26 -0
  95. data/docs/Item.md +52 -0
  96. data/docs/ItemFilesInner.md +52 -0
  97. data/docs/ItemFilesInnerAllOfPosition.md +30 -0
  98. data/docs/ItemInfo.md +26 -0
  99. data/docs/ItemOption.md +20 -0
  100. data/docs/Material.md +20 -0
  101. data/docs/Measurement.md +22 -0
  102. data/docs/MeasurementValue.md +24 -0
  103. data/docs/MockupGeneratorAPIClient.md +313 -0
  104. data/docs/OAuthAPIClient.md +74 -0
  105. data/docs/Option.md +20 -0
  106. data/docs/OptionType.md +28 -0
  107. data/docs/Order.md +52 -0
  108. data/docs/OrderCosts.md +38 -0
  109. data/docs/OrderEstimateCosts.md +36 -0
  110. data/docs/OrderEstimateRetailCosts.md +30 -0
  111. data/docs/OrderEvent.md +52 -0
  112. data/docs/OrderShipmentItem.md +24 -0
  113. data/docs/OrdersAPIClient.md +535 -0
  114. data/docs/PackingSlip.md +28 -0
  115. data/docs/Paging.md +22 -0
  116. data/docs/PricingBreakdown.md +24 -0
  117. data/docs/Printfile.md +28 -0
  118. data/docs/PrintfileInfo.md +28 -0
  119. data/docs/PrintfulCosts.md +20 -0
  120. data/docs/Product.md +50 -0
  121. data/docs/Product1.md +20 -0
  122. data/docs/Product1SyncVariantsInner.md +46 -0
  123. data/docs/ProductInfo.md +20 -0
  124. data/docs/ProductSizeGuide.md +22 -0
  125. data/docs/ProductTemplate.md +26 -0
  126. data/docs/ProductTemplatesAPIClient.md +221 -0
  127. data/docs/ProductVariant.md +24 -0
  128. data/docs/ProductsAPIClient.md +679 -0
  129. data/docs/Profit.md +20 -0
  130. data/docs/README.md +410 -0
  131. data/docs/ReportsAPIClient.md +87 -0
  132. data/docs/Response200.md +18 -0
  133. data/docs/Response200Paginated.md +20 -0
  134. data/docs/RetailCosts.md +30 -0
  135. data/docs/SalesAndCostsInner.md +32 -0
  136. data/docs/SalesAndCostsSummaryInner.md +24 -0
  137. data/docs/Shipment.md +36 -0
  138. data/docs/ShippingInfo.md +32 -0
  139. data/docs/ShippingRateAPIClient.md +81 -0
  140. data/docs/SizeTable.md +28 -0
  141. data/docs/State.md +20 -0
  142. data/docs/Statistics.md +18 -0
  143. data/docs/Store.md +22 -0
  144. data/docs/StoreInformationAPIClient.md +218 -0
  145. data/docs/StoreStatistics.md +38 -0
  146. data/docs/SubmitApprovalSheetChanges200Response.md +20 -0
  147. data/docs/SyncProduct.md +32 -0
  148. data/docs/SyncProductDeleted.md +22 -0
  149. data/docs/SyncProductEvent.md +32 -0
  150. data/docs/SyncProductInfo.md +20 -0
  151. data/docs/SyncVariant.md +46 -0
  152. data/docs/SyncVariantInfo.md +20 -0
  153. data/docs/SyncVariantProduct.md +24 -0
  154. data/docs/TaxAddressInfo.md +24 -0
  155. data/docs/TaxInfo.md +22 -0
  156. data/docs/TaxRateAPIClient.md +134 -0
  157. data/docs/TaxRequest.md +18 -0
  158. data/docs/Template.md +42 -0
  159. data/docs/TemplateById.md +42 -0
  160. data/docs/TemplateByIdColorsInner.md +20 -0
  161. data/docs/TemplateByIdOptionDataInner.md +20 -0
  162. data/docs/TemplateByIdPlacementOptionDataInner.md +20 -0
  163. data/docs/TemplateByIdPlacementOptionDataInnerOptionsInner.md +20 -0
  164. data/docs/TemplateByIdPlacementsInner.md +24 -0
  165. data/docs/TemplatePlacementConflict.md +20 -0
  166. data/docs/TemplateVariantMapping.md +20 -0
  167. data/docs/TemplateVariantMappingItem.md +20 -0
  168. data/docs/Templates.md +18 -0
  169. data/docs/ThreadColors200Response.md +20 -0
  170. data/docs/ThreadColorsRequest.md +18 -0
  171. data/docs/TotalPaidOrders.md +20 -0
  172. data/docs/UpdateSyncProductRequest.md +20 -0
  173. data/docs/UpdateSyncProductRequestSyncVariantsInner.md +46 -0
  174. data/docs/UpdateSyncVariantRequest.md +46 -0
  175. data/docs/Variant.md +42 -0
  176. data/docs/VariantInfo.md +20 -0
  177. data/docs/VariantPrintfile.md +20 -0
  178. data/docs/WarehouseProduct.md +30 -0
  179. data/docs/WarehouseProductVariant.md +36 -0
  180. data/docs/WarehouseProductsAPIClient.md +159 -0
  181. data/docs/Webhook.md +24 -0
  182. data/docs/WebhookAPIClient.md +225 -0
  183. data/docs/WebhookInfo.md +22 -0
  184. data/generate.sh +53 -0
  185. data/lib/printful_client/api/approval_sheets_api_client.rb +238 -0
  186. data/lib/printful_client/api/catalog_api_client.rb +394 -0
  187. data/lib/printful_client/api/country_state_code_api_client.rb +79 -0
  188. data/lib/printful_client/api/ecommerce_platform_sync_api_client.rb +435 -0
  189. data/lib/printful_client/api/file_library_api_client.rb +227 -0
  190. data/lib/printful_client/api/mockup_generator_api_client.rb +318 -0
  191. data/lib/printful_client/api/o_auth_api_client.rb +79 -0
  192. data/lib/printful_client/api/orders_api_client.rb +514 -0
  193. data/lib/printful_client/api/product_templates_api_client.rb +211 -0
  194. data/lib/printful_client/api/products_api_client.rb +651 -0
  195. data/lib/printful_client/api/reports_api_client.rb +106 -0
  196. data/lib/printful_client/api/shipping_rate_api_client.rb +93 -0
  197. data/lib/printful_client/api/store_information_api_client.rb +209 -0
  198. data/lib/printful_client/api/tax_rate_api_client.rb +147 -0
  199. data/lib/printful_client/api/warehouse_products_api_client.rb +157 -0
  200. data/lib/printful_client/api/webhook_api_client.rb +213 -0
  201. data/lib/printful_client/api_client.rb +392 -0
  202. data/lib/printful_client/api_error.rb +58 -0
  203. data/lib/printful_client/configuration.rb +297 -0
  204. data/lib/printful_client/models/add_file200_response.rb +231 -0
  205. data/lib/printful_client/models/address.rb +336 -0
  206. data/lib/printful_client/models/address_info.rb +287 -0
  207. data/lib/printful_client/models/approval_sheet.rb +256 -0
  208. data/lib/printful_client/models/approval_sheet_changes.rb +242 -0
  209. data/lib/printful_client/models/approval_sheet_changes_files_inner.rb +222 -0
  210. data/lib/printful_client/models/approval_sheet_webhook_file.rb +241 -0
  211. data/lib/printful_client/models/approve_design200_response.rb +231 -0
  212. data/lib/printful_client/models/approve_design200_response_all_of_result.rb +214 -0
  213. data/lib/printful_client/models/availability_status.rb +225 -0
  214. data/lib/printful_client/models/available_technique.rb +235 -0
  215. data/lib/printful_client/models/average_fulfillment_time.rb +226 -0
  216. data/lib/printful_client/models/calculate_shipping_rates.rb +261 -0
  217. data/lib/printful_client/models/calculate_shipping_rates200_response.rb +226 -0
  218. data/lib/printful_client/models/calculate_tax_rates200_response.rb +224 -0
  219. data/lib/printful_client/models/catalog_file_option.rb +244 -0
  220. data/lib/printful_client/models/category.rb +290 -0
  221. data/lib/printful_client/models/change_packing_slip200_response.rb +224 -0
  222. data/lib/printful_client/models/change_packing_slip200_response_result.rb +215 -0
  223. data/lib/printful_client/models/costs.rb +316 -0
  224. data/lib/printful_client/models/costs_by_amount_inner.rb +295 -0
  225. data/lib/printful_client/models/costs_by_product_inner.rb +255 -0
  226. data/lib/printful_client/models/costs_by_variant_inner.rb +265 -0
  227. data/lib/printful_client/models/country.rb +246 -0
  228. data/lib/printful_client/models/create_generation_task.rb +329 -0
  229. data/lib/printful_client/models/create_generator_task200_response.rb +231 -0
  230. data/lib/printful_client/models/create_order200_response.rb +231 -0
  231. data/lib/printful_client/models/create_sync_product200_response.rb +231 -0
  232. data/lib/printful_client/models/create_sync_product400_response.rb +234 -0
  233. data/lib/printful_client/models/create_sync_product400_response_error.rb +223 -0
  234. data/lib/printful_client/models/create_webhook_request.rb +259 -0
  235. data/lib/printful_client/models/delete_product_template200_response.rb +231 -0
  236. data/lib/printful_client/models/delete_product_template200_response_all_of_result.rb +215 -0
  237. data/lib/printful_client/models/delete_sync_variant200_response.rb +234 -0
  238. data/lib/printful_client/models/estimate_order_costs200_response.rb +231 -0
  239. data/lib/printful_client/models/estimate_order_costs200_response_all_of_result.rb +223 -0
  240. data/lib/printful_client/models/file.rb +385 -0
  241. data/lib/printful_client/models/file_option.rb +240 -0
  242. data/lib/printful_client/models/file_type.rb +257 -0
  243. data/lib/printful_client/models/generation_task.rb +294 -0
  244. data/lib/printful_client/models/generation_task_extra_mockup.rb +246 -0
  245. data/lib/printful_client/models/generation_task_file.rb +247 -0
  246. data/lib/printful_client/models/generation_task_file_position.rb +268 -0
  247. data/lib/printful_client/models/generation_task_mockup.rb +250 -0
  248. data/lib/printful_client/models/generation_task_template_file.rb +238 -0
  249. data/lib/printful_client/models/get_approval_sheets200_response.rb +233 -0
  250. data/lib/printful_client/models/get_categories200_response.rb +233 -0
  251. data/lib/printful_client/models/get_category_by_id200_response.rb +231 -0
  252. data/lib/printful_client/models/get_countries200_response.rb +233 -0
  253. data/lib/printful_client/models/get_order_by_id_id_parameter.rb +105 -0
  254. data/lib/printful_client/models/get_orders200_response.rb +242 -0
  255. data/lib/printful_client/models/get_printfiles200_response.rb +231 -0
  256. data/lib/printful_client/models/get_product_by_id200_response.rb +231 -0
  257. data/lib/printful_client/models/get_product_size_guide_by_id200_response.rb +231 -0
  258. data/lib/printful_client/models/get_product_size_guide_by_id404_response.rb +234 -0
  259. data/lib/printful_client/models/get_product_size_guide_by_id404_response_error.rb +223 -0
  260. data/lib/printful_client/models/get_product_template_by_id200_response.rb +231 -0
  261. data/lib/printful_client/models/get_product_templates200_response.rb +240 -0
  262. data/lib/printful_client/models/get_products200_response.rb +233 -0
  263. data/lib/printful_client/models/get_products401_response.rb +234 -0
  264. data/lib/printful_client/models/get_products401_response_error.rb +223 -0
  265. data/lib/printful_client/models/get_scopes200_response.rb +231 -0
  266. data/lib/printful_client/models/get_scopes200_response_all_of_result.rb +216 -0
  267. data/lib/printful_client/models/get_scopes200_response_all_of_result_scopes_inner.rb +223 -0
  268. data/lib/printful_client/models/get_statistics200_response.rb +224 -0
  269. data/lib/printful_client/models/get_store200_response.rb +231 -0
  270. data/lib/printful_client/models/get_store_sync_variant_by_id200_response.rb +231 -0
  271. data/lib/printful_client/models/get_stores200_response.rb +242 -0
  272. data/lib/printful_client/models/get_stores403_response.rb +234 -0
  273. data/lib/printful_client/models/get_stores403_response_error.rb +223 -0
  274. data/lib/printful_client/models/get_sync_product_by_id200_response.rb +231 -0
  275. data/lib/printful_client/models/get_sync_product_by_id_id_parameter.rb +105 -0
  276. data/lib/printful_client/models/get_sync_products200_response.rb +243 -0
  277. data/lib/printful_client/models/get_sync_variant_by_id200_response.rb +224 -0
  278. data/lib/printful_client/models/get_tax_countries200_response.rb +226 -0
  279. data/lib/printful_client/models/get_tax_countries200_response_result_inner.rb +252 -0
  280. data/lib/printful_client/models/get_tax_countries200_response_result_inner_all_of_states_inner.rb +215 -0
  281. data/lib/printful_client/models/get_templates200_response.rb +231 -0
  282. data/lib/printful_client/models/get_variant_by_id200_response.rb +231 -0
  283. data/lib/printful_client/models/get_warehouse_product200_response.rb +231 -0
  284. data/lib/printful_client/models/get_warehouse_products200_response.rb +243 -0
  285. data/lib/printful_client/models/get_webhooks200_response.rb +231 -0
  286. data/lib/printful_client/models/gift.rb +264 -0
  287. data/lib/printful_client/models/incomplete_item.rb +256 -0
  288. data/lib/printful_client/models/item.rb +389 -0
  289. data/lib/printful_client/models/item_files_inner.rb +400 -0
  290. data/lib/printful_client/models/item_files_inner_all_of_position.rb +286 -0
  291. data/lib/printful_client/models/item_info.rb +263 -0
  292. data/lib/printful_client/models/item_option.rb +240 -0
  293. data/lib/printful_client/models/material.rb +225 -0
  294. data/lib/printful_client/models/measurement.rb +245 -0
  295. data/lib/printful_client/models/measurement_value.rb +253 -0
  296. data/lib/printful_client/models/option.rb +226 -0
  297. data/lib/printful_client/models/option_type.rb +269 -0
  298. data/lib/printful_client/models/order.rb +406 -0
  299. data/lib/printful_client/models/order_costs.rb +322 -0
  300. data/lib/printful_client/models/order_estimate_costs.rb +306 -0
  301. data/lib/printful_client/models/order_estimate_retail_costs.rb +282 -0
  302. data/lib/printful_client/models/order_event.rb +396 -0
  303. data/lib/printful_client/models/order_shipment_item.rb +292 -0
  304. data/lib/printful_client/models/packing_slip.rb +266 -0
  305. data/lib/printful_client/models/paging.rb +236 -0
  306. data/lib/printful_client/models/pricing_breakdown.rb +246 -0
  307. data/lib/printful_client/models/printfile.rb +300 -0
  308. data/lib/printful_client/models/printfile_info.rb +270 -0
  309. data/lib/printful_client/models/printful_costs.rb +226 -0
  310. data/lib/printful_client/models/product.rb +383 -0
  311. data/lib/printful_client/models/product1.rb +241 -0
  312. data/lib/printful_client/models/product1_sync_variants_inner.rb +379 -0
  313. data/lib/printful_client/models/product_info.rb +225 -0
  314. data/lib/printful_client/models/product_size_guide.rb +261 -0
  315. data/lib/printful_client/models/product_template.rb +262 -0
  316. data/lib/printful_client/models/product_variant.rb +246 -0
  317. data/lib/printful_client/models/profit.rb +226 -0
  318. data/lib/printful_client/models/response200.rb +215 -0
  319. data/lib/printful_client/models/response200_paginated.rb +231 -0
  320. data/lib/printful_client/models/retail_costs.rb +282 -0
  321. data/lib/printful_client/models/sales_and_costs_inner.rb +285 -0
  322. data/lib/printful_client/models/sales_and_costs_summary_inner.rb +245 -0
  323. data/lib/printful_client/models/shipment.rb +308 -0
  324. data/lib/printful_client/models/shipping_info.rb +286 -0
  325. data/lib/printful_client/models/size_table.rb +328 -0
  326. data/lib/printful_client/models/state.rb +225 -0
  327. data/lib/printful_client/models/statistics.rb +218 -0
  328. data/lib/printful_client/models/store.rb +236 -0
  329. data/lib/printful_client/models/store_statistics.rb +322 -0
  330. data/lib/printful_client/models/submit_approval_sheet_changes200_response.rb +231 -0
  331. data/lib/printful_client/models/sync_product.rb +312 -0
  332. data/lib/printful_client/models/sync_product_deleted.rb +257 -0
  333. data/lib/printful_client/models/sync_product_event.rb +293 -0
  334. data/lib/printful_client/models/sync_product_info.rb +226 -0
  335. data/lib/printful_client/models/sync_variant.rb +359 -0
  336. data/lib/printful_client/models/sync_variant_info.rb +223 -0
  337. data/lib/printful_client/models/sync_variant_product.rb +252 -0
  338. data/lib/printful_client/models/tax_address_info.rb +274 -0
  339. data/lib/printful_client/models/tax_info.rb +236 -0
  340. data/lib/printful_client/models/tax_request.rb +222 -0
  341. data/lib/printful_client/models/template.rb +372 -0
  342. data/lib/printful_client/models/template_by_id.rb +335 -0
  343. data/lib/printful_client/models/template_by_id_colors_inner.rb +223 -0
  344. data/lib/printful_client/models/template_by_id_option_data_inner.rb +225 -0
  345. data/lib/printful_client/models/template_by_id_placement_option_data_inner.rb +225 -0
  346. data/lib/printful_client/models/template_by_id_placement_option_data_inner_options_inner.rb +224 -0
  347. data/lib/printful_client/models/template_by_id_placements_inner.rb +241 -0
  348. data/lib/printful_client/models/template_placement_conflict.rb +228 -0
  349. data/lib/printful_client/models/template_variant_mapping.rb +228 -0
  350. data/lib/printful_client/models/template_variant_mapping_item.rb +226 -0
  351. data/lib/printful_client/models/templates.rb +217 -0
  352. data/lib/printful_client/models/thread_colors200_response.rb +233 -0
  353. data/lib/printful_client/models/thread_colors_request.rb +215 -0
  354. data/lib/printful_client/models/total_paid_orders.rb +226 -0
  355. data/lib/printful_client/models/update_sync_product_request.rb +226 -0
  356. data/lib/printful_client/models/update_sync_product_request_sync_variants_inner.rb +365 -0
  357. data/lib/printful_client/models/update_sync_variant_request.rb +365 -0
  358. data/lib/printful_client/models/variant.rb +341 -0
  359. data/lib/printful_client/models/variant_info.rb +223 -0
  360. data/lib/printful_client/models/variant_printfile.rb +224 -0
  361. data/lib/printful_client/models/warehouse_product.rb +312 -0
  362. data/lib/printful_client/models/warehouse_product_variant.rb +306 -0
  363. data/lib/printful_client/models/webhook.rb +245 -0
  364. data/lib/printful_client/models/webhook_info.rb +238 -0
  365. data/lib/printful_client/version.rb +15 -0
  366. data/lib/printful_client.rb +216 -0
  367. data/printful_client.gemspec +38 -0
  368. data/spec/api/approval_sheets_api_client_spec.rb +75 -0
  369. data/spec/api/catalog_api_client_spec.rb +107 -0
  370. data/spec/api/country_state_code_api_client_spec.rb +46 -0
  371. data/spec/api/ecommerce_platform_sync_api_client_spec.rb +117 -0
  372. data/spec/api/file_library_api_client_spec.rb +73 -0
  373. data/spec/api/mockup_generator_api_client_spec.rb +92 -0
  374. data/spec/api/o_auth_api_client_spec.rb +46 -0
  375. data/spec/api/orders_api_client_spec.rb +131 -0
  376. data/spec/api/product_templates_api_client_spec.rb +72 -0
  377. data/spec/api/products_api_client_spec.rb +155 -0
  378. data/spec/api/reports_api_client_spec.rb +51 -0
  379. data/spec/api/shipping_rate_api_client_spec.rb +48 -0
  380. data/spec/api/store_information_api_client_spec.rb +71 -0
  381. data/spec/api/tax_rate_api_client_spec.rb +58 -0
  382. data/spec/api/warehouse_products_api_client_spec.rb +63 -0
  383. data/spec/api/webhook_api_client_spec.rb +72 -0
  384. data/spec/api_client_spec.rb +228 -0
  385. data/spec/configuration_spec.rb +42 -0
  386. data/spec/models/add_file200_response_spec.rb +40 -0
  387. data/spec/models/address_info_spec.rb +64 -0
  388. data/spec/models/address_spec.rb +106 -0
  389. data/spec/models/approval_sheet_changes_files_inner_spec.rb +34 -0
  390. data/spec/models/approval_sheet_changes_spec.rb +40 -0
  391. data/spec/models/approval_sheet_spec.rb +38 -0
  392. data/spec/models/approval_sheet_webhook_file_spec.rb +52 -0
  393. data/spec/models/approve_design200_response_all_of_result_spec.rb +34 -0
  394. data/spec/models/approve_design200_response_spec.rb +40 -0
  395. data/spec/models/availability_status_spec.rb +40 -0
  396. data/spec/models/available_technique_spec.rb +46 -0
  397. data/spec/models/average_fulfillment_time_spec.rb +40 -0
  398. data/spec/models/calculate_shipping_rates200_response_spec.rb +40 -0
  399. data/spec/models/calculate_shipping_rates_spec.rb +52 -0
  400. data/spec/models/calculate_tax_rates200_response_spec.rb +40 -0
  401. data/spec/models/catalog_file_option_spec.rb +52 -0
  402. data/spec/models/category_spec.rb +62 -0
  403. data/spec/models/change_packing_slip200_response_result_spec.rb +34 -0
  404. data/spec/models/change_packing_slip200_response_spec.rb +40 -0
  405. data/spec/models/costs_by_amount_inner_spec.rb +82 -0
  406. data/spec/models/costs_by_product_inner_spec.rb +58 -0
  407. data/spec/models/costs_by_variant_inner_spec.rb +64 -0
  408. data/spec/models/costs_spec.rb +94 -0
  409. data/spec/models/country_spec.rb +52 -0
  410. data/spec/models/create_generation_task_spec.rb +80 -0
  411. data/spec/models/create_generator_task200_response_spec.rb +40 -0
  412. data/spec/models/create_order200_response_spec.rb +40 -0
  413. data/spec/models/create_sync_product200_response_spec.rb +40 -0
  414. data/spec/models/create_sync_product400_response_error_spec.rb +40 -0
  415. data/spec/models/create_sync_product400_response_spec.rb +46 -0
  416. data/spec/models/create_webhook_request_spec.rb +46 -0
  417. data/spec/models/delete_product_template200_response_all_of_result_spec.rb +34 -0
  418. data/spec/models/delete_product_template200_response_spec.rb +40 -0
  419. data/spec/models/delete_sync_variant200_response_spec.rb +40 -0
  420. data/spec/models/estimate_order_costs200_response_all_of_result_spec.rb +40 -0
  421. data/spec/models/estimate_order_costs200_response_spec.rb +40 -0
  422. data/spec/models/file_option_spec.rb +40 -0
  423. data/spec/models/file_spec.rb +130 -0
  424. data/spec/models/file_type_spec.rb +58 -0
  425. data/spec/models/generation_task_extra_mockup_spec.rb +52 -0
  426. data/spec/models/generation_task_file_position_spec.rb +64 -0
  427. data/spec/models/generation_task_file_spec.rb +52 -0
  428. data/spec/models/generation_task_mockup_spec.rb +52 -0
  429. data/spec/models/generation_task_spec.rb +62 -0
  430. data/spec/models/generation_task_template_file_spec.rb +46 -0
  431. data/spec/models/get_approval_sheets200_response_spec.rb +40 -0
  432. data/spec/models/get_categories200_response_spec.rb +40 -0
  433. data/spec/models/get_category_by_id200_response_spec.rb +40 -0
  434. data/spec/models/get_countries200_response_spec.rb +40 -0
  435. data/spec/models/get_order_by_id_id_parameter_spec.rb +31 -0
  436. data/spec/models/get_orders200_response_spec.rb +46 -0
  437. data/spec/models/get_printfiles200_response_spec.rb +40 -0
  438. data/spec/models/get_product_by_id200_response_spec.rb +40 -0
  439. data/spec/models/get_product_size_guide_by_id200_response_spec.rb +40 -0
  440. data/spec/models/get_product_size_guide_by_id404_response_error_spec.rb +40 -0
  441. data/spec/models/get_product_size_guide_by_id404_response_spec.rb +46 -0
  442. data/spec/models/get_product_template_by_id200_response_spec.rb +40 -0
  443. data/spec/models/get_product_templates200_response_spec.rb +46 -0
  444. data/spec/models/get_products200_response_spec.rb +40 -0
  445. data/spec/models/get_products401_response_error_spec.rb +40 -0
  446. data/spec/models/get_products401_response_spec.rb +46 -0
  447. data/spec/models/get_scopes200_response_all_of_result_scopes_inner_spec.rb +40 -0
  448. data/spec/models/get_scopes200_response_all_of_result_spec.rb +34 -0
  449. data/spec/models/get_scopes200_response_spec.rb +40 -0
  450. data/spec/models/get_statistics200_response_spec.rb +40 -0
  451. data/spec/models/get_store200_response_spec.rb +40 -0
  452. data/spec/models/get_store_sync_variant_by_id200_response_spec.rb +40 -0
  453. data/spec/models/get_stores200_response_spec.rb +46 -0
  454. data/spec/models/get_stores403_response_error_spec.rb +40 -0
  455. data/spec/models/get_stores403_response_spec.rb +46 -0
  456. data/spec/models/get_sync_product_by_id200_response_spec.rb +40 -0
  457. data/spec/models/get_sync_product_by_id_id_parameter_spec.rb +31 -0
  458. data/spec/models/get_sync_products200_response_spec.rb +46 -0
  459. data/spec/models/get_sync_variant_by_id200_response_spec.rb +40 -0
  460. data/spec/models/get_tax_countries200_response_result_inner_all_of_states_inner_spec.rb +34 -0
  461. data/spec/models/get_tax_countries200_response_result_inner_spec.rb +52 -0
  462. data/spec/models/get_tax_countries200_response_spec.rb +40 -0
  463. data/spec/models/get_templates200_response_spec.rb +40 -0
  464. data/spec/models/get_variant_by_id200_response_spec.rb +40 -0
  465. data/spec/models/get_warehouse_product200_response_spec.rb +40 -0
  466. data/spec/models/get_warehouse_products200_response_spec.rb +46 -0
  467. data/spec/models/get_webhooks200_response_spec.rb +40 -0
  468. data/spec/models/gift_spec.rb +40 -0
  469. data/spec/models/incomplete_item_spec.rb +58 -0
  470. data/spec/models/item_files_inner_all_of_position_spec.rb +70 -0
  471. data/spec/models/item_files_inner_spec.rb +136 -0
  472. data/spec/models/item_info_spec.rb +58 -0
  473. data/spec/models/item_option_spec.rb +40 -0
  474. data/spec/models/item_spec.rb +136 -0
  475. data/spec/models/material_spec.rb +40 -0
  476. data/spec/models/measurement_spec.rb +46 -0
  477. data/spec/models/measurement_value_spec.rb +52 -0
  478. data/spec/models/option_spec.rb +40 -0
  479. data/spec/models/option_type_spec.rb +64 -0
  480. data/spec/models/order_costs_spec.rb +94 -0
  481. data/spec/models/order_estimate_costs_spec.rb +88 -0
  482. data/spec/models/order_estimate_retail_costs_spec.rb +70 -0
  483. data/spec/models/order_event_spec.rb +136 -0
  484. data/spec/models/order_shipment_item_spec.rb +60 -0
  485. data/spec/models/order_spec.rb +136 -0
  486. data/spec/models/packing_slip_spec.rb +64 -0
  487. data/spec/models/paging_spec.rb +46 -0
  488. data/spec/models/pricing_breakdown_spec.rb +52 -0
  489. data/spec/models/printfile_info_spec.rb +64 -0
  490. data/spec/models/printfile_spec.rb +68 -0
  491. data/spec/models/printful_costs_spec.rb +40 -0
  492. data/spec/models/product1_spec.rb +40 -0
  493. data/spec/models/product1_sync_variants_inner_spec.rb +118 -0
  494. data/spec/models/product_info_spec.rb +40 -0
  495. data/spec/models/product_size_guide_spec.rb +46 -0
  496. data/spec/models/product_spec.rb +130 -0
  497. data/spec/models/product_template_spec.rb +58 -0
  498. data/spec/models/product_variant_spec.rb +52 -0
  499. data/spec/models/profit_spec.rb +40 -0
  500. data/spec/models/response200_paginated_spec.rb +40 -0
  501. data/spec/models/response200_spec.rb +34 -0
  502. data/spec/models/retail_costs_spec.rb +70 -0
  503. data/spec/models/sales_and_costs_inner_spec.rb +76 -0
  504. data/spec/models/sales_and_costs_summary_inner_spec.rb +52 -0
  505. data/spec/models/shipment_spec.rb +88 -0
  506. data/spec/models/shipping_info_spec.rb +76 -0
  507. data/spec/models/size_table_spec.rb +72 -0
  508. data/spec/models/state_spec.rb +40 -0
  509. data/spec/models/statistics_spec.rb +34 -0
  510. data/spec/models/store_spec.rb +46 -0
  511. data/spec/models/store_statistics_spec.rb +94 -0
  512. data/spec/models/submit_approval_sheet_changes200_response_spec.rb +40 -0
  513. data/spec/models/sync_product_deleted_spec.rb +46 -0
  514. data/spec/models/sync_product_event_spec.rb +76 -0
  515. data/spec/models/sync_product_info_spec.rb +40 -0
  516. data/spec/models/sync_product_spec.rb +76 -0
  517. data/spec/models/sync_variant_info_spec.rb +40 -0
  518. data/spec/models/sync_variant_product_spec.rb +52 -0
  519. data/spec/models/sync_variant_spec.rb +118 -0
  520. data/spec/models/tax_address_info_spec.rb +52 -0
  521. data/spec/models/tax_info_spec.rb +46 -0
  522. data/spec/models/tax_request_spec.rb +34 -0
  523. data/spec/models/template_by_id_colors_inner_spec.rb +40 -0
  524. data/spec/models/template_by_id_option_data_inner_spec.rb +40 -0
  525. data/spec/models/template_by_id_placement_option_data_inner_options_inner_spec.rb +40 -0
  526. data/spec/models/template_by_id_placement_option_data_inner_spec.rb +40 -0
  527. data/spec/models/template_by_id_placements_inner_spec.rb +52 -0
  528. data/spec/models/template_by_id_spec.rb +106 -0
  529. data/spec/models/template_placement_conflict_spec.rb +40 -0
  530. data/spec/models/template_spec.rb +110 -0
  531. data/spec/models/template_variant_mapping_item_spec.rb +40 -0
  532. data/spec/models/template_variant_mapping_spec.rb +40 -0
  533. data/spec/models/templates_spec.rb +34 -0
  534. data/spec/models/thread_colors200_response_spec.rb +40 -0
  535. data/spec/models/thread_colors_request_spec.rb +34 -0
  536. data/spec/models/total_paid_orders_spec.rb +40 -0
  537. data/spec/models/update_sync_product_request_spec.rb +40 -0
  538. data/spec/models/update_sync_product_request_sync_variants_inner_spec.rb +118 -0
  539. data/spec/models/update_sync_variant_request_spec.rb +118 -0
  540. data/spec/models/variant_info_spec.rb +40 -0
  541. data/spec/models/variant_printfile_spec.rb +40 -0
  542. data/spec/models/variant_spec.rb +106 -0
  543. data/spec/models/warehouse_product_spec.rb +74 -0
  544. data/spec/models/warehouse_product_variant_spec.rb +88 -0
  545. data/spec/models/webhook_info_spec.rb +46 -0
  546. data/spec/models/webhook_spec.rb +52 -0
  547. data/spec/spec_helper.rb +111 -0
  548. data/swagger.json +8318 -0
  549. metadata +812 -0
@@ -0,0 +1,679 @@
1
+ # Printful::ProductsAPIClient
2
+
3
+ All URIs are relative to *https://api.printful.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_sync_product**](ProductsAPIClient.md#create_sync_product) | **POST** /store/products | Create a new Sync Product |
8
+ | [**create_sync_variant**](ProductsAPIClient.md#create_sync_variant) | **POST** /store/products/{id}/variants | Create a new Sync Variant |
9
+ | [**delete_sync_product**](ProductsAPIClient.md#delete_sync_product) | **DELETE** /store/products/{id} | Delete a Sync Product |
10
+ | [**delete_sync_variant**](ProductsAPIClient.md#delete_sync_variant) | **DELETE** /store/variants/{id} | Delete a Sync Variant |
11
+ | [**get_sync_product_by_id**](ProductsAPIClient.md#get_sync_product_by_id) | **GET** /store/products/{id} | Get a Sync Product |
12
+ | [**get_sync_products**](ProductsAPIClient.md#get_sync_products) | **GET** /store/products | Get Sync Products |
13
+ | [**get_sync_variant_by_id**](ProductsAPIClient.md#get_sync_variant_by_id) | **GET** /store/variants/{id} | Get a Sync Variant |
14
+ | [**update_sync_product**](ProductsAPIClient.md#update_sync_product) | **PUT** /store/products/{id} | Modify a Sync Product |
15
+ | [**update_sync_variant**](ProductsAPIClient.md#update_sync_variant) | **PUT** /store/variants/{id} | Modify a Sync Variant |
16
+
17
+
18
+ ## create_sync_product
19
+
20
+ > <CreateSyncProduct200Response> create_sync_product(product1, opts)
21
+
22
+ Create a new Sync Product
23
+
24
+ Creates a new Sync Product together with its Sync Variants ([See examples](#section/Products-API-examples/Create-a-new-Sync-Product)).
25
+
26
+ ### Examples
27
+
28
+ ```ruby
29
+ require 'time'
30
+ require 'printful_client'
31
+ # setup authorization
32
+ Printful.configure do |config|
33
+ # Configure OAuth2 access token for authorization: OAuth
34
+ config.access_token = 'YOUR ACCESS TOKEN'
35
+ end
36
+
37
+ api_instance = Printful::ProductsAPIClient.new
38
+ product1 = Printful::Product1.new({sync_product: Printful::SyncProduct.new({name: 'T-shirt'}), sync_variants: [Printful::Product1SyncVariantsInner.new({variant_id: 3001, files: [3.56]})]}) # Product1 | POST request body
39
+ opts = {
40
+ 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)
41
+ }
42
+
43
+ begin
44
+ # Create a new Sync Product
45
+ result = api_instance.create_sync_product(product1, opts)
46
+ p result
47
+ rescue Printful::ApiError => e
48
+ puts "Error when calling ProductsAPIClient->create_sync_product: #{e}"
49
+ end
50
+ ```
51
+
52
+ #### Using the create_sync_product_with_http_info variant
53
+
54
+ This returns an Array which contains the response data, status code and headers.
55
+
56
+ > <Array(<CreateSyncProduct200Response>, Integer, Hash)> create_sync_product_with_http_info(product1, opts)
57
+
58
+ ```ruby
59
+ begin
60
+ # Create a new Sync Product
61
+ data, status_code, headers = api_instance.create_sync_product_with_http_info(product1, opts)
62
+ p status_code # => 2xx
63
+ p headers # => { ... }
64
+ p data # => <CreateSyncProduct200Response>
65
+ rescue Printful::ApiError => e
66
+ puts "Error when calling ProductsAPIClient->create_sync_product_with_http_info: #{e}"
67
+ end
68
+ ```
69
+
70
+ ### Parameters
71
+
72
+ | Name | Type | Description | Notes |
73
+ | ---- | ---- | ----------- | ----- |
74
+ | **product1** | [**Product1**](Product1.md) | POST request body | |
75
+ | **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
76
+
77
+ ### Return type
78
+
79
+ [**CreateSyncProduct200Response**](CreateSyncProduct200Response.md)
80
+
81
+ ### Authorization
82
+
83
+ [OAuth](../README.md#OAuth)
84
+
85
+ ### HTTP request headers
86
+
87
+ - **Content-Type**: application/json
88
+ - **Accept**: application/json
89
+
90
+
91
+ ## create_sync_variant
92
+
93
+ > <GetSyncVariantById200Response> create_sync_variant(id, product1_sync_variants_inner, opts)
94
+
95
+ Create a new Sync Variant
96
+
97
+ Creates a new Sync Variant for an existing Sync Product ([See examples](#section/Products-API-examples/Create-a-new-Sync-Variant)).
98
+
99
+ ### Examples
100
+
101
+ ```ruby
102
+ require 'time'
103
+ require 'printful_client'
104
+ # setup authorization
105
+ Printful.configure do |config|
106
+ # Configure OAuth2 access token for authorization: OAuth
107
+ config.access_token = 'YOUR ACCESS TOKEN'
108
+ end
109
+
110
+ api_instance = Printful::ProductsAPIClient.new
111
+ id = nil # GetSyncProductByIdIdParameter | Sync Product ID (integer) or External ID (if prefixed with @)
112
+ product1_sync_variants_inner = Printful::Product1SyncVariantsInner.new({variant_id: 3001, files: [3.56]}) # Product1SyncVariantsInner | POST request body
113
+ opts = {
114
+ 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)
115
+ }
116
+
117
+ begin
118
+ # Create a new Sync Variant
119
+ result = api_instance.create_sync_variant(id, product1_sync_variants_inner, opts)
120
+ p result
121
+ rescue Printful::ApiError => e
122
+ puts "Error when calling ProductsAPIClient->create_sync_variant: #{e}"
123
+ end
124
+ ```
125
+
126
+ #### Using the create_sync_variant_with_http_info variant
127
+
128
+ This returns an Array which contains the response data, status code and headers.
129
+
130
+ > <Array(<GetSyncVariantById200Response>, Integer, Hash)> create_sync_variant_with_http_info(id, product1_sync_variants_inner, opts)
131
+
132
+ ```ruby
133
+ begin
134
+ # Create a new Sync Variant
135
+ data, status_code, headers = api_instance.create_sync_variant_with_http_info(id, product1_sync_variants_inner, opts)
136
+ p status_code # => 2xx
137
+ p headers # => { ... }
138
+ p data # => <GetSyncVariantById200Response>
139
+ rescue Printful::ApiError => e
140
+ puts "Error when calling ProductsAPIClient->create_sync_variant_with_http_info: #{e}"
141
+ end
142
+ ```
143
+
144
+ ### Parameters
145
+
146
+ | Name | Type | Description | Notes |
147
+ | ---- | ---- | ----------- | ----- |
148
+ | **id** | [**GetSyncProductByIdIdParameter**](.md) | Sync Product ID (integer) or External ID (if prefixed with @) | |
149
+ | **product1_sync_variants_inner** | [**Product1SyncVariantsInner**](Product1SyncVariantsInner.md) | POST request body | |
150
+ | **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
151
+
152
+ ### Return type
153
+
154
+ [**GetSyncVariantById200Response**](GetSyncVariantById200Response.md)
155
+
156
+ ### Authorization
157
+
158
+ [OAuth](../README.md#OAuth)
159
+
160
+ ### HTTP request headers
161
+
162
+ - **Content-Type**: application/json
163
+ - **Accept**: application/json
164
+
165
+
166
+ ## delete_sync_product
167
+
168
+ > <GetSyncProductById200Response> delete_sync_product(id, opts)
169
+
170
+ Delete a Sync Product
171
+
172
+ Deletes a Sync Product with all of its Sync Variants
173
+
174
+ ### Examples
175
+
176
+ ```ruby
177
+ require 'time'
178
+ require 'printful_client'
179
+ # setup authorization
180
+ Printful.configure do |config|
181
+ # Configure OAuth2 access token for authorization: OAuth
182
+ config.access_token = 'YOUR ACCESS TOKEN'
183
+ end
184
+
185
+ api_instance = Printful::ProductsAPIClient.new
186
+ id = nil # GetSyncProductByIdIdParameter | Sync Product ID (integer) or External ID (if prefixed with @)
187
+ opts = {
188
+ 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)
189
+ }
190
+
191
+ begin
192
+ # Delete a Sync Product
193
+ result = api_instance.delete_sync_product(id, opts)
194
+ p result
195
+ rescue Printful::ApiError => e
196
+ puts "Error when calling ProductsAPIClient->delete_sync_product: #{e}"
197
+ end
198
+ ```
199
+
200
+ #### Using the delete_sync_product_with_http_info variant
201
+
202
+ This returns an Array which contains the response data, status code and headers.
203
+
204
+ > <Array(<GetSyncProductById200Response>, Integer, Hash)> delete_sync_product_with_http_info(id, opts)
205
+
206
+ ```ruby
207
+ begin
208
+ # Delete a Sync Product
209
+ data, status_code, headers = api_instance.delete_sync_product_with_http_info(id, opts)
210
+ p status_code # => 2xx
211
+ p headers # => { ... }
212
+ p data # => <GetSyncProductById200Response>
213
+ rescue Printful::ApiError => e
214
+ puts "Error when calling ProductsAPIClient->delete_sync_product_with_http_info: #{e}"
215
+ end
216
+ ```
217
+
218
+ ### Parameters
219
+
220
+ | Name | Type | Description | Notes |
221
+ | ---- | ---- | ----------- | ----- |
222
+ | **id** | [**GetSyncProductByIdIdParameter**](.md) | Sync Product ID (integer) or External ID (if prefixed with @) | |
223
+ | **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
224
+
225
+ ### Return type
226
+
227
+ [**GetSyncProductById200Response**](GetSyncProductById200Response.md)
228
+
229
+ ### Authorization
230
+
231
+ [OAuth](../README.md#OAuth)
232
+
233
+ ### HTTP request headers
234
+
235
+ - **Content-Type**: Not defined
236
+ - **Accept**: application/json
237
+
238
+
239
+ ## delete_sync_variant
240
+
241
+ > <DeleteSyncVariant200Response> delete_sync_variant(id, opts)
242
+
243
+ Delete a Sync Variant
244
+
245
+ Deletes a single Sync Variant.
246
+
247
+ ### Examples
248
+
249
+ ```ruby
250
+ require 'time'
251
+ require 'printful_client'
252
+ # setup authorization
253
+ Printful.configure do |config|
254
+ # Configure OAuth2 access token for authorization: OAuth
255
+ config.access_token = 'YOUR ACCESS TOKEN'
256
+ end
257
+
258
+ api_instance = Printful::ProductsAPIClient.new
259
+ id = nil # GetSyncProductByIdIdParameter | Sync Variant ID (integer) or External ID (if prefixed with @)
260
+ opts = {
261
+ 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)
262
+ }
263
+
264
+ begin
265
+ # Delete a Sync Variant
266
+ result = api_instance.delete_sync_variant(id, opts)
267
+ p result
268
+ rescue Printful::ApiError => e
269
+ puts "Error when calling ProductsAPIClient->delete_sync_variant: #{e}"
270
+ end
271
+ ```
272
+
273
+ #### Using the delete_sync_variant_with_http_info variant
274
+
275
+ This returns an Array which contains the response data, status code and headers.
276
+
277
+ > <Array(<DeleteSyncVariant200Response>, Integer, Hash)> delete_sync_variant_with_http_info(id, opts)
278
+
279
+ ```ruby
280
+ begin
281
+ # Delete a Sync Variant
282
+ data, status_code, headers = api_instance.delete_sync_variant_with_http_info(id, opts)
283
+ p status_code # => 2xx
284
+ p headers # => { ... }
285
+ p data # => <DeleteSyncVariant200Response>
286
+ rescue Printful::ApiError => e
287
+ puts "Error when calling ProductsAPIClient->delete_sync_variant_with_http_info: #{e}"
288
+ end
289
+ ```
290
+
291
+ ### Parameters
292
+
293
+ | Name | Type | Description | Notes |
294
+ | ---- | ---- | ----------- | ----- |
295
+ | **id** | [**GetSyncProductByIdIdParameter**](.md) | Sync Variant ID (integer) or External ID (if prefixed with @) | |
296
+ | **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
297
+
298
+ ### Return type
299
+
300
+ [**DeleteSyncVariant200Response**](DeleteSyncVariant200Response.md)
301
+
302
+ ### Authorization
303
+
304
+ [OAuth](../README.md#OAuth)
305
+
306
+ ### HTTP request headers
307
+
308
+ - **Content-Type**: Not defined
309
+ - **Accept**: application/json
310
+
311
+
312
+ ## get_sync_product_by_id
313
+
314
+ > <GetSyncProductById200Response> get_sync_product_by_id(id, opts)
315
+
316
+ Get a Sync Product
317
+
318
+ Get information about a single Sync Product and its Sync Variants.
319
+
320
+ ### Examples
321
+
322
+ ```ruby
323
+ require 'time'
324
+ require 'printful_client'
325
+ # setup authorization
326
+ Printful.configure do |config|
327
+ # Configure OAuth2 access token for authorization: OAuth
328
+ config.access_token = 'YOUR ACCESS TOKEN'
329
+ end
330
+
331
+ api_instance = Printful::ProductsAPIClient.new
332
+ id = nil # GetSyncProductByIdIdParameter | Sync Product ID (integer) or External ID (if prefixed with @)
333
+ opts = {
334
+ 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)
335
+ }
336
+
337
+ begin
338
+ # Get a Sync Product
339
+ result = api_instance.get_sync_product_by_id(id, opts)
340
+ p result
341
+ rescue Printful::ApiError => e
342
+ puts "Error when calling ProductsAPIClient->get_sync_product_by_id: #{e}"
343
+ end
344
+ ```
345
+
346
+ #### Using the get_sync_product_by_id_with_http_info variant
347
+
348
+ This returns an Array which contains the response data, status code and headers.
349
+
350
+ > <Array(<GetSyncProductById200Response>, Integer, Hash)> get_sync_product_by_id_with_http_info(id, opts)
351
+
352
+ ```ruby
353
+ begin
354
+ # Get a Sync Product
355
+ data, status_code, headers = api_instance.get_sync_product_by_id_with_http_info(id, opts)
356
+ p status_code # => 2xx
357
+ p headers # => { ... }
358
+ p data # => <GetSyncProductById200Response>
359
+ rescue Printful::ApiError => e
360
+ puts "Error when calling ProductsAPIClient->get_sync_product_by_id_with_http_info: #{e}"
361
+ end
362
+ ```
363
+
364
+ ### Parameters
365
+
366
+ | Name | Type | Description | Notes |
367
+ | ---- | ---- | ----------- | ----- |
368
+ | **id** | [**GetSyncProductByIdIdParameter**](.md) | Sync Product ID (integer) or External ID (if prefixed with @) | |
369
+ | **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
370
+
371
+ ### Return type
372
+
373
+ [**GetSyncProductById200Response**](GetSyncProductById200Response.md)
374
+
375
+ ### Authorization
376
+
377
+ [OAuth](../README.md#OAuth)
378
+
379
+ ### HTTP request headers
380
+
381
+ - **Content-Type**: Not defined
382
+ - **Accept**: application/json
383
+
384
+
385
+ ## get_sync_products
386
+
387
+ > <GetSyncProducts200Response> get_sync_products(opts)
388
+
389
+ Get Sync Products
390
+
391
+ Returns a list of Sync Product objects from your custom Printful store.
392
+
393
+ ### Examples
394
+
395
+ ```ruby
396
+ require 'time'
397
+ require 'printful_client'
398
+ # setup authorization
399
+ Printful.configure do |config|
400
+ # Configure OAuth2 access token for authorization: OAuth
401
+ config.access_token = 'YOUR ACCESS TOKEN'
402
+ end
403
+
404
+ api_instance = Printful::ProductsAPIClient.new
405
+ opts = {
406
+ 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)
407
+ category_id: 'category_id_example' # String | A comma-separated list of Category IDs of the Products that are to be returned
408
+ }
409
+
410
+ begin
411
+ # Get Sync Products
412
+ result = api_instance.get_sync_products(opts)
413
+ p result
414
+ rescue Printful::ApiError => e
415
+ puts "Error when calling ProductsAPIClient->get_sync_products: #{e}"
416
+ end
417
+ ```
418
+
419
+ #### Using the get_sync_products_with_http_info variant
420
+
421
+ This returns an Array which contains the response data, status code and headers.
422
+
423
+ > <Array(<GetSyncProducts200Response>, Integer, Hash)> get_sync_products_with_http_info(opts)
424
+
425
+ ```ruby
426
+ begin
427
+ # Get Sync Products
428
+ data, status_code, headers = api_instance.get_sync_products_with_http_info(opts)
429
+ p status_code # => 2xx
430
+ p headers # => { ... }
431
+ p data # => <GetSyncProducts200Response>
432
+ rescue Printful::ApiError => e
433
+ puts "Error when calling ProductsAPIClient->get_sync_products_with_http_info: #{e}"
434
+ end
435
+ ```
436
+
437
+ ### Parameters
438
+
439
+ | Name | Type | Description | Notes |
440
+ | ---- | ---- | ----------- | ----- |
441
+ | **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
442
+ | **category_id** | **String** | A comma-separated list of Category IDs of the Products that are to be returned | [optional] |
443
+
444
+ ### Return type
445
+
446
+ [**GetSyncProducts200Response**](GetSyncProducts200Response.md)
447
+
448
+ ### Authorization
449
+
450
+ [OAuth](../README.md#OAuth)
451
+
452
+ ### HTTP request headers
453
+
454
+ - **Content-Type**: Not defined
455
+ - **Accept**: application/json
456
+
457
+
458
+ ## get_sync_variant_by_id
459
+
460
+ > <GetSyncVariantById200Response> get_sync_variant_by_id(id, opts)
461
+
462
+ Get a Sync Variant
463
+
464
+ Get information about a single Sync Variant.
465
+
466
+ ### Examples
467
+
468
+ ```ruby
469
+ require 'time'
470
+ require 'printful_client'
471
+ # setup authorization
472
+ Printful.configure do |config|
473
+ # Configure OAuth2 access token for authorization: OAuth
474
+ config.access_token = 'YOUR ACCESS TOKEN'
475
+ end
476
+
477
+ api_instance = Printful::ProductsAPIClient.new
478
+ id = nil # GetSyncProductByIdIdParameter | Sync Variant ID (integer) or External ID (if prefixed with @)
479
+ opts = {
480
+ 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)
481
+ }
482
+
483
+ begin
484
+ # Get a Sync Variant
485
+ result = api_instance.get_sync_variant_by_id(id, opts)
486
+ p result
487
+ rescue Printful::ApiError => e
488
+ puts "Error when calling ProductsAPIClient->get_sync_variant_by_id: #{e}"
489
+ end
490
+ ```
491
+
492
+ #### Using the get_sync_variant_by_id_with_http_info variant
493
+
494
+ This returns an Array which contains the response data, status code and headers.
495
+
496
+ > <Array(<GetSyncVariantById200Response>, Integer, Hash)> get_sync_variant_by_id_with_http_info(id, opts)
497
+
498
+ ```ruby
499
+ begin
500
+ # Get a Sync Variant
501
+ data, status_code, headers = api_instance.get_sync_variant_by_id_with_http_info(id, opts)
502
+ p status_code # => 2xx
503
+ p headers # => { ... }
504
+ p data # => <GetSyncVariantById200Response>
505
+ rescue Printful::ApiError => e
506
+ puts "Error when calling ProductsAPIClient->get_sync_variant_by_id_with_http_info: #{e}"
507
+ end
508
+ ```
509
+
510
+ ### Parameters
511
+
512
+ | Name | Type | Description | Notes |
513
+ | ---- | ---- | ----------- | ----- |
514
+ | **id** | [**GetSyncProductByIdIdParameter**](.md) | Sync Variant ID (integer) or External ID (if prefixed with @) | |
515
+ | **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
516
+
517
+ ### Return type
518
+
519
+ [**GetSyncVariantById200Response**](GetSyncVariantById200Response.md)
520
+
521
+ ### Authorization
522
+
523
+ [OAuth](../README.md#OAuth)
524
+
525
+ ### HTTP request headers
526
+
527
+ - **Content-Type**: Not defined
528
+ - **Accept**: application/json
529
+
530
+
531
+ ## update_sync_product
532
+
533
+ > <CreateSyncProduct200Response> update_sync_product(id, update_sync_product_request, opts)
534
+
535
+ Modify a Sync Product
536
+
537
+ Modifies an existing Sync Product with its Sync Variants. Please note that in the request body you only need to specify the fields that need to be changed. Furthermore, if you want to update existing sync variants, then in the sync variants array you must specify the IDs of all existing sync variants. All omitted existing sync variants will be deleted. All new sync variants without an ID will be created. See examples for more insights. **Rate limiting:** Up to 10 requests per 60 seconds. A 60 seconds lockout is applied if request count is exceeded. [See examples](#section/Products-API-examples/Modify-a-Sync-Product)
538
+
539
+ ### Examples
540
+
541
+ ```ruby
542
+ require 'time'
543
+ require 'printful_client'
544
+ # setup authorization
545
+ Printful.configure do |config|
546
+ # Configure OAuth2 access token for authorization: OAuth
547
+ config.access_token = 'YOUR ACCESS TOKEN'
548
+ end
549
+
550
+ api_instance = Printful::ProductsAPIClient.new
551
+ id = nil # GetSyncProductByIdIdParameter | Sync Product ID (integer) or External ID (if prefixed with @)
552
+ update_sync_product_request = Printful::UpdateSyncProductRequest.new # UpdateSyncProductRequest | PUT request body
553
+ opts = {
554
+ 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)
555
+ }
556
+
557
+ begin
558
+ # Modify a Sync Product
559
+ result = api_instance.update_sync_product(id, update_sync_product_request, opts)
560
+ p result
561
+ rescue Printful::ApiError => e
562
+ puts "Error when calling ProductsAPIClient->update_sync_product: #{e}"
563
+ end
564
+ ```
565
+
566
+ #### Using the update_sync_product_with_http_info variant
567
+
568
+ This returns an Array which contains the response data, status code and headers.
569
+
570
+ > <Array(<CreateSyncProduct200Response>, Integer, Hash)> update_sync_product_with_http_info(id, update_sync_product_request, opts)
571
+
572
+ ```ruby
573
+ begin
574
+ # Modify a Sync Product
575
+ data, status_code, headers = api_instance.update_sync_product_with_http_info(id, update_sync_product_request, opts)
576
+ p status_code # => 2xx
577
+ p headers # => { ... }
578
+ p data # => <CreateSyncProduct200Response>
579
+ rescue Printful::ApiError => e
580
+ puts "Error when calling ProductsAPIClient->update_sync_product_with_http_info: #{e}"
581
+ end
582
+ ```
583
+
584
+ ### Parameters
585
+
586
+ | Name | Type | Description | Notes |
587
+ | ---- | ---- | ----------- | ----- |
588
+ | **id** | [**GetSyncProductByIdIdParameter**](.md) | Sync Product ID (integer) or External ID (if prefixed with @) | |
589
+ | **update_sync_product_request** | [**UpdateSyncProductRequest**](UpdateSyncProductRequest.md) | PUT request body | |
590
+ | **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
591
+
592
+ ### Return type
593
+
594
+ [**CreateSyncProduct200Response**](CreateSyncProduct200Response.md)
595
+
596
+ ### Authorization
597
+
598
+ [OAuth](../README.md#OAuth)
599
+
600
+ ### HTTP request headers
601
+
602
+ - **Content-Type**: application/json
603
+ - **Accept**: application/json
604
+
605
+
606
+ ## update_sync_variant
607
+
608
+ > <GetSyncVariantById200Response> update_sync_variant(id, update_sync_variant_request, opts)
609
+
610
+ Modify a Sync Variant
611
+
612
+ Modifies an existing Sync Variant. Please note that in the request body you only need to specify the fields that need to be changed. See examples for more insights. [See examples](#section/Products-API-examples/Modify-a-Sync-Variant)
613
+
614
+ ### Examples
615
+
616
+ ```ruby
617
+ require 'time'
618
+ require 'printful_client'
619
+ # setup authorization
620
+ Printful.configure do |config|
621
+ # Configure OAuth2 access token for authorization: OAuth
622
+ config.access_token = 'YOUR ACCESS TOKEN'
623
+ end
624
+
625
+ api_instance = Printful::ProductsAPIClient.new
626
+ id = nil # GetSyncProductByIdIdParameter | Sync Variant ID (integer) or External ID (if prefixed with @)
627
+ update_sync_variant_request = Printful::UpdateSyncVariantRequest.new # UpdateSyncVariantRequest | POST request body
628
+ opts = {
629
+ 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)
630
+ }
631
+
632
+ begin
633
+ # Modify a Sync Variant
634
+ result = api_instance.update_sync_variant(id, update_sync_variant_request, opts)
635
+ p result
636
+ rescue Printful::ApiError => e
637
+ puts "Error when calling ProductsAPIClient->update_sync_variant: #{e}"
638
+ end
639
+ ```
640
+
641
+ #### Using the update_sync_variant_with_http_info variant
642
+
643
+ This returns an Array which contains the response data, status code and headers.
644
+
645
+ > <Array(<GetSyncVariantById200Response>, Integer, Hash)> update_sync_variant_with_http_info(id, update_sync_variant_request, opts)
646
+
647
+ ```ruby
648
+ begin
649
+ # Modify a Sync Variant
650
+ data, status_code, headers = api_instance.update_sync_variant_with_http_info(id, update_sync_variant_request, opts)
651
+ p status_code # => 2xx
652
+ p headers # => { ... }
653
+ p data # => <GetSyncVariantById200Response>
654
+ rescue Printful::ApiError => e
655
+ puts "Error when calling ProductsAPIClient->update_sync_variant_with_http_info: #{e}"
656
+ end
657
+ ```
658
+
659
+ ### Parameters
660
+
661
+ | Name | Type | Description | Notes |
662
+ | ---- | ---- | ----------- | ----- |
663
+ | **id** | [**GetSyncProductByIdIdParameter**](.md) | Sync Variant ID (integer) or External ID (if prefixed with @) | |
664
+ | **update_sync_variant_request** | [**UpdateSyncVariantRequest**](UpdateSyncVariantRequest.md) | POST request body | |
665
+ | **x_pf_store_id** | **String** | Use this to specify which store you want to use (required only for account level token) | [optional] |
666
+
667
+ ### Return type
668
+
669
+ [**GetSyncVariantById200Response**](GetSyncVariantById200Response.md)
670
+
671
+ ### Authorization
672
+
673
+ [OAuth](../README.md#OAuth)
674
+
675
+ ### HTTP request headers
676
+
677
+ - **Content-Type**: application/json
678
+ - **Accept**: application/json
679
+
data/docs/Profit.md ADDED
@@ -0,0 +1,20 @@
1
+ # Printful::Profit
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **Float** | The difference between Sales and Fulfillment. If retail price data is not available, profit might be negative | [optional] |
8
+ | **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] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'printful_client'
14
+
15
+ instance = Printful::Profit.new(
16
+ value: null,
17
+ relative_difference: null
18
+ )
19
+ ```
20
+