ship_engine 1.0.0

data/docs/TrackingInformation.md

@@ -0,0 +1,35 @@
+# OpenapiClient::TrackingInformation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tracking_number** | **String** |  | [optional] 
+**status_code** | **String** | Status code | [optional] [readonly] 
+**status_description** | **String** | Status description | [optional] [readonly] 
+**carrier_status_code** | **String** | Carrier status code | [optional] [readonly] 
+**carrier_status_description** | **String** | carrier status description | [optional] [readonly] 
+**ship_date** | **DateTime** |  | [optional] 
+**estimated_delivery_date** | **DateTime** |  | [optional] 
+**actual_delivery_date** | **DateTime** |  | [optional] 
+**exception_description** | **String** | Exception description | [optional] [readonly] 
+**events** | [**Array<TrackEvent>**](TrackEvent.md) | The events that have occured during the lifetime of this tracking number. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::TrackingInformation.new(tracking_number: null,
+                                 status_code: DE,
+                                 status_description: Delivered,
+                                 carrier_status_code: 1,
+                                 carrier_status_description: Your item was delivered in or at the mailbox at 9:10 am on March,
+                                 ship_date: null,
+                                 estimated_delivery_date: null,
+                                 actual_delivery_date: null,
+                                 exception_description: null,
+                                 events: null)
+```
+
+

data/docs/TrackingStatus.md

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

data/docs/UpdateAmazonBuyShippingRequestBody.md

@@ -0,0 +1,17 @@
+# OpenapiClient::UpdateAmazonBuyShippingRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UpdateAmazonBuyShippingRequestBody.new(email: null)
+```
+
+

data/docs/UpdateCarrierSettingsRequestBody.md

@@ -0,0 +1,51 @@
+# OpenapiClient::UpdateCarrierSettingsRequestBody
+
+## 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] 
+**include_barcode_with_order_number** | **Boolean** |  | [optional] 
+**receive_email_on_manifest_processing** | **Boolean** |  | [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] 
+**email** | **String** | Email | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UpdateCarrierSettingsRequestBody.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,
+                                 include_barcode_with_order_number: null,
+                                 receive_email_on_manifest_processing: 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,
+                                 email: null)
+```
+
+

data/docs/UpdateDhlExpressSettingsRequestBody.md

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

data/docs/UpdateFedexSettingsRequestBody.md

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

data/docs/UpdateNewgisticsSettingsRequestBody.md

@@ -0,0 +1,19 @@
+# OpenapiClient::UpdateNewgisticsSettingsRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**include_barcode_with_order_number** | **Boolean** |  | [optional] 
+**receive_email_on_manifest_processing** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UpdateNewgisticsSettingsRequestBody.new(include_barcode_with_order_number: null,
+                                 receive_email_on_manifest_processing: null)
+```
+
+

data/docs/UpdatePackageTypeRequestBody.md

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

data/docs/UpdateShipmentFields.md

@@ -0,0 +1,17 @@
+# OpenapiClient::UpdateShipmentFields
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**validate_address** | [**ValidateAddress**](ValidateAddress.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UpdateShipmentFields.new(validate_address: null)
+```
+
+

data/docs/UpdateShipmentRequestBody.md

@@ -0,0 +1,61 @@
+# OpenapiClient::UpdateShipmentRequestBody
+
+## 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 | 
+**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.  | 
+**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] 
+**validate_address** | [**ValidateAddress**](ValidateAddress.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UpdateShipmentRequestBody.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,
+                                 validate_address: null)
+```
+
+

data/docs/UpdateShipmentResponseBody.md

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

data/docs/UpdateUpsSettingsRequestBody.md

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

data/docs/UpdateWarehouseRequestBody.md

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

data/docs/UpdateWebhookRequestBody.md

@@ -0,0 +1,17 @@
+# OpenapiClient::UpdateWebhookRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | The url that the wehbook sends the request | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UpdateWebhookRequestBody.new(url: https://[YOUR ENDPOINT ID].x.requestbin.com)
+```
+
+

data/docs/UpsAccountSettings.md

@@ -0,0 +1,39 @@
+# OpenapiClient::UpsAccountSettings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **String** | nickname | [optional] 
+**is_primary_account** | **Boolean** | Indicates if this is the primary UPS account | [optional] 
+**pickup_type** | [**UpsPickupType**](UpsPickupType.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::UpsAccountSettings.new(nickname: null,
+                                 is_primary_account: null,
+                                 pickup_type: 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/UpsInvoice.md

@@ -0,0 +1,23 @@
+# OpenapiClient::UpsInvoice
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**invoice_date** | **DateTime** | invoice date | [optional] 
+**invoice_number** | **String** | invoice number | [optional] 
+**control_id** | **String** | A string that uniquely identifies the control | [optional] 
+**invoice_amount** | **Float** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UpsInvoice.new(invoice_date: null,
+                                 invoice_number: null,
+                                 control_id: null,
+                                 invoice_amount: null)
+```
+
+

data/docs/UpsPickupType.md

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

data/docs/UpsSettingsResponseBody.md

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