ultracart_api 3.11.10 → 4.0.32.rc

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1779) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -7
  3. data/README.md +1166 -1743
  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 -34
  28. data/docs/AutoOrderApi.md +693 -675
  29. data/docs/AutoOrderItem.md +64 -35
  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 -25
  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 -15
  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 -11
  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 -27
  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 -811
  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 -100
  109. data/docs/ChannelPartnerOrderItem.md +30 -15
  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 -12
  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 -10
  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 -14
  148. data/docs/CouponDiscountItems.md +24 -11
  149. data/docs/CouponEditorValues.md +36 -18
  150. data/docs/CouponExistsResponse.md +28 -13
  151. data/docs/CouponFreeItemAndShippingWithSubtotal.md +26 -12
  152. data/docs/CouponFreeItemWithItemPurchase.md +24 -13
  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 -14
  164. data/docs/CouponPercentOffItems.md +24 -13
  165. data/docs/CouponPercentOffItemsAndFreeShipping.md +22 -12
  166. data/docs/CouponPercentOffItemsWithItemsPurchase.md +24 -13
  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 -11
  184. data/docs/CouponTieredAmountOffSubtotal.md +20 -9
  185. data/docs/CouponTieredPercentOffItems.md +22 -11
  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 -71
  193. data/docs/CustomerActivity.md +24 -15
  194. data/docs/CustomerAffiliate.md +24 -11
  195. data/docs/CustomerApi.md +1380 -1347
  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 -37
  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 -41
  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 -1266
  374. data/docs/ItemAutoOrder.md +50 -29
  375. data/docs/ItemAutoOrderStep.md +46 -24
  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 -23
  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 -13
  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 -56
  428. data/docs/ItemShippingCase.md +24 -11
  429. data/docs/ItemShippingDestinationMarkup.md +28 -14
  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 -46
  470. data/docs/OrderAffiliate.md +22 -10
  471. data/docs/OrderAffiliateLedger.md +34 -16
  472. data/docs/OrderApi.md +1856 -1593
  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 -73
  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 -27
  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 -13
  511. data/docs/OrderQuery.md +94 -50
  512. data/docs/OrderQueryBatch.md +18 -9
  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 -33
  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 -41
  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 -10
  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 -9377
  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 -16
  628. data/docs/TwilioResponse.md +28 -13
  629. data/docs/TwiliosResponse.md +26 -12
  630. data/docs/UltraCartConfig.md +18 -10
  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 -463
  644. data/docs/WebhookEventCategory.md +26 -12
  645. data/docs/WebhookEventSubscription.md +34 -17
  646. data/docs/WebhookLog.md +38 -19
  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 -0
  652. data/docs/WebhookSampleRequestResponse.md +26 -0
  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 -770
  658. data/lib/ultracart_api/api/channel_partner_api.rb +370 -920
  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 -1523
  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 -1412
  667. data/lib/ultracart_api/api/oauth_api.rb +198 -171
  668. data/lib/ultracart_api/api/order_api.rb +1728 -1785
  669. data/lib/ultracart_api/api/sso_api.rb +289 -243
  670. data/lib/ultracart_api/api/storefront_api.rb +11407 -10583
  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 -538
  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 -485
  699. data/lib/ultracart_api/models/auto_order_item.rb +487 -492
  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 -550
  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 -249
  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 -217
  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 -356
  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 -1723
  778. data/lib/ultracart_api/models/channel_partner_order_item.rb +331 -308
  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 -244
  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 -209
  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 -264
  814. data/lib/ultracart_api/models/coupon_discount_items.rb +267 -232
  815. data/lib/ultracart_api/models/coupon_editor_values.rb +330 -307
  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 -243
  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 -253
  830. data/lib/ultracart_api/models/coupon_percent_off_items.rb +254 -243
  831. data/lib/ultracart_api/models/coupon_percent_off_items_and_free_shipping.rb +244 -233
  832. data/lib/ultracart_api/models/coupon_percent_off_items_with_items_purchase.rb +254 -243
  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 -221
  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 -221
  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 -994
  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 -766
  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 -507
  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 -398
  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 -356
  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 -239
  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 -688
  1089. data/lib/ultracart_api/models/item_shipping_case.rb +265 -230
  1090. data/lib/ultracart_api/models/item_shipping_destination_markup.rb +315 -290
  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 -622
  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 -1028
  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 -415
  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 -280
  1170. data/lib/ultracart_api/models/order_query.rb +826 -843
  1171. data/lib/ultracart_api/models/order_query_batch.rb +222 -231
  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 -411
  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 -528
  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 -205
  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 -258
  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 -205
  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 -275
  1300. data/lib/ultracart_api/models/webhook_log.rb +324 -299
  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/{conversation_pbx_audio_usage_response.rb → webhook_sample_request.rb} +252 -245
  1306. data/lib/ultracart_api/models/{customer_wish_list_items_response.rb → webhook_sample_request_response.rb} +256 -223
  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 -920
  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 +9 -631
  1316. data/docs/AccountsReceivableRetryTransactionReject.md +0 -9
  1317. data/docs/AutoOrderAddonItem.md +0 -13
  1318. data/docs/AutoOrderAddonItemOption.md +0 -9
  1319. data/docs/AutoOrderConsolidate.md +0 -8
  1320. data/docs/AutoOrderManagement.md +0 -8
  1321. data/docs/CartItemProperty.md +0 -11
  1322. data/docs/CartPaymentHealthBenefitCard.md +0 -13
  1323. data/docs/ChanelPartnerReasonCodesResponse.md +0 -18
  1324. data/docs/ChannelPartner.md +0 -15
  1325. data/docs/ChannelPartnerOrderItemProperty.md +0 -11
  1326. data/docs/ChannelPartnerShipToPreference.md +0 -14
  1327. data/docs/ChannelPartnerShipToPreferenceResponse.md +0 -12
  1328. data/docs/ChannelPartnerShipToPreferencesResponse.md +0 -12
  1329. data/docs/ChannelPartnersResponse.md +0 -12
  1330. data/docs/Conversation.md +0 -26
  1331. data/docs/ConversationAgentAuth.md +0 -22
  1332. data/docs/ConversationAgentAuthResponse.md +0 -12
  1333. data/docs/ConversationAgentProfile.md +0 -19
  1334. data/docs/ConversationAgentProfileResponse.md +0 -12
  1335. data/docs/ConversationAgentProfilesResponse.md +0 -12
  1336. data/docs/ConversationApi.md +0 -4245
  1337. data/docs/ConversationAutocompleteRequest.md +0 -9
  1338. data/docs/ConversationAutocompleteResponse.md +0 -14
  1339. data/docs/ConversationAutocompleteValue.md +0 -9
  1340. data/docs/ConversationCannedMessage.md +0 -11
  1341. data/docs/ConversationCannedMessageResponse.md +0 -12
  1342. data/docs/ConversationCannedMessagesResponse.md +0 -12
  1343. data/docs/ConversationCannedMessagesSearch.md +0 -9
  1344. data/docs/ConversationDepartment.md +0 -12
  1345. data/docs/ConversationDepartmentMember.md +0 -10
  1346. data/docs/ConversationDepartmentMembersResponse.md +0 -12
  1347. data/docs/ConversationDepartmentResponse.md +0 -12
  1348. data/docs/ConversationDepartmentSettings.md +0 -7
  1349. data/docs/ConversationDepartmentsResponse.md +0 -12
  1350. data/docs/ConversationEngagement.md +0 -16
  1351. data/docs/ConversationEngagementEquation.md +0 -8
  1352. data/docs/ConversationEngagementEquationFunction.md +0 -21
  1353. data/docs/ConversationEngagementEquationGroup.md +0 -8
  1354. data/docs/ConversationEngagementResponse.md +0 -12
  1355. data/docs/ConversationEngagementsResponse.md +0 -12
  1356. data/docs/ConversationEventAddCoupon.md +0 -10
  1357. data/docs/ConversationEventAddItem.md +0 -10
  1358. data/docs/ConversationEventQueuePosition.md +0 -9
  1359. data/docs/ConversationEventRRWeb.md +0 -14
  1360. data/docs/ConversationEventReadMessage.md +0 -10
  1361. data/docs/ConversationEventTyping.md +0 -10
  1362. data/docs/ConversationEventWebchatContext.md +0 -10
  1363. data/docs/ConversationJoinRequest.md +0 -8
  1364. data/docs/ConversationLocationCountry.md +0 -10
  1365. data/docs/ConversationLocationStateProvince.md +0 -9
  1366. data/docs/ConversationLocationsResponse.md +0 -12
  1367. data/docs/ConversationMessage.md +0 -22
  1368. data/docs/ConversationMessageTranslation.md +0 -9
  1369. data/docs/ConversationMessageTransportStatus.md +0 -9
  1370. data/docs/ConversationMessagesResponse.md +0 -12
  1371. data/docs/ConversationMultimediaUploadUrl.md +0 -9
  1372. data/docs/ConversationMultimediaUploadUrlResponse.md +0 -12
  1373. data/docs/ConversationParticipant.md +0 -20
  1374. data/docs/ConversationPbxAgent.md +0 -23
  1375. data/docs/ConversationPbxAgentResponse.md +0 -12
  1376. data/docs/ConversationPbxAgentsResponse.md +0 -12
  1377. data/docs/ConversationPbxAudio.md +0 -17
  1378. data/docs/ConversationPbxAudioResponse.md +0 -12
  1379. data/docs/ConversationPbxAudioUploadUrl.md +0 -9
  1380. data/docs/ConversationPbxAudioUploadUrlResponse.md +0 -12
  1381. data/docs/ConversationPbxAudioUsageResponse.md +0 -14
  1382. data/docs/ConversationPbxAudiosResponse.md +0 -12
  1383. data/docs/ConversationPbxCustomerSnapshotRequest.md +0 -15
  1384. data/docs/ConversationPbxCustomerSnapshotResponse.md +0 -14
  1385. data/docs/ConversationPbxMenu.md +0 -18
  1386. data/docs/ConversationPbxMenuMapping.md +0 -11
  1387. data/docs/ConversationPbxMenuResponse.md +0 -12
  1388. data/docs/ConversationPbxMenusResponse.md +0 -12
  1389. data/docs/ConversationPbxPhoneNumber.md +0 -12
  1390. data/docs/ConversationPbxPhoneNumberResponse.md +0 -12
  1391. data/docs/ConversationPbxPhoneNumbersResponse.md +0 -12
  1392. data/docs/ConversationPbxQueue.md +0 -28
  1393. data/docs/ConversationPbxQueueMembers.md +0 -9
  1394. data/docs/ConversationPbxQueueResponse.md +0 -12
  1395. data/docs/ConversationPbxQueuesResponse.md +0 -12
  1396. data/docs/ConversationPbxTimeBased.md +0 -11
  1397. data/docs/ConversationPbxTimeBasedMapping.md +0 -11
  1398. data/docs/ConversationPbxTimeBasedMappingConfig.md +0 -9
  1399. data/docs/ConversationPbxTimeBasedResponse.md +0 -12
  1400. data/docs/ConversationPbxTimeBasedsResponse.md +0 -12
  1401. data/docs/ConversationPbxTimeRange.md +0 -12
  1402. data/docs/ConversationPbxTimeRangeConfig.md +0 -13
  1403. data/docs/ConversationPbxTimeRangeResponse.md +0 -12
  1404. data/docs/ConversationPbxTimeRangesResponse.md +0 -12
  1405. data/docs/ConversationPbxVoicemailMailbox.md +0 -19
  1406. data/docs/ConversationPbxVoicemailMailboxResponse.md +0 -12
  1407. data/docs/ConversationPbxVoicemailMailboxesResponse.md +0 -12
  1408. data/docs/ConversationPbxVoicemailMessage.md +0 -20
  1409. data/docs/ConversationPbxVoicemailMessageResponse.md +0 -12
  1410. data/docs/ConversationPbxVoicemailMessageSummariesResponse.md +0 -12
  1411. data/docs/ConversationPbxVoicemailMessageSummary.md +0 -17
  1412. data/docs/ConversationPermissions.md +0 -8
  1413. data/docs/ConversationPermissionsResponse.md +0 -12
  1414. data/docs/ConversationResponse.md +0 -12
  1415. data/docs/ConversationSearchRequest.md +0 -19
  1416. data/docs/ConversationSearchResponse.md +0 -11
  1417. data/docs/ConversationSentiment.md +0 -13
  1418. data/docs/ConversationStartRequest.md +0 -10
  1419. data/docs/ConversationStartResponse.md +0 -8
  1420. data/docs/ConversationSummary.md +0 -24
  1421. data/docs/ConversationTwilioAccount.md +0 -9
  1422. data/docs/ConversationWebchatContext.md +0 -15
  1423. data/docs/ConversationWebchatQueueStatus.md +0 -22
  1424. data/docs/ConversationWebchatQueueStatusAgent.md +0 -13
  1425. data/docs/ConversationWebchatQueueStatusQueueEntry.md +0 -15
  1426. data/docs/ConversationWebchatQueueStatusUpdateRequest.md +0 -8
  1427. data/docs/ConversationWebchatQueueStatusesResponse.md +0 -12
  1428. data/docs/ConversationWebsocketMessage.md +0 -31
  1429. data/docs/ConversationsResponse.md +0 -12
  1430. data/docs/CouponFreeItemWithItemPurchaseAndFreeShipping.md +0 -11
  1431. data/docs/CouponMoreLoyaltyCashback.md +0 -8
  1432. data/docs/CouponMoreLoyaltyPoints.md +0 -8
  1433. data/docs/CouponNoDiscount.md +0 -8
  1434. data/docs/CouponPercentMoreLoyaltyCashback.md +0 -8
  1435. data/docs/CouponPercentMoreLoyaltyPoints.md +0 -8
  1436. data/docs/CouponTieredPercentOffSubtotalBasedOnMSRP.md +0 -9
  1437. data/docs/CustomerEDI.md +0 -10
  1438. data/docs/CustomerMagicLinkResponse.md +0 -12
  1439. data/docs/CustomerMergeRequest.md +0 -9
  1440. data/docs/CustomerProperty.md +0 -11
  1441. data/docs/CustomerWishListItem.md +0 -14
  1442. data/docs/CustomerWishListItemResponse.md +0 -12
  1443. data/docs/CustomerWishListItemsResponse.md +0 -12
  1444. data/docs/DatawarehouseApi.md +0 -512
  1445. data/docs/EmailCommseqSequenceTestRequest.md +0 -22
  1446. data/docs/EmailCommseqSequenceTestResponse.md +0 -11
  1447. data/docs/EmailCommseqSmsSendTestRequest.md +0 -10
  1448. data/docs/EmailCommseqSmsSendTestResponse.md +0 -13
  1449. data/docs/EmailPostcardTracking.md +0 -32
  1450. data/docs/EmailPostcardTrackingResponse.md +0 -12
  1451. data/docs/EmailRateLimiter.md +0 -10
  1452. data/docs/EmailRateLimitersResponse.md +0 -12
  1453. data/docs/EmailSmsOrder.md +0 -11
  1454. data/docs/EmailSmsOrdersResponse.md +0 -12
  1455. data/docs/EmailSmsStat.md +0 -37
  1456. data/docs/EmailStatSmsSummaryRequest.md +0 -9
  1457. data/docs/EmailStatSmsSummaryResponse.md +0 -12
  1458. data/docs/FileManagerDirectory.md +0 -20
  1459. data/docs/FileManagerFile.md +0 -29
  1460. data/docs/FileManagerPage.md +0 -15
  1461. data/docs/FileManagerPageResponse.md +0 -12
  1462. data/docs/FileManagerUploadRequest.md +0 -10
  1463. data/docs/FileManagerUploadUrlResponse.md +0 -13
  1464. data/docs/HitPageView.md +0 -18
  1465. data/docs/HitPageViewMetaData.md +0 -9
  1466. data/docs/HitSessionStart.md +0 -24
  1467. data/docs/HitSessionUtm.md +0 -22
  1468. data/docs/ItemDigitalItemPdfMeta.md +0 -18
  1469. data/docs/ItemDigitalItemResponse.md +0 -12
  1470. data/docs/ItemDigitalItemsResponse.md +0 -12
  1471. data/docs/ItemInventorySnapshot.md +0 -13
  1472. data/docs/ItemInventorySnapshotDistributionCenter.md +0 -12
  1473. data/docs/ItemInventorySnapshotResponse.md +0 -12
  1474. data/docs/ItemReview.md +0 -45
  1475. data/docs/ItemReviewResponse.md +0 -12
  1476. data/docs/ItemReviewsResponse.md +0 -12
  1477. data/docs/OrderCurrentStageHistory.md +0 -10
  1478. data/docs/OrderEdiDocument.md +0 -21
  1479. data/docs/OrderEdiDocumentsResponse.md +0 -12
  1480. data/docs/OrderInvoiceResponse.md +0 -12
  1481. data/docs/OrderPaymentCreditCardDualVaulted.md +0 -10
  1482. data/docs/OrderPaymentCreditCardDualVaultedProperty.md +0 -9
  1483. data/docs/OrderPaymentHealthBenefitCard.md +0 -13
  1484. data/docs/OrderPaymentPayPal.md +0 -9
  1485. data/docs/OrderPointOfSale.md +0 -10
  1486. data/docs/OrderReason.md +0 -10
  1487. data/docs/OrderRefundableResponse.md +0 -20
  1488. data/docs/OrderTransactionalMerchantNote.md +0 -11
  1489. data/docs/OrderUtm.md +0 -39
  1490. data/docs/OrderValidationRequest.md +0 -9
  1491. data/docs/OrderValidationResponse.md +0 -10
  1492. data/docs/PointOfSaleLocation.md +0 -17
  1493. data/docs/PointOfSaleReader.md +0 -16
  1494. data/docs/PointOfSaleRegister.md +0 -11
  1495. data/docs/Report.md +0 -18
  1496. data/docs/ReportAuth.md +0 -11
  1497. data/docs/ReportAuthResponse.md +0 -12
  1498. data/docs/ReportDataSet.md +0 -24
  1499. data/docs/ReportDataSetColumn.md +0 -13
  1500. data/docs/ReportDataSetPage.md +0 -17
  1501. data/docs/ReportDataSetPageResponse.md +0 -12
  1502. data/docs/ReportDataSetQuery.md +0 -20
  1503. data/docs/ReportDataSetQueryOrderByColumn.md +0 -9
  1504. data/docs/ReportDataSetResponse.md +0 -12
  1505. data/docs/ReportDataSetRow.md +0 -8
  1506. data/docs/ReportDataSetSchema.md +0 -10
  1507. data/docs/ReportDataSource.md +0 -14
  1508. data/docs/ReportDataSourceSchema.md +0 -11
  1509. data/docs/ReportDryRunQueriesRequest.md +0 -13
  1510. data/docs/ReportDryRunQueriesResponse.md +0 -8
  1511. data/docs/ReportDryRunQueryResult.md +0 -9
  1512. data/docs/ReportExecuteQueriesRequest.md +0 -15
  1513. data/docs/ReportFilter.md +0 -13
  1514. data/docs/ReportFilterConnection.md +0 -10
  1515. data/docs/ReportPage.md +0 -13
  1516. data/docs/ReportPageFilter.md +0 -11
  1517. data/docs/ReportPageVisualization.md +0 -17
  1518. data/docs/ReportPageVisualizationDimension.md +0 -14
  1519. data/docs/ReportPageVisualizationMetric.md +0 -11
  1520. data/docs/ReportResponse.md +0 -12
  1521. data/docs/ReportWebsocketEvent.md +0 -9
  1522. data/docs/ReportsResponse.md +0 -12
  1523. data/docs/RulerValidationRequest.md +0 -8
  1524. data/docs/RulerValidationResponse.md +0 -9
  1525. data/docs/StoreFront.md +0 -18
  1526. data/docs/StoreFrontPageContentAttribute.md +0 -11
  1527. data/docs/StoreFrontsResponse.md +0 -12
  1528. data/docs/WebhookReflow.md +0 -9
  1529. data/docs/WebhookReflowResponse.md +0 -12
  1530. data/docs/WorkflowAgentAuth.md +0 -10
  1531. data/docs/WorkflowAgentAuthResponse.md +0 -12
  1532. data/docs/WorkflowApi.md +0 -620
  1533. data/docs/WorkflowAttachment.md +0 -12
  1534. data/docs/WorkflowAttachmentUploadUrl.md +0 -9
  1535. data/docs/WorkflowAttachmentUploadUrlResponse.md +0 -12
  1536. data/docs/WorkflowGroup.md +0 -9
  1537. data/docs/WorkflowGroupsResponse.md +0 -12
  1538. data/docs/WorkflowNote.md +0 -13
  1539. data/docs/WorkflowTask.md +0 -39
  1540. data/docs/WorkflowTaskHistory.md +0 -11
  1541. data/docs/WorkflowTaskOpenCountResponse.md +0 -12
  1542. data/docs/WorkflowTaskResponse.md +0 -12
  1543. data/docs/WorkflowTaskTagsResponse.md +0 -12
  1544. data/docs/WorkflowTasksRequest.md +0 -27
  1545. data/docs/WorkflowTasksResponse.md +0 -13
  1546. data/docs/WorkflowUser.md +0 -10
  1547. data/docs/WorkflowUserResponse.md +0 -12
  1548. data/docs/WorkflowUsersResponse.md +0 -13
  1549. data/lib/ultracart_api/api/conversation_api.rb +0 -4632
  1550. data/lib/ultracart_api/api/datawarehouse_api.rb +0 -584
  1551. data/lib/ultracart_api/api/workflow_api.rb +0 -693
  1552. data/lib/ultracart_api/models/accounts_receivable_retry_transaction_reject.rb +0 -195
  1553. data/lib/ultracart_api/models/auto_order_addon_item.rb +0 -232
  1554. data/lib/ultracart_api/models/auto_order_addon_item_option.rb +0 -225
  1555. data/lib/ultracart_api/models/auto_order_consolidate.rb +0 -186
  1556. data/lib/ultracart_api/models/auto_order_management.rb +0 -185
  1557. data/lib/ultracart_api/models/cart_item_property.rb +0 -245
  1558. data/lib/ultracart_api/models/cart_payment_health_benefit_card.rb +0 -235
  1559. data/lib/ultracart_api/models/chanel_partner_reason_codes_response.rb +0 -290
  1560. data/lib/ultracart_api/models/channel_partner.rb +0 -255
  1561. data/lib/ultracart_api/models/channel_partner_order_item_property.rb +0 -245
  1562. data/lib/ultracart_api/models/channel_partner_ship_to_preference.rb +0 -262
  1563. data/lib/ultracart_api/models/channel_partner_ship_to_preference_response.rb +0 -221
  1564. data/lib/ultracart_api/models/channel_partner_ship_to_preferences_response.rb +0 -224
  1565. data/lib/ultracart_api/models/channel_partners_response.rb +0 -224
  1566. data/lib/ultracart_api/models/conversation.rb +0 -390
  1567. data/lib/ultracart_api/models/conversation_agent_auth.rb +0 -316
  1568. data/lib/ultracart_api/models/conversation_agent_auth_response.rb +0 -221
  1569. data/lib/ultracart_api/models/conversation_agent_profile.rb +0 -329
  1570. data/lib/ultracart_api/models/conversation_agent_profile_response.rb +0 -221
  1571. data/lib/ultracart_api/models/conversation_agent_profiles_response.rb +0 -223
  1572. data/lib/ultracart_api/models/conversation_autocomplete_request.rb +0 -193
  1573. data/lib/ultracart_api/models/conversation_autocomplete_response.rb +0 -241
  1574. data/lib/ultracart_api/models/conversation_autocomplete_value.rb +0 -193
  1575. data/lib/ultracart_api/models/conversation_canned_message.rb +0 -213
  1576. data/lib/ultracart_api/models/conversation_canned_message_response.rb +0 -221
  1577. data/lib/ultracart_api/models/conversation_canned_messages_response.rb +0 -223
  1578. data/lib/ultracart_api/models/conversation_canned_messages_search.rb +0 -193
  1579. data/lib/ultracart_api/models/conversation_department.rb +0 -222
  1580. data/lib/ultracart_api/models/conversation_department_member.rb +0 -202
  1581. data/lib/ultracart_api/models/conversation_department_members_response.rb +0 -223
  1582. data/lib/ultracart_api/models/conversation_department_response.rb +0 -221
  1583. data/lib/ultracart_api/models/conversation_department_settings.rb +0 -175
  1584. data/lib/ultracart_api/models/conversation_departments_response.rb +0 -223
  1585. data/lib/ultracart_api/models/conversation_engagement.rb +0 -293
  1586. data/lib/ultracart_api/models/conversation_engagement_equation.rb +0 -186
  1587. data/lib/ultracart_api/models/conversation_engagement_equation_function.rb +0 -414
  1588. data/lib/ultracart_api/models/conversation_engagement_equation_group.rb +0 -186
  1589. data/lib/ultracart_api/models/conversation_engagement_response.rb +0 -221
  1590. data/lib/ultracart_api/models/conversation_engagements_response.rb +0 -223
  1591. data/lib/ultracart_api/models/conversation_event_add_coupon.rb +0 -202
  1592. data/lib/ultracart_api/models/conversation_event_add_item.rb +0 -204
  1593. data/lib/ultracart_api/models/conversation_event_queue_position.rb +0 -195
  1594. data/lib/ultracart_api/models/conversation_event_read_message.rb +0 -203
  1595. data/lib/ultracart_api/models/conversation_event_rr_web.rb +0 -273
  1596. data/lib/ultracart_api/models/conversation_event_typing.rb +0 -202
  1597. data/lib/ultracart_api/models/conversation_event_webchat_context.rb +0 -202
  1598. data/lib/ultracart_api/models/conversation_join_request.rb +0 -184
  1599. data/lib/ultracart_api/models/conversation_location_country.rb +0 -204
  1600. data/lib/ultracart_api/models/conversation_location_state_province.rb +0 -193
  1601. data/lib/ultracart_api/models/conversation_locations_response.rb +0 -223
  1602. data/lib/ultracart_api/models/conversation_message.rb +0 -356
  1603. data/lib/ultracart_api/models/conversation_message_translation.rb +0 -193
  1604. data/lib/ultracart_api/models/conversation_message_transport_status.rb +0 -228
  1605. data/lib/ultracart_api/models/conversation_messages_response.rb +0 -223
  1606. data/lib/ultracart_api/models/conversation_multimedia_upload_url.rb +0 -193
  1607. data/lib/ultracart_api/models/conversation_multimedia_upload_url_response.rb +0 -221
  1608. data/lib/ultracart_api/models/conversation_participant.rb +0 -295
  1609. data/lib/ultracart_api/models/conversation_pbx_agent.rb +0 -440
  1610. data/lib/ultracart_api/models/conversation_pbx_agent_response.rb +0 -221
  1611. data/lib/ultracart_api/models/conversation_pbx_agents_response.rb +0 -223
  1612. data/lib/ultracart_api/models/conversation_pbx_audio.rb +0 -365
  1613. data/lib/ultracart_api/models/conversation_pbx_audio_response.rb +0 -221
  1614. data/lib/ultracart_api/models/conversation_pbx_audio_upload_url.rb +0 -193
  1615. data/lib/ultracart_api/models/conversation_pbx_audio_upload_url_response.rb +0 -221
  1616. data/lib/ultracart_api/models/conversation_pbx_audios_response.rb +0 -223
  1617. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_request.rb +0 -248
  1618. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_response.rb +0 -245
  1619. data/lib/ultracart_api/models/conversation_pbx_menu.rb +0 -416
  1620. data/lib/ultracart_api/models/conversation_pbx_menu_mapping.rb +0 -269
  1621. data/lib/ultracart_api/models/conversation_pbx_menu_response.rb +0 -221
  1622. data/lib/ultracart_api/models/conversation_pbx_menus_response.rb +0 -223
  1623. data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +0 -324
  1624. data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +0 -221
  1625. data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +0 -223
  1626. data/lib/ultracart_api/models/conversation_pbx_queue.rb +0 -534
  1627. data/lib/ultracart_api/models/conversation_pbx_queue_members.rb +0 -197
  1628. data/lib/ultracart_api/models/conversation_pbx_queue_response.rb +0 -221
  1629. data/lib/ultracart_api/models/conversation_pbx_queues_response.rb +0 -223
  1630. data/lib/ultracart_api/models/conversation_pbx_time_based.rb +0 -211
  1631. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping.rb +0 -299
  1632. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping_config.rb +0 -196
  1633. data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +0 -221
  1634. data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +0 -223
  1635. data/lib/ultracart_api/models/conversation_pbx_time_range.rb +0 -287
  1636. data/lib/ultracart_api/models/conversation_pbx_time_range_config.rb +0 -235
  1637. data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +0 -221
  1638. data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +0 -223
  1639. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +0 -458
  1640. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +0 -221
  1641. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +0 -223
  1642. data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +0 -339
  1643. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +0 -221
  1644. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +0 -223
  1645. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +0 -309
  1646. data/lib/ultracart_api/models/conversation_permissions.rb +0 -184
  1647. data/lib/ultracart_api/models/conversation_permissions_response.rb +0 -221
  1648. data/lib/ultracart_api/models/conversation_response.rb +0 -221
  1649. data/lib/ultracart_api/models/conversation_search_request.rb +0 -285
  1650. data/lib/ultracart_api/models/conversation_search_response.rb +0 -213
  1651. data/lib/ultracart_api/models/conversation_sentiment.rb +0 -269
  1652. data/lib/ultracart_api/models/conversation_start_request.rb +0 -204
  1653. data/lib/ultracart_api/models/conversation_start_response.rb +0 -184
  1654. data/lib/ultracart_api/models/conversation_summary.rb +0 -369
  1655. data/lib/ultracart_api/models/conversation_twilio_account.rb +0 -195
  1656. data/lib/ultracart_api/models/conversation_webchat_context.rb +0 -254
  1657. data/lib/ultracart_api/models/conversation_webchat_queue_status.rb +0 -315
  1658. data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb +0 -266
  1659. data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +0 -248
  1660. data/lib/ultracart_api/models/conversation_webchat_queue_status_update_request.rb +0 -219
  1661. data/lib/ultracart_api/models/conversation_webchat_queue_statuses_response.rb +0 -223
  1662. data/lib/ultracart_api/models/conversation_websocket_message.rb +0 -441
  1663. data/lib/ultracart_api/models/conversations_response.rb +0 -223
  1664. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase_and_free_shipping.rb +0 -219
  1665. data/lib/ultracart_api/models/coupon_more_loyalty_cashback.rb +0 -185
  1666. data/lib/ultracart_api/models/coupon_more_loyalty_points.rb +0 -185
  1667. data/lib/ultracart_api/models/coupon_no_discount.rb +0 -185
  1668. data/lib/ultracart_api/models/coupon_percent_more_loyalty_cashback.rb +0 -185
  1669. data/lib/ultracart_api/models/coupon_percent_more_loyalty_points.rb +0 -185
  1670. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal_based_on_msrp.rb +0 -199
  1671. data/lib/ultracart_api/models/customer_edi.rb +0 -205
  1672. data/lib/ultracart_api/models/customer_magic_link_response.rb +0 -222
  1673. data/lib/ultracart_api/models/customer_merge_request.rb +0 -195
  1674. data/lib/ultracart_api/models/customer_property.rb +0 -245
  1675. data/lib/ultracart_api/models/customer_wish_list_item.rb +0 -260
  1676. data/lib/ultracart_api/models/customer_wish_list_item_response.rb +0 -221
  1677. data/lib/ultracart_api/models/email_commseq_sequence_test_request.rb +0 -312
  1678. data/lib/ultracart_api/models/email_commseq_sequence_test_response.rb +0 -212
  1679. data/lib/ultracart_api/models/email_commseq_sms_send_test_request.rb +0 -202
  1680. data/lib/ultracart_api/models/email_commseq_sms_send_test_response.rb +0 -232
  1681. data/lib/ultracart_api/models/email_postcard_tracking.rb +0 -404
  1682. data/lib/ultracart_api/models/email_postcard_tracking_response.rb +0 -221
  1683. data/lib/ultracart_api/models/email_rate_limiter.rb +0 -202
  1684. data/lib/ultracart_api/models/email_rate_limiters_response.rb +0 -223
  1685. data/lib/ultracart_api/models/email_sms_order.rb +0 -214
  1686. data/lib/ultracart_api/models/email_sms_orders_response.rb +0 -223
  1687. data/lib/ultracart_api/models/email_sms_stat.rb +0 -476
  1688. data/lib/ultracart_api/models/email_stat_sms_summary_request.rb +0 -195
  1689. data/lib/ultracart_api/models/email_stat_sms_summary_response.rb +0 -223
  1690. data/lib/ultracart_api/models/file_manager_directory.rb +0 -292
  1691. data/lib/ultracart_api/models/file_manager_file.rb +0 -376
  1692. data/lib/ultracart_api/models/file_manager_page.rb +0 -253
  1693. data/lib/ultracart_api/models/file_manager_page_response.rb +0 -221
  1694. data/lib/ultracart_api/models/file_manager_upload_request.rb +0 -202
  1695. data/lib/ultracart_api/models/file_manager_upload_url_response.rb +0 -230
  1696. data/lib/ultracart_api/models/hit_page_view.rb +0 -276
  1697. data/lib/ultracart_api/models/hit_page_view_meta_data.rb +0 -193
  1698. data/lib/ultracart_api/models/hit_session_start.rb +0 -328
  1699. data/lib/ultracart_api/models/hit_session_utm.rb +0 -310
  1700. data/lib/ultracart_api/models/item_digital_item_pdf_meta.rb +0 -315
  1701. data/lib/ultracart_api/models/item_digital_item_response.rb +0 -221
  1702. data/lib/ultracart_api/models/item_digital_items_response.rb +0 -224
  1703. data/lib/ultracart_api/models/item_inventory_snapshot.rb +0 -231
  1704. data/lib/ultracart_api/models/item_inventory_snapshot_distribution_center.rb +0 -220
  1705. data/lib/ultracart_api/models/item_inventory_snapshot_response.rb +0 -224
  1706. data/lib/ultracart_api/models/item_review.rb +0 -826
  1707. data/lib/ultracart_api/models/item_review_response.rb +0 -221
  1708. data/lib/ultracart_api/models/item_reviews_response.rb +0 -224
  1709. data/lib/ultracart_api/models/order_current_stage_history.rb +0 -251
  1710. data/lib/ultracart_api/models/order_edi_document.rb +0 -337
  1711. data/lib/ultracart_api/models/order_edi_documents_response.rb +0 -224
  1712. data/lib/ultracart_api/models/order_invoice_response.rb +0 -222
  1713. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted.rb +0 -204
  1714. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted_property.rb +0 -193
  1715. data/lib/ultracart_api/models/order_payment_health_benefit_card.rb +0 -235
  1716. data/lib/ultracart_api/models/order_payment_pay_pal.rb +0 -195
  1717. data/lib/ultracart_api/models/order_point_of_sale.rb +0 -202
  1718. data/lib/ultracart_api/models/order_reason.rb +0 -205
  1719. data/lib/ultracart_api/models/order_refundable_response.rb +0 -310
  1720. data/lib/ultracart_api/models/order_transactional_merchant_note.rb +0 -215
  1721. data/lib/ultracart_api/models/order_utm.rb +0 -464
  1722. data/lib/ultracart_api/models/order_validation_request.rb +0 -196
  1723. data/lib/ultracart_api/models/order_validation_response.rb +0 -209
  1724. data/lib/ultracart_api/models/point_of_sale_location.rb +0 -290
  1725. data/lib/ultracart_api/models/point_of_sale_reader.rb +0 -299
  1726. data/lib/ultracart_api/models/point_of_sale_register.rb +0 -215
  1727. data/lib/ultracart_api/models/report.rb +0 -317
  1728. data/lib/ultracart_api/models/report_auth.rb +0 -212
  1729. data/lib/ultracart_api/models/report_auth_response.rb +0 -221
  1730. data/lib/ultracart_api/models/report_data_set.rb +0 -381
  1731. data/lib/ultracart_api/models/report_data_set_column.rb +0 -229
  1732. data/lib/ultracart_api/models/report_data_set_page.rb +0 -273
  1733. data/lib/ultracart_api/models/report_data_set_page_response.rb +0 -221
  1734. data/lib/ultracart_api/models/report_data_set_query.rb +0 -342
  1735. data/lib/ultracart_api/models/report_data_set_query_order_by_column.rb +0 -193
  1736. data/lib/ultracart_api/models/report_data_set_response.rb +0 -221
  1737. data/lib/ultracart_api/models/report_data_set_row.rb +0 -186
  1738. data/lib/ultracart_api/models/report_data_set_schema.rb +0 -238
  1739. data/lib/ultracart_api/models/report_data_source.rb +0 -242
  1740. data/lib/ultracart_api/models/report_data_source_schema.rb +0 -248
  1741. data/lib/ultracart_api/models/report_dry_run_queries_request.rb +0 -231
  1742. data/lib/ultracart_api/models/report_dry_run_queries_response.rb +0 -186
  1743. data/lib/ultracart_api/models/report_dry_run_query_result.rb +0 -193
  1744. data/lib/ultracart_api/models/report_execute_queries_request.rb +0 -288
  1745. data/lib/ultracart_api/models/report_filter.rb +0 -272
  1746. data/lib/ultracart_api/models/report_filter_connection.rb +0 -203
  1747. data/lib/ultracart_api/models/report_page.rb +0 -237
  1748. data/lib/ultracart_api/models/report_page_filter.rb +0 -214
  1749. data/lib/ultracart_api/models/report_page_visualization.rb +0 -309
  1750. data/lib/ultracart_api/models/report_page_visualization_dimension.rb +0 -244
  1751. data/lib/ultracart_api/models/report_page_visualization_metric.rb +0 -248
  1752. data/lib/ultracart_api/models/report_response.rb +0 -221
  1753. data/lib/ultracart_api/models/report_websocket_event.rb +0 -228
  1754. data/lib/ultracart_api/models/reports_response.rb +0 -223
  1755. data/lib/ultracart_api/models/ruler_validation_request.rb +0 -184
  1756. data/lib/ultracart_api/models/ruler_validation_response.rb +0 -193
  1757. data/lib/ultracart_api/models/store_front.rb +0 -274
  1758. data/lib/ultracart_api/models/store_front_page_content_attribute.rb +0 -245
  1759. data/lib/ultracart_api/models/store_fronts_response.rb +0 -223
  1760. data/lib/ultracart_api/models/webhook_reflow.rb +0 -193
  1761. data/lib/ultracart_api/models/webhook_reflow_response.rb +0 -221
  1762. data/lib/ultracart_api/models/workflow_agent_auth.rb +0 -202
  1763. data/lib/ultracart_api/models/workflow_agent_auth_response.rb +0 -221
  1764. data/lib/ultracart_api/models/workflow_attachment.rb +0 -225
  1765. data/lib/ultracart_api/models/workflow_attachment_upload_url.rb +0 -193
  1766. data/lib/ultracart_api/models/workflow_attachment_upload_url_response.rb +0 -221
  1767. data/lib/ultracart_api/models/workflow_group.rb +0 -195
  1768. data/lib/ultracart_api/models/workflow_groups_response.rb +0 -224
  1769. data/lib/ultracart_api/models/workflow_note.rb +0 -236
  1770. data/lib/ultracart_api/models/workflow_task.rb +0 -574
  1771. data/lib/ultracart_api/models/workflow_task_history.rb +0 -214
  1772. data/lib/ultracart_api/models/workflow_task_open_count_response.rb +0 -222
  1773. data/lib/ultracart_api/models/workflow_task_response.rb +0 -221
  1774. data/lib/ultracart_api/models/workflow_task_tags_response.rb +0 -224
  1775. data/lib/ultracart_api/models/workflow_tasks_request.rb +0 -434
  1776. data/lib/ultracart_api/models/workflow_tasks_response.rb +0 -234
  1777. data/lib/ultracart_api/models/workflow_user.rb +0 -205
  1778. data/lib/ultracart_api/models/workflow_user_response.rb +0 -221
  1779. data/lib/ultracart_api/models/workflow_users_response.rb +0 -234
data/docs/WebhookApi.md CHANGED
@@ -1,463 +1,636 @@
1
- # UltracartClient::WebhookApi
2
-
3
- All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**delete_webhook**](WebhookApi.md#delete_webhook) | **DELETE** /webhook/webhooks/{webhookOid} | Delete a webhook
8
- [**delete_webhook_by_url**](WebhookApi.md#delete_webhook_by_url) | **DELETE** /webhook/webhooks | Delete a webhook by URL
9
- [**get_webhook_log**](WebhookApi.md#get_webhook_log) | **GET** /webhook/webhooks/{webhookOid}/logs/{requestId} | Retrieve an individual log
10
- [**get_webhook_log_summaries**](WebhookApi.md#get_webhook_log_summaries) | **GET** /webhook/webhooks/{webhookOid}/logs | Retrieve the log summaries
11
- [**get_webhooks**](WebhookApi.md#get_webhooks) | **GET** /webhook/webhooks | Retrieve webhooks
12
- [**insert_webhook**](WebhookApi.md#insert_webhook) | **POST** /webhook/webhooks | Add a webhook
13
- [**resend_event**](WebhookApi.md#resend_event) | **POST** /webhook/webhooks/{webhookOid}/reflow/{eventName} | Resend events to the webhook endpoint.
14
- [**update_webhook**](WebhookApi.md#update_webhook) | **PUT** /webhook/webhooks/{webhookOid} | Update a webhook
15
-
16
-
17
- # **delete_webhook**
18
- > delete_webhook(webhook_oid)
19
-
20
- Delete a webhook
21
-
22
- Delete a webhook on the UltraCart account.
23
-
24
- ### Example
25
- ```ruby
26
- # load the gem
27
- require 'ultracart_api'
28
-
29
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
30
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
31
- api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false)
32
-
33
-
34
- webhook_oid = 56 # Integer | The webhook oid to delete.
35
-
36
-
37
- begin
38
- #Delete a webhook
39
- api_instance.delete_webhook(webhook_oid)
40
- rescue UltracartClient::ApiError => e
41
- puts "Exception when calling WebhookApi->delete_webhook: #{e}"
42
- end
43
- ```
44
-
45
- ### Parameters
46
-
47
- Name | Type | Description | Notes
48
- ------------- | ------------- | ------------- | -------------
49
- **webhook_oid** | **Integer**| The webhook oid to delete. |
50
-
51
- ### Return type
52
-
53
- nil (empty response body)
54
-
55
- ### Authorization
56
-
57
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
58
-
59
- ### HTTP request headers
60
-
61
- - **Content-Type**: application/json
62
- - **Accept**: application/json
63
-
64
-
65
-
66
- # **delete_webhook_by_url**
67
- > WebhookResponse delete_webhook_by_url(webhook)
68
-
69
- Delete a webhook by URL
70
-
71
- Delete a webhook based upon the URL on the webhook_url matching an existing webhook.
72
-
73
- ### Example
74
- ```ruby
75
- # load the gem
76
- require 'ultracart_api'
77
-
78
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
79
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
80
- api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false)
81
-
82
-
83
- webhook = UltracartClient::Webhook.new # Webhook | Webhook to delete
84
-
85
-
86
- begin
87
- #Delete a webhook by URL
88
- result = api_instance.delete_webhook_by_url(webhook)
89
- p result
90
- rescue UltracartClient::ApiError => e
91
- puts "Exception when calling WebhookApi->delete_webhook_by_url: #{e}"
92
- end
93
- ```
94
-
95
- ### Parameters
96
-
97
- Name | Type | Description | Notes
98
- ------------- | ------------- | ------------- | -------------
99
- **webhook** | [**Webhook**](Webhook.md)| Webhook to delete |
100
-
101
- ### Return type
102
-
103
- [**WebhookResponse**](WebhookResponse.md)
104
-
105
- ### Authorization
106
-
107
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
108
-
109
- ### HTTP request headers
110
-
111
- - **Content-Type**: application/json; charset=UTF-8
112
- - **Accept**: application/json
113
-
114
-
115
-
116
- # **get_webhook_log**
117
- > WebhookLogResponse get_webhook_log(webhook_oid, request_id)
118
-
119
- Retrieve an individual log
120
-
121
- Retrieves an individual log for a webhook given the webhook oid the request id.
122
-
123
- ### Example
124
- ```ruby
125
- # load the gem
126
- require 'ultracart_api'
127
-
128
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
129
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
130
- api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false)
131
-
132
-
133
- webhook_oid = 56 # Integer | The webhook oid that owns the log.
134
-
135
- request_id = 'request_id_example' # String | The request id associated with the log to view.
136
-
137
-
138
- begin
139
- #Retrieve an individual log
140
- result = api_instance.get_webhook_log(webhook_oid, request_id)
141
- p result
142
- rescue UltracartClient::ApiError => e
143
- puts "Exception when calling WebhookApi->get_webhook_log: #{e}"
144
- end
145
- ```
146
-
147
- ### Parameters
148
-
149
- Name | Type | Description | Notes
150
- ------------- | ------------- | ------------- | -------------
151
- **webhook_oid** | **Integer**| The webhook oid that owns the log. |
152
- **request_id** | **String**| The request id associated with the log to view. |
153
-
154
- ### Return type
155
-
156
- [**WebhookLogResponse**](WebhookLogResponse.md)
157
-
158
- ### Authorization
159
-
160
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
161
-
162
- ### HTTP request headers
163
-
164
- - **Content-Type**: application/json
165
- - **Accept**: application/json
166
-
167
-
168
-
169
- # **get_webhook_log_summaries**
170
- > WebhookLogSummariesResponse get_webhook_log_summaries(webhook_oid, opts)
171
-
172
- Retrieve the log summaries
173
-
174
- Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.
175
-
176
- ### Example
177
- ```ruby
178
- # load the gem
179
- require 'ultracart_api'
180
-
181
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
182
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
183
- api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false)
184
-
185
-
186
- webhook_oid = 56 # Integer | The webhook oid to retrieve log summaries for.
187
-
188
- opts = {
189
- request_id: 'request_id_example', # String |
190
- begin_date: 'begin_date_example', # String |
191
- end_date: 'end_date_example', # String |
192
- status: 'status_example', # String |
193
- event: 'event_example', # String |
194
- order_id: 'order_id_example', # String |
195
- request: 'request_example', # String |
196
- duration: 56, # Integer |
197
- _limit: 100, # Integer | The maximum number of records to return on this one API call.
198
- _offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
199
- _since: '_since_example' # String | Fetch log summaries that have been delivered since this date/time.
200
- }
201
-
202
- begin
203
- #Retrieve the log summaries
204
- result = api_instance.get_webhook_log_summaries(webhook_oid, opts)
205
- p result
206
- rescue UltracartClient::ApiError => e
207
- puts "Exception when calling WebhookApi->get_webhook_log_summaries: #{e}"
208
- end
209
- ```
210
-
211
- ### Parameters
212
-
213
- Name | Type | Description | Notes
214
- ------------- | ------------- | ------------- | -------------
215
- **webhook_oid** | **Integer**| The webhook oid to retrieve log summaries for. |
216
- **request_id** | **String**| | [optional]
217
- **begin_date** | **String**| | [optional]
218
- **end_date** | **String**| | [optional]
219
- **status** | **String**| | [optional]
220
- **event** | **String**| | [optional]
221
- **order_id** | **String**| | [optional]
222
- **request** | **String**| | [optional]
223
- **duration** | **Integer**| | [optional]
224
- **_limit** | **Integer**| The maximum number of records to return on this one API call. | [optional] [default to 100]
225
- **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
226
- **_since** | **String**| Fetch log summaries that have been delivered since this date/time. | [optional]
227
-
228
- ### Return type
229
-
230
- [**WebhookLogSummariesResponse**](WebhookLogSummariesResponse.md)
231
-
232
- ### Authorization
233
-
234
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
235
-
236
- ### HTTP request headers
237
-
238
- - **Content-Type**: application/json
239
- - **Accept**: application/json
240
-
241
-
242
-
243
- # **get_webhooks**
244
- > WebhooksResponse get_webhooks(opts)
245
-
246
- Retrieve webhooks
247
-
248
- Retrieves the webhooks associated with this application.
249
-
250
- ### Example
251
- ```ruby
252
- # load the gem
253
- require 'ultracart_api'
254
-
255
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
256
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
257
- api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false)
258
-
259
-
260
- opts = {
261
- _limit: 100, # Integer | The maximum number of records to return on this one API call.
262
- _offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
263
- _sort: '_sort_example', # String | The sort order of the webhooks. See documentation for examples
264
- _placeholders: true # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
265
- }
266
-
267
- begin
268
- #Retrieve webhooks
269
- result = api_instance.get_webhooks(opts)
270
- p result
271
- rescue UltracartClient::ApiError => e
272
- puts "Exception when calling WebhookApi->get_webhooks: #{e}"
273
- end
274
- ```
275
-
276
- ### Parameters
277
-
278
- Name | Type | Description | Notes
279
- ------------- | ------------- | ------------- | -------------
280
- **_limit** | **Integer**| The maximum number of records to return on this one API call. | [optional] [default to 100]
281
- **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
282
- **_sort** | **String**| The sort order of the webhooks. See documentation for examples | [optional]
283
- **_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
284
-
285
- ### Return type
286
-
287
- [**WebhooksResponse**](WebhooksResponse.md)
288
-
289
- ### Authorization
290
-
291
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
292
-
293
- ### HTTP request headers
294
-
295
- - **Content-Type**: application/json
296
- - **Accept**: application/json
297
-
298
-
299
-
300
- # **insert_webhook**
301
- > WebhookResponse insert_webhook(webhook, opts)
302
-
303
- Add a webhook
304
-
305
- Adds a new webhook on the account. If you add a new webhook with the authentication_type set to basic, but do not specify the basic_username and basic_password, UltraCart will automatically generate random ones and return them. This allows your application to have simpler logic on the setup of a secure webhook.
306
-
307
- ### Example
308
- ```ruby
309
- # load the gem
310
- require 'ultracart_api'
311
-
312
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
313
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
314
- api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false)
315
-
316
-
317
- webhook = UltracartClient::Webhook.new # Webhook | Webhook to create
318
-
319
- opts = {
320
- _placeholders: true # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
321
- }
322
-
323
- begin
324
- #Add a webhook
325
- result = api_instance.insert_webhook(webhook, opts)
326
- p result
327
- rescue UltracartClient::ApiError => e
328
- puts "Exception when calling WebhookApi->insert_webhook: #{e}"
329
- end
330
- ```
331
-
332
- ### Parameters
333
-
334
- Name | Type | Description | Notes
335
- ------------- | ------------- | ------------- | -------------
336
- **webhook** | [**Webhook**](Webhook.md)| Webhook to create |
337
- **_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
338
-
339
- ### Return type
340
-
341
- [**WebhookResponse**](WebhookResponse.md)
342
-
343
- ### Authorization
344
-
345
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
346
-
347
- ### HTTP request headers
348
-
349
- - **Content-Type**: application/json; charset=UTF-8
350
- - **Accept**: application/json
351
-
352
-
353
-
354
- # **resend_event**
355
- > WebhookReflowResponse resend_event(webhook_oid, event_name)
356
-
357
- Resend events to the webhook endpoint.
358
-
359
- This method will resend events to the webhook endpoint. This method can be used for example to send all the existing items on an account to a webhook.
360
-
361
- ### Example
362
- ```ruby
363
- # load the gem
364
- require 'ultracart_api'
365
-
366
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
367
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
368
- api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false)
369
-
370
-
371
- webhook_oid = 56 # Integer | The webhook oid that is receiving the reflowed events.
372
-
373
- event_name = 'event_name_example' # String | The event to reflow.
374
-
375
-
376
- begin
377
- #Resend events to the webhook endpoint.
378
- result = api_instance.resend_event(webhook_oid, event_name)
379
- p result
380
- rescue UltracartClient::ApiError => e
381
- puts "Exception when calling WebhookApi->resend_event: #{e}"
382
- end
383
- ```
384
-
385
- ### Parameters
386
-
387
- Name | Type | Description | Notes
388
- ------------- | ------------- | ------------- | -------------
389
- **webhook_oid** | **Integer**| The webhook oid that is receiving the reflowed events. |
390
- **event_name** | **String**| The event to reflow. |
391
-
392
- ### Return type
393
-
394
- [**WebhookReflowResponse**](WebhookReflowResponse.md)
395
-
396
- ### Authorization
397
-
398
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
399
-
400
- ### HTTP request headers
401
-
402
- - **Content-Type**: application/json
403
- - **Accept**: application/json
404
-
405
-
406
-
407
- # **update_webhook**
408
- > WebhookResponse update_webhook(webhook, webhook_oid, opts)
409
-
410
- Update a webhook
411
-
412
- Update a webhook on the account
413
-
414
- ### Example
415
- ```ruby
416
- # load the gem
417
- require 'ultracart_api'
418
-
419
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
420
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
421
- api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false)
422
-
423
-
424
- webhook = UltracartClient::Webhook.new # Webhook | Webhook to update
425
-
426
- webhook_oid = 56 # Integer | The webhook oid to update.
427
-
428
- opts = {
429
- _placeholders: true # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
430
- }
431
-
432
- begin
433
- #Update a webhook
434
- result = api_instance.update_webhook(webhook, webhook_oid, opts)
435
- p result
436
- rescue UltracartClient::ApiError => e
437
- puts "Exception when calling WebhookApi->update_webhook: #{e}"
438
- end
439
- ```
440
-
441
- ### Parameters
442
-
443
- Name | Type | Description | Notes
444
- ------------- | ------------- | ------------- | -------------
445
- **webhook** | [**Webhook**](Webhook.md)| Webhook to update |
446
- **webhook_oid** | **Integer**| The webhook oid to update. |
447
- **_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
448
-
449
- ### Return type
450
-
451
- [**WebhookResponse**](WebhookResponse.md)
452
-
453
- ### Authorization
454
-
455
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
456
-
457
- ### HTTP request headers
458
-
459
- - **Content-Type**: application/json; charset=UTF-8
460
- - **Accept**: application/json
461
-
462
-
463
-
1
+ # UltracartClient::WebhookApi
2
+
3
+ All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**delete_webhook**](WebhookApi.md#delete_webhook) | **DELETE** /webhook/webhooks/{webhookOid} | Delete a webhook |
8
+ | [**delete_webhook_by_url**](WebhookApi.md#delete_webhook_by_url) | **DELETE** /webhook/webhooks | Delete a webhook by URL |
9
+ | [**get_webhook_log**](WebhookApi.md#get_webhook_log) | **GET** /webhook/webhooks/{webhookOid}/logs/{requestId} | Retrieve an individual log |
10
+ | [**get_webhook_log_summaries**](WebhookApi.md#get_webhook_log_summaries) | **GET** /webhook/webhooks/{webhookOid}/logs | Retrieve the log summaries |
11
+ | [**get_webhooks**](WebhookApi.md#get_webhooks) | **GET** /webhook/webhooks | Retrieve webhooks |
12
+ | [**insert_webhook**](WebhookApi.md#insert_webhook) | **POST** /webhook/webhooks | Add a webhook |
13
+ | [**resend_event**](WebhookApi.md#resend_event) | **POST** /webhook/webhooks/{webhookOid}/reflow/{eventName} | Resend events to the webhook endpoint. |
14
+ | [**update_webhook**](WebhookApi.md#update_webhook) | **PUT** /webhook/webhooks/{webhookOid} | Update a webhook |
15
+
16
+
17
+ ## delete_webhook
18
+
19
+ > delete_webhook(webhook_oid)
20
+
21
+ Delete a webhook
22
+
23
+ Delete a webhook on the UltraCart account.
24
+
25
+ ### Examples
26
+
27
+ ```ruby
28
+ require 'time'
29
+ require 'ultracart_api'
30
+ # setup authorization
31
+ UltracartClient.configure do |config|
32
+ # Configure OAuth2 access token for authorization: ultraCartOauth
33
+ config.access_token = 'YOUR ACCESS TOKEN'
34
+
35
+ # Configure API key authorization: ultraCartSimpleApiKey
36
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
37
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
38
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
39
+ end
40
+
41
+ api_instance = UltracartClient::WebhookApi.new
42
+ webhook_oid = 56 # Integer | The webhook oid to delete.
43
+
44
+ begin
45
+ # Delete a webhook
46
+ api_instance.delete_webhook(webhook_oid)
47
+ rescue UltracartClient::ApiError => e
48
+ puts "Error when calling WebhookApi->delete_webhook: #{e}"
49
+ end
50
+ ```
51
+
52
+ #### Using the delete_webhook_with_http_info variant
53
+
54
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
55
+
56
+ > <Array(nil, Integer, Hash)> delete_webhook_with_http_info(webhook_oid)
57
+
58
+ ```ruby
59
+ begin
60
+ # Delete a webhook
61
+ data, status_code, headers = api_instance.delete_webhook_with_http_info(webhook_oid)
62
+ p status_code # => 2xx
63
+ p headers # => { ... }
64
+ p data # => nil
65
+ rescue UltracartClient::ApiError => e
66
+ puts "Error when calling WebhookApi->delete_webhook_with_http_info: #{e}"
67
+ end
68
+ ```
69
+
70
+ ### Parameters
71
+
72
+ | Name | Type | Description | Notes |
73
+ | ---- | ---- | ----------- | ----- |
74
+ | **webhook_oid** | **Integer** | The webhook oid to delete. | |
75
+
76
+ ### Return type
77
+
78
+ nil (empty response body)
79
+
80
+ ### Authorization
81
+
82
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
83
+
84
+ ### HTTP request headers
85
+
86
+ - **Content-Type**: Not defined
87
+ - **Accept**: application/json
88
+
89
+
90
+ ## delete_webhook_by_url
91
+
92
+ > <WebhookResponse> delete_webhook_by_url(webhook)
93
+
94
+ Delete a webhook by URL
95
+
96
+ Delete a webhook based upon the URL on the webhook_url matching an existing webhook.
97
+
98
+ ### Examples
99
+
100
+ ```ruby
101
+ require 'time'
102
+ require 'ultracart_api'
103
+ # setup authorization
104
+ UltracartClient.configure do |config|
105
+ # Configure OAuth2 access token for authorization: ultraCartOauth
106
+ config.access_token = 'YOUR ACCESS TOKEN'
107
+
108
+ # Configure API key authorization: ultraCartSimpleApiKey
109
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
110
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
111
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
112
+ end
113
+
114
+ api_instance = UltracartClient::WebhookApi.new
115
+ webhook = UltracartClient::Webhook.new # Webhook | Webhook to delete
116
+
117
+ begin
118
+ # Delete a webhook by URL
119
+ result = api_instance.delete_webhook_by_url(webhook)
120
+ p result
121
+ rescue UltracartClient::ApiError => e
122
+ puts "Error when calling WebhookApi->delete_webhook_by_url: #{e}"
123
+ end
124
+ ```
125
+
126
+ #### Using the delete_webhook_by_url_with_http_info variant
127
+
128
+ This returns an Array which contains the response data, status code and headers.
129
+
130
+ > <Array(<WebhookResponse>, Integer, Hash)> delete_webhook_by_url_with_http_info(webhook)
131
+
132
+ ```ruby
133
+ begin
134
+ # Delete a webhook by URL
135
+ data, status_code, headers = api_instance.delete_webhook_by_url_with_http_info(webhook)
136
+ p status_code # => 2xx
137
+ p headers # => { ... }
138
+ p data # => <WebhookResponse>
139
+ rescue UltracartClient::ApiError => e
140
+ puts "Error when calling WebhookApi->delete_webhook_by_url_with_http_info: #{e}"
141
+ end
142
+ ```
143
+
144
+ ### Parameters
145
+
146
+ | Name | Type | Description | Notes |
147
+ | ---- | ---- | ----------- | ----- |
148
+ | **webhook** | [**Webhook**](Webhook.md) | Webhook to delete | |
149
+
150
+ ### Return type
151
+
152
+ [**WebhookResponse**](WebhookResponse.md)
153
+
154
+ ### Authorization
155
+
156
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
157
+
158
+ ### HTTP request headers
159
+
160
+ - **Content-Type**: application/json; charset=UTF-8
161
+ - **Accept**: application/json
162
+
163
+
164
+ ## get_webhook_log
165
+
166
+ > <WebhookLogResponse> get_webhook_log(webhook_oid, request_id)
167
+
168
+ Retrieve an individual log
169
+
170
+ Retrieves an individual log for a webhook given the webhook oid the request id.
171
+
172
+ ### Examples
173
+
174
+ ```ruby
175
+ require 'time'
176
+ require 'ultracart_api'
177
+ # setup authorization
178
+ UltracartClient.configure do |config|
179
+ # Configure OAuth2 access token for authorization: ultraCartOauth
180
+ config.access_token = 'YOUR ACCESS TOKEN'
181
+
182
+ # Configure API key authorization: ultraCartSimpleApiKey
183
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
184
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
185
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
186
+ end
187
+
188
+ api_instance = UltracartClient::WebhookApi.new
189
+ webhook_oid = 56 # Integer | The webhook oid that owns the log.
190
+ request_id = 'request_id_example' # String | The request id associated with the log to view.
191
+
192
+ begin
193
+ # Retrieve an individual log
194
+ result = api_instance.get_webhook_log(webhook_oid, request_id)
195
+ p result
196
+ rescue UltracartClient::ApiError => e
197
+ puts "Error when calling WebhookApi->get_webhook_log: #{e}"
198
+ end
199
+ ```
200
+
201
+ #### Using the get_webhook_log_with_http_info variant
202
+
203
+ This returns an Array which contains the response data, status code and headers.
204
+
205
+ > <Array(<WebhookLogResponse>, Integer, Hash)> get_webhook_log_with_http_info(webhook_oid, request_id)
206
+
207
+ ```ruby
208
+ begin
209
+ # Retrieve an individual log
210
+ data, status_code, headers = api_instance.get_webhook_log_with_http_info(webhook_oid, request_id)
211
+ p status_code # => 2xx
212
+ p headers # => { ... }
213
+ p data # => <WebhookLogResponse>
214
+ rescue UltracartClient::ApiError => e
215
+ puts "Error when calling WebhookApi->get_webhook_log_with_http_info: #{e}"
216
+ end
217
+ ```
218
+
219
+ ### Parameters
220
+
221
+ | Name | Type | Description | Notes |
222
+ | ---- | ---- | ----------- | ----- |
223
+ | **webhook_oid** | **Integer** | The webhook oid that owns the log. | |
224
+ | **request_id** | **String** | The request id associated with the log to view. | |
225
+
226
+ ### Return type
227
+
228
+ [**WebhookLogResponse**](WebhookLogResponse.md)
229
+
230
+ ### Authorization
231
+
232
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
233
+
234
+ ### HTTP request headers
235
+
236
+ - **Content-Type**: Not defined
237
+ - **Accept**: application/json
238
+
239
+
240
+ ## get_webhook_log_summaries
241
+
242
+ > <WebhookLogSummariesResponse> get_webhook_log_summaries(webhook_oid, opts)
243
+
244
+ Retrieve the log summaries
245
+
246
+ Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.
247
+
248
+ ### Examples
249
+
250
+ ```ruby
251
+ require 'time'
252
+ require 'ultracart_api'
253
+ # setup authorization
254
+ UltracartClient.configure do |config|
255
+ # Configure OAuth2 access token for authorization: ultraCartOauth
256
+ config.access_token = 'YOUR ACCESS TOKEN'
257
+
258
+ # Configure API key authorization: ultraCartSimpleApiKey
259
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
260
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
261
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
262
+ end
263
+
264
+ api_instance = UltracartClient::WebhookApi.new
265
+ webhook_oid = 56 # Integer | The webhook oid to retrieve log summaries for.
266
+ opts = {
267
+ _limit: 56, # Integer | The maximum number of records to return on this one API call.
268
+ _offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
269
+ _since: '_since_example' # String | Fetch log summaries that have been delivered since this date/time.
270
+ }
271
+
272
+ begin
273
+ # Retrieve the log summaries
274
+ result = api_instance.get_webhook_log_summaries(webhook_oid, opts)
275
+ p result
276
+ rescue UltracartClient::ApiError => e
277
+ puts "Error when calling WebhookApi->get_webhook_log_summaries: #{e}"
278
+ end
279
+ ```
280
+
281
+ #### Using the get_webhook_log_summaries_with_http_info variant
282
+
283
+ This returns an Array which contains the response data, status code and headers.
284
+
285
+ > <Array(<WebhookLogSummariesResponse>, Integer, Hash)> get_webhook_log_summaries_with_http_info(webhook_oid, opts)
286
+
287
+ ```ruby
288
+ begin
289
+ # Retrieve the log summaries
290
+ data, status_code, headers = api_instance.get_webhook_log_summaries_with_http_info(webhook_oid, opts)
291
+ p status_code # => 2xx
292
+ p headers # => { ... }
293
+ p data # => <WebhookLogSummariesResponse>
294
+ rescue UltracartClient::ApiError => e
295
+ puts "Error when calling WebhookApi->get_webhook_log_summaries_with_http_info: #{e}"
296
+ end
297
+ ```
298
+
299
+ ### Parameters
300
+
301
+ | Name | Type | Description | Notes |
302
+ | ---- | ---- | ----------- | ----- |
303
+ | **webhook_oid** | **Integer** | The webhook oid to retrieve log summaries for. | |
304
+ | **_limit** | **Integer** | The maximum number of records to return on this one API call. | [optional][default to 100] |
305
+ | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
306
+ | **_since** | **String** | Fetch log summaries that have been delivered since this date/time. | [optional] |
307
+
308
+ ### Return type
309
+
310
+ [**WebhookLogSummariesResponse**](WebhookLogSummariesResponse.md)
311
+
312
+ ### Authorization
313
+
314
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
315
+
316
+ ### HTTP request headers
317
+
318
+ - **Content-Type**: Not defined
319
+ - **Accept**: application/json
320
+
321
+
322
+ ## get_webhooks
323
+
324
+ > <WebhooksResponse> get_webhooks(opts)
325
+
326
+ Retrieve webhooks
327
+
328
+ Retrieves the webhooks associated with this application.
329
+
330
+ ### Examples
331
+
332
+ ```ruby
333
+ require 'time'
334
+ require 'ultracart_api'
335
+ # setup authorization
336
+ UltracartClient.configure do |config|
337
+ # Configure OAuth2 access token for authorization: ultraCartOauth
338
+ config.access_token = 'YOUR ACCESS TOKEN'
339
+
340
+ # Configure API key authorization: ultraCartSimpleApiKey
341
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
342
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
343
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
344
+ end
345
+
346
+ api_instance = UltracartClient::WebhookApi.new
347
+ opts = {
348
+ _limit: 56, # Integer | The maximum number of records to return on this one API call.
349
+ _offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
350
+ _sort: '_sort_example', # String | The sort order of the webhooks. See documentation for examples
351
+ _placeholders: true # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
352
+ }
353
+
354
+ begin
355
+ # Retrieve webhooks
356
+ result = api_instance.get_webhooks(opts)
357
+ p result
358
+ rescue UltracartClient::ApiError => e
359
+ puts "Error when calling WebhookApi->get_webhooks: #{e}"
360
+ end
361
+ ```
362
+
363
+ #### Using the get_webhooks_with_http_info variant
364
+
365
+ This returns an Array which contains the response data, status code and headers.
366
+
367
+ > <Array(<WebhooksResponse>, Integer, Hash)> get_webhooks_with_http_info(opts)
368
+
369
+ ```ruby
370
+ begin
371
+ # Retrieve webhooks
372
+ data, status_code, headers = api_instance.get_webhooks_with_http_info(opts)
373
+ p status_code # => 2xx
374
+ p headers # => { ... }
375
+ p data # => <WebhooksResponse>
376
+ rescue UltracartClient::ApiError => e
377
+ puts "Error when calling WebhookApi->get_webhooks_with_http_info: #{e}"
378
+ end
379
+ ```
380
+
381
+ ### Parameters
382
+
383
+ | Name | Type | Description | Notes |
384
+ | ---- | ---- | ----------- | ----- |
385
+ | **_limit** | **Integer** | The maximum number of records to return on this one API call. | [optional][default to 100] |
386
+ | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
387
+ | **_sort** | **String** | The sort order of the webhooks. See documentation for examples | [optional] |
388
+ | **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional] |
389
+
390
+ ### Return type
391
+
392
+ [**WebhooksResponse**](WebhooksResponse.md)
393
+
394
+ ### Authorization
395
+
396
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
397
+
398
+ ### HTTP request headers
399
+
400
+ - **Content-Type**: Not defined
401
+ - **Accept**: application/json
402
+
403
+
404
+ ## insert_webhook
405
+
406
+ > <WebhookResponse> insert_webhook(webhook, opts)
407
+
408
+ Add a webhook
409
+
410
+ Adds a new webhook on the account. If you add a new webhook with the authentication_type set to basic, but do not specify the basic_username and basic_password, UltraCart will automatically generate random ones and return them. This allows your application to have simpler logic on the setup of a secure webhook.
411
+
412
+ ### Examples
413
+
414
+ ```ruby
415
+ require 'time'
416
+ require 'ultracart_api'
417
+ # setup authorization
418
+ UltracartClient.configure do |config|
419
+ # Configure OAuth2 access token for authorization: ultraCartOauth
420
+ config.access_token = 'YOUR ACCESS TOKEN'
421
+
422
+ # Configure API key authorization: ultraCartSimpleApiKey
423
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
424
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
425
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
426
+ end
427
+
428
+ api_instance = UltracartClient::WebhookApi.new
429
+ webhook = UltracartClient::Webhook.new # Webhook | Webhook to create
430
+ opts = {
431
+ _placeholders: true # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
432
+ }
433
+
434
+ begin
435
+ # Add a webhook
436
+ result = api_instance.insert_webhook(webhook, opts)
437
+ p result
438
+ rescue UltracartClient::ApiError => e
439
+ puts "Error when calling WebhookApi->insert_webhook: #{e}"
440
+ end
441
+ ```
442
+
443
+ #### Using the insert_webhook_with_http_info variant
444
+
445
+ This returns an Array which contains the response data, status code and headers.
446
+
447
+ > <Array(<WebhookResponse>, Integer, Hash)> insert_webhook_with_http_info(webhook, opts)
448
+
449
+ ```ruby
450
+ begin
451
+ # Add a webhook
452
+ data, status_code, headers = api_instance.insert_webhook_with_http_info(webhook, opts)
453
+ p status_code # => 2xx
454
+ p headers # => { ... }
455
+ p data # => <WebhookResponse>
456
+ rescue UltracartClient::ApiError => e
457
+ puts "Error when calling WebhookApi->insert_webhook_with_http_info: #{e}"
458
+ end
459
+ ```
460
+
461
+ ### Parameters
462
+
463
+ | Name | Type | Description | Notes |
464
+ | ---- | ---- | ----------- | ----- |
465
+ | **webhook** | [**Webhook**](Webhook.md) | Webhook to create | |
466
+ | **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional] |
467
+
468
+ ### Return type
469
+
470
+ [**WebhookResponse**](WebhookResponse.md)
471
+
472
+ ### Authorization
473
+
474
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
475
+
476
+ ### HTTP request headers
477
+
478
+ - **Content-Type**: application/json; charset=UTF-8
479
+ - **Accept**: application/json
480
+
481
+
482
+ ## resend_event
483
+
484
+ > <WebhookSampleRequestResponse> resend_event(webhook_oid, event_name)
485
+
486
+ Resend events to the webhook endpoint.
487
+
488
+ This method will resend events to the webhook endpoint. This method can be used for example to send all the existing items on an account to a webhook.
489
+
490
+ ### Examples
491
+
492
+ ```ruby
493
+ require 'time'
494
+ require 'ultracart_api'
495
+ # setup authorization
496
+ UltracartClient.configure do |config|
497
+ # Configure OAuth2 access token for authorization: ultraCartOauth
498
+ config.access_token = 'YOUR ACCESS TOKEN'
499
+
500
+ # Configure API key authorization: ultraCartSimpleApiKey
501
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
502
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
503
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
504
+ end
505
+
506
+ api_instance = UltracartClient::WebhookApi.new
507
+ webhook_oid = 56 # Integer | The webhook oid that is receiving the reflowed events.
508
+ event_name = 'event_name_example' # String | The event to reflow.
509
+
510
+ begin
511
+ # Resend events to the webhook endpoint.
512
+ result = api_instance.resend_event(webhook_oid, event_name)
513
+ p result
514
+ rescue UltracartClient::ApiError => e
515
+ puts "Error when calling WebhookApi->resend_event: #{e}"
516
+ end
517
+ ```
518
+
519
+ #### Using the resend_event_with_http_info variant
520
+
521
+ This returns an Array which contains the response data, status code and headers.
522
+
523
+ > <Array(<WebhookSampleRequestResponse>, Integer, Hash)> resend_event_with_http_info(webhook_oid, event_name)
524
+
525
+ ```ruby
526
+ begin
527
+ # Resend events to the webhook endpoint.
528
+ data, status_code, headers = api_instance.resend_event_with_http_info(webhook_oid, event_name)
529
+ p status_code # => 2xx
530
+ p headers # => { ... }
531
+ p data # => <WebhookSampleRequestResponse>
532
+ rescue UltracartClient::ApiError => e
533
+ puts "Error when calling WebhookApi->resend_event_with_http_info: #{e}"
534
+ end
535
+ ```
536
+
537
+ ### Parameters
538
+
539
+ | Name | Type | Description | Notes |
540
+ | ---- | ---- | ----------- | ----- |
541
+ | **webhook_oid** | **Integer** | The webhook oid that is receiving the reflowed events. | |
542
+ | **event_name** | **String** | The event to reflow. | |
543
+
544
+ ### Return type
545
+
546
+ [**WebhookSampleRequestResponse**](WebhookSampleRequestResponse.md)
547
+
548
+ ### Authorization
549
+
550
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
551
+
552
+ ### HTTP request headers
553
+
554
+ - **Content-Type**: Not defined
555
+ - **Accept**: application/json
556
+
557
+
558
+ ## update_webhook
559
+
560
+ > <WebhookResponse> update_webhook(webhook_oid, webhook, opts)
561
+
562
+ Update a webhook
563
+
564
+ Update a webhook on the account
565
+
566
+ ### Examples
567
+
568
+ ```ruby
569
+ require 'time'
570
+ require 'ultracart_api'
571
+ # setup authorization
572
+ UltracartClient.configure do |config|
573
+ # Configure OAuth2 access token for authorization: ultraCartOauth
574
+ config.access_token = 'YOUR ACCESS TOKEN'
575
+
576
+ # Configure API key authorization: ultraCartSimpleApiKey
577
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
578
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
579
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
580
+ end
581
+
582
+ api_instance = UltracartClient::WebhookApi.new
583
+ webhook_oid = 56 # Integer | The webhook oid to update.
584
+ webhook = UltracartClient::Webhook.new # Webhook | Webhook to update
585
+ opts = {
586
+ _placeholders: true # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
587
+ }
588
+
589
+ begin
590
+ # Update a webhook
591
+ result = api_instance.update_webhook(webhook_oid, webhook, opts)
592
+ p result
593
+ rescue UltracartClient::ApiError => e
594
+ puts "Error when calling WebhookApi->update_webhook: #{e}"
595
+ end
596
+ ```
597
+
598
+ #### Using the update_webhook_with_http_info variant
599
+
600
+ This returns an Array which contains the response data, status code and headers.
601
+
602
+ > <Array(<WebhookResponse>, Integer, Hash)> update_webhook_with_http_info(webhook_oid, webhook, opts)
603
+
604
+ ```ruby
605
+ begin
606
+ # Update a webhook
607
+ data, status_code, headers = api_instance.update_webhook_with_http_info(webhook_oid, webhook, opts)
608
+ p status_code # => 2xx
609
+ p headers # => { ... }
610
+ p data # => <WebhookResponse>
611
+ rescue UltracartClient::ApiError => e
612
+ puts "Error when calling WebhookApi->update_webhook_with_http_info: #{e}"
613
+ end
614
+ ```
615
+
616
+ ### Parameters
617
+
618
+ | Name | Type | Description | Notes |
619
+ | ---- | ---- | ----------- | ----- |
620
+ | **webhook_oid** | **Integer** | The webhook oid to update. | |
621
+ | **webhook** | [**Webhook**](Webhook.md) | Webhook to update | |
622
+ | **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional] |
623
+
624
+ ### Return type
625
+
626
+ [**WebhookResponse**](WebhookResponse.md)
627
+
628
+ ### Authorization
629
+
630
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
631
+
632
+ ### HTTP request headers
633
+
634
+ - **Content-Type**: application/json; charset=UTF-8
635
+ - **Accept**: application/json
636
+