ultracart_api 3.10.162 → 4.0.32.rc

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1619) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -7
  3. data/README.md +1166 -1505
  4. data/Rakefile +10 -8
  5. data/docs/AccountsReceivableRetryConfig.md +46 -23
  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 -15
  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 +173 -126
  17. data/docs/AffiliateClick.md +38 -20
  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 -31
  28. data/docs/AutoOrderApi.md +693 -559
  29. data/docs/AutoOrderItem.md +64 -33
  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 -24
  49. data/docs/CartBuysafe.md +28 -13
  50. data/docs/CartCheckout.md +44 -24
  51. data/docs/CartCoupon.md +18 -8
  52. data/docs/CartCurrencyConversion.md +20 -9
  53. data/docs/CartCustomerProfile.md +60 -30
  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 -37
  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 -10
  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 +382 -578
  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 +420 -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 +1566 -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 -74
  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 +1500 -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 -13
  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 -70
  193. data/docs/CustomerActivity.md +24 -15
  194. data/docs/CustomerAffiliate.md +24 -11
  195. data/docs/CustomerApi.md +1380 -1077
  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 -19
  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/CustomerOrdersSummary.md +24 -11
  206. data/docs/CustomerPricingTier.md +20 -9
  207. data/docs/CustomerPrivacy.md +24 -11
  208. data/docs/CustomerQuery.md +74 -36
  209. data/docs/CustomerQuotesSummary.md +24 -11
  210. data/docs/CustomerResponse.md +26 -12
  211. data/docs/CustomerReviewer.md +36 -17
  212. data/docs/CustomerShipping.md +50 -24
  213. data/docs/CustomerSoftwareEntitlement.md +32 -15
  214. data/docs/CustomerStoreCredit.md +28 -13
  215. data/docs/CustomerStoreCreditAddRequest.md +24 -11
  216. data/docs/CustomerStoreCreditLedgerEntry.md +30 -14
  217. data/docs/CustomerStoreCreditResponse.md +26 -12
  218. data/docs/CustomerTag.md +18 -8
  219. data/docs/CustomerTaxCodes.md +26 -12
  220. data/docs/CustomersResponse.md +26 -12
  221. data/docs/DataTablesServerSideResponse.md +24 -11
  222. data/docs/Distance.md +20 -9
  223. data/docs/DistributionCenter.md +86 -57
  224. data/docs/DistributionCentersResponse.md +26 -12
  225. data/docs/EmailBaseTemplateListResponse.md +18 -8
  226. data/docs/EmailCampaign.md +64 -33
  227. data/docs/EmailCampaignFolder.md +26 -12
  228. data/docs/EmailCampaignFolderResponse.md +26 -12
  229. data/docs/EmailCampaignFoldersResponse.md +26 -12
  230. data/docs/EmailCampaignResponse.md +26 -12
  231. data/docs/EmailCampaignsResponse.md +26 -12
  232. data/docs/EmailClick.md +20 -9
  233. data/docs/EmailClicksResponse.md +26 -12
  234. data/docs/EmailCommseq.md +24 -11
  235. data/docs/EmailCommseqEmail.md +68 -33
  236. data/docs/EmailCommseqEmailResponse.md +26 -12
  237. data/docs/EmailCommseqEmailSendTestRequest.md +36 -17
  238. data/docs/EmailCommseqEmailSendTestResponse.md +24 -11
  239. data/docs/EmailCommseqEmailsRequest.md +26 -12
  240. data/docs/EmailCommseqEmailsResponse.md +26 -12
  241. data/docs/EmailCommseqPostcard.md +42 -20
  242. data/docs/EmailCommseqPostcardResponse.md +26 -12
  243. data/docs/EmailCommseqPostcardSendTestRequest.md +42 -20
  244. data/docs/EmailCommseqPostcardSendTestResponse.md +30 -14
  245. data/docs/EmailCommseqPostcardsRequest.md +18 -8
  246. data/docs/EmailCommseqPostcardsResponse.md +26 -12
  247. data/docs/EmailCommseqResponse.md +26 -12
  248. data/docs/EmailCommseqStat.md +90 -44
  249. data/docs/EmailCommseqStatResponse.md +26 -12
  250. data/docs/EmailCommseqStep.md +36 -17
  251. data/docs/EmailCommseqStepLog.md +22 -10
  252. data/docs/EmailCommseqStepLogsResponse.md +26 -12
  253. data/docs/EmailCommseqWebhookSendTestRequest.md +30 -14
  254. data/docs/EmailCommseqWebhookSendTestResponse.md +30 -14
  255. data/docs/EmailCommseqsResponse.md +26 -12
  256. data/docs/EmailCustomer.md +32 -15
  257. data/docs/EmailCustomerEditorUrlResponse.md +26 -12
  258. data/docs/EmailCustomersResponse.md +26 -12
  259. data/docs/EmailDashboardActivity.md +30 -14
  260. data/docs/EmailDashboardActivityResponse.md +26 -12
  261. data/docs/EmailDashboardStatsResponse.md +26 -12
  262. data/docs/EmailDomain.md +42 -20
  263. data/docs/EmailEditorTokenResponse.md +26 -12
  264. data/docs/EmailFlow.md +72 -38
  265. data/docs/EmailFlowBackPopulateRequest.md +20 -9
  266. data/docs/EmailFlowBackPopulateResponse.md +24 -11
  267. data/docs/EmailFlowFolder.md +26 -12
  268. data/docs/EmailFlowFolderResponse.md +26 -12
  269. data/docs/EmailFlowFoldersResponse.md +26 -12
  270. data/docs/EmailFlowResponse.md +26 -12
  271. data/docs/EmailFlowsResponse.md +26 -12
  272. data/docs/EmailGlobalSettings.md +18 -8
  273. data/docs/EmailGlobalSettingsResponse.md +26 -12
  274. data/docs/EmailGlobalUnsubscribeRequest.md +18 -8
  275. data/docs/EmailGlobalUnsubscribeResponse.md +18 -8
  276. data/docs/EmailHistogramPropertyNamesResponse.md +18 -8
  277. data/docs/EmailHistogramPropertyValuesResponse.md +18 -8
  278. data/docs/EmailList.md +40 -19
  279. data/docs/EmailListArchiveResponse.md +26 -12
  280. data/docs/EmailListCustomer.md +24 -11
  281. data/docs/EmailListCustomersResponse.md +26 -12
  282. data/docs/EmailListResponse.md +26 -12
  283. data/docs/EmailListSegmentFolder.md +26 -12
  284. data/docs/EmailListSegmentFolderResponse.md +26 -12
  285. data/docs/EmailListSegmentFoldersResponse.md +26 -12
  286. data/docs/EmailListSegmentMembership.md +24 -11
  287. data/docs/EmailListSegmentUsedBy.md +22 -10
  288. data/docs/EmailListSubscribeResponse.md +20 -9
  289. data/docs/EmailListsResponse.md +26 -12
  290. data/docs/EmailOrder.md +24 -11
  291. data/docs/EmailOrdersResponse.md +26 -12
  292. data/docs/EmailPerformance.md +62 -30
  293. data/docs/EmailPerformanceCustomerHistogram.md +18 -8
  294. data/docs/EmailPerformanceCustomerHistogramPeriod.md +26 -12
  295. data/docs/EmailPerformanceDaily.md +30 -14
  296. data/docs/EmailPerformanceResponse.md +26 -12
  297. data/docs/EmailPlan.md +50 -24
  298. data/docs/EmailPlanAdditional.md +34 -16
  299. data/docs/EmailPlanResponse.md +26 -12
  300. data/docs/EmailPostcardStat.md +80 -39
  301. data/docs/EmailSegment.md +58 -29
  302. data/docs/EmailSegmentArchiveResponse.md +26 -12
  303. data/docs/EmailSegmentCustomer.md +24 -11
  304. data/docs/EmailSegmentCustomersResponse.md +26 -12
  305. data/docs/EmailSegmentDownloadPrepareResponse.md +32 -15
  306. data/docs/EmailSegmentResponse.md +26 -12
  307. data/docs/EmailSegmentsResponse.md +26 -12
  308. data/docs/EmailSendingDomainResponse.md +26 -12
  309. data/docs/EmailSendingDomainsResponse.md +26 -12
  310. data/docs/EmailSettings.md +40 -26
  311. data/docs/EmailSettingsResponse.md +26 -12
  312. data/docs/EmailStat.md +92 -45
  313. data/docs/EmailStatPostcardSummaryRequest.md +20 -9
  314. data/docs/EmailStatPostcardSummaryResponse.md +26 -12
  315. data/docs/EmailStatSummaryRequest.md +22 -10
  316. data/docs/EmailStatSummaryResponse.md +26 -12
  317. data/docs/EmailStepStat.md +56 -37
  318. data/docs/EmailStepStatRequest.md +20 -9
  319. data/docs/EmailStepStatResponse.md +26 -12
  320. data/docs/EmailStepWaitingRequest.md +18 -8
  321. data/docs/EmailStepWaitingResponse.md +18 -8
  322. data/docs/EmailTemplate.md +38 -18
  323. data/docs/EmailTemplatesResponse.md +26 -12
  324. data/docs/EmailThirdPartyList.md +20 -9
  325. data/docs/EmailThirdPartyListImportRequest.md +18 -8
  326. data/docs/EmailThirdPartyProvider.md +38 -18
  327. data/docs/EmailThirdPartyProvidersResponse.md +26 -12
  328. data/docs/EmailThirdPartyTag.md +20 -9
  329. data/docs/EmailVerifyTokenRequest.md +20 -9
  330. data/docs/EmailVerifyTokenResponse.md +26 -12
  331. data/docs/EmailVerifyTokenValidateRequest.md +18 -8
  332. data/docs/EmailVerifyTokenValidateResponse.md +24 -11
  333. data/docs/EmailWebhookEditorValuesResponse.md +30 -14
  334. data/docs/Error.md +26 -12
  335. data/docs/ErrorResponse.md +24 -11
  336. data/docs/Experiment.md +52 -31
  337. data/docs/ExperimentResponse.md +26 -12
  338. data/docs/ExperimentVariation.md +60 -30
  339. data/docs/ExperimentVariationStat.md +38 -20
  340. data/docs/ExperimentsResponse.md +26 -12
  341. data/docs/FulfillmentApi.md +459 -318
  342. data/docs/FulfillmentInventory.md +20 -9
  343. data/docs/FulfillmentShipment.md +26 -12
  344. data/docs/GeoPoint.md +20 -9
  345. data/docs/GeocodeRequest.md +26 -12
  346. data/docs/GeocodeResponse.md +28 -13
  347. data/docs/GiftCertificate.md +44 -21
  348. data/docs/GiftCertificateApi.md +622 -433
  349. data/docs/GiftCertificateCreateRequest.md +26 -12
  350. data/docs/GiftCertificateLedgerEntry.md +28 -13
  351. data/docs/GiftCertificateQuery.md +34 -16
  352. data/docs/GiftCertificateResponse.md +26 -12
  353. data/docs/GiftCertificatesResponse.md +26 -12
  354. data/docs/Group.md +26 -12
  355. data/docs/GroupResponse.md +26 -12
  356. data/docs/GroupUserMembership.md +26 -12
  357. data/docs/GroupsResponse.md +26 -12
  358. data/docs/HTTPHeader.md +20 -9
  359. data/docs/IntegrationLog.md +52 -26
  360. data/docs/IntegrationLogApi.md +400 -286
  361. data/docs/IntegrationLogFile.md +24 -11
  362. data/docs/IntegrationLogLog.md +20 -9
  363. data/docs/IntegrationLogQueryFilterValues.md +40 -19
  364. data/docs/IntegrationLogQueryRequest.md +42 -23
  365. data/docs/IntegrationLogQueryResponse.md +28 -13
  366. data/docs/IntegrationLogResponse.md +26 -12
  367. data/docs/IntegrationLogSummary.md +34 -16
  368. data/docs/IntegrationLogSummaryQueryRequest.md +20 -9
  369. data/docs/IntegrationLogSummaryQueryResponse.md +26 -12
  370. data/docs/Item.md +118 -58
  371. data/docs/ItemAccounting.md +20 -9
  372. data/docs/ItemAmember.md +20 -9
  373. data/docs/ItemApi.md +733 -1167
  374. data/docs/ItemAutoOrder.md +50 -29
  375. data/docs/ItemAutoOrderStep.md +46 -22
  376. data/docs/ItemAutoOrderStepArbitraryUnitCostSchedule.md +20 -9
  377. data/docs/ItemAutoOrderStepGrandfatherPricing.md +20 -9
  378. data/docs/ItemCCBill.md +28 -13
  379. data/docs/ItemChannelPartnerMapping.md +54 -26
  380. data/docs/ItemChargeback.md +20 -9
  381. data/docs/ItemChargebackAddendum.md +24 -11
  382. data/docs/ItemChargebackAdjustmentRequest.md +22 -10
  383. data/docs/ItemCheckout.md +24 -11
  384. data/docs/ItemContent.md +42 -20
  385. data/docs/ItemContentAssignment.md +28 -13
  386. data/docs/ItemContentAttribute.md +24 -11
  387. data/docs/ItemContentMultimedia.md +46 -22
  388. data/docs/ItemContentMultimediaThumbnail.md +28 -13
  389. data/docs/ItemDigitalDelivery.md +28 -13
  390. data/docs/ItemDigitalItem.md +26 -17
  391. data/docs/ItemEbay.md +154 -76
  392. data/docs/ItemEbayCategorySpecific.md +20 -9
  393. data/docs/ItemEbayMarketListing.md +26 -12
  394. data/docs/ItemEbayMarketPlaceAnalysis.md +36 -17
  395. data/docs/ItemEmailNotifications.md +20 -9
  396. data/docs/ItemEnrollment123.md +18 -8
  397. data/docs/ItemFulfillmentAddon.md +24 -12
  398. data/docs/ItemGiftCertificate.md +20 -9
  399. data/docs/ItemGoogleProductSearch.md +112 -55
  400. data/docs/ItemIdentifiers.md +24 -15
  401. data/docs/ItemInstantPaymentNotification.md +22 -10
  402. data/docs/ItemInstantPaymentNotifications.md +18 -8
  403. data/docs/ItemInternal.md +18 -8
  404. data/docs/ItemKitComponent.md +26 -12
  405. data/docs/ItemKitDefinition.md +18 -8
  406. data/docs/ItemOption.md +44 -21
  407. data/docs/ItemOptionValue.md +46 -22
  408. data/docs/ItemOptionValueAdditionalItem.md +20 -9
  409. data/docs/ItemOptionValueDigitalItem.md +20 -9
  410. data/docs/ItemPaymentProcessing.md +26 -12
  411. data/docs/ItemPhysical.md +24 -11
  412. data/docs/ItemPricing.md +52 -25
  413. data/docs/ItemPricingTier.md +26 -12
  414. data/docs/ItemPricingTierDiscount.md +20 -9
  415. data/docs/ItemPricingTierLimit.md +22 -12
  416. data/docs/ItemProperty.md +22 -10
  417. data/docs/ItemRealtimePricing.md +22 -10
  418. data/docs/ItemRelated.md +22 -10
  419. data/docs/ItemRelatedItem.md +22 -10
  420. data/docs/ItemReporting.md +20 -9
  421. data/docs/ItemResponse.md +26 -12
  422. data/docs/ItemRestriction.md +32 -15
  423. data/docs/ItemRestrictionItem.md +22 -10
  424. data/docs/ItemRevguard.md +30 -14
  425. data/docs/ItemReviews.md +34 -17
  426. data/docs/ItemSalesforce.md +20 -9
  427. data/docs/ItemShipping.md +112 -55
  428. data/docs/ItemShippingCase.md +24 -11
  429. data/docs/ItemShippingDestinationMarkup.md +28 -13
  430. data/docs/ItemShippingDestinationRestriction.md +22 -10
  431. data/docs/ItemShippingDistributionCenter.md +44 -21
  432. data/docs/ItemShippingMethod.md +46 -22
  433. data/docs/ItemShippingPackageRequirement.md +20 -9
  434. data/docs/ItemTag.md +20 -9
  435. data/docs/ItemTags.md +18 -8
  436. data/docs/ItemTax.md +24 -11
  437. data/docs/ItemTaxExemption.md +26 -12
  438. data/docs/ItemThirdPartyEmailMarketing.md +26 -12
  439. data/docs/ItemVariantItem.md +28 -13
  440. data/docs/ItemVariation.md +26 -12
  441. data/docs/ItemVariationOption.md +24 -11
  442. data/docs/ItemWishlistMember.md +22 -10
  443. data/docs/ItemsRequest.md +18 -8
  444. data/docs/ItemsResponse.md +26 -12
  445. data/docs/KeyValue.md +22 -10
  446. data/docs/LibraryFilterValues.md +24 -11
  447. data/docs/LibraryFilterValuesResponse.md +26 -12
  448. data/docs/LibraryItem.md +96 -47
  449. data/docs/LibraryItemAccount.md +22 -10
  450. data/docs/LibraryItemAsset.md +20 -9
  451. data/docs/LibraryItemAttribute.md +20 -9
  452. data/docs/LibraryItemEmail.md +22 -10
  453. data/docs/LibraryItemPublishedMeta.md +32 -15
  454. data/docs/LibraryItemPurchasedMeta.md +22 -10
  455. data/docs/LibraryItemQuery.md +40 -19
  456. data/docs/LibraryItemResponse.md +26 -12
  457. data/docs/LibraryItemScreenshot.md +20 -9
  458. data/docs/LibraryItemsResponse.md +26 -12
  459. data/docs/LinkedAccount.md +22 -10
  460. data/docs/ListSegmentMembership.md +22 -10
  461. data/docs/LookupRequest.md +26 -13
  462. data/docs/LookupResponse.md +26 -12
  463. data/docs/Mailgun.md +18 -8
  464. data/docs/Metric.md +32 -15
  465. data/docs/Notification.md +38 -18
  466. data/docs/OauthApi.md +179 -124
  467. data/docs/OauthRevokeSuccessResponse.md +20 -9
  468. data/docs/OauthTokenResponse.md +32 -15
  469. data/docs/Order.md +84 -45
  470. data/docs/OrderAffiliate.md +22 -10
  471. data/docs/OrderAffiliateLedger.md +34 -16
  472. data/docs/OrderApi.md +1856 -1520
  473. data/docs/OrderAutoOrder.md +56 -27
  474. data/docs/OrderBilling.md +48 -25
  475. data/docs/OrderBuysafe.md +28 -13
  476. data/docs/OrderByTokenQuery.md +18 -8
  477. data/docs/OrderChannelPartner.md +38 -18
  478. data/docs/OrderCheckout.md +44 -24
  479. data/docs/OrderCoupon.md +26 -12
  480. data/docs/OrderDigitalItem.md +32 -15
  481. data/docs/OrderDigitalOrder.md +26 -12
  482. data/docs/OrderEdi.md +24 -11
  483. data/docs/OrderFormat.md +48 -23
  484. data/docs/OrderFormatResponse.md +20 -9
  485. data/docs/OrderFraudScore.md +56 -27
  486. data/docs/OrderGift.md +36 -17
  487. data/docs/OrderGiftCertificate.md +22 -10
  488. data/docs/OrderInternal.md +26 -13
  489. data/docs/OrderItem.md +128 -72
  490. data/docs/OrderItemEdi.md +20 -9
  491. data/docs/OrderItemEdiIdentification.md +20 -9
  492. data/docs/OrderItemEdiLot.md +22 -10
  493. data/docs/OrderItemOption.md +38 -18
  494. data/docs/OrderItemOptionFileAttachment.md +24 -11
  495. data/docs/OrderItemProperty.md +24 -11
  496. data/docs/OrderItemTag.md +18 -8
  497. data/docs/OrderLinkedShipment.md +26 -12
  498. data/docs/OrderMarketing.md +22 -11
  499. data/docs/OrderPackingSlipResponse.md +26 -12
  500. data/docs/OrderPayment.md +52 -25
  501. data/docs/OrderPaymentCheck.md +18 -8
  502. data/docs/OrderPaymentCreditCard.md +38 -19
  503. data/docs/OrderPaymentECheck.md +36 -17
  504. data/docs/OrderPaymentInsurance.md +24 -11
  505. data/docs/OrderPaymentPurchaseOrder.md +18 -8
  506. data/docs/OrderPaymentTransaction.md +24 -12
  507. data/docs/OrderPaymentTransactionDetail.md +22 -10
  508. data/docs/OrderProcessPaymentRequest.md +20 -9
  509. data/docs/OrderProcessPaymentResponse.md +26 -12
  510. data/docs/OrderProperty.md +24 -11
  511. data/docs/OrderQuery.md +94 -46
  512. data/docs/OrderQueryBatch.md +18 -8
  513. data/docs/OrderQuote.md +22 -10
  514. data/docs/OrderReplacement.md +46 -22
  515. data/docs/OrderReplacementItem.md +22 -10
  516. data/docs/OrderReplacementResponse.md +28 -13
  517. data/docs/OrderResponse.md +26 -12
  518. data/docs/OrderSalesforce.md +18 -8
  519. data/docs/OrderShipping.md +76 -38
  520. data/docs/OrderSummary.md +56 -27
  521. data/docs/OrderTag.md +18 -8
  522. data/docs/OrderTaxes.md +50 -24
  523. data/docs/OrderTokenResponse.md +26 -12
  524. data/docs/OrderTrackingNumberDetail.md +40 -19
  525. data/docs/OrderTrackingNumberDetails.md +52 -25
  526. data/docs/OrdersResponse.md +26 -12
  527. data/docs/Permission.md +22 -10
  528. data/docs/PricingTier.md +78 -40
  529. data/docs/PricingTierNotification.md +22 -10
  530. data/docs/PricingTiersResponse.md +26 -12
  531. data/docs/Property.md +20 -9
  532. data/docs/PublishLibraryItemRequest.md +18 -8
  533. data/docs/RegisterAffiliateClickRequest.md +28 -13
  534. data/docs/RegisterAffiliateClickResponse.md +24 -11
  535. data/docs/ResponseMetadata.md +20 -9
  536. data/docs/ResultSet.md +28 -13
  537. data/docs/ScreenRecording.md +116 -57
  538. data/docs/ScreenRecordingAdPlatform.md +30 -14
  539. data/docs/ScreenRecordingFilter.md +136 -67
  540. data/docs/ScreenRecordingFilterGeoDistance.md +26 -12
  541. data/docs/ScreenRecordingFilterIpSearch.md +24 -11
  542. data/docs/ScreenRecordingFilterPageView.md +50 -24
  543. data/docs/ScreenRecordingFilterPageViewEvent.md +20 -9
  544. data/docs/ScreenRecordingFilterPageViewEventParam.md +26 -12
  545. data/docs/ScreenRecordingFilterPageViewParam.md +20 -9
  546. data/docs/ScreenRecordingFilterPageViewReferrerParam.md +20 -9
  547. data/docs/ScreenRecordingFilterRangeBigDecimal.md +26 -12
  548. data/docs/ScreenRecordingFilterRangeDate.md +20 -9
  549. data/docs/ScreenRecordingFilterRangeInteger.md +26 -12
  550. data/docs/ScreenRecordingFilterStringSearch.md +26 -12
  551. data/docs/ScreenRecordingFilterValues.md +58 -28
  552. data/docs/ScreenRecordingFilterValuesEvent.md +20 -9
  553. data/docs/ScreenRecordingFilterValuesEventParams.md +26 -12
  554. data/docs/ScreenRecordingFilterValuesPageParam.md +20 -9
  555. data/docs/ScreenRecordingFilterValuesPageView.md +28 -13
  556. data/docs/ScreenRecordingHeatmap.md +64 -31
  557. data/docs/ScreenRecordingHeatmapIndexRequest.md +18 -8
  558. data/docs/ScreenRecordingHeatmapIndexResponse.md +26 -12
  559. data/docs/ScreenRecordingHeatmapRequest.md +22 -10
  560. data/docs/ScreenRecordingHeatmapReset.md +18 -8
  561. data/docs/ScreenRecordingHeatmapResponse.md +26 -12
  562. data/docs/ScreenRecordingHeatmapUrl.md +28 -13
  563. data/docs/ScreenRecordingMerchantNotesRequest.md +18 -8
  564. data/docs/ScreenRecordingMultifield.md +26 -12
  565. data/docs/ScreenRecordingPageView.md +54 -26
  566. data/docs/ScreenRecordingPageViewDataResponse.md +26 -12
  567. data/docs/ScreenRecordingPageViewEvent.md +28 -13
  568. data/docs/ScreenRecordingPageViewEventParameter.md +20 -9
  569. data/docs/ScreenRecordingPageViewParameter.md +20 -9
  570. data/docs/ScreenRecordingQueryRequest.md +18 -8
  571. data/docs/ScreenRecordingQueryResponse.md +38 -18
  572. data/docs/ScreenRecordingResponse.md +28 -13
  573. data/docs/ScreenRecordingSegment.md +36 -17
  574. data/docs/ScreenRecordingSegmentResponse.md +26 -12
  575. data/docs/ScreenRecordingSegmentsResponse.md +26 -12
  576. data/docs/ScreenRecordingSettings.md +32 -15
  577. data/docs/ScreenRecordingSettingsResponse.md +26 -12
  578. data/docs/ScreenRecordingStoreFront.md +20 -9
  579. data/docs/ScreenRecordingTagsRequest.md +18 -8
  580. data/docs/ScreenRecordingTagsResponse.md +26 -12
  581. data/docs/ScreenRecordingUserAgent.md +26 -12
  582. data/docs/ScreenRecordingUserAgentDevice.md +18 -8
  583. data/docs/ScreenRecordingUserAgentOS.md +22 -10
  584. data/docs/ScreenRecordingUserProperty.md +20 -9
  585. data/docs/ScreenshotsResponse.md +26 -12
  586. data/docs/SelfConfig.md +18 -8
  587. data/docs/SimpleValue.md +20 -9
  588. data/docs/SingleSignOnAuthorizeRequest.md +20 -9
  589. data/docs/SingleSignOnAuthorizeResponse.md +20 -9
  590. data/docs/SingleSignOnTokenRequest.md +20 -9
  591. data/docs/SingleSignOnTokenResponse.md +22 -10
  592. data/docs/SovosConfig.md +30 -14
  593. data/docs/SsoApi.md +300 -201
  594. data/docs/StateProvince.md +20 -9
  595. data/docs/StepWaiting.md +20 -9
  596. data/docs/StorefrontApi.md +13005 -9053
  597. data/docs/TaxApi.md +2101 -1421
  598. data/docs/TaxCity.md +34 -16
  599. data/docs/TaxCountry.md +34 -16
  600. data/docs/TaxCountryCode.md +26 -12
  601. data/docs/TaxCounty.md +36 -17
  602. data/docs/TaxJarConfig.md +30 -14
  603. data/docs/TaxPostalCode.md +30 -14
  604. data/docs/TaxProviderActivateResult.md +20 -9
  605. data/docs/TaxProviderAvalara.md +24 -11
  606. data/docs/TaxProviderAvalaraCompaniesResult.md +18 -8
  607. data/docs/TaxProviderAvalaraCompany.md +26 -12
  608. data/docs/TaxProviderSelf.md +26 -12
  609. data/docs/TaxProviderSelfCountriesResponse.md +18 -8
  610. data/docs/TaxProviderSelfRegionsResponse.md +18 -8
  611. data/docs/TaxProviderSovos.md +24 -11
  612. data/docs/TaxProviderTaxJar.md +24 -11
  613. data/docs/TaxProviderTestResult.md +20 -9
  614. data/docs/TaxProviderUltraCart.md +26 -12
  615. data/docs/TaxProviderUltraCartState.md +36 -17
  616. data/docs/TaxProvidersResponse.md +34 -16
  617. data/docs/TaxState.md +52 -25
  618. data/docs/TaxStateCode.md +26 -12
  619. data/docs/TempMultimedia.md +30 -14
  620. data/docs/TempMultimediaResponse.md +26 -12
  621. data/docs/ThumbnailParametersRequest.md +26 -12
  622. data/docs/ThumbnailParametersResponse.md +26 -12
  623. data/docs/TransactionEmail.md +56 -27
  624. data/docs/TransactionEmailListResponse.md +26 -12
  625. data/docs/TransactionEmailOption.md +32 -15
  626. data/docs/TransactionEmailResponse.md +26 -12
  627. data/docs/Twilio.md +24 -11
  628. data/docs/TwilioResponse.md +28 -13
  629. data/docs/TwiliosResponse.md +26 -12
  630. data/docs/UltraCartConfig.md +18 -8
  631. data/docs/UploadCouponCodesRequest.md +26 -12
  632. data/docs/UploadCouponCodesResponse.md +30 -14
  633. data/docs/User.md +44 -21
  634. data/docs/UserApi.md +823 -558
  635. data/docs/UserGroupMembership.md +22 -10
  636. data/docs/UserLogin.md +24 -11
  637. data/docs/UserLoginsResponse.md +26 -12
  638. data/docs/UserResponse.md +26 -12
  639. data/docs/UsersResponse.md +26 -12
  640. data/docs/VerificationRecord.md +22 -10
  641. data/docs/Warning.md +20 -9
  642. data/docs/Webhook.md +52 -26
  643. data/docs/WebhookApi.md +636 -447
  644. data/docs/WebhookEventCategory.md +26 -12
  645. data/docs/WebhookEventSubscription.md +34 -16
  646. data/docs/WebhookLog.md +38 -18
  647. data/docs/WebhookLogResponse.md +26 -12
  648. data/docs/WebhookLogSummariesResponse.md +26 -12
  649. data/docs/WebhookLogSummary.md +22 -10
  650. data/docs/WebhookResponse.md +26 -12
  651. data/docs/WebhookSampleRequest.md +24 -11
  652. data/docs/WebhookSampleRequestResponse.md +26 -12
  653. data/docs/WebhooksResponse.md +26 -12
  654. data/docs/Weight.md +20 -9
  655. data/git_push.sh +57 -55
  656. data/lib/ultracart_api/api/affiliate_api.rb +191 -164
  657. data/lib/ultracart_api/api/auto_order_api.rb +672 -642
  658. data/lib/ultracart_api/api/channel_partner_api.rb +370 -664
  659. data/lib/ultracart_api/api/chargeback_api.rb +410 -356
  660. data/lib/ultracart_api/api/checkout_api.rb +1341 -1111
  661. data/lib/ultracart_api/api/coupon_api.rb +1390 -1161
  662. data/lib/ultracart_api/api/customer_api.rb +1292 -1218
  663. data/lib/ultracart_api/api/fulfillment_api.rb +452 -381
  664. data/lib/ultracart_api/api/gift_certificate_api.rb +594 -502
  665. data/lib/ultracart_api/api/integration_log_api.rb +404 -350
  666. data/lib/ultracart_api/api/item_api.rb +686 -1303
  667. data/lib/ultracart_api/api/oauth_api.rb +198 -171
  668. data/lib/ultracart_api/api/order_api.rb +1728 -1700
  669. data/lib/ultracart_api/api/sso_api.rb +289 -243
  670. data/lib/ultracart_api/api/storefront_api.rb +11407 -10209
  671. data/lib/ultracart_api/api/tax_api.rb +1916 -1580
  672. data/lib/ultracart_api/api/user_api.rb +755 -634
  673. data/lib/ultracart_api/api/webhook_api.rb +601 -514
  674. data/lib/ultracart_api/api_client.rb +399 -400
  675. data/lib/ultracart_api/api_error.rb +57 -38
  676. data/lib/ultracart_api/configuration.rb +302 -229
  677. data/lib/ultracart_api/models/accounts_receivable_retry_config.rb +364 -341
  678. data/lib/ultracart_api/models/accounts_receivable_retry_config_response.rb +287 -252
  679. data/lib/ultracart_api/models/accounts_receivable_retry_day_activity.rb +240 -205
  680. data/lib/ultracart_api/models/accounts_receivable_retry_stat_account.rb +250 -215
  681. data/lib/ultracart_api/models/accounts_receivable_retry_stat_metrics.rb +309 -274
  682. data/lib/ultracart_api/models/accounts_receivable_retry_stat_revenue.rb +228 -193
  683. data/lib/ultracart_api/models/accounts_receivable_retry_stats_response.rb +267 -232
  684. data/lib/ultracart_api/models/activity.rb +264 -247
  685. data/lib/ultracart_api/models/add_library_item_request.rb +324 -289
  686. data/lib/ultracart_api/models/adjust_internal_certificate_request.rb +270 -235
  687. data/lib/ultracart_api/models/adjust_internal_certificate_response.rb +267 -232
  688. data/lib/ultracart_api/models/affiliate_click.rb +319 -304
  689. data/lib/ultracart_api/models/affiliate_click_query.rb +270 -235
  690. data/lib/ultracart_api/models/affiliate_clicks_response.rb +259 -224
  691. data/lib/ultracart_api/models/affiliate_ledger.rb +431 -396
  692. data/lib/ultracart_api/models/affiliate_ledger_query.rb +270 -235
  693. data/lib/ultracart_api/models/affiliate_ledgers_response.rb +259 -224
  694. data/lib/ultracart_api/models/affiliate_link.rb +408 -373
  695. data/lib/ultracart_api/models/api_user_application_profile.rb +260 -225
  696. data/lib/ultracart_api/models/apply_library_item_request.rb +250 -215
  697. data/lib/ultracart_api/models/apply_library_item_response.rb +319 -284
  698. data/lib/ultracart_api/models/auto_order.rb +469 -455
  699. data/lib/ultracart_api/models/auto_order_item.rb +487 -472
  700. data/lib/ultracart_api/models/auto_order_item_future_schedule.rb +250 -215
  701. data/lib/ultracart_api/models/auto_order_item_option.rb +260 -225
  702. data/lib/ultracart_api/models/auto_order_item_simple_schedule.rb +274 -239
  703. data/lib/ultracart_api/models/auto_order_log.rb +230 -195
  704. data/lib/ultracart_api/models/auto_order_query.rb +480 -445
  705. data/lib/ultracart_api/models/auto_order_query_batch.rb +222 -187
  706. data/lib/ultracart_api/models/auto_order_response.rb +256 -221
  707. data/lib/ultracart_api/models/auto_orders_request.rb +222 -187
  708. data/lib/ultracart_api/models/auto_orders_response.rb +258 -223
  709. data/lib/ultracart_api/models/avalara_config.rb +340 -305
  710. data/lib/ultracart_api/models/base_response.rb +247 -212
  711. data/lib/ultracart_api/models/browser.rb +237 -202
  712. data/lib/ultracart_api/models/browser_device.rb +219 -184
  713. data/lib/ultracart_api/models/browser_os.rb +255 -220
  714. data/lib/ultracart_api/models/browser_user_agent.rb +246 -211
  715. data/lib/ultracart_api/models/cart.rb +506 -471
  716. data/lib/ultracart_api/models/cart_affiliate.rb +245 -210
  717. data/lib/ultracart_api/models/cart_affirm_checkout_response.rb +232 -197
  718. data/lib/ultracart_api/models/cart_billing.rb +572 -587
  719. data/lib/ultracart_api/models/cart_buysafe.rb +269 -234
  720. data/lib/ultracart_api/models/cart_checkout.rb +500 -540
  721. data/lib/ultracart_api/models/cart_coupon.rb +220 -185
  722. data/lib/ultracart_api/models/cart_currency_conversion.rb +232 -197
  723. data/lib/ultracart_api/models/cart_customer_profile.rb +438 -413
  724. data/lib/ultracart_api/models/cart_customer_profile_address.rb +350 -315
  725. data/lib/ultracart_api/models/cart_customer_profile_credit_card.rb +304 -269
  726. data/lib/ultracart_api/models/cart_finalize_order_request.rb +228 -193
  727. data/lib/ultracart_api/models/cart_finalize_order_request_options.rb +355 -320
  728. data/lib/ultracart_api/models/cart_finalize_order_response.rb +260 -225
  729. data/lib/ultracart_api/models/cart_gift.rb +313 -278
  730. data/lib/ultracart_api/models/cart_gift_certificate.rb +238 -203
  731. data/lib/ultracart_api/models/cart_item.rb +504 -481
  732. data/lib/ultracart_api/models/cart_item_attribute.rb +240 -205
  733. data/lib/ultracart_api/models/cart_item_multimedia.rb +336 -301
  734. data/lib/ultracart_api/models/cart_item_multimedia_thumbnail.rb +260 -225
  735. data/lib/ultracart_api/models/cart_item_option.rb +378 -343
  736. data/lib/ultracart_api/models/cart_item_option_value.rb +258 -223
  737. data/lib/ultracart_api/models/cart_item_physical.rb +246 -211
  738. data/lib/ultracart_api/models/cart_item_variation_selection.rb +230 -195
  739. data/lib/ultracart_api/models/cart_kit_component_option.rb +398 -363
  740. data/lib/ultracart_api/models/cart_marketing.rb +230 -205
  741. data/lib/ultracart_api/models/cart_payment.rb +275 -240
  742. data/lib/ultracart_api/models/cart_payment_affirm.rb +220 -185
  743. data/lib/ultracart_api/models/cart_payment_amazon.rb +220 -185
  744. data/lib/ultracart_api/models/cart_payment_check.rb +220 -185
  745. data/lib/ultracart_api/models/cart_payment_credit_card.rb +300 -265
  746. data/lib/ultracart_api/models/cart_payment_purchase_order.rb +220 -185
  747. data/lib/ultracart_api/models/cart_profile_login_request.rb +239 -204
  748. data/lib/ultracart_api/models/cart_profile_login_response.rb +231 -196
  749. data/lib/ultracart_api/models/cart_profile_register_request.rb +229 -194
  750. data/lib/ultracart_api/models/cart_profile_register_response.rb +231 -196
  751. data/lib/ultracart_api/models/cart_property.rb +280 -245
  752. data/lib/ultracart_api/models/cart_response.rb +231 -196
  753. data/lib/ultracart_api/models/cart_settings.rb +264 -229
  754. data/lib/ultracart_api/models/cart_settings_billing.rb +222 -187
  755. data/lib/ultracart_api/models/cart_settings_gift.rb +251 -216
  756. data/lib/ultracart_api/models/cart_settings_gift_wrap.rb +239 -204
  757. data/lib/ultracart_api/models/cart_settings_payment.rb +337 -302
  758. data/lib/ultracart_api/models/cart_settings_payment_amazon.rb +240 -205
  759. data/lib/ultracart_api/models/cart_settings_payment_credit_card.rb +242 -207
  760. data/lib/ultracart_api/models/cart_settings_payment_pay_pal.rb +260 -225
  761. data/lib/ultracart_api/models/cart_settings_province.rb +228 -193
  762. data/lib/ultracart_api/models/cart_settings_shipping.rb +262 -227
  763. data/lib/ultracart_api/models/cart_settings_shipping_calendar.rb +264 -229
  764. data/lib/ultracart_api/models/cart_settings_shipping_estimate.rb +345 -310
  765. data/lib/ultracart_api/models/cart_settings_taxes.rb +221 -186
  766. data/lib/ultracart_api/models/cart_settings_terms.rb +230 -195
  767. data/lib/ultracart_api/models/cart_shipping.rb +625 -590
  768. data/lib/ultracart_api/models/cart_summary.rb +354 -319
  769. data/lib/ultracart_api/models/cart_taxes.rb +255 -220
  770. data/lib/ultracart_api/models/cart_upsell_after.rb +255 -220
  771. data/lib/ultracart_api/models/cart_validation_request.rb +231 -196
  772. data/lib/ultracart_api/models/cart_validation_response.rb +231 -196
  773. data/lib/ultracart_api/models/channel_partner_cancel_response.rb +259 -224
  774. data/lib/ultracart_api/models/channel_partner_estimate_shipping_response.rb +259 -224
  775. data/lib/ultracart_api/models/channel_partner_estimate_tax_response.rb +256 -221
  776. data/lib/ultracart_api/models/channel_partner_import_response.rb +281 -246
  777. data/lib/ultracart_api/models/channel_partner_order.rb +1604 -1569
  778. data/lib/ultracart_api/models/channel_partner_order_item.rb +331 -296
  779. data/lib/ultracart_api/models/channel_partner_order_item_option.rb +230 -195
  780. data/lib/ultracart_api/models/channel_partner_order_transaction.rb +232 -197
  781. data/lib/ultracart_api/models/channel_partner_order_transaction_detail.rb +230 -195
  782. data/lib/ultracart_api/models/channel_partner_shipping_estimate.rb +230 -195
  783. data/lib/ultracart_api/models/chargeback_dispute.rb +649 -614
  784. data/lib/ultracart_api/models/chargeback_dispute_response.rb +256 -221
  785. data/lib/ultracart_api/models/chargeback_disputes_response.rb +258 -223
  786. data/lib/ultracart_api/models/checkout_allowed_countries_response.rb +221 -186
  787. data/lib/ultracart_api/models/checkout_handoff_request.rb +323 -288
  788. data/lib/ultracart_api/models/checkout_handoff_response.rb +241 -206
  789. data/lib/ultracart_api/models/checkout_setup_browser_key_request.rb +222 -187
  790. data/lib/ultracart_api/models/checkout_setup_browser_key_response.rb +220 -185
  791. data/lib/ultracart_api/models/checkout_state_province_response.rb +221 -186
  792. data/lib/ultracart_api/models/city_state_zip.rb +255 -220
  793. data/lib/ultracart_api/models/countries_response.rb +221 -186
  794. data/lib/ultracart_api/models/country.rb +260 -225
  795. data/lib/ultracart_api/models/coupon.rb +864 -917
  796. data/lib/ultracart_api/models/coupon_amount_off_items.rb +267 -232
  797. data/lib/ultracart_api/models/coupon_amount_off_shipping.rb +257 -222
  798. data/lib/ultracart_api/models/coupon_amount_off_shipping_with_items_purchase.rb +269 -234
  799. data/lib/ultracart_api/models/coupon_amount_off_subtotal.rb +245 -210
  800. data/lib/ultracart_api/models/coupon_amount_off_subtotal_and_shipping.rb +245 -210
  801. data/lib/ultracart_api/models/coupon_amount_off_subtotal_free_shipping_with_purchase.rb +267 -232
  802. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_block_purchase.rb +265 -230
  803. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_items_purchase.rb +267 -232
  804. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_purchase.rb +255 -220
  805. data/lib/ultracart_api/models/coupon_amount_shipping_with_subtotal.rb +267 -232
  806. data/lib/ultracart_api/models/coupon_auto_apply_condition.rb +239 -204
  807. data/lib/ultracart_api/models/coupon_auto_apply_conditions.rb +269 -234
  808. data/lib/ultracart_api/models/coupon_automatically_apply_coupon_codes.rb +222 -187
  809. data/lib/ultracart_api/models/coupon_buy_one_get_one_limit.rb +232 -197
  810. data/lib/ultracart_api/models/coupon_codes_request.rb +277 -242
  811. data/lib/ultracart_api/models/coupon_codes_response.rb +269 -234
  812. data/lib/ultracart_api/models/coupon_deletes_request.rb +234 -199
  813. data/lib/ultracart_api/models/coupon_discount_item_with_item_purchase.rb +275 -240
  814. data/lib/ultracart_api/models/coupon_discount_items.rb +267 -232
  815. data/lib/ultracart_api/models/coupon_editor_values.rb +330 -295
  816. data/lib/ultracart_api/models/coupon_exists_response.rb +267 -232
  817. data/lib/ultracart_api/models/coupon_free_item_and_shipping_with_subtotal.rb +279 -244
  818. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase.rb +254 -219
  819. data/lib/ultracart_api/models/coupon_free_item_with_subtotal.rb +267 -232
  820. data/lib/ultracart_api/models/coupon_free_items_with_item_purchase.rb +260 -225
  821. data/lib/ultracart_api/models/coupon_free_items_with_mix_match_purchase.rb +260 -225
  822. data/lib/ultracart_api/models/coupon_free_shipping.rb +222 -187
  823. data/lib/ultracart_api/models/coupon_free_shipping_specific_items.rb +222 -187
  824. data/lib/ultracart_api/models/coupon_free_shipping_with_items_purchase.rb +234 -199
  825. data/lib/ultracart_api/models/coupon_free_shipping_with_subtotal.rb +257 -222
  826. data/lib/ultracart_api/models/coupon_item_search_result.rb +290 -255
  827. data/lib/ultracart_api/models/coupon_item_search_results_response.rb +259 -224
  828. data/lib/ultracart_api/models/coupon_multiple_amounts_off_items.rb +232 -197
  829. data/lib/ultracart_api/models/coupon_percent_off_item_with_items_quantity_purchase.rb +264 -229
  830. data/lib/ultracart_api/models/coupon_percent_off_items.rb +254 -219
  831. data/lib/ultracart_api/models/coupon_percent_off_items_and_free_shipping.rb +244 -209
  832. data/lib/ultracart_api/models/coupon_percent_off_items_with_items_purchase.rb +254 -219
  833. data/lib/ultracart_api/models/coupon_percent_off_msrp_items.rb +254 -239
  834. data/lib/ultracart_api/models/coupon_percent_off_retail_price_items.rb +254 -219
  835. data/lib/ultracart_api/models/coupon_percent_off_shipping.rb +232 -197
  836. data/lib/ultracart_api/models/coupon_percent_off_subtotal.rb +220 -185
  837. data/lib/ultracart_api/models/coupon_percent_off_subtotal_and_free_shipping.rb +232 -197
  838. data/lib/ultracart_api/models/coupon_percent_off_subtotal_limit.rb +255 -220
  839. data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_items_purchase.rb +232 -197
  840. data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_subtotal.rb +255 -220
  841. data/lib/ultracart_api/models/coupon_query.rb +310 -275
  842. data/lib/ultracart_api/models/coupon_response.rb +268 -233
  843. data/lib/ultracart_api/models/coupon_restriction.rb +246 -211
  844. data/lib/ultracart_api/models/coupon_tier_amount.rb +255 -220
  845. data/lib/ultracart_api/models/coupon_tier_item_discount.rb +232 -197
  846. data/lib/ultracart_api/models/coupon_tier_percent.rb +255 -220
  847. data/lib/ultracart_api/models/coupon_tier_quantity_amount.rb +255 -220
  848. data/lib/ultracart_api/models/coupon_tier_quantity_percent.rb +255 -220
  849. data/lib/ultracart_api/models/coupon_tiered_amount_off_items.rb +244 -209
  850. data/lib/ultracart_api/models/coupon_tiered_amount_off_subtotal.rb +234 -199
  851. data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb +244 -209
  852. data/lib/ultracart_api/models/coupon_tiered_percent_off_shipping.rb +259 -224
  853. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal.rb +234 -199
  854. data/lib/ultracart_api/models/coupon_type.rb +230 -195
  855. data/lib/ultracart_api/models/coupons_request.rb +222 -187
  856. data/lib/ultracart_api/models/coupons_response.rb +258 -223
  857. data/lib/ultracart_api/models/currency.rb +260 -225
  858. data/lib/ultracart_api/models/customer.rb +978 -984
  859. data/lib/ultracart_api/models/customer_activity.rb +254 -255
  860. data/lib/ultracart_api/models/customer_affiliate.rb +250 -215
  861. data/lib/ultracart_api/models/customer_attachment.rb +260 -225
  862. data/lib/ultracart_api/models/customer_billing.rb +575 -540
  863. data/lib/ultracart_api/models/customer_card.rb +290 -255
  864. data/lib/ultracart_api/models/customer_editor_values.rb +328 -317
  865. data/lib/ultracart_api/models/customer_email.rb +300 -265
  866. data/lib/ultracart_api/models/customer_email_list_changes.rb +234 -199
  867. data/lib/ultracart_api/models/customer_loyalty.rb +283 -248
  868. data/lib/ultracart_api/models/customer_loyalty_ledger.rb +360 -325
  869. data/lib/ultracart_api/models/customer_loyalty_redemption.rb +340 -305
  870. data/lib/ultracart_api/models/customer_orders_summary.rb +250 -215
  871. data/lib/ultracart_api/models/customer_pricing_tier.rb +245 -210
  872. data/lib/ultracart_api/models/customer_privacy.rb +250 -215
  873. data/lib/ultracart_api/models/customer_query.rb +789 -754
  874. data/lib/ultracart_api/models/customer_quotes_summary.rb +250 -215
  875. data/lib/ultracart_api/models/customer_response.rb +256 -221
  876. data/lib/ultracart_api/models/customer_reviewer.rb +310 -275
  877. data/lib/ultracart_api/models/customer_shipping.rb +575 -540
  878. data/lib/ultracart_api/models/customer_software_entitlement.rb +365 -330
  879. data/lib/ultracart_api/models/customer_store_credit.rb +274 -239
  880. data/lib/ultracart_api/models/customer_store_credit_add_request.rb +250 -215
  881. data/lib/ultracart_api/models/customer_store_credit_ledger_entry.rb +295 -260
  882. data/lib/ultracart_api/models/customer_store_credit_response.rb +256 -221
  883. data/lib/ultracart_api/models/customer_tag.rb +235 -200
  884. data/lib/ultracart_api/models/customer_tax_codes.rb +260 -225
  885. data/lib/ultracart_api/models/customers_response.rb +258 -223
  886. data/lib/ultracart_api/models/data_tables_server_side_response.rb +248 -213
  887. data/lib/ultracart_api/models/distance.rb +264 -229
  888. data/lib/ultracart_api/models/distribution_center.rb +559 -674
  889. data/lib/ultracart_api/models/distribution_centers_response.rb +258 -223
  890. data/lib/ultracart_api/models/email_base_template_list_response.rb +221 -186
  891. data/lib/ultracart_api/models/email_campaign.rb +467 -452
  892. data/lib/ultracart_api/models/email_campaign_folder.rb +275 -240
  893. data/lib/ultracart_api/models/email_campaign_folder_response.rb +256 -221
  894. data/lib/ultracart_api/models/email_campaign_folders_response.rb +258 -223
  895. data/lib/ultracart_api/models/email_campaign_response.rb +256 -221
  896. data/lib/ultracart_api/models/email_campaigns_response.rb +258 -223
  897. data/lib/ultracart_api/models/email_click.rb +230 -195
  898. data/lib/ultracart_api/models/email_clicks_response.rb +258 -223
  899. data/lib/ultracart_api/models/email_commseq.rb +252 -217
  900. data/lib/ultracart_api/models/email_commseq_email.rb +470 -435
  901. data/lib/ultracart_api/models/email_commseq_email_response.rb +256 -221
  902. data/lib/ultracart_api/models/email_commseq_email_send_test_request.rb +304 -269
  903. data/lib/ultracart_api/models/email_commseq_email_send_test_response.rb +247 -212
  904. data/lib/ultracart_api/models/email_commseq_emails_request.rb +258 -223
  905. data/lib/ultracart_api/models/email_commseq_emails_response.rb +258 -223
  906. data/lib/ultracart_api/models/email_commseq_postcard.rb +340 -305
  907. data/lib/ultracart_api/models/email_commseq_postcard_response.rb +256 -221
  908. data/lib/ultracart_api/models/email_commseq_postcard_send_test_request.rb +329 -294
  909. data/lib/ultracart_api/models/email_commseq_postcard_send_test_response.rb +274 -239
  910. data/lib/ultracart_api/models/email_commseq_postcards_request.rb +221 -186
  911. data/lib/ultracart_api/models/email_commseq_postcards_response.rb +258 -223
  912. data/lib/ultracart_api/models/email_commseq_response.rb +256 -221
  913. data/lib/ultracart_api/models/email_commseq_stat.rb +580 -545
  914. data/lib/ultracart_api/models/email_commseq_stat_response.rb +256 -221
  915. data/lib/ultracart_api/models/email_commseq_step.rb +348 -313
  916. data/lib/ultracart_api/models/email_commseq_step_log.rb +240 -205
  917. data/lib/ultracart_api/models/email_commseq_step_logs_response.rb +258 -223
  918. data/lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb +275 -240
  919. data/lib/ultracart_api/models/email_commseq_webhook_send_test_response.rb +277 -242
  920. data/lib/ultracart_api/models/email_commseqs_response.rb +258 -223
  921. data/lib/ultracart_api/models/email_customer.rb +292 -257
  922. data/lib/ultracart_api/models/email_customer_editor_url_response.rb +256 -221
  923. data/lib/ultracart_api/models/email_customers_response.rb +262 -227
  924. data/lib/ultracart_api/models/email_dashboard_activity.rb +280 -245
  925. data/lib/ultracart_api/models/email_dashboard_activity_response.rb +258 -223
  926. data/lib/ultracart_api/models/email_dashboard_stats_response.rb +258 -223
  927. data/lib/ultracart_api/models/email_domain.rb +329 -294
  928. data/lib/ultracart_api/models/email_editor_token_response.rb +256 -221
  929. data/lib/ultracart_api/models/email_flow.rb +505 -500
  930. data/lib/ultracart_api/models/email_flow_back_populate_request.rb +230 -195
  931. data/lib/ultracart_api/models/email_flow_back_populate_response.rb +247 -212
  932. data/lib/ultracart_api/models/email_flow_folder.rb +275 -240
  933. data/lib/ultracart_api/models/email_flow_folder_response.rb +256 -221
  934. data/lib/ultracart_api/models/email_flow_folders_response.rb +258 -223
  935. data/lib/ultracart_api/models/email_flow_response.rb +256 -221
  936. data/lib/ultracart_api/models/email_flows_response.rb +258 -223
  937. data/lib/ultracart_api/models/email_global_settings.rb +219 -184
  938. data/lib/ultracart_api/models/email_global_settings_response.rb +256 -221
  939. data/lib/ultracart_api/models/email_global_unsubscribe_request.rb +219 -184
  940. data/lib/ultracart_api/models/email_global_unsubscribe_response.rb +219 -184
  941. data/lib/ultracart_api/models/email_histogram_property_names_response.rb +221 -186
  942. data/lib/ultracart_api/models/email_histogram_property_values_response.rb +221 -186
  943. data/lib/ultracart_api/models/email_list.rb +347 -312
  944. data/lib/ultracart_api/models/email_list_archive_response.rb +256 -221
  945. data/lib/ultracart_api/models/email_list_customer.rb +250 -215
  946. data/lib/ultracart_api/models/email_list_customers_response.rb +262 -227
  947. data/lib/ultracart_api/models/email_list_response.rb +256 -221
  948. data/lib/ultracart_api/models/email_list_segment_folder.rb +275 -240
  949. data/lib/ultracart_api/models/email_list_segment_folder_response.rb +256 -221
  950. data/lib/ultracart_api/models/email_list_segment_folders_response.rb +258 -223
  951. data/lib/ultracart_api/models/email_list_segment_membership.rb +250 -215
  952. data/lib/ultracart_api/models/email_list_segment_used_by.rb +240 -205
  953. data/lib/ultracart_api/models/email_list_subscribe_response.rb +228 -193
  954. data/lib/ultracart_api/models/email_lists_response.rb +258 -223
  955. data/lib/ultracart_api/models/email_order.rb +249 -214
  956. data/lib/ultracart_api/models/email_orders_response.rb +258 -223
  957. data/lib/ultracart_api/models/email_performance.rb +475 -440
  958. data/lib/ultracart_api/models/email_performance_customer_histogram.rb +222 -187
  959. data/lib/ultracart_api/models/email_performance_customer_histogram_period.rb +260 -225
  960. data/lib/ultracart_api/models/email_performance_daily.rb +280 -245
  961. data/lib/ultracart_api/models/email_performance_response.rb +256 -221
  962. data/lib/ultracart_api/models/email_plan.rb +365 -330
  963. data/lib/ultracart_api/models/email_plan_additional.rb +291 -256
  964. data/lib/ultracart_api/models/email_plan_response.rb +256 -221
  965. data/lib/ultracart_api/models/email_postcard_stat.rb +531 -496
  966. data/lib/ultracart_api/models/email_segment.rb +445 -420
  967. data/lib/ultracart_api/models/email_segment_archive_response.rb +256 -221
  968. data/lib/ultracart_api/models/email_segment_customer.rb +250 -215
  969. data/lib/ultracart_api/models/email_segment_customers_response.rb +262 -227
  970. data/lib/ultracart_api/models/email_segment_download_prepare_response.rb +283 -248
  971. data/lib/ultracart_api/models/email_segment_response.rb +256 -221
  972. data/lib/ultracart_api/models/email_segments_response.rb +258 -223
  973. data/lib/ultracart_api/models/email_sending_domain_response.rb +256 -221
  974. data/lib/ultracart_api/models/email_sending_domains_response.rb +258 -223
  975. data/lib/ultracart_api/models/email_settings.rb +318 -351
  976. data/lib/ultracart_api/models/email_settings_response.rb +256 -221
  977. data/lib/ultracart_api/models/email_stat.rb +591 -556
  978. data/lib/ultracart_api/models/email_stat_postcard_summary_request.rb +230 -195
  979. data/lib/ultracart_api/models/email_stat_postcard_summary_response.rb +258 -223
  980. data/lib/ultracart_api/models/email_stat_summary_request.rb +241 -206
  981. data/lib/ultracart_api/models/email_stat_summary_response.rb +258 -223
  982. data/lib/ultracart_api/models/email_step_stat.rb +410 -475
  983. data/lib/ultracart_api/models/email_step_stat_request.rb +230 -195
  984. data/lib/ultracart_api/models/email_step_stat_response.rb +258 -223
  985. data/lib/ultracart_api/models/email_step_waiting_request.rb +221 -186
  986. data/lib/ultracart_api/models/email_step_waiting_response.rb +221 -186
  987. data/lib/ultracart_api/models/email_template.rb +365 -330
  988. data/lib/ultracart_api/models/email_templates_response.rb +258 -223
  989. data/lib/ultracart_api/models/email_third_party_list.rb +230 -195
  990. data/lib/ultracart_api/models/email_third_party_list_import_request.rb +222 -187
  991. data/lib/ultracart_api/models/email_third_party_provider.rb +324 -289
  992. data/lib/ultracart_api/models/email_third_party_providers_response.rb +258 -223
  993. data/lib/ultracart_api/models/email_third_party_tag.rb +230 -195
  994. data/lib/ultracart_api/models/email_verify_token_request.rb +230 -195
  995. data/lib/ultracart_api/models/email_verify_token_response.rb +257 -222
  996. data/lib/ultracart_api/models/email_verify_token_validate_request.rb +220 -185
  997. data/lib/ultracart_api/models/email_verify_token_validate_response.rb +247 -212
  998. data/lib/ultracart_api/models/email_webhook_editor_values_response.rb +278 -243
  999. data/lib/ultracart_api/models/error.rb +260 -225
  1000. data/lib/ultracart_api/models/error_response.rb +247 -212
  1001. data/lib/ultracart_api/models/experiment.rb +426 -463
  1002. data/lib/ultracart_api/models/experiment_response.rb +256 -221
  1003. data/lib/ultracart_api/models/experiment_variation.rb +432 -407
  1004. data/lib/ultracart_api/models/experiment_variation_stat.rb +320 -307
  1005. data/lib/ultracart_api/models/experiments_response.rb +258 -223
  1006. data/lib/ultracart_api/models/fulfillment_inventory.rb +228 -193
  1007. data/lib/ultracart_api/models/fulfillment_shipment.rb +262 -227
  1008. data/lib/ultracart_api/models/geo_point.rb +228 -193
  1009. data/lib/ultracart_api/models/geocode_request.rb +260 -225
  1010. data/lib/ultracart_api/models/geocode_response.rb +265 -230
  1011. data/lib/ultracart_api/models/gift_certificate.rb +367 -332
  1012. data/lib/ultracart_api/models/gift_certificate_create_request.rb +260 -225
  1013. data/lib/ultracart_api/models/gift_certificate_ledger_entry.rb +285 -250
  1014. data/lib/ultracart_api/models/gift_certificate_query.rb +300 -265
  1015. data/lib/ultracart_api/models/gift_certificate_response.rb +256 -221
  1016. data/lib/ultracart_api/models/gift_certificates_response.rb +258 -223
  1017. data/lib/ultracart_api/models/group.rb +266 -231
  1018. data/lib/ultracart_api/models/group_response.rb +256 -221
  1019. data/lib/ultracart_api/models/group_user_membership.rb +260 -225
  1020. data/lib/ultracart_api/models/groups_response.rb +258 -223
  1021. data/lib/ultracart_api/models/http_header.rb +230 -195
  1022. data/lib/ultracart_api/models/integration_log.rb +379 -355
  1023. data/lib/ultracart_api/models/integration_log_file.rb +246 -211
  1024. data/lib/ultracart_api/models/integration_log_log.rb +228 -193
  1025. data/lib/ultracart_api/models/integration_log_query_filter_values.rb +340 -305
  1026. data/lib/ultracart_api/models/integration_log_query_request.rb +333 -329
  1027. data/lib/ultracart_api/models/integration_log_query_response.rb +267 -232
  1028. data/lib/ultracart_api/models/integration_log_response.rb +256 -221
  1029. data/lib/ultracart_api/models/integration_log_summary.rb +291 -256
  1030. data/lib/ultracart_api/models/integration_log_summary_query_request.rb +230 -195
  1031. data/lib/ultracart_api/models/integration_log_summary_query_response.rb +258 -223
  1032. data/lib/ultracart_api/models/item.rb +748 -713
  1033. data/lib/ultracart_api/models/item_accounting.rb +260 -225
  1034. data/lib/ultracart_api/models/item_amember.rb +245 -210
  1035. data/lib/ultracart_api/models/item_auto_order.rb +403 -418
  1036. data/lib/ultracart_api/models/item_auto_order_step.rb +413 -378
  1037. data/lib/ultracart_api/models/item_auto_order_step_arbitrary_unit_cost_schedule.rb +230 -195
  1038. data/lib/ultracart_api/models/item_auto_order_step_grandfather_pricing.rb +230 -195
  1039. data/lib/ultracart_api/models/item_cc_bill.rb +270 -235
  1040. data/lib/ultracart_api/models/item_channel_partner_mapping.rb +445 -410
  1041. data/lib/ultracart_api/models/item_chargeback.rb +234 -199
  1042. data/lib/ultracart_api/models/item_chargeback_addendum.rb +250 -215
  1043. data/lib/ultracart_api/models/item_chargeback_adjustment_request.rb +240 -205
  1044. data/lib/ultracart_api/models/item_checkout.rb +265 -230
  1045. data/lib/ultracart_api/models/item_content.rb +361 -326
  1046. data/lib/ultracart_api/models/item_content_assignment.rb +285 -250
  1047. data/lib/ultracart_api/models/item_content_attribute.rb +280 -245
  1048. data/lib/ultracart_api/models/item_content_multimedia.rb +441 -406
  1049. data/lib/ultracart_api/models/item_content_multimedia_thumbnail.rb +270 -235
  1050. data/lib/ultracart_api/models/item_digital_delivery.rb +317 -282
  1051. data/lib/ultracart_api/models/item_digital_item.rb +305 -334
  1052. data/lib/ultracart_api/models/item_ebay.rb +901 -866
  1053. data/lib/ultracart_api/models/item_ebay_category_specific.rb +230 -195
  1054. data/lib/ultracart_api/models/item_ebay_market_listing.rb +260 -225
  1055. data/lib/ultracart_api/models/item_ebay_market_place_analysis.rb +311 -276
  1056. data/lib/ultracart_api/models/item_email_notifications.rb +230 -195
  1057. data/lib/ultracart_api/models/item_enrollment123.rb +220 -185
  1058. data/lib/ultracart_api/models/item_fulfillment_addon.rb +250 -225
  1059. data/lib/ultracart_api/models/item_gift_certificate.rb +230 -195
  1060. data/lib/ultracart_api/models/item_google_product_search.rb +1289 -1254
  1061. data/lib/ultracart_api/models/item_identifiers.rb +310 -375
  1062. data/lib/ultracart_api/models/item_instant_payment_notification.rb +270 -235
  1063. data/lib/ultracart_api/models/item_instant_payment_notifications.rb +222 -187
  1064. data/lib/ultracart_api/models/item_internal.rb +235 -200
  1065. data/lib/ultracart_api/models/item_kit_component.rb +260 -225
  1066. data/lib/ultracart_api/models/item_kit_definition.rb +222 -187
  1067. data/lib/ultracart_api/models/item_option.rb +416 -381
  1068. data/lib/ultracart_api/models/item_option_value.rb +409 -374
  1069. data/lib/ultracart_api/models/item_option_value_additional_item.rb +230 -195
  1070. data/lib/ultracart_api/models/item_option_value_digital_item.rb +230 -195
  1071. data/lib/ultracart_api/models/item_payment_processing.rb +264 -229
  1072. data/lib/ultracart_api/models/item_physical.rb +246 -211
  1073. data/lib/ultracart_api/models/item_pricing.rb +422 -387
  1074. data/lib/ultracart_api/models/item_pricing_tier.rb +261 -226
  1075. data/lib/ultracart_api/models/item_pricing_tier_discount.rb +230 -195
  1076. data/lib/ultracart_api/models/item_pricing_tier_limit.rb +240 -227
  1077. data/lib/ultracart_api/models/item_property.rb +270 -235
  1078. data/lib/ultracart_api/models/item_realtime_pricing.rb +240 -205
  1079. data/lib/ultracart_api/models/item_related.rb +242 -207
  1080. data/lib/ultracart_api/models/item_related_item.rb +274 -239
  1081. data/lib/ultracart_api/models/item_reporting.rb +232 -197
  1082. data/lib/ultracart_api/models/item_response.rb +256 -221
  1083. data/lib/ultracart_api/models/item_restriction.rb +292 -257
  1084. data/lib/ultracart_api/models/item_restriction_item.rb +274 -239
  1085. data/lib/ultracart_api/models/item_revguard.rb +280 -245
  1086. data/lib/ultracart_api/models/item_reviews.rb +300 -276
  1087. data/lib/ultracart_api/models/item_salesforce.rb +230 -195
  1088. data/lib/ultracart_api/models/item_shipping.rb +713 -678
  1089. data/lib/ultracart_api/models/item_shipping_case.rb +265 -230
  1090. data/lib/ultracart_api/models/item_shipping_destination_markup.rb +315 -280
  1091. data/lib/ultracart_api/models/item_shipping_destination_restriction.rb +304 -269
  1092. data/lib/ultracart_api/models/item_shipping_distribution_center.rb +380 -345
  1093. data/lib/ultracart_api/models/item_shipping_method.rb +394 -359
  1094. data/lib/ultracart_api/models/item_shipping_package_requirement.rb +230 -195
  1095. data/lib/ultracart_api/models/item_tag.rb +279 -244
  1096. data/lib/ultracart_api/models/item_tags.rb +222 -187
  1097. data/lib/ultracart_api/models/item_tax.rb +286 -251
  1098. data/lib/ultracart_api/models/item_tax_exemption.rb +335 -300
  1099. data/lib/ultracart_api/models/item_third_party_email_marketing.rb +302 -267
  1100. data/lib/ultracart_api/models/item_variant_item.rb +289 -254
  1101. data/lib/ultracart_api/models/item_variation.rb +292 -257
  1102. data/lib/ultracart_api/models/item_variation_option.rb +265 -230
  1103. data/lib/ultracart_api/models/item_wishlist_member.rb +255 -220
  1104. data/lib/ultracart_api/models/items_request.rb +222 -187
  1105. data/lib/ultracart_api/models/items_response.rb +259 -224
  1106. data/lib/ultracart_api/models/key_value.rb +240 -205
  1107. data/lib/ultracart_api/models/library_filter_values.rb +254 -219
  1108. data/lib/ultracart_api/models/library_filter_values_response.rb +256 -221
  1109. data/lib/ultracart_api/models/library_item.rb +606 -571
  1110. data/lib/ultracart_api/models/library_item_account.rb +237 -202
  1111. data/lib/ultracart_api/models/library_item_asset.rb +228 -193
  1112. data/lib/ultracart_api/models/library_item_attribute.rb +228 -193
  1113. data/lib/ultracart_api/models/library_item_email.rb +237 -202
  1114. data/lib/ultracart_api/models/library_item_published_meta.rb +290 -255
  1115. data/lib/ultracart_api/models/library_item_purchased_meta.rb +240 -205
  1116. data/lib/ultracart_api/models/library_item_query.rb +330 -295
  1117. data/lib/ultracart_api/models/library_item_response.rb +256 -221
  1118. data/lib/ultracart_api/models/library_item_screenshot.rb +228 -193
  1119. data/lib/ultracart_api/models/library_items_response.rb +259 -224
  1120. data/lib/ultracart_api/models/linked_account.rb +240 -205
  1121. data/lib/ultracart_api/models/list_segment_membership.rb +237 -202
  1122. data/lib/ultracart_api/models/lookup_request.rb +255 -229
  1123. data/lib/ultracart_api/models/lookup_response.rb +258 -223
  1124. data/lib/ultracart_api/models/mailgun.rb +219 -184
  1125. data/lib/ultracart_api/models/metric.rb +282 -247
  1126. data/lib/ultracart_api/models/notification.rb +322 -287
  1127. data/lib/ultracart_api/models/oauth_revoke_success_response.rb +230 -195
  1128. data/lib/ultracart_api/models/oauth_token_response.rb +321 -286
  1129. data/lib/ultracart_api/models/order.rb +604 -610
  1130. data/lib/ultracart_api/models/order_affiliate.rb +242 -207
  1131. data/lib/ultracart_api/models/order_affiliate_ledger.rb +334 -299
  1132. data/lib/ultracart_api/models/order_auto_order.rb +448 -413
  1133. data/lib/ultracart_api/models/order_billing.rb +597 -612
  1134. data/lib/ultracart_api/models/order_buysafe.rb +268 -233
  1135. data/lib/ultracart_api/models/order_by_token_query.rb +220 -185
  1136. data/lib/ultracart_api/models/order_channel_partner.rb +335 -300
  1137. data/lib/ultracart_api/models/order_checkout.rb +469 -509
  1138. data/lib/ultracart_api/models/order_coupon.rb +290 -255
  1139. data/lib/ultracart_api/models/order_digital_item.rb +290 -255
  1140. data/lib/ultracart_api/models/order_digital_order.rb +262 -227
  1141. data/lib/ultracart_api/models/order_edi.rb +265 -230
  1142. data/lib/ultracart_api/models/order_format.rb +404 -369
  1143. data/lib/ultracart_api/models/order_format_response.rb +232 -197
  1144. data/lib/ultracart_api/models/order_fraud_score.rb +444 -409
  1145. data/lib/ultracart_api/models/order_gift.rb +351 -316
  1146. data/lib/ultracart_api/models/order_gift_certificate.rb +239 -204
  1147. data/lib/ultracart_api/models/order_internal.rb +275 -252
  1148. data/lib/ultracart_api/models/order_item.rb +889 -1019
  1149. data/lib/ultracart_api/models/order_item_edi.rb +234 -199
  1150. data/lib/ultracart_api/models/order_item_edi_identification.rb +230 -195
  1151. data/lib/ultracart_api/models/order_item_edi_lot.rb +240 -205
  1152. data/lib/ultracart_api/models/order_item_option.rb +378 -343
  1153. data/lib/ultracart_api/models/order_item_option_file_attachment.rb +250 -215
  1154. data/lib/ultracart_api/models/order_item_property.rb +280 -245
  1155. data/lib/ultracart_api/models/order_item_tag.rb +235 -200
  1156. data/lib/ultracart_api/models/order_linked_shipment.rb +264 -229
  1157. data/lib/ultracart_api/models/order_marketing.rb +270 -245
  1158. data/lib/ultracart_api/models/order_packing_slip_response.rb +257 -222
  1159. data/lib/ultracart_api/models/order_payment.rb +432 -397
  1160. data/lib/ultracart_api/models/order_payment_check.rb +220 -185
  1161. data/lib/ultracart_api/models/order_payment_credit_card.rb +354 -328
  1162. data/lib/ultracart_api/models/order_payment_e_check.rb +476 -441
  1163. data/lib/ultracart_api/models/order_payment_insurance.rb +250 -215
  1164. data/lib/ultracart_api/models/order_payment_purchase_order.rb +220 -185
  1165. data/lib/ultracart_api/models/order_payment_transaction.rb +252 -227
  1166. data/lib/ultracart_api/models/order_payment_transaction_detail.rb +240 -205
  1167. data/lib/ultracart_api/models/order_process_payment_request.rb +230 -195
  1168. data/lib/ultracart_api/models/order_process_payment_response.rb +256 -221
  1169. data/lib/ultracart_api/models/order_property.rb +280 -245
  1170. data/lib/ultracart_api/models/order_query.rb +826 -791
  1171. data/lib/ultracart_api/models/order_query_batch.rb +222 -187
  1172. data/lib/ultracart_api/models/order_quote.rb +240 -205
  1173. data/lib/ultracart_api/models/order_replacement.rb +467 -432
  1174. data/lib/ultracart_api/models/order_replacement_item.rb +255 -220
  1175. data/lib/ultracart_api/models/order_replacement_response.rb +264 -229
  1176. data/lib/ultracart_api/models/order_response.rb +256 -221
  1177. data/lib/ultracart_api/models/order_salesforce.rb +220 -185
  1178. data/lib/ultracart_api/models/order_shipping.rb +770 -745
  1179. data/lib/ultracart_api/models/order_summary.rb +390 -355
  1180. data/lib/ultracart_api/models/order_tag.rb +235 -200
  1181. data/lib/ultracart_api/models/order_taxes.rb +395 -360
  1182. data/lib/ultracart_api/models/order_token_response.rb +257 -222
  1183. data/lib/ultracart_api/models/order_tracking_number_detail.rb +320 -285
  1184. data/lib/ultracart_api/models/order_tracking_number_details.rb +374 -339
  1185. data/lib/ultracart_api/models/orders_response.rb +259 -224
  1186. data/lib/ultracart_api/models/permission.rb +240 -205
  1187. data/lib/ultracart_api/models/pricing_tier.rb +533 -518
  1188. data/lib/ultracart_api/models/pricing_tier_notification.rb +270 -235
  1189. data/lib/ultracart_api/models/pricing_tiers_response.rb +259 -224
  1190. data/lib/ultracart_api/models/property.rb +228 -193
  1191. data/lib/ultracart_api/models/publish_library_item_request.rb +220 -185
  1192. data/lib/ultracart_api/models/register_affiliate_click_request.rb +270 -235
  1193. data/lib/ultracart_api/models/register_affiliate_click_response.rb +254 -219
  1194. data/lib/ultracart_api/models/response_metadata.rb +229 -194
  1195. data/lib/ultracart_api/models/result_set.rb +270 -235
  1196. data/lib/ultracart_api/models/screen_recording.rb +688 -653
  1197. data/lib/ultracart_api/models/screen_recording_ad_platform.rb +280 -245
  1198. data/lib/ultracart_api/models/screen_recording_filter.rb +758 -723
  1199. data/lib/ultracart_api/models/screen_recording_filter_geo_distance.rb +255 -220
  1200. data/lib/ultracart_api/models/screen_recording_filter_ip_search.rb +246 -211
  1201. data/lib/ultracart_api/models/screen_recording_filter_page_view.rb +369 -334
  1202. data/lib/ultracart_api/models/screen_recording_filter_page_view_event.rb +230 -195
  1203. data/lib/ultracart_api/models/screen_recording_filter_page_view_event_param.rb +255 -220
  1204. data/lib/ultracart_api/models/screen_recording_filter_page_view_param.rb +228 -193
  1205. data/lib/ultracart_api/models/screen_recording_filter_page_view_referrer_param.rb +228 -193
  1206. data/lib/ultracart_api/models/screen_recording_filter_range_big_decimal.rb +255 -220
  1207. data/lib/ultracart_api/models/screen_recording_filter_range_date.rb +230 -195
  1208. data/lib/ultracart_api/models/screen_recording_filter_range_integer.rb +255 -220
  1209. data/lib/ultracart_api/models/screen_recording_filter_string_search.rb +255 -220
  1210. data/lib/ultracart_api/models/screen_recording_filter_values.rb +435 -400
  1211. data/lib/ultracart_api/models/screen_recording_filter_values_event.rb +230 -195
  1212. data/lib/ultracart_api/models/screen_recording_filter_values_event_params.rb +263 -228
  1213. data/lib/ultracart_api/models/screen_recording_filter_values_page_param.rb +230 -195
  1214. data/lib/ultracart_api/models/screen_recording_filter_values_page_view.rb +272 -237
  1215. data/lib/ultracart_api/models/screen_recording_heatmap.rb +426 -391
  1216. data/lib/ultracart_api/models/screen_recording_heatmap_index_request.rb +219 -184
  1217. data/lib/ultracart_api/models/screen_recording_heatmap_index_response.rb +258 -223
  1218. data/lib/ultracart_api/models/screen_recording_heatmap_request.rb +239 -204
  1219. data/lib/ultracart_api/models/screen_recording_heatmap_reset.rb +219 -184
  1220. data/lib/ultracart_api/models/screen_recording_heatmap_response.rb +256 -221
  1221. data/lib/ultracart_api/models/screen_recording_heatmap_url.rb +266 -231
  1222. data/lib/ultracart_api/models/screen_recording_merchant_notes_request.rb +219 -184
  1223. data/lib/ultracart_api/models/screen_recording_multifield.rb +255 -220
  1224. data/lib/ultracart_api/models/screen_recording_page_view.rb +391 -356
  1225. data/lib/ultracart_api/models/screen_recording_page_view_data_response.rb +256 -221
  1226. data/lib/ultracart_api/models/screen_recording_page_view_event.rb +267 -232
  1227. data/lib/ultracart_api/models/screen_recording_page_view_event_parameter.rb +228 -193
  1228. data/lib/ultracart_api/models/screen_recording_page_view_parameter.rb +228 -193
  1229. data/lib/ultracart_api/models/screen_recording_query_request.rb +219 -184
  1230. data/lib/ultracart_api/models/screen_recording_query_response.rb +314 -279
  1231. data/lib/ultracart_api/models/screen_recording_response.rb +265 -230
  1232. data/lib/ultracart_api/models/screen_recording_segment.rb +302 -267
  1233. data/lib/ultracart_api/models/screen_recording_segment_response.rb +256 -221
  1234. data/lib/ultracart_api/models/screen_recording_segments_response.rb +258 -223
  1235. data/lib/ultracart_api/models/screen_recording_settings.rb +284 -249
  1236. data/lib/ultracart_api/models/screen_recording_settings_response.rb +256 -221
  1237. data/lib/ultracart_api/models/screen_recording_store_front.rb +228 -193
  1238. data/lib/ultracart_api/models/screen_recording_tags_request.rb +221 -186
  1239. data/lib/ultracart_api/models/screen_recording_tags_response.rb +258 -223
  1240. data/lib/ultracart_api/models/screen_recording_user_agent.rb +255 -220
  1241. data/lib/ultracart_api/models/screen_recording_user_agent_device.rb +219 -184
  1242. data/lib/ultracart_api/models/screen_recording_user_agent_os.rb +237 -202
  1243. data/lib/ultracart_api/models/screen_recording_user_property.rb +228 -193
  1244. data/lib/ultracart_api/models/screenshots_response.rb +259 -224
  1245. data/lib/ultracart_api/models/self_config.rb +220 -185
  1246. data/lib/ultracart_api/models/simple_value.rb +230 -195
  1247. data/lib/ultracart_api/models/single_sign_on_authorize_request.rb +230 -195
  1248. data/lib/ultracart_api/models/single_sign_on_authorize_response.rb +230 -195
  1249. data/lib/ultracart_api/models/single_sign_on_token_request.rb +230 -195
  1250. data/lib/ultracart_api/models/single_sign_on_token_response.rb +240 -205
  1251. data/lib/ultracart_api/models/sovos_config.rb +280 -245
  1252. data/lib/ultracart_api/models/state_province.rb +245 -210
  1253. data/lib/ultracart_api/models/step_waiting.rb +228 -193
  1254. data/lib/ultracart_api/models/tax_city.rb +302 -267
  1255. data/lib/ultracart_api/models/tax_country.rb +302 -267
  1256. data/lib/ultracart_api/models/tax_country_code.rb +260 -225
  1257. data/lib/ultracart_api/models/tax_county.rb +312 -277
  1258. data/lib/ultracart_api/models/tax_jar_config.rb +280 -245
  1259. data/lib/ultracart_api/models/tax_postal_code.rb +280 -245
  1260. data/lib/ultracart_api/models/tax_provider_activate_result.rb +229 -194
  1261. data/lib/ultracart_api/models/tax_provider_avalara.rb +249 -214
  1262. data/lib/ultracart_api/models/tax_provider_avalara_companies_result.rb +222 -187
  1263. data/lib/ultracart_api/models/tax_provider_avalara_company.rb +260 -225
  1264. data/lib/ultracart_api/models/tax_provider_self.rb +261 -226
  1265. data/lib/ultracart_api/models/tax_provider_self_countries_response.rb +222 -187
  1266. data/lib/ultracart_api/models/tax_provider_self_regions_response.rb +222 -187
  1267. data/lib/ultracart_api/models/tax_provider_sovos.rb +249 -214
  1268. data/lib/ultracart_api/models/tax_provider_tax_jar.rb +249 -214
  1269. data/lib/ultracart_api/models/tax_provider_test_result.rb +229 -194
  1270. data/lib/ultracart_api/models/tax_provider_ultra_cart.rb +261 -226
  1271. data/lib/ultracart_api/models/tax_provider_ultra_cart_state.rb +310 -275
  1272. data/lib/ultracart_api/models/tax_providers_response.rb +292 -257
  1273. data/lib/ultracart_api/models/tax_state.rb +392 -357
  1274. data/lib/ultracart_api/models/tax_state_code.rb +260 -225
  1275. data/lib/ultracart_api/models/temp_multimedia.rb +329 -294
  1276. data/lib/ultracart_api/models/temp_multimedia_response.rb +256 -221
  1277. data/lib/ultracart_api/models/thumbnail_parameters_request.rb +255 -220
  1278. data/lib/ultracart_api/models/thumbnail_parameters_response.rb +257 -222
  1279. data/lib/ultracart_api/models/transaction_email.rb +414 -379
  1280. data/lib/ultracart_api/models/transaction_email_list_response.rb +258 -223
  1281. data/lib/ultracart_api/models/transaction_email_option.rb +282 -247
  1282. data/lib/ultracart_api/models/transaction_email_response.rb +256 -221
  1283. data/lib/ultracart_api/models/twilio.rb +248 -213
  1284. data/lib/ultracart_api/models/twilio_response.rb +265 -230
  1285. data/lib/ultracart_api/models/twilios_response.rb +258 -223
  1286. data/lib/ultracart_api/models/ultra_cart_config.rb +220 -185
  1287. data/lib/ultracart_api/models/upload_coupon_codes_request.rb +259 -224
  1288. data/lib/ultracart_api/models/upload_coupon_codes_response.rb +283 -248
  1289. data/lib/ultracart_api/models/user.rb +377 -342
  1290. data/lib/ultracart_api/models/user_group_membership.rb +240 -205
  1291. data/lib/ultracart_api/models/user_login.rb +250 -215
  1292. data/lib/ultracart_api/models/user_logins_response.rb +259 -224
  1293. data/lib/ultracart_api/models/user_response.rb +256 -221
  1294. data/lib/ultracart_api/models/users_response.rb +258 -223
  1295. data/lib/ultracart_api/models/verification_record.rb +237 -202
  1296. data/lib/ultracart_api/models/warning.rb +230 -195
  1297. data/lib/ultracart_api/models/webhook.rb +437 -412
  1298. data/lib/ultracart_api/models/webhook_event_category.rb +264 -229
  1299. data/lib/ultracart_api/models/webhook_event_subscription.rb +300 -265
  1300. data/lib/ultracart_api/models/webhook_log.rb +324 -289
  1301. data/lib/ultracart_api/models/webhook_log_response.rb +256 -221
  1302. data/lib/ultracart_api/models/webhook_log_summaries_response.rb +259 -224
  1303. data/lib/ultracart_api/models/webhook_log_summary.rb +240 -205
  1304. data/lib/ultracart_api/models/webhook_response.rb +256 -221
  1305. data/lib/ultracart_api/models/webhook_sample_request.rb +252 -217
  1306. data/lib/ultracart_api/models/webhook_sample_request_response.rb +256 -221
  1307. data/lib/ultracart_api/models/webhooks_response.rb +258 -223
  1308. data/lib/ultracart_api/models/weight.rb +264 -229
  1309. data/lib/ultracart_api/version.rb +15 -15
  1310. data/lib/ultracart_api.rb +689 -841
  1311. data/spec/api_client_spec.rb +226 -243
  1312. data/spec/configuration_spec.rb +42 -42
  1313. data/spec/spec_helper.rb +111 -111
  1314. data/ultracart_api.gemspec +38 -46
  1315. metadata +5 -469
  1316. data/docs/AccountsReceivableRetryTransactionReject.md +0 -9
  1317. data/docs/AutoOrderAddonItem.md +0 -13
  1318. data/docs/AutoOrderAddonItemOption.md +0 -9
  1319. data/docs/AutoOrderManagement.md +0 -8
  1320. data/docs/CartItemProperty.md +0 -11
  1321. data/docs/ChannelPartner.md +0 -15
  1322. data/docs/ChannelPartnerShipToPreference.md +0 -14
  1323. data/docs/ChannelPartnerShipToPreferenceResponse.md +0 -12
  1324. data/docs/ChannelPartnerShipToPreferencesResponse.md +0 -12
  1325. data/docs/ChannelPartnersResponse.md +0 -12
  1326. data/docs/Conversation.md +0 -26
  1327. data/docs/ConversationAgentAuth.md +0 -13
  1328. data/docs/ConversationAgentAuthResponse.md +0 -12
  1329. data/docs/ConversationAgentProfile.md +0 -14
  1330. data/docs/ConversationAgentProfileResponse.md +0 -12
  1331. data/docs/ConversationApi.md +0 -1768
  1332. data/docs/ConversationAutocompleteRequest.md +0 -9
  1333. data/docs/ConversationAutocompleteResponse.md +0 -14
  1334. data/docs/ConversationAutocompleteValue.md +0 -9
  1335. data/docs/ConversationCannedMessage.md +0 -11
  1336. data/docs/ConversationCannedMessageResponse.md +0 -12
  1337. data/docs/ConversationCannedMessagesResponse.md +0 -12
  1338. data/docs/ConversationCannedMessagesSearch.md +0 -9
  1339. data/docs/ConversationDepartment.md +0 -12
  1340. data/docs/ConversationDepartmentMember.md +0 -10
  1341. data/docs/ConversationDepartmentMembersResponse.md +0 -12
  1342. data/docs/ConversationDepartmentResponse.md +0 -12
  1343. data/docs/ConversationDepartmentSettings.md +0 -7
  1344. data/docs/ConversationDepartmentsResponse.md +0 -12
  1345. data/docs/ConversationEngagement.md +0 -16
  1346. data/docs/ConversationEngagementEquation.md +0 -8
  1347. data/docs/ConversationEngagementEquationFunction.md +0 -21
  1348. data/docs/ConversationEngagementEquationGroup.md +0 -8
  1349. data/docs/ConversationEngagementResponse.md +0 -12
  1350. data/docs/ConversationEngagementsResponse.md +0 -12
  1351. data/docs/ConversationEventAddCoupon.md +0 -10
  1352. data/docs/ConversationEventAddItem.md +0 -10
  1353. data/docs/ConversationEventQueuePosition.md +0 -9
  1354. data/docs/ConversationEventRRWeb.md +0 -14
  1355. data/docs/ConversationEventReadMessage.md +0 -10
  1356. data/docs/ConversationEventTyping.md +0 -10
  1357. data/docs/ConversationEventWebchatContext.md +0 -10
  1358. data/docs/ConversationJoinRequest.md +0 -8
  1359. data/docs/ConversationLocationCountry.md +0 -10
  1360. data/docs/ConversationLocationStateProvince.md +0 -9
  1361. data/docs/ConversationLocationsResponse.md +0 -12
  1362. data/docs/ConversationMessage.md +0 -22
  1363. data/docs/ConversationMessageTranslation.md +0 -9
  1364. data/docs/ConversationMessageTransportStatus.md +0 -9
  1365. data/docs/ConversationMessagesResponse.md +0 -12
  1366. data/docs/ConversationMultimediaUploadUrl.md +0 -9
  1367. data/docs/ConversationMultimediaUploadUrlResponse.md +0 -12
  1368. data/docs/ConversationParticipant.md +0 -20
  1369. data/docs/ConversationPermissions.md +0 -8
  1370. data/docs/ConversationPermissionsResponse.md +0 -12
  1371. data/docs/ConversationResponse.md +0 -12
  1372. data/docs/ConversationSearchRequest.md +0 -19
  1373. data/docs/ConversationSearchResponse.md +0 -11
  1374. data/docs/ConversationSentiment.md +0 -13
  1375. data/docs/ConversationStartRequest.md +0 -10
  1376. data/docs/ConversationStartResponse.md +0 -8
  1377. data/docs/ConversationSummary.md +0 -24
  1378. data/docs/ConversationTwilioAccount.md +0 -9
  1379. data/docs/ConversationWebchatContext.md +0 -15
  1380. data/docs/ConversationWebchatQueueStatus.md +0 -22
  1381. data/docs/ConversationWebchatQueueStatusAgent.md +0 -13
  1382. data/docs/ConversationWebchatQueueStatusQueueEntry.md +0 -15
  1383. data/docs/ConversationWebchatQueueStatusUpdateRequest.md +0 -8
  1384. data/docs/ConversationWebchatQueueStatusesResponse.md +0 -12
  1385. data/docs/ConversationWebsocketMessage.md +0 -31
  1386. data/docs/ConversationsResponse.md +0 -12
  1387. data/docs/CouponFreeItemWithItemPurchaseAndFreeShipping.md +0 -11
  1388. data/docs/CouponMoreLoyaltyCashback.md +0 -8
  1389. data/docs/CouponMoreLoyaltyPoints.md +0 -8
  1390. data/docs/CouponNoDiscount.md +0 -8
  1391. data/docs/CouponPercentMoreLoyaltyCashback.md +0 -8
  1392. data/docs/CouponPercentMoreLoyaltyPoints.md +0 -8
  1393. data/docs/CouponTieredPercentOffSubtotalBasedOnMSRP.md +0 -9
  1394. data/docs/CustomerEDI.md +0 -10
  1395. data/docs/CustomerMagicLinkResponse.md +0 -12
  1396. data/docs/CustomerMergeRequest.md +0 -9
  1397. data/docs/CustomerProperty.md +0 -11
  1398. data/docs/DatawarehouseApi.md +0 -512
  1399. data/docs/EmailCommseqSequenceTestRequest.md +0 -22
  1400. data/docs/EmailCommseqSequenceTestResponse.md +0 -11
  1401. data/docs/EmailCommseqSmsSendTestRequest.md +0 -10
  1402. data/docs/EmailCommseqSmsSendTestResponse.md +0 -13
  1403. data/docs/EmailPostcardTracking.md +0 -32
  1404. data/docs/EmailPostcardTrackingResponse.md +0 -12
  1405. data/docs/FileManagerDirectory.md +0 -20
  1406. data/docs/FileManagerFile.md +0 -29
  1407. data/docs/FileManagerPage.md +0 -15
  1408. data/docs/FileManagerPageResponse.md +0 -12
  1409. data/docs/FileManagerUploadRequest.md +0 -10
  1410. data/docs/FileManagerUploadUrlResponse.md +0 -13
  1411. data/docs/HitPageView.md +0 -18
  1412. data/docs/HitPageViewMetaData.md +0 -9
  1413. data/docs/HitSessionStart.md +0 -24
  1414. data/docs/HitSessionUtm.md +0 -22
  1415. data/docs/ItemDigitalItemPdfMeta.md +0 -18
  1416. data/docs/ItemDigitalItemResponse.md +0 -12
  1417. data/docs/ItemDigitalItemsResponse.md +0 -12
  1418. data/docs/ItemReview.md +0 -44
  1419. data/docs/ItemReviewResponse.md +0 -12
  1420. data/docs/ItemReviewsResponse.md +0 -12
  1421. data/docs/OrderEdiDocument.md +0 -21
  1422. data/docs/OrderEdiDocumentsResponse.md +0 -12
  1423. data/docs/OrderInvoiceResponse.md +0 -12
  1424. data/docs/OrderPaymentCreditCardDualVaulted.md +0 -10
  1425. data/docs/OrderPaymentCreditCardDualVaultedProperty.md +0 -9
  1426. data/docs/OrderPointOfSale.md +0 -10
  1427. data/docs/OrderReason.md +0 -10
  1428. data/docs/OrderRefundableResponse.md +0 -19
  1429. data/docs/OrderTransactionalMerchantNote.md +0 -11
  1430. data/docs/OrderUtm.md +0 -31
  1431. data/docs/OrderValidationRequest.md +0 -9
  1432. data/docs/OrderValidationResponse.md +0 -10
  1433. data/docs/PointOfSaleLocation.md +0 -17
  1434. data/docs/PointOfSaleReader.md +0 -16
  1435. data/docs/PointOfSaleRegister.md +0 -11
  1436. data/docs/Report.md +0 -18
  1437. data/docs/ReportAuth.md +0 -11
  1438. data/docs/ReportAuthResponse.md +0 -12
  1439. data/docs/ReportDataSet.md +0 -24
  1440. data/docs/ReportDataSetColumn.md +0 -13
  1441. data/docs/ReportDataSetPage.md +0 -17
  1442. data/docs/ReportDataSetPageResponse.md +0 -12
  1443. data/docs/ReportDataSetQuery.md +0 -20
  1444. data/docs/ReportDataSetQueryOrderByColumn.md +0 -9
  1445. data/docs/ReportDataSetResponse.md +0 -12
  1446. data/docs/ReportDataSetRow.md +0 -8
  1447. data/docs/ReportDataSetSchema.md +0 -10
  1448. data/docs/ReportDataSource.md +0 -14
  1449. data/docs/ReportDataSourceSchema.md +0 -11
  1450. data/docs/ReportDryRunQueriesRequest.md +0 -13
  1451. data/docs/ReportDryRunQueriesResponse.md +0 -8
  1452. data/docs/ReportDryRunQueryResult.md +0 -9
  1453. data/docs/ReportExecuteQueriesRequest.md +0 -15
  1454. data/docs/ReportFilter.md +0 -13
  1455. data/docs/ReportFilterConnection.md +0 -10
  1456. data/docs/ReportPage.md +0 -13
  1457. data/docs/ReportPageFilter.md +0 -11
  1458. data/docs/ReportPageVisualization.md +0 -17
  1459. data/docs/ReportPageVisualizationDimension.md +0 -14
  1460. data/docs/ReportPageVisualizationMetric.md +0 -11
  1461. data/docs/ReportResponse.md +0 -12
  1462. data/docs/ReportWebsocketEvent.md +0 -9
  1463. data/docs/ReportsResponse.md +0 -12
  1464. data/docs/RulerValidationRequest.md +0 -8
  1465. data/docs/RulerValidationResponse.md +0 -9
  1466. data/docs/StoreFront.md +0 -18
  1467. data/docs/StoreFrontsResponse.md +0 -12
  1468. data/lib/ultracart_api/api/conversation_api.rb +0 -1936
  1469. data/lib/ultracart_api/api/datawarehouse_api.rb +0 -584
  1470. data/lib/ultracart_api/models/accounts_receivable_retry_transaction_reject.rb +0 -195
  1471. data/lib/ultracart_api/models/auto_order_addon_item.rb +0 -232
  1472. data/lib/ultracart_api/models/auto_order_addon_item_option.rb +0 -225
  1473. data/lib/ultracart_api/models/auto_order_management.rb +0 -185
  1474. data/lib/ultracart_api/models/cart_item_property.rb +0 -245
  1475. data/lib/ultracart_api/models/channel_partner.rb +0 -255
  1476. data/lib/ultracart_api/models/channel_partner_ship_to_preference.rb +0 -262
  1477. data/lib/ultracart_api/models/channel_partner_ship_to_preference_response.rb +0 -221
  1478. data/lib/ultracart_api/models/channel_partner_ship_to_preferences_response.rb +0 -224
  1479. data/lib/ultracart_api/models/channel_partners_response.rb +0 -224
  1480. data/lib/ultracart_api/models/conversation.rb +0 -390
  1481. data/lib/ultracart_api/models/conversation_agent_auth.rb +0 -231
  1482. data/lib/ultracart_api/models/conversation_agent_auth_response.rb +0 -221
  1483. data/lib/ultracart_api/models/conversation_agent_profile.rb +0 -279
  1484. data/lib/ultracart_api/models/conversation_agent_profile_response.rb +0 -221
  1485. data/lib/ultracart_api/models/conversation_autocomplete_request.rb +0 -193
  1486. data/lib/ultracart_api/models/conversation_autocomplete_response.rb +0 -241
  1487. data/lib/ultracart_api/models/conversation_autocomplete_value.rb +0 -193
  1488. data/lib/ultracart_api/models/conversation_canned_message.rb +0 -213
  1489. data/lib/ultracart_api/models/conversation_canned_message_response.rb +0 -221
  1490. data/lib/ultracart_api/models/conversation_canned_messages_response.rb +0 -223
  1491. data/lib/ultracart_api/models/conversation_canned_messages_search.rb +0 -193
  1492. data/lib/ultracart_api/models/conversation_department.rb +0 -222
  1493. data/lib/ultracart_api/models/conversation_department_member.rb +0 -202
  1494. data/lib/ultracart_api/models/conversation_department_members_response.rb +0 -223
  1495. data/lib/ultracart_api/models/conversation_department_response.rb +0 -221
  1496. data/lib/ultracart_api/models/conversation_department_settings.rb +0 -175
  1497. data/lib/ultracart_api/models/conversation_departments_response.rb +0 -223
  1498. data/lib/ultracart_api/models/conversation_engagement.rb +0 -293
  1499. data/lib/ultracart_api/models/conversation_engagement_equation.rb +0 -186
  1500. data/lib/ultracart_api/models/conversation_engagement_equation_function.rb +0 -414
  1501. data/lib/ultracart_api/models/conversation_engagement_equation_group.rb +0 -186
  1502. data/lib/ultracart_api/models/conversation_engagement_response.rb +0 -221
  1503. data/lib/ultracart_api/models/conversation_engagements_response.rb +0 -223
  1504. data/lib/ultracart_api/models/conversation_event_add_coupon.rb +0 -202
  1505. data/lib/ultracart_api/models/conversation_event_add_item.rb +0 -204
  1506. data/lib/ultracart_api/models/conversation_event_queue_position.rb +0 -195
  1507. data/lib/ultracart_api/models/conversation_event_read_message.rb +0 -203
  1508. data/lib/ultracart_api/models/conversation_event_rr_web.rb +0 -273
  1509. data/lib/ultracart_api/models/conversation_event_typing.rb +0 -202
  1510. data/lib/ultracart_api/models/conversation_event_webchat_context.rb +0 -202
  1511. data/lib/ultracart_api/models/conversation_join_request.rb +0 -184
  1512. data/lib/ultracart_api/models/conversation_location_country.rb +0 -204
  1513. data/lib/ultracart_api/models/conversation_location_state_province.rb +0 -193
  1514. data/lib/ultracart_api/models/conversation_locations_response.rb +0 -223
  1515. data/lib/ultracart_api/models/conversation_message.rb +0 -356
  1516. data/lib/ultracart_api/models/conversation_message_translation.rb +0 -193
  1517. data/lib/ultracart_api/models/conversation_message_transport_status.rb +0 -228
  1518. data/lib/ultracart_api/models/conversation_messages_response.rb +0 -223
  1519. data/lib/ultracart_api/models/conversation_multimedia_upload_url.rb +0 -193
  1520. data/lib/ultracart_api/models/conversation_multimedia_upload_url_response.rb +0 -221
  1521. data/lib/ultracart_api/models/conversation_participant.rb +0 -295
  1522. data/lib/ultracart_api/models/conversation_permissions.rb +0 -184
  1523. data/lib/ultracart_api/models/conversation_permissions_response.rb +0 -221
  1524. data/lib/ultracart_api/models/conversation_response.rb +0 -221
  1525. data/lib/ultracart_api/models/conversation_search_request.rb +0 -285
  1526. data/lib/ultracart_api/models/conversation_search_response.rb +0 -213
  1527. data/lib/ultracart_api/models/conversation_sentiment.rb +0 -269
  1528. data/lib/ultracart_api/models/conversation_start_request.rb +0 -204
  1529. data/lib/ultracart_api/models/conversation_start_response.rb +0 -184
  1530. data/lib/ultracart_api/models/conversation_summary.rb +0 -369
  1531. data/lib/ultracart_api/models/conversation_twilio_account.rb +0 -195
  1532. data/lib/ultracart_api/models/conversation_webchat_context.rb +0 -254
  1533. data/lib/ultracart_api/models/conversation_webchat_queue_status.rb +0 -315
  1534. data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb +0 -266
  1535. data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +0 -248
  1536. data/lib/ultracart_api/models/conversation_webchat_queue_status_update_request.rb +0 -219
  1537. data/lib/ultracart_api/models/conversation_webchat_queue_statuses_response.rb +0 -223
  1538. data/lib/ultracart_api/models/conversation_websocket_message.rb +0 -441
  1539. data/lib/ultracart_api/models/conversations_response.rb +0 -223
  1540. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase_and_free_shipping.rb +0 -219
  1541. data/lib/ultracart_api/models/coupon_more_loyalty_cashback.rb +0 -185
  1542. data/lib/ultracart_api/models/coupon_more_loyalty_points.rb +0 -185
  1543. data/lib/ultracart_api/models/coupon_no_discount.rb +0 -185
  1544. data/lib/ultracart_api/models/coupon_percent_more_loyalty_cashback.rb +0 -185
  1545. data/lib/ultracart_api/models/coupon_percent_more_loyalty_points.rb +0 -185
  1546. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal_based_on_msrp.rb +0 -199
  1547. data/lib/ultracart_api/models/customer_edi.rb +0 -205
  1548. data/lib/ultracart_api/models/customer_magic_link_response.rb +0 -222
  1549. data/lib/ultracart_api/models/customer_merge_request.rb +0 -195
  1550. data/lib/ultracart_api/models/customer_property.rb +0 -245
  1551. data/lib/ultracart_api/models/email_commseq_sequence_test_request.rb +0 -312
  1552. data/lib/ultracart_api/models/email_commseq_sequence_test_response.rb +0 -212
  1553. data/lib/ultracart_api/models/email_commseq_sms_send_test_request.rb +0 -202
  1554. data/lib/ultracart_api/models/email_commseq_sms_send_test_response.rb +0 -232
  1555. data/lib/ultracart_api/models/email_postcard_tracking.rb +0 -404
  1556. data/lib/ultracart_api/models/email_postcard_tracking_response.rb +0 -221
  1557. data/lib/ultracart_api/models/file_manager_directory.rb +0 -292
  1558. data/lib/ultracart_api/models/file_manager_file.rb +0 -376
  1559. data/lib/ultracart_api/models/file_manager_page.rb +0 -253
  1560. data/lib/ultracart_api/models/file_manager_page_response.rb +0 -221
  1561. data/lib/ultracart_api/models/file_manager_upload_request.rb +0 -202
  1562. data/lib/ultracart_api/models/file_manager_upload_url_response.rb +0 -230
  1563. data/lib/ultracart_api/models/hit_page_view.rb +0 -276
  1564. data/lib/ultracart_api/models/hit_page_view_meta_data.rb +0 -193
  1565. data/lib/ultracart_api/models/hit_session_start.rb +0 -328
  1566. data/lib/ultracart_api/models/hit_session_utm.rb +0 -310
  1567. data/lib/ultracart_api/models/item_digital_item_pdf_meta.rb +0 -315
  1568. data/lib/ultracart_api/models/item_digital_item_response.rb +0 -221
  1569. data/lib/ultracart_api/models/item_digital_items_response.rb +0 -224
  1570. data/lib/ultracart_api/models/item_review.rb +0 -801
  1571. data/lib/ultracart_api/models/item_review_response.rb +0 -221
  1572. data/lib/ultracart_api/models/item_reviews_response.rb +0 -224
  1573. data/lib/ultracart_api/models/order_edi_document.rb +0 -337
  1574. data/lib/ultracart_api/models/order_edi_documents_response.rb +0 -224
  1575. data/lib/ultracart_api/models/order_invoice_response.rb +0 -222
  1576. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted.rb +0 -204
  1577. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted_property.rb +0 -193
  1578. data/lib/ultracart_api/models/order_point_of_sale.rb +0 -202
  1579. data/lib/ultracart_api/models/order_reason.rb +0 -205
  1580. data/lib/ultracart_api/models/order_refundable_response.rb +0 -300
  1581. data/lib/ultracart_api/models/order_transactional_merchant_note.rb +0 -215
  1582. data/lib/ultracart_api/models/order_utm.rb +0 -392
  1583. data/lib/ultracart_api/models/order_validation_request.rb +0 -196
  1584. data/lib/ultracart_api/models/order_validation_response.rb +0 -209
  1585. data/lib/ultracart_api/models/point_of_sale_location.rb +0 -290
  1586. data/lib/ultracart_api/models/point_of_sale_reader.rb +0 -299
  1587. data/lib/ultracart_api/models/point_of_sale_register.rb +0 -215
  1588. data/lib/ultracart_api/models/report.rb +0 -317
  1589. data/lib/ultracart_api/models/report_auth.rb +0 -212
  1590. data/lib/ultracart_api/models/report_auth_response.rb +0 -221
  1591. data/lib/ultracart_api/models/report_data_set.rb +0 -381
  1592. data/lib/ultracart_api/models/report_data_set_column.rb +0 -229
  1593. data/lib/ultracart_api/models/report_data_set_page.rb +0 -273
  1594. data/lib/ultracart_api/models/report_data_set_page_response.rb +0 -221
  1595. data/lib/ultracart_api/models/report_data_set_query.rb +0 -342
  1596. data/lib/ultracart_api/models/report_data_set_query_order_by_column.rb +0 -193
  1597. data/lib/ultracart_api/models/report_data_set_response.rb +0 -221
  1598. data/lib/ultracart_api/models/report_data_set_row.rb +0 -186
  1599. data/lib/ultracart_api/models/report_data_set_schema.rb +0 -238
  1600. data/lib/ultracart_api/models/report_data_source.rb +0 -242
  1601. data/lib/ultracart_api/models/report_data_source_schema.rb +0 -248
  1602. data/lib/ultracart_api/models/report_dry_run_queries_request.rb +0 -231
  1603. data/lib/ultracart_api/models/report_dry_run_queries_response.rb +0 -186
  1604. data/lib/ultracart_api/models/report_dry_run_query_result.rb +0 -193
  1605. data/lib/ultracart_api/models/report_execute_queries_request.rb +0 -288
  1606. data/lib/ultracart_api/models/report_filter.rb +0 -272
  1607. data/lib/ultracart_api/models/report_filter_connection.rb +0 -203
  1608. data/lib/ultracart_api/models/report_page.rb +0 -237
  1609. data/lib/ultracart_api/models/report_page_filter.rb +0 -214
  1610. data/lib/ultracart_api/models/report_page_visualization.rb +0 -309
  1611. data/lib/ultracart_api/models/report_page_visualization_dimension.rb +0 -244
  1612. data/lib/ultracart_api/models/report_page_visualization_metric.rb +0 -248
  1613. data/lib/ultracart_api/models/report_response.rb +0 -221
  1614. data/lib/ultracart_api/models/report_websocket_event.rb +0 -228
  1615. data/lib/ultracart_api/models/reports_response.rb +0 -223
  1616. data/lib/ultracart_api/models/ruler_validation_request.rb +0 -184
  1617. data/lib/ultracart_api/models/ruler_validation_response.rb +0 -193
  1618. data/lib/ultracart_api/models/store_front.rb +0 -274
  1619. data/lib/ultracart_api/models/store_fronts_response.rb +0 -223
data/docs/ItemApi.md CHANGED
@@ -1,1167 +1,733 @@
1
- # UltracartClient::ItemApi
2
-
3
- All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**delete_digital_item**](ItemApi.md#delete_digital_item) | **DELETE** /item/digital_library/{digital_item_oid} | Delete a digital item, which is a file within the digital library, not an actual merchant item
8
- [**delete_item**](ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
9
- [**delete_review**](ItemApi.md#delete_review) | **DELETE** /item/items/{merchant_item_oid}/reviews/{review_oid} | Delete a review
10
- [**get_digital_item**](ItemApi.md#get_digital_item) | **GET** /item/digital_library/{digital_item_oid} | Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
11
- [**get_digital_items**](ItemApi.md#get_digital_items) | **GET** /item/digital_library | Retrieve digital items from the digital library which are digital files that may be attached to normal items
12
- [**get_digital_items_by_external_id**](ItemApi.md#get_digital_items_by_external_id) | **GET** /item/digital_library/by_external/{external_id} | Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
13
- [**get_item**](ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
14
- [**get_item_by_merchant_item_id**](ItemApi.md#get_item_by_merchant_item_id) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id
15
- [**get_items**](ItemApi.md#get_items) | **GET** /item/items | Retrieve items
16
- [**get_pricing_tiers**](ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
17
- [**get_review**](ItemApi.md#get_review) | **GET** /item/items/{merchant_item_oid}/reviews/{review_oid} | Get a review
18
- [**get_reviews**](ItemApi.md#get_reviews) | **GET** /item/items/{merchant_item_oid}/reviews | Get reviews for an item
19
- [**get_unassociated_digital_items**](ItemApi.md#get_unassociated_digital_items) | **GET** /item/digital_library/unassociated | Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
20
- [**insert_digital_item**](ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
21
- [**insert_item**](ItemApi.md#insert_item) | **POST** /item/items | Create an item
22
- [**insert_review**](ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review
23
- [**update_digital_item**](ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
24
- [**update_item**](ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
25
- [**update_items**](ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
26
- [**update_review**](ItemApi.md#update_review) | **PUT** /item/items/{merchant_item_oid}/reviews/{review_oid} | Update a review
27
- [**upload_temporary_multimedia**](ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
28
-
29
-
30
- # **delete_digital_item**
31
- > delete_digital_item(digital_item_oid)
32
-
33
- Delete a digital item, which is a file within the digital library, not an actual merchant item
34
-
35
- Delete a digital item on the UltraCart account.
36
-
37
- ### Example
38
- ```ruby
39
- # load the gem
40
- require 'ultracart_api'
41
-
42
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
43
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
44
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
45
-
46
-
47
- digital_item_oid = 56 # Integer | The digital item oid to delete.
48
-
49
-
50
- begin
51
- #Delete a digital item, which is a file within the digital library, not an actual merchant item
52
- api_instance.delete_digital_item(digital_item_oid)
53
- rescue UltracartClient::ApiError => e
54
- puts "Exception when calling ItemApi->delete_digital_item: #{e}"
55
- end
56
- ```
57
-
58
- ### Parameters
59
-
60
- Name | Type | Description | Notes
61
- ------------- | ------------- | ------------- | -------------
62
- **digital_item_oid** | **Integer**| The digital item oid to delete. |
63
-
64
- ### Return type
65
-
66
- nil (empty response body)
67
-
68
- ### Authorization
69
-
70
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
71
-
72
- ### HTTP request headers
73
-
74
- - **Content-Type**: application/json
75
- - **Accept**: application/json
76
-
77
-
78
-
79
- # **delete_item**
80
- > delete_item(merchant_item_oid)
81
-
82
- Delete an item
83
-
84
- Delete an item on the UltraCart account.
85
-
86
- ### Example
87
- ```ruby
88
- # load the gem
89
- require 'ultracart_api'
90
-
91
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
92
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
93
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
94
-
95
-
96
- merchant_item_oid = 56 # Integer | The item oid to delete.
97
-
98
-
99
- begin
100
- #Delete an item
101
- api_instance.delete_item(merchant_item_oid)
102
- rescue UltracartClient::ApiError => e
103
- puts "Exception when calling ItemApi->delete_item: #{e}"
104
- end
105
- ```
106
-
107
- ### Parameters
108
-
109
- Name | Type | Description | Notes
110
- ------------- | ------------- | ------------- | -------------
111
- **merchant_item_oid** | **Integer**| The item oid to delete. |
112
-
113
- ### Return type
114
-
115
- nil (empty response body)
116
-
117
- ### Authorization
118
-
119
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
120
-
121
- ### HTTP request headers
122
-
123
- - **Content-Type**: application/json
124
- - **Accept**: application/json
125
-
126
-
127
-
128
- # **delete_review**
129
- > delete_review(review_oid, merchant_item_oid)
130
-
131
- Delete a review
132
-
133
- Delete an item review.
134
-
135
- ### Example
136
- ```ruby
137
- # load the gem
138
- require 'ultracart_api'
139
-
140
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
141
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
142
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
143
-
144
-
145
- review_oid = 56 # Integer | The review oid to delete.
146
-
147
- merchant_item_oid = 56 # Integer | The item oid the review is associated with.
148
-
149
-
150
- begin
151
- #Delete a review
152
- api_instance.delete_review(review_oid, merchant_item_oid)
153
- rescue UltracartClient::ApiError => e
154
- puts "Exception when calling ItemApi->delete_review: #{e}"
155
- end
156
- ```
157
-
158
- ### Parameters
159
-
160
- Name | Type | Description | Notes
161
- ------------- | ------------- | ------------- | -------------
162
- **review_oid** | **Integer**| The review oid to delete. |
163
- **merchant_item_oid** | **Integer**| The item oid the review is associated with. |
164
-
165
- ### Return type
166
-
167
- nil (empty response body)
168
-
169
- ### Authorization
170
-
171
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
172
-
173
- ### HTTP request headers
174
-
175
- - **Content-Type**: application/json; charset=UTF-8
176
- - **Accept**: application/json
177
-
178
-
179
-
180
- # **get_digital_item**
181
- > ItemDigitalItemResponse get_digital_item(digital_item_oid)
182
-
183
- Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
184
-
185
- Retrieves a digital item (file information) from the account. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.
186
-
187
- ### Example
188
- ```ruby
189
- # load the gem
190
- require 'ultracart_api'
191
-
192
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
193
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
194
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
195
-
196
-
197
- digital_item_oid = 56 # Integer | The digital item oid to retrieve.
198
-
199
-
200
- begin
201
- #Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
202
- result = api_instance.get_digital_item(digital_item_oid)
203
- p result
204
- rescue UltracartClient::ApiError => e
205
- puts "Exception when calling ItemApi->get_digital_item: #{e}"
206
- end
207
- ```
208
-
209
- ### Parameters
210
-
211
- Name | Type | Description | Notes
212
- ------------- | ------------- | ------------- | -------------
213
- **digital_item_oid** | **Integer**| The digital item oid to retrieve. |
214
-
215
- ### Return type
216
-
217
- [**ItemDigitalItemResponse**](ItemDigitalItemResponse.md)
218
-
219
- ### Authorization
220
-
221
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
222
-
223
- ### HTTP request headers
224
-
225
- - **Content-Type**: application/json
226
- - **Accept**: application/json
227
-
228
-
229
-
230
- # **get_digital_items**
231
- > ItemDigitalItemsResponse get_digital_items(opts)
232
-
233
- Retrieve digital items from the digital library which are digital files that may be attached to normal items
234
-
235
- Retrieves a group of digital items (file information) from the account. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
236
-
237
- ### Example
238
- ```ruby
239
- # load the gem
240
- require 'ultracart_api'
241
-
242
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
243
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
244
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
245
-
246
-
247
- opts = {
248
- _limit: 100, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 2000)
249
- _offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
250
- _since: '_since_example', # String | Fetch items that have been created/modified since this date/time.
251
- _sort: '_sort_example', # String | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
252
- _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
253
- _placeholders: true # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
254
- }
255
-
256
- begin
257
- #Retrieve digital items from the digital library which are digital files that may be attached to normal items
258
- result = api_instance.get_digital_items(opts)
259
- p result
260
- rescue UltracartClient::ApiError => e
261
- puts "Exception when calling ItemApi->get_digital_items: #{e}"
262
- end
263
- ```
264
-
265
- ### Parameters
266
-
267
- Name | Type | Description | Notes
268
- ------------- | ------------- | ------------- | -------------
269
- **_limit** | **Integer**| The maximum number of records to return on this one API call. (Default 100, Max 2000) | [optional] [default to 100]
270
- **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
271
- **_since** | **String**| Fetch items that have been created/modified since this date/time. | [optional]
272
- **_sort** | **String**| The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
273
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
274
- **_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
275
-
276
- ### Return type
277
-
278
- [**ItemDigitalItemsResponse**](ItemDigitalItemsResponse.md)
279
-
280
- ### Authorization
281
-
282
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
283
-
284
- ### HTTP request headers
285
-
286
- - **Content-Type**: application/json
287
- - **Accept**: application/json
288
-
289
-
290
-
291
- # **get_digital_items_by_external_id**
292
- > ItemDigitalItemsResponse get_digital_items_by_external_id(external_id)
293
-
294
- Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
295
-
296
- Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.
297
-
298
- ### Example
299
- ```ruby
300
- # load the gem
301
- require 'ultracart_api'
302
-
303
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
304
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
305
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
306
-
307
-
308
- external_id = 'external_id_example' # String | The external id to match against.
309
-
310
-
311
- begin
312
- #Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
313
- result = api_instance.get_digital_items_by_external_id(external_id)
314
- p result
315
- rescue UltracartClient::ApiError => e
316
- puts "Exception when calling ItemApi->get_digital_items_by_external_id: #{e}"
317
- end
318
- ```
319
-
320
- ### Parameters
321
-
322
- Name | Type | Description | Notes
323
- ------------- | ------------- | ------------- | -------------
324
- **external_id** | **String**| The external id to match against. |
325
-
326
- ### Return type
327
-
328
- [**ItemDigitalItemsResponse**](ItemDigitalItemsResponse.md)
329
-
330
- ### Authorization
331
-
332
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
333
-
334
- ### HTTP request headers
335
-
336
- - **Content-Type**: application/json
337
- - **Accept**: application/json
338
-
339
-
340
-
341
- # **get_item**
342
- > ItemResponse get_item(merchant_item_oid, opts)
343
-
344
- Retrieve an item
345
-
346
- Retrieves a single item using the specified item oid.
347
-
348
- ### Example
349
- ```ruby
350
- # load the gem
351
- require 'ultracart_api'
352
-
353
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
354
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
355
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
356
-
357
-
358
- merchant_item_oid = 56 # Integer | The item oid to retrieve.
359
-
360
- opts = {
361
- _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
362
- _placeholders: true # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
363
- }
364
-
365
- begin
366
- #Retrieve an item
367
- result = api_instance.get_item(merchant_item_oid, opts)
368
- p result
369
- rescue UltracartClient::ApiError => e
370
- puts "Exception when calling ItemApi->get_item: #{e}"
371
- end
372
- ```
373
-
374
- ### Parameters
375
-
376
- Name | Type | Description | Notes
377
- ------------- | ------------- | ------------- | -------------
378
- **merchant_item_oid** | **Integer**| The item oid to retrieve. |
379
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
380
- **_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
381
-
382
- ### Return type
383
-
384
- [**ItemResponse**](ItemResponse.md)
385
-
386
- ### Authorization
387
-
388
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
389
-
390
- ### HTTP request headers
391
-
392
- - **Content-Type**: application/json
393
- - **Accept**: application/json
394
-
395
-
396
-
397
- # **get_item_by_merchant_item_id**
398
- > ItemResponse get_item_by_merchant_item_id(merchant_item_id, opts)
399
-
400
- Retrieve an item by item id
401
-
402
- Retrieves a single item using the specified item id.
403
-
404
- ### Example
405
- ```ruby
406
- # load the gem
407
- require 'ultracart_api'
408
-
409
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
410
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
411
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
412
-
413
-
414
- merchant_item_id = 'merchant_item_id_example' # String | The item id to retrieve.
415
-
416
- opts = {
417
- _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
418
- _placeholders: true # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
419
- }
420
-
421
- begin
422
- #Retrieve an item by item id
423
- result = api_instance.get_item_by_merchant_item_id(merchant_item_id, opts)
424
- p result
425
- rescue UltracartClient::ApiError => e
426
- puts "Exception when calling ItemApi->get_item_by_merchant_item_id: #{e}"
427
- end
428
- ```
429
-
430
- ### Parameters
431
-
432
- Name | Type | Description | Notes
433
- ------------- | ------------- | ------------- | -------------
434
- **merchant_item_id** | **String**| The item id to retrieve. |
435
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
436
- **_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
437
-
438
- ### Return type
439
-
440
- [**ItemResponse**](ItemResponse.md)
441
-
442
- ### Authorization
443
-
444
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
445
-
446
- ### HTTP request headers
447
-
448
- - **Content-Type**: application/json
449
- - **Accept**: application/json
450
-
451
-
452
-
453
- # **get_items**
454
- > ItemsResponse get_items(opts)
455
-
456
- Retrieve items
457
-
458
- Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
459
-
460
- ### Example
461
- ```ruby
462
- # load the gem
463
- require 'ultracart_api'
464
-
465
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
466
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
467
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
468
-
469
-
470
- opts = {
471
- parent_category_id: 56, # Integer | The parent category object id to retrieve items for. Unspecified means all items on the account. 0 = root
472
- parent_category_path: 'parent_category_path_example', # String | The parent category path to retrieve items for. Unspecified means all items on the account. / = root
473
- _limit: 100, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 2000)
474
- _offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
475
- _since: '_since_example', # String | Fetch items that have been created/modified since this date/time.
476
- _sort: '_sort_example', # String | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
477
- _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
478
- _placeholders: true # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
479
- }
480
-
481
- begin
482
- #Retrieve items
483
- result = api_instance.get_items(opts)
484
- p result
485
- rescue UltracartClient::ApiError => e
486
- puts "Exception when calling ItemApi->get_items: #{e}"
487
- end
488
- ```
489
-
490
- ### Parameters
491
-
492
- Name | Type | Description | Notes
493
- ------------- | ------------- | ------------- | -------------
494
- **parent_category_id** | **Integer**| The parent category object id to retrieve items for. Unspecified means all items on the account. 0 = root | [optional]
495
- **parent_category_path** | **String**| The parent category path to retrieve items for. Unspecified means all items on the account. / = root | [optional]
496
- **_limit** | **Integer**| The maximum number of records to return on this one API call. (Default 100, Max 2000) | [optional] [default to 100]
497
- **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
498
- **_since** | **String**| Fetch items that have been created/modified since this date/time. | [optional]
499
- **_sort** | **String**| The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
500
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
501
- **_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
502
-
503
- ### Return type
504
-
505
- [**ItemsResponse**](ItemsResponse.md)
506
-
507
- ### Authorization
508
-
509
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
510
-
511
- ### HTTP request headers
512
-
513
- - **Content-Type**: application/json
514
- - **Accept**: application/json
515
-
516
-
517
-
518
- # **get_pricing_tiers**
519
- > PricingTiersResponse get_pricing_tiers(opts)
520
-
521
- Retrieve pricing tiers
522
-
523
- Retrieves the pricing tiers
524
-
525
- ### Example
526
- ```ruby
527
- # load the gem
528
- require 'ultracart_api'
529
-
530
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
531
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
532
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
533
-
534
-
535
- opts = {
536
- _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
537
- }
538
-
539
- begin
540
- #Retrieve pricing tiers
541
- result = api_instance.get_pricing_tiers(opts)
542
- p result
543
- rescue UltracartClient::ApiError => e
544
- puts "Exception when calling ItemApi->get_pricing_tiers: #{e}"
545
- end
546
- ```
547
-
548
- ### Parameters
549
-
550
- Name | Type | Description | Notes
551
- ------------- | ------------- | ------------- | -------------
552
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
553
-
554
- ### Return type
555
-
556
- [**PricingTiersResponse**](PricingTiersResponse.md)
557
-
558
- ### Authorization
559
-
560
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
561
-
562
- ### HTTP request headers
563
-
564
- - **Content-Type**: application/json
565
- - **Accept**: application/json
566
-
567
-
568
-
569
- # **get_review**
570
- > ItemReviewResponse get_review(review_oid, merchant_item_oid)
571
-
572
- Get a review
573
-
574
- Retrieve an item review.
575
-
576
- ### Example
577
- ```ruby
578
- # load the gem
579
- require 'ultracart_api'
580
-
581
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
582
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
583
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
584
-
585
-
586
- review_oid = 56 # Integer | The review oid to retrieve.
587
-
588
- merchant_item_oid = 56 # Integer | The item oid the review is associated with.
589
-
590
-
591
- begin
592
- #Get a review
593
- result = api_instance.get_review(review_oid, merchant_item_oid)
594
- p result
595
- rescue UltracartClient::ApiError => e
596
- puts "Exception when calling ItemApi->get_review: #{e}"
597
- end
598
- ```
599
-
600
- ### Parameters
601
-
602
- Name | Type | Description | Notes
603
- ------------- | ------------- | ------------- | -------------
604
- **review_oid** | **Integer**| The review oid to retrieve. |
605
- **merchant_item_oid** | **Integer**| The item oid the review is associated with. |
606
-
607
- ### Return type
608
-
609
- [**ItemReviewResponse**](ItemReviewResponse.md)
610
-
611
- ### Authorization
612
-
613
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
614
-
615
- ### HTTP request headers
616
-
617
- - **Content-Type**: application/json; charset=UTF-8
618
- - **Accept**: application/json
619
-
620
-
621
-
622
- # **get_reviews**
623
- > ItemReviewsResponse get_reviews(merchant_item_oid)
624
-
625
- Get reviews for an item
626
-
627
- Retrieve item reviews.
628
-
629
- ### Example
630
- ```ruby
631
- # load the gem
632
- require 'ultracart_api'
633
-
634
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
635
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
636
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
637
-
638
-
639
- merchant_item_oid = 56 # Integer | The item oid the review is associated with.
640
-
641
-
642
- begin
643
- #Get reviews for an item
644
- result = api_instance.get_reviews(merchant_item_oid)
645
- p result
646
- rescue UltracartClient::ApiError => e
647
- puts "Exception when calling ItemApi->get_reviews: #{e}"
648
- end
649
- ```
650
-
651
- ### Parameters
652
-
653
- Name | Type | Description | Notes
654
- ------------- | ------------- | ------------- | -------------
655
- **merchant_item_oid** | **Integer**| The item oid the review is associated with. |
656
-
657
- ### Return type
658
-
659
- [**ItemReviewsResponse**](ItemReviewsResponse.md)
660
-
661
- ### Authorization
662
-
663
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
664
-
665
- ### HTTP request headers
666
-
667
- - **Content-Type**: application/json; charset=UTF-8
668
- - **Accept**: application/json
669
-
670
-
671
-
672
- # **get_unassociated_digital_items**
673
- > ItemDigitalItemsResponse get_unassociated_digital_items(opts)
674
-
675
- Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
676
-
677
- Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
678
-
679
- ### Example
680
- ```ruby
681
- # load the gem
682
- require 'ultracart_api'
683
-
684
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
685
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
686
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
687
-
688
-
689
- opts = {
690
- _limit: 100, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 2000)
691
- _offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
692
- _since: '_since_example', # String | Fetch items that have been created/modified since this date/time.
693
- _sort: '_sort_example', # String | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
694
- _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
695
- _placeholders: true # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
696
- }
697
-
698
- begin
699
- #Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
700
- result = api_instance.get_unassociated_digital_items(opts)
701
- p result
702
- rescue UltracartClient::ApiError => e
703
- puts "Exception when calling ItemApi->get_unassociated_digital_items: #{e}"
704
- end
705
- ```
706
-
707
- ### Parameters
708
-
709
- Name | Type | Description | Notes
710
- ------------- | ------------- | ------------- | -------------
711
- **_limit** | **Integer**| The maximum number of records to return on this one API call. (Default 100, Max 2000) | [optional] [default to 100]
712
- **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
713
- **_since** | **String**| Fetch items that have been created/modified since this date/time. | [optional]
714
- **_sort** | **String**| The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
715
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
716
- **_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
717
-
718
- ### Return type
719
-
720
- [**ItemDigitalItemsResponse**](ItemDigitalItemsResponse.md)
721
-
722
- ### Authorization
723
-
724
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
725
-
726
- ### HTTP request headers
727
-
728
- - **Content-Type**: application/json
729
- - **Accept**: application/json
730
-
731
-
732
-
733
- # **insert_digital_item**
734
- > ItemDigitalItemResponse insert_digital_item(digital_item)
735
-
736
- Create a file within the digital library
737
-
738
- Create a file within the digital library. This does not create an item, but makes this digital file available and selectable as part (or all) of an item.
739
-
740
- ### Example
741
- ```ruby
742
- # load the gem
743
- require 'ultracart_api'
744
-
745
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
746
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
747
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
748
-
749
-
750
- digital_item = UltracartClient::ItemDigitalItem.new # ItemDigitalItem | Digital item to create
751
-
752
-
753
- begin
754
- #Create a file within the digital library
755
- result = api_instance.insert_digital_item(digital_item)
756
- p result
757
- rescue UltracartClient::ApiError => e
758
- puts "Exception when calling ItemApi->insert_digital_item: #{e}"
759
- end
760
- ```
761
-
762
- ### Parameters
763
-
764
- Name | Type | Description | Notes
765
- ------------- | ------------- | ------------- | -------------
766
- **digital_item** | [**ItemDigitalItem**](ItemDigitalItem.md)| Digital item to create |
767
-
768
- ### Return type
769
-
770
- [**ItemDigitalItemResponse**](ItemDigitalItemResponse.md)
771
-
772
- ### Authorization
773
-
774
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
775
-
776
- ### HTTP request headers
777
-
778
- - **Content-Type**: application/json; charset=UTF-8
779
- - **Accept**: application/json
780
-
781
-
782
-
783
- # **insert_item**
784
- > ItemResponse insert_item(item, opts)
785
-
786
- Create an item
787
-
788
- Create a new item on the UltraCart account.
789
-
790
- ### Example
791
- ```ruby
792
- # load the gem
793
- require 'ultracart_api'
794
-
795
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
796
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
797
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
798
-
799
-
800
- item = UltracartClient::Item.new # Item | Item to create
801
-
802
- opts = {
803
- _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
804
- _placeholders: true # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
805
- }
806
-
807
- begin
808
- #Create an item
809
- result = api_instance.insert_item(item, opts)
810
- p result
811
- rescue UltracartClient::ApiError => e
812
- puts "Exception when calling ItemApi->insert_item: #{e}"
813
- end
814
- ```
815
-
816
- ### Parameters
817
-
818
- Name | Type | Description | Notes
819
- ------------- | ------------- | ------------- | -------------
820
- **item** | [**Item**](Item.md)| Item to create |
821
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
822
- **_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
823
-
824
- ### Return type
825
-
826
- [**ItemResponse**](ItemResponse.md)
827
-
828
- ### Authorization
829
-
830
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
831
-
832
- ### HTTP request headers
833
-
834
- - **Content-Type**: application/json; charset=UTF-8
835
- - **Accept**: application/json
836
-
837
-
838
-
839
- # **insert_review**
840
- > ItemReviewResponse insert_review(review, merchant_item_oid)
841
-
842
- Insert a review
843
-
844
- Insert a item review.
845
-
846
- ### Example
847
- ```ruby
848
- # load the gem
849
- require 'ultracart_api'
850
-
851
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
852
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
853
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
854
-
855
-
856
- review = UltracartClient::ItemReview.new # ItemReview | Review to insert
857
-
858
- merchant_item_oid = 56 # Integer | The item oid the review is associated with.
859
-
860
-
861
- begin
862
- #Insert a review
863
- result = api_instance.insert_review(review, merchant_item_oid)
864
- p result
865
- rescue UltracartClient::ApiError => e
866
- puts "Exception when calling ItemApi->insert_review: #{e}"
867
- end
868
- ```
869
-
870
- ### Parameters
871
-
872
- Name | Type | Description | Notes
873
- ------------- | ------------- | ------------- | -------------
874
- **review** | [**ItemReview**](ItemReview.md)| Review to insert |
875
- **merchant_item_oid** | **Integer**| The item oid the review is associated with. |
876
-
877
- ### Return type
878
-
879
- [**ItemReviewResponse**](ItemReviewResponse.md)
880
-
881
- ### Authorization
882
-
883
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
884
-
885
- ### HTTP request headers
886
-
887
- - **Content-Type**: application/json; charset=UTF-8
888
- - **Accept**: application/json
889
-
890
-
891
-
892
- # **update_digital_item**
893
- > ItemDigitalItemResponse update_digital_item(digital_item_oid, digital_item)
894
-
895
- Updates a file within the digital library
896
-
897
- Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
898
-
899
- ### Example
900
- ```ruby
901
- # load the gem
902
- require 'ultracart_api'
903
-
904
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
905
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
906
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
907
-
908
-
909
- digital_item_oid = 56 # Integer | The digital item oid to update.
910
-
911
- digital_item = UltracartClient::ItemDigitalItem.new # ItemDigitalItem | Digital item to update
912
-
913
-
914
- begin
915
- #Updates a file within the digital library
916
- result = api_instance.update_digital_item(digital_item_oid, digital_item)
917
- p result
918
- rescue UltracartClient::ApiError => e
919
- puts "Exception when calling ItemApi->update_digital_item: #{e}"
920
- end
921
- ```
922
-
923
- ### Parameters
924
-
925
- Name | Type | Description | Notes
926
- ------------- | ------------- | ------------- | -------------
927
- **digital_item_oid** | **Integer**| The digital item oid to update. |
928
- **digital_item** | [**ItemDigitalItem**](ItemDigitalItem.md)| Digital item to update |
929
-
930
- ### Return type
931
-
932
- [**ItemDigitalItemResponse**](ItemDigitalItemResponse.md)
933
-
934
- ### Authorization
935
-
936
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
937
-
938
- ### HTTP request headers
939
-
940
- - **Content-Type**: application/json; charset=UTF-8
941
- - **Accept**: application/json
942
-
943
-
944
-
945
- # **update_item**
946
- > ItemResponse update_item(item, merchant_item_oid, opts)
947
-
948
- Update an item
949
-
950
- Update a new item on the UltraCart account.
951
-
952
- ### Example
953
- ```ruby
954
- # load the gem
955
- require 'ultracart_api'
956
-
957
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
958
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
959
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
960
-
961
-
962
- item = UltracartClient::Item.new # Item | Item to update
963
-
964
- merchant_item_oid = 56 # Integer | The item oid to update.
965
-
966
- opts = {
967
- _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
968
- _placeholders: true # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
969
- }
970
-
971
- begin
972
- #Update an item
973
- result = api_instance.update_item(item, merchant_item_oid, opts)
974
- p result
975
- rescue UltracartClient::ApiError => e
976
- puts "Exception when calling ItemApi->update_item: #{e}"
977
- end
978
- ```
979
-
980
- ### Parameters
981
-
982
- Name | Type | Description | Notes
983
- ------------- | ------------- | ------------- | -------------
984
- **item** | [**Item**](Item.md)| Item to update |
985
- **merchant_item_oid** | **Integer**| The item oid to update. |
986
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
987
- **_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
988
-
989
- ### Return type
990
-
991
- [**ItemResponse**](ItemResponse.md)
992
-
993
- ### Authorization
994
-
995
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
996
-
997
- ### HTTP request headers
998
-
999
- - **Content-Type**: application/json; charset=UTF-8
1000
- - **Accept**: application/json
1001
-
1002
-
1003
-
1004
- # **update_items**
1005
- > ItemsResponse update_items(items_request, opts)
1006
-
1007
- Update multiple items
1008
-
1009
- Update multiple item on the UltraCart account.
1010
-
1011
- ### Example
1012
- ```ruby
1013
- # load the gem
1014
- require 'ultracart_api'
1015
-
1016
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1017
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1018
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
1019
-
1020
-
1021
- items_request = UltracartClient::ItemsRequest.new # ItemsRequest | Items to update (synchronous maximum 20 / asynchronous maximum 100)
1022
-
1023
- opts = {
1024
- _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
1025
- _placeholders: true, # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
1026
- _async: true # BOOLEAN | True if the operation should be run async. No result returned
1027
- }
1028
-
1029
- begin
1030
- #Update multiple items
1031
- result = api_instance.update_items(items_request, opts)
1032
- p result
1033
- rescue UltracartClient::ApiError => e
1034
- puts "Exception when calling ItemApi->update_items: #{e}"
1035
- end
1036
- ```
1037
-
1038
- ### Parameters
1039
-
1040
- Name | Type | Description | Notes
1041
- ------------- | ------------- | ------------- | -------------
1042
- **items_request** | [**ItemsRequest**](ItemsRequest.md)| Items to update (synchronous maximum 20 / asynchronous maximum 100) |
1043
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
1044
- **_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
1045
- **_async** | **BOOLEAN**| True if the operation should be run async. No result returned | [optional]
1046
-
1047
- ### Return type
1048
-
1049
- [**ItemsResponse**](ItemsResponse.md)
1050
-
1051
- ### Authorization
1052
-
1053
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1054
-
1055
- ### HTTP request headers
1056
-
1057
- - **Content-Type**: application/json; charset=UTF-8
1058
- - **Accept**: application/json
1059
-
1060
-
1061
-
1062
- # **update_review**
1063
- > ItemReviewResponse update_review(review, review_oid, merchant_item_oid)
1064
-
1065
- Update a review
1066
-
1067
- Update an item review.
1068
-
1069
- ### Example
1070
- ```ruby
1071
- # load the gem
1072
- require 'ultracart_api'
1073
-
1074
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1075
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1076
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
1077
-
1078
-
1079
- review = UltracartClient::ItemReview.new # ItemReview | Review to update
1080
-
1081
- review_oid = 56 # Integer | The review oid to update.
1082
-
1083
- merchant_item_oid = 56 # Integer | The item oid the review is associated with.
1084
-
1085
-
1086
- begin
1087
- #Update a review
1088
- result = api_instance.update_review(review, review_oid, merchant_item_oid)
1089
- p result
1090
- rescue UltracartClient::ApiError => e
1091
- puts "Exception when calling ItemApi->update_review: #{e}"
1092
- end
1093
- ```
1094
-
1095
- ### Parameters
1096
-
1097
- Name | Type | Description | Notes
1098
- ------------- | ------------- | ------------- | -------------
1099
- **review** | [**ItemReview**](ItemReview.md)| Review to update |
1100
- **review_oid** | **Integer**| The review oid to update. |
1101
- **merchant_item_oid** | **Integer**| The item oid the review is associated with. |
1102
-
1103
- ### Return type
1104
-
1105
- [**ItemReviewResponse**](ItemReviewResponse.md)
1106
-
1107
- ### Authorization
1108
-
1109
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1110
-
1111
- ### HTTP request headers
1112
-
1113
- - **Content-Type**: application/json; charset=UTF-8
1114
- - **Accept**: application/json
1115
-
1116
-
1117
-
1118
- # **upload_temporary_multimedia**
1119
- > TempMultimediaResponse upload_temporary_multimedia(file)
1120
-
1121
- Upload an image to the temporary multimedia.
1122
-
1123
- Uploads an image and returns back meta information about the image as well as the identifier needed for the item update.
1124
-
1125
- ### Example
1126
- ```ruby
1127
- # load the gem
1128
- require 'ultracart_api'
1129
-
1130
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1131
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1132
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
1133
-
1134
-
1135
- file = File.new('/path/to/file.txt') # File | File to upload
1136
-
1137
-
1138
- begin
1139
- #Upload an image to the temporary multimedia.
1140
- result = api_instance.upload_temporary_multimedia(file)
1141
- p result
1142
- rescue UltracartClient::ApiError => e
1143
- puts "Exception when calling ItemApi->upload_temporary_multimedia: #{e}"
1144
- end
1145
- ```
1146
-
1147
- ### Parameters
1148
-
1149
- Name | Type | Description | Notes
1150
- ------------- | ------------- | ------------- | -------------
1151
- **file** | **File**| File to upload |
1152
-
1153
- ### Return type
1154
-
1155
- [**TempMultimediaResponse**](TempMultimediaResponse.md)
1156
-
1157
- ### Authorization
1158
-
1159
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1160
-
1161
- ### HTTP request headers
1162
-
1163
- - **Content-Type**: multipart/form-data
1164
- - **Accept**: application/json
1165
-
1166
-
1167
-
1
+ # UltracartClient::ItemApi
2
+
3
+ All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**delete_item**](ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item |
8
+ | [**get_item**](ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item |
9
+ | [**get_item_by_merchant_item_id**](ItemApi.md#get_item_by_merchant_item_id) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id |
10
+ | [**get_items**](ItemApi.md#get_items) | **GET** /item/items | Retrieve items |
11
+ | [**get_pricing_tiers**](ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers |
12
+ | [**insert_item**](ItemApi.md#insert_item) | **POST** /item/items | Create an item |
13
+ | [**update_item**](ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item |
14
+ | [**update_items**](ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items |
15
+ | [**upload_temporary_multimedia**](ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia. |
16
+
17
+
18
+ ## delete_item
19
+
20
+ > delete_item(merchant_item_oid)
21
+
22
+ Delete an item
23
+
24
+ Delete an item on the UltraCart account.
25
+
26
+ ### Examples
27
+
28
+ ```ruby
29
+ require 'time'
30
+ require 'ultracart_api'
31
+ # setup authorization
32
+ UltracartClient.configure do |config|
33
+ # Configure OAuth2 access token for authorization: ultraCartOauth
34
+ config.access_token = 'YOUR ACCESS TOKEN'
35
+
36
+ # Configure API key authorization: ultraCartSimpleApiKey
37
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
38
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
39
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
40
+ end
41
+
42
+ api_instance = UltracartClient::ItemApi.new
43
+ merchant_item_oid = 56 # Integer | The item oid to delete.
44
+
45
+ begin
46
+ # Delete an item
47
+ api_instance.delete_item(merchant_item_oid)
48
+ rescue UltracartClient::ApiError => e
49
+ puts "Error when calling ItemApi->delete_item: #{e}"
50
+ end
51
+ ```
52
+
53
+ #### Using the delete_item_with_http_info variant
54
+
55
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
56
+
57
+ > <Array(nil, Integer, Hash)> delete_item_with_http_info(merchant_item_oid)
58
+
59
+ ```ruby
60
+ begin
61
+ # Delete an item
62
+ data, status_code, headers = api_instance.delete_item_with_http_info(merchant_item_oid)
63
+ p status_code # => 2xx
64
+ p headers # => { ... }
65
+ p data # => nil
66
+ rescue UltracartClient::ApiError => e
67
+ puts "Error when calling ItemApi->delete_item_with_http_info: #{e}"
68
+ end
69
+ ```
70
+
71
+ ### Parameters
72
+
73
+ | Name | Type | Description | Notes |
74
+ | ---- | ---- | ----------- | ----- |
75
+ | **merchant_item_oid** | **Integer** | The item oid to delete. | |
76
+
77
+ ### Return type
78
+
79
+ nil (empty response body)
80
+
81
+ ### Authorization
82
+
83
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
84
+
85
+ ### HTTP request headers
86
+
87
+ - **Content-Type**: Not defined
88
+ - **Accept**: application/json
89
+
90
+
91
+ ## get_item
92
+
93
+ > <ItemResponse> get_item(merchant_item_oid, opts)
94
+
95
+ Retrieve an item
96
+
97
+ Retrieves a single item using the specified item oid.
98
+
99
+ ### Examples
100
+
101
+ ```ruby
102
+ require 'time'
103
+ require 'ultracart_api'
104
+ # setup authorization
105
+ UltracartClient.configure do |config|
106
+ # Configure OAuth2 access token for authorization: ultraCartOauth
107
+ config.access_token = 'YOUR ACCESS TOKEN'
108
+
109
+ # Configure API key authorization: ultraCartSimpleApiKey
110
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
111
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
112
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
113
+ end
114
+
115
+ api_instance = UltracartClient::ItemApi.new
116
+ merchant_item_oid = 56 # Integer | The item oid to retrieve.
117
+ opts = {
118
+ _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
119
+ _placeholders: true # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
120
+ }
121
+
122
+ begin
123
+ # Retrieve an item
124
+ result = api_instance.get_item(merchant_item_oid, opts)
125
+ p result
126
+ rescue UltracartClient::ApiError => e
127
+ puts "Error when calling ItemApi->get_item: #{e}"
128
+ end
129
+ ```
130
+
131
+ #### Using the get_item_with_http_info variant
132
+
133
+ This returns an Array which contains the response data, status code and headers.
134
+
135
+ > <Array(<ItemResponse>, Integer, Hash)> get_item_with_http_info(merchant_item_oid, opts)
136
+
137
+ ```ruby
138
+ begin
139
+ # Retrieve an item
140
+ data, status_code, headers = api_instance.get_item_with_http_info(merchant_item_oid, opts)
141
+ p status_code # => 2xx
142
+ p headers # => { ... }
143
+ p data # => <ItemResponse>
144
+ rescue UltracartClient::ApiError => e
145
+ puts "Error when calling ItemApi->get_item_with_http_info: #{e}"
146
+ end
147
+ ```
148
+
149
+ ### Parameters
150
+
151
+ | Name | Type | Description | Notes |
152
+ | ---- | ---- | ----------- | ----- |
153
+ | **merchant_item_oid** | **Integer** | The item oid to retrieve. | |
154
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
155
+ | **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional] |
156
+
157
+ ### Return type
158
+
159
+ [**ItemResponse**](ItemResponse.md)
160
+
161
+ ### Authorization
162
+
163
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
164
+
165
+ ### HTTP request headers
166
+
167
+ - **Content-Type**: Not defined
168
+ - **Accept**: application/json
169
+
170
+
171
+ ## get_item_by_merchant_item_id
172
+
173
+ > <ItemResponse> get_item_by_merchant_item_id(merchant_item_id, opts)
174
+
175
+ Retrieve an item by item id
176
+
177
+ Retrieves a single item using the specified item id.
178
+
179
+ ### Examples
180
+
181
+ ```ruby
182
+ require 'time'
183
+ require 'ultracart_api'
184
+ # setup authorization
185
+ UltracartClient.configure do |config|
186
+ # Configure OAuth2 access token for authorization: ultraCartOauth
187
+ config.access_token = 'YOUR ACCESS TOKEN'
188
+
189
+ # Configure API key authorization: ultraCartSimpleApiKey
190
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
191
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
192
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
193
+ end
194
+
195
+ api_instance = UltracartClient::ItemApi.new
196
+ merchant_item_id = 'merchant_item_id_example' # String | The item id to retrieve.
197
+ opts = {
198
+ _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
199
+ _placeholders: true # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
200
+ }
201
+
202
+ begin
203
+ # Retrieve an item by item id
204
+ result = api_instance.get_item_by_merchant_item_id(merchant_item_id, opts)
205
+ p result
206
+ rescue UltracartClient::ApiError => e
207
+ puts "Error when calling ItemApi->get_item_by_merchant_item_id: #{e}"
208
+ end
209
+ ```
210
+
211
+ #### Using the get_item_by_merchant_item_id_with_http_info variant
212
+
213
+ This returns an Array which contains the response data, status code and headers.
214
+
215
+ > <Array(<ItemResponse>, Integer, Hash)> get_item_by_merchant_item_id_with_http_info(merchant_item_id, opts)
216
+
217
+ ```ruby
218
+ begin
219
+ # Retrieve an item by item id
220
+ data, status_code, headers = api_instance.get_item_by_merchant_item_id_with_http_info(merchant_item_id, opts)
221
+ p status_code # => 2xx
222
+ p headers # => { ... }
223
+ p data # => <ItemResponse>
224
+ rescue UltracartClient::ApiError => e
225
+ puts "Error when calling ItemApi->get_item_by_merchant_item_id_with_http_info: #{e}"
226
+ end
227
+ ```
228
+
229
+ ### Parameters
230
+
231
+ | Name | Type | Description | Notes |
232
+ | ---- | ---- | ----------- | ----- |
233
+ | **merchant_item_id** | **String** | The item id to retrieve. | |
234
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
235
+ | **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional] |
236
+
237
+ ### Return type
238
+
239
+ [**ItemResponse**](ItemResponse.md)
240
+
241
+ ### Authorization
242
+
243
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
244
+
245
+ ### HTTP request headers
246
+
247
+ - **Content-Type**: Not defined
248
+ - **Accept**: application/json
249
+
250
+
251
+ ## get_items
252
+
253
+ > <ItemsResponse> get_items(opts)
254
+
255
+ Retrieve items
256
+
257
+ Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
258
+
259
+ ### Examples
260
+
261
+ ```ruby
262
+ require 'time'
263
+ require 'ultracart_api'
264
+ # setup authorization
265
+ UltracartClient.configure do |config|
266
+ # Configure OAuth2 access token for authorization: ultraCartOauth
267
+ config.access_token = 'YOUR ACCESS TOKEN'
268
+
269
+ # Configure API key authorization: ultraCartSimpleApiKey
270
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
271
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
272
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
273
+ end
274
+
275
+ api_instance = UltracartClient::ItemApi.new
276
+ opts = {
277
+ parent_category_id: 56, # Integer | The parent category object id to retrieve items for. Unspecified means all items on the account. 0 = root
278
+ parent_category_path: 'parent_category_path_example', # String | The parent category path to retrieve items for. Unspecified means all items on the account. / = root
279
+ _limit: 56, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 2000)
280
+ _offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
281
+ _since: '_since_example', # String | Fetch items that have been created/modified since this date/time.
282
+ _sort: '_sort_example', # String | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
283
+ _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
284
+ _placeholders: true # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
285
+ }
286
+
287
+ begin
288
+ # Retrieve items
289
+ result = api_instance.get_items(opts)
290
+ p result
291
+ rescue UltracartClient::ApiError => e
292
+ puts "Error when calling ItemApi->get_items: #{e}"
293
+ end
294
+ ```
295
+
296
+ #### Using the get_items_with_http_info variant
297
+
298
+ This returns an Array which contains the response data, status code and headers.
299
+
300
+ > <Array(<ItemsResponse>, Integer, Hash)> get_items_with_http_info(opts)
301
+
302
+ ```ruby
303
+ begin
304
+ # Retrieve items
305
+ data, status_code, headers = api_instance.get_items_with_http_info(opts)
306
+ p status_code # => 2xx
307
+ p headers # => { ... }
308
+ p data # => <ItemsResponse>
309
+ rescue UltracartClient::ApiError => e
310
+ puts "Error when calling ItemApi->get_items_with_http_info: #{e}"
311
+ end
312
+ ```
313
+
314
+ ### Parameters
315
+
316
+ | Name | Type | Description | Notes |
317
+ | ---- | ---- | ----------- | ----- |
318
+ | **parent_category_id** | **Integer** | The parent category object id to retrieve items for. Unspecified means all items on the account. 0 &#x3D; root | [optional] |
319
+ | **parent_category_path** | **String** | The parent category path to retrieve items for. Unspecified means all items on the account. / &#x3D; root | [optional] |
320
+ | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Default 100, Max 2000) | [optional][default to 100] |
321
+ | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
322
+ | **_since** | **String** | Fetch items that have been created/modified since this date/time. | [optional] |
323
+ | **_sort** | **String** | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
324
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
325
+ | **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional] |
326
+
327
+ ### Return type
328
+
329
+ [**ItemsResponse**](ItemsResponse.md)
330
+
331
+ ### Authorization
332
+
333
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
334
+
335
+ ### HTTP request headers
336
+
337
+ - **Content-Type**: Not defined
338
+ - **Accept**: application/json
339
+
340
+
341
+ ## get_pricing_tiers
342
+
343
+ > <PricingTiersResponse> get_pricing_tiers(opts)
344
+
345
+ Retrieve pricing tiers
346
+
347
+ Retrieves the pricing tiers
348
+
349
+ ### Examples
350
+
351
+ ```ruby
352
+ require 'time'
353
+ require 'ultracart_api'
354
+ # setup authorization
355
+ UltracartClient.configure do |config|
356
+ # Configure OAuth2 access token for authorization: ultraCartOauth
357
+ config.access_token = 'YOUR ACCESS TOKEN'
358
+
359
+ # Configure API key authorization: ultraCartSimpleApiKey
360
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
361
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
362
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
363
+ end
364
+
365
+ api_instance = UltracartClient::ItemApi.new
366
+ opts = {
367
+ _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
368
+ }
369
+
370
+ begin
371
+ # Retrieve pricing tiers
372
+ result = api_instance.get_pricing_tiers(opts)
373
+ p result
374
+ rescue UltracartClient::ApiError => e
375
+ puts "Error when calling ItemApi->get_pricing_tiers: #{e}"
376
+ end
377
+ ```
378
+
379
+ #### Using the get_pricing_tiers_with_http_info variant
380
+
381
+ This returns an Array which contains the response data, status code and headers.
382
+
383
+ > <Array(<PricingTiersResponse>, Integer, Hash)> get_pricing_tiers_with_http_info(opts)
384
+
385
+ ```ruby
386
+ begin
387
+ # Retrieve pricing tiers
388
+ data, status_code, headers = api_instance.get_pricing_tiers_with_http_info(opts)
389
+ p status_code # => 2xx
390
+ p headers # => { ... }
391
+ p data # => <PricingTiersResponse>
392
+ rescue UltracartClient::ApiError => e
393
+ puts "Error when calling ItemApi->get_pricing_tiers_with_http_info: #{e}"
394
+ end
395
+ ```
396
+
397
+ ### Parameters
398
+
399
+ | Name | Type | Description | Notes |
400
+ | ---- | ---- | ----------- | ----- |
401
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
402
+
403
+ ### Return type
404
+
405
+ [**PricingTiersResponse**](PricingTiersResponse.md)
406
+
407
+ ### Authorization
408
+
409
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
410
+
411
+ ### HTTP request headers
412
+
413
+ - **Content-Type**: Not defined
414
+ - **Accept**: application/json
415
+
416
+
417
+ ## insert_item
418
+
419
+ > <ItemResponse> insert_item(item, opts)
420
+
421
+ Create an item
422
+
423
+ Create a new item on the UltraCart account.
424
+
425
+ ### Examples
426
+
427
+ ```ruby
428
+ require 'time'
429
+ require 'ultracart_api'
430
+ # setup authorization
431
+ UltracartClient.configure do |config|
432
+ # Configure OAuth2 access token for authorization: ultraCartOauth
433
+ config.access_token = 'YOUR ACCESS TOKEN'
434
+
435
+ # Configure API key authorization: ultraCartSimpleApiKey
436
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
437
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
438
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
439
+ end
440
+
441
+ api_instance = UltracartClient::ItemApi.new
442
+ item = UltracartClient::Item.new # Item | Item to create
443
+ opts = {
444
+ _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
445
+ _placeholders: true # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
446
+ }
447
+
448
+ begin
449
+ # Create an item
450
+ result = api_instance.insert_item(item, opts)
451
+ p result
452
+ rescue UltracartClient::ApiError => e
453
+ puts "Error when calling ItemApi->insert_item: #{e}"
454
+ end
455
+ ```
456
+
457
+ #### Using the insert_item_with_http_info variant
458
+
459
+ This returns an Array which contains the response data, status code and headers.
460
+
461
+ > <Array(<ItemResponse>, Integer, Hash)> insert_item_with_http_info(item, opts)
462
+
463
+ ```ruby
464
+ begin
465
+ # Create an item
466
+ data, status_code, headers = api_instance.insert_item_with_http_info(item, opts)
467
+ p status_code # => 2xx
468
+ p headers # => { ... }
469
+ p data # => <ItemResponse>
470
+ rescue UltracartClient::ApiError => e
471
+ puts "Error when calling ItemApi->insert_item_with_http_info: #{e}"
472
+ end
473
+ ```
474
+
475
+ ### Parameters
476
+
477
+ | Name | Type | Description | Notes |
478
+ | ---- | ---- | ----------- | ----- |
479
+ | **item** | [**Item**](Item.md) | Item to create | |
480
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
481
+ | **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional] |
482
+
483
+ ### Return type
484
+
485
+ [**ItemResponse**](ItemResponse.md)
486
+
487
+ ### Authorization
488
+
489
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
490
+
491
+ ### HTTP request headers
492
+
493
+ - **Content-Type**: application/json; charset=UTF-8
494
+ - **Accept**: application/json
495
+
496
+
497
+ ## update_item
498
+
499
+ > <ItemResponse> update_item(merchant_item_oid, item, opts)
500
+
501
+ Update an item
502
+
503
+ Update a new item on the UltraCart account.
504
+
505
+ ### Examples
506
+
507
+ ```ruby
508
+ require 'time'
509
+ require 'ultracart_api'
510
+ # setup authorization
511
+ UltracartClient.configure do |config|
512
+ # Configure OAuth2 access token for authorization: ultraCartOauth
513
+ config.access_token = 'YOUR ACCESS TOKEN'
514
+
515
+ # Configure API key authorization: ultraCartSimpleApiKey
516
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
517
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
518
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
519
+ end
520
+
521
+ api_instance = UltracartClient::ItemApi.new
522
+ merchant_item_oid = 56 # Integer | The item oid to update.
523
+ item = UltracartClient::Item.new # Item | Item to update
524
+ opts = {
525
+ _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
526
+ _placeholders: true # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
527
+ }
528
+
529
+ begin
530
+ # Update an item
531
+ result = api_instance.update_item(merchant_item_oid, item, opts)
532
+ p result
533
+ rescue UltracartClient::ApiError => e
534
+ puts "Error when calling ItemApi->update_item: #{e}"
535
+ end
536
+ ```
537
+
538
+ #### Using the update_item_with_http_info variant
539
+
540
+ This returns an Array which contains the response data, status code and headers.
541
+
542
+ > <Array(<ItemResponse>, Integer, Hash)> update_item_with_http_info(merchant_item_oid, item, opts)
543
+
544
+ ```ruby
545
+ begin
546
+ # Update an item
547
+ data, status_code, headers = api_instance.update_item_with_http_info(merchant_item_oid, item, opts)
548
+ p status_code # => 2xx
549
+ p headers # => { ... }
550
+ p data # => <ItemResponse>
551
+ rescue UltracartClient::ApiError => e
552
+ puts "Error when calling ItemApi->update_item_with_http_info: #{e}"
553
+ end
554
+ ```
555
+
556
+ ### Parameters
557
+
558
+ | Name | Type | Description | Notes |
559
+ | ---- | ---- | ----------- | ----- |
560
+ | **merchant_item_oid** | **Integer** | The item oid to update. | |
561
+ | **item** | [**Item**](Item.md) | Item to update | |
562
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
563
+ | **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional] |
564
+
565
+ ### Return type
566
+
567
+ [**ItemResponse**](ItemResponse.md)
568
+
569
+ ### Authorization
570
+
571
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
572
+
573
+ ### HTTP request headers
574
+
575
+ - **Content-Type**: application/json; charset=UTF-8
576
+ - **Accept**: application/json
577
+
578
+
579
+ ## update_items
580
+
581
+ > <ItemsResponse> update_items(items_request, opts)
582
+
583
+ Update multiple items
584
+
585
+ Update multiple item on the UltraCart account.
586
+
587
+ ### Examples
588
+
589
+ ```ruby
590
+ require 'time'
591
+ require 'ultracart_api'
592
+ # setup authorization
593
+ UltracartClient.configure do |config|
594
+ # Configure OAuth2 access token for authorization: ultraCartOauth
595
+ config.access_token = 'YOUR ACCESS TOKEN'
596
+
597
+ # Configure API key authorization: ultraCartSimpleApiKey
598
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
599
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
600
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
601
+ end
602
+
603
+ api_instance = UltracartClient::ItemApi.new
604
+ items_request = UltracartClient::ItemsRequest.new # ItemsRequest | Items to update (synchronous maximum 20 / asynchronous maximum 100)
605
+ opts = {
606
+ _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
607
+ _placeholders: true, # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
608
+ _async: true # Boolean | True if the operation should be run async. No result returned
609
+ }
610
+
611
+ begin
612
+ # Update multiple items
613
+ result = api_instance.update_items(items_request, opts)
614
+ p result
615
+ rescue UltracartClient::ApiError => e
616
+ puts "Error when calling ItemApi->update_items: #{e}"
617
+ end
618
+ ```
619
+
620
+ #### Using the update_items_with_http_info variant
621
+
622
+ This returns an Array which contains the response data, status code and headers.
623
+
624
+ > <Array(<ItemsResponse>, Integer, Hash)> update_items_with_http_info(items_request, opts)
625
+
626
+ ```ruby
627
+ begin
628
+ # Update multiple items
629
+ data, status_code, headers = api_instance.update_items_with_http_info(items_request, opts)
630
+ p status_code # => 2xx
631
+ p headers # => { ... }
632
+ p data # => <ItemsResponse>
633
+ rescue UltracartClient::ApiError => e
634
+ puts "Error when calling ItemApi->update_items_with_http_info: #{e}"
635
+ end
636
+ ```
637
+
638
+ ### Parameters
639
+
640
+ | Name | Type | Description | Notes |
641
+ | ---- | ---- | ----------- | ----- |
642
+ | **items_request** | [**ItemsRequest**](ItemsRequest.md) | Items to update (synchronous maximum 20 / asynchronous maximum 100) | |
643
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
644
+ | **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional] |
645
+ | **_async** | **Boolean** | True if the operation should be run async. No result returned | [optional] |
646
+
647
+ ### Return type
648
+
649
+ [**ItemsResponse**](ItemsResponse.md)
650
+
651
+ ### Authorization
652
+
653
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
654
+
655
+ ### HTTP request headers
656
+
657
+ - **Content-Type**: application/json; charset=UTF-8
658
+ - **Accept**: application/json
659
+
660
+
661
+ ## upload_temporary_multimedia
662
+
663
+ > <TempMultimediaResponse> upload_temporary_multimedia(file)
664
+
665
+ Upload an image to the temporary multimedia.
666
+
667
+ Uploads an image and returns back meta information about the image as well as the identifier needed for the item update.
668
+
669
+ ### Examples
670
+
671
+ ```ruby
672
+ require 'time'
673
+ require 'ultracart_api'
674
+ # setup authorization
675
+ UltracartClient.configure do |config|
676
+ # Configure OAuth2 access token for authorization: ultraCartOauth
677
+ config.access_token = 'YOUR ACCESS TOKEN'
678
+
679
+ # Configure API key authorization: ultraCartSimpleApiKey
680
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
681
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
682
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
683
+ end
684
+
685
+ api_instance = UltracartClient::ItemApi.new
686
+ file = File.new('/path/to/some/file') # File | File to upload
687
+
688
+ begin
689
+ # Upload an image to the temporary multimedia.
690
+ result = api_instance.upload_temporary_multimedia(file)
691
+ p result
692
+ rescue UltracartClient::ApiError => e
693
+ puts "Error when calling ItemApi->upload_temporary_multimedia: #{e}"
694
+ end
695
+ ```
696
+
697
+ #### Using the upload_temporary_multimedia_with_http_info variant
698
+
699
+ This returns an Array which contains the response data, status code and headers.
700
+
701
+ > <Array(<TempMultimediaResponse>, Integer, Hash)> upload_temporary_multimedia_with_http_info(file)
702
+
703
+ ```ruby
704
+ begin
705
+ # Upload an image to the temporary multimedia.
706
+ data, status_code, headers = api_instance.upload_temporary_multimedia_with_http_info(file)
707
+ p status_code # => 2xx
708
+ p headers # => { ... }
709
+ p data # => <TempMultimediaResponse>
710
+ rescue UltracartClient::ApiError => e
711
+ puts "Error when calling ItemApi->upload_temporary_multimedia_with_http_info: #{e}"
712
+ end
713
+ ```
714
+
715
+ ### Parameters
716
+
717
+ | Name | Type | Description | Notes |
718
+ | ---- | ---- | ----------- | ----- |
719
+ | **file** | **File** | File to upload | |
720
+
721
+ ### Return type
722
+
723
+ [**TempMultimediaResponse**](TempMultimediaResponse.md)
724
+
725
+ ### Authorization
726
+
727
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
728
+
729
+ ### HTTP request headers
730
+
731
+ - **Content-Type**: multipart/form-data
732
+ - **Accept**: application/json
733
+