ship_engine 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +431 -0
- data/Rakefile +10 -0
- data/docs/AddFundsToCarrierRequestBody.md +16 -0
- data/docs/AddFundsToCarrierResponseBody.md +17 -0
- data/docs/AddFundsToInsuranceRequestBody.md +16 -0
- data/docs/AddFundsToInsuranceResponseBody.md +16 -0
- data/docs/AddToBatchRequestBody.md +16 -0
- data/docs/Address.md +16 -0
- data/docs/AddressResidentialIndicator.md +16 -0
- data/docs/AddressToValidate.md +16 -0
- data/docs/AddressValidatingShipment.md +61 -0
- data/docs/AddressValidationCode.md +16 -0
- data/docs/AddressValidationDetailCode.md +16 -0
- data/docs/AddressValidationMessageType.md +16 -0
- data/docs/AddressValidationResult.md +23 -0
- data/docs/AddressValidationStatus.md +16 -0
- data/docs/AddressesApi.md +118 -0
- data/docs/AdvancedShipmentOptions.md +47 -0
- data/docs/AncillaryServiceEndorsement.md +16 -0
- data/docs/Batch.md +51 -0
- data/docs/BatchResponseError.md +19 -0
- data/docs/BatchStatus.md +16 -0
- data/docs/BatchesApi.md +580 -0
- data/docs/BatchesSortBy.md +16 -0
- data/docs/BillToParty.md +16 -0
- data/docs/BulkRate.md +25 -0
- data/docs/CalculateRatesRequestBody.md +16 -0
- data/docs/CalculateRatesResponseBody.md +61 -0
- data/docs/Carrier.md +41 -0
- data/docs/CarrierAccountsApi.md +238 -0
- data/docs/CarrierAdvancedOption.md +21 -0
- data/docs/CarrierName.md +16 -0
- data/docs/CarrierNameWithSettings.md +16 -0
- data/docs/CarriersApi.md +336 -0
- data/docs/CollectOnDelivery.md +19 -0
- data/docs/CollectOnDeliveryPaymentType.md +16 -0
- data/docs/CompareBulkRatesRequestBody.md +16 -0
- data/docs/ConnectAccessWorldwideRequestBody.md +21 -0
- data/docs/ConnectAmazonBuyShippingRequestBody.md +23 -0
- data/docs/ConnectApcRequestBody.md +21 -0
- data/docs/ConnectAsendiaRequestBody.md +23 -0
- data/docs/ConnectAustraliaPostRequestBody.md +23 -0
- data/docs/ConnectCanadaPostRequestBody.md +25 -0
- data/docs/ConnectCarrierRequestBody.md +113 -0
- data/docs/ConnectCarrierResponseBody.md +17 -0
- data/docs/ConnectDhlEcommerceRequestBody.md +39 -0
- data/docs/ConnectDhlExpressAuRequestBody.md +19 -0
- data/docs/ConnectDhlExpressCaRequestBody.md +19 -0
- data/docs/ConnectDhlExpressRequestBody.md +19 -0
- data/docs/ConnectDhlExpressUkRequestBody.md +23 -0
- data/docs/ConnectDpdRequestBody.md +21 -0
- data/docs/ConnectEndiciaRequestBody.md +21 -0
- data/docs/ConnectFedexRequestBody.md +45 -0
- data/docs/ConnectFedexUkRequestBody.md +45 -0
- data/docs/ConnectFirstmileRequestBody.md +23 -0
- data/docs/ConnectGlobegisticsRequestBody.md +21 -0
- data/docs/ConnectImexRequestBody.md +21 -0
- data/docs/ConnectInsurerRequestBody.md +19 -0
- data/docs/ConnectNewgisticsRequestBody.md +23 -0
- data/docs/ConnectOntracRequestBody.md +21 -0
- data/docs/ConnectPurolatorRequestBody.md +21 -0
- data/docs/ConnectRoyalMailRequestBody.md +39 -0
- data/docs/ConnectRrDonnelleyRequestBody.md +21 -0
- data/docs/ConnectSekoRequestBody.md +19 -0
- data/docs/ConnectSendleRequestBody.md +21 -0
- data/docs/ConnectStampsRequestBody.md +21 -0
- data/docs/ConnectUpsRequestBody.md +51 -0
- data/docs/CreateAndValidateShipment.md +63 -0
- data/docs/CreateBatchRequestBody.md +23 -0
- data/docs/CreateBatchResponseBody.md +16 -0
- data/docs/CreateLabelFromRateRequestBody.md +16 -0
- data/docs/CreateLabelFromRateResponseBody.md +16 -0
- data/docs/CreateLabelFromShipmentRequestBody.md +23 -0
- data/docs/CreateLabelFromShipmentResponseBody.md +16 -0
- data/docs/CreateLabelRequestBody.md +16 -0
- data/docs/CreateLabelResponseBody.md +16 -0
- data/docs/CreateManifestByObjectRequestBody.md +25 -0
- data/docs/CreateManifestLabelIdsRequestBody.md +17 -0
- data/docs/CreateManifestRequestBody.md +25 -0
- data/docs/CreateManifestResponseBody.md +35 -0
- data/docs/CreatePackageTypeRequestBody.md +16 -0
- data/docs/CreatePackageTypeResponseBody.md +16 -0
- data/docs/CreateReturnLabelRequestBody.md +25 -0
- data/docs/CreateReturnLabelResponseBody.md +16 -0
- data/docs/CreateShipmentResponseBodyFields.md +19 -0
- data/docs/CreateShipmentsRequestBody.md +17 -0
- data/docs/CreateShipmentsResponseBody.md +19 -0
- data/docs/CreateTagResponseBody.md +16 -0
- data/docs/CreateWarehouseRequestBody.md +16 -0
- data/docs/CreateWarehouseResponseBody.md +16 -0
- data/docs/CreateWebhookRequestBody.md +19 -0
- data/docs/CreateWebhookResponseBody.md +16 -0
- data/docs/Currency.md +16 -0
- data/docs/CustomsItem.md +33 -0
- data/docs/DeliveryConfirmation.md +16 -0
- data/docs/DeprecatedManifest.md +33 -0
- data/docs/DhlExpressAccountSettings.md +21 -0
- data/docs/DhlExpressSettingsResponseBody.md +16 -0
- data/docs/DimensionUnit.md +16 -0
- data/docs/Dimensions.md +23 -0
- data/docs/DownloadsApi.md +71 -0
- data/docs/Error.md +23 -0
- data/docs/ErrorCode.md +16 -0
- data/docs/ErrorResponseBody.md +19 -0
- data/docs/ErrorSource.md +16 -0
- data/docs/ErrorType.md +16 -0
- data/docs/EstimateRatesRequestBody.md +16 -0
- data/docs/FedexAccountSettings.md +25 -0
- data/docs/FedexAccountSettingsRequestBody.md +16 -0
- data/docs/FedexPickupType.md +16 -0
- data/docs/FedexSettingsResponseBody.md +16 -0
- data/docs/GetBatchByExternalIdResponseBody.md +16 -0
- data/docs/GetBatchByIdResponseBody.md +16 -0
- data/docs/GetCarrierByIdResponseBody.md +16 -0
- data/docs/GetCarrierOptionsResponseBody.md +17 -0
- data/docs/GetCarrierSettingsResponseBody.md +45 -0
- data/docs/GetCarriersResponseBody.md +21 -0
- data/docs/GetInsuranceBalanceResponseBody.md +16 -0
- data/docs/GetLabelByExternalShipmentIdResponseBody.md +16 -0
- data/docs/GetLabelByIdResponseBody.md +16 -0
- data/docs/GetManifestByIdResponseBody.md +16 -0
- data/docs/GetPackageTypeByIdResponseBody.md +16 -0
- data/docs/GetRateByIdResponseBody.md +16 -0
- data/docs/GetShipmentByExternalIdResponseBody.md +16 -0
- data/docs/GetShipmentByIdResponseBody.md +16 -0
- data/docs/GetTrackingLogFromLabelResponseBody.md +16 -0
- data/docs/GetTrackingLogResponseBody.md +16 -0
- data/docs/GetWarehouseByIdResponseBody.md +16 -0
- data/docs/GetWebhookByIdResponseBody.md +16 -0
- data/docs/InsuranceApi.md +220 -0
- data/docs/InsuranceProvider.md +16 -0
- data/docs/InternationalShipmentOptions.md +21 -0
- data/docs/Label.md +81 -0
- data/docs/LabelChargeEvent.md +16 -0
- data/docs/LabelDownload.md +23 -0
- data/docs/LabelDownloadType.md +16 -0
- data/docs/LabelFormat.md +16 -0
- data/docs/LabelLayout.md +16 -0
- data/docs/LabelMessages.md +21 -0
- data/docs/LabelStatus.md +16 -0
- data/docs/LabelsApi.md +545 -0
- data/docs/Link.md +16 -0
- data/docs/ListBatchErrorsResponseBody.md +19 -0
- data/docs/ListBatchesResponseBody.md +25 -0
- data/docs/ListCarrierPackageTypesResponseBody.md +17 -0
- data/docs/ListCarrierServicesResponseBody.md +17 -0
- data/docs/ListCarriersResponseBody.md +17 -0
- data/docs/ListLabelsResponseBody.md +17 -0
- data/docs/ListManifestsResponseBody.md +25 -0
- data/docs/ListPackageTypesResponseBody.md +17 -0
- data/docs/ListShipmentErrorsResponseBody.md +19 -0
- data/docs/ListShipmentRatesResponseBody.md +16 -0
- data/docs/ListShipmentsResponseBody.md +25 -0
- data/docs/ListTagsResponseBody.md +17 -0
- data/docs/ListWarehousesResponseBody.md +17 -0
- data/docs/Manifest.md +33 -0
- data/docs/ManifestDownload.md +17 -0
- data/docs/Manifests.md +17 -0
- data/docs/ManifestsApi.md +191 -0
- data/docs/ModifyBatch.md +19 -0
- data/docs/MonetaryValue.md +19 -0
- data/docs/NonDelivery.md +16 -0
- data/docs/OptionalLink.md +19 -0
- data/docs/OrderSourceName.md +16 -0
- data/docs/Package.md +29 -0
- data/docs/PackageContents.md +16 -0
- data/docs/PackageType.md +25 -0
- data/docs/PackageTypesApi.md +281 -0
- data/docs/PagedListResponseBody.md +23 -0
- data/docs/PaginationLink.md +23 -0
- data/docs/ParseAddressRequestBody.md +19 -0
- data/docs/ParseAddressResponseBody.md +21 -0
- data/docs/ParseShipmentRequestBody.md +20 -0
- data/docs/ParseShipmentResponseBody.md +21 -0
- data/docs/PartialAddress.md +37 -0
- data/docs/PartialShipment.md +59 -0
- data/docs/PaymentAmount.md +19 -0
- data/docs/ProcessBatchRequestBody.md +21 -0
- data/docs/PurchaseLabelWithoutShipment.md +23 -0
- data/docs/Rate.md +65 -0
- data/docs/RateEstimateByCarrierId.md +17 -0
- data/docs/RateEstimateByCarrierIds.md +17 -0
- data/docs/RateEstimateOptions.md +41 -0
- data/docs/RateRequestBody.md +25 -0
- data/docs/RateRequestByShipmentIds.md +17 -0
- data/docs/RateRequestByShipments.md +17 -0
- data/docs/RateRequestOptions.md +17 -0
- data/docs/RateRequestRateOptions.md +17 -0
- data/docs/RateResponse.md +17 -0
- data/docs/RateResponseStatus.md +16 -0
- data/docs/RateType.md +16 -0
- data/docs/RatesApi.md +228 -0
- data/docs/RatesInformation.md +29 -0
- data/docs/RecognizedEntity.md +27 -0
- data/docs/RemoveFromBatchRequestBody.md +16 -0
- data/docs/ResponseMessage.md +23 -0
- data/docs/Service.md +29 -0
- data/docs/Shipment.md +16 -0
- data/docs/ShipmentIdRequest.md +17 -0
- data/docs/ShipmentItem.md +33 -0
- data/docs/ShipmentRequest.md +17 -0
- data/docs/ShipmentResponseError.md +21 -0
- data/docs/ShipmentStatus.md +16 -0
- data/docs/ShipmentsApi.md +653 -0
- data/docs/ShipmentsSortBy.md +16 -0
- data/docs/SmartPostHub.md +16 -0
- data/docs/SortDir.md +16 -0
- data/docs/Tag.md +17 -0
- data/docs/TagShipmentResponseBody.md +19 -0
- data/docs/TagsApi.md +226 -0
- data/docs/TrackEvent.md +39 -0
- data/docs/TrackingApi.md +185 -0
- data/docs/TrackingInformation.md +35 -0
- data/docs/TrackingStatus.md +16 -0
- data/docs/UpdateAmazonBuyShippingRequestBody.md +17 -0
- data/docs/UpdateCarrierSettingsRequestBody.md +51 -0
- data/docs/UpdateDhlExpressSettingsRequestBody.md +16 -0
- data/docs/UpdateFedexSettingsRequestBody.md +16 -0
- data/docs/UpdateNewgisticsSettingsRequestBody.md +19 -0
- data/docs/UpdatePackageTypeRequestBody.md +16 -0
- data/docs/UpdateShipmentFields.md +17 -0
- data/docs/UpdateShipmentRequestBody.md +61 -0
- data/docs/UpdateShipmentResponseBody.md +16 -0
- data/docs/UpdateUpsSettingsRequestBody.md +16 -0
- data/docs/UpdateWarehouseRequestBody.md +16 -0
- data/docs/UpdateWebhookRequestBody.md +17 -0
- data/docs/UpsAccountSettings.md +39 -0
- data/docs/UpsInvoice.md +23 -0
- data/docs/UpsPickupType.md +16 -0
- data/docs/UpsSettingsResponseBody.md +16 -0
- data/docs/ValidateAddress.md +16 -0
- data/docs/ValidateShipmentFields.md +17 -0
- data/docs/ValidationStatus.md +16 -0
- data/docs/VoidLabelResponseBody.md +19 -0
- data/docs/Warehouse.md +25 -0
- data/docs/WarehousesApi.md +281 -0
- data/docs/Webhook.md +21 -0
- data/docs/WebhookEvent.md +16 -0
- data/docs/WebhooksApi.md +281 -0
- data/docs/Weight.md +19 -0
- data/docs/WeightUnit.md +16 -0
- data/git_push.sh +58 -0
- data/lib/openapi_client.rb +278 -0
- data/lib/openapi_client/api/addresses_api.rb +150 -0
- data/lib/openapi_client/api/batches_api.rb +790 -0
- data/lib/openapi_client/api/carrier_accounts_api.rb +343 -0
- data/lib/openapi_client/api/carriers_api.rb +461 -0
- data/lib/openapi_client/api/downloads_api.rb +99 -0
- data/lib/openapi_client/api/insurance_api.rb +262 -0
- data/lib/openapi_client/api/labels_api.rb +812 -0
- data/lib/openapi_client/api/manifests_api.rb +278 -0
- data/lib/openapi_client/api/package_types_api.rb +375 -0
- data/lib/openapi_client/api/rates_api.rb +289 -0
- data/lib/openapi_client/api/shipments_api.rb +899 -0
- data/lib/openapi_client/api/tags_api.rb +286 -0
- data/lib/openapi_client/api/tracking_api.rb +232 -0
- data/lib/openapi_client/api/warehouses_api.rb +375 -0
- data/lib/openapi_client/api/webhooks_api.rb +375 -0
- data/lib/openapi_client/api_client.rb +388 -0
- data/lib/openapi_client/api_error.rb +57 -0
- data/lib/openapi_client/configuration.rb +248 -0
- data/lib/openapi_client/models/add_funds_to_carrier_request_body.rb +209 -0
- data/lib/openapi_client/models/add_funds_to_carrier_response_body.rb +213 -0
- data/lib/openapi_client/models/add_funds_to_insurance_request_body.rb +209 -0
- data/lib/openapi_client/models/add_funds_to_insurance_response_body.rb +209 -0
- data/lib/openapi_client/models/add_to_batch_request_body.rb +209 -0
- data/lib/openapi_client/models/address.rb +209 -0
- data/lib/openapi_client/models/address_residential_indicator.rb +37 -0
- data/lib/openapi_client/models/address_to_validate.rb +209 -0
- data/lib/openapi_client/models/address_validating_shipment.rb +484 -0
- data/lib/openapi_client/models/address_validation_code.rb +47 -0
- data/lib/openapi_client/models/address_validation_detail_code.rb +92 -0
- data/lib/openapi_client/models/address_validation_message_type.rb +37 -0
- data/lib/openapi_client/models/address_validation_result.rb +259 -0
- data/lib/openapi_client/models/address_validation_status.rb +38 -0
- data/lib/openapi_client/models/advanced_shipment_options.rb +434 -0
- data/lib/openapi_client/models/ancillary_service_endorsement.rb +40 -0
- data/lib/openapi_client/models/batch.rb +566 -0
- data/lib/openapi_client/models/batch_response_error.rb +233 -0
- data/lib/openapi_client/models/batch_status.rb +42 -0
- data/lib/openapi_client/models/batches_sort_by.rb +36 -0
- data/lib/openapi_client/models/bill_to_party.rb +36 -0
- data/lib/openapi_client/models/bulk_rate.rb +273 -0
- data/lib/openapi_client/models/calculate_rates_request_body.rb +225 -0
- data/lib/openapi_client/models/calculate_rates_response_body.rb +525 -0
- data/lib/openapi_client/models/carrier.rb +394 -0
- data/lib/openapi_client/models/carrier_advanced_option.rb +273 -0
- data/lib/openapi_client/models/carrier_name.rb +61 -0
- data/lib/openapi_client/models/carrier_name_with_settings.rb +38 -0
- data/lib/openapi_client/models/collect_on_delivery.rb +216 -0
- data/lib/openapi_client/models/collect_on_delivery_payment_type.rb +38 -0
- data/lib/openapi_client/models/compare_bulk_rates_request_body.rb +225 -0
- data/lib/openapi_client/models/connect_access_worldwide_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_amazon_buy_shipping_request_body.rb +312 -0
- data/lib/openapi_client/models/connect_apc_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_asendia_request_body.rb +334 -0
- data/lib/openapi_client/models/connect_australia_post_request_body.rb +334 -0
- data/lib/openapi_client/models/connect_canada_post_request_body.rb +368 -0
- data/lib/openapi_client/models/connect_carrier_request_body.rb +1661 -0
- data/lib/openapi_client/models/connect_carrier_response_body.rb +213 -0
- data/lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb +536 -0
- data/lib/openapi_client/models/connect_dhl_express_au_request_body.rb +266 -0
- data/lib/openapi_client/models/connect_dhl_express_ca_request_body.rb +266 -0
- data/lib/openapi_client/models/connect_dhl_express_request_body.rb +266 -0
- data/lib/openapi_client/models/connect_dhl_express_uk_request_body.rb +315 -0
- data/lib/openapi_client/models/connect_dpd_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_endicia_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_fedex_request_body.rb +643 -0
- data/lib/openapi_client/models/connect_fedex_uk_request_body.rb +643 -0
- data/lib/openapi_client/models/connect_firstmile_request_body.rb +306 -0
- data/lib/openapi_client/models/connect_globegistics_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_imex_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_insurer_request_body.rb +245 -0
- data/lib/openapi_client/models/connect_newgistics_request_body.rb +316 -0
- data/lib/openapi_client/models/connect_ontrac_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_purolator_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_royal_mail_request_body.rb +513 -0
- data/lib/openapi_client/models/connect_rr_donnelley_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_seko_request_body.rb +266 -0
- data/lib/openapi_client/models/connect_sendle_request_body.rb +281 -0
- data/lib/openapi_client/models/connect_stamps_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_ups_request_body.rb +730 -0
- data/lib/openapi_client/models/create_and_validate_shipment.rb +472 -0
- data/lib/openapi_client/models/create_batch_request_body.rb +257 -0
- data/lib/openapi_client/models/create_batch_response_body.rb +209 -0
- data/lib/openapi_client/models/create_label_from_rate_request_body.rb +209 -0
- data/lib/openapi_client/models/create_label_from_rate_response_body.rb +209 -0
- data/lib/openapi_client/models/create_label_from_shipment_request_body.rb +234 -0
- data/lib/openapi_client/models/create_label_from_shipment_response_body.rb +209 -0
- data/lib/openapi_client/models/create_label_request_body.rb +209 -0
- data/lib/openapi_client/models/create_label_response_body.rb +209 -0
- data/lib/openapi_client/models/create_manifest_by_object_request_body.rb +267 -0
- data/lib/openapi_client/models/create_manifest_label_ids_request_body.rb +215 -0
- data/lib/openapi_client/models/create_manifest_request_body.rb +295 -0
- data/lib/openapi_client/models/create_manifest_response_body.rb +389 -0
- data/lib/openapi_client/models/create_package_type_request_body.rb +209 -0
- data/lib/openapi_client/models/create_package_type_response_body.rb +209 -0
- data/lib/openapi_client/models/create_return_label_request_body.rb +248 -0
- data/lib/openapi_client/models/create_return_label_response_body.rb +209 -0
- data/lib/openapi_client/models/create_shipment_response_body_fields.rb +219 -0
- data/lib/openapi_client/models/create_shipments_request_body.rb +215 -0
- data/lib/openapi_client/models/create_shipments_response_body.rb +232 -0
- data/lib/openapi_client/models/create_tag_response_body.rb +209 -0
- data/lib/openapi_client/models/create_warehouse_request_body.rb +209 -0
- data/lib/openapi_client/models/create_warehouse_response_body.rb +209 -0
- data/lib/openapi_client/models/create_webhook_request_body.rb +227 -0
- data/lib/openapi_client/models/create_webhook_response_body.rb +209 -0
- data/lib/openapi_client/models/currency.rb +40 -0
- data/lib/openapi_client/models/customs_item.rb +334 -0
- data/lib/openapi_client/models/delivery_confirmation.rb +40 -0
- data/lib/openapi_client/models/deprecated_manifest.rb +317 -0
- data/lib/openapi_client/models/dhl_express_account_settings.rb +243 -0
- data/lib/openapi_client/models/dhl_express_settings_response_body.rb +209 -0
- data/lib/openapi_client/models/dimension_unit.rb +36 -0
- data/lib/openapi_client/models/dimensions.rb +320 -0
- data/lib/openapi_client/models/error.rb +274 -0
- data/lib/openapi_client/models/error_code.rb +71 -0
- data/lib/openapi_client/models/error_response_body.rb +230 -0
- data/lib/openapi_client/models/error_source.rb +37 -0
- data/lib/openapi_client/models/error_type.rb +40 -0
- data/lib/openapi_client/models/estimate_rates_request_body.rb +225 -0
- data/lib/openapi_client/models/fedex_account_settings.rb +259 -0
- data/lib/openapi_client/models/fedex_account_settings_request_body.rb +209 -0
- data/lib/openapi_client/models/fedex_pickup_type.rb +40 -0
- data/lib/openapi_client/models/fedex_settings_response_body.rb +209 -0
- data/lib/openapi_client/models/get_batch_by_external_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_batch_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_carrier_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_carrier_options_response_body.rb +210 -0
- data/lib/openapi_client/models/get_carrier_settings_response_body.rb +413 -0
- data/lib/openapi_client/models/get_carriers_response_body.rb +254 -0
- data/lib/openapi_client/models/get_insurance_balance_response_body.rb +209 -0
- data/lib/openapi_client/models/get_label_by_external_shipment_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_label_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_manifest_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_package_type_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_rate_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_shipment_by_external_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_shipment_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_tracking_log_from_label_response_body.rb +209 -0
- data/lib/openapi_client/models/get_tracking_log_response_body.rb +209 -0
- data/lib/openapi_client/models/get_warehouse_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_webhook_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/insurance_provider.rb +38 -0
- data/lib/openapi_client/models/international_shipment_options.rb +240 -0
- data/lib/openapi_client/models/label.rb +548 -0
- data/lib/openapi_client/models/label_charge_event.rb +37 -0
- data/lib/openapi_client/models/label_download.rb +238 -0
- data/lib/openapi_client/models/label_download_type.rb +36 -0
- data/lib/openapi_client/models/label_format.rb +37 -0
- data/lib/openapi_client/models/label_layout.rb +36 -0
- data/lib/openapi_client/models/label_messages.rb +237 -0
- data/lib/openapi_client/models/label_status.rb +38 -0
- data/lib/openapi_client/models/link.rb +209 -0
- data/lib/openapi_client/models/list_batch_errors_response_body.rb +229 -0
- data/lib/openapi_client/models/list_batches_response_body.rb +331 -0
- data/lib/openapi_client/models/list_carrier_package_types_response_body.rb +210 -0
- data/lib/openapi_client/models/list_carrier_services_response_body.rb +210 -0
- data/lib/openapi_client/models/list_carriers_response_body.rb +215 -0
- data/lib/openapi_client/models/list_labels_response_body.rb +226 -0
- data/lib/openapi_client/models/list_manifests_response_body.rb +332 -0
- data/lib/openapi_client/models/list_package_types_response_body.rb +210 -0
- data/lib/openapi_client/models/list_shipment_errors_response_body.rb +229 -0
- data/lib/openapi_client/models/list_shipment_rates_response_body.rb +209 -0
- data/lib/openapi_client/models/list_shipments_response_body.rb +329 -0
- data/lib/openapi_client/models/list_tags_response_body.rb +210 -0
- data/lib/openapi_client/models/list_warehouses_response_body.rb +215 -0
- data/lib/openapi_client/models/manifest.rb +317 -0
- data/lib/openapi_client/models/manifest_download.rb +208 -0
- data/lib/openapi_client/models/manifests.rb +209 -0
- data/lib/openapi_client/models/modify_batch.rb +222 -0
- data/lib/openapi_client/models/monetary_value.rb +246 -0
- data/lib/openapi_client/models/non_delivery.rb +36 -0
- data/lib/openapi_client/models/optional_link.rb +233 -0
- data/lib/openapi_client/models/order_source_name.rb +54 -0
- data/lib/openapi_client/models/package.rb +287 -0
- data/lib/openapi_client/models/package_contents.rb +39 -0
- data/lib/openapi_client/models/package_type.rb +276 -0
- data/lib/openapi_client/models/paged_list_response_body.rb +314 -0
- data/lib/openapi_client/models/pagination_link.rb +258 -0
- data/lib/openapi_client/models/parse_address_request_body.rb +242 -0
- data/lib/openapi_client/models/parse_address_response_body.rb +273 -0
- data/lib/openapi_client/models/parse_shipment_request_body.rb +242 -0
- data/lib/openapi_client/models/parse_shipment_response_body.rb +273 -0
- data/lib/openapi_client/models/partial_address.rb +432 -0
- data/lib/openapi_client/models/partial_shipment.rb +442 -0
- data/lib/openapi_client/models/payment_amount.rb +230 -0
- data/lib/openapi_client/models/process_batch_request_body.rb +228 -0
- data/lib/openapi_client/models/purchase_label_without_shipment.rb +234 -0
- data/lib/openapi_client/models/rate.rb +696 -0
- data/lib/openapi_client/models/rate_estimate_by_carrier_id.rb +207 -0
- data/lib/openapi_client/models/rate_estimate_by_carrier_ids.rb +209 -0
- data/lib/openapi_client/models/rate_estimate_options.rb +381 -0
- data/lib/openapi_client/models/rate_request_body.rb +256 -0
- data/lib/openapi_client/models/rate_request_by_shipment_ids.rb +214 -0
- data/lib/openapi_client/models/rate_request_by_shipments.rb +214 -0
- data/lib/openapi_client/models/rate_request_options.rb +207 -0
- data/lib/openapi_client/models/rate_request_rate_options.rb +207 -0
- data/lib/openapi_client/models/rate_response.rb +207 -0
- data/lib/openapi_client/models/rate_response_status.rb +38 -0
- data/lib/openapi_client/models/rate_type.rb +36 -0
- data/lib/openapi_client/models/rates_information.rb +272 -0
- data/lib/openapi_client/models/recognized_entity.rb +389 -0
- data/lib/openapi_client/models/remove_from_batch_request_body.rb +209 -0
- data/lib/openapi_client/models/response_message.rb +251 -0
- data/lib/openapi_client/models/service.rb +297 -0
- data/lib/openapi_client/models/shipment.rb +209 -0
- data/lib/openapi_client/models/shipment_id_request.rb +207 -0
- data/lib/openapi_client/models/shipment_item.rb +347 -0
- data/lib/openapi_client/models/shipment_request.rb +207 -0
- data/lib/openapi_client/models/shipment_response_error.rb +257 -0
- data/lib/openapi_client/models/shipment_status.rb +38 -0
- data/lib/openapi_client/models/shipments_sort_by.rb +36 -0
- data/lib/openapi_client/models/smart_post_hub.rb +68 -0
- data/lib/openapi_client/models/sort_dir.rb +36 -0
- data/lib/openapi_client/models/tag.rb +232 -0
- data/lib/openapi_client/models/tag_shipment_response_body.rb +228 -0
- data/lib/openapi_client/models/track_event.rb +502 -0
- data/lib/openapi_client/models/tracking_information.rb +371 -0
- data/lib/openapi_client/models/tracking_status.rb +38 -0
- data/lib/openapi_client/models/update_amazon_buy_shipping_request_body.rb +223 -0
- data/lib/openapi_client/models/update_carrier_settings_request_body.rb +458 -0
- data/lib/openapi_client/models/update_dhl_express_settings_request_body.rb +209 -0
- data/lib/openapi_client/models/update_fedex_settings_request_body.rb +209 -0
- data/lib/openapi_client/models/update_newgistics_settings_request_body.rb +216 -0
- data/lib/openapi_client/models/update_package_type_request_body.rb +209 -0
- data/lib/openapi_client/models/update_shipment_fields.rb +206 -0
- data/lib/openapi_client/models/update_shipment_request_body.rb +469 -0
- data/lib/openapi_client/models/update_shipment_response_body.rb +209 -0
- data/lib/openapi_client/models/update_ups_settings_request_body.rb +209 -0
- data/lib/openapi_client/models/update_warehouse_request_body.rb +209 -0
- data/lib/openapi_client/models/update_webhook_request_body.rb +208 -0
- data/lib/openapi_client/models/ups_account_settings.rb +361 -0
- data/lib/openapi_client/models/ups_invoice.rb +267 -0
- data/lib/openapi_client/models/ups_pickup_type.rb +37 -0
- data/lib/openapi_client/models/ups_settings_response_body.rb +209 -0
- data/lib/openapi_client/models/validate_address.rb +37 -0
- data/lib/openapi_client/models/validate_shipment_fields.rb +206 -0
- data/lib/openapi_client/models/validation_status.rb +38 -0
- data/lib/openapi_client/models/void_label_response_body.rb +246 -0
- data/lib/openapi_client/models/warehouse.rb +263 -0
- data/lib/openapi_client/models/webhook.rb +227 -0
- data/lib/openapi_client/models/webhook_event.rb +41 -0
- data/lib/openapi_client/models/weight.rb +246 -0
- data/lib/openapi_client/models/weight_unit.rb +38 -0
- data/lib/openapi_client/version.rb +15 -0
- data/openapi_client-1.0.0.gem +0 -0
- data/ship_engine.gemspec +39 -0
- data/spec/api/addresses_api_spec.rb +59 -0
- data/spec/api/batches_api_spec.rb +164 -0
- data/spec/api/carrier_accounts_api_spec.rb +88 -0
- data/spec/api/carriers_api_spec.rb +107 -0
- data/spec/api/downloads_api_spec.rb +50 -0
- data/spec/api/insurance_api_spec.rb +81 -0
- data/spec/api/labels_api_spec.rb +161 -0
- data/spec/api/manifests_api_spec.rb +79 -0
- data/spec/api/package_types_api_spec.rb +95 -0
- data/spec/api/rates_api_spec.rb +83 -0
- data/spec/api/shipments_api_spec.rb +184 -0
- data/spec/api/tags_api_spec.rb +83 -0
- data/spec/api/tracking_api_spec.rb +74 -0
- data/spec/api/warehouses_api_spec.rb +95 -0
- data/spec/api/webhooks_api_spec.rb +95 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/add_funds_to_carrier_request_body_spec.rb +35 -0
- data/spec/models/add_funds_to_carrier_response_body_spec.rb +41 -0
- data/spec/models/add_funds_to_insurance_request_body_spec.rb +35 -0
- data/spec/models/add_funds_to_insurance_response_body_spec.rb +35 -0
- data/spec/models/add_to_batch_request_body_spec.rb +35 -0
- data/spec/models/address_residential_indicator_spec.rb +35 -0
- data/spec/models/address_spec.rb +35 -0
- data/spec/models/address_to_validate_spec.rb +35 -0
- data/spec/models/address_validating_shipment_spec.rb +173 -0
- data/spec/models/address_validation_code_spec.rb +35 -0
- data/spec/models/address_validation_detail_code_spec.rb +35 -0
- data/spec/models/address_validation_message_type_spec.rb +35 -0
- data/spec/models/address_validation_result_spec.rb +59 -0
- data/spec/models/address_validation_status_spec.rb +35 -0
- data/spec/models/advanced_shipment_options_spec.rb +131 -0
- data/spec/models/ancillary_service_endorsement_spec.rb +35 -0
- data/spec/models/batch_response_error_spec.rb +47 -0
- data/spec/models/batch_spec.rb +143 -0
- data/spec/models/batch_status_spec.rb +35 -0
- data/spec/models/batches_sort_by_spec.rb +35 -0
- data/spec/models/bill_to_party_spec.rb +35 -0
- data/spec/models/bulk_rate_spec.rb +65 -0
- data/spec/models/calculate_rates_request_body_spec.rb +35 -0
- data/spec/models/calculate_rates_response_body_spec.rb +173 -0
- data/spec/models/carrier_advanced_option_spec.rb +53 -0
- data/spec/models/carrier_name_spec.rb +35 -0
- data/spec/models/carrier_name_with_settings_spec.rb +35 -0
- data/spec/models/carrier_spec.rb +113 -0
- data/spec/models/collect_on_delivery_payment_type_spec.rb +35 -0
- data/spec/models/collect_on_delivery_spec.rb +47 -0
- data/spec/models/compare_bulk_rates_request_body_spec.rb +35 -0
- data/spec/models/connect_access_worldwide_request_body_spec.rb +53 -0
- data/spec/models/connect_amazon_buy_shipping_request_body_spec.rb +59 -0
- data/spec/models/connect_apc_request_body_spec.rb +53 -0
- data/spec/models/connect_asendia_request_body_spec.rb +59 -0
- data/spec/models/connect_australia_post_request_body_spec.rb +59 -0
- data/spec/models/connect_canada_post_request_body_spec.rb +65 -0
- data/spec/models/connect_carrier_request_body_spec.rb +329 -0
- data/spec/models/connect_carrier_response_body_spec.rb +41 -0
- data/spec/models/connect_dhl_ecommerce_request_body_spec.rb +107 -0
- data/spec/models/connect_dhl_express_au_request_body_spec.rb +47 -0
- data/spec/models/connect_dhl_express_ca_request_body_spec.rb +47 -0
- data/spec/models/connect_dhl_express_request_body_spec.rb +47 -0
- data/spec/models/connect_dhl_express_uk_request_body_spec.rb +59 -0
- data/spec/models/connect_dpd_request_body_spec.rb +53 -0
- data/spec/models/connect_endicia_request_body_spec.rb +53 -0
- data/spec/models/connect_fedex_request_body_spec.rb +125 -0
- data/spec/models/connect_fedex_uk_request_body_spec.rb +125 -0
- data/spec/models/connect_firstmile_request_body_spec.rb +59 -0
- data/spec/models/connect_globegistics_request_body_spec.rb +53 -0
- data/spec/models/connect_imex_request_body_spec.rb +53 -0
- data/spec/models/connect_insurer_request_body_spec.rb +47 -0
- data/spec/models/connect_newgistics_request_body_spec.rb +59 -0
- data/spec/models/connect_ontrac_request_body_spec.rb +53 -0
- data/spec/models/connect_purolator_request_body_spec.rb +53 -0
- data/spec/models/connect_royal_mail_request_body_spec.rb +107 -0
- data/spec/models/connect_rr_donnelley_request_body_spec.rb +53 -0
- data/spec/models/connect_seko_request_body_spec.rb +47 -0
- data/spec/models/connect_sendle_request_body_spec.rb +53 -0
- data/spec/models/connect_stamps_request_body_spec.rb +53 -0
- data/spec/models/connect_ups_request_body_spec.rb +143 -0
- data/spec/models/create_and_validate_shipment_spec.rb +179 -0
- data/spec/models/create_batch_request_body_spec.rb +59 -0
- data/spec/models/create_batch_response_body_spec.rb +35 -0
- data/spec/models/create_label_from_rate_request_body_spec.rb +35 -0
- data/spec/models/create_label_from_rate_response_body_spec.rb +35 -0
- data/spec/models/create_label_from_shipment_request_body_spec.rb +59 -0
- data/spec/models/create_label_from_shipment_response_body_spec.rb +35 -0
- data/spec/models/create_label_request_body_spec.rb +35 -0
- data/spec/models/create_label_response_body_spec.rb +35 -0
- data/spec/models/create_manifest_by_object_request_body_spec.rb +65 -0
- data/spec/models/create_manifest_label_ids_request_body_spec.rb +41 -0
- data/spec/models/create_manifest_request_body_spec.rb +65 -0
- data/spec/models/create_manifest_response_body_spec.rb +95 -0
- data/spec/models/create_package_type_request_body_spec.rb +35 -0
- data/spec/models/create_package_type_response_body_spec.rb +35 -0
- data/spec/models/create_return_label_request_body_spec.rb +65 -0
- data/spec/models/create_return_label_response_body_spec.rb +35 -0
- data/spec/models/create_shipment_response_body_fields_spec.rb +47 -0
- data/spec/models/create_shipments_request_body_spec.rb +41 -0
- data/spec/models/create_shipments_response_body_spec.rb +47 -0
- data/spec/models/create_tag_response_body_spec.rb +35 -0
- data/spec/models/create_warehouse_request_body_spec.rb +35 -0
- data/spec/models/create_warehouse_response_body_spec.rb +35 -0
- data/spec/models/create_webhook_request_body_spec.rb +47 -0
- data/spec/models/create_webhook_response_body_spec.rb +35 -0
- data/spec/models/currency_spec.rb +35 -0
- data/spec/models/customs_item_spec.rb +89 -0
- data/spec/models/delivery_confirmation_spec.rb +35 -0
- data/spec/models/deprecated_manifest_spec.rb +89 -0
- data/spec/models/dhl_express_account_settings_spec.rb +53 -0
- data/spec/models/dhl_express_settings_response_body_spec.rb +35 -0
- data/spec/models/dimension_unit_spec.rb +35 -0
- data/spec/models/dimensions_spec.rb +59 -0
- data/spec/models/error_code_spec.rb +35 -0
- data/spec/models/error_response_body_spec.rb +47 -0
- data/spec/models/error_source_spec.rb +35 -0
- data/spec/models/error_spec.rb +59 -0
- data/spec/models/error_type_spec.rb +35 -0
- data/spec/models/estimate_rates_request_body_spec.rb +35 -0
- data/spec/models/fedex_account_settings_request_body_spec.rb +35 -0
- data/spec/models/fedex_account_settings_spec.rb +65 -0
- data/spec/models/fedex_pickup_type_spec.rb +35 -0
- data/spec/models/fedex_settings_response_body_spec.rb +35 -0
- data/spec/models/get_batch_by_external_id_response_body_spec.rb +35 -0
- data/spec/models/get_batch_by_id_response_body_spec.rb +35 -0
- data/spec/models/get_carrier_by_id_response_body_spec.rb +35 -0
- data/spec/models/get_carrier_options_response_body_spec.rb +41 -0
- data/spec/models/get_carrier_settings_response_body_spec.rb +125 -0
- data/spec/models/get_carriers_response_body_spec.rb +53 -0
- data/spec/models/get_insurance_balance_response_body_spec.rb +35 -0
- data/spec/models/get_label_by_external_shipment_id_response_body_spec.rb +35 -0
- data/spec/models/get_label_by_id_response_body_spec.rb +35 -0
- data/spec/models/get_manifest_by_id_response_body_spec.rb +35 -0
- data/spec/models/get_package_type_by_id_response_body_spec.rb +35 -0
- data/spec/models/get_rate_by_id_response_body_spec.rb +35 -0
- data/spec/models/get_shipment_by_external_id_response_body_spec.rb +35 -0
- data/spec/models/get_shipment_by_id_response_body_spec.rb +35 -0
- data/spec/models/get_tracking_log_from_label_response_body_spec.rb +35 -0
- data/spec/models/get_tracking_log_response_body_spec.rb +35 -0
- data/spec/models/get_warehouse_by_id_response_body_spec.rb +35 -0
- data/spec/models/get_webhook_by_id_response_body_spec.rb +35 -0
- data/spec/models/insurance_provider_spec.rb +35 -0
- data/spec/models/international_shipment_options_spec.rb +53 -0
- data/spec/models/label_charge_event_spec.rb +35 -0
- data/spec/models/label_download_spec.rb +59 -0
- data/spec/models/label_download_type_spec.rb +35 -0
- data/spec/models/label_format_spec.rb +35 -0
- data/spec/models/label_layout_spec.rb +35 -0
- data/spec/models/label_messages_spec.rb +53 -0
- data/spec/models/label_spec.rb +233 -0
- data/spec/models/label_status_spec.rb +35 -0
- data/spec/models/link_spec.rb +35 -0
- data/spec/models/list_batch_errors_response_body_spec.rb +47 -0
- data/spec/models/list_batches_response_body_spec.rb +65 -0
- data/spec/models/list_carrier_package_types_response_body_spec.rb +41 -0
- data/spec/models/list_carrier_services_response_body_spec.rb +41 -0
- data/spec/models/list_carriers_response_body_spec.rb +41 -0
- data/spec/models/list_labels_response_body_spec.rb +41 -0
- data/spec/models/list_manifests_response_body_spec.rb +65 -0
- data/spec/models/list_package_types_response_body_spec.rb +41 -0
- data/spec/models/list_shipment_errors_response_body_spec.rb +47 -0
- data/spec/models/list_shipment_rates_response_body_spec.rb +35 -0
- data/spec/models/list_shipments_response_body_spec.rb +65 -0
- data/spec/models/list_tags_response_body_spec.rb +41 -0
- data/spec/models/list_warehouses_response_body_spec.rb +41 -0
- data/spec/models/manifest_download_spec.rb +41 -0
- data/spec/models/manifest_spec.rb +89 -0
- data/spec/models/manifests_spec.rb +41 -0
- data/spec/models/modify_batch_spec.rb +47 -0
- data/spec/models/monetary_value_spec.rb +47 -0
- data/spec/models/non_delivery_spec.rb +35 -0
- data/spec/models/optional_link_spec.rb +47 -0
- data/spec/models/order_source_name_spec.rb +35 -0
- data/spec/models/package_contents_spec.rb +35 -0
- data/spec/models/package_spec.rb +77 -0
- data/spec/models/package_type_spec.rb +65 -0
- data/spec/models/paged_list_response_body_spec.rb +59 -0
- data/spec/models/pagination_link_spec.rb +59 -0
- data/spec/models/parse_address_request_body_spec.rb +47 -0
- data/spec/models/parse_address_response_body_spec.rb +53 -0
- data/spec/models/parse_shipment_request_body_spec.rb +47 -0
- data/spec/models/parse_shipment_response_body_spec.rb +53 -0
- data/spec/models/partial_address_spec.rb +101 -0
- data/spec/models/partial_shipment_spec.rb +167 -0
- data/spec/models/payment_amount_spec.rb +47 -0
- data/spec/models/process_batch_request_body_spec.rb +53 -0
- data/spec/models/purchase_label_without_shipment_spec.rb +59 -0
- data/spec/models/rate_estimate_by_carrier_id_spec.rb +41 -0
- data/spec/models/rate_estimate_by_carrier_ids_spec.rb +41 -0
- data/spec/models/rate_estimate_options_spec.rb +113 -0
- data/spec/models/rate_request_body_spec.rb +65 -0
- data/spec/models/rate_request_by_shipment_ids_spec.rb +41 -0
- data/spec/models/rate_request_by_shipments_spec.rb +41 -0
- data/spec/models/rate_request_options_spec.rb +41 -0
- data/spec/models/rate_request_rate_options_spec.rb +41 -0
- data/spec/models/rate_response_spec.rb +41 -0
- data/spec/models/rate_response_status_spec.rb +35 -0
- data/spec/models/rate_spec.rb +185 -0
- data/spec/models/rate_type_spec.rb +35 -0
- data/spec/models/rates_information_spec.rb +77 -0
- data/spec/models/recognized_entity_spec.rb +71 -0
- data/spec/models/remove_from_batch_request_body_spec.rb +35 -0
- data/spec/models/response_message_spec.rb +59 -0
- data/spec/models/service_spec.rb +77 -0
- data/spec/models/shipment_id_request_spec.rb +41 -0
- data/spec/models/shipment_item_spec.rb +89 -0
- data/spec/models/shipment_request_spec.rb +41 -0
- data/spec/models/shipment_response_error_spec.rb +53 -0
- data/spec/models/shipment_spec.rb +35 -0
- data/spec/models/shipment_status_spec.rb +35 -0
- data/spec/models/shipments_sort_by_spec.rb +35 -0
- data/spec/models/smart_post_hub_spec.rb +35 -0
- data/spec/models/sort_dir_spec.rb +35 -0
- data/spec/models/tag_shipment_response_body_spec.rb +47 -0
- data/spec/models/tag_spec.rb +41 -0
- data/spec/models/track_event_spec.rb +107 -0
- data/spec/models/tracking_information_spec.rb +95 -0
- data/spec/models/tracking_status_spec.rb +35 -0
- data/spec/models/update_amazon_buy_shipping_request_body_spec.rb +41 -0
- data/spec/models/update_carrier_settings_request_body_spec.rb +143 -0
- data/spec/models/update_dhl_express_settings_request_body_spec.rb +35 -0
- data/spec/models/update_fedex_settings_request_body_spec.rb +35 -0
- data/spec/models/update_newgistics_settings_request_body_spec.rb +47 -0
- data/spec/models/update_package_type_request_body_spec.rb +35 -0
- data/spec/models/update_shipment_fields_spec.rb +41 -0
- data/spec/models/update_shipment_request_body_spec.rb +173 -0
- data/spec/models/update_shipment_response_body_spec.rb +35 -0
- data/spec/models/update_ups_settings_request_body_spec.rb +35 -0
- data/spec/models/update_warehouse_request_body_spec.rb +35 -0
- data/spec/models/update_webhook_request_body_spec.rb +41 -0
- data/spec/models/ups_account_settings_spec.rb +107 -0
- data/spec/models/ups_invoice_spec.rb +59 -0
- data/spec/models/ups_pickup_type_spec.rb +35 -0
- data/spec/models/ups_settings_response_body_spec.rb +35 -0
- data/spec/models/validate_address_spec.rb +35 -0
- data/spec/models/validate_shipment_fields_spec.rb +41 -0
- data/spec/models/validation_status_spec.rb +35 -0
- data/spec/models/void_label_response_body_spec.rb +47 -0
- data/spec/models/warehouse_spec.rb +65 -0
- data/spec/models/webhook_event_spec.rb +35 -0
- data/spec/models/webhook_spec.rb +53 -0
- data/spec/models/weight_spec.rb +47 -0
- data/spec/models/weight_unit_spec.rb +35 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1110 -0
@@ -0,0 +1,88 @@
|
|
1
|
+
=begin
|
2
|
+
#ShipEngine API
|
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.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.1.202006302006
|
7
|
+
Contact: sales@shipengine.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for OpenapiClient::CarrierAccountsApi
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'CarrierAccountsApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@api_instance = OpenapiClient::CarrierAccountsApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of CarrierAccountsApi' do
|
30
|
+
it 'should create an instance of CarrierAccountsApi' do
|
31
|
+
expect(@api_instance).to be_instance_of(OpenapiClient::CarrierAccountsApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for connect_carrier
|
36
|
+
# Connect a carrier account
|
37
|
+
# Connect a carrier account
|
38
|
+
# @param carrier_name The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
|
39
|
+
# @param connect_carrier_request_body
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @return [ConnectCarrierResponseBody]
|
42
|
+
describe 'connect_carrier test' do
|
43
|
+
it 'should work' do
|
44
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
# unit tests for disconnect_carrier
|
49
|
+
# Disconnect a carrier
|
50
|
+
# Disconnect a carrier
|
51
|
+
# @param carrier_name The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
|
52
|
+
# @param carrier_id Carrier ID
|
53
|
+
# @param [Hash] opts the optional parameters
|
54
|
+
# @return [String]
|
55
|
+
describe 'disconnect_carrier test' do
|
56
|
+
it 'should work' do
|
57
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
# unit tests for get_carrier_settings
|
62
|
+
# Get carrier settings
|
63
|
+
# Get carrier settings
|
64
|
+
# @param carrier_name The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
|
65
|
+
# @param carrier_id Carrier ID
|
66
|
+
# @param [Hash] opts the optional parameters
|
67
|
+
# @return [GetCarrierSettingsResponseBody]
|
68
|
+
describe 'get_carrier_settings test' do
|
69
|
+
it 'should work' do
|
70
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
# unit tests for update_carrier_settings
|
75
|
+
# Update carrier settings
|
76
|
+
# Update carrier settings
|
77
|
+
# @param carrier_name The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
|
78
|
+
# @param carrier_id Carrier ID
|
79
|
+
# @param update_carrier_settings_request_body
|
80
|
+
# @param [Hash] opts the optional parameters
|
81
|
+
# @return [String]
|
82
|
+
describe 'update_carrier_settings test' do
|
83
|
+
it 'should work' do
|
84
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
85
|
+
end
|
86
|
+
end
|
87
|
+
|
88
|
+
end
|
@@ -0,0 +1,107 @@
|
|
1
|
+
=begin
|
2
|
+
#ShipEngine API
|
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.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.1.202006302006
|
7
|
+
Contact: sales@shipengine.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for OpenapiClient::CarriersApi
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'CarriersApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@api_instance = OpenapiClient::CarriersApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of CarriersApi' do
|
30
|
+
it 'should create an instance of CarriersApi' do
|
31
|
+
expect(@api_instance).to be_instance_of(OpenapiClient::CarriersApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for add_funds_to_carrier
|
36
|
+
# Add Funds To Carrier
|
37
|
+
# Add Funds To A Carrier
|
38
|
+
# @param carrier_id Carrier ID
|
39
|
+
# @param add_funds_to_carrier_request_body
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @return [AddFundsToCarrierResponseBody]
|
42
|
+
describe 'add_funds_to_carrier test' do
|
43
|
+
it 'should work' do
|
44
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
# unit tests for get_carrier_by_id
|
49
|
+
# Get Carrier By ID
|
50
|
+
# Retrive carrier info by ID
|
51
|
+
# @param carrier_id Carrier ID
|
52
|
+
# @param [Hash] opts the optional parameters
|
53
|
+
# @return [GetCarrierByIdResponseBody]
|
54
|
+
describe 'get_carrier_by_id test' do
|
55
|
+
it 'should work' do
|
56
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
# unit tests for get_carrier_options
|
61
|
+
# Get Carrier Options
|
62
|
+
# Get a list of the options available for the carrier
|
63
|
+
# @param carrier_id Carrier ID
|
64
|
+
# @param [Hash] opts the optional parameters
|
65
|
+
# @return [GetCarrierOptionsResponseBody]
|
66
|
+
describe 'get_carrier_options test' do
|
67
|
+
it 'should work' do
|
68
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
# unit tests for list_carrier_package_types
|
73
|
+
# List Carrier Package Types
|
74
|
+
# List the package types associated with the carrier
|
75
|
+
# @param carrier_id Carrier ID
|
76
|
+
# @param [Hash] opts the optional parameters
|
77
|
+
# @return [ListCarrierPackageTypesResponseBody]
|
78
|
+
describe 'list_carrier_package_types test' do
|
79
|
+
it 'should work' do
|
80
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
81
|
+
end
|
82
|
+
end
|
83
|
+
|
84
|
+
# unit tests for list_carrier_services
|
85
|
+
# List Carrier Services
|
86
|
+
# List the services associated with the carrier ID
|
87
|
+
# @param carrier_id Carrier ID
|
88
|
+
# @param [Hash] opts the optional parameters
|
89
|
+
# @return [ListCarrierServicesResponseBody]
|
90
|
+
describe 'list_carrier_services test' do
|
91
|
+
it 'should work' do
|
92
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
93
|
+
end
|
94
|
+
end
|
95
|
+
|
96
|
+
# unit tests for list_carriers
|
97
|
+
# List Carriers
|
98
|
+
# List all carriers that have been added to this account
|
99
|
+
# @param [Hash] opts the optional parameters
|
100
|
+
# @return [GetCarriersResponseBody]
|
101
|
+
describe 'list_carriers test' do
|
102
|
+
it 'should work' do
|
103
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
104
|
+
end
|
105
|
+
end
|
106
|
+
|
107
|
+
end
|
@@ -0,0 +1,50 @@
|
|
1
|
+
=begin
|
2
|
+
#ShipEngine API
|
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.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.1.202006302006
|
7
|
+
Contact: sales@shipengine.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for OpenapiClient::DownloadsApi
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'DownloadsApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@api_instance = OpenapiClient::DownloadsApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of DownloadsApi' do
|
30
|
+
it 'should create an instance of DownloadsApi' do
|
31
|
+
expect(@api_instance).to be_instance_of(OpenapiClient::DownloadsApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for download_file
|
36
|
+
# Download File
|
37
|
+
# Get File
|
38
|
+
# @param subdir
|
39
|
+
# @param filename
|
40
|
+
# @param dir
|
41
|
+
# @param [Hash] opts the optional parameters
|
42
|
+
# @option opts [String] :download
|
43
|
+
# @return [File]
|
44
|
+
describe 'download_file test' do
|
45
|
+
it 'should work' do
|
46
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
50
|
+
end
|
@@ -0,0 +1,81 @@
|
|
1
|
+
=begin
|
2
|
+
#ShipEngine API
|
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.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.1.202006302006
|
7
|
+
Contact: sales@shipengine.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for OpenapiClient::InsuranceApi
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'InsuranceApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@api_instance = OpenapiClient::InsuranceApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of InsuranceApi' do
|
30
|
+
it 'should create an instance of InsuranceApi' do
|
31
|
+
expect(@api_instance).to be_instance_of(OpenapiClient::InsuranceApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for add_funds_to_insurance
|
36
|
+
# Add Funds To Insurance
|
37
|
+
# You may need to auto fund your account from time to time. For example, if you don't normally ship items over $100, and may want to add funds to insurance rather than keeping the account funded.
|
38
|
+
# @param add_funds_to_insurance_request_body
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @return [AddFundsToInsuranceResponseBody]
|
41
|
+
describe 'add_funds_to_insurance test' do
|
42
|
+
it 'should work' do
|
43
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
# unit tests for connect_insurer
|
48
|
+
# Connect a Shipsurance Account
|
49
|
+
# Connect a Shipsurance Account
|
50
|
+
# @param connect_insurer_request_body
|
51
|
+
# @param [Hash] opts the optional parameters
|
52
|
+
# @return [Object]
|
53
|
+
describe 'connect_insurer test' do
|
54
|
+
it 'should work' do
|
55
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
# unit tests for disconnect_insurer
|
60
|
+
# Disconnect a Shipsurance Account
|
61
|
+
# Disconnect a Shipsurance Account
|
62
|
+
# @param [Hash] opts the optional parameters
|
63
|
+
# @return [Object]
|
64
|
+
describe 'disconnect_insurer test' do
|
65
|
+
it 'should work' do
|
66
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
# unit tests for get_insurance_balance
|
71
|
+
# Get Insurance Funds Balance
|
72
|
+
# Retrieve the balance of your Shipsurance account.
|
73
|
+
# @param [Hash] opts the optional parameters
|
74
|
+
# @return [GetInsuranceBalanceResponseBody]
|
75
|
+
describe 'get_insurance_balance test' do
|
76
|
+
it 'should work' do
|
77
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
78
|
+
end
|
79
|
+
end
|
80
|
+
|
81
|
+
end
|
@@ -0,0 +1,161 @@
|
|
1
|
+
=begin
|
2
|
+
#ShipEngine API
|
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.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.1.202006302006
|
7
|
+
Contact: sales@shipengine.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for OpenapiClient::LabelsApi
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'LabelsApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@api_instance = OpenapiClient::LabelsApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of LabelsApi' do
|
30
|
+
it 'should create an instance of LabelsApi' do
|
31
|
+
expect(@api_instance).to be_instance_of(OpenapiClient::LabelsApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for create_label
|
36
|
+
# Purchase Label
|
37
|
+
# Purchase and print a label for shipment
|
38
|
+
# @param create_label_request_body
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @return [CreateLabelResponseBody]
|
41
|
+
describe 'create_label test' do
|
42
|
+
it 'should work' do
|
43
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
# unit tests for create_label_from_rate
|
48
|
+
# Purchase Label with Rate ID
|
49
|
+
# When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly.
|
50
|
+
# @param rate_id Rate ID
|
51
|
+
# @param create_label_from_rate_request_body
|
52
|
+
# @param [Hash] opts the optional parameters
|
53
|
+
# @return [CreateLabelFromRateResponseBody]
|
54
|
+
describe 'create_label_from_rate test' do
|
55
|
+
it 'should work' do
|
56
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
# unit tests for create_label_from_shipment
|
61
|
+
# Purchase Label with Shipment ID
|
62
|
+
# Purchase a label using a shipment ID that has already been created with the desired address and package info.
|
63
|
+
# @param shipment_id Shipment ID
|
64
|
+
# @param create_label_from_shipment_request_body
|
65
|
+
# @param [Hash] opts the optional parameters
|
66
|
+
# @return [CreateLabelFromShipmentResponseBody]
|
67
|
+
describe 'create_label_from_shipment test' do
|
68
|
+
it 'should work' do
|
69
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
# unit tests for create_return_label
|
74
|
+
# Create a return label
|
75
|
+
# Create a return label
|
76
|
+
# @param label_id Label ID
|
77
|
+
# @param create_return_label_request_body
|
78
|
+
# @param [Hash] opts the optional parameters
|
79
|
+
# @return [CreateReturnLabelResponseBody]
|
80
|
+
describe 'create_return_label test' do
|
81
|
+
it 'should work' do
|
82
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
83
|
+
end
|
84
|
+
end
|
85
|
+
|
86
|
+
# unit tests for get_label_by_external_shipment_id
|
87
|
+
# Get Label By External Shipment ID
|
88
|
+
# Find a label by using the external shipment id that was used during label creation
|
89
|
+
# @param external_shipment_id
|
90
|
+
# @param [Hash] opts the optional parameters
|
91
|
+
# @option opts [LabelDownloadType] :label_download_type
|
92
|
+
# @return [GetLabelByExternalShipmentIdResponseBody]
|
93
|
+
describe 'get_label_by_external_shipment_id test' do
|
94
|
+
it 'should work' do
|
95
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
# unit tests for get_label_by_id
|
100
|
+
# Get Label By ID
|
101
|
+
# Retrieve information for individual labels.
|
102
|
+
# @param label_id Label ID
|
103
|
+
# @param [Hash] opts the optional parameters
|
104
|
+
# @option opts [LabelDownloadType] :label_download_type
|
105
|
+
# @return [GetLabelByIdResponseBody]
|
106
|
+
describe 'get_label_by_id test' do
|
107
|
+
it 'should work' do
|
108
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
109
|
+
end
|
110
|
+
end
|
111
|
+
|
112
|
+
# unit tests for get_tracking_log_from_label
|
113
|
+
# Get Label Tracking Information
|
114
|
+
# Retrieve the label's tracking information
|
115
|
+
# @param label_id Label ID
|
116
|
+
# @param [Hash] opts the optional parameters
|
117
|
+
# @return [GetTrackingLogFromLabelResponseBody]
|
118
|
+
describe 'get_tracking_log_from_label test' do
|
119
|
+
it 'should work' do
|
120
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
121
|
+
end
|
122
|
+
end
|
123
|
+
|
124
|
+
# unit tests for list_labels
|
125
|
+
# List labels
|
126
|
+
# This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/labels/create-a-label/). You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want to get your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id`
|
127
|
+
# @param [Hash] opts the optional parameters
|
128
|
+
# @option opts [LabelStatus] :label_status Only return labels that are currently in the specified status
|
129
|
+
# @option opts [String] :service_code Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/)
|
130
|
+
# @option opts [String] :carrier_id Only return labels for a specific [carrier account](https://www.shipengine.com/docs/carriers/setup/)
|
131
|
+
# @option opts [String] :tracking_number Only return labels with a specific tracking number
|
132
|
+
# @option opts [String] :batch_id Only return labels that were created in a specific [batch](https://www.shipengine.com/docs/labels/bulk/)
|
133
|
+
# @option opts [String] :rate_id Rate ID
|
134
|
+
# @option opts [String] :shipment_id Shipment ID
|
135
|
+
# @option opts [String] :warehouse_id Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/)
|
136
|
+
# @option opts [DateTime] :created_at_start Only return labels that were created on or after a specific date/time
|
137
|
+
# @option opts [DateTime] :created_at_end Only return labels that were created on or before a specific date/time
|
138
|
+
# @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
|
139
|
+
# @option opts [Integer] :page_size The number of results to return per response.
|
140
|
+
# @option opts [SortDir] :sort_dir Controls the sort order of the query.
|
141
|
+
# @option opts [String] :sort_by Controls which field the query is sorted by.
|
142
|
+
# @return [ListLabelsResponseBody]
|
143
|
+
describe 'list_labels test' do
|
144
|
+
it 'should work' do
|
145
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
146
|
+
end
|
147
|
+
end
|
148
|
+
|
149
|
+
# unit tests for void_label
|
150
|
+
# Void a Label By ID
|
151
|
+
# Void a label by ID to get a refund.
|
152
|
+
# @param label_id Label ID
|
153
|
+
# @param [Hash] opts the optional parameters
|
154
|
+
# @return [VoidLabelResponseBody]
|
155
|
+
describe 'void_label test' do
|
156
|
+
it 'should work' do
|
157
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
158
|
+
end
|
159
|
+
end
|
160
|
+
|
161
|
+
end
|