ship_engine 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +315 -320
- data/docs/AddFundsToCarrierRequestBody.md +5 -6
- data/docs/AddFundsToCarrierResponseBody.md +5 -7
- data/docs/AddFundsToInsuranceRequestBody.md +5 -6
- data/docs/AddFundsToInsuranceResponseBody.md +5 -6
- data/docs/AddToBatchRequestBody.md +5 -6
- data/docs/Address.md +5 -6
- data/docs/AddressResidentialIndicator.md +5 -6
- data/docs/AddressToValidate.md +5 -6
- data/docs/AddressValidatingShipment.md +27 -29
- data/docs/AddressValidationCode.md +5 -6
- data/docs/AddressValidationDetailCode.md +5 -6
- data/docs/AddressValidationMessageType.md +5 -6
- data/docs/AddressValidationResult.md +8 -10
- data/docs/AddressValidationStatus.md +5 -6
- data/docs/AddressesApi.md +19 -25
- data/docs/AdvancedShipmentOptions.md +20 -22
- data/docs/AncillaryServiceEndorsement.md +5 -6
- data/docs/Batch.md +22 -24
- data/docs/BatchResponseError.md +6 -8
- data/docs/BatchStatus.md +5 -6
- data/docs/BatchesApi.md +84 -106
- data/docs/BatchesSortBy.md +5 -6
- data/docs/BillToParty.md +5 -6
- data/docs/BulkRate.md +9 -11
- data/docs/CalculateRatesRequestBody.md +5 -6
- data/docs/CalculateRatesResponseBody.md +27 -29
- data/docs/Carrier.md +17 -19
- data/docs/CarrierAccountsApi.md +38 -48
- data/docs/CarrierAdvancedOption.md +7 -9
- data/docs/CarrierName.md +5 -6
- data/docs/CarrierNameWithSettings.md +5 -6
- data/docs/CarriersApi.md +38 -51
- data/docs/CollectOnDelivery.md +6 -8
- data/docs/CollectOnDeliveryPaymentType.md +5 -6
- data/docs/CompareBulkRatesRequestBody.md +5 -6
- data/docs/ConnectAccessWorldwideRequestBody.md +7 -9
- data/docs/ConnectAmazonBuyShippingRequestBody.md +8 -10
- data/docs/ConnectApcRequestBody.md +7 -9
- data/docs/ConnectAsendiaRequestBody.md +8 -10
- data/docs/ConnectAustraliaPostRequestBody.md +8 -10
- data/docs/ConnectCanadaPostRequestBody.md +9 -11
- data/docs/ConnectCarrierRequestBody.md +53 -55
- data/docs/ConnectCarrierResponseBody.md +5 -7
- data/docs/ConnectDhlEcommerceRequestBody.md +16 -18
- data/docs/ConnectDhlExpressAuRequestBody.md +6 -8
- data/docs/ConnectDhlExpressCaRequestBody.md +6 -8
- data/docs/ConnectDhlExpressRequestBody.md +6 -8
- data/docs/ConnectDhlExpressUkRequestBody.md +8 -10
- data/docs/ConnectDpdRequestBody.md +7 -9
- data/docs/ConnectEndiciaRequestBody.md +7 -9
- data/docs/ConnectFedexRequestBody.md +19 -21
- data/docs/ConnectFedexUkRequestBody.md +19 -21
- data/docs/ConnectFirstmileRequestBody.md +8 -10
- data/docs/ConnectGlobegisticsRequestBody.md +7 -9
- data/docs/ConnectImexRequestBody.md +7 -9
- data/docs/ConnectInsurerRequestBody.md +6 -8
- data/docs/ConnectNewgisticsRequestBody.md +8 -10
- data/docs/ConnectOntracRequestBody.md +7 -9
- data/docs/ConnectPurolatorRequestBody.md +7 -9
- data/docs/ConnectRoyalMailRequestBody.md +16 -18
- data/docs/ConnectRrDonnelleyRequestBody.md +7 -9
- data/docs/ConnectSekoRequestBody.md +6 -8
- data/docs/ConnectSendleRequestBody.md +7 -9
- data/docs/ConnectStampsRequestBody.md +7 -9
- data/docs/ConnectUpsRequestBody.md +22 -24
- data/docs/CreateAndValidateShipment.md +28 -30
- data/docs/CreateBatchRequestBody.md +8 -10
- data/docs/CreateBatchResponseBody.md +5 -6
- data/docs/CreateLabelFromRateRequestBody.md +5 -6
- data/docs/CreateLabelFromRateResponseBody.md +5 -6
- data/docs/CreateLabelFromShipmentRequestBody.md +8 -10
- data/docs/CreateLabelFromShipmentResponseBody.md +5 -6
- data/docs/CreateLabelRequestBody.md +5 -6
- data/docs/CreateLabelResponseBody.md +5 -6
- data/docs/CreateManifestByObjectRequestBody.md +9 -11
- data/docs/CreateManifestLabelIdsRequestBody.md +5 -7
- data/docs/CreateManifestRequestBody.md +9 -11
- data/docs/CreateManifestResponseBody.md +14 -16
- data/docs/CreatePackageTypeRequestBody.md +5 -6
- data/docs/CreatePackageTypeResponseBody.md +5 -6
- data/docs/CreateReturnLabelRequestBody.md +9 -11
- data/docs/CreateReturnLabelResponseBody.md +5 -6
- data/docs/CreateShipmentResponseBodyFields.md +6 -8
- data/docs/CreateShipmentsRequestBody.md +5 -7
- data/docs/CreateShipmentsResponseBody.md +6 -8
- data/docs/CreateTagResponseBody.md +5 -6
- data/docs/CreateWarehouseRequestBody.md +5 -6
- data/docs/CreateWarehouseResponseBody.md +5 -6
- data/docs/CreateWebhookRequestBody.md +4 -4
- data/docs/CreateWebhookResponseBody.md +5 -6
- data/docs/Currency.md +5 -6
- data/docs/CustomsItem.md +13 -15
- data/docs/DeliveryConfirmation.md +5 -6
- data/docs/DeprecatedManifest.md +13 -15
- data/docs/DhlExpressAccountSettings.md +7 -9
- data/docs/DhlExpressSettingsResponseBody.md +5 -6
- data/docs/DimensionUnit.md +5 -6
- data/docs/Dimensions.md +8 -10
- data/docs/DownloadsApi.md +16 -20
- data/docs/Error.md +8 -10
- data/docs/ErrorCode.md +5 -6
- data/docs/ErrorResponseBody.md +6 -8
- data/docs/ErrorSource.md +5 -6
- data/docs/ErrorType.md +5 -6
- data/docs/EstimateRatesRequestBody.md +5 -6
- data/docs/FedexAccountSettings.md +9 -11
- data/docs/FedexAccountSettingsRequestBody.md +5 -6
- data/docs/FedexPickupType.md +5 -6
- data/docs/FedexSettingsResponseBody.md +5 -6
- data/docs/GetBatchByExternalIdResponseBody.md +5 -6
- data/docs/GetBatchByIdResponseBody.md +5 -6
- data/docs/GetCarrierByIdResponseBody.md +5 -6
- data/docs/GetCarrierOptionsResponseBody.md +5 -7
- data/docs/GetCarrierSettingsResponseBody.md +19 -21
- data/docs/GetCarriersResponseBody.md +7 -9
- data/docs/GetInsuranceBalanceResponseBody.md +5 -6
- data/docs/GetLabelByExternalShipmentIdResponseBody.md +5 -6
- data/docs/GetLabelByIdResponseBody.md +5 -6
- data/docs/GetManifestByIdResponseBody.md +5 -6
- data/docs/GetPackageTypeByIdResponseBody.md +5 -6
- data/docs/GetRateByIdResponseBody.md +5 -6
- data/docs/GetShipmentByExternalIdResponseBody.md +5 -6
- data/docs/GetShipmentByIdResponseBody.md +5 -6
- data/docs/GetTrackingLogFromLabelResponseBody.md +5 -6
- data/docs/GetTrackingLogResponseBody.md +5 -6
- data/docs/GetWarehouseByIdResponseBody.md +5 -6
- data/docs/GetWebhookByIdResponseBody.md +5 -6
- data/docs/InsuranceApi.md +24 -32
- data/docs/InsuranceProvider.md +5 -6
- data/docs/InternationalShipmentOptions.md +7 -9
- data/docs/Label.md +34 -34
- data/docs/LabelChargeEvent.md +5 -6
- data/docs/LabelDownload.md +8 -10
- data/docs/LabelDownloadType.md +5 -6
- data/docs/LabelFormat.md +5 -6
- data/docs/LabelLayout.md +5 -6
- data/docs/LabelMessages.md +7 -9
- data/docs/LabelStatus.md +5 -6
- data/docs/LabelsApi.md +89 -109
- data/docs/Link.md +5 -6
- data/docs/ListBatchErrorsResponseBody.md +6 -8
- data/docs/ListBatchesResponseBody.md +9 -11
- data/docs/ListCarrierPackageTypesResponseBody.md +5 -7
- data/docs/ListCarrierServicesResponseBody.md +5 -7
- data/docs/ListCarriersResponseBody.md +5 -7
- data/docs/ListLabelsResponseBody.md +5 -7
- data/docs/ListManifestsResponseBody.md +9 -11
- data/docs/ListPackageTypesResponseBody.md +5 -7
- data/docs/ListShipmentErrorsResponseBody.md +6 -8
- data/docs/ListShipmentRatesResponseBody.md +5 -6
- data/docs/ListShipmentsResponseBody.md +9 -11
- data/docs/ListTagsResponseBody.md +5 -7
- data/docs/ListWarehousesResponseBody.md +5 -7
- data/docs/Manifest.md +13 -15
- data/docs/ManifestDownload.md +5 -7
- data/docs/Manifests.md +5 -7
- data/docs/ManifestsApi.md +33 -41
- data/docs/ModifyBatch.md +6 -8
- data/docs/MonetaryValue.md +6 -8
- data/docs/NonDelivery.md +5 -6
- data/docs/OptionalLink.md +6 -8
- data/docs/OrderSourceName.md +5 -6
- data/docs/Package.md +11 -13
- data/docs/PackageContents.md +5 -6
- data/docs/PackageType.md +9 -11
- data/docs/PackageTypesApi.md +33 -44
- data/docs/PagedListResponseBody.md +8 -10
- data/docs/PaginationLink.md +8 -10
- data/docs/ParseAddressRequestBody.md +6 -8
- data/docs/ParseAddressResponseBody.md +7 -9
- data/docs/ParseShipmentRequestBody.md +6 -8
- data/docs/ParseShipmentResponseBody.md +7 -9
- data/docs/PartialAddress.md +15 -17
- data/docs/PartialShipment.md +26 -28
- data/docs/PaymentAmount.md +6 -8
- data/docs/ProcessBatchRequestBody.md +7 -9
- data/docs/PurchaseLabelWithoutShipment.md +8 -10
- data/docs/Rate.md +29 -31
- data/docs/RateEstimateByCarrierId.md +5 -7
- data/docs/RateEstimateByCarrierIds.md +3 -3
- data/docs/RateEstimateOptions.md +17 -19
- data/docs/RateRequestBody.md +9 -11
- data/docs/RateRequestByShipmentIds.md +5 -7
- data/docs/RateRequestByShipments.md +5 -7
- data/docs/RateRequestOptions.md +5 -7
- data/docs/RateRequestRateOptions.md +5 -7
- data/docs/RateResponse.md +5 -7
- data/docs/RateResponseStatus.md +5 -6
- data/docs/RateType.md +5 -6
- data/docs/RatesApi.md +31 -41
- data/docs/RatesInformation.md +11 -13
- data/docs/RecognizedEntity.md +10 -12
- data/docs/RemoveFromBatchRequestBody.md +5 -6
- data/docs/ResponseMessage.md +8 -10
- data/docs/Service.md +11 -13
- data/docs/Shipment.md +5 -6
- data/docs/ShipmentIdRequest.md +5 -7
- data/docs/ShipmentItem.md +13 -15
- data/docs/ShipmentRequest.md +5 -7
- data/docs/ShipmentResponseError.md +7 -9
- data/docs/ShipmentStatus.md +5 -6
- data/docs/ShipmentsApi.md +101 -125
- data/docs/ShipmentsSortBy.md +5 -6
- data/docs/SmartPostHub.md +5 -6
- data/docs/SortDir.md +5 -6
- data/docs/Tag.md +5 -7
- data/docs/TagShipmentResponseBody.md +6 -8
- data/docs/TagsApi.md +29 -38
- data/docs/TrackEvent.md +16 -18
- data/docs/TrackingApi.md +25 -33
- data/docs/TrackingInformation.md +14 -16
- data/docs/TrackingStatus.md +5 -6
- data/docs/UpdateAmazonBuyShippingRequestBody.md +3 -3
- data/docs/UpdateCarrierSettingsRequestBody.md +22 -24
- data/docs/UpdateDhlExpressSettingsRequestBody.md +5 -6
- data/docs/UpdateFedexSettingsRequestBody.md +5 -6
- data/docs/UpdateNewgisticsSettingsRequestBody.md +6 -8
- data/docs/UpdatePackageTypeRequestBody.md +5 -6
- data/docs/UpdateShipmentFields.md +5 -7
- data/docs/UpdateShipmentRequestBody.md +27 -29
- data/docs/UpdateShipmentResponseBody.md +5 -6
- data/docs/UpdateUpsSettingsRequestBody.md +5 -6
- data/docs/UpdateWarehouseRequestBody.md +5 -6
- data/docs/UpdateWebhookRequestBody.md +5 -7
- data/docs/UpsAccountSettings.md +16 -18
- data/docs/UpsInvoice.md +8 -10
- data/docs/UpsPickupType.md +5 -6
- data/docs/UpsSettingsResponseBody.md +5 -6
- data/docs/ValidateAddress.md +5 -6
- data/docs/ValidateShipmentFields.md +5 -7
- data/docs/ValidationStatus.md +5 -6
- data/docs/VoidLabelResponseBody.md +6 -8
- data/docs/Warehouse.md +9 -11
- data/docs/WarehousesApi.md +34 -45
- data/docs/Webhook.md +7 -9
- data/docs/WebhookEvent.md +5 -6
- data/docs/WebhooksApi.md +33 -44
- data/docs/Weight.md +6 -8
- data/docs/WeightUnit.md +5 -6
- data/lib/ship_engine.rb +278 -0
- data/lib/{openapi_client → ship_engine}/api/addresses_api.rb +14 -14
- data/lib/{openapi_client → ship_engine}/api/batches_api.rb +42 -42
- data/lib/{openapi_client → ship_engine}/api/carrier_accounts_api.rb +14 -14
- data/lib/{openapi_client → ship_engine}/api/carriers_api.rb +16 -16
- data/lib/{openapi_client → ship_engine}/api/downloads_api.rb +12 -12
- data/lib/{openapi_client → ship_engine}/api/insurance_api.rb +16 -16
- data/lib/{openapi_client → ship_engine}/api/labels_api.rb +43 -43
- data/lib/{openapi_client → ship_engine}/api/manifests_api.rb +15 -15
- data/lib/{openapi_client → ship_engine}/api/package_types_api.rb +16 -16
- data/lib/{openapi_client → ship_engine}/api/rates_api.rb +18 -18
- data/lib/{openapi_client → ship_engine}/api/shipments_api.rb +50 -50
- data/lib/{openapi_client → ship_engine}/api/tags_api.rb +18 -18
- data/lib/{openapi_client → ship_engine}/api/tracking_api.rb +10 -10
- data/lib/{openapi_client → ship_engine}/api/warehouses_api.rb +18 -18
- data/lib/{openapi_client → ship_engine}/api/webhooks_api.rb +16 -16
- data/lib/{openapi_client → ship_engine}/api_client.rb +2 -2
- data/lib/{openapi_client → ship_engine}/api_error.rb +2 -2
- data/lib/{openapi_client → ship_engine}/configuration.rb +2 -2
- data/lib/ship_engine/models/add_funds_to_carrier_request_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/add_funds_to_carrier_response_body.rb +5 -5
- data/lib/{openapi_client/models/create_warehouse_response_body.rb → ship_engine/models/add_funds_to_insurance_request_body.rb} +8 -8
- data/lib/{openapi_client/models/add_funds_to_carrier_request_body.rb → ship_engine/models/add_funds_to_insurance_response_body.rb} +7 -7
- data/lib/{openapi_client → ship_engine}/models/add_to_batch_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/address.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/address_residential_indicator.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/address_to_validate.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/address_validating_shipment.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/address_validation_code.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/address_validation_detail_code.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/address_validation_message_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/address_validation_result.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/address_validation_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/advanced_shipment_options.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/ancillary_service_endorsement.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/batch.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/batch_response_error.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/batch_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/batches_sort_by.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/bill_to_party.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/bulk_rate.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/calculate_rates_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/calculate_rates_response_body.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/carrier.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/carrier_advanced_option.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/carrier_name.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/carrier_name_with_settings.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/collect_on_delivery.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/collect_on_delivery_payment_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/compare_bulk_rates_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_access_worldwide_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_amazon_buy_shipping_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_apc_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_asendia_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_australia_post_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_canada_post_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_carrier_request_body.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/connect_carrier_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_ecommerce_request_body.rb +7 -7
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_au_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_ca_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_uk_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dpd_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_endicia_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_fedex_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_fedex_uk_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_firstmile_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_globegistics_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_imex_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_insurer_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_newgistics_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_ontrac_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_purolator_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_royal_mail_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_rr_donnelley_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_seko_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_sendle_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_stamps_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_ups_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_and_validate_shipment.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/create_batch_request_body.rb +5 -5
- data/lib/ship_engine/models/create_batch_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/create_label_from_rate_request_body.rb +5 -5
- data/lib/{openapi_client/models/get_warehouse_by_id_response_body.rb → ship_engine/models/create_label_from_rate_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/create_label_from_shipment_request_body.rb +5 -5
- data/lib/{openapi_client/models/get_batch_by_external_id_response_body.rb → ship_engine/models/create_label_from_shipment_response_body.rb} +8 -8
- data/lib/ship_engine/models/create_label_request_body.rb +209 -0
- data/lib/ship_engine/models/create_label_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/create_manifest_by_object_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_manifest_label_ids_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_manifest_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_manifest_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_package_type_request_body.rb +5 -5
- data/lib/{openapi_client/models/get_carrier_by_id_response_body.rb → ship_engine/models/create_package_type_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/create_return_label_request_body.rb +8 -8
- data/lib/{openapi_client/models/get_webhook_by_id_response_body.rb → ship_engine/models/create_return_label_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/create_shipment_response_body_fields.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_shipments_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_shipments_response_body.rb +5 -5
- data/lib/ship_engine/models/create_tag_response_body.rb +209 -0
- data/lib/{openapi_client/models/create_batch_response_body.rb → ship_engine/models/create_warehouse_request_body.rb} +8 -8
- data/lib/{openapi_client/models/get_batch_by_id_response_body.rb → ship_engine/models/create_warehouse_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/create_webhook_request_body.rb +5 -5
- data/lib/{openapi_client/models/create_label_request_body.rb → ship_engine/models/create_webhook_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/currency.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/customs_item.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/delivery_confirmation.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/deprecated_manifest.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/dhl_express_account_settings.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/dhl_express_settings_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/dimension_unit.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/dimensions.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/error.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/error_code.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/error_response_body.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/error_source.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/error_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/estimate_rates_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/fedex_account_settings.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/fedex_account_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/fedex_pickup_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/fedex_settings_response_body.rb +5 -5
- data/lib/{openapi_client/models/create_return_label_response_body.rb → ship_engine/models/get_batch_by_external_id_response_body.rb} +8 -8
- data/lib/{openapi_client/models/create_tag_response_body.rb → ship_engine/models/get_batch_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client/models/create_label_response_body.rb → ship_engine/models/get_carrier_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/get_carrier_options_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/get_carrier_settings_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/get_carriers_response_body.rb +6 -6
- data/lib/ship_engine/models/get_insurance_balance_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/get_label_by_external_shipment_id_response_body.rb +5 -5
- data/lib/ship_engine/models/get_label_by_id_response_body.rb +209 -0
- data/lib/{openapi_client/models/get_label_by_id_response_body.rb → ship_engine/models/get_manifest_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client/models/get_shipment_by_id_response_body.rb → ship_engine/models/get_package_type_by_id_response_body.rb} +8 -8
- data/lib/ship_engine/models/get_rate_by_id_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/get_shipment_by_external_id_response_body.rb +5 -5
- data/lib/ship_engine/models/get_shipment_by_id_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/get_tracking_log_from_label_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/get_tracking_log_response_body.rb +5 -5
- data/lib/{openapi_client/models/create_webhook_response_body.rb → ship_engine/models/get_warehouse_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client/models/get_rate_by_id_response_body.rb → ship_engine/models/get_webhook_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/insurance_provider.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/international_shipment_options.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/label.rb +29 -29
- data/lib/{openapi_client → ship_engine}/models/label_charge_event.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/label_download.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/label_download_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/label_format.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/label_layout.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/label_messages.rb +9 -9
- data/lib/{openapi_client → ship_engine}/models/label_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/link.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_batch_errors_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_batches_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_carrier_package_types_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_carrier_services_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_carriers_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_labels_response_body.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/list_manifests_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_package_types_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_shipment_errors_response_body.rb +5 -5
- data/lib/{openapi_client/models/create_warehouse_request_body.rb → ship_engine/models/list_shipment_rates_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/list_shipments_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_tags_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_warehouses_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/manifest.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/manifest_download.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/manifests.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/modify_batch.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/monetary_value.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/non_delivery.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/optional_link.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/order_source_name.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/package.rb +8 -8
- data/lib/{openapi_client → ship_engine}/models/package_contents.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/package_type.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/paged_list_response_body.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/pagination_link.rb +9 -9
- data/lib/{openapi_client → ship_engine}/models/parse_address_request_body.rb +7 -7
- data/lib/{openapi_client → ship_engine}/models/parse_address_response_body.rb +9 -9
- data/lib/{openapi_client → ship_engine}/models/parse_shipment_request_body.rb +7 -7
- data/lib/{openapi_client → ship_engine}/models/parse_shipment_response_body.rb +9 -9
- data/lib/{openapi_client → ship_engine}/models/partial_address.rb +13 -13
- data/lib/{openapi_client → ship_engine}/models/partial_shipment.rb +17 -17
- data/lib/{openapi_client → ship_engine}/models/payment_amount.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/process_batch_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/purchase_label_without_shipment.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate.rb +7 -7
- data/lib/{openapi_client → ship_engine}/models/rate_estimate_by_carrier_id.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_estimate_by_carrier_ids.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_estimate_options.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_by_shipment_ids.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_by_shipments.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_options.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_rate_options.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_response.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_response_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/rate_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/rates_information.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/recognized_entity.rb +8 -8
- data/lib/{openapi_client → ship_engine}/models/remove_from_batch_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/response_message.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/service.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/shipment_id_request.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment_item.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment_request.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment_response_error.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/shipments_sort_by.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/smart_post_hub.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/sort_dir.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/tag.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/tag_shipment_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/track_event.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/tracking_information.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/tracking_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/update_amazon_buy_shipping_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_carrier_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_dhl_express_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_fedex_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_newgistics_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_package_type_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_shipment_fields.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_shipment_request_body.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/update_shipment_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_ups_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_warehouse_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_webhook_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/ups_account_settings.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/ups_invoice.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/ups_pickup_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/ups_settings_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/validate_address.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/validate_shipment_fields.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/validation_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/void_label_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/warehouse.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/webhook.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/webhook_event.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/weight.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/weight_unit.rb +2 -2
- data/lib/{openapi_client → ship_engine}/version.rb +3 -3
- data/ship_engine-1.0.0.gem +0 -0
- data/ship_engine.gemspec +2 -2
- data/spec/api/addresses_api_spec.rb +8 -8
- data/spec/api/batches_api_spec.rb +15 -15
- data/spec/api/carrier_accounts_api_spec.rb +6 -6
- data/spec/api/carriers_api_spec.rb +5 -5
- data/spec/api/downloads_api_spec.rb +8 -8
- data/spec/api/insurance_api_spec.rb +7 -7
- data/spec/api/labels_api_spec.rb +16 -16
- data/spec/api/manifests_api_spec.rb +8 -8
- data/spec/api/package_types_api_spec.rb +6 -6
- data/spec/api/rates_api_spec.rb +8 -8
- data/spec/api/shipments_api_spec.rb +18 -18
- data/spec/api/tags_api_spec.rb +8 -8
- data/spec/api/tracking_api_spec.rb +5 -5
- data/spec/api/warehouses_api_spec.rb +7 -7
- data/spec/api/webhooks_api_spec.rb +6 -6
- data/spec/api_client_spec.rb +24 -24
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/add_funds_to_carrier_request_body_spec.rb +4 -4
- data/spec/models/add_funds_to_carrier_response_body_spec.rb +4 -4
- data/spec/models/add_funds_to_insurance_request_body_spec.rb +4 -4
- data/spec/models/add_funds_to_insurance_response_body_spec.rb +4 -4
- data/spec/models/add_to_batch_request_body_spec.rb +4 -4
- data/spec/models/address_residential_indicator_spec.rb +4 -4
- data/spec/models/address_spec.rb +4 -4
- data/spec/models/address_to_validate_spec.rb +4 -4
- data/spec/models/address_validating_shipment_spec.rb +4 -4
- data/spec/models/address_validation_code_spec.rb +4 -4
- data/spec/models/address_validation_detail_code_spec.rb +4 -4
- data/spec/models/address_validation_message_type_spec.rb +4 -4
- data/spec/models/address_validation_result_spec.rb +4 -4
- data/spec/models/address_validation_status_spec.rb +4 -4
- data/spec/models/advanced_shipment_options_spec.rb +4 -4
- data/spec/models/ancillary_service_endorsement_spec.rb +4 -4
- data/spec/models/batch_response_error_spec.rb +4 -4
- data/spec/models/batch_spec.rb +4 -4
- data/spec/models/batch_status_spec.rb +4 -4
- data/spec/models/batches_sort_by_spec.rb +4 -4
- data/spec/models/bill_to_party_spec.rb +4 -4
- data/spec/models/bulk_rate_spec.rb +4 -4
- data/spec/models/calculate_rates_request_body_spec.rb +4 -4
- data/spec/models/calculate_rates_response_body_spec.rb +4 -4
- data/spec/models/carrier_advanced_option_spec.rb +4 -4
- data/spec/models/carrier_name_spec.rb +4 -4
- data/spec/models/carrier_name_with_settings_spec.rb +4 -4
- data/spec/models/carrier_spec.rb +4 -4
- data/spec/models/collect_on_delivery_payment_type_spec.rb +4 -4
- data/spec/models/collect_on_delivery_spec.rb +4 -4
- data/spec/models/compare_bulk_rates_request_body_spec.rb +4 -4
- data/spec/models/connect_access_worldwide_request_body_spec.rb +4 -4
- data/spec/models/connect_amazon_buy_shipping_request_body_spec.rb +4 -4
- data/spec/models/connect_apc_request_body_spec.rb +4 -4
- data/spec/models/connect_asendia_request_body_spec.rb +4 -4
- data/spec/models/connect_australia_post_request_body_spec.rb +4 -4
- data/spec/models/connect_canada_post_request_body_spec.rb +4 -4
- data/spec/models/connect_carrier_request_body_spec.rb +4 -4
- data/spec/models/connect_carrier_response_body_spec.rb +4 -4
- data/spec/models/connect_dhl_ecommerce_request_body_spec.rb +4 -4
- data/spec/models/connect_dhl_express_au_request_body_spec.rb +4 -4
- data/spec/models/connect_dhl_express_ca_request_body_spec.rb +4 -4
- data/spec/models/connect_dhl_express_request_body_spec.rb +4 -4
- data/spec/models/connect_dhl_express_uk_request_body_spec.rb +4 -4
- data/spec/models/connect_dpd_request_body_spec.rb +4 -4
- data/spec/models/connect_endicia_request_body_spec.rb +4 -4
- data/spec/models/connect_fedex_request_body_spec.rb +4 -4
- data/spec/models/connect_fedex_uk_request_body_spec.rb +4 -4
- data/spec/models/connect_firstmile_request_body_spec.rb +4 -4
- data/spec/models/connect_globegistics_request_body_spec.rb +4 -4
- data/spec/models/connect_imex_request_body_spec.rb +4 -4
- data/spec/models/connect_insurer_request_body_spec.rb +4 -4
- data/spec/models/connect_newgistics_request_body_spec.rb +4 -4
- data/spec/models/connect_ontrac_request_body_spec.rb +4 -4
- data/spec/models/connect_purolator_request_body_spec.rb +4 -4
- data/spec/models/connect_royal_mail_request_body_spec.rb +4 -4
- data/spec/models/connect_rr_donnelley_request_body_spec.rb +4 -4
- data/spec/models/connect_seko_request_body_spec.rb +4 -4
- data/spec/models/connect_sendle_request_body_spec.rb +4 -4
- data/spec/models/connect_stamps_request_body_spec.rb +4 -4
- data/spec/models/connect_ups_request_body_spec.rb +4 -4
- data/spec/models/create_and_validate_shipment_spec.rb +4 -4
- data/spec/models/create_batch_request_body_spec.rb +4 -4
- data/spec/models/create_batch_response_body_spec.rb +4 -4
- data/spec/models/create_label_from_rate_request_body_spec.rb +4 -4
- data/spec/models/create_label_from_rate_response_body_spec.rb +4 -4
- data/spec/models/create_label_from_shipment_request_body_spec.rb +4 -4
- data/spec/models/create_label_from_shipment_response_body_spec.rb +4 -4
- data/spec/models/create_label_request_body_spec.rb +4 -4
- data/spec/models/create_label_response_body_spec.rb +4 -4
- data/spec/models/create_manifest_by_object_request_body_spec.rb +4 -4
- data/spec/models/create_manifest_label_ids_request_body_spec.rb +4 -4
- data/spec/models/create_manifest_request_body_spec.rb +4 -4
- data/spec/models/create_manifest_response_body_spec.rb +4 -4
- data/spec/models/create_package_type_request_body_spec.rb +4 -4
- data/spec/models/create_package_type_response_body_spec.rb +4 -4
- data/spec/models/create_return_label_request_body_spec.rb +4 -4
- data/spec/models/create_return_label_response_body_spec.rb +4 -4
- data/spec/models/create_shipment_response_body_fields_spec.rb +4 -4
- data/spec/models/create_shipments_request_body_spec.rb +4 -4
- data/spec/models/create_shipments_response_body_spec.rb +4 -4
- data/spec/models/create_tag_response_body_spec.rb +4 -4
- data/spec/models/create_warehouse_request_body_spec.rb +4 -4
- data/spec/models/create_warehouse_response_body_spec.rb +4 -4
- data/spec/models/create_webhook_request_body_spec.rb +4 -4
- data/spec/models/create_webhook_response_body_spec.rb +4 -4
- data/spec/models/currency_spec.rb +4 -4
- data/spec/models/customs_item_spec.rb +4 -4
- data/spec/models/delivery_confirmation_spec.rb +4 -4
- data/spec/models/deprecated_manifest_spec.rb +4 -4
- data/spec/models/dhl_express_account_settings_spec.rb +4 -4
- data/spec/models/dhl_express_settings_response_body_spec.rb +4 -4
- data/spec/models/dimension_unit_spec.rb +4 -4
- data/spec/models/dimensions_spec.rb +4 -4
- data/spec/models/error_code_spec.rb +4 -4
- data/spec/models/error_response_body_spec.rb +4 -4
- data/spec/models/error_source_spec.rb +4 -4
- data/spec/models/error_spec.rb +4 -4
- data/spec/models/error_type_spec.rb +4 -4
- data/spec/models/estimate_rates_request_body_spec.rb +4 -4
- data/spec/models/fedex_account_settings_request_body_spec.rb +4 -4
- data/spec/models/fedex_account_settings_spec.rb +4 -4
- data/spec/models/fedex_pickup_type_spec.rb +4 -4
- data/spec/models/fedex_settings_response_body_spec.rb +4 -4
- data/spec/models/get_batch_by_external_id_response_body_spec.rb +4 -4
- data/spec/models/get_batch_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_carrier_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_carrier_options_response_body_spec.rb +4 -4
- data/spec/models/get_carrier_settings_response_body_spec.rb +4 -4
- data/spec/models/get_carriers_response_body_spec.rb +4 -4
- data/spec/models/get_insurance_balance_response_body_spec.rb +4 -4
- data/spec/models/get_label_by_external_shipment_id_response_body_spec.rb +4 -4
- data/spec/models/get_label_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_manifest_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_package_type_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_rate_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_shipment_by_external_id_response_body_spec.rb +4 -4
- data/spec/models/get_shipment_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_tracking_log_from_label_response_body_spec.rb +4 -4
- data/spec/models/get_tracking_log_response_body_spec.rb +4 -4
- data/spec/models/get_warehouse_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_webhook_by_id_response_body_spec.rb +4 -4
- data/spec/models/insurance_provider_spec.rb +4 -4
- data/spec/models/international_shipment_options_spec.rb +4 -4
- data/spec/models/label_charge_event_spec.rb +4 -4
- data/spec/models/label_download_spec.rb +4 -4
- data/spec/models/label_download_type_spec.rb +4 -4
- data/spec/models/label_format_spec.rb +4 -4
- data/spec/models/label_layout_spec.rb +4 -4
- data/spec/models/label_messages_spec.rb +4 -4
- data/spec/models/label_spec.rb +4 -4
- data/spec/models/label_status_spec.rb +4 -4
- data/spec/models/link_spec.rb +4 -4
- data/spec/models/list_batch_errors_response_body_spec.rb +4 -4
- data/spec/models/list_batches_response_body_spec.rb +4 -4
- data/spec/models/list_carrier_package_types_response_body_spec.rb +4 -4
- data/spec/models/list_carrier_services_response_body_spec.rb +4 -4
- data/spec/models/list_carriers_response_body_spec.rb +4 -4
- data/spec/models/list_labels_response_body_spec.rb +4 -4
- data/spec/models/list_manifests_response_body_spec.rb +4 -4
- data/spec/models/list_package_types_response_body_spec.rb +4 -4
- data/spec/models/list_shipment_errors_response_body_spec.rb +4 -4
- data/spec/models/list_shipment_rates_response_body_spec.rb +4 -4
- data/spec/models/list_shipments_response_body_spec.rb +4 -4
- data/spec/models/list_tags_response_body_spec.rb +4 -4
- data/spec/models/list_warehouses_response_body_spec.rb +4 -4
- data/spec/models/manifest_download_spec.rb +4 -4
- data/spec/models/manifest_spec.rb +4 -4
- data/spec/models/manifests_spec.rb +4 -4
- data/spec/models/modify_batch_spec.rb +4 -4
- data/spec/models/monetary_value_spec.rb +4 -4
- data/spec/models/non_delivery_spec.rb +4 -4
- data/spec/models/optional_link_spec.rb +4 -4
- data/spec/models/order_source_name_spec.rb +4 -4
- data/spec/models/package_contents_spec.rb +4 -4
- data/spec/models/package_spec.rb +4 -4
- data/spec/models/package_type_spec.rb +4 -4
- data/spec/models/paged_list_response_body_spec.rb +4 -4
- data/spec/models/pagination_link_spec.rb +4 -4
- data/spec/models/parse_address_request_body_spec.rb +4 -4
- data/spec/models/parse_address_response_body_spec.rb +4 -4
- data/spec/models/parse_shipment_request_body_spec.rb +4 -4
- data/spec/models/parse_shipment_response_body_spec.rb +4 -4
- data/spec/models/partial_address_spec.rb +4 -4
- data/spec/models/partial_shipment_spec.rb +4 -4
- data/spec/models/payment_amount_spec.rb +4 -4
- data/spec/models/process_batch_request_body_spec.rb +4 -4
- data/spec/models/purchase_label_without_shipment_spec.rb +4 -4
- data/spec/models/rate_estimate_by_carrier_id_spec.rb +4 -4
- data/spec/models/rate_estimate_by_carrier_ids_spec.rb +4 -4
- data/spec/models/rate_estimate_options_spec.rb +4 -4
- data/spec/models/rate_request_body_spec.rb +4 -4
- data/spec/models/rate_request_by_shipment_ids_spec.rb +4 -4
- data/spec/models/rate_request_by_shipments_spec.rb +4 -4
- data/spec/models/rate_request_options_spec.rb +4 -4
- data/spec/models/rate_request_rate_options_spec.rb +4 -4
- data/spec/models/rate_response_spec.rb +4 -4
- data/spec/models/rate_response_status_spec.rb +4 -4
- data/spec/models/rate_spec.rb +4 -4
- data/spec/models/rate_type_spec.rb +4 -4
- data/spec/models/rates_information_spec.rb +4 -4
- data/spec/models/recognized_entity_spec.rb +4 -4
- data/spec/models/remove_from_batch_request_body_spec.rb +4 -4
- data/spec/models/response_message_spec.rb +4 -4
- data/spec/models/service_spec.rb +4 -4
- data/spec/models/shipment_id_request_spec.rb +4 -4
- data/spec/models/shipment_item_spec.rb +4 -4
- data/spec/models/shipment_request_spec.rb +4 -4
- data/spec/models/shipment_response_error_spec.rb +4 -4
- data/spec/models/shipment_spec.rb +4 -4
- data/spec/models/shipment_status_spec.rb +4 -4
- data/spec/models/shipments_sort_by_spec.rb +4 -4
- data/spec/models/smart_post_hub_spec.rb +4 -4
- data/spec/models/sort_dir_spec.rb +4 -4
- data/spec/models/tag_shipment_response_body_spec.rb +4 -4
- data/spec/models/tag_spec.rb +4 -4
- data/spec/models/track_event_spec.rb +4 -4
- data/spec/models/tracking_information_spec.rb +4 -4
- data/spec/models/tracking_status_spec.rb +4 -4
- data/spec/models/update_amazon_buy_shipping_request_body_spec.rb +4 -4
- data/spec/models/update_carrier_settings_request_body_spec.rb +4 -4
- data/spec/models/update_dhl_express_settings_request_body_spec.rb +4 -4
- data/spec/models/update_fedex_settings_request_body_spec.rb +4 -4
- data/spec/models/update_newgistics_settings_request_body_spec.rb +4 -4
- data/spec/models/update_package_type_request_body_spec.rb +4 -4
- data/spec/models/update_shipment_fields_spec.rb +4 -4
- data/spec/models/update_shipment_request_body_spec.rb +4 -4
- data/spec/models/update_shipment_response_body_spec.rb +4 -4
- data/spec/models/update_ups_settings_request_body_spec.rb +4 -4
- data/spec/models/update_warehouse_request_body_spec.rb +4 -4
- data/spec/models/update_webhook_request_body_spec.rb +4 -4
- data/spec/models/ups_account_settings_spec.rb +4 -4
- data/spec/models/ups_invoice_spec.rb +4 -4
- data/spec/models/ups_pickup_type_spec.rb +4 -4
- data/spec/models/ups_settings_response_body_spec.rb +4 -4
- data/spec/models/validate_address_spec.rb +4 -4
- data/spec/models/validate_shipment_fields_spec.rb +4 -4
- data/spec/models/validation_status_spec.rb +4 -4
- data/spec/models/void_label_response_body_spec.rb +4 -4
- data/spec/models/warehouse_spec.rb +4 -4
- data/spec/models/webhook_event_spec.rb +4 -4
- data/spec/models/webhook_spec.rb +4 -4
- data/spec/models/weight_spec.rb +4 -4
- data/spec/models/weight_unit_spec.rb +4 -4
- metadata +246 -246
- data/lib/openapi_client.rb +0 -278
- data/lib/openapi_client/models/add_funds_to_insurance_request_body.rb +0 -209
- data/lib/openapi_client/models/add_funds_to_insurance_response_body.rb +0 -209
- data/lib/openapi_client/models/create_label_from_rate_response_body.rb +0 -209
- data/lib/openapi_client/models/create_label_from_shipment_response_body.rb +0 -209
- data/lib/openapi_client/models/create_package_type_response_body.rb +0 -209
- data/lib/openapi_client/models/get_insurance_balance_response_body.rb +0 -209
- data/lib/openapi_client/models/get_manifest_by_id_response_body.rb +0 -209
- data/lib/openapi_client/models/get_package_type_by_id_response_body.rb +0 -209
- data/lib/openapi_client/models/list_shipment_rates_response_body.rb +0 -209
- data/openapi_client-1.0.0.gem +0 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#ShipEngine API
|
|
3
3
|
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
|
7
7
|
Contact: sales@shipengine.com
|
|
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
|
|
|
12
12
|
|
|
13
13
|
require 'cgi'
|
|
14
14
|
|
|
15
|
-
module
|
|
15
|
+
module ShipEngine
|
|
16
16
|
class TagsApi
|
|
17
17
|
attr_accessor :api_client
|
|
18
18
|
|
|
@@ -21,7 +21,7 @@ module OpenapiClient
|
|
|
21
21
|
end
|
|
22
22
|
# Create a New Tag
|
|
23
23
|
# Create a new Tag for customizing how you track your shipments
|
|
24
|
-
# @param tag_name [String]
|
|
24
|
+
# @param tag_name [String]
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [CreateTagResponseBody]
|
|
27
27
|
def create_tag(tag_name, opts = {})
|
|
@@ -31,7 +31,7 @@ module OpenapiClient
|
|
|
31
31
|
|
|
32
32
|
# Create a New Tag
|
|
33
33
|
# Create a new Tag for customizing how you track your shipments
|
|
34
|
-
# @param tag_name [String]
|
|
34
|
+
# @param tag_name [String]
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(CreateTagResponseBody, Integer, Hash)>] CreateTagResponseBody data, response status code and response headers
|
|
37
37
|
def create_tag_with_http_info(tag_name, opts = {})
|
|
@@ -61,10 +61,10 @@ module OpenapiClient
|
|
|
61
61
|
form_params = opts[:form_params] || {}
|
|
62
62
|
|
|
63
63
|
# http body (model)
|
|
64
|
-
post_body = opts[:body]
|
|
64
|
+
post_body = opts[:body]
|
|
65
65
|
|
|
66
66
|
# return_type
|
|
67
|
-
return_type = opts[:return_type] || 'CreateTagResponseBody'
|
|
67
|
+
return_type = opts[:return_type] || 'CreateTagResponseBody'
|
|
68
68
|
|
|
69
69
|
# auth_names
|
|
70
70
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -87,7 +87,7 @@ module OpenapiClient
|
|
|
87
87
|
|
|
88
88
|
# Delete Tag
|
|
89
89
|
# Delete a tag that is no longer needed
|
|
90
|
-
# @param tag_name [String]
|
|
90
|
+
# @param tag_name [String]
|
|
91
91
|
# @param [Hash] opts the optional parameters
|
|
92
92
|
# @return [String]
|
|
93
93
|
def delete_tag(tag_name, opts = {})
|
|
@@ -97,7 +97,7 @@ module OpenapiClient
|
|
|
97
97
|
|
|
98
98
|
# Delete Tag
|
|
99
99
|
# Delete a tag that is no longer needed
|
|
100
|
-
# @param tag_name [String]
|
|
100
|
+
# @param tag_name [String]
|
|
101
101
|
# @param [Hash] opts the optional parameters
|
|
102
102
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
103
103
|
def delete_tag_with_http_info(tag_name, opts = {})
|
|
@@ -127,10 +127,10 @@ module OpenapiClient
|
|
|
127
127
|
form_params = opts[:form_params] || {}
|
|
128
128
|
|
|
129
129
|
# http body (model)
|
|
130
|
-
post_body = opts[:body]
|
|
130
|
+
post_body = opts[:body]
|
|
131
131
|
|
|
132
132
|
# return_type
|
|
133
|
-
return_type = opts[:return_type] || 'String'
|
|
133
|
+
return_type = opts[:return_type] || 'String'
|
|
134
134
|
|
|
135
135
|
# auth_names
|
|
136
136
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -183,10 +183,10 @@ module OpenapiClient
|
|
|
183
183
|
form_params = opts[:form_params] || {}
|
|
184
184
|
|
|
185
185
|
# http body (model)
|
|
186
|
-
post_body = opts[:body]
|
|
186
|
+
post_body = opts[:body]
|
|
187
187
|
|
|
188
188
|
# return_type
|
|
189
|
-
return_type = opts[:return_type] || 'ListTagsResponseBody'
|
|
189
|
+
return_type = opts[:return_type] || 'ListTagsResponseBody'
|
|
190
190
|
|
|
191
191
|
# auth_names
|
|
192
192
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -209,8 +209,8 @@ module OpenapiClient
|
|
|
209
209
|
|
|
210
210
|
# Update Tag Name
|
|
211
211
|
# Change a tag name while still keeping the relevant shipments attached to it
|
|
212
|
-
# @param tag_name [String]
|
|
213
|
-
# @param new_tag_name [String]
|
|
212
|
+
# @param tag_name [String]
|
|
213
|
+
# @param new_tag_name [String]
|
|
214
214
|
# @param [Hash] opts the optional parameters
|
|
215
215
|
# @return [String]
|
|
216
216
|
def rename_tag(tag_name, new_tag_name, opts = {})
|
|
@@ -220,8 +220,8 @@ module OpenapiClient
|
|
|
220
220
|
|
|
221
221
|
# Update Tag Name
|
|
222
222
|
# Change a tag name while still keeping the relevant shipments attached to it
|
|
223
|
-
# @param tag_name [String]
|
|
224
|
-
# @param new_tag_name [String]
|
|
223
|
+
# @param tag_name [String]
|
|
224
|
+
# @param new_tag_name [String]
|
|
225
225
|
# @param [Hash] opts the optional parameters
|
|
226
226
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
227
227
|
def rename_tag_with_http_info(tag_name, new_tag_name, opts = {})
|
|
@@ -259,10 +259,10 @@ module OpenapiClient
|
|
|
259
259
|
form_params = opts[:form_params] || {}
|
|
260
260
|
|
|
261
261
|
# http body (model)
|
|
262
|
-
post_body = opts[:body]
|
|
262
|
+
post_body = opts[:body]
|
|
263
263
|
|
|
264
264
|
# return_type
|
|
265
|
-
return_type = opts[:return_type] || 'String'
|
|
265
|
+
return_type = opts[:return_type] || 'String'
|
|
266
266
|
|
|
267
267
|
# auth_names
|
|
268
268
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#ShipEngine API
|
|
3
3
|
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
|
7
7
|
Contact: sales@shipengine.com
|
|
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
|
|
|
12
12
|
|
|
13
13
|
require 'cgi'
|
|
14
14
|
|
|
15
|
-
module
|
|
15
|
+
module ShipEngine
|
|
16
16
|
class TrackingApi
|
|
17
17
|
attr_accessor :api_client
|
|
18
18
|
|
|
@@ -65,10 +65,10 @@ module OpenapiClient
|
|
|
65
65
|
form_params = opts[:form_params] || {}
|
|
66
66
|
|
|
67
67
|
# http body (model)
|
|
68
|
-
post_body = opts[:body]
|
|
68
|
+
post_body = opts[:body]
|
|
69
69
|
|
|
70
70
|
# return_type
|
|
71
|
-
return_type = opts[:return_type] || 'GetTrackingLogResponseBody'
|
|
71
|
+
return_type = opts[:return_type] || 'GetTrackingLogResponseBody'
|
|
72
72
|
|
|
73
73
|
# auth_names
|
|
74
74
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -90,7 +90,7 @@ module OpenapiClient
|
|
|
90
90
|
end
|
|
91
91
|
|
|
92
92
|
# Start Tracking a Package
|
|
93
|
-
# Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes.
|
|
93
|
+
# Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes.
|
|
94
94
|
# @param [Hash] opts the optional parameters
|
|
95
95
|
# @option opts [String] :carrier_code Carrier code used to retrieve tracking information
|
|
96
96
|
# @option opts [String] :tracking_number The tracking number associated with a shipment
|
|
@@ -101,7 +101,7 @@ module OpenapiClient
|
|
|
101
101
|
end
|
|
102
102
|
|
|
103
103
|
# Start Tracking a Package
|
|
104
|
-
# Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes.
|
|
104
|
+
# Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes.
|
|
105
105
|
# @param [Hash] opts the optional parameters
|
|
106
106
|
# @option opts [String] :carrier_code Carrier code used to retrieve tracking information
|
|
107
107
|
# @option opts [String] :tracking_number The tracking number associated with a shipment
|
|
@@ -135,10 +135,10 @@ module OpenapiClient
|
|
|
135
135
|
form_params = opts[:form_params] || {}
|
|
136
136
|
|
|
137
137
|
# http body (model)
|
|
138
|
-
post_body = opts[:body]
|
|
138
|
+
post_body = opts[:body]
|
|
139
139
|
|
|
140
140
|
# return_type
|
|
141
|
-
return_type = opts[:return_type] || 'String'
|
|
141
|
+
return_type = opts[:return_type] || 'String'
|
|
142
142
|
|
|
143
143
|
# auth_names
|
|
144
144
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -205,10 +205,10 @@ module OpenapiClient
|
|
|
205
205
|
form_params = opts[:form_params] || {}
|
|
206
206
|
|
|
207
207
|
# http body (model)
|
|
208
|
-
post_body = opts[:body]
|
|
208
|
+
post_body = opts[:body]
|
|
209
209
|
|
|
210
210
|
# return_type
|
|
211
|
-
return_type = opts[:return_type] || 'String'
|
|
211
|
+
return_type = opts[:return_type] || 'String'
|
|
212
212
|
|
|
213
213
|
# auth_names
|
|
214
214
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#ShipEngine API
|
|
3
3
|
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
|
7
7
|
Contact: sales@shipengine.com
|
|
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
|
|
|
12
12
|
|
|
13
13
|
require 'cgi'
|
|
14
14
|
|
|
15
|
-
module
|
|
15
|
+
module ShipEngine
|
|
16
16
|
class WarehousesApi
|
|
17
17
|
attr_accessor :api_client
|
|
18
18
|
|
|
@@ -20,8 +20,8 @@ module OpenapiClient
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Create Warehouse
|
|
23
|
-
# Create a warehouse location that you can use to create shipping items by simply passing in the generated warehouse id. If the return address is not supplied in the request body then it is assumed that the origin address is the return address as well
|
|
24
|
-
# @param create_warehouse_request_body [CreateWarehouseRequestBody]
|
|
23
|
+
# Create a warehouse location that you can use to create shipping items by simply passing in the generated warehouse id. If the return address is not supplied in the request body then it is assumed that the origin address is the return address as well
|
|
24
|
+
# @param create_warehouse_request_body [CreateWarehouseRequestBody]
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [CreateWarehouseResponseBody]
|
|
27
27
|
def create_warehouse(create_warehouse_request_body, opts = {})
|
|
@@ -30,8 +30,8 @@ module OpenapiClient
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
# Create Warehouse
|
|
33
|
-
# Create a warehouse location that you can use to create shipping items by simply passing in the generated warehouse id. If the return address is not supplied in the request body then it is assumed that the origin address is the return address as well
|
|
34
|
-
# @param create_warehouse_request_body [CreateWarehouseRequestBody]
|
|
33
|
+
# Create a warehouse location that you can use to create shipping items by simply passing in the generated warehouse id. If the return address is not supplied in the request body then it is assumed that the origin address is the return address as well
|
|
34
|
+
# @param create_warehouse_request_body [CreateWarehouseRequestBody]
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(CreateWarehouseResponseBody, Integer, Hash)>] CreateWarehouseResponseBody data, response status code and response headers
|
|
37
37
|
def create_warehouse_with_http_info(create_warehouse_request_body, opts = {})
|
|
@@ -59,10 +59,10 @@ module OpenapiClient
|
|
|
59
59
|
form_params = opts[:form_params] || {}
|
|
60
60
|
|
|
61
61
|
# http body (model)
|
|
62
|
-
post_body = opts[:body] || @api_client.object_to_http_body(create_warehouse_request_body)
|
|
62
|
+
post_body = opts[:body] || @api_client.object_to_http_body(create_warehouse_request_body)
|
|
63
63
|
|
|
64
64
|
# return_type
|
|
65
|
-
return_type = opts[:return_type] || 'CreateWarehouseResponseBody'
|
|
65
|
+
return_type = opts[:return_type] || 'CreateWarehouseResponseBody'
|
|
66
66
|
|
|
67
67
|
# auth_names
|
|
68
68
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -134,10 +134,10 @@ module OpenapiClient
|
|
|
134
134
|
form_params = opts[:form_params] || {}
|
|
135
135
|
|
|
136
136
|
# http body (model)
|
|
137
|
-
post_body = opts[:body]
|
|
137
|
+
post_body = opts[:body]
|
|
138
138
|
|
|
139
139
|
# return_type
|
|
140
|
-
return_type = opts[:return_type] || 'String'
|
|
140
|
+
return_type = opts[:return_type] || 'String'
|
|
141
141
|
|
|
142
142
|
# auth_names
|
|
143
143
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -209,10 +209,10 @@ module OpenapiClient
|
|
|
209
209
|
form_params = opts[:form_params] || {}
|
|
210
210
|
|
|
211
211
|
# http body (model)
|
|
212
|
-
post_body = opts[:body]
|
|
212
|
+
post_body = opts[:body]
|
|
213
213
|
|
|
214
214
|
# return_type
|
|
215
|
-
return_type = opts[:return_type] || 'GetWarehouseByIdResponseBody'
|
|
215
|
+
return_type = opts[:return_type] || 'GetWarehouseByIdResponseBody'
|
|
216
216
|
|
|
217
217
|
# auth_names
|
|
218
218
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -265,10 +265,10 @@ module OpenapiClient
|
|
|
265
265
|
form_params = opts[:form_params] || {}
|
|
266
266
|
|
|
267
267
|
# http body (model)
|
|
268
|
-
post_body = opts[:body]
|
|
268
|
+
post_body = opts[:body]
|
|
269
269
|
|
|
270
270
|
# return_type
|
|
271
|
-
return_type = opts[:return_type] || 'ListWarehousesResponseBody'
|
|
271
|
+
return_type = opts[:return_type] || 'ListWarehousesResponseBody'
|
|
272
272
|
|
|
273
273
|
# auth_names
|
|
274
274
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -292,7 +292,7 @@ module OpenapiClient
|
|
|
292
292
|
# Update WareHouse By Id
|
|
293
293
|
# Update Warehouse object information
|
|
294
294
|
# @param warehouse_id [String] Warehouse ID
|
|
295
|
-
# @param update_warehouse_request_body [UpdateWarehouseRequestBody]
|
|
295
|
+
# @param update_warehouse_request_body [UpdateWarehouseRequestBody]
|
|
296
296
|
# @param [Hash] opts the optional parameters
|
|
297
297
|
# @return [String]
|
|
298
298
|
def update_warehouse(warehouse_id, update_warehouse_request_body, opts = {})
|
|
@@ -303,7 +303,7 @@ module OpenapiClient
|
|
|
303
303
|
# Update WareHouse By Id
|
|
304
304
|
# Update Warehouse object information
|
|
305
305
|
# @param warehouse_id [String] Warehouse ID
|
|
306
|
-
# @param update_warehouse_request_body [UpdateWarehouseRequestBody]
|
|
306
|
+
# @param update_warehouse_request_body [UpdateWarehouseRequestBody]
|
|
307
307
|
# @param [Hash] opts the optional parameters
|
|
308
308
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
309
309
|
def update_warehouse_with_http_info(warehouse_id, update_warehouse_request_body, opts = {})
|
|
@@ -348,10 +348,10 @@ module OpenapiClient
|
|
|
348
348
|
form_params = opts[:form_params] || {}
|
|
349
349
|
|
|
350
350
|
# http body (model)
|
|
351
|
-
post_body = opts[:body] || @api_client.object_to_http_body(update_warehouse_request_body)
|
|
351
|
+
post_body = opts[:body] || @api_client.object_to_http_body(update_warehouse_request_body)
|
|
352
352
|
|
|
353
353
|
# return_type
|
|
354
|
-
return_type = opts[:return_type] || 'String'
|
|
354
|
+
return_type = opts[:return_type] || 'String'
|
|
355
355
|
|
|
356
356
|
# auth_names
|
|
357
357
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#ShipEngine API
|
|
3
3
|
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
|
7
7
|
Contact: sales@shipengine.com
|
|
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
|
|
|
12
12
|
|
|
13
13
|
require 'cgi'
|
|
14
14
|
|
|
15
|
-
module
|
|
15
|
+
module ShipEngine
|
|
16
16
|
class WebhooksApi
|
|
17
17
|
attr_accessor :api_client
|
|
18
18
|
|
|
@@ -21,7 +21,7 @@ module OpenapiClient
|
|
|
21
21
|
end
|
|
22
22
|
# Create a Webhook
|
|
23
23
|
# Create a webook for specific events in the environment.
|
|
24
|
-
# @param create_webhook_request_body [CreateWebhookRequestBody]
|
|
24
|
+
# @param create_webhook_request_body [CreateWebhookRequestBody]
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [CreateWebhookResponseBody]
|
|
27
27
|
def create_webhook(create_webhook_request_body, opts = {})
|
|
@@ -31,7 +31,7 @@ module OpenapiClient
|
|
|
31
31
|
|
|
32
32
|
# Create a Webhook
|
|
33
33
|
# Create a webook for specific events in the environment.
|
|
34
|
-
# @param create_webhook_request_body [CreateWebhookRequestBody]
|
|
34
|
+
# @param create_webhook_request_body [CreateWebhookRequestBody]
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(CreateWebhookResponseBody, Integer, Hash)>] CreateWebhookResponseBody data, response status code and response headers
|
|
37
37
|
def create_webhook_with_http_info(create_webhook_request_body, opts = {})
|
|
@@ -59,10 +59,10 @@ module OpenapiClient
|
|
|
59
59
|
form_params = opts[:form_params] || {}
|
|
60
60
|
|
|
61
61
|
# http body (model)
|
|
62
|
-
post_body = opts[:body] || @api_client.object_to_http_body(create_webhook_request_body)
|
|
62
|
+
post_body = opts[:body] || @api_client.object_to_http_body(create_webhook_request_body)
|
|
63
63
|
|
|
64
64
|
# return_type
|
|
65
|
-
return_type = opts[:return_type] || 'CreateWebhookResponseBody'
|
|
65
|
+
return_type = opts[:return_type] || 'CreateWebhookResponseBody'
|
|
66
66
|
|
|
67
67
|
# auth_names
|
|
68
68
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -134,10 +134,10 @@ module OpenapiClient
|
|
|
134
134
|
form_params = opts[:form_params] || {}
|
|
135
135
|
|
|
136
136
|
# http body (model)
|
|
137
|
-
post_body = opts[:body]
|
|
137
|
+
post_body = opts[:body]
|
|
138
138
|
|
|
139
139
|
# return_type
|
|
140
|
-
return_type = opts[:return_type] || 'String'
|
|
140
|
+
return_type = opts[:return_type] || 'String'
|
|
141
141
|
|
|
142
142
|
# auth_names
|
|
143
143
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -209,10 +209,10 @@ module OpenapiClient
|
|
|
209
209
|
form_params = opts[:form_params] || {}
|
|
210
210
|
|
|
211
211
|
# http body (model)
|
|
212
|
-
post_body = opts[:body]
|
|
212
|
+
post_body = opts[:body]
|
|
213
213
|
|
|
214
214
|
# return_type
|
|
215
|
-
return_type = opts[:return_type] || 'GetWebhookByIdResponseBody'
|
|
215
|
+
return_type = opts[:return_type] || 'GetWebhookByIdResponseBody'
|
|
216
216
|
|
|
217
217
|
# auth_names
|
|
218
218
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -265,10 +265,10 @@ module OpenapiClient
|
|
|
265
265
|
form_params = opts[:form_params] || {}
|
|
266
266
|
|
|
267
267
|
# http body (model)
|
|
268
|
-
post_body = opts[:body]
|
|
268
|
+
post_body = opts[:body]
|
|
269
269
|
|
|
270
270
|
# return_type
|
|
271
|
-
return_type = opts[:return_type] || 'Array<Webhook>'
|
|
271
|
+
return_type = opts[:return_type] || 'Array<Webhook>'
|
|
272
272
|
|
|
273
273
|
# auth_names
|
|
274
274
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -292,7 +292,7 @@ module OpenapiClient
|
|
|
292
292
|
# Update a Webhook
|
|
293
293
|
# Update the webhook url property
|
|
294
294
|
# @param webhook_id [String] Webhook ID
|
|
295
|
-
# @param update_webhook_request_body [UpdateWebhookRequestBody]
|
|
295
|
+
# @param update_webhook_request_body [UpdateWebhookRequestBody]
|
|
296
296
|
# @param [Hash] opts the optional parameters
|
|
297
297
|
# @return [String]
|
|
298
298
|
def update_webhook(webhook_id, update_webhook_request_body, opts = {})
|
|
@@ -303,7 +303,7 @@ module OpenapiClient
|
|
|
303
303
|
# Update a Webhook
|
|
304
304
|
# Update the webhook url property
|
|
305
305
|
# @param webhook_id [String] Webhook ID
|
|
306
|
-
# @param update_webhook_request_body [UpdateWebhookRequestBody]
|
|
306
|
+
# @param update_webhook_request_body [UpdateWebhookRequestBody]
|
|
307
307
|
# @param [Hash] opts the optional parameters
|
|
308
308
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
309
309
|
def update_webhook_with_http_info(webhook_id, update_webhook_request_body, opts = {})
|
|
@@ -348,10 +348,10 @@ module OpenapiClient
|
|
|
348
348
|
form_params = opts[:form_params] || {}
|
|
349
349
|
|
|
350
350
|
# http body (model)
|
|
351
|
-
post_body = opts[:body] || @api_client.object_to_http_body(update_webhook_request_body)
|
|
351
|
+
post_body = opts[:body] || @api_client.object_to_http_body(update_webhook_request_body)
|
|
352
352
|
|
|
353
353
|
# return_type
|
|
354
|
-
return_type = opts[:return_type] || 'String'
|
|
354
|
+
return_type = opts[:return_type] || 'String'
|
|
355
355
|
|
|
356
356
|
# auth_names
|
|
357
357
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#ShipEngine API
|
|
3
3
|
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
|
7
7
|
Contact: sales@shipengine.com
|
|
@@ -16,7 +16,7 @@ require 'logger'
|
|
|
16
16
|
require 'tempfile'
|
|
17
17
|
require 'typhoeus'
|
|
18
18
|
|
|
19
|
-
module
|
|
19
|
+
module ShipEngine
|
|
20
20
|
class ApiClient
|
|
21
21
|
# The Configuration object holding settings to be used in the API client.
|
|
22
22
|
attr_accessor :config
|
|
@@ -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
|
|
@@ -10,7 +10,7 @@ OpenAPI Generator version: 4.3.1
|
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
|
-
module
|
|
13
|
+
module ShipEngine
|
|
14
14
|
class ApiError < StandardError
|
|
15
15
|
attr_reader :code, :response_headers, :response_body
|
|
16
16
|
|