ship_engine 1.0.0

data/docs/CreateWebhookRequestBody.md

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

data/docs/CreateWebhookResponseBody.md

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

data/docs/Currency.md

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

data/docs/CustomsItem.md

@@ -0,0 +1,33 @@
+# OpenapiClient::CustomsItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customs_item_id** | **String** | A string that uniquely identifies the customs item | [readonly] 
+**description** | **String** | A description of the item | [optional] [default to 'null']
+**quantity** | **Integer** | The quantity of this item in the shipment. | [optional] [default to 0]
+**value** | [**MonetaryValue**](MonetaryValue.md) | The total value of the customs item | [optional] 
+**harmonized_tariff_code** | **String** | The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item. | [optional] [default to 'null']
+**country_of_origin** | **String** | The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated  | [optional] 
+**unit_of_measure** | **String** |  | [optional] 
+**sku** | **String** | The SKU (Stock Keeping Unit) of the customs item | [optional] 
+**sku_description** | **String** | Description of the Custom Item's SKU | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CustomsItem.new(customs_item_id: null,
+                                 description: null,
+                                 quantity: null,
+                                 value: null,
+                                 harmonized_tariff_code: 3926.1,
+                                 country_of_origin: null,
+                                 unit_of_measure: null,
+                                 sku: null,
+                                 sku_description: null)
+```
+
+

data/docs/DeliveryConfirmation.md

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

data/docs/DeprecatedManifest.md

@@ -0,0 +1,33 @@
+# OpenapiClient::DeprecatedManifest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**manifest_id** | **String** | A string that uniquely identifies the manifest | [optional] 
+**form_id** | **String** | A string that uniquely identifies the form | [optional] 
+**created_at** | **DateTime** | The date-time that the manifest was created | [optional] 
+**ship_date** | **DateTime** | The date-time that the manifests shipments will be picked up | [optional] 
+**shipments** | **Integer** | The number of shipments that are included in this manifest | [optional] [readonly] 
+**warehouse_id** | **String** | A string that uniquely identifies the warehouse | [optional] 
+**submission_id** | **String** | A string that uniquely identifies the submission | [optional] 
+**carrier_id** | **String** | A string that uniquely identifies the carrier | [optional] 
+**manifest_download** | [**ManifestDownload**](ManifestDownload.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::DeprecatedManifest.new(manifest_id: null,
+                                 form_id: null,
+                                 created_at: 2019-07-12T13:37:39.050Z,
+                                 ship_date: 2019-07-12T13:37:39.050Z,
+                                 shipments: 100,
+                                 warehouse_id: null,
+                                 submission_id: 9.475711899564878E+21,
+                                 carrier_id: null,
+                                 manifest_download: null)
+```
+
+

data/docs/DhlExpressAccountSettings.md

@@ -0,0 +1,21 @@
+# OpenapiClient::DhlExpressAccountSettings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | Account nickname | [optional] 
+**should_hide_account_number_on_archive_doc** | **Boolean** | Indicates if the account number should be hidden on the archive documentation | [optional] 
+**is_primary_account** | **Boolean** | Indicates if this is primary account | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::DhlExpressAccountSettings.new(nickname: null,
+                                 should_hide_account_number_on_archive_doc: null,
+                                 is_primary_account: null)
+```
+
+

data/docs/DhlExpressSettingsResponseBody.md

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

data/docs/DimensionUnit.md

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

data/docs/Dimensions.md

@@ -0,0 +1,23 @@
+# OpenapiClient::Dimensions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**unit** | [**DimensionUnit**](DimensionUnit.md) |  | 
+**length** | **Float** | The length of the package, in the specified unit | [default to 0]
+**width** | **Float** | The width of the package, in the specified unit | [default to 0]
+**height** | **Float** | The length of the package, in the specified unit | [default to 0]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Dimensions.new(unit: null,
+                                 length: null,
+                                 width: null,
+                                 height: null)
+```
+
+

data/docs/DownloadsApi.md

@@ -0,0 +1,71 @@
+# OpenapiClient::DownloadsApi
+
+All URIs are relative to *https://api.shipengine.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**download_file**](DownloadsApi.md#download_file) | **GET** /v1/downloads/{dir}/{subdir}/{filename} | Download File
+
+
+
+## download_file
+
+> File download_file(subdir, filename, dir, opts)
+
+Download File
+
+Get File
+
+### 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::DownloadsApi.new
+subdir = 'subdir_example' # String | 
+filename = 'filename_example' # String | 
+dir = 'dir_example' # String | 
+opts = {
+  download: 'download_example' # String | 
+}
+
+begin
+  #Download File
+  result = api_instance.download_file(subdir, filename, dir, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling DownloadsApi->download_file: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subdir** | **String**|  | 
+ **filename** | **String**|  | 
+ **dir** | **String**|  | 
+ **download** | **String**|  | [optional] 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/pdf, image/png, application/zpl, application/json
+

data/docs/Error.md

@@ -0,0 +1,23 @@
+# OpenapiClient::Error
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_source** | [**ErrorSource**](ErrorSource.md) |  | 
+**error_type** | [**ErrorType**](ErrorType.md) |  | 
+**error_code** | [**ErrorCode**](ErrorCode.md) |  | 
+**message** | **String** | An error message associated with the failed API call | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Error.new(error_source: null,
+                                 error_type: null,
+                                 error_code: null,
+                                 message: Body of request cannot be null.)
+```
+
+

data/docs/ErrorCode.md

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

data/docs/ErrorResponseBody.md

@@ -0,0 +1,19 @@
+# OpenapiClient::ErrorResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_id** | **String** | A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur  | 
+**errors** | [**Array<Error>**](Error.md) | The errors associated with the failed API call | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ErrorResponseBody.new(request_id: null,
+                                 errors: null)
+```
+
+

data/docs/ErrorSource.md

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

data/docs/ErrorType.md

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

data/docs/EstimateRatesRequestBody.md

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

data/docs/FedexAccountSettings.md

@@ -0,0 +1,25 @@
+# OpenapiClient::FedexAccountSettings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | Account nickname | [optional] 
+**pickup_type** | [**FedexPickupType**](FedexPickupType.md) |  | [optional] 
+**smart_post_hub** | [**SmartPostHub**](SmartPostHub.md) |  | [optional] 
+**smart_post_endorsement** | [**AncillaryServiceEndorsement**](AncillaryServiceEndorsement.md) |  | [optional] 
+**is_primary_account** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::FedexAccountSettings.new(nickname: null,
+                                 pickup_type: null,
+                                 smart_post_hub: null,
+                                 smart_post_endorsement: null,
+                                 is_primary_account: null)
+```
+
+

data/docs/FedexAccountSettingsRequestBody.md

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