ship_engine 1.0.0

data/docs/ConnectApcRequestBody.md

@@ -0,0 +1,21 @@
+# OpenapiClient::ConnectApcRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | The nickname for the APC account | 
+**username** | **String** | The username for the APC account | 
+**password** | **String** | The password for the APC account | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectApcRequestBody.new(nickname: APC carrier account,
+                                 username: john_doe,
+                                 password: 12345)
+```
+
+

data/docs/ConnectAsendiaRequestBody.md

@@ -0,0 +1,23 @@
+# OpenapiClient::ConnectAsendiaRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | The nickname of the Asendia account | 
+**account_number** | **String** | Asendia account number | 
+**ftp_username** | **String** | FTP username | 
+**ftp_password** | **String** | FTP password | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectAsendiaRequestBody.new(nickname: Asendia account,
+                                 account_number: null,
+                                 ftp_username: null,
+                                 ftp_password: null)
+```
+
+

data/docs/ConnectAustraliaPostRequestBody.md

@@ -0,0 +1,23 @@
+# OpenapiClient::ConnectAustraliaPostRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_number** | **String** | Account number | 
+**api_key** | **String** | API key | 
+**api_secret** | **String** | API secret | 
+**nickname** | **String** | Nickname | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectAustraliaPostRequestBody.new(account_number: null,
+                                 api_key: null,
+                                 api_secret: null,
+                                 nickname: null)
+```
+
+

data/docs/ConnectCanadaPostRequestBody.md

@@ -0,0 +1,25 @@
+# OpenapiClient::ConnectCanadaPostRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | Nickname | 
+**api_key** | **String** | Canada Post Account API Key | 
+**api_secret** | **String** | Canada Post Account API Secret | 
+**account_number** | **String** | Canada Post Account Number | 
+**contract_id** | **String** | Canada Post Account Contract ID | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectCanadaPostRequestBody.new(nickname: null,
+                                 api_key: null,
+                                 api_secret: null,
+                                 account_number: null,
+                                 contract_id: null)
+```
+
+

data/docs/ConnectCarrierRequestBody.md

@@ -0,0 +1,113 @@
+# OpenapiClient::ConnectCarrierRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | Nickname | 
+**username** | **String** | Username | 
+**password** | **String** | Password | 
+**merchant_seller_id** | **String** |  | 
+**mws_auth_token** | **String** |  | 
+**email** | **String** | The email address | 
+**account_number** | **String** | Account number | 
+**ftp_username** | **String** | FTP username | 
+**ftp_password** | **String** | FTP password | 
+**api_key** | **String** | API key | 
+**api_secret** | **String** | The DHL E-Commerce API secret. This field is optional, but if not set you will not be able to get rates for this account.  | 
+**contract_id** | **String** | Canada Post Account Contract ID | 
+**client_id** | **String** | The client id | 
+**pickup_number** | **String** | The pickup number | 
+**distribution_center** | **String** | The distribution center | 
+**ancillary_endorsement** | [**AncillaryServiceEndorsement**](AncillaryServiceEndorsement.md) |  | [optional] 
+**site_id** | **String** | A string that uniquely identifies the site | 
+**account** | **String** | Account | 
+**passphrase** | **String** | Passphrase | 
+**address1** | **String** | Address Line 1 | 
+**address2** | **String** | Address Line 2 | [optional] 
+**city** | **String** | City | 
+**company** | **String** | Company | 
+**country_code** | **String** | Country code | 
+**first_name** | **String** | First name | 
+**last_name** | **String** | Last name | 
+**phone** | **String** | Phone | 
+**postal_code** | **String** | Postal code | 
+**state** | **String** | State | 
+**agree_to_eula** | **Boolean** | Boolean signaling agreement to the Fedex End User License Agreement | 
+**meter_number** | **String** | Meter number | [optional] 
+**mailer_id** | **Integer** | Mailer id | 
+**profile_name** | **String** | Profile name | [optional] 
+**merchant_id** | **Integer** | Merchant id | [optional] 
+**induction_site** | **String** | Induction site | 
+**activation_key** | **String** | Activation key | 
+**oba_email** | **String** | The oba email address | [optional] 
+**contact_name** | **String** | Contact name | 
+**company_name** | **String** | Company name | [optional] 
+**street_line1** | **String** | Street line1 | [optional] 
+**street_line2** | **String** | Street line2 | [optional] 
+**street_line3** | **String** | Street line3 | [optional] 
+**access_key** | **String** | Seko Account Access Key | 
+**sendle_id** | **String** | A string that uniquely identifies the sendle | 
+**account_country_code** | **String** | Account country code | 
+**account_postal_code** | **String** | Account postal code | 
+**title** | **String** | Title | [optional] 
+**invoice** | [**UpsInvoice**](UpsInvoice.md) | The UPS invoice | [optional] 
+**agree_to_technology_agreement** | **Boolean** | The Agreement to the [UPS Technology Agreement](https://www.ups.com/assets/resources/media/UTA_with_EUR.pdf) | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectCarrierRequestBody.new(nickname: null,
+                                 username: null,
+                                 password: null,
+                                 merchant_seller_id: null,
+                                 mws_auth_token: null,
+                                 email: null,
+                                 account_number: null,
+                                 ftp_username: null,
+                                 ftp_password: null,
+                                 api_key: null,
+                                 api_secret: null,
+                                 contract_id: null,
+                                 client_id: null,
+                                 pickup_number: null,
+                                 distribution_center: null,
+                                 ancillary_endorsement: null,
+                                 site_id: null,
+                                 account: null,
+                                 passphrase: null,
+                                 address1: null,
+                                 address2: null,
+                                 city: null,
+                                 company: null,
+                                 country_code: null,
+                                 first_name: null,
+                                 last_name: null,
+                                 phone: null,
+                                 postal_code: null,
+                                 state: null,
+                                 agree_to_eula: null,
+                                 meter_number: null,
+                                 mailer_id: null,
+                                 profile_name: null,
+                                 merchant_id: null,
+                                 induction_site: null,
+                                 activation_key: null,
+                                 oba_email: null,
+                                 contact_name: null,
+                                 company_name: null,
+                                 street_line1: null,
+                                 street_line2: null,
+                                 street_line3: null,
+                                 access_key: null,
+                                 sendle_id: null,
+                                 account_country_code: null,
+                                 account_postal_code: null,
+                                 title: null,
+                                 invoice: null,
+                                 agree_to_technology_agreement: null)
+```
+
+

data/docs/ConnectCarrierResponseBody.md

@@ -0,0 +1,17 @@
+# OpenapiClient::ConnectCarrierResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**carrier_id** | **String** | A string that uniquely identifies the carrier | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectCarrierResponseBody.new(carrier_id: null)
+```
+
+

data/docs/ConnectDhlEcommerceRequestBody.md

@@ -0,0 +1,39 @@
+# OpenapiClient::ConnectDhlEcommerceRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | A nickname to help you identify this account | 
+**client_id** | **String** | The client id | 
+**username** | **String** | The account username | 
+**password** | **String** | The account password | 
+**pickup_number** | **String** | The pickup number | 
+**distribution_center** | **String** | The distribution center | 
+**api_key** | **String** | The DHL E-Commerce API key. This field is optional, but if not set you will not be able to get rates for this account.  | [optional] 
+**api_secret** | **String** | The DHL E-Commerce API secret. This field is optional, but if not set you will not be able to get rates for this account.  | [optional] 
+**ancillary_endorsement** | [**AncillaryServiceEndorsement**](AncillaryServiceEndorsement.md) |  | [optional] 
+**account_number** | **String** | Account number | [optional] 
+**ftp_username** | **String** | FTP username | [optional] 
+**ftp_password** | **String** | FTP password | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectDhlEcommerceRequestBody.new(nickname: null,
+                                 client_id: null,
+                                 username: null,
+                                 password: null,
+                                 pickup_number: null,
+                                 distribution_center: null,
+                                 api_key: null,
+                                 api_secret: null,
+                                 ancillary_endorsement: null,
+                                 account_number: null,
+                                 ftp_username: null,
+                                 ftp_password: null)
+```
+
+

data/docs/ConnectDhlExpressAuRequestBody.md

@@ -0,0 +1,19 @@
+# OpenapiClient::ConnectDhlExpressAuRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | Nickname | 
+**account_number** | **String** | Account number | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectDhlExpressAuRequestBody.new(nickname: null,
+                                 account_number: null)
+```
+
+

data/docs/ConnectDhlExpressCaRequestBody.md

@@ -0,0 +1,19 @@
+# OpenapiClient::ConnectDhlExpressCaRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | Nickname | 
+**account_number** | **String** | Account number | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectDhlExpressCaRequestBody.new(nickname: null,
+                                 account_number: null)
+```
+
+

data/docs/ConnectDhlExpressRequestBody.md

@@ -0,0 +1,19 @@
+# OpenapiClient::ConnectDhlExpressRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | Nickname | 
+**account_number** | **String** | Account number | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectDhlExpressRequestBody.new(nickname: null,
+                                 account_number: null)
+```
+
+

data/docs/ConnectDhlExpressUkRequestBody.md

@@ -0,0 +1,23 @@
+# OpenapiClient::ConnectDhlExpressUkRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_number** | **String** | Account number | 
+**site_id** | **String** | A string that uniquely identifies the site | 
+**password** | **String** | Password | 
+**nickname** | **String** | Nickname | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectDhlExpressUkRequestBody.new(account_number: null,
+                                 site_id: null,
+                                 password: null,
+                                 nickname: null)
+```
+
+

data/docs/ConnectDpdRequestBody.md

@@ -0,0 +1,21 @@
+# OpenapiClient::ConnectDpdRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_number** | **String** | Account number | 
+**password** | **String** | Password | 
+**nickname** | **String** | Nickname | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectDpdRequestBody.new(account_number: null,
+                                 password: null,
+                                 nickname: null)
+```
+
+

data/docs/ConnectEndiciaRequestBody.md

@@ -0,0 +1,21 @@
+# OpenapiClient::ConnectEndiciaRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | Nickname | 
+**account** | **String** | Account | 
+**passphrase** | **String** | Passphrase | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectEndiciaRequestBody.new(nickname: null,
+                                 account: null,
+                                 passphrase: null)
+```
+
+

data/docs/ConnectFedexRequestBody.md

@@ -0,0 +1,45 @@
+# OpenapiClient::ConnectFedexRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_number** | **String** | Account number | 
+**address1** | **String** | Address | 
+**address2** | **String** | Address | [optional] 
+**city** | **String** | The city | 
+**company** | **String** | The company | [optional] 
+**country_code** | **String** | Country code | 
+**email** | **String** | The email address | 
+**first_name** | **String** | First name | 
+**last_name** | **String** | Last name | 
+**phone** | **String** | Phone number | 
+**postal_code** | **String** | Postal Code | 
+**state** | **String** | State | 
+**nickname** | **String** | Nickname | 
+**agree_to_eula** | **Boolean** | Boolean signaling agreement to the Fedex End User License Agreement | 
+**meter_number** | **String** | Meter number | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectFedexRequestBody.new(account_number: null,
+                                 address1: null,
+                                 address2: null,
+                                 city: null,
+                                 company: null,
+                                 country_code: null,
+                                 email: null,
+                                 first_name: null,
+                                 last_name: null,
+                                 phone: null,
+                                 postal_code: null,
+                                 state: null,
+                                 nickname: null,
+                                 agree_to_eula: null,
+                                 meter_number: null)
+```
+
+