order_cloud 0.0.6 → 1.0.43

data/docs/MessageCCListenerAssignment.md

@@ -1,13 +0,0 @@
-# OrderCloud::MessageCCListenerAssignment
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message_sender_assignment** | [**MessageSenderAssignment**](MessageSenderAssignment.md) |  | [optional] 
-**message_config_name** | **String** |  | [optional] 
-**message_type** | **String** |  | [optional] 
-**buyer_id** | **String** |  | [optional] 
-**user_group_id** | **String** |  | [optional] 
-**user_id** | **String** |  | [optional] 
-
-

data/docs/MessageConfig.md

@@ -1,11 +0,0 @@
-# OrderCloud::MessageConfig
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**url** | **String** |  | [optional] 
-**elevated_claims_list** | **String** |  | [optional] 
-**shared_key** | **String** |  | [optional] 
-**config_data** | **Object** |  | [optional] 
-
-

data/docs/MessageSender.md

@@ -1,10 +0,0 @@
-# OrderCloud::MessageSender
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**name** | **String** |  | [optional] 
-**message_types** | **String** |  | [optional] 
-
-

data/docs/MessageSenderAssignment.md

@@ -1,12 +0,0 @@
-# OrderCloud::MessageSenderAssignment
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message_sender_id** | **String** |  | [optional] 
-**buyer_id** | **String** |  | [optional] 
-**user_id** | **String** |  | [optional] 
-**user_group_id** | **String** |  | [optional] 
-**message_config_name** | **String** |  | [optional] 
-
-

data/docs/MessageSendersApi.md

@@ -1,398 +0,0 @@
-# OrderCloud::MessageSendersApi
-
-All URIs are relative to *https://api.ordercloud.io/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**delete_assignment**](MessageSendersApi.md#delete_assignment) | **DELETE** /MessageSenders/{messageSenderID}/assignments | 
-[**get**](MessageSendersApi.md#get) | **GET** /MessageSenders/{messageSenderID} | 
-[**list**](MessageSendersApi.md#list) | **GET** /MessageSenders | 
-[**list_assignments**](MessageSendersApi.md#list_assignments) | **GET** /MessageSenders/assignments | 
-[**list_cc_listener_assignments**](MessageSendersApi.md#list_cc_listener_assignments) | **GET** /MessageSenders/CCListenerAssignments | 
-[**save_assignment**](MessageSendersApi.md#save_assignment) | **POST** /MessageSenders/assignments | 
-[**save_cc_listener_assignment**](MessageSendersApi.md#save_cc_listener_assignment) | **POST** /MessageSenders/CCListenerAssignments | 
-
-
-# **delete_assignment**
-> delete_assignment(message_sender_id, opts)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::MessageSendersApi.new
-
-message_sender_id = "message_sender_id_example" # String | ID of the message sender.
-
-opts = { 
-  buyer_id: "buyer_id_example", # String | ID of the buyer.
-  user_id: "user_id_example", # String | ID of the user.
-  user_group_id: "user_group_id_example" # String | ID of the user group.
-}
-
-begin
-  api_instance.delete_assignment(message_sender_id, opts)
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling MessageSendersApi->delete_assignment: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **message_sender_id** | **String**| ID of the message sender. | 
- **buyer_id** | **String**| ID of the buyer. | [optional] 
- **user_id** | **String**| ID of the user. | [optional] 
- **user_group_id** | **String**| ID of the user group. | [optional] 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **get**
-> MessageSender get(message_sender_id)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::MessageSendersApi.new
-
-message_sender_id = "message_sender_id_example" # String | ID of the message sender.
-
-
-begin
-  result = api_instance.get(message_sender_id)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling MessageSendersApi->get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **message_sender_id** | **String**| ID of the message sender. | 
-
-### Return type
-
-[**MessageSender**](MessageSender.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **list**
-> ListMessageSender list(opts)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::MessageSendersApi.new
-
-opts = { 
-  search: "search_example", # String | Word or phrase to search for.
-  search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
-  sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
-  page: 56, # Integer | Page of results to return. Default: 1
-  page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
-  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.???'
-}
-
-begin
-  result = api_instance.list(opts)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling MessageSendersApi->list: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **search** | **String**| Word or phrase to search for. | [optional] 
- **search_on** | **String**| Comma-delimited list of fields to search on. | [optional] 
- **sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional] 
- **page** | **Integer**| Page of results to return. Default: 1 | [optional] 
- **page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional] 
- **filters** | [**Hash&lt;String, String&gt;**](String.md)| Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39; | [optional] 
-
-### Return type
-
-[**ListMessageSender**](ListMessageSender.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **list_assignments**
-> ListMessageSenderAssignment list_assignments(opts)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::MessageSendersApi.new
-
-opts = { 
-  buyer_id: "buyer_id_example", # String | ID of the buyer.
-  message_sender_id: "message_sender_id_example", # String | ID of the message sender.
-  user_id: "user_id_example", # String | ID of the user.
-  user_group_id: "user_group_id_example", # String | ID of the user group.
-  level: "level_example", # String | Level of the message sender.
-  page: 56, # Integer | Page of results to return. Default: 1
-  page_size: 56 # Integer | Number of results to return per page. Default: 20, max: 100.
-}
-
-begin
-  result = api_instance.list_assignments(opts)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling MessageSendersApi->list_assignments: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | [optional] 
- **message_sender_id** | **String**| ID of the message sender. | [optional] 
- **user_id** | **String**| ID of the user. | [optional] 
- **user_group_id** | **String**| ID of the user group. | [optional] 
- **level** | **String**| Level of the message sender. | [optional] 
- **page** | **Integer**| Page of results to return. Default: 1 | [optional] 
- **page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional] 
-
-### Return type
-
-[**ListMessageSenderAssignment**](ListMessageSenderAssignment.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **list_cc_listener_assignments**
-> ListMessageCCListenerAssignment list_cc_listener_assignments(opts)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::MessageSendersApi.new
-
-opts = { 
-  search: "search_example", # String | Word or phrase to search for.
-  search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
-  sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
-  page: 56, # Integer | Page of results to return. Default: 1
-  page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
-  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.???'
-}
-
-begin
-  result = api_instance.list_cc_listener_assignments(opts)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling MessageSendersApi->list_cc_listener_assignments: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **search** | **String**| Word or phrase to search for. | [optional] 
- **search_on** | **String**| Comma-delimited list of fields to search on. | [optional] 
- **sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional] 
- **page** | **Integer**| Page of results to return. Default: 1 | [optional] 
- **page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional] 
- **filters** | [**Hash&lt;String, String&gt;**](String.md)| Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39; | [optional] 
-
-### Return type
-
-[**ListMessageCCListenerAssignment**](ListMessageCCListenerAssignment.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **save_assignment**
-> save_assignment(assignment)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::MessageSendersApi.new
-
-assignment = OrderCloud::MessageSenderAssignment.new # MessageSenderAssignment | 
-
-
-begin
-  api_instance.save_assignment(assignment)
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling MessageSendersApi->save_assignment: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **assignment** | [**MessageSenderAssignment**](MessageSenderAssignment.md)|  | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **save_cc_listener_assignment**
-> save_cc_listener_assignment(assignment)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::MessageSendersApi.new
-
-assignment = OrderCloud::MessageCCListenerAssignment.new # MessageCCListenerAssignment | 
-
-
-begin
-  api_instance.save_cc_listener_assignment(assignment)
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling MessageSendersApi->save_cc_listener_assignment: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **assignment** | [**MessageCCListenerAssignment**](MessageCCListenerAssignment.md)|  | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-

data/docs/Meta.md

@@ -1,12 +0,0 @@
-# OrderCloud::Meta
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**page** | **Integer** |  | [optional] 
-**page_size** | **Integer** |  | [optional] 
-**total_count** | **Integer** |  | [optional] 
-**total_pages** | **Integer** |  | [optional] 
-**item_range** | **Array<Integer>** |  | [optional] 
-
-