ship_engine 1.0.0

data/docs/CreateBatchRequestBody.md

@@ -0,0 +1,23 @@
+# OpenapiClient::CreateBatchRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_batch_id** | **String** | A string that uniquely identifies the external batch | [optional] 
+**batch_notes** | **String** | Add custom messages for a particular batch | [optional] 
+**shipment_ids** | **Array<String>** | Array of shipment IDs used in the batch | [optional] 
+**rate_ids** | **Array<String>** | Array of rate IDs used in the batch | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CreateBatchRequestBody.new(external_batch_id: null,
+                                 batch_notes: This is my batch,
+                                 shipment_ids: null,
+                                 rate_ids: null)
+```
+
+

data/docs/CreateBatchResponseBody.md

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

data/docs/CreateLabelFromRateRequestBody.md

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

data/docs/CreateLabelFromRateResponseBody.md

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

data/docs/CreateLabelFromShipmentRequestBody.md

@@ -0,0 +1,23 @@
+# OpenapiClient::CreateLabelFromShipmentRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**validate_address** | [**ValidateAddress**](ValidateAddress.md) |  | [optional] 
+**label_layout** | [**LabelLayout**](LabelLayout.md) |  | [optional] 
+**label_format** | [**LabelFormat**](LabelFormat.md) |  | [optional] 
+**label_download_type** | [**LabelDownloadType**](LabelDownloadType.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CreateLabelFromShipmentRequestBody.new(validate_address: null,
+                                 label_layout: null,
+                                 label_format: null,
+                                 label_download_type: null)
+```
+
+

data/docs/CreateLabelFromShipmentResponseBody.md

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

data/docs/CreateLabelRequestBody.md

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

data/docs/CreateLabelResponseBody.md

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

data/docs/CreateManifestByObjectRequestBody.md

@@ -0,0 +1,25 @@
+# OpenapiClient::CreateManifestByObjectRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**carrier_id** | **String** | A string that uniquely identifies the carrier | 
+**excluded_label_ids** | **Array<String>** | The list of label ids to exclude from the manifest | [optional] 
+**label_ids** | **Array<String>** | The list of label ids to include for the manifest | [optional] 
+**warehouse_id** | **String** | A string that uniquely identifies the warehouse | 
+**ship_date** | **DateTime** | The ship date that the shipment will be sent out on | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CreateManifestByObjectRequestBody.new(carrier_id: null,
+                                 excluded_label_ids: null,
+                                 label_ids: null,
+                                 warehouse_id: null,
+                                 ship_date: 2018-09-23T15:00Z)
+```
+
+

data/docs/CreateManifestLabelIdsRequestBody.md

@@ -0,0 +1,17 @@
+# OpenapiClient::CreateManifestLabelIdsRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label_ids** | **Array<String>** | The list of label ids to include in the manifest | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CreateManifestLabelIdsRequestBody.new(label_ids: null)
+```
+
+

data/docs/CreateManifestRequestBody.md

@@ -0,0 +1,25 @@
+# OpenapiClient::CreateManifestRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**carrier_id** | **String** | A string that uniquely identifies the carrier | 
+**excluded_label_ids** | **Array<String>** | The list of label ids to exclude from the manifest | [optional] 
+**label_ids** | **Array<String>** | The list of label ids to include in the manifest | 
+**warehouse_id** | **String** | A string that uniquely identifies the warehouse | 
+**ship_date** | **DateTime** | The ship date that the shipment will be sent out on | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CreateManifestRequestBody.new(carrier_id: null,
+                                 excluded_label_ids: null,
+                                 label_ids: null,
+                                 warehouse_id: null,
+                                 ship_date: 2018-09-23T15:00Z)
+```
+
+

data/docs/CreateManifestResponseBody.md

@@ -0,0 +1,35 @@
+# OpenapiClient::CreateManifestResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**manifests** | [**Array<Manifest>**](Manifest.md) |  | [optional] 
+**manifest_id** | **String** | A string that uniquely identifies the manifest | 
+**form_id** | **String** | A string that uniquely identifies the form | 
+**created_at** | **DateTime** | The date-time that the manifest was created | 
+**ship_date** | **DateTime** | The date-time that the manifests shipments will be picked up | 
+**shipments** | **Integer** | The number of shipments that are included in this manifest | [readonly] 
+**warehouse_id** | **String** | A string that uniquely identifies the warehouse | 
+**submission_id** | **String** | A string that uniquely identifies the submission | 
+**carrier_id** | **String** | A string that uniquely identifies the carrier | 
+**manifest_download** | [**ManifestDownload**](ManifestDownload.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CreateManifestResponseBody.new(manifests: null,
+                                 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/CreatePackageTypeRequestBody.md

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

data/docs/CreatePackageTypeResponseBody.md

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

data/docs/CreateReturnLabelRequestBody.md

@@ -0,0 +1,25 @@
+# OpenapiClient::CreateReturnLabelRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**charge_event** | [**LabelChargeEvent**](LabelChargeEvent.md) | The label charge event.  | [optional] 
+**label_layout** | [**LabelLayout**](LabelLayout.md) | The layout (size) that you want the label to be in.  The `label_format` determines which sizes are allowed.  `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format.  | [optional] 
+**label_format** | [**LabelFormat**](LabelFormat.md) | The file format that you want the label to be in.  We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.  | [optional] 
+**label_download_type** | [**LabelDownloadType**](LabelDownloadType.md) |  | [optional] 
+**label_image_id** | **String** | The label image resource that was used to create a custom label image. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CreateReturnLabelRequestBody.new(charge_event: null,
+                                 label_layout: null,
+                                 label_format: null,
+                                 label_download_type: null,
+                                 label_image_id: null)
+```
+
+

data/docs/CreateReturnLabelResponseBody.md

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

data/docs/CreateShipmentResponseBodyFields.md

@@ -0,0 +1,19 @@
+# OpenapiClient::CreateShipmentResponseBodyFields
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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::CreateShipmentResponseBodyFields.new(errors: null,
+                                 address_validation: null)
+```
+
+

data/docs/CreateShipmentsRequestBody.md

@@ -0,0 +1,17 @@
+# OpenapiClient::CreateShipmentsRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shipments** | [**Array<AddressValidatingShipment>**](AddressValidatingShipment.md) | An array of shipments to be created. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CreateShipmentsRequestBody.new(shipments: null)
+```
+
+

data/docs/CreateShipmentsResponseBody.md

@@ -0,0 +1,19 @@
+# OpenapiClient::CreateShipmentsResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**has_errors** | **Boolean** | Indicates if errors occured while creating the shipments | [default to false]
+**shipments** | [**Array<CreateAndValidateShipment>**](CreateAndValidateShipment.md) | An array of shipments that were created. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CreateShipmentsResponseBody.new(has_errors: null,
+                                 shipments: null)
+```
+
+

data/docs/CreateTagResponseBody.md

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

data/docs/CreateWarehouseRequestBody.md

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

data/docs/CreateWarehouseResponseBody.md

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