ship_engine 1.0.0

data/docs/RateRequestBody.md

@@ -0,0 +1,25 @@
+# OpenapiClient::RateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**carrier_ids** | **Array<String>** | Array of carrier ids to get rates for | 
+**package_types** | **Array<String>** |  | [optional] 
+**service_codes** | **Array<String>** |  | [optional] 
+**calculate_tax_amount** | **Boolean** | Calculate the duties and tariffs for cross border shipments. | [optional] 
+**preferred_currency** | [**Currency**](Currency.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RateRequestBody.new(carrier_ids: null,
+                                 package_types: null,
+                                 service_codes: null,
+                                 calculate_tax_amount: null,
+                                 preferred_currency: null)
+```
+
+

data/docs/RateRequestByShipmentIds.md

@@ -0,0 +1,17 @@
+# OpenapiClient::RateRequestByShipmentIds
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shipment_ids** | **Array<String>** | The array of shipment IDs | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RateRequestByShipmentIds.new(shipment_ids: null)
+```
+
+

data/docs/RateRequestByShipments.md

@@ -0,0 +1,17 @@
+# OpenapiClient::RateRequestByShipments
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shipments** | [**Array<AddressValidatingShipment>**](AddressValidatingShipment.md) | The array of shipments to get bulk rate estimates for | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RateRequestByShipments.new(shipments: null)
+```
+
+

data/docs/RateRequestOptions.md

@@ -0,0 +1,17 @@
+# OpenapiClient::RateRequestOptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rate_options** | [**RateRequestBody**](RateRequestBody.md) | The rate options | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RateRequestOptions.new(rate_options: null)
+```
+
+

data/docs/RateRequestRateOptions.md

@@ -0,0 +1,17 @@
+# OpenapiClient::RateRequestRateOptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rate_options** | [**RateRequestBody**](RateRequestBody.md) | The rate options | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RateRequestRateOptions.new(rate_options: null)
+```
+
+

data/docs/RateResponse.md

@@ -0,0 +1,17 @@
+# OpenapiClient::RateResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rate_response** | [**RatesInformation**](RatesInformation.md) | The rates response | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RateResponse.new(rate_response: null)
+```
+
+

data/docs/RateResponseStatus.md

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

data/docs/RateType.md

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

data/docs/RatesApi.md

@@ -0,0 +1,228 @@
+# OpenapiClient::RatesApi
+
+All URIs are relative to *https://api.shipengine.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**calculate_rates**](RatesApi.md#calculate_rates) | **POST** /v1/rates | Get Shipping Rates
+[**compare_bulk_rates**](RatesApi.md#compare_bulk_rates) | **POST** /v1/rates/bulk | Get Bulk Rates
+[**estimate_rates**](RatesApi.md#estimate_rates) | **POST** /v1/rates/estimate | Estimate Rates
+[**get_rate_by_id**](RatesApi.md#get_rate_by_id) | **GET** /v1/rates/{rate_id} | Get Rate By ID
+
+
+
+## calculate_rates
+
+> CalculateRatesResponseBody calculate_rates(calculate_rates_request_body)
+
+Get Shipping Rates
+
+It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option; so we provide functionality to show you all your options! 
+
+### 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::RatesApi.new
+calculate_rates_request_body = OpenapiClient::CalculateRatesRequestBody.new # CalculateRatesRequestBody | 
+
+begin
+  #Get Shipping Rates
+  result = api_instance.calculate_rates(calculate_rates_request_body)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling RatesApi->calculate_rates: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **calculate_rates_request_body** | [**CalculateRatesRequestBody**](CalculateRatesRequestBody.md)|  | 
+
+### Return type
+
+[**CalculateRatesResponseBody**](CalculateRatesResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## compare_bulk_rates
+
+> Array<BulkRate> compare_bulk_rates(compare_bulk_rates_request_body)
+
+Get Bulk Rates
+
+Get Bulk Shipment Rates
+
+### 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::RatesApi.new
+compare_bulk_rates_request_body = OpenapiClient::CompareBulkRatesRequestBody.new # CompareBulkRatesRequestBody | 
+
+begin
+  #Get Bulk Rates
+  result = api_instance.compare_bulk_rates(compare_bulk_rates_request_body)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling RatesApi->compare_bulk_rates: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **compare_bulk_rates_request_body** | [**CompareBulkRatesRequestBody**](CompareBulkRatesRequestBody.md)|  | 
+
+### Return type
+
+[**Array<BulkRate>**](BulkRate.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## estimate_rates
+
+> Array<Rate> estimate_rates(estimate_rates_request_body)
+
+Estimate Rates
+
+Get Rate Estimates
+
+### 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::RatesApi.new
+estimate_rates_request_body = OpenapiClient::EstimateRatesRequestBody.new # EstimateRatesRequestBody | 
+
+begin
+  #Estimate Rates
+  result = api_instance.estimate_rates(estimate_rates_request_body)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling RatesApi->estimate_rates: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **estimate_rates_request_body** | [**EstimateRatesRequestBody**](EstimateRatesRequestBody.md)|  | 
+
+### Return type
+
+[**Array<Rate>**](Rate.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_rate_by_id
+
+> GetRateByIdResponseBody get_rate_by_id(rate_id)
+
+Get Rate By ID
+
+Retrieve a previously queried rate by its 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::RatesApi.new
+rate_id = 'rate_id_example' # String | Rate ID
+
+begin
+  #Get Rate By ID
+  result = api_instance.get_rate_by_id(rate_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling RatesApi->get_rate_by_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rate_id** | **String**| Rate ID | 
+
+### Return type
+
+[**GetRateByIdResponseBody**](GetRateByIdResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RatesInformation.md

@@ -0,0 +1,29 @@
+# OpenapiClient::RatesInformation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rates** | [**Array<Rate>**](Rate.md) | An array of shipment rates | [optional] [readonly] 
+**invalid_rates** | [**Array<Rate>**](Rate.md) | An array of invalid shipment rates | [optional] [readonly] 
+**rate_request_id** | **String** | A string that uniquely identifies the rate request | [optional] [readonly] 
+**shipment_id** | **String** | A string that uniquely identifies the shipment | [optional] [readonly] 
+**created_at** | **String** | When the rate was created | [optional] 
+**status** | [**RateResponseStatus**](RateResponseStatus.md) |  | [optional] [readonly] 
+**errors** | [**Array<Error>**](Error.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RatesInformation.new(rates: null,
+                                 invalid_rates: null,
+                                 rate_request_id: null,
+                                 shipment_id: null,
+                                 created_at: null,
+                                 status: null,
+                                 errors: null)
+```
+
+

data/docs/RecognizedEntity.md

@@ -0,0 +1,27 @@
+# OpenapiClient::RecognizedEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) | 
+**score** | **Float** | A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity  | 
+**text** | **String** | The substring from the original text that was recognized as this entity | 
+**start_index** | **Integer** | The index of the first character of this entity within the original text | 
+**end_index** | **Integer** | The index of the last character of this entity within the original text | 
+**result** | **Hash<String, Object>** | The normalized value of the entity.  Most entity results have a `value` field, which is the normalized value of the entity.  For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\").  Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\".  Some entities have other information in addition to, or instead of a `value`.  For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RecognizedEntity.new(type: null,
+                                 score: null,
+                                 text: null,
+                                 start_index: null,
+                                 end_index: null,
+                                 result: null)
+```
+
+

data/docs/RemoveFromBatchRequestBody.md

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