order_cloud 0.0.6 → 1.0.43

data/Rakefile

@@ -1,31 +0,0 @@
-=begin
-#OrderCloud
-
-#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
-
-OpenAPI spec version: 1.0
-Contact: ordercloud@four51.com
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-
-=end
-
-require 'rake'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = Dir.glob('spec/**/*_spec.rb')
-  t.rspec_opts = '--format documentation'
-end
-task :default => :spec

data/docs/AccessToken.md

@@ -1,10 +0,0 @@
-# OrderCloud::AccessToken
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**access_token** | **String** |  | [optional] 
-**expires_in** | **Integer** |  | [optional] 
-**token_type** | **String** |  | [optional] 
-
-

data/docs/Address.md

@@ -1,20 +0,0 @@
-# OrderCloud::Address
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**company_name** | **String** |  | [optional] 
-**first_name** | **String** |  | [optional] 
-**last_name** | **String** |  | [optional] 
-**street1** | **String** |  | [optional] 
-**street2** | **String** |  | [optional] 
-**city** | **String** |  | [optional] 
-**state** | **String** |  | [optional] 
-**zip** | **String** |  | [optional] 
-**country** | **String** |  | [optional] 
-**phone** | **String** |  | [optional] 
-**address_name** | **String** |  | [optional] 
-**xp** | **Object** |  | [optional] 
-
-

data/docs/AddressApi.md

@@ -1,520 +0,0 @@
-# OrderCloud::AddressApi
-
-All URIs are relative to *https://api.ordercloud.io/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](AddressApi.md#create) | **POST** /buyers/{buyerID}/addresses | 
-[**delete**](AddressApi.md#delete) | **DELETE** /buyers/{buyerID}/addresses/{addressID} | 
-[**delete_assignment**](AddressApi.md#delete_assignment) | **DELETE** /buyers/{buyerID}/addresses/{addressID}/assignments | 
-[**get**](AddressApi.md#get) | **GET** /buyers/{buyerID}/addresses/{addressID} | 
-[**list**](AddressApi.md#list) | **GET** /buyers/{buyerID}/addresses | 
-[**list_assignments**](AddressApi.md#list_assignments) | **GET** /buyers/{buyerID}/addresses/assignments | 
-[**patch**](AddressApi.md#patch) | **PATCH** /buyers/{buyerID}/addresses/{addressID} | 
-[**save_assignment**](AddressApi.md#save_assignment) | **POST** /buyers/{buyerID}/addresses/assignments | 
-[**update**](AddressApi.md#update) | **PUT** /buyers/{buyerID}/addresses/{addressID} | 
-
-
-# **create**
-> Address create(buyer_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::AddressApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-address = OrderCloud::Address.new # Address | 
-
-
-begin
-  result = api_instance.create(buyer_id, address)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AddressApi->create: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **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(buyer_id, 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::AddressApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-address_id = "address_id_example" # String | ID of the address.
-
-
-begin
-  api_instance.delete(buyer_id, address_id)
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AddressApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **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_assignment**
-> delete_assignment(buyer_id, address_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::AddressApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-address_id = "address_id_example" # String | ID of the address.
-
-opts = { 
-  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(buyer_id, address_id, opts)
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AddressApi->delete_assignment: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **address_id** | **String**| ID of the address. | 
- **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**
-> Address get(buyer_id, 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::AddressApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-address_id = "address_id_example" # String | ID of the address.
-
-
-begin
-  result = api_instance.get(buyer_id, address_id)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AddressApi->get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **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(buyer_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::AddressApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-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(buyer_id, opts)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AddressApi->list: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **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
-
-
-
-# **list_assignments**
-> ListAddressAssignment list_assignments(buyer_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::AddressApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-opts = { 
-  address_id: "address_id_example", # String | ID of the address.
-  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 address.
-  is_shipping: true, # BOOLEAN | Is shipping of the address.
-  is_billing: true, # BOOLEAN | Is billing of the address.
-  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(buyer_id, opts)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AddressApi->list_assignments: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **address_id** | **String**| ID of the address. | [optional] 
- **user_id** | **String**| ID of the user. | [optional] 
- **user_group_id** | **String**| ID of the user group. | [optional] 
- **level** | **String**| Level of the address. | [optional] 
- **is_shipping** | **BOOLEAN**| Is shipping of the address. | [optional] 
- **is_billing** | **BOOLEAN**| Is billing of the address. | [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
-
-[**ListAddressAssignment**](ListAddressAssignment.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **patch**
-> Address patch(buyer_id, 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::AddressApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-address_id = "address_id_example" # String | ID of the address.
-
-address = OrderCloud::Address.new # Address | 
-
-
-begin
-  result = api_instance.patch(buyer_id, address_id, address)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AddressApi->patch: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **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
-
-
-
-# **save_assignment**
-> save_assignment(buyer_id, 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::AddressApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-assignment = OrderCloud::AddressAssignment.new # AddressAssignment | 
-
-
-begin
-  api_instance.save_assignment(buyer_id, assignment)
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AddressApi->save_assignment: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **assignment** | [**AddressAssignment**](AddressAssignment.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**
-> Address update(buyer_id, 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::AddressApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-address_id = "address_id_example" # String | ID of the address.
-
-address = OrderCloud::Address.new # Address | 
-
-
-begin
-  result = api_instance.update(buyer_id, address_id, address)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling AddressApi->update: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **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
-
-
-