ship_engine 1.0.0

data/docs/FedexPickupType.md

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

data/docs/FedexSettingsResponseBody.md

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

data/docs/GetBatchByExternalIdResponseBody.md

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

data/docs/GetBatchByIdResponseBody.md

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

data/docs/GetCarrierByIdResponseBody.md

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

data/docs/GetCarrierOptionsResponseBody.md

@@ -0,0 +1,17 @@
+# OpenapiClient::GetCarrierOptionsResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**options** | [**Array<CarrierAdvancedOption>**](CarrierAdvancedOption.md) | AN array of carrier options | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::GetCarrierOptionsResponseBody.new(options: null)
+```
+
+

data/docs/GetCarrierSettingsResponseBody.md

@@ -0,0 +1,45 @@
+# OpenapiClient::GetCarrierSettingsResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | 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 the primary UPS account | [optional] 
+**pickup_type** | [**UpsPickupType**](UpsPickupType.md) |  | [optional] 
+**smart_post_hub** | [**SmartPostHub**](SmartPostHub.md) |  | [optional] 
+**smart_post_endorsement** | [**AncillaryServiceEndorsement**](AncillaryServiceEndorsement.md) |  | [optional] 
+**use_carbon_neutral_shipping_program** | **Boolean** | The use carbon neutral shipping program | [optional] 
+**use_ground_freight_pricing** | **Boolean** | The use ground freight pricing | [optional] 
+**use_consolidation_services** | **Boolean** | The use consolidation services | [optional] 
+**use_order_number_on_mail_innovations_labels** | **Boolean** | The use order number on mail innovations labels | [optional] 
+**mail_innovations_endorsement** | [**AncillaryServiceEndorsement**](AncillaryServiceEndorsement.md) |  | [optional] 
+**mail_innovations_cost_center** | **String** | mail innovations cost center | [optional] 
+**use_negotiated_rates** | **Boolean** | The use negotiated rates | [optional] 
+**account_postal_code** | **String** | account postal code | [optional] 
+**invoice** | [**UpsInvoice**](UpsInvoice.md) | The invoice | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::GetCarrierSettingsResponseBody.new(nickname: null,
+                                 should_hide_account_number_on_archive_doc: null,
+                                 is_primary_account: null,
+                                 pickup_type: null,
+                                 smart_post_hub: null,
+                                 smart_post_endorsement: null,
+                                 use_carbon_neutral_shipping_program: null,
+                                 use_ground_freight_pricing: null,
+                                 use_consolidation_services: null,
+                                 use_order_number_on_mail_innovations_labels: null,
+                                 mail_innovations_endorsement: null,
+                                 mail_innovations_cost_center: null,
+                                 use_negotiated_rates: null,
+                                 account_postal_code: null,
+                                 invoice: null)
+```
+
+

data/docs/GetCarriersResponseBody.md

@@ -0,0 +1,21 @@
+# OpenapiClient::GetCarriersResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**carriers** | [**Array<Carrier>**](Carrier.md) | The carrier response body | [readonly] 
+**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::GetCarriersResponseBody.new(carriers: null,
+                                 request_id: null,
+                                 errors: null)
+```
+
+

data/docs/GetInsuranceBalanceResponseBody.md

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

data/docs/GetLabelByExternalShipmentIdResponseBody.md

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

data/docs/GetLabelByIdResponseBody.md

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

data/docs/GetManifestByIdResponseBody.md

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

data/docs/GetPackageTypeByIdResponseBody.md

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

data/docs/GetRateByIdResponseBody.md

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

data/docs/GetShipmentByExternalIdResponseBody.md

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

data/docs/GetShipmentByIdResponseBody.md

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

data/docs/GetTrackingLogFromLabelResponseBody.md

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

data/docs/GetTrackingLogResponseBody.md

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

data/docs/GetWarehouseByIdResponseBody.md

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

data/docs/GetWebhookByIdResponseBody.md

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

data/docs/InsuranceApi.md

@@ -0,0 +1,220 @@
+# OpenapiClient::InsuranceApi
+
+All URIs are relative to *https://api.shipengine.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_funds_to_insurance**](InsuranceApi.md#add_funds_to_insurance) | **PATCH** /v1/insurance/shipsurance/add_funds | Add Funds To Insurance
+[**connect_insurer**](InsuranceApi.md#connect_insurer) | **POST** /v1/connections/insurance/shipsurance | Connect a Shipsurance Account
+[**disconnect_insurer**](InsuranceApi.md#disconnect_insurer) | **DELETE** /v1/connections/insurance/shipsurance | Disconnect a Shipsurance Account
+[**get_insurance_balance**](InsuranceApi.md#get_insurance_balance) | **GET** /v1/insurance/shipsurance/balance | Get Insurance Funds Balance
+
+
+
+## add_funds_to_insurance
+
+> AddFundsToInsuranceResponseBody add_funds_to_insurance(add_funds_to_insurance_request_body)
+
+Add Funds To Insurance
+
+You may need to auto fund your account from time to time. For example, if you don't normally ship items over $100, and may want to add funds to insurance rather than keeping the account funded. 
+
+### 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::InsuranceApi.new
+add_funds_to_insurance_request_body = OpenapiClient::AddFundsToInsuranceRequestBody.new # AddFundsToInsuranceRequestBody | 
+
+begin
+  #Add Funds To Insurance
+  result = api_instance.add_funds_to_insurance(add_funds_to_insurance_request_body)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling InsuranceApi->add_funds_to_insurance: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **add_funds_to_insurance_request_body** | [**AddFundsToInsuranceRequestBody**](AddFundsToInsuranceRequestBody.md)|  | 
+
+### Return type
+
+[**AddFundsToInsuranceResponseBody**](AddFundsToInsuranceResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## connect_insurer
+
+> Object connect_insurer(connect_insurer_request_body)
+
+Connect a Shipsurance Account
+
+Connect a Shipsurance 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::InsuranceApi.new
+connect_insurer_request_body = OpenapiClient::ConnectInsurerRequestBody.new # ConnectInsurerRequestBody | 
+
+begin
+  #Connect a Shipsurance Account
+  result = api_instance.connect_insurer(connect_insurer_request_body)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling InsuranceApi->connect_insurer: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **connect_insurer_request_body** | [**ConnectInsurerRequestBody**](ConnectInsurerRequestBody.md)|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## disconnect_insurer
+
+> Object disconnect_insurer
+
+Disconnect a Shipsurance Account
+
+Disconnect a Shipsurance 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::InsuranceApi.new
+
+begin
+  #Disconnect a Shipsurance Account
+  result = api_instance.disconnect_insurer
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling InsuranceApi->disconnect_insurer: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_insurance_balance
+
+> GetInsuranceBalanceResponseBody get_insurance_balance
+
+Get Insurance Funds Balance
+
+Retrieve the balance of your Shipsurance 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::InsuranceApi.new
+
+begin
+  #Get Insurance Funds Balance
+  result = api_instance.get_insurance_balance
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling InsuranceApi->get_insurance_balance: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetInsuranceBalanceResponseBody**](GetInsuranceBalanceResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+