ship_engine 1.0.2 → 1.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +70 -0
- data/README.md +326 -321
- data/docs/AddFundsToCarrierRequestBody.md +4 -3
- data/docs/AddFundsToCarrierResponseBody.md +5 -3
- data/docs/AddFundsToInsuranceRequestBody.md +4 -3
- data/docs/AddFundsToInsuranceResponseBody.md +4 -3
- data/docs/AddToBatchRequestBody.md +4 -3
- data/docs/Address.md +4 -3
- data/docs/AddressResidentialIndicator.md +4 -3
- data/docs/AddressToValidate.md +4 -3
- data/docs/AddressValidatingShipment.md +27 -25
- data/docs/AddressValidationCode.md +4 -3
- data/docs/AddressValidationDetailCode.md +4 -3
- data/docs/AddressValidationMessageType.md +4 -3
- data/docs/AddressValidationResult.md +8 -6
- data/docs/AddressValidationStatus.md +4 -3
- data/docs/AddressesApi.md +22 -16
- data/docs/AdvancedShipmentOptions.md +20 -18
- data/docs/AncillaryServiceEndorsement.md +4 -3
- data/docs/Batch.md +22 -20
- data/docs/BatchResponseError.md +6 -4
- data/docs/BatchStatus.md +4 -3
- data/docs/BatchesApi.md +94 -72
- data/docs/BatchesSortBy.md +4 -3
- data/docs/BillToParty.md +4 -3
- data/docs/BulkRate.md +9 -7
- data/docs/CalculateRatesRequestBody.md +4 -3
- data/docs/CalculateRatesResponseBody.md +27 -25
- data/docs/Carrier.md +17 -15
- data/docs/CarrierAccountsApi.md +39 -29
- data/docs/CarrierAdvancedOption.md +7 -5
- data/docs/CarrierName.md +4 -3
- data/docs/CarrierNameWithSettings.md +4 -3
- data/docs/CarriersApi.md +44 -31
- data/docs/CollectOnDelivery.md +6 -4
- data/docs/CollectOnDeliveryPaymentType.md +4 -3
- data/docs/CompareBulkRatesRequestBody.md +4 -3
- data/docs/ConnectAccessWorldwideRequestBody.md +7 -5
- data/docs/ConnectAmazonBuyShippingRequestBody.md +8 -6
- data/docs/ConnectApcRequestBody.md +7 -5
- data/docs/ConnectAsendiaRequestBody.md +8 -6
- data/docs/ConnectAustraliaPostRequestBody.md +8 -6
- data/docs/ConnectCanadaPostRequestBody.md +9 -7
- data/docs/ConnectCarrierRequestBody.md +53 -51
- data/docs/ConnectCarrierResponseBody.md +5 -3
- data/docs/ConnectDhlEcommerceRequestBody.md +16 -14
- data/docs/ConnectDhlExpressAuRequestBody.md +6 -4
- data/docs/ConnectDhlExpressCaRequestBody.md +6 -4
- data/docs/ConnectDhlExpressRequestBody.md +6 -4
- data/docs/ConnectDhlExpressUkRequestBody.md +8 -6
- data/docs/ConnectDpdRequestBody.md +7 -5
- data/docs/ConnectEndiciaRequestBody.md +7 -5
- data/docs/ConnectFedexRequestBody.md +19 -17
- data/docs/ConnectFedexUkRequestBody.md +19 -17
- data/docs/ConnectFirstmileRequestBody.md +8 -6
- data/docs/ConnectGlobegisticsRequestBody.md +7 -5
- data/docs/ConnectImexRequestBody.md +7 -5
- data/docs/ConnectInsurerRequestBody.md +6 -4
- data/docs/ConnectNewgisticsRequestBody.md +8 -6
- data/docs/ConnectOntracRequestBody.md +7 -5
- data/docs/ConnectPurolatorRequestBody.md +7 -5
- data/docs/ConnectRoyalMailRequestBody.md +16 -14
- data/docs/ConnectRrDonnelleyRequestBody.md +7 -5
- data/docs/ConnectSekoRequestBody.md +6 -4
- data/docs/ConnectSendleRequestBody.md +7 -5
- data/docs/ConnectStampsRequestBody.md +7 -5
- data/docs/ConnectUpsRequestBody.md +22 -20
- data/docs/CreateAndValidateShipment.md +28 -26
- data/docs/CreateBatchRequestBody.md +8 -6
- data/docs/CreateBatchResponseBody.md +4 -3
- data/docs/CreateLabelFromRateRequestBody.md +4 -3
- data/docs/CreateLabelFromRateResponseBody.md +4 -3
- data/docs/CreateLabelFromShipmentRequestBody.md +8 -6
- data/docs/CreateLabelFromShipmentResponseBody.md +4 -3
- data/docs/CreateLabelRequestBody.md +4 -3
- data/docs/CreateLabelResponseBody.md +4 -3
- data/docs/CreateManifestByObjectRequestBody.md +9 -7
- data/docs/CreateManifestLabelIdsRequestBody.md +5 -3
- data/docs/CreateManifestRequestBody.md +9 -7
- data/docs/CreateManifestResponseBody.md +14 -12
- data/docs/CreatePackageTypeRequestBody.md +4 -3
- data/docs/CreatePackageTypeResponseBody.md +4 -3
- data/docs/CreateReturnLabelRequestBody.md +9 -7
- data/docs/CreateReturnLabelResponseBody.md +4 -3
- data/docs/CreateShipmentResponseBodyFields.md +6 -4
- data/docs/CreateShipmentsRequestBody.md +5 -3
- data/docs/CreateShipmentsResponseBody.md +6 -4
- data/docs/CreateTagResponseBody.md +4 -3
- data/docs/CreateWarehouseRequestBody.md +4 -3
- data/docs/CreateWarehouseResponseBody.md +4 -3
- data/docs/CreateWebhookRequestBody.md +6 -4
- data/docs/CreateWebhookResponseBody.md +4 -3
- data/docs/Currency.md +4 -3
- data/docs/CustomsItem.md +13 -11
- data/docs/DeliveryConfirmation.md +4 -3
- data/docs/DeprecatedManifest.md +13 -11
- data/docs/DhlExpressAccountSettings.md +7 -5
- data/docs/DhlExpressSettingsResponseBody.md +4 -3
- data/docs/DimensionUnit.md +4 -3
- data/docs/Dimensions.md +8 -6
- data/docs/DownloadsApi.md +18 -14
- data/docs/Error.md +8 -6
- data/docs/ErrorCode.md +4 -3
- data/docs/ErrorResponseBody.md +6 -4
- data/docs/ErrorSource.md +4 -3
- data/docs/ErrorType.md +4 -3
- data/docs/EstimateRatesRequestBody.md +4 -3
- data/docs/FedexAccountSettings.md +9 -7
- data/docs/FedexAccountSettingsRequestBody.md +4 -3
- data/docs/FedexPickupType.md +4 -3
- data/docs/FedexSettingsResponseBody.md +4 -3
- data/docs/GetBatchByExternalIdResponseBody.md +4 -3
- data/docs/GetBatchByIdResponseBody.md +4 -3
- data/docs/GetCarrierByIdResponseBody.md +4 -3
- data/docs/GetCarrierOptionsResponseBody.md +5 -3
- data/docs/GetCarrierSettingsResponseBody.md +19 -17
- data/docs/GetCarriersResponseBody.md +7 -5
- data/docs/GetInsuranceBalanceResponseBody.md +4 -3
- data/docs/GetLabelByExternalShipmentIdResponseBody.md +4 -3
- data/docs/GetLabelByIdResponseBody.md +4 -3
- data/docs/GetManifestByIdResponseBody.md +4 -3
- data/docs/GetPackageTypeByIdResponseBody.md +4 -3
- data/docs/GetRateByIdResponseBody.md +4 -3
- data/docs/GetShipmentByExternalIdResponseBody.md +4 -3
- data/docs/GetShipmentByIdResponseBody.md +4 -3
- data/docs/GetTrackingLogFromLabelResponseBody.md +4 -3
- data/docs/GetTrackingLogResponseBody.md +4 -3
- data/docs/GetWarehouseByIdResponseBody.md +4 -3
- data/docs/GetWebhookByIdResponseBody.md +4 -3
- data/docs/InsuranceApi.md +27 -19
- data/docs/InsuranceProvider.md +4 -3
- data/docs/InternationalShipmentOptions.md +7 -5
- data/docs/Label.md +37 -35
- data/docs/LabelChargeEvent.md +4 -3
- data/docs/LabelDownload.md +8 -6
- data/docs/LabelDownloadType.md +4 -3
- data/docs/LabelFormat.md +4 -3
- data/docs/LabelLayout.md +4 -3
- data/docs/LabelMessages.md +7 -5
- data/docs/LabelStatus.md +4 -3
- data/docs/LabelsApi.md +97 -77
- data/docs/Link.md +4 -3
- data/docs/ListBatchErrorsResponseBody.md +6 -4
- data/docs/ListBatchesResponseBody.md +9 -7
- data/docs/ListCarrierPackageTypesResponseBody.md +5 -3
- data/docs/ListCarrierServicesResponseBody.md +5 -3
- data/docs/ListCarriersResponseBody.md +5 -3
- data/docs/ListLabelsResponseBody.md +5 -3
- data/docs/ListManifestsResponseBody.md +9 -7
- data/docs/ListPackageTypesResponseBody.md +5 -3
- data/docs/ListShipmentErrorsResponseBody.md +6 -4
- data/docs/ListShipmentRatesResponseBody.md +4 -3
- data/docs/ListShipmentsResponseBody.md +9 -7
- data/docs/ListTagsResponseBody.md +5 -3
- data/docs/ListWarehousesResponseBody.md +5 -3
- data/docs/Manifest.md +13 -11
- data/docs/ManifestDownload.md +5 -3
- data/docs/Manifests.md +5 -3
- data/docs/ManifestsApi.md +37 -29
- data/docs/ModifyBatch.md +6 -4
- data/docs/MonetaryValue.md +6 -4
- data/docs/NonDelivery.md +4 -3
- data/docs/OptionalLink.md +6 -4
- data/docs/OrderSourceName.md +4 -3
- data/docs/Package.md +11 -9
- data/docs/PackageContents.md +4 -3
- data/docs/PackageType.md +9 -7
- data/docs/PackageTypesApi.md +38 -27
- data/docs/PagedListResponseBody.md +8 -6
- data/docs/PaginationLink.md +8 -6
- data/docs/ParseAddressRequestBody.md +6 -4
- data/docs/ParseAddressResponseBody.md +7 -5
- data/docs/ParseShipmentRequestBody.md +6 -4
- data/docs/ParseShipmentResponseBody.md +7 -5
- data/docs/PartialAddress.md +15 -13
- data/docs/PartialShipment.md +26 -24
- data/docs/PaymentAmount.md +6 -4
- data/docs/ProcessBatchRequestBody.md +7 -5
- data/docs/PurchaseLabelWithoutShipment.md +8 -6
- data/docs/Rate.md +29 -27
- data/docs/RateEstimateByCarrierId.md +5 -3
- data/docs/RateEstimateByCarrierIds.md +5 -3
- data/docs/RateEstimateOptions.md +17 -15
- data/docs/RateRequestBody.md +9 -7
- data/docs/RateRequestByShipmentIds.md +5 -3
- data/docs/RateRequestByShipments.md +5 -3
- data/docs/RateRequestOptions.md +5 -3
- data/docs/RateRequestRateOptions.md +5 -3
- data/docs/RateResponse.md +5 -3
- data/docs/RateResponseStatus.md +4 -3
- data/docs/RateType.md +4 -3
- data/docs/RatesApi.md +36 -26
- data/docs/RatesInformation.md +11 -9
- data/docs/RecognizedEntity.md +10 -8
- data/docs/RemoveFromBatchRequestBody.md +4 -3
- data/docs/ResponseMessage.md +8 -6
- data/docs/Service.md +11 -9
- data/docs/Shipment.md +4 -3
- data/docs/ShipmentIdRequest.md +5 -3
- data/docs/ShipmentItem.md +13 -11
- data/docs/ShipmentRequest.md +5 -3
- data/docs/ShipmentResponseError.md +7 -5
- data/docs/ShipmentStatus.md +4 -3
- data/docs/ShipmentsApi.md +112 -88
- data/docs/ShipmentsSortBy.md +4 -3
- data/docs/SmartPostHub.md +4 -3
- data/docs/SortDir.md +4 -3
- data/docs/Tag.md +5 -3
- data/docs/TagShipmentResponseBody.md +6 -4
- data/docs/TagsApi.md +33 -24
- data/docs/TrackEvent.md +16 -14
- data/docs/TrackingApi.md +29 -21
- data/docs/TrackingInformation.md +14 -12
- data/docs/TrackingStatus.md +4 -3
- data/docs/UpdateAmazonBuyShippingRequestBody.md +5 -3
- data/docs/UpdateCarrierSettingsRequestBody.md +22 -20
- data/docs/UpdateDhlExpressSettingsRequestBody.md +4 -3
- data/docs/UpdateFedexSettingsRequestBody.md +4 -3
- data/docs/UpdateNewgisticsSettingsRequestBody.md +6 -4
- data/docs/UpdatePackageTypeRequestBody.md +4 -3
- data/docs/UpdateShipmentFields.md +5 -3
- data/docs/UpdateShipmentRequestBody.md +27 -25
- data/docs/UpdateShipmentResponseBody.md +4 -3
- data/docs/UpdateUpsSettingsRequestBody.md +4 -3
- data/docs/UpdateWarehouseRequestBody.md +4 -3
- data/docs/UpdateWebhookRequestBody.md +5 -3
- data/docs/UpsAccountSettings.md +16 -14
- data/docs/UpsInvoice.md +8 -6
- data/docs/UpsPickupType.md +4 -3
- data/docs/UpsSettingsResponseBody.md +4 -3
- data/docs/ValidateAddress.md +4 -3
- data/docs/ValidateShipmentFields.md +5 -3
- data/docs/ValidationStatus.md +4 -3
- data/docs/VoidLabelResponseBody.md +6 -4
- data/docs/Warehouse.md +9 -7
- data/docs/WarehousesApi.md +39 -28
- data/docs/Webhook.md +7 -5
- data/docs/WebhookEvent.md +4 -3
- data/docs/WebhooksApi.md +38 -27
- data/docs/Weight.md +6 -4
- data/docs/WeightUnit.md +4 -3
- data/lib/ship_engine.rb +25 -25
- data/lib/ship_engine/api/addresses_api.rb +13 -13
- data/lib/ship_engine/api/batches_api.rb +41 -41
- data/lib/ship_engine/api/carrier_accounts_api.rb +13 -13
- data/lib/ship_engine/api/carriers_api.rb +15 -15
- data/lib/ship_engine/api/downloads_api.rb +11 -11
- data/lib/ship_engine/api/insurance_api.rb +15 -15
- data/lib/ship_engine/api/labels_api.rb +42 -42
- data/lib/ship_engine/api/manifests_api.rb +14 -14
- data/lib/ship_engine/api/package_types_api.rb +15 -15
- data/lib/ship_engine/api/rates_api.rb +17 -17
- data/lib/ship_engine/api/shipments_api.rb +49 -49
- data/lib/ship_engine/api/tags_api.rb +17 -17
- data/lib/ship_engine/api/tracking_api.rb +9 -9
- data/lib/ship_engine/api/warehouses_api.rb +17 -17
- data/lib/ship_engine/api/webhooks_api.rb +15 -15
- data/lib/ship_engine/api_client.rb +1 -1
- data/lib/ship_engine/api_error.rb +1 -1
- data/lib/ship_engine/configuration.rb +1 -1
- data/lib/ship_engine/models/add_funds_to_carrier_request_body.rb +2 -2
- data/lib/ship_engine/models/add_funds_to_carrier_response_body.rb +2 -2
- data/lib/ship_engine/models/add_funds_to_insurance_request_body.rb +2 -2
- data/lib/ship_engine/models/add_funds_to_insurance_response_body.rb +2 -2
- data/lib/ship_engine/models/add_to_batch_request_body.rb +2 -2
- data/lib/ship_engine/models/address.rb +3 -3
- data/lib/ship_engine/models/address_residential_indicator.rb +1 -1
- data/lib/ship_engine/models/address_to_validate.rb +3 -3
- data/lib/ship_engine/models/address_validating_shipment.rb +13 -13
- data/lib/ship_engine/models/address_validation_code.rb +1 -1
- data/lib/ship_engine/models/address_validation_detail_code.rb +1 -1
- data/lib/ship_engine/models/address_validation_message_type.rb +1 -1
- data/lib/ship_engine/models/address_validation_result.rb +2 -2
- data/lib/ship_engine/models/address_validation_status.rb +1 -1
- data/lib/ship_engine/models/advanced_shipment_options.rb +13 -13
- data/lib/ship_engine/models/ancillary_service_endorsement.rb +1 -1
- data/lib/ship_engine/models/batch.rb +3 -3
- data/lib/ship_engine/models/batch_response_error.rb +2 -2
- data/lib/ship_engine/models/batch_status.rb +1 -1
- data/lib/ship_engine/models/batches_sort_by.rb +1 -1
- data/lib/ship_engine/models/bill_to_party.rb +1 -1
- data/lib/ship_engine/models/bulk_rate.rb +2 -2
- data/lib/ship_engine/models/calculate_rates_request_body.rb +2 -2
- data/lib/ship_engine/models/calculate_rates_response_body.rb +13 -13
- data/lib/ship_engine/models/carrier.rb +3 -3
- data/lib/ship_engine/models/carrier_advanced_option.rb +2 -2
- data/lib/ship_engine/models/carrier_name.rb +1 -1
- data/lib/ship_engine/models/carrier_name_with_settings.rb +1 -1
- data/lib/ship_engine/models/collect_on_delivery.rb +2 -2
- data/lib/ship_engine/models/collect_on_delivery_payment_type.rb +1 -1
- data/lib/ship_engine/models/compare_bulk_rates_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_access_worldwide_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_amazon_buy_shipping_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_apc_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_asendia_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_australia_post_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_canada_post_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_carrier_request_body.rb +3 -3
- data/lib/ship_engine/models/connect_carrier_response_body.rb +2 -2
- data/lib/ship_engine/models/connect_dhl_ecommerce_request_body.rb +4 -4
- data/lib/ship_engine/models/connect_dhl_express_au_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_dhl_express_ca_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_dhl_express_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_dhl_express_uk_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_dpd_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_endicia_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_fedex_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_fedex_uk_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_firstmile_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_globegistics_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_imex_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_insurer_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_newgistics_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_ontrac_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_purolator_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_royal_mail_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_rr_donnelley_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_seko_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_sendle_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_stamps_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_ups_request_body.rb +2 -2
- data/lib/ship_engine/models/create_and_validate_shipment.rb +13 -13
- data/lib/ship_engine/models/create_batch_request_body.rb +2 -2
- data/lib/ship_engine/models/create_batch_response_body.rb +2 -2
- data/lib/ship_engine/models/create_label_from_rate_request_body.rb +2 -2
- data/lib/ship_engine/models/create_label_from_rate_response_body.rb +2 -2
- data/lib/ship_engine/models/create_label_from_shipment_request_body.rb +2 -2
- data/lib/ship_engine/models/create_label_from_shipment_response_body.rb +2 -2
- data/lib/ship_engine/models/create_label_request_body.rb +2 -2
- data/lib/ship_engine/models/create_label_response_body.rb +2 -2
- data/lib/ship_engine/models/create_manifest_by_object_request_body.rb +2 -2
- data/lib/ship_engine/models/create_manifest_label_ids_request_body.rb +2 -2
- data/lib/ship_engine/models/create_manifest_request_body.rb +2 -2
- data/lib/ship_engine/models/create_manifest_response_body.rb +2 -2
- data/lib/ship_engine/models/create_package_type_request_body.rb +2 -2
- data/lib/ship_engine/models/create_package_type_response_body.rb +2 -2
- data/lib/ship_engine/models/create_return_label_request_body.rb +5 -5
- data/lib/ship_engine/models/create_return_label_response_body.rb +2 -2
- data/lib/ship_engine/models/create_shipment_response_body_fields.rb +2 -2
- data/lib/ship_engine/models/create_shipments_request_body.rb +2 -2
- data/lib/ship_engine/models/create_shipments_response_body.rb +2 -2
- data/lib/ship_engine/models/create_tag_response_body.rb +2 -2
- data/lib/ship_engine/models/create_warehouse_request_body.rb +2 -2
- data/lib/ship_engine/models/create_warehouse_response_body.rb +2 -2
- data/lib/ship_engine/models/create_webhook_request_body.rb +2 -2
- data/lib/ship_engine/models/create_webhook_response_body.rb +2 -2
- data/lib/ship_engine/models/currency.rb +1 -1
- data/lib/ship_engine/models/customs_item.rb +3 -3
- data/lib/ship_engine/models/delivery_confirmation.rb +1 -1
- data/lib/ship_engine/models/deprecated_manifest.rb +2 -2
- data/lib/ship_engine/models/dhl_express_account_settings.rb +2 -2
- data/lib/ship_engine/models/dhl_express_settings_response_body.rb +2 -2
- data/lib/ship_engine/models/dimension_unit.rb +1 -1
- data/lib/ship_engine/models/dimensions.rb +2 -2
- data/lib/ship_engine/models/error.rb +3 -3
- data/lib/ship_engine/models/error_code.rb +1 -1
- data/lib/ship_engine/models/error_response_body.rb +3 -3
- data/lib/ship_engine/models/error_source.rb +1 -1
- data/lib/ship_engine/models/error_type.rb +1 -1
- data/lib/ship_engine/models/estimate_rates_request_body.rb +2 -2
- data/lib/ship_engine/models/fedex_account_settings.rb +2 -2
- data/lib/ship_engine/models/fedex_account_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/fedex_pickup_type.rb +1 -1
- data/lib/ship_engine/models/fedex_settings_response_body.rb +2 -2
- data/lib/ship_engine/models/get_batch_by_external_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_batch_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_carrier_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_carrier_options_response_body.rb +2 -2
- data/lib/ship_engine/models/get_carrier_settings_response_body.rb +2 -2
- data/lib/ship_engine/models/get_carriers_response_body.rb +3 -3
- data/lib/ship_engine/models/get_insurance_balance_response_body.rb +2 -2
- data/lib/ship_engine/models/get_label_by_external_shipment_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_label_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_manifest_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_package_type_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_rate_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_shipment_by_external_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_shipment_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_tracking_log_from_label_response_body.rb +2 -2
- data/lib/ship_engine/models/get_tracking_log_response_body.rb +2 -2
- data/lib/ship_engine/models/get_warehouse_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_webhook_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/insurance_provider.rb +1 -1
- data/lib/ship_engine/models/international_shipment_options.rb +2 -2
- data/lib/ship_engine/models/label.rb +26 -26
- data/lib/ship_engine/models/label_charge_event.rb +1 -1
- data/lib/ship_engine/models/label_download.rb +3 -3
- data/lib/ship_engine/models/label_download_type.rb +1 -1
- data/lib/ship_engine/models/label_format.rb +1 -1
- data/lib/ship_engine/models/label_layout.rb +1 -1
- data/lib/ship_engine/models/label_messages.rb +6 -6
- data/lib/ship_engine/models/label_status.rb +1 -1
- data/lib/ship_engine/models/link.rb +2 -2
- data/lib/ship_engine/models/list_batch_errors_response_body.rb +2 -2
- data/lib/ship_engine/models/list_batches_response_body.rb +2 -2
- data/lib/ship_engine/models/list_carrier_package_types_response_body.rb +2 -2
- data/lib/ship_engine/models/list_carrier_services_response_body.rb +2 -2
- data/lib/ship_engine/models/list_carriers_response_body.rb +2 -2
- data/lib/ship_engine/models/list_labels_response_body.rb +3 -3
- data/lib/ship_engine/models/list_manifests_response_body.rb +2 -2
- data/lib/ship_engine/models/list_package_types_response_body.rb +2 -2
- data/lib/ship_engine/models/list_shipment_errors_response_body.rb +2 -2
- data/lib/ship_engine/models/list_shipment_rates_response_body.rb +2 -2
- data/lib/ship_engine/models/list_shipments_response_body.rb +2 -2
- data/lib/ship_engine/models/list_tags_response_body.rb +2 -2
- data/lib/ship_engine/models/list_warehouses_response_body.rb +2 -2
- data/lib/ship_engine/models/manifest.rb +3 -3
- data/lib/ship_engine/models/manifest_download.rb +2 -2
- data/lib/ship_engine/models/manifests.rb +2 -2
- data/lib/ship_engine/models/modify_batch.rb +2 -2
- data/lib/ship_engine/models/monetary_value.rb +3 -3
- data/lib/ship_engine/models/non_delivery.rb +1 -1
- data/lib/ship_engine/models/optional_link.rb +2 -2
- data/lib/ship_engine/models/order_source_name.rb +1 -1
- data/lib/ship_engine/models/package.rb +5 -5
- data/lib/ship_engine/models/package_contents.rb +1 -1
- data/lib/ship_engine/models/package_type.rb +2 -2
- data/lib/ship_engine/models/paged_list_response_body.rb +3 -3
- data/lib/ship_engine/models/pagination_link.rb +6 -6
- data/lib/ship_engine/models/parse_address_request_body.rb +4 -4
- data/lib/ship_engine/models/parse_address_response_body.rb +6 -6
- data/lib/ship_engine/models/parse_shipment_request_body.rb +4 -4
- data/lib/ship_engine/models/parse_shipment_response_body.rb +6 -6
- data/lib/ship_engine/models/partial_address.rb +10 -10
- data/lib/ship_engine/models/partial_shipment.rb +14 -14
- data/lib/ship_engine/models/payment_amount.rb +2 -2
- data/lib/ship_engine/models/process_batch_request_body.rb +2 -2
- data/lib/ship_engine/models/purchase_label_without_shipment.rb +2 -2
- data/lib/ship_engine/models/rate.rb +4 -4
- data/lib/ship_engine/models/rate_estimate_by_carrier_id.rb +2 -2
- data/lib/ship_engine/models/rate_estimate_by_carrier_ids.rb +2 -2
- data/lib/ship_engine/models/rate_estimate_options.rb +2 -2
- data/lib/ship_engine/models/rate_request_body.rb +2 -2
- data/lib/ship_engine/models/rate_request_by_shipment_ids.rb +2 -2
- data/lib/ship_engine/models/rate_request_by_shipments.rb +2 -2
- data/lib/ship_engine/models/rate_request_options.rb +2 -2
- data/lib/ship_engine/models/rate_request_rate_options.rb +2 -2
- data/lib/ship_engine/models/rate_response.rb +2 -2
- data/lib/ship_engine/models/rate_response_status.rb +1 -1
- data/lib/ship_engine/models/rate_type.rb +1 -1
- data/lib/ship_engine/models/rates_information.rb +2 -2
- data/lib/ship_engine/models/recognized_entity.rb +5 -5
- data/lib/ship_engine/models/remove_from_batch_request_body.rb +2 -2
- data/lib/ship_engine/models/response_message.rb +2 -2
- data/lib/ship_engine/models/service.rb +2 -2
- data/lib/ship_engine/models/shipment.rb +3 -3
- data/lib/ship_engine/models/shipment_id_request.rb +2 -2
- data/lib/ship_engine/models/shipment_item.rb +2 -2
- data/lib/ship_engine/models/shipment_request.rb +2 -2
- data/lib/ship_engine/models/shipment_response_error.rb +2 -2
- data/lib/ship_engine/models/shipment_status.rb +1 -1
- data/lib/ship_engine/models/shipments_sort_by.rb +1 -1
- data/lib/ship_engine/models/smart_post_hub.rb +1 -1
- data/lib/ship_engine/models/sort_dir.rb +1 -1
- data/lib/ship_engine/models/tag.rb +3 -3
- data/lib/ship_engine/models/tag_shipment_response_body.rb +2 -2
- data/lib/ship_engine/models/track_event.rb +2 -2
- data/lib/ship_engine/models/tracking_information.rb +2 -2
- data/lib/ship_engine/models/tracking_status.rb +1 -1
- data/lib/ship_engine/models/update_amazon_buy_shipping_request_body.rb +2 -2
- data/lib/ship_engine/models/update_carrier_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/update_dhl_express_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/update_fedex_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/update_newgistics_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/update_package_type_request_body.rb +2 -2
- data/lib/ship_engine/models/update_shipment_fields.rb +2 -2
- data/lib/ship_engine/models/update_shipment_request_body.rb +13 -13
- data/lib/ship_engine/models/update_shipment_response_body.rb +2 -2
- data/lib/ship_engine/models/update_ups_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/update_warehouse_request_body.rb +2 -2
- data/lib/ship_engine/models/update_webhook_request_body.rb +2 -2
- data/lib/ship_engine/models/ups_account_settings.rb +2 -2
- data/lib/ship_engine/models/ups_invoice.rb +2 -2
- data/lib/ship_engine/models/ups_pickup_type.rb +1 -1
- data/lib/ship_engine/models/ups_settings_response_body.rb +2 -2
- data/lib/ship_engine/models/validate_address.rb +1 -1
- data/lib/ship_engine/models/validate_shipment_fields.rb +2 -2
- data/lib/ship_engine/models/validation_status.rb +1 -1
- data/lib/ship_engine/models/void_label_response_body.rb +2 -2
- data/lib/ship_engine/models/warehouse.rb +2 -2
- data/lib/ship_engine/models/webhook.rb +2 -2
- data/lib/ship_engine/models/webhook_event.rb +1 -1
- data/lib/ship_engine/models/weight.rb +2 -2
- data/lib/ship_engine/models/weight_unit.rb +1 -1
- data/lib/ship_engine/version.rb +2 -2
- data/ship_engine.gemspec +1 -1
- data/spec/api/addresses_api_spec.rb +5 -5
- data/spec/api/batches_api_spec.rb +12 -12
- data/spec/api/carrier_accounts_api_spec.rb +3 -3
- data/spec/api/carriers_api_spec.rb +2 -2
- data/spec/api/downloads_api_spec.rb +5 -5
- data/spec/api/insurance_api_spec.rb +4 -4
- data/spec/api/labels_api_spec.rb +13 -13
- data/spec/api/manifests_api_spec.rb +5 -5
- data/spec/api/package_types_api_spec.rb +3 -3
- data/spec/api/rates_api_spec.rb +5 -5
- data/spec/api/shipments_api_spec.rb +15 -15
- data/spec/api/tags_api_spec.rb +5 -5
- data/spec/api/tracking_api_spec.rb +2 -2
- data/spec/api/warehouses_api_spec.rb +4 -4
- data/spec/api/webhooks_api_spec.rb +3 -3
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/add_funds_to_carrier_request_body_spec.rb +1 -1
- data/spec/models/add_funds_to_carrier_response_body_spec.rb +1 -1
- data/spec/models/add_funds_to_insurance_request_body_spec.rb +1 -1
- data/spec/models/add_funds_to_insurance_response_body_spec.rb +1 -1
- data/spec/models/add_to_batch_request_body_spec.rb +1 -1
- data/spec/models/address_residential_indicator_spec.rb +1 -1
- data/spec/models/address_spec.rb +1 -1
- data/spec/models/address_to_validate_spec.rb +1 -1
- data/spec/models/address_validating_shipment_spec.rb +1 -1
- data/spec/models/address_validation_code_spec.rb +1 -1
- data/spec/models/address_validation_detail_code_spec.rb +1 -1
- data/spec/models/address_validation_message_type_spec.rb +1 -1
- data/spec/models/address_validation_result_spec.rb +1 -1
- data/spec/models/address_validation_status_spec.rb +1 -1
- data/spec/models/advanced_shipment_options_spec.rb +1 -1
- data/spec/models/ancillary_service_endorsement_spec.rb +1 -1
- data/spec/models/batch_response_error_spec.rb +1 -1
- data/spec/models/batch_spec.rb +1 -1
- data/spec/models/batch_status_spec.rb +1 -1
- data/spec/models/batches_sort_by_spec.rb +1 -1
- data/spec/models/bill_to_party_spec.rb +1 -1
- data/spec/models/bulk_rate_spec.rb +1 -1
- data/spec/models/calculate_rates_request_body_spec.rb +1 -1
- data/spec/models/calculate_rates_response_body_spec.rb +1 -1
- data/spec/models/carrier_advanced_option_spec.rb +1 -1
- data/spec/models/carrier_name_spec.rb +1 -1
- data/spec/models/carrier_name_with_settings_spec.rb +1 -1
- data/spec/models/carrier_spec.rb +1 -1
- data/spec/models/collect_on_delivery_payment_type_spec.rb +1 -1
- data/spec/models/collect_on_delivery_spec.rb +1 -1
- data/spec/models/compare_bulk_rates_request_body_spec.rb +1 -1
- data/spec/models/connect_access_worldwide_request_body_spec.rb +1 -1
- data/spec/models/connect_amazon_buy_shipping_request_body_spec.rb +1 -1
- data/spec/models/connect_apc_request_body_spec.rb +1 -1
- data/spec/models/connect_asendia_request_body_spec.rb +1 -1
- data/spec/models/connect_australia_post_request_body_spec.rb +1 -1
- data/spec/models/connect_canada_post_request_body_spec.rb +1 -1
- data/spec/models/connect_carrier_request_body_spec.rb +1 -1
- data/spec/models/connect_carrier_response_body_spec.rb +1 -1
- data/spec/models/connect_dhl_ecommerce_request_body_spec.rb +1 -1
- data/spec/models/connect_dhl_express_au_request_body_spec.rb +1 -1
- data/spec/models/connect_dhl_express_ca_request_body_spec.rb +1 -1
- data/spec/models/connect_dhl_express_request_body_spec.rb +1 -1
- data/spec/models/connect_dhl_express_uk_request_body_spec.rb +1 -1
- data/spec/models/connect_dpd_request_body_spec.rb +1 -1
- data/spec/models/connect_endicia_request_body_spec.rb +1 -1
- data/spec/models/connect_fedex_request_body_spec.rb +1 -1
- data/spec/models/connect_fedex_uk_request_body_spec.rb +1 -1
- data/spec/models/connect_firstmile_request_body_spec.rb +1 -1
- data/spec/models/connect_globegistics_request_body_spec.rb +1 -1
- data/spec/models/connect_imex_request_body_spec.rb +1 -1
- data/spec/models/connect_insurer_request_body_spec.rb +1 -1
- data/spec/models/connect_newgistics_request_body_spec.rb +1 -1
- data/spec/models/connect_ontrac_request_body_spec.rb +1 -1
- data/spec/models/connect_purolator_request_body_spec.rb +1 -1
- data/spec/models/connect_royal_mail_request_body_spec.rb +1 -1
- data/spec/models/connect_rr_donnelley_request_body_spec.rb +1 -1
- data/spec/models/connect_seko_request_body_spec.rb +1 -1
- data/spec/models/connect_sendle_request_body_spec.rb +1 -1
- data/spec/models/connect_stamps_request_body_spec.rb +1 -1
- data/spec/models/connect_ups_request_body_spec.rb +1 -1
- data/spec/models/create_and_validate_shipment_spec.rb +1 -1
- data/spec/models/create_batch_request_body_spec.rb +1 -1
- data/spec/models/create_batch_response_body_spec.rb +1 -1
- data/spec/models/create_label_from_rate_request_body_spec.rb +1 -1
- data/spec/models/create_label_from_rate_response_body_spec.rb +1 -1
- data/spec/models/create_label_from_shipment_request_body_spec.rb +1 -1
- data/spec/models/create_label_from_shipment_response_body_spec.rb +1 -1
- data/spec/models/create_label_request_body_spec.rb +1 -1
- data/spec/models/create_label_response_body_spec.rb +1 -1
- data/spec/models/create_manifest_by_object_request_body_spec.rb +1 -1
- data/spec/models/create_manifest_label_ids_request_body_spec.rb +1 -1
- data/spec/models/create_manifest_request_body_spec.rb +1 -1
- data/spec/models/create_manifest_response_body_spec.rb +1 -1
- data/spec/models/create_package_type_request_body_spec.rb +1 -1
- data/spec/models/create_package_type_response_body_spec.rb +1 -1
- data/spec/models/create_return_label_request_body_spec.rb +1 -1
- data/spec/models/create_return_label_response_body_spec.rb +1 -1
- data/spec/models/create_shipment_response_body_fields_spec.rb +1 -1
- data/spec/models/create_shipments_request_body_spec.rb +1 -1
- data/spec/models/create_shipments_response_body_spec.rb +1 -1
- data/spec/models/create_tag_response_body_spec.rb +1 -1
- data/spec/models/create_warehouse_request_body_spec.rb +1 -1
- data/spec/models/create_warehouse_response_body_spec.rb +1 -1
- data/spec/models/create_webhook_request_body_spec.rb +1 -1
- data/spec/models/create_webhook_response_body_spec.rb +1 -1
- data/spec/models/currency_spec.rb +1 -1
- data/spec/models/customs_item_spec.rb +1 -1
- data/spec/models/delivery_confirmation_spec.rb +1 -1
- data/spec/models/deprecated_manifest_spec.rb +1 -1
- data/spec/models/dhl_express_account_settings_spec.rb +1 -1
- data/spec/models/dhl_express_settings_response_body_spec.rb +1 -1
- data/spec/models/dimension_unit_spec.rb +1 -1
- data/spec/models/dimensions_spec.rb +1 -1
- data/spec/models/error_code_spec.rb +1 -1
- data/spec/models/error_response_body_spec.rb +1 -1
- data/spec/models/error_source_spec.rb +1 -1
- data/spec/models/error_spec.rb +1 -1
- data/spec/models/error_type_spec.rb +1 -1
- data/spec/models/estimate_rates_request_body_spec.rb +1 -1
- data/spec/models/fedex_account_settings_request_body_spec.rb +1 -1
- data/spec/models/fedex_account_settings_spec.rb +1 -1
- data/spec/models/fedex_pickup_type_spec.rb +1 -1
- data/spec/models/fedex_settings_response_body_spec.rb +1 -1
- data/spec/models/get_batch_by_external_id_response_body_spec.rb +1 -1
- data/spec/models/get_batch_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_carrier_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_carrier_options_response_body_spec.rb +1 -1
- data/spec/models/get_carrier_settings_response_body_spec.rb +1 -1
- data/spec/models/get_carriers_response_body_spec.rb +1 -1
- data/spec/models/get_insurance_balance_response_body_spec.rb +1 -1
- data/spec/models/get_label_by_external_shipment_id_response_body_spec.rb +1 -1
- data/spec/models/get_label_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_manifest_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_package_type_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_rate_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_shipment_by_external_id_response_body_spec.rb +1 -1
- data/spec/models/get_shipment_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_tracking_log_from_label_response_body_spec.rb +1 -1
- data/spec/models/get_tracking_log_response_body_spec.rb +1 -1
- data/spec/models/get_warehouse_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_webhook_by_id_response_body_spec.rb +1 -1
- data/spec/models/insurance_provider_spec.rb +1 -1
- data/spec/models/international_shipment_options_spec.rb +1 -1
- data/spec/models/label_charge_event_spec.rb +1 -1
- data/spec/models/label_download_spec.rb +1 -1
- data/spec/models/label_download_type_spec.rb +1 -1
- data/spec/models/label_format_spec.rb +1 -1
- data/spec/models/label_layout_spec.rb +1 -1
- data/spec/models/label_messages_spec.rb +1 -1
- data/spec/models/label_spec.rb +1 -1
- data/spec/models/label_status_spec.rb +1 -1
- data/spec/models/link_spec.rb +1 -1
- data/spec/models/list_batch_errors_response_body_spec.rb +1 -1
- data/spec/models/list_batches_response_body_spec.rb +1 -1
- data/spec/models/list_carrier_package_types_response_body_spec.rb +1 -1
- data/spec/models/list_carrier_services_response_body_spec.rb +1 -1
- data/spec/models/list_carriers_response_body_spec.rb +1 -1
- data/spec/models/list_labels_response_body_spec.rb +1 -1
- data/spec/models/list_manifests_response_body_spec.rb +1 -1
- data/spec/models/list_package_types_response_body_spec.rb +1 -1
- data/spec/models/list_shipment_errors_response_body_spec.rb +1 -1
- data/spec/models/list_shipment_rates_response_body_spec.rb +1 -1
- data/spec/models/list_shipments_response_body_spec.rb +1 -1
- data/spec/models/list_tags_response_body_spec.rb +1 -1
- data/spec/models/list_warehouses_response_body_spec.rb +1 -1
- data/spec/models/manifest_download_spec.rb +1 -1
- data/spec/models/manifest_spec.rb +1 -1
- data/spec/models/manifests_spec.rb +1 -1
- data/spec/models/modify_batch_spec.rb +1 -1
- data/spec/models/monetary_value_spec.rb +1 -1
- data/spec/models/non_delivery_spec.rb +1 -1
- data/spec/models/optional_link_spec.rb +1 -1
- data/spec/models/order_source_name_spec.rb +1 -1
- data/spec/models/package_contents_spec.rb +1 -1
- data/spec/models/package_spec.rb +1 -1
- data/spec/models/package_type_spec.rb +1 -1
- data/spec/models/paged_list_response_body_spec.rb +1 -1
- data/spec/models/pagination_link_spec.rb +1 -1
- data/spec/models/parse_address_request_body_spec.rb +1 -1
- data/spec/models/parse_address_response_body_spec.rb +1 -1
- data/spec/models/parse_shipment_request_body_spec.rb +1 -1
- data/spec/models/parse_shipment_response_body_spec.rb +1 -1
- data/spec/models/partial_address_spec.rb +1 -1
- data/spec/models/partial_shipment_spec.rb +1 -1
- data/spec/models/payment_amount_spec.rb +1 -1
- data/spec/models/process_batch_request_body_spec.rb +1 -1
- data/spec/models/purchase_label_without_shipment_spec.rb +1 -1
- data/spec/models/rate_estimate_by_carrier_id_spec.rb +1 -1
- data/spec/models/rate_estimate_by_carrier_ids_spec.rb +1 -1
- data/spec/models/rate_estimate_options_spec.rb +1 -1
- data/spec/models/rate_request_body_spec.rb +1 -1
- data/spec/models/rate_request_by_shipment_ids_spec.rb +1 -1
- data/spec/models/rate_request_by_shipments_spec.rb +1 -1
- data/spec/models/rate_request_options_spec.rb +1 -1
- data/spec/models/rate_request_rate_options_spec.rb +1 -1
- data/spec/models/rate_response_spec.rb +1 -1
- data/spec/models/rate_response_status_spec.rb +1 -1
- data/spec/models/rate_spec.rb +1 -1
- data/spec/models/rate_type_spec.rb +1 -1
- data/spec/models/rates_information_spec.rb +1 -1
- data/spec/models/recognized_entity_spec.rb +1 -1
- data/spec/models/remove_from_batch_request_body_spec.rb +1 -1
- data/spec/models/response_message_spec.rb +1 -1
- data/spec/models/service_spec.rb +1 -1
- data/spec/models/shipment_id_request_spec.rb +1 -1
- data/spec/models/shipment_item_spec.rb +1 -1
- data/spec/models/shipment_request_spec.rb +1 -1
- data/spec/models/shipment_response_error_spec.rb +1 -1
- data/spec/models/shipment_spec.rb +1 -1
- data/spec/models/shipment_status_spec.rb +1 -1
- data/spec/models/shipments_sort_by_spec.rb +1 -1
- data/spec/models/smart_post_hub_spec.rb +1 -1
- data/spec/models/sort_dir_spec.rb +1 -1
- data/spec/models/tag_shipment_response_body_spec.rb +1 -1
- data/spec/models/tag_spec.rb +1 -1
- data/spec/models/track_event_spec.rb +1 -1
- data/spec/models/tracking_information_spec.rb +1 -1
- data/spec/models/tracking_status_spec.rb +1 -1
- data/spec/models/update_amazon_buy_shipping_request_body_spec.rb +1 -1
- data/spec/models/update_carrier_settings_request_body_spec.rb +1 -1
- data/spec/models/update_dhl_express_settings_request_body_spec.rb +1 -1
- data/spec/models/update_fedex_settings_request_body_spec.rb +1 -1
- data/spec/models/update_newgistics_settings_request_body_spec.rb +1 -1
- data/spec/models/update_package_type_request_body_spec.rb +1 -1
- data/spec/models/update_shipment_fields_spec.rb +1 -1
- data/spec/models/update_shipment_request_body_spec.rb +1 -1
- data/spec/models/update_shipment_response_body_spec.rb +1 -1
- data/spec/models/update_ups_settings_request_body_spec.rb +1 -1
- data/spec/models/update_warehouse_request_body_spec.rb +1 -1
- data/spec/models/update_webhook_request_body_spec.rb +1 -1
- data/spec/models/ups_account_settings_spec.rb +1 -1
- data/spec/models/ups_invoice_spec.rb +1 -1
- data/spec/models/ups_pickup_type_spec.rb +1 -1
- data/spec/models/ups_settings_response_body_spec.rb +1 -1
- data/spec/models/validate_address_spec.rb +1 -1
- data/spec/models/validate_shipment_fields_spec.rb +1 -1
- data/spec/models/validation_status_spec.rb +1 -1
- data/spec/models/void_label_response_body_spec.rb +1 -1
- data/spec/models/warehouse_spec.rb +1 -1
- data/spec/models/webhook_event_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +1 -1
- data/spec/models/weight_spec.rb +1 -1
- data/spec/models/weight_unit_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +2 -3
- data/ship_engine-1.0.0.gem +0 -0
- data/ship_engine-1.0.1.gem +0 -0
|
@@ -2,9 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
8
7
|
|
|
9
8
|
## Code Sample
|
|
10
9
|
|
|
@@ -13,3 +12,5 @@ require 'ShipEngine'
|
|
|
13
12
|
|
|
14
13
|
instance = ShipEngine::AncillaryServiceEndorsement.new()
|
|
15
14
|
```
|
|
15
|
+
|
|
16
|
+
|
data/docs/Batch.md
CHANGED
|
@@ -2,26 +2,26 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**label_layout** | [**LabelLayout**](LabelLayout.md) | label layout | [readonly]
|
|
8
|
+
**label_format** | [**LabelFormat**](LabelFormat.md) | | [readonly]
|
|
9
|
+
**batch_id** | **String** | A string that uniquely identifies the batch | [readonly]
|
|
10
|
+
**external_batch_id** | **String** | A string that uniquely identifies the external batch | [readonly]
|
|
11
|
+
**batch_notes** | **String** | Custom notes you can add for each created batch | [readonly] [default to '']
|
|
12
|
+
**created_at** | **DateTime** | The date and time the batch was created in ShipEngine | [readonly]
|
|
13
|
+
**processed_at** | **DateTime** | The date and time the batch was processed in ShipEngine | [readonly]
|
|
14
|
+
**errors** | **Integer** | The number of errors that occurred while generating the batch | [readonly]
|
|
15
|
+
**warnings** | **Integer** | The number of warnings that occurred while generating the batch | [readonly]
|
|
16
|
+
**completed** | **Integer** | The number of labels generated in the batch | [readonly]
|
|
17
|
+
**forms** | **Integer** | The number of forms for customs that are available for download | [readonly]
|
|
18
|
+
**count** | **Integer** | The total of errors, warnings, and completed properties | [readonly]
|
|
19
|
+
**batch_shipments_url** | [**OptionalLink**](OptionalLink.md) | The batch shipments endpoint |
|
|
20
|
+
**batch_labels_url** | [**OptionalLink**](OptionalLink.md) | Link to batch labels query |
|
|
21
|
+
**batch_errors_url** | [**OptionalLink**](OptionalLink.md) | Link to batch errors endpoint | [readonly]
|
|
22
|
+
**label_download** | [**LabelDownload**](LabelDownload.md) | The label download for the batch | [readonly]
|
|
23
|
+
**form_download** | [**OptionalLink**](OptionalLink.md) | The form download for any customs that are needed | [readonly]
|
|
24
|
+
**status** | [**BatchStatus**](BatchStatus.md) | | [readonly]
|
|
25
25
|
|
|
26
26
|
## Code Sample
|
|
27
27
|
|
|
@@ -47,3 +47,5 @@ instance = ShipEngine::Batch.new(label_layout: null,
|
|
|
47
47
|
form_download: null,
|
|
48
48
|
status: null)
|
|
49
49
|
```
|
|
50
|
+
|
|
51
|
+
|
data/docs/BatchResponseError.md
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**error** | **String** | Error message associated with the shipment. | [optional] [readonly]
|
|
8
|
+
**shipment_id** | **String** | A string that uniquely identifies the shipment | [optional] [readonly]
|
|
9
9
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
|
@@ -15,3 +15,5 @@ require 'ShipEngine'
|
|
|
15
15
|
instance = ShipEngine::BatchResponseError.new(error: Recipient address has not been verified.,
|
|
16
16
|
shipment_id: null)
|
|
17
17
|
```
|
|
18
|
+
|
|
19
|
+
|
data/docs/BatchStatus.md
CHANGED
|
@@ -2,9 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
8
7
|
|
|
9
8
|
## Code Sample
|
|
10
9
|
|
|
@@ -13,3 +12,5 @@ require 'ShipEngine'
|
|
|
13
12
|
|
|
14
13
|
instance = ShipEngine::BatchStatus.new()
|
|
15
14
|
```
|
|
15
|
+
|
|
16
|
+
|
data/docs/BatchesApi.md
CHANGED
|
@@ -2,18 +2,20 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://api.shipengine.com*
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**add_to_batch**](BatchesApi.md#add_to_batch) | **POST** /v1/batches/{batch_id}/add | Add to a Batch
|
|
8
|
+
[**create_batch**](BatchesApi.md#create_batch) | **POST** /v1/batches | Create A Batch
|
|
9
|
+
[**delete_batch**](BatchesApi.md#delete_batch) | **DELETE** /v1/batches/{batch_id} | Delete Batch By Id
|
|
10
|
+
[**get_batch_by_external_id**](BatchesApi.md#get_batch_by_external_id) | **GET** /v1/batches/external_batch_id/{external_batch_id} | Get Batch By External ID
|
|
11
|
+
[**get_batch_by_id**](BatchesApi.md#get_batch_by_id) | **GET** /v1/batches/{batch_id} | Get Batch By ID
|
|
12
|
+
[**list_batch_errors**](BatchesApi.md#list_batch_errors) | **GET** /v1/batches/{batch_id}/errors | Get Batch Errors
|
|
13
|
+
[**list_batches**](BatchesApi.md#list_batches) | **GET** /v1/batches | List Batches
|
|
14
|
+
[**process_batch**](BatchesApi.md#process_batch) | **POST** /v1/batches/{batch_id}/process/labels | Process Batch ID Labels
|
|
15
|
+
[**remove_from_batch**](BatchesApi.md#remove_from_batch) | **POST** /v1/batches/{batch_id}/remove | Remove From Batch
|
|
16
|
+
[**update_batch**](BatchesApi.md#update_batch) | **PUT** /v1/batches/{batch_id} | Update Batch By Id
|
|
17
|
+
|
|
18
|
+
|
|
17
19
|
|
|
18
20
|
## add_to_batch
|
|
19
21
|
|
|
@@ -27,7 +29,7 @@ Add a Shipment or Rate to a Batch
|
|
|
27
29
|
|
|
28
30
|
```ruby
|
|
29
31
|
# load the gem
|
|
30
|
-
require '
|
|
32
|
+
require 'ship_engine'
|
|
31
33
|
# setup authorization
|
|
32
34
|
ShipEngine.configure do |config|
|
|
33
35
|
# Configure API key authorization: api_key
|
|
@@ -38,7 +40,7 @@ end
|
|
|
38
40
|
|
|
39
41
|
api_instance = ShipEngine::BatchesApi.new
|
|
40
42
|
batch_id = 'batch_id_example' # String | Batch ID
|
|
41
|
-
add_to_batch_request_body = ShipEngine::AddToBatchRequestBody.new # AddToBatchRequestBody |
|
|
43
|
+
add_to_batch_request_body = ShipEngine::AddToBatchRequestBody.new # AddToBatchRequestBody |
|
|
42
44
|
|
|
43
45
|
begin
|
|
44
46
|
#Add to a Batch
|
|
@@ -51,10 +53,11 @@ end
|
|
|
51
53
|
|
|
52
54
|
### Parameters
|
|
53
55
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
56
|
+
|
|
57
|
+
Name | Type | Description | Notes
|
|
58
|
+
------------- | ------------- | ------------- | -------------
|
|
59
|
+
**batch_id** | **String**| Batch ID |
|
|
60
|
+
**add_to_batch_request_body** | [**AddToBatchRequestBody**](AddToBatchRequestBody.md)| |
|
|
58
61
|
|
|
59
62
|
### Return type
|
|
60
63
|
|
|
@@ -69,6 +72,7 @@ end
|
|
|
69
72
|
- **Content-Type**: application/json
|
|
70
73
|
- **Accept**: text/plain, application/json
|
|
71
74
|
|
|
75
|
+
|
|
72
76
|
## create_batch
|
|
73
77
|
|
|
74
78
|
> CreateBatchResponseBody create_batch(create_batch_request_body)
|
|
@@ -81,7 +85,7 @@ Create a Batch
|
|
|
81
85
|
|
|
82
86
|
```ruby
|
|
83
87
|
# load the gem
|
|
84
|
-
require '
|
|
88
|
+
require 'ship_engine'
|
|
85
89
|
# setup authorization
|
|
86
90
|
ShipEngine.configure do |config|
|
|
87
91
|
# Configure API key authorization: api_key
|
|
@@ -91,7 +95,7 @@ ShipEngine.configure do |config|
|
|
|
91
95
|
end
|
|
92
96
|
|
|
93
97
|
api_instance = ShipEngine::BatchesApi.new
|
|
94
|
-
create_batch_request_body = ShipEngine::CreateBatchRequestBody.new # CreateBatchRequestBody |
|
|
98
|
+
create_batch_request_body = ShipEngine::CreateBatchRequestBody.new # CreateBatchRequestBody |
|
|
95
99
|
|
|
96
100
|
begin
|
|
97
101
|
#Create A Batch
|
|
@@ -104,9 +108,10 @@ end
|
|
|
104
108
|
|
|
105
109
|
### Parameters
|
|
106
110
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
|
111
|
+
|
|
112
|
+
Name | Type | Description | Notes
|
|
113
|
+
------------- | ------------- | ------------- | -------------
|
|
114
|
+
**create_batch_request_body** | [**CreateBatchRequestBody**](CreateBatchRequestBody.md)| |
|
|
110
115
|
|
|
111
116
|
### Return type
|
|
112
117
|
|
|
@@ -121,6 +126,7 @@ end
|
|
|
121
126
|
- **Content-Type**: application/json
|
|
122
127
|
- **Accept**: application/json
|
|
123
128
|
|
|
129
|
+
|
|
124
130
|
## delete_batch
|
|
125
131
|
|
|
126
132
|
> String delete_batch(batch_id)
|
|
@@ -133,7 +139,7 @@ Delete Batch By Id
|
|
|
133
139
|
|
|
134
140
|
```ruby
|
|
135
141
|
# load the gem
|
|
136
|
-
require '
|
|
142
|
+
require 'ship_engine'
|
|
137
143
|
# setup authorization
|
|
138
144
|
ShipEngine.configure do |config|
|
|
139
145
|
# Configure API key authorization: api_key
|
|
@@ -156,9 +162,10 @@ end
|
|
|
156
162
|
|
|
157
163
|
### Parameters
|
|
158
164
|
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
|
165
|
+
|
|
166
|
+
Name | Type | Description | Notes
|
|
167
|
+
------------- | ------------- | ------------- | -------------
|
|
168
|
+
**batch_id** | **String**| Batch ID |
|
|
162
169
|
|
|
163
170
|
### Return type
|
|
164
171
|
|
|
@@ -173,6 +180,7 @@ end
|
|
|
173
180
|
- **Content-Type**: Not defined
|
|
174
181
|
- **Accept**: text/plain, application/json
|
|
175
182
|
|
|
183
|
+
|
|
176
184
|
## get_batch_by_external_id
|
|
177
185
|
|
|
178
186
|
> GetBatchByExternalIdResponseBody get_batch_by_external_id(external_batch_id)
|
|
@@ -185,7 +193,7 @@ Get Batch By External ID
|
|
|
185
193
|
|
|
186
194
|
```ruby
|
|
187
195
|
# load the gem
|
|
188
|
-
require '
|
|
196
|
+
require 'ship_engine'
|
|
189
197
|
# setup authorization
|
|
190
198
|
ShipEngine.configure do |config|
|
|
191
199
|
# Configure API key authorization: api_key
|
|
@@ -195,7 +203,7 @@ ShipEngine.configure do |config|
|
|
|
195
203
|
end
|
|
196
204
|
|
|
197
205
|
api_instance = ShipEngine::BatchesApi.new
|
|
198
|
-
external_batch_id = '13553d7f-3c87-4771-bae1-c49bacef11cb' # String |
|
|
206
|
+
external_batch_id = '13553d7f-3c87-4771-bae1-c49bacef11cb' # String |
|
|
199
207
|
|
|
200
208
|
begin
|
|
201
209
|
#Get Batch By External ID
|
|
@@ -208,9 +216,10 @@ end
|
|
|
208
216
|
|
|
209
217
|
### Parameters
|
|
210
218
|
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
|
219
|
+
|
|
220
|
+
Name | Type | Description | Notes
|
|
221
|
+
------------- | ------------- | ------------- | -------------
|
|
222
|
+
**external_batch_id** | **String**| |
|
|
214
223
|
|
|
215
224
|
### Return type
|
|
216
225
|
|
|
@@ -225,6 +234,7 @@ end
|
|
|
225
234
|
- **Content-Type**: Not defined
|
|
226
235
|
- **Accept**: application/json
|
|
227
236
|
|
|
237
|
+
|
|
228
238
|
## get_batch_by_id
|
|
229
239
|
|
|
230
240
|
> GetBatchByIdResponseBody get_batch_by_id(batch_id)
|
|
@@ -237,7 +247,7 @@ Get Batch By ID
|
|
|
237
247
|
|
|
238
248
|
```ruby
|
|
239
249
|
# load the gem
|
|
240
|
-
require '
|
|
250
|
+
require 'ship_engine'
|
|
241
251
|
# setup authorization
|
|
242
252
|
ShipEngine.configure do |config|
|
|
243
253
|
# Configure API key authorization: api_key
|
|
@@ -260,9 +270,10 @@ end
|
|
|
260
270
|
|
|
261
271
|
### Parameters
|
|
262
272
|
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
|
273
|
+
|
|
274
|
+
Name | Type | Description | Notes
|
|
275
|
+
------------- | ------------- | ------------- | -------------
|
|
276
|
+
**batch_id** | **String**| Batch ID |
|
|
266
277
|
|
|
267
278
|
### Return type
|
|
268
279
|
|
|
@@ -277,19 +288,20 @@ end
|
|
|
277
288
|
- **Content-Type**: Not defined
|
|
278
289
|
- **Accept**: application/json
|
|
279
290
|
|
|
291
|
+
|
|
280
292
|
## list_batch_errors
|
|
281
293
|
|
|
282
294
|
> ListBatchErrorsResponseBody list_batch_errors(batch_id, opts)
|
|
283
295
|
|
|
284
296
|
Get Batch Errors
|
|
285
297
|
|
|
286
|
-
Error handling in batches are handled differently than in a single synchronous request. You must retrieve the status of your batch by [getting a batch](https://www.shipengine.com/docs/reference/get-batch-by-id/) and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors.
|
|
298
|
+
Error handling in batches are handled differently than in a single synchronous request. You must retrieve the status of your batch by [getting a batch](https://www.shipengine.com/docs/reference/get-batch-by-id/) and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors.
|
|
287
299
|
|
|
288
300
|
### Example
|
|
289
301
|
|
|
290
302
|
```ruby
|
|
291
303
|
# load the gem
|
|
292
|
-
require '
|
|
304
|
+
require 'ship_engine'
|
|
293
305
|
# setup authorization
|
|
294
306
|
ShipEngine.configure do |config|
|
|
295
307
|
# Configure API key authorization: api_key
|
|
@@ -301,8 +313,8 @@ end
|
|
|
301
313
|
api_instance = ShipEngine::BatchesApi.new
|
|
302
314
|
batch_id = 'batch_id_example' # String | Batch ID
|
|
303
315
|
opts = {
|
|
304
|
-
page: 1, # Integer | 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.
|
|
305
|
-
pagesize: 56 # Integer |
|
|
316
|
+
page: 1, # Integer | 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.
|
|
317
|
+
pagesize: 56 # Integer |
|
|
306
318
|
}
|
|
307
319
|
|
|
308
320
|
begin
|
|
@@ -316,11 +328,12 @@ end
|
|
|
316
328
|
|
|
317
329
|
### Parameters
|
|
318
330
|
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
|
322
|
-
|
|
323
|
-
|
|
331
|
+
|
|
332
|
+
Name | Type | Description | Notes
|
|
333
|
+
------------- | ------------- | ------------- | -------------
|
|
334
|
+
**batch_id** | **String**| Batch ID |
|
|
335
|
+
**page** | **Integer**| 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. | [optional] [default to 1]
|
|
336
|
+
**pagesize** | **Integer**| | [optional]
|
|
324
337
|
|
|
325
338
|
### Return type
|
|
326
339
|
|
|
@@ -335,6 +348,7 @@ end
|
|
|
335
348
|
- **Content-Type**: Not defined
|
|
336
349
|
- **Accept**: application/json
|
|
337
350
|
|
|
351
|
+
|
|
338
352
|
## list_batches
|
|
339
353
|
|
|
340
354
|
> ListBatchesResponseBody list_batches(opts)
|
|
@@ -347,7 +361,7 @@ List Batches associated with your Shipengine account
|
|
|
347
361
|
|
|
348
362
|
```ruby
|
|
349
363
|
# load the gem
|
|
350
|
-
require '
|
|
364
|
+
require 'ship_engine'
|
|
351
365
|
# setup authorization
|
|
352
366
|
ShipEngine.configure do |config|
|
|
353
367
|
# Configure API key authorization: api_key
|
|
@@ -358,11 +372,11 @@ end
|
|
|
358
372
|
|
|
359
373
|
api_instance = ShipEngine::BatchesApi.new
|
|
360
374
|
opts = {
|
|
361
|
-
status: ShipEngine::BatchStatus.new, # BatchStatus |
|
|
362
|
-
page: 1, # Integer | 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.
|
|
375
|
+
status: ShipEngine::BatchStatus.new, # BatchStatus |
|
|
376
|
+
page: 1, # Integer | 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.
|
|
363
377
|
page_size: 25, # Integer | The number of results to return per response.
|
|
364
378
|
sort_dir: ShipEngine::SortDir.new, # SortDir | Controls the sort order of the query.
|
|
365
|
-
sort_by: ShipEngine::BatchesSortBy.new # BatchesSortBy |
|
|
379
|
+
sort_by: ShipEngine::BatchesSortBy.new # BatchesSortBy |
|
|
366
380
|
}
|
|
367
381
|
|
|
368
382
|
begin
|
|
@@ -376,13 +390,14 @@ end
|
|
|
376
390
|
|
|
377
391
|
### Parameters
|
|
378
392
|
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
393
|
+
|
|
394
|
+
Name | Type | Description | Notes
|
|
395
|
+
------------- | ------------- | ------------- | -------------
|
|
396
|
+
**status** | [**BatchStatus**](.md)| | [optional]
|
|
397
|
+
**page** | **Integer**| 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. | [optional] [default to 1]
|
|
398
|
+
**page_size** | **Integer**| The number of results to return per response. | [optional] [default to 25]
|
|
399
|
+
**sort_dir** | [**SortDir**](.md)| Controls the sort order of the query. | [optional]
|
|
400
|
+
**sort_by** | [**BatchesSortBy**](.md)| | [optional]
|
|
386
401
|
|
|
387
402
|
### Return type
|
|
388
403
|
|
|
@@ -397,6 +412,7 @@ end
|
|
|
397
412
|
- **Content-Type**: Not defined
|
|
398
413
|
- **Accept**: application/json
|
|
399
414
|
|
|
415
|
+
|
|
400
416
|
## process_batch
|
|
401
417
|
|
|
402
418
|
> String process_batch(batch_id, process_batch_request_body)
|
|
@@ -409,7 +425,7 @@ Process Batch ID Labels
|
|
|
409
425
|
|
|
410
426
|
```ruby
|
|
411
427
|
# load the gem
|
|
412
|
-
require '
|
|
428
|
+
require 'ship_engine'
|
|
413
429
|
# setup authorization
|
|
414
430
|
ShipEngine.configure do |config|
|
|
415
431
|
# Configure API key authorization: api_key
|
|
@@ -420,7 +436,7 @@ end
|
|
|
420
436
|
|
|
421
437
|
api_instance = ShipEngine::BatchesApi.new
|
|
422
438
|
batch_id = 'batch_id_example' # String | Batch ID
|
|
423
|
-
process_batch_request_body = ShipEngine::ProcessBatchRequestBody.new # ProcessBatchRequestBody |
|
|
439
|
+
process_batch_request_body = ShipEngine::ProcessBatchRequestBody.new # ProcessBatchRequestBody |
|
|
424
440
|
|
|
425
441
|
begin
|
|
426
442
|
#Process Batch ID Labels
|
|
@@ -433,10 +449,11 @@ end
|
|
|
433
449
|
|
|
434
450
|
### Parameters
|
|
435
451
|
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
452
|
+
|
|
453
|
+
Name | Type | Description | Notes
|
|
454
|
+
------------- | ------------- | ------------- | -------------
|
|
455
|
+
**batch_id** | **String**| Batch ID |
|
|
456
|
+
**process_batch_request_body** | [**ProcessBatchRequestBody**](ProcessBatchRequestBody.md)| |
|
|
440
457
|
|
|
441
458
|
### Return type
|
|
442
459
|
|
|
@@ -451,6 +468,7 @@ end
|
|
|
451
468
|
- **Content-Type**: application/json
|
|
452
469
|
- **Accept**: text/plain, application/json
|
|
453
470
|
|
|
471
|
+
|
|
454
472
|
## remove_from_batch
|
|
455
473
|
|
|
456
474
|
> String remove_from_batch(batch_id, remove_from_batch_request_body)
|
|
@@ -463,7 +481,7 @@ Remove a shipment or rate from a batch
|
|
|
463
481
|
|
|
464
482
|
```ruby
|
|
465
483
|
# load the gem
|
|
466
|
-
require '
|
|
484
|
+
require 'ship_engine'
|
|
467
485
|
# setup authorization
|
|
468
486
|
ShipEngine.configure do |config|
|
|
469
487
|
# Configure API key authorization: api_key
|
|
@@ -474,7 +492,7 @@ end
|
|
|
474
492
|
|
|
475
493
|
api_instance = ShipEngine::BatchesApi.new
|
|
476
494
|
batch_id = 'batch_id_example' # String | Batch ID
|
|
477
|
-
remove_from_batch_request_body = ShipEngine::RemoveFromBatchRequestBody.new # RemoveFromBatchRequestBody |
|
|
495
|
+
remove_from_batch_request_body = ShipEngine::RemoveFromBatchRequestBody.new # RemoveFromBatchRequestBody |
|
|
478
496
|
|
|
479
497
|
begin
|
|
480
498
|
#Remove From Batch
|
|
@@ -487,10 +505,11 @@ end
|
|
|
487
505
|
|
|
488
506
|
### Parameters
|
|
489
507
|
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
508
|
+
|
|
509
|
+
Name | Type | Description | Notes
|
|
510
|
+
------------- | ------------- | ------------- | -------------
|
|
511
|
+
**batch_id** | **String**| Batch ID |
|
|
512
|
+
**remove_from_batch_request_body** | [**RemoveFromBatchRequestBody**](RemoveFromBatchRequestBody.md)| |
|
|
494
513
|
|
|
495
514
|
### Return type
|
|
496
515
|
|
|
@@ -505,6 +524,7 @@ end
|
|
|
505
524
|
- **Content-Type**: application/json
|
|
506
525
|
- **Accept**: text/plain, application/json
|
|
507
526
|
|
|
527
|
+
|
|
508
528
|
## update_batch
|
|
509
529
|
|
|
510
530
|
> String update_batch(batch_id)
|
|
@@ -517,7 +537,7 @@ Update Batch By Id
|
|
|
517
537
|
|
|
518
538
|
```ruby
|
|
519
539
|
# load the gem
|
|
520
|
-
require '
|
|
540
|
+
require 'ship_engine'
|
|
521
541
|
# setup authorization
|
|
522
542
|
ShipEngine.configure do |config|
|
|
523
543
|
# Configure API key authorization: api_key
|
|
@@ -540,9 +560,10 @@ end
|
|
|
540
560
|
|
|
541
561
|
### Parameters
|
|
542
562
|
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
|
563
|
+
|
|
564
|
+
Name | Type | Description | Notes
|
|
565
|
+
------------- | ------------- | ------------- | -------------
|
|
566
|
+
**batch_id** | **String**| Batch ID |
|
|
546
567
|
|
|
547
568
|
### Return type
|
|
548
569
|
|
|
@@ -556,3 +577,4 @@ end
|
|
|
556
577
|
|
|
557
578
|
- **Content-Type**: Not defined
|
|
558
579
|
- **Accept**: text/plain, application/json
|
|
580
|
+
|