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