wine_shipping 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 468af68b215dad640e19094781538965307c00f9
+  data.tar.gz: a7f9ea3b26e0cbcd93f00b648bbb6371788735cb
+SHA512:
+  metadata.gz: cb4a05a4150df4ef4f5a8bbea21153354d859b99b16222f571cfd5a29dc4e333ae90aca23a8ad73545384625203c3fe988e8bb07e9e3b67d5ff51144aa66954a
+  data.tar.gz: 74a5c7b97968b4e8e25d3d4df7bdf2bb84629f1a806c225c07f33aa447e3ebc155e7aa0ffe82f3a9295421d61aa25982fe8290deb36b50981bbd1b3f453f3893

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/README.md

@@ -0,0 +1,128 @@
+# wine_shipping
+
+WineShipping - the Ruby gem for the API from Wineshipping
+
+Wineshipping API is a programmatically consumable service or an Application Programming Interface (API) platform designed to enable Wineshipping LLC's client applications to natively transmit and manage their order, view inventory, track shipments etc.<br /><br />In order to access API operations request a UserKey and Password from Wineshipping. For any questions please contact Wineshipping Helpdesk at <a href='mailto:IT-Help@wineshipping.com?Subject=API from Wineshipping'>IT-Help@wineshipping.com</a>.
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: V3
+- Package version: 1.0.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build wine_shipping.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./wine_shipping-1.0.0.gem
+```
+(for development, run `gem install --dev ./wine_shipping-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'wine_shipping', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:
+
+    gem 'wine_shipping', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'wine_shipping'
+
+api_instance = WineShipping::InventoryApi.new
+
+authentication_details = WineShipping::Authentication.new # Authentication | 
+
+
+begin
+  result = api_instance.get_inventory_details(authentication_details)
+  p result
+rescue WineShipping::ApiError => e
+  puts "Exception when calling InventoryApi->get_inventory_details: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://wsservices-test.azurewebsites.net*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*WineShipping::InventoryApi* | [**get_inventory_details**](docs/InventoryApi.md#get_inventory_details) | **POST** /api/Inventory/GetDetails | 
+*WineShipping::InventoryApi* | [**get_inventory_status**](docs/InventoryApi.md#get_inventory_status) | **POST** /api/Inventory/GetStatus | 
+*WineShipping::InventoryMovementApi* | [**create_purchase_order**](docs/InventoryMovementApi.md#create_purchase_order) | **POST** /api/InventoryMovement/CreatePurchaseOrder | 
+*WineShipping::InventoryMovementApi* | [**create_transfer_order**](docs/InventoryMovementApi.md#create_transfer_order) | **POST** /api/InventoryMovement/CreateTransferOrder | 
+*WineShipping::SKUApi* | [**create_sku**](docs/SKUApi.md#create_sku) | **POST** /api/SKU/CreateSKU | 
+*WineShipping::SalesOrderApi* | [**cancel_sales_order**](docs/SalesOrderApi.md#cancel_sales_order) | **POST** /api/SalesOrder/CancelSalesOrder | 
+*WineShipping::SalesOrderApi* | [**create_sales_order**](docs/SalesOrderApi.md#create_sales_order) | **POST** /api/SalesOrder/CreateSalesOrder | 
+*WineShipping::SalesOrderApi* | [**get_orders_on_hold**](docs/SalesOrderApi.md#get_orders_on_hold) | **POST** /api/SalesOrder/GetOrdersOnHold | 
+*WineShipping::SalesOrderApi* | [**get_returns**](docs/SalesOrderApi.md#get_returns) | **POST** /api/SalesOrder/GetReturns | 
+*WineShipping::SalesOrderApi* | [**replace_sales_order**](docs/SalesOrderApi.md#replace_sales_order) | **POST** /api/SalesOrder/ReplaceSalesOrder | 
+*WineShipping::TrackingApi* | [**get_details**](docs/TrackingApi.md#get_details) | **POST** /api/Tracking/GetDetails | 
+
+
+## Documentation for Models
+
+ - [WineShipping::Authentication](docs/Authentication.md)
+ - [WineShipping::BillingContactInfo](docs/BillingContactInfo.md)
+ - [WineShipping::DeliveryContactInfo](docs/DeliveryContactInfo.md)
+ - [WineShipping::Inventory](docs/Inventory.md)
+ - [WineShipping::InventoryStatusRequest](docs/InventoryStatusRequest.md)
+ - [WineShipping::InventoryStatusResult](docs/InventoryStatusResult.md)
+ - [WineShipping::ItemInfo](docs/ItemInfo.md)
+ - [WineShipping::OrderOnHold](docs/OrderOnHold.md)
+ - [WineShipping::OrderOnHoldItem](docs/OrderOnHoldItem.md)
+ - [WineShipping::PackageItem](docs/PackageItem.md)
+ - [WineShipping::PurchaseOrderDetails](docs/PurchaseOrderDetails.md)
+ - [WineShipping::PurchaseOrderInfo](docs/PurchaseOrderInfo.md)
+ - [WineShipping::PurchaseOrderItemInfo](docs/PurchaseOrderItemInfo.md)
+ - [WineShipping::RecipientContactInfo](docs/RecipientContactInfo.md)
+ - [WineShipping::RequestorInfo](docs/RequestorInfo.md)
+ - [WineShipping::ReturnResult](docs/ReturnResult.md)
+ - [WineShipping::ReturnSalesOrderHeader](docs/ReturnSalesOrderHeader.md)
+ - [WineShipping::ReturnSalesOrderLine](docs/ReturnSalesOrderLine.md)
+ - [WineShipping::ReturnsRequest](docs/ReturnsRequest.md)
+ - [WineShipping::SKUDetails](docs/SKUDetails.md)
+ - [WineShipping::SKUInfo](docs/SKUInfo.md)
+ - [WineShipping::SalesOrderCancelRequest](docs/SalesOrderCancelRequest.md)
+ - [WineShipping::SalesOrderDetails](docs/SalesOrderDetails.md)
+ - [WineShipping::SalesOrderInfo](docs/SalesOrderInfo.md)
+ - [WineShipping::ShipmentInfo](docs/ShipmentInfo.md)
+ - [WineShipping::TrackingRequest](docs/TrackingRequest.md)
+ - [WineShipping::TrackingResult](docs/TrackingResult.md)
+ - [WineShipping::TransferOrderDetails](docs/TransferOrderDetails.md)
+ - [WineShipping::TransferOrderInfo](docs/TransferOrderInfo.md)
+ - [WineShipping::TransferOrderItemInfo](docs/TransferOrderItemInfo.md)
+ - [WineShipping::WarehouseInventoryStatus](docs/WarehouseInventoryStatus.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Authentication.md

@@ -0,0 +1,10 @@
+# WineShipping::Authentication
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_key** | **String** |  | [optional] 
+**password** | **String** |  | [optional] 
+**customer_no** | **String** |  | [optional] 
+
+

data/docs/BillingContactInfo.md

@@ -0,0 +1,18 @@
+# WineShipping::BillingContactInfo
+
+## 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/DeliveryContactInfo.md

@@ -0,0 +1,17 @@
+# WineShipping::DeliveryContactInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hold_at_location** | **Integer** |  | [optional] 
+**location_code** | **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] 
+
+

data/docs/Inventory.md

@@ -0,0 +1,20 @@
+# WineShipping::Inventory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer_no** | **String** |  | [optional] 
+**customer_name** | **String** |  | [optional] 
+**item_no** | **String** |  | [optional] 
+**item_description** | **String** |  | [optional] 
+**item_unit** | **String** |  | [optional] 
+**inventory_site** | **String** |  | [optional] 
+**inventory_warehouse** | **String** |  | [optional] 
+**inventory_status** | **String** |  | [optional] 
+**on_hand_quantity** | **String** |  | [optional] 
+**reserved_quantity** | **String** |  | [optional] 
+**available_quantity** | **String** |  | [optional] 
+**back_order_quantity** | **String** |  | [optional] 
+**open_po_quantity** | **String** |  | [optional] 
+
+

data/docs/InventoryApi.md

@@ -0,0 +1,102 @@
+# WineShipping::InventoryApi
+
+All URIs are relative to *https://wsservices-test.azurewebsites.net*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_inventory_details**](InventoryApi.md#get_inventory_details) | **POST** /api/Inventory/GetDetails | 
+[**get_inventory_status**](InventoryApi.md#get_inventory_status) | **POST** /api/Inventory/GetStatus | 
+
+
+# **get_inventory_details**
+> Array<Inventory> get_inventory_details(authentication_details)
+
+
+
+This operation provides inventory information with warehouse, status, quantity on hand, quantity reserved on orders, quantity on backorder, quantity available, and quantity on an inbound PO. This operation accepts a customer number to summarize inventory information within the Wineshipping system. This is a Legacy operation for backward compatibility. For new integration the recomended operation is GetInventoryStatus.
+
+### Example
+```ruby
+# load the gem
+require 'wine_shipping'
+
+api_instance = WineShipping::InventoryApi.new
+
+authentication_details = WineShipping::Authentication.new # Authentication | 
+
+
+begin
+  result = api_instance.get_inventory_details(authentication_details)
+  p result
+rescue WineShipping::ApiError => e
+  puts "Exception when calling InventoryApi->get_inventory_details: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authentication_details** | [**Authentication**](Authentication.md)|  | 
+
+### Return type
+
+[**Array<Inventory>**](Inventory.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_inventory_status**
+> InventoryStatusResult get_inventory_status(invent_status_request)
+
+
+
+This operation provides inventory information with warehouse, status, quantity on hand, quantity reserved on orders, quantity on backorder, quantity available, and quantity on an inbound PO. This operation optionally accepts a warehouse code to return related inventory records for a specific Wineshipping warehouse, if omitted the operation will return inventory records for all warehouses. The operation also accepts an array of items to query inventory records, if omitted returns inventory records for all items in the warehouse specified.
+
+### Example
+```ruby
+# load the gem
+require 'wine_shipping'
+
+api_instance = WineShipping::InventoryApi.new
+
+invent_status_request = WineShipping::InventoryStatusRequest.new # InventoryStatusRequest | 
+
+
+begin
+  result = api_instance.get_inventory_status(invent_status_request)
+  p result
+rescue WineShipping::ApiError => e
+  puts "Exception when calling InventoryApi->get_inventory_status: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **invent_status_request** | [**InventoryStatusRequest**](InventoryStatusRequest.md)|  | 
+
+### Return type
+
+[**InventoryStatusResult**](InventoryStatusResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/InventoryMovementApi.md

@@ -0,0 +1,100 @@
+# WineShipping::InventoryMovementApi
+
+All URIs are relative to *https://wsservices-test.azurewebsites.net*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_purchase_order**](InventoryMovementApi.md#create_purchase_order) | **POST** /api/InventoryMovement/CreatePurchaseOrder | 
+[**create_transfer_order**](InventoryMovementApi.md#create_transfer_order) | **POST** /api/InventoryMovement/CreateTransferOrder | 
+
+
+# **create_purchase_order**
+> create_purchase_order(order_details_info)
+
+
+
+Successful execution of this method will generate a new purchase 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 the purchase order.
+
+### Example
+```ruby
+# load the gem
+require 'wine_shipping'
+
+api_instance = WineShipping::InventoryMovementApi.new
+
+order_details_info = WineShipping::PurchaseOrderDetails.new # PurchaseOrderDetails | 
+
+
+begin
+  api_instance.create_purchase_order(order_details_info)
+rescue WineShipping::ApiError => e
+  puts "Exception when calling InventoryMovementApi->create_purchase_order: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_details_info** | [**PurchaseOrderDetails**](PurchaseOrderDetails.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_transfer_order**
+> create_transfer_order(order_details_info)
+
+
+
+Successful execution of this method will generate a new transfer 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 the transfer order.
+
+### Example
+```ruby
+# load the gem
+require 'wine_shipping'
+
+api_instance = WineShipping::InventoryMovementApi.new
+
+order_details_info = WineShipping::TransferOrderDetails.new # TransferOrderDetails | 
+
+
+begin
+  api_instance.create_transfer_order(order_details_info)
+rescue WineShipping::ApiError => e
+  puts "Exception when calling InventoryMovementApi->create_transfer_order: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_details_info** | [**TransferOrderDetails**](TransferOrderDetails.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/InventoryStatusRequest.md

@@ -0,0 +1,13 @@
+# WineShipping::InventoryStatusRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authentication** | [**Authentication**](Authentication.md) |  | [optional] 
+**warehouse** | **String** |  | [optional] 
+**item_numbers** | **Array<String>** |  | [optional] 
+**include_total_record_count** | **BOOLEAN** |  | [optional] 
+**skip** | **Integer** |  | [optional] 
+**top** | **Integer** |  | [optional] 
+
+

data/docs/InventoryStatusResult.md

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