ship_engine 1.0.0

data/docs/PagedListResponseBody.md

@@ -0,0 +1,23 @@
+# OpenapiClient::PagedListResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** | The total number of items across all pages of results | 
+**page** | **Integer** | The current page number of results.  For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4.  The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. | 
+**pages** | **Integer** | The total number of pages of results.  For example, if there are 80 results, and the page size is 25, then `pages` would be 4.  The first three pages would contain 25 items each, and the fourth page would contain the five remaining items.  If there are no results, then `pages` will be zero. | 
+**links** | [**PaginationLink**](PaginationLink.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PagedListResponseBody.new(total: 2750,
+                                 page: 1,
+                                 pages: 4,
+                                 links: null)
+```
+
+

data/docs/PaginationLink.md

@@ -0,0 +1,23 @@
+# OpenapiClient::PaginationLink
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first** | [**Link**](Link.md) | The link to the first page of results.  This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.  | 
+**last** | [**Link**](Link.md) | The link to the final page of results.  This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.  | 
+**prev** | [**OptionalLink**](OptionalLink.md) | The link to the previous page of results.  The `href` field will only be set when the `page` is 2 or greater.  | 
+**_next** | [**OptionalLink**](OptionalLink.md) | The link to the next page of results.  The `href` field will only be set when the `page` is less than `pages`.  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaginationLink.new(first: null,
+                                 last: null,
+                                 prev: null,
+                                 _next: null)
+```
+
+

data/docs/ParseAddressRequestBody.md

@@ -0,0 +1,19 @@
+# OpenapiClient::ParseAddressRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **String** | The unstructured text that contains address-related entities | 
+**address** | [**PartialAddress**](PartialAddress.md) | You can optionally provide any already-known address values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ParseAddressRequestBody.new(text: Margie McMiller at 3800 North Lamar suite 200 in austin, tx.  The zip code there is 78652.,
+                                 address: null)
+```
+
+

data/docs/ParseAddressResponseBody.md

@@ -0,0 +1,21 @@
+# OpenapiClient::ParseAddressResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**score** | **Float** | A confidence score between zero and one that indicates how certain the API is that it understood the text.  | 
+**address** | [**PartialAddress**](PartialAddress.md) | The parsed address.  This address may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity.  > **Note:** The address-recognition API does not currently perform any validation of the parsed address, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the address is correct.  | 
+**entities** | [**Array<RecognizedEntity>**](RecognizedEntity.md) | All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, or an address line.  Each entity includes the original text and the parsed value.  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ParseAddressResponseBody.new(score: null,
+                                 address: null,
+                                 entities: null)
+```
+
+

data/docs/ParseShipmentRequestBody.md

@@ -0,0 +1,20 @@
+# OpenapiClient::ParseShipmentRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **String** | The unstructured text that contains shipping-related entities | 
+**shipment** | [**PartialShipment**](PartialShipment.md) | You can optionally provide a `shipment` object containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ParseShipmentRequestBody.new(text: I have a 4oz package that's 5x10x14in, and I need to ship it to Margie McMiller at 3800 North Lamar suite 200 in austin, tx 78652. Please send it via USPS first class and require an adult signature. It also needs to be insured for $400.
+,
+                                 shipment: null)
+```
+
+

data/docs/ParseShipmentResponseBody.md

@@ -0,0 +1,21 @@
+# OpenapiClient::ParseShipmentResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**score** | **Float** | A confidence score between zero and one that indicates how certain the API is that it understood the text.  | 
+**shipment** | [**PartialShipment**](PartialShipment.md) | The parsed shipment.  This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity.  > **Note:** The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct.  | 
+**entities** | [**Array<RecognizedEntity>**](RecognizedEntity.md) | All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight.  Each entity includes the original text and the parsed value.  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ParseShipmentResponseBody.new(score: null,
+                                 shipment: null,
+                                 entities: null)
+```
+
+

data/docs/PartialAddress.md

@@ -0,0 +1,37 @@
+# OpenapiClient::PartialAddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of a contact person at this address.  This field may be set instead of - or in addition to - the `company_name` field.  | [optional] 
+**phone** | **String** | The phone number of a contact person at this address.  The format of this phone number varies depending on the country.  | [optional] 
+**company_name** | **String** | If this is a business address, then the company name should be specified here.  | [optional] 
+**address_line1** | **String** | The first line of the street address.  For some addresses, this may be the only line.  Other addresses may require 2 or 3 lines.  | [optional] 
+**address_line2** | **String** | The second line of the street address.  For some addresses, this line may not be needed.  | [optional] 
+**address_line3** | **String** | The third line of the street address.  For some addresses, this line may not be needed.  | [optional] 
+**city_locality** | **String** | The name of the city or locality | [optional] 
+**state_province** | **String** | The state or province.  For some countries (including the U.S.) only abbreviations are allowed.  Other countries allow the full name or abbreviation.  | [optional] 
+**postal_code** | **String** |  | [optional] 
+**country_code** | **String** | The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)  | [optional] 
+**address_residential_indicator** | [**AddressResidentialIndicator**](AddressResidentialIndicator.md) | Indicates whether this is a residential address. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PartialAddress.new(name: John Doe,
+                                 phone: +1 204-253-9411 ext. 123,
+                                 company_name: The Home Depot,
+                                 address_line1: 1999 Bishop Grandin Blvd.,
+                                 address_line2: Unit 408,
+                                 address_line3: Building #7,
+                                 city_locality: Winnipeg,
+                                 state_province: Manitoba,
+                                 postal_code: null,
+                                 country_code: null,
+                                 address_residential_indicator: no)
+```
+
+

data/docs/PartialShipment.md

@@ -0,0 +1,59 @@
+# OpenapiClient::PartialShipment
+
+## 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] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PartialShipment.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)
+```
+
+

data/docs/PaymentAmount.md

@@ -0,0 +1,19 @@
+# OpenapiClient::PaymentAmount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency** | [**Currency**](Currency.md) |  | [optional] 
+**amount** | **Float** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentAmount.new(currency: null,
+                                 amount: null)
+```
+
+

data/docs/ProcessBatchRequestBody.md

@@ -0,0 +1,21 @@
+# OpenapiClient::ProcessBatchRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ship_date** | **DateTime** | The Ship date the batch is being processed for | [optional] 
+**label_layout** | [**LabelLayout**](LabelLayout.md) |  | [optional] [default to '4x6']
+**label_format** | [**LabelFormat**](LabelFormat.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ProcessBatchRequestBody.new(ship_date: null,
+                                 label_layout: null,
+                                 label_format: null)
+```
+
+

data/docs/PurchaseLabelWithoutShipment.md

@@ -0,0 +1,23 @@
+# OpenapiClient::PurchaseLabelWithoutShipment
+
+## 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::PurchaseLabelWithoutShipment.new(validate_address: null,
+                                 label_layout: null,
+                                 label_format: null,
+                                 label_download_type: null)
+```
+
+

data/docs/Rate.md

@@ -0,0 +1,65 @@
+# OpenapiClient::Rate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rate_id** | **String** | A string that uniquely identifies the rate | [readonly] 
+**rate_type** | [**RateType**](RateType.md) |  | [readonly] 
+**carrier_id** | **String** | A string that uniquely identifies the carrier | [readonly] 
+**shipping_amount** | [**MonetaryValue**](MonetaryValue.md) | The shipping amount | [readonly] 
+**insurance_amount** | [**MonetaryValue**](MonetaryValue.md) | The insurance amount | [readonly] 
+**confirmation_amount** | [**MonetaryValue**](MonetaryValue.md) | The confirmation amount | [readonly] 
+**other_amount** | [**MonetaryValue**](MonetaryValue.md) | Any other charges associated with this rate | [readonly] 
+**tax_amount** | [**MonetaryValue**](MonetaryValue.md) | Tariff and additional taxes associated with an international shipment. | [optional] [readonly] 
+**zone** | **Integer** | Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location  | [readonly] 
+**package_type** | **String** | package type that this rate was estimated for | [readonly] 
+**delivery_days** | **Integer** | The number of days estimated for delivery, this will show the _actual_ deliverty time if for example, the package gets shipped on a Friday  | [optional] [readonly] 
+**guaranteed_service** | **Boolean** | Indicates if the rate is guaranteed. | [readonly] 
+**estimated_delivery_date** | **DateTime** |  | [optional] [readonly] 
+**carrier_delivery_days** | **String** | The carrier delivery days | [optional] [readonly] 
+**ship_date** | **DateTime** | ship date | [optional] [readonly] 
+**negotiated_rate** | **Boolean** | Indicates if the rates been negotiated | [readonly] 
+**service_type** | **String** | service type | [readonly] 
+**service_code** | **String** | service code for the rate | [readonly] 
+**trackable** | **Boolean** | Indicates if rate is trackable | [readonly] 
+**carrier_code** | **String** | carrier code | [readonly] 
+**carrier_nickname** | **String** | carrier nickname | [readonly] 
+**carrier_friendly_name** | **String** | carrier friendly name | [readonly] 
+**validation_status** | [**ValidationStatus**](ValidationStatus.md) |  | [readonly] 
+**warning_messages** | **Array<String>** | The warning messages | [readonly] 
+**error_messages** | **Array<String>** | The error messages | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Rate.new(rate_id: null,
+                                 rate_type: null,
+                                 carrier_id: null,
+                                 shipping_amount: null,
+                                 insurance_amount: null,
+                                 confirmation_amount: null,
+                                 other_amount: null,
+                                 tax_amount: null,
+                                 zone: 6,
+                                 package_type: package,
+                                 delivery_days: 5,
+                                 guaranteed_service: null,
+                                 estimated_delivery_date: null,
+                                 carrier_delivery_days: null,
+                                 ship_date: null,
+                                 negotiated_rate: null,
+                                 service_type: null,
+                                 service_code: null,
+                                 trackable: null,
+                                 carrier_code: null,
+                                 carrier_nickname: null,
+                                 carrier_friendly_name: null,
+                                 validation_status: null,
+                                 warning_messages: null,
+                                 error_messages: null)
+```
+
+

data/docs/RateEstimateByCarrierId.md

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

data/docs/RateEstimateByCarrierIds.md

@@ -0,0 +1,17 @@
+# OpenapiClient::RateEstimateByCarrierIds
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**carrier_ids** | **Array<String>** | Array of Carrier Ids | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RateEstimateByCarrierIds.new(carrier_ids: null)
+```
+
+

data/docs/RateEstimateOptions.md

@@ -0,0 +1,41 @@
+# OpenapiClient::RateEstimateOptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from_country_code** | **String** |  | [optional] 
+**from_postal_code** | **String** |  | [optional] 
+**from_city_locality** | **String** | from postal code | [optional] 
+**from_state_province** | **String** | From state province | [optional] 
+**to_country_code** | **String** |  | [optional] 
+**to_postal_code** | **String** |  | [optional] 
+**to_city_locality** | **String** | The city locality the package is being shipped to | [optional] 
+**to_state_province** | **String** | To state province | [optional] 
+**weight** | [**Weight**](Weight.md) | The weight of the package | [optional] 
+**dimensions** | [**Dimensions**](Dimensions.md) | The dimensions of the package | [optional] 
+**confirmation** | [**DeliveryConfirmation**](DeliveryConfirmation.md) |  | [optional] 
+**address_residential_indicator** | [**AddressResidentialIndicator**](AddressResidentialIndicator.md) |  | [optional] 
+**ship_date** | **DateTime** | ship date | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RateEstimateOptions.new(from_country_code: null,
+                                 from_postal_code: null,
+                                 from_city_locality: Austin,
+                                 from_state_province: Austin,
+                                 to_country_code: null,
+                                 to_postal_code: null,
+                                 to_city_locality: Austin,
+                                 to_state_province: Houston,
+                                 weight: null,
+                                 dimensions: null,
+                                 confirmation: null,
+                                 address_residential_indicator: null,
+                                 ship_date: null)
+```
+
+