order_cloud 0.0.4 → 0.0.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +39 -14
- data/Rakefile +1 -1
- data/docs/AdminUserGroupApi.md +482 -0
- data/docs/CategoryApi.md +4 -3
- data/docs/ListMessageCCListenerAssignment.md +9 -0
- data/docs/{ListApiClient.md → ListMessageConfig.md} +2 -2
- data/docs/{ListDevAccessibleCompany.md → ListMessageSender.md} +2 -2
- data/docs/ListMessageSenderAssignment.md +9 -0
- data/docs/MessageCCListenerAssignment.md +13 -0
- data/docs/MessageConfig.md +11 -0
- data/docs/MessageSender.md +10 -0
- data/docs/MessageSenderAssignment.md +12 -0
- data/docs/MessageSendersApi.md +398 -0
- data/docs/Product.md +4 -0
- data/docs/ProductApi.md +4 -3
- data/docs/ProductAssignment.md +2 -2
- data/docs/SecurityProfileApi.md +5 -5
- data/docs/User.md +1 -0
- data/docs/UserApi.md +4 -3
- data/docs/UserGroupApi.md +4 -3
- data/git_push.sh +0 -0
- data/lib/order_cloud.rb +11 -4
- data/lib/order_cloud/api/address_api.rb +1 -1
- data/lib/order_cloud/api/admin_address_api.rb +1 -1
- data/lib/order_cloud/api/admin_user_api.rb +1 -1
- data/lib/order_cloud/api/admin_user_group_api.rb +578 -0
- data/lib/order_cloud/api/approval_rule_api.rb +1 -1
- data/lib/order_cloud/api/buyer_api.rb +1 -1
- data/lib/order_cloud/api/category_api.rb +7 -6
- data/lib/order_cloud/api/cost_center_api.rb +1 -1
- data/lib/order_cloud/api/credit_card_api.rb +1 -1
- data/lib/order_cloud/api/email_template_api.rb +1 -1
- data/lib/order_cloud/api/line_item_api.rb +1 -1
- data/lib/order_cloud/api/me_api.rb +1 -1
- data/lib/order_cloud/api/message_senders_api.rb +484 -0
- data/lib/order_cloud/api/order_api.rb +1 -1
- data/lib/order_cloud/api/password_reset_api.rb +1 -1
- data/lib/order_cloud/api/payment_api.rb +1 -1
- data/lib/order_cloud/api/price_schedule_api.rb +1 -1
- data/lib/order_cloud/api/product_api.rb +7 -6
- data/lib/order_cloud/api/promotion_api.rb +1 -1
- data/lib/order_cloud/api/security_profile_api.rb +6 -6
- data/lib/order_cloud/api/shipment_api.rb +1 -1
- data/lib/order_cloud/api/spec_api.rb +1 -1
- data/lib/order_cloud/api/spending_account_api.rb +1 -1
- data/lib/order_cloud/api/user_api.rb +7 -6
- data/lib/order_cloud/api/user_group_api.rb +7 -6
- data/lib/order_cloud/api_auth.rb +1 -1
- data/lib/order_cloud/api_client.rb +1 -1
- data/lib/order_cloud/api_error.rb +1 -1
- data/lib/order_cloud/configuration.rb +1 -1
- data/lib/order_cloud/models/access_token.rb +1 -1
- data/lib/order_cloud/models/address.rb +1 -1
- data/lib/order_cloud/models/address_assignment.rb +1 -1
- data/lib/order_cloud/models/admin_company.rb +1 -1
- data/lib/order_cloud/models/admin_model_on_view.rb +1 -1
- data/lib/order_cloud/models/approval_rule.rb +1 -1
- data/lib/order_cloud/models/base_spec.rb +1 -1
- data/lib/order_cloud/models/buyer.rb +1 -1
- data/lib/order_cloud/models/buyer_address.rb +1 -1
- data/lib/order_cloud/models/buyer_credit_card.rb +1 -1
- data/lib/order_cloud/models/buyer_product.rb +1 -1
- data/lib/order_cloud/models/buyer_spec.rb +1 -1
- data/lib/order_cloud/models/category.rb +1 -1
- data/lib/order_cloud/models/category_assignment.rb +1 -1
- data/lib/order_cloud/models/category_product_assignment.rb +1 -1
- data/lib/order_cloud/models/cost_center.rb +1 -1
- data/lib/order_cloud/models/cost_center_assignment.rb +1 -1
- data/lib/order_cloud/models/credit_card.rb +1 -1
- data/lib/order_cloud/models/credit_card_assignment.rb +1 -1
- data/lib/order_cloud/models/email_template.rb +1 -1
- data/lib/order_cloud/models/file.rb +1 -1
- data/lib/order_cloud/models/impersonate_token_request.rb +1 -1
- data/lib/order_cloud/models/inventory.rb +1 -1
- data/lib/order_cloud/models/line_item.rb +1 -1
- data/lib/order_cloud/models/line_item_spec.rb +1 -1
- data/lib/order_cloud/models/list_address.rb +1 -1
- data/lib/order_cloud/models/list_address_assignment.rb +1 -1
- data/lib/order_cloud/models/list_admin_company.rb +1 -1
- data/lib/order_cloud/models/list_approval_rule.rb +1 -1
- data/lib/order_cloud/models/list_buyer.rb +1 -1
- data/lib/order_cloud/models/list_buyer_address.rb +1 -1
- data/lib/order_cloud/models/list_buyer_credit_card.rb +1 -1
- data/lib/order_cloud/models/list_buyer_product.rb +1 -1
- data/lib/order_cloud/models/list_buyer_spec.rb +1 -1
- data/lib/order_cloud/models/list_category.rb +1 -1
- data/lib/order_cloud/models/list_category_assignment.rb +1 -1
- data/lib/order_cloud/models/list_category_product_assignment.rb +1 -1
- data/lib/order_cloud/models/list_cost_center.rb +1 -1
- data/lib/order_cloud/models/list_cost_center_assignment.rb +1 -1
- data/lib/order_cloud/models/list_credit_card.rb +1 -1
- data/lib/order_cloud/models/list_credit_card_assignment.rb +1 -1
- data/lib/order_cloud/models/list_file.rb +1 -1
- data/lib/order_cloud/models/list_inventory.rb +1 -1
- data/lib/order_cloud/models/list_line_item.rb +1 -1
- data/lib/order_cloud/models/list_message_cc_listener_assignment.rb +210 -0
- data/lib/order_cloud/models/{list_api_client.rb → list_message_config.rb} +3 -3
- data/lib/order_cloud/models/{list_dev_accessible_company.rb → list_message_sender.rb} +3 -3
- data/lib/order_cloud/models/list_message_sender_assignment.rb +210 -0
- data/lib/order_cloud/models/list_order.rb +1 -1
- data/lib/order_cloud/models/list_order_approval.rb +1 -1
- data/lib/order_cloud/models/list_order_promotion.rb +1 -1
- data/lib/order_cloud/models/list_payment.rb +1 -1
- data/lib/order_cloud/models/list_price_schedule.rb +1 -1
- data/lib/order_cloud/models/list_product.rb +1 -1
- data/lib/order_cloud/models/list_product_assignment.rb +1 -1
- data/lib/order_cloud/models/list_promotion.rb +1 -1
- data/lib/order_cloud/models/list_promotion_assignment.rb +1 -1
- data/lib/order_cloud/models/list_security_profile.rb +1 -1
- data/lib/order_cloud/models/list_security_profile_assignment.rb +1 -1
- data/lib/order_cloud/models/list_shipment.rb +1 -1
- data/lib/order_cloud/models/list_spec.rb +1 -1
- data/lib/order_cloud/models/list_spec_option.rb +1 -1
- data/lib/order_cloud/models/list_spec_product_assignment.rb +1 -1
- data/lib/order_cloud/models/list_spending_account.rb +1 -1
- data/lib/order_cloud/models/list_spending_account_assignment.rb +1 -1
- data/lib/order_cloud/models/list_user.rb +1 -1
- data/lib/order_cloud/models/list_user_group.rb +1 -1
- data/lib/order_cloud/models/list_user_group_assignment.rb +1 -1
- data/lib/order_cloud/models/list_variant.rb +1 -1
- data/lib/order_cloud/models/list_web_hook.rb +1 -1
- data/lib/order_cloud/models/list_web_hook_route.rb +1 -1
- data/lib/order_cloud/models/list_xp_index.rb +1 -1
- data/lib/order_cloud/models/message_cc_listener_assignment.rb +244 -0
- data/lib/order_cloud/models/message_config.rb +226 -0
- data/lib/order_cloud/models/message_sender.rb +217 -0
- data/lib/order_cloud/models/message_sender_assignment.rb +235 -0
- data/lib/order_cloud/models/meta.rb +1 -1
- data/lib/order_cloud/models/order.rb +1 -1
- data/lib/order_cloud/models/order_approval.rb +1 -1
- data/lib/order_cloud/models/order_promotion.rb +1 -1
- data/lib/order_cloud/models/password_reset.rb +1 -1
- data/lib/order_cloud/models/password_reset_request.rb +1 -1
- data/lib/order_cloud/models/payment.rb +1 -1
- data/lib/order_cloud/models/payment_transaction.rb +1 -1
- data/lib/order_cloud/models/ping_response.rb +1 -1
- data/lib/order_cloud/models/price_break.rb +1 -1
- data/lib/order_cloud/models/price_schedule.rb +1 -1
- data/lib/order_cloud/models/product.rb +41 -5
- data/lib/order_cloud/models/product_assignment.rb +20 -20
- data/lib/order_cloud/models/promotion.rb +1 -1
- data/lib/order_cloud/models/promotion_assignment.rb +1 -1
- data/lib/order_cloud/models/security_profile.rb +1 -1
- data/lib/order_cloud/models/security_profile_assignment.rb +1 -1
- data/lib/order_cloud/models/shipment.rb +1 -1
- data/lib/order_cloud/models/shipment_item.rb +1 -1
- data/lib/order_cloud/models/spec.rb +1 -1
- data/lib/order_cloud/models/spec_option.rb +1 -1
- data/lib/order_cloud/models/spec_product_assignment.rb +1 -1
- data/lib/order_cloud/models/spending_account.rb +1 -1
- data/lib/order_cloud/models/spending_account_assignment.rb +1 -1
- data/lib/order_cloud/models/user.rb +16 -5
- data/lib/order_cloud/models/user_group.rb +1 -1
- data/lib/order_cloud/models/user_group_assignment.rb +1 -1
- data/lib/order_cloud/models/variant.rb +1 -1
- data/lib/order_cloud/models/web_hook.rb +1 -1
- data/lib/order_cloud/models/web_hook_route.rb +1 -1
- data/lib/order_cloud/models/xp_index.rb +1 -1
- data/lib/order_cloud/version.rb +2 -2
- data/order_cloud.gemspec +2 -2
- data/spec/api/address_api_spec.rb +1 -1
- data/spec/api/admin_address_api_spec.rb +1 -1
- data/spec/api/admin_user_api_spec.rb +1 -1
- data/spec/api/admin_user_group_api_spec.rb +165 -0
- data/spec/api/approval_rule_api_spec.rb +1 -1
- data/spec/api/buyer_api_spec.rb +1 -1
- data/spec/api/category_api_spec.rb +2 -2
- data/spec/api/cost_center_api_spec.rb +1 -1
- data/spec/api/credit_card_api_spec.rb +1 -1
- data/spec/api/email_template_api_spec.rb +1 -1
- data/spec/api/line_item_api_spec.rb +1 -1
- data/spec/api/me_api_spec.rb +1 -1
- data/spec/api/message_senders_api_spec.rb +149 -0
- data/spec/api/order_api_spec.rb +1 -1
- data/spec/api/password_reset_api_spec.rb +1 -1
- data/spec/api/payment_api_spec.rb +1 -1
- data/spec/api/price_schedule_api_spec.rb +1 -1
- data/spec/api/product_api_spec.rb +2 -2
- data/spec/api/promotion_api_spec.rb +1 -1
- data/spec/api/security_profile_api_spec.rb +1 -1
- data/spec/api/shipment_api_spec.rb +1 -1
- data/spec/api/spec_api_spec.rb +1 -1
- data/spec/api/spending_account_api_spec.rb +1 -1
- data/spec/api/user_api_spec.rb +2 -2
- data/spec/api/user_group_api_spec.rb +2 -2
- data/spec/api_auth_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/access_token_spec.rb +1 -1
- data/spec/models/address_assignment_spec.rb +1 -1
- data/spec/models/address_spec.rb +1 -1
- data/spec/models/admin_company_spec.rb +1 -1
- data/spec/models/admin_model_on_view_spec.rb +1 -1
- data/spec/models/approval_rule_spec.rb +1 -1
- data/spec/models/base_spec_spec.rb +1 -1
- data/spec/models/buyer_address_spec.rb +1 -1
- data/spec/models/buyer_credit_card_spec.rb +1 -1
- data/spec/models/buyer_product_spec.rb +1 -1
- data/spec/models/buyer_spec.rb +1 -1
- data/spec/models/buyer_spec_spec.rb +1 -1
- data/spec/models/category_assignment_spec.rb +1 -1
- data/spec/models/category_product_assignment_spec.rb +1 -1
- data/spec/models/category_spec.rb +1 -1
- data/spec/models/cost_center_assignment_spec.rb +1 -1
- data/spec/models/cost_center_spec.rb +1 -1
- data/spec/models/credit_card_assignment_spec.rb +1 -1
- data/spec/models/credit_card_spec.rb +1 -1
- data/spec/models/email_template_spec.rb +1 -1
- data/spec/models/file_spec.rb +1 -1
- data/spec/models/impersonate_token_request_spec.rb +1 -1
- data/spec/models/inventory_spec.rb +1 -1
- data/spec/models/line_item_spec.rb +1 -1
- data/spec/models/line_item_spec_spec.rb +1 -1
- data/spec/models/list_address_assignment_spec.rb +1 -1
- data/spec/models/list_address_spec.rb +1 -1
- data/spec/models/list_admin_company_spec.rb +1 -1
- data/spec/models/list_approval_rule_spec.rb +1 -1
- data/spec/models/list_buyer_address_spec.rb +1 -1
- data/spec/models/list_buyer_credit_card_spec.rb +1 -1
- data/spec/models/list_buyer_product_spec.rb +1 -1
- data/spec/models/list_buyer_spec.rb +1 -1
- data/spec/models/list_buyer_spec_spec.rb +1 -1
- data/spec/models/list_category_assignment_spec.rb +1 -1
- data/spec/models/list_category_product_assignment_spec.rb +1 -1
- data/spec/models/list_category_spec.rb +1 -1
- data/spec/models/list_cost_center_assignment_spec.rb +1 -1
- data/spec/models/list_cost_center_spec.rb +1 -1
- data/spec/models/list_credit_card_assignment_spec.rb +1 -1
- data/spec/models/list_credit_card_spec.rb +1 -1
- data/spec/models/list_file_spec.rb +1 -1
- data/spec/models/list_inventory_spec.rb +1 -1
- data/spec/models/list_line_item_spec.rb +1 -1
- data/spec/models/list_message_cc_listener_assignment_spec.rb +59 -0
- data/spec/models/{list_api_client_spec.rb → list_message_config_spec.rb} +7 -7
- data/spec/models/list_message_sender_assignment_spec.rb +59 -0
- data/spec/models/{list_dev_accessible_company_spec.rb → list_message_sender_spec.rb} +7 -7
- data/spec/models/list_order_approval_spec.rb +1 -1
- data/spec/models/list_order_promotion_spec.rb +1 -1
- data/spec/models/list_order_spec.rb +1 -1
- data/spec/models/list_payment_spec.rb +1 -1
- data/spec/models/list_price_schedule_spec.rb +1 -1
- data/spec/models/list_product_assignment_spec.rb +1 -1
- data/spec/models/list_product_spec.rb +1 -1
- data/spec/models/list_promotion_assignment_spec.rb +1 -1
- data/spec/models/list_promotion_spec.rb +1 -1
- data/spec/models/list_security_profile_assignment_spec.rb +1 -1
- data/spec/models/list_security_profile_spec.rb +1 -1
- data/spec/models/list_shipment_spec.rb +1 -1
- data/spec/models/list_spec_option_spec.rb +1 -1
- data/spec/models/list_spec_product_assignment_spec.rb +1 -1
- data/spec/models/list_spec_spec.rb +1 -1
- data/spec/models/list_spending_account_assignment_spec.rb +1 -1
- data/spec/models/list_spending_account_spec.rb +1 -1
- data/spec/models/list_user_group_assignment_spec.rb +1 -1
- data/spec/models/list_user_group_spec.rb +1 -1
- data/spec/models/list_user_spec.rb +1 -1
- data/spec/models/list_variant_spec.rb +1 -1
- data/spec/models/list_web_hook_route_spec.rb +1 -1
- data/spec/models/list_web_hook_spec.rb +1 -1
- data/spec/models/list_xp_index_spec.rb +1 -1
- data/spec/models/message_cc_listener_assignment_spec.rb +83 -0
- data/spec/models/message_config_spec.rb +71 -0
- data/spec/models/message_sender_assignment_spec.rb +77 -0
- data/spec/models/message_sender_spec.rb +65 -0
- data/spec/models/meta_spec.rb +1 -1
- data/spec/models/order_approval_spec.rb +1 -1
- data/spec/models/order_promotion_spec.rb +1 -1
- data/spec/models/order_spec.rb +1 -1
- data/spec/models/password_reset_request_spec.rb +1 -1
- data/spec/models/password_reset_spec.rb +1 -1
- data/spec/models/payment_spec.rb +1 -1
- data/spec/models/payment_transaction_spec.rb +1 -1
- data/spec/models/ping_response_spec.rb +1 -1
- data/spec/models/price_break_spec.rb +1 -1
- data/spec/models/price_schedule_spec.rb +1 -1
- data/spec/models/product_assignment_spec.rb +6 -6
- data/spec/models/product_spec.rb +25 -1
- data/spec/models/promotion_assignment_spec.rb +1 -1
- data/spec/models/promotion_spec.rb +1 -1
- data/spec/models/security_profile_assignment_spec.rb +1 -1
- data/spec/models/security_profile_spec.rb +1 -1
- data/spec/models/shipment_item_spec.rb +1 -1
- data/spec/models/shipment_spec.rb +1 -1
- data/spec/models/spec_option_spec.rb +1 -1
- data/spec/models/spec_product_assignment_spec.rb +1 -1
- data/spec/models/spec_spec.rb +1 -1
- data/spec/models/spending_account_assignment_spec.rb +1 -1
- data/spec/models/spending_account_spec.rb +1 -1
- data/spec/models/user_group_assignment_spec.rb +1 -1
- data/spec/models/user_group_spec.rb +1 -1
- data/spec/models/user_spec.rb +7 -1
- data/spec/models/variant_spec.rb +1 -1
- data/spec/models/web_hook_route_spec.rb +1 -1
- data/spec/models/web_hook_spec.rb +1 -1
- data/spec/models/xp_index_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +42 -15
- data/Gemfile.lock +0 -34
- data/docs/FileApi.md +0 -162
- data/lib/order_cloud/api/file_api.rb +0 -206
- data/spec/api/file_api_spec.rb +0 -83
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 83e9e367cf08df78524e391c9a0be60398fa70fa
|
4
|
+
data.tar.gz: 081aa96237b7f410d7aa278d8410c6f8e889df7a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4f0b1fd5fdc6738c30773999a09e6f051be20256220216a13558344c00d02b9fef09f0a09bbe7fbea2553517d913ed5fd7ba520b26021fb2ddfeb9149bebf4bc
|
7
|
+
data.tar.gz: 3cb5dec7912242eb40a5c92050dba42d8a06f646e854170a97cd82c8ee2f768f0ee8dafdc8d6123c8195d9bb610d324855b23d5355a9eae68a86ca96f5a7b147
|
data/Gemfile
CHANGED
data/README.md
CHANGED
@@ -9,11 +9,11 @@ OrderCloud - the Ruby gem for the OrderCloud
|
|
9
9
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
10
10
|
|
11
11
|
- API version: 1.0
|
12
|
-
- Package version: 0.0.
|
13
|
-
- Build date: 2016-09-
|
12
|
+
- Package version: 0.0.5
|
13
|
+
- Build date: 2016-09-27T15:54:14.541-05:00
|
14
14
|
- Build package: class io.swagger.codegen.languages.RubyClientCodegen
|
15
15
|
|
16
|
-
For more information, please visit [http://
|
16
|
+
For more information, please visit [http://ordercloud.io](http://ordercloud.io)
|
17
17
|
|
18
18
|
## Requirements
|
19
19
|
- Ruby >= 2.3.0
|
@@ -22,7 +22,7 @@ For more information, please visit [http://public.four51.com/](http://public.fou
|
|
22
22
|
|
23
23
|
Add this line to your `Gemfile`:
|
24
24
|
|
25
|
-
gem 'order_cloud', '~> 0.0.
|
25
|
+
gem 'order_cloud', '~> 0.0.5'
|
26
26
|
|
27
27
|
Or run this in your terminal:
|
28
28
|
```shell
|
@@ -102,6 +102,15 @@ Class | Method | HTTP request | Description
|
|
102
102
|
*OrderCloud::AdminUserApi* | [**list**](docs/AdminUserApi.md#list) | **GET** /adminusers |
|
103
103
|
*OrderCloud::AdminUserApi* | [**patch**](docs/AdminUserApi.md#patch) | **PATCH** /adminusers/{userID} |
|
104
104
|
*OrderCloud::AdminUserApi* | [**update**](docs/AdminUserApi.md#update) | **PUT** /adminusers/{userID} |
|
105
|
+
*OrderCloud::AdminUserGroupApi* | [**create**](docs/AdminUserGroupApi.md#create) | **POST** /usergroups |
|
106
|
+
*OrderCloud::AdminUserGroupApi* | [**delete**](docs/AdminUserGroupApi.md#delete) | **DELETE** /usergroups/{userGroupID} |
|
107
|
+
*OrderCloud::AdminUserGroupApi* | [**delete_user_assignment**](docs/AdminUserGroupApi.md#delete_user_assignment) | **DELETE** /usergroups/{userGroupID}/assignments/{userID} |
|
108
|
+
*OrderCloud::AdminUserGroupApi* | [**get**](docs/AdminUserGroupApi.md#get) | **GET** /usergroups/{userGroupID} |
|
109
|
+
*OrderCloud::AdminUserGroupApi* | [**list**](docs/AdminUserGroupApi.md#list) | **GET** /usergroups |
|
110
|
+
*OrderCloud::AdminUserGroupApi* | [**list_user_assignments**](docs/AdminUserGroupApi.md#list_user_assignments) | **GET** /usergroups/assignments |
|
111
|
+
*OrderCloud::AdminUserGroupApi* | [**patch**](docs/AdminUserGroupApi.md#patch) | **PATCH** /usergroups/{userGroupID} |
|
112
|
+
*OrderCloud::AdminUserGroupApi* | [**save_user_assignment**](docs/AdminUserGroupApi.md#save_user_assignment) | **POST** /usergroups/assignments |
|
113
|
+
*OrderCloud::AdminUserGroupApi* | [**update**](docs/AdminUserGroupApi.md#update) | **PUT** /usergroups/{userGroupID} |
|
105
114
|
*OrderCloud::ApprovalRuleApi* | [**create**](docs/ApprovalRuleApi.md#create) | **POST** /buyers/{buyerID}/approvalrules |
|
106
115
|
*OrderCloud::ApprovalRuleApi* | [**delete**](docs/ApprovalRuleApi.md#delete) | **DELETE** /buyers/{buyerID}/approvalrules/{approvalRuleID} |
|
107
116
|
*OrderCloud::ApprovalRuleApi* | [**get**](docs/ApprovalRuleApi.md#get) | **GET** /buyers/{buyerID}/approvalrules/{approvalRuleID} |
|
@@ -148,9 +157,6 @@ Class | Method | HTTP request | Description
|
|
148
157
|
*OrderCloud::EmailTemplateApi* | [**patch**](docs/EmailTemplateApi.md#patch) | **PATCH** /buyers/{buyerID}/emailtemplates/{emailTemplateType} |
|
149
158
|
*OrderCloud::EmailTemplateApi* | [**reset_to_default**](docs/EmailTemplateApi.md#reset_to_default) | **DELETE** /buyers/{buyerID}/emailtemplates/{emailTemplateType} |
|
150
159
|
*OrderCloud::EmailTemplateApi* | [**update**](docs/EmailTemplateApi.md#update) | **PUT** /buyers/{buyerID}/emailtemplates/{emailTemplateType} |
|
151
|
-
*OrderCloud::FileApi* | [**get**](docs/FileApi.md#get) | **GET** /files/{fileID} |
|
152
|
-
*OrderCloud::FileApi* | [**list**](docs/FileApi.md#list) | **GET** /files |
|
153
|
-
*OrderCloud::FileApi* | [**post_file_data**](docs/FileApi.md#post_file_data) | **POST** /files |
|
154
160
|
*OrderCloud::LineItemApi* | [**create**](docs/LineItemApi.md#create) | **POST** /buyers/{buyerID}/orders/{orderID}/lineitems |
|
155
161
|
*OrderCloud::LineItemApi* | [**delete**](docs/LineItemApi.md#delete) | **DELETE** /buyers/{buyerID}/orders/{orderID}/lineitems/{lineItemID} |
|
156
162
|
*OrderCloud::LineItemApi* | [**get**](docs/LineItemApi.md#get) | **GET** /buyers/{buyerID}/orders/{orderID}/lineitems/{lineItemID} |
|
@@ -186,6 +192,13 @@ Class | Method | HTTP request | Description
|
|
186
192
|
*OrderCloud::MeApi* | [**update**](docs/MeApi.md#update) | **PUT** /me |
|
187
193
|
*OrderCloud::MeApi* | [**update_address**](docs/MeApi.md#update_address) | **PUT** /me/addresses/{addressID} |
|
188
194
|
*OrderCloud::MeApi* | [**update_credit_card**](docs/MeApi.md#update_credit_card) | **PUT** /me/creditcards/{creditcardID} |
|
195
|
+
*OrderCloud::MessageSendersApi* | [**delete_assignment**](docs/MessageSendersApi.md#delete_assignment) | **DELETE** /MessageSenders/{messageSenderID}/assignments |
|
196
|
+
*OrderCloud::MessageSendersApi* | [**get**](docs/MessageSendersApi.md#get) | **GET** /MessageSenders/{messageSenderID} |
|
197
|
+
*OrderCloud::MessageSendersApi* | [**list**](docs/MessageSendersApi.md#list) | **GET** /MessageSenders |
|
198
|
+
*OrderCloud::MessageSendersApi* | [**list_assignments**](docs/MessageSendersApi.md#list_assignments) | **GET** /MessageSenders/assignments |
|
199
|
+
*OrderCloud::MessageSendersApi* | [**list_cc_listener_assignments**](docs/MessageSendersApi.md#list_cc_listener_assignments) | **GET** /MessageSenders/CCListenerAssignments |
|
200
|
+
*OrderCloud::MessageSendersApi* | [**save_assignment**](docs/MessageSendersApi.md#save_assignment) | **POST** /MessageSenders/assignments |
|
201
|
+
*OrderCloud::MessageSendersApi* | [**save_cc_listener_assignment**](docs/MessageSendersApi.md#save_cc_listener_assignment) | **POST** /MessageSenders/CCListenerAssignments |
|
189
202
|
*OrderCloud::OrderApi* | [**add_promotion**](docs/OrderApi.md#add_promotion) | **POST** /buyers/{buyerID}/orders/{orderID}/promotions/{promoCode} |
|
190
203
|
*OrderCloud::OrderApi* | [**approve**](docs/OrderApi.md#approve) | **POST** /buyers/{buyerID}/orders/{orderID}/approve |
|
191
204
|
*OrderCloud::OrderApi* | [**cancel**](docs/OrderApi.md#cancel) | **POST** /buyers/{buyerID}/orders/{orderID}/cancel |
|
@@ -257,11 +270,11 @@ Class | Method | HTTP request | Description
|
|
257
270
|
*OrderCloud::PromotionApi* | [**patch**](docs/PromotionApi.md#patch) | **PATCH** /promotions/{promotionID} |
|
258
271
|
*OrderCloud::PromotionApi* | [**save_assignment**](docs/PromotionApi.md#save_assignment) | **POST** /promotions/assignments |
|
259
272
|
*OrderCloud::PromotionApi* | [**update**](docs/PromotionApi.md#update) | **PUT** /promotions/{promotionID} |
|
260
|
-
*OrderCloud::SecurityProfileApi* | [**delete_assignment**](docs/SecurityProfileApi.md#delete_assignment) | **DELETE** /
|
261
|
-
*OrderCloud::SecurityProfileApi* | [**get**](docs/SecurityProfileApi.md#get) | **GET** /
|
262
|
-
*OrderCloud::SecurityProfileApi* | [**list**](docs/SecurityProfileApi.md#list) | **GET** /
|
263
|
-
*OrderCloud::SecurityProfileApi* | [**list_assignments**](docs/SecurityProfileApi.md#list_assignments) | **GET** /
|
264
|
-
*OrderCloud::SecurityProfileApi* | [**save_assignment**](docs/SecurityProfileApi.md#save_assignment) | **POST** /
|
273
|
+
*OrderCloud::SecurityProfileApi* | [**delete_assignment**](docs/SecurityProfileApi.md#delete_assignment) | **DELETE** /securityprofiles/{securityProfileID}/assignments |
|
274
|
+
*OrderCloud::SecurityProfileApi* | [**get**](docs/SecurityProfileApi.md#get) | **GET** /securityprofiles/{securityProfileID} |
|
275
|
+
*OrderCloud::SecurityProfileApi* | [**list**](docs/SecurityProfileApi.md#list) | **GET** /securityprofiles |
|
276
|
+
*OrderCloud::SecurityProfileApi* | [**list_assignments**](docs/SecurityProfileApi.md#list_assignments) | **GET** /securityprofiles/assignments |
|
277
|
+
*OrderCloud::SecurityProfileApi* | [**save_assignment**](docs/SecurityProfileApi.md#save_assignment) | **POST** /securityprofiles/assignments |
|
265
278
|
*OrderCloud::ShipmentApi* | [**create**](docs/ShipmentApi.md#create) | **POST** /buyers/{buyerID}/shipments |
|
266
279
|
*OrderCloud::ShipmentApi* | [**delete**](docs/ShipmentApi.md#delete) | **DELETE** /buyers/{buyerID}/shipments/{shipmentID} |
|
267
280
|
*OrderCloud::ShipmentApi* | [**delete_item**](docs/ShipmentApi.md#delete_item) | **DELETE** /buyers/{buyerID}/shipments/{shipmentID}/items/{orderID}/{lineItemID} |
|
@@ -342,7 +355,6 @@ Class | Method | HTTP request | Description
|
|
342
355
|
- [OrderCloud::ListAddress](docs/ListAddress.md)
|
343
356
|
- [OrderCloud::ListAddressAssignment](docs/ListAddressAssignment.md)
|
344
357
|
- [OrderCloud::ListAdminCompany](docs/ListAdminCompany.md)
|
345
|
-
- [OrderCloud::ListApiClient](docs/ListApiClient.md)
|
346
358
|
- [OrderCloud::ListApprovalRule](docs/ListApprovalRule.md)
|
347
359
|
- [OrderCloud::ListBuyer](docs/ListBuyer.md)
|
348
360
|
- [OrderCloud::ListBuyerAddress](docs/ListBuyerAddress.md)
|
@@ -356,10 +368,13 @@ Class | Method | HTTP request | Description
|
|
356
368
|
- [OrderCloud::ListCostCenterAssignment](docs/ListCostCenterAssignment.md)
|
357
369
|
- [OrderCloud::ListCreditCard](docs/ListCreditCard.md)
|
358
370
|
- [OrderCloud::ListCreditCardAssignment](docs/ListCreditCardAssignment.md)
|
359
|
-
- [OrderCloud::ListDevAccessibleCompany](docs/ListDevAccessibleCompany.md)
|
360
371
|
- [OrderCloud::ListFile](docs/ListFile.md)
|
361
372
|
- [OrderCloud::ListInventory](docs/ListInventory.md)
|
362
373
|
- [OrderCloud::ListLineItem](docs/ListLineItem.md)
|
374
|
+
- [OrderCloud::ListMessageCCListenerAssignment](docs/ListMessageCCListenerAssignment.md)
|
375
|
+
- [OrderCloud::ListMessageConfig](docs/ListMessageConfig.md)
|
376
|
+
- [OrderCloud::ListMessageSender](docs/ListMessageSender.md)
|
377
|
+
- [OrderCloud::ListMessageSenderAssignment](docs/ListMessageSenderAssignment.md)
|
363
378
|
- [OrderCloud::ListOrder](docs/ListOrder.md)
|
364
379
|
- [OrderCloud::ListOrderApproval](docs/ListOrderApproval.md)
|
365
380
|
- [OrderCloud::ListOrderPromotion](docs/ListOrderPromotion.md)
|
@@ -384,6 +399,10 @@ Class | Method | HTTP request | Description
|
|
384
399
|
- [OrderCloud::ListWebHook](docs/ListWebHook.md)
|
385
400
|
- [OrderCloud::ListWebHookRoute](docs/ListWebHookRoute.md)
|
386
401
|
- [OrderCloud::ListXpIndex](docs/ListXpIndex.md)
|
402
|
+
- [OrderCloud::MessageCCListenerAssignment](docs/MessageCCListenerAssignment.md)
|
403
|
+
- [OrderCloud::MessageConfig](docs/MessageConfig.md)
|
404
|
+
- [OrderCloud::MessageSender](docs/MessageSender.md)
|
405
|
+
- [OrderCloud::MessageSenderAssignment](docs/MessageSenderAssignment.md)
|
387
406
|
- [OrderCloud::Meta](docs/Meta.md)
|
388
407
|
- [OrderCloud::Order](docs/Order.md)
|
389
408
|
- [OrderCloud::OrderApproval](docs/OrderApproval.md)
|
@@ -428,6 +447,10 @@ Class | Method | HTTP request | Description
|
|
428
447
|
- **Scopes**:
|
429
448
|
- AddressAdmin:
|
430
449
|
- AddressReader:
|
450
|
+
- AdminUserAdmin:
|
451
|
+
- AdminUserGroupAdmin:
|
452
|
+
- AdminUserGroupReader:
|
453
|
+
- AdminUserReader:
|
431
454
|
- ApprovalRuleAdmin:
|
432
455
|
- ApprovalRuleReader:
|
433
456
|
- BuyerAdmin:
|
@@ -442,6 +465,7 @@ Class | Method | HTTP request | Description
|
|
442
465
|
- CreditCardReader:
|
443
466
|
- DevCenter:
|
444
467
|
- DevCenterImpersonate:
|
468
|
+
- DevCenterMessageConfigAdmin:
|
445
469
|
- DevCenterPasswordReset:
|
446
470
|
- EmailTemplateAdmin:
|
447
471
|
- EmailTemplateReader:
|
@@ -451,6 +475,7 @@ Class | Method | HTTP request | Description
|
|
451
475
|
- MeAddressAdmin:
|
452
476
|
- MeAdmin:
|
453
477
|
- MeCreditCardAdmin:
|
478
|
+
- MessageConfigAssignmentAdmin:
|
454
479
|
- MeXpAdmin:
|
455
480
|
- OrderAdmin:
|
456
481
|
- OrderReader:
|
data/Rakefile
CHANGED
@@ -0,0 +1,482 @@
|
|
1
|
+
# OrderCloud::AdminUserGroupApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ordercloud.io/v1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create**](AdminUserGroupApi.md#create) | **POST** /usergroups |
|
8
|
+
[**delete**](AdminUserGroupApi.md#delete) | **DELETE** /usergroups/{userGroupID} |
|
9
|
+
[**delete_user_assignment**](AdminUserGroupApi.md#delete_user_assignment) | **DELETE** /usergroups/{userGroupID}/assignments/{userID} |
|
10
|
+
[**get**](AdminUserGroupApi.md#get) | **GET** /usergroups/{userGroupID} |
|
11
|
+
[**list**](AdminUserGroupApi.md#list) | **GET** /usergroups |
|
12
|
+
[**list_user_assignments**](AdminUserGroupApi.md#list_user_assignments) | **GET** /usergroups/assignments |
|
13
|
+
[**patch**](AdminUserGroupApi.md#patch) | **PATCH** /usergroups/{userGroupID} |
|
14
|
+
[**save_user_assignment**](AdminUserGroupApi.md#save_user_assignment) | **POST** /usergroups/assignments |
|
15
|
+
[**update**](AdminUserGroupApi.md#update) | **PUT** /usergroups/{userGroupID} |
|
16
|
+
|
17
|
+
|
18
|
+
# **create**
|
19
|
+
> UserGroup create(group)
|
20
|
+
|
21
|
+
|
22
|
+
|
23
|
+
### Example
|
24
|
+
```ruby
|
25
|
+
# load the gem
|
26
|
+
require 'order_cloud'
|
27
|
+
# setup authorization
|
28
|
+
OrderCloud.configure do |config|
|
29
|
+
# Configure OAuth2 access token for authorization: oauth2
|
30
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = OrderCloud::AdminUserGroupApi.new
|
34
|
+
|
35
|
+
group = OrderCloud::UserGroup.new # UserGroup |
|
36
|
+
|
37
|
+
|
38
|
+
begin
|
39
|
+
result = api_instance.create(group)
|
40
|
+
p result
|
41
|
+
rescue OrderCloud::ApiError => e
|
42
|
+
puts "Exception when calling AdminUserGroupApi->create: #{e}"
|
43
|
+
end
|
44
|
+
```
|
45
|
+
|
46
|
+
### Parameters
|
47
|
+
|
48
|
+
Name | Type | Description | Notes
|
49
|
+
------------- | ------------- | ------------- | -------------
|
50
|
+
**group** | [**UserGroup**](UserGroup.md)| |
|
51
|
+
|
52
|
+
### Return type
|
53
|
+
|
54
|
+
[**UserGroup**](UserGroup.md)
|
55
|
+
|
56
|
+
### Authorization
|
57
|
+
|
58
|
+
[oauth2](../README.md#oauth2)
|
59
|
+
|
60
|
+
### HTTP request headers
|
61
|
+
|
62
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
63
|
+
- **Accept**: application/json
|
64
|
+
|
65
|
+
|
66
|
+
|
67
|
+
# **delete**
|
68
|
+
> delete(user_group_id)
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
### Example
|
73
|
+
```ruby
|
74
|
+
# load the gem
|
75
|
+
require 'order_cloud'
|
76
|
+
# setup authorization
|
77
|
+
OrderCloud.configure do |config|
|
78
|
+
# Configure OAuth2 access token for authorization: oauth2
|
79
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
80
|
+
end
|
81
|
+
|
82
|
+
api_instance = OrderCloud::AdminUserGroupApi.new
|
83
|
+
|
84
|
+
user_group_id = "user_group_id_example" # String | ID of the user group.
|
85
|
+
|
86
|
+
|
87
|
+
begin
|
88
|
+
api_instance.delete(user_group_id)
|
89
|
+
rescue OrderCloud::ApiError => e
|
90
|
+
puts "Exception when calling AdminUserGroupApi->delete: #{e}"
|
91
|
+
end
|
92
|
+
```
|
93
|
+
|
94
|
+
### Parameters
|
95
|
+
|
96
|
+
Name | Type | Description | Notes
|
97
|
+
------------- | ------------- | ------------- | -------------
|
98
|
+
**user_group_id** | **String**| ID of the user group. |
|
99
|
+
|
100
|
+
### Return type
|
101
|
+
|
102
|
+
nil (empty response body)
|
103
|
+
|
104
|
+
### Authorization
|
105
|
+
|
106
|
+
[oauth2](../README.md#oauth2)
|
107
|
+
|
108
|
+
### HTTP request headers
|
109
|
+
|
110
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
111
|
+
- **Accept**: application/json
|
112
|
+
|
113
|
+
|
114
|
+
|
115
|
+
# **delete_user_assignment**
|
116
|
+
> delete_user_assignment(user_group_id, user_id)
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
### Example
|
121
|
+
```ruby
|
122
|
+
# load the gem
|
123
|
+
require 'order_cloud'
|
124
|
+
# setup authorization
|
125
|
+
OrderCloud.configure do |config|
|
126
|
+
# Configure OAuth2 access token for authorization: oauth2
|
127
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
128
|
+
end
|
129
|
+
|
130
|
+
api_instance = OrderCloud::AdminUserGroupApi.new
|
131
|
+
|
132
|
+
user_group_id = "user_group_id_example" # String | ID of the user group.
|
133
|
+
|
134
|
+
user_id = "user_id_example" # String | ID of the user.
|
135
|
+
|
136
|
+
|
137
|
+
begin
|
138
|
+
api_instance.delete_user_assignment(user_group_id, user_id)
|
139
|
+
rescue OrderCloud::ApiError => e
|
140
|
+
puts "Exception when calling AdminUserGroupApi->delete_user_assignment: #{e}"
|
141
|
+
end
|
142
|
+
```
|
143
|
+
|
144
|
+
### Parameters
|
145
|
+
|
146
|
+
Name | Type | Description | Notes
|
147
|
+
------------- | ------------- | ------------- | -------------
|
148
|
+
**user_group_id** | **String**| ID of the user group. |
|
149
|
+
**user_id** | **String**| ID of the user. |
|
150
|
+
|
151
|
+
### Return type
|
152
|
+
|
153
|
+
nil (empty response body)
|
154
|
+
|
155
|
+
### Authorization
|
156
|
+
|
157
|
+
[oauth2](../README.md#oauth2)
|
158
|
+
|
159
|
+
### HTTP request headers
|
160
|
+
|
161
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
162
|
+
- **Accept**: application/json
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
# **get**
|
167
|
+
> UserGroup get(user_group_id)
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
### Example
|
172
|
+
```ruby
|
173
|
+
# load the gem
|
174
|
+
require 'order_cloud'
|
175
|
+
# setup authorization
|
176
|
+
OrderCloud.configure do |config|
|
177
|
+
# Configure OAuth2 access token for authorization: oauth2
|
178
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
179
|
+
end
|
180
|
+
|
181
|
+
api_instance = OrderCloud::AdminUserGroupApi.new
|
182
|
+
|
183
|
+
user_group_id = "user_group_id_example" # String | ID of the user group.
|
184
|
+
|
185
|
+
|
186
|
+
begin
|
187
|
+
result = api_instance.get(user_group_id)
|
188
|
+
p result
|
189
|
+
rescue OrderCloud::ApiError => e
|
190
|
+
puts "Exception when calling AdminUserGroupApi->get: #{e}"
|
191
|
+
end
|
192
|
+
```
|
193
|
+
|
194
|
+
### Parameters
|
195
|
+
|
196
|
+
Name | Type | Description | Notes
|
197
|
+
------------- | ------------- | ------------- | -------------
|
198
|
+
**user_group_id** | **String**| ID of the user group. |
|
199
|
+
|
200
|
+
### Return type
|
201
|
+
|
202
|
+
[**UserGroup**](UserGroup.md)
|
203
|
+
|
204
|
+
### Authorization
|
205
|
+
|
206
|
+
[oauth2](../README.md#oauth2)
|
207
|
+
|
208
|
+
### HTTP request headers
|
209
|
+
|
210
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
211
|
+
- **Accept**: application/json
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
# **list**
|
216
|
+
> ListUserGroup list(opts)
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
### Example
|
221
|
+
```ruby
|
222
|
+
# load the gem
|
223
|
+
require 'order_cloud'
|
224
|
+
# setup authorization
|
225
|
+
OrderCloud.configure do |config|
|
226
|
+
# Configure OAuth2 access token for authorization: oauth2
|
227
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
228
|
+
end
|
229
|
+
|
230
|
+
api_instance = OrderCloud::AdminUserGroupApi.new
|
231
|
+
|
232
|
+
opts = {
|
233
|
+
search: "search_example", # String | Word or phrase to search for.
|
234
|
+
search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
|
235
|
+
sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
|
236
|
+
page: 56, # Integer | Page of results to return. Default: 1
|
237
|
+
page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
|
238
|
+
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.???'
|
239
|
+
}
|
240
|
+
|
241
|
+
begin
|
242
|
+
result = api_instance.list(opts)
|
243
|
+
p result
|
244
|
+
rescue OrderCloud::ApiError => e
|
245
|
+
puts "Exception when calling AdminUserGroupApi->list: #{e}"
|
246
|
+
end
|
247
|
+
```
|
248
|
+
|
249
|
+
### Parameters
|
250
|
+
|
251
|
+
Name | Type | Description | Notes
|
252
|
+
------------- | ------------- | ------------- | -------------
|
253
|
+
**search** | **String**| Word or phrase to search for. | [optional]
|
254
|
+
**search_on** | **String**| Comma-delimited list of fields to search on. | [optional]
|
255
|
+
**sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional]
|
256
|
+
**page** | **Integer**| Page of results to return. Default: 1 | [optional]
|
257
|
+
**page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
|
258
|
+
**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]
|
259
|
+
|
260
|
+
### Return type
|
261
|
+
|
262
|
+
[**ListUserGroup**](ListUserGroup.md)
|
263
|
+
|
264
|
+
### Authorization
|
265
|
+
|
266
|
+
[oauth2](../README.md#oauth2)
|
267
|
+
|
268
|
+
### HTTP request headers
|
269
|
+
|
270
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
271
|
+
- **Accept**: application/json
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
# **list_user_assignments**
|
276
|
+
> ListUserGroupAssignment list_user_assignments(opts)
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
### Example
|
281
|
+
```ruby
|
282
|
+
# load the gem
|
283
|
+
require 'order_cloud'
|
284
|
+
# setup authorization
|
285
|
+
OrderCloud.configure do |config|
|
286
|
+
# Configure OAuth2 access token for authorization: oauth2
|
287
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
288
|
+
end
|
289
|
+
|
290
|
+
api_instance = OrderCloud::AdminUserGroupApi.new
|
291
|
+
|
292
|
+
opts = {
|
293
|
+
user_group_id: "user_group_id_example", # String | ID of the user group.
|
294
|
+
user_id: "user_id_example", # String | ID of the user.
|
295
|
+
page: 56, # Integer | Page of results to return. Default: 1
|
296
|
+
page_size: 56 # Integer | Number of results to return per page. Default: 20, max: 100.
|
297
|
+
}
|
298
|
+
|
299
|
+
begin
|
300
|
+
result = api_instance.list_user_assignments(opts)
|
301
|
+
p result
|
302
|
+
rescue OrderCloud::ApiError => e
|
303
|
+
puts "Exception when calling AdminUserGroupApi->list_user_assignments: #{e}"
|
304
|
+
end
|
305
|
+
```
|
306
|
+
|
307
|
+
### Parameters
|
308
|
+
|
309
|
+
Name | Type | Description | Notes
|
310
|
+
------------- | ------------- | ------------- | -------------
|
311
|
+
**user_group_id** | **String**| ID of the user group. | [optional]
|
312
|
+
**user_id** | **String**| ID of the user. | [optional]
|
313
|
+
**page** | **Integer**| Page of results to return. Default: 1 | [optional]
|
314
|
+
**page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
|
315
|
+
|
316
|
+
### Return type
|
317
|
+
|
318
|
+
[**ListUserGroupAssignment**](ListUserGroupAssignment.md)
|
319
|
+
|
320
|
+
### Authorization
|
321
|
+
|
322
|
+
[oauth2](../README.md#oauth2)
|
323
|
+
|
324
|
+
### HTTP request headers
|
325
|
+
|
326
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
327
|
+
- **Accept**: application/json
|
328
|
+
|
329
|
+
|
330
|
+
|
331
|
+
# **patch**
|
332
|
+
> UserGroup patch(user_group_id, group)
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
### Example
|
337
|
+
```ruby
|
338
|
+
# load the gem
|
339
|
+
require 'order_cloud'
|
340
|
+
# setup authorization
|
341
|
+
OrderCloud.configure do |config|
|
342
|
+
# Configure OAuth2 access token for authorization: oauth2
|
343
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
344
|
+
end
|
345
|
+
|
346
|
+
api_instance = OrderCloud::AdminUserGroupApi.new
|
347
|
+
|
348
|
+
user_group_id = "user_group_id_example" # String | ID of the user group.
|
349
|
+
|
350
|
+
group = OrderCloud::UserGroup.new # UserGroup |
|
351
|
+
|
352
|
+
|
353
|
+
begin
|
354
|
+
result = api_instance.patch(user_group_id, group)
|
355
|
+
p result
|
356
|
+
rescue OrderCloud::ApiError => e
|
357
|
+
puts "Exception when calling AdminUserGroupApi->patch: #{e}"
|
358
|
+
end
|
359
|
+
```
|
360
|
+
|
361
|
+
### Parameters
|
362
|
+
|
363
|
+
Name | Type | Description | Notes
|
364
|
+
------------- | ------------- | ------------- | -------------
|
365
|
+
**user_group_id** | **String**| ID of the user group. |
|
366
|
+
**group** | [**UserGroup**](UserGroup.md)| |
|
367
|
+
|
368
|
+
### Return type
|
369
|
+
|
370
|
+
[**UserGroup**](UserGroup.md)
|
371
|
+
|
372
|
+
### Authorization
|
373
|
+
|
374
|
+
[oauth2](../README.md#oauth2)
|
375
|
+
|
376
|
+
### HTTP request headers
|
377
|
+
|
378
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
379
|
+
- **Accept**: application/json
|
380
|
+
|
381
|
+
|
382
|
+
|
383
|
+
# **save_user_assignment**
|
384
|
+
> save_user_assignment(user_group_assignment)
|
385
|
+
|
386
|
+
|
387
|
+
|
388
|
+
### Example
|
389
|
+
```ruby
|
390
|
+
# load the gem
|
391
|
+
require 'order_cloud'
|
392
|
+
# setup authorization
|
393
|
+
OrderCloud.configure do |config|
|
394
|
+
# Configure OAuth2 access token for authorization: oauth2
|
395
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
396
|
+
end
|
397
|
+
|
398
|
+
api_instance = OrderCloud::AdminUserGroupApi.new
|
399
|
+
|
400
|
+
user_group_assignment = OrderCloud::UserGroupAssignment.new # UserGroupAssignment |
|
401
|
+
|
402
|
+
|
403
|
+
begin
|
404
|
+
api_instance.save_user_assignment(user_group_assignment)
|
405
|
+
rescue OrderCloud::ApiError => e
|
406
|
+
puts "Exception when calling AdminUserGroupApi->save_user_assignment: #{e}"
|
407
|
+
end
|
408
|
+
```
|
409
|
+
|
410
|
+
### Parameters
|
411
|
+
|
412
|
+
Name | Type | Description | Notes
|
413
|
+
------------- | ------------- | ------------- | -------------
|
414
|
+
**user_group_assignment** | [**UserGroupAssignment**](UserGroupAssignment.md)| |
|
415
|
+
|
416
|
+
### Return type
|
417
|
+
|
418
|
+
nil (empty response body)
|
419
|
+
|
420
|
+
### Authorization
|
421
|
+
|
422
|
+
[oauth2](../README.md#oauth2)
|
423
|
+
|
424
|
+
### HTTP request headers
|
425
|
+
|
426
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
427
|
+
- **Accept**: application/json
|
428
|
+
|
429
|
+
|
430
|
+
|
431
|
+
# **update**
|
432
|
+
> UserGroup update(user_group_id, group)
|
433
|
+
|
434
|
+
|
435
|
+
|
436
|
+
### Example
|
437
|
+
```ruby
|
438
|
+
# load the gem
|
439
|
+
require 'order_cloud'
|
440
|
+
# setup authorization
|
441
|
+
OrderCloud.configure do |config|
|
442
|
+
# Configure OAuth2 access token for authorization: oauth2
|
443
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
444
|
+
end
|
445
|
+
|
446
|
+
api_instance = OrderCloud::AdminUserGroupApi.new
|
447
|
+
|
448
|
+
user_group_id = "user_group_id_example" # String | ID of the user group.
|
449
|
+
|
450
|
+
group = OrderCloud::UserGroup.new # UserGroup |
|
451
|
+
|
452
|
+
|
453
|
+
begin
|
454
|
+
result = api_instance.update(user_group_id, group)
|
455
|
+
p result
|
456
|
+
rescue OrderCloud::ApiError => e
|
457
|
+
puts "Exception when calling AdminUserGroupApi->update: #{e}"
|
458
|
+
end
|
459
|
+
```
|
460
|
+
|
461
|
+
### Parameters
|
462
|
+
|
463
|
+
Name | Type | Description | Notes
|
464
|
+
------------- | ------------- | ------------- | -------------
|
465
|
+
**user_group_id** | **String**| ID of the user group. |
|
466
|
+
**group** | [**UserGroup**](UserGroup.md)| |
|
467
|
+
|
468
|
+
### Return type
|
469
|
+
|
470
|
+
[**UserGroup**](UserGroup.md)
|
471
|
+
|
472
|
+
### Authorization
|
473
|
+
|
474
|
+
[oauth2](../README.md#oauth2)
|
475
|
+
|
476
|
+
### HTTP request headers
|
477
|
+
|
478
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
479
|
+
- **Accept**: application/json
|
480
|
+
|
481
|
+
|
482
|
+
|