wine_shipping 1.0.0

data/docs/ItemInfo.md

@@ -0,0 +1,10 @@
+# WineShipping::ItemInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item_no** | **String** |  | [optional] 
+**item_description** | **String** |  | [optional] 
+**item_quantity** | **Integer** |  | [optional] 
+
+

data/docs/OrderOnHold.md

@@ -0,0 +1,19 @@
+# WineShipping::OrderOnHold
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer_no** | **String** |  | [optional] 
+**customer_name** | **String** |  | [optional] 
+**order_no** | **String** |  | [optional] 
+**order_type** | **String** |  | [optional] 
+**order_date** | **String** |  | [optional] 
+**shipment_date** | **String** |  | [optional] 
+**shipping_site** | **String** |  | [optional] 
+**shipping_warehouse** | **String** |  | [optional] 
+**hold_reason** | **String** |  | [optional] 
+**shipping_carrier** | **String** |  | [optional] 
+**shipping_carrier_service** | **String** |  | [optional] 
+**order_on_hold_items** | [**Array<OrderOnHoldItem>**](OrderOnHoldItem.md) |  | [optional] 
+
+

data/docs/OrderOnHoldItem.md

@@ -0,0 +1,11 @@
+# WineShipping::OrderOnHoldItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item_no** | **String** |  | [optional] 
+**quantity** | **String** |  | [optional] 
+**item_description** | **String** |  | [optional] 
+**quantity_reserved** | **String** |  | [optional] 
+
+

data/docs/PackageItem.md

@@ -0,0 +1,10 @@
+# WineShipping::PackageItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item_no** | **String** |  | [optional] 
+**quantity** | **String** |  | [optional] 
+**item_description** | **String** |  | [optional] 
+
+

data/docs/PurchaseOrderDetails.md

@@ -0,0 +1,10 @@
+# WineShipping::PurchaseOrderDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authentication** | [**Authentication**](Authentication.md) |  | [optional] 
+**order_info** | [**PurchaseOrderInfo**](PurchaseOrderInfo.md) |  | [optional] 
+**items_info** | [**Array<PurchaseOrderItemInfo>**](PurchaseOrderItemInfo.md) |  | [optional] 
+
+

data/docs/PurchaseOrderInfo.md

@@ -0,0 +1,24 @@
+# WineShipping::PurchaseOrderInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer_reference_no** | **String** |  | [optional] 
+**transport_method** | **Integer** |  | [optional] 
+**requested_date** | **DateTime** |  | [optional] 
+**receive_to_location** | **String** |  | [optional] 
+**inventory_status_code** | **String** |  | [optional] 
+**reference_no** | **String** |  | [optional] 
+**first_name** | **String** |  | [optional] 
+**last_name** | **String** |  | [optional] 
+**company** | **String** |  | [optional] 
+**address** | **String** |  | [optional] 
+**address2** | **String** |  | [optional] 
+**city** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+**zip_code** | **String** |  | [optional] 
+**phone_number** | **String** |  | [optional] 
+**email_address** | **String** |  | [optional] 
+**special_instruction** | **String** |  | [optional] 
+
+

data/docs/PurchaseOrderItemInfo.md

@@ -0,0 +1,10 @@
+# WineShipping::PurchaseOrderItemInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item_no** | **String** |  | [optional] 
+**item_description** | **String** |  | [optional] 
+**item_quantity** | **Integer** |  | [optional] 
+
+

data/docs/RecipientContactInfo.md

@@ -0,0 +1,18 @@
+# WineShipping::RecipientContactInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | [optional] 
+**last_name** | **String** |  | [optional] 
+**company** | **String** |  | [optional] 
+**address** | **String** |  | [optional] 
+**address2** | **String** |  | [optional] 
+**city** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+**zip_code** | **String** |  | [optional] 
+**country** | **String** |  | [optional] 
+**phone_number** | **String** |  | [optional] 
+**email_address** | **String** |  | [optional] 
+
+

data/docs/RequestorInfo.md

@@ -0,0 +1,11 @@
+# WineShipping::RequestorInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | [optional] 
+**last_name** | **String** |  | [optional] 
+**phone_number** | **String** |  | [optional] 
+**email_address** | **String** |  | [optional] 
+
+

data/docs/ReturnResult.md

@@ -0,0 +1,12 @@
+# WineShipping::ReturnResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_record_count** | **Integer** |  | [optional] 
+**skip** | **Integer** |  | [optional] 
+**top** | **Integer** |  | [optional] 
+**more_records** | **BOOLEAN** |  | [optional] 
+**return_sales_order_headers** | [**Array<ReturnSalesOrderHeader>**](ReturnSalesOrderHeader.md) |  | [optional] 
+
+

data/docs/ReturnSalesOrderHeader.md

@@ -0,0 +1,31 @@
+# WineShipping::ReturnSalesOrderHeader
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer_no** | **String** |  | [optional] 
+**customer_name** | **String** |  | [optional] 
+**rma_number** | **String** |  | [optional] 
+**order_no** | **String** |  | [optional] 
+**received_date** | **String** |  | [optional] 
+**close_date** | **String** |  | [optional] 
+**ship_to_name** | **String** |  | [optional] 
+**ship_to_company** | **String** |  | [optional] 
+**ship_to_address** | **String** |  | [optional] 
+**ship_to_address2** | **String** |  | [optional] 
+**ship_to_city** | **String** |  | [optional] 
+**ship_to_state** | **String** |  | [optional] 
+**ship_to_zip_code** | **String** |  | [optional] 
+**ship_to_country** | **String** |  | [optional] 
+**email_address** | **String** |  | [optional] 
+**phone_number** | **String** |  | [optional] 
+**return_warehouse** | **String** |  | [optional] 
+**return_status** | **String** |  | [optional] 
+**disposition_code** | **String** |  | [optional] 
+**return_reason** | **String** |  | [optional] 
+**original_tracking_number** | **String** |  | [optional] 
+**shipping_carrier_code** | **String** |  | [optional] 
+**shippng_service_code** | **String** |  | [optional] 
+**return_sales_order_lines** | [**Array<ReturnSalesOrderLine>**](ReturnSalesOrderLine.md) |  | [optional] 
+
+

data/docs/ReturnSalesOrderLine.md

@@ -0,0 +1,13 @@
+# WineShipping::ReturnSalesOrderLine
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item_no** | **String** |  | [optional] 
+**item_description** | **String** |  | [optional] 
+**quantity** | **String** |  | [optional] 
+**uom** | **String** |  | [optional] 
+**disposition_code** | **String** |  | [optional] 
+**inventory_status_code** | **String** |  | [optional] 
+
+

data/docs/ReturnsRequest.md

@@ -0,0 +1,16 @@
+# WineShipping::ReturnsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authentication** | [**Authentication**](Authentication.md) |  | [optional] 
+**order_numbers** | **Array<String>** |  | [optional] 
+**start_time** | **DateTime** |  | [optional] 
+**end_time** | **DateTime** |  | [optional] 
+**disposition_code** | **String** |  | [optional] 
+**warehouse** | **String** |  | [optional] 
+**include_total_record_count** | **BOOLEAN** |  | [optional] 
+**skip** | **Integer** |  | [optional] 
+**top** | **Integer** |  | [optional] 
+
+

data/docs/SKUApi.md

@@ -0,0 +1,54 @@
+# WineShipping::SKUApi
+
+All URIs are relative to *https://wsservices-test.azurewebsites.net*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_sku**](SKUApi.md#create_sku) | **POST** /api/SKU/CreateSKU | 
+
+
+# **create_sku**
+> create_sku(sku_request_details)
+
+
+
+Successful execution of this method will generate a new SKU in Wineshipping's system and will return a transaction reference identifier. Store this identifier back into your system for reference later in the event there is an issue with the SKU.
+
+### Example
+```ruby
+# load the gem
+require 'wine_shipping'
+
+api_instance = WineShipping::SKUApi.new
+
+sku_request_details = WineShipping::SKUDetails.new # SKUDetails | 
+
+
+begin
+  api_instance.create_sku(sku_request_details)
+rescue WineShipping::ApiError => e
+  puts "Exception when calling SKUApi->create_sku: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sku_request_details** | [**SKUDetails**](SKUDetails.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/SKUDetails.md

@@ -0,0 +1,10 @@
+# WineShipping::SKUDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authentication** | [**Authentication**](Authentication.md) |  | [optional] 
+**requestor_info** | [**RequestorInfo**](RequestorInfo.md) |  | [optional] 
+**sku_info** | [**SKUInfo**](SKUInfo.md) |  | [optional] 
+
+

data/docs/SKUInfo.md

@@ -0,0 +1,20 @@
+# WineShipping::SKUInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item_category** | **Integer** |  | [optional] 
+**item_no** | **String** |  | [optional] 
+**item_description** | **String** |  | [optional] 
+**vintage** | **String** |  | [optional] 
+**varietal** | **String** |  | [optional] 
+**appellation** | **String** |  | [optional] 
+**value** | **String** |  | [optional] 
+**alcohol_by_volume** | **String** |  | [optional] 
+**upc_code** | **String** |  | [optional] 
+**uom** | **String** |  | [optional] 
+**num_bottle_in_each_case** | **String** |  | [optional] 
+**classification** | **String** |  | [optional] 
+**comments** | **String** |  | [optional] 
+
+

data/docs/SalesOrderApi.md

@@ -0,0 +1,240 @@
+# WineShipping::SalesOrderApi
+
+All URIs are relative to *https://wsservices-test.azurewebsites.net*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancel_sales_order**](SalesOrderApi.md#cancel_sales_order) | **POST** /api/SalesOrder/CancelSalesOrder | 
+[**create_sales_order**](SalesOrderApi.md#create_sales_order) | **POST** /api/SalesOrder/CreateSalesOrder | 
+[**get_orders_on_hold**](SalesOrderApi.md#get_orders_on_hold) | **POST** /api/SalesOrder/GetOrdersOnHold | 
+[**get_returns**](SalesOrderApi.md#get_returns) | **POST** /api/SalesOrder/GetReturns | 
+[**replace_sales_order**](SalesOrderApi.md#replace_sales_order) | **POST** /api/SalesOrder/ReplaceSalesOrder | 
+
+
+# **cancel_sales_order**
+> cancel_sales_order(cancel_sales_order_request)
+
+
+
+Use this operation to cancel an existing open sales order. Successful execution of this method will cancel the sales order in Wineshipping system. If the order cannot be cancelled for some reason standard HTTP Status Code and a reason will be returned.
+
+### Example
+```ruby
+# load the gem
+require 'wine_shipping'
+
+api_instance = WineShipping::SalesOrderApi.new
+
+cancel_sales_order_request = WineShipping::SalesOrderCancelRequest.new # SalesOrderCancelRequest | 
+
+
+begin
+  api_instance.cancel_sales_order(cancel_sales_order_request)
+rescue WineShipping::ApiError => e
+  puts "Exception when calling SalesOrderApi->cancel_sales_order: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cancel_sales_order_request** | [**SalesOrderCancelRequest**](SalesOrderCancelRequest.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_sales_order**
+> create_sales_order(order_details_info)
+
+
+
+Successful execution of this method will generate a new shipment order in Wineshipping's system and will return a transaction reference identifier. Store this identifier back into your system for reference later in the event there is an issue with your order.
+
+### Example
+```ruby
+# load the gem
+require 'wine_shipping'
+
+api_instance = WineShipping::SalesOrderApi.new
+
+order_details_info = WineShipping::SalesOrderDetails.new # SalesOrderDetails | 
+
+
+begin
+  api_instance.create_sales_order(order_details_info)
+rescue WineShipping::ApiError => e
+  puts "Exception when calling SalesOrderApi->create_sales_order: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_details_info** | [**SalesOrderDetails**](SalesOrderDetails.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_orders_on_hold**
+> Array<OrderOnHold> get_orders_on_hold(authentication_details)
+
+
+
+Use this operation to retrieve a list of on-hold orders for a customer. Successful execution of this method will generate a list of on hold orders from Wineshipping's system and if no orders are on hold, HTTP status code Not Found response will be returned.
+
+### Example
+```ruby
+# load the gem
+require 'wine_shipping'
+
+api_instance = WineShipping::SalesOrderApi.new
+
+authentication_details = WineShipping::Authentication.new # Authentication | 
+
+
+begin
+  result = api_instance.get_orders_on_hold(authentication_details)
+  p result
+rescue WineShipping::ApiError => e
+  puts "Exception when calling SalesOrderApi->get_orders_on_hold: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authentication_details** | [**Authentication**](Authentication.md)|  | 
+
+### Return type
+
+[**Array<OrderOnHold>**](OrderOnHold.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_returns**
+> ReturnResult get_returns(returns_request_details)
+
+
+
+Use this operation to retrieve a list of return sales orders for a customer. Successful execution of this method will generate a list of returns from Wineshipping system.
+
+### Example
+```ruby
+# load the gem
+require 'wine_shipping'
+
+api_instance = WineShipping::SalesOrderApi.new
+
+returns_request_details = WineShipping::ReturnsRequest.new # ReturnsRequest | 
+
+
+begin
+  result = api_instance.get_returns(returns_request_details)
+  p result
+rescue WineShipping::ApiError => e
+  puts "Exception when calling SalesOrderApi->get_returns: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **returns_request_details** | [**ReturnsRequest**](ReturnsRequest.md)|  | 
+
+### Return type
+
+[**ReturnResult**](ReturnResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **replace_sales_order**
+> replace_sales_order(order_details_info)
+
+
+
+Use this operation to replace/update an existing open sales order. Successful execution of this method will replace an open sales order in Wineshipping system and will return a transaction reference identifier. Store this identifier back into your system for reference later in the event there is an issue with your replacement order. If the order cannot be replaced for some, reason standard HTTP Status Code and a reason message will be returned.
+
+### Example
+```ruby
+# load the gem
+require 'wine_shipping'
+
+api_instance = WineShipping::SalesOrderApi.new
+
+order_details_info = WineShipping::SalesOrderDetails.new # SalesOrderDetails | 
+
+
+begin
+  api_instance.replace_sales_order(order_details_info)
+rescue WineShipping::ApiError => e
+  puts "Exception when calling SalesOrderApi->replace_sales_order: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_details_info** | [**SalesOrderDetails**](SalesOrderDetails.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+