order_cloud 0.0.6 → 1.0.43

data/docs/AddressAssignment.md

@@ -1,12 +0,0 @@
-# OrderCloud::AddressAssignment
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**address_id** | **String** |  | [optional] 
-**user_id** | **String** |  | [optional] 
-**user_group_id** | **String** |  | [optional] 
-**is_shipping** | **BOOLEAN** |  | [optional] 
-**is_billing** | **BOOLEAN** |  | [optional] 
-
-

data/docs/AdminAddressApi.md

@@ -1,324 +0,0 @@
-# OrderCloud::AdminAddressApi
-
-All URIs are relative to *https://api.ordercloud.io/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](AdminAddressApi.md#create) | **POST** /addresses | 
-[**delete**](AdminAddressApi.md#delete) | **DELETE** /addresses/{addressID} | 
-[**get**](AdminAddressApi.md#get) | **GET** /addresses/{addressID} | 
-[**list**](AdminAddressApi.md#list) | **GET** /addresses | 
-[**patch**](AdminAddressApi.md#patch) | **PATCH** /addresses/{addressID} | 
-[**update**](AdminAddressApi.md#update) | **PUT** /addresses/{addressID} | 
-
-
-# **create**
-> Address create(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::AdminAddressApi.new
-
-address = OrderCloud::Address.new # Address | 
-
-
-begin
-  result = api_instance.create(address)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AdminAddressApi->create: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **address** | [**Address**](Address.md)|  | 
-
-### Return type
-
-[**Address**](Address.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **delete**
-> delete(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::AdminAddressApi.new
-
-address_id = "address_id_example" # String | ID of the address.
-
-
-begin
-  api_instance.delete(address_id)
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AdminAddressApi->delete: #{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
-
-
-
-# **get**
-> Address get(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::AdminAddressApi.new
-
-address_id = "address_id_example" # String | ID of the address.
-
-
-begin
-  result = api_instance.get(address_id)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AdminAddressApi->get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **address_id** | **String**| ID of the address. | 
-
-### Return type
-
-[**Address**](Address.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **list**
-> ListAddress 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::AdminAddressApi.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 AdminAddressApi->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
-
-[**ListAddress**](ListAddress.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_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::AdminAddressApi.new
-
-address_id = "address_id_example" # String | ID of the address.
-
-address = OrderCloud::Address.new # Address | 
-
-
-begin
-  result = api_instance.patch(address_id, address)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AdminAddressApi->patch: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **address_id** | **String**| ID of the address. | 
- **address** | [**Address**](Address.md)|  | 
-
-### Return type
-
-[**Address**](Address.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **update**
-> Address update(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::AdminAddressApi.new
-
-address_id = "address_id_example" # String | ID of the address.
-
-address = OrderCloud::Address.new # Address | 
-
-
-begin
-  result = api_instance.update(address_id, address)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AdminAddressApi->update: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **address_id** | **String**| ID of the address. | 
- **address** | [**Address**](Address.md)|  | 
-
-### Return type
-
-[**Address**](Address.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-

data/docs/AdminCompany.md

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

data/docs/AdminModelOnView.md

@@ -1,7 +0,0 @@
-# OrderCloud::AdminModelOnView
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-

data/docs/AdminUserApi.md

@@ -1,323 +0,0 @@
-# OrderCloud::AdminUserApi
-
-All URIs are relative to *https://api.ordercloud.io/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](AdminUserApi.md#create) | **POST** /adminusers | 
-[**delete**](AdminUserApi.md#delete) | **DELETE** /adminusers/{userID} | 
-[**get**](AdminUserApi.md#get) | **GET** /adminusers/{userID} | 
-[**list**](AdminUserApi.md#list) | **GET** /adminusers | 
-[**patch**](AdminUserApi.md#patch) | **PATCH** /adminusers/{userID} | 
-[**update**](AdminUserApi.md#update) | **PUT** /adminusers/{userID} | 
-
-
-# **create**
-> User create(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::AdminUserApi.new
-
-user = OrderCloud::User.new # User | 
-
-
-begin
-  result = api_instance.create(user)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AdminUserApi->create: #{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
-
-
-
-# **delete**
-> delete(user_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::AdminUserApi.new
-
-user_id = "user_id_example" # String | ID of the user.
-
-
-begin
-  api_instance.delete(user_id)
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AdminUserApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **user_id** | **String**| ID of the user. | 
-
-### 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(user_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::AdminUserApi.new
-
-user_id = "user_id_example" # String | ID of the user.
-
-
-begin
-  result = api_instance.get(user_id)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AdminUserApi->get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **user_id** | **String**| ID of the user. | 
-
-### 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
-
-
-
-# **list**
-> ListUser 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::AdminUserApi.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 AdminUserApi->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
-
-[**ListUser**](ListUser.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **patch**
-> patch(user_id, 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::AdminUserApi.new
-
-user_id = "user_id_example" # String | ID of the user.
-
-user = OrderCloud::User.new # User | 
-
-
-begin
-  api_instance.patch(user_id, user)
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AdminUserApi->patch: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **user_id** | **String**| ID of the user. | 
- **user** | [**User**](User.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_id, 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::AdminUserApi.new
-
-user_id = "user_id_example" # String | ID of the user.
-
-user = OrderCloud::User.new # User | 
-
-
-begin
-  result = api_instance.update(user_id, user)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AdminUserApi->update: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **user_id** | **String**| ID of the user. | 
- **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
-
-
-