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
@@ -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
|
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
|
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
|
-
module
|
15
|
+
module ShipEngine
|
16
16
|
class AddressResidentialIndicator
|
17
17
|
UNKNOWN = "unknown".freeze
|
18
18
|
YES = "yes".freeze
|
@@ -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
|
@@ -12,8 +12,8 @@ OpenAPI Generator version: 4.3.1
|
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
|
-
module
|
16
|
-
# Any residential or business mailing address, anywhere in the world.
|
15
|
+
module ShipEngine
|
16
|
+
# Any residential or business mailing address, anywhere in the world.
|
17
17
|
class AddressToValidate < PartialAddress
|
18
18
|
# Attribute mapping from ruby-style variable name to JSON key.
|
19
19
|
def self.attribute_map
|
@@ -44,13 +44,13 @@ module OpenapiClient
|
|
44
44
|
# @param [Hash] attributes Model attributes in the form of hash
|
45
45
|
def initialize(attributes = {})
|
46
46
|
if (!attributes.is_a?(Hash))
|
47
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `
|
47
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::AddressToValidate` initialize method"
|
48
48
|
end
|
49
49
|
|
50
50
|
# check to see if the attribute exists and convert string to symbol for hash key
|
51
51
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
52
52
|
if (!self.class.attribute_map.key?(k.to_sym))
|
53
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `
|
53
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `ShipEngine::AddressToValidate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
54
54
|
end
|
55
55
|
h[k.to_sym] = v
|
56
56
|
}
|
@@ -182,7 +182,7 @@ module OpenapiClient
|
|
182
182
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
183
183
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
184
184
|
end
|
185
|
-
|
185
|
+
|
186
186
|
hash[param] = _to_hash(value)
|
187
187
|
end
|
188
188
|
hash
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#ShipEngine API
|
3
3
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
7
7
|
Contact: sales@shipengine.com
|
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
|
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
|
-
module
|
15
|
+
module ShipEngine
|
16
16
|
# An address validating shipment
|
17
17
|
class AddressValidatingShipment
|
18
18
|
attr_accessor :validate_address
|
@@ -23,19 +23,19 @@ module OpenapiClient
|
|
23
23
|
# The carrier account that is billed for the shipping charges
|
24
24
|
attr_accessor :carrier_id
|
25
25
|
|
26
|
-
# The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.
|
26
|
+
# The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.
|
27
27
|
attr_accessor :service_code
|
28
28
|
|
29
29
|
# ID that the Order Source assigned
|
30
30
|
attr_accessor :external_order_id
|
31
31
|
|
32
|
-
# Describe the packages included in this shipment as related to potential metadata that was imported from external order sources
|
32
|
+
# Describe the packages included in this shipment as related to potential metadata that was imported from external order sources
|
33
33
|
attr_accessor :items
|
34
34
|
|
35
|
-
# You can optionally use this field to store your own identifier for this shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.
|
35
|
+
# You can optionally use this field to store your own identifier for this shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.
|
36
36
|
attr_accessor :external_shipment_id
|
37
37
|
|
38
|
-
# The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.
|
38
|
+
# The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.
|
39
39
|
attr_accessor :ship_date
|
40
40
|
|
41
41
|
# The date and time that the shipment was created in ShipEngine.
|
@@ -50,33 +50,33 @@ module OpenapiClient
|
|
50
50
|
# The recipient's mailing address
|
51
51
|
attr_accessor :ship_to
|
52
52
|
|
53
|
-
# The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time.
|
53
|
+
# The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time.
|
54
54
|
attr_accessor :ship_from
|
55
55
|
|
56
|
-
# The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified.
|
56
|
+
# The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified.
|
57
57
|
attr_accessor :warehouse_id
|
58
58
|
|
59
|
-
# The return address for this shipment. Defaults to the `ship_from` address.
|
59
|
+
# The return address for this shipment. Defaults to the `ship_from` address.
|
60
60
|
attr_accessor :return_to
|
61
61
|
|
62
62
|
# The type of delivery confirmation that is required for this shipment.
|
63
63
|
attr_accessor :confirmation
|
64
64
|
|
65
|
-
# Customs information. This is usually only needed for international shipments.
|
65
|
+
# Customs information. This is usually only needed for international shipments.
|
66
66
|
attr_accessor :customs
|
67
67
|
|
68
68
|
# Advanced shipment options. These are entirely optional.
|
69
69
|
attr_accessor :advanced_options
|
70
70
|
|
71
|
-
# The insurance provider to use for any insured packages in the shipment.
|
71
|
+
# The insurance provider to use for any insured packages in the shipment.
|
72
72
|
attr_accessor :insurance_provider
|
73
73
|
|
74
|
-
# Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.
|
74
|
+
# Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.
|
75
75
|
attr_accessor :tags
|
76
76
|
|
77
77
|
attr_accessor :order_source_code
|
78
78
|
|
79
|
-
# The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.
|
79
|
+
# The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.
|
80
80
|
attr_accessor :packages
|
81
81
|
|
82
82
|
# The combined weight of all packages in the shipment
|
@@ -162,13 +162,13 @@ module OpenapiClient
|
|
162
162
|
# @param [Hash] attributes Model attributes in the form of hash
|
163
163
|
def initialize(attributes = {})
|
164
164
|
if (!attributes.is_a?(Hash))
|
165
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `
|
165
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::AddressValidatingShipment` initialize method"
|
166
166
|
end
|
167
167
|
|
168
168
|
# check to see if the attribute exists and convert string to symbol for hash key
|
169
169
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
170
170
|
if (!self.class.attribute_map.key?(k.to_sym))
|
171
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `
|
171
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `ShipEngine::AddressValidatingShipment`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
172
172
|
end
|
173
173
|
h[k.to_sym] = v
|
174
174
|
}
|
@@ -457,7 +457,7 @@ module OpenapiClient
|
|
457
457
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
458
458
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
459
459
|
end
|
460
|
-
|
460
|
+
|
461
461
|
hash[param] = _to_hash(value)
|
462
462
|
end
|
463
463
|
hash
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#ShipEngine API
|
3
3
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
7
7
|
Contact: sales@shipengine.com
|
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
|
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
|
-
module
|
15
|
+
module ShipEngine
|
16
16
|
class AddressValidationCode
|
17
17
|
A1000 = "a1000".freeze
|
18
18
|
A1001 = "a1001".freeze
|
@@ -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
|
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
|
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
|
-
module
|
15
|
+
module ShipEngine
|
16
16
|
class AddressValidationDetailCode
|
17
17
|
UNSUPPORTED_COUNTRY = "unsupported_country".freeze
|
18
18
|
NON_SUPPORTED_COUNTRY = "non_supported_country".freeze
|
@@ -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
|
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
|
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
|
-
module
|
15
|
+
module ShipEngine
|
16
16
|
class AddressValidationMessageType
|
17
17
|
ERROR = "error".freeze
|
18
18
|
WARNING = "warning".freeze
|
@@ -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
|
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
|
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
|
-
module
|
15
|
+
module ShipEngine
|
16
16
|
# An address validation result
|
17
17
|
class AddressValidationResult
|
18
18
|
attr_accessor :status
|
@@ -56,13 +56,13 @@ module OpenapiClient
|
|
56
56
|
# @param [Hash] attributes Model attributes in the form of hash
|
57
57
|
def initialize(attributes = {})
|
58
58
|
if (!attributes.is_a?(Hash))
|
59
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `
|
59
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::AddressValidationResult` initialize method"
|
60
60
|
end
|
61
61
|
|
62
62
|
# check to see if the attribute exists and convert string to symbol for hash key
|
63
63
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
64
64
|
if (!self.class.attribute_map.key?(k.to_sym))
|
65
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `
|
65
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `ShipEngine::AddressValidationResult`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
66
66
|
end
|
67
67
|
h[k.to_sym] = v
|
68
68
|
}
|
@@ -232,7 +232,7 @@ module OpenapiClient
|
|
232
232
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
233
233
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
234
234
|
end
|
235
|
-
|
235
|
+
|
236
236
|
hash[param] = _to_hash(value)
|
237
237
|
end
|
238
238
|
hash
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#ShipEngine API
|
3
3
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
7
7
|
Contact: sales@shipengine.com
|
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
|
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
|
-
module
|
15
|
+
module ShipEngine
|
16
16
|
class AddressValidationStatus
|
17
17
|
UNVERIFIED = "unverified".freeze
|
18
18
|
VERIFIED = "verified".freeze
|
@@ -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
|
@@ -12,25 +12,25 @@ OpenAPI Generator version: 4.3.1
|
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
|
-
module
|
15
|
+
module ShipEngine
|
16
16
|
# Advanced shipment options
|
17
17
|
class AdvancedShipmentOptions
|
18
|
-
# This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields.
|
18
|
+
# This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields.
|
19
19
|
attr_accessor :bill_to_account
|
20
20
|
|
21
|
-
# The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the third-party that is responsible for shipping costs.
|
21
|
+
# The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the third-party that is responsible for shipping costs.
|
22
22
|
attr_accessor :bill_to_country_code
|
23
23
|
|
24
|
-
# Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set.
|
24
|
+
# Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set.
|
25
25
|
attr_accessor :bill_to_party
|
26
26
|
|
27
|
-
# The postal code of the third-party that is responsible for shipping costs.
|
27
|
+
# The postal code of the third-party that is responsible for shipping costs.
|
28
28
|
attr_accessor :bill_to_postal_code
|
29
29
|
|
30
30
|
# Indicates that the shipment contains alcohol.
|
31
31
|
attr_accessor :contains_alcohol
|
32
32
|
|
33
|
-
# Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express.
|
33
|
+
# Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express.
|
34
34
|
attr_accessor :delivered_duty_paid
|
35
35
|
|
36
36
|
# Indicates if the shipment contain dry ice
|
@@ -39,25 +39,25 @@ module OpenapiClient
|
|
39
39
|
# The weight of the dry ice in the shipment
|
40
40
|
attr_accessor :dry_ice_weight
|
41
41
|
|
42
|
-
# Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details.
|
42
|
+
# Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details.
|
43
43
|
attr_accessor :non_machinable
|
44
44
|
|
45
45
|
# Enables Saturday delivery, if supported by the carrier.
|
46
46
|
attr_accessor :saturday_delivery
|
47
47
|
|
48
|
-
# Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified.
|
48
|
+
# Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified.
|
49
49
|
attr_accessor :use_ups_ground_freight_pricing
|
50
50
|
|
51
|
-
# The National Motor Freight Traffic Association [freight class](http://www.nmfta.org/pages/nmfc?AspxAutoDetectCookieSupport=1), such as \"77.5\", \"110\", or \"250\".
|
51
|
+
# The National Motor Freight Traffic Association [freight class](http://www.nmfta.org/pages/nmfc?AspxAutoDetectCookieSupport=1), such as \"77.5\", \"110\", or \"250\".
|
52
52
|
attr_accessor :freight_class
|
53
53
|
|
54
|
-
# An arbitrary field that can be used to store information about the shipment.
|
54
|
+
# An arbitrary field that can be used to store information about the shipment.
|
55
55
|
attr_accessor :custom_field1
|
56
56
|
|
57
|
-
# An arbitrary field that can be used to store information about the shipment.
|
57
|
+
# An arbitrary field that can be used to store information about the shipment.
|
58
58
|
attr_accessor :custom_field2
|
59
59
|
|
60
|
-
# An arbitrary field that can be used to store information about the shipment.
|
60
|
+
# An arbitrary field that can be used to store information about the shipment.
|
61
61
|
attr_accessor :custom_field3
|
62
62
|
|
63
63
|
attr_accessor :collect_on_delivery
|
@@ -126,13 +126,13 @@ module OpenapiClient
|
|
126
126
|
# @param [Hash] attributes Model attributes in the form of hash
|
127
127
|
def initialize(attributes = {})
|
128
128
|
if (!attributes.is_a?(Hash))
|
129
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `
|
129
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::AdvancedShipmentOptions` initialize method"
|
130
130
|
end
|
131
131
|
|
132
132
|
# check to see if the attribute exists and convert string to symbol for hash key
|
133
133
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
134
134
|
if (!self.class.attribute_map.key?(k.to_sym))
|
135
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `
|
135
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `ShipEngine::AdvancedShipmentOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
136
136
|
end
|
137
137
|
h[k.to_sym] = v
|
138
138
|
}
|
@@ -407,7 +407,7 @@ module OpenapiClient
|
|
407
407
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
408
408
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
409
409
|
end
|
410
|
-
|
410
|
+
|
411
411
|
hash[param] = _to_hash(value)
|
412
412
|
end
|
413
413
|
hash
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#ShipEngine API
|
3
3
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
7
7
|
Contact: sales@shipengine.com
|
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
|
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
|
-
module
|
15
|
+
module ShipEngine
|
16
16
|
class AncillaryServiceEndorsement
|
17
17
|
NONE = "none".freeze
|
18
18
|
RETURN_SERVICE_REQUESTED = "return_service_requested".freeze
|
@@ -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
|
@@ -12,8 +12,8 @@ OpenAPI Generator version: 4.3.1
|
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
|
-
module
|
16
|
-
# Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or thousands of labels at a time.
|
15
|
+
module ShipEngine
|
16
|
+
# Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or thousands of labels at a time.
|
17
17
|
class Batch
|
18
18
|
# label layout
|
19
19
|
attr_accessor :label_layout
|
@@ -128,13 +128,13 @@ module OpenapiClient
|
|
128
128
|
# @param [Hash] attributes Model attributes in the form of hash
|
129
129
|
def initialize(attributes = {})
|
130
130
|
if (!attributes.is_a?(Hash))
|
131
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `
|
131
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::Batch` initialize method"
|
132
132
|
end
|
133
133
|
|
134
134
|
# check to see if the attribute exists and convert string to symbol for hash key
|
135
135
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
136
136
|
if (!self.class.attribute_map.key?(k.to_sym))
|
137
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `
|
137
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `ShipEngine::Batch`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
138
138
|
end
|
139
139
|
h[k.to_sym] = v
|
140
140
|
}
|
@@ -539,7 +539,7 @@ module OpenapiClient
|
|
539
539
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
540
540
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
541
541
|
end
|
542
|
-
|
542
|
+
|
543
543
|
hash[param] = _to_hash(value)
|
544
544
|
end
|
545
545
|
hash
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#ShipEngine API
|
3
3
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
7
7
|
Contact: sales@shipengine.com
|
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
|
|
12
12
|
|
13
13
|
require 'date'
|
14
14
|
|
15
|
-
module
|
15
|
+
module ShipEngine
|
16
16
|
# A batch response error
|
17
17
|
class BatchResponseError
|
18
18
|
# Error message associated with the shipment.
|
@@ -47,13 +47,13 @@ module OpenapiClient
|
|
47
47
|
# @param [Hash] attributes Model attributes in the form of hash
|
48
48
|
def initialize(attributes = {})
|
49
49
|
if (!attributes.is_a?(Hash))
|
50
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `
|
50
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::BatchResponseError` initialize method"
|
51
51
|
end
|
52
52
|
|
53
53
|
# check to see if the attribute exists and convert string to symbol for hash key
|
54
54
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
55
55
|
if (!self.class.attribute_map.key?(k.to_sym))
|
56
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `
|
56
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `ShipEngine::BatchResponseError`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
57
57
|
end
|
58
58
|
h[k.to_sym] = v
|
59
59
|
}
|
@@ -206,7 +206,7 @@ module OpenapiClient
|
|
206
206
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
207
207
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
208
208
|
end
|
209
|
-
|
209
|
+
|
210
210
|
hash[param] = _to_hash(value)
|
211
211
|
end
|
212
212
|
hash
|