ultracart_api 3.10.19 → 4.0.34.rc

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 (1319) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -7
  3. data/README.md +1170 -1133
  4. data/Rakefile +10 -8
  5. data/docs/AccountsReceivableRetryConfig.md +46 -22
  6. data/docs/AccountsReceivableRetryConfigResponse.md +32 -15
  7. data/docs/AccountsReceivableRetryDayActivity.md +22 -10
  8. data/docs/AccountsReceivableRetryStatAccount.md +24 -11
  9. data/docs/AccountsReceivableRetryStatMetrics.md +38 -18
  10. data/docs/AccountsReceivableRetryStatRevenue.md +20 -9
  11. data/docs/AccountsReceivableRetryStatsResponse.md +28 -13
  12. data/docs/Activity.md +28 -13
  13. data/docs/AddLibraryItemRequest.md +38 -18
  14. data/docs/AdjustInternalCertificateRequest.md +28 -13
  15. data/docs/AdjustInternalCertificateResponse.md +28 -13
  16. data/docs/AffiliateApi.md +167 -126
  17. data/docs/AffiliateClick.md +38 -18
  18. data/docs/AffiliateClickQuery.md +28 -13
  19. data/docs/AffiliateClicksResponse.md +26 -12
  20. data/docs/AffiliateLedger.md +54 -26
  21. data/docs/AffiliateLedgerQuery.md +28 -13
  22. data/docs/AffiliateLedgersResponse.md +26 -12
  23. data/docs/AffiliateLink.md +44 -21
  24. data/docs/ApiUserApplicationProfile.md +26 -12
  25. data/docs/ApplyLibraryItemRequest.md +24 -11
  26. data/docs/ApplyLibraryItemResponse.md +38 -18
  27. data/docs/AutoOrder.md +60 -29
  28. data/docs/AutoOrderApi.md +669 -502
  29. data/docs/AutoOrderItem.md +64 -31
  30. data/docs/AutoOrderItemFutureSchedule.md +24 -11
  31. data/docs/AutoOrderItemOption.md +20 -9
  32. data/docs/AutoOrderItemSimpleSchedule.md +22 -10
  33. data/docs/AutoOrderLog.md +20 -9
  34. data/docs/AutoOrderQuery.md +58 -28
  35. data/docs/AutoOrderQueryBatch.md +18 -8
  36. data/docs/AutoOrderResponse.md +26 -12
  37. data/docs/AutoOrdersRequest.md +18 -8
  38. data/docs/AutoOrdersResponse.md +26 -12
  39. data/docs/AvalaraConfig.md +42 -20
  40. data/docs/BaseResponse.md +24 -11
  41. data/docs/Browser.md +22 -10
  42. data/docs/BrowserDevice.md +18 -8
  43. data/docs/BrowserOS.md +26 -12
  44. data/docs/BrowserUserAgent.md +24 -11
  45. data/docs/Cart.md +68 -33
  46. data/docs/CartAffiliate.md +20 -9
  47. data/docs/CartAffirmCheckoutResponse.md +20 -9
  48. data/docs/CartBilling.md +46 -22
  49. data/docs/CartBuysafe.md +28 -13
  50. data/docs/CartCheckout.md +44 -21
  51. data/docs/CartCoupon.md +18 -8
  52. data/docs/CartCurrencyConversion.md +20 -9
  53. data/docs/CartCustomerProfile.md +60 -29
  54. data/docs/CartCustomerProfileAddress.md +44 -21
  55. data/docs/CartCustomerProfileCreditCard.md +28 -13
  56. data/docs/CartFinalizeOrderRequest.md +20 -9
  57. data/docs/CartFinalizeOrderRequestOptions.md +42 -20
  58. data/docs/CartFinalizeOrderResponse.md +26 -12
  59. data/docs/CartGift.md +28 -13
  60. data/docs/CartGiftCertificate.md +22 -10
  61. data/docs/CartItem.md +74 -36
  62. data/docs/CartItemAttribute.md +22 -10
  63. data/docs/CartItemMultimedia.md +34 -16
  64. data/docs/CartItemMultimediaThumbnail.md +26 -12
  65. data/docs/CartItemOption.md +40 -19
  66. data/docs/CartItemOptionValue.md +26 -12
  67. data/docs/CartItemPhysical.md +24 -11
  68. data/docs/CartItemVariationSelection.md +20 -9
  69. data/docs/CartKitComponentOption.md +44 -21
  70. data/docs/CartMarketing.md +20 -9
  71. data/docs/CartPayment.md +30 -14
  72. data/docs/CartPaymentAffirm.md +18 -8
  73. data/docs/CartPaymentAmazon.md +18 -8
  74. data/docs/CartPaymentCheck.md +18 -8
  75. data/docs/CartPaymentCreditCard.md +34 -16
  76. data/docs/CartPaymentPurchaseOrder.md +18 -8
  77. data/docs/CartProfileLoginRequest.md +22 -10
  78. data/docs/CartProfileLoginResponse.md +20 -9
  79. data/docs/CartProfileRegisterRequest.md +20 -9
  80. data/docs/CartProfileRegisterResponse.md +20 -9
  81. data/docs/CartProperty.md +24 -11
  82. data/docs/CartResponse.md +20 -9
  83. data/docs/CartSettings.md +28 -13
  84. data/docs/CartSettingsBilling.md +18 -8
  85. data/docs/CartSettingsGift.md +24 -11
  86. data/docs/CartSettingsGiftWrap.md +22 -10
  87. data/docs/CartSettingsPayment.md +42 -20
  88. data/docs/CartSettingsPaymentAmazon.md +22 -10
  89. data/docs/CartSettingsPaymentCreditCard.md +22 -10
  90. data/docs/CartSettingsPaymentPayPal.md +26 -12
  91. data/docs/CartSettingsProvince.md +20 -9
  92. data/docs/CartSettingsShipping.md +26 -12
  93. data/docs/CartSettingsShippingCalendar.md +26 -12
  94. data/docs/CartSettingsShippingEstimate.md +44 -21
  95. data/docs/CartSettingsTaxes.md +18 -8
  96. data/docs/CartSettingsTerms.md +20 -9
  97. data/docs/CartShipping.md +54 -26
  98. data/docs/CartSummary.md +48 -23
  99. data/docs/CartTaxes.md +22 -10
  100. data/docs/CartUpsellAfter.md +22 -10
  101. data/docs/CartValidationRequest.md +20 -9
  102. data/docs/CartValidationResponse.md +20 -9
  103. data/docs/ChannelPartnerApi.md +367 -263
  104. data/docs/ChannelPartnerCancelResponse.md +26 -12
  105. data/docs/ChannelPartnerEstimateShippingResponse.md +26 -12
  106. data/docs/ChannelPartnerEstimateTaxResponse.md +26 -12
  107. data/docs/ChannelPartnerImportResponse.md +30 -14
  108. data/docs/ChannelPartnerOrder.md +176 -87
  109. data/docs/ChannelPartnerOrderItem.md +30 -14
  110. data/docs/ChannelPartnerOrderItemOption.md +20 -9
  111. data/docs/ChannelPartnerOrderTransaction.md +20 -9
  112. data/docs/ChannelPartnerOrderTransactionDetail.md +20 -9
  113. data/docs/ChannelPartnerShippingEstimate.md +20 -9
  114. data/docs/ChargebackApi.md +405 -301
  115. data/docs/ChargebackDispute.md +62 -30
  116. data/docs/ChargebackDisputeResponse.md +26 -12
  117. data/docs/ChargebackDisputesResponse.md +26 -12
  118. data/docs/CheckoutAllowedCountriesResponse.md +18 -8
  119. data/docs/CheckoutApi.md +1424 -1023
  120. data/docs/CheckoutHandoffRequest.md +32 -15
  121. data/docs/CheckoutHandoffResponse.md +22 -10
  122. data/docs/CheckoutSetupBrowserKeyRequest.md +18 -8
  123. data/docs/CheckoutSetupBrowserKeyResponse.md +18 -8
  124. data/docs/CheckoutStateProvinceResponse.md +18 -8
  125. data/docs/CityStateZip.md +26 -12
  126. data/docs/CountriesResponse.md +18 -8
  127. data/docs/Country.md +20 -9
  128. data/docs/Coupon.md +136 -67
  129. data/docs/CouponAmountOffItems.md +24 -11
  130. data/docs/CouponAmountOffShipping.md +22 -10
  131. data/docs/CouponAmountOffShippingWithItemsPurchase.md +24 -11
  132. data/docs/CouponAmountOffSubtotal.md +20 -9
  133. data/docs/CouponAmountOffSubtotalAndShipping.md +20 -9
  134. data/docs/CouponAmountOffSubtotalFreeShippingWithPurchase.md +24 -11
  135. data/docs/CouponAmountOffSubtotalWithBlockPurchase.md +24 -11
  136. data/docs/CouponAmountOffSubtotalWithItemsPurchase.md +24 -11
  137. data/docs/CouponAmountOffSubtotalWithPurchase.md +22 -10
  138. data/docs/CouponAmountShippingWithSubtotal.md +24 -11
  139. data/docs/CouponApi.md +1443 -1043
  140. data/docs/CouponAutoApplyCondition.md +22 -10
  141. data/docs/CouponAutoApplyConditions.md +28 -13
  142. data/docs/CouponAutomaticallyApplyCouponCodes.md +18 -8
  143. data/docs/CouponBuyOneGetOneLimit.md +20 -9
  144. data/docs/CouponCodesRequest.md +30 -14
  145. data/docs/CouponCodesResponse.md +28 -13
  146. data/docs/CouponDeletesRequest.md +20 -9
  147. data/docs/CouponDiscountItemWithItemPurchase.md +26 -12
  148. data/docs/CouponDiscountItems.md +24 -11
  149. data/docs/CouponEditorValues.md +36 -17
  150. data/docs/CouponExistsResponse.md +28 -13
  151. data/docs/CouponFreeItemAndShippingWithSubtotal.md +26 -12
  152. data/docs/CouponFreeItemWithItemPurchase.md +24 -11
  153. data/docs/CouponFreeItemWithSubtotal.md +24 -11
  154. data/docs/CouponFreeItemsWithItemPurchase.md +26 -12
  155. data/docs/CouponFreeItemsWithMixMatchPurchase.md +26 -12
  156. data/docs/CouponFreeShipping.md +18 -8
  157. data/docs/CouponFreeShippingSpecificItems.md +18 -8
  158. data/docs/CouponFreeShippingWithItemsPurchase.md +20 -9
  159. data/docs/CouponFreeShippingWithSubtotal.md +22 -10
  160. data/docs/CouponItemSearchResult.md +32 -15
  161. data/docs/CouponItemSearchResultsResponse.md +26 -12
  162. data/docs/CouponMultipleAmountsOffItems.md +20 -9
  163. data/docs/CouponPercentOffItemWithItemsQuantityPurchase.md +26 -12
  164. data/docs/CouponPercentOffItems.md +24 -11
  165. data/docs/CouponPercentOffItemsAndFreeShipping.md +22 -10
  166. data/docs/CouponPercentOffItemsWithItemsPurchase.md +24 -11
  167. data/docs/CouponPercentOffMsrpItems.md +24 -11
  168. data/docs/CouponPercentOffRetailPriceItems.md +24 -11
  169. data/docs/CouponPercentOffShipping.md +20 -9
  170. data/docs/CouponPercentOffSubtotal.md +18 -8
  171. data/docs/CouponPercentOffSubtotalAndFreeShipping.md +20 -9
  172. data/docs/CouponPercentOffSubtotalLimit.md +22 -10
  173. data/docs/CouponPercentOffSubtotalWithItemsPurchase.md +20 -9
  174. data/docs/CouponPercentOffSubtotalWithSubtotal.md +22 -10
  175. data/docs/CouponQuery.md +36 -17
  176. data/docs/CouponResponse.md +28 -13
  177. data/docs/CouponRestriction.md +24 -11
  178. data/docs/CouponTierAmount.md +22 -10
  179. data/docs/CouponTierItemDiscount.md +20 -9
  180. data/docs/CouponTierPercent.md +22 -10
  181. data/docs/CouponTierQuantityAmount.md +22 -10
  182. data/docs/CouponTierQuantityPercent.md +22 -10
  183. data/docs/CouponTieredAmountOffItems.md +22 -10
  184. data/docs/CouponTieredAmountOffSubtotal.md +20 -9
  185. data/docs/CouponTieredPercentOffItems.md +22 -10
  186. data/docs/CouponTieredPercentOffShipping.md +22 -10
  187. data/docs/CouponTieredPercentOffSubtotal.md +20 -9
  188. data/docs/CouponType.md +20 -9
  189. data/docs/CouponsRequest.md +18 -8
  190. data/docs/CouponsResponse.md +26 -12
  191. data/docs/Currency.md +26 -12
  192. data/docs/Customer.md +134 -66
  193. data/docs/CustomerActivity.md +32 -15
  194. data/docs/CustomerAffiliate.md +24 -11
  195. data/docs/CustomerApi.md +1401 -1023
  196. data/docs/CustomerAttachment.md +26 -12
  197. data/docs/CustomerBilling.md +50 -24
  198. data/docs/CustomerCard.md +32 -15
  199. data/docs/CustomerEditorValues.md +36 -17
  200. data/docs/CustomerEmail.md +28 -13
  201. data/docs/CustomerEmailListChanges.md +20 -9
  202. data/docs/CustomerLoyalty.md +30 -14
  203. data/docs/CustomerLoyaltyLedger.md +46 -22
  204. data/docs/CustomerLoyaltyRedemption.md +42 -20
  205. data/docs/CustomerMergeRequest.md +20 -9
  206. data/docs/CustomerOrdersSummary.md +24 -11
  207. data/docs/CustomerPricingTier.md +20 -9
  208. data/docs/CustomerPrivacy.md +24 -11
  209. data/docs/CustomerQuery.md +74 -36
  210. data/docs/CustomerQuotesSummary.md +24 -11
  211. data/docs/CustomerResponse.md +26 -12
  212. data/docs/CustomerReviewer.md +36 -17
  213. data/docs/CustomerShipping.md +50 -24
  214. data/docs/CustomerSoftwareEntitlement.md +32 -15
  215. data/docs/CustomerStoreCredit.md +28 -13
  216. data/docs/CustomerStoreCreditAddRequest.md +24 -11
  217. data/docs/CustomerStoreCreditLedgerEntry.md +30 -14
  218. data/docs/CustomerStoreCreditResponse.md +26 -12
  219. data/docs/CustomerTag.md +18 -8
  220. data/docs/CustomerTaxCodes.md +26 -12
  221. data/docs/CustomersResponse.md +26 -12
  222. data/docs/DataTablesServerSideResponse.md +24 -11
  223. data/docs/Distance.md +20 -9
  224. data/docs/DistributionCenter.md +86 -42
  225. data/docs/DistributionCentersResponse.md +26 -12
  226. data/docs/EmailBaseTemplateListResponse.md +18 -8
  227. data/docs/EmailCampaign.md +64 -31
  228. data/docs/EmailCampaignFolder.md +26 -12
  229. data/docs/EmailCampaignFolderResponse.md +26 -12
  230. data/docs/EmailCampaignFoldersResponse.md +26 -12
  231. data/docs/EmailCampaignResponse.md +26 -12
  232. data/docs/EmailCampaignsResponse.md +26 -12
  233. data/docs/EmailClick.md +20 -9
  234. data/docs/EmailClicksResponse.md +26 -12
  235. data/docs/EmailCommseq.md +24 -11
  236. data/docs/EmailCommseqEmail.md +68 -33
  237. data/docs/EmailCommseqEmailResponse.md +26 -12
  238. data/docs/EmailCommseqEmailSendTestRequest.md +36 -17
  239. data/docs/EmailCommseqEmailSendTestResponse.md +24 -11
  240. data/docs/EmailCommseqEmailsRequest.md +26 -12
  241. data/docs/EmailCommseqEmailsResponse.md +26 -12
  242. data/docs/EmailCommseqPostcard.md +42 -20
  243. data/docs/EmailCommseqPostcardResponse.md +26 -12
  244. data/docs/EmailCommseqPostcardSendTestRequest.md +42 -20
  245. data/docs/EmailCommseqPostcardSendTestResponse.md +30 -14
  246. data/docs/EmailCommseqPostcardsRequest.md +18 -8
  247. data/docs/EmailCommseqPostcardsResponse.md +26 -12
  248. data/docs/EmailCommseqResponse.md +26 -12
  249. data/docs/EmailCommseqStat.md +90 -44
  250. data/docs/EmailCommseqStatResponse.md +26 -12
  251. data/docs/EmailCommseqStep.md +36 -17
  252. data/docs/EmailCommseqStepLog.md +22 -10
  253. data/docs/EmailCommseqStepLogsResponse.md +26 -12
  254. data/docs/EmailCommseqWebhookSendTestRequest.md +30 -14
  255. data/docs/EmailCommseqWebhookSendTestResponse.md +30 -14
  256. data/docs/EmailCommseqsResponse.md +26 -12
  257. data/docs/EmailCustomer.md +32 -15
  258. data/docs/EmailCustomerEditorUrlResponse.md +26 -12
  259. data/docs/EmailCustomersResponse.md +26 -12
  260. data/docs/EmailDashboardActivity.md +30 -14
  261. data/docs/EmailDashboardActivityResponse.md +26 -12
  262. data/docs/EmailDashboardStatsResponse.md +26 -12
  263. data/docs/EmailDomain.md +42 -20
  264. data/docs/EmailEditorTokenResponse.md +26 -12
  265. data/docs/EmailFlow.md +72 -35
  266. data/docs/EmailFlowBackPopulateRequest.md +20 -9
  267. data/docs/EmailFlowBackPopulateResponse.md +24 -11
  268. data/docs/EmailFlowFolder.md +26 -12
  269. data/docs/EmailFlowFolderResponse.md +26 -12
  270. data/docs/EmailFlowFoldersResponse.md +26 -12
  271. data/docs/EmailFlowResponse.md +26 -12
  272. data/docs/EmailFlowsResponse.md +26 -12
  273. data/docs/EmailGlobalSettings.md +18 -8
  274. data/docs/EmailGlobalSettingsResponse.md +26 -12
  275. data/docs/EmailGlobalUnsubscribeRequest.md +18 -8
  276. data/docs/EmailGlobalUnsubscribeResponse.md +18 -8
  277. data/docs/EmailHistogramPropertyNamesResponse.md +18 -8
  278. data/docs/EmailHistogramPropertyValuesResponse.md +18 -8
  279. data/docs/EmailList.md +40 -19
  280. data/docs/EmailListArchiveResponse.md +26 -12
  281. data/docs/EmailListCustomer.md +24 -11
  282. data/docs/EmailListCustomersResponse.md +26 -12
  283. data/docs/EmailListResponse.md +26 -12
  284. data/docs/EmailListSegmentFolder.md +26 -12
  285. data/docs/EmailListSegmentFolderResponse.md +26 -12
  286. data/docs/EmailListSegmentFoldersResponse.md +26 -12
  287. data/docs/EmailListSegmentMembership.md +24 -11
  288. data/docs/EmailListSegmentUsedBy.md +22 -10
  289. data/docs/EmailListSubscribeResponse.md +20 -9
  290. data/docs/EmailListsResponse.md +26 -12
  291. data/docs/EmailOrder.md +24 -11
  292. data/docs/EmailOrdersResponse.md +26 -12
  293. data/docs/EmailPerformance.md +62 -30
  294. data/docs/EmailPerformanceCustomerHistogram.md +18 -8
  295. data/docs/EmailPerformanceCustomerHistogramPeriod.md +26 -12
  296. data/docs/EmailPerformanceDaily.md +30 -14
  297. data/docs/EmailPerformanceResponse.md +26 -12
  298. data/docs/EmailPlan.md +50 -24
  299. data/docs/EmailPlanAdditional.md +34 -16
  300. data/docs/EmailPlanResponse.md +26 -12
  301. data/docs/EmailPostcardStat.md +80 -39
  302. data/docs/EmailSegment.md +58 -28
  303. data/docs/EmailSegmentArchiveResponse.md +26 -12
  304. data/docs/EmailSegmentCustomer.md +24 -11
  305. data/docs/EmailSegmentCustomersResponse.md +26 -12
  306. data/docs/EmailSegmentDownloadPrepareResponse.md +32 -15
  307. data/docs/EmailSegmentResponse.md +26 -12
  308. data/docs/EmailSegmentsResponse.md +26 -12
  309. data/docs/EmailSendingDomainResponse.md +26 -12
  310. data/docs/EmailSendingDomainsResponse.md +26 -12
  311. data/docs/EmailSettings.md +40 -19
  312. data/docs/EmailSettingsResponse.md +26 -12
  313. data/docs/EmailStat.md +92 -45
  314. data/docs/EmailStatPostcardSummaryRequest.md +20 -9
  315. data/docs/EmailStatPostcardSummaryResponse.md +26 -12
  316. data/docs/EmailStatSummaryRequest.md +22 -10
  317. data/docs/EmailStatSummaryResponse.md +26 -12
  318. data/docs/EmailStepStat.md +56 -27
  319. data/docs/EmailStepStatRequest.md +20 -9
  320. data/docs/EmailStepStatResponse.md +26 -12
  321. data/docs/EmailStepWaitingRequest.md +18 -8
  322. data/docs/EmailStepWaitingResponse.md +18 -8
  323. data/docs/EmailTemplate.md +38 -18
  324. data/docs/EmailTemplatesResponse.md +26 -12
  325. data/docs/EmailThirdPartyList.md +20 -9
  326. data/docs/EmailThirdPartyListImportRequest.md +18 -8
  327. data/docs/EmailThirdPartyProvider.md +38 -18
  328. data/docs/EmailThirdPartyProvidersResponse.md +26 -12
  329. data/docs/EmailThirdPartyTag.md +20 -9
  330. data/docs/EmailVerifyTokenRequest.md +20 -9
  331. data/docs/EmailVerifyTokenResponse.md +26 -12
  332. data/docs/EmailVerifyTokenValidateRequest.md +18 -8
  333. data/docs/EmailVerifyTokenValidateResponse.md +24 -11
  334. data/docs/EmailWebhookEditorValuesResponse.md +30 -14
  335. data/docs/Error.md +26 -12
  336. data/docs/ErrorResponse.md +24 -11
  337. data/docs/Experiment.md +52 -25
  338. data/docs/ExperimentResponse.md +26 -12
  339. data/docs/ExperimentVariation.md +60 -29
  340. data/docs/ExperimentVariationStat.md +38 -18
  341. data/docs/ExperimentsResponse.md +26 -12
  342. data/docs/FulfillmentApi.md +441 -318
  343. data/docs/FulfillmentInventory.md +20 -9
  344. data/docs/FulfillmentShipment.md +26 -12
  345. data/docs/GeoPoint.md +20 -9
  346. data/docs/GeocodeRequest.md +26 -12
  347. data/docs/GeocodeResponse.md +28 -13
  348. data/docs/GiftCertificate.md +44 -21
  349. data/docs/GiftCertificateApi.md +598 -433
  350. data/docs/GiftCertificateCreateRequest.md +26 -12
  351. data/docs/GiftCertificateLedgerEntry.md +28 -13
  352. data/docs/GiftCertificateQuery.md +34 -16
  353. data/docs/GiftCertificateResponse.md +26 -12
  354. data/docs/GiftCertificatesResponse.md +26 -12
  355. data/docs/Group.md +26 -12
  356. data/docs/GroupResponse.md +26 -12
  357. data/docs/GroupUserMembership.md +26 -12
  358. data/docs/GroupsResponse.md +26 -12
  359. data/docs/HTTPHeader.md +20 -9
  360. data/docs/IntegrationLog.md +52 -25
  361. data/docs/IntegrationLogApi.md +385 -286
  362. data/docs/IntegrationLogFile.md +24 -11
  363. data/docs/IntegrationLogLog.md +20 -9
  364. data/docs/IntegrationLogQueryFilterValues.md +40 -19
  365. data/docs/IntegrationLogQueryRequest.md +42 -20
  366. data/docs/IntegrationLogQueryResponse.md +28 -13
  367. data/docs/IntegrationLogResponse.md +26 -12
  368. data/docs/IntegrationLogSummary.md +34 -16
  369. data/docs/IntegrationLogSummaryQueryRequest.md +20 -9
  370. data/docs/IntegrationLogSummaryQueryResponse.md +26 -12
  371. data/docs/Item.md +118 -58
  372. data/docs/ItemAccounting.md +20 -9
  373. data/docs/ItemAmember.md +20 -9
  374. data/docs/ItemApi.md +706 -517
  375. data/docs/ItemAutoOrder.md +50 -24
  376. data/docs/ItemAutoOrderStep.md +46 -22
  377. data/docs/ItemAutoOrderStepArbitraryUnitCostSchedule.md +20 -9
  378. data/docs/ItemAutoOrderStepGrandfatherPricing.md +20 -9
  379. data/docs/ItemCCBill.md +28 -13
  380. data/docs/ItemChannelPartnerMapping.md +54 -26
  381. data/docs/ItemChargeback.md +20 -9
  382. data/docs/ItemChargebackAddendum.md +24 -11
  383. data/docs/ItemChargebackAdjustmentRequest.md +22 -10
  384. data/docs/ItemCheckout.md +24 -11
  385. data/docs/ItemContent.md +42 -20
  386. data/docs/ItemContentAssignment.md +28 -13
  387. data/docs/ItemContentAttribute.md +24 -11
  388. data/docs/ItemContentMultimedia.md +46 -22
  389. data/docs/ItemContentMultimediaThumbnail.md +28 -13
  390. data/docs/ItemDigitalDelivery.md +28 -13
  391. data/docs/ItemDigitalItem.md +26 -12
  392. data/docs/ItemEbay.md +154 -76
  393. data/docs/ItemEbayCategorySpecific.md +20 -9
  394. data/docs/ItemEbayMarketListing.md +26 -12
  395. data/docs/ItemEbayMarketPlaceAnalysis.md +36 -17
  396. data/docs/ItemEmailNotifications.md +20 -9
  397. data/docs/ItemEnrollment123.md +18 -8
  398. data/docs/ItemFulfillmentAddon.md +24 -11
  399. data/docs/ItemGiftCertificate.md +20 -9
  400. data/docs/ItemGoogleProductSearch.md +112 -55
  401. data/docs/ItemIdentifiers.md +24 -11
  402. data/docs/ItemInstantPaymentNotification.md +22 -10
  403. data/docs/ItemInstantPaymentNotifications.md +18 -8
  404. data/docs/ItemInternal.md +18 -8
  405. data/docs/ItemKitComponent.md +26 -12
  406. data/docs/ItemKitDefinition.md +18 -8
  407. data/docs/ItemOption.md +44 -21
  408. data/docs/ItemOptionValue.md +46 -22
  409. data/docs/ItemOptionValueAdditionalItem.md +20 -9
  410. data/docs/ItemOptionValueDigitalItem.md +20 -9
  411. data/docs/ItemPaymentProcessing.md +26 -12
  412. data/docs/ItemPhysical.md +24 -11
  413. data/docs/ItemPricing.md +52 -25
  414. data/docs/ItemPricingTier.md +26 -12
  415. data/docs/ItemPricingTierDiscount.md +20 -9
  416. data/docs/ItemPricingTierLimit.md +22 -10
  417. data/docs/ItemProperty.md +22 -10
  418. data/docs/ItemRealtimePricing.md +22 -10
  419. data/docs/ItemRelated.md +22 -10
  420. data/docs/ItemRelatedItem.md +22 -10
  421. data/docs/ItemReporting.md +20 -9
  422. data/docs/ItemResponse.md +26 -12
  423. data/docs/ItemRestriction.md +32 -15
  424. data/docs/ItemRestrictionItem.md +22 -10
  425. data/docs/ItemRevguard.md +30 -14
  426. data/docs/ItemReviews.md +34 -16
  427. data/docs/ItemSalesforce.md +20 -9
  428. data/docs/ItemShipping.md +112 -55
  429. data/docs/ItemShippingCase.md +24 -11
  430. data/docs/ItemShippingDestinationMarkup.md +28 -13
  431. data/docs/ItemShippingDestinationRestriction.md +22 -10
  432. data/docs/ItemShippingDistributionCenter.md +44 -21
  433. data/docs/ItemShippingMethod.md +46 -22
  434. data/docs/ItemShippingPackageRequirement.md +20 -9
  435. data/docs/ItemTag.md +20 -9
  436. data/docs/ItemTags.md +18 -8
  437. data/docs/ItemTax.md +24 -11
  438. data/docs/ItemTaxExemption.md +26 -12
  439. data/docs/ItemThirdPartyEmailMarketing.md +26 -12
  440. data/docs/ItemVariantItem.md +28 -13
  441. data/docs/ItemVariation.md +26 -12
  442. data/docs/ItemVariationOption.md +24 -11
  443. data/docs/ItemWishlistMember.md +22 -10
  444. data/docs/ItemsRequest.md +18 -8
  445. data/docs/ItemsResponse.md +26 -12
  446. data/docs/KeyValue.md +22 -10
  447. data/docs/LibraryFilterValues.md +24 -11
  448. data/docs/LibraryFilterValuesResponse.md +26 -12
  449. data/docs/LibraryItem.md +96 -47
  450. data/docs/LibraryItemAccount.md +22 -10
  451. data/docs/LibraryItemAsset.md +20 -9
  452. data/docs/LibraryItemAttribute.md +20 -9
  453. data/docs/LibraryItemEmail.md +22 -10
  454. data/docs/LibraryItemPublishedMeta.md +32 -15
  455. data/docs/LibraryItemPurchasedMeta.md +22 -10
  456. data/docs/LibraryItemQuery.md +40 -19
  457. data/docs/LibraryItemResponse.md +26 -12
  458. data/docs/LibraryItemScreenshot.md +20 -9
  459. data/docs/LibraryItemsResponse.md +26 -12
  460. data/docs/LinkedAccount.md +22 -10
  461. data/docs/ListSegmentMembership.md +22 -10
  462. data/docs/LookupRequest.md +26 -12
  463. data/docs/LookupResponse.md +26 -12
  464. data/docs/Mailgun.md +18 -8
  465. data/docs/Metric.md +32 -15
  466. data/docs/Notification.md +38 -18
  467. data/docs/OauthApi.md +163 -124
  468. data/docs/OauthRevokeSuccessResponse.md +20 -9
  469. data/docs/OauthTokenResponse.md +32 -15
  470. data/docs/Order.md +84 -41
  471. data/docs/OrderAffiliate.md +22 -10
  472. data/docs/OrderAffiliateLedger.md +34 -16
  473. data/docs/OrderApi.md +1787 -1308
  474. data/docs/OrderAutoOrder.md +56 -27
  475. data/docs/OrderBilling.md +48 -23
  476. data/docs/OrderBuysafe.md +28 -13
  477. data/docs/OrderByTokenQuery.md +18 -8
  478. data/docs/OrderChannelPartner.md +38 -18
  479. data/docs/OrderCheckout.md +44 -21
  480. data/docs/OrderCoupon.md +26 -12
  481. data/docs/OrderDigitalItem.md +32 -15
  482. data/docs/OrderDigitalOrder.md +26 -12
  483. data/docs/OrderEdi.md +24 -11
  484. data/docs/OrderFormat.md +48 -23
  485. data/docs/OrderFormatResponse.md +20 -9
  486. data/docs/OrderFraudScore.md +56 -27
  487. data/docs/OrderGift.md +36 -17
  488. data/docs/OrderGiftCertificate.md +22 -10
  489. data/docs/OrderInternal.md +26 -12
  490. data/docs/OrderItem.md +128 -63
  491. data/docs/OrderItemEdi.md +20 -9
  492. data/docs/OrderItemEdiIdentification.md +20 -9
  493. data/docs/OrderItemEdiLot.md +22 -10
  494. data/docs/OrderItemOption.md +38 -18
  495. data/docs/OrderItemOptionFileAttachment.md +24 -11
  496. data/docs/OrderItemProperty.md +24 -11
  497. data/docs/OrderItemTag.md +18 -8
  498. data/docs/OrderLinkedShipment.md +26 -12
  499. data/docs/OrderMarketing.md +22 -10
  500. data/docs/OrderPackingSlipResponse.md +26 -12
  501. data/docs/OrderPayment.md +52 -25
  502. data/docs/OrderPaymentCheck.md +18 -8
  503. data/docs/OrderPaymentCreditCard.md +38 -18
  504. data/docs/OrderPaymentECheck.md +36 -17
  505. data/docs/OrderPaymentInsurance.md +24 -11
  506. data/docs/OrderPaymentPurchaseOrder.md +18 -8
  507. data/docs/OrderPaymentTransaction.md +24 -11
  508. data/docs/OrderPaymentTransactionDetail.md +22 -10
  509. data/docs/OrderProcessPaymentRequest.md +20 -9
  510. data/docs/OrderProcessPaymentResponse.md +26 -12
  511. data/docs/OrderProperty.md +24 -11
  512. data/docs/OrderQuery.md +94 -46
  513. data/docs/OrderQueryBatch.md +18 -8
  514. data/docs/OrderQuote.md +22 -10
  515. data/docs/OrderReplacement.md +46 -22
  516. data/docs/OrderReplacementItem.md +22 -10
  517. data/docs/OrderReplacementResponse.md +28 -13
  518. data/docs/OrderResponse.md +26 -12
  519. data/docs/OrderSalesforce.md +18 -8
  520. data/docs/OrderShipping.md +76 -37
  521. data/docs/OrderSummary.md +56 -27
  522. data/docs/OrderTag.md +18 -8
  523. data/docs/OrderTaxes.md +50 -24
  524. data/docs/OrderTokenResponse.md +26 -12
  525. data/docs/OrderTrackingNumberDetail.md +40 -19
  526. data/docs/OrderTrackingNumberDetails.md +52 -25
  527. data/docs/OrdersResponse.md +26 -12
  528. data/docs/Permission.md +22 -10
  529. data/docs/PricingTier.md +78 -38
  530. data/docs/PricingTierNotification.md +22 -10
  531. data/docs/PricingTiersResponse.md +26 -12
  532. data/docs/Property.md +20 -9
  533. data/docs/PublishLibraryItemRequest.md +18 -8
  534. data/docs/RegisterAffiliateClickRequest.md +28 -13
  535. data/docs/RegisterAffiliateClickResponse.md +24 -11
  536. data/docs/ResponseMetadata.md +20 -9
  537. data/docs/ResultSet.md +28 -13
  538. data/docs/ScreenRecording.md +116 -57
  539. data/docs/ScreenRecordingAdPlatform.md +30 -14
  540. data/docs/ScreenRecordingFilter.md +136 -67
  541. data/docs/ScreenRecordingFilterGeoDistance.md +26 -12
  542. data/docs/ScreenRecordingFilterIpSearch.md +24 -11
  543. data/docs/ScreenRecordingFilterPageView.md +50 -24
  544. data/docs/ScreenRecordingFilterPageViewEvent.md +20 -9
  545. data/docs/ScreenRecordingFilterPageViewEventParam.md +26 -12
  546. data/docs/ScreenRecordingFilterPageViewParam.md +20 -9
  547. data/docs/ScreenRecordingFilterPageViewReferrerParam.md +20 -9
  548. data/docs/ScreenRecordingFilterRangeBigDecimal.md +26 -12
  549. data/docs/ScreenRecordingFilterRangeDate.md +20 -9
  550. data/docs/ScreenRecordingFilterRangeInteger.md +26 -12
  551. data/docs/ScreenRecordingFilterStringSearch.md +26 -12
  552. data/docs/ScreenRecordingFilterValues.md +58 -28
  553. data/docs/ScreenRecordingFilterValuesEvent.md +20 -9
  554. data/docs/ScreenRecordingFilterValuesEventParams.md +26 -12
  555. data/docs/ScreenRecordingFilterValuesPageParam.md +20 -9
  556. data/docs/ScreenRecordingFilterValuesPageView.md +28 -13
  557. data/docs/ScreenRecordingHeatmap.md +64 -31
  558. data/docs/ScreenRecordingHeatmapIndexRequest.md +18 -8
  559. data/docs/ScreenRecordingHeatmapIndexResponse.md +26 -12
  560. data/docs/ScreenRecordingHeatmapRequest.md +22 -10
  561. data/docs/ScreenRecordingHeatmapReset.md +18 -8
  562. data/docs/ScreenRecordingHeatmapResponse.md +26 -12
  563. data/docs/ScreenRecordingHeatmapUrl.md +28 -13
  564. data/docs/ScreenRecordingMerchantNotesRequest.md +18 -8
  565. data/docs/ScreenRecordingMultifield.md +26 -12
  566. data/docs/ScreenRecordingPageView.md +54 -26
  567. data/docs/ScreenRecordingPageViewDataResponse.md +26 -12
  568. data/docs/ScreenRecordingPageViewEvent.md +28 -13
  569. data/docs/ScreenRecordingPageViewEventParameter.md +20 -9
  570. data/docs/ScreenRecordingPageViewParameter.md +20 -9
  571. data/docs/ScreenRecordingQueryRequest.md +18 -8
  572. data/docs/ScreenRecordingQueryResponse.md +38 -18
  573. data/docs/ScreenRecordingResponse.md +28 -13
  574. data/docs/ScreenRecordingSegment.md +36 -17
  575. data/docs/ScreenRecordingSegmentResponse.md +26 -12
  576. data/docs/ScreenRecordingSegmentsResponse.md +26 -12
  577. data/docs/ScreenRecordingSettings.md +32 -15
  578. data/docs/ScreenRecordingSettingsResponse.md +26 -12
  579. data/docs/ScreenRecordingStoreFront.md +20 -9
  580. data/docs/ScreenRecordingTagsRequest.md +18 -8
  581. data/docs/ScreenRecordingTagsResponse.md +26 -12
  582. data/docs/ScreenRecordingUserAgent.md +26 -12
  583. data/docs/ScreenRecordingUserAgentDevice.md +18 -8
  584. data/docs/ScreenRecordingUserAgentOS.md +22 -10
  585. data/docs/ScreenRecordingUserProperty.md +20 -9
  586. data/docs/ScreenshotsResponse.md +26 -12
  587. data/docs/SelfConfig.md +18 -8
  588. data/docs/SimpleValue.md +20 -9
  589. data/docs/SingleSignOnAuthorizeRequest.md +20 -9
  590. data/docs/SingleSignOnAuthorizeResponse.md +20 -9
  591. data/docs/SingleSignOnTokenRequest.md +20 -9
  592. data/docs/SingleSignOnTokenResponse.md +22 -10
  593. data/docs/SovosConfig.md +30 -14
  594. data/docs/SsoApi.md +288 -201
  595. data/docs/StateProvince.md +20 -9
  596. data/docs/StepWaiting.md +20 -9
  597. data/docs/StorefrontApi.md +11794 -8525
  598. data/docs/TaxApi.md +2017 -1421
  599. data/docs/TaxCity.md +34 -16
  600. data/docs/TaxCountry.md +34 -16
  601. data/docs/TaxCountryCode.md +26 -12
  602. data/docs/TaxCounty.md +36 -17
  603. data/docs/TaxJarConfig.md +30 -14
  604. data/docs/TaxPostalCode.md +30 -14
  605. data/docs/TaxProviderActivateResult.md +20 -9
  606. data/docs/TaxProviderAvalara.md +24 -11
  607. data/docs/TaxProviderAvalaraCompaniesResult.md +18 -8
  608. data/docs/TaxProviderAvalaraCompany.md +26 -12
  609. data/docs/TaxProviderSelf.md +26 -12
  610. data/docs/TaxProviderSelfCountriesResponse.md +18 -8
  611. data/docs/TaxProviderSelfRegionsResponse.md +18 -8
  612. data/docs/TaxProviderSovos.md +24 -11
  613. data/docs/TaxProviderTaxJar.md +24 -11
  614. data/docs/TaxProviderTestResult.md +20 -9
  615. data/docs/TaxProviderUltraCart.md +26 -12
  616. data/docs/TaxProviderUltraCartState.md +36 -17
  617. data/docs/TaxProvidersResponse.md +34 -16
  618. data/docs/TaxState.md +52 -25
  619. data/docs/TaxStateCode.md +26 -12
  620. data/docs/TempMultimedia.md +30 -14
  621. data/docs/TempMultimediaResponse.md +26 -12
  622. data/docs/ThumbnailParametersRequest.md +26 -12
  623. data/docs/ThumbnailParametersResponse.md +26 -12
  624. data/docs/TransactionEmail.md +56 -27
  625. data/docs/TransactionEmailListResponse.md +26 -12
  626. data/docs/TransactionEmailOption.md +32 -15
  627. data/docs/TransactionEmailResponse.md +26 -12
  628. data/docs/Twilio.md +24 -11
  629. data/docs/TwilioResponse.md +28 -13
  630. data/docs/TwiliosResponse.md +26 -12
  631. data/docs/UltraCartConfig.md +18 -8
  632. data/docs/UploadCouponCodesRequest.md +26 -12
  633. data/docs/UploadCouponCodesResponse.md +30 -14
  634. data/docs/User.md +44 -21
  635. data/docs/UserApi.md +790 -558
  636. data/docs/UserGroupMembership.md +22 -10
  637. data/docs/UserLogin.md +24 -11
  638. data/docs/UserLoginsResponse.md +26 -12
  639. data/docs/UserResponse.md +26 -12
  640. data/docs/UsersResponse.md +26 -12
  641. data/docs/VerificationRecord.md +22 -10
  642. data/docs/Warning.md +20 -9
  643. data/docs/Webhook.md +52 -25
  644. data/docs/WebhookApi.md +612 -447
  645. data/docs/WebhookEventCategory.md +26 -12
  646. data/docs/WebhookEventSubscription.md +34 -16
  647. data/docs/WebhookLog.md +38 -18
  648. data/docs/WebhookLogResponse.md +26 -12
  649. data/docs/WebhookLogSummariesResponse.md +26 -12
  650. data/docs/WebhookLogSummary.md +22 -10
  651. data/docs/WebhookResponse.md +26 -12
  652. data/docs/WebhookSampleRequest.md +24 -11
  653. data/docs/WebhookSampleRequestResponse.md +26 -12
  654. data/docs/WebhooksResponse.md +26 -12
  655. data/docs/Weight.md +20 -9
  656. data/git_push.sh +57 -55
  657. data/lib/ultracart_api/api/affiliate_api.rb +191 -164
  658. data/lib/ultracart_api/api/auto_order_api.rb +672 -581
  659. data/lib/ultracart_api/api/channel_partner_api.rb +370 -311
  660. data/lib/ultracart_api/api/chargeback_api.rb +410 -356
  661. data/lib/ultracart_api/api/checkout_api.rb +1341 -1111
  662. data/lib/ultracart_api/api/coupon_api.rb +1390 -1161
  663. data/lib/ultracart_api/api/customer_api.rb +1370 -1157
  664. data/lib/ultracart_api/api/fulfillment_api.rb +452 -381
  665. data/lib/ultracart_api/api/gift_certificate_api.rb +594 -502
  666. data/lib/ultracart_api/api/integration_log_api.rb +404 -350
  667. data/lib/ultracart_api/api/item_api.rb +686 -585
  668. data/lib/ultracart_api/api/oauth_api.rb +198 -171
  669. data/lib/ultracart_api/api/order_api.rb +1728 -1471
  670. data/lib/ultracart_api/api/sso_api.rb +289 -243
  671. data/lib/ultracart_api/api/storefront_api.rb +11407 -9617
  672. data/lib/ultracart_api/api/tax_api.rb +1916 -1580
  673. data/lib/ultracart_api/api/user_api.rb +755 -634
  674. data/lib/ultracart_api/api/webhook_api.rb +601 -514
  675. data/lib/ultracart_api/api_client.rb +399 -400
  676. data/lib/ultracart_api/api_error.rb +57 -38
  677. data/lib/ultracart_api/configuration.rb +302 -229
  678. data/lib/ultracart_api/models/accounts_receivable_retry_config.rb +364 -329
  679. data/lib/ultracart_api/models/accounts_receivable_retry_config_response.rb +287 -252
  680. data/lib/ultracart_api/models/accounts_receivable_retry_day_activity.rb +240 -205
  681. data/lib/ultracart_api/models/accounts_receivable_retry_stat_account.rb +250 -215
  682. data/lib/ultracart_api/models/accounts_receivable_retry_stat_metrics.rb +309 -274
  683. data/lib/ultracart_api/models/accounts_receivable_retry_stat_revenue.rb +228 -193
  684. data/lib/ultracart_api/models/accounts_receivable_retry_stats_response.rb +267 -232
  685. data/lib/ultracart_api/models/activity.rb +264 -229
  686. data/lib/ultracart_api/models/add_library_item_request.rb +324 -289
  687. data/lib/ultracart_api/models/adjust_internal_certificate_request.rb +270 -235
  688. data/lib/ultracart_api/models/adjust_internal_certificate_response.rb +267 -232
  689. data/lib/ultracart_api/models/affiliate_click.rb +319 -284
  690. data/lib/ultracart_api/models/affiliate_click_query.rb +270 -235
  691. data/lib/ultracart_api/models/affiliate_clicks_response.rb +259 -224
  692. data/lib/ultracart_api/models/affiliate_ledger.rb +431 -396
  693. data/lib/ultracart_api/models/affiliate_ledger_query.rb +270 -235
  694. data/lib/ultracart_api/models/affiliate_ledgers_response.rb +259 -224
  695. data/lib/ultracart_api/models/affiliate_link.rb +408 -373
  696. data/lib/ultracart_api/models/api_user_application_profile.rb +260 -225
  697. data/lib/ultracart_api/models/apply_library_item_request.rb +250 -215
  698. data/lib/ultracart_api/models/apply_library_item_response.rb +319 -284
  699. data/lib/ultracart_api/models/auto_order.rb +469 -434
  700. data/lib/ultracart_api/models/auto_order_item.rb +487 -452
  701. data/lib/ultracart_api/models/auto_order_item_future_schedule.rb +250 -215
  702. data/lib/ultracart_api/models/auto_order_item_option.rb +260 -225
  703. data/lib/ultracart_api/models/auto_order_item_simple_schedule.rb +274 -239
  704. data/lib/ultracart_api/models/auto_order_log.rb +230 -195
  705. data/lib/ultracart_api/models/auto_order_query.rb +480 -445
  706. data/lib/ultracart_api/models/auto_order_query_batch.rb +222 -187
  707. data/lib/ultracart_api/models/auto_order_response.rb +256 -221
  708. data/lib/ultracart_api/models/auto_orders_request.rb +222 -187
  709. data/lib/ultracart_api/models/auto_orders_response.rb +258 -223
  710. data/lib/ultracart_api/models/avalara_config.rb +340 -305
  711. data/lib/ultracart_api/models/base_response.rb +247 -212
  712. data/lib/ultracart_api/models/browser.rb +237 -202
  713. data/lib/ultracart_api/models/browser_device.rb +219 -184
  714. data/lib/ultracart_api/models/browser_os.rb +255 -220
  715. data/lib/ultracart_api/models/browser_user_agent.rb +246 -211
  716. data/lib/ultracart_api/models/cart.rb +506 -471
  717. data/lib/ultracart_api/models/cart_affiliate.rb +245 -210
  718. data/lib/ultracart_api/models/cart_affirm_checkout_response.rb +232 -197
  719. data/lib/ultracart_api/models/cart_billing.rb +572 -537
  720. data/lib/ultracart_api/models/cart_buysafe.rb +269 -234
  721. data/lib/ultracart_api/models/cart_checkout.rb +500 -465
  722. data/lib/ultracart_api/models/cart_coupon.rb +220 -185
  723. data/lib/ultracart_api/models/cart_currency_conversion.rb +232 -197
  724. data/lib/ultracart_api/models/cart_customer_profile.rb +438 -403
  725. data/lib/ultracart_api/models/cart_customer_profile_address.rb +350 -315
  726. data/lib/ultracart_api/models/cart_customer_profile_credit_card.rb +304 -269
  727. data/lib/ultracart_api/models/cart_finalize_order_request.rb +228 -193
  728. data/lib/ultracart_api/models/cart_finalize_order_request_options.rb +355 -320
  729. data/lib/ultracart_api/models/cart_finalize_order_response.rb +260 -225
  730. data/lib/ultracart_api/models/cart_gift.rb +313 -278
  731. data/lib/ultracart_api/models/cart_gift_certificate.rb +238 -203
  732. data/lib/ultracart_api/models/cart_item.rb +504 -469
  733. data/lib/ultracart_api/models/cart_item_attribute.rb +240 -205
  734. data/lib/ultracart_api/models/cart_item_multimedia.rb +336 -301
  735. data/lib/ultracart_api/models/cart_item_multimedia_thumbnail.rb +260 -225
  736. data/lib/ultracart_api/models/cart_item_option.rb +378 -343
  737. data/lib/ultracart_api/models/cart_item_option_value.rb +258 -223
  738. data/lib/ultracart_api/models/cart_item_physical.rb +246 -211
  739. data/lib/ultracart_api/models/cart_item_variation_selection.rb +230 -195
  740. data/lib/ultracart_api/models/cart_kit_component_option.rb +398 -363
  741. data/lib/ultracart_api/models/cart_marketing.rb +230 -195
  742. data/lib/ultracart_api/models/cart_payment.rb +275 -240
  743. data/lib/ultracart_api/models/cart_payment_affirm.rb +220 -185
  744. data/lib/ultracart_api/models/cart_payment_amazon.rb +220 -185
  745. data/lib/ultracart_api/models/cart_payment_check.rb +220 -185
  746. data/lib/ultracart_api/models/cart_payment_credit_card.rb +300 -265
  747. data/lib/ultracart_api/models/cart_payment_purchase_order.rb +220 -185
  748. data/lib/ultracart_api/models/cart_profile_login_request.rb +239 -204
  749. data/lib/ultracart_api/models/cart_profile_login_response.rb +231 -196
  750. data/lib/ultracart_api/models/cart_profile_register_request.rb +229 -194
  751. data/lib/ultracart_api/models/cart_profile_register_response.rb +231 -196
  752. data/lib/ultracart_api/models/cart_property.rb +280 -245
  753. data/lib/ultracart_api/models/cart_response.rb +231 -196
  754. data/lib/ultracart_api/models/cart_settings.rb +264 -229
  755. data/lib/ultracart_api/models/cart_settings_billing.rb +222 -187
  756. data/lib/ultracart_api/models/cart_settings_gift.rb +251 -216
  757. data/lib/ultracart_api/models/cart_settings_gift_wrap.rb +239 -204
  758. data/lib/ultracart_api/models/cart_settings_payment.rb +337 -302
  759. data/lib/ultracart_api/models/cart_settings_payment_amazon.rb +240 -205
  760. data/lib/ultracart_api/models/cart_settings_payment_credit_card.rb +242 -207
  761. data/lib/ultracart_api/models/cart_settings_payment_pay_pal.rb +260 -225
  762. data/lib/ultracart_api/models/cart_settings_province.rb +228 -193
  763. data/lib/ultracart_api/models/cart_settings_shipping.rb +262 -227
  764. data/lib/ultracart_api/models/cart_settings_shipping_calendar.rb +264 -229
  765. data/lib/ultracart_api/models/cart_settings_shipping_estimate.rb +345 -310
  766. data/lib/ultracart_api/models/cart_settings_taxes.rb +221 -186
  767. data/lib/ultracart_api/models/cart_settings_terms.rb +230 -195
  768. data/lib/ultracart_api/models/cart_shipping.rb +625 -590
  769. data/lib/ultracart_api/models/cart_summary.rb +354 -319
  770. data/lib/ultracart_api/models/cart_taxes.rb +255 -220
  771. data/lib/ultracart_api/models/cart_upsell_after.rb +255 -220
  772. data/lib/ultracart_api/models/cart_validation_request.rb +231 -196
  773. data/lib/ultracart_api/models/cart_validation_response.rb +231 -196
  774. data/lib/ultracart_api/models/channel_partner_cancel_response.rb +259 -224
  775. data/lib/ultracart_api/models/channel_partner_estimate_shipping_response.rb +259 -224
  776. data/lib/ultracart_api/models/channel_partner_estimate_tax_response.rb +256 -221
  777. data/lib/ultracart_api/models/channel_partner_import_response.rb +281 -246
  778. data/lib/ultracart_api/models/channel_partner_order.rb +1604 -1569
  779. data/lib/ultracart_api/models/channel_partner_order_item.rb +331 -296
  780. data/lib/ultracart_api/models/channel_partner_order_item_option.rb +230 -195
  781. data/lib/ultracart_api/models/channel_partner_order_transaction.rb +232 -197
  782. data/lib/ultracart_api/models/channel_partner_order_transaction_detail.rb +230 -195
  783. data/lib/ultracart_api/models/channel_partner_shipping_estimate.rb +230 -195
  784. data/lib/ultracart_api/models/chargeback_dispute.rb +649 -614
  785. data/lib/ultracart_api/models/chargeback_dispute_response.rb +256 -221
  786. data/lib/ultracart_api/models/chargeback_disputes_response.rb +258 -223
  787. data/lib/ultracart_api/models/checkout_allowed_countries_response.rb +221 -186
  788. data/lib/ultracart_api/models/checkout_handoff_request.rb +323 -288
  789. data/lib/ultracart_api/models/checkout_handoff_response.rb +241 -206
  790. data/lib/ultracart_api/models/checkout_setup_browser_key_request.rb +222 -187
  791. data/lib/ultracart_api/models/checkout_setup_browser_key_response.rb +220 -185
  792. data/lib/ultracart_api/models/checkout_state_province_response.rb +221 -186
  793. data/lib/ultracart_api/models/city_state_zip.rb +255 -220
  794. data/lib/ultracart_api/models/countries_response.rb +221 -186
  795. data/lib/ultracart_api/models/country.rb +260 -225
  796. data/lib/ultracart_api/models/coupon.rb +864 -829
  797. data/lib/ultracart_api/models/coupon_amount_off_items.rb +267 -232
  798. data/lib/ultracart_api/models/coupon_amount_off_shipping.rb +257 -222
  799. data/lib/ultracart_api/models/coupon_amount_off_shipping_with_items_purchase.rb +269 -234
  800. data/lib/ultracart_api/models/coupon_amount_off_subtotal.rb +245 -210
  801. data/lib/ultracart_api/models/coupon_amount_off_subtotal_and_shipping.rb +245 -210
  802. data/lib/ultracart_api/models/coupon_amount_off_subtotal_free_shipping_with_purchase.rb +267 -232
  803. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_block_purchase.rb +265 -230
  804. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_items_purchase.rb +267 -232
  805. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_purchase.rb +255 -220
  806. data/lib/ultracart_api/models/coupon_amount_shipping_with_subtotal.rb +267 -232
  807. data/lib/ultracart_api/models/coupon_auto_apply_condition.rb +239 -204
  808. data/lib/ultracart_api/models/coupon_auto_apply_conditions.rb +269 -234
  809. data/lib/ultracart_api/models/coupon_automatically_apply_coupon_codes.rb +222 -187
  810. data/lib/ultracart_api/models/coupon_buy_one_get_one_limit.rb +232 -197
  811. data/lib/ultracart_api/models/coupon_codes_request.rb +277 -242
  812. data/lib/ultracart_api/models/coupon_codes_response.rb +269 -234
  813. data/lib/ultracart_api/models/coupon_deletes_request.rb +234 -199
  814. data/lib/ultracart_api/models/coupon_discount_item_with_item_purchase.rb +275 -240
  815. data/lib/ultracart_api/models/coupon_discount_items.rb +267 -232
  816. data/lib/ultracart_api/models/coupon_editor_values.rb +330 -295
  817. data/lib/ultracart_api/models/coupon_exists_response.rb +267 -232
  818. data/lib/ultracart_api/models/coupon_free_item_and_shipping_with_subtotal.rb +279 -244
  819. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase.rb +254 -219
  820. data/lib/ultracart_api/models/coupon_free_item_with_subtotal.rb +267 -232
  821. data/lib/ultracart_api/models/coupon_free_items_with_item_purchase.rb +260 -225
  822. data/lib/ultracart_api/models/coupon_free_items_with_mix_match_purchase.rb +260 -225
  823. data/lib/ultracart_api/models/coupon_free_shipping.rb +222 -187
  824. data/lib/ultracart_api/models/coupon_free_shipping_specific_items.rb +222 -187
  825. data/lib/ultracart_api/models/coupon_free_shipping_with_items_purchase.rb +234 -199
  826. data/lib/ultracart_api/models/coupon_free_shipping_with_subtotal.rb +257 -222
  827. data/lib/ultracart_api/models/coupon_item_search_result.rb +290 -255
  828. data/lib/ultracart_api/models/coupon_item_search_results_response.rb +259 -224
  829. data/lib/ultracart_api/models/coupon_multiple_amounts_off_items.rb +232 -197
  830. data/lib/ultracart_api/models/coupon_percent_off_item_with_items_quantity_purchase.rb +264 -229
  831. data/lib/ultracart_api/models/coupon_percent_off_items.rb +254 -219
  832. data/lib/ultracart_api/models/coupon_percent_off_items_and_free_shipping.rb +244 -209
  833. data/lib/ultracart_api/models/coupon_percent_off_items_with_items_purchase.rb +254 -219
  834. data/lib/ultracart_api/models/coupon_percent_off_msrp_items.rb +254 -219
  835. data/lib/ultracart_api/models/coupon_percent_off_retail_price_items.rb +254 -219
  836. data/lib/ultracart_api/models/coupon_percent_off_shipping.rb +232 -197
  837. data/lib/ultracart_api/models/coupon_percent_off_subtotal.rb +220 -185
  838. data/lib/ultracart_api/models/coupon_percent_off_subtotal_and_free_shipping.rb +232 -197
  839. data/lib/ultracart_api/models/coupon_percent_off_subtotal_limit.rb +255 -220
  840. data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_items_purchase.rb +232 -197
  841. data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_subtotal.rb +255 -220
  842. data/lib/ultracart_api/models/coupon_query.rb +310 -275
  843. data/lib/ultracart_api/models/coupon_response.rb +268 -233
  844. data/lib/ultracart_api/models/coupon_restriction.rb +246 -211
  845. data/lib/ultracart_api/models/coupon_tier_amount.rb +255 -220
  846. data/lib/ultracart_api/models/coupon_tier_item_discount.rb +232 -197
  847. data/lib/ultracart_api/models/coupon_tier_percent.rb +255 -220
  848. data/lib/ultracart_api/models/coupon_tier_quantity_amount.rb +255 -220
  849. data/lib/ultracart_api/models/coupon_tier_quantity_percent.rb +255 -220
  850. data/lib/ultracart_api/models/coupon_tiered_amount_off_items.rb +244 -209
  851. data/lib/ultracart_api/models/coupon_tiered_amount_off_subtotal.rb +234 -199
  852. data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb +244 -209
  853. data/lib/ultracart_api/models/coupon_tiered_percent_off_shipping.rb +259 -224
  854. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal.rb +234 -199
  855. data/lib/ultracart_api/models/coupon_type.rb +230 -195
  856. data/lib/ultracart_api/models/coupons_request.rb +222 -187
  857. data/lib/ultracart_api/models/coupons_response.rb +258 -223
  858. data/lib/ultracart_api/models/currency.rb +260 -225
  859. data/lib/ultracart_api/models/customer.rb +978 -943
  860. data/lib/ultracart_api/models/customer_activity.rb +290 -255
  861. data/lib/ultracart_api/models/customer_affiliate.rb +250 -215
  862. data/lib/ultracart_api/models/customer_attachment.rb +260 -225
  863. data/lib/ultracart_api/models/customer_billing.rb +575 -540
  864. data/lib/ultracart_api/models/customer_card.rb +290 -255
  865. data/lib/ultracart_api/models/customer_editor_values.rb +328 -293
  866. data/lib/ultracart_api/models/customer_email.rb +300 -265
  867. data/lib/ultracart_api/models/customer_email_list_changes.rb +234 -199
  868. data/lib/ultracart_api/models/customer_loyalty.rb +283 -248
  869. data/lib/ultracart_api/models/customer_loyalty_ledger.rb +360 -325
  870. data/lib/ultracart_api/models/customer_loyalty_redemption.rb +340 -305
  871. data/lib/ultracart_api/models/customer_merge_request.rb +230 -195
  872. data/lib/ultracart_api/models/customer_orders_summary.rb +250 -215
  873. data/lib/ultracart_api/models/customer_pricing_tier.rb +245 -210
  874. data/lib/ultracart_api/models/customer_privacy.rb +250 -215
  875. data/lib/ultracart_api/models/customer_query.rb +789 -754
  876. data/lib/ultracart_api/models/customer_quotes_summary.rb +250 -215
  877. data/lib/ultracart_api/models/customer_response.rb +256 -221
  878. data/lib/ultracart_api/models/customer_reviewer.rb +310 -275
  879. data/lib/ultracart_api/models/customer_shipping.rb +575 -540
  880. data/lib/ultracart_api/models/customer_software_entitlement.rb +365 -330
  881. data/lib/ultracart_api/models/customer_store_credit.rb +274 -239
  882. data/lib/ultracart_api/models/customer_store_credit_add_request.rb +250 -215
  883. data/lib/ultracart_api/models/customer_store_credit_ledger_entry.rb +295 -260
  884. data/lib/ultracart_api/models/customer_store_credit_response.rb +256 -221
  885. data/lib/ultracart_api/models/customer_tag.rb +235 -200
  886. data/lib/ultracart_api/models/customer_tax_codes.rb +260 -225
  887. data/lib/ultracart_api/models/customers_response.rb +258 -223
  888. data/lib/ultracart_api/models/data_tables_server_side_response.rb +248 -213
  889. data/lib/ultracart_api/models/distance.rb +264 -229
  890. data/lib/ultracart_api/models/distribution_center.rb +559 -524
  891. data/lib/ultracart_api/models/distribution_centers_response.rb +258 -223
  892. data/lib/ultracart_api/models/email_base_template_list_response.rb +221 -186
  893. data/lib/ultracart_api/models/email_campaign.rb +467 -432
  894. data/lib/ultracart_api/models/email_campaign_folder.rb +275 -240
  895. data/lib/ultracart_api/models/email_campaign_folder_response.rb +256 -221
  896. data/lib/ultracart_api/models/email_campaign_folders_response.rb +258 -223
  897. data/lib/ultracart_api/models/email_campaign_response.rb +256 -221
  898. data/lib/ultracart_api/models/email_campaigns_response.rb +258 -223
  899. data/lib/ultracart_api/models/email_click.rb +230 -195
  900. data/lib/ultracart_api/models/email_clicks_response.rb +258 -223
  901. data/lib/ultracart_api/models/email_commseq.rb +252 -217
  902. data/lib/ultracart_api/models/email_commseq_email.rb +470 -435
  903. data/lib/ultracart_api/models/email_commseq_email_response.rb +256 -221
  904. data/lib/ultracart_api/models/email_commseq_email_send_test_request.rb +304 -269
  905. data/lib/ultracart_api/models/email_commseq_email_send_test_response.rb +247 -212
  906. data/lib/ultracart_api/models/email_commseq_emails_request.rb +258 -223
  907. data/lib/ultracart_api/models/email_commseq_emails_response.rb +258 -223
  908. data/lib/ultracart_api/models/email_commseq_postcard.rb +340 -305
  909. data/lib/ultracart_api/models/email_commseq_postcard_response.rb +256 -221
  910. data/lib/ultracart_api/models/email_commseq_postcard_send_test_request.rb +329 -294
  911. data/lib/ultracart_api/models/email_commseq_postcard_send_test_response.rb +274 -239
  912. data/lib/ultracart_api/models/email_commseq_postcards_request.rb +221 -186
  913. data/lib/ultracart_api/models/email_commseq_postcards_response.rb +258 -223
  914. data/lib/ultracart_api/models/email_commseq_response.rb +256 -221
  915. data/lib/ultracart_api/models/email_commseq_stat.rb +580 -545
  916. data/lib/ultracart_api/models/email_commseq_stat_response.rb +256 -221
  917. data/lib/ultracart_api/models/email_commseq_step.rb +348 -313
  918. data/lib/ultracart_api/models/email_commseq_step_log.rb +240 -205
  919. data/lib/ultracart_api/models/email_commseq_step_logs_response.rb +258 -223
  920. data/lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb +275 -240
  921. data/lib/ultracart_api/models/email_commseq_webhook_send_test_response.rb +277 -242
  922. data/lib/ultracart_api/models/email_commseqs_response.rb +258 -223
  923. data/lib/ultracart_api/models/email_customer.rb +292 -257
  924. data/lib/ultracart_api/models/email_customer_editor_url_response.rb +256 -221
  925. data/lib/ultracart_api/models/email_customers_response.rb +262 -227
  926. data/lib/ultracart_api/models/email_dashboard_activity.rb +280 -245
  927. data/lib/ultracart_api/models/email_dashboard_activity_response.rb +258 -223
  928. data/lib/ultracart_api/models/email_dashboard_stats_response.rb +258 -223
  929. data/lib/ultracart_api/models/email_domain.rb +329 -294
  930. data/lib/ultracart_api/models/email_editor_token_response.rb +256 -221
  931. data/lib/ultracart_api/models/email_flow.rb +505 -470
  932. data/lib/ultracart_api/models/email_flow_back_populate_request.rb +230 -195
  933. data/lib/ultracart_api/models/email_flow_back_populate_response.rb +247 -212
  934. data/lib/ultracart_api/models/email_flow_folder.rb +275 -240
  935. data/lib/ultracart_api/models/email_flow_folder_response.rb +256 -221
  936. data/lib/ultracart_api/models/email_flow_folders_response.rb +258 -223
  937. data/lib/ultracart_api/models/email_flow_response.rb +256 -221
  938. data/lib/ultracart_api/models/email_flows_response.rb +258 -223
  939. data/lib/ultracart_api/models/email_global_settings.rb +219 -184
  940. data/lib/ultracart_api/models/email_global_settings_response.rb +256 -221
  941. data/lib/ultracart_api/models/email_global_unsubscribe_request.rb +219 -184
  942. data/lib/ultracart_api/models/email_global_unsubscribe_response.rb +219 -184
  943. data/lib/ultracart_api/models/email_histogram_property_names_response.rb +221 -186
  944. data/lib/ultracart_api/models/email_histogram_property_values_response.rb +221 -186
  945. data/lib/ultracart_api/models/email_list.rb +347 -312
  946. data/lib/ultracart_api/models/email_list_archive_response.rb +256 -221
  947. data/lib/ultracart_api/models/email_list_customer.rb +250 -215
  948. data/lib/ultracart_api/models/email_list_customers_response.rb +262 -227
  949. data/lib/ultracart_api/models/email_list_response.rb +256 -221
  950. data/lib/ultracart_api/models/email_list_segment_folder.rb +275 -240
  951. data/lib/ultracart_api/models/email_list_segment_folder_response.rb +256 -221
  952. data/lib/ultracart_api/models/email_list_segment_folders_response.rb +258 -223
  953. data/lib/ultracart_api/models/email_list_segment_membership.rb +250 -215
  954. data/lib/ultracart_api/models/email_list_segment_used_by.rb +240 -205
  955. data/lib/ultracart_api/models/email_list_subscribe_response.rb +228 -193
  956. data/lib/ultracart_api/models/email_lists_response.rb +258 -223
  957. data/lib/ultracart_api/models/email_order.rb +249 -214
  958. data/lib/ultracart_api/models/email_orders_response.rb +258 -223
  959. data/lib/ultracart_api/models/email_performance.rb +475 -440
  960. data/lib/ultracart_api/models/email_performance_customer_histogram.rb +222 -187
  961. data/lib/ultracart_api/models/email_performance_customer_histogram_period.rb +260 -225
  962. data/lib/ultracart_api/models/email_performance_daily.rb +280 -245
  963. data/lib/ultracart_api/models/email_performance_response.rb +256 -221
  964. data/lib/ultracart_api/models/email_plan.rb +365 -330
  965. data/lib/ultracart_api/models/email_plan_additional.rb +291 -256
  966. data/lib/ultracart_api/models/email_plan_response.rb +256 -221
  967. data/lib/ultracart_api/models/email_postcard_stat.rb +531 -496
  968. data/lib/ultracart_api/models/email_segment.rb +445 -410
  969. data/lib/ultracart_api/models/email_segment_archive_response.rb +256 -221
  970. data/lib/ultracart_api/models/email_segment_customer.rb +250 -215
  971. data/lib/ultracart_api/models/email_segment_customers_response.rb +262 -227
  972. data/lib/ultracart_api/models/email_segment_download_prepare_response.rb +283 -248
  973. data/lib/ultracart_api/models/email_segment_response.rb +256 -221
  974. data/lib/ultracart_api/models/email_segments_response.rb +258 -223
  975. data/lib/ultracart_api/models/email_sending_domain_response.rb +256 -221
  976. data/lib/ultracart_api/models/email_sending_domains_response.rb +258 -223
  977. data/lib/ultracart_api/models/email_settings.rb +318 -283
  978. data/lib/ultracart_api/models/email_settings_response.rb +256 -221
  979. data/lib/ultracart_api/models/email_stat.rb +591 -556
  980. data/lib/ultracart_api/models/email_stat_postcard_summary_request.rb +230 -195
  981. data/lib/ultracart_api/models/email_stat_postcard_summary_response.rb +258 -223
  982. data/lib/ultracart_api/models/email_stat_summary_request.rb +241 -206
  983. data/lib/ultracart_api/models/email_stat_summary_response.rb +258 -223
  984. data/lib/ultracart_api/models/email_step_stat.rb +410 -375
  985. data/lib/ultracart_api/models/email_step_stat_request.rb +230 -195
  986. data/lib/ultracart_api/models/email_step_stat_response.rb +258 -223
  987. data/lib/ultracart_api/models/email_step_waiting_request.rb +221 -186
  988. data/lib/ultracart_api/models/email_step_waiting_response.rb +221 -186
  989. data/lib/ultracart_api/models/email_template.rb +365 -330
  990. data/lib/ultracart_api/models/email_templates_response.rb +258 -223
  991. data/lib/ultracart_api/models/email_third_party_list.rb +230 -195
  992. data/lib/ultracart_api/models/email_third_party_list_import_request.rb +222 -187
  993. data/lib/ultracart_api/models/email_third_party_provider.rb +324 -289
  994. data/lib/ultracart_api/models/email_third_party_providers_response.rb +258 -223
  995. data/lib/ultracart_api/models/email_third_party_tag.rb +230 -195
  996. data/lib/ultracart_api/models/email_verify_token_request.rb +230 -195
  997. data/lib/ultracart_api/models/email_verify_token_response.rb +257 -222
  998. data/lib/ultracart_api/models/email_verify_token_validate_request.rb +220 -185
  999. data/lib/ultracart_api/models/email_verify_token_validate_response.rb +247 -212
  1000. data/lib/ultracart_api/models/email_webhook_editor_values_response.rb +278 -243
  1001. data/lib/ultracart_api/models/error.rb +260 -225
  1002. data/lib/ultracart_api/models/error_response.rb +247 -212
  1003. data/lib/ultracart_api/models/experiment.rb +426 -391
  1004. data/lib/ultracart_api/models/experiment_response.rb +256 -221
  1005. data/lib/ultracart_api/models/experiment_variation.rb +432 -397
  1006. data/lib/ultracart_api/models/experiment_variation_stat.rb +320 -285
  1007. data/lib/ultracart_api/models/experiments_response.rb +258 -223
  1008. data/lib/ultracart_api/models/fulfillment_inventory.rb +228 -193
  1009. data/lib/ultracart_api/models/fulfillment_shipment.rb +262 -227
  1010. data/lib/ultracart_api/models/geo_point.rb +228 -193
  1011. data/lib/ultracart_api/models/geocode_request.rb +260 -225
  1012. data/lib/ultracart_api/models/geocode_response.rb +265 -230
  1013. data/lib/ultracart_api/models/gift_certificate.rb +367 -332
  1014. data/lib/ultracart_api/models/gift_certificate_create_request.rb +260 -225
  1015. data/lib/ultracart_api/models/gift_certificate_ledger_entry.rb +285 -250
  1016. data/lib/ultracart_api/models/gift_certificate_query.rb +300 -265
  1017. data/lib/ultracart_api/models/gift_certificate_response.rb +256 -221
  1018. data/lib/ultracart_api/models/gift_certificates_response.rb +258 -223
  1019. data/lib/ultracart_api/models/group.rb +266 -231
  1020. data/lib/ultracart_api/models/group_response.rb +256 -221
  1021. data/lib/ultracart_api/models/group_user_membership.rb +260 -225
  1022. data/lib/ultracart_api/models/groups_response.rb +258 -223
  1023. data/lib/ultracart_api/models/http_header.rb +230 -195
  1024. data/lib/ultracart_api/models/integration_log.rb +379 -344
  1025. data/lib/ultracart_api/models/integration_log_file.rb +246 -211
  1026. data/lib/ultracart_api/models/integration_log_log.rb +228 -193
  1027. data/lib/ultracart_api/models/integration_log_query_filter_values.rb +340 -305
  1028. data/lib/ultracart_api/models/integration_log_query_request.rb +333 -298
  1029. data/lib/ultracart_api/models/integration_log_query_response.rb +267 -232
  1030. data/lib/ultracart_api/models/integration_log_response.rb +256 -221
  1031. data/lib/ultracart_api/models/integration_log_summary.rb +291 -256
  1032. data/lib/ultracart_api/models/integration_log_summary_query_request.rb +230 -195
  1033. data/lib/ultracart_api/models/integration_log_summary_query_response.rb +258 -223
  1034. data/lib/ultracart_api/models/item.rb +748 -713
  1035. data/lib/ultracart_api/models/item_accounting.rb +260 -225
  1036. data/lib/ultracart_api/models/item_amember.rb +245 -210
  1037. data/lib/ultracart_api/models/item_auto_order.rb +403 -368
  1038. data/lib/ultracart_api/models/item_auto_order_step.rb +413 -378
  1039. data/lib/ultracart_api/models/item_auto_order_step_arbitrary_unit_cost_schedule.rb +230 -195
  1040. data/lib/ultracart_api/models/item_auto_order_step_grandfather_pricing.rb +230 -195
  1041. data/lib/ultracart_api/models/item_cc_bill.rb +270 -235
  1042. data/lib/ultracart_api/models/item_channel_partner_mapping.rb +445 -410
  1043. data/lib/ultracart_api/models/item_chargeback.rb +234 -199
  1044. data/lib/ultracart_api/models/item_chargeback_addendum.rb +250 -215
  1045. data/lib/ultracart_api/models/item_chargeback_adjustment_request.rb +240 -205
  1046. data/lib/ultracart_api/models/item_checkout.rb +265 -230
  1047. data/lib/ultracart_api/models/item_content.rb +361 -326
  1048. data/lib/ultracart_api/models/item_content_assignment.rb +285 -250
  1049. data/lib/ultracart_api/models/item_content_attribute.rb +280 -245
  1050. data/lib/ultracart_api/models/item_content_multimedia.rb +441 -406
  1051. data/lib/ultracart_api/models/item_content_multimedia_thumbnail.rb +270 -235
  1052. data/lib/ultracart_api/models/item_digital_delivery.rb +317 -282
  1053. data/lib/ultracart_api/models/item_digital_item.rb +305 -270
  1054. data/lib/ultracart_api/models/item_ebay.rb +901 -866
  1055. data/lib/ultracart_api/models/item_ebay_category_specific.rb +230 -195
  1056. data/lib/ultracart_api/models/item_ebay_market_listing.rb +260 -225
  1057. data/lib/ultracart_api/models/item_ebay_market_place_analysis.rb +311 -276
  1058. data/lib/ultracart_api/models/item_email_notifications.rb +230 -195
  1059. data/lib/ultracart_api/models/item_enrollment123.rb +220 -185
  1060. data/lib/ultracart_api/models/item_fulfillment_addon.rb +250 -215
  1061. data/lib/ultracart_api/models/item_gift_certificate.rb +230 -195
  1062. data/lib/ultracart_api/models/item_google_product_search.rb +1289 -1254
  1063. data/lib/ultracart_api/models/item_identifiers.rb +310 -275
  1064. data/lib/ultracart_api/models/item_instant_payment_notification.rb +270 -235
  1065. data/lib/ultracart_api/models/item_instant_payment_notifications.rb +222 -187
  1066. data/lib/ultracart_api/models/item_internal.rb +235 -200
  1067. data/lib/ultracart_api/models/item_kit_component.rb +260 -225
  1068. data/lib/ultracart_api/models/item_kit_definition.rb +222 -187
  1069. data/lib/ultracart_api/models/item_option.rb +416 -381
  1070. data/lib/ultracart_api/models/item_option_value.rb +409 -374
  1071. data/lib/ultracart_api/models/item_option_value_additional_item.rb +230 -195
  1072. data/lib/ultracart_api/models/item_option_value_digital_item.rb +230 -195
  1073. data/lib/ultracart_api/models/item_payment_processing.rb +264 -229
  1074. data/lib/ultracart_api/models/item_physical.rb +246 -211
  1075. data/lib/ultracart_api/models/item_pricing.rb +422 -387
  1076. data/lib/ultracart_api/models/item_pricing_tier.rb +261 -226
  1077. data/lib/ultracart_api/models/item_pricing_tier_discount.rb +230 -195
  1078. data/lib/ultracart_api/models/item_pricing_tier_limit.rb +240 -205
  1079. data/lib/ultracart_api/models/item_property.rb +270 -235
  1080. data/lib/ultracart_api/models/item_realtime_pricing.rb +240 -205
  1081. data/lib/ultracart_api/models/item_related.rb +242 -207
  1082. data/lib/ultracart_api/models/item_related_item.rb +274 -239
  1083. data/lib/ultracart_api/models/item_reporting.rb +232 -197
  1084. data/lib/ultracart_api/models/item_response.rb +256 -221
  1085. data/lib/ultracart_api/models/item_restriction.rb +292 -257
  1086. data/lib/ultracart_api/models/item_restriction_item.rb +274 -239
  1087. data/lib/ultracart_api/models/item_revguard.rb +280 -245
  1088. data/lib/ultracart_api/models/item_reviews.rb +300 -265
  1089. data/lib/ultracart_api/models/item_salesforce.rb +230 -195
  1090. data/lib/ultracart_api/models/item_shipping.rb +713 -678
  1091. data/lib/ultracart_api/models/item_shipping_case.rb +265 -230
  1092. data/lib/ultracart_api/models/item_shipping_destination_markup.rb +315 -280
  1093. data/lib/ultracart_api/models/item_shipping_destination_restriction.rb +304 -269
  1094. data/lib/ultracart_api/models/item_shipping_distribution_center.rb +380 -345
  1095. data/lib/ultracart_api/models/item_shipping_method.rb +394 -359
  1096. data/lib/ultracart_api/models/item_shipping_package_requirement.rb +230 -195
  1097. data/lib/ultracart_api/models/item_tag.rb +279 -244
  1098. data/lib/ultracart_api/models/item_tags.rb +222 -187
  1099. data/lib/ultracart_api/models/item_tax.rb +286 -251
  1100. data/lib/ultracart_api/models/item_tax_exemption.rb +335 -300
  1101. data/lib/ultracart_api/models/item_third_party_email_marketing.rb +302 -267
  1102. data/lib/ultracart_api/models/item_variant_item.rb +289 -254
  1103. data/lib/ultracart_api/models/item_variation.rb +292 -257
  1104. data/lib/ultracart_api/models/item_variation_option.rb +265 -230
  1105. data/lib/ultracart_api/models/item_wishlist_member.rb +255 -220
  1106. data/lib/ultracart_api/models/items_request.rb +222 -187
  1107. data/lib/ultracart_api/models/items_response.rb +259 -224
  1108. data/lib/ultracart_api/models/key_value.rb +240 -205
  1109. data/lib/ultracart_api/models/library_filter_values.rb +254 -219
  1110. data/lib/ultracart_api/models/library_filter_values_response.rb +256 -221
  1111. data/lib/ultracart_api/models/library_item.rb +606 -571
  1112. data/lib/ultracart_api/models/library_item_account.rb +237 -202
  1113. data/lib/ultracart_api/models/library_item_asset.rb +228 -193
  1114. data/lib/ultracart_api/models/library_item_attribute.rb +228 -193
  1115. data/lib/ultracart_api/models/library_item_email.rb +237 -202
  1116. data/lib/ultracart_api/models/library_item_published_meta.rb +290 -255
  1117. data/lib/ultracart_api/models/library_item_purchased_meta.rb +240 -205
  1118. data/lib/ultracart_api/models/library_item_query.rb +330 -295
  1119. data/lib/ultracart_api/models/library_item_response.rb +256 -221
  1120. data/lib/ultracart_api/models/library_item_screenshot.rb +228 -193
  1121. data/lib/ultracart_api/models/library_items_response.rb +259 -224
  1122. data/lib/ultracart_api/models/linked_account.rb +240 -205
  1123. data/lib/ultracart_api/models/list_segment_membership.rb +237 -202
  1124. data/lib/ultracart_api/models/lookup_request.rb +255 -220
  1125. data/lib/ultracart_api/models/lookup_response.rb +258 -223
  1126. data/lib/ultracart_api/models/mailgun.rb +219 -184
  1127. data/lib/ultracart_api/models/metric.rb +282 -247
  1128. data/lib/ultracart_api/models/notification.rb +322 -287
  1129. data/lib/ultracart_api/models/oauth_revoke_success_response.rb +230 -195
  1130. data/lib/ultracart_api/models/oauth_token_response.rb +321 -286
  1131. data/lib/ultracart_api/models/order.rb +604 -569
  1132. data/lib/ultracart_api/models/order_affiliate.rb +242 -207
  1133. data/lib/ultracart_api/models/order_affiliate_ledger.rb +334 -299
  1134. data/lib/ultracart_api/models/order_auto_order.rb +448 -413
  1135. data/lib/ultracart_api/models/order_billing.rb +597 -562
  1136. data/lib/ultracart_api/models/order_buysafe.rb +268 -233
  1137. data/lib/ultracart_api/models/order_by_token_query.rb +220 -185
  1138. data/lib/ultracart_api/models/order_channel_partner.rb +335 -300
  1139. data/lib/ultracart_api/models/order_checkout.rb +469 -434
  1140. data/lib/ultracart_api/models/order_coupon.rb +290 -255
  1141. data/lib/ultracart_api/models/order_digital_item.rb +290 -255
  1142. data/lib/ultracart_api/models/order_digital_order.rb +262 -227
  1143. data/lib/ultracart_api/models/order_edi.rb +265 -230
  1144. data/lib/ultracart_api/models/order_format.rb +404 -369
  1145. data/lib/ultracart_api/models/order_format_response.rb +232 -197
  1146. data/lib/ultracart_api/models/order_fraud_score.rb +444 -409
  1147. data/lib/ultracart_api/models/order_gift.rb +351 -316
  1148. data/lib/ultracart_api/models/order_gift_certificate.rb +239 -204
  1149. data/lib/ultracart_api/models/order_internal.rb +275 -240
  1150. data/lib/ultracart_api/models/order_item.rb +889 -854
  1151. data/lib/ultracart_api/models/order_item_edi.rb +234 -199
  1152. data/lib/ultracart_api/models/order_item_edi_identification.rb +230 -195
  1153. data/lib/ultracart_api/models/order_item_edi_lot.rb +240 -205
  1154. data/lib/ultracart_api/models/order_item_option.rb +378 -343
  1155. data/lib/ultracart_api/models/order_item_option_file_attachment.rb +250 -215
  1156. data/lib/ultracart_api/models/order_item_property.rb +280 -245
  1157. data/lib/ultracart_api/models/order_item_tag.rb +235 -200
  1158. data/lib/ultracart_api/models/order_linked_shipment.rb +264 -229
  1159. data/lib/ultracart_api/models/order_marketing.rb +270 -235
  1160. data/lib/ultracart_api/models/order_packing_slip_response.rb +257 -222
  1161. data/lib/ultracart_api/models/order_payment.rb +432 -397
  1162. data/lib/ultracart_api/models/order_payment_check.rb +220 -185
  1163. data/lib/ultracart_api/models/order_payment_credit_card.rb +354 -319
  1164. data/lib/ultracart_api/models/order_payment_e_check.rb +476 -441
  1165. data/lib/ultracart_api/models/order_payment_insurance.rb +250 -215
  1166. data/lib/ultracart_api/models/order_payment_purchase_order.rb +220 -185
  1167. data/lib/ultracart_api/models/order_payment_transaction.rb +252 -217
  1168. data/lib/ultracart_api/models/order_payment_transaction_detail.rb +240 -205
  1169. data/lib/ultracart_api/models/order_process_payment_request.rb +230 -195
  1170. data/lib/ultracart_api/models/order_process_payment_response.rb +256 -221
  1171. data/lib/ultracart_api/models/order_property.rb +280 -245
  1172. data/lib/ultracart_api/models/order_query.rb +826 -791
  1173. data/lib/ultracart_api/models/order_query_batch.rb +222 -187
  1174. data/lib/ultracart_api/models/order_quote.rb +240 -205
  1175. data/lib/ultracart_api/models/order_replacement.rb +467 -432
  1176. data/lib/ultracart_api/models/order_replacement_item.rb +255 -220
  1177. data/lib/ultracart_api/models/order_replacement_response.rb +264 -229
  1178. data/lib/ultracart_api/models/order_response.rb +256 -221
  1179. data/lib/ultracart_api/models/order_salesforce.rb +220 -185
  1180. data/lib/ultracart_api/models/order_shipping.rb +770 -735
  1181. data/lib/ultracart_api/models/order_summary.rb +390 -355
  1182. data/lib/ultracart_api/models/order_tag.rb +235 -200
  1183. data/lib/ultracart_api/models/order_taxes.rb +395 -360
  1184. data/lib/ultracart_api/models/order_token_response.rb +257 -222
  1185. data/lib/ultracart_api/models/order_tracking_number_detail.rb +320 -285
  1186. data/lib/ultracart_api/models/order_tracking_number_details.rb +374 -339
  1187. data/lib/ultracart_api/models/orders_response.rb +259 -224
  1188. data/lib/ultracart_api/models/permission.rb +240 -205
  1189. data/lib/ultracart_api/models/pricing_tier.rb +533 -498
  1190. data/lib/ultracart_api/models/pricing_tier_notification.rb +270 -235
  1191. data/lib/ultracart_api/models/pricing_tiers_response.rb +259 -224
  1192. data/lib/ultracart_api/models/property.rb +228 -193
  1193. data/lib/ultracart_api/models/publish_library_item_request.rb +220 -185
  1194. data/lib/ultracart_api/models/register_affiliate_click_request.rb +270 -235
  1195. data/lib/ultracart_api/models/register_affiliate_click_response.rb +254 -219
  1196. data/lib/ultracart_api/models/response_metadata.rb +229 -194
  1197. data/lib/ultracart_api/models/result_set.rb +270 -235
  1198. data/lib/ultracart_api/models/screen_recording.rb +688 -653
  1199. data/lib/ultracart_api/models/screen_recording_ad_platform.rb +280 -245
  1200. data/lib/ultracart_api/models/screen_recording_filter.rb +758 -723
  1201. data/lib/ultracart_api/models/screen_recording_filter_geo_distance.rb +255 -220
  1202. data/lib/ultracart_api/models/screen_recording_filter_ip_search.rb +246 -211
  1203. data/lib/ultracart_api/models/screen_recording_filter_page_view.rb +369 -334
  1204. data/lib/ultracart_api/models/screen_recording_filter_page_view_event.rb +230 -195
  1205. data/lib/ultracart_api/models/screen_recording_filter_page_view_event_param.rb +255 -220
  1206. data/lib/ultracart_api/models/screen_recording_filter_page_view_param.rb +228 -193
  1207. data/lib/ultracart_api/models/screen_recording_filter_page_view_referrer_param.rb +228 -193
  1208. data/lib/ultracart_api/models/screen_recording_filter_range_big_decimal.rb +255 -220
  1209. data/lib/ultracart_api/models/screen_recording_filter_range_date.rb +230 -195
  1210. data/lib/ultracart_api/models/screen_recording_filter_range_integer.rb +255 -220
  1211. data/lib/ultracart_api/models/screen_recording_filter_string_search.rb +255 -220
  1212. data/lib/ultracart_api/models/screen_recording_filter_values.rb +435 -400
  1213. data/lib/ultracart_api/models/screen_recording_filter_values_event.rb +230 -195
  1214. data/lib/ultracart_api/models/screen_recording_filter_values_event_params.rb +263 -228
  1215. data/lib/ultracart_api/models/screen_recording_filter_values_page_param.rb +230 -195
  1216. data/lib/ultracart_api/models/screen_recording_filter_values_page_view.rb +272 -237
  1217. data/lib/ultracart_api/models/screen_recording_heatmap.rb +426 -391
  1218. data/lib/ultracart_api/models/screen_recording_heatmap_index_request.rb +219 -184
  1219. data/lib/ultracart_api/models/screen_recording_heatmap_index_response.rb +258 -223
  1220. data/lib/ultracart_api/models/screen_recording_heatmap_request.rb +239 -204
  1221. data/lib/ultracart_api/models/screen_recording_heatmap_reset.rb +219 -184
  1222. data/lib/ultracart_api/models/screen_recording_heatmap_response.rb +256 -221
  1223. data/lib/ultracart_api/models/screen_recording_heatmap_url.rb +266 -231
  1224. data/lib/ultracart_api/models/screen_recording_merchant_notes_request.rb +219 -184
  1225. data/lib/ultracart_api/models/screen_recording_multifield.rb +255 -220
  1226. data/lib/ultracart_api/models/screen_recording_page_view.rb +391 -356
  1227. data/lib/ultracart_api/models/screen_recording_page_view_data_response.rb +256 -221
  1228. data/lib/ultracart_api/models/screen_recording_page_view_event.rb +267 -232
  1229. data/lib/ultracart_api/models/screen_recording_page_view_event_parameter.rb +228 -193
  1230. data/lib/ultracart_api/models/screen_recording_page_view_parameter.rb +228 -193
  1231. data/lib/ultracart_api/models/screen_recording_query_request.rb +219 -184
  1232. data/lib/ultracart_api/models/screen_recording_query_response.rb +314 -279
  1233. data/lib/ultracart_api/models/screen_recording_response.rb +265 -230
  1234. data/lib/ultracart_api/models/screen_recording_segment.rb +302 -267
  1235. data/lib/ultracart_api/models/screen_recording_segment_response.rb +256 -221
  1236. data/lib/ultracart_api/models/screen_recording_segments_response.rb +258 -223
  1237. data/lib/ultracart_api/models/screen_recording_settings.rb +284 -249
  1238. data/lib/ultracart_api/models/screen_recording_settings_response.rb +256 -221
  1239. data/lib/ultracart_api/models/screen_recording_store_front.rb +228 -193
  1240. data/lib/ultracart_api/models/screen_recording_tags_request.rb +221 -186
  1241. data/lib/ultracart_api/models/screen_recording_tags_response.rb +258 -223
  1242. data/lib/ultracart_api/models/screen_recording_user_agent.rb +255 -220
  1243. data/lib/ultracart_api/models/screen_recording_user_agent_device.rb +219 -184
  1244. data/lib/ultracart_api/models/screen_recording_user_agent_os.rb +237 -202
  1245. data/lib/ultracart_api/models/screen_recording_user_property.rb +228 -193
  1246. data/lib/ultracart_api/models/screenshots_response.rb +259 -224
  1247. data/lib/ultracart_api/models/self_config.rb +220 -185
  1248. data/lib/ultracart_api/models/simple_value.rb +230 -195
  1249. data/lib/ultracart_api/models/single_sign_on_authorize_request.rb +230 -195
  1250. data/lib/ultracart_api/models/single_sign_on_authorize_response.rb +230 -195
  1251. data/lib/ultracart_api/models/single_sign_on_token_request.rb +230 -195
  1252. data/lib/ultracart_api/models/single_sign_on_token_response.rb +240 -205
  1253. data/lib/ultracart_api/models/sovos_config.rb +280 -245
  1254. data/lib/ultracart_api/models/state_province.rb +245 -210
  1255. data/lib/ultracart_api/models/step_waiting.rb +228 -193
  1256. data/lib/ultracart_api/models/tax_city.rb +302 -267
  1257. data/lib/ultracart_api/models/tax_country.rb +302 -267
  1258. data/lib/ultracart_api/models/tax_country_code.rb +260 -225
  1259. data/lib/ultracart_api/models/tax_county.rb +312 -277
  1260. data/lib/ultracart_api/models/tax_jar_config.rb +280 -245
  1261. data/lib/ultracart_api/models/tax_postal_code.rb +280 -245
  1262. data/lib/ultracart_api/models/tax_provider_activate_result.rb +229 -194
  1263. data/lib/ultracart_api/models/tax_provider_avalara.rb +249 -214
  1264. data/lib/ultracart_api/models/tax_provider_avalara_companies_result.rb +222 -187
  1265. data/lib/ultracart_api/models/tax_provider_avalara_company.rb +260 -225
  1266. data/lib/ultracart_api/models/tax_provider_self.rb +261 -226
  1267. data/lib/ultracart_api/models/tax_provider_self_countries_response.rb +222 -187
  1268. data/lib/ultracart_api/models/tax_provider_self_regions_response.rb +222 -187
  1269. data/lib/ultracart_api/models/tax_provider_sovos.rb +249 -214
  1270. data/lib/ultracart_api/models/tax_provider_tax_jar.rb +249 -214
  1271. data/lib/ultracart_api/models/tax_provider_test_result.rb +229 -194
  1272. data/lib/ultracart_api/models/tax_provider_ultra_cart.rb +261 -226
  1273. data/lib/ultracart_api/models/tax_provider_ultra_cart_state.rb +310 -275
  1274. data/lib/ultracart_api/models/tax_providers_response.rb +292 -257
  1275. data/lib/ultracart_api/models/tax_state.rb +392 -357
  1276. data/lib/ultracart_api/models/tax_state_code.rb +260 -225
  1277. data/lib/ultracart_api/models/temp_multimedia.rb +329 -294
  1278. data/lib/ultracart_api/models/temp_multimedia_response.rb +256 -221
  1279. data/lib/ultracart_api/models/thumbnail_parameters_request.rb +255 -220
  1280. data/lib/ultracart_api/models/thumbnail_parameters_response.rb +257 -222
  1281. data/lib/ultracart_api/models/transaction_email.rb +414 -379
  1282. data/lib/ultracart_api/models/transaction_email_list_response.rb +258 -223
  1283. data/lib/ultracart_api/models/transaction_email_option.rb +282 -247
  1284. data/lib/ultracart_api/models/transaction_email_response.rb +256 -221
  1285. data/lib/ultracart_api/models/twilio.rb +248 -213
  1286. data/lib/ultracart_api/models/twilio_response.rb +265 -230
  1287. data/lib/ultracart_api/models/twilios_response.rb +258 -223
  1288. data/lib/ultracart_api/models/ultra_cart_config.rb +220 -185
  1289. data/lib/ultracart_api/models/upload_coupon_codes_request.rb +259 -224
  1290. data/lib/ultracart_api/models/upload_coupon_codes_response.rb +283 -248
  1291. data/lib/ultracart_api/models/user.rb +377 -342
  1292. data/lib/ultracart_api/models/user_group_membership.rb +240 -205
  1293. data/lib/ultracart_api/models/user_login.rb +250 -215
  1294. data/lib/ultracart_api/models/user_logins_response.rb +259 -224
  1295. data/lib/ultracart_api/models/user_response.rb +256 -221
  1296. data/lib/ultracart_api/models/users_response.rb +258 -223
  1297. data/lib/ultracart_api/models/verification_record.rb +237 -202
  1298. data/lib/ultracart_api/models/warning.rb +230 -195
  1299. data/lib/ultracart_api/models/webhook.rb +437 -402
  1300. data/lib/ultracart_api/models/webhook_event_category.rb +264 -229
  1301. data/lib/ultracart_api/models/webhook_event_subscription.rb +300 -265
  1302. data/lib/ultracart_api/models/webhook_log.rb +324 -289
  1303. data/lib/ultracart_api/models/webhook_log_response.rb +256 -221
  1304. data/lib/ultracart_api/models/webhook_log_summaries_response.rb +259 -224
  1305. data/lib/ultracart_api/models/webhook_log_summary.rb +240 -205
  1306. data/lib/ultracart_api/models/webhook_response.rb +256 -221
  1307. data/lib/ultracart_api/models/webhook_sample_request.rb +252 -217
  1308. data/lib/ultracart_api/models/webhook_sample_request_response.rb +256 -221
  1309. data/lib/ultracart_api/models/webhooks_response.rb +258 -223
  1310. data/lib/ultracart_api/models/weight.rb +264 -229
  1311. data/lib/ultracart_api/version.rb +15 -15
  1312. data/lib/ultracart_api.rb +690 -691
  1313. data/spec/api_client_spec.rb +226 -243
  1314. data/spec/configuration_spec.rb +42 -42
  1315. data/spec/spec_helper.rb +111 -111
  1316. data/ultracart_api.gemspec +38 -46
  1317. metadata +4 -166
  1318. data/docs/CouponNoDiscount.md +0 -7
  1319. data/lib/ultracart_api/models/coupon_no_discount.rb +0 -175
@@ -1,400 +1,399 @@
1
- =begin
2
- #UltraCart Rest API V2
3
-
4
- #UltraCart REST API Version 2
5
-
6
- OpenAPI spec version: 2.0.0
7
- Contact: support@ultracart.com
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.15-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'date'
14
- require 'json'
15
- require 'logger'
16
- require 'tempfile'
17
- require 'typhoeus'
18
- require 'addressable/uri'
19
-
20
- module UltracartClient
21
- class ApiClient
22
- # The Configuration object holding settings to be used in the API client.
23
- attr_accessor :config
24
-
25
- # Defines the headers to be used in HTTP requests of all API calls by default.
26
- #
27
- # @return [Hash]
28
- attr_accessor :default_headers
29
-
30
- # Initializes the ApiClient
31
- # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
32
- def initialize(config = Configuration.default)
33
- @config = config
34
- @user_agent = "Swagger-Codegen/#{VERSION}/ruby"
35
- @default_headers = {
36
- 'Content-Type' => 'application/json',
37
- 'User-Agent' => @user_agent
38
- }
39
- end
40
-
41
- def self.default
42
- @@default ||= ApiClient.new
43
- end
44
-
45
- # Call an API with given options.
46
- #
47
- # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
48
- # the data deserialized from response body (could be nil), response status code and response headers.
49
- def call_api(http_method, path, opts = {})
50
- request = build_request(http_method, path, opts)
51
- response = request.run
52
-
53
- if @config.debugging
54
- @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
55
- end
56
-
57
- unless response.success?
58
- if response.timed_out?
59
- fail ApiError.new('Connection timed out')
60
- elsif response.code == 0
61
- # Errors from libcurl will be made visible here
62
- fail ApiError.new(:code => 0,
63
- :message => response.return_message)
64
- else
65
- fail ApiError.new(:code => response.code,
66
- :response_headers => response.headers,
67
- :response_body => response.body),
68
- response.status_message
69
- end
70
- end
71
-
72
- if opts[:return_type]
73
- data = deserialize(response, opts[:return_type])
74
- else
75
- data = nil
76
- end
77
- return data, response.code, response.headers
78
- end
79
-
80
- # Builds the HTTP request
81
- #
82
- # @param [String] http_method HTTP method/verb (e.g. POST)
83
- # @param [String] path URL path (e.g. /account/new)
84
- # @option opts [Hash] :header_params Header parameters
85
- # @option opts [Hash] :query_params Query parameters
86
- # @option opts [Hash] :form_params Query parameters
87
- # @option opts [Object] :body HTTP body (JSON/XML)
88
- # @return [Typhoeus::Request] A Typhoeus Request
89
- def build_request(http_method, path, opts = {})
90
- url = build_request_url(path)
91
- http_method = http_method.to_sym.downcase
92
-
93
- header_params = @default_headers.merge(opts[:header_params] || {})
94
- query_params = opts[:query_params] || {}
95
- form_params = opts[:form_params] || {}
96
-
97
- update_params_for_auth! header_params, query_params, opts[:auth_names]
98
-
99
- # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
100
- _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
101
-
102
- req_opts = {
103
- :method => http_method,
104
- :headers => header_params,
105
- :params => query_params,
106
- :params_encoding => @config.params_encoding,
107
- :timeout => @config.timeout,
108
- :ssl_verifypeer => @config.verify_ssl,
109
- :ssl_verifyhost => _verify_ssl_host,
110
- :sslcert => @config.cert_file,
111
- :sslkey => @config.key_file,
112
- :verbose => @config.debugging
113
- }
114
-
115
- req_opts.merge!(multipart: true) if header_params['Content-Type'].start_with? "multipart/"
116
-
117
- # set custom cert, if provided
118
- req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
119
-
120
- if [:post, :patch, :put, :delete].include?(http_method)
121
- req_body = build_request_body(header_params, form_params, opts[:body])
122
- req_opts.update :body => req_body
123
- if @config.debugging
124
- @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
125
- end
126
- end
127
-
128
- request = Typhoeus::Request.new(url, req_opts)
129
- download_file(request) if opts[:return_type] == 'File'
130
- request
131
- end
132
-
133
- # Check if the given MIME is a JSON MIME.
134
- # JSON MIME examples:
135
- # application/json
136
- # application/json; charset=UTF8
137
- # APPLICATION/JSON
138
- # */*
139
- # @param [String] mime MIME
140
- # @return [Boolean] True if the MIME is application/json
141
- def json_mime?(mime)
142
- (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
143
- end
144
-
145
- # Deserialize the response to the given return type.
146
- #
147
- # @param [Response] response HTTP response
148
- # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
149
- def deserialize(response, return_type)
150
- body = response.body
151
-
152
- # handle file downloading - return the File instance processed in request callbacks
153
- # note that response body is empty when the file is written in chunks in request on_body callback
154
- return @tempfile if return_type == 'File'
155
-
156
- return nil if body.nil? || body.empty?
157
-
158
- # return response body directly for String return type
159
- return body if return_type == 'String'
160
-
161
- # ensuring a default content type
162
- content_type = response.headers['Content-Type'] || 'application/json'
163
-
164
- fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
165
-
166
- begin
167
- data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
168
- rescue JSON::ParserError => e
169
- if %w(String Date DateTime).include?(return_type)
170
- data = body
171
- else
172
- raise e
173
- end
174
- end
175
-
176
- convert_to_type data, return_type
177
- end
178
-
179
- # Convert data to the given return type.
180
- # @param [Object] data Data to be converted
181
- # @param [String] return_type Return type
182
- # @return [Mixed] Data in a particular type
183
- def convert_to_type(data, return_type)
184
- return nil if data.nil?
185
- case return_type
186
- when 'String'
187
- data.to_s
188
- when 'Integer'
189
- data.to_i
190
- when 'Float'
191
- data.to_f
192
- when 'BOOLEAN'
193
- data == true
194
- when 'DateTime'
195
- # parse date time (expecting ISO 8601 format)
196
- DateTime.parse data
197
- when 'Date'
198
- # parse date time (expecting ISO 8601 format)
199
- Date.parse data
200
- when 'Object'
201
- # generic object (usually a Hash), return directly
202
- data
203
- when /\AArray<(.+)>\z/
204
- # e.g. Array<Pet>
205
- sub_type = $1
206
- data.map { |item| convert_to_type(item, sub_type) }
207
- when /\AHash\<String, (.+)\>\z/
208
- # e.g. Hash<String, Integer>
209
- sub_type = $1
210
- {}.tap do |hash|
211
- data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
212
- end
213
- else
214
- # models, e.g. Pet
215
- UltracartClient.const_get(return_type).new.tap do |model|
216
- model.build_from_hash data
217
- end
218
- end
219
- end
220
-
221
- # Save response body into a file in (the defined) temporary folder, using the filename
222
- # from the "Content-Disposition" header if provided, otherwise a random filename.
223
- # The response body is written to the file in chunks in order to handle files which
224
- # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
225
- # process can use.
226
- #
227
- # @see Configuration#temp_folder_path
228
- def download_file(request)
229
- tempfile = nil
230
- encoding = nil
231
- request.on_headers do |response|
232
- content_disposition = response.headers['Content-Disposition']
233
- if content_disposition && content_disposition =~ /filename=/i
234
- filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
235
- prefix = sanitize_filename(filename)
236
- else
237
- prefix = 'download-'
238
- end
239
- prefix = prefix + '-' unless prefix.end_with?('-')
240
- encoding = response.body.encoding
241
- tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
242
- @tempfile = tempfile
243
- end
244
- request.on_body do |chunk|
245
- chunk.force_encoding(encoding)
246
- tempfile.write(chunk)
247
- end
248
- request.on_complete do |response|
249
- tempfile.close
250
- @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
251
- "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
252
- "will be deleted automatically with GC. It's also recommended to delete the temp file "\
253
- "explicitly with `tempfile.delete`"
254
- end
255
- end
256
-
257
- # Sanitize filename by removing path.
258
- # e.g. ../../sun.gif becomes sun.gif
259
- #
260
- # @param [String] filename the filename to be sanitized
261
- # @return [String] the sanitized filename
262
- def sanitize_filename(filename)
263
- filename.gsub(/.*[\/\\]/, '')
264
- end
265
-
266
- def build_request_url(path)
267
- # Add leading and trailing slashes to path
268
- path = "/#{path}".gsub(/\/+/, '/')
269
- Addressable::URI.encode(@config.base_url + path)
270
- end
271
-
272
- # Builds the HTTP request body
273
- #
274
- # @param [Hash] header_params Header parameters
275
- # @param [Hash] form_params Query parameters
276
- # @param [Object] body HTTP body (JSON/XML)
277
- # @return [String] HTTP body data in the form of string
278
- def build_request_body(header_params, form_params, body)
279
- # http form
280
- if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
281
- header_params['Content-Type'] == 'multipart/form-data'
282
- data = {}
283
- form_params.each do |key, value|
284
- case value
285
- when ::File, ::Array, nil
286
- # let typhoeus handle File, Array and nil parameters
287
- data[key] = value
288
- else
289
- data[key] = value.to_s
290
- end
291
- end
292
- elsif body
293
- data = body.is_a?(String) ? body : body.to_json
294
- else
295
- data = nil
296
- end
297
- data
298
- end
299
-
300
- # Update hearder and query params based on authentication settings.
301
- #
302
- # @param [Hash] header_params Header parameters
303
- # @param [Hash] query_params Query parameters
304
- # @param [String] auth_names Authentication scheme name
305
- def update_params_for_auth!(header_params, query_params, auth_names)
306
- Array(auth_names).each do |auth_name|
307
- auth_setting = @config.auth_settings[auth_name]
308
- next unless auth_setting
309
- case auth_setting[:in]
310
- when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
311
- when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
312
- else fail ArgumentError, 'Authentication token must be in `query` of `header`'
313
- end
314
- end
315
- end
316
-
317
- # Sets user agent in HTTP header
318
- #
319
- # @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
320
- def user_agent=(user_agent)
321
- @user_agent = user_agent
322
- @default_headers['User-Agent'] = @user_agent
323
- end
324
-
325
-
326
- # Return api version header based on the configuration and default
327
- # @return [String] the api_version header (e.g. '2017-03-01')
328
- def select_header_api_version()
329
- return '2017-03-01' if @config.api_version.nil?
330
- @config.api_version
331
- end
332
-
333
-
334
- # Return Accept header based on an array of accepts provided.
335
- # @param [Array] accepts array for Accept
336
- # @return [String] the Accept header (e.g. application/json)
337
- def select_header_accept(accepts)
338
- return nil if accepts.nil? || accepts.empty?
339
- # use JSON when present, otherwise use all of the provided
340
- json_accept = accepts.find { |s| json_mime?(s) }
341
- json_accept || accepts.join(',')
342
- end
343
-
344
- # Return Content-Type header based on an array of content types provided.
345
- # @param [Array] content_types array for Content-Type
346
- # @return [String] the Content-Type header (e.g. application/json)
347
- def select_header_content_type(content_types)
348
- # use application/json by default
349
- return 'application/json' if content_types.nil? || content_types.empty?
350
- # use JSON when present, otherwise use the first one
351
- json_content_type = content_types.find { |s| json_mime?(s) }
352
- json_content_type || content_types.first
353
- end
354
-
355
- # Convert object (array, hash, object, etc) to JSON string.
356
- # @param [Object] model object to be converted into JSON string
357
- # @return [String] JSON string representation of the object
358
- def object_to_http_body(model)
359
- return model if model.nil? || model.is_a?(String)
360
- local_body = nil
361
- if model.is_a?(Array)
362
- local_body = model.map { |m| object_to_hash(m) }
363
- else
364
- local_body = object_to_hash(model)
365
- end
366
- local_body.to_json
367
- end
368
-
369
- # Convert object(non-array) to hash.
370
- # @param [Object] obj object to be converted into JSON string
371
- # @return [String] JSON string representation of the object
372
- def object_to_hash(obj)
373
- if obj.respond_to?(:to_hash)
374
- obj.to_hash
375
- else
376
- obj
377
- end
378
- end
379
-
380
- # Build parameter value according to the given collection format.
381
- # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
382
- def build_collection_param(param, collection_format)
383
- case collection_format
384
- when :csv
385
- param.join(',')
386
- when :ssv
387
- param.join(' ')
388
- when :tsv
389
- param.join("\t")
390
- when :pipes
391
- param.join('|')
392
- when :multi
393
- # return the array directly as typhoeus will handle it as expected
394
- param
395
- else
396
- fail "unknown collection format: #{collection_format.inspect}"
397
- end
398
- end
399
- end
400
- end
1
+ =begin
2
+ #UltraCart Rest API V2
3
+
4
+ #UltraCart REST API Version 2
5
+
6
+ The version of the OpenAPI document: 2.0.0
7
+ Contact: support@ultracart.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.1-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'json'
15
+ require 'logger'
16
+ require 'tempfile'
17
+ require 'time'
18
+ require 'typhoeus'
19
+
20
+ module UltracartClient
21
+ class ApiClient
22
+ # The Configuration object holding settings to be used in the API client.
23
+ attr_accessor :config
24
+
25
+ # Defines the headers to be used in HTTP requests of all API calls by default.
26
+ #
27
+ # @return [Hash]
28
+ attr_accessor :default_headers
29
+
30
+ # Initializes the ApiClient
31
+ # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
32
+ def initialize(config = Configuration.default)
33
+ @config = config
34
+ @user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
35
+ @default_headers = {
36
+ 'Content-Type' => 'application/json',
37
+ 'User-Agent' => @user_agent
38
+ }
39
+ end
40
+
41
+ def self.default
42
+ @@default ||= ApiClient.new
43
+ end
44
+
45
+ # Call an API with given options.
46
+ #
47
+ # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
48
+ # the data deserialized from response body (could be nil), response status code and response headers.
49
+ def call_api(http_method, path, opts = {})
50
+ request = build_request(http_method, path, opts)
51
+ response = request.run
52
+
53
+ if @config.debugging
54
+ @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
55
+ end
56
+
57
+ unless response.success?
58
+ if response.timed_out?
59
+ fail ApiError.new('Connection timed out')
60
+ elsif response.code == 0
61
+ # Errors from libcurl will be made visible here
62
+ fail ApiError.new(:code => 0,
63
+ :message => response.return_message)
64
+ else
65
+ fail ApiError.new(:code => response.code,
66
+ :response_headers => response.headers,
67
+ :response_body => response.body),
68
+ response.status_message
69
+ end
70
+ end
71
+
72
+ if opts[:return_type]
73
+ data = deserialize(response, opts[:return_type])
74
+ else
75
+ data = nil
76
+ end
77
+ return data, response.code, response.headers
78
+ end
79
+
80
+ # Builds the HTTP request
81
+ #
82
+ # @param [String] http_method HTTP method/verb (e.g. POST)
83
+ # @param [String] path URL path (e.g. /account/new)
84
+ # @option opts [Hash] :header_params Header parameters
85
+ # @option opts [Hash] :query_params Query parameters
86
+ # @option opts [Hash] :form_params Query parameters
87
+ # @option opts [Object] :body HTTP body (JSON/XML)
88
+ # @return [Typhoeus::Request] A Typhoeus Request
89
+ def build_request(http_method, path, opts = {})
90
+ url = build_request_url(path, opts)
91
+ http_method = http_method.to_sym.downcase
92
+
93
+ header_params = @default_headers.merge(opts[:header_params] || {})
94
+ query_params = opts[:query_params] || {}
95
+ form_params = opts[:form_params] || {}
96
+ follow_location = opts[:follow_location] || true
97
+
98
+ update_params_for_auth! header_params, query_params, opts[:auth_names]
99
+
100
+ # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
101
+ _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
102
+
103
+ req_opts = {
104
+ :method => http_method,
105
+ :headers => header_params,
106
+ :params => query_params,
107
+ :params_encoding => @config.params_encoding,
108
+ :timeout => @config.timeout,
109
+ :ssl_verifypeer => @config.verify_ssl,
110
+ :ssl_verifyhost => _verify_ssl_host,
111
+ :sslcert => @config.cert_file,
112
+ :sslkey => @config.key_file,
113
+ :verbose => @config.debugging,
114
+ :followlocation => follow_location
115
+ }
116
+
117
+ # set custom cert, if provided
118
+ req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
119
+
120
+ if [:post, :patch, :put, :delete].include?(http_method)
121
+ req_body = build_request_body(header_params, form_params, opts[:body])
122
+ req_opts.update :body => req_body
123
+ if @config.debugging
124
+ @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
125
+ end
126
+ end
127
+
128
+ request = Typhoeus::Request.new(url, req_opts)
129
+ download_file(request) if opts[:return_type] == 'File'
130
+ request
131
+ end
132
+
133
+ # Builds the HTTP request body
134
+ #
135
+ # @param [Hash] header_params Header parameters
136
+ # @param [Hash] form_params Query parameters
137
+ # @param [Object] body HTTP body (JSON/XML)
138
+ # @return [String] HTTP body data in the form of string
139
+ def build_request_body(header_params, form_params, body)
140
+ # http form
141
+ if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
142
+ header_params['Content-Type'] == 'multipart/form-data'
143
+ data = {}
144
+ form_params.each do |key, value|
145
+ case value
146
+ when ::File, ::Array, nil
147
+ # let typhoeus handle File, Array and nil parameters
148
+ data[key] = value
149
+ else
150
+ data[key] = value.to_s
151
+ end
152
+ end
153
+ elsif body
154
+ data = body.is_a?(String) ? body : body.to_json
155
+ else
156
+ data = nil
157
+ end
158
+ data
159
+ end
160
+
161
+ # Save response body into a file in (the defined) temporary folder, using the filename
162
+ # from the "Content-Disposition" header if provided, otherwise a random filename.
163
+ # The response body is written to the file in chunks in order to handle files which
164
+ # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
165
+ # process can use.
166
+ #
167
+ # @see Configuration#temp_folder_path
168
+ def download_file(request)
169
+ tempfile = nil
170
+ encoding = nil
171
+ request.on_headers do |response|
172
+ content_disposition = response.headers['Content-Disposition']
173
+ if content_disposition && content_disposition =~ /filename=/i
174
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
175
+ prefix = sanitize_filename(filename)
176
+ else
177
+ prefix = 'download-'
178
+ end
179
+ prefix = prefix + '-' unless prefix.end_with?('-')
180
+ encoding = response.body.encoding
181
+ tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
182
+ @tempfile = tempfile
183
+ end
184
+ request.on_body do |chunk|
185
+ chunk.force_encoding(encoding)
186
+ tempfile.write(chunk)
187
+ end
188
+ request.on_complete do |response|
189
+ if tempfile
190
+ tempfile.close
191
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
192
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
193
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
194
+ "explicitly with `tempfile.delete`"
195
+ end
196
+ end
197
+ end
198
+
199
+ # Check if the given MIME is a JSON MIME.
200
+ # JSON MIME examples:
201
+ # application/json
202
+ # application/json; charset=UTF8
203
+ # APPLICATION/JSON
204
+ # */*
205
+ # @param [String] mime MIME
206
+ # @return [Boolean] True if the MIME is application/json
207
+ def json_mime?(mime)
208
+ (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
209
+ end
210
+
211
+ # Deserialize the response to the given return type.
212
+ #
213
+ # @param [Response] response HTTP response
214
+ # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
215
+ def deserialize(response, return_type)
216
+ body = response.body
217
+
218
+ # handle file downloading - return the File instance processed in request callbacks
219
+ # note that response body is empty when the file is written in chunks in request on_body callback
220
+ return @tempfile if return_type == 'File'
221
+
222
+ return nil if body.nil? || body.empty?
223
+
224
+ # return response body directly for String return type
225
+ return body if return_type == 'String'
226
+
227
+ # ensuring a default content type
228
+ content_type = response.headers['Content-Type'] || 'application/json'
229
+
230
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
231
+
232
+ begin
233
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
234
+ rescue JSON::ParserError => e
235
+ if %w(String Date Time).include?(return_type)
236
+ data = body
237
+ else
238
+ raise e
239
+ end
240
+ end
241
+
242
+ convert_to_type data, return_type
243
+ end
244
+
245
+ # Convert data to the given return type.
246
+ # @param [Object] data Data to be converted
247
+ # @param [String] return_type Return type
248
+ # @return [Mixed] Data in a particular type
249
+ def convert_to_type(data, return_type)
250
+ return nil if data.nil?
251
+ case return_type
252
+ when 'String'
253
+ data.to_s
254
+ when 'Integer'
255
+ data.to_i
256
+ when 'Float'
257
+ data.to_f
258
+ when 'Boolean'
259
+ data == true
260
+ when 'Time'
261
+ # parse date time (expecting ISO 8601 format)
262
+ Time.parse data
263
+ when 'Date'
264
+ # parse date time (expecting ISO 8601 format)
265
+ Date.parse data
266
+ when 'Object'
267
+ # generic object (usually a Hash), return directly
268
+ data
269
+ when /\AArray<(.+)>\z/
270
+ # e.g. Array<Pet>
271
+ sub_type = $1
272
+ data.map { |item| convert_to_type(item, sub_type) }
273
+ when /\AHash\<String, (.+)\>\z/
274
+ # e.g. Hash<String, Integer>
275
+ sub_type = $1
276
+ {}.tap do |hash|
277
+ data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
278
+ end
279
+ else
280
+ # models (e.g. Pet) or oneOf
281
+ klass = UltracartClient.const_get(return_type)
282
+ klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
283
+ end
284
+ end
285
+
286
+ # Sanitize filename by removing path.
287
+ # e.g. ../../sun.gif becomes sun.gif
288
+ #
289
+ # @param [String] filename the filename to be sanitized
290
+ # @return [String] the sanitized filename
291
+ def sanitize_filename(filename)
292
+ filename.gsub(/.*[\/\\]/, '')
293
+ end
294
+
295
+ def build_request_url(path, opts = {})
296
+ # Add leading and trailing slashes to path
297
+ path = "/#{path}".gsub(/\/+/, '/')
298
+ @config.base_url(opts[:operation]) + path
299
+ end
300
+
301
+ # Update header and query params based on authentication settings.
302
+ #
303
+ # @param [Hash] header_params Header parameters
304
+ # @param [Hash] query_params Query parameters
305
+ # @param [String] auth_names Authentication scheme name
306
+ def update_params_for_auth!(header_params, query_params, auth_names)
307
+ Array(auth_names).each do |auth_name|
308
+ auth_setting = @config.auth_settings[auth_name]
309
+ next unless auth_setting
310
+ case auth_setting[:in]
311
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
312
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
313
+ else fail ArgumentError, 'Authentication token must be in `query` or `header`'
314
+ end
315
+ end
316
+ end
317
+
318
+ # Sets user agent in HTTP header
319
+ #
320
+ # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
321
+ def user_agent=(user_agent)
322
+ @user_agent = user_agent
323
+ @default_headers['User-Agent'] = @user_agent
324
+ end
325
+
326
+ # Return api version header based on the configuration and default
327
+ # @return [String] the api_version header (e.g. '2017-03-01')
328
+ def select_header_api_version()
329
+ return '2017-03-01' if @config.api_version.nil?
330
+ @config.api_version
331
+ end
332
+
333
+ # Return Accept header based on an array of accepts provided.
334
+ # @param [Array] accepts array for Accept
335
+ # @return [String] the Accept header (e.g. application/json)
336
+ def select_header_accept(accepts)
337
+ return nil if accepts.nil? || accepts.empty?
338
+ # use JSON when present, otherwise use all of the provided
339
+ json_accept = accepts.find { |s| json_mime?(s) }
340
+ json_accept || accepts.join(',')
341
+ end
342
+
343
+ # Return Content-Type header based on an array of content types provided.
344
+ # @param [Array] content_types array for Content-Type
345
+ # @return [String] the Content-Type header (e.g. application/json)
346
+ def select_header_content_type(content_types)
347
+ # return nil by default
348
+ return if content_types.nil? || content_types.empty?
349
+ # use JSON when present, otherwise use the first one
350
+ json_content_type = content_types.find { |s| json_mime?(s) }
351
+ json_content_type || content_types.first
352
+ end
353
+
354
+ # Convert object (array, hash, object, etc) to JSON string.
355
+ # @param [Object] model object to be converted into JSON string
356
+ # @return [String] JSON string representation of the object
357
+ def object_to_http_body(model)
358
+ return model if model.nil? || model.is_a?(String)
359
+ local_body = nil
360
+ if model.is_a?(Array)
361
+ local_body = model.map { |m| object_to_hash(m) }
362
+ else
363
+ local_body = object_to_hash(model)
364
+ end
365
+ local_body.to_json
366
+ end
367
+
368
+ # Convert object(non-array) to hash.
369
+ # @param [Object] obj object to be converted into JSON string
370
+ # @return [String] JSON string representation of the object
371
+ def object_to_hash(obj)
372
+ if obj.respond_to?(:to_hash)
373
+ obj.to_hash
374
+ else
375
+ obj
376
+ end
377
+ end
378
+
379
+ # Build parameter value according to the given collection format.
380
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
381
+ def build_collection_param(param, collection_format)
382
+ case collection_format
383
+ when :csv
384
+ param.join(',')
385
+ when :ssv
386
+ param.join(' ')
387
+ when :tsv
388
+ param.join("\t")
389
+ when :pipes
390
+ param.join('|')
391
+ when :multi
392
+ # return the array directly as typhoeus will handle it as expected
393
+ param
394
+ else
395
+ fail "unknown collection format: #{collection_format.inspect}"
396
+ end
397
+ end
398
+ end
399
+ end