ship_engine 1.0.0

data/docs/ConnectFedexUkRequestBody.md

@@ -0,0 +1,45 @@
+# OpenapiClient::ConnectFedexUkRequestBody
+
+## 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::ConnectFedexUkRequestBody.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)
+```
+
+

data/docs/ConnectFirstmileRequestBody.md

@@ -0,0 +1,23 @@
+# OpenapiClient::ConnectFirstmileRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | Nickname | 
+**mailer_id** | **String** | A string that uniquely identifies the mailer | 
+**profile_name** | **String** | Profile name | [optional] 
+**password** | **String** | Password | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectFirstmileRequestBody.new(nickname: null,
+                                 mailer_id: null,
+                                 profile_name: null,
+                                 password: null)
+```
+
+

data/docs/ConnectGlobegisticsRequestBody.md

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

data/docs/ConnectImexRequestBody.md

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

data/docs/ConnectInsurerRequestBody.md

@@ -0,0 +1,19 @@
+# OpenapiClient::ConnectInsurerRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** |  | 
+**policy_id** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectInsurerRequestBody.new(email: null,
+                                 policy_id: null)
+```
+
+

data/docs/ConnectNewgisticsRequestBody.md

@@ -0,0 +1,23 @@
+# OpenapiClient::ConnectNewgisticsRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**merchant_id** | **Integer** | Merchant id | [optional] 
+**mailer_id** | **Integer** | Mailer id | [optional] 
+**induction_site** | **String** | Induction site | 
+**nickname** | **String** | Nickname | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectNewgisticsRequestBody.new(merchant_id: null,
+                                 mailer_id: null,
+                                 induction_site: null,
+                                 nickname: null)
+```
+
+

data/docs/ConnectOntracRequestBody.md

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

data/docs/ConnectPurolatorRequestBody.md

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

data/docs/ConnectRoyalMailRequestBody.md

@@ -0,0 +1,39 @@
+# OpenapiClient::ConnectRoyalMailRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_number** | **String** | Account number | 
+**oba_email** | **String** | The oba email address | [optional] 
+**contact_name** | **String** | Contact name | 
+**email** | **String** | The email address | [optional] 
+**company_name** | **String** | Company name | [optional] 
+**street_line1** | **String** | Street line1 | [optional] 
+**street_line2** | **String** | Street line2 | [optional] 
+**street_line3** | **String** | Street line3 | [optional] 
+**city** | **String** | City | 
+**postal_code** | **String** | Postal code | 
+**phone** | **String** | Phone | [optional] 
+**nickname** | **String** | Nickname | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectRoyalMailRequestBody.new(account_number: null,
+                                 oba_email: null,
+                                 contact_name: null,
+                                 email: null,
+                                 company_name: null,
+                                 street_line1: null,
+                                 street_line2: null,
+                                 street_line3: null,
+                                 city: null,
+                                 postal_code: null,
+                                 phone: null,
+                                 nickname: null)
+```
+
+

data/docs/ConnectRrDonnelleyRequestBody.md

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

data/docs/ConnectSekoRequestBody.md

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

data/docs/ConnectSendleRequestBody.md

@@ -0,0 +1,21 @@
+# OpenapiClient::ConnectSendleRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | Nickname | 
+**sendle_id** | **String** | A string that uniquely identifies the sendle | 
+**api_key** | **String** | API key | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ConnectSendleRequestBody.new(nickname: null,
+                                 sendle_id: null,
+                                 api_key: null)
+```
+
+

data/docs/ConnectStampsRequestBody.md

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

data/docs/ConnectUpsRequestBody.md

@@ -0,0 +1,51 @@
+# OpenapiClient::ConnectUpsRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | Nickname | 
+**account_number** | **String** | Account number | 
+**account_country_code** | **String** | Account country code | 
+**account_postal_code** | **String** | Account postal code | 
+**title** | **String** | Title | [optional] 
+**first_name** | **String** | First name | 
+**last_name** | **String** | Last name | 
+**company** | **String** | Company | 
+**address1** | **String** | Address Line 1 | 
+**address2** | **String** | Address Line 2 | [optional] 
+**city** | **String** | City | 
+**state** | **String** | State | 
+**postal_code** | **String** | Postal code | 
+**country_code** | **String** | Country code | 
+**email** | **String** | The email address | 
+**phone** | **String** | Phone | 
+**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::ConnectUpsRequestBody.new(nickname: null,
+                                 account_number: null,
+                                 account_country_code: null,
+                                 account_postal_code: null,
+                                 title: null,
+                                 first_name: null,
+                                 last_name: null,
+                                 company: null,
+                                 address1: null,
+                                 address2: null,
+                                 city: null,
+                                 state: null,
+                                 postal_code: null,
+                                 country_code: null,
+                                 email: null,
+                                 phone: null,
+                                 invoice: null,
+                                 agree_to_technology_agreement: null)
+```
+
+

data/docs/CreateAndValidateShipment.md

@@ -0,0 +1,63 @@
+# OpenapiClient::CreateAndValidateShipment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shipment_id** | **String** | A string that uniquely identifies the shipment | [optional] [readonly] 
+**carrier_id** | **String** | The carrier account that is billed for the shipping charges | [optional] 
+**service_code** | **String** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.  | [optional] 
+**external_order_id** | **String** | ID that the Order Source assigned | [optional] 
+**items** | [**Array<ShipmentItem>**](ShipmentItem.md) | Describe the packages included in this shipment as related to potential metadata that was imported from external order sources  | [optional] 
+**external_shipment_id** | **String** | You can optionally use this field to store your own identifier for this shipment.  > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.  | [optional] 
+**ship_date** | **DateTime** | The date that the shipment was (or will be) shippped.  ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.  | [optional] 
+**created_at** | **DateTime** | The date and time that the shipment was created in ShipEngine. | [optional] [readonly] 
+**modified_at** | **DateTime** | The date and time that the shipment was created or last modified. | [optional] [readonly] 
+**shipment_status** | [**ShipmentStatus**](ShipmentStatus.md) | The current status of the shipment | [optional] [readonly] 
+**ship_to** | [**Address**](Address.md) | The recipient's mailing address | [optional] 
+**ship_from** | [**Address**](Address.md) | The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time.  | [optional] 
+**warehouse_id** | **String** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from.  Either `warehouse_id` or `ship_from` must be specified.  | [optional] 
+**return_to** | [**Address**](Address.md) | The return address for this shipment.  Defaults to the `ship_from` address.  | [optional] 
+**confirmation** | [**DeliveryConfirmation**](DeliveryConfirmation.md) | The type of delivery confirmation that is required for this shipment. | [optional] 
+**customs** | [**InternationalShipmentOptions**](InternationalShipmentOptions.md) | Customs information.  This is usually only needed for international shipments.  | [optional] 
+**advanced_options** | [**AdvancedShipmentOptions**](AdvancedShipmentOptions.md) | Advanced shipment options.  These are entirely optional. | [optional] 
+**insurance_provider** | [**InsuranceProvider**](InsuranceProvider.md) | The insurance provider to use for any insured packages in the shipment.  | [optional] 
+**tags** | [**Array<Tag>**](Tag.md) | Arbitrary tags associated with this shipment.  Tags can be used to categorize shipments, and shipments can be queried by their tags.  | [optional] [readonly] 
+**order_source_code** | [**OrderSourceName**](OrderSourceName.md) |  | [optional] 
+**packages** | [**Array<Package>**](Package.md) | The packages in the shipment.  > **Note:** Some carriers only allow one package per shipment.  If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.  | [optional] 
+**total_weight** | [**Weight**](Weight.md) | The combined weight of all packages in the shipment | [optional] [readonly] 
+**errors** | **Array<String>** | An array of errors that occurred while creating shipment. | [optional] [readonly] 
+**address_validation** | [**AddressValidationResult**](AddressValidationResult.md) | The address validation | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CreateAndValidateShipment.new(shipment_id: null,
+                                 carrier_id: null,
+                                 service_code: null,
+                                 external_order_id: null,
+                                 items: null,
+                                 external_shipment_id: null,
+                                 ship_date: null,
+                                 created_at: null,
+                                 modified_at: null,
+                                 shipment_status: null,
+                                 ship_to: null,
+                                 ship_from: null,
+                                 warehouse_id: null,
+                                 return_to: null,
+                                 confirmation: null,
+                                 customs: null,
+                                 advanced_options: null,
+                                 insurance_provider: null,
+                                 tags: null,
+                                 order_source_code: null,
+                                 packages: null,
+                                 total_weight: null,
+                                 errors: null,
+                                 address_validation: null)
+```
+
+