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
data/docs/CategoryApi.md
CHANGED
@@ -472,7 +472,7 @@ Name | Type | Description | Notes
|
|
472
472
|
|
473
473
|
|
474
474
|
# **patch**
|
475
|
-
> patch(buyer_id, category_id, category)
|
475
|
+
> Category patch(buyer_id, category_id, category)
|
476
476
|
|
477
477
|
|
478
478
|
|
@@ -496,7 +496,8 @@ category = OrderCloud::Category.new # Category |
|
|
496
496
|
|
497
497
|
|
498
498
|
begin
|
499
|
-
api_instance.patch(buyer_id, category_id, category)
|
499
|
+
result = api_instance.patch(buyer_id, category_id, category)
|
500
|
+
p result
|
500
501
|
rescue OrderCloud::ApiError => e
|
501
502
|
puts "Exception when calling CategoryApi->patch: #{e}"
|
502
503
|
end
|
@@ -512,7 +513,7 @@ Name | Type | Description | Notes
|
|
512
513
|
|
513
514
|
### Return type
|
514
515
|
|
515
|
-
|
516
|
+
[**Category**](Category.md)
|
516
517
|
|
517
518
|
### Authorization
|
518
519
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# OrderCloud::ListMessageCCListenerAssignment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**items** | [**Array<MessageCCListenerAssignment>**](MessageCCListenerAssignment.md) | | [optional]
|
7
|
+
**meta** | [**Meta**](Meta.md) | | [optional]
|
8
|
+
|
9
|
+
|
@@ -1,9 +1,9 @@
|
|
1
|
-
# OrderCloud::
|
1
|
+
# OrderCloud::ListMessageConfig
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**items** | [**Array<
|
6
|
+
**items** | [**Array<MessageConfig>**](MessageConfig.md) | | [optional]
|
7
7
|
**meta** | [**Meta**](Meta.md) | | [optional]
|
8
8
|
|
9
9
|
|
@@ -1,9 +1,9 @@
|
|
1
|
-
# OrderCloud::
|
1
|
+
# OrderCloud::ListMessageSender
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**items** | [**Array<
|
6
|
+
**items** | [**Array<MessageSender>**](MessageSender.md) | | [optional]
|
7
7
|
**meta** | [**Meta**](Meta.md) | | [optional]
|
8
8
|
|
9
9
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# OrderCloud::ListMessageSenderAssignment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**items** | [**Array<MessageSenderAssignment>**](MessageSenderAssignment.md) | | [optional]
|
7
|
+
**meta** | [**Meta**](Meta.md) | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# OrderCloud::MessageCCListenerAssignment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**message_sender_assignment** | [**MessageSenderAssignment**](MessageSenderAssignment.md) | | [optional]
|
7
|
+
**message_config_name** | **String** | | [optional]
|
8
|
+
**message_type** | **String** | | [optional]
|
9
|
+
**buyer_id** | **String** | | [optional]
|
10
|
+
**user_group_id** | **String** | | [optional]
|
11
|
+
**user_id** | **String** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# OrderCloud::MessageConfig
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**url** | **String** | | [optional]
|
7
|
+
**elevated_claims_list** | **String** | | [optional]
|
8
|
+
**shared_key** | **String** | | [optional]
|
9
|
+
**config_data** | **Object** | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# OrderCloud::MessageSender
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | | [optional]
|
7
|
+
**name** | **String** | | [optional]
|
8
|
+
**message_types** | **String** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# OrderCloud::MessageSenderAssignment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**message_sender_id** | **String** | | [optional]
|
7
|
+
**buyer_id** | **String** | | [optional]
|
8
|
+
**user_id** | **String** | | [optional]
|
9
|
+
**user_group_id** | **String** | | [optional]
|
10
|
+
**message_config_name** | **String** | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,398 @@
|
|
1
|
+
# OrderCloud::MessageSendersApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ordercloud.io/v1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**delete_assignment**](MessageSendersApi.md#delete_assignment) | **DELETE** /MessageSenders/{messageSenderID}/assignments |
|
8
|
+
[**get**](MessageSendersApi.md#get) | **GET** /MessageSenders/{messageSenderID} |
|
9
|
+
[**list**](MessageSendersApi.md#list) | **GET** /MessageSenders |
|
10
|
+
[**list_assignments**](MessageSendersApi.md#list_assignments) | **GET** /MessageSenders/assignments |
|
11
|
+
[**list_cc_listener_assignments**](MessageSendersApi.md#list_cc_listener_assignments) | **GET** /MessageSenders/CCListenerAssignments |
|
12
|
+
[**save_assignment**](MessageSendersApi.md#save_assignment) | **POST** /MessageSenders/assignments |
|
13
|
+
[**save_cc_listener_assignment**](MessageSendersApi.md#save_cc_listener_assignment) | **POST** /MessageSenders/CCListenerAssignments |
|
14
|
+
|
15
|
+
|
16
|
+
# **delete_assignment**
|
17
|
+
> delete_assignment(message_sender_id, opts)
|
18
|
+
|
19
|
+
|
20
|
+
|
21
|
+
### Example
|
22
|
+
```ruby
|
23
|
+
# load the gem
|
24
|
+
require 'order_cloud'
|
25
|
+
# setup authorization
|
26
|
+
OrderCloud.configure do |config|
|
27
|
+
# Configure OAuth2 access token for authorization: oauth2
|
28
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = OrderCloud::MessageSendersApi.new
|
32
|
+
|
33
|
+
message_sender_id = "message_sender_id_example" # String | ID of the message sender.
|
34
|
+
|
35
|
+
opts = {
|
36
|
+
buyer_id: "buyer_id_example", # String | ID of the buyer.
|
37
|
+
user_id: "user_id_example", # String | ID of the user.
|
38
|
+
user_group_id: "user_group_id_example" # String | ID of the user group.
|
39
|
+
}
|
40
|
+
|
41
|
+
begin
|
42
|
+
api_instance.delete_assignment(message_sender_id, opts)
|
43
|
+
rescue OrderCloud::ApiError => e
|
44
|
+
puts "Exception when calling MessageSendersApi->delete_assignment: #{e}"
|
45
|
+
end
|
46
|
+
```
|
47
|
+
|
48
|
+
### Parameters
|
49
|
+
|
50
|
+
Name | Type | Description | Notes
|
51
|
+
------------- | ------------- | ------------- | -------------
|
52
|
+
**message_sender_id** | **String**| ID of the message sender. |
|
53
|
+
**buyer_id** | **String**| ID of the buyer. | [optional]
|
54
|
+
**user_id** | **String**| ID of the user. | [optional]
|
55
|
+
**user_group_id** | **String**| ID of the user group. | [optional]
|
56
|
+
|
57
|
+
### Return type
|
58
|
+
|
59
|
+
nil (empty response body)
|
60
|
+
|
61
|
+
### Authorization
|
62
|
+
|
63
|
+
[oauth2](../README.md#oauth2)
|
64
|
+
|
65
|
+
### HTTP request headers
|
66
|
+
|
67
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
68
|
+
- **Accept**: application/json
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
# **get**
|
73
|
+
> MessageSender get(message_sender_id)
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
### Example
|
78
|
+
```ruby
|
79
|
+
# load the gem
|
80
|
+
require 'order_cloud'
|
81
|
+
# setup authorization
|
82
|
+
OrderCloud.configure do |config|
|
83
|
+
# Configure OAuth2 access token for authorization: oauth2
|
84
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
85
|
+
end
|
86
|
+
|
87
|
+
api_instance = OrderCloud::MessageSendersApi.new
|
88
|
+
|
89
|
+
message_sender_id = "message_sender_id_example" # String | ID of the message sender.
|
90
|
+
|
91
|
+
|
92
|
+
begin
|
93
|
+
result = api_instance.get(message_sender_id)
|
94
|
+
p result
|
95
|
+
rescue OrderCloud::ApiError => e
|
96
|
+
puts "Exception when calling MessageSendersApi->get: #{e}"
|
97
|
+
end
|
98
|
+
```
|
99
|
+
|
100
|
+
### Parameters
|
101
|
+
|
102
|
+
Name | Type | Description | Notes
|
103
|
+
------------- | ------------- | ------------- | -------------
|
104
|
+
**message_sender_id** | **String**| ID of the message sender. |
|
105
|
+
|
106
|
+
### Return type
|
107
|
+
|
108
|
+
[**MessageSender**](MessageSender.md)
|
109
|
+
|
110
|
+
### Authorization
|
111
|
+
|
112
|
+
[oauth2](../README.md#oauth2)
|
113
|
+
|
114
|
+
### HTTP request headers
|
115
|
+
|
116
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
117
|
+
- **Accept**: application/json
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
# **list**
|
122
|
+
> ListMessageSender list(opts)
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
### Example
|
127
|
+
```ruby
|
128
|
+
# load the gem
|
129
|
+
require 'order_cloud'
|
130
|
+
# setup authorization
|
131
|
+
OrderCloud.configure do |config|
|
132
|
+
# Configure OAuth2 access token for authorization: oauth2
|
133
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
134
|
+
end
|
135
|
+
|
136
|
+
api_instance = OrderCloud::MessageSendersApi.new
|
137
|
+
|
138
|
+
opts = {
|
139
|
+
search: "search_example", # String | Word or phrase to search for.
|
140
|
+
search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
|
141
|
+
sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
|
142
|
+
page: 56, # Integer | Page of results to return. Default: 1
|
143
|
+
page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
|
144
|
+
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.???'
|
145
|
+
}
|
146
|
+
|
147
|
+
begin
|
148
|
+
result = api_instance.list(opts)
|
149
|
+
p result
|
150
|
+
rescue OrderCloud::ApiError => e
|
151
|
+
puts "Exception when calling MessageSendersApi->list: #{e}"
|
152
|
+
end
|
153
|
+
```
|
154
|
+
|
155
|
+
### Parameters
|
156
|
+
|
157
|
+
Name | Type | Description | Notes
|
158
|
+
------------- | ------------- | ------------- | -------------
|
159
|
+
**search** | **String**| Word or phrase to search for. | [optional]
|
160
|
+
**search_on** | **String**| Comma-delimited list of fields to search on. | [optional]
|
161
|
+
**sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional]
|
162
|
+
**page** | **Integer**| Page of results to return. Default: 1 | [optional]
|
163
|
+
**page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
|
164
|
+
**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]
|
165
|
+
|
166
|
+
### Return type
|
167
|
+
|
168
|
+
[**ListMessageSender**](ListMessageSender.md)
|
169
|
+
|
170
|
+
### Authorization
|
171
|
+
|
172
|
+
[oauth2](../README.md#oauth2)
|
173
|
+
|
174
|
+
### HTTP request headers
|
175
|
+
|
176
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
177
|
+
- **Accept**: application/json
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
# **list_assignments**
|
182
|
+
> ListMessageSenderAssignment list_assignments(opts)
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
### Example
|
187
|
+
```ruby
|
188
|
+
# load the gem
|
189
|
+
require 'order_cloud'
|
190
|
+
# setup authorization
|
191
|
+
OrderCloud.configure do |config|
|
192
|
+
# Configure OAuth2 access token for authorization: oauth2
|
193
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
194
|
+
end
|
195
|
+
|
196
|
+
api_instance = OrderCloud::MessageSendersApi.new
|
197
|
+
|
198
|
+
opts = {
|
199
|
+
buyer_id: "buyer_id_example", # String | ID of the buyer.
|
200
|
+
message_sender_id: "message_sender_id_example", # String | ID of the message sender.
|
201
|
+
user_id: "user_id_example", # String | ID of the user.
|
202
|
+
user_group_id: "user_group_id_example", # String | ID of the user group.
|
203
|
+
level: "level_example", # String | Level of the message sender.
|
204
|
+
page: 56, # Integer | Page of results to return. Default: 1
|
205
|
+
page_size: 56 # Integer | Number of results to return per page. Default: 20, max: 100.
|
206
|
+
}
|
207
|
+
|
208
|
+
begin
|
209
|
+
result = api_instance.list_assignments(opts)
|
210
|
+
p result
|
211
|
+
rescue OrderCloud::ApiError => e
|
212
|
+
puts "Exception when calling MessageSendersApi->list_assignments: #{e}"
|
213
|
+
end
|
214
|
+
```
|
215
|
+
|
216
|
+
### Parameters
|
217
|
+
|
218
|
+
Name | Type | Description | Notes
|
219
|
+
------------- | ------------- | ------------- | -------------
|
220
|
+
**buyer_id** | **String**| ID of the buyer. | [optional]
|
221
|
+
**message_sender_id** | **String**| ID of the message sender. | [optional]
|
222
|
+
**user_id** | **String**| ID of the user. | [optional]
|
223
|
+
**user_group_id** | **String**| ID of the user group. | [optional]
|
224
|
+
**level** | **String**| Level of the message sender. | [optional]
|
225
|
+
**page** | **Integer**| Page of results to return. Default: 1 | [optional]
|
226
|
+
**page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
|
227
|
+
|
228
|
+
### Return type
|
229
|
+
|
230
|
+
[**ListMessageSenderAssignment**](ListMessageSenderAssignment.md)
|
231
|
+
|
232
|
+
### Authorization
|
233
|
+
|
234
|
+
[oauth2](../README.md#oauth2)
|
235
|
+
|
236
|
+
### HTTP request headers
|
237
|
+
|
238
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
239
|
+
- **Accept**: application/json
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
# **list_cc_listener_assignments**
|
244
|
+
> ListMessageCCListenerAssignment list_cc_listener_assignments(opts)
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
### Example
|
249
|
+
```ruby
|
250
|
+
# load the gem
|
251
|
+
require 'order_cloud'
|
252
|
+
# setup authorization
|
253
|
+
OrderCloud.configure do |config|
|
254
|
+
# Configure OAuth2 access token for authorization: oauth2
|
255
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
256
|
+
end
|
257
|
+
|
258
|
+
api_instance = OrderCloud::MessageSendersApi.new
|
259
|
+
|
260
|
+
opts = {
|
261
|
+
search: "search_example", # String | Word or phrase to search for.
|
262
|
+
search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
|
263
|
+
sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
|
264
|
+
page: 56, # Integer | Page of results to return. Default: 1
|
265
|
+
page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
|
266
|
+
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.???'
|
267
|
+
}
|
268
|
+
|
269
|
+
begin
|
270
|
+
result = api_instance.list_cc_listener_assignments(opts)
|
271
|
+
p result
|
272
|
+
rescue OrderCloud::ApiError => e
|
273
|
+
puts "Exception when calling MessageSendersApi->list_cc_listener_assignments: #{e}"
|
274
|
+
end
|
275
|
+
```
|
276
|
+
|
277
|
+
### Parameters
|
278
|
+
|
279
|
+
Name | Type | Description | Notes
|
280
|
+
------------- | ------------- | ------------- | -------------
|
281
|
+
**search** | **String**| Word or phrase to search for. | [optional]
|
282
|
+
**search_on** | **String**| Comma-delimited list of fields to search on. | [optional]
|
283
|
+
**sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional]
|
284
|
+
**page** | **Integer**| Page of results to return. Default: 1 | [optional]
|
285
|
+
**page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
|
286
|
+
**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]
|
287
|
+
|
288
|
+
### Return type
|
289
|
+
|
290
|
+
[**ListMessageCCListenerAssignment**](ListMessageCCListenerAssignment.md)
|
291
|
+
|
292
|
+
### Authorization
|
293
|
+
|
294
|
+
[oauth2](../README.md#oauth2)
|
295
|
+
|
296
|
+
### HTTP request headers
|
297
|
+
|
298
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
299
|
+
- **Accept**: application/json
|
300
|
+
|
301
|
+
|
302
|
+
|
303
|
+
# **save_assignment**
|
304
|
+
> save_assignment(assignment)
|
305
|
+
|
306
|
+
|
307
|
+
|
308
|
+
### Example
|
309
|
+
```ruby
|
310
|
+
# load the gem
|
311
|
+
require 'order_cloud'
|
312
|
+
# setup authorization
|
313
|
+
OrderCloud.configure do |config|
|
314
|
+
# Configure OAuth2 access token for authorization: oauth2
|
315
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
316
|
+
end
|
317
|
+
|
318
|
+
api_instance = OrderCloud::MessageSendersApi.new
|
319
|
+
|
320
|
+
assignment = OrderCloud::MessageSenderAssignment.new # MessageSenderAssignment |
|
321
|
+
|
322
|
+
|
323
|
+
begin
|
324
|
+
api_instance.save_assignment(assignment)
|
325
|
+
rescue OrderCloud::ApiError => e
|
326
|
+
puts "Exception when calling MessageSendersApi->save_assignment: #{e}"
|
327
|
+
end
|
328
|
+
```
|
329
|
+
|
330
|
+
### Parameters
|
331
|
+
|
332
|
+
Name | Type | Description | Notes
|
333
|
+
------------- | ------------- | ------------- | -------------
|
334
|
+
**assignment** | [**MessageSenderAssignment**](MessageSenderAssignment.md)| |
|
335
|
+
|
336
|
+
### Return type
|
337
|
+
|
338
|
+
nil (empty response body)
|
339
|
+
|
340
|
+
### Authorization
|
341
|
+
|
342
|
+
[oauth2](../README.md#oauth2)
|
343
|
+
|
344
|
+
### HTTP request headers
|
345
|
+
|
346
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
347
|
+
- **Accept**: application/json
|
348
|
+
|
349
|
+
|
350
|
+
|
351
|
+
# **save_cc_listener_assignment**
|
352
|
+
> save_cc_listener_assignment(assignment)
|
353
|
+
|
354
|
+
|
355
|
+
|
356
|
+
### Example
|
357
|
+
```ruby
|
358
|
+
# load the gem
|
359
|
+
require 'order_cloud'
|
360
|
+
# setup authorization
|
361
|
+
OrderCloud.configure do |config|
|
362
|
+
# Configure OAuth2 access token for authorization: oauth2
|
363
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
364
|
+
end
|
365
|
+
|
366
|
+
api_instance = OrderCloud::MessageSendersApi.new
|
367
|
+
|
368
|
+
assignment = OrderCloud::MessageCCListenerAssignment.new # MessageCCListenerAssignment |
|
369
|
+
|
370
|
+
|
371
|
+
begin
|
372
|
+
api_instance.save_cc_listener_assignment(assignment)
|
373
|
+
rescue OrderCloud::ApiError => e
|
374
|
+
puts "Exception when calling MessageSendersApi->save_cc_listener_assignment: #{e}"
|
375
|
+
end
|
376
|
+
```
|
377
|
+
|
378
|
+
### Parameters
|
379
|
+
|
380
|
+
Name | Type | Description | Notes
|
381
|
+
------------- | ------------- | ------------- | -------------
|
382
|
+
**assignment** | [**MessageCCListenerAssignment**](MessageCCListenerAssignment.md)| |
|
383
|
+
|
384
|
+
### Return type
|
385
|
+
|
386
|
+
nil (empty response body)
|
387
|
+
|
388
|
+
### Authorization
|
389
|
+
|
390
|
+
[oauth2](../README.md#oauth2)
|
391
|
+
|
392
|
+
### HTTP request headers
|
393
|
+
|
394
|
+
- **Content-Type**: application/json, text/plain; charset=utf-8
|
395
|
+
- **Accept**: application/json
|
396
|
+
|
397
|
+
|
398
|
+
|