order_cloud 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE +201 -0
- data/README.md +476 -0
- data/Rakefile +31 -0
- data/docs/AccessToken.md +10 -0
- data/docs/Address.md +20 -0
- data/docs/AddressApi.md +520 -0
- data/docs/AddressAssignment.md +12 -0
- data/docs/AdminAddressApi.md +324 -0
- data/docs/AdminCompany.md +10 -0
- data/docs/AdminModelOnView.md +7 -0
- data/docs/AdminUserApi.md +323 -0
- data/docs/ApprovalRule.md +20 -0
- data/docs/ApprovalRuleApi.md +342 -0
- data/docs/BaseSpec.md +15 -0
- data/docs/Buyer.md +11 -0
- data/docs/BuyerAddress.md +11 -0
- data/docs/BuyerApi.md +324 -0
- data/docs/BuyerCreditCard.md +9 -0
- data/docs/BuyerProduct.md +9 -0
- data/docs/BuyerSpec.md +9 -0
- data/docs/Category.md +15 -0
- data/docs/CategoryApi.md +684 -0
- data/docs/CategoryAssignment.md +10 -0
- data/docs/CategoryProductAssignment.md +10 -0
- data/docs/CostCenter.md +11 -0
- data/docs/CostCenterApi.md +516 -0
- data/docs/CostCenterAssignment.md +10 -0
- data/docs/CreditCard.md +15 -0
- data/docs/CreditCardApi.md +516 -0
- data/docs/CreditCardAssignment.md +10 -0
- data/docs/EmailTemplate.md +12 -0
- data/docs/EmailTemplateApi.md +223 -0
- data/docs/File.md +10 -0
- data/docs/FileApi.md +162 -0
- data/docs/ImpersonateTokenRequest.md +9 -0
- data/docs/Inventory.md +12 -0
- data/docs/LineItem.md +23 -0
- data/docs/LineItemApi.md +478 -0
- data/docs/LineItemSpec.md +11 -0
- data/docs/ListAddress.md +9 -0
- data/docs/ListAddressAssignment.md +9 -0
- data/docs/ListAdminCompany.md +9 -0
- data/docs/ListApiClient.md +9 -0
- data/docs/ListApprovalRule.md +9 -0
- data/docs/ListBuyer.md +9 -0
- data/docs/ListBuyerAddress.md +9 -0
- data/docs/ListBuyerCreditCard.md +9 -0
- data/docs/ListBuyerProduct.md +9 -0
- data/docs/ListBuyerSpec.md +9 -0
- data/docs/ListCategory.md +9 -0
- data/docs/ListCategoryAssignment.md +9 -0
- data/docs/ListCategoryProductAssignment.md +9 -0
- data/docs/ListCostCenter.md +9 -0
- data/docs/ListCostCenterAssignment.md +9 -0
- data/docs/ListCreditCard.md +9 -0
- data/docs/ListCreditCardAssignment.md +9 -0
- data/docs/ListDevAccessibleCompany.md +9 -0
- data/docs/ListFile.md +9 -0
- data/docs/ListInventory.md +9 -0
- data/docs/ListLineItem.md +9 -0
- data/docs/ListOrder.md +9 -0
- data/docs/ListOrderApproval.md +9 -0
- data/docs/ListOrderPromotion.md +9 -0
- data/docs/ListPayment.md +9 -0
- data/docs/ListPriceSchedule.md +9 -0
- data/docs/ListProduct.md +9 -0
- data/docs/ListProductAssignment.md +9 -0
- data/docs/ListPromotion.md +9 -0
- data/docs/ListPromotionAssignment.md +9 -0
- data/docs/ListSecurityProfile.md +9 -0
- data/docs/ListSecurityProfileAssignment.md +9 -0
- data/docs/ListShipment.md +9 -0
- data/docs/ListSpec.md +9 -0
- data/docs/ListSpecOption.md +9 -0
- data/docs/ListSpecProductAssignment.md +9 -0
- data/docs/ListSpendingAccount.md +9 -0
- data/docs/ListSpendingAccountAssignment.md +9 -0
- data/docs/ListUser.md +9 -0
- data/docs/ListUserGroup.md +9 -0
- data/docs/ListUserGroupAssignment.md +9 -0
- data/docs/ListVariant.md +9 -0
- data/docs/ListWebHook.md +9 -0
- data/docs/ListWebHookRoute.md +9 -0
- data/docs/ListXpIndex.md +9 -0
- data/docs/MeApi.md +1488 -0
- data/docs/Meta.md +12 -0
- data/docs/Order.md +31 -0
- data/docs/OrderApi.md +1277 -0
- data/docs/OrderApproval.md +16 -0
- data/docs/OrderPromotion.md +8 -0
- data/docs/PasswordReset.md +10 -0
- data/docs/PasswordResetApi.md +109 -0
- data/docs/PasswordResetRequest.md +11 -0
- data/docs/Payment.md +16 -0
- data/docs/PaymentApi.md +601 -0
- data/docs/PaymentTransaction.md +15 -0
- data/docs/PingResponse.md +8 -0
- data/docs/PriceBreak.md +9 -0
- data/docs/PriceSchedule.md +18 -0
- data/docs/PriceScheduleApi.md +429 -0
- data/docs/Product.md +22 -0
- data/docs/ProductApi.md +1115 -0
- data/docs/ProductAssignment.md +13 -0
- data/docs/Promotion.md +21 -0
- data/docs/PromotionApi.md +495 -0
- data/docs/PromotionAssignment.md +11 -0
- data/docs/SecurityProfile.md +11 -0
- data/docs/SecurityProfileApi.md +290 -0
- data/docs/SecurityProfileAssignment.md +11 -0
- data/docs/Shipment.md +14 -0
- data/docs/ShipmentApi.md +459 -0
- data/docs/ShipmentItem.md +10 -0
- data/docs/Spec.md +8 -0
- data/docs/SpecApi.md +816 -0
- data/docs/SpecOption.md +14 -0
- data/docs/SpecProductAssignment.md +10 -0
- data/docs/SpendingAccount.md +15 -0
- data/docs/SpendingAccountApi.md +516 -0
- data/docs/SpendingAccountAssignment.md +11 -0
- data/docs/User.md +17 -0
- data/docs/UserApi.md +399 -0
- data/docs/UserGroup.md +11 -0
- data/docs/UserGroupApi.md +508 -0
- data/docs/UserGroupAssignment.md +9 -0
- data/docs/Variant.md +12 -0
- data/docs/WebHook.md +18 -0
- data/docs/WebHookRoute.md +10 -0
- data/docs/XpIndex.md +9 -0
- data/git_push.sh +67 -0
- data/lib/order_cloud.rb +176 -0
- data/lib/order_cloud/api/address_api.rb +628 -0
- data/lib/order_cloud/api/admin_address_api.rb +397 -0
- data/lib/order_cloud/api/admin_user_api.rb +396 -0
- data/lib/order_cloud/api/approval_rule_api.rb +421 -0
- data/lib/order_cloud/api/buyer_api.rb +397 -0
- data/lib/order_cloud/api/category_api.rb +817 -0
- data/lib/order_cloud/api/cost_center_api.rb +622 -0
- data/lib/order_cloud/api/credit_card_api.rb +622 -0
- data/lib/order_cloud/api/email_template_api.rb +283 -0
- data/lib/order_cloud/api/file_api.rb +206 -0
- data/lib/order_cloud/api/line_item_api.rb +583 -0
- data/lib/order_cloud/api/me_api.rb +1747 -0
- data/lib/order_cloud/api/order_api.rb +1509 -0
- data/lib/order_cloud/api/password_reset_api.rb +150 -0
- data/lib/order_cloud/api/payment_api.rb +728 -0
- data/lib/order_cloud/api/price_schedule_api.rb +519 -0
- data/lib/order_cloud/api/product_api.rb +1311 -0
- data/lib/order_cloud/api/promotion_api.rb +596 -0
- data/lib/order_cloud/api/security_profile_api.rb +361 -0
- data/lib/order_cloud/api/shipment_api.rb +558 -0
- data/lib/order_cloud/api/spec_api.rb +965 -0
- data/lib/order_cloud/api/spending_account_api.rb +622 -0
- data/lib/order_cloud/api/user_api.rb +488 -0
- data/lib/order_cloud/api/user_group_api.rb +613 -0
- data/lib/order_cloud/api_auth.rb +99 -0
- data/lib/order_cloud/api_client.rb +385 -0
- data/lib/order_cloud/api_error.rb +47 -0
- data/lib/order_cloud/configuration.rb +244 -0
- data/lib/order_cloud/models/access_token.rb +217 -0
- data/lib/order_cloud/models/address.rb +307 -0
- data/lib/order_cloud/models/address_assignment.rb +235 -0
- data/lib/order_cloud/models/admin_company.rb +217 -0
- data/lib/order_cloud/models/admin_model_on_view.rb +190 -0
- data/lib/order_cloud/models/approval_rule.rb +307 -0
- data/lib/order_cloud/models/base_spec.rb +262 -0
- data/lib/order_cloud/models/buyer.rb +226 -0
- data/lib/order_cloud/models/buyer_address.rb +226 -0
- data/lib/order_cloud/models/buyer_credit_card.rb +208 -0
- data/lib/order_cloud/models/buyer_product.rb +208 -0
- data/lib/order_cloud/models/buyer_spec.rb +210 -0
- data/lib/order_cloud/models/category.rb +262 -0
- data/lib/order_cloud/models/category_assignment.rb +217 -0
- data/lib/order_cloud/models/category_product_assignment.rb +217 -0
- data/lib/order_cloud/models/cost_center.rb +226 -0
- data/lib/order_cloud/models/cost_center_assignment.rb +217 -0
- data/lib/order_cloud/models/credit_card.rb +262 -0
- data/lib/order_cloud/models/credit_card_assignment.rb +217 -0
- data/lib/order_cloud/models/email_template.rb +235 -0
- data/lib/order_cloud/models/file.rb +217 -0
- data/lib/order_cloud/models/impersonate_token_request.rb +208 -0
- data/lib/order_cloud/models/inventory.rb +235 -0
- data/lib/order_cloud/models/line_item.rb +336 -0
- data/lib/order_cloud/models/line_item_spec.rb +226 -0
- data/lib/order_cloud/models/list_address.rb +210 -0
- data/lib/order_cloud/models/list_address_assignment.rb +210 -0
- data/lib/order_cloud/models/list_admin_company.rb +210 -0
- data/lib/order_cloud/models/list_api_client.rb +210 -0
- data/lib/order_cloud/models/list_approval_rule.rb +210 -0
- data/lib/order_cloud/models/list_buyer.rb +210 -0
- data/lib/order_cloud/models/list_buyer_address.rb +210 -0
- data/lib/order_cloud/models/list_buyer_credit_card.rb +210 -0
- data/lib/order_cloud/models/list_buyer_product.rb +210 -0
- data/lib/order_cloud/models/list_buyer_spec.rb +210 -0
- data/lib/order_cloud/models/list_category.rb +210 -0
- data/lib/order_cloud/models/list_category_assignment.rb +210 -0
- data/lib/order_cloud/models/list_category_product_assignment.rb +210 -0
- data/lib/order_cloud/models/list_cost_center.rb +210 -0
- data/lib/order_cloud/models/list_cost_center_assignment.rb +210 -0
- data/lib/order_cloud/models/list_credit_card.rb +210 -0
- data/lib/order_cloud/models/list_credit_card_assignment.rb +210 -0
- data/lib/order_cloud/models/list_dev_accessible_company.rb +210 -0
- data/lib/order_cloud/models/list_file.rb +210 -0
- data/lib/order_cloud/models/list_inventory.rb +210 -0
- data/lib/order_cloud/models/list_line_item.rb +210 -0
- data/lib/order_cloud/models/list_order.rb +210 -0
- data/lib/order_cloud/models/list_order_approval.rb +210 -0
- data/lib/order_cloud/models/list_order_promotion.rb +210 -0
- data/lib/order_cloud/models/list_payment.rb +210 -0
- data/lib/order_cloud/models/list_price_schedule.rb +210 -0
- data/lib/order_cloud/models/list_product.rb +210 -0
- data/lib/order_cloud/models/list_product_assignment.rb +210 -0
- data/lib/order_cloud/models/list_promotion.rb +210 -0
- data/lib/order_cloud/models/list_promotion_assignment.rb +210 -0
- data/lib/order_cloud/models/list_security_profile.rb +210 -0
- data/lib/order_cloud/models/list_security_profile_assignment.rb +210 -0
- data/lib/order_cloud/models/list_shipment.rb +210 -0
- data/lib/order_cloud/models/list_spec.rb +210 -0
- data/lib/order_cloud/models/list_spec_option.rb +210 -0
- data/lib/order_cloud/models/list_spec_product_assignment.rb +210 -0
- data/lib/order_cloud/models/list_spending_account.rb +210 -0
- data/lib/order_cloud/models/list_spending_account_assignment.rb +210 -0
- data/lib/order_cloud/models/list_user.rb +210 -0
- data/lib/order_cloud/models/list_user_group.rb +210 -0
- data/lib/order_cloud/models/list_user_group_assignment.rb +210 -0
- data/lib/order_cloud/models/list_variant.rb +210 -0
- data/lib/order_cloud/models/list_web_hook.rb +210 -0
- data/lib/order_cloud/models/list_web_hook_route.rb +210 -0
- data/lib/order_cloud/models/list_xp_index.rb +210 -0
- data/lib/order_cloud/models/meta.rb +237 -0
- data/lib/order_cloud/models/order.rb +406 -0
- data/lib/order_cloud/models/order_approval.rb +271 -0
- data/lib/order_cloud/models/order_promotion.rb +199 -0
- data/lib/order_cloud/models/password_reset.rb +217 -0
- data/lib/order_cloud/models/password_reset_request.rb +226 -0
- data/lib/order_cloud/models/payment.rb +273 -0
- data/lib/order_cloud/models/payment_transaction.rb +262 -0
- data/lib/order_cloud/models/ping_response.rb +199 -0
- data/lib/order_cloud/models/price_break.rb +208 -0
- data/lib/order_cloud/models/price_schedule.rb +291 -0
- data/lib/order_cloud/models/product.rb +325 -0
- data/lib/order_cloud/models/product_assignment.rb +244 -0
- data/lib/order_cloud/models/promotion.rb +316 -0
- data/lib/order_cloud/models/promotion_assignment.rb +226 -0
- data/lib/order_cloud/models/security_profile.rb +228 -0
- data/lib/order_cloud/models/security_profile_assignment.rb +226 -0
- data/lib/order_cloud/models/shipment.rb +255 -0
- data/lib/order_cloud/models/shipment_item.rb +217 -0
- data/lib/order_cloud/models/spec.rb +199 -0
- data/lib/order_cloud/models/spec_option.rb +253 -0
- data/lib/order_cloud/models/spec_product_assignment.rb +217 -0
- data/lib/order_cloud/models/spending_account.rb +262 -0
- data/lib/order_cloud/models/spending_account_assignment.rb +226 -0
- data/lib/order_cloud/models/user.rb +280 -0
- data/lib/order_cloud/models/user_group.rb +226 -0
- data/lib/order_cloud/models/user_group_assignment.rb +208 -0
- data/lib/order_cloud/models/variant.rb +235 -0
- data/lib/order_cloud/models/web_hook.rb +289 -0
- data/lib/order_cloud/models/web_hook_route.rb +217 -0
- data/lib/order_cloud/models/xp_index.rb +208 -0
- data/lib/order_cloud/version.rb +26 -0
- data/order_cloud.gemspec +56 -0
- data/spec/api/address_api_spec.rb +179 -0
- data/spec/api/admin_address_api_spec.rb +125 -0
- data/spec/api/admin_user_api_spec.rb +125 -0
- data/spec/api/approval_rule_api_spec.rb +131 -0
- data/spec/api/buyer_api_spec.rb +125 -0
- data/spec/api/category_api_spec.rb +221 -0
- data/spec/api/cost_center_api_spec.rb +177 -0
- data/spec/api/credit_card_api_spec.rb +177 -0
- data/spec/api/email_template_api_spec.rb +100 -0
- data/spec/api/file_api_spec.rb +83 -0
- data/spec/api/line_item_api_spec.rb +167 -0
- data/spec/api/me_api_spec.rb +431 -0
- data/spec/api/order_api_spec.rb +375 -0
- data/spec/api/password_reset_api_spec.rb +71 -0
- data/spec/api/payment_api_spec.rb +199 -0
- data/spec/api/price_schedule_api_spec.rb +151 -0
- data/spec/api/product_api_spec.rb +330 -0
- data/spec/api/promotion_api_spec.rb +170 -0
- data/spec/api/security_profile_api_spec.rb +120 -0
- data/spec/api/shipment_api_spec.rb +161 -0
- data/spec/api/spec_api_spec.rb +250 -0
- data/spec/api/spending_account_api_spec.rb +177 -0
- data/spec/api/user_api_spec.rb +146 -0
- data/spec/api/user_group_api_spec.rb +174 -0
- data/spec/api_auth_spec.rb +165 -0
- data/spec/api_client_spec.rb +237 -0
- data/spec/configuration_spec.rb +80 -0
- data/spec/models/access_token_spec.rb +65 -0
- data/spec/models/address_assignment_spec.rb +77 -0
- data/spec/models/address_spec.rb +125 -0
- data/spec/models/admin_company_spec.rb +65 -0
- data/spec/models/admin_model_on_view_spec.rb +47 -0
- data/spec/models/approval_rule_spec.rb +125 -0
- data/spec/models/base_spec_spec.rb +95 -0
- data/spec/models/buyer_address_spec.rb +71 -0
- data/spec/models/buyer_credit_card_spec.rb +59 -0
- data/spec/models/buyer_product_spec.rb +59 -0
- data/spec/models/buyer_spec.rb +71 -0
- data/spec/models/buyer_spec_spec.rb +59 -0
- data/spec/models/category_assignment_spec.rb +65 -0
- data/spec/models/category_product_assignment_spec.rb +65 -0
- data/spec/models/category_spec.rb +95 -0
- data/spec/models/cost_center_assignment_spec.rb +65 -0
- data/spec/models/cost_center_spec.rb +71 -0
- data/spec/models/credit_card_assignment_spec.rb +65 -0
- data/spec/models/credit_card_spec.rb +95 -0
- data/spec/models/email_template_spec.rb +77 -0
- data/spec/models/file_spec.rb +65 -0
- data/spec/models/impersonate_token_request_spec.rb +59 -0
- data/spec/models/inventory_spec.rb +77 -0
- data/spec/models/line_item_spec.rb +143 -0
- data/spec/models/line_item_spec_spec.rb +71 -0
- data/spec/models/list_address_assignment_spec.rb +59 -0
- data/spec/models/list_address_spec.rb +59 -0
- data/spec/models/list_admin_company_spec.rb +59 -0
- data/spec/models/list_api_client_spec.rb +59 -0
- data/spec/models/list_approval_rule_spec.rb +59 -0
- data/spec/models/list_buyer_address_spec.rb +59 -0
- data/spec/models/list_buyer_credit_card_spec.rb +59 -0
- data/spec/models/list_buyer_product_spec.rb +59 -0
- data/spec/models/list_buyer_spec.rb +59 -0
- data/spec/models/list_buyer_spec_spec.rb +59 -0
- data/spec/models/list_category_assignment_spec.rb +59 -0
- data/spec/models/list_category_product_assignment_spec.rb +59 -0
- data/spec/models/list_category_spec.rb +59 -0
- data/spec/models/list_cost_center_assignment_spec.rb +59 -0
- data/spec/models/list_cost_center_spec.rb +59 -0
- data/spec/models/list_credit_card_assignment_spec.rb +59 -0
- data/spec/models/list_credit_card_spec.rb +59 -0
- data/spec/models/list_dev_accessible_company_spec.rb +59 -0
- data/spec/models/list_file_spec.rb +59 -0
- data/spec/models/list_inventory_spec.rb +59 -0
- data/spec/models/list_line_item_spec.rb +59 -0
- data/spec/models/list_order_approval_spec.rb +59 -0
- data/spec/models/list_order_promotion_spec.rb +59 -0
- data/spec/models/list_order_spec.rb +59 -0
- data/spec/models/list_payment_spec.rb +59 -0
- data/spec/models/list_price_schedule_spec.rb +59 -0
- data/spec/models/list_product_assignment_spec.rb +59 -0
- data/spec/models/list_product_spec.rb +59 -0
- data/spec/models/list_promotion_assignment_spec.rb +59 -0
- data/spec/models/list_promotion_spec.rb +59 -0
- data/spec/models/list_security_profile_assignment_spec.rb +59 -0
- data/spec/models/list_security_profile_spec.rb +59 -0
- data/spec/models/list_shipment_spec.rb +59 -0
- data/spec/models/list_spec_option_spec.rb +59 -0
- data/spec/models/list_spec_product_assignment_spec.rb +59 -0
- data/spec/models/list_spec_spec.rb +59 -0
- data/spec/models/list_spending_account_assignment_spec.rb +59 -0
- data/spec/models/list_spending_account_spec.rb +59 -0
- data/spec/models/list_user_group_assignment_spec.rb +59 -0
- data/spec/models/list_user_group_spec.rb +59 -0
- data/spec/models/list_user_spec.rb +59 -0
- data/spec/models/list_variant_spec.rb +59 -0
- data/spec/models/list_web_hook_route_spec.rb +59 -0
- data/spec/models/list_web_hook_spec.rb +59 -0
- data/spec/models/list_xp_index_spec.rb +59 -0
- data/spec/models/meta_spec.rb +77 -0
- data/spec/models/order_approval_spec.rb +101 -0
- data/spec/models/order_promotion_spec.rb +53 -0
- data/spec/models/order_spec.rb +191 -0
- data/spec/models/password_reset_request_spec.rb +71 -0
- data/spec/models/password_reset_spec.rb +65 -0
- data/spec/models/payment_spec.rb +101 -0
- data/spec/models/payment_transaction_spec.rb +95 -0
- data/spec/models/ping_response_spec.rb +53 -0
- data/spec/models/price_break_spec.rb +59 -0
- data/spec/models/price_schedule_spec.rb +113 -0
- data/spec/models/product_assignment_spec.rb +83 -0
- data/spec/models/product_spec.rb +137 -0
- data/spec/models/promotion_assignment_spec.rb +71 -0
- data/spec/models/promotion_spec.rb +131 -0
- data/spec/models/security_profile_assignment_spec.rb +71 -0
- data/spec/models/security_profile_spec.rb +71 -0
- data/spec/models/shipment_item_spec.rb +65 -0
- data/spec/models/shipment_spec.rb +89 -0
- data/spec/models/spec_option_spec.rb +89 -0
- data/spec/models/spec_product_assignment_spec.rb +65 -0
- data/spec/models/spec_spec.rb +53 -0
- data/spec/models/spending_account_assignment_spec.rb +71 -0
- data/spec/models/spending_account_spec.rb +95 -0
- data/spec/models/user_group_assignment_spec.rb +59 -0
- data/spec/models/user_group_spec.rb +71 -0
- data/spec/models/user_spec.rb +107 -0
- data/spec/models/variant_spec.rb +77 -0
- data/spec/models/web_hook_route_spec.rb +65 -0
- data/spec/models/web_hook_spec.rb +113 -0
- data/spec/models/xp_index_spec.rb +59 -0
- data/spec/spec_helper.rb +122 -0
- metadata +757 -0
@@ -0,0 +1,9 @@
|
|
1
|
+
# OrderCloud::ListUserGroupAssignment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**items** | [**Array<UserGroupAssignment>**](UserGroupAssignment.md) | | [optional]
|
7
|
+
**meta** | [**Meta**](Meta.md) | | [optional]
|
8
|
+
|
9
|
+
|
data/docs/ListVariant.md
ADDED
data/docs/ListWebHook.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# OrderCloud::ListWebHookRoute
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**items** | [**Array<WebHookRoute>**](WebHookRoute.md) | | [optional]
|
7
|
+
**meta** | [**Meta**](Meta.md) | | [optional]
|
8
|
+
|
9
|
+
|
data/docs/ListXpIndex.md
ADDED
data/docs/MeApi.md
ADDED
@@ -0,0 +1,1488 @@
|
|
1
|
+
# OrderCloud::MeApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ordercloud.io/v1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create_address**](MeApi.md#create_address) | **POST** /me/addresses |
|
8
|
+
[**create_credit_card**](MeApi.md#create_credit_card) | **POST** /me/creditcards |
|
9
|
+
[**delete_address**](MeApi.md#delete_address) | **DELETE** /me/addresses/{addressID} |
|
10
|
+
[**delete_credit_card**](MeApi.md#delete_credit_card) | **DELETE** /me/creditcards/{creditcardID} |
|
11
|
+
[**get**](MeApi.md#get) | **GET** /me |
|
12
|
+
[**get_address**](MeApi.md#get_address) | **GET** /me/addresses/{addressID} |
|
13
|
+
[**get_credit_card**](MeApi.md#get_credit_card) | **GET** /me/creditcards/{creditcardID} |
|
14
|
+
[**get_order**](MeApi.md#get_order) | **GET** /me/orders/{orderID} |
|
15
|
+
[**get_product**](MeApi.md#get_product) | **GET** /me/products/{productID} |
|
16
|
+
[**get_promotion**](MeApi.md#get_promotion) | **GET** /me/promotions/{promotionID} |
|
17
|
+
[**get_spec**](MeApi.md#get_spec) | **GET** /me/products/{productID}/specs/{specID} |
|
18
|
+
[**list_addresses**](MeApi.md#list_addresses) | **GET** /me/addresses |
|
19
|
+
[**list_categories**](MeApi.md#list_categories) | **GET** /me/categories |
|
20
|
+
[**list_cost_centers**](MeApi.md#list_cost_centers) | **GET** /me/costcenters |
|
21
|
+
[**list_credit_cards**](MeApi.md#list_credit_cards) | **GET** /me/creditcards |
|
22
|
+
[**list_incoming_orders**](MeApi.md#list_incoming_orders) | **GET** /me/orders/incoming |
|
23
|
+
[**list_outgoing_orders**](MeApi.md#list_outgoing_orders) | **GET** /me/orders/outgoing |
|
24
|
+
[**list_products**](MeApi.md#list_products) | **GET** /me/products |
|
25
|
+
[**list_promotions**](MeApi.md#list_promotions) | **GET** /me/promotions |
|
26
|
+
[**list_specs**](MeApi.md#list_specs) | **GET** /me/products/{productID}/specs |
|
27
|
+
[**list_user_groups**](MeApi.md#list_user_groups) | **GET** /me/usergroups |
|
28
|
+
[**patch**](MeApi.md#patch) | **PATCH** /me |
|
29
|
+
[**patch_address**](MeApi.md#patch_address) | **PATCH** /me/addresses/{addressID} |
|
30
|
+
[**patch_credit_card**](MeApi.md#patch_credit_card) | **PATCH** /me/creditcards/{creditcardID} |
|
31
|
+
[**update**](MeApi.md#update) | **PUT** /me |
|
32
|
+
[**update_address**](MeApi.md#update_address) | **PUT** /me/addresses/{addressID} |
|
33
|
+
[**update_credit_card**](MeApi.md#update_credit_card) | **PUT** /me/creditcards/{creditcardID} |
|
34
|
+
|
35
|
+
|
36
|
+
# **create_address**
|
37
|
+
> BuyerAddress create_address(address)
|
38
|
+
|
39
|
+
|
40
|
+
|
41
|
+
### Example
|
42
|
+
```ruby
|
43
|
+
# load the gem
|
44
|
+
require 'order_cloud'
|
45
|
+
# setup authorization
|
46
|
+
OrderCloud.configure do |config|
|
47
|
+
# Configure OAuth2 access token for authorization: oauth2
|
48
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
49
|
+
end
|
50
|
+
|
51
|
+
api_instance = OrderCloud::MeApi.new
|
52
|
+
|
53
|
+
address = OrderCloud::BuyerAddress.new # BuyerAddress |
|
54
|
+
|
55
|
+
|
56
|
+
begin
|
57
|
+
result = api_instance.create_address(address)
|
58
|
+
p result
|
59
|
+
rescue OrderCloud::ApiError => e
|
60
|
+
puts "Exception when calling MeApi->create_address: #{e}"
|
61
|
+
end
|
62
|
+
```
|
63
|
+
|
64
|
+
### Parameters
|
65
|
+
|
66
|
+
Name | Type | Description | Notes
|
67
|
+
------------- | ------------- | ------------- | -------------
|
68
|
+
**address** | [**BuyerAddress**](BuyerAddress.md)| |
|
69
|
+
|
70
|
+
### Return type
|
71
|
+
|
72
|
+
[**BuyerAddress**](BuyerAddress.md)
|
73
|
+
|
74
|
+
### Authorization
|
75
|
+
|
76
|
+
[oauth2](../README.md#oauth2)
|
77
|
+
|
78
|
+
### HTTP request headers
|
79
|
+
|
80
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
81
|
+
- **Accept**: application/json
|
82
|
+
|
83
|
+
|
84
|
+
|
85
|
+
# **create_credit_card**
|
86
|
+
> BuyerCreditCard create_credit_card(credit_card)
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
### Example
|
91
|
+
```ruby
|
92
|
+
# load the gem
|
93
|
+
require 'order_cloud'
|
94
|
+
# setup authorization
|
95
|
+
OrderCloud.configure do |config|
|
96
|
+
# Configure OAuth2 access token for authorization: oauth2
|
97
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
98
|
+
end
|
99
|
+
|
100
|
+
api_instance = OrderCloud::MeApi.new
|
101
|
+
|
102
|
+
credit_card = OrderCloud::BuyerCreditCard.new # BuyerCreditCard |
|
103
|
+
|
104
|
+
|
105
|
+
begin
|
106
|
+
result = api_instance.create_credit_card(credit_card)
|
107
|
+
p result
|
108
|
+
rescue OrderCloud::ApiError => e
|
109
|
+
puts "Exception when calling MeApi->create_credit_card: #{e}"
|
110
|
+
end
|
111
|
+
```
|
112
|
+
|
113
|
+
### Parameters
|
114
|
+
|
115
|
+
Name | Type | Description | Notes
|
116
|
+
------------- | ------------- | ------------- | -------------
|
117
|
+
**credit_card** | [**BuyerCreditCard**](BuyerCreditCard.md)| |
|
118
|
+
|
119
|
+
### Return type
|
120
|
+
|
121
|
+
[**BuyerCreditCard**](BuyerCreditCard.md)
|
122
|
+
|
123
|
+
### Authorization
|
124
|
+
|
125
|
+
[oauth2](../README.md#oauth2)
|
126
|
+
|
127
|
+
### HTTP request headers
|
128
|
+
|
129
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
130
|
+
- **Accept**: application/json
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
# **delete_address**
|
135
|
+
> delete_address(address_id)
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
### Example
|
140
|
+
```ruby
|
141
|
+
# load the gem
|
142
|
+
require 'order_cloud'
|
143
|
+
# setup authorization
|
144
|
+
OrderCloud.configure do |config|
|
145
|
+
# Configure OAuth2 access token for authorization: oauth2
|
146
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
147
|
+
end
|
148
|
+
|
149
|
+
api_instance = OrderCloud::MeApi.new
|
150
|
+
|
151
|
+
address_id = "address_id_example" # String | ID of the address.
|
152
|
+
|
153
|
+
|
154
|
+
begin
|
155
|
+
api_instance.delete_address(address_id)
|
156
|
+
rescue OrderCloud::ApiError => e
|
157
|
+
puts "Exception when calling MeApi->delete_address: #{e}"
|
158
|
+
end
|
159
|
+
```
|
160
|
+
|
161
|
+
### Parameters
|
162
|
+
|
163
|
+
Name | Type | Description | Notes
|
164
|
+
------------- | ------------- | ------------- | -------------
|
165
|
+
**address_id** | **String**| ID of the address. |
|
166
|
+
|
167
|
+
### Return type
|
168
|
+
|
169
|
+
nil (empty response body)
|
170
|
+
|
171
|
+
### Authorization
|
172
|
+
|
173
|
+
[oauth2](../README.md#oauth2)
|
174
|
+
|
175
|
+
### HTTP request headers
|
176
|
+
|
177
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
178
|
+
- **Accept**: application/json
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
# **delete_credit_card**
|
183
|
+
> delete_credit_card(creditcard_id)
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
### Example
|
188
|
+
```ruby
|
189
|
+
# load the gem
|
190
|
+
require 'order_cloud'
|
191
|
+
# setup authorization
|
192
|
+
OrderCloud.configure do |config|
|
193
|
+
# Configure OAuth2 access token for authorization: oauth2
|
194
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
195
|
+
end
|
196
|
+
|
197
|
+
api_instance = OrderCloud::MeApi.new
|
198
|
+
|
199
|
+
creditcard_id = "creditcard_id_example" # String | ID of the creditcard.
|
200
|
+
|
201
|
+
|
202
|
+
begin
|
203
|
+
api_instance.delete_credit_card(creditcard_id)
|
204
|
+
rescue OrderCloud::ApiError => e
|
205
|
+
puts "Exception when calling MeApi->delete_credit_card: #{e}"
|
206
|
+
end
|
207
|
+
```
|
208
|
+
|
209
|
+
### Parameters
|
210
|
+
|
211
|
+
Name | Type | Description | Notes
|
212
|
+
------------- | ------------- | ------------- | -------------
|
213
|
+
**creditcard_id** | **String**| ID of the creditcard. |
|
214
|
+
|
215
|
+
### Return type
|
216
|
+
|
217
|
+
nil (empty response body)
|
218
|
+
|
219
|
+
### Authorization
|
220
|
+
|
221
|
+
[oauth2](../README.md#oauth2)
|
222
|
+
|
223
|
+
### HTTP request headers
|
224
|
+
|
225
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
226
|
+
- **Accept**: application/json
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
# **get**
|
231
|
+
> User get
|
232
|
+
|
233
|
+
|
234
|
+
|
235
|
+
### Example
|
236
|
+
```ruby
|
237
|
+
# load the gem
|
238
|
+
require 'order_cloud'
|
239
|
+
# setup authorization
|
240
|
+
OrderCloud.configure do |config|
|
241
|
+
# Configure OAuth2 access token for authorization: oauth2
|
242
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
243
|
+
end
|
244
|
+
|
245
|
+
api_instance = OrderCloud::MeApi.new
|
246
|
+
|
247
|
+
begin
|
248
|
+
result = api_instance.get
|
249
|
+
p result
|
250
|
+
rescue OrderCloud::ApiError => e
|
251
|
+
puts "Exception when calling MeApi->get: #{e}"
|
252
|
+
end
|
253
|
+
```
|
254
|
+
|
255
|
+
### Parameters
|
256
|
+
This endpoint does not need any parameter.
|
257
|
+
|
258
|
+
### Return type
|
259
|
+
|
260
|
+
[**User**](User.md)
|
261
|
+
|
262
|
+
### Authorization
|
263
|
+
|
264
|
+
[oauth2](../README.md#oauth2)
|
265
|
+
|
266
|
+
### HTTP request headers
|
267
|
+
|
268
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
269
|
+
- **Accept**: application/json
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
# **get_address**
|
274
|
+
> BuyerAddress get_address(address_id)
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
### Example
|
279
|
+
```ruby
|
280
|
+
# load the gem
|
281
|
+
require 'order_cloud'
|
282
|
+
# setup authorization
|
283
|
+
OrderCloud.configure do |config|
|
284
|
+
# Configure OAuth2 access token for authorization: oauth2
|
285
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
286
|
+
end
|
287
|
+
|
288
|
+
api_instance = OrderCloud::MeApi.new
|
289
|
+
|
290
|
+
address_id = "address_id_example" # String | ID of the address.
|
291
|
+
|
292
|
+
|
293
|
+
begin
|
294
|
+
result = api_instance.get_address(address_id)
|
295
|
+
p result
|
296
|
+
rescue OrderCloud::ApiError => e
|
297
|
+
puts "Exception when calling MeApi->get_address: #{e}"
|
298
|
+
end
|
299
|
+
```
|
300
|
+
|
301
|
+
### Parameters
|
302
|
+
|
303
|
+
Name | Type | Description | Notes
|
304
|
+
------------- | ------------- | ------------- | -------------
|
305
|
+
**address_id** | **String**| ID of the address. |
|
306
|
+
|
307
|
+
### Return type
|
308
|
+
|
309
|
+
[**BuyerAddress**](BuyerAddress.md)
|
310
|
+
|
311
|
+
### Authorization
|
312
|
+
|
313
|
+
[oauth2](../README.md#oauth2)
|
314
|
+
|
315
|
+
### HTTP request headers
|
316
|
+
|
317
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
318
|
+
- **Accept**: application/json
|
319
|
+
|
320
|
+
|
321
|
+
|
322
|
+
# **get_credit_card**
|
323
|
+
> BuyerCreditCard get_credit_card(creditcard_id)
|
324
|
+
|
325
|
+
|
326
|
+
|
327
|
+
### Example
|
328
|
+
```ruby
|
329
|
+
# load the gem
|
330
|
+
require 'order_cloud'
|
331
|
+
# setup authorization
|
332
|
+
OrderCloud.configure do |config|
|
333
|
+
# Configure OAuth2 access token for authorization: oauth2
|
334
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
335
|
+
end
|
336
|
+
|
337
|
+
api_instance = OrderCloud::MeApi.new
|
338
|
+
|
339
|
+
creditcard_id = "creditcard_id_example" # String | ID of the creditcard.
|
340
|
+
|
341
|
+
|
342
|
+
begin
|
343
|
+
result = api_instance.get_credit_card(creditcard_id)
|
344
|
+
p result
|
345
|
+
rescue OrderCloud::ApiError => e
|
346
|
+
puts "Exception when calling MeApi->get_credit_card: #{e}"
|
347
|
+
end
|
348
|
+
```
|
349
|
+
|
350
|
+
### Parameters
|
351
|
+
|
352
|
+
Name | Type | Description | Notes
|
353
|
+
------------- | ------------- | ------------- | -------------
|
354
|
+
**creditcard_id** | **String**| ID of the creditcard. |
|
355
|
+
|
356
|
+
### Return type
|
357
|
+
|
358
|
+
[**BuyerCreditCard**](BuyerCreditCard.md)
|
359
|
+
|
360
|
+
### Authorization
|
361
|
+
|
362
|
+
[oauth2](../README.md#oauth2)
|
363
|
+
|
364
|
+
### HTTP request headers
|
365
|
+
|
366
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
367
|
+
- **Accept**: application/json
|
368
|
+
|
369
|
+
|
370
|
+
|
371
|
+
# **get_order**
|
372
|
+
> Order get_order(order_id)
|
373
|
+
|
374
|
+
|
375
|
+
|
376
|
+
### Example
|
377
|
+
```ruby
|
378
|
+
# load the gem
|
379
|
+
require 'order_cloud'
|
380
|
+
# setup authorization
|
381
|
+
OrderCloud.configure do |config|
|
382
|
+
# Configure OAuth2 access token for authorization: oauth2
|
383
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
384
|
+
end
|
385
|
+
|
386
|
+
api_instance = OrderCloud::MeApi.new
|
387
|
+
|
388
|
+
order_id = "order_id_example" # String | ID of the order.
|
389
|
+
|
390
|
+
|
391
|
+
begin
|
392
|
+
result = api_instance.get_order(order_id)
|
393
|
+
p result
|
394
|
+
rescue OrderCloud::ApiError => e
|
395
|
+
puts "Exception when calling MeApi->get_order: #{e}"
|
396
|
+
end
|
397
|
+
```
|
398
|
+
|
399
|
+
### Parameters
|
400
|
+
|
401
|
+
Name | Type | Description | Notes
|
402
|
+
------------- | ------------- | ------------- | -------------
|
403
|
+
**order_id** | **String**| ID of the order. |
|
404
|
+
|
405
|
+
### Return type
|
406
|
+
|
407
|
+
[**Order**](Order.md)
|
408
|
+
|
409
|
+
### Authorization
|
410
|
+
|
411
|
+
[oauth2](../README.md#oauth2)
|
412
|
+
|
413
|
+
### HTTP request headers
|
414
|
+
|
415
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
416
|
+
- **Accept**: application/json
|
417
|
+
|
418
|
+
|
419
|
+
|
420
|
+
# **get_product**
|
421
|
+
> BuyerProduct get_product(product_id)
|
422
|
+
|
423
|
+
|
424
|
+
|
425
|
+
### Example
|
426
|
+
```ruby
|
427
|
+
# load the gem
|
428
|
+
require 'order_cloud'
|
429
|
+
# setup authorization
|
430
|
+
OrderCloud.configure do |config|
|
431
|
+
# Configure OAuth2 access token for authorization: oauth2
|
432
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
433
|
+
end
|
434
|
+
|
435
|
+
api_instance = OrderCloud::MeApi.new
|
436
|
+
|
437
|
+
product_id = "product_id_example" # String | ID of the product.
|
438
|
+
|
439
|
+
|
440
|
+
begin
|
441
|
+
result = api_instance.get_product(product_id)
|
442
|
+
p result
|
443
|
+
rescue OrderCloud::ApiError => e
|
444
|
+
puts "Exception when calling MeApi->get_product: #{e}"
|
445
|
+
end
|
446
|
+
```
|
447
|
+
|
448
|
+
### Parameters
|
449
|
+
|
450
|
+
Name | Type | Description | Notes
|
451
|
+
------------- | ------------- | ------------- | -------------
|
452
|
+
**product_id** | **String**| ID of the product. |
|
453
|
+
|
454
|
+
### Return type
|
455
|
+
|
456
|
+
[**BuyerProduct**](BuyerProduct.md)
|
457
|
+
|
458
|
+
### Authorization
|
459
|
+
|
460
|
+
[oauth2](../README.md#oauth2)
|
461
|
+
|
462
|
+
### HTTP request headers
|
463
|
+
|
464
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
465
|
+
- **Accept**: application/json
|
466
|
+
|
467
|
+
|
468
|
+
|
469
|
+
# **get_promotion**
|
470
|
+
> Promotion get_promotion(promotion_id)
|
471
|
+
|
472
|
+
|
473
|
+
|
474
|
+
### Example
|
475
|
+
```ruby
|
476
|
+
# load the gem
|
477
|
+
require 'order_cloud'
|
478
|
+
# setup authorization
|
479
|
+
OrderCloud.configure do |config|
|
480
|
+
# Configure OAuth2 access token for authorization: oauth2
|
481
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
482
|
+
end
|
483
|
+
|
484
|
+
api_instance = OrderCloud::MeApi.new
|
485
|
+
|
486
|
+
promotion_id = "promotion_id_example" # String | ID of the promotion.
|
487
|
+
|
488
|
+
|
489
|
+
begin
|
490
|
+
result = api_instance.get_promotion(promotion_id)
|
491
|
+
p result
|
492
|
+
rescue OrderCloud::ApiError => e
|
493
|
+
puts "Exception when calling MeApi->get_promotion: #{e}"
|
494
|
+
end
|
495
|
+
```
|
496
|
+
|
497
|
+
### Parameters
|
498
|
+
|
499
|
+
Name | Type | Description | Notes
|
500
|
+
------------- | ------------- | ------------- | -------------
|
501
|
+
**promotion_id** | **String**| ID of the promotion. |
|
502
|
+
|
503
|
+
### Return type
|
504
|
+
|
505
|
+
[**Promotion**](Promotion.md)
|
506
|
+
|
507
|
+
### Authorization
|
508
|
+
|
509
|
+
[oauth2](../README.md#oauth2)
|
510
|
+
|
511
|
+
### HTTP request headers
|
512
|
+
|
513
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
514
|
+
- **Accept**: application/json
|
515
|
+
|
516
|
+
|
517
|
+
|
518
|
+
# **get_spec**
|
519
|
+
> BuyerSpec get_spec(product_id, spec_id)
|
520
|
+
|
521
|
+
|
522
|
+
|
523
|
+
### Example
|
524
|
+
```ruby
|
525
|
+
# load the gem
|
526
|
+
require 'order_cloud'
|
527
|
+
# setup authorization
|
528
|
+
OrderCloud.configure do |config|
|
529
|
+
# Configure OAuth2 access token for authorization: oauth2
|
530
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
531
|
+
end
|
532
|
+
|
533
|
+
api_instance = OrderCloud::MeApi.new
|
534
|
+
|
535
|
+
product_id = "product_id_example" # String | ID of the product.
|
536
|
+
|
537
|
+
spec_id = "spec_id_example" # String | ID of the spec.
|
538
|
+
|
539
|
+
|
540
|
+
begin
|
541
|
+
result = api_instance.get_spec(product_id, spec_id)
|
542
|
+
p result
|
543
|
+
rescue OrderCloud::ApiError => e
|
544
|
+
puts "Exception when calling MeApi->get_spec: #{e}"
|
545
|
+
end
|
546
|
+
```
|
547
|
+
|
548
|
+
### Parameters
|
549
|
+
|
550
|
+
Name | Type | Description | Notes
|
551
|
+
------------- | ------------- | ------------- | -------------
|
552
|
+
**product_id** | **String**| ID of the product. |
|
553
|
+
**spec_id** | **String**| ID of the spec. |
|
554
|
+
|
555
|
+
### Return type
|
556
|
+
|
557
|
+
[**BuyerSpec**](BuyerSpec.md)
|
558
|
+
|
559
|
+
### Authorization
|
560
|
+
|
561
|
+
[oauth2](../README.md#oauth2)
|
562
|
+
|
563
|
+
### HTTP request headers
|
564
|
+
|
565
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
566
|
+
- **Accept**: application/json
|
567
|
+
|
568
|
+
|
569
|
+
|
570
|
+
# **list_addresses**
|
571
|
+
> ListBuyerAddress list_addresses(opts)
|
572
|
+
|
573
|
+
|
574
|
+
|
575
|
+
### Example
|
576
|
+
```ruby
|
577
|
+
# load the gem
|
578
|
+
require 'order_cloud'
|
579
|
+
# setup authorization
|
580
|
+
OrderCloud.configure do |config|
|
581
|
+
# Configure OAuth2 access token for authorization: oauth2
|
582
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
583
|
+
end
|
584
|
+
|
585
|
+
api_instance = OrderCloud::MeApi.new
|
586
|
+
|
587
|
+
opts = {
|
588
|
+
search: "search_example", # String | Word or phrase to search for.
|
589
|
+
search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
|
590
|
+
sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
|
591
|
+
page: 56, # Integer | Page of results to return. Default: 1
|
592
|
+
page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
|
593
|
+
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.???'
|
594
|
+
}
|
595
|
+
|
596
|
+
begin
|
597
|
+
result = api_instance.list_addresses(opts)
|
598
|
+
p result
|
599
|
+
rescue OrderCloud::ApiError => e
|
600
|
+
puts "Exception when calling MeApi->list_addresses: #{e}"
|
601
|
+
end
|
602
|
+
```
|
603
|
+
|
604
|
+
### Parameters
|
605
|
+
|
606
|
+
Name | Type | Description | Notes
|
607
|
+
------------- | ------------- | ------------- | -------------
|
608
|
+
**search** | **String**| Word or phrase to search for. | [optional]
|
609
|
+
**search_on** | **String**| Comma-delimited list of fields to search on. | [optional]
|
610
|
+
**sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional]
|
611
|
+
**page** | **Integer**| Page of results to return. Default: 1 | [optional]
|
612
|
+
**page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
|
613
|
+
**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]
|
614
|
+
|
615
|
+
### Return type
|
616
|
+
|
617
|
+
[**ListBuyerAddress**](ListBuyerAddress.md)
|
618
|
+
|
619
|
+
### Authorization
|
620
|
+
|
621
|
+
[oauth2](../README.md#oauth2)
|
622
|
+
|
623
|
+
### HTTP request headers
|
624
|
+
|
625
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
626
|
+
- **Accept**: application/json
|
627
|
+
|
628
|
+
|
629
|
+
|
630
|
+
# **list_categories**
|
631
|
+
> ListCategory list_categories(opts)
|
632
|
+
|
633
|
+
|
634
|
+
|
635
|
+
### Example
|
636
|
+
```ruby
|
637
|
+
# load the gem
|
638
|
+
require 'order_cloud'
|
639
|
+
# setup authorization
|
640
|
+
OrderCloud.configure do |config|
|
641
|
+
# Configure OAuth2 access token for authorization: oauth2
|
642
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
643
|
+
end
|
644
|
+
|
645
|
+
api_instance = OrderCloud::MeApi.new
|
646
|
+
|
647
|
+
opts = {
|
648
|
+
depth: "depth_example", # String | Depth of the category.
|
649
|
+
search: "search_example", # String | Word or phrase to search for.
|
650
|
+
search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
|
651
|
+
sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
|
652
|
+
page: 56, # Integer | Page of results to return. Default: 1
|
653
|
+
page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
|
654
|
+
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.???'
|
655
|
+
}
|
656
|
+
|
657
|
+
begin
|
658
|
+
result = api_instance.list_categories(opts)
|
659
|
+
p result
|
660
|
+
rescue OrderCloud::ApiError => e
|
661
|
+
puts "Exception when calling MeApi->list_categories: #{e}"
|
662
|
+
end
|
663
|
+
```
|
664
|
+
|
665
|
+
### Parameters
|
666
|
+
|
667
|
+
Name | Type | Description | Notes
|
668
|
+
------------- | ------------- | ------------- | -------------
|
669
|
+
**depth** | **String**| Depth of the category. | [optional]
|
670
|
+
**search** | **String**| Word or phrase to search for. | [optional]
|
671
|
+
**search_on** | **String**| Comma-delimited list of fields to search on. | [optional]
|
672
|
+
**sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional]
|
673
|
+
**page** | **Integer**| Page of results to return. Default: 1 | [optional]
|
674
|
+
**page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
|
675
|
+
**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]
|
676
|
+
|
677
|
+
### Return type
|
678
|
+
|
679
|
+
[**ListCategory**](ListCategory.md)
|
680
|
+
|
681
|
+
### Authorization
|
682
|
+
|
683
|
+
[oauth2](../README.md#oauth2)
|
684
|
+
|
685
|
+
### HTTP request headers
|
686
|
+
|
687
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
688
|
+
- **Accept**: application/json
|
689
|
+
|
690
|
+
|
691
|
+
|
692
|
+
# **list_cost_centers**
|
693
|
+
> ListCostCenter list_cost_centers(opts)
|
694
|
+
|
695
|
+
|
696
|
+
|
697
|
+
### Example
|
698
|
+
```ruby
|
699
|
+
# load the gem
|
700
|
+
require 'order_cloud'
|
701
|
+
# setup authorization
|
702
|
+
OrderCloud.configure do |config|
|
703
|
+
# Configure OAuth2 access token for authorization: oauth2
|
704
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
705
|
+
end
|
706
|
+
|
707
|
+
api_instance = OrderCloud::MeApi.new
|
708
|
+
|
709
|
+
opts = {
|
710
|
+
search: "search_example", # String | Word or phrase to search for.
|
711
|
+
search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
|
712
|
+
sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
|
713
|
+
page: 56, # Integer | Page of results to return. Default: 1
|
714
|
+
page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
|
715
|
+
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.???'
|
716
|
+
}
|
717
|
+
|
718
|
+
begin
|
719
|
+
result = api_instance.list_cost_centers(opts)
|
720
|
+
p result
|
721
|
+
rescue OrderCloud::ApiError => e
|
722
|
+
puts "Exception when calling MeApi->list_cost_centers: #{e}"
|
723
|
+
end
|
724
|
+
```
|
725
|
+
|
726
|
+
### Parameters
|
727
|
+
|
728
|
+
Name | Type | Description | Notes
|
729
|
+
------------- | ------------- | ------------- | -------------
|
730
|
+
**search** | **String**| Word or phrase to search for. | [optional]
|
731
|
+
**search_on** | **String**| Comma-delimited list of fields to search on. | [optional]
|
732
|
+
**sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional]
|
733
|
+
**page** | **Integer**| Page of results to return. Default: 1 | [optional]
|
734
|
+
**page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
|
735
|
+
**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]
|
736
|
+
|
737
|
+
### Return type
|
738
|
+
|
739
|
+
[**ListCostCenter**](ListCostCenter.md)
|
740
|
+
|
741
|
+
### Authorization
|
742
|
+
|
743
|
+
[oauth2](../README.md#oauth2)
|
744
|
+
|
745
|
+
### HTTP request headers
|
746
|
+
|
747
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
748
|
+
- **Accept**: application/json
|
749
|
+
|
750
|
+
|
751
|
+
|
752
|
+
# **list_credit_cards**
|
753
|
+
> ListBuyerCreditCard list_credit_cards(opts)
|
754
|
+
|
755
|
+
|
756
|
+
|
757
|
+
### Example
|
758
|
+
```ruby
|
759
|
+
# load the gem
|
760
|
+
require 'order_cloud'
|
761
|
+
# setup authorization
|
762
|
+
OrderCloud.configure do |config|
|
763
|
+
# Configure OAuth2 access token for authorization: oauth2
|
764
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
765
|
+
end
|
766
|
+
|
767
|
+
api_instance = OrderCloud::MeApi.new
|
768
|
+
|
769
|
+
opts = {
|
770
|
+
search: "search_example", # String | Word or phrase to search for.
|
771
|
+
search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
|
772
|
+
sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
|
773
|
+
page: 56, # Integer | Page of results to return. Default: 1
|
774
|
+
page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
|
775
|
+
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.???'
|
776
|
+
}
|
777
|
+
|
778
|
+
begin
|
779
|
+
result = api_instance.list_credit_cards(opts)
|
780
|
+
p result
|
781
|
+
rescue OrderCloud::ApiError => e
|
782
|
+
puts "Exception when calling MeApi->list_credit_cards: #{e}"
|
783
|
+
end
|
784
|
+
```
|
785
|
+
|
786
|
+
### Parameters
|
787
|
+
|
788
|
+
Name | Type | Description | Notes
|
789
|
+
------------- | ------------- | ------------- | -------------
|
790
|
+
**search** | **String**| Word or phrase to search for. | [optional]
|
791
|
+
**search_on** | **String**| Comma-delimited list of fields to search on. | [optional]
|
792
|
+
**sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional]
|
793
|
+
**page** | **Integer**| Page of results to return. Default: 1 | [optional]
|
794
|
+
**page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
|
795
|
+
**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]
|
796
|
+
|
797
|
+
### Return type
|
798
|
+
|
799
|
+
[**ListBuyerCreditCard**](ListBuyerCreditCard.md)
|
800
|
+
|
801
|
+
### Authorization
|
802
|
+
|
803
|
+
[oauth2](../README.md#oauth2)
|
804
|
+
|
805
|
+
### HTTP request headers
|
806
|
+
|
807
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
808
|
+
- **Accept**: application/json
|
809
|
+
|
810
|
+
|
811
|
+
|
812
|
+
# **list_incoming_orders**
|
813
|
+
> ListOrder list_incoming_orders(opts)
|
814
|
+
|
815
|
+
|
816
|
+
|
817
|
+
### Example
|
818
|
+
```ruby
|
819
|
+
# load the gem
|
820
|
+
require 'order_cloud'
|
821
|
+
# setup authorization
|
822
|
+
OrderCloud.configure do |config|
|
823
|
+
# Configure OAuth2 access token for authorization: oauth2
|
824
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
825
|
+
end
|
826
|
+
|
827
|
+
api_instance = OrderCloud::MeApi.new
|
828
|
+
|
829
|
+
opts = {
|
830
|
+
from: "from_example", # String | Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).
|
831
|
+
to: "to_example", # String | Upper bound of date range that the order was created (if outgoing) or submitted (if incoming).
|
832
|
+
search: "search_example", # String | Word or phrase to search for.
|
833
|
+
search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
|
834
|
+
sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
|
835
|
+
page: 56, # Integer | Page of results to return. Default: 1
|
836
|
+
page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
|
837
|
+
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.???'
|
838
|
+
}
|
839
|
+
|
840
|
+
begin
|
841
|
+
result = api_instance.list_incoming_orders(opts)
|
842
|
+
p result
|
843
|
+
rescue OrderCloud::ApiError => e
|
844
|
+
puts "Exception when calling MeApi->list_incoming_orders: #{e}"
|
845
|
+
end
|
846
|
+
```
|
847
|
+
|
848
|
+
### Parameters
|
849
|
+
|
850
|
+
Name | Type | Description | Notes
|
851
|
+
------------- | ------------- | ------------- | -------------
|
852
|
+
**from** | **String**| Lower bound of date range that the order was created (if outgoing) or submitted (if incoming). | [optional]
|
853
|
+
**to** | **String**| Upper bound of date range that the order was created (if outgoing) or submitted (if incoming). | [optional]
|
854
|
+
**search** | **String**| Word or phrase to search for. | [optional]
|
855
|
+
**search_on** | **String**| Comma-delimited list of fields to search on. | [optional]
|
856
|
+
**sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional]
|
857
|
+
**page** | **Integer**| Page of results to return. Default: 1 | [optional]
|
858
|
+
**page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
|
859
|
+
**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]
|
860
|
+
|
861
|
+
### Return type
|
862
|
+
|
863
|
+
[**ListOrder**](ListOrder.md)
|
864
|
+
|
865
|
+
### Authorization
|
866
|
+
|
867
|
+
[oauth2](../README.md#oauth2)
|
868
|
+
|
869
|
+
### HTTP request headers
|
870
|
+
|
871
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
872
|
+
- **Accept**: application/json
|
873
|
+
|
874
|
+
|
875
|
+
|
876
|
+
# **list_outgoing_orders**
|
877
|
+
> ListOrder list_outgoing_orders(opts)
|
878
|
+
|
879
|
+
|
880
|
+
|
881
|
+
### Example
|
882
|
+
```ruby
|
883
|
+
# load the gem
|
884
|
+
require 'order_cloud'
|
885
|
+
# setup authorization
|
886
|
+
OrderCloud.configure do |config|
|
887
|
+
# Configure OAuth2 access token for authorization: oauth2
|
888
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
889
|
+
end
|
890
|
+
|
891
|
+
api_instance = OrderCloud::MeApi.new
|
892
|
+
|
893
|
+
opts = {
|
894
|
+
from: "from_example", # String | Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).
|
895
|
+
to: "to_example", # String | Upper bound of date range that the order was created (if outgoing) or submitted (if incoming).
|
896
|
+
search: "search_example", # String | Word or phrase to search for.
|
897
|
+
search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
|
898
|
+
sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
|
899
|
+
page: 56, # Integer | Page of results to return. Default: 1
|
900
|
+
page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
|
901
|
+
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.???'
|
902
|
+
}
|
903
|
+
|
904
|
+
begin
|
905
|
+
result = api_instance.list_outgoing_orders(opts)
|
906
|
+
p result
|
907
|
+
rescue OrderCloud::ApiError => e
|
908
|
+
puts "Exception when calling MeApi->list_outgoing_orders: #{e}"
|
909
|
+
end
|
910
|
+
```
|
911
|
+
|
912
|
+
### Parameters
|
913
|
+
|
914
|
+
Name | Type | Description | Notes
|
915
|
+
------------- | ------------- | ------------- | -------------
|
916
|
+
**from** | **String**| Lower bound of date range that the order was created (if outgoing) or submitted (if incoming). | [optional]
|
917
|
+
**to** | **String**| Upper bound of date range that the order was created (if outgoing) or submitted (if incoming). | [optional]
|
918
|
+
**search** | **String**| Word or phrase to search for. | [optional]
|
919
|
+
**search_on** | **String**| Comma-delimited list of fields to search on. | [optional]
|
920
|
+
**sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional]
|
921
|
+
**page** | **Integer**| Page of results to return. Default: 1 | [optional]
|
922
|
+
**page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
|
923
|
+
**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]
|
924
|
+
|
925
|
+
### Return type
|
926
|
+
|
927
|
+
[**ListOrder**](ListOrder.md)
|
928
|
+
|
929
|
+
### Authorization
|
930
|
+
|
931
|
+
[oauth2](../README.md#oauth2)
|
932
|
+
|
933
|
+
### HTTP request headers
|
934
|
+
|
935
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
936
|
+
- **Accept**: application/json
|
937
|
+
|
938
|
+
|
939
|
+
|
940
|
+
# **list_products**
|
941
|
+
> ListBuyerProduct list_products(opts)
|
942
|
+
|
943
|
+
|
944
|
+
|
945
|
+
### Example
|
946
|
+
```ruby
|
947
|
+
# load the gem
|
948
|
+
require 'order_cloud'
|
949
|
+
# setup authorization
|
950
|
+
OrderCloud.configure do |config|
|
951
|
+
# Configure OAuth2 access token for authorization: oauth2
|
952
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
953
|
+
end
|
954
|
+
|
955
|
+
api_instance = OrderCloud::MeApi.new
|
956
|
+
|
957
|
+
opts = {
|
958
|
+
category_id: "category_id_example", # String | ID of the category.
|
959
|
+
search: "search_example", # String | Word or phrase to search for.
|
960
|
+
search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
|
961
|
+
sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
|
962
|
+
page: 56, # Integer | Page of results to return. Default: 1
|
963
|
+
page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
|
964
|
+
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.???'
|
965
|
+
}
|
966
|
+
|
967
|
+
begin
|
968
|
+
result = api_instance.list_products(opts)
|
969
|
+
p result
|
970
|
+
rescue OrderCloud::ApiError => e
|
971
|
+
puts "Exception when calling MeApi->list_products: #{e}"
|
972
|
+
end
|
973
|
+
```
|
974
|
+
|
975
|
+
### Parameters
|
976
|
+
|
977
|
+
Name | Type | Description | Notes
|
978
|
+
------------- | ------------- | ------------- | -------------
|
979
|
+
**category_id** | **String**| ID of the category. | [optional]
|
980
|
+
**search** | **String**| Word or phrase to search for. | [optional]
|
981
|
+
**search_on** | **String**| Comma-delimited list of fields to search on. | [optional]
|
982
|
+
**sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional]
|
983
|
+
**page** | **Integer**| Page of results to return. Default: 1 | [optional]
|
984
|
+
**page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
|
985
|
+
**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]
|
986
|
+
|
987
|
+
### Return type
|
988
|
+
|
989
|
+
[**ListBuyerProduct**](ListBuyerProduct.md)
|
990
|
+
|
991
|
+
### Authorization
|
992
|
+
|
993
|
+
[oauth2](../README.md#oauth2)
|
994
|
+
|
995
|
+
### HTTP request headers
|
996
|
+
|
997
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
998
|
+
- **Accept**: application/json
|
999
|
+
|
1000
|
+
|
1001
|
+
|
1002
|
+
# **list_promotions**
|
1003
|
+
> ListPromotion list_promotions(opts)
|
1004
|
+
|
1005
|
+
|
1006
|
+
|
1007
|
+
### Example
|
1008
|
+
```ruby
|
1009
|
+
# load the gem
|
1010
|
+
require 'order_cloud'
|
1011
|
+
# setup authorization
|
1012
|
+
OrderCloud.configure do |config|
|
1013
|
+
# Configure OAuth2 access token for authorization: oauth2
|
1014
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1015
|
+
end
|
1016
|
+
|
1017
|
+
api_instance = OrderCloud::MeApi.new
|
1018
|
+
|
1019
|
+
opts = {
|
1020
|
+
search: "search_example", # String | Word or phrase to search for.
|
1021
|
+
search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
|
1022
|
+
sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
|
1023
|
+
page: 56, # Integer | Page of results to return. Default: 1
|
1024
|
+
page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
|
1025
|
+
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.???'
|
1026
|
+
}
|
1027
|
+
|
1028
|
+
begin
|
1029
|
+
result = api_instance.list_promotions(opts)
|
1030
|
+
p result
|
1031
|
+
rescue OrderCloud::ApiError => e
|
1032
|
+
puts "Exception when calling MeApi->list_promotions: #{e}"
|
1033
|
+
end
|
1034
|
+
```
|
1035
|
+
|
1036
|
+
### Parameters
|
1037
|
+
|
1038
|
+
Name | Type | Description | Notes
|
1039
|
+
------------- | ------------- | ------------- | -------------
|
1040
|
+
**search** | **String**| Word or phrase to search for. | [optional]
|
1041
|
+
**search_on** | **String**| Comma-delimited list of fields to search on. | [optional]
|
1042
|
+
**sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional]
|
1043
|
+
**page** | **Integer**| Page of results to return. Default: 1 | [optional]
|
1044
|
+
**page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
|
1045
|
+
**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]
|
1046
|
+
|
1047
|
+
### Return type
|
1048
|
+
|
1049
|
+
[**ListPromotion**](ListPromotion.md)
|
1050
|
+
|
1051
|
+
### Authorization
|
1052
|
+
|
1053
|
+
[oauth2](../README.md#oauth2)
|
1054
|
+
|
1055
|
+
### HTTP request headers
|
1056
|
+
|
1057
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
1058
|
+
- **Accept**: application/json
|
1059
|
+
|
1060
|
+
|
1061
|
+
|
1062
|
+
# **list_specs**
|
1063
|
+
> ListBuyerSpec list_specs(product_id, opts)
|
1064
|
+
|
1065
|
+
|
1066
|
+
|
1067
|
+
### Example
|
1068
|
+
```ruby
|
1069
|
+
# load the gem
|
1070
|
+
require 'order_cloud'
|
1071
|
+
# setup authorization
|
1072
|
+
OrderCloud.configure do |config|
|
1073
|
+
# Configure OAuth2 access token for authorization: oauth2
|
1074
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1075
|
+
end
|
1076
|
+
|
1077
|
+
api_instance = OrderCloud::MeApi.new
|
1078
|
+
|
1079
|
+
product_id = "product_id_example" # String | ID of the product.
|
1080
|
+
|
1081
|
+
opts = {
|
1082
|
+
search: "search_example", # String | Word or phrase to search for.
|
1083
|
+
search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
|
1084
|
+
sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
|
1085
|
+
page: 56, # Integer | Page of results to return. Default: 1
|
1086
|
+
page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
|
1087
|
+
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.???'
|
1088
|
+
}
|
1089
|
+
|
1090
|
+
begin
|
1091
|
+
result = api_instance.list_specs(product_id, opts)
|
1092
|
+
p result
|
1093
|
+
rescue OrderCloud::ApiError => e
|
1094
|
+
puts "Exception when calling MeApi->list_specs: #{e}"
|
1095
|
+
end
|
1096
|
+
```
|
1097
|
+
|
1098
|
+
### Parameters
|
1099
|
+
|
1100
|
+
Name | Type | Description | Notes
|
1101
|
+
------------- | ------------- | ------------- | -------------
|
1102
|
+
**product_id** | **String**| ID of the product. |
|
1103
|
+
**search** | **String**| Word or phrase to search for. | [optional]
|
1104
|
+
**search_on** | **String**| Comma-delimited list of fields to search on. | [optional]
|
1105
|
+
**sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional]
|
1106
|
+
**page** | **Integer**| Page of results to return. Default: 1 | [optional]
|
1107
|
+
**page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
|
1108
|
+
**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]
|
1109
|
+
|
1110
|
+
### Return type
|
1111
|
+
|
1112
|
+
[**ListBuyerSpec**](ListBuyerSpec.md)
|
1113
|
+
|
1114
|
+
### Authorization
|
1115
|
+
|
1116
|
+
[oauth2](../README.md#oauth2)
|
1117
|
+
|
1118
|
+
### HTTP request headers
|
1119
|
+
|
1120
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
1121
|
+
- **Accept**: application/json
|
1122
|
+
|
1123
|
+
|
1124
|
+
|
1125
|
+
# **list_user_groups**
|
1126
|
+
> ListUserGroup list_user_groups(opts)
|
1127
|
+
|
1128
|
+
|
1129
|
+
|
1130
|
+
### Example
|
1131
|
+
```ruby
|
1132
|
+
# load the gem
|
1133
|
+
require 'order_cloud'
|
1134
|
+
# setup authorization
|
1135
|
+
OrderCloud.configure do |config|
|
1136
|
+
# Configure OAuth2 access token for authorization: oauth2
|
1137
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1138
|
+
end
|
1139
|
+
|
1140
|
+
api_instance = OrderCloud::MeApi.new
|
1141
|
+
|
1142
|
+
opts = {
|
1143
|
+
search: "search_example", # String | Word or phrase to search for.
|
1144
|
+
search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
|
1145
|
+
sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
|
1146
|
+
page: 56, # Integer | Page of results to return. Default: 1
|
1147
|
+
page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
|
1148
|
+
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.???'
|
1149
|
+
}
|
1150
|
+
|
1151
|
+
begin
|
1152
|
+
result = api_instance.list_user_groups(opts)
|
1153
|
+
p result
|
1154
|
+
rescue OrderCloud::ApiError => e
|
1155
|
+
puts "Exception when calling MeApi->list_user_groups: #{e}"
|
1156
|
+
end
|
1157
|
+
```
|
1158
|
+
|
1159
|
+
### Parameters
|
1160
|
+
|
1161
|
+
Name | Type | Description | Notes
|
1162
|
+
------------- | ------------- | ------------- | -------------
|
1163
|
+
**search** | **String**| Word or phrase to search for. | [optional]
|
1164
|
+
**search_on** | **String**| Comma-delimited list of fields to search on. | [optional]
|
1165
|
+
**sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional]
|
1166
|
+
**page** | **Integer**| Page of results to return. Default: 1 | [optional]
|
1167
|
+
**page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
|
1168
|
+
**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]
|
1169
|
+
|
1170
|
+
### Return type
|
1171
|
+
|
1172
|
+
[**ListUserGroup**](ListUserGroup.md)
|
1173
|
+
|
1174
|
+
### Authorization
|
1175
|
+
|
1176
|
+
[oauth2](../README.md#oauth2)
|
1177
|
+
|
1178
|
+
### HTTP request headers
|
1179
|
+
|
1180
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
1181
|
+
- **Accept**: application/json
|
1182
|
+
|
1183
|
+
|
1184
|
+
|
1185
|
+
# **patch**
|
1186
|
+
> User patch(user)
|
1187
|
+
|
1188
|
+
|
1189
|
+
|
1190
|
+
### Example
|
1191
|
+
```ruby
|
1192
|
+
# load the gem
|
1193
|
+
require 'order_cloud'
|
1194
|
+
# setup authorization
|
1195
|
+
OrderCloud.configure do |config|
|
1196
|
+
# Configure OAuth2 access token for authorization: oauth2
|
1197
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1198
|
+
end
|
1199
|
+
|
1200
|
+
api_instance = OrderCloud::MeApi.new
|
1201
|
+
|
1202
|
+
user = OrderCloud::User.new # User |
|
1203
|
+
|
1204
|
+
|
1205
|
+
begin
|
1206
|
+
result = api_instance.patch(user)
|
1207
|
+
p result
|
1208
|
+
rescue OrderCloud::ApiError => e
|
1209
|
+
puts "Exception when calling MeApi->patch: #{e}"
|
1210
|
+
end
|
1211
|
+
```
|
1212
|
+
|
1213
|
+
### Parameters
|
1214
|
+
|
1215
|
+
Name | Type | Description | Notes
|
1216
|
+
------------- | ------------- | ------------- | -------------
|
1217
|
+
**user** | [**User**](User.md)| |
|
1218
|
+
|
1219
|
+
### Return type
|
1220
|
+
|
1221
|
+
[**User**](User.md)
|
1222
|
+
|
1223
|
+
### Authorization
|
1224
|
+
|
1225
|
+
[oauth2](../README.md#oauth2)
|
1226
|
+
|
1227
|
+
### HTTP request headers
|
1228
|
+
|
1229
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
1230
|
+
- **Accept**: application/json
|
1231
|
+
|
1232
|
+
|
1233
|
+
|
1234
|
+
# **patch_address**
|
1235
|
+
> patch_address(address_id, address)
|
1236
|
+
|
1237
|
+
|
1238
|
+
|
1239
|
+
### Example
|
1240
|
+
```ruby
|
1241
|
+
# load the gem
|
1242
|
+
require 'order_cloud'
|
1243
|
+
# setup authorization
|
1244
|
+
OrderCloud.configure do |config|
|
1245
|
+
# Configure OAuth2 access token for authorization: oauth2
|
1246
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1247
|
+
end
|
1248
|
+
|
1249
|
+
api_instance = OrderCloud::MeApi.new
|
1250
|
+
|
1251
|
+
address_id = "address_id_example" # String | ID of the address.
|
1252
|
+
|
1253
|
+
address = OrderCloud::Address.new # Address |
|
1254
|
+
|
1255
|
+
|
1256
|
+
begin
|
1257
|
+
api_instance.patch_address(address_id, address)
|
1258
|
+
rescue OrderCloud::ApiError => e
|
1259
|
+
puts "Exception when calling MeApi->patch_address: #{e}"
|
1260
|
+
end
|
1261
|
+
```
|
1262
|
+
|
1263
|
+
### Parameters
|
1264
|
+
|
1265
|
+
Name | Type | Description | Notes
|
1266
|
+
------------- | ------------- | ------------- | -------------
|
1267
|
+
**address_id** | **String**| ID of the address. |
|
1268
|
+
**address** | [**Address**](Address.md)| |
|
1269
|
+
|
1270
|
+
### Return type
|
1271
|
+
|
1272
|
+
nil (empty response body)
|
1273
|
+
|
1274
|
+
### Authorization
|
1275
|
+
|
1276
|
+
[oauth2](../README.md#oauth2)
|
1277
|
+
|
1278
|
+
### HTTP request headers
|
1279
|
+
|
1280
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
1281
|
+
- **Accept**: application/json
|
1282
|
+
|
1283
|
+
|
1284
|
+
|
1285
|
+
# **patch_credit_card**
|
1286
|
+
> patch_credit_card(creditcard_id, credit_card)
|
1287
|
+
|
1288
|
+
|
1289
|
+
|
1290
|
+
### Example
|
1291
|
+
```ruby
|
1292
|
+
# load the gem
|
1293
|
+
require 'order_cloud'
|
1294
|
+
# setup authorization
|
1295
|
+
OrderCloud.configure do |config|
|
1296
|
+
# Configure OAuth2 access token for authorization: oauth2
|
1297
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1298
|
+
end
|
1299
|
+
|
1300
|
+
api_instance = OrderCloud::MeApi.new
|
1301
|
+
|
1302
|
+
creditcard_id = "creditcard_id_example" # String | ID of the creditcard.
|
1303
|
+
|
1304
|
+
credit_card = OrderCloud::CreditCard.new # CreditCard |
|
1305
|
+
|
1306
|
+
|
1307
|
+
begin
|
1308
|
+
api_instance.patch_credit_card(creditcard_id, credit_card)
|
1309
|
+
rescue OrderCloud::ApiError => e
|
1310
|
+
puts "Exception when calling MeApi->patch_credit_card: #{e}"
|
1311
|
+
end
|
1312
|
+
```
|
1313
|
+
|
1314
|
+
### Parameters
|
1315
|
+
|
1316
|
+
Name | Type | Description | Notes
|
1317
|
+
------------- | ------------- | ------------- | -------------
|
1318
|
+
**creditcard_id** | **String**| ID of the creditcard. |
|
1319
|
+
**credit_card** | [**CreditCard**](CreditCard.md)| |
|
1320
|
+
|
1321
|
+
### Return type
|
1322
|
+
|
1323
|
+
nil (empty response body)
|
1324
|
+
|
1325
|
+
### Authorization
|
1326
|
+
|
1327
|
+
[oauth2](../README.md#oauth2)
|
1328
|
+
|
1329
|
+
### HTTP request headers
|
1330
|
+
|
1331
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
1332
|
+
- **Accept**: application/json
|
1333
|
+
|
1334
|
+
|
1335
|
+
|
1336
|
+
# **update**
|
1337
|
+
> User update(user)
|
1338
|
+
|
1339
|
+
|
1340
|
+
|
1341
|
+
### Example
|
1342
|
+
```ruby
|
1343
|
+
# load the gem
|
1344
|
+
require 'order_cloud'
|
1345
|
+
# setup authorization
|
1346
|
+
OrderCloud.configure do |config|
|
1347
|
+
# Configure OAuth2 access token for authorization: oauth2
|
1348
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1349
|
+
end
|
1350
|
+
|
1351
|
+
api_instance = OrderCloud::MeApi.new
|
1352
|
+
|
1353
|
+
user = OrderCloud::User.new # User |
|
1354
|
+
|
1355
|
+
|
1356
|
+
begin
|
1357
|
+
result = api_instance.update(user)
|
1358
|
+
p result
|
1359
|
+
rescue OrderCloud::ApiError => e
|
1360
|
+
puts "Exception when calling MeApi->update: #{e}"
|
1361
|
+
end
|
1362
|
+
```
|
1363
|
+
|
1364
|
+
### Parameters
|
1365
|
+
|
1366
|
+
Name | Type | Description | Notes
|
1367
|
+
------------- | ------------- | ------------- | -------------
|
1368
|
+
**user** | [**User**](User.md)| |
|
1369
|
+
|
1370
|
+
### Return type
|
1371
|
+
|
1372
|
+
[**User**](User.md)
|
1373
|
+
|
1374
|
+
### Authorization
|
1375
|
+
|
1376
|
+
[oauth2](../README.md#oauth2)
|
1377
|
+
|
1378
|
+
### HTTP request headers
|
1379
|
+
|
1380
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
1381
|
+
- **Accept**: application/json
|
1382
|
+
|
1383
|
+
|
1384
|
+
|
1385
|
+
# **update_address**
|
1386
|
+
> BuyerAddress update_address(address_id, address)
|
1387
|
+
|
1388
|
+
|
1389
|
+
|
1390
|
+
### Example
|
1391
|
+
```ruby
|
1392
|
+
# load the gem
|
1393
|
+
require 'order_cloud'
|
1394
|
+
# setup authorization
|
1395
|
+
OrderCloud.configure do |config|
|
1396
|
+
# Configure OAuth2 access token for authorization: oauth2
|
1397
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1398
|
+
end
|
1399
|
+
|
1400
|
+
api_instance = OrderCloud::MeApi.new
|
1401
|
+
|
1402
|
+
address_id = "address_id_example" # String | ID of the address.
|
1403
|
+
|
1404
|
+
address = OrderCloud::BuyerAddress.new # BuyerAddress |
|
1405
|
+
|
1406
|
+
|
1407
|
+
begin
|
1408
|
+
result = api_instance.update_address(address_id, address)
|
1409
|
+
p result
|
1410
|
+
rescue OrderCloud::ApiError => e
|
1411
|
+
puts "Exception when calling MeApi->update_address: #{e}"
|
1412
|
+
end
|
1413
|
+
```
|
1414
|
+
|
1415
|
+
### Parameters
|
1416
|
+
|
1417
|
+
Name | Type | Description | Notes
|
1418
|
+
------------- | ------------- | ------------- | -------------
|
1419
|
+
**address_id** | **String**| ID of the address. |
|
1420
|
+
**address** | [**BuyerAddress**](BuyerAddress.md)| |
|
1421
|
+
|
1422
|
+
### Return type
|
1423
|
+
|
1424
|
+
[**BuyerAddress**](BuyerAddress.md)
|
1425
|
+
|
1426
|
+
### Authorization
|
1427
|
+
|
1428
|
+
[oauth2](../README.md#oauth2)
|
1429
|
+
|
1430
|
+
### HTTP request headers
|
1431
|
+
|
1432
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
1433
|
+
- **Accept**: application/json
|
1434
|
+
|
1435
|
+
|
1436
|
+
|
1437
|
+
# **update_credit_card**
|
1438
|
+
> BuyerCreditCard update_credit_card(creditcard_id, credit_card)
|
1439
|
+
|
1440
|
+
|
1441
|
+
|
1442
|
+
### Example
|
1443
|
+
```ruby
|
1444
|
+
# load the gem
|
1445
|
+
require 'order_cloud'
|
1446
|
+
# setup authorization
|
1447
|
+
OrderCloud.configure do |config|
|
1448
|
+
# Configure OAuth2 access token for authorization: oauth2
|
1449
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1450
|
+
end
|
1451
|
+
|
1452
|
+
api_instance = OrderCloud::MeApi.new
|
1453
|
+
|
1454
|
+
creditcard_id = "creditcard_id_example" # String | ID of the creditcard.
|
1455
|
+
|
1456
|
+
credit_card = OrderCloud::BuyerCreditCard.new # BuyerCreditCard |
|
1457
|
+
|
1458
|
+
|
1459
|
+
begin
|
1460
|
+
result = api_instance.update_credit_card(creditcard_id, credit_card)
|
1461
|
+
p result
|
1462
|
+
rescue OrderCloud::ApiError => e
|
1463
|
+
puts "Exception when calling MeApi->update_credit_card: #{e}"
|
1464
|
+
end
|
1465
|
+
```
|
1466
|
+
|
1467
|
+
### Parameters
|
1468
|
+
|
1469
|
+
Name | Type | Description | Notes
|
1470
|
+
------------- | ------------- | ------------- | -------------
|
1471
|
+
**creditcard_id** | **String**| ID of the creditcard. |
|
1472
|
+
**credit_card** | [**BuyerCreditCard**](BuyerCreditCard.md)| |
|
1473
|
+
|
1474
|
+
### Return type
|
1475
|
+
|
1476
|
+
[**BuyerCreditCard**](BuyerCreditCard.md)
|
1477
|
+
|
1478
|
+
### Authorization
|
1479
|
+
|
1480
|
+
[oauth2](../README.md#oauth2)
|
1481
|
+
|
1482
|
+
### HTTP request headers
|
1483
|
+
|
1484
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
1485
|
+
- **Accept**: application/json
|
1486
|
+
|
1487
|
+
|
1488
|
+
|