ship_engine 1.0.0

data/docs/ValidateAddress.md

@@ -0,0 +1,16 @@
+# OpenapiClient::ValidateAddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ValidateAddress.new()
+```
+
+

data/docs/ValidateShipmentFields.md

@@ -0,0 +1,17 @@
+# OpenapiClient::ValidateShipmentFields
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**validate_address** | [**ValidateAddress**](ValidateAddress.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ValidateShipmentFields.new(validate_address: null)
+```
+
+

data/docs/ValidationStatus.md

@@ -0,0 +1,16 @@
+# OpenapiClient::ValidationStatus
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ValidationStatus.new()
+```
+
+

data/docs/VoidLabelResponseBody.md

@@ -0,0 +1,19 @@
+# OpenapiClient::VoidLabelResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**approved** | **Boolean** | Indicates whether the attempt to void the label was successful | [readonly] 
+**message** | **String** |  | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::VoidLabelResponseBody.new(approved: null,
+                                 message: Request for refund submitted.  This label has been voided.)
+```
+
+

data/docs/Warehouse.md

@@ -0,0 +1,25 @@
+# OpenapiClient::Warehouse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**warehouse_id** | **String** | A string that uniquely identifies the warehouse | [optional] [readonly] 
+**name** | **String** | Name of the warehouse | [optional] 
+**created_at** | **DateTime** | Timestamp that indicates when the warehouse was created | [optional] [readonly] 
+**origin_address** | [**Address**](Address.md) | The origin address of the warehouse | [optional] 
+**return_address** | [**Address**](Address.md) | The return address associated with the warehouse | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Warehouse.new(warehouse_id: null,
+                                 name: Zero Cool HQ,
+                                 created_at: 2019-06-25T18:12:35.583Z,
+                                 origin_address: null,
+                                 return_address: null)
+```
+
+

data/docs/WarehousesApi.md

@@ -0,0 +1,281 @@
+# OpenapiClient::WarehousesApi
+
+All URIs are relative to *https://api.shipengine.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_warehouse**](WarehousesApi.md#create_warehouse) | **POST** /v1/warehouses | Create Warehouse
+[**delete_warehouse**](WarehousesApi.md#delete_warehouse) | **DELETE** /v1/warehouses/{warehouse_id} | Delete Warehouse By ID
+[**get_warehouse_by_id**](WarehousesApi.md#get_warehouse_by_id) | **GET** /v1/warehouses/{warehouse_id} | Get Warehouse By Id
+[**list_warehouses**](WarehousesApi.md#list_warehouses) | **GET** /v1/warehouses | List Warehouses
+[**update_warehouse**](WarehousesApi.md#update_warehouse) | **PUT** /v1/warehouses/{warehouse_id} | Update WareHouse By Id
+
+
+
+## create_warehouse
+
+> CreateWarehouseResponseBody create_warehouse(create_warehouse_request_body)
+
+Create Warehouse
+
+Create a warehouse location that you can use to create shipping items by simply passing in the generated warehouse id. If the return address is not supplied in the request body then it is assumed that the origin address is the return address as well 
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['API-Key'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::WarehousesApi.new
+create_warehouse_request_body = OpenapiClient::CreateWarehouseRequestBody.new # CreateWarehouseRequestBody | 
+
+begin
+  #Create Warehouse
+  result = api_instance.create_warehouse(create_warehouse_request_body)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling WarehousesApi->create_warehouse: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_warehouse_request_body** | [**CreateWarehouseRequestBody**](CreateWarehouseRequestBody.md)|  | 
+
+### Return type
+
+[**CreateWarehouseResponseBody**](CreateWarehouseResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_warehouse
+
+> String delete_warehouse(warehouse_id)
+
+Delete Warehouse By ID
+
+Delete a warehouse by ID
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['API-Key'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::WarehousesApi.new
+warehouse_id = 'warehouse_id_example' # String | Warehouse ID
+
+begin
+  #Delete Warehouse By ID
+  result = api_instance.delete_warehouse(warehouse_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling WarehousesApi->delete_warehouse: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **warehouse_id** | **String**| Warehouse ID | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json
+
+
+## get_warehouse_by_id
+
+> GetWarehouseByIdResponseBody get_warehouse_by_id(warehouse_id)
+
+Get Warehouse By Id
+
+Retrieve warehouse data based on the warehouse ID
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['API-Key'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::WarehousesApi.new
+warehouse_id = 'warehouse_id_example' # String | Warehouse ID
+
+begin
+  #Get Warehouse By Id
+  result = api_instance.get_warehouse_by_id(warehouse_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling WarehousesApi->get_warehouse_by_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **warehouse_id** | **String**| Warehouse ID | 
+
+### Return type
+
+[**GetWarehouseByIdResponseBody**](GetWarehouseByIdResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_warehouses
+
+> ListWarehousesResponseBody list_warehouses
+
+List Warehouses
+
+Retrieve a list of warehouses associated with this account.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['API-Key'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::WarehousesApi.new
+
+begin
+  #List Warehouses
+  result = api_instance.list_warehouses
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling WarehousesApi->list_warehouses: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListWarehousesResponseBody**](ListWarehousesResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_warehouse
+
+> String update_warehouse(warehouse_id, update_warehouse_request_body)
+
+Update WareHouse By Id
+
+Update Warehouse object information
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['API-Key'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::WarehousesApi.new
+warehouse_id = 'warehouse_id_example' # String | Warehouse ID
+update_warehouse_request_body = OpenapiClient::UpdateWarehouseRequestBody.new # UpdateWarehouseRequestBody | 
+
+begin
+  #Update WareHouse By Id
+  result = api_instance.update_warehouse(warehouse_id, update_warehouse_request_body)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling WarehousesApi->update_warehouse: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **warehouse_id** | **String**| Warehouse ID | 
+ **update_warehouse_request_body** | [**UpdateWarehouseRequestBody**](UpdateWarehouseRequestBody.md)|  | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: text/plain, application/json
+

data/docs/Webhook.md

@@ -0,0 +1,21 @@
+# OpenapiClient::Webhook
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**webhook_id** | **String** | A string that uniquely identifies the webhook | [optional] [readonly] 
+**url** | **String** | The url that the webhook sends the request to | [optional] 
+**event** | [**WebhookEvent**](WebhookEvent.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Webhook.new(webhook_id: null,
+                                 url: https://[YOUR ENDPOINT ID].x.requestbin.com,
+                                 event: null)
+```
+
+

data/docs/WebhookEvent.md

@@ -0,0 +1,16 @@
+# OpenapiClient::WebhookEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::WebhookEvent.new()
+```
+
+

data/docs/WebhooksApi.md

@@ -0,0 +1,281 @@
+# OpenapiClient::WebhooksApi
+
+All URIs are relative to *https://api.shipengine.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_webhook**](WebhooksApi.md#create_webhook) | **POST** /v1/environment/webhooks | Create a Webhook
+[**delete_webhook**](WebhooksApi.md#delete_webhook) | **DELETE** /v1/environment/webhooks/{webhook_id} | Delete Webhook By ID
+[**get_webhook_by_id**](WebhooksApi.md#get_webhook_by_id) | **GET** /v1/environment/webhooks/{webhook_id} | Get Webhook By ID
+[**list_webhooks**](WebhooksApi.md#list_webhooks) | **GET** /v1/environment/webhooks | List Webhooks
+[**update_webhook**](WebhooksApi.md#update_webhook) | **PUT** /v1/environment/webhooks/{webhook_id} | Update a Webhook
+
+
+
+## create_webhook
+
+> CreateWebhookResponseBody create_webhook(create_webhook_request_body)
+
+Create a Webhook
+
+Create a webook for specific events in the environment.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['API-Key'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::WebhooksApi.new
+create_webhook_request_body = OpenapiClient::CreateWebhookRequestBody.new # CreateWebhookRequestBody | 
+
+begin
+  #Create a Webhook
+  result = api_instance.create_webhook(create_webhook_request_body)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling WebhooksApi->create_webhook: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_webhook_request_body** | [**CreateWebhookRequestBody**](CreateWebhookRequestBody.md)|  | 
+
+### Return type
+
+[**CreateWebhookResponseBody**](CreateWebhookResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_webhook
+
+> String delete_webhook(webhook_id)
+
+Delete Webhook By ID
+
+Delete a webhook
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['API-Key'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::WebhooksApi.new
+webhook_id = 'webhook_id_example' # String | Webhook ID
+
+begin
+  #Delete Webhook By ID
+  result = api_instance.delete_webhook(webhook_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling WebhooksApi->delete_webhook: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | **String**| Webhook ID | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json
+
+
+## get_webhook_by_id
+
+> GetWebhookByIdResponseBody get_webhook_by_id(webhook_id)
+
+Get Webhook By ID
+
+Retrieve individual webhook by an ID
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['API-Key'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::WebhooksApi.new
+webhook_id = 'webhook_id_example' # String | Webhook ID
+
+begin
+  #Get Webhook By ID
+  result = api_instance.get_webhook_by_id(webhook_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling WebhooksApi->get_webhook_by_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | **String**| Webhook ID | 
+
+### Return type
+
+[**GetWebhookByIdResponseBody**](GetWebhookByIdResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_webhooks
+
+> Array<Webhook> list_webhooks
+
+List Webhooks
+
+List all webhooks currently enabled for the account.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['API-Key'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::WebhooksApi.new
+
+begin
+  #List Webhooks
+  result = api_instance.list_webhooks
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling WebhooksApi->list_webhooks: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<Webhook>**](Webhook.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_webhook
+
+> String update_webhook(webhook_id, update_webhook_request_body)
+
+Update a Webhook
+
+Update the webhook url property
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['API-Key'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::WebhooksApi.new
+webhook_id = 'webhook_id_example' # String | Webhook ID
+update_webhook_request_body = OpenapiClient::UpdateWebhookRequestBody.new # UpdateWebhookRequestBody | 
+
+begin
+  #Update a Webhook
+  result = api_instance.update_webhook(webhook_id, update_webhook_request_body)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling WebhooksApi->update_webhook: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | **String**| Webhook ID | 
+ **update_webhook_request_body** | [**UpdateWebhookRequestBody**](UpdateWebhookRequestBody.md)|  | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: text/plain, application/json
+