order_cloud 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (392) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +201 -0
  3. data/README.md +476 -0
  4. data/Rakefile +31 -0
  5. data/docs/AccessToken.md +10 -0
  6. data/docs/Address.md +20 -0
  7. data/docs/AddressApi.md +520 -0
  8. data/docs/AddressAssignment.md +12 -0
  9. data/docs/AdminAddressApi.md +324 -0
  10. data/docs/AdminCompany.md +10 -0
  11. data/docs/AdminModelOnView.md +7 -0
  12. data/docs/AdminUserApi.md +323 -0
  13. data/docs/ApprovalRule.md +20 -0
  14. data/docs/ApprovalRuleApi.md +342 -0
  15. data/docs/BaseSpec.md +15 -0
  16. data/docs/Buyer.md +11 -0
  17. data/docs/BuyerAddress.md +11 -0
  18. data/docs/BuyerApi.md +324 -0
  19. data/docs/BuyerCreditCard.md +9 -0
  20. data/docs/BuyerProduct.md +9 -0
  21. data/docs/BuyerSpec.md +9 -0
  22. data/docs/Category.md +15 -0
  23. data/docs/CategoryApi.md +684 -0
  24. data/docs/CategoryAssignment.md +10 -0
  25. data/docs/CategoryProductAssignment.md +10 -0
  26. data/docs/CostCenter.md +11 -0
  27. data/docs/CostCenterApi.md +516 -0
  28. data/docs/CostCenterAssignment.md +10 -0
  29. data/docs/CreditCard.md +15 -0
  30. data/docs/CreditCardApi.md +516 -0
  31. data/docs/CreditCardAssignment.md +10 -0
  32. data/docs/EmailTemplate.md +12 -0
  33. data/docs/EmailTemplateApi.md +223 -0
  34. data/docs/File.md +10 -0
  35. data/docs/FileApi.md +162 -0
  36. data/docs/ImpersonateTokenRequest.md +9 -0
  37. data/docs/Inventory.md +12 -0
  38. data/docs/LineItem.md +23 -0
  39. data/docs/LineItemApi.md +478 -0
  40. data/docs/LineItemSpec.md +11 -0
  41. data/docs/ListAddress.md +9 -0
  42. data/docs/ListAddressAssignment.md +9 -0
  43. data/docs/ListAdminCompany.md +9 -0
  44. data/docs/ListApiClient.md +9 -0
  45. data/docs/ListApprovalRule.md +9 -0
  46. data/docs/ListBuyer.md +9 -0
  47. data/docs/ListBuyerAddress.md +9 -0
  48. data/docs/ListBuyerCreditCard.md +9 -0
  49. data/docs/ListBuyerProduct.md +9 -0
  50. data/docs/ListBuyerSpec.md +9 -0
  51. data/docs/ListCategory.md +9 -0
  52. data/docs/ListCategoryAssignment.md +9 -0
  53. data/docs/ListCategoryProductAssignment.md +9 -0
  54. data/docs/ListCostCenter.md +9 -0
  55. data/docs/ListCostCenterAssignment.md +9 -0
  56. data/docs/ListCreditCard.md +9 -0
  57. data/docs/ListCreditCardAssignment.md +9 -0
  58. data/docs/ListDevAccessibleCompany.md +9 -0
  59. data/docs/ListFile.md +9 -0
  60. data/docs/ListInventory.md +9 -0
  61. data/docs/ListLineItem.md +9 -0
  62. data/docs/ListOrder.md +9 -0
  63. data/docs/ListOrderApproval.md +9 -0
  64. data/docs/ListOrderPromotion.md +9 -0
  65. data/docs/ListPayment.md +9 -0
  66. data/docs/ListPriceSchedule.md +9 -0
  67. data/docs/ListProduct.md +9 -0
  68. data/docs/ListProductAssignment.md +9 -0
  69. data/docs/ListPromotion.md +9 -0
  70. data/docs/ListPromotionAssignment.md +9 -0
  71. data/docs/ListSecurityProfile.md +9 -0
  72. data/docs/ListSecurityProfileAssignment.md +9 -0
  73. data/docs/ListShipment.md +9 -0
  74. data/docs/ListSpec.md +9 -0
  75. data/docs/ListSpecOption.md +9 -0
  76. data/docs/ListSpecProductAssignment.md +9 -0
  77. data/docs/ListSpendingAccount.md +9 -0
  78. data/docs/ListSpendingAccountAssignment.md +9 -0
  79. data/docs/ListUser.md +9 -0
  80. data/docs/ListUserGroup.md +9 -0
  81. data/docs/ListUserGroupAssignment.md +9 -0
  82. data/docs/ListVariant.md +9 -0
  83. data/docs/ListWebHook.md +9 -0
  84. data/docs/ListWebHookRoute.md +9 -0
  85. data/docs/ListXpIndex.md +9 -0
  86. data/docs/MeApi.md +1488 -0
  87. data/docs/Meta.md +12 -0
  88. data/docs/Order.md +31 -0
  89. data/docs/OrderApi.md +1277 -0
  90. data/docs/OrderApproval.md +16 -0
  91. data/docs/OrderPromotion.md +8 -0
  92. data/docs/PasswordReset.md +10 -0
  93. data/docs/PasswordResetApi.md +109 -0
  94. data/docs/PasswordResetRequest.md +11 -0
  95. data/docs/Payment.md +16 -0
  96. data/docs/PaymentApi.md +601 -0
  97. data/docs/PaymentTransaction.md +15 -0
  98. data/docs/PingResponse.md +8 -0
  99. data/docs/PriceBreak.md +9 -0
  100. data/docs/PriceSchedule.md +18 -0
  101. data/docs/PriceScheduleApi.md +429 -0
  102. data/docs/Product.md +22 -0
  103. data/docs/ProductApi.md +1115 -0
  104. data/docs/ProductAssignment.md +13 -0
  105. data/docs/Promotion.md +21 -0
  106. data/docs/PromotionApi.md +495 -0
  107. data/docs/PromotionAssignment.md +11 -0
  108. data/docs/SecurityProfile.md +11 -0
  109. data/docs/SecurityProfileApi.md +290 -0
  110. data/docs/SecurityProfileAssignment.md +11 -0
  111. data/docs/Shipment.md +14 -0
  112. data/docs/ShipmentApi.md +459 -0
  113. data/docs/ShipmentItem.md +10 -0
  114. data/docs/Spec.md +8 -0
  115. data/docs/SpecApi.md +816 -0
  116. data/docs/SpecOption.md +14 -0
  117. data/docs/SpecProductAssignment.md +10 -0
  118. data/docs/SpendingAccount.md +15 -0
  119. data/docs/SpendingAccountApi.md +516 -0
  120. data/docs/SpendingAccountAssignment.md +11 -0
  121. data/docs/User.md +17 -0
  122. data/docs/UserApi.md +399 -0
  123. data/docs/UserGroup.md +11 -0
  124. data/docs/UserGroupApi.md +508 -0
  125. data/docs/UserGroupAssignment.md +9 -0
  126. data/docs/Variant.md +12 -0
  127. data/docs/WebHook.md +18 -0
  128. data/docs/WebHookRoute.md +10 -0
  129. data/docs/XpIndex.md +9 -0
  130. data/git_push.sh +67 -0
  131. data/lib/order_cloud.rb +176 -0
  132. data/lib/order_cloud/api/address_api.rb +628 -0
  133. data/lib/order_cloud/api/admin_address_api.rb +397 -0
  134. data/lib/order_cloud/api/admin_user_api.rb +396 -0
  135. data/lib/order_cloud/api/approval_rule_api.rb +421 -0
  136. data/lib/order_cloud/api/buyer_api.rb +397 -0
  137. data/lib/order_cloud/api/category_api.rb +817 -0
  138. data/lib/order_cloud/api/cost_center_api.rb +622 -0
  139. data/lib/order_cloud/api/credit_card_api.rb +622 -0
  140. data/lib/order_cloud/api/email_template_api.rb +283 -0
  141. data/lib/order_cloud/api/file_api.rb +206 -0
  142. data/lib/order_cloud/api/line_item_api.rb +583 -0
  143. data/lib/order_cloud/api/me_api.rb +1747 -0
  144. data/lib/order_cloud/api/order_api.rb +1509 -0
  145. data/lib/order_cloud/api/password_reset_api.rb +150 -0
  146. data/lib/order_cloud/api/payment_api.rb +728 -0
  147. data/lib/order_cloud/api/price_schedule_api.rb +519 -0
  148. data/lib/order_cloud/api/product_api.rb +1311 -0
  149. data/lib/order_cloud/api/promotion_api.rb +596 -0
  150. data/lib/order_cloud/api/security_profile_api.rb +361 -0
  151. data/lib/order_cloud/api/shipment_api.rb +558 -0
  152. data/lib/order_cloud/api/spec_api.rb +965 -0
  153. data/lib/order_cloud/api/spending_account_api.rb +622 -0
  154. data/lib/order_cloud/api/user_api.rb +488 -0
  155. data/lib/order_cloud/api/user_group_api.rb +613 -0
  156. data/lib/order_cloud/api_auth.rb +99 -0
  157. data/lib/order_cloud/api_client.rb +385 -0
  158. data/lib/order_cloud/api_error.rb +47 -0
  159. data/lib/order_cloud/configuration.rb +244 -0
  160. data/lib/order_cloud/models/access_token.rb +217 -0
  161. data/lib/order_cloud/models/address.rb +307 -0
  162. data/lib/order_cloud/models/address_assignment.rb +235 -0
  163. data/lib/order_cloud/models/admin_company.rb +217 -0
  164. data/lib/order_cloud/models/admin_model_on_view.rb +190 -0
  165. data/lib/order_cloud/models/approval_rule.rb +307 -0
  166. data/lib/order_cloud/models/base_spec.rb +262 -0
  167. data/lib/order_cloud/models/buyer.rb +226 -0
  168. data/lib/order_cloud/models/buyer_address.rb +226 -0
  169. data/lib/order_cloud/models/buyer_credit_card.rb +208 -0
  170. data/lib/order_cloud/models/buyer_product.rb +208 -0
  171. data/lib/order_cloud/models/buyer_spec.rb +210 -0
  172. data/lib/order_cloud/models/category.rb +262 -0
  173. data/lib/order_cloud/models/category_assignment.rb +217 -0
  174. data/lib/order_cloud/models/category_product_assignment.rb +217 -0
  175. data/lib/order_cloud/models/cost_center.rb +226 -0
  176. data/lib/order_cloud/models/cost_center_assignment.rb +217 -0
  177. data/lib/order_cloud/models/credit_card.rb +262 -0
  178. data/lib/order_cloud/models/credit_card_assignment.rb +217 -0
  179. data/lib/order_cloud/models/email_template.rb +235 -0
  180. data/lib/order_cloud/models/file.rb +217 -0
  181. data/lib/order_cloud/models/impersonate_token_request.rb +208 -0
  182. data/lib/order_cloud/models/inventory.rb +235 -0
  183. data/lib/order_cloud/models/line_item.rb +336 -0
  184. data/lib/order_cloud/models/line_item_spec.rb +226 -0
  185. data/lib/order_cloud/models/list_address.rb +210 -0
  186. data/lib/order_cloud/models/list_address_assignment.rb +210 -0
  187. data/lib/order_cloud/models/list_admin_company.rb +210 -0
  188. data/lib/order_cloud/models/list_api_client.rb +210 -0
  189. data/lib/order_cloud/models/list_approval_rule.rb +210 -0
  190. data/lib/order_cloud/models/list_buyer.rb +210 -0
  191. data/lib/order_cloud/models/list_buyer_address.rb +210 -0
  192. data/lib/order_cloud/models/list_buyer_credit_card.rb +210 -0
  193. data/lib/order_cloud/models/list_buyer_product.rb +210 -0
  194. data/lib/order_cloud/models/list_buyer_spec.rb +210 -0
  195. data/lib/order_cloud/models/list_category.rb +210 -0
  196. data/lib/order_cloud/models/list_category_assignment.rb +210 -0
  197. data/lib/order_cloud/models/list_category_product_assignment.rb +210 -0
  198. data/lib/order_cloud/models/list_cost_center.rb +210 -0
  199. data/lib/order_cloud/models/list_cost_center_assignment.rb +210 -0
  200. data/lib/order_cloud/models/list_credit_card.rb +210 -0
  201. data/lib/order_cloud/models/list_credit_card_assignment.rb +210 -0
  202. data/lib/order_cloud/models/list_dev_accessible_company.rb +210 -0
  203. data/lib/order_cloud/models/list_file.rb +210 -0
  204. data/lib/order_cloud/models/list_inventory.rb +210 -0
  205. data/lib/order_cloud/models/list_line_item.rb +210 -0
  206. data/lib/order_cloud/models/list_order.rb +210 -0
  207. data/lib/order_cloud/models/list_order_approval.rb +210 -0
  208. data/lib/order_cloud/models/list_order_promotion.rb +210 -0
  209. data/lib/order_cloud/models/list_payment.rb +210 -0
  210. data/lib/order_cloud/models/list_price_schedule.rb +210 -0
  211. data/lib/order_cloud/models/list_product.rb +210 -0
  212. data/lib/order_cloud/models/list_product_assignment.rb +210 -0
  213. data/lib/order_cloud/models/list_promotion.rb +210 -0
  214. data/lib/order_cloud/models/list_promotion_assignment.rb +210 -0
  215. data/lib/order_cloud/models/list_security_profile.rb +210 -0
  216. data/lib/order_cloud/models/list_security_profile_assignment.rb +210 -0
  217. data/lib/order_cloud/models/list_shipment.rb +210 -0
  218. data/lib/order_cloud/models/list_spec.rb +210 -0
  219. data/lib/order_cloud/models/list_spec_option.rb +210 -0
  220. data/lib/order_cloud/models/list_spec_product_assignment.rb +210 -0
  221. data/lib/order_cloud/models/list_spending_account.rb +210 -0
  222. data/lib/order_cloud/models/list_spending_account_assignment.rb +210 -0
  223. data/lib/order_cloud/models/list_user.rb +210 -0
  224. data/lib/order_cloud/models/list_user_group.rb +210 -0
  225. data/lib/order_cloud/models/list_user_group_assignment.rb +210 -0
  226. data/lib/order_cloud/models/list_variant.rb +210 -0
  227. data/lib/order_cloud/models/list_web_hook.rb +210 -0
  228. data/lib/order_cloud/models/list_web_hook_route.rb +210 -0
  229. data/lib/order_cloud/models/list_xp_index.rb +210 -0
  230. data/lib/order_cloud/models/meta.rb +237 -0
  231. data/lib/order_cloud/models/order.rb +406 -0
  232. data/lib/order_cloud/models/order_approval.rb +271 -0
  233. data/lib/order_cloud/models/order_promotion.rb +199 -0
  234. data/lib/order_cloud/models/password_reset.rb +217 -0
  235. data/lib/order_cloud/models/password_reset_request.rb +226 -0
  236. data/lib/order_cloud/models/payment.rb +273 -0
  237. data/lib/order_cloud/models/payment_transaction.rb +262 -0
  238. data/lib/order_cloud/models/ping_response.rb +199 -0
  239. data/lib/order_cloud/models/price_break.rb +208 -0
  240. data/lib/order_cloud/models/price_schedule.rb +291 -0
  241. data/lib/order_cloud/models/product.rb +325 -0
  242. data/lib/order_cloud/models/product_assignment.rb +244 -0
  243. data/lib/order_cloud/models/promotion.rb +316 -0
  244. data/lib/order_cloud/models/promotion_assignment.rb +226 -0
  245. data/lib/order_cloud/models/security_profile.rb +228 -0
  246. data/lib/order_cloud/models/security_profile_assignment.rb +226 -0
  247. data/lib/order_cloud/models/shipment.rb +255 -0
  248. data/lib/order_cloud/models/shipment_item.rb +217 -0
  249. data/lib/order_cloud/models/spec.rb +199 -0
  250. data/lib/order_cloud/models/spec_option.rb +253 -0
  251. data/lib/order_cloud/models/spec_product_assignment.rb +217 -0
  252. data/lib/order_cloud/models/spending_account.rb +262 -0
  253. data/lib/order_cloud/models/spending_account_assignment.rb +226 -0
  254. data/lib/order_cloud/models/user.rb +280 -0
  255. data/lib/order_cloud/models/user_group.rb +226 -0
  256. data/lib/order_cloud/models/user_group_assignment.rb +208 -0
  257. data/lib/order_cloud/models/variant.rb +235 -0
  258. data/lib/order_cloud/models/web_hook.rb +289 -0
  259. data/lib/order_cloud/models/web_hook_route.rb +217 -0
  260. data/lib/order_cloud/models/xp_index.rb +208 -0
  261. data/lib/order_cloud/version.rb +26 -0
  262. data/order_cloud.gemspec +56 -0
  263. data/spec/api/address_api_spec.rb +179 -0
  264. data/spec/api/admin_address_api_spec.rb +125 -0
  265. data/spec/api/admin_user_api_spec.rb +125 -0
  266. data/spec/api/approval_rule_api_spec.rb +131 -0
  267. data/spec/api/buyer_api_spec.rb +125 -0
  268. data/spec/api/category_api_spec.rb +221 -0
  269. data/spec/api/cost_center_api_spec.rb +177 -0
  270. data/spec/api/credit_card_api_spec.rb +177 -0
  271. data/spec/api/email_template_api_spec.rb +100 -0
  272. data/spec/api/file_api_spec.rb +83 -0
  273. data/spec/api/line_item_api_spec.rb +167 -0
  274. data/spec/api/me_api_spec.rb +431 -0
  275. data/spec/api/order_api_spec.rb +375 -0
  276. data/spec/api/password_reset_api_spec.rb +71 -0
  277. data/spec/api/payment_api_spec.rb +199 -0
  278. data/spec/api/price_schedule_api_spec.rb +151 -0
  279. data/spec/api/product_api_spec.rb +330 -0
  280. data/spec/api/promotion_api_spec.rb +170 -0
  281. data/spec/api/security_profile_api_spec.rb +120 -0
  282. data/spec/api/shipment_api_spec.rb +161 -0
  283. data/spec/api/spec_api_spec.rb +250 -0
  284. data/spec/api/spending_account_api_spec.rb +177 -0
  285. data/spec/api/user_api_spec.rb +146 -0
  286. data/spec/api/user_group_api_spec.rb +174 -0
  287. data/spec/api_auth_spec.rb +165 -0
  288. data/spec/api_client_spec.rb +237 -0
  289. data/spec/configuration_spec.rb +80 -0
  290. data/spec/models/access_token_spec.rb +65 -0
  291. data/spec/models/address_assignment_spec.rb +77 -0
  292. data/spec/models/address_spec.rb +125 -0
  293. data/spec/models/admin_company_spec.rb +65 -0
  294. data/spec/models/admin_model_on_view_spec.rb +47 -0
  295. data/spec/models/approval_rule_spec.rb +125 -0
  296. data/spec/models/base_spec_spec.rb +95 -0
  297. data/spec/models/buyer_address_spec.rb +71 -0
  298. data/spec/models/buyer_credit_card_spec.rb +59 -0
  299. data/spec/models/buyer_product_spec.rb +59 -0
  300. data/spec/models/buyer_spec.rb +71 -0
  301. data/spec/models/buyer_spec_spec.rb +59 -0
  302. data/spec/models/category_assignment_spec.rb +65 -0
  303. data/spec/models/category_product_assignment_spec.rb +65 -0
  304. data/spec/models/category_spec.rb +95 -0
  305. data/spec/models/cost_center_assignment_spec.rb +65 -0
  306. data/spec/models/cost_center_spec.rb +71 -0
  307. data/spec/models/credit_card_assignment_spec.rb +65 -0
  308. data/spec/models/credit_card_spec.rb +95 -0
  309. data/spec/models/email_template_spec.rb +77 -0
  310. data/spec/models/file_spec.rb +65 -0
  311. data/spec/models/impersonate_token_request_spec.rb +59 -0
  312. data/spec/models/inventory_spec.rb +77 -0
  313. data/spec/models/line_item_spec.rb +143 -0
  314. data/spec/models/line_item_spec_spec.rb +71 -0
  315. data/spec/models/list_address_assignment_spec.rb +59 -0
  316. data/spec/models/list_address_spec.rb +59 -0
  317. data/spec/models/list_admin_company_spec.rb +59 -0
  318. data/spec/models/list_api_client_spec.rb +59 -0
  319. data/spec/models/list_approval_rule_spec.rb +59 -0
  320. data/spec/models/list_buyer_address_spec.rb +59 -0
  321. data/spec/models/list_buyer_credit_card_spec.rb +59 -0
  322. data/spec/models/list_buyer_product_spec.rb +59 -0
  323. data/spec/models/list_buyer_spec.rb +59 -0
  324. data/spec/models/list_buyer_spec_spec.rb +59 -0
  325. data/spec/models/list_category_assignment_spec.rb +59 -0
  326. data/spec/models/list_category_product_assignment_spec.rb +59 -0
  327. data/spec/models/list_category_spec.rb +59 -0
  328. data/spec/models/list_cost_center_assignment_spec.rb +59 -0
  329. data/spec/models/list_cost_center_spec.rb +59 -0
  330. data/spec/models/list_credit_card_assignment_spec.rb +59 -0
  331. data/spec/models/list_credit_card_spec.rb +59 -0
  332. data/spec/models/list_dev_accessible_company_spec.rb +59 -0
  333. data/spec/models/list_file_spec.rb +59 -0
  334. data/spec/models/list_inventory_spec.rb +59 -0
  335. data/spec/models/list_line_item_spec.rb +59 -0
  336. data/spec/models/list_order_approval_spec.rb +59 -0
  337. data/spec/models/list_order_promotion_spec.rb +59 -0
  338. data/spec/models/list_order_spec.rb +59 -0
  339. data/spec/models/list_payment_spec.rb +59 -0
  340. data/spec/models/list_price_schedule_spec.rb +59 -0
  341. data/spec/models/list_product_assignment_spec.rb +59 -0
  342. data/spec/models/list_product_spec.rb +59 -0
  343. data/spec/models/list_promotion_assignment_spec.rb +59 -0
  344. data/spec/models/list_promotion_spec.rb +59 -0
  345. data/spec/models/list_security_profile_assignment_spec.rb +59 -0
  346. data/spec/models/list_security_profile_spec.rb +59 -0
  347. data/spec/models/list_shipment_spec.rb +59 -0
  348. data/spec/models/list_spec_option_spec.rb +59 -0
  349. data/spec/models/list_spec_product_assignment_spec.rb +59 -0
  350. data/spec/models/list_spec_spec.rb +59 -0
  351. data/spec/models/list_spending_account_assignment_spec.rb +59 -0
  352. data/spec/models/list_spending_account_spec.rb +59 -0
  353. data/spec/models/list_user_group_assignment_spec.rb +59 -0
  354. data/spec/models/list_user_group_spec.rb +59 -0
  355. data/spec/models/list_user_spec.rb +59 -0
  356. data/spec/models/list_variant_spec.rb +59 -0
  357. data/spec/models/list_web_hook_route_spec.rb +59 -0
  358. data/spec/models/list_web_hook_spec.rb +59 -0
  359. data/spec/models/list_xp_index_spec.rb +59 -0
  360. data/spec/models/meta_spec.rb +77 -0
  361. data/spec/models/order_approval_spec.rb +101 -0
  362. data/spec/models/order_promotion_spec.rb +53 -0
  363. data/spec/models/order_spec.rb +191 -0
  364. data/spec/models/password_reset_request_spec.rb +71 -0
  365. data/spec/models/password_reset_spec.rb +65 -0
  366. data/spec/models/payment_spec.rb +101 -0
  367. data/spec/models/payment_transaction_spec.rb +95 -0
  368. data/spec/models/ping_response_spec.rb +53 -0
  369. data/spec/models/price_break_spec.rb +59 -0
  370. data/spec/models/price_schedule_spec.rb +113 -0
  371. data/spec/models/product_assignment_spec.rb +83 -0
  372. data/spec/models/product_spec.rb +137 -0
  373. data/spec/models/promotion_assignment_spec.rb +71 -0
  374. data/spec/models/promotion_spec.rb +131 -0
  375. data/spec/models/security_profile_assignment_spec.rb +71 -0
  376. data/spec/models/security_profile_spec.rb +71 -0
  377. data/spec/models/shipment_item_spec.rb +65 -0
  378. data/spec/models/shipment_spec.rb +89 -0
  379. data/spec/models/spec_option_spec.rb +89 -0
  380. data/spec/models/spec_product_assignment_spec.rb +65 -0
  381. data/spec/models/spec_spec.rb +53 -0
  382. data/spec/models/spending_account_assignment_spec.rb +71 -0
  383. data/spec/models/spending_account_spec.rb +95 -0
  384. data/spec/models/user_group_assignment_spec.rb +59 -0
  385. data/spec/models/user_group_spec.rb +71 -0
  386. data/spec/models/user_spec.rb +107 -0
  387. data/spec/models/variant_spec.rb +77 -0
  388. data/spec/models/web_hook_route_spec.rb +65 -0
  389. data/spec/models/web_hook_spec.rb +113 -0
  390. data/spec/models/xp_index_spec.rb +59 -0
  391. data/spec/spec_helper.rb +122 -0
  392. metadata +757 -0
@@ -0,0 +1,11 @@
1
+ # OrderCloud::SpendingAccountAssignment
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **spending_account_id** | **String** | | [optional]
7
+ **user_id** | **String** | | [optional]
8
+ **user_group_id** | **String** | | [optional]
9
+ **allow_exceed** | **BOOLEAN** | | [optional]
10
+
11
+
@@ -0,0 +1,17 @@
1
+ # OrderCloud::User
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | | [optional]
7
+ **username** | **String** | | [optional]
8
+ **password** | **String** | | [optional]
9
+ **first_name** | **String** | | [optional]
10
+ **last_name** | **String** | | [optional]
11
+ **email** | **String** | | [optional]
12
+ **phone** | **String** | | [optional]
13
+ **terms_accepted** | **String** | | [optional]
14
+ **active** | **BOOLEAN** | | [optional]
15
+ **xp** | **Object** | | [optional]
16
+
17
+
@@ -0,0 +1,399 @@
1
+ # OrderCloud::UserApi
2
+
3
+ All URIs are relative to *https://api.ordercloud.io/v1*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create**](UserApi.md#create) | **POST** /buyers/{buyerID}/users |
8
+ [**delete**](UserApi.md#delete) | **DELETE** /buyers/{buyerID}/users/{userID} |
9
+ [**get**](UserApi.md#get) | **GET** /buyers/{buyerID}/users/{userID} |
10
+ [**get_access_token**](UserApi.md#get_access_token) | **POST** /buyers/{buyerID}/users/{userID}/accesstoken |
11
+ [**list**](UserApi.md#list) | **GET** /buyers/{buyerID}/users |
12
+ [**patch**](UserApi.md#patch) | **PATCH** /buyers/{buyerID}/users/{userID} |
13
+ [**update**](UserApi.md#update) | **PUT** /buyers/{buyerID}/users/{userID} |
14
+
15
+
16
+ # **create**
17
+ > User create(buyer_id, user)
18
+
19
+
20
+
21
+ ### Example
22
+ ```ruby
23
+ # load the gem
24
+ require 'order_cloud'
25
+ # setup authorization
26
+ OrderCloud.configure do |config|
27
+ # Configure OAuth2 access token for authorization: oauth2
28
+ config.access_token = 'YOUR ACCESS TOKEN'
29
+ end
30
+
31
+ api_instance = OrderCloud::UserApi.new
32
+
33
+ buyer_id = "buyer_id_example" # String | ID of the buyer.
34
+
35
+ user = OrderCloud::User.new # User |
36
+
37
+
38
+ begin
39
+ result = api_instance.create(buyer_id, user)
40
+ p result
41
+ rescue OrderCloud::ApiError => e
42
+ puts "Exception when calling UserApi->create: #{e}"
43
+ end
44
+ ```
45
+
46
+ ### Parameters
47
+
48
+ Name | Type | Description | Notes
49
+ ------------- | ------------- | ------------- | -------------
50
+ **buyer_id** | **String**| ID of the buyer. |
51
+ **user** | [**User**](User.md)| |
52
+
53
+ ### Return type
54
+
55
+ [**User**](User.md)
56
+
57
+ ### Authorization
58
+
59
+ [oauth2](../README.md#oauth2)
60
+
61
+ ### HTTP request headers
62
+
63
+ - **Content-Type**: application/json, text/plain; charset=utf-8
64
+ - **Accept**: application/json
65
+
66
+
67
+
68
+ # **delete**
69
+ > delete(buyer_id, user_id)
70
+
71
+
72
+
73
+ ### Example
74
+ ```ruby
75
+ # load the gem
76
+ require 'order_cloud'
77
+ # setup authorization
78
+ OrderCloud.configure do |config|
79
+ # Configure OAuth2 access token for authorization: oauth2
80
+ config.access_token = 'YOUR ACCESS TOKEN'
81
+ end
82
+
83
+ api_instance = OrderCloud::UserApi.new
84
+
85
+ buyer_id = "buyer_id_example" # String | ID of the buyer.
86
+
87
+ user_id = "user_id_example" # String | ID of the user.
88
+
89
+
90
+ begin
91
+ api_instance.delete(buyer_id, user_id)
92
+ rescue OrderCloud::ApiError => e
93
+ puts "Exception when calling UserApi->delete: #{e}"
94
+ end
95
+ ```
96
+
97
+ ### Parameters
98
+
99
+ Name | Type | Description | Notes
100
+ ------------- | ------------- | ------------- | -------------
101
+ **buyer_id** | **String**| ID of the buyer. |
102
+ **user_id** | **String**| ID of the user. |
103
+
104
+ ### Return type
105
+
106
+ nil (empty response body)
107
+
108
+ ### Authorization
109
+
110
+ [oauth2](../README.md#oauth2)
111
+
112
+ ### HTTP request headers
113
+
114
+ - **Content-Type**: application/json, text/plain; charset=utf-8
115
+ - **Accept**: application/json
116
+
117
+
118
+
119
+ # **get**
120
+ > User get(buyer_id, user_id)
121
+
122
+
123
+
124
+ ### Example
125
+ ```ruby
126
+ # load the gem
127
+ require 'order_cloud'
128
+ # setup authorization
129
+ OrderCloud.configure do |config|
130
+ # Configure OAuth2 access token for authorization: oauth2
131
+ config.access_token = 'YOUR ACCESS TOKEN'
132
+ end
133
+
134
+ api_instance = OrderCloud::UserApi.new
135
+
136
+ buyer_id = "buyer_id_example" # String | ID of the buyer.
137
+
138
+ user_id = "user_id_example" # String | ID of the user.
139
+
140
+
141
+ begin
142
+ result = api_instance.get(buyer_id, user_id)
143
+ p result
144
+ rescue OrderCloud::ApiError => e
145
+ puts "Exception when calling UserApi->get: #{e}"
146
+ end
147
+ ```
148
+
149
+ ### Parameters
150
+
151
+ Name | Type | Description | Notes
152
+ ------------- | ------------- | ------------- | -------------
153
+ **buyer_id** | **String**| ID of the buyer. |
154
+ **user_id** | **String**| ID of the user. |
155
+
156
+ ### Return type
157
+
158
+ [**User**](User.md)
159
+
160
+ ### Authorization
161
+
162
+ [oauth2](../README.md#oauth2)
163
+
164
+ ### HTTP request headers
165
+
166
+ - **Content-Type**: application/json, text/plain; charset=utf-8
167
+ - **Accept**: application/json
168
+
169
+
170
+
171
+ # **get_access_token**
172
+ > AccessToken get_access_token(buyer_id, user_id, token_request)
173
+
174
+
175
+
176
+ ### Example
177
+ ```ruby
178
+ # load the gem
179
+ require 'order_cloud'
180
+ # setup authorization
181
+ OrderCloud.configure do |config|
182
+ # Configure OAuth2 access token for authorization: oauth2
183
+ config.access_token = 'YOUR ACCESS TOKEN'
184
+ end
185
+
186
+ api_instance = OrderCloud::UserApi.new
187
+
188
+ buyer_id = "buyer_id_example" # String | ID of the buyer.
189
+
190
+ user_id = "user_id_example" # String | ID of the user.
191
+
192
+ token_request = OrderCloud::ImpersonateTokenRequest.new # ImpersonateTokenRequest |
193
+
194
+
195
+ begin
196
+ result = api_instance.get_access_token(buyer_id, user_id, token_request)
197
+ p result
198
+ rescue OrderCloud::ApiError => e
199
+ puts "Exception when calling UserApi->get_access_token: #{e}"
200
+ end
201
+ ```
202
+
203
+ ### Parameters
204
+
205
+ Name | Type | Description | Notes
206
+ ------------- | ------------- | ------------- | -------------
207
+ **buyer_id** | **String**| ID of the buyer. |
208
+ **user_id** | **String**| ID of the user. |
209
+ **token_request** | [**ImpersonateTokenRequest**](ImpersonateTokenRequest.md)| |
210
+
211
+ ### Return type
212
+
213
+ [**AccessToken**](AccessToken.md)
214
+
215
+ ### Authorization
216
+
217
+ [oauth2](../README.md#oauth2)
218
+
219
+ ### HTTP request headers
220
+
221
+ - **Content-Type**: application/json, text/plain; charset=utf-8
222
+ - **Accept**: application/json
223
+
224
+
225
+
226
+ # **list**
227
+ > ListUser list(buyer_id, opts)
228
+
229
+
230
+
231
+ ### Example
232
+ ```ruby
233
+ # load the gem
234
+ require 'order_cloud'
235
+ # setup authorization
236
+ OrderCloud.configure do |config|
237
+ # Configure OAuth2 access token for authorization: oauth2
238
+ config.access_token = 'YOUR ACCESS TOKEN'
239
+ end
240
+
241
+ api_instance = OrderCloud::UserApi.new
242
+
243
+ buyer_id = "buyer_id_example" # String | ID of the buyer.
244
+
245
+ opts = {
246
+ user_group_id: "user_group_id_example", # String | ID of the user group.
247
+ search: "search_example", # String | Word or phrase to search for.
248
+ search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
249
+ sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
250
+ page: 56, # Integer | Page of results to return. Default: 1
251
+ page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
252
+ filters: {'key' => "filters_example"} # Hash<String, String> | Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'
253
+ }
254
+
255
+ begin
256
+ result = api_instance.list(buyer_id, opts)
257
+ p result
258
+ rescue OrderCloud::ApiError => e
259
+ puts "Exception when calling UserApi->list: #{e}"
260
+ end
261
+ ```
262
+
263
+ ### Parameters
264
+
265
+ Name | Type | Description | Notes
266
+ ------------- | ------------- | ------------- | -------------
267
+ **buyer_id** | **String**| ID of the buyer. |
268
+ **user_group_id** | **String**| ID of the user group. | [optional]
269
+ **search** | **String**| Word or phrase to search for. | [optional]
270
+ **search_on** | **String**| Comma-delimited list of fields to search on. | [optional]
271
+ **sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional]
272
+ **page** | **Integer**| Page of results to return. Default: 1 | [optional]
273
+ **page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
274
+ **filters** | [**Hash&lt;String, String&gt;**](String.md)| Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39; | [optional]
275
+
276
+ ### Return type
277
+
278
+ [**ListUser**](ListUser.md)
279
+
280
+ ### Authorization
281
+
282
+ [oauth2](../README.md#oauth2)
283
+
284
+ ### HTTP request headers
285
+
286
+ - **Content-Type**: application/json, text/plain; charset=utf-8
287
+ - **Accept**: application/json
288
+
289
+
290
+
291
+ # **patch**
292
+ > patch(buyer_id, user_id, user)
293
+
294
+
295
+
296
+ ### Example
297
+ ```ruby
298
+ # load the gem
299
+ require 'order_cloud'
300
+ # setup authorization
301
+ OrderCloud.configure do |config|
302
+ # Configure OAuth2 access token for authorization: oauth2
303
+ config.access_token = 'YOUR ACCESS TOKEN'
304
+ end
305
+
306
+ api_instance = OrderCloud::UserApi.new
307
+
308
+ buyer_id = "buyer_id_example" # String | ID of the buyer.
309
+
310
+ user_id = "user_id_example" # String | ID of the user.
311
+
312
+ user = OrderCloud::User.new # User |
313
+
314
+
315
+ begin
316
+ api_instance.patch(buyer_id, user_id, user)
317
+ rescue OrderCloud::ApiError => e
318
+ puts "Exception when calling UserApi->patch: #{e}"
319
+ end
320
+ ```
321
+
322
+ ### Parameters
323
+
324
+ Name | Type | Description | Notes
325
+ ------------- | ------------- | ------------- | -------------
326
+ **buyer_id** | **String**| ID of the buyer. |
327
+ **user_id** | **String**| ID of the user. |
328
+ **user** | [**User**](User.md)| |
329
+
330
+ ### Return type
331
+
332
+ nil (empty response body)
333
+
334
+ ### Authorization
335
+
336
+ [oauth2](../README.md#oauth2)
337
+
338
+ ### HTTP request headers
339
+
340
+ - **Content-Type**: application/json, text/plain; charset=utf-8
341
+ - **Accept**: application/json
342
+
343
+
344
+
345
+ # **update**
346
+ > User update(buyer_id, user_id, user)
347
+
348
+
349
+
350
+ ### Example
351
+ ```ruby
352
+ # load the gem
353
+ require 'order_cloud'
354
+ # setup authorization
355
+ OrderCloud.configure do |config|
356
+ # Configure OAuth2 access token for authorization: oauth2
357
+ config.access_token = 'YOUR ACCESS TOKEN'
358
+ end
359
+
360
+ api_instance = OrderCloud::UserApi.new
361
+
362
+ buyer_id = "buyer_id_example" # String | ID of the buyer.
363
+
364
+ user_id = "user_id_example" # String | ID of the user.
365
+
366
+ user = OrderCloud::User.new # User |
367
+
368
+
369
+ begin
370
+ result = api_instance.update(buyer_id, user_id, user)
371
+ p result
372
+ rescue OrderCloud::ApiError => e
373
+ puts "Exception when calling UserApi->update: #{e}"
374
+ end
375
+ ```
376
+
377
+ ### Parameters
378
+
379
+ Name | Type | Description | Notes
380
+ ------------- | ------------- | ------------- | -------------
381
+ **buyer_id** | **String**| ID of the buyer. |
382
+ **user_id** | **String**| ID of the user. |
383
+ **user** | [**User**](User.md)| |
384
+
385
+ ### Return type
386
+
387
+ [**User**](User.md)
388
+
389
+ ### Authorization
390
+
391
+ [oauth2](../README.md#oauth2)
392
+
393
+ ### HTTP request headers
394
+
395
+ - **Content-Type**: application/json, text/plain; charset=utf-8
396
+ - **Accept**: application/json
397
+
398
+
399
+
@@ -0,0 +1,11 @@
1
+ # OrderCloud::UserGroup
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | | [optional]
7
+ **name** | **String** | | [optional]
8
+ **description** | **String** | | [optional]
9
+ **xp** | **Object** | | [optional]
10
+
11
+
@@ -0,0 +1,508 @@
1
+ # OrderCloud::UserGroupApi
2
+
3
+ All URIs are relative to *https://api.ordercloud.io/v1*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create**](UserGroupApi.md#create) | **POST** /buyers/{buyerID}/usergroups |
8
+ [**delete**](UserGroupApi.md#delete) | **DELETE** /buyers/{buyerID}/usergroups/{userGroupID} |
9
+ [**delete_user_assignment**](UserGroupApi.md#delete_user_assignment) | **DELETE** /buyers/{buyerID}/usergroups/{userGroupID}/assignments/{userID} |
10
+ [**get**](UserGroupApi.md#get) | **GET** /buyers/{buyerID}/usergroups/{userGroupID} |
11
+ [**list**](UserGroupApi.md#list) | **GET** /buyers/{buyerID}/usergroups |
12
+ [**list_user_assignments**](UserGroupApi.md#list_user_assignments) | **GET** /buyers/{buyerID}/usergroups/assignments |
13
+ [**patch**](UserGroupApi.md#patch) | **PATCH** /buyers/{buyerID}/usergroups/{userGroupID} |
14
+ [**save_user_assignment**](UserGroupApi.md#save_user_assignment) | **POST** /buyers/{buyerID}/usergroups/assignments |
15
+ [**update**](UserGroupApi.md#update) | **PUT** /buyers/{buyerID}/usergroups/{userGroupID} |
16
+
17
+
18
+ # **create**
19
+ > UserGroup create(buyer_id, group)
20
+
21
+
22
+
23
+ ### Example
24
+ ```ruby
25
+ # load the gem
26
+ require 'order_cloud'
27
+ # setup authorization
28
+ OrderCloud.configure do |config|
29
+ # Configure OAuth2 access token for authorization: oauth2
30
+ config.access_token = 'YOUR ACCESS TOKEN'
31
+ end
32
+
33
+ api_instance = OrderCloud::UserGroupApi.new
34
+
35
+ buyer_id = "buyer_id_example" # String | ID of the buyer.
36
+
37
+ group = OrderCloud::UserGroup.new # UserGroup |
38
+
39
+
40
+ begin
41
+ result = api_instance.create(buyer_id, group)
42
+ p result
43
+ rescue OrderCloud::ApiError => e
44
+ puts "Exception when calling UserGroupApi->create: #{e}"
45
+ end
46
+ ```
47
+
48
+ ### Parameters
49
+
50
+ Name | Type | Description | Notes
51
+ ------------- | ------------- | ------------- | -------------
52
+ **buyer_id** | **String**| ID of the buyer. |
53
+ **group** | [**UserGroup**](UserGroup.md)| |
54
+
55
+ ### Return type
56
+
57
+ [**UserGroup**](UserGroup.md)
58
+
59
+ ### Authorization
60
+
61
+ [oauth2](../README.md#oauth2)
62
+
63
+ ### HTTP request headers
64
+
65
+ - **Content-Type**: application/json, text/plain; charset=utf-8
66
+ - **Accept**: application/json
67
+
68
+
69
+
70
+ # **delete**
71
+ > delete(buyer_id, user_group_id)
72
+
73
+
74
+
75
+ ### Example
76
+ ```ruby
77
+ # load the gem
78
+ require 'order_cloud'
79
+ # setup authorization
80
+ OrderCloud.configure do |config|
81
+ # Configure OAuth2 access token for authorization: oauth2
82
+ config.access_token = 'YOUR ACCESS TOKEN'
83
+ end
84
+
85
+ api_instance = OrderCloud::UserGroupApi.new
86
+
87
+ buyer_id = "buyer_id_example" # String | ID of the buyer.
88
+
89
+ user_group_id = "user_group_id_example" # String | ID of the user group.
90
+
91
+
92
+ begin
93
+ api_instance.delete(buyer_id, user_group_id)
94
+ rescue OrderCloud::ApiError => e
95
+ puts "Exception when calling UserGroupApi->delete: #{e}"
96
+ end
97
+ ```
98
+
99
+ ### Parameters
100
+
101
+ Name | Type | Description | Notes
102
+ ------------- | ------------- | ------------- | -------------
103
+ **buyer_id** | **String**| ID of the buyer. |
104
+ **user_group_id** | **String**| ID of the user group. |
105
+
106
+ ### Return type
107
+
108
+ nil (empty response body)
109
+
110
+ ### Authorization
111
+
112
+ [oauth2](../README.md#oauth2)
113
+
114
+ ### HTTP request headers
115
+
116
+ - **Content-Type**: application/json, text/plain; charset=utf-8
117
+ - **Accept**: application/json
118
+
119
+
120
+
121
+ # **delete_user_assignment**
122
+ > delete_user_assignment(buyer_id, user_group_id, user_id)
123
+
124
+
125
+
126
+ ### Example
127
+ ```ruby
128
+ # load the gem
129
+ require 'order_cloud'
130
+ # setup authorization
131
+ OrderCloud.configure do |config|
132
+ # Configure OAuth2 access token for authorization: oauth2
133
+ config.access_token = 'YOUR ACCESS TOKEN'
134
+ end
135
+
136
+ api_instance = OrderCloud::UserGroupApi.new
137
+
138
+ buyer_id = "buyer_id_example" # String | ID of the buyer.
139
+
140
+ user_group_id = "user_group_id_example" # String | ID of the user group.
141
+
142
+ user_id = "user_id_example" # String | ID of the user.
143
+
144
+
145
+ begin
146
+ api_instance.delete_user_assignment(buyer_id, user_group_id, user_id)
147
+ rescue OrderCloud::ApiError => e
148
+ puts "Exception when calling UserGroupApi->delete_user_assignment: #{e}"
149
+ end
150
+ ```
151
+
152
+ ### Parameters
153
+
154
+ Name | Type | Description | Notes
155
+ ------------- | ------------- | ------------- | -------------
156
+ **buyer_id** | **String**| ID of the buyer. |
157
+ **user_group_id** | **String**| ID of the user group. |
158
+ **user_id** | **String**| ID of the user. |
159
+
160
+ ### Return type
161
+
162
+ nil (empty response body)
163
+
164
+ ### Authorization
165
+
166
+ [oauth2](../README.md#oauth2)
167
+
168
+ ### HTTP request headers
169
+
170
+ - **Content-Type**: application/json, text/plain; charset=utf-8
171
+ - **Accept**: application/json
172
+
173
+
174
+
175
+ # **get**
176
+ > UserGroup get(buyer_id, user_group_id)
177
+
178
+
179
+
180
+ ### Example
181
+ ```ruby
182
+ # load the gem
183
+ require 'order_cloud'
184
+ # setup authorization
185
+ OrderCloud.configure do |config|
186
+ # Configure OAuth2 access token for authorization: oauth2
187
+ config.access_token = 'YOUR ACCESS TOKEN'
188
+ end
189
+
190
+ api_instance = OrderCloud::UserGroupApi.new
191
+
192
+ buyer_id = "buyer_id_example" # String | ID of the buyer.
193
+
194
+ user_group_id = "user_group_id_example" # String | ID of the user group.
195
+
196
+
197
+ begin
198
+ result = api_instance.get(buyer_id, user_group_id)
199
+ p result
200
+ rescue OrderCloud::ApiError => e
201
+ puts "Exception when calling UserGroupApi->get: #{e}"
202
+ end
203
+ ```
204
+
205
+ ### Parameters
206
+
207
+ Name | Type | Description | Notes
208
+ ------------- | ------------- | ------------- | -------------
209
+ **buyer_id** | **String**| ID of the buyer. |
210
+ **user_group_id** | **String**| ID of the user group. |
211
+
212
+ ### Return type
213
+
214
+ [**UserGroup**](UserGroup.md)
215
+
216
+ ### Authorization
217
+
218
+ [oauth2](../README.md#oauth2)
219
+
220
+ ### HTTP request headers
221
+
222
+ - **Content-Type**: application/json, text/plain; charset=utf-8
223
+ - **Accept**: application/json
224
+
225
+
226
+
227
+ # **list**
228
+ > ListUserGroup list(buyer_id, opts)
229
+
230
+
231
+
232
+ ### Example
233
+ ```ruby
234
+ # load the gem
235
+ require 'order_cloud'
236
+ # setup authorization
237
+ OrderCloud.configure do |config|
238
+ # Configure OAuth2 access token for authorization: oauth2
239
+ config.access_token = 'YOUR ACCESS TOKEN'
240
+ end
241
+
242
+ api_instance = OrderCloud::UserGroupApi.new
243
+
244
+ buyer_id = "buyer_id_example" # String | ID of the buyer.
245
+
246
+ opts = {
247
+ search: "search_example", # String | Word or phrase to search for.
248
+ search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
249
+ sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
250
+ page: 56, # Integer | Page of results to return. Default: 1
251
+ page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
252
+ filters: {'key' => "filters_example"} # Hash<String, String> | Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'
253
+ }
254
+
255
+ begin
256
+ result = api_instance.list(buyer_id, opts)
257
+ p result
258
+ rescue OrderCloud::ApiError => e
259
+ puts "Exception when calling UserGroupApi->list: #{e}"
260
+ end
261
+ ```
262
+
263
+ ### Parameters
264
+
265
+ Name | Type | Description | Notes
266
+ ------------- | ------------- | ------------- | -------------
267
+ **buyer_id** | **String**| ID of the buyer. |
268
+ **search** | **String**| Word or phrase to search for. | [optional]
269
+ **search_on** | **String**| Comma-delimited list of fields to search on. | [optional]
270
+ **sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional]
271
+ **page** | **Integer**| Page of results to return. Default: 1 | [optional]
272
+ **page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
273
+ **filters** | [**Hash&lt;String, String&gt;**](String.md)| Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39; | [optional]
274
+
275
+ ### Return type
276
+
277
+ [**ListUserGroup**](ListUserGroup.md)
278
+
279
+ ### Authorization
280
+
281
+ [oauth2](../README.md#oauth2)
282
+
283
+ ### HTTP request headers
284
+
285
+ - **Content-Type**: application/json, text/plain; charset=utf-8
286
+ - **Accept**: application/json
287
+
288
+
289
+
290
+ # **list_user_assignments**
291
+ > ListUserGroupAssignment list_user_assignments(buyer_id, opts)
292
+
293
+
294
+
295
+ ### Example
296
+ ```ruby
297
+ # load the gem
298
+ require 'order_cloud'
299
+ # setup authorization
300
+ OrderCloud.configure do |config|
301
+ # Configure OAuth2 access token for authorization: oauth2
302
+ config.access_token = 'YOUR ACCESS TOKEN'
303
+ end
304
+
305
+ api_instance = OrderCloud::UserGroupApi.new
306
+
307
+ buyer_id = "buyer_id_example" # String | ID of the buyer.
308
+
309
+ opts = {
310
+ user_group_id: "user_group_id_example", # String | ID of the user group.
311
+ user_id: "user_id_example", # String | ID of the user.
312
+ page: 56, # Integer | Page of results to return. Default: 1
313
+ page_size: 56 # Integer | Number of results to return per page. Default: 20, max: 100.
314
+ }
315
+
316
+ begin
317
+ result = api_instance.list_user_assignments(buyer_id, opts)
318
+ p result
319
+ rescue OrderCloud::ApiError => e
320
+ puts "Exception when calling UserGroupApi->list_user_assignments: #{e}"
321
+ end
322
+ ```
323
+
324
+ ### Parameters
325
+
326
+ Name | Type | Description | Notes
327
+ ------------- | ------------- | ------------- | -------------
328
+ **buyer_id** | **String**| ID of the buyer. |
329
+ **user_group_id** | **String**| ID of the user group. | [optional]
330
+ **user_id** | **String**| ID of the user. | [optional]
331
+ **page** | **Integer**| Page of results to return. Default: 1 | [optional]
332
+ **page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
333
+
334
+ ### Return type
335
+
336
+ [**ListUserGroupAssignment**](ListUserGroupAssignment.md)
337
+
338
+ ### Authorization
339
+
340
+ [oauth2](../README.md#oauth2)
341
+
342
+ ### HTTP request headers
343
+
344
+ - **Content-Type**: application/json, text/plain; charset=utf-8
345
+ - **Accept**: application/json
346
+
347
+
348
+
349
+ # **patch**
350
+ > patch(buyer_id, user_group_id, group)
351
+
352
+
353
+
354
+ ### Example
355
+ ```ruby
356
+ # load the gem
357
+ require 'order_cloud'
358
+ # setup authorization
359
+ OrderCloud.configure do |config|
360
+ # Configure OAuth2 access token for authorization: oauth2
361
+ config.access_token = 'YOUR ACCESS TOKEN'
362
+ end
363
+
364
+ api_instance = OrderCloud::UserGroupApi.new
365
+
366
+ buyer_id = "buyer_id_example" # String | ID of the buyer.
367
+
368
+ user_group_id = "user_group_id_example" # String | ID of the user group.
369
+
370
+ group = OrderCloud::UserGroup.new # UserGroup |
371
+
372
+
373
+ begin
374
+ api_instance.patch(buyer_id, user_group_id, group)
375
+ rescue OrderCloud::ApiError => e
376
+ puts "Exception when calling UserGroupApi->patch: #{e}"
377
+ end
378
+ ```
379
+
380
+ ### Parameters
381
+
382
+ Name | Type | Description | Notes
383
+ ------------- | ------------- | ------------- | -------------
384
+ **buyer_id** | **String**| ID of the buyer. |
385
+ **user_group_id** | **String**| ID of the user group. |
386
+ **group** | [**UserGroup**](UserGroup.md)| |
387
+
388
+ ### Return type
389
+
390
+ nil (empty response body)
391
+
392
+ ### Authorization
393
+
394
+ [oauth2](../README.md#oauth2)
395
+
396
+ ### HTTP request headers
397
+
398
+ - **Content-Type**: application/json, text/plain; charset=utf-8
399
+ - **Accept**: application/json
400
+
401
+
402
+
403
+ # **save_user_assignment**
404
+ > save_user_assignment(buyer_id, user_group_assignment)
405
+
406
+
407
+
408
+ ### Example
409
+ ```ruby
410
+ # load the gem
411
+ require 'order_cloud'
412
+ # setup authorization
413
+ OrderCloud.configure do |config|
414
+ # Configure OAuth2 access token for authorization: oauth2
415
+ config.access_token = 'YOUR ACCESS TOKEN'
416
+ end
417
+
418
+ api_instance = OrderCloud::UserGroupApi.new
419
+
420
+ buyer_id = "buyer_id_example" # String | ID of the buyer.
421
+
422
+ user_group_assignment = OrderCloud::UserGroupAssignment.new # UserGroupAssignment |
423
+
424
+
425
+ begin
426
+ api_instance.save_user_assignment(buyer_id, user_group_assignment)
427
+ rescue OrderCloud::ApiError => e
428
+ puts "Exception when calling UserGroupApi->save_user_assignment: #{e}"
429
+ end
430
+ ```
431
+
432
+ ### Parameters
433
+
434
+ Name | Type | Description | Notes
435
+ ------------- | ------------- | ------------- | -------------
436
+ **buyer_id** | **String**| ID of the buyer. |
437
+ **user_group_assignment** | [**UserGroupAssignment**](UserGroupAssignment.md)| |
438
+
439
+ ### Return type
440
+
441
+ nil (empty response body)
442
+
443
+ ### Authorization
444
+
445
+ [oauth2](../README.md#oauth2)
446
+
447
+ ### HTTP request headers
448
+
449
+ - **Content-Type**: application/json, text/plain; charset=utf-8
450
+ - **Accept**: application/json
451
+
452
+
453
+
454
+ # **update**
455
+ > UserGroup update(buyer_id, user_group_id, group)
456
+
457
+
458
+
459
+ ### Example
460
+ ```ruby
461
+ # load the gem
462
+ require 'order_cloud'
463
+ # setup authorization
464
+ OrderCloud.configure do |config|
465
+ # Configure OAuth2 access token for authorization: oauth2
466
+ config.access_token = 'YOUR ACCESS TOKEN'
467
+ end
468
+
469
+ api_instance = OrderCloud::UserGroupApi.new
470
+
471
+ buyer_id = "buyer_id_example" # String | ID of the buyer.
472
+
473
+ user_group_id = "user_group_id_example" # String | ID of the user group.
474
+
475
+ group = OrderCloud::UserGroup.new # UserGroup |
476
+
477
+
478
+ begin
479
+ result = api_instance.update(buyer_id, user_group_id, group)
480
+ p result
481
+ rescue OrderCloud::ApiError => e
482
+ puts "Exception when calling UserGroupApi->update: #{e}"
483
+ end
484
+ ```
485
+
486
+ ### Parameters
487
+
488
+ Name | Type | Description | Notes
489
+ ------------- | ------------- | ------------- | -------------
490
+ **buyer_id** | **String**| ID of the buyer. |
491
+ **user_group_id** | **String**| ID of the user group. |
492
+ **group** | [**UserGroup**](UserGroup.md)| |
493
+
494
+ ### Return type
495
+
496
+ [**UserGroup**](UserGroup.md)
497
+
498
+ ### Authorization
499
+
500
+ [oauth2](../README.md#oauth2)
501
+
502
+ ### HTTP request headers
503
+
504
+ - **Content-Type**: application/json, text/plain; charset=utf-8
505
+ - **Accept**: application/json
506
+
507
+
508
+