ship_engine 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +315 -320
- data/docs/AddFundsToCarrierRequestBody.md +5 -6
- data/docs/AddFundsToCarrierResponseBody.md +5 -7
- data/docs/AddFundsToInsuranceRequestBody.md +5 -6
- data/docs/AddFundsToInsuranceResponseBody.md +5 -6
- data/docs/AddToBatchRequestBody.md +5 -6
- data/docs/Address.md +5 -6
- data/docs/AddressResidentialIndicator.md +5 -6
- data/docs/AddressToValidate.md +5 -6
- data/docs/AddressValidatingShipment.md +27 -29
- data/docs/AddressValidationCode.md +5 -6
- data/docs/AddressValidationDetailCode.md +5 -6
- data/docs/AddressValidationMessageType.md +5 -6
- data/docs/AddressValidationResult.md +8 -10
- data/docs/AddressValidationStatus.md +5 -6
- data/docs/AddressesApi.md +19 -25
- data/docs/AdvancedShipmentOptions.md +20 -22
- data/docs/AncillaryServiceEndorsement.md +5 -6
- data/docs/Batch.md +22 -24
- data/docs/BatchResponseError.md +6 -8
- data/docs/BatchStatus.md +5 -6
- data/docs/BatchesApi.md +84 -106
- data/docs/BatchesSortBy.md +5 -6
- data/docs/BillToParty.md +5 -6
- data/docs/BulkRate.md +9 -11
- data/docs/CalculateRatesRequestBody.md +5 -6
- data/docs/CalculateRatesResponseBody.md +27 -29
- data/docs/Carrier.md +17 -19
- data/docs/CarrierAccountsApi.md +38 -48
- data/docs/CarrierAdvancedOption.md +7 -9
- data/docs/CarrierName.md +5 -6
- data/docs/CarrierNameWithSettings.md +5 -6
- data/docs/CarriersApi.md +38 -51
- data/docs/CollectOnDelivery.md +6 -8
- data/docs/CollectOnDeliveryPaymentType.md +5 -6
- data/docs/CompareBulkRatesRequestBody.md +5 -6
- data/docs/ConnectAccessWorldwideRequestBody.md +7 -9
- data/docs/ConnectAmazonBuyShippingRequestBody.md +8 -10
- data/docs/ConnectApcRequestBody.md +7 -9
- data/docs/ConnectAsendiaRequestBody.md +8 -10
- data/docs/ConnectAustraliaPostRequestBody.md +8 -10
- data/docs/ConnectCanadaPostRequestBody.md +9 -11
- data/docs/ConnectCarrierRequestBody.md +53 -55
- data/docs/ConnectCarrierResponseBody.md +5 -7
- data/docs/ConnectDhlEcommerceRequestBody.md +16 -18
- data/docs/ConnectDhlExpressAuRequestBody.md +6 -8
- data/docs/ConnectDhlExpressCaRequestBody.md +6 -8
- data/docs/ConnectDhlExpressRequestBody.md +6 -8
- data/docs/ConnectDhlExpressUkRequestBody.md +8 -10
- data/docs/ConnectDpdRequestBody.md +7 -9
- data/docs/ConnectEndiciaRequestBody.md +7 -9
- data/docs/ConnectFedexRequestBody.md +19 -21
- data/docs/ConnectFedexUkRequestBody.md +19 -21
- data/docs/ConnectFirstmileRequestBody.md +8 -10
- data/docs/ConnectGlobegisticsRequestBody.md +7 -9
- data/docs/ConnectImexRequestBody.md +7 -9
- data/docs/ConnectInsurerRequestBody.md +6 -8
- data/docs/ConnectNewgisticsRequestBody.md +8 -10
- data/docs/ConnectOntracRequestBody.md +7 -9
- data/docs/ConnectPurolatorRequestBody.md +7 -9
- data/docs/ConnectRoyalMailRequestBody.md +16 -18
- data/docs/ConnectRrDonnelleyRequestBody.md +7 -9
- data/docs/ConnectSekoRequestBody.md +6 -8
- data/docs/ConnectSendleRequestBody.md +7 -9
- data/docs/ConnectStampsRequestBody.md +7 -9
- data/docs/ConnectUpsRequestBody.md +22 -24
- data/docs/CreateAndValidateShipment.md +28 -30
- data/docs/CreateBatchRequestBody.md +8 -10
- data/docs/CreateBatchResponseBody.md +5 -6
- data/docs/CreateLabelFromRateRequestBody.md +5 -6
- data/docs/CreateLabelFromRateResponseBody.md +5 -6
- data/docs/CreateLabelFromShipmentRequestBody.md +8 -10
- data/docs/CreateLabelFromShipmentResponseBody.md +5 -6
- data/docs/CreateLabelRequestBody.md +5 -6
- data/docs/CreateLabelResponseBody.md +5 -6
- data/docs/CreateManifestByObjectRequestBody.md +9 -11
- data/docs/CreateManifestLabelIdsRequestBody.md +5 -7
- data/docs/CreateManifestRequestBody.md +9 -11
- data/docs/CreateManifestResponseBody.md +14 -16
- data/docs/CreatePackageTypeRequestBody.md +5 -6
- data/docs/CreatePackageTypeResponseBody.md +5 -6
- data/docs/CreateReturnLabelRequestBody.md +9 -11
- data/docs/CreateReturnLabelResponseBody.md +5 -6
- data/docs/CreateShipmentResponseBodyFields.md +6 -8
- data/docs/CreateShipmentsRequestBody.md +5 -7
- data/docs/CreateShipmentsResponseBody.md +6 -8
- data/docs/CreateTagResponseBody.md +5 -6
- data/docs/CreateWarehouseRequestBody.md +5 -6
- data/docs/CreateWarehouseResponseBody.md +5 -6
- data/docs/CreateWebhookRequestBody.md +4 -4
- data/docs/CreateWebhookResponseBody.md +5 -6
- data/docs/Currency.md +5 -6
- data/docs/CustomsItem.md +13 -15
- data/docs/DeliveryConfirmation.md +5 -6
- data/docs/DeprecatedManifest.md +13 -15
- data/docs/DhlExpressAccountSettings.md +7 -9
- data/docs/DhlExpressSettingsResponseBody.md +5 -6
- data/docs/DimensionUnit.md +5 -6
- data/docs/Dimensions.md +8 -10
- data/docs/DownloadsApi.md +16 -20
- data/docs/Error.md +8 -10
- data/docs/ErrorCode.md +5 -6
- data/docs/ErrorResponseBody.md +6 -8
- data/docs/ErrorSource.md +5 -6
- data/docs/ErrorType.md +5 -6
- data/docs/EstimateRatesRequestBody.md +5 -6
- data/docs/FedexAccountSettings.md +9 -11
- data/docs/FedexAccountSettingsRequestBody.md +5 -6
- data/docs/FedexPickupType.md +5 -6
- data/docs/FedexSettingsResponseBody.md +5 -6
- data/docs/GetBatchByExternalIdResponseBody.md +5 -6
- data/docs/GetBatchByIdResponseBody.md +5 -6
- data/docs/GetCarrierByIdResponseBody.md +5 -6
- data/docs/GetCarrierOptionsResponseBody.md +5 -7
- data/docs/GetCarrierSettingsResponseBody.md +19 -21
- data/docs/GetCarriersResponseBody.md +7 -9
- data/docs/GetInsuranceBalanceResponseBody.md +5 -6
- data/docs/GetLabelByExternalShipmentIdResponseBody.md +5 -6
- data/docs/GetLabelByIdResponseBody.md +5 -6
- data/docs/GetManifestByIdResponseBody.md +5 -6
- data/docs/GetPackageTypeByIdResponseBody.md +5 -6
- data/docs/GetRateByIdResponseBody.md +5 -6
- data/docs/GetShipmentByExternalIdResponseBody.md +5 -6
- data/docs/GetShipmentByIdResponseBody.md +5 -6
- data/docs/GetTrackingLogFromLabelResponseBody.md +5 -6
- data/docs/GetTrackingLogResponseBody.md +5 -6
- data/docs/GetWarehouseByIdResponseBody.md +5 -6
- data/docs/GetWebhookByIdResponseBody.md +5 -6
- data/docs/InsuranceApi.md +24 -32
- data/docs/InsuranceProvider.md +5 -6
- data/docs/InternationalShipmentOptions.md +7 -9
- data/docs/Label.md +34 -34
- data/docs/LabelChargeEvent.md +5 -6
- data/docs/LabelDownload.md +8 -10
- data/docs/LabelDownloadType.md +5 -6
- data/docs/LabelFormat.md +5 -6
- data/docs/LabelLayout.md +5 -6
- data/docs/LabelMessages.md +7 -9
- data/docs/LabelStatus.md +5 -6
- data/docs/LabelsApi.md +89 -109
- data/docs/Link.md +5 -6
- data/docs/ListBatchErrorsResponseBody.md +6 -8
- data/docs/ListBatchesResponseBody.md +9 -11
- data/docs/ListCarrierPackageTypesResponseBody.md +5 -7
- data/docs/ListCarrierServicesResponseBody.md +5 -7
- data/docs/ListCarriersResponseBody.md +5 -7
- data/docs/ListLabelsResponseBody.md +5 -7
- data/docs/ListManifestsResponseBody.md +9 -11
- data/docs/ListPackageTypesResponseBody.md +5 -7
- data/docs/ListShipmentErrorsResponseBody.md +6 -8
- data/docs/ListShipmentRatesResponseBody.md +5 -6
- data/docs/ListShipmentsResponseBody.md +9 -11
- data/docs/ListTagsResponseBody.md +5 -7
- data/docs/ListWarehousesResponseBody.md +5 -7
- data/docs/Manifest.md +13 -15
- data/docs/ManifestDownload.md +5 -7
- data/docs/Manifests.md +5 -7
- data/docs/ManifestsApi.md +33 -41
- data/docs/ModifyBatch.md +6 -8
- data/docs/MonetaryValue.md +6 -8
- data/docs/NonDelivery.md +5 -6
- data/docs/OptionalLink.md +6 -8
- data/docs/OrderSourceName.md +5 -6
- data/docs/Package.md +11 -13
- data/docs/PackageContents.md +5 -6
- data/docs/PackageType.md +9 -11
- data/docs/PackageTypesApi.md +33 -44
- data/docs/PagedListResponseBody.md +8 -10
- data/docs/PaginationLink.md +8 -10
- data/docs/ParseAddressRequestBody.md +6 -8
- data/docs/ParseAddressResponseBody.md +7 -9
- data/docs/ParseShipmentRequestBody.md +6 -8
- data/docs/ParseShipmentResponseBody.md +7 -9
- data/docs/PartialAddress.md +15 -17
- data/docs/PartialShipment.md +26 -28
- data/docs/PaymentAmount.md +6 -8
- data/docs/ProcessBatchRequestBody.md +7 -9
- data/docs/PurchaseLabelWithoutShipment.md +8 -10
- data/docs/Rate.md +29 -31
- data/docs/RateEstimateByCarrierId.md +5 -7
- data/docs/RateEstimateByCarrierIds.md +3 -3
- data/docs/RateEstimateOptions.md +17 -19
- data/docs/RateRequestBody.md +9 -11
- data/docs/RateRequestByShipmentIds.md +5 -7
- data/docs/RateRequestByShipments.md +5 -7
- data/docs/RateRequestOptions.md +5 -7
- data/docs/RateRequestRateOptions.md +5 -7
- data/docs/RateResponse.md +5 -7
- data/docs/RateResponseStatus.md +5 -6
- data/docs/RateType.md +5 -6
- data/docs/RatesApi.md +31 -41
- data/docs/RatesInformation.md +11 -13
- data/docs/RecognizedEntity.md +10 -12
- data/docs/RemoveFromBatchRequestBody.md +5 -6
- data/docs/ResponseMessage.md +8 -10
- data/docs/Service.md +11 -13
- data/docs/Shipment.md +5 -6
- data/docs/ShipmentIdRequest.md +5 -7
- data/docs/ShipmentItem.md +13 -15
- data/docs/ShipmentRequest.md +5 -7
- data/docs/ShipmentResponseError.md +7 -9
- data/docs/ShipmentStatus.md +5 -6
- data/docs/ShipmentsApi.md +101 -125
- data/docs/ShipmentsSortBy.md +5 -6
- data/docs/SmartPostHub.md +5 -6
- data/docs/SortDir.md +5 -6
- data/docs/Tag.md +5 -7
- data/docs/TagShipmentResponseBody.md +6 -8
- data/docs/TagsApi.md +29 -38
- data/docs/TrackEvent.md +16 -18
- data/docs/TrackingApi.md +25 -33
- data/docs/TrackingInformation.md +14 -16
- data/docs/TrackingStatus.md +5 -6
- data/docs/UpdateAmazonBuyShippingRequestBody.md +3 -3
- data/docs/UpdateCarrierSettingsRequestBody.md +22 -24
- data/docs/UpdateDhlExpressSettingsRequestBody.md +5 -6
- data/docs/UpdateFedexSettingsRequestBody.md +5 -6
- data/docs/UpdateNewgisticsSettingsRequestBody.md +6 -8
- data/docs/UpdatePackageTypeRequestBody.md +5 -6
- data/docs/UpdateShipmentFields.md +5 -7
- data/docs/UpdateShipmentRequestBody.md +27 -29
- data/docs/UpdateShipmentResponseBody.md +5 -6
- data/docs/UpdateUpsSettingsRequestBody.md +5 -6
- data/docs/UpdateWarehouseRequestBody.md +5 -6
- data/docs/UpdateWebhookRequestBody.md +5 -7
- data/docs/UpsAccountSettings.md +16 -18
- data/docs/UpsInvoice.md +8 -10
- data/docs/UpsPickupType.md +5 -6
- data/docs/UpsSettingsResponseBody.md +5 -6
- data/docs/ValidateAddress.md +5 -6
- data/docs/ValidateShipmentFields.md +5 -7
- data/docs/ValidationStatus.md +5 -6
- data/docs/VoidLabelResponseBody.md +6 -8
- data/docs/Warehouse.md +9 -11
- data/docs/WarehousesApi.md +34 -45
- data/docs/Webhook.md +7 -9
- data/docs/WebhookEvent.md +5 -6
- data/docs/WebhooksApi.md +33 -44
- data/docs/Weight.md +6 -8
- data/docs/WeightUnit.md +5 -6
- data/lib/ship_engine.rb +278 -0
- data/lib/{openapi_client → ship_engine}/api/addresses_api.rb +14 -14
- data/lib/{openapi_client → ship_engine}/api/batches_api.rb +42 -42
- data/lib/{openapi_client → ship_engine}/api/carrier_accounts_api.rb +14 -14
- data/lib/{openapi_client → ship_engine}/api/carriers_api.rb +16 -16
- data/lib/{openapi_client → ship_engine}/api/downloads_api.rb +12 -12
- data/lib/{openapi_client → ship_engine}/api/insurance_api.rb +16 -16
- data/lib/{openapi_client → ship_engine}/api/labels_api.rb +43 -43
- data/lib/{openapi_client → ship_engine}/api/manifests_api.rb +15 -15
- data/lib/{openapi_client → ship_engine}/api/package_types_api.rb +16 -16
- data/lib/{openapi_client → ship_engine}/api/rates_api.rb +18 -18
- data/lib/{openapi_client → ship_engine}/api/shipments_api.rb +50 -50
- data/lib/{openapi_client → ship_engine}/api/tags_api.rb +18 -18
- data/lib/{openapi_client → ship_engine}/api/tracking_api.rb +10 -10
- data/lib/{openapi_client → ship_engine}/api/warehouses_api.rb +18 -18
- data/lib/{openapi_client → ship_engine}/api/webhooks_api.rb +16 -16
- data/lib/{openapi_client → ship_engine}/api_client.rb +2 -2
- data/lib/{openapi_client → ship_engine}/api_error.rb +2 -2
- data/lib/{openapi_client → ship_engine}/configuration.rb +2 -2
- data/lib/ship_engine/models/add_funds_to_carrier_request_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/add_funds_to_carrier_response_body.rb +5 -5
- data/lib/{openapi_client/models/create_warehouse_response_body.rb → ship_engine/models/add_funds_to_insurance_request_body.rb} +8 -8
- data/lib/{openapi_client/models/add_funds_to_carrier_request_body.rb → ship_engine/models/add_funds_to_insurance_response_body.rb} +7 -7
- data/lib/{openapi_client → ship_engine}/models/add_to_batch_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/address.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/address_residential_indicator.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/address_to_validate.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/address_validating_shipment.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/address_validation_code.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/address_validation_detail_code.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/address_validation_message_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/address_validation_result.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/address_validation_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/advanced_shipment_options.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/ancillary_service_endorsement.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/batch.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/batch_response_error.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/batch_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/batches_sort_by.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/bill_to_party.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/bulk_rate.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/calculate_rates_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/calculate_rates_response_body.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/carrier.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/carrier_advanced_option.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/carrier_name.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/carrier_name_with_settings.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/collect_on_delivery.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/collect_on_delivery_payment_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/compare_bulk_rates_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_access_worldwide_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_amazon_buy_shipping_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_apc_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_asendia_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_australia_post_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_canada_post_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_carrier_request_body.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/connect_carrier_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_ecommerce_request_body.rb +7 -7
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_au_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_ca_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_uk_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dpd_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_endicia_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_fedex_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_fedex_uk_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_firstmile_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_globegistics_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_imex_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_insurer_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_newgistics_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_ontrac_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_purolator_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_royal_mail_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_rr_donnelley_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_seko_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_sendle_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_stamps_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_ups_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_and_validate_shipment.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/create_batch_request_body.rb +5 -5
- data/lib/ship_engine/models/create_batch_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/create_label_from_rate_request_body.rb +5 -5
- data/lib/{openapi_client/models/get_warehouse_by_id_response_body.rb → ship_engine/models/create_label_from_rate_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/create_label_from_shipment_request_body.rb +5 -5
- data/lib/{openapi_client/models/get_batch_by_external_id_response_body.rb → ship_engine/models/create_label_from_shipment_response_body.rb} +8 -8
- data/lib/ship_engine/models/create_label_request_body.rb +209 -0
- data/lib/ship_engine/models/create_label_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/create_manifest_by_object_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_manifest_label_ids_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_manifest_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_manifest_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_package_type_request_body.rb +5 -5
- data/lib/{openapi_client/models/get_carrier_by_id_response_body.rb → ship_engine/models/create_package_type_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/create_return_label_request_body.rb +8 -8
- data/lib/{openapi_client/models/get_webhook_by_id_response_body.rb → ship_engine/models/create_return_label_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/create_shipment_response_body_fields.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_shipments_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_shipments_response_body.rb +5 -5
- data/lib/ship_engine/models/create_tag_response_body.rb +209 -0
- data/lib/{openapi_client/models/create_batch_response_body.rb → ship_engine/models/create_warehouse_request_body.rb} +8 -8
- data/lib/{openapi_client/models/get_batch_by_id_response_body.rb → ship_engine/models/create_warehouse_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/create_webhook_request_body.rb +5 -5
- data/lib/{openapi_client/models/create_label_request_body.rb → ship_engine/models/create_webhook_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/currency.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/customs_item.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/delivery_confirmation.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/deprecated_manifest.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/dhl_express_account_settings.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/dhl_express_settings_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/dimension_unit.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/dimensions.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/error.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/error_code.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/error_response_body.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/error_source.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/error_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/estimate_rates_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/fedex_account_settings.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/fedex_account_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/fedex_pickup_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/fedex_settings_response_body.rb +5 -5
- data/lib/{openapi_client/models/create_return_label_response_body.rb → ship_engine/models/get_batch_by_external_id_response_body.rb} +8 -8
- data/lib/{openapi_client/models/create_tag_response_body.rb → ship_engine/models/get_batch_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client/models/create_label_response_body.rb → ship_engine/models/get_carrier_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/get_carrier_options_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/get_carrier_settings_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/get_carriers_response_body.rb +6 -6
- data/lib/ship_engine/models/get_insurance_balance_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/get_label_by_external_shipment_id_response_body.rb +5 -5
- data/lib/ship_engine/models/get_label_by_id_response_body.rb +209 -0
- data/lib/{openapi_client/models/get_label_by_id_response_body.rb → ship_engine/models/get_manifest_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client/models/get_shipment_by_id_response_body.rb → ship_engine/models/get_package_type_by_id_response_body.rb} +8 -8
- data/lib/ship_engine/models/get_rate_by_id_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/get_shipment_by_external_id_response_body.rb +5 -5
- data/lib/ship_engine/models/get_shipment_by_id_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/get_tracking_log_from_label_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/get_tracking_log_response_body.rb +5 -5
- data/lib/{openapi_client/models/create_webhook_response_body.rb → ship_engine/models/get_warehouse_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client/models/get_rate_by_id_response_body.rb → ship_engine/models/get_webhook_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/insurance_provider.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/international_shipment_options.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/label.rb +29 -29
- data/lib/{openapi_client → ship_engine}/models/label_charge_event.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/label_download.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/label_download_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/label_format.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/label_layout.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/label_messages.rb +9 -9
- data/lib/{openapi_client → ship_engine}/models/label_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/link.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_batch_errors_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_batches_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_carrier_package_types_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_carrier_services_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_carriers_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_labels_response_body.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/list_manifests_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_package_types_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_shipment_errors_response_body.rb +5 -5
- data/lib/{openapi_client/models/create_warehouse_request_body.rb → ship_engine/models/list_shipment_rates_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/list_shipments_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_tags_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_warehouses_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/manifest.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/manifest_download.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/manifests.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/modify_batch.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/monetary_value.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/non_delivery.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/optional_link.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/order_source_name.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/package.rb +8 -8
- data/lib/{openapi_client → ship_engine}/models/package_contents.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/package_type.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/paged_list_response_body.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/pagination_link.rb +9 -9
- data/lib/{openapi_client → ship_engine}/models/parse_address_request_body.rb +7 -7
- data/lib/{openapi_client → ship_engine}/models/parse_address_response_body.rb +9 -9
- data/lib/{openapi_client → ship_engine}/models/parse_shipment_request_body.rb +7 -7
- data/lib/{openapi_client → ship_engine}/models/parse_shipment_response_body.rb +9 -9
- data/lib/{openapi_client → ship_engine}/models/partial_address.rb +13 -13
- data/lib/{openapi_client → ship_engine}/models/partial_shipment.rb +17 -17
- data/lib/{openapi_client → ship_engine}/models/payment_amount.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/process_batch_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/purchase_label_without_shipment.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate.rb +7 -7
- data/lib/{openapi_client → ship_engine}/models/rate_estimate_by_carrier_id.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_estimate_by_carrier_ids.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_estimate_options.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_by_shipment_ids.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_by_shipments.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_options.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_rate_options.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_response.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_response_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/rate_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/rates_information.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/recognized_entity.rb +8 -8
- data/lib/{openapi_client → ship_engine}/models/remove_from_batch_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/response_message.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/service.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/shipment_id_request.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment_item.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment_request.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment_response_error.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/shipments_sort_by.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/smart_post_hub.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/sort_dir.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/tag.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/tag_shipment_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/track_event.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/tracking_information.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/tracking_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/update_amazon_buy_shipping_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_carrier_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_dhl_express_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_fedex_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_newgistics_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_package_type_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_shipment_fields.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_shipment_request_body.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/update_shipment_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_ups_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_warehouse_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_webhook_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/ups_account_settings.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/ups_invoice.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/ups_pickup_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/ups_settings_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/validate_address.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/validate_shipment_fields.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/validation_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/void_label_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/warehouse.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/webhook.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/webhook_event.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/weight.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/weight_unit.rb +2 -2
- data/lib/{openapi_client → ship_engine}/version.rb +3 -3
- data/ship_engine-1.0.0.gem +0 -0
- data/ship_engine.gemspec +2 -2
- data/spec/api/addresses_api_spec.rb +8 -8
- data/spec/api/batches_api_spec.rb +15 -15
- data/spec/api/carrier_accounts_api_spec.rb +6 -6
- data/spec/api/carriers_api_spec.rb +5 -5
- data/spec/api/downloads_api_spec.rb +8 -8
- data/spec/api/insurance_api_spec.rb +7 -7
- data/spec/api/labels_api_spec.rb +16 -16
- data/spec/api/manifests_api_spec.rb +8 -8
- data/spec/api/package_types_api_spec.rb +6 -6
- data/spec/api/rates_api_spec.rb +8 -8
- data/spec/api/shipments_api_spec.rb +18 -18
- data/spec/api/tags_api_spec.rb +8 -8
- data/spec/api/tracking_api_spec.rb +5 -5
- data/spec/api/warehouses_api_spec.rb +7 -7
- data/spec/api/webhooks_api_spec.rb +6 -6
- data/spec/api_client_spec.rb +24 -24
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/add_funds_to_carrier_request_body_spec.rb +4 -4
- data/spec/models/add_funds_to_carrier_response_body_spec.rb +4 -4
- data/spec/models/add_funds_to_insurance_request_body_spec.rb +4 -4
- data/spec/models/add_funds_to_insurance_response_body_spec.rb +4 -4
- data/spec/models/add_to_batch_request_body_spec.rb +4 -4
- data/spec/models/address_residential_indicator_spec.rb +4 -4
- data/spec/models/address_spec.rb +4 -4
- data/spec/models/address_to_validate_spec.rb +4 -4
- data/spec/models/address_validating_shipment_spec.rb +4 -4
- data/spec/models/address_validation_code_spec.rb +4 -4
- data/spec/models/address_validation_detail_code_spec.rb +4 -4
- data/spec/models/address_validation_message_type_spec.rb +4 -4
- data/spec/models/address_validation_result_spec.rb +4 -4
- data/spec/models/address_validation_status_spec.rb +4 -4
- data/spec/models/advanced_shipment_options_spec.rb +4 -4
- data/spec/models/ancillary_service_endorsement_spec.rb +4 -4
- data/spec/models/batch_response_error_spec.rb +4 -4
- data/spec/models/batch_spec.rb +4 -4
- data/spec/models/batch_status_spec.rb +4 -4
- data/spec/models/batches_sort_by_spec.rb +4 -4
- data/spec/models/bill_to_party_spec.rb +4 -4
- data/spec/models/bulk_rate_spec.rb +4 -4
- data/spec/models/calculate_rates_request_body_spec.rb +4 -4
- data/spec/models/calculate_rates_response_body_spec.rb +4 -4
- data/spec/models/carrier_advanced_option_spec.rb +4 -4
- data/spec/models/carrier_name_spec.rb +4 -4
- data/spec/models/carrier_name_with_settings_spec.rb +4 -4
- data/spec/models/carrier_spec.rb +4 -4
- data/spec/models/collect_on_delivery_payment_type_spec.rb +4 -4
- data/spec/models/collect_on_delivery_spec.rb +4 -4
- data/spec/models/compare_bulk_rates_request_body_spec.rb +4 -4
- data/spec/models/connect_access_worldwide_request_body_spec.rb +4 -4
- data/spec/models/connect_amazon_buy_shipping_request_body_spec.rb +4 -4
- data/spec/models/connect_apc_request_body_spec.rb +4 -4
- data/spec/models/connect_asendia_request_body_spec.rb +4 -4
- data/spec/models/connect_australia_post_request_body_spec.rb +4 -4
- data/spec/models/connect_canada_post_request_body_spec.rb +4 -4
- data/spec/models/connect_carrier_request_body_spec.rb +4 -4
- data/spec/models/connect_carrier_response_body_spec.rb +4 -4
- data/spec/models/connect_dhl_ecommerce_request_body_spec.rb +4 -4
- data/spec/models/connect_dhl_express_au_request_body_spec.rb +4 -4
- data/spec/models/connect_dhl_express_ca_request_body_spec.rb +4 -4
- data/spec/models/connect_dhl_express_request_body_spec.rb +4 -4
- data/spec/models/connect_dhl_express_uk_request_body_spec.rb +4 -4
- data/spec/models/connect_dpd_request_body_spec.rb +4 -4
- data/spec/models/connect_endicia_request_body_spec.rb +4 -4
- data/spec/models/connect_fedex_request_body_spec.rb +4 -4
- data/spec/models/connect_fedex_uk_request_body_spec.rb +4 -4
- data/spec/models/connect_firstmile_request_body_spec.rb +4 -4
- data/spec/models/connect_globegistics_request_body_spec.rb +4 -4
- data/spec/models/connect_imex_request_body_spec.rb +4 -4
- data/spec/models/connect_insurer_request_body_spec.rb +4 -4
- data/spec/models/connect_newgistics_request_body_spec.rb +4 -4
- data/spec/models/connect_ontrac_request_body_spec.rb +4 -4
- data/spec/models/connect_purolator_request_body_spec.rb +4 -4
- data/spec/models/connect_royal_mail_request_body_spec.rb +4 -4
- data/spec/models/connect_rr_donnelley_request_body_spec.rb +4 -4
- data/spec/models/connect_seko_request_body_spec.rb +4 -4
- data/spec/models/connect_sendle_request_body_spec.rb +4 -4
- data/spec/models/connect_stamps_request_body_spec.rb +4 -4
- data/spec/models/connect_ups_request_body_spec.rb +4 -4
- data/spec/models/create_and_validate_shipment_spec.rb +4 -4
- data/spec/models/create_batch_request_body_spec.rb +4 -4
- data/spec/models/create_batch_response_body_spec.rb +4 -4
- data/spec/models/create_label_from_rate_request_body_spec.rb +4 -4
- data/spec/models/create_label_from_rate_response_body_spec.rb +4 -4
- data/spec/models/create_label_from_shipment_request_body_spec.rb +4 -4
- data/spec/models/create_label_from_shipment_response_body_spec.rb +4 -4
- data/spec/models/create_label_request_body_spec.rb +4 -4
- data/spec/models/create_label_response_body_spec.rb +4 -4
- data/spec/models/create_manifest_by_object_request_body_spec.rb +4 -4
- data/spec/models/create_manifest_label_ids_request_body_spec.rb +4 -4
- data/spec/models/create_manifest_request_body_spec.rb +4 -4
- data/spec/models/create_manifest_response_body_spec.rb +4 -4
- data/spec/models/create_package_type_request_body_spec.rb +4 -4
- data/spec/models/create_package_type_response_body_spec.rb +4 -4
- data/spec/models/create_return_label_request_body_spec.rb +4 -4
- data/spec/models/create_return_label_response_body_spec.rb +4 -4
- data/spec/models/create_shipment_response_body_fields_spec.rb +4 -4
- data/spec/models/create_shipments_request_body_spec.rb +4 -4
- data/spec/models/create_shipments_response_body_spec.rb +4 -4
- data/spec/models/create_tag_response_body_spec.rb +4 -4
- data/spec/models/create_warehouse_request_body_spec.rb +4 -4
- data/spec/models/create_warehouse_response_body_spec.rb +4 -4
- data/spec/models/create_webhook_request_body_spec.rb +4 -4
- data/spec/models/create_webhook_response_body_spec.rb +4 -4
- data/spec/models/currency_spec.rb +4 -4
- data/spec/models/customs_item_spec.rb +4 -4
- data/spec/models/delivery_confirmation_spec.rb +4 -4
- data/spec/models/deprecated_manifest_spec.rb +4 -4
- data/spec/models/dhl_express_account_settings_spec.rb +4 -4
- data/spec/models/dhl_express_settings_response_body_spec.rb +4 -4
- data/spec/models/dimension_unit_spec.rb +4 -4
- data/spec/models/dimensions_spec.rb +4 -4
- data/spec/models/error_code_spec.rb +4 -4
- data/spec/models/error_response_body_spec.rb +4 -4
- data/spec/models/error_source_spec.rb +4 -4
- data/spec/models/error_spec.rb +4 -4
- data/spec/models/error_type_spec.rb +4 -4
- data/spec/models/estimate_rates_request_body_spec.rb +4 -4
- data/spec/models/fedex_account_settings_request_body_spec.rb +4 -4
- data/spec/models/fedex_account_settings_spec.rb +4 -4
- data/spec/models/fedex_pickup_type_spec.rb +4 -4
- data/spec/models/fedex_settings_response_body_spec.rb +4 -4
- data/spec/models/get_batch_by_external_id_response_body_spec.rb +4 -4
- data/spec/models/get_batch_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_carrier_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_carrier_options_response_body_spec.rb +4 -4
- data/spec/models/get_carrier_settings_response_body_spec.rb +4 -4
- data/spec/models/get_carriers_response_body_spec.rb +4 -4
- data/spec/models/get_insurance_balance_response_body_spec.rb +4 -4
- data/spec/models/get_label_by_external_shipment_id_response_body_spec.rb +4 -4
- data/spec/models/get_label_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_manifest_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_package_type_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_rate_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_shipment_by_external_id_response_body_spec.rb +4 -4
- data/spec/models/get_shipment_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_tracking_log_from_label_response_body_spec.rb +4 -4
- data/spec/models/get_tracking_log_response_body_spec.rb +4 -4
- data/spec/models/get_warehouse_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_webhook_by_id_response_body_spec.rb +4 -4
- data/spec/models/insurance_provider_spec.rb +4 -4
- data/spec/models/international_shipment_options_spec.rb +4 -4
- data/spec/models/label_charge_event_spec.rb +4 -4
- data/spec/models/label_download_spec.rb +4 -4
- data/spec/models/label_download_type_spec.rb +4 -4
- data/spec/models/label_format_spec.rb +4 -4
- data/spec/models/label_layout_spec.rb +4 -4
- data/spec/models/label_messages_spec.rb +4 -4
- data/spec/models/label_spec.rb +4 -4
- data/spec/models/label_status_spec.rb +4 -4
- data/spec/models/link_spec.rb +4 -4
- data/spec/models/list_batch_errors_response_body_spec.rb +4 -4
- data/spec/models/list_batches_response_body_spec.rb +4 -4
- data/spec/models/list_carrier_package_types_response_body_spec.rb +4 -4
- data/spec/models/list_carrier_services_response_body_spec.rb +4 -4
- data/spec/models/list_carriers_response_body_spec.rb +4 -4
- data/spec/models/list_labels_response_body_spec.rb +4 -4
- data/spec/models/list_manifests_response_body_spec.rb +4 -4
- data/spec/models/list_package_types_response_body_spec.rb +4 -4
- data/spec/models/list_shipment_errors_response_body_spec.rb +4 -4
- data/spec/models/list_shipment_rates_response_body_spec.rb +4 -4
- data/spec/models/list_shipments_response_body_spec.rb +4 -4
- data/spec/models/list_tags_response_body_spec.rb +4 -4
- data/spec/models/list_warehouses_response_body_spec.rb +4 -4
- data/spec/models/manifest_download_spec.rb +4 -4
- data/spec/models/manifest_spec.rb +4 -4
- data/spec/models/manifests_spec.rb +4 -4
- data/spec/models/modify_batch_spec.rb +4 -4
- data/spec/models/monetary_value_spec.rb +4 -4
- data/spec/models/non_delivery_spec.rb +4 -4
- data/spec/models/optional_link_spec.rb +4 -4
- data/spec/models/order_source_name_spec.rb +4 -4
- data/spec/models/package_contents_spec.rb +4 -4
- data/spec/models/package_spec.rb +4 -4
- data/spec/models/package_type_spec.rb +4 -4
- data/spec/models/paged_list_response_body_spec.rb +4 -4
- data/spec/models/pagination_link_spec.rb +4 -4
- data/spec/models/parse_address_request_body_spec.rb +4 -4
- data/spec/models/parse_address_response_body_spec.rb +4 -4
- data/spec/models/parse_shipment_request_body_spec.rb +4 -4
- data/spec/models/parse_shipment_response_body_spec.rb +4 -4
- data/spec/models/partial_address_spec.rb +4 -4
- data/spec/models/partial_shipment_spec.rb +4 -4
- data/spec/models/payment_amount_spec.rb +4 -4
- data/spec/models/process_batch_request_body_spec.rb +4 -4
- data/spec/models/purchase_label_without_shipment_spec.rb +4 -4
- data/spec/models/rate_estimate_by_carrier_id_spec.rb +4 -4
- data/spec/models/rate_estimate_by_carrier_ids_spec.rb +4 -4
- data/spec/models/rate_estimate_options_spec.rb +4 -4
- data/spec/models/rate_request_body_spec.rb +4 -4
- data/spec/models/rate_request_by_shipment_ids_spec.rb +4 -4
- data/spec/models/rate_request_by_shipments_spec.rb +4 -4
- data/spec/models/rate_request_options_spec.rb +4 -4
- data/spec/models/rate_request_rate_options_spec.rb +4 -4
- data/spec/models/rate_response_spec.rb +4 -4
- data/spec/models/rate_response_status_spec.rb +4 -4
- data/spec/models/rate_spec.rb +4 -4
- data/spec/models/rate_type_spec.rb +4 -4
- data/spec/models/rates_information_spec.rb +4 -4
- data/spec/models/recognized_entity_spec.rb +4 -4
- data/spec/models/remove_from_batch_request_body_spec.rb +4 -4
- data/spec/models/response_message_spec.rb +4 -4
- data/spec/models/service_spec.rb +4 -4
- data/spec/models/shipment_id_request_spec.rb +4 -4
- data/spec/models/shipment_item_spec.rb +4 -4
- data/spec/models/shipment_request_spec.rb +4 -4
- data/spec/models/shipment_response_error_spec.rb +4 -4
- data/spec/models/shipment_spec.rb +4 -4
- data/spec/models/shipment_status_spec.rb +4 -4
- data/spec/models/shipments_sort_by_spec.rb +4 -4
- data/spec/models/smart_post_hub_spec.rb +4 -4
- data/spec/models/sort_dir_spec.rb +4 -4
- data/spec/models/tag_shipment_response_body_spec.rb +4 -4
- data/spec/models/tag_spec.rb +4 -4
- data/spec/models/track_event_spec.rb +4 -4
- data/spec/models/tracking_information_spec.rb +4 -4
- data/spec/models/tracking_status_spec.rb +4 -4
- data/spec/models/update_amazon_buy_shipping_request_body_spec.rb +4 -4
- data/spec/models/update_carrier_settings_request_body_spec.rb +4 -4
- data/spec/models/update_dhl_express_settings_request_body_spec.rb +4 -4
- data/spec/models/update_fedex_settings_request_body_spec.rb +4 -4
- data/spec/models/update_newgistics_settings_request_body_spec.rb +4 -4
- data/spec/models/update_package_type_request_body_spec.rb +4 -4
- data/spec/models/update_shipment_fields_spec.rb +4 -4
- data/spec/models/update_shipment_request_body_spec.rb +4 -4
- data/spec/models/update_shipment_response_body_spec.rb +4 -4
- data/spec/models/update_ups_settings_request_body_spec.rb +4 -4
- data/spec/models/update_warehouse_request_body_spec.rb +4 -4
- data/spec/models/update_webhook_request_body_spec.rb +4 -4
- data/spec/models/ups_account_settings_spec.rb +4 -4
- data/spec/models/ups_invoice_spec.rb +4 -4
- data/spec/models/ups_pickup_type_spec.rb +4 -4
- data/spec/models/ups_settings_response_body_spec.rb +4 -4
- data/spec/models/validate_address_spec.rb +4 -4
- data/spec/models/validate_shipment_fields_spec.rb +4 -4
- data/spec/models/validation_status_spec.rb +4 -4
- data/spec/models/void_label_response_body_spec.rb +4 -4
- data/spec/models/warehouse_spec.rb +4 -4
- data/spec/models/webhook_event_spec.rb +4 -4
- data/spec/models/webhook_spec.rb +4 -4
- data/spec/models/weight_spec.rb +4 -4
- data/spec/models/weight_unit_spec.rb +4 -4
- metadata +246 -246
- data/lib/openapi_client.rb +0 -278
- data/lib/openapi_client/models/add_funds_to_insurance_request_body.rb +0 -209
- data/lib/openapi_client/models/add_funds_to_insurance_response_body.rb +0 -209
- data/lib/openapi_client/models/create_label_from_rate_response_body.rb +0 -209
- data/lib/openapi_client/models/create_label_from_shipment_response_body.rb +0 -209
- data/lib/openapi_client/models/create_package_type_response_body.rb +0 -209
- data/lib/openapi_client/models/get_insurance_balance_response_body.rb +0 -209
- data/lib/openapi_client/models/get_manifest_by_id_response_body.rb +0 -209
- data/lib/openapi_client/models/get_package_type_by_id_response_body.rb +0 -209
- data/lib/openapi_client/models/list_shipment_rates_response_body.rb +0 -209
- data/openapi_client-1.0.0.gem +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a82d2d4f04716808c275599f57d08fd9e404ff4cf2da2b32c1cf33eb133f7e32
|
|
4
|
+
data.tar.gz: 6193a435421db2b42233d14b0f24e52f9702d1a2e5e11a216f8265e75f72edcc
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b927ea1e8160dd7d68a07b25a30fd4a4c2ef3cec83df5556fb0e75d09b7320c81a7185400493671bd772dbf742d3d45febee4d6c11f59c604902d3c52be1c319
|
|
7
|
+
data.tar.gz: d425bc94ccf13a35e70c6083bff464387890dad06c556e1235c2a0536a46d7c612daa3de1c39e9704f2d2bd130b1625c3294cbeb6d9f2c5cc544c68ae04ce891
|
data/README.md
CHANGED
|
@@ -7,38 +7,38 @@ ShipEngine's easy-to-use REST API lets you manage all of your shipping needs wit
|
|
|
7
7
|
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.
|
|
8
8
|
|
|
9
9
|
## Getting Started
|
|
10
|
+
|
|
10
11
|
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.
|
|
11
12
|
|
|
12
13
|
Here are some step-by-step **tutorials** to get you started:
|
|
13
14
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
15
|
+
- [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/)
|
|
16
|
+
- [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/)
|
|
17
|
+
- [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/)
|
|
18
|
+
- [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/)
|
|
19
19
|
|
|
20
20
|
## Shipping Labels for Every Major Carrier
|
|
21
|
-
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/).
|
|
22
21
|
|
|
22
|
+
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/).
|
|
23
23
|
|
|
24
24
|
## Real-Time Package Tracking
|
|
25
|
-
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.
|
|
26
25
|
|
|
26
|
+
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.
|
|
27
27
|
|
|
28
28
|
## Compare Shipping Costs Across Carriers
|
|
29
|
-
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.
|
|
30
29
|
|
|
30
|
+
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.
|
|
31
31
|
|
|
32
32
|
## Worldwide Address Validation
|
|
33
|
-
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.
|
|
34
33
|
|
|
34
|
+
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.
|
|
35
35
|
|
|
36
36
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
37
37
|
|
|
38
38
|
- API version: 1.1.202006302006
|
|
39
39
|
- Package version: 1.0.0
|
|
40
40
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
41
|
-
For more information, please visit [https://www.shipengine.com/contact/](https://www.shipengine.com/contact/)
|
|
41
|
+
For more information, please visit [https://www.shipengine.com/contact/](https://www.shipengine.com/contact/)
|
|
42
42
|
|
|
43
43
|
## Installation
|
|
44
44
|
|
|
@@ -94,14 +94,14 @@ OpenapiClient.configure do |config|
|
|
|
94
94
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
95
95
|
end
|
|
96
96
|
|
|
97
|
-
api_instance =
|
|
98
|
-
parse_address_request_body = {"text":"Margie McMiller at 3800 North Lamar suite 200 in austin, tx. The zip code there is 78652."} # ParseAddressRequestBody | The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.
|
|
97
|
+
api_instance = ShipEngine::AddressesApi.new
|
|
98
|
+
parse_address_request_body = {"text":"Margie McMiller at 3800 North Lamar suite 200 in austin, tx. The zip code there is 78652."} # ParseAddressRequestBody | The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.
|
|
99
99
|
|
|
100
100
|
begin
|
|
101
101
|
#Parse an address
|
|
102
102
|
result = api_instance.parse_address(parse_address_request_body)
|
|
103
103
|
p result
|
|
104
|
-
rescue
|
|
104
|
+
rescue ShipEngine::ApiError => e
|
|
105
105
|
puts "Exception when calling AddressesApi->parse_address: #{e}"
|
|
106
106
|
end
|
|
107
107
|
|
|
@@ -111,321 +111,316 @@ end
|
|
|
111
111
|
|
|
112
112
|
All URIs are relative to *https://api.shipengine.com*
|
|
113
113
|
|
|
114
|
-
Class
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
114
|
+
| Class | Method | HTTP request | Description |
|
|
115
|
+
| -------------------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------- |
|
|
116
|
+
| _ShipEngine::AddressesApi_ | [**parse_address**](docs/AddressesApi.md#parse_address) | **PUT** /v1/addresses/recognize | Parse an address |
|
|
117
|
+
| _ShipEngine::AddressesApi_ | [**validate_address**](docs/AddressesApi.md#validate_address) | **POST** /v1/addresses/validate | Validate An Address |
|
|
118
|
+
| _ShipEngine::BatchesApi_ | [**add_to_batch**](docs/BatchesApi.md#add_to_batch) | **POST** /v1/batches/{batch_id}/add | Add to a Batch |
|
|
119
|
+
| _ShipEngine::BatchesApi_ | [**create_batch**](docs/BatchesApi.md#create_batch) | **POST** /v1/batches | Create A Batch |
|
|
120
|
+
| _ShipEngine::BatchesApi_ | [**delete_batch**](docs/BatchesApi.md#delete_batch) | **DELETE** /v1/batches/{batch_id} | Delete Batch By Id |
|
|
121
|
+
| _ShipEngine::BatchesApi_ | [**get_batch_by_external_id**](docs/BatchesApi.md#get_batch_by_external_id) | **GET** /v1/batches/external_batch_id/{external_batch_id} | Get Batch By External ID |
|
|
122
|
+
| _ShipEngine::BatchesApi_ | [**get_batch_by_id**](docs/BatchesApi.md#get_batch_by_id) | **GET** /v1/batches/{batch_id} | Get Batch By ID |
|
|
123
|
+
| _ShipEngine::BatchesApi_ | [**list_batch_errors**](docs/BatchesApi.md#list_batch_errors) | **GET** /v1/batches/{batch_id}/errors | Get Batch Errors |
|
|
124
|
+
| _ShipEngine::BatchesApi_ | [**list_batches**](docs/BatchesApi.md#list_batches) | **GET** /v1/batches | List Batches |
|
|
125
|
+
| _ShipEngine::BatchesApi_ | [**process_batch**](docs/BatchesApi.md#process_batch) | **POST** /v1/batches/{batch_id}/process/labels | Process Batch ID Labels |
|
|
126
|
+
| _ShipEngine::BatchesApi_ | [**remove_from_batch**](docs/BatchesApi.md#remove_from_batch) | **POST** /v1/batches/{batch_id}/remove | Remove From Batch |
|
|
127
|
+
| _ShipEngine::BatchesApi_ | [**update_batch**](docs/BatchesApi.md#update_batch) | **PUT** /v1/batches/{batch_id} | Update Batch By Id |
|
|
128
|
+
| _ShipEngine::CarrierAccountsApi_ | [**connect_carrier**](docs/CarrierAccountsApi.md#connect_carrier) | **POST** /v1/connections/carriers/{carrier_name} | Connect a carrier account |
|
|
129
|
+
| _ShipEngine::CarrierAccountsApi_ | [**disconnect_carrier**](docs/CarrierAccountsApi.md#disconnect_carrier) | **DELETE** /v1/connections/carriers/{carrier_name}/{carrier_id} | Disconnect a carrier |
|
|
130
|
+
| _ShipEngine::CarrierAccountsApi_ | [**get_carrier_settings**](docs/CarrierAccountsApi.md#get_carrier_settings) | **GET** /v1/connections/carriers/{carrier_name}/{carrier_id}/settings | Get carrier settings |
|
|
131
|
+
| _ShipEngine::CarrierAccountsApi_ | [**update_carrier_settings**](docs/CarrierAccountsApi.md#update_carrier_settings) | **PUT** /v1/connections/carriers/{carrier_name}/{carrier_id}/settings | Update carrier settings |
|
|
132
|
+
| _ShipEngine::CarriersApi_ | [**add_funds_to_carrier**](docs/CarriersApi.md#add_funds_to_carrier) | **PUT** /v1/carriers/{carrier_id}/add_funds | Add Funds To Carrier |
|
|
133
|
+
| _ShipEngine::CarriersApi_ | [**get_carrier_by_id**](docs/CarriersApi.md#get_carrier_by_id) | **GET** /v1/carriers/{carrier_id} | Get Carrier By ID |
|
|
134
|
+
| _ShipEngine::CarriersApi_ | [**get_carrier_options**](docs/CarriersApi.md#get_carrier_options) | **GET** /v1/carriers/{carrier_id}/options | Get Carrier Options |
|
|
135
|
+
| _ShipEngine::CarriersApi_ | [**list_carrier_package_types**](docs/CarriersApi.md#list_carrier_package_types) | **GET** /v1/carriers/{carrier_id}/packages | List Carrier Package Types |
|
|
136
|
+
| _ShipEngine::CarriersApi_ | [**list_carrier_services**](docs/CarriersApi.md#list_carrier_services) | **GET** /v1/carriers/{carrier_id}/services | List Carrier Services |
|
|
137
|
+
| _ShipEngine::CarriersApi_ | [**list_carriers**](docs/CarriersApi.md#list_carriers) | **GET** /v1/carriers | List Carriers |
|
|
138
|
+
| _ShipEngine::DownloadsApi_ | [**download_file**](docs/DownloadsApi.md#download_file) | **GET** /v1/downloads/{dir}/{subdir}/{filename} | Download File |
|
|
139
|
+
| _ShipEngine::InsuranceApi_ | [**add_funds_to_insurance**](docs/InsuranceApi.md#add_funds_to_insurance) | **PATCH** /v1/insurance/shipsurance/add_funds | Add Funds To Insurance |
|
|
140
|
+
| _ShipEngine::InsuranceApi_ | [**connect_insurer**](docs/InsuranceApi.md#connect_insurer) | **POST** /v1/connections/insurance/shipsurance | Connect a Shipsurance Account |
|
|
141
|
+
| _ShipEngine::InsuranceApi_ | [**disconnect_insurer**](docs/InsuranceApi.md#disconnect_insurer) | **DELETE** /v1/connections/insurance/shipsurance | Disconnect a Shipsurance Account |
|
|
142
|
+
| _ShipEngine::InsuranceApi_ | [**get_insurance_balance**](docs/InsuranceApi.md#get_insurance_balance) | **GET** /v1/insurance/shipsurance/balance | Get Insurance Funds Balance |
|
|
143
|
+
| _ShipEngine::LabelsApi_ | [**create_label**](docs/LabelsApi.md#create_label) | **POST** /v1/labels | Purchase Label |
|
|
144
|
+
| _ShipEngine::LabelsApi_ | [**create_label_from_rate**](docs/LabelsApi.md#create_label_from_rate) | **POST** /v1/labels/rates/{rate_id} | Purchase Label with Rate ID |
|
|
145
|
+
| _ShipEngine::LabelsApi_ | [**create_label_from_shipment**](docs/LabelsApi.md#create_label_from_shipment) | **POST** /v1/labels/shipment/{shipment_id} | Purchase Label with Shipment ID |
|
|
146
|
+
| _ShipEngine::LabelsApi_ | [**create_return_label**](docs/LabelsApi.md#create_return_label) | **POST** /v1/labels/{label_id}/return | Create a return label |
|
|
147
|
+
| _ShipEngine::LabelsApi_ | [**get_label_by_external_shipment_id**](docs/LabelsApi.md#get_label_by_external_shipment_id) | **GET** /v1/labels/external_shipment_id/{external_shipment_id} | Get Label By External Shipment ID |
|
|
148
|
+
| _ShipEngine::LabelsApi_ | [**get_label_by_id**](docs/LabelsApi.md#get_label_by_id) | **GET** /v1/labels/{label_id} | Get Label By ID |
|
|
149
|
+
| _ShipEngine::LabelsApi_ | [**get_tracking_log_from_label**](docs/LabelsApi.md#get_tracking_log_from_label) | **GET** /v1/labels/{label_id}/track | Get Label Tracking Information |
|
|
150
|
+
| _ShipEngine::LabelsApi_ | [**list_labels**](docs/LabelsApi.md#list_labels) | **GET** /v1/labels | List labels |
|
|
151
|
+
| _ShipEngine::LabelsApi_ | [**void_label**](docs/LabelsApi.md#void_label) | **PUT** /v1/labels/{label_id}/void | Void a Label By ID |
|
|
152
|
+
| _ShipEngine::ManifestsApi_ | [**create_manifest**](docs/ManifestsApi.md#create_manifest) | **POST** /v1/manifests | Create Manifest |
|
|
153
|
+
| _ShipEngine::ManifestsApi_ | [**get_manifest_by_id**](docs/ManifestsApi.md#get_manifest_by_id) | **GET** /v1/manifests/{manifest_id} | Get Manifest By Id |
|
|
154
|
+
| _ShipEngine::ManifestsApi_ | [**list_manifests**](docs/ManifestsApi.md#list_manifests) | **GET** /v1/manifests | List Manifests |
|
|
155
|
+
| _ShipEngine::PackageTypesApi_ | [**create_package_type**](docs/PackageTypesApi.md#create_package_type) | **POST** /v1/packages | Create Custom Package Type |
|
|
156
|
+
| _ShipEngine::PackageTypesApi_ | [**delete_package_type**](docs/PackageTypesApi.md#delete_package_type) | **DELETE** /v1/packages/{package_id} | Delete A Custom Package By ID |
|
|
157
|
+
| _ShipEngine::PackageTypesApi_ | [**get_package_type_by_id**](docs/PackageTypesApi.md#get_package_type_by_id) | **GET** /v1/packages/{package_id} | Get Custom Package Type By ID |
|
|
158
|
+
| _ShipEngine::PackageTypesApi_ | [**list_package_types**](docs/PackageTypesApi.md#list_package_types) | **GET** /v1/packages | List Custom Package Types |
|
|
159
|
+
| _ShipEngine::PackageTypesApi_ | [**update_package_type**](docs/PackageTypesApi.md#update_package_type) | **PUT** /v1/packages/{package_id} | Update Custom Package Type By ID |
|
|
160
|
+
| _ShipEngine::RatesApi_ | [**calculate_rates**](docs/RatesApi.md#calculate_rates) | **POST** /v1/rates | Get Shipping Rates |
|
|
161
|
+
| _ShipEngine::RatesApi_ | [**compare_bulk_rates**](docs/RatesApi.md#compare_bulk_rates) | **POST** /v1/rates/bulk | Get Bulk Rates |
|
|
162
|
+
| _ShipEngine::RatesApi_ | [**estimate_rates**](docs/RatesApi.md#estimate_rates) | **POST** /v1/rates/estimate | Estimate Rates |
|
|
163
|
+
| _ShipEngine::RatesApi_ | [**get_rate_by_id**](docs/RatesApi.md#get_rate_by_id) | **GET** /v1/rates/{rate_id} | Get Rate By ID |
|
|
164
|
+
| _ShipEngine::ShipmentsApi_ | [**cancel_shipments**](docs/ShipmentsApi.md#cancel_shipments) | **PUT** /v1/shipments/{shipment_id}/cancel | Cancel a Shipment |
|
|
165
|
+
| _ShipEngine::ShipmentsApi_ | [**create_shipments**](docs/ShipmentsApi.md#create_shipments) | **POST** /v1/shipments | Create Shipments |
|
|
166
|
+
| _ShipEngine::ShipmentsApi_ | [**get_shipment_by_external_id**](docs/ShipmentsApi.md#get_shipment_by_external_id) | **GET** /v1/shipments/external_shipment_id/{external_shipment_id} | Get Shipment By External ID |
|
|
167
|
+
| _ShipEngine::ShipmentsApi_ | [**get_shipment_by_id**](docs/ShipmentsApi.md#get_shipment_by_id) | **GET** /v1/shipments/{shipment_id} | Get Shipment By ID |
|
|
168
|
+
| _ShipEngine::ShipmentsApi_ | [**list_shipment_errors**](docs/ShipmentsApi.md#list_shipment_errors) | **GET** /v1/shipments/{shipment_id}/errors | Get Shipment Errors |
|
|
169
|
+
| _ShipEngine::ShipmentsApi_ | [**list_shipment_rates**](docs/ShipmentsApi.md#list_shipment_rates) | **GET** /v1/shipments/{shipment_id}/rates | Get Shipment Rates |
|
|
170
|
+
| _ShipEngine::ShipmentsApi_ | [**list_shipments**](docs/ShipmentsApi.md#list_shipments) | **GET** /v1/shipments | List Shipments |
|
|
171
|
+
| _ShipEngine::ShipmentsApi_ | [**parse_shipment**](docs/ShipmentsApi.md#parse_shipment) | **PUT** /v1/shipments/recognize | Parse shipping info |
|
|
172
|
+
| _ShipEngine::ShipmentsApi_ | [**tag_shipment**](docs/ShipmentsApi.md#tag_shipment) | **POST** /v1/shipments/{shipment_id}/tags/{tag_name} | Add Tag to Shipment |
|
|
173
|
+
| _ShipEngine::ShipmentsApi_ | [**untag_shipment**](docs/ShipmentsApi.md#untag_shipment) | **DELETE** /v1/shipments/{shipment_id}/tags/{tag_name} | Remove Tag from Shipment |
|
|
174
|
+
| _ShipEngine::ShipmentsApi_ | [**update_shipment**](docs/ShipmentsApi.md#update_shipment) | **PUT** /v1/shipments/{shipment_id} | Update Shipment By ID |
|
|
175
|
+
| _ShipEngine::TagsApi_ | [**create_tag**](docs/TagsApi.md#create_tag) | **POST** /v1/tags/{tag_name} | Create a New Tag |
|
|
176
|
+
| _ShipEngine::TagsApi_ | [**delete_tag**](docs/TagsApi.md#delete_tag) | **DELETE** /v1/tags/{tag_name} | Delete Tag |
|
|
177
|
+
| _ShipEngine::TagsApi_ | [**list_tags**](docs/TagsApi.md#list_tags) | **GET** /v1/tags | Get Tags |
|
|
178
|
+
| _ShipEngine::TagsApi_ | [**rename_tag**](docs/TagsApi.md#rename_tag) | **PUT** /v1/tags/{tag_name}/{new_tag_name} | Update Tag Name |
|
|
179
|
+
| _ShipEngine::TrackingApi_ | [**get_tracking_log**](docs/TrackingApi.md#get_tracking_log) | **GET** /v1/tracking | Get Tracking Information |
|
|
180
|
+
| _ShipEngine::TrackingApi_ | [**start_tracking**](docs/TrackingApi.md#start_tracking) | **POST** /v1/tracking/start | Start Tracking a Package |
|
|
181
|
+
| _ShipEngine::TrackingApi_ | [**stop_tracking**](docs/TrackingApi.md#stop_tracking) | **POST** /v1/tracking/stop | Stop Tracking a Package |
|
|
182
|
+
| _ShipEngine::WarehousesApi_ | [**create_warehouse**](docs/WarehousesApi.md#create_warehouse) | **POST** /v1/warehouses | Create Warehouse |
|
|
183
|
+
| _ShipEngine::WarehousesApi_ | [**delete_warehouse**](docs/WarehousesApi.md#delete_warehouse) | **DELETE** /v1/warehouses/{warehouse_id} | Delete Warehouse By ID |
|
|
184
|
+
| _ShipEngine::WarehousesApi_ | [**get_warehouse_by_id**](docs/WarehousesApi.md#get_warehouse_by_id) | **GET** /v1/warehouses/{warehouse_id} | Get Warehouse By Id |
|
|
185
|
+
| _ShipEngine::WarehousesApi_ | [**list_warehouses**](docs/WarehousesApi.md#list_warehouses) | **GET** /v1/warehouses | List Warehouses |
|
|
186
|
+
| _ShipEngine::WarehousesApi_ | [**update_warehouse**](docs/WarehousesApi.md#update_warehouse) | **PUT** /v1/warehouses/{warehouse_id} | Update WareHouse By Id |
|
|
187
|
+
| _ShipEngine::WebhooksApi_ | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /v1/environment/webhooks | Create a Webhook |
|
|
188
|
+
| _ShipEngine::WebhooksApi_ | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /v1/environment/webhooks/{webhook_id} | Delete Webhook By ID |
|
|
189
|
+
| _ShipEngine::WebhooksApi_ | [**get_webhook_by_id**](docs/WebhooksApi.md#get_webhook_by_id) | **GET** /v1/environment/webhooks/{webhook_id} | Get Webhook By ID |
|
|
190
|
+
| _ShipEngine::WebhooksApi_ | [**list_webhooks**](docs/WebhooksApi.md#list_webhooks) | **GET** /v1/environment/webhooks | List Webhooks |
|
|
191
|
+
| _ShipEngine::WebhooksApi_ | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PUT** /v1/environment/webhooks/{webhook_id} | Update a Webhook |
|
|
193
192
|
|
|
194
193
|
## Documentation for Models
|
|
195
194
|
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
195
|
+
- [ShipEngine::AddFundsToCarrierRequestBody](docs/AddFundsToCarrierRequestBody.md)
|
|
196
|
+
- [ShipEngine::AddFundsToCarrierResponseBody](docs/AddFundsToCarrierResponseBody.md)
|
|
197
|
+
- [ShipEngine::AddFundsToInsuranceRequestBody](docs/AddFundsToInsuranceRequestBody.md)
|
|
198
|
+
- [ShipEngine::AddFundsToInsuranceResponseBody](docs/AddFundsToInsuranceResponseBody.md)
|
|
199
|
+
- [ShipEngine::AddToBatchRequestBody](docs/AddToBatchRequestBody.md)
|
|
200
|
+
- [ShipEngine::Address](docs/Address.md)
|
|
201
|
+
- [ShipEngine::AddressResidentialIndicator](docs/AddressResidentialIndicator.md)
|
|
202
|
+
- [ShipEngine::AddressToValidate](docs/AddressToValidate.md)
|
|
203
|
+
- [ShipEngine::AddressValidatingShipment](docs/AddressValidatingShipment.md)
|
|
204
|
+
- [ShipEngine::AddressValidationCode](docs/AddressValidationCode.md)
|
|
205
|
+
- [ShipEngine::AddressValidationDetailCode](docs/AddressValidationDetailCode.md)
|
|
206
|
+
- [ShipEngine::AddressValidationMessageType](docs/AddressValidationMessageType.md)
|
|
207
|
+
- [ShipEngine::AddressValidationResult](docs/AddressValidationResult.md)
|
|
208
|
+
- [ShipEngine::AddressValidationStatus](docs/AddressValidationStatus.md)
|
|
209
|
+
- [ShipEngine::AdvancedShipmentOptions](docs/AdvancedShipmentOptions.md)
|
|
210
|
+
- [ShipEngine::AncillaryServiceEndorsement](docs/AncillaryServiceEndorsement.md)
|
|
211
|
+
- [ShipEngine::Batch](docs/Batch.md)
|
|
212
|
+
- [ShipEngine::BatchResponseError](docs/BatchResponseError.md)
|
|
213
|
+
- [ShipEngine::BatchStatus](docs/BatchStatus.md)
|
|
214
|
+
- [ShipEngine::BatchesSortBy](docs/BatchesSortBy.md)
|
|
215
|
+
- [ShipEngine::BillToParty](docs/BillToParty.md)
|
|
216
|
+
- [ShipEngine::BulkRate](docs/BulkRate.md)
|
|
217
|
+
- [ShipEngine::CalculateRatesRequestBody](docs/CalculateRatesRequestBody.md)
|
|
218
|
+
- [ShipEngine::CalculateRatesResponseBody](docs/CalculateRatesResponseBody.md)
|
|
219
|
+
- [ShipEngine::Carrier](docs/Carrier.md)
|
|
220
|
+
- [ShipEngine::CarrierAdvancedOption](docs/CarrierAdvancedOption.md)
|
|
221
|
+
- [ShipEngine::CarrierName](docs/CarrierName.md)
|
|
222
|
+
- [ShipEngine::CarrierNameWithSettings](docs/CarrierNameWithSettings.md)
|
|
223
|
+
- [ShipEngine::CollectOnDelivery](docs/CollectOnDelivery.md)
|
|
224
|
+
- [ShipEngine::CollectOnDeliveryPaymentType](docs/CollectOnDeliveryPaymentType.md)
|
|
225
|
+
- [ShipEngine::CompareBulkRatesRequestBody](docs/CompareBulkRatesRequestBody.md)
|
|
226
|
+
- [ShipEngine::ConnectAccessWorldwideRequestBody](docs/ConnectAccessWorldwideRequestBody.md)
|
|
227
|
+
- [ShipEngine::ConnectAmazonBuyShippingRequestBody](docs/ConnectAmazonBuyShippingRequestBody.md)
|
|
228
|
+
- [ShipEngine::ConnectApcRequestBody](docs/ConnectApcRequestBody.md)
|
|
229
|
+
- [ShipEngine::ConnectAsendiaRequestBody](docs/ConnectAsendiaRequestBody.md)
|
|
230
|
+
- [ShipEngine::ConnectAustraliaPostRequestBody](docs/ConnectAustraliaPostRequestBody.md)
|
|
231
|
+
- [ShipEngine::ConnectCanadaPostRequestBody](docs/ConnectCanadaPostRequestBody.md)
|
|
232
|
+
- [ShipEngine::ConnectCarrierRequestBody](docs/ConnectCarrierRequestBody.md)
|
|
233
|
+
- [ShipEngine::ConnectCarrierResponseBody](docs/ConnectCarrierResponseBody.md)
|
|
234
|
+
- [ShipEngine::ConnectDhlEcommerceRequestBody](docs/ConnectDhlEcommerceRequestBody.md)
|
|
235
|
+
- [ShipEngine::ConnectDhlExpressAuRequestBody](docs/ConnectDhlExpressAuRequestBody.md)
|
|
236
|
+
- [ShipEngine::ConnectDhlExpressCaRequestBody](docs/ConnectDhlExpressCaRequestBody.md)
|
|
237
|
+
- [ShipEngine::ConnectDhlExpressRequestBody](docs/ConnectDhlExpressRequestBody.md)
|
|
238
|
+
- [ShipEngine::ConnectDhlExpressUkRequestBody](docs/ConnectDhlExpressUkRequestBody.md)
|
|
239
|
+
- [ShipEngine::ConnectDpdRequestBody](docs/ConnectDpdRequestBody.md)
|
|
240
|
+
- [ShipEngine::ConnectEndiciaRequestBody](docs/ConnectEndiciaRequestBody.md)
|
|
241
|
+
- [ShipEngine::ConnectFedexRequestBody](docs/ConnectFedexRequestBody.md)
|
|
242
|
+
- [ShipEngine::ConnectFedexUkRequestBody](docs/ConnectFedexUkRequestBody.md)
|
|
243
|
+
- [ShipEngine::ConnectFirstmileRequestBody](docs/ConnectFirstmileRequestBody.md)
|
|
244
|
+
- [ShipEngine::ConnectGlobegisticsRequestBody](docs/ConnectGlobegisticsRequestBody.md)
|
|
245
|
+
- [ShipEngine::ConnectImexRequestBody](docs/ConnectImexRequestBody.md)
|
|
246
|
+
- [ShipEngine::ConnectInsurerRequestBody](docs/ConnectInsurerRequestBody.md)
|
|
247
|
+
- [ShipEngine::ConnectNewgisticsRequestBody](docs/ConnectNewgisticsRequestBody.md)
|
|
248
|
+
- [ShipEngine::ConnectOntracRequestBody](docs/ConnectOntracRequestBody.md)
|
|
249
|
+
- [ShipEngine::ConnectPurolatorRequestBody](docs/ConnectPurolatorRequestBody.md)
|
|
250
|
+
- [ShipEngine::ConnectRoyalMailRequestBody](docs/ConnectRoyalMailRequestBody.md)
|
|
251
|
+
- [ShipEngine::ConnectRrDonnelleyRequestBody](docs/ConnectRrDonnelleyRequestBody.md)
|
|
252
|
+
- [ShipEngine::ConnectSekoRequestBody](docs/ConnectSekoRequestBody.md)
|
|
253
|
+
- [ShipEngine::ConnectSendleRequestBody](docs/ConnectSendleRequestBody.md)
|
|
254
|
+
- [ShipEngine::ConnectStampsRequestBody](docs/ConnectStampsRequestBody.md)
|
|
255
|
+
- [ShipEngine::ConnectUpsRequestBody](docs/ConnectUpsRequestBody.md)
|
|
256
|
+
- [ShipEngine::CreateAndValidateShipment](docs/CreateAndValidateShipment.md)
|
|
257
|
+
- [ShipEngine::CreateBatchRequestBody](docs/CreateBatchRequestBody.md)
|
|
258
|
+
- [ShipEngine::CreateBatchResponseBody](docs/CreateBatchResponseBody.md)
|
|
259
|
+
- [ShipEngine::CreateLabelFromRateRequestBody](docs/CreateLabelFromRateRequestBody.md)
|
|
260
|
+
- [ShipEngine::CreateLabelFromRateResponseBody](docs/CreateLabelFromRateResponseBody.md)
|
|
261
|
+
- [ShipEngine::CreateLabelFromShipmentRequestBody](docs/CreateLabelFromShipmentRequestBody.md)
|
|
262
|
+
- [ShipEngine::CreateLabelFromShipmentResponseBody](docs/CreateLabelFromShipmentResponseBody.md)
|
|
263
|
+
- [ShipEngine::CreateLabelRequestBody](docs/CreateLabelRequestBody.md)
|
|
264
|
+
- [ShipEngine::CreateLabelResponseBody](docs/CreateLabelResponseBody.md)
|
|
265
|
+
- [ShipEngine::CreateManifestByObjectRequestBody](docs/CreateManifestByObjectRequestBody.md)
|
|
266
|
+
- [ShipEngine::CreateManifestLabelIdsRequestBody](docs/CreateManifestLabelIdsRequestBody.md)
|
|
267
|
+
- [ShipEngine::CreateManifestRequestBody](docs/CreateManifestRequestBody.md)
|
|
268
|
+
- [ShipEngine::CreateManifestResponseBody](docs/CreateManifestResponseBody.md)
|
|
269
|
+
- [ShipEngine::CreatePackageTypeRequestBody](docs/CreatePackageTypeRequestBody.md)
|
|
270
|
+
- [ShipEngine::CreatePackageTypeResponseBody](docs/CreatePackageTypeResponseBody.md)
|
|
271
|
+
- [ShipEngine::CreateReturnLabelRequestBody](docs/CreateReturnLabelRequestBody.md)
|
|
272
|
+
- [ShipEngine::CreateReturnLabelResponseBody](docs/CreateReturnLabelResponseBody.md)
|
|
273
|
+
- [ShipEngine::CreateShipmentResponseBodyFields](docs/CreateShipmentResponseBodyFields.md)
|
|
274
|
+
- [ShipEngine::CreateShipmentsRequestBody](docs/CreateShipmentsRequestBody.md)
|
|
275
|
+
- [ShipEngine::CreateShipmentsResponseBody](docs/CreateShipmentsResponseBody.md)
|
|
276
|
+
- [ShipEngine::CreateTagResponseBody](docs/CreateTagResponseBody.md)
|
|
277
|
+
- [ShipEngine::CreateWarehouseRequestBody](docs/CreateWarehouseRequestBody.md)
|
|
278
|
+
- [ShipEngine::CreateWarehouseResponseBody](docs/CreateWarehouseResponseBody.md)
|
|
279
|
+
- [ShipEngine::CreateWebhookRequestBody](docs/CreateWebhookRequestBody.md)
|
|
280
|
+
- [ShipEngine::CreateWebhookResponseBody](docs/CreateWebhookResponseBody.md)
|
|
281
|
+
- [ShipEngine::Currency](docs/Currency.md)
|
|
282
|
+
- [ShipEngine::CustomsItem](docs/CustomsItem.md)
|
|
283
|
+
- [ShipEngine::DeliveryConfirmation](docs/DeliveryConfirmation.md)
|
|
284
|
+
- [ShipEngine::DeprecatedManifest](docs/DeprecatedManifest.md)
|
|
285
|
+
- [ShipEngine::DhlExpressAccountSettings](docs/DhlExpressAccountSettings.md)
|
|
286
|
+
- [ShipEngine::DhlExpressSettingsResponseBody](docs/DhlExpressSettingsResponseBody.md)
|
|
287
|
+
- [ShipEngine::DimensionUnit](docs/DimensionUnit.md)
|
|
288
|
+
- [ShipEngine::Dimensions](docs/Dimensions.md)
|
|
289
|
+
- [ShipEngine::Error](docs/Error.md)
|
|
290
|
+
- [ShipEngine::ErrorCode](docs/ErrorCode.md)
|
|
291
|
+
- [ShipEngine::ErrorResponseBody](docs/ErrorResponseBody.md)
|
|
292
|
+
- [ShipEngine::ErrorSource](docs/ErrorSource.md)
|
|
293
|
+
- [ShipEngine::ErrorType](docs/ErrorType.md)
|
|
294
|
+
- [ShipEngine::EstimateRatesRequestBody](docs/EstimateRatesRequestBody.md)
|
|
295
|
+
- [ShipEngine::FedexAccountSettings](docs/FedexAccountSettings.md)
|
|
296
|
+
- [ShipEngine::FedexAccountSettingsRequestBody](docs/FedexAccountSettingsRequestBody.md)
|
|
297
|
+
- [ShipEngine::FedexPickupType](docs/FedexPickupType.md)
|
|
298
|
+
- [ShipEngine::FedexSettingsResponseBody](docs/FedexSettingsResponseBody.md)
|
|
299
|
+
- [ShipEngine::GetBatchByExternalIdResponseBody](docs/GetBatchByExternalIdResponseBody.md)
|
|
300
|
+
- [ShipEngine::GetBatchByIdResponseBody](docs/GetBatchByIdResponseBody.md)
|
|
301
|
+
- [ShipEngine::GetCarrierByIdResponseBody](docs/GetCarrierByIdResponseBody.md)
|
|
302
|
+
- [ShipEngine::GetCarrierOptionsResponseBody](docs/GetCarrierOptionsResponseBody.md)
|
|
303
|
+
- [ShipEngine::GetCarrierSettingsResponseBody](docs/GetCarrierSettingsResponseBody.md)
|
|
304
|
+
- [ShipEngine::GetCarriersResponseBody](docs/GetCarriersResponseBody.md)
|
|
305
|
+
- [ShipEngine::GetInsuranceBalanceResponseBody](docs/GetInsuranceBalanceResponseBody.md)
|
|
306
|
+
- [ShipEngine::GetLabelByExternalShipmentIdResponseBody](docs/GetLabelByExternalShipmentIdResponseBody.md)
|
|
307
|
+
- [ShipEngine::GetLabelByIdResponseBody](docs/GetLabelByIdResponseBody.md)
|
|
308
|
+
- [ShipEngine::GetManifestByIdResponseBody](docs/GetManifestByIdResponseBody.md)
|
|
309
|
+
- [ShipEngine::GetPackageTypeByIdResponseBody](docs/GetPackageTypeByIdResponseBody.md)
|
|
310
|
+
- [ShipEngine::GetRateByIdResponseBody](docs/GetRateByIdResponseBody.md)
|
|
311
|
+
- [ShipEngine::GetShipmentByExternalIdResponseBody](docs/GetShipmentByExternalIdResponseBody.md)
|
|
312
|
+
- [ShipEngine::GetShipmentByIdResponseBody](docs/GetShipmentByIdResponseBody.md)
|
|
313
|
+
- [ShipEngine::GetTrackingLogFromLabelResponseBody](docs/GetTrackingLogFromLabelResponseBody.md)
|
|
314
|
+
- [ShipEngine::GetTrackingLogResponseBody](docs/GetTrackingLogResponseBody.md)
|
|
315
|
+
- [ShipEngine::GetWarehouseByIdResponseBody](docs/GetWarehouseByIdResponseBody.md)
|
|
316
|
+
- [ShipEngine::GetWebhookByIdResponseBody](docs/GetWebhookByIdResponseBody.md)
|
|
317
|
+
- [ShipEngine::InsuranceProvider](docs/InsuranceProvider.md)
|
|
318
|
+
- [ShipEngine::InternationalShipmentOptions](docs/InternationalShipmentOptions.md)
|
|
319
|
+
- [ShipEngine::Label](docs/Label.md)
|
|
320
|
+
- [ShipEngine::LabelChargeEvent](docs/LabelChargeEvent.md)
|
|
321
|
+
- [ShipEngine::LabelDownload](docs/LabelDownload.md)
|
|
322
|
+
- [ShipEngine::LabelDownloadType](docs/LabelDownloadType.md)
|
|
323
|
+
- [ShipEngine::LabelFormat](docs/LabelFormat.md)
|
|
324
|
+
- [ShipEngine::LabelLayout](docs/LabelLayout.md)
|
|
325
|
+
- [ShipEngine::LabelMessages](docs/LabelMessages.md)
|
|
326
|
+
- [ShipEngine::LabelStatus](docs/LabelStatus.md)
|
|
327
|
+
- [ShipEngine::Link](docs/Link.md)
|
|
328
|
+
- [ShipEngine::ListBatchErrorsResponseBody](docs/ListBatchErrorsResponseBody.md)
|
|
329
|
+
- [ShipEngine::ListBatchesResponseBody](docs/ListBatchesResponseBody.md)
|
|
330
|
+
- [ShipEngine::ListCarrierPackageTypesResponseBody](docs/ListCarrierPackageTypesResponseBody.md)
|
|
331
|
+
- [ShipEngine::ListCarrierServicesResponseBody](docs/ListCarrierServicesResponseBody.md)
|
|
332
|
+
- [ShipEngine::ListCarriersResponseBody](docs/ListCarriersResponseBody.md)
|
|
333
|
+
- [ShipEngine::ListLabelsResponseBody](docs/ListLabelsResponseBody.md)
|
|
334
|
+
- [ShipEngine::ListManifestsResponseBody](docs/ListManifestsResponseBody.md)
|
|
335
|
+
- [ShipEngine::ListPackageTypesResponseBody](docs/ListPackageTypesResponseBody.md)
|
|
336
|
+
- [ShipEngine::ListShipmentErrorsResponseBody](docs/ListShipmentErrorsResponseBody.md)
|
|
337
|
+
- [ShipEngine::ListShipmentRatesResponseBody](docs/ListShipmentRatesResponseBody.md)
|
|
338
|
+
- [ShipEngine::ListShipmentsResponseBody](docs/ListShipmentsResponseBody.md)
|
|
339
|
+
- [ShipEngine::ListTagsResponseBody](docs/ListTagsResponseBody.md)
|
|
340
|
+
- [ShipEngine::ListWarehousesResponseBody](docs/ListWarehousesResponseBody.md)
|
|
341
|
+
- [ShipEngine::Manifest](docs/Manifest.md)
|
|
342
|
+
- [ShipEngine::ManifestDownload](docs/ManifestDownload.md)
|
|
343
|
+
- [ShipEngine::Manifests](docs/Manifests.md)
|
|
344
|
+
- [ShipEngine::ModifyBatch](docs/ModifyBatch.md)
|
|
345
|
+
- [ShipEngine::MonetaryValue](docs/MonetaryValue.md)
|
|
346
|
+
- [ShipEngine::NonDelivery](docs/NonDelivery.md)
|
|
347
|
+
- [ShipEngine::OptionalLink](docs/OptionalLink.md)
|
|
348
|
+
- [ShipEngine::OrderSourceName](docs/OrderSourceName.md)
|
|
349
|
+
- [ShipEngine::Package](docs/Package.md)
|
|
350
|
+
- [ShipEngine::PackageContents](docs/PackageContents.md)
|
|
351
|
+
- [ShipEngine::PackageType](docs/PackageType.md)
|
|
352
|
+
- [ShipEngine::PagedListResponseBody](docs/PagedListResponseBody.md)
|
|
353
|
+
- [ShipEngine::PaginationLink](docs/PaginationLink.md)
|
|
354
|
+
- [ShipEngine::ParseAddressRequestBody](docs/ParseAddressRequestBody.md)
|
|
355
|
+
- [ShipEngine::ParseAddressResponseBody](docs/ParseAddressResponseBody.md)
|
|
356
|
+
- [ShipEngine::ParseShipmentRequestBody](docs/ParseShipmentRequestBody.md)
|
|
357
|
+
- [ShipEngine::ParseShipmentResponseBody](docs/ParseShipmentResponseBody.md)
|
|
358
|
+
- [ShipEngine::PartialAddress](docs/PartialAddress.md)
|
|
359
|
+
- [ShipEngine::PartialShipment](docs/PartialShipment.md)
|
|
360
|
+
- [ShipEngine::PaymentAmount](docs/PaymentAmount.md)
|
|
361
|
+
- [ShipEngine::ProcessBatchRequestBody](docs/ProcessBatchRequestBody.md)
|
|
362
|
+
- [ShipEngine::PurchaseLabelWithoutShipment](docs/PurchaseLabelWithoutShipment.md)
|
|
363
|
+
- [ShipEngine::Rate](docs/Rate.md)
|
|
364
|
+
- [ShipEngine::RateEstimateByCarrierId](docs/RateEstimateByCarrierId.md)
|
|
365
|
+
- [ShipEngine::RateEstimateByCarrierIds](docs/RateEstimateByCarrierIds.md)
|
|
366
|
+
- [ShipEngine::RateEstimateOptions](docs/RateEstimateOptions.md)
|
|
367
|
+
- [ShipEngine::RateRequestBody](docs/RateRequestBody.md)
|
|
368
|
+
- [ShipEngine::RateRequestByShipmentIds](docs/RateRequestByShipmentIds.md)
|
|
369
|
+
- [ShipEngine::RateRequestByShipments](docs/RateRequestByShipments.md)
|
|
370
|
+
- [ShipEngine::RateRequestOptions](docs/RateRequestOptions.md)
|
|
371
|
+
- [ShipEngine::RateRequestRateOptions](docs/RateRequestRateOptions.md)
|
|
372
|
+
- [ShipEngine::RateResponse](docs/RateResponse.md)
|
|
373
|
+
- [ShipEngine::RateResponseStatus](docs/RateResponseStatus.md)
|
|
374
|
+
- [ShipEngine::RateType](docs/RateType.md)
|
|
375
|
+
- [ShipEngine::RatesInformation](docs/RatesInformation.md)
|
|
376
|
+
- [ShipEngine::RecognizedEntity](docs/RecognizedEntity.md)
|
|
377
|
+
- [ShipEngine::RemoveFromBatchRequestBody](docs/RemoveFromBatchRequestBody.md)
|
|
378
|
+
- [ShipEngine::ResponseMessage](docs/ResponseMessage.md)
|
|
379
|
+
- [ShipEngine::Service](docs/Service.md)
|
|
380
|
+
- [ShipEngine::Shipment](docs/Shipment.md)
|
|
381
|
+
- [ShipEngine::ShipmentIdRequest](docs/ShipmentIdRequest.md)
|
|
382
|
+
- [ShipEngine::ShipmentItem](docs/ShipmentItem.md)
|
|
383
|
+
- [ShipEngine::ShipmentRequest](docs/ShipmentRequest.md)
|
|
384
|
+
- [ShipEngine::ShipmentResponseError](docs/ShipmentResponseError.md)
|
|
385
|
+
- [ShipEngine::ShipmentStatus](docs/ShipmentStatus.md)
|
|
386
|
+
- [ShipEngine::ShipmentsSortBy](docs/ShipmentsSortBy.md)
|
|
387
|
+
- [ShipEngine::SmartPostHub](docs/SmartPostHub.md)
|
|
388
|
+
- [ShipEngine::SortDir](docs/SortDir.md)
|
|
389
|
+
- [ShipEngine::Tag](docs/Tag.md)
|
|
390
|
+
- [ShipEngine::TagShipmentResponseBody](docs/TagShipmentResponseBody.md)
|
|
391
|
+
- [ShipEngine::TrackEvent](docs/TrackEvent.md)
|
|
392
|
+
- [ShipEngine::TrackingInformation](docs/TrackingInformation.md)
|
|
393
|
+
- [ShipEngine::TrackingStatus](docs/TrackingStatus.md)
|
|
394
|
+
- [ShipEngine::UpdateAmazonBuyShippingRequestBody](docs/UpdateAmazonBuyShippingRequestBody.md)
|
|
395
|
+
- [ShipEngine::UpdateCarrierSettingsRequestBody](docs/UpdateCarrierSettingsRequestBody.md)
|
|
396
|
+
- [ShipEngine::UpdateDhlExpressSettingsRequestBody](docs/UpdateDhlExpressSettingsRequestBody.md)
|
|
397
|
+
- [ShipEngine::UpdateFedexSettingsRequestBody](docs/UpdateFedexSettingsRequestBody.md)
|
|
398
|
+
- [ShipEngine::UpdateNewgisticsSettingsRequestBody](docs/UpdateNewgisticsSettingsRequestBody.md)
|
|
399
|
+
- [ShipEngine::UpdatePackageTypeRequestBody](docs/UpdatePackageTypeRequestBody.md)
|
|
400
|
+
- [ShipEngine::UpdateShipmentFields](docs/UpdateShipmentFields.md)
|
|
401
|
+
- [ShipEngine::UpdateShipmentRequestBody](docs/UpdateShipmentRequestBody.md)
|
|
402
|
+
- [ShipEngine::UpdateShipmentResponseBody](docs/UpdateShipmentResponseBody.md)
|
|
403
|
+
- [ShipEngine::UpdateUpsSettingsRequestBody](docs/UpdateUpsSettingsRequestBody.md)
|
|
404
|
+
- [ShipEngine::UpdateWarehouseRequestBody](docs/UpdateWarehouseRequestBody.md)
|
|
405
|
+
- [ShipEngine::UpdateWebhookRequestBody](docs/UpdateWebhookRequestBody.md)
|
|
406
|
+
- [ShipEngine::UpsAccountSettings](docs/UpsAccountSettings.md)
|
|
407
|
+
- [ShipEngine::UpsInvoice](docs/UpsInvoice.md)
|
|
408
|
+
- [ShipEngine::UpsPickupType](docs/UpsPickupType.md)
|
|
409
|
+
- [ShipEngine::UpsSettingsResponseBody](docs/UpsSettingsResponseBody.md)
|
|
410
|
+
- [ShipEngine::ValidateAddress](docs/ValidateAddress.md)
|
|
411
|
+
- [ShipEngine::ValidateShipmentFields](docs/ValidateShipmentFields.md)
|
|
412
|
+
- [ShipEngine::ValidationStatus](docs/ValidationStatus.md)
|
|
413
|
+
- [ShipEngine::VoidLabelResponseBody](docs/VoidLabelResponseBody.md)
|
|
414
|
+
- [ShipEngine::Warehouse](docs/Warehouse.md)
|
|
415
|
+
- [ShipEngine::Webhook](docs/Webhook.md)
|
|
416
|
+
- [ShipEngine::WebhookEvent](docs/WebhookEvent.md)
|
|
417
|
+
- [ShipEngine::Weight](docs/Weight.md)
|
|
418
|
+
- [ShipEngine::WeightUnit](docs/WeightUnit.md)
|
|
421
419
|
|
|
422
420
|
## Documentation for Authorization
|
|
423
421
|
|
|
424
|
-
|
|
425
422
|
### api_key
|
|
426
423
|
|
|
427
|
-
|
|
428
424
|
- **Type**: API key
|
|
429
425
|
- **API key parameter name**: API-Key
|
|
430
426
|
- **Location**: HTTP header
|
|
431
|
-
|