ship_engine 1.0.2 → 1.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +70 -0
- data/README.md +326 -321
- data/docs/AddFundsToCarrierRequestBody.md +4 -3
- data/docs/AddFundsToCarrierResponseBody.md +5 -3
- data/docs/AddFundsToInsuranceRequestBody.md +4 -3
- data/docs/AddFundsToInsuranceResponseBody.md +4 -3
- data/docs/AddToBatchRequestBody.md +4 -3
- data/docs/Address.md +4 -3
- data/docs/AddressResidentialIndicator.md +4 -3
- data/docs/AddressToValidate.md +4 -3
- data/docs/AddressValidatingShipment.md +27 -25
- data/docs/AddressValidationCode.md +4 -3
- data/docs/AddressValidationDetailCode.md +4 -3
- data/docs/AddressValidationMessageType.md +4 -3
- data/docs/AddressValidationResult.md +8 -6
- data/docs/AddressValidationStatus.md +4 -3
- data/docs/AddressesApi.md +22 -16
- data/docs/AdvancedShipmentOptions.md +20 -18
- data/docs/AncillaryServiceEndorsement.md +4 -3
- data/docs/Batch.md +22 -20
- data/docs/BatchResponseError.md +6 -4
- data/docs/BatchStatus.md +4 -3
- data/docs/BatchesApi.md +94 -72
- data/docs/BatchesSortBy.md +4 -3
- data/docs/BillToParty.md +4 -3
- data/docs/BulkRate.md +9 -7
- data/docs/CalculateRatesRequestBody.md +4 -3
- data/docs/CalculateRatesResponseBody.md +27 -25
- data/docs/Carrier.md +17 -15
- data/docs/CarrierAccountsApi.md +39 -29
- data/docs/CarrierAdvancedOption.md +7 -5
- data/docs/CarrierName.md +4 -3
- data/docs/CarrierNameWithSettings.md +4 -3
- data/docs/CarriersApi.md +44 -31
- data/docs/CollectOnDelivery.md +6 -4
- data/docs/CollectOnDeliveryPaymentType.md +4 -3
- data/docs/CompareBulkRatesRequestBody.md +4 -3
- data/docs/ConnectAccessWorldwideRequestBody.md +7 -5
- data/docs/ConnectAmazonBuyShippingRequestBody.md +8 -6
- data/docs/ConnectApcRequestBody.md +7 -5
- data/docs/ConnectAsendiaRequestBody.md +8 -6
- data/docs/ConnectAustraliaPostRequestBody.md +8 -6
- data/docs/ConnectCanadaPostRequestBody.md +9 -7
- data/docs/ConnectCarrierRequestBody.md +53 -51
- data/docs/ConnectCarrierResponseBody.md +5 -3
- data/docs/ConnectDhlEcommerceRequestBody.md +16 -14
- data/docs/ConnectDhlExpressAuRequestBody.md +6 -4
- data/docs/ConnectDhlExpressCaRequestBody.md +6 -4
- data/docs/ConnectDhlExpressRequestBody.md +6 -4
- data/docs/ConnectDhlExpressUkRequestBody.md +8 -6
- data/docs/ConnectDpdRequestBody.md +7 -5
- data/docs/ConnectEndiciaRequestBody.md +7 -5
- data/docs/ConnectFedexRequestBody.md +19 -17
- data/docs/ConnectFedexUkRequestBody.md +19 -17
- data/docs/ConnectFirstmileRequestBody.md +8 -6
- data/docs/ConnectGlobegisticsRequestBody.md +7 -5
- data/docs/ConnectImexRequestBody.md +7 -5
- data/docs/ConnectInsurerRequestBody.md +6 -4
- data/docs/ConnectNewgisticsRequestBody.md +8 -6
- data/docs/ConnectOntracRequestBody.md +7 -5
- data/docs/ConnectPurolatorRequestBody.md +7 -5
- data/docs/ConnectRoyalMailRequestBody.md +16 -14
- data/docs/ConnectRrDonnelleyRequestBody.md +7 -5
- data/docs/ConnectSekoRequestBody.md +6 -4
- data/docs/ConnectSendleRequestBody.md +7 -5
- data/docs/ConnectStampsRequestBody.md +7 -5
- data/docs/ConnectUpsRequestBody.md +22 -20
- data/docs/CreateAndValidateShipment.md +28 -26
- data/docs/CreateBatchRequestBody.md +8 -6
- data/docs/CreateBatchResponseBody.md +4 -3
- data/docs/CreateLabelFromRateRequestBody.md +4 -3
- data/docs/CreateLabelFromRateResponseBody.md +4 -3
- data/docs/CreateLabelFromShipmentRequestBody.md +8 -6
- data/docs/CreateLabelFromShipmentResponseBody.md +4 -3
- data/docs/CreateLabelRequestBody.md +4 -3
- data/docs/CreateLabelResponseBody.md +4 -3
- data/docs/CreateManifestByObjectRequestBody.md +9 -7
- data/docs/CreateManifestLabelIdsRequestBody.md +5 -3
- data/docs/CreateManifestRequestBody.md +9 -7
- data/docs/CreateManifestResponseBody.md +14 -12
- data/docs/CreatePackageTypeRequestBody.md +4 -3
- data/docs/CreatePackageTypeResponseBody.md +4 -3
- data/docs/CreateReturnLabelRequestBody.md +9 -7
- data/docs/CreateReturnLabelResponseBody.md +4 -3
- data/docs/CreateShipmentResponseBodyFields.md +6 -4
- data/docs/CreateShipmentsRequestBody.md +5 -3
- data/docs/CreateShipmentsResponseBody.md +6 -4
- data/docs/CreateTagResponseBody.md +4 -3
- data/docs/CreateWarehouseRequestBody.md +4 -3
- data/docs/CreateWarehouseResponseBody.md +4 -3
- data/docs/CreateWebhookRequestBody.md +6 -4
- data/docs/CreateWebhookResponseBody.md +4 -3
- data/docs/Currency.md +4 -3
- data/docs/CustomsItem.md +13 -11
- data/docs/DeliveryConfirmation.md +4 -3
- data/docs/DeprecatedManifest.md +13 -11
- data/docs/DhlExpressAccountSettings.md +7 -5
- data/docs/DhlExpressSettingsResponseBody.md +4 -3
- data/docs/DimensionUnit.md +4 -3
- data/docs/Dimensions.md +8 -6
- data/docs/DownloadsApi.md +18 -14
- data/docs/Error.md +8 -6
- data/docs/ErrorCode.md +4 -3
- data/docs/ErrorResponseBody.md +6 -4
- data/docs/ErrorSource.md +4 -3
- data/docs/ErrorType.md +4 -3
- data/docs/EstimateRatesRequestBody.md +4 -3
- data/docs/FedexAccountSettings.md +9 -7
- data/docs/FedexAccountSettingsRequestBody.md +4 -3
- data/docs/FedexPickupType.md +4 -3
- data/docs/FedexSettingsResponseBody.md +4 -3
- data/docs/GetBatchByExternalIdResponseBody.md +4 -3
- data/docs/GetBatchByIdResponseBody.md +4 -3
- data/docs/GetCarrierByIdResponseBody.md +4 -3
- data/docs/GetCarrierOptionsResponseBody.md +5 -3
- data/docs/GetCarrierSettingsResponseBody.md +19 -17
- data/docs/GetCarriersResponseBody.md +7 -5
- data/docs/GetInsuranceBalanceResponseBody.md +4 -3
- data/docs/GetLabelByExternalShipmentIdResponseBody.md +4 -3
- data/docs/GetLabelByIdResponseBody.md +4 -3
- data/docs/GetManifestByIdResponseBody.md +4 -3
- data/docs/GetPackageTypeByIdResponseBody.md +4 -3
- data/docs/GetRateByIdResponseBody.md +4 -3
- data/docs/GetShipmentByExternalIdResponseBody.md +4 -3
- data/docs/GetShipmentByIdResponseBody.md +4 -3
- data/docs/GetTrackingLogFromLabelResponseBody.md +4 -3
- data/docs/GetTrackingLogResponseBody.md +4 -3
- data/docs/GetWarehouseByIdResponseBody.md +4 -3
- data/docs/GetWebhookByIdResponseBody.md +4 -3
- data/docs/InsuranceApi.md +27 -19
- data/docs/InsuranceProvider.md +4 -3
- data/docs/InternationalShipmentOptions.md +7 -5
- data/docs/Label.md +37 -35
- data/docs/LabelChargeEvent.md +4 -3
- data/docs/LabelDownload.md +8 -6
- data/docs/LabelDownloadType.md +4 -3
- data/docs/LabelFormat.md +4 -3
- data/docs/LabelLayout.md +4 -3
- data/docs/LabelMessages.md +7 -5
- data/docs/LabelStatus.md +4 -3
- data/docs/LabelsApi.md +97 -77
- data/docs/Link.md +4 -3
- data/docs/ListBatchErrorsResponseBody.md +6 -4
- data/docs/ListBatchesResponseBody.md +9 -7
- data/docs/ListCarrierPackageTypesResponseBody.md +5 -3
- data/docs/ListCarrierServicesResponseBody.md +5 -3
- data/docs/ListCarriersResponseBody.md +5 -3
- data/docs/ListLabelsResponseBody.md +5 -3
- data/docs/ListManifestsResponseBody.md +9 -7
- data/docs/ListPackageTypesResponseBody.md +5 -3
- data/docs/ListShipmentErrorsResponseBody.md +6 -4
- data/docs/ListShipmentRatesResponseBody.md +4 -3
- data/docs/ListShipmentsResponseBody.md +9 -7
- data/docs/ListTagsResponseBody.md +5 -3
- data/docs/ListWarehousesResponseBody.md +5 -3
- data/docs/Manifest.md +13 -11
- data/docs/ManifestDownload.md +5 -3
- data/docs/Manifests.md +5 -3
- data/docs/ManifestsApi.md +37 -29
- data/docs/ModifyBatch.md +6 -4
- data/docs/MonetaryValue.md +6 -4
- data/docs/NonDelivery.md +4 -3
- data/docs/OptionalLink.md +6 -4
- data/docs/OrderSourceName.md +4 -3
- data/docs/Package.md +11 -9
- data/docs/PackageContents.md +4 -3
- data/docs/PackageType.md +9 -7
- data/docs/PackageTypesApi.md +38 -27
- data/docs/PagedListResponseBody.md +8 -6
- data/docs/PaginationLink.md +8 -6
- data/docs/ParseAddressRequestBody.md +6 -4
- data/docs/ParseAddressResponseBody.md +7 -5
- data/docs/ParseShipmentRequestBody.md +6 -4
- data/docs/ParseShipmentResponseBody.md +7 -5
- data/docs/PartialAddress.md +15 -13
- data/docs/PartialShipment.md +26 -24
- data/docs/PaymentAmount.md +6 -4
- data/docs/ProcessBatchRequestBody.md +7 -5
- data/docs/PurchaseLabelWithoutShipment.md +8 -6
- data/docs/Rate.md +29 -27
- data/docs/RateEstimateByCarrierId.md +5 -3
- data/docs/RateEstimateByCarrierIds.md +5 -3
- data/docs/RateEstimateOptions.md +17 -15
- data/docs/RateRequestBody.md +9 -7
- data/docs/RateRequestByShipmentIds.md +5 -3
- data/docs/RateRequestByShipments.md +5 -3
- data/docs/RateRequestOptions.md +5 -3
- data/docs/RateRequestRateOptions.md +5 -3
- data/docs/RateResponse.md +5 -3
- data/docs/RateResponseStatus.md +4 -3
- data/docs/RateType.md +4 -3
- data/docs/RatesApi.md +36 -26
- data/docs/RatesInformation.md +11 -9
- data/docs/RecognizedEntity.md +10 -8
- data/docs/RemoveFromBatchRequestBody.md +4 -3
- data/docs/ResponseMessage.md +8 -6
- data/docs/Service.md +11 -9
- data/docs/Shipment.md +4 -3
- data/docs/ShipmentIdRequest.md +5 -3
- data/docs/ShipmentItem.md +13 -11
- data/docs/ShipmentRequest.md +5 -3
- data/docs/ShipmentResponseError.md +7 -5
- data/docs/ShipmentStatus.md +4 -3
- data/docs/ShipmentsApi.md +112 -88
- data/docs/ShipmentsSortBy.md +4 -3
- data/docs/SmartPostHub.md +4 -3
- data/docs/SortDir.md +4 -3
- data/docs/Tag.md +5 -3
- data/docs/TagShipmentResponseBody.md +6 -4
- data/docs/TagsApi.md +33 -24
- data/docs/TrackEvent.md +16 -14
- data/docs/TrackingApi.md +29 -21
- data/docs/TrackingInformation.md +14 -12
- data/docs/TrackingStatus.md +4 -3
- data/docs/UpdateAmazonBuyShippingRequestBody.md +5 -3
- data/docs/UpdateCarrierSettingsRequestBody.md +22 -20
- data/docs/UpdateDhlExpressSettingsRequestBody.md +4 -3
- data/docs/UpdateFedexSettingsRequestBody.md +4 -3
- data/docs/UpdateNewgisticsSettingsRequestBody.md +6 -4
- data/docs/UpdatePackageTypeRequestBody.md +4 -3
- data/docs/UpdateShipmentFields.md +5 -3
- data/docs/UpdateShipmentRequestBody.md +27 -25
- data/docs/UpdateShipmentResponseBody.md +4 -3
- data/docs/UpdateUpsSettingsRequestBody.md +4 -3
- data/docs/UpdateWarehouseRequestBody.md +4 -3
- data/docs/UpdateWebhookRequestBody.md +5 -3
- data/docs/UpsAccountSettings.md +16 -14
- data/docs/UpsInvoice.md +8 -6
- data/docs/UpsPickupType.md +4 -3
- data/docs/UpsSettingsResponseBody.md +4 -3
- data/docs/ValidateAddress.md +4 -3
- data/docs/ValidateShipmentFields.md +5 -3
- data/docs/ValidationStatus.md +4 -3
- data/docs/VoidLabelResponseBody.md +6 -4
- data/docs/Warehouse.md +9 -7
- data/docs/WarehousesApi.md +39 -28
- data/docs/Webhook.md +7 -5
- data/docs/WebhookEvent.md +4 -3
- data/docs/WebhooksApi.md +38 -27
- data/docs/Weight.md +6 -4
- data/docs/WeightUnit.md +4 -3
- data/lib/ship_engine.rb +25 -25
- data/lib/ship_engine/api/addresses_api.rb +13 -13
- data/lib/ship_engine/api/batches_api.rb +41 -41
- data/lib/ship_engine/api/carrier_accounts_api.rb +13 -13
- data/lib/ship_engine/api/carriers_api.rb +15 -15
- data/lib/ship_engine/api/downloads_api.rb +11 -11
- data/lib/ship_engine/api/insurance_api.rb +15 -15
- data/lib/ship_engine/api/labels_api.rb +42 -42
- data/lib/ship_engine/api/manifests_api.rb +14 -14
- data/lib/ship_engine/api/package_types_api.rb +15 -15
- data/lib/ship_engine/api/rates_api.rb +17 -17
- data/lib/ship_engine/api/shipments_api.rb +49 -49
- data/lib/ship_engine/api/tags_api.rb +17 -17
- data/lib/ship_engine/api/tracking_api.rb +9 -9
- data/lib/ship_engine/api/warehouses_api.rb +17 -17
- data/lib/ship_engine/api/webhooks_api.rb +15 -15
- data/lib/ship_engine/api_client.rb +1 -1
- data/lib/ship_engine/api_error.rb +1 -1
- data/lib/ship_engine/configuration.rb +1 -1
- data/lib/ship_engine/models/add_funds_to_carrier_request_body.rb +2 -2
- data/lib/ship_engine/models/add_funds_to_carrier_response_body.rb +2 -2
- data/lib/ship_engine/models/add_funds_to_insurance_request_body.rb +2 -2
- data/lib/ship_engine/models/add_funds_to_insurance_response_body.rb +2 -2
- data/lib/ship_engine/models/add_to_batch_request_body.rb +2 -2
- data/lib/ship_engine/models/address.rb +3 -3
- data/lib/ship_engine/models/address_residential_indicator.rb +1 -1
- data/lib/ship_engine/models/address_to_validate.rb +3 -3
- data/lib/ship_engine/models/address_validating_shipment.rb +13 -13
- data/lib/ship_engine/models/address_validation_code.rb +1 -1
- data/lib/ship_engine/models/address_validation_detail_code.rb +1 -1
- data/lib/ship_engine/models/address_validation_message_type.rb +1 -1
- data/lib/ship_engine/models/address_validation_result.rb +2 -2
- data/lib/ship_engine/models/address_validation_status.rb +1 -1
- data/lib/ship_engine/models/advanced_shipment_options.rb +13 -13
- data/lib/ship_engine/models/ancillary_service_endorsement.rb +1 -1
- data/lib/ship_engine/models/batch.rb +3 -3
- data/lib/ship_engine/models/batch_response_error.rb +2 -2
- data/lib/ship_engine/models/batch_status.rb +1 -1
- data/lib/ship_engine/models/batches_sort_by.rb +1 -1
- data/lib/ship_engine/models/bill_to_party.rb +1 -1
- data/lib/ship_engine/models/bulk_rate.rb +2 -2
- data/lib/ship_engine/models/calculate_rates_request_body.rb +2 -2
- data/lib/ship_engine/models/calculate_rates_response_body.rb +13 -13
- data/lib/ship_engine/models/carrier.rb +3 -3
- data/lib/ship_engine/models/carrier_advanced_option.rb +2 -2
- data/lib/ship_engine/models/carrier_name.rb +1 -1
- data/lib/ship_engine/models/carrier_name_with_settings.rb +1 -1
- data/lib/ship_engine/models/collect_on_delivery.rb +2 -2
- data/lib/ship_engine/models/collect_on_delivery_payment_type.rb +1 -1
- data/lib/ship_engine/models/compare_bulk_rates_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_access_worldwide_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_amazon_buy_shipping_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_apc_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_asendia_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_australia_post_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_canada_post_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_carrier_request_body.rb +3 -3
- data/lib/ship_engine/models/connect_carrier_response_body.rb +2 -2
- data/lib/ship_engine/models/connect_dhl_ecommerce_request_body.rb +4 -4
- data/lib/ship_engine/models/connect_dhl_express_au_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_dhl_express_ca_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_dhl_express_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_dhl_express_uk_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_dpd_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_endicia_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_fedex_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_fedex_uk_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_firstmile_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_globegistics_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_imex_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_insurer_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_newgistics_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_ontrac_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_purolator_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_royal_mail_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_rr_donnelley_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_seko_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_sendle_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_stamps_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_ups_request_body.rb +2 -2
- data/lib/ship_engine/models/create_and_validate_shipment.rb +13 -13
- data/lib/ship_engine/models/create_batch_request_body.rb +2 -2
- data/lib/ship_engine/models/create_batch_response_body.rb +2 -2
- data/lib/ship_engine/models/create_label_from_rate_request_body.rb +2 -2
- data/lib/ship_engine/models/create_label_from_rate_response_body.rb +2 -2
- data/lib/ship_engine/models/create_label_from_shipment_request_body.rb +2 -2
- data/lib/ship_engine/models/create_label_from_shipment_response_body.rb +2 -2
- data/lib/ship_engine/models/create_label_request_body.rb +2 -2
- data/lib/ship_engine/models/create_label_response_body.rb +2 -2
- data/lib/ship_engine/models/create_manifest_by_object_request_body.rb +2 -2
- data/lib/ship_engine/models/create_manifest_label_ids_request_body.rb +2 -2
- data/lib/ship_engine/models/create_manifest_request_body.rb +2 -2
- data/lib/ship_engine/models/create_manifest_response_body.rb +2 -2
- data/lib/ship_engine/models/create_package_type_request_body.rb +2 -2
- data/lib/ship_engine/models/create_package_type_response_body.rb +2 -2
- data/lib/ship_engine/models/create_return_label_request_body.rb +5 -5
- data/lib/ship_engine/models/create_return_label_response_body.rb +2 -2
- data/lib/ship_engine/models/create_shipment_response_body_fields.rb +2 -2
- data/lib/ship_engine/models/create_shipments_request_body.rb +2 -2
- data/lib/ship_engine/models/create_shipments_response_body.rb +2 -2
- data/lib/ship_engine/models/create_tag_response_body.rb +2 -2
- data/lib/ship_engine/models/create_warehouse_request_body.rb +2 -2
- data/lib/ship_engine/models/create_warehouse_response_body.rb +2 -2
- data/lib/ship_engine/models/create_webhook_request_body.rb +2 -2
- data/lib/ship_engine/models/create_webhook_response_body.rb +2 -2
- data/lib/ship_engine/models/currency.rb +1 -1
- data/lib/ship_engine/models/customs_item.rb +3 -3
- data/lib/ship_engine/models/delivery_confirmation.rb +1 -1
- data/lib/ship_engine/models/deprecated_manifest.rb +2 -2
- data/lib/ship_engine/models/dhl_express_account_settings.rb +2 -2
- data/lib/ship_engine/models/dhl_express_settings_response_body.rb +2 -2
- data/lib/ship_engine/models/dimension_unit.rb +1 -1
- data/lib/ship_engine/models/dimensions.rb +2 -2
- data/lib/ship_engine/models/error.rb +3 -3
- data/lib/ship_engine/models/error_code.rb +1 -1
- data/lib/ship_engine/models/error_response_body.rb +3 -3
- data/lib/ship_engine/models/error_source.rb +1 -1
- data/lib/ship_engine/models/error_type.rb +1 -1
- data/lib/ship_engine/models/estimate_rates_request_body.rb +2 -2
- data/lib/ship_engine/models/fedex_account_settings.rb +2 -2
- data/lib/ship_engine/models/fedex_account_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/fedex_pickup_type.rb +1 -1
- data/lib/ship_engine/models/fedex_settings_response_body.rb +2 -2
- data/lib/ship_engine/models/get_batch_by_external_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_batch_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_carrier_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_carrier_options_response_body.rb +2 -2
- data/lib/ship_engine/models/get_carrier_settings_response_body.rb +2 -2
- data/lib/ship_engine/models/get_carriers_response_body.rb +3 -3
- data/lib/ship_engine/models/get_insurance_balance_response_body.rb +2 -2
- data/lib/ship_engine/models/get_label_by_external_shipment_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_label_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_manifest_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_package_type_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_rate_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_shipment_by_external_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_shipment_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_tracking_log_from_label_response_body.rb +2 -2
- data/lib/ship_engine/models/get_tracking_log_response_body.rb +2 -2
- data/lib/ship_engine/models/get_warehouse_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_webhook_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/insurance_provider.rb +1 -1
- data/lib/ship_engine/models/international_shipment_options.rb +2 -2
- data/lib/ship_engine/models/label.rb +26 -26
- data/lib/ship_engine/models/label_charge_event.rb +1 -1
- data/lib/ship_engine/models/label_download.rb +3 -3
- data/lib/ship_engine/models/label_download_type.rb +1 -1
- data/lib/ship_engine/models/label_format.rb +1 -1
- data/lib/ship_engine/models/label_layout.rb +1 -1
- data/lib/ship_engine/models/label_messages.rb +6 -6
- data/lib/ship_engine/models/label_status.rb +1 -1
- data/lib/ship_engine/models/link.rb +2 -2
- data/lib/ship_engine/models/list_batch_errors_response_body.rb +2 -2
- data/lib/ship_engine/models/list_batches_response_body.rb +2 -2
- data/lib/ship_engine/models/list_carrier_package_types_response_body.rb +2 -2
- data/lib/ship_engine/models/list_carrier_services_response_body.rb +2 -2
- data/lib/ship_engine/models/list_carriers_response_body.rb +2 -2
- data/lib/ship_engine/models/list_labels_response_body.rb +3 -3
- data/lib/ship_engine/models/list_manifests_response_body.rb +2 -2
- data/lib/ship_engine/models/list_package_types_response_body.rb +2 -2
- data/lib/ship_engine/models/list_shipment_errors_response_body.rb +2 -2
- data/lib/ship_engine/models/list_shipment_rates_response_body.rb +2 -2
- data/lib/ship_engine/models/list_shipments_response_body.rb +2 -2
- data/lib/ship_engine/models/list_tags_response_body.rb +2 -2
- data/lib/ship_engine/models/list_warehouses_response_body.rb +2 -2
- data/lib/ship_engine/models/manifest.rb +3 -3
- data/lib/ship_engine/models/manifest_download.rb +2 -2
- data/lib/ship_engine/models/manifests.rb +2 -2
- data/lib/ship_engine/models/modify_batch.rb +2 -2
- data/lib/ship_engine/models/monetary_value.rb +3 -3
- data/lib/ship_engine/models/non_delivery.rb +1 -1
- data/lib/ship_engine/models/optional_link.rb +2 -2
- data/lib/ship_engine/models/order_source_name.rb +1 -1
- data/lib/ship_engine/models/package.rb +5 -5
- data/lib/ship_engine/models/package_contents.rb +1 -1
- data/lib/ship_engine/models/package_type.rb +2 -2
- data/lib/ship_engine/models/paged_list_response_body.rb +3 -3
- data/lib/ship_engine/models/pagination_link.rb +6 -6
- data/lib/ship_engine/models/parse_address_request_body.rb +4 -4
- data/lib/ship_engine/models/parse_address_response_body.rb +6 -6
- data/lib/ship_engine/models/parse_shipment_request_body.rb +4 -4
- data/lib/ship_engine/models/parse_shipment_response_body.rb +6 -6
- data/lib/ship_engine/models/partial_address.rb +10 -10
- data/lib/ship_engine/models/partial_shipment.rb +14 -14
- data/lib/ship_engine/models/payment_amount.rb +2 -2
- data/lib/ship_engine/models/process_batch_request_body.rb +2 -2
- data/lib/ship_engine/models/purchase_label_without_shipment.rb +2 -2
- data/lib/ship_engine/models/rate.rb +4 -4
- data/lib/ship_engine/models/rate_estimate_by_carrier_id.rb +2 -2
- data/lib/ship_engine/models/rate_estimate_by_carrier_ids.rb +2 -2
- data/lib/ship_engine/models/rate_estimate_options.rb +2 -2
- data/lib/ship_engine/models/rate_request_body.rb +2 -2
- data/lib/ship_engine/models/rate_request_by_shipment_ids.rb +2 -2
- data/lib/ship_engine/models/rate_request_by_shipments.rb +2 -2
- data/lib/ship_engine/models/rate_request_options.rb +2 -2
- data/lib/ship_engine/models/rate_request_rate_options.rb +2 -2
- data/lib/ship_engine/models/rate_response.rb +2 -2
- data/lib/ship_engine/models/rate_response_status.rb +1 -1
- data/lib/ship_engine/models/rate_type.rb +1 -1
- data/lib/ship_engine/models/rates_information.rb +2 -2
- data/lib/ship_engine/models/recognized_entity.rb +5 -5
- data/lib/ship_engine/models/remove_from_batch_request_body.rb +2 -2
- data/lib/ship_engine/models/response_message.rb +2 -2
- data/lib/ship_engine/models/service.rb +2 -2
- data/lib/ship_engine/models/shipment.rb +3 -3
- data/lib/ship_engine/models/shipment_id_request.rb +2 -2
- data/lib/ship_engine/models/shipment_item.rb +2 -2
- data/lib/ship_engine/models/shipment_request.rb +2 -2
- data/lib/ship_engine/models/shipment_response_error.rb +2 -2
- data/lib/ship_engine/models/shipment_status.rb +1 -1
- data/lib/ship_engine/models/shipments_sort_by.rb +1 -1
- data/lib/ship_engine/models/smart_post_hub.rb +1 -1
- data/lib/ship_engine/models/sort_dir.rb +1 -1
- data/lib/ship_engine/models/tag.rb +3 -3
- data/lib/ship_engine/models/tag_shipment_response_body.rb +2 -2
- data/lib/ship_engine/models/track_event.rb +2 -2
- data/lib/ship_engine/models/tracking_information.rb +2 -2
- data/lib/ship_engine/models/tracking_status.rb +1 -1
- data/lib/ship_engine/models/update_amazon_buy_shipping_request_body.rb +2 -2
- data/lib/ship_engine/models/update_carrier_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/update_dhl_express_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/update_fedex_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/update_newgistics_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/update_package_type_request_body.rb +2 -2
- data/lib/ship_engine/models/update_shipment_fields.rb +2 -2
- data/lib/ship_engine/models/update_shipment_request_body.rb +13 -13
- data/lib/ship_engine/models/update_shipment_response_body.rb +2 -2
- data/lib/ship_engine/models/update_ups_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/update_warehouse_request_body.rb +2 -2
- data/lib/ship_engine/models/update_webhook_request_body.rb +2 -2
- data/lib/ship_engine/models/ups_account_settings.rb +2 -2
- data/lib/ship_engine/models/ups_invoice.rb +2 -2
- data/lib/ship_engine/models/ups_pickup_type.rb +1 -1
- data/lib/ship_engine/models/ups_settings_response_body.rb +2 -2
- data/lib/ship_engine/models/validate_address.rb +1 -1
- data/lib/ship_engine/models/validate_shipment_fields.rb +2 -2
- data/lib/ship_engine/models/validation_status.rb +1 -1
- data/lib/ship_engine/models/void_label_response_body.rb +2 -2
- data/lib/ship_engine/models/warehouse.rb +2 -2
- data/lib/ship_engine/models/webhook.rb +2 -2
- data/lib/ship_engine/models/webhook_event.rb +1 -1
- data/lib/ship_engine/models/weight.rb +2 -2
- data/lib/ship_engine/models/weight_unit.rb +1 -1
- data/lib/ship_engine/version.rb +2 -2
- data/ship_engine.gemspec +1 -1
- data/spec/api/addresses_api_spec.rb +5 -5
- data/spec/api/batches_api_spec.rb +12 -12
- data/spec/api/carrier_accounts_api_spec.rb +3 -3
- data/spec/api/carriers_api_spec.rb +2 -2
- data/spec/api/downloads_api_spec.rb +5 -5
- data/spec/api/insurance_api_spec.rb +4 -4
- data/spec/api/labels_api_spec.rb +13 -13
- data/spec/api/manifests_api_spec.rb +5 -5
- data/spec/api/package_types_api_spec.rb +3 -3
- data/spec/api/rates_api_spec.rb +5 -5
- data/spec/api/shipments_api_spec.rb +15 -15
- data/spec/api/tags_api_spec.rb +5 -5
- data/spec/api/tracking_api_spec.rb +2 -2
- data/spec/api/warehouses_api_spec.rb +4 -4
- data/spec/api/webhooks_api_spec.rb +3 -3
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/add_funds_to_carrier_request_body_spec.rb +1 -1
- data/spec/models/add_funds_to_carrier_response_body_spec.rb +1 -1
- data/spec/models/add_funds_to_insurance_request_body_spec.rb +1 -1
- data/spec/models/add_funds_to_insurance_response_body_spec.rb +1 -1
- data/spec/models/add_to_batch_request_body_spec.rb +1 -1
- data/spec/models/address_residential_indicator_spec.rb +1 -1
- data/spec/models/address_spec.rb +1 -1
- data/spec/models/address_to_validate_spec.rb +1 -1
- data/spec/models/address_validating_shipment_spec.rb +1 -1
- data/spec/models/address_validation_code_spec.rb +1 -1
- data/spec/models/address_validation_detail_code_spec.rb +1 -1
- data/spec/models/address_validation_message_type_spec.rb +1 -1
- data/spec/models/address_validation_result_spec.rb +1 -1
- data/spec/models/address_validation_status_spec.rb +1 -1
- data/spec/models/advanced_shipment_options_spec.rb +1 -1
- data/spec/models/ancillary_service_endorsement_spec.rb +1 -1
- data/spec/models/batch_response_error_spec.rb +1 -1
- data/spec/models/batch_spec.rb +1 -1
- data/spec/models/batch_status_spec.rb +1 -1
- data/spec/models/batches_sort_by_spec.rb +1 -1
- data/spec/models/bill_to_party_spec.rb +1 -1
- data/spec/models/bulk_rate_spec.rb +1 -1
- data/spec/models/calculate_rates_request_body_spec.rb +1 -1
- data/spec/models/calculate_rates_response_body_spec.rb +1 -1
- data/spec/models/carrier_advanced_option_spec.rb +1 -1
- data/spec/models/carrier_name_spec.rb +1 -1
- data/spec/models/carrier_name_with_settings_spec.rb +1 -1
- data/spec/models/carrier_spec.rb +1 -1
- data/spec/models/collect_on_delivery_payment_type_spec.rb +1 -1
- data/spec/models/collect_on_delivery_spec.rb +1 -1
- data/spec/models/compare_bulk_rates_request_body_spec.rb +1 -1
- data/spec/models/connect_access_worldwide_request_body_spec.rb +1 -1
- data/spec/models/connect_amazon_buy_shipping_request_body_spec.rb +1 -1
- data/spec/models/connect_apc_request_body_spec.rb +1 -1
- data/spec/models/connect_asendia_request_body_spec.rb +1 -1
- data/spec/models/connect_australia_post_request_body_spec.rb +1 -1
- data/spec/models/connect_canada_post_request_body_spec.rb +1 -1
- data/spec/models/connect_carrier_request_body_spec.rb +1 -1
- data/spec/models/connect_carrier_response_body_spec.rb +1 -1
- data/spec/models/connect_dhl_ecommerce_request_body_spec.rb +1 -1
- data/spec/models/connect_dhl_express_au_request_body_spec.rb +1 -1
- data/spec/models/connect_dhl_express_ca_request_body_spec.rb +1 -1
- data/spec/models/connect_dhl_express_request_body_spec.rb +1 -1
- data/spec/models/connect_dhl_express_uk_request_body_spec.rb +1 -1
- data/spec/models/connect_dpd_request_body_spec.rb +1 -1
- data/spec/models/connect_endicia_request_body_spec.rb +1 -1
- data/spec/models/connect_fedex_request_body_spec.rb +1 -1
- data/spec/models/connect_fedex_uk_request_body_spec.rb +1 -1
- data/spec/models/connect_firstmile_request_body_spec.rb +1 -1
- data/spec/models/connect_globegistics_request_body_spec.rb +1 -1
- data/spec/models/connect_imex_request_body_spec.rb +1 -1
- data/spec/models/connect_insurer_request_body_spec.rb +1 -1
- data/spec/models/connect_newgistics_request_body_spec.rb +1 -1
- data/spec/models/connect_ontrac_request_body_spec.rb +1 -1
- data/spec/models/connect_purolator_request_body_spec.rb +1 -1
- data/spec/models/connect_royal_mail_request_body_spec.rb +1 -1
- data/spec/models/connect_rr_donnelley_request_body_spec.rb +1 -1
- data/spec/models/connect_seko_request_body_spec.rb +1 -1
- data/spec/models/connect_sendle_request_body_spec.rb +1 -1
- data/spec/models/connect_stamps_request_body_spec.rb +1 -1
- data/spec/models/connect_ups_request_body_spec.rb +1 -1
- data/spec/models/create_and_validate_shipment_spec.rb +1 -1
- data/spec/models/create_batch_request_body_spec.rb +1 -1
- data/spec/models/create_batch_response_body_spec.rb +1 -1
- data/spec/models/create_label_from_rate_request_body_spec.rb +1 -1
- data/spec/models/create_label_from_rate_response_body_spec.rb +1 -1
- data/spec/models/create_label_from_shipment_request_body_spec.rb +1 -1
- data/spec/models/create_label_from_shipment_response_body_spec.rb +1 -1
- data/spec/models/create_label_request_body_spec.rb +1 -1
- data/spec/models/create_label_response_body_spec.rb +1 -1
- data/spec/models/create_manifest_by_object_request_body_spec.rb +1 -1
- data/spec/models/create_manifest_label_ids_request_body_spec.rb +1 -1
- data/spec/models/create_manifest_request_body_spec.rb +1 -1
- data/spec/models/create_manifest_response_body_spec.rb +1 -1
- data/spec/models/create_package_type_request_body_spec.rb +1 -1
- data/spec/models/create_package_type_response_body_spec.rb +1 -1
- data/spec/models/create_return_label_request_body_spec.rb +1 -1
- data/spec/models/create_return_label_response_body_spec.rb +1 -1
- data/spec/models/create_shipment_response_body_fields_spec.rb +1 -1
- data/spec/models/create_shipments_request_body_spec.rb +1 -1
- data/spec/models/create_shipments_response_body_spec.rb +1 -1
- data/spec/models/create_tag_response_body_spec.rb +1 -1
- data/spec/models/create_warehouse_request_body_spec.rb +1 -1
- data/spec/models/create_warehouse_response_body_spec.rb +1 -1
- data/spec/models/create_webhook_request_body_spec.rb +1 -1
- data/spec/models/create_webhook_response_body_spec.rb +1 -1
- data/spec/models/currency_spec.rb +1 -1
- data/spec/models/customs_item_spec.rb +1 -1
- data/spec/models/delivery_confirmation_spec.rb +1 -1
- data/spec/models/deprecated_manifest_spec.rb +1 -1
- data/spec/models/dhl_express_account_settings_spec.rb +1 -1
- data/spec/models/dhl_express_settings_response_body_spec.rb +1 -1
- data/spec/models/dimension_unit_spec.rb +1 -1
- data/spec/models/dimensions_spec.rb +1 -1
- data/spec/models/error_code_spec.rb +1 -1
- data/spec/models/error_response_body_spec.rb +1 -1
- data/spec/models/error_source_spec.rb +1 -1
- data/spec/models/error_spec.rb +1 -1
- data/spec/models/error_type_spec.rb +1 -1
- data/spec/models/estimate_rates_request_body_spec.rb +1 -1
- data/spec/models/fedex_account_settings_request_body_spec.rb +1 -1
- data/spec/models/fedex_account_settings_spec.rb +1 -1
- data/spec/models/fedex_pickup_type_spec.rb +1 -1
- data/spec/models/fedex_settings_response_body_spec.rb +1 -1
- data/spec/models/get_batch_by_external_id_response_body_spec.rb +1 -1
- data/spec/models/get_batch_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_carrier_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_carrier_options_response_body_spec.rb +1 -1
- data/spec/models/get_carrier_settings_response_body_spec.rb +1 -1
- data/spec/models/get_carriers_response_body_spec.rb +1 -1
- data/spec/models/get_insurance_balance_response_body_spec.rb +1 -1
- data/spec/models/get_label_by_external_shipment_id_response_body_spec.rb +1 -1
- data/spec/models/get_label_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_manifest_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_package_type_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_rate_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_shipment_by_external_id_response_body_spec.rb +1 -1
- data/spec/models/get_shipment_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_tracking_log_from_label_response_body_spec.rb +1 -1
- data/spec/models/get_tracking_log_response_body_spec.rb +1 -1
- data/spec/models/get_warehouse_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_webhook_by_id_response_body_spec.rb +1 -1
- data/spec/models/insurance_provider_spec.rb +1 -1
- data/spec/models/international_shipment_options_spec.rb +1 -1
- data/spec/models/label_charge_event_spec.rb +1 -1
- data/spec/models/label_download_spec.rb +1 -1
- data/spec/models/label_download_type_spec.rb +1 -1
- data/spec/models/label_format_spec.rb +1 -1
- data/spec/models/label_layout_spec.rb +1 -1
- data/spec/models/label_messages_spec.rb +1 -1
- data/spec/models/label_spec.rb +1 -1
- data/spec/models/label_status_spec.rb +1 -1
- data/spec/models/link_spec.rb +1 -1
- data/spec/models/list_batch_errors_response_body_spec.rb +1 -1
- data/spec/models/list_batches_response_body_spec.rb +1 -1
- data/spec/models/list_carrier_package_types_response_body_spec.rb +1 -1
- data/spec/models/list_carrier_services_response_body_spec.rb +1 -1
- data/spec/models/list_carriers_response_body_spec.rb +1 -1
- data/spec/models/list_labels_response_body_spec.rb +1 -1
- data/spec/models/list_manifests_response_body_spec.rb +1 -1
- data/spec/models/list_package_types_response_body_spec.rb +1 -1
- data/spec/models/list_shipment_errors_response_body_spec.rb +1 -1
- data/spec/models/list_shipment_rates_response_body_spec.rb +1 -1
- data/spec/models/list_shipments_response_body_spec.rb +1 -1
- data/spec/models/list_tags_response_body_spec.rb +1 -1
- data/spec/models/list_warehouses_response_body_spec.rb +1 -1
- data/spec/models/manifest_download_spec.rb +1 -1
- data/spec/models/manifest_spec.rb +1 -1
- data/spec/models/manifests_spec.rb +1 -1
- data/spec/models/modify_batch_spec.rb +1 -1
- data/spec/models/monetary_value_spec.rb +1 -1
- data/spec/models/non_delivery_spec.rb +1 -1
- data/spec/models/optional_link_spec.rb +1 -1
- data/spec/models/order_source_name_spec.rb +1 -1
- data/spec/models/package_contents_spec.rb +1 -1
- data/spec/models/package_spec.rb +1 -1
- data/spec/models/package_type_spec.rb +1 -1
- data/spec/models/paged_list_response_body_spec.rb +1 -1
- data/spec/models/pagination_link_spec.rb +1 -1
- data/spec/models/parse_address_request_body_spec.rb +1 -1
- data/spec/models/parse_address_response_body_spec.rb +1 -1
- data/spec/models/parse_shipment_request_body_spec.rb +1 -1
- data/spec/models/parse_shipment_response_body_spec.rb +1 -1
- data/spec/models/partial_address_spec.rb +1 -1
- data/spec/models/partial_shipment_spec.rb +1 -1
- data/spec/models/payment_amount_spec.rb +1 -1
- data/spec/models/process_batch_request_body_spec.rb +1 -1
- data/spec/models/purchase_label_without_shipment_spec.rb +1 -1
- data/spec/models/rate_estimate_by_carrier_id_spec.rb +1 -1
- data/spec/models/rate_estimate_by_carrier_ids_spec.rb +1 -1
- data/spec/models/rate_estimate_options_spec.rb +1 -1
- data/spec/models/rate_request_body_spec.rb +1 -1
- data/spec/models/rate_request_by_shipment_ids_spec.rb +1 -1
- data/spec/models/rate_request_by_shipments_spec.rb +1 -1
- data/spec/models/rate_request_options_spec.rb +1 -1
- data/spec/models/rate_request_rate_options_spec.rb +1 -1
- data/spec/models/rate_response_spec.rb +1 -1
- data/spec/models/rate_response_status_spec.rb +1 -1
- data/spec/models/rate_spec.rb +1 -1
- data/spec/models/rate_type_spec.rb +1 -1
- data/spec/models/rates_information_spec.rb +1 -1
- data/spec/models/recognized_entity_spec.rb +1 -1
- data/spec/models/remove_from_batch_request_body_spec.rb +1 -1
- data/spec/models/response_message_spec.rb +1 -1
- data/spec/models/service_spec.rb +1 -1
- data/spec/models/shipment_id_request_spec.rb +1 -1
- data/spec/models/shipment_item_spec.rb +1 -1
- data/spec/models/shipment_request_spec.rb +1 -1
- data/spec/models/shipment_response_error_spec.rb +1 -1
- data/spec/models/shipment_spec.rb +1 -1
- data/spec/models/shipment_status_spec.rb +1 -1
- data/spec/models/shipments_sort_by_spec.rb +1 -1
- data/spec/models/smart_post_hub_spec.rb +1 -1
- data/spec/models/sort_dir_spec.rb +1 -1
- data/spec/models/tag_shipment_response_body_spec.rb +1 -1
- data/spec/models/tag_spec.rb +1 -1
- data/spec/models/track_event_spec.rb +1 -1
- data/spec/models/tracking_information_spec.rb +1 -1
- data/spec/models/tracking_status_spec.rb +1 -1
- data/spec/models/update_amazon_buy_shipping_request_body_spec.rb +1 -1
- data/spec/models/update_carrier_settings_request_body_spec.rb +1 -1
- data/spec/models/update_dhl_express_settings_request_body_spec.rb +1 -1
- data/spec/models/update_fedex_settings_request_body_spec.rb +1 -1
- data/spec/models/update_newgistics_settings_request_body_spec.rb +1 -1
- data/spec/models/update_package_type_request_body_spec.rb +1 -1
- data/spec/models/update_shipment_fields_spec.rb +1 -1
- data/spec/models/update_shipment_request_body_spec.rb +1 -1
- data/spec/models/update_shipment_response_body_spec.rb +1 -1
- data/spec/models/update_ups_settings_request_body_spec.rb +1 -1
- data/spec/models/update_warehouse_request_body_spec.rb +1 -1
- data/spec/models/update_webhook_request_body_spec.rb +1 -1
- data/spec/models/ups_account_settings_spec.rb +1 -1
- data/spec/models/ups_invoice_spec.rb +1 -1
- data/spec/models/ups_pickup_type_spec.rb +1 -1
- data/spec/models/ups_settings_response_body_spec.rb +1 -1
- data/spec/models/validate_address_spec.rb +1 -1
- data/spec/models/validate_shipment_fields_spec.rb +1 -1
- data/spec/models/validation_status_spec.rb +1 -1
- data/spec/models/void_label_response_body_spec.rb +1 -1
- data/spec/models/warehouse_spec.rb +1 -1
- data/spec/models/webhook_event_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +1 -1
- data/spec/models/weight_spec.rb +1 -1
- data/spec/models/weight_unit_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +2 -3
- data/ship_engine-1.0.0.gem +0 -0
- data/ship_engine-1.0.1.gem +0 -0
|
@@ -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
|
|
@@ -20,8 +20,8 @@ module ShipEngine
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Create Manifest
|
|
23
|
-
# Each ShipEngine manifest is created for a specific warehouse, so you'll need to provide the warehouse_id rather than the ship_from address. You can create a warehouse for each location that you want to create manifests for.
|
|
24
|
-
# @param create_manifest_request_body [CreateManifestRequestBody]
|
|
23
|
+
# Each ShipEngine manifest is created for a specific warehouse, so you'll need to provide the warehouse_id rather than the ship_from address. You can create a warehouse for each location that you want to create manifests for.
|
|
24
|
+
# @param create_manifest_request_body [CreateManifestRequestBody]
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [CreateManifestResponseBody]
|
|
27
27
|
def create_manifest(create_manifest_request_body, opts = {})
|
|
@@ -30,8 +30,8 @@ module ShipEngine
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
# Create Manifest
|
|
33
|
-
# Each ShipEngine manifest is created for a specific warehouse, so you'll need to provide the warehouse_id rather than the ship_from address. You can create a warehouse for each location that you want to create manifests for.
|
|
34
|
-
# @param create_manifest_request_body [CreateManifestRequestBody]
|
|
33
|
+
# Each ShipEngine manifest is created for a specific warehouse, so you'll need to provide the warehouse_id rather than the ship_from address. You can create a warehouse for each location that you want to create manifests for.
|
|
34
|
+
# @param create_manifest_request_body [CreateManifestRequestBody]
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(CreateManifestResponseBody, Integer, Hash)>] CreateManifestResponseBody data, response status code and response headers
|
|
37
37
|
def create_manifest_with_http_info(create_manifest_request_body, opts = {})
|
|
@@ -59,10 +59,10 @@ module ShipEngine
|
|
|
59
59
|
form_params = opts[:form_params] || {}
|
|
60
60
|
|
|
61
61
|
# http body (model)
|
|
62
|
-
post_body = opts[:body] || @api_client.object_to_http_body(create_manifest_request_body)
|
|
62
|
+
post_body = opts[:body] || @api_client.object_to_http_body(create_manifest_request_body)
|
|
63
63
|
|
|
64
64
|
# return_type
|
|
65
|
-
return_type = opts[:return_type] || 'CreateManifestResponseBody'
|
|
65
|
+
return_type = opts[:return_type] || 'CreateManifestResponseBody'
|
|
66
66
|
|
|
67
67
|
# auth_names
|
|
68
68
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -134,10 +134,10 @@ module ShipEngine
|
|
|
134
134
|
form_params = opts[:form_params] || {}
|
|
135
135
|
|
|
136
136
|
# http body (model)
|
|
137
|
-
post_body = opts[:body]
|
|
137
|
+
post_body = opts[:body]
|
|
138
138
|
|
|
139
139
|
# return_type
|
|
140
|
-
return_type = opts[:return_type] || 'GetManifestByIdResponseBody'
|
|
140
|
+
return_type = opts[:return_type] || 'GetManifestByIdResponseBody'
|
|
141
141
|
|
|
142
142
|
# auth_names
|
|
143
143
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -169,7 +169,7 @@ module ShipEngine
|
|
|
169
169
|
# @option opts [String] :carrier_id Carrier ID
|
|
170
170
|
# @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned. (default to 1)
|
|
171
171
|
# @option opts [Integer] :page_size The number of results to return per response. (default to 25)
|
|
172
|
-
# @option opts [Array<String>] :label_ids
|
|
172
|
+
# @option opts [Array<String>] :label_ids
|
|
173
173
|
# @return [ListManifestsResponseBody]
|
|
174
174
|
def list_manifests(opts = {})
|
|
175
175
|
data, _status_code, _headers = list_manifests_with_http_info(opts)
|
|
@@ -185,9 +185,9 @@ module ShipEngine
|
|
|
185
185
|
# @option opts [DateTime] :created_at_start Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
|
|
186
186
|
# @option opts [DateTime] :created_at_end Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
|
|
187
187
|
# @option opts [String] :carrier_id Carrier ID
|
|
188
|
-
# @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
|
|
188
|
+
# @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
|
|
189
189
|
# @option opts [Integer] :page_size The number of results to return per response.
|
|
190
|
-
# @option opts [Array<String>] :label_ids
|
|
190
|
+
# @option opts [Array<String>] :label_ids
|
|
191
191
|
# @return [Array<(ListManifestsResponseBody, Integer, Hash)>] ListManifestsResponseBody data, response status code and response headers
|
|
192
192
|
def list_manifests_with_http_info(opts = {})
|
|
193
193
|
if @api_client.config.debugging
|
|
@@ -251,10 +251,10 @@ module ShipEngine
|
|
|
251
251
|
form_params = opts[:form_params] || {}
|
|
252
252
|
|
|
253
253
|
# http body (model)
|
|
254
|
-
post_body = opts[:body]
|
|
254
|
+
post_body = opts[:body]
|
|
255
255
|
|
|
256
256
|
# return_type
|
|
257
|
-
return_type = opts[:return_type] || 'ListManifestsResponseBody'
|
|
257
|
+
return_type = opts[:return_type] || 'ListManifestsResponseBody'
|
|
258
258
|
|
|
259
259
|
# auth_names
|
|
260
260
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -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
|
|
@@ -21,7 +21,7 @@ module ShipEngine
|
|
|
21
21
|
end
|
|
22
22
|
# Create Custom Package Type
|
|
23
23
|
# Create a custom package type to better assist in getting accurate rate estimates
|
|
24
|
-
# @param create_package_type_request_body [CreatePackageTypeRequestBody]
|
|
24
|
+
# @param create_package_type_request_body [CreatePackageTypeRequestBody]
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [CreatePackageTypeResponseBody]
|
|
27
27
|
def create_package_type(create_package_type_request_body, opts = {})
|
|
@@ -31,7 +31,7 @@ module ShipEngine
|
|
|
31
31
|
|
|
32
32
|
# Create Custom Package Type
|
|
33
33
|
# Create a custom package type to better assist in getting accurate rate estimates
|
|
34
|
-
# @param create_package_type_request_body [CreatePackageTypeRequestBody]
|
|
34
|
+
# @param create_package_type_request_body [CreatePackageTypeRequestBody]
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(CreatePackageTypeResponseBody, Integer, Hash)>] CreatePackageTypeResponseBody data, response status code and response headers
|
|
37
37
|
def create_package_type_with_http_info(create_package_type_request_body, opts = {})
|
|
@@ -59,10 +59,10 @@ module ShipEngine
|
|
|
59
59
|
form_params = opts[:form_params] || {}
|
|
60
60
|
|
|
61
61
|
# http body (model)
|
|
62
|
-
post_body = opts[:body] || @api_client.object_to_http_body(create_package_type_request_body)
|
|
62
|
+
post_body = opts[:body] || @api_client.object_to_http_body(create_package_type_request_body)
|
|
63
63
|
|
|
64
64
|
# return_type
|
|
65
|
-
return_type = opts[:return_type] || 'CreatePackageTypeResponseBody'
|
|
65
|
+
return_type = opts[:return_type] || 'CreatePackageTypeResponseBody'
|
|
66
66
|
|
|
67
67
|
# auth_names
|
|
68
68
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -134,10 +134,10 @@ module ShipEngine
|
|
|
134
134
|
form_params = opts[:form_params] || {}
|
|
135
135
|
|
|
136
136
|
# http body (model)
|
|
137
|
-
post_body = opts[:body]
|
|
137
|
+
post_body = opts[:body]
|
|
138
138
|
|
|
139
139
|
# return_type
|
|
140
|
-
return_type = opts[:return_type] || 'String'
|
|
140
|
+
return_type = opts[:return_type] || 'String'
|
|
141
141
|
|
|
142
142
|
# auth_names
|
|
143
143
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -209,10 +209,10 @@ module ShipEngine
|
|
|
209
209
|
form_params = opts[:form_params] || {}
|
|
210
210
|
|
|
211
211
|
# http body (model)
|
|
212
|
-
post_body = opts[:body]
|
|
212
|
+
post_body = opts[:body]
|
|
213
213
|
|
|
214
214
|
# return_type
|
|
215
|
-
return_type = opts[:return_type] || 'GetPackageTypeByIdResponseBody'
|
|
215
|
+
return_type = opts[:return_type] || 'GetPackageTypeByIdResponseBody'
|
|
216
216
|
|
|
217
217
|
# auth_names
|
|
218
218
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -265,10 +265,10 @@ module ShipEngine
|
|
|
265
265
|
form_params = opts[:form_params] || {}
|
|
266
266
|
|
|
267
267
|
# http body (model)
|
|
268
|
-
post_body = opts[:body]
|
|
268
|
+
post_body = opts[:body]
|
|
269
269
|
|
|
270
270
|
# return_type
|
|
271
|
-
return_type = opts[:return_type] || 'ListPackageTypesResponseBody'
|
|
271
|
+
return_type = opts[:return_type] || 'ListPackageTypesResponseBody'
|
|
272
272
|
|
|
273
273
|
# auth_names
|
|
274
274
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -292,7 +292,7 @@ module ShipEngine
|
|
|
292
292
|
# Update Custom Package Type By ID
|
|
293
293
|
# Update the custom package type object by ID
|
|
294
294
|
# @param package_id [String] Package ID
|
|
295
|
-
# @param update_package_type_request_body [UpdatePackageTypeRequestBody]
|
|
295
|
+
# @param update_package_type_request_body [UpdatePackageTypeRequestBody]
|
|
296
296
|
# @param [Hash] opts the optional parameters
|
|
297
297
|
# @return [String]
|
|
298
298
|
def update_package_type(package_id, update_package_type_request_body, opts = {})
|
|
@@ -303,7 +303,7 @@ module ShipEngine
|
|
|
303
303
|
# Update Custom Package Type By ID
|
|
304
304
|
# Update the custom package type object by ID
|
|
305
305
|
# @param package_id [String] Package ID
|
|
306
|
-
# @param update_package_type_request_body [UpdatePackageTypeRequestBody]
|
|
306
|
+
# @param update_package_type_request_body [UpdatePackageTypeRequestBody]
|
|
307
307
|
# @param [Hash] opts the optional parameters
|
|
308
308
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
309
309
|
def update_package_type_with_http_info(package_id, update_package_type_request_body, opts = {})
|
|
@@ -348,10 +348,10 @@ module ShipEngine
|
|
|
348
348
|
form_params = opts[:form_params] || {}
|
|
349
349
|
|
|
350
350
|
# http body (model)
|
|
351
|
-
post_body = opts[:body] || @api_client.object_to_http_body(update_package_type_request_body)
|
|
351
|
+
post_body = opts[:body] || @api_client.object_to_http_body(update_package_type_request_body)
|
|
352
352
|
|
|
353
353
|
# return_type
|
|
354
|
-
return_type = opts[:return_type] || 'String'
|
|
354
|
+
return_type = opts[:return_type] || 'String'
|
|
355
355
|
|
|
356
356
|
# auth_names
|
|
357
357
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -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
|
|
@@ -20,8 +20,8 @@ module ShipEngine
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Get Shipping Rates
|
|
23
|
-
# It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option; so we provide functionality to show you all your options!
|
|
24
|
-
# @param calculate_rates_request_body [CalculateRatesRequestBody]
|
|
23
|
+
# It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option; so we provide functionality to show you all your options!
|
|
24
|
+
# @param calculate_rates_request_body [CalculateRatesRequestBody]
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [CalculateRatesResponseBody]
|
|
27
27
|
def calculate_rates(calculate_rates_request_body, opts = {})
|
|
@@ -30,8 +30,8 @@ module ShipEngine
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
# Get Shipping Rates
|
|
33
|
-
# It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option; so we provide functionality to show you all your options!
|
|
34
|
-
# @param calculate_rates_request_body [CalculateRatesRequestBody]
|
|
33
|
+
# It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option; so we provide functionality to show you all your options!
|
|
34
|
+
# @param calculate_rates_request_body [CalculateRatesRequestBody]
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(CalculateRatesResponseBody, Integer, Hash)>] CalculateRatesResponseBody data, response status code and response headers
|
|
37
37
|
def calculate_rates_with_http_info(calculate_rates_request_body, opts = {})
|
|
@@ -59,10 +59,10 @@ module ShipEngine
|
|
|
59
59
|
form_params = opts[:form_params] || {}
|
|
60
60
|
|
|
61
61
|
# http body (model)
|
|
62
|
-
post_body = opts[:body] || @api_client.object_to_http_body(calculate_rates_request_body)
|
|
62
|
+
post_body = opts[:body] || @api_client.object_to_http_body(calculate_rates_request_body)
|
|
63
63
|
|
|
64
64
|
# return_type
|
|
65
|
-
return_type = opts[:return_type] || 'CalculateRatesResponseBody'
|
|
65
|
+
return_type = opts[:return_type] || 'CalculateRatesResponseBody'
|
|
66
66
|
|
|
67
67
|
# auth_names
|
|
68
68
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -85,7 +85,7 @@ module ShipEngine
|
|
|
85
85
|
|
|
86
86
|
# Get Bulk Rates
|
|
87
87
|
# Get Bulk Shipment Rates
|
|
88
|
-
# @param compare_bulk_rates_request_body [CompareBulkRatesRequestBody]
|
|
88
|
+
# @param compare_bulk_rates_request_body [CompareBulkRatesRequestBody]
|
|
89
89
|
# @param [Hash] opts the optional parameters
|
|
90
90
|
# @return [Array<BulkRate>]
|
|
91
91
|
def compare_bulk_rates(compare_bulk_rates_request_body, opts = {})
|
|
@@ -95,7 +95,7 @@ module ShipEngine
|
|
|
95
95
|
|
|
96
96
|
# Get Bulk Rates
|
|
97
97
|
# Get Bulk Shipment Rates
|
|
98
|
-
# @param compare_bulk_rates_request_body [CompareBulkRatesRequestBody]
|
|
98
|
+
# @param compare_bulk_rates_request_body [CompareBulkRatesRequestBody]
|
|
99
99
|
# @param [Hash] opts the optional parameters
|
|
100
100
|
# @return [Array<(Array<BulkRate>, Integer, Hash)>] Array<BulkRate> data, response status code and response headers
|
|
101
101
|
def compare_bulk_rates_with_http_info(compare_bulk_rates_request_body, opts = {})
|
|
@@ -123,10 +123,10 @@ module ShipEngine
|
|
|
123
123
|
form_params = opts[:form_params] || {}
|
|
124
124
|
|
|
125
125
|
# http body (model)
|
|
126
|
-
post_body = opts[:body] || @api_client.object_to_http_body(compare_bulk_rates_request_body)
|
|
126
|
+
post_body = opts[:body] || @api_client.object_to_http_body(compare_bulk_rates_request_body)
|
|
127
127
|
|
|
128
128
|
# return_type
|
|
129
|
-
return_type = opts[:return_type] || 'Array<BulkRate>'
|
|
129
|
+
return_type = opts[:return_type] || 'Array<BulkRate>'
|
|
130
130
|
|
|
131
131
|
# auth_names
|
|
132
132
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -149,7 +149,7 @@ module ShipEngine
|
|
|
149
149
|
|
|
150
150
|
# Estimate Rates
|
|
151
151
|
# Get Rate Estimates
|
|
152
|
-
# @param estimate_rates_request_body [EstimateRatesRequestBody]
|
|
152
|
+
# @param estimate_rates_request_body [EstimateRatesRequestBody]
|
|
153
153
|
# @param [Hash] opts the optional parameters
|
|
154
154
|
# @return [Array<Rate>]
|
|
155
155
|
def estimate_rates(estimate_rates_request_body, opts = {})
|
|
@@ -159,7 +159,7 @@ module ShipEngine
|
|
|
159
159
|
|
|
160
160
|
# Estimate Rates
|
|
161
161
|
# Get Rate Estimates
|
|
162
|
-
# @param estimate_rates_request_body [EstimateRatesRequestBody]
|
|
162
|
+
# @param estimate_rates_request_body [EstimateRatesRequestBody]
|
|
163
163
|
# @param [Hash] opts the optional parameters
|
|
164
164
|
# @return [Array<(Array<Rate>, Integer, Hash)>] Array<Rate> data, response status code and response headers
|
|
165
165
|
def estimate_rates_with_http_info(estimate_rates_request_body, opts = {})
|
|
@@ -187,10 +187,10 @@ module ShipEngine
|
|
|
187
187
|
form_params = opts[:form_params] || {}
|
|
188
188
|
|
|
189
189
|
# http body (model)
|
|
190
|
-
post_body = opts[:body] || @api_client.object_to_http_body(estimate_rates_request_body)
|
|
190
|
+
post_body = opts[:body] || @api_client.object_to_http_body(estimate_rates_request_body)
|
|
191
191
|
|
|
192
192
|
# return_type
|
|
193
|
-
return_type = opts[:return_type] || 'Array<Rate>'
|
|
193
|
+
return_type = opts[:return_type] || 'Array<Rate>'
|
|
194
194
|
|
|
195
195
|
# auth_names
|
|
196
196
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -262,10 +262,10 @@ module ShipEngine
|
|
|
262
262
|
form_params = opts[:form_params] || {}
|
|
263
263
|
|
|
264
264
|
# http body (model)
|
|
265
|
-
post_body = opts[:body]
|
|
265
|
+
post_body = opts[:body]
|
|
266
266
|
|
|
267
267
|
# return_type
|
|
268
|
-
return_type = opts[:return_type] || 'GetRateByIdResponseBody'
|
|
268
|
+
return_type = opts[:return_type] || 'GetRateByIdResponseBody'
|
|
269
269
|
|
|
270
270
|
# auth_names
|
|
271
271
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -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
|
|
@@ -20,7 +20,7 @@ module ShipEngine
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Cancel a Shipment
|
|
23
|
-
# Mark a shipment cancelled, if it is no longer needed or being used by your organized. Any label associated with the shipment needs to be voided first An example use case would be if a batch label creation job is going to run at a set time and only queries `pending` shipments. Marking a shipment as cancelled would remove it from this process
|
|
23
|
+
# Mark a shipment cancelled, if it is no longer needed or being used by your organized. Any label associated with the shipment needs to be voided first An example use case would be if a batch label creation job is going to run at a set time and only queries `pending` shipments. Marking a shipment as cancelled would remove it from this process
|
|
24
24
|
# @param shipment_id [String] Shipment ID
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [String]
|
|
@@ -30,7 +30,7 @@ module ShipEngine
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
# Cancel a Shipment
|
|
33
|
-
# Mark a shipment cancelled, if it is no longer needed or being used by your organized. Any label associated with the shipment needs to be voided first An example use case would be if a batch label creation job is going to run at a set time and only queries `pending` shipments. Marking a shipment as cancelled would remove it from this process
|
|
33
|
+
# Mark a shipment cancelled, if it is no longer needed or being used by your organized. Any label associated with the shipment needs to be voided first An example use case would be if a batch label creation job is going to run at a set time and only queries `pending` shipments. Marking a shipment as cancelled would remove it from this process
|
|
34
34
|
# @param shipment_id [String] Shipment ID
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
@@ -70,10 +70,10 @@ module ShipEngine
|
|
|
70
70
|
form_params = opts[:form_params] || {}
|
|
71
71
|
|
|
72
72
|
# http body (model)
|
|
73
|
-
post_body = opts[:body]
|
|
73
|
+
post_body = opts[:body]
|
|
74
74
|
|
|
75
75
|
# return_type
|
|
76
|
-
return_type = opts[:return_type] || 'String'
|
|
76
|
+
return_type = opts[:return_type] || 'String'
|
|
77
77
|
|
|
78
78
|
# auth_names
|
|
79
79
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -96,7 +96,7 @@ module ShipEngine
|
|
|
96
96
|
|
|
97
97
|
# Create Shipments
|
|
98
98
|
# Create one or multiple shipments.
|
|
99
|
-
# @param create_shipments_request_body [CreateShipmentsRequestBody]
|
|
99
|
+
# @param create_shipments_request_body [CreateShipmentsRequestBody]
|
|
100
100
|
# @param [Hash] opts the optional parameters
|
|
101
101
|
# @return [CreateShipmentsResponseBody]
|
|
102
102
|
def create_shipments(create_shipments_request_body, opts = {})
|
|
@@ -106,7 +106,7 @@ module ShipEngine
|
|
|
106
106
|
|
|
107
107
|
# Create Shipments
|
|
108
108
|
# Create one or multiple shipments.
|
|
109
|
-
# @param create_shipments_request_body [CreateShipmentsRequestBody]
|
|
109
|
+
# @param create_shipments_request_body [CreateShipmentsRequestBody]
|
|
110
110
|
# @param [Hash] opts the optional parameters
|
|
111
111
|
# @return [Array<(CreateShipmentsResponseBody, Integer, Hash)>] CreateShipmentsResponseBody data, response status code and response headers
|
|
112
112
|
def create_shipments_with_http_info(create_shipments_request_body, opts = {})
|
|
@@ -134,10 +134,10 @@ module ShipEngine
|
|
|
134
134
|
form_params = opts[:form_params] || {}
|
|
135
135
|
|
|
136
136
|
# http body (model)
|
|
137
|
-
post_body = opts[:body] || @api_client.object_to_http_body(create_shipments_request_body)
|
|
137
|
+
post_body = opts[:body] || @api_client.object_to_http_body(create_shipments_request_body)
|
|
138
138
|
|
|
139
139
|
# return_type
|
|
140
|
-
return_type = opts[:return_type] || 'CreateShipmentsResponseBody'
|
|
140
|
+
return_type = opts[:return_type] || 'CreateShipmentsResponseBody'
|
|
141
141
|
|
|
142
142
|
# auth_names
|
|
143
143
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -160,7 +160,7 @@ module ShipEngine
|
|
|
160
160
|
|
|
161
161
|
# Get Shipment By External ID
|
|
162
162
|
# Query Shipments created using your own custom ID convention using this endpint
|
|
163
|
-
# @param external_shipment_id [String]
|
|
163
|
+
# @param external_shipment_id [String]
|
|
164
164
|
# @param [Hash] opts the optional parameters
|
|
165
165
|
# @return [GetShipmentByExternalIdResponseBody]
|
|
166
166
|
def get_shipment_by_external_id(external_shipment_id, opts = {})
|
|
@@ -170,7 +170,7 @@ module ShipEngine
|
|
|
170
170
|
|
|
171
171
|
# Get Shipment By External ID
|
|
172
172
|
# Query Shipments created using your own custom ID convention using this endpint
|
|
173
|
-
# @param external_shipment_id [String]
|
|
173
|
+
# @param external_shipment_id [String]
|
|
174
174
|
# @param [Hash] opts the optional parameters
|
|
175
175
|
# @return [Array<(GetShipmentByExternalIdResponseBody, Integer, Hash)>] GetShipmentByExternalIdResponseBody data, response status code and response headers
|
|
176
176
|
def get_shipment_by_external_id_with_http_info(external_shipment_id, opts = {})
|
|
@@ -196,10 +196,10 @@ module ShipEngine
|
|
|
196
196
|
form_params = opts[:form_params] || {}
|
|
197
197
|
|
|
198
198
|
# http body (model)
|
|
199
|
-
post_body = opts[:body]
|
|
199
|
+
post_body = opts[:body]
|
|
200
200
|
|
|
201
201
|
# return_type
|
|
202
|
-
return_type = opts[:return_type] || 'GetShipmentByExternalIdResponseBody'
|
|
202
|
+
return_type = opts[:return_type] || 'GetShipmentByExternalIdResponseBody'
|
|
203
203
|
|
|
204
204
|
# auth_names
|
|
205
205
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -271,10 +271,10 @@ module ShipEngine
|
|
|
271
271
|
form_params = opts[:form_params] || {}
|
|
272
272
|
|
|
273
273
|
# http body (model)
|
|
274
|
-
post_body = opts[:body]
|
|
274
|
+
post_body = opts[:body]
|
|
275
275
|
|
|
276
276
|
# return_type
|
|
277
|
-
return_type = opts[:return_type] || 'GetShipmentByIdResponseBody'
|
|
277
|
+
return_type = opts[:return_type] || 'GetShipmentByIdResponseBody'
|
|
278
278
|
|
|
279
279
|
# auth_names
|
|
280
280
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -296,11 +296,11 @@ module ShipEngine
|
|
|
296
296
|
end
|
|
297
297
|
|
|
298
298
|
# Get Shipment Errors
|
|
299
|
-
# If there are no errors associated with this shipment then the API will return a 404 Not Found response to indicate that no errors are associated with the request
|
|
299
|
+
# If there are no errors associated with this shipment then the API will return a 404 Not Found response to indicate that no errors are associated with the request
|
|
300
300
|
# @param shipment_id [String] Shipment ID
|
|
301
301
|
# @param [Hash] opts the optional parameters
|
|
302
302
|
# @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned. (default to 1)
|
|
303
|
-
# @option opts [Integer] :pagesize
|
|
303
|
+
# @option opts [Integer] :pagesize
|
|
304
304
|
# @return [ListShipmentErrorsResponseBody]
|
|
305
305
|
def list_shipment_errors(shipment_id, opts = {})
|
|
306
306
|
data, _status_code, _headers = list_shipment_errors_with_http_info(shipment_id, opts)
|
|
@@ -308,11 +308,11 @@ module ShipEngine
|
|
|
308
308
|
end
|
|
309
309
|
|
|
310
310
|
# Get Shipment Errors
|
|
311
|
-
# If there are no errors associated with this shipment then the API will return a 404 Not Found response to indicate that no errors are associated with the request
|
|
311
|
+
# If there are no errors associated with this shipment then the API will return a 404 Not Found response to indicate that no errors are associated with the request
|
|
312
312
|
# @param shipment_id [String] Shipment ID
|
|
313
313
|
# @param [Hash] opts the optional parameters
|
|
314
|
-
# @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
|
|
315
|
-
# @option opts [Integer] :pagesize
|
|
314
|
+
# @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
|
|
315
|
+
# @option opts [Integer] :pagesize
|
|
316
316
|
# @return [Array<(ListShipmentErrorsResponseBody, Integer, Hash)>] ListShipmentErrorsResponseBody data, response status code and response headers
|
|
317
317
|
def list_shipment_errors_with_http_info(shipment_id, opts = {})
|
|
318
318
|
if @api_client.config.debugging
|
|
@@ -360,10 +360,10 @@ module ShipEngine
|
|
|
360
360
|
form_params = opts[:form_params] || {}
|
|
361
361
|
|
|
362
362
|
# http body (model)
|
|
363
|
-
post_body = opts[:body]
|
|
363
|
+
post_body = opts[:body]
|
|
364
364
|
|
|
365
365
|
# return_type
|
|
366
|
-
return_type = opts[:return_type] || 'ListShipmentErrorsResponseBody'
|
|
366
|
+
return_type = opts[:return_type] || 'ListShipmentErrorsResponseBody'
|
|
367
367
|
|
|
368
368
|
# auth_names
|
|
369
369
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -438,10 +438,10 @@ module ShipEngine
|
|
|
438
438
|
form_params = opts[:form_params] || {}
|
|
439
439
|
|
|
440
440
|
# http body (model)
|
|
441
|
-
post_body = opts[:body]
|
|
441
|
+
post_body = opts[:body]
|
|
442
442
|
|
|
443
443
|
# return_type
|
|
444
|
-
return_type = opts[:return_type] || 'ListShipmentRatesResponseBody'
|
|
444
|
+
return_type = opts[:return_type] || 'ListShipmentRatesResponseBody'
|
|
445
445
|
|
|
446
446
|
# auth_names
|
|
447
447
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -465,7 +465,7 @@ module ShipEngine
|
|
|
465
465
|
# List Shipments
|
|
466
466
|
# Get list of Shipments
|
|
467
467
|
# @param [Hash] opts the optional parameters
|
|
468
|
-
# @option opts [ShipmentStatus] :shipment_status
|
|
468
|
+
# @option opts [ShipmentStatus] :shipment_status
|
|
469
469
|
# @option opts [String] :batch_id Batch ID
|
|
470
470
|
# @option opts [String] :tag Search for shipments based on the custom tag added to the shipment object
|
|
471
471
|
# @option opts [DateTime] :created_at_start Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
|
|
@@ -476,7 +476,7 @@ module ShipEngine
|
|
|
476
476
|
# @option opts [Integer] :page_size The number of results to return per response. (default to 25)
|
|
477
477
|
# @option opts [String] :sales_order_id Sales Order ID
|
|
478
478
|
# @option opts [SortDir] :sort_dir Controls the sort order of the query.
|
|
479
|
-
# @option opts [ShipmentsSortBy] :sort_by
|
|
479
|
+
# @option opts [ShipmentsSortBy] :sort_by
|
|
480
480
|
# @return [ListShipmentsResponseBody]
|
|
481
481
|
def list_shipments(opts = {})
|
|
482
482
|
data, _status_code, _headers = list_shipments_with_http_info(opts)
|
|
@@ -486,18 +486,18 @@ module ShipEngine
|
|
|
486
486
|
# List Shipments
|
|
487
487
|
# Get list of Shipments
|
|
488
488
|
# @param [Hash] opts the optional parameters
|
|
489
|
-
# @option opts [ShipmentStatus] :shipment_status
|
|
489
|
+
# @option opts [ShipmentStatus] :shipment_status
|
|
490
490
|
# @option opts [String] :batch_id Batch ID
|
|
491
491
|
# @option opts [String] :tag Search for shipments based on the custom tag added to the shipment object
|
|
492
492
|
# @option opts [DateTime] :created_at_start Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
|
|
493
493
|
# @option opts [DateTime] :created_at_end Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
|
|
494
494
|
# @option opts [DateTime] :modified_at_start Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time)
|
|
495
495
|
# @option opts [DateTime] :modified_at_end Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time)
|
|
496
|
-
# @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
|
|
496
|
+
# @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
|
|
497
497
|
# @option opts [Integer] :page_size The number of results to return per response.
|
|
498
498
|
# @option opts [String] :sales_order_id Sales Order ID
|
|
499
499
|
# @option opts [SortDir] :sort_dir Controls the sort order of the query.
|
|
500
|
-
# @option opts [ShipmentsSortBy] :sort_by
|
|
500
|
+
# @option opts [ShipmentsSortBy] :sort_by
|
|
501
501
|
# @return [Array<(ListShipmentsResponseBody, Integer, Hash)>] ListShipmentsResponseBody data, response status code and response headers
|
|
502
502
|
def list_shipments_with_http_info(opts = {})
|
|
503
503
|
if @api_client.config.debugging
|
|
@@ -555,10 +555,10 @@ module ShipEngine
|
|
|
555
555
|
form_params = opts[:form_params] || {}
|
|
556
556
|
|
|
557
557
|
# http body (model)
|
|
558
|
-
post_body = opts[:body]
|
|
558
|
+
post_body = opts[:body]
|
|
559
559
|
|
|
560
560
|
# return_type
|
|
561
|
-
return_type = opts[:return_type] || 'ListShipmentsResponseBody'
|
|
561
|
+
return_type = opts[:return_type] || 'ListShipmentsResponseBody'
|
|
562
562
|
|
|
563
563
|
# auth_names
|
|
564
564
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -580,8 +580,8 @@ module ShipEngine
|
|
|
580
580
|
end
|
|
581
581
|
|
|
582
582
|
# Parse shipping info
|
|
583
|
-
# The shipment-recognition API makes it easy for you to extract shipping data from unstructured text, including people's names, addresses, package weights and dimensions, insurance and delivery requirements, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's shipment-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed shipment data is returned in the same structure that's used for other ShipEngine APIs, so you can easily use the parsed data to create a shipping label. > **Note:** Shipment recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland.
|
|
584
|
-
# @param parse_shipment_request_body [ParseShipmentRequestBody] 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.
|
|
583
|
+
# The shipment-recognition API makes it easy for you to extract shipping data from unstructured text, including people's names, addresses, package weights and dimensions, insurance and delivery requirements, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's shipment-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed shipment data is returned in the same structure that's used for other ShipEngine APIs, so you can easily use the parsed data to create a shipping label. > **Note:** Shipment recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland.
|
|
584
|
+
# @param parse_shipment_request_body [ParseShipmentRequestBody] 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.
|
|
585
585
|
# @param [Hash] opts the optional parameters
|
|
586
586
|
# @return [ParseShipmentResponseBody]
|
|
587
587
|
def parse_shipment(parse_shipment_request_body, opts = {})
|
|
@@ -590,8 +590,8 @@ module ShipEngine
|
|
|
590
590
|
end
|
|
591
591
|
|
|
592
592
|
# Parse shipping info
|
|
593
|
-
# The shipment-recognition API makes it easy for you to extract shipping data from unstructured text, including people's names, addresses, package weights and dimensions, insurance and delivery requirements, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's shipment-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed shipment data is returned in the same structure that's used for other ShipEngine APIs, so you can easily use the parsed data to create a shipping label. > **Note:** Shipment recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland.
|
|
594
|
-
# @param parse_shipment_request_body [ParseShipmentRequestBody] 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.
|
|
593
|
+
# The shipment-recognition API makes it easy for you to extract shipping data from unstructured text, including people's names, addresses, package weights and dimensions, insurance and delivery requirements, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's shipment-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed shipment data is returned in the same structure that's used for other ShipEngine APIs, so you can easily use the parsed data to create a shipping label. > **Note:** Shipment recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland.
|
|
594
|
+
# @param parse_shipment_request_body [ParseShipmentRequestBody] 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.
|
|
595
595
|
# @param [Hash] opts the optional parameters
|
|
596
596
|
# @return [Array<(ParseShipmentResponseBody, Integer, Hash)>] ParseShipmentResponseBody data, response status code and response headers
|
|
597
597
|
def parse_shipment_with_http_info(parse_shipment_request_body, opts = {})
|
|
@@ -619,10 +619,10 @@ module ShipEngine
|
|
|
619
619
|
form_params = opts[:form_params] || {}
|
|
620
620
|
|
|
621
621
|
# http body (model)
|
|
622
|
-
post_body = opts[:body] || @api_client.object_to_http_body(parse_shipment_request_body)
|
|
622
|
+
post_body = opts[:body] || @api_client.object_to_http_body(parse_shipment_request_body)
|
|
623
623
|
|
|
624
624
|
# return_type
|
|
625
|
-
return_type = opts[:return_type] || 'ParseShipmentResponseBody'
|
|
625
|
+
return_type = opts[:return_type] || 'ParseShipmentResponseBody'
|
|
626
626
|
|
|
627
627
|
# auth_names
|
|
628
628
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -646,7 +646,7 @@ module ShipEngine
|
|
|
646
646
|
# Add Tag to Shipment
|
|
647
647
|
# Add a tag to the shipment object
|
|
648
648
|
# @param shipment_id [String] Shipment ID
|
|
649
|
-
# @param tag_name [String]
|
|
649
|
+
# @param tag_name [String]
|
|
650
650
|
# @param [Hash] opts the optional parameters
|
|
651
651
|
# @return [TagShipmentResponseBody]
|
|
652
652
|
def tag_shipment(shipment_id, tag_name, opts = {})
|
|
@@ -657,7 +657,7 @@ module ShipEngine
|
|
|
657
657
|
# Add Tag to Shipment
|
|
658
658
|
# Add a tag to the shipment object
|
|
659
659
|
# @param shipment_id [String] Shipment ID
|
|
660
|
-
# @param tag_name [String]
|
|
660
|
+
# @param tag_name [String]
|
|
661
661
|
# @param [Hash] opts the optional parameters
|
|
662
662
|
# @return [Array<(TagShipmentResponseBody, Integer, Hash)>] TagShipmentResponseBody data, response status code and response headers
|
|
663
663
|
def tag_shipment_with_http_info(shipment_id, tag_name, opts = {})
|
|
@@ -704,10 +704,10 @@ module ShipEngine
|
|
|
704
704
|
form_params = opts[:form_params] || {}
|
|
705
705
|
|
|
706
706
|
# http body (model)
|
|
707
|
-
post_body = opts[:body]
|
|
707
|
+
post_body = opts[:body]
|
|
708
708
|
|
|
709
709
|
# return_type
|
|
710
|
-
return_type = opts[:return_type] || 'TagShipmentResponseBody'
|
|
710
|
+
return_type = opts[:return_type] || 'TagShipmentResponseBody'
|
|
711
711
|
|
|
712
712
|
# auth_names
|
|
713
713
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -731,7 +731,7 @@ module ShipEngine
|
|
|
731
731
|
# Remove Tag from Shipment
|
|
732
732
|
# Remove an existing tag from the Shipment object
|
|
733
733
|
# @param shipment_id [String] Shipment ID
|
|
734
|
-
# @param tag_name [String]
|
|
734
|
+
# @param tag_name [String]
|
|
735
735
|
# @param [Hash] opts the optional parameters
|
|
736
736
|
# @return [String]
|
|
737
737
|
def untag_shipment(shipment_id, tag_name, opts = {})
|
|
@@ -742,7 +742,7 @@ module ShipEngine
|
|
|
742
742
|
# Remove Tag from Shipment
|
|
743
743
|
# Remove an existing tag from the Shipment object
|
|
744
744
|
# @param shipment_id [String] Shipment ID
|
|
745
|
-
# @param tag_name [String]
|
|
745
|
+
# @param tag_name [String]
|
|
746
746
|
# @param [Hash] opts the optional parameters
|
|
747
747
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
748
748
|
def untag_shipment_with_http_info(shipment_id, tag_name, opts = {})
|
|
@@ -789,10 +789,10 @@ module ShipEngine
|
|
|
789
789
|
form_params = opts[:form_params] || {}
|
|
790
790
|
|
|
791
791
|
# http body (model)
|
|
792
|
-
post_body = opts[:body]
|
|
792
|
+
post_body = opts[:body]
|
|
793
793
|
|
|
794
794
|
# return_type
|
|
795
|
-
return_type = opts[:return_type] || 'String'
|
|
795
|
+
return_type = opts[:return_type] || 'String'
|
|
796
796
|
|
|
797
797
|
# auth_names
|
|
798
798
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -816,7 +816,7 @@ module ShipEngine
|
|
|
816
816
|
# Update Shipment By ID
|
|
817
817
|
# Update a shipment object based on its ID
|
|
818
818
|
# @param shipment_id [String] Shipment ID
|
|
819
|
-
# @param update_shipment_request_body [UpdateShipmentRequestBody]
|
|
819
|
+
# @param update_shipment_request_body [UpdateShipmentRequestBody]
|
|
820
820
|
# @param [Hash] opts the optional parameters
|
|
821
821
|
# @return [UpdateShipmentResponseBody]
|
|
822
822
|
def update_shipment(shipment_id, update_shipment_request_body, opts = {})
|
|
@@ -827,7 +827,7 @@ module ShipEngine
|
|
|
827
827
|
# Update Shipment By ID
|
|
828
828
|
# Update a shipment object based on its ID
|
|
829
829
|
# @param shipment_id [String] Shipment ID
|
|
830
|
-
# @param update_shipment_request_body [UpdateShipmentRequestBody]
|
|
830
|
+
# @param update_shipment_request_body [UpdateShipmentRequestBody]
|
|
831
831
|
# @param [Hash] opts the optional parameters
|
|
832
832
|
# @return [Array<(UpdateShipmentResponseBody, Integer, Hash)>] UpdateShipmentResponseBody data, response status code and response headers
|
|
833
833
|
def update_shipment_with_http_info(shipment_id, update_shipment_request_body, opts = {})
|
|
@@ -872,10 +872,10 @@ module ShipEngine
|
|
|
872
872
|
form_params = opts[:form_params] || {}
|
|
873
873
|
|
|
874
874
|
# http body (model)
|
|
875
|
-
post_body = opts[:body] || @api_client.object_to_http_body(update_shipment_request_body)
|
|
875
|
+
post_body = opts[:body] || @api_client.object_to_http_body(update_shipment_request_body)
|
|
876
876
|
|
|
877
877
|
# return_type
|
|
878
|
-
return_type = opts[:return_type] || 'UpdateShipmentResponseBody'
|
|
878
|
+
return_type = opts[:return_type] || 'UpdateShipmentResponseBody'
|
|
879
879
|
|
|
880
880
|
# auth_names
|
|
881
881
|
auth_names = opts[:auth_names] || ['api_key']
|