ship_engine 1.0.0

data/docs/AddFundsToCarrierRequestBody.md

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

data/docs/AddFundsToCarrierResponseBody.md

@@ -0,0 +1,17 @@
+# OpenapiClient::AddFundsToCarrierResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**balance** | [**MonetaryValue**](MonetaryValue.md) | The current balance of the account | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::AddFundsToCarrierResponseBody.new(balance: null)
+```
+
+

data/docs/AddFundsToInsuranceRequestBody.md

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

data/docs/AddFundsToInsuranceResponseBody.md

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

data/docs/AddToBatchRequestBody.md

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

data/docs/Address.md

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

data/docs/AddressResidentialIndicator.md

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

data/docs/AddressToValidate.md

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

data/docs/AddressValidatingShipment.md

@@ -0,0 +1,61 @@
+# OpenapiClient::AddressValidatingShipment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**validate_address** | [**ValidateAddress**](ValidateAddress.md) |  | [optional] 
+**shipment_id** | **String** | A string that uniquely identifies the shipment | [readonly] 
+**carrier_id** | **String** | The carrier account that is billed for the shipping charges | 
+**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.  | 
+**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] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::AddressValidatingShipment.new(validate_address: null,
+                                 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/AddressValidationCode.md

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

data/docs/AddressValidationDetailCode.md

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

data/docs/AddressValidationMessageType.md

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

data/docs/AddressValidationResult.md

@@ -0,0 +1,23 @@
+# OpenapiClient::AddressValidationResult
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**AddressValidationStatus**](AddressValidationStatus.md) |  | 
+**original_address** | [**Address**](Address.md) | The original address that was sent for validation | 
+**matched_address** | [**Address**](Address.md) | The matched address found by the Shipengine API | [readonly] 
+**messages** | [**Array<ResponseMessage>**](ResponseMessage.md) | The list of messages that were generated during the address validation request. | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::AddressValidationResult.new(status: null,
+                                 original_address: null,
+                                 matched_address: null,
+                                 messages: null)
+```
+
+

data/docs/AddressValidationStatus.md

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

data/docs/AddressesApi.md

@@ -0,0 +1,118 @@
+# OpenapiClient::AddressesApi
+
+All URIs are relative to *https://api.shipengine.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**parse_address**](AddressesApi.md#parse_address) | **PUT** /v1/addresses/recognize | Parse an address
+[**validate_address**](AddressesApi.md#validate_address) | **POST** /v1/addresses/validate | Validate An Address
+
+
+
+## parse_address
+
+> ParseAddressResponseBody parse_address(parse_address_request_body)
+
+Parse an address
+
+The address-recognition API makes it easy for you to extract address data from unstructured text, including the recipient name, line 1, line 2, city, postal code, and more.  Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's address-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed address data is returned in the same structure that's used for other ShipEngine APIs, such as address validation, rate quotes, and shipping labels.  > **Note:** Address recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland. 
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['API-Key'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::AddressesApi.new
+parse_address_request_body = {"text":"Margie McMiller at 3800 North Lamar suite 200 in austin, tx.  The zip code there is 78652."} # ParseAddressRequestBody | The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known 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. 
+
+begin
+  #Parse an address
+  result = api_instance.parse_address(parse_address_request_body)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling AddressesApi->parse_address: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **parse_address_request_body** | [**ParseAddressRequestBody**](ParseAddressRequestBody.md)| The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known 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.  | 
+
+### Return type
+
+[**ParseAddressResponseBody**](ParseAddressResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## validate_address
+
+> Array<AddressValidationResult> validate_address(address_to_validate)
+
+Validate An Address
+
+Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues. 
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['API-Key'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::AddressesApi.new
+address_to_validate = [{"name":"Mickey and Minnie Mouse","phone":"714-781-4565","company_name":"The Walt Disney Company","address_line1":"500 South Buena Vista Street","city_locality":"Burbank","state_province":"CA","postal_code":91521,"country_code":"US"}] # Array<AddressToValidate> | 
+
+begin
+  #Validate An Address
+  result = api_instance.validate_address(address_to_validate)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling AddressesApi->validate_address: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **address_to_validate** | [**Array&lt;AddressToValidate&gt;**](AddressToValidate.md)|  | 
+
+### Return type
+
+[**Array&lt;AddressValidationResult&gt;**](AddressValidationResult.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AdvancedShipmentOptions.md

@@ -0,0 +1,47 @@
+# OpenapiClient::AdvancedShipmentOptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bill_to_account** | **String** | This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields.  | [optional] [default to 'null']
+**bill_to_country_code** | **String** | The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the third-party that is responsible for shipping costs.  | [optional] 
+**bill_to_party** | [**BillToParty**](BillToParty.md) | Indicates whether to bill shipping costs to the recipient or to a third-party.  When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set.  | [optional] 
+**bill_to_postal_code** | **String** | The postal code of the third-party that is responsible for shipping costs.  | [optional] [default to 'null']
+**contains_alcohol** | **Boolean** | Indicates that the shipment contains alcohol. | [optional] [default to false]
+**delivered_duty_paid** | **Boolean** | Indicates that the shipper is paying the international delivery duties for this shipment.  This option is supported by UPS, FedEx, and DHL Express.  | [optional] [default to false]
+**dry_ice** | **Boolean** | Indicates if the shipment contain dry ice | [optional] [default to false]
+**dry_ice_weight** | [**Weight**](Weight.md) | The weight of the dry ice in the shipment | [optional] 
+**non_machinable** | **Boolean** | Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments.  See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details.  | [optional] [default to false]
+**saturday_delivery** | **Boolean** | Enables Saturday delivery, if supported by the carrier. | [optional] [default to false]
+**use_ups_ground_freight_pricing** | **Boolean** | Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified.  | [optional] 
+**freight_class** | **String** | The National Motor Freight Traffic Association [freight class](http://www.nmfta.org/pages/nmfc?AspxAutoDetectCookieSupport=1), such as \"77.5\", \"110\", or \"250\".  | [optional] [default to 'null']
+**custom_field1** | **String** | An arbitrary field that can be used to store information about the shipment.  | [optional] [default to 'null']
+**custom_field2** | **String** | An arbitrary field that can be used to store information about the shipment.  | [optional] [default to 'null']
+**custom_field3** | **String** | An arbitrary field that can be used to store information about the shipment.  | [optional] [default to 'null']
+**collect_on_delivery** | [**CollectOnDelivery**](CollectOnDelivery.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::AdvancedShipmentOptions.new(bill_to_account: null,
+                                 bill_to_country_code: null,
+                                 bill_to_party: null,
+                                 bill_to_postal_code: null,
+                                 contains_alcohol: null,
+                                 delivered_duty_paid: null,
+                                 dry_ice: null,
+                                 dry_ice_weight: null,
+                                 non_machinable: null,
+                                 saturday_delivery: null,
+                                 use_ups_ground_freight_pricing: null,
+                                 freight_class: 77.5,
+                                 custom_field1: null,
+                                 custom_field2: null,
+                                 custom_field3: null,
+                                 collect_on_delivery: null)
+```
+
+