order_cloud 0.0.1

data/docs/ListUserGroupAssignment.md

@@ -0,0 +1,9 @@
+# OrderCloud::ListUserGroupAssignment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<UserGroupAssignment>**](UserGroupAssignment.md) |  | [optional] 
+**meta** | [**Meta**](Meta.md) |  | [optional] 
+
+

data/docs/ListVariant.md

@@ -0,0 +1,9 @@
+# OrderCloud::ListVariant
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<Variant>**](Variant.md) |  | [optional] 
+**meta** | [**Meta**](Meta.md) |  | [optional] 
+
+

data/docs/ListWebHook.md

@@ -0,0 +1,9 @@
+# OrderCloud::ListWebHook
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<WebHook>**](WebHook.md) |  | [optional] 
+**meta** | [**Meta**](Meta.md) |  | [optional] 
+
+

data/docs/ListWebHookRoute.md

@@ -0,0 +1,9 @@
+# OrderCloud::ListWebHookRoute
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<WebHookRoute>**](WebHookRoute.md) |  | [optional] 
+**meta** | [**Meta**](Meta.md) |  | [optional] 
+
+

data/docs/ListXpIndex.md

@@ -0,0 +1,9 @@
+# OrderCloud::ListXpIndex
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<XpIndex>**](XpIndex.md) |  | [optional] 
+**meta** | [**Meta**](Meta.md) |  | [optional] 
+
+

data/docs/MeApi.md

@@ -0,0 +1,1488 @@
+# OrderCloud::MeApi
+
+All URIs are relative to *https://api.ordercloud.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_address**](MeApi.md#create_address) | **POST** /me/addresses | 
+[**create_credit_card**](MeApi.md#create_credit_card) | **POST** /me/creditcards | 
+[**delete_address**](MeApi.md#delete_address) | **DELETE** /me/addresses/{addressID} | 
+[**delete_credit_card**](MeApi.md#delete_credit_card) | **DELETE** /me/creditcards/{creditcardID} | 
+[**get**](MeApi.md#get) | **GET** /me | 
+[**get_address**](MeApi.md#get_address) | **GET** /me/addresses/{addressID} | 
+[**get_credit_card**](MeApi.md#get_credit_card) | **GET** /me/creditcards/{creditcardID} | 
+[**get_order**](MeApi.md#get_order) | **GET** /me/orders/{orderID} | 
+[**get_product**](MeApi.md#get_product) | **GET** /me/products/{productID} | 
+[**get_promotion**](MeApi.md#get_promotion) | **GET** /me/promotions/{promotionID} | 
+[**get_spec**](MeApi.md#get_spec) | **GET** /me/products/{productID}/specs/{specID} | 
+[**list_addresses**](MeApi.md#list_addresses) | **GET** /me/addresses | 
+[**list_categories**](MeApi.md#list_categories) | **GET** /me/categories | 
+[**list_cost_centers**](MeApi.md#list_cost_centers) | **GET** /me/costcenters | 
+[**list_credit_cards**](MeApi.md#list_credit_cards) | **GET** /me/creditcards | 
+[**list_incoming_orders**](MeApi.md#list_incoming_orders) | **GET** /me/orders/incoming | 
+[**list_outgoing_orders**](MeApi.md#list_outgoing_orders) | **GET** /me/orders/outgoing | 
+[**list_products**](MeApi.md#list_products) | **GET** /me/products | 
+[**list_promotions**](MeApi.md#list_promotions) | **GET** /me/promotions | 
+[**list_specs**](MeApi.md#list_specs) | **GET** /me/products/{productID}/specs | 
+[**list_user_groups**](MeApi.md#list_user_groups) | **GET** /me/usergroups | 
+[**patch**](MeApi.md#patch) | **PATCH** /me | 
+[**patch_address**](MeApi.md#patch_address) | **PATCH** /me/addresses/{addressID} | 
+[**patch_credit_card**](MeApi.md#patch_credit_card) | **PATCH** /me/creditcards/{creditcardID} | 
+[**update**](MeApi.md#update) | **PUT** /me | 
+[**update_address**](MeApi.md#update_address) | **PUT** /me/addresses/{addressID} | 
+[**update_credit_card**](MeApi.md#update_credit_card) | **PUT** /me/creditcards/{creditcardID} | 
+
+
+# **create_address**
+> BuyerAddress create_address(address)
+
+
+
+### 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::MeApi.new
+
+address = OrderCloud::BuyerAddress.new # BuyerAddress | 
+
+
+begin
+  result = api_instance.create_address(address)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->create_address: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **address** | [**BuyerAddress**](BuyerAddress.md)|  | 
+
+### Return type
+
+[**BuyerAddress**](BuyerAddress.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **create_credit_card**
+> BuyerCreditCard create_credit_card(credit_card)
+
+
+
+### 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::MeApi.new
+
+credit_card = OrderCloud::BuyerCreditCard.new # BuyerCreditCard | 
+
+
+begin
+  result = api_instance.create_credit_card(credit_card)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->create_credit_card: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **credit_card** | [**BuyerCreditCard**](BuyerCreditCard.md)|  | 
+
+### Return type
+
+[**BuyerCreditCard**](BuyerCreditCard.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **delete_address**
+> delete_address(address_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::MeApi.new
+
+address_id = "address_id_example" # String | ID of the address.
+
+
+begin
+  api_instance.delete_address(address_id)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->delete_address: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **address_id** | **String**| ID of the address. | 
+
+### 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
+
+
+
+# **delete_credit_card**
+> delete_credit_card(creditcard_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::MeApi.new
+
+creditcard_id = "creditcard_id_example" # String | ID of the creditcard.
+
+
+begin
+  api_instance.delete_credit_card(creditcard_id)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->delete_credit_card: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **creditcard_id** | **String**| ID of the creditcard. | 
+
+### 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**
+> User get
+
+
+
+### 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::MeApi.new
+
+begin
+  result = api_instance.get
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **get_address**
+> BuyerAddress get_address(address_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::MeApi.new
+
+address_id = "address_id_example" # String | ID of the address.
+
+
+begin
+  result = api_instance.get_address(address_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->get_address: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **address_id** | **String**| ID of the address. | 
+
+### Return type
+
+[**BuyerAddress**](BuyerAddress.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **get_credit_card**
+> BuyerCreditCard get_credit_card(creditcard_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::MeApi.new
+
+creditcard_id = "creditcard_id_example" # String | ID of the creditcard.
+
+
+begin
+  result = api_instance.get_credit_card(creditcard_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->get_credit_card: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **creditcard_id** | **String**| ID of the creditcard. | 
+
+### Return type
+
+[**BuyerCreditCard**](BuyerCreditCard.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **get_order**
+> Order get_order(order_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::MeApi.new
+
+order_id = "order_id_example" # String | ID of the order.
+
+
+begin
+  result = api_instance.get_order(order_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->get_order: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| ID of the order. | 
+
+### Return type
+
+[**Order**](Order.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **get_product**
+> BuyerProduct get_product(product_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::MeApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+
+begin
+  result = api_instance.get_product(product_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->get_product: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | 
+
+### Return type
+
+[**BuyerProduct**](BuyerProduct.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **get_promotion**
+> Promotion get_promotion(promotion_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::MeApi.new
+
+promotion_id = "promotion_id_example" # String | ID of the promotion.
+
+
+begin
+  result = api_instance.get_promotion(promotion_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->get_promotion: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **promotion_id** | **String**| ID of the promotion. | 
+
+### Return type
+
+[**Promotion**](Promotion.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **get_spec**
+> BuyerSpec get_spec(product_id, spec_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::MeApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+spec_id = "spec_id_example" # String | ID of the spec.
+
+
+begin
+  result = api_instance.get_spec(product_id, spec_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->get_spec: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | 
+ **spec_id** | **String**| ID of the spec. | 
+
+### Return type
+
+[**BuyerSpec**](BuyerSpec.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_addresses**
+> ListBuyerAddress list_addresses(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::MeApi.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_addresses(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->list_addresses: #{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
+
+[**ListBuyerAddress**](ListBuyerAddress.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_categories**
+> ListCategory list_categories(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::MeApi.new
+
+opts = { 
+  depth: "depth_example", # String | Depth of the category.
+  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_categories(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->list_categories: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **depth** | **String**| Depth of the category. | [optional] 
+ **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
+
+[**ListCategory**](ListCategory.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_cost_centers**
+> ListCostCenter list_cost_centers(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::MeApi.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_cost_centers(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->list_cost_centers: #{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
+
+[**ListCostCenter**](ListCostCenter.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_credit_cards**
+> ListBuyerCreditCard list_credit_cards(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::MeApi.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_credit_cards(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->list_credit_cards: #{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
+
+[**ListBuyerCreditCard**](ListBuyerCreditCard.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_incoming_orders**
+> ListOrder list_incoming_orders(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::MeApi.new
+
+opts = { 
+  from: "from_example", # String | Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).
+  to: "to_example", # String | Upper bound of date range that the order was created (if outgoing) or submitted (if incoming).
+  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_incoming_orders(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->list_incoming_orders: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **from** | **String**| Lower bound of date range that the order was created (if outgoing) or submitted (if incoming). | [optional] 
+ **to** | **String**| Upper bound of date range that the order was created (if outgoing) or submitted (if incoming). | [optional] 
+ **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
+
+[**ListOrder**](ListOrder.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_outgoing_orders**
+> ListOrder list_outgoing_orders(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::MeApi.new
+
+opts = { 
+  from: "from_example", # String | Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).
+  to: "to_example", # String | Upper bound of date range that the order was created (if outgoing) or submitted (if incoming).
+  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_outgoing_orders(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->list_outgoing_orders: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **from** | **String**| Lower bound of date range that the order was created (if outgoing) or submitted (if incoming). | [optional] 
+ **to** | **String**| Upper bound of date range that the order was created (if outgoing) or submitted (if incoming). | [optional] 
+ **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
+
+[**ListOrder**](ListOrder.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_products**
+> ListBuyerProduct list_products(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::MeApi.new
+
+opts = { 
+  category_id: "category_id_example", # String | ID of the category.
+  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_products(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->list_products: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **category_id** | **String**| ID of the category. | [optional] 
+ **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
+
+[**ListBuyerProduct**](ListBuyerProduct.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_promotions**
+> ListPromotion list_promotions(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::MeApi.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_promotions(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->list_promotions: #{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
+
+[**ListPromotion**](ListPromotion.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_specs**
+> ListBuyerSpec list_specs(product_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::MeApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+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_specs(product_id, opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->list_specs: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | 
+ **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
+
+[**ListBuyerSpec**](ListBuyerSpec.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_user_groups**
+> ListUserGroup list_user_groups(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::MeApi.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_user_groups(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->list_user_groups: #{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
+
+[**ListUserGroup**](ListUserGroup.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **patch**
+> User patch(user)
+
+
+
+### 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::MeApi.new
+
+user = OrderCloud::User.new # User | 
+
+
+begin
+  result = api_instance.patch(user)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user** | [**User**](User.md)|  | 
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **patch_address**
+> patch_address(address_id, address)
+
+
+
+### 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::MeApi.new
+
+address_id = "address_id_example" # String | ID of the address.
+
+address = OrderCloud::Address.new # Address | 
+
+
+begin
+  api_instance.patch_address(address_id, address)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->patch_address: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **address_id** | **String**| ID of the address. | 
+ **address** | [**Address**](Address.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
+
+
+
+# **patch_credit_card**
+> patch_credit_card(creditcard_id, credit_card)
+
+
+
+### 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::MeApi.new
+
+creditcard_id = "creditcard_id_example" # String | ID of the creditcard.
+
+credit_card = OrderCloud::CreditCard.new # CreditCard | 
+
+
+begin
+  api_instance.patch_credit_card(creditcard_id, credit_card)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->patch_credit_card: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **creditcard_id** | **String**| ID of the creditcard. | 
+ **credit_card** | [**CreditCard**](CreditCard.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
+
+
+
+# **update**
+> User update(user)
+
+
+
+### 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::MeApi.new
+
+user = OrderCloud::User.new # User | 
+
+
+begin
+  result = api_instance.update(user)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user** | [**User**](User.md)|  | 
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **update_address**
+> BuyerAddress update_address(address_id, address)
+
+
+
+### 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::MeApi.new
+
+address_id = "address_id_example" # String | ID of the address.
+
+address = OrderCloud::BuyerAddress.new # BuyerAddress | 
+
+
+begin
+  result = api_instance.update_address(address_id, address)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->update_address: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **address_id** | **String**| ID of the address. | 
+ **address** | [**BuyerAddress**](BuyerAddress.md)|  | 
+
+### Return type
+
+[**BuyerAddress**](BuyerAddress.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **update_credit_card**
+> BuyerCreditCard update_credit_card(creditcard_id, credit_card)
+
+
+
+### 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::MeApi.new
+
+creditcard_id = "creditcard_id_example" # String | ID of the creditcard.
+
+credit_card = OrderCloud::BuyerCreditCard.new # BuyerCreditCard | 
+
+
+begin
+  result = api_instance.update_credit_card(creditcard_id, credit_card)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling MeApi->update_credit_card: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **creditcard_id** | **String**| ID of the creditcard. | 
+ **credit_card** | [**BuyerCreditCard**](BuyerCreditCard.md)|  | 
+
+### Return type
+
+[**BuyerCreditCard**](BuyerCreditCard.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+