ship_engine 1.0.0 → 1.0.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +70 -0
- data/README.md +312 -312
- data/docs/AddFundsToCarrierRequestBody.md +3 -3
- data/docs/AddFundsToCarrierResponseBody.md +3 -3
- data/docs/AddFundsToInsuranceRequestBody.md +3 -3
- data/docs/AddFundsToInsuranceResponseBody.md +3 -3
- data/docs/AddToBatchRequestBody.md +3 -3
- data/docs/Address.md +3 -3
- data/docs/AddressResidentialIndicator.md +3 -3
- data/docs/AddressToValidate.md +3 -3
- data/docs/AddressValidatingShipment.md +3 -3
- data/docs/AddressValidationCode.md +3 -3
- data/docs/AddressValidationDetailCode.md +3 -3
- data/docs/AddressValidationMessageType.md +3 -3
- data/docs/AddressValidationResult.md +3 -3
- data/docs/AddressValidationStatus.md +3 -3
- data/docs/AddressesApi.md +9 -9
- data/docs/AdvancedShipmentOptions.md +3 -3
- data/docs/AncillaryServiceEndorsement.md +3 -3
- data/docs/Batch.md +3 -3
- data/docs/BatchResponseError.md +3 -3
- data/docs/BatchStatus.md +3 -3
- data/docs/BatchesApi.md +57 -57
- data/docs/BatchesSortBy.md +3 -3
- data/docs/BillToParty.md +3 -3
- data/docs/BulkRate.md +3 -3
- data/docs/CalculateRatesRequestBody.md +3 -3
- data/docs/CalculateRatesResponseBody.md +3 -3
- data/docs/Carrier.md +3 -3
- data/docs/CarrierAccountsApi.md +29 -29
- data/docs/CarrierAdvancedOption.md +3 -3
- data/docs/CarrierName.md +3 -3
- data/docs/CarrierNameWithSettings.md +3 -3
- data/docs/CarriersApi.md +29 -29
- data/docs/CollectOnDelivery.md +3 -3
- data/docs/CollectOnDeliveryPaymentType.md +3 -3
- data/docs/CompareBulkRatesRequestBody.md +3 -3
- data/docs/ConnectAccessWorldwideRequestBody.md +3 -3
- data/docs/ConnectAmazonBuyShippingRequestBody.md +3 -3
- data/docs/ConnectApcRequestBody.md +3 -3
- data/docs/ConnectAsendiaRequestBody.md +3 -3
- data/docs/ConnectAustraliaPostRequestBody.md +3 -3
- data/docs/ConnectCanadaPostRequestBody.md +3 -3
- data/docs/ConnectCarrierRequestBody.md +3 -3
- data/docs/ConnectCarrierResponseBody.md +3 -3
- data/docs/ConnectDhlEcommerceRequestBody.md +3 -3
- data/docs/ConnectDhlExpressAuRequestBody.md +3 -3
- data/docs/ConnectDhlExpressCaRequestBody.md +3 -3
- data/docs/ConnectDhlExpressRequestBody.md +3 -3
- data/docs/ConnectDhlExpressUkRequestBody.md +3 -3
- data/docs/ConnectDpdRequestBody.md +3 -3
- data/docs/ConnectEndiciaRequestBody.md +3 -3
- data/docs/ConnectFedexRequestBody.md +3 -3
- data/docs/ConnectFedexUkRequestBody.md +3 -3
- data/docs/ConnectFirstmileRequestBody.md +3 -3
- data/docs/ConnectGlobegisticsRequestBody.md +3 -3
- data/docs/ConnectImexRequestBody.md +3 -3
- data/docs/ConnectInsurerRequestBody.md +3 -3
- data/docs/ConnectNewgisticsRequestBody.md +3 -3
- data/docs/ConnectOntracRequestBody.md +3 -3
- data/docs/ConnectPurolatorRequestBody.md +3 -3
- data/docs/ConnectRoyalMailRequestBody.md +3 -3
- data/docs/ConnectRrDonnelleyRequestBody.md +3 -3
- data/docs/ConnectSekoRequestBody.md +3 -3
- data/docs/ConnectSendleRequestBody.md +3 -3
- data/docs/ConnectStampsRequestBody.md +3 -3
- data/docs/ConnectUpsRequestBody.md +3 -3
- data/docs/CreateAndValidateShipment.md +3 -3
- data/docs/CreateBatchRequestBody.md +3 -3
- data/docs/CreateBatchResponseBody.md +3 -3
- data/docs/CreateLabelFromRateRequestBody.md +3 -3
- data/docs/CreateLabelFromRateResponseBody.md +3 -3
- data/docs/CreateLabelFromShipmentRequestBody.md +3 -3
- data/docs/CreateLabelFromShipmentResponseBody.md +3 -3
- data/docs/CreateLabelRequestBody.md +3 -3
- data/docs/CreateLabelResponseBody.md +3 -3
- data/docs/CreateManifestByObjectRequestBody.md +3 -3
- data/docs/CreateManifestLabelIdsRequestBody.md +3 -3
- data/docs/CreateManifestRequestBody.md +3 -3
- data/docs/CreateManifestResponseBody.md +3 -3
- data/docs/CreatePackageTypeRequestBody.md +3 -3
- data/docs/CreatePackageTypeResponseBody.md +3 -3
- data/docs/CreateReturnLabelRequestBody.md +3 -3
- data/docs/CreateReturnLabelResponseBody.md +3 -3
- data/docs/CreateShipmentResponseBodyFields.md +3 -3
- data/docs/CreateShipmentsRequestBody.md +3 -3
- data/docs/CreateShipmentsResponseBody.md +3 -3
- data/docs/CreateTagResponseBody.md +3 -3
- data/docs/CreateWarehouseRequestBody.md +3 -3
- data/docs/CreateWarehouseResponseBody.md +3 -3
- data/docs/CreateWebhookRequestBody.md +3 -3
- data/docs/CreateWebhookResponseBody.md +3 -3
- data/docs/Currency.md +3 -3
- data/docs/CustomsItem.md +3 -3
- data/docs/DeliveryConfirmation.md +3 -3
- data/docs/DeprecatedManifest.md +3 -3
- data/docs/DhlExpressAccountSettings.md +3 -3
- data/docs/DhlExpressSettingsResponseBody.md +3 -3
- data/docs/DimensionUnit.md +3 -3
- data/docs/Dimensions.md +3 -3
- data/docs/DownloadsApi.md +5 -5
- data/docs/Error.md +3 -3
- data/docs/ErrorCode.md +3 -3
- data/docs/ErrorResponseBody.md +3 -3
- data/docs/ErrorSource.md +3 -3
- data/docs/ErrorType.md +3 -3
- data/docs/EstimateRatesRequestBody.md +3 -3
- data/docs/FedexAccountSettings.md +3 -3
- data/docs/FedexAccountSettingsRequestBody.md +3 -3
- data/docs/FedexPickupType.md +3 -3
- data/docs/FedexSettingsResponseBody.md +3 -3
- data/docs/GetBatchByExternalIdResponseBody.md +3 -3
- data/docs/GetBatchByIdResponseBody.md +3 -3
- data/docs/GetCarrierByIdResponseBody.md +3 -3
- data/docs/GetCarrierOptionsResponseBody.md +3 -3
- data/docs/GetCarrierSettingsResponseBody.md +3 -3
- data/docs/GetCarriersResponseBody.md +3 -3
- data/docs/GetInsuranceBalanceResponseBody.md +3 -3
- data/docs/GetLabelByExternalShipmentIdResponseBody.md +3 -3
- data/docs/GetLabelByIdResponseBody.md +3 -3
- data/docs/GetManifestByIdResponseBody.md +3 -3
- data/docs/GetPackageTypeByIdResponseBody.md +3 -3
- data/docs/GetRateByIdResponseBody.md +3 -3
- data/docs/GetShipmentByExternalIdResponseBody.md +3 -3
- data/docs/GetShipmentByIdResponseBody.md +3 -3
- data/docs/GetTrackingLogFromLabelResponseBody.md +3 -3
- data/docs/GetTrackingLogResponseBody.md +3 -3
- data/docs/GetWarehouseByIdResponseBody.md +3 -3
- data/docs/GetWebhookByIdResponseBody.md +3 -3
- data/docs/InsuranceApi.md +19 -19
- data/docs/InsuranceProvider.md +3 -3
- data/docs/InternationalShipmentOptions.md +3 -3
- data/docs/Label.md +3 -3
- data/docs/LabelChargeEvent.md +3 -3
- data/docs/LabelDownload.md +3 -3
- data/docs/LabelDownloadType.md +3 -3
- data/docs/LabelFormat.md +3 -3
- data/docs/LabelLayout.md +3 -3
- data/docs/LabelMessages.md +3 -3
- data/docs/LabelStatus.md +3 -3
- data/docs/LabelsApi.md +54 -54
- data/docs/Link.md +3 -3
- data/docs/ListBatchErrorsResponseBody.md +3 -3
- data/docs/ListBatchesResponseBody.md +3 -3
- data/docs/ListCarrierPackageTypesResponseBody.md +3 -3
- data/docs/ListCarrierServicesResponseBody.md +3 -3
- data/docs/ListCarriersResponseBody.md +3 -3
- data/docs/ListLabelsResponseBody.md +3 -3
- data/docs/ListManifestsResponseBody.md +3 -3
- data/docs/ListPackageTypesResponseBody.md +3 -3
- data/docs/ListShipmentErrorsResponseBody.md +3 -3
- data/docs/ListShipmentRatesResponseBody.md +3 -3
- data/docs/ListShipmentsResponseBody.md +3 -3
- data/docs/ListTagsResponseBody.md +3 -3
- data/docs/ListWarehousesResponseBody.md +3 -3
- data/docs/Manifest.md +3 -3
- data/docs/ManifestDownload.md +3 -3
- data/docs/Manifests.md +3 -3
- data/docs/ManifestsApi.md +14 -14
- data/docs/ModifyBatch.md +3 -3
- data/docs/MonetaryValue.md +3 -3
- data/docs/NonDelivery.md +3 -3
- data/docs/OptionalLink.md +3 -3
- data/docs/OrderSourceName.md +3 -3
- data/docs/Package.md +3 -3
- data/docs/PackageContents.md +3 -3
- data/docs/PackageType.md +3 -3
- data/docs/PackageTypesApi.md +26 -26
- data/docs/PagedListResponseBody.md +3 -3
- data/docs/PaginationLink.md +3 -3
- data/docs/ParseAddressRequestBody.md +3 -3
- data/docs/ParseAddressResponseBody.md +3 -3
- data/docs/ParseShipmentRequestBody.md +3 -3
- data/docs/ParseShipmentResponseBody.md +3 -3
- data/docs/PartialAddress.md +3 -3
- data/docs/PartialShipment.md +3 -3
- data/docs/PaymentAmount.md +3 -3
- data/docs/ProcessBatchRequestBody.md +3 -3
- data/docs/PurchaseLabelWithoutShipment.md +3 -3
- data/docs/Rate.md +3 -3
- data/docs/RateEstimateByCarrierId.md +3 -3
- data/docs/RateEstimateByCarrierIds.md +3 -3
- data/docs/RateEstimateOptions.md +3 -3
- data/docs/RateRequestBody.md +3 -3
- data/docs/RateRequestByShipmentIds.md +3 -3
- data/docs/RateRequestByShipments.md +3 -3
- data/docs/RateRequestOptions.md +3 -3
- data/docs/RateRequestRateOptions.md +3 -3
- data/docs/RateResponse.md +3 -3
- data/docs/RateResponseStatus.md +3 -3
- data/docs/RateType.md +3 -3
- data/docs/RatesApi.md +20 -20
- data/docs/RatesInformation.md +3 -3
- data/docs/RecognizedEntity.md +3 -3
- data/docs/RemoveFromBatchRequestBody.md +3 -3
- data/docs/ResponseMessage.md +3 -3
- data/docs/Service.md +3 -3
- data/docs/Shipment.md +3 -3
- data/docs/ShipmentIdRequest.md +3 -3
- data/docs/ShipmentItem.md +3 -3
- data/docs/ShipmentRequest.md +3 -3
- data/docs/ShipmentResponseError.md +3 -3
- data/docs/ShipmentStatus.md +3 -3
- data/docs/ShipmentsApi.md +53 -53
- data/docs/ShipmentsSortBy.md +3 -3
- data/docs/SmartPostHub.md +3 -3
- data/docs/SortDir.md +3 -3
- data/docs/Tag.md +3 -3
- data/docs/TagShipmentResponseBody.md +3 -3
- data/docs/TagsApi.md +17 -17
- data/docs/TrackEvent.md +3 -3
- data/docs/TrackingApi.md +13 -13
- data/docs/TrackingInformation.md +3 -3
- data/docs/TrackingStatus.md +3 -3
- data/docs/UpdateAmazonBuyShippingRequestBody.md +3 -3
- data/docs/UpdateCarrierSettingsRequestBody.md +3 -3
- data/docs/UpdateDhlExpressSettingsRequestBody.md +3 -3
- data/docs/UpdateFedexSettingsRequestBody.md +3 -3
- data/docs/UpdateNewgisticsSettingsRequestBody.md +3 -3
- data/docs/UpdatePackageTypeRequestBody.md +3 -3
- data/docs/UpdateShipmentFields.md +3 -3
- data/docs/UpdateShipmentRequestBody.md +3 -3
- data/docs/UpdateShipmentResponseBody.md +3 -3
- data/docs/UpdateUpsSettingsRequestBody.md +3 -3
- data/docs/UpdateWarehouseRequestBody.md +3 -3
- data/docs/UpdateWebhookRequestBody.md +3 -3
- data/docs/UpsAccountSettings.md +3 -3
- data/docs/UpsInvoice.md +3 -3
- data/docs/UpsPickupType.md +3 -3
- data/docs/UpsSettingsResponseBody.md +3 -3
- data/docs/ValidateAddress.md +3 -3
- data/docs/ValidateShipmentFields.md +3 -3
- data/docs/ValidationStatus.md +3 -3
- data/docs/VoidLabelResponseBody.md +3 -3
- data/docs/Warehouse.md +3 -3
- data/docs/WarehousesApi.md +26 -26
- data/docs/Webhook.md +3 -3
- data/docs/WebhookEvent.md +3 -3
- data/docs/WebhooksApi.md +26 -26
- data/docs/Weight.md +3 -3
- data/docs/WeightUnit.md +3 -3
- data/lib/ship_engine.rb +278 -0
- data/lib/{openapi_client → ship_engine}/api/addresses_api.rb +1 -1
- data/lib/{openapi_client → ship_engine}/api/batches_api.rb +28 -28
- data/lib/{openapi_client → ship_engine}/api/carrier_accounts_api.rb +19 -19
- data/lib/{openapi_client → ship_engine}/api/carriers_api.rb +10 -10
- data/lib/{openapi_client → ship_engine}/api/downloads_api.rb +1 -1
- data/lib/{openapi_client → ship_engine}/api/insurance_api.rb +1 -1
- data/lib/{openapi_client → ship_engine}/api/labels_api.rb +28 -28
- data/lib/{openapi_client → ship_engine}/api/manifests_api.rb +1 -1
- data/lib/{openapi_client → ship_engine}/api/package_types_api.rb +10 -10
- data/lib/{openapi_client → ship_engine}/api/rates_api.rb +1 -1
- data/lib/{openapi_client → ship_engine}/api/shipments_api.rb +10 -10
- data/lib/{openapi_client → ship_engine}/api/tags_api.rb +1 -1
- data/lib/{openapi_client → ship_engine}/api/tracking_api.rb +1 -1
- data/lib/{openapi_client → ship_engine}/api/warehouses_api.rb +10 -10
- data/lib/{openapi_client → ship_engine}/api/webhooks_api.rb +10 -10
- data/lib/{openapi_client → ship_engine}/api_client.rb +2 -2
- data/lib/{openapi_client → ship_engine}/api_error.rb +1 -1
- data/lib/{openapi_client → ship_engine}/configuration.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/add_funds_to_carrier_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/add_funds_to_carrier_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/add_funds_to_insurance_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/add_funds_to_insurance_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/add_to_batch_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/address.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/address_residential_indicator.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/address_to_validate.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/address_validating_shipment.rb +17 -19
- data/lib/{openapi_client → ship_engine}/models/address_validation_code.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/address_validation_detail_code.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/address_validation_message_type.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/address_validation_result.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/address_validation_status.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/advanced_shipment_options.rb +17 -19
- data/lib/{openapi_client → ship_engine}/models/ancillary_service_endorsement.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/batch.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/batch_response_error.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/batch_status.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/batches_sort_by.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/bill_to_party.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/bulk_rate.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/calculate_rates_request_body.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/calculate_rates_response_body.rb +17 -19
- data/lib/{openapi_client → ship_engine}/models/carrier.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/carrier_advanced_option.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/carrier_name.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/carrier_name_with_settings.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/collect_on_delivery.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/collect_on_delivery_payment_type.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/compare_bulk_rates_request_body.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/connect_access_worldwide_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_amazon_buy_shipping_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_apc_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_asendia_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_australia_post_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_canada_post_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_carrier_request_body.rb +8 -10
- data/lib/{openapi_client → ship_engine}/models/connect_carrier_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_ecommerce_request_body.rb +8 -10
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_au_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_ca_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_uk_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_dpd_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_endicia_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_fedex_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_fedex_uk_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_firstmile_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_globegistics_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_imex_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_insurer_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_newgistics_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_ontrac_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_purolator_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_royal_mail_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_rr_donnelley_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_seko_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_sendle_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_stamps_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/connect_ups_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_and_validate_shipment.rb +17 -19
- data/lib/{openapi_client → ship_engine}/models/create_batch_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_batch_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_label_from_rate_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_label_from_rate_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_label_from_shipment_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_label_from_shipment_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_label_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_label_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_manifest_by_object_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_manifest_label_ids_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_manifest_request_body.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/create_manifest_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_package_type_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_package_type_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_return_label_request_body.rb +9 -11
- data/lib/{openapi_client → ship_engine}/models/create_return_label_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_shipment_response_body_fields.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_shipments_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_shipments_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_tag_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_warehouse_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_warehouse_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_webhook_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/create_webhook_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/currency.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/customs_item.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/delivery_confirmation.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/deprecated_manifest.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/dhl_express_account_settings.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/dhl_express_settings_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/dimension_unit.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/dimensions.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/error.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/error_code.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/error_response_body.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/error_source.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/error_type.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/estimate_rates_request_body.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/fedex_account_settings.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/fedex_account_settings_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/fedex_pickup_type.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/fedex_settings_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/get_batch_by_external_id_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/get_batch_by_id_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/get_carrier_by_id_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/get_carrier_options_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/get_carrier_settings_response_body.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/get_carriers_response_body.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/get_insurance_balance_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/get_label_by_external_shipment_id_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/get_label_by_id_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/get_manifest_by_id_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/get_package_type_by_id_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/get_rate_by_id_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/get_shipment_by_external_id_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/get_shipment_by_id_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/get_tracking_log_from_label_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/get_tracking_log_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/get_warehouse_by_id_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/get_webhook_by_id_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/insurance_provider.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/international_shipment_options.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/label.rb +30 -32
- data/lib/{openapi_client → ship_engine}/models/label_charge_event.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/label_download.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/label_download_type.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/label_format.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/label_layout.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/label_messages.rb +10 -12
- data/lib/{openapi_client → ship_engine}/models/label_status.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/link.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/list_batch_errors_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/list_batches_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/list_carrier_package_types_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/list_carrier_services_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/list_carriers_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/list_labels_response_body.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/list_manifests_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/list_package_types_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/list_shipment_errors_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/list_shipment_rates_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/list_shipments_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/list_tags_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/list_warehouses_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/manifest.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/manifest_download.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/manifests.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/modify_batch.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/monetary_value.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/non_delivery.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/optional_link.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/order_source_name.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/package.rb +9 -11
- data/lib/{openapi_client → ship_engine}/models/package_contents.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/package_type.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/paged_list_response_body.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/pagination_link.rb +10 -12
- data/lib/{openapi_client → ship_engine}/models/parse_address_request_body.rb +8 -10
- data/lib/{openapi_client → ship_engine}/models/parse_address_response_body.rb +10 -12
- data/lib/{openapi_client → ship_engine}/models/parse_shipment_request_body.rb +8 -10
- data/lib/{openapi_client → ship_engine}/models/parse_shipment_response_body.rb +10 -12
- data/lib/{openapi_client → ship_engine}/models/partial_address.rb +14 -16
- data/lib/{openapi_client → ship_engine}/models/partial_shipment.rb +18 -20
- data/lib/{openapi_client → ship_engine}/models/payment_amount.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/process_batch_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/purchase_label_without_shipment.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/rate.rb +8 -10
- data/lib/{openapi_client → ship_engine}/models/rate_estimate_by_carrier_id.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/rate_estimate_by_carrier_ids.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/rate_estimate_options.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/rate_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/rate_request_by_shipment_ids.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/rate_request_by_shipments.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/rate_request_options.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/rate_request_rate_options.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/rate_response.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/rate_response_status.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/rate_type.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/rates_information.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/recognized_entity.rb +9 -11
- data/lib/{openapi_client → ship_engine}/models/remove_from_batch_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/response_message.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/service.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/shipment.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/shipment_id_request.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/shipment_item.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/shipment_request.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/shipment_response_error.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/shipment_status.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/shipments_sort_by.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/smart_post_hub.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/sort_dir.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/tag.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/tag_shipment_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/track_event.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/tracking_information.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/tracking_status.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/update_amazon_buy_shipping_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/update_carrier_settings_request_body.rb +7 -9
- data/lib/{openapi_client → ship_engine}/models/update_dhl_express_settings_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/update_fedex_settings_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/update_newgistics_settings_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/update_package_type_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/update_shipment_fields.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/update_shipment_request_body.rb +17 -19
- data/lib/{openapi_client → ship_engine}/models/update_shipment_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/update_ups_settings_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/update_warehouse_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/update_webhook_request_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/ups_account_settings.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/ups_invoice.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/ups_pickup_type.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/ups_settings_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/validate_address.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/validate_shipment_fields.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/validation_status.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/void_label_response_body.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/warehouse.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/webhook.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/webhook_event.rb +1 -1
- data/lib/{openapi_client → ship_engine}/models/weight.rb +6 -8
- data/lib/{openapi_client → ship_engine}/models/weight_unit.rb +1 -1
- data/lib/{openapi_client → ship_engine}/version.rb +3 -3
- data/ship_engine-1.0.3.gem +0 -0
- data/ship_engine-1.0.4.gem +0 -0
- data/ship_engine.gemspec +2 -2
- data/spec/api/addresses_api_spec.rb +3 -3
- data/spec/api/batches_api_spec.rb +3 -3
- data/spec/api/carrier_accounts_api_spec.rb +3 -3
- data/spec/api/carriers_api_spec.rb +3 -3
- data/spec/api/downloads_api_spec.rb +3 -3
- data/spec/api/insurance_api_spec.rb +3 -3
- data/spec/api/labels_api_spec.rb +3 -3
- data/spec/api/manifests_api_spec.rb +3 -3
- data/spec/api/package_types_api_spec.rb +3 -3
- data/spec/api/rates_api_spec.rb +3 -3
- data/spec/api/shipments_api_spec.rb +3 -3
- data/spec/api/tags_api_spec.rb +3 -3
- data/spec/api/tracking_api_spec.rb +3 -3
- data/spec/api/warehouses_api_spec.rb +3 -3
- data/spec/api/webhooks_api_spec.rb +3 -3
- data/spec/api_client_spec.rb +29 -29
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/add_funds_to_carrier_request_body_spec.rb +3 -3
- data/spec/models/add_funds_to_carrier_response_body_spec.rb +3 -3
- data/spec/models/add_funds_to_insurance_request_body_spec.rb +3 -3
- data/spec/models/add_funds_to_insurance_response_body_spec.rb +3 -3
- data/spec/models/add_to_batch_request_body_spec.rb +3 -3
- data/spec/models/address_residential_indicator_spec.rb +3 -3
- data/spec/models/address_spec.rb +3 -3
- data/spec/models/address_to_validate_spec.rb +3 -3
- data/spec/models/address_validating_shipment_spec.rb +3 -3
- data/spec/models/address_validation_code_spec.rb +3 -3
- data/spec/models/address_validation_detail_code_spec.rb +3 -3
- data/spec/models/address_validation_message_type_spec.rb +3 -3
- data/spec/models/address_validation_result_spec.rb +3 -3
- data/spec/models/address_validation_status_spec.rb +3 -3
- data/spec/models/advanced_shipment_options_spec.rb +3 -3
- data/spec/models/ancillary_service_endorsement_spec.rb +3 -3
- data/spec/models/batch_response_error_spec.rb +3 -3
- data/spec/models/batch_spec.rb +3 -3
- data/spec/models/batch_status_spec.rb +3 -3
- data/spec/models/batches_sort_by_spec.rb +3 -3
- data/spec/models/bill_to_party_spec.rb +3 -3
- data/spec/models/bulk_rate_spec.rb +3 -3
- data/spec/models/calculate_rates_request_body_spec.rb +3 -3
- data/spec/models/calculate_rates_response_body_spec.rb +3 -3
- data/spec/models/carrier_advanced_option_spec.rb +3 -3
- data/spec/models/carrier_name_spec.rb +3 -3
- data/spec/models/carrier_name_with_settings_spec.rb +3 -3
- data/spec/models/carrier_spec.rb +3 -3
- data/spec/models/collect_on_delivery_payment_type_spec.rb +3 -3
- data/spec/models/collect_on_delivery_spec.rb +3 -3
- data/spec/models/compare_bulk_rates_request_body_spec.rb +3 -3
- data/spec/models/connect_access_worldwide_request_body_spec.rb +3 -3
- data/spec/models/connect_amazon_buy_shipping_request_body_spec.rb +3 -3
- data/spec/models/connect_apc_request_body_spec.rb +3 -3
- data/spec/models/connect_asendia_request_body_spec.rb +3 -3
- data/spec/models/connect_australia_post_request_body_spec.rb +3 -3
- data/spec/models/connect_canada_post_request_body_spec.rb +3 -3
- data/spec/models/connect_carrier_request_body_spec.rb +3 -3
- data/spec/models/connect_carrier_response_body_spec.rb +3 -3
- data/spec/models/connect_dhl_ecommerce_request_body_spec.rb +3 -3
- data/spec/models/connect_dhl_express_au_request_body_spec.rb +3 -3
- data/spec/models/connect_dhl_express_ca_request_body_spec.rb +3 -3
- data/spec/models/connect_dhl_express_request_body_spec.rb +3 -3
- data/spec/models/connect_dhl_express_uk_request_body_spec.rb +3 -3
- data/spec/models/connect_dpd_request_body_spec.rb +3 -3
- data/spec/models/connect_endicia_request_body_spec.rb +3 -3
- data/spec/models/connect_fedex_request_body_spec.rb +3 -3
- data/spec/models/connect_fedex_uk_request_body_spec.rb +3 -3
- data/spec/models/connect_firstmile_request_body_spec.rb +3 -3
- data/spec/models/connect_globegistics_request_body_spec.rb +3 -3
- data/spec/models/connect_imex_request_body_spec.rb +3 -3
- data/spec/models/connect_insurer_request_body_spec.rb +3 -3
- data/spec/models/connect_newgistics_request_body_spec.rb +3 -3
- data/spec/models/connect_ontrac_request_body_spec.rb +3 -3
- data/spec/models/connect_purolator_request_body_spec.rb +3 -3
- data/spec/models/connect_royal_mail_request_body_spec.rb +3 -3
- data/spec/models/connect_rr_donnelley_request_body_spec.rb +3 -3
- data/spec/models/connect_seko_request_body_spec.rb +3 -3
- data/spec/models/connect_sendle_request_body_spec.rb +3 -3
- data/spec/models/connect_stamps_request_body_spec.rb +3 -3
- data/spec/models/connect_ups_request_body_spec.rb +3 -3
- data/spec/models/create_and_validate_shipment_spec.rb +3 -3
- data/spec/models/create_batch_request_body_spec.rb +3 -3
- data/spec/models/create_batch_response_body_spec.rb +3 -3
- data/spec/models/create_label_from_rate_request_body_spec.rb +3 -3
- data/spec/models/create_label_from_rate_response_body_spec.rb +3 -3
- data/spec/models/create_label_from_shipment_request_body_spec.rb +3 -3
- data/spec/models/create_label_from_shipment_response_body_spec.rb +3 -3
- data/spec/models/create_label_request_body_spec.rb +3 -3
- data/spec/models/create_label_response_body_spec.rb +3 -3
- data/spec/models/create_manifest_by_object_request_body_spec.rb +3 -3
- data/spec/models/create_manifest_label_ids_request_body_spec.rb +3 -3
- data/spec/models/create_manifest_request_body_spec.rb +3 -3
- data/spec/models/create_manifest_response_body_spec.rb +3 -3
- data/spec/models/create_package_type_request_body_spec.rb +3 -3
- data/spec/models/create_package_type_response_body_spec.rb +3 -3
- data/spec/models/create_return_label_request_body_spec.rb +3 -3
- data/spec/models/create_return_label_response_body_spec.rb +3 -3
- data/spec/models/create_shipment_response_body_fields_spec.rb +3 -3
- data/spec/models/create_shipments_request_body_spec.rb +3 -3
- data/spec/models/create_shipments_response_body_spec.rb +3 -3
- data/spec/models/create_tag_response_body_spec.rb +3 -3
- data/spec/models/create_warehouse_request_body_spec.rb +3 -3
- data/spec/models/create_warehouse_response_body_spec.rb +3 -3
- data/spec/models/create_webhook_request_body_spec.rb +3 -3
- data/spec/models/create_webhook_response_body_spec.rb +3 -3
- data/spec/models/currency_spec.rb +3 -3
- data/spec/models/customs_item_spec.rb +3 -3
- data/spec/models/delivery_confirmation_spec.rb +3 -3
- data/spec/models/deprecated_manifest_spec.rb +3 -3
- data/spec/models/dhl_express_account_settings_spec.rb +3 -3
- data/spec/models/dhl_express_settings_response_body_spec.rb +3 -3
- data/spec/models/dimension_unit_spec.rb +3 -3
- data/spec/models/dimensions_spec.rb +3 -3
- data/spec/models/error_code_spec.rb +3 -3
- data/spec/models/error_response_body_spec.rb +3 -3
- data/spec/models/error_source_spec.rb +3 -3
- data/spec/models/error_spec.rb +3 -3
- data/spec/models/error_type_spec.rb +3 -3
- data/spec/models/estimate_rates_request_body_spec.rb +3 -3
- data/spec/models/fedex_account_settings_request_body_spec.rb +3 -3
- data/spec/models/fedex_account_settings_spec.rb +3 -3
- data/spec/models/fedex_pickup_type_spec.rb +3 -3
- data/spec/models/fedex_settings_response_body_spec.rb +3 -3
- data/spec/models/get_batch_by_external_id_response_body_spec.rb +3 -3
- data/spec/models/get_batch_by_id_response_body_spec.rb +3 -3
- data/spec/models/get_carrier_by_id_response_body_spec.rb +3 -3
- data/spec/models/get_carrier_options_response_body_spec.rb +3 -3
- data/spec/models/get_carrier_settings_response_body_spec.rb +3 -3
- data/spec/models/get_carriers_response_body_spec.rb +3 -3
- data/spec/models/get_insurance_balance_response_body_spec.rb +3 -3
- data/spec/models/get_label_by_external_shipment_id_response_body_spec.rb +3 -3
- data/spec/models/get_label_by_id_response_body_spec.rb +3 -3
- data/spec/models/get_manifest_by_id_response_body_spec.rb +3 -3
- data/spec/models/get_package_type_by_id_response_body_spec.rb +3 -3
- data/spec/models/get_rate_by_id_response_body_spec.rb +3 -3
- data/spec/models/get_shipment_by_external_id_response_body_spec.rb +3 -3
- data/spec/models/get_shipment_by_id_response_body_spec.rb +3 -3
- data/spec/models/get_tracking_log_from_label_response_body_spec.rb +3 -3
- data/spec/models/get_tracking_log_response_body_spec.rb +3 -3
- data/spec/models/get_warehouse_by_id_response_body_spec.rb +3 -3
- data/spec/models/get_webhook_by_id_response_body_spec.rb +3 -3
- data/spec/models/insurance_provider_spec.rb +3 -3
- data/spec/models/international_shipment_options_spec.rb +3 -3
- data/spec/models/label_charge_event_spec.rb +3 -3
- data/spec/models/label_download_spec.rb +3 -3
- data/spec/models/label_download_type_spec.rb +3 -3
- data/spec/models/label_format_spec.rb +3 -3
- data/spec/models/label_layout_spec.rb +3 -3
- data/spec/models/label_messages_spec.rb +3 -3
- data/spec/models/label_spec.rb +3 -3
- data/spec/models/label_status_spec.rb +3 -3
- data/spec/models/link_spec.rb +3 -3
- data/spec/models/list_batch_errors_response_body_spec.rb +3 -3
- data/spec/models/list_batches_response_body_spec.rb +3 -3
- data/spec/models/list_carrier_package_types_response_body_spec.rb +3 -3
- data/spec/models/list_carrier_services_response_body_spec.rb +3 -3
- data/spec/models/list_carriers_response_body_spec.rb +3 -3
- data/spec/models/list_labels_response_body_spec.rb +3 -3
- data/spec/models/list_manifests_response_body_spec.rb +3 -3
- data/spec/models/list_package_types_response_body_spec.rb +3 -3
- data/spec/models/list_shipment_errors_response_body_spec.rb +3 -3
- data/spec/models/list_shipment_rates_response_body_spec.rb +3 -3
- data/spec/models/list_shipments_response_body_spec.rb +3 -3
- data/spec/models/list_tags_response_body_spec.rb +3 -3
- data/spec/models/list_warehouses_response_body_spec.rb +3 -3
- data/spec/models/manifest_download_spec.rb +3 -3
- data/spec/models/manifest_spec.rb +3 -3
- data/spec/models/manifests_spec.rb +3 -3
- data/spec/models/modify_batch_spec.rb +3 -3
- data/spec/models/monetary_value_spec.rb +3 -3
- data/spec/models/non_delivery_spec.rb +3 -3
- data/spec/models/optional_link_spec.rb +3 -3
- data/spec/models/order_source_name_spec.rb +3 -3
- data/spec/models/package_contents_spec.rb +3 -3
- data/spec/models/package_spec.rb +3 -3
- data/spec/models/package_type_spec.rb +3 -3
- data/spec/models/paged_list_response_body_spec.rb +3 -3
- data/spec/models/pagination_link_spec.rb +3 -3
- data/spec/models/parse_address_request_body_spec.rb +3 -3
- data/spec/models/parse_address_response_body_spec.rb +3 -3
- data/spec/models/parse_shipment_request_body_spec.rb +3 -3
- data/spec/models/parse_shipment_response_body_spec.rb +3 -3
- data/spec/models/partial_address_spec.rb +3 -3
- data/spec/models/partial_shipment_spec.rb +3 -3
- data/spec/models/payment_amount_spec.rb +3 -3
- data/spec/models/process_batch_request_body_spec.rb +3 -3
- data/spec/models/purchase_label_without_shipment_spec.rb +3 -3
- data/spec/models/rate_estimate_by_carrier_id_spec.rb +3 -3
- data/spec/models/rate_estimate_by_carrier_ids_spec.rb +3 -3
- data/spec/models/rate_estimate_options_spec.rb +3 -3
- data/spec/models/rate_request_body_spec.rb +3 -3
- data/spec/models/rate_request_by_shipment_ids_spec.rb +3 -3
- data/spec/models/rate_request_by_shipments_spec.rb +3 -3
- data/spec/models/rate_request_options_spec.rb +3 -3
- data/spec/models/rate_request_rate_options_spec.rb +3 -3
- data/spec/models/rate_response_spec.rb +3 -3
- data/spec/models/rate_response_status_spec.rb +3 -3
- data/spec/models/rate_spec.rb +3 -3
- data/spec/models/rate_type_spec.rb +3 -3
- data/spec/models/rates_information_spec.rb +3 -3
- data/spec/models/recognized_entity_spec.rb +3 -3
- data/spec/models/remove_from_batch_request_body_spec.rb +3 -3
- data/spec/models/response_message_spec.rb +3 -3
- data/spec/models/service_spec.rb +3 -3
- data/spec/models/shipment_id_request_spec.rb +3 -3
- data/spec/models/shipment_item_spec.rb +3 -3
- data/spec/models/shipment_request_spec.rb +3 -3
- data/spec/models/shipment_response_error_spec.rb +3 -3
- data/spec/models/shipment_spec.rb +3 -3
- data/spec/models/shipment_status_spec.rb +3 -3
- data/spec/models/shipments_sort_by_spec.rb +3 -3
- data/spec/models/smart_post_hub_spec.rb +3 -3
- data/spec/models/sort_dir_spec.rb +3 -3
- data/spec/models/tag_shipment_response_body_spec.rb +3 -3
- data/spec/models/tag_spec.rb +3 -3
- data/spec/models/track_event_spec.rb +3 -3
- data/spec/models/tracking_information_spec.rb +3 -3
- data/spec/models/tracking_status_spec.rb +3 -3
- data/spec/models/update_amazon_buy_shipping_request_body_spec.rb +3 -3
- data/spec/models/update_carrier_settings_request_body_spec.rb +3 -3
- data/spec/models/update_dhl_express_settings_request_body_spec.rb +3 -3
- data/spec/models/update_fedex_settings_request_body_spec.rb +3 -3
- data/spec/models/update_newgistics_settings_request_body_spec.rb +3 -3
- data/spec/models/update_package_type_request_body_spec.rb +3 -3
- data/spec/models/update_shipment_fields_spec.rb +3 -3
- data/spec/models/update_shipment_request_body_spec.rb +3 -3
- data/spec/models/update_shipment_response_body_spec.rb +3 -3
- data/spec/models/update_ups_settings_request_body_spec.rb +3 -3
- data/spec/models/update_warehouse_request_body_spec.rb +3 -3
- data/spec/models/update_webhook_request_body_spec.rb +3 -3
- data/spec/models/ups_account_settings_spec.rb +3 -3
- data/spec/models/ups_invoice_spec.rb +3 -3
- data/spec/models/ups_pickup_type_spec.rb +3 -3
- data/spec/models/ups_settings_response_body_spec.rb +3 -3
- data/spec/models/validate_address_spec.rb +3 -3
- data/spec/models/validate_shipment_fields_spec.rb +3 -3
- data/spec/models/validation_status_spec.rb +3 -3
- data/spec/models/void_label_response_body_spec.rb +3 -3
- data/spec/models/warehouse_spec.rb +3 -3
- data/spec/models/webhook_event_spec.rb +3 -3
- data/spec/models/webhook_spec.rb +3 -3
- data/spec/models/weight_spec.rb +3 -3
- data/spec/models/weight_unit_spec.rb +3 -3
- data/spec/spec_helper.rb +1 -1
- metadata +248 -246
- data/lib/openapi_client.rb +0 -278
- 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
|
# A package type that a carrier supports for shipment.
|
|
17
17
|
class PackageType
|
|
18
18
|
# A string that uniquely identifies the package.
|
|
@@ -61,14 +61,12 @@ module OpenapiClient
|
|
|
61
61
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
62
62
|
def initialize(attributes = {})
|
|
63
63
|
if (!attributes.is_a?(Hash))
|
|
64
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `
|
|
64
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::PackageType` initialize method"
|
|
65
65
|
end
|
|
66
66
|
|
|
67
67
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
68
68
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
69
|
-
|
|
70
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::PackageType`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
71
|
-
end
|
|
69
|
+
|
|
72
70
|
h[k.to_sym] = v
|
|
73
71
|
}
|
|
74
72
|
|
|
@@ -223,7 +221,7 @@ module OpenapiClient
|
|
|
223
221
|
end
|
|
224
222
|
end
|
|
225
223
|
else # model
|
|
226
|
-
|
|
224
|
+
ShipEngine.const_get(type).build_from_hash(value)
|
|
227
225
|
end
|
|
228
226
|
end
|
|
229
227
|
|
|
@@ -249,7 +247,7 @@ module OpenapiClient
|
|
|
249
247
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
250
248
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
251
249
|
end
|
|
252
|
-
|
|
250
|
+
|
|
253
251
|
hash[param] = _to_hash(value)
|
|
254
252
|
end
|
|
255
253
|
hash
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#ShipEngine API
|
|
3
3
|
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
|
7
7
|
Contact: sales@shipengine.com
|
|
@@ -12,8 +12,8 @@ OpenAPI Generator version: 4.3.1
|
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
14
|
|
|
15
|
-
module
|
|
16
|
-
# Many ShipEngine endpoints return a paged list of items. In addition to the returned items, these responses also include information about the total number of items, the number of pages of results, and URLs of other pages of results.
|
|
15
|
+
module ShipEngine
|
|
16
|
+
# Many ShipEngine endpoints return a paged list of items. In addition to the returned items, these responses also include information about the total number of items, the number of pages of results, and URLs of other pages of results.
|
|
17
17
|
class PagedListResponseBody
|
|
18
18
|
# The total number of items across all pages of results
|
|
19
19
|
attr_accessor :total
|
|
@@ -56,14 +56,12 @@ 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::PagedListResponseBody` 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
|
-
|
|
65
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::PagedListResponseBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
66
|
-
end
|
|
64
|
+
|
|
67
65
|
h[k.to_sym] = v
|
|
68
66
|
}
|
|
69
67
|
|
|
@@ -261,7 +259,7 @@ module OpenapiClient
|
|
|
261
259
|
end
|
|
262
260
|
end
|
|
263
261
|
else # model
|
|
264
|
-
|
|
262
|
+
ShipEngine.const_get(type).build_from_hash(value)
|
|
265
263
|
end
|
|
266
264
|
end
|
|
267
265
|
|
|
@@ -287,7 +285,7 @@ module OpenapiClient
|
|
|
287
285
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
288
286
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
289
287
|
end
|
|
290
|
-
|
|
288
|
+
|
|
291
289
|
hash[param] = _to_hash(value)
|
|
292
290
|
end
|
|
293
291
|
hash
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#ShipEngine API
|
|
3
3
|
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
|
7
7
|
Contact: sales@shipengine.com
|
|
@@ -12,19 +12,19 @@ OpenAPI Generator version: 4.3.1
|
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
14
|
|
|
15
|
-
module
|
|
15
|
+
module ShipEngine
|
|
16
16
|
# Helpful links to other pages of results
|
|
17
17
|
class PaginationLink
|
|
18
|
-
# The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.
|
|
18
|
+
# The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.
|
|
19
19
|
attr_accessor :first
|
|
20
20
|
|
|
21
|
-
# The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.
|
|
21
|
+
# The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.
|
|
22
22
|
attr_accessor :last
|
|
23
23
|
|
|
24
|
-
# The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.
|
|
24
|
+
# The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.
|
|
25
25
|
attr_accessor :prev
|
|
26
26
|
|
|
27
|
-
# The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.
|
|
27
|
+
# The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.
|
|
28
28
|
attr_accessor :_next
|
|
29
29
|
|
|
30
30
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -57,14 +57,12 @@ module OpenapiClient
|
|
|
57
57
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
58
58
|
def initialize(attributes = {})
|
|
59
59
|
if (!attributes.is_a?(Hash))
|
|
60
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `
|
|
60
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::PaginationLink` initialize method"
|
|
61
61
|
end
|
|
62
62
|
|
|
63
63
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
64
64
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
65
|
-
|
|
66
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::PaginationLink`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
67
|
-
end
|
|
65
|
+
|
|
68
66
|
h[k.to_sym] = v
|
|
69
67
|
}
|
|
70
68
|
|
|
@@ -205,7 +203,7 @@ module OpenapiClient
|
|
|
205
203
|
end
|
|
206
204
|
end
|
|
207
205
|
else # model
|
|
208
|
-
|
|
206
|
+
ShipEngine.const_get(type).build_from_hash(value)
|
|
209
207
|
end
|
|
210
208
|
end
|
|
211
209
|
|
|
@@ -231,7 +229,7 @@ module OpenapiClient
|
|
|
231
229
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
232
230
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
233
231
|
end
|
|
234
|
-
|
|
232
|
+
|
|
235
233
|
hash[param] = _to_hash(value)
|
|
236
234
|
end
|
|
237
235
|
hash
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#ShipEngine API
|
|
3
3
|
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
|
7
7
|
Contact: sales@shipengine.com
|
|
@@ -12,13 +12,13 @@ OpenAPI Generator version: 4.3.1
|
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
14
|
|
|
15
|
-
module
|
|
16
|
-
# The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.
|
|
15
|
+
module ShipEngine
|
|
16
|
+
# The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.
|
|
17
17
|
class ParseAddressRequestBody
|
|
18
18
|
# The unstructured text that contains address-related entities
|
|
19
19
|
attr_accessor :text
|
|
20
20
|
|
|
21
|
-
# You can optionally provide any already-known address values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.
|
|
21
|
+
# You can optionally provide any already-known address values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.
|
|
22
22
|
attr_accessor :address
|
|
23
23
|
|
|
24
24
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -47,14 +47,12 @@ 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::ParseAddressRequestBody` 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
|
-
|
|
56
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::ParseAddressRequestBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
57
|
-
end
|
|
55
|
+
|
|
58
56
|
h[k.to_sym] = v
|
|
59
57
|
}
|
|
60
58
|
|
|
@@ -189,7 +187,7 @@ module OpenapiClient
|
|
|
189
187
|
end
|
|
190
188
|
end
|
|
191
189
|
else # model
|
|
192
|
-
|
|
190
|
+
ShipEngine.const_get(type).build_from_hash(value)
|
|
193
191
|
end
|
|
194
192
|
end
|
|
195
193
|
|
|
@@ -215,7 +213,7 @@ module OpenapiClient
|
|
|
215
213
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
216
214
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
217
215
|
end
|
|
218
|
-
|
|
216
|
+
|
|
219
217
|
hash[param] = _to_hash(value)
|
|
220
218
|
end
|
|
221
219
|
hash
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#ShipEngine API
|
|
3
3
|
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
|
7
7
|
Contact: sales@shipengine.com
|
|
@@ -12,16 +12,16 @@ OpenAPI Generator version: 4.3.1
|
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
14
|
|
|
15
|
-
module
|
|
16
|
-
# The parsed address, as well as a confidence score and a list of all the entities that were recognized in the text.
|
|
15
|
+
module ShipEngine
|
|
16
|
+
# The parsed address, as well as a confidence score and a list of all the entities that were recognized in the text.
|
|
17
17
|
class ParseAddressResponseBody
|
|
18
|
-
# A confidence score between zero and one that indicates how certain the API is that it understood the text.
|
|
18
|
+
# A confidence score between zero and one that indicates how certain the API is that it understood the text.
|
|
19
19
|
attr_accessor :score
|
|
20
20
|
|
|
21
|
-
# The parsed address. This address may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The address-recognition API does not currently perform any validation of the parsed address, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the address is correct.
|
|
21
|
+
# The parsed address. This address may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The address-recognition API does not currently perform any validation of the parsed address, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the address is correct.
|
|
22
22
|
attr_accessor :address
|
|
23
23
|
|
|
24
|
-
# All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, or an address line. Each entity includes the original text and the parsed value.
|
|
24
|
+
# All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, or an address line. Each entity includes the original text and the parsed value.
|
|
25
25
|
attr_accessor :entities
|
|
26
26
|
|
|
27
27
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -52,14 +52,12 @@ module OpenapiClient
|
|
|
52
52
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
53
53
|
def initialize(attributes = {})
|
|
54
54
|
if (!attributes.is_a?(Hash))
|
|
55
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `
|
|
55
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::ParseAddressResponseBody` initialize method"
|
|
56
56
|
end
|
|
57
57
|
|
|
58
58
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
59
59
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
60
|
-
|
|
61
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::ParseAddressResponseBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
62
|
-
end
|
|
60
|
+
|
|
63
61
|
h[k.to_sym] = v
|
|
64
62
|
}
|
|
65
63
|
|
|
@@ -220,7 +218,7 @@ module OpenapiClient
|
|
|
220
218
|
end
|
|
221
219
|
end
|
|
222
220
|
else # model
|
|
223
|
-
|
|
221
|
+
ShipEngine.const_get(type).build_from_hash(value)
|
|
224
222
|
end
|
|
225
223
|
end
|
|
226
224
|
|
|
@@ -246,7 +244,7 @@ module OpenapiClient
|
|
|
246
244
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
247
245
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
248
246
|
end
|
|
249
|
-
|
|
247
|
+
|
|
250
248
|
hash[param] = _to_hash(value)
|
|
251
249
|
end
|
|
252
250
|
hash
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#ShipEngine API
|
|
3
3
|
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
|
7
7
|
Contact: sales@shipengine.com
|
|
@@ -12,13 +12,13 @@ OpenAPI Generator version: 4.3.1
|
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
14
|
|
|
15
|
-
module
|
|
16
|
-
# The only required field is `text`, which is the text to be parsed. You can optionally also provide a `shipment` containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use.
|
|
15
|
+
module ShipEngine
|
|
16
|
+
# The only required field is `text`, which is the text to be parsed. You can optionally also provide a `shipment` containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use.
|
|
17
17
|
class ParseShipmentRequestBody
|
|
18
18
|
# The unstructured text that contains shipping-related entities
|
|
19
19
|
attr_accessor :text
|
|
20
20
|
|
|
21
|
-
# You can optionally provide a `shipment` object containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use.
|
|
21
|
+
# You can optionally provide a `shipment` object containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use.
|
|
22
22
|
attr_accessor :shipment
|
|
23
23
|
|
|
24
24
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -47,14 +47,12 @@ 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::ParseShipmentRequestBody` 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
|
-
|
|
56
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::ParseShipmentRequestBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
57
|
-
end
|
|
55
|
+
|
|
58
56
|
h[k.to_sym] = v
|
|
59
57
|
}
|
|
60
58
|
|
|
@@ -189,7 +187,7 @@ module OpenapiClient
|
|
|
189
187
|
end
|
|
190
188
|
end
|
|
191
189
|
else # model
|
|
192
|
-
|
|
190
|
+
ShipEngine.const_get(type).build_from_hash(value)
|
|
193
191
|
end
|
|
194
192
|
end
|
|
195
193
|
|
|
@@ -215,7 +213,7 @@ module OpenapiClient
|
|
|
215
213
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
216
214
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
217
215
|
end
|
|
218
|
-
|
|
216
|
+
|
|
219
217
|
hash[param] = _to_hash(value)
|
|
220
218
|
end
|
|
221
219
|
hash
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#ShipEngine API
|
|
3
3
|
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
|
7
7
|
Contact: sales@shipengine.com
|
|
@@ -12,16 +12,16 @@ OpenAPI Generator version: 4.3.1
|
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
14
|
|
|
15
|
-
module
|
|
16
|
-
# The parsed shipment, as well as a confidence score and a list of all the shipping entities that were recognized in the text.
|
|
15
|
+
module ShipEngine
|
|
16
|
+
# The parsed shipment, as well as a confidence score and a list of all the shipping entities that were recognized in the text.
|
|
17
17
|
class ParseShipmentResponseBody
|
|
18
|
-
# A confidence score between zero and one that indicates how certain the API is that it understood the text.
|
|
18
|
+
# A confidence score between zero and one that indicates how certain the API is that it understood the text.
|
|
19
19
|
attr_accessor :score
|
|
20
20
|
|
|
21
|
-
# The parsed shipment. This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct.
|
|
21
|
+
# The parsed shipment. This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct.
|
|
22
22
|
attr_accessor :shipment
|
|
23
23
|
|
|
24
|
-
# All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value.
|
|
24
|
+
# All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value.
|
|
25
25
|
attr_accessor :entities
|
|
26
26
|
|
|
27
27
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -52,14 +52,12 @@ module OpenapiClient
|
|
|
52
52
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
53
53
|
def initialize(attributes = {})
|
|
54
54
|
if (!attributes.is_a?(Hash))
|
|
55
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `
|
|
55
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::ParseShipmentResponseBody` initialize method"
|
|
56
56
|
end
|
|
57
57
|
|
|
58
58
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
59
59
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
60
|
-
|
|
61
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::ParseShipmentResponseBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
62
|
-
end
|
|
60
|
+
|
|
63
61
|
h[k.to_sym] = v
|
|
64
62
|
}
|
|
65
63
|
|
|
@@ -220,7 +218,7 @@ module OpenapiClient
|
|
|
220
218
|
end
|
|
221
219
|
end
|
|
222
220
|
else # model
|
|
223
|
-
|
|
221
|
+
ShipEngine.const_get(type).build_from_hash(value)
|
|
224
222
|
end
|
|
225
223
|
end
|
|
226
224
|
|
|
@@ -246,7 +244,7 @@ module OpenapiClient
|
|
|
246
244
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
247
245
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
248
246
|
end
|
|
249
|
-
|
|
247
|
+
|
|
250
248
|
hash[param] = _to_hash(value)
|
|
251
249
|
end
|
|
252
250
|
hash
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#ShipEngine API
|
|
3
3
|
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
|
7
7
|
Contact: sales@shipengine.com
|
|
@@ -12,36 +12,36 @@ OpenAPI Generator version: 4.3.1
|
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
14
|
|
|
15
|
-
module
|
|
15
|
+
module ShipEngine
|
|
16
16
|
# A complete or partial mailing address.
|
|
17
17
|
class PartialAddress
|
|
18
|
-
# The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.
|
|
18
|
+
# The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.
|
|
19
19
|
attr_accessor :name
|
|
20
20
|
|
|
21
|
-
# The phone number of a contact person at this address. The format of this phone number varies depending on the country.
|
|
21
|
+
# The phone number of a contact person at this address. The format of this phone number varies depending on the country.
|
|
22
22
|
attr_accessor :phone
|
|
23
23
|
|
|
24
|
-
# If this is a business address, then the company name should be specified here.
|
|
24
|
+
# If this is a business address, then the company name should be specified here.
|
|
25
25
|
attr_accessor :company_name
|
|
26
26
|
|
|
27
|
-
# The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
|
|
27
|
+
# The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
|
|
28
28
|
attr_accessor :address_line1
|
|
29
29
|
|
|
30
|
-
# The second line of the street address. For some addresses, this line may not be needed.
|
|
30
|
+
# The second line of the street address. For some addresses, this line may not be needed.
|
|
31
31
|
attr_accessor :address_line2
|
|
32
32
|
|
|
33
|
-
# The third line of the street address. For some addresses, this line may not be needed.
|
|
33
|
+
# The third line of the street address. For some addresses, this line may not be needed.
|
|
34
34
|
attr_accessor :address_line3
|
|
35
35
|
|
|
36
36
|
# The name of the city or locality
|
|
37
37
|
attr_accessor :city_locality
|
|
38
38
|
|
|
39
|
-
# The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
|
|
39
|
+
# The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
|
|
40
40
|
attr_accessor :state_province
|
|
41
41
|
|
|
42
42
|
attr_accessor :postal_code
|
|
43
43
|
|
|
44
|
-
# The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)
|
|
44
|
+
# The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)
|
|
45
45
|
attr_accessor :country_code
|
|
46
46
|
|
|
47
47
|
# Indicates whether this is a residential address.
|
|
@@ -96,14 +96,12 @@ module OpenapiClient
|
|
|
96
96
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
97
97
|
def initialize(attributes = {})
|
|
98
98
|
if (!attributes.is_a?(Hash))
|
|
99
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `
|
|
99
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::PartialAddress` initialize method"
|
|
100
100
|
end
|
|
101
101
|
|
|
102
102
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
103
103
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
104
|
-
|
|
105
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::PartialAddress`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
106
|
-
end
|
|
104
|
+
|
|
107
105
|
h[k.to_sym] = v
|
|
108
106
|
}
|
|
109
107
|
|
|
@@ -379,7 +377,7 @@ module OpenapiClient
|
|
|
379
377
|
end
|
|
380
378
|
end
|
|
381
379
|
else # model
|
|
382
|
-
|
|
380
|
+
ShipEngine.const_get(type).build_from_hash(value)
|
|
383
381
|
end
|
|
384
382
|
end
|
|
385
383
|
|
|
@@ -405,7 +403,7 @@ module OpenapiClient
|
|
|
405
403
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
406
404
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
407
405
|
end
|
|
408
|
-
|
|
406
|
+
|
|
409
407
|
hash[param] = _to_hash(value)
|
|
410
408
|
end
|
|
411
409
|
hash
|