ship_engine 1.0.4 → 1.0.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/BatchesApi.md +12 -12
- data/docs/CarrierAccountsApi.md +8 -8
- data/docs/CarriersApi.md +4 -4
- data/docs/LabelsApi.md +12 -12
- data/docs/PackageTypesApi.md +4 -4
- data/docs/ShipmentsApi.md +4 -4
- data/docs/WarehousesApi.md +4 -4
- data/docs/WebhooksApi.md +4 -4
- data/lib/ship_engine/api/batches_api.rb +27 -27
- data/lib/ship_engine/api/carrier_accounts_api.rb +18 -18
- data/lib/ship_engine/api/carriers_api.rb +9 -9
- data/lib/ship_engine/api/labels_api.rb +27 -27
- data/lib/ship_engine/api/package_types_api.rb +9 -9
- data/lib/ship_engine/api/shipments_api.rb +9 -9
- data/lib/ship_engine/api/warehouses_api.rb +9 -9
- data/lib/ship_engine/api/webhooks_api.rb +9 -9
- data/lib/ship_engine/models/add_funds_to_carrier_request_body.rb +3 -5
- data/lib/ship_engine/models/add_funds_to_carrier_response_body.rb +3 -5
- data/lib/ship_engine/models/add_funds_to_insurance_request_body.rb +3 -5
- data/lib/ship_engine/models/add_funds_to_insurance_response_body.rb +3 -5
- data/lib/ship_engine/models/add_to_batch_request_body.rb +3 -5
- data/lib/ship_engine/models/address.rb +4 -6
- data/lib/ship_engine/models/address_to_validate.rb +4 -6
- data/lib/ship_engine/models/address_validating_shipment.rb +14 -16
- data/lib/ship_engine/models/address_validation_result.rb +3 -5
- data/lib/ship_engine/models/advanced_shipment_options.rb +14 -16
- data/lib/ship_engine/models/batch.rb +4 -6
- data/lib/ship_engine/models/batch_response_error.rb +3 -5
- data/lib/ship_engine/models/bulk_rate.rb +3 -5
- data/lib/ship_engine/models/calculate_rates_request_body.rb +3 -5
- data/lib/ship_engine/models/calculate_rates_response_body.rb +14 -16
- data/lib/ship_engine/models/carrier.rb +4 -6
- data/lib/ship_engine/models/carrier_advanced_option.rb +3 -5
- data/lib/ship_engine/models/collect_on_delivery.rb +3 -5
- data/lib/ship_engine/models/compare_bulk_rates_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_access_worldwide_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_amazon_buy_shipping_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_apc_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_asendia_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_australia_post_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_canada_post_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_carrier_request_body.rb +4 -6
- data/lib/ship_engine/models/connect_carrier_response_body.rb +3 -5
- data/lib/ship_engine/models/connect_dhl_ecommerce_request_body.rb +5 -7
- data/lib/ship_engine/models/connect_dhl_express_au_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_dhl_express_ca_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_dhl_express_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_dhl_express_uk_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_dpd_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_endicia_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_fedex_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_fedex_uk_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_firstmile_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_globegistics_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_imex_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_insurer_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_newgistics_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_ontrac_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_purolator_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_royal_mail_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_rr_donnelley_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_seko_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_sendle_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_stamps_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_ups_request_body.rb +3 -5
- data/lib/ship_engine/models/create_and_validate_shipment.rb +14 -16
- data/lib/ship_engine/models/create_batch_request_body.rb +3 -5
- data/lib/ship_engine/models/create_batch_response_body.rb +3 -5
- data/lib/ship_engine/models/create_label_from_rate_request_body.rb +3 -5
- data/lib/ship_engine/models/create_label_from_rate_response_body.rb +3 -5
- data/lib/ship_engine/models/create_label_from_shipment_request_body.rb +3 -5
- data/lib/ship_engine/models/create_label_from_shipment_response_body.rb +3 -5
- data/lib/ship_engine/models/create_label_request_body.rb +3 -5
- data/lib/ship_engine/models/create_label_response_body.rb +3 -5
- data/lib/ship_engine/models/create_manifest_by_object_request_body.rb +3 -5
- data/lib/ship_engine/models/create_manifest_label_ids_request_body.rb +3 -5
- data/lib/ship_engine/models/create_manifest_request_body.rb +3 -5
- data/lib/ship_engine/models/create_manifest_response_body.rb +3 -5
- data/lib/ship_engine/models/create_package_type_request_body.rb +3 -5
- data/lib/ship_engine/models/create_package_type_response_body.rb +3 -5
- data/lib/ship_engine/models/create_return_label_request_body.rb +6 -8
- data/lib/ship_engine/models/create_return_label_response_body.rb +3 -5
- data/lib/ship_engine/models/create_shipment_response_body_fields.rb +3 -5
- data/lib/ship_engine/models/create_shipments_request_body.rb +3 -5
- data/lib/ship_engine/models/create_shipments_response_body.rb +3 -5
- data/lib/ship_engine/models/create_tag_response_body.rb +3 -5
- data/lib/ship_engine/models/create_warehouse_request_body.rb +3 -5
- data/lib/ship_engine/models/create_warehouse_response_body.rb +3 -5
- data/lib/ship_engine/models/create_webhook_request_body.rb +3 -5
- data/lib/ship_engine/models/create_webhook_response_body.rb +3 -5
- data/lib/ship_engine/models/customs_item.rb +4 -6
- data/lib/ship_engine/models/deprecated_manifest.rb +3 -5
- data/lib/ship_engine/models/dhl_express_account_settings.rb +3 -5
- data/lib/ship_engine/models/dhl_express_settings_response_body.rb +3 -5
- data/lib/ship_engine/models/dimensions.rb +3 -5
- data/lib/ship_engine/models/error.rb +4 -6
- data/lib/ship_engine/models/error_response_body.rb +4 -6
- data/lib/ship_engine/models/estimate_rates_request_body.rb +3 -5
- data/lib/ship_engine/models/fedex_account_settings.rb +3 -5
- data/lib/ship_engine/models/fedex_account_settings_request_body.rb +3 -5
- data/lib/ship_engine/models/fedex_settings_response_body.rb +3 -5
- data/lib/ship_engine/models/get_batch_by_external_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_batch_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_carrier_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_carrier_options_response_body.rb +3 -5
- data/lib/ship_engine/models/get_carrier_settings_response_body.rb +3 -5
- data/lib/ship_engine/models/get_carriers_response_body.rb +4 -6
- data/lib/ship_engine/models/get_insurance_balance_response_body.rb +3 -5
- data/lib/ship_engine/models/get_label_by_external_shipment_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_label_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_manifest_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_package_type_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_rate_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_shipment_by_external_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_shipment_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_tracking_log_from_label_response_body.rb +3 -5
- data/lib/ship_engine/models/get_tracking_log_response_body.rb +3 -5
- data/lib/ship_engine/models/get_warehouse_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_webhook_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/international_shipment_options.rb +3 -5
- data/lib/ship_engine/models/label.rb +27 -29
- data/lib/ship_engine/models/label_download.rb +4 -6
- data/lib/ship_engine/models/label_messages.rb +7 -9
- data/lib/ship_engine/models/link.rb +3 -5
- data/lib/ship_engine/models/list_batch_errors_response_body.rb +3 -5
- data/lib/ship_engine/models/list_batches_response_body.rb +3 -5
- data/lib/ship_engine/models/list_carrier_package_types_response_body.rb +3 -5
- data/lib/ship_engine/models/list_carrier_services_response_body.rb +3 -5
- data/lib/ship_engine/models/list_carriers_response_body.rb +3 -5
- data/lib/ship_engine/models/list_labels_response_body.rb +4 -6
- data/lib/ship_engine/models/list_manifests_response_body.rb +3 -5
- data/lib/ship_engine/models/list_package_types_response_body.rb +3 -5
- data/lib/ship_engine/models/list_shipment_errors_response_body.rb +3 -5
- data/lib/ship_engine/models/list_shipment_rates_response_body.rb +3 -5
- data/lib/ship_engine/models/list_shipments_response_body.rb +3 -5
- data/lib/ship_engine/models/list_tags_response_body.rb +3 -5
- data/lib/ship_engine/models/list_warehouses_response_body.rb +3 -5
- data/lib/ship_engine/models/manifest.rb +4 -6
- data/lib/ship_engine/models/manifest_download.rb +3 -5
- data/lib/ship_engine/models/manifests.rb +3 -5
- data/lib/ship_engine/models/modify_batch.rb +3 -5
- data/lib/ship_engine/models/monetary_value.rb +4 -6
- data/lib/ship_engine/models/optional_link.rb +3 -5
- data/lib/ship_engine/models/package.rb +6 -8
- data/lib/ship_engine/models/package_type.rb +3 -5
- data/lib/ship_engine/models/paged_list_response_body.rb +4 -6
- data/lib/ship_engine/models/pagination_link.rb +7 -9
- data/lib/ship_engine/models/parse_address_request_body.rb +5 -7
- data/lib/ship_engine/models/parse_address_response_body.rb +7 -9
- data/lib/ship_engine/models/parse_shipment_request_body.rb +5 -7
- data/lib/ship_engine/models/parse_shipment_response_body.rb +7 -9
- data/lib/ship_engine/models/partial_address.rb +11 -13
- data/lib/ship_engine/models/partial_shipment.rb +15 -17
- data/lib/ship_engine/models/payment_amount.rb +3 -5
- data/lib/ship_engine/models/process_batch_request_body.rb +3 -5
- data/lib/ship_engine/models/purchase_label_without_shipment.rb +3 -5
- data/lib/ship_engine/models/rate.rb +5 -7
- data/lib/ship_engine/models/rate_estimate_by_carrier_id.rb +3 -5
- data/lib/ship_engine/models/rate_estimate_by_carrier_ids.rb +3 -5
- data/lib/ship_engine/models/rate_estimate_options.rb +3 -5
- data/lib/ship_engine/models/rate_request_body.rb +3 -5
- data/lib/ship_engine/models/rate_request_by_shipment_ids.rb +3 -5
- data/lib/ship_engine/models/rate_request_by_shipments.rb +3 -5
- data/lib/ship_engine/models/rate_request_options.rb +3 -5
- data/lib/ship_engine/models/rate_request_rate_options.rb +3 -5
- data/lib/ship_engine/models/rate_response.rb +3 -5
- data/lib/ship_engine/models/rates_information.rb +3 -5
- data/lib/ship_engine/models/recognized_entity.rb +6 -8
- data/lib/ship_engine/models/remove_from_batch_request_body.rb +3 -5
- data/lib/ship_engine/models/response_message.rb +3 -5
- data/lib/ship_engine/models/service.rb +3 -5
- data/lib/ship_engine/models/shipment.rb +4 -6
- data/lib/ship_engine/models/shipment_id_request.rb +3 -5
- data/lib/ship_engine/models/shipment_item.rb +3 -5
- data/lib/ship_engine/models/shipment_request.rb +3 -5
- data/lib/ship_engine/models/shipment_response_error.rb +3 -5
- data/lib/ship_engine/models/tag.rb +4 -6
- data/lib/ship_engine/models/tag_shipment_response_body.rb +3 -5
- data/lib/ship_engine/models/track_event.rb +3 -5
- data/lib/ship_engine/models/tracking_information.rb +3 -5
- data/lib/ship_engine/models/update_amazon_buy_shipping_request_body.rb +3 -5
- data/lib/ship_engine/models/update_carrier_settings_request_body.rb +3 -5
- data/lib/ship_engine/models/update_dhl_express_settings_request_body.rb +3 -5
- data/lib/ship_engine/models/update_fedex_settings_request_body.rb +3 -5
- data/lib/ship_engine/models/update_newgistics_settings_request_body.rb +3 -5
- data/lib/ship_engine/models/update_package_type_request_body.rb +3 -5
- data/lib/ship_engine/models/update_shipment_fields.rb +3 -5
- data/lib/ship_engine/models/update_shipment_request_body.rb +14 -16
- data/lib/ship_engine/models/update_shipment_response_body.rb +3 -5
- data/lib/ship_engine/models/update_ups_settings_request_body.rb +3 -5
- data/lib/ship_engine/models/update_warehouse_request_body.rb +3 -5
- data/lib/ship_engine/models/update_webhook_request_body.rb +3 -5
- data/lib/ship_engine/models/ups_account_settings.rb +3 -5
- data/lib/ship_engine/models/ups_invoice.rb +3 -5
- data/lib/ship_engine/models/ups_settings_response_body.rb +3 -5
- data/lib/ship_engine/models/validate_shipment_fields.rb +3 -5
- data/lib/ship_engine/models/void_label_response_body.rb +3 -5
- data/lib/ship_engine/models/warehouse.rb +3 -5
- data/lib/ship_engine/models/webhook.rb +3 -5
- data/lib/ship_engine/models/weight.rb +3 -5
- data/lib/ship_engine/version.rb +1 -1
- data/ship_engine-1.0.4.gem +0 -0
- data/ship_engine.gemspec +1 -1
- metadata +2 -1
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#ShipEngine API
|
3
3
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
7
7
|
Contact: sales@shipengine.com
|
@@ -15,7 +15,7 @@ require 'date'
|
|
15
15
|
module ShipEngine
|
16
16
|
# A package associated with a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)
|
17
17
|
class Package
|
18
|
-
# The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type.
|
18
|
+
# The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type.
|
19
19
|
attr_accessor :package_code
|
20
20
|
|
21
21
|
# The package weight
|
@@ -24,10 +24,10 @@ module ShipEngine
|
|
24
24
|
# The package dimensions
|
25
25
|
attr_accessor :dimensions
|
26
26
|
|
27
|
-
# The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.
|
27
|
+
# The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.
|
28
28
|
attr_accessor :insured_value
|
29
29
|
|
30
|
-
# The tracking number for the package. The format depends on the carrier.
|
30
|
+
# The tracking number for the package. The format depends on the carrier.
|
31
31
|
attr_accessor :tracking_number
|
32
32
|
|
33
33
|
attr_accessor :label_messages
|
@@ -76,9 +76,7 @@ module ShipEngine
|
|
76
76
|
|
77
77
|
# check to see if the attribute exists and convert string to symbol for hash key
|
78
78
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
79
|
-
|
80
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `ShipEngine::Package`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
81
|
-
end
|
79
|
+
|
82
80
|
h[k.to_sym] = v
|
83
81
|
}
|
84
82
|
|
@@ -260,7 +258,7 @@ module ShipEngine
|
|
260
258
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
261
259
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
262
260
|
end
|
263
|
-
|
261
|
+
|
264
262
|
hash[param] = _to_hash(value)
|
265
263
|
end
|
266
264
|
hash
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#ShipEngine API
|
3
3
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
7
7
|
Contact: sales@shipengine.com
|
@@ -66,9 +66,7 @@ module ShipEngine
|
|
66
66
|
|
67
67
|
# check to see if the attribute exists and convert string to symbol for hash key
|
68
68
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
69
|
-
|
70
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `ShipEngine::PackageType`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
71
|
-
end
|
69
|
+
|
72
70
|
h[k.to_sym] = v
|
73
71
|
}
|
74
72
|
|
@@ -249,7 +247,7 @@ module ShipEngine
|
|
249
247
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
250
248
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
251
249
|
end
|
252
|
-
|
250
|
+
|
253
251
|
hash[param] = _to_hash(value)
|
254
252
|
end
|
255
253
|
hash
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#ShipEngine API
|
3
3
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
7
7
|
Contact: sales@shipengine.com
|
@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module ShipEngine
|
16
|
-
# Many ShipEngine endpoints return a paged list of items. In addition to the returned items, these responses also include information about the total number of items, the number of pages of results, and URLs of other pages of results.
|
16
|
+
# Many ShipEngine endpoints return a paged list of items. In addition to the returned items, these responses also include information about the total number of items, the number of pages of results, and URLs of other pages of results.
|
17
17
|
class PagedListResponseBody
|
18
18
|
# The total number of items across all pages of results
|
19
19
|
attr_accessor :total
|
@@ -61,9 +61,7 @@ module ShipEngine
|
|
61
61
|
|
62
62
|
# check to see if the attribute exists and convert string to symbol for hash key
|
63
63
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
64
|
-
|
65
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `ShipEngine::PagedListResponseBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
66
|
-
end
|
64
|
+
|
67
65
|
h[k.to_sym] = v
|
68
66
|
}
|
69
67
|
|
@@ -287,7 +285,7 @@ module ShipEngine
|
|
287
285
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
288
286
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
289
287
|
end
|
290
|
-
|
288
|
+
|
291
289
|
hash[param] = _to_hash(value)
|
292
290
|
end
|
293
291
|
hash
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#ShipEngine API
|
3
3
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
7
7
|
Contact: sales@shipengine.com
|
@@ -15,16 +15,16 @@ require 'date'
|
|
15
15
|
module ShipEngine
|
16
16
|
# Helpful links to other pages of results
|
17
17
|
class PaginationLink
|
18
|
-
# 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.
|
18
|
+
# 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.
|
19
19
|
attr_accessor :first
|
20
20
|
|
21
|
-
# 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.
|
21
|
+
# 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.
|
22
22
|
attr_accessor :last
|
23
23
|
|
24
|
-
# The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.
|
24
|
+
# The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.
|
25
25
|
attr_accessor :prev
|
26
26
|
|
27
|
-
# The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.
|
27
|
+
# The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.
|
28
28
|
attr_accessor :_next
|
29
29
|
|
30
30
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -62,9 +62,7 @@ module ShipEngine
|
|
62
62
|
|
63
63
|
# check to see if the attribute exists and convert string to symbol for hash key
|
64
64
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
65
|
-
|
66
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `ShipEngine::PaginationLink`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
67
|
-
end
|
65
|
+
|
68
66
|
h[k.to_sym] = v
|
69
67
|
}
|
70
68
|
|
@@ -231,7 +229,7 @@ module ShipEngine
|
|
231
229
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
232
230
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
233
231
|
end
|
234
|
-
|
232
|
+
|
235
233
|
hash[param] = _to_hash(value)
|
236
234
|
end
|
237
235
|
hash
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#ShipEngine API
|
3
3
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
7
7
|
Contact: sales@shipengine.com
|
@@ -13,12 +13,12 @@ OpenAPI Generator version: 4.3.1
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module ShipEngine
|
16
|
-
# 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.
|
16
|
+
# 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.
|
17
17
|
class ParseAddressRequestBody
|
18
18
|
# The unstructured text that contains address-related entities
|
19
19
|
attr_accessor :text
|
20
20
|
|
21
|
-
# 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.
|
21
|
+
# 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.
|
22
22
|
attr_accessor :address
|
23
23
|
|
24
24
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -52,9 +52,7 @@ module ShipEngine
|
|
52
52
|
|
53
53
|
# check to see if the attribute exists and convert string to symbol for hash key
|
54
54
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
55
|
-
|
56
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `ShipEngine::ParseAddressRequestBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
57
|
-
end
|
55
|
+
|
58
56
|
h[k.to_sym] = v
|
59
57
|
}
|
60
58
|
|
@@ -215,7 +213,7 @@ module ShipEngine
|
|
215
213
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
216
214
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
217
215
|
end
|
218
|
-
|
216
|
+
|
219
217
|
hash[param] = _to_hash(value)
|
220
218
|
end
|
221
219
|
hash
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#ShipEngine API
|
3
3
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
7
7
|
Contact: sales@shipengine.com
|
@@ -13,15 +13,15 @@ OpenAPI Generator version: 4.3.1
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module ShipEngine
|
16
|
-
# The parsed address, as well as a confidence score and a list of all the entities that were recognized in the text.
|
16
|
+
# The parsed address, as well as a confidence score and a list of all the entities that were recognized in the text.
|
17
17
|
class ParseAddressResponseBody
|
18
|
-
# A confidence score between zero and one that indicates how certain the API is that it understood the text.
|
18
|
+
# A confidence score between zero and one that indicates how certain the API is that it understood the text.
|
19
19
|
attr_accessor :score
|
20
20
|
|
21
|
-
# 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.
|
21
|
+
# 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.
|
22
22
|
attr_accessor :address
|
23
23
|
|
24
|
-
# 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.
|
24
|
+
# 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.
|
25
25
|
attr_accessor :entities
|
26
26
|
|
27
27
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -57,9 +57,7 @@ module ShipEngine
|
|
57
57
|
|
58
58
|
# check to see if the attribute exists and convert string to symbol for hash key
|
59
59
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
60
|
-
|
61
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `ShipEngine::ParseAddressResponseBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
62
|
-
end
|
60
|
+
|
63
61
|
h[k.to_sym] = v
|
64
62
|
}
|
65
63
|
|
@@ -246,7 +244,7 @@ module ShipEngine
|
|
246
244
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
247
245
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
248
246
|
end
|
249
|
-
|
247
|
+
|
250
248
|
hash[param] = _to_hash(value)
|
251
249
|
end
|
252
250
|
hash
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#ShipEngine API
|
3
3
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
7
7
|
Contact: sales@shipengine.com
|
@@ -13,12 +13,12 @@ OpenAPI Generator version: 4.3.1
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module ShipEngine
|
16
|
-
# The only required field is `text`, which is the text to be parsed. You can optionally also provide a `shipment` 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.
|
16
|
+
# The only required field is `text`, which is the text to be parsed. You can optionally also provide a `shipment` 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.
|
17
17
|
class ParseShipmentRequestBody
|
18
18
|
# The unstructured text that contains shipping-related entities
|
19
19
|
attr_accessor :text
|
20
20
|
|
21
|
-
# 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.
|
21
|
+
# 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.
|
22
22
|
attr_accessor :shipment
|
23
23
|
|
24
24
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -52,9 +52,7 @@ module ShipEngine
|
|
52
52
|
|
53
53
|
# check to see if the attribute exists and convert string to symbol for hash key
|
54
54
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
55
|
-
|
56
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `ShipEngine::ParseShipmentRequestBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
57
|
-
end
|
55
|
+
|
58
56
|
h[k.to_sym] = v
|
59
57
|
}
|
60
58
|
|
@@ -215,7 +213,7 @@ module ShipEngine
|
|
215
213
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
216
214
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
217
215
|
end
|
218
|
-
|
216
|
+
|
219
217
|
hash[param] = _to_hash(value)
|
220
218
|
end
|
221
219
|
hash
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#ShipEngine API
|
3
3
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
7
7
|
Contact: sales@shipengine.com
|
@@ -13,15 +13,15 @@ OpenAPI Generator version: 4.3.1
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module ShipEngine
|
16
|
-
# The parsed shipment, as well as a confidence score and a list of all the shipping entities that were recognized in the text.
|
16
|
+
# The parsed shipment, as well as a confidence score and a list of all the shipping entities that were recognized in the text.
|
17
17
|
class ParseShipmentResponseBody
|
18
|
-
# A confidence score between zero and one that indicates how certain the API is that it understood the text.
|
18
|
+
# A confidence score between zero and one that indicates how certain the API is that it understood the text.
|
19
19
|
attr_accessor :score
|
20
20
|
|
21
|
-
# 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.
|
21
|
+
# 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.
|
22
22
|
attr_accessor :shipment
|
23
23
|
|
24
|
-
# 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.
|
24
|
+
# 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.
|
25
25
|
attr_accessor :entities
|
26
26
|
|
27
27
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -57,9 +57,7 @@ module ShipEngine
|
|
57
57
|
|
58
58
|
# check to see if the attribute exists and convert string to symbol for hash key
|
59
59
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
60
|
-
|
61
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `ShipEngine::ParseShipmentResponseBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
62
|
-
end
|
60
|
+
|
63
61
|
h[k.to_sym] = v
|
64
62
|
}
|
65
63
|
|
@@ -246,7 +244,7 @@ module ShipEngine
|
|
246
244
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
247
245
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
248
246
|
end
|
249
|
-
|
247
|
+
|
250
248
|
hash[param] = _to_hash(value)
|
251
249
|
end
|
252
250
|
hash
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#ShipEngine API
|
3
3
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
7
7
|
Contact: sales@shipengine.com
|
@@ -15,33 +15,33 @@ require 'date'
|
|
15
15
|
module ShipEngine
|
16
16
|
# A complete or partial mailing address.
|
17
17
|
class PartialAddress
|
18
|
-
# The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.
|
18
|
+
# The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.
|
19
19
|
attr_accessor :name
|
20
20
|
|
21
|
-
# The phone number of a contact person at this address. The format of this phone number varies depending on the country.
|
21
|
+
# The phone number of a contact person at this address. The format of this phone number varies depending on the country.
|
22
22
|
attr_accessor :phone
|
23
23
|
|
24
|
-
# If this is a business address, then the company name should be specified here.
|
24
|
+
# If this is a business address, then the company name should be specified here.
|
25
25
|
attr_accessor :company_name
|
26
26
|
|
27
|
-
# The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
|
27
|
+
# The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
|
28
28
|
attr_accessor :address_line1
|
29
29
|
|
30
|
-
# The second line of the street address. For some addresses, this line may not be needed.
|
30
|
+
# The second line of the street address. For some addresses, this line may not be needed.
|
31
31
|
attr_accessor :address_line2
|
32
32
|
|
33
|
-
# The third line of the street address. For some addresses, this line may not be needed.
|
33
|
+
# The third line of the street address. For some addresses, this line may not be needed.
|
34
34
|
attr_accessor :address_line3
|
35
35
|
|
36
36
|
# The name of the city or locality
|
37
37
|
attr_accessor :city_locality
|
38
38
|
|
39
|
-
# The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
|
39
|
+
# The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
|
40
40
|
attr_accessor :state_province
|
41
41
|
|
42
42
|
attr_accessor :postal_code
|
43
43
|
|
44
|
-
# The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)
|
44
|
+
# The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)
|
45
45
|
attr_accessor :country_code
|
46
46
|
|
47
47
|
# Indicates whether this is a residential address.
|
@@ -101,9 +101,7 @@ module ShipEngine
|
|
101
101
|
|
102
102
|
# check to see if the attribute exists and convert string to symbol for hash key
|
103
103
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
104
|
-
|
105
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `ShipEngine::PartialAddress`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
106
|
-
end
|
104
|
+
|
107
105
|
h[k.to_sym] = v
|
108
106
|
}
|
109
107
|
|
@@ -405,7 +403,7 @@ module ShipEngine
|
|
405
403
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
406
404
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
407
405
|
end
|
408
|
-
|
406
|
+
|
409
407
|
hash[param] = _to_hash(value)
|
410
408
|
end
|
411
409
|
hash
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#ShipEngine API
|
3
3
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
7
7
|
Contact: sales@shipengine.com
|
@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module ShipEngine
|
16
|
-
# The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.
|
16
|
+
# The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.
|
17
17
|
class PartialShipment
|
18
18
|
# A string that uniquely identifies the shipment
|
19
19
|
attr_accessor :shipment_id
|
@@ -21,19 +21,19 @@ module ShipEngine
|
|
21
21
|
# The carrier account that is billed for the shipping charges
|
22
22
|
attr_accessor :carrier_id
|
23
23
|
|
24
|
-
# 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.
|
24
|
+
# 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.
|
25
25
|
attr_accessor :service_code
|
26
26
|
|
27
27
|
# ID that the Order Source assigned
|
28
28
|
attr_accessor :external_order_id
|
29
29
|
|
30
|
-
# Describe the packages included in this shipment as related to potential metadata that was imported from external order sources
|
30
|
+
# Describe the packages included in this shipment as related to potential metadata that was imported from external order sources
|
31
31
|
attr_accessor :items
|
32
32
|
|
33
|
-
# 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.
|
33
|
+
# 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.
|
34
34
|
attr_accessor :external_shipment_id
|
35
35
|
|
36
|
-
# 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.
|
36
|
+
# 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.
|
37
37
|
attr_accessor :ship_date
|
38
38
|
|
39
39
|
# The date and time that the shipment was created in ShipEngine.
|
@@ -48,33 +48,33 @@ module ShipEngine
|
|
48
48
|
# The recipient's mailing address
|
49
49
|
attr_accessor :ship_to
|
50
50
|
|
51
|
-
# 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.
|
51
|
+
# 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.
|
52
52
|
attr_accessor :ship_from
|
53
53
|
|
54
|
-
# 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.
|
54
|
+
# 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.
|
55
55
|
attr_accessor :warehouse_id
|
56
56
|
|
57
|
-
# The return address for this shipment. Defaults to the `ship_from` address.
|
57
|
+
# The return address for this shipment. Defaults to the `ship_from` address.
|
58
58
|
attr_accessor :return_to
|
59
59
|
|
60
60
|
# The type of delivery confirmation that is required for this shipment.
|
61
61
|
attr_accessor :confirmation
|
62
62
|
|
63
|
-
# Customs information. This is usually only needed for international shipments.
|
63
|
+
# Customs information. This is usually only needed for international shipments.
|
64
64
|
attr_accessor :customs
|
65
65
|
|
66
66
|
# Advanced shipment options. These are entirely optional.
|
67
67
|
attr_accessor :advanced_options
|
68
68
|
|
69
|
-
# The insurance provider to use for any insured packages in the shipment.
|
69
|
+
# The insurance provider to use for any insured packages in the shipment.
|
70
70
|
attr_accessor :insurance_provider
|
71
71
|
|
72
|
-
# Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.
|
72
|
+
# Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.
|
73
73
|
attr_accessor :tags
|
74
74
|
|
75
75
|
attr_accessor :order_source_code
|
76
76
|
|
77
|
-
# 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.
|
77
|
+
# 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.
|
78
78
|
attr_accessor :packages
|
79
79
|
|
80
80
|
# The combined weight of all packages in the shipment
|
@@ -155,9 +155,7 @@ module ShipEngine
|
|
155
155
|
|
156
156
|
# check to see if the attribute exists and convert string to symbol for hash key
|
157
157
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
158
|
-
|
159
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `ShipEngine::PartialShipment`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
160
|
-
end
|
158
|
+
|
161
159
|
h[k.to_sym] = v
|
162
160
|
}
|
163
161
|
|
@@ -415,7 +413,7 @@ module ShipEngine
|
|
415
413
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
416
414
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
417
415
|
end
|
418
|
-
|
416
|
+
|
419
417
|
hash[param] = _to_hash(value)
|
420
418
|
end
|
421
419
|
hash
|