zippendo 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE.md +21 -0
- data/README.md +99 -0
- data/Rakefile +10 -0
- data/docs/AddressesApi.md +375 -0
- data/docs/BatchSendShipments200Response.md +20 -0
- data/docs/BatchSendShipments200ResponseResultsInner.md +26 -0
- data/docs/BatchSendShipments200ResponseSummary.md +22 -0
- data/docs/BatchSendShipmentsRequest.md +18 -0
- data/docs/BatchSplitShipment201Response.md +20 -0
- data/docs/BatchSplitShipmentRequest.md +28 -0
- data/docs/BatchSplitShipmentRequestShipmentsInner.md +20 -0
- data/docs/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.md +20 -0
- data/docs/BillingApi.md +77 -0
- data/docs/CarrierCatalogApi.md +77 -0
- data/docs/CarriersApi.md +521 -0
- data/docs/ConnectCarrierRequest.md +22 -0
- data/docs/CreateAddressRequest.md +40 -0
- data/docs/CreateApiToken201Response.md +32 -0
- data/docs/CreateApiTokenRequest.md +22 -0
- data/docs/CreateOrder201Response.md +52 -0
- data/docs/CreateOrder201ResponseOrderLinesInner.md +54 -0
- data/docs/CreateOrder201ResponseShippingAddress.md +42 -0
- data/docs/CreateOrderRequest.md +40 -0
- data/docs/CreateOrderRequestOrderLinesInner.md +54 -0
- data/docs/CreateOrderRequestShippingAddress.md +42 -0
- data/docs/CreateOrgWebhook201Response.md +32 -0
- data/docs/CreateOrgWebhookRequest.md +24 -0
- data/docs/CreateShipment201Response.md +64 -0
- data/docs/CreateShipment201ResponseActivitiesInner.md +26 -0
- data/docs/CreateShipment201ResponseDocumentsInner.md +32 -0
- data/docs/CreateShipment201ResponseErrorsInner.md +26 -0
- data/docs/CreateShipment201ResponseLogsInner.md +32 -0
- data/docs/CreateShipment201ResponseParcelsInner.md +38 -0
- data/docs/CreateShipment201ResponseParcelsInnerDimensions.md +22 -0
- data/docs/CreateShipment201ResponseParcelsInnerOrderLinesInner.md +36 -0
- data/docs/CreateShipment201ResponsePartiesInner.md +38 -0
- data/docs/CreateShipment201ResponsePartiesInnerAttributesInner.md +20 -0
- data/docs/CreateShipment201ResponsePickupDetails.md +24 -0
- data/docs/CreateShipment201ResponseShippingRule.md +40 -0
- data/docs/CreateShipment201ResponseTracking.md +28 -0
- data/docs/CreateShipmentRequest.md +42 -0
- data/docs/CreateShipmentRequestCarrierSettings.md +24 -0
- data/docs/CreateShipmentRequestParcelsInner.md +38 -0
- data/docs/CreateShipmentRequestParcelsInnerDimensions.md +22 -0
- data/docs/CreateShipmentRequestParcelsInnerOrderLinesInner.md +36 -0
- data/docs/CreateShipmentRequestPartiesInner.md +38 -0
- data/docs/CreateShipmentRequestPartiesInnerAttributesInner.md +20 -0
- data/docs/CreateShipmentRequestPickupDetails.md +24 -0
- data/docs/CreateShippingQuote200Response.md +18 -0
- data/docs/CreateShippingQuote200ResponseRatesInner.md +38 -0
- data/docs/CreateShippingQuote400Response.md +20 -0
- data/docs/CreateShippingQuote404Response.md +20 -0
- data/docs/CreateShippingQuoteRequest.md +24 -0
- data/docs/CreateShippingQuoteRequestDestination.md +28 -0
- data/docs/CreateShippingQuoteRequestItemsInner.md +30 -0
- data/docs/CreateShippingRule201Response.md +74 -0
- data/docs/CreateShippingRuleRequest.md +66 -0
- data/docs/CreateShippingRuleRequestAdditionalParameters.md +15 -0
- data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfInner.md +20 -0
- data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfValue.md +24 -0
- data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.md +24 -0
- data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.md +15 -0
- data/docs/CreateShippingRuleRequestConditionsInner.md +55 -0
- data/docs/CreateShippingRuleRequestConditionsInnerOneOf.md +26 -0
- data/docs/CreateShippingRuleRequestConditionsInnerOneOf1.md +28 -0
- data/docs/CreateShippingRuleRequestConditionsInnerOneOf2.md +28 -0
- data/docs/CreateShippingRuleRequestConditionsInnerOneOf3.md +26 -0
- data/docs/CreateShippingRuleRequestConditionsInnerOneOf4.md +22 -0
- data/docs/DeleteOrgWebhook200Response.md +18 -0
- data/docs/DeleteShippingRule200Response.md +18 -0
- data/docs/GetBillingUsage200Response.md +24 -0
- data/docs/GetBillingUsage200ResponseAddOnsInner.md +24 -0
- data/docs/GetBillingUsage200ResponseCurrentPeriod.md +20 -0
- data/docs/GetBillingUsage200ResponseLimits.md +30 -0
- data/docs/GetBillingUsage200ResponseLimitsTeamMembers.md +20 -0
- data/docs/GetBillingUsage200ResponseShipments.md +24 -0
- data/docs/GetOrder200Response.md +58 -0
- data/docs/GetOrder200ResponseShipmentsInner.md +36 -0
- data/docs/GetOrder200ResponseShippingRule.md +40 -0
- data/docs/GetOrg200Response.md +50 -0
- data/docs/GetOrg200ResponseCount.md +18 -0
- data/docs/GetOrgBranding200Response.md +22 -0
- data/docs/HealthCheck200Response.md +22 -0
- data/docs/ListAddresses200Response.md +26 -0
- data/docs/ListAddresses200ResponseDataInner.md +48 -0
- data/docs/ListApiTokens200Response.md +26 -0
- data/docs/ListApiTokens200ResponseDataInner.md +32 -0
- data/docs/ListApiTokens200ResponseDataInnerCreatedBy.md +22 -0
- data/docs/ListApiTokens401Response.md +22 -0
- data/docs/ListAvailableCarriers200ResponseInner.md +38 -0
- data/docs/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.md +28 -0
- data/docs/ListCarrierProductServicePoints200ResponseInner.md +32 -0
- data/docs/ListCarrierProductServicePoints200ResponseInnerAddress.md +28 -0
- data/docs/ListCarrierProductServicePointsRequest.md +28 -0
- data/docs/ListCarrierProducts200ResponseInner.md +38 -0
- data/docs/ListCarrierProducts200ResponseInnerAdditionalParametersInner.md +30 -0
- data/docs/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.md +22 -0
- data/docs/ListCarrierProducts200ResponseInnerServicesInner.md +20 -0
- data/docs/ListCarrierProducts200ResponseInnerWeightLimits.md +22 -0
- data/docs/ListCarriers200Response.md +26 -0
- data/docs/ListCarriers200ResponseDataInner.md +38 -0
- data/docs/ListCarriers200ResponseDataInnerConfigValue.md +15 -0
- data/docs/ListOrders200Response.md +26 -0
- data/docs/ListOrders200ResponseDataInner.md +40 -0
- data/docs/ListOrders200ResponseDataInnerOrderChannel.md +22 -0
- data/docs/ListOrgWebhookDeliveries200Response.md +26 -0
- data/docs/ListOrgWebhookDeliveries200ResponseDataInner.md +38 -0
- data/docs/ListOrgWebhooks200Response.md +26 -0
- data/docs/ListOrgWebhooks200ResponseDataInner.md +30 -0
- data/docs/ListShipments200Response.md +26 -0
- data/docs/ListShipments200ResponseDataInner.md +32 -0
- data/docs/ListShipments200ResponseDataInnerAddress.md +48 -0
- data/docs/ListShipments200ResponseDataInnerCarrierSettings.md +24 -0
- data/docs/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.md +24 -0
- data/docs/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.md +24 -0
- data/docs/ListShippingRules200Response.md +26 -0
- data/docs/ListShippingRules200ResponseDataInner.md +84 -0
- data/docs/ListShippingRules200ResponseDataInnerAdditionalParametersInner.md +20 -0
- data/docs/ListShippingRules200ResponseDataInnerCarrier.md +30 -0
- data/docs/ListShippingRules200ResponseDataInnerConditionsInner.md +55 -0
- data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.md +26 -0
- data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.md +28 -0
- data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.md +28 -0
- data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.md +26 -0
- data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.md +22 -0
- data/docs/ListShippingRules200ResponseDataInnerLabelPrinter.md +20 -0
- data/docs/ListShippingRules200ResponseDataInnerReturnShippingRule.md +20 -0
- data/docs/OrdersApi.md +379 -0
- data/docs/OrgsApi.md +503 -0
- data/docs/QuotesApi.md +79 -0
- data/docs/RevokeApiToken200Response.md +18 -0
- data/docs/RulesApi.md +373 -0
- data/docs/SendShipment422Response.md +24 -0
- data/docs/SendShipment422ResponseErrorsInner.md +20 -0
- data/docs/ShipmentsApi.md +962 -0
- data/docs/SplitShipment201Response.md +20 -0
- data/docs/SplitShipmentParcel200Response.md +18 -0
- data/docs/SplitShipmentParcelRequest.md +18 -0
- data/docs/SplitShipmentParcelRequestParcelsInner.md +20 -0
- data/docs/SplitShipmentRequest.md +30 -0
- data/docs/SystemApi.md +74 -0
- data/docs/TestOrgWebhook200Response.md +18 -0
- data/docs/TokensApi.md +443 -0
- data/docs/TrackShipment200Response.md +26 -0
- data/docs/TrackShipment200ResponseEventsInner.md +28 -0
- data/docs/UpdateAddressRequest.md +40 -0
- data/docs/UpdateApiTokenRequest.md +18 -0
- data/docs/UpdateCarrierRequest.md +22 -0
- data/docs/UpdateOrderRequest.md +38 -0
- data/docs/UpdateOrg200Response.md +48 -0
- data/docs/UpdateOrgBrandingRequest.md +20 -0
- data/docs/UpdateOrgRequest.md +44 -0
- data/docs/UpdateOrgWebhookRequest.md +24 -0
- data/docs/UpdateShipmentRequest.md +44 -0
- data/docs/UpdateShippingRuleRequest.md +66 -0
- data/docs/VerifyApiToken200Response.md +28 -0
- data/docs/VerifyApiTokenRequest.md +18 -0
- data/docs/WebhooksApi.md +523 -0
- data/git_push.sh +57 -0
- data/lib/zippendo/api/addresses_api.rb +406 -0
- data/lib/zippendo/api/billing_api.rb +85 -0
- data/lib/zippendo/api/carrier_catalog_api.rb +85 -0
- data/lib/zippendo/api/carriers_api.rb +554 -0
- data/lib/zippendo/api/orders_api.rb +412 -0
- data/lib/zippendo/api/orgs_api.rb +497 -0
- data/lib/zippendo/api/quotes_api.rb +96 -0
- data/lib/zippendo/api/rules_api.rb +399 -0
- data/lib/zippendo/api/shipments_api.rb +1003 -0
- data/lib/zippendo/api/system_api.rb +79 -0
- data/lib/zippendo/api/tokens_api.rb +467 -0
- data/lib/zippendo/api/webhooks_api.rb +559 -0
- data/lib/zippendo/api_client.rb +397 -0
- data/lib/zippendo/api_error.rb +58 -0
- data/lib/zippendo/api_model_base.rb +88 -0
- data/lib/zippendo/configuration.rb +309 -0
- data/lib/zippendo/models/batch_send_shipments200_response.rb +193 -0
- data/lib/zippendo/models/batch_send_shipments200_response_results_inner.rb +260 -0
- data/lib/zippendo/models/batch_send_shipments200_response_summary.rb +274 -0
- data/lib/zippendo/models/batch_send_shipments_request.rb +185 -0
- data/lib/zippendo/models/batch_split_shipment201_response.rb +193 -0
- data/lib/zippendo/models/batch_split_shipment_request.rb +247 -0
- data/lib/zippendo/models/batch_split_shipment_request_shipments_inner.rb +186 -0
- data/lib/zippendo/models/batch_split_shipment_request_shipments_inner_order_lines_inner.rb +210 -0
- data/lib/zippendo/models/connect_carrier_request.rb +239 -0
- data/lib/zippendo/models/create_address_request.rb +508 -0
- data/lib/zippendo/models/create_api_token201_response.rb +328 -0
- data/lib/zippendo/models/create_api_token_request.rb +267 -0
- data/lib/zippendo/models/create_order201_response.rb +491 -0
- data/lib/zippendo/models/create_order201_response_order_lines_inner.rb +533 -0
- data/lib/zippendo/models/create_order201_response_shipping_address.rb +433 -0
- data/lib/zippendo/models/create_order_request.rb +410 -0
- data/lib/zippendo/models/create_order_request_order_lines_inner.rb +533 -0
- data/lib/zippendo/models/create_order_request_shipping_address.rb +433 -0
- data/lib/zippendo/models/create_org_webhook201_response.rb +356 -0
- data/lib/zippendo/models/create_org_webhook_request.rb +268 -0
- data/lib/zippendo/models/create_shipment201_response.rb +659 -0
- data/lib/zippendo/models/create_shipment201_response_activities_inner.rb +281 -0
- data/lib/zippendo/models/create_shipment201_response_documents_inner.rb +382 -0
- data/lib/zippendo/models/create_shipment201_response_errors_inner.rb +257 -0
- data/lib/zippendo/models/create_shipment201_response_logs_inner.rb +300 -0
- data/lib/zippendo/models/create_shipment201_response_parcels_inner.rb +356 -0
- data/lib/zippendo/models/create_shipment201_response_parcels_inner_dimensions.rb +246 -0
- data/lib/zippendo/models/create_shipment201_response_parcels_inner_order_lines_inner.rb +402 -0
- data/lib/zippendo/models/create_shipment201_response_parties_inner.rb +468 -0
- data/lib/zippendo/models/create_shipment201_response_parties_inner_attributes_inner.rb +210 -0
- data/lib/zippendo/models/create_shipment201_response_pickup_details.rb +229 -0
- data/lib/zippendo/models/create_shipment201_response_shipping_rule.rb +365 -0
- data/lib/zippendo/models/create_shipment201_response_tracking.rb +204 -0
- data/lib/zippendo/models/create_shipment_request.rb +407 -0
- data/lib/zippendo/models/create_shipment_request_carrier_settings.rb +250 -0
- data/lib/zippendo/models/create_shipment_request_parcels_inner.rb +356 -0
- data/lib/zippendo/models/create_shipment_request_parcels_inner_dimensions.rb +246 -0
- data/lib/zippendo/models/create_shipment_request_parcels_inner_order_lines_inner.rb +402 -0
- data/lib/zippendo/models/create_shipment_request_parties_inner.rb +451 -0
- data/lib/zippendo/models/create_shipment_request_parties_inner_attributes_inner.rb +210 -0
- data/lib/zippendo/models/create_shipment_request_pickup_details.rb +229 -0
- data/lib/zippendo/models/create_shipping_quote200_response.rb +167 -0
- data/lib/zippendo/models/create_shipping_quote200_response_rates_inner.rb +333 -0
- data/lib/zippendo/models/create_shipping_quote400_response.rb +192 -0
- data/lib/zippendo/models/create_shipping_quote404_response.rb +192 -0
- data/lib/zippendo/models/create_shipping_quote_request.rb +276 -0
- data/lib/zippendo/models/create_shipping_quote_request_destination.rb +233 -0
- data/lib/zippendo/models/create_shipping_quote_request_items_inner.rb +315 -0
- data/lib/zippendo/models/create_shipping_rule201_response.rb +910 -0
- data/lib/zippendo/models/create_shipping_rule_request.rb +640 -0
- data/lib/zippendo/models/create_shipping_rule_request_additional_parameters.rb +104 -0
- data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_inner.rb +201 -0
- data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value.rb +105 -0
- data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of.rb +259 -0
- data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_coordinates_inner.rb +102 -0
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner.rb +107 -0
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of.rb +342 -0
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of1.rb +359 -0
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of2.rb +366 -0
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of3.rb +344 -0
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of4.rb +270 -0
- data/lib/zippendo/models/delete_org_webhook200_response.rb +165 -0
- data/lib/zippendo/models/delete_shipping_rule200_response.rb +165 -0
- data/lib/zippendo/models/get_billing_usage200_response.rb +245 -0
- data/lib/zippendo/models/get_billing_usage200_response_add_ons_inner.rb +270 -0
- data/lib/zippendo/models/get_billing_usage200_response_current_period.rb +192 -0
- data/lib/zippendo/models/get_billing_usage200_response_limits.rb +320 -0
- data/lib/zippendo/models/get_billing_usage200_response_limits_team_members.rb +192 -0
- data/lib/zippendo/models/get_billing_usage200_response_shipments.rb +246 -0
- data/lib/zippendo/models/get_order200_response.rb +555 -0
- data/lib/zippendo/models/get_order200_response_shipments_inner.rb +385 -0
- data/lib/zippendo/models/get_order200_response_shipping_rule.rb +365 -0
- data/lib/zippendo/models/get_org200_response.rb +440 -0
- data/lib/zippendo/models/get_org200_response_count.rb +165 -0
- data/lib/zippendo/models/get_org_branding200_response.rb +177 -0
- data/lib/zippendo/models/health_check200_response.rb +219 -0
- data/lib/zippendo/models/list_addresses200_response.rb +275 -0
- data/lib/zippendo/models/list_addresses200_response_data_inner.rb +553 -0
- data/lib/zippendo/models/list_api_tokens200_response.rb +275 -0
- data/lib/zippendo/models/list_api_tokens200_response_data_inner.rb +327 -0
- data/lib/zippendo/models/list_api_tokens200_response_data_inner_created_by.rb +205 -0
- data/lib/zippendo/models/list_api_tokens401_response.rb +236 -0
- data/lib/zippendo/models/list_available_carriers200_response_inner.rb +286 -0
- data/lib/zippendo/models/list_available_carriers200_response_inner_required_fields_inner.rb +292 -0
- data/lib/zippendo/models/list_carrier_product_service_points200_response_inner.rb +287 -0
- data/lib/zippendo/models/list_carrier_product_service_points200_response_inner_address.rb +314 -0
- data/lib/zippendo/models/list_carrier_product_service_points_request.rb +313 -0
- data/lib/zippendo/models/list_carrier_products200_response_inner.rb +398 -0
- data/lib/zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner.rb +321 -0
- data/lib/zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner_options_inner.rb +219 -0
- data/lib/zippendo/models/list_carrier_products200_response_inner_services_inner.rb +192 -0
- data/lib/zippendo/models/list_carrier_products200_response_inner_weight_limits.rb +244 -0
- data/lib/zippendo/models/list_carriers200_response.rb +275 -0
- data/lib/zippendo/models/list_carriers200_response_data_inner.rb +369 -0
- data/lib/zippendo/models/list_carriers200_response_data_inner_config_value.rb +104 -0
- data/lib/zippendo/models/list_orders200_response.rb +275 -0
- data/lib/zippendo/models/list_orders200_response_data_inner.rb +423 -0
- data/lib/zippendo/models/list_orders200_response_data_inner_order_channel.rb +244 -0
- data/lib/zippendo/models/list_org_webhook_deliveries200_response.rb +275 -0
- data/lib/zippendo/models/list_org_webhook_deliveries200_response_data_inner.rb +365 -0
- data/lib/zippendo/models/list_org_webhooks200_response.rb +275 -0
- data/lib/zippendo/models/list_org_webhooks200_response_data_inner.rb +329 -0
- data/lib/zippendo/models/list_shipments200_response.rb +275 -0
- data/lib/zippendo/models/list_shipments200_response_data_inner.rb +362 -0
- data/lib/zippendo/models/list_shipments200_response_data_inner_address.rb +553 -0
- data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings.rb +250 -0
- data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value.rb +105 -0
- data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_any_of.rb +259 -0
- data/lib/zippendo/models/list_shipping_rules200_response.rb +275 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner.rb +992 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_additional_parameters_inner.rb +201 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_carrier.rb +329 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner.rb +107 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of.rb +342 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of1.rb +364 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of2.rb +371 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of3.rb +344 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of4.rb +270 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_label_printer.rb +192 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_return_shipping_rule.rb +192 -0
- data/lib/zippendo/models/revoke_api_token200_response.rb +165 -0
- data/lib/zippendo/models/send_shipment422_response.rb +265 -0
- data/lib/zippendo/models/send_shipment422_response_errors_inner.rb +175 -0
- data/lib/zippendo/models/split_shipment201_response.rb +190 -0
- data/lib/zippendo/models/split_shipment_parcel200_response.rb +164 -0
- data/lib/zippendo/models/split_shipment_parcel_request.rb +176 -0
- data/lib/zippendo/models/split_shipment_parcel_request_parcels_inner.rb +186 -0
- data/lib/zippendo/models/split_shipment_request.rb +231 -0
- data/lib/zippendo/models/test_org_webhook200_response.rb +165 -0
- data/lib/zippendo/models/track_shipment200_response.rb +251 -0
- data/lib/zippendo/models/track_shipment200_response_events_inner.rb +296 -0
- data/lib/zippendo/models/update_address_request.rb +471 -0
- data/lib/zippendo/models/update_api_token_request.rb +183 -0
- data/lib/zippendo/models/update_carrier_request.rb +208 -0
- data/lib/zippendo/models/update_order_request.rb +400 -0
- data/lib/zippendo/models/update_org200_response.rb +414 -0
- data/lib/zippendo/models/update_org_branding_request.rb +194 -0
- data/lib/zippendo/models/update_org_request.rb +389 -0
- data/lib/zippendo/models/update_org_webhook_request.rb +235 -0
- data/lib/zippendo/models/update_shipment_request.rb +394 -0
- data/lib/zippendo/models/update_shipping_rule_request.rb +531 -0
- data/lib/zippendo/models/verify_api_token200_response.rb +218 -0
- data/lib/zippendo/models/verify_api_token_request.rb +165 -0
- data/lib/zippendo/version.rb +15 -0
- data/lib/zippendo.rb +195 -0
- data/spec/api/addresses_api_spec.rb +103 -0
- data/spec/api/billing_api_spec.rb +47 -0
- data/spec/api/carrier_catalog_api_spec.rb +47 -0
- data/spec/api/carriers_api_spec.rb +130 -0
- data/spec/api/orders_api_spec.rb +105 -0
- data/spec/api/orgs_api_spec.rb +122 -0
- data/spec/api/quotes_api_spec.rb +48 -0
- data/spec/api/rules_api_spec.rb +102 -0
- data/spec/api/shipments_api_spec.rb +212 -0
- data/spec/api/system_api_spec.rb +46 -0
- data/spec/api/tokens_api_spec.rb +114 -0
- data/spec/api/webhooks_api_spec.rb +130 -0
- data/spec/models/batch_send_shipments200_response_results_inner_spec.rb +68 -0
- data/spec/models/batch_send_shipments200_response_spec.rb +42 -0
- data/spec/models/batch_send_shipments200_response_summary_spec.rb +48 -0
- data/spec/models/batch_send_shipments_request_spec.rb +36 -0
- data/spec/models/batch_split_shipment201_response_spec.rb +42 -0
- data/spec/models/batch_split_shipment_request_shipments_inner_order_lines_inner_spec.rb +42 -0
- data/spec/models/batch_split_shipment_request_shipments_inner_spec.rb +42 -0
- data/spec/models/batch_split_shipment_request_spec.rb +66 -0
- data/spec/models/connect_carrier_request_spec.rb +48 -0
- data/spec/models/create_address_request_spec.rb +106 -0
- data/spec/models/create_api_token201_response_spec.rb +78 -0
- data/spec/models/create_api_token_request_spec.rb +52 -0
- data/spec/models/create_order201_response_order_lines_inner_spec.rb +148 -0
- data/spec/models/create_order201_response_shipping_address_spec.rb +108 -0
- data/spec/models/create_order201_response_spec.rb +142 -0
- data/spec/models/create_order_request_order_lines_inner_spec.rb +148 -0
- data/spec/models/create_order_request_shipping_address_spec.rb +108 -0
- data/spec/models/create_order_request_spec.rb +102 -0
- data/spec/models/create_org_webhook201_response_spec.rb +78 -0
- data/spec/models/create_org_webhook_request_spec.rb +58 -0
- data/spec/models/create_shipment201_response_activities_inner_spec.rb +64 -0
- data/spec/models/create_shipment201_response_documents_inner_spec.rb +90 -0
- data/spec/models/create_shipment201_response_errors_inner_spec.rb +60 -0
- data/spec/models/create_shipment201_response_logs_inner_spec.rb +82 -0
- data/spec/models/create_shipment201_response_parcels_inner_dimensions_spec.rb +48 -0
- data/spec/models/create_shipment201_response_parcels_inner_order_lines_inner_spec.rb +90 -0
- data/spec/models/create_shipment201_response_parcels_inner_spec.rb +100 -0
- data/spec/models/create_shipment201_response_parties_inner_attributes_inner_spec.rb +42 -0
- data/spec/models/create_shipment201_response_parties_inner_spec.rb +100 -0
- data/spec/models/create_shipment201_response_pickup_details_spec.rb +54 -0
- data/spec/models/create_shipment201_response_shipping_rule_spec.rb +102 -0
- data/spec/models/create_shipment201_response_spec.rb +182 -0
- data/spec/models/create_shipment201_response_tracking_spec.rb +66 -0
- data/spec/models/create_shipment_request_carrier_settings_spec.rb +54 -0
- data/spec/models/create_shipment_request_parcels_inner_dimensions_spec.rb +48 -0
- data/spec/models/create_shipment_request_parcels_inner_order_lines_inner_spec.rb +90 -0
- data/spec/models/create_shipment_request_parcels_inner_spec.rb +100 -0
- data/spec/models/create_shipment_request_parties_inner_attributes_inner_spec.rb +42 -0
- data/spec/models/create_shipment_request_parties_inner_spec.rb +100 -0
- data/spec/models/create_shipment_request_pickup_details_spec.rb +54 -0
- data/spec/models/create_shipment_request_spec.rb +116 -0
- data/spec/models/create_shipping_quote200_response_rates_inner_spec.rb +96 -0
- data/spec/models/create_shipping_quote200_response_spec.rb +36 -0
- data/spec/models/create_shipping_quote400_response_spec.rb +42 -0
- data/spec/models/create_shipping_quote404_response_spec.rb +42 -0
- data/spec/models/create_shipping_quote_request_destination_spec.rb +66 -0
- data/spec/models/create_shipping_quote_request_items_inner_spec.rb +72 -0
- data/spec/models/create_shipping_quote_request_spec.rb +54 -0
- data/spec/models/create_shipping_rule201_response_spec.rb +208 -0
- data/spec/models/create_shipping_rule_request_additional_parameters_any_of_inner_spec.rb +42 -0
- data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_coordinates_inner_spec.rb +21 -0
- data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_spec.rb +54 -0
- data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_spec.rb +21 -0
- data/spec/models/create_shipping_rule_request_additional_parameters_spec.rb +21 -0
- data/spec/models/create_shipping_rule_request_conditions_inner_one_of1_spec.rb +78 -0
- data/spec/models/create_shipping_rule_request_conditions_inner_one_of2_spec.rb +74 -0
- data/spec/models/create_shipping_rule_request_conditions_inner_one_of3_spec.rb +68 -0
- data/spec/models/create_shipping_rule_request_conditions_inner_one_of4_spec.rb +52 -0
- data/spec/models/create_shipping_rule_request_conditions_inner_one_of_spec.rb +64 -0
- data/spec/models/create_shipping_rule_request_conditions_inner_spec.rb +32 -0
- data/spec/models/create_shipping_rule_request_spec.rb +184 -0
- data/spec/models/delete_org_webhook200_response_spec.rb +36 -0
- data/spec/models/delete_shipping_rule200_response_spec.rb +36 -0
- data/spec/models/get_billing_usage200_response_add_ons_inner_spec.rb +58 -0
- data/spec/models/get_billing_usage200_response_current_period_spec.rb +42 -0
- data/spec/models/get_billing_usage200_response_limits_spec.rb +72 -0
- data/spec/models/get_billing_usage200_response_limits_team_members_spec.rb +42 -0
- data/spec/models/get_billing_usage200_response_shipments_spec.rb +54 -0
- data/spec/models/get_billing_usage200_response_spec.rb +54 -0
- data/spec/models/get_order200_response_shipments_inner_spec.rb +98 -0
- data/spec/models/get_order200_response_shipping_rule_spec.rb +102 -0
- data/spec/models/get_order200_response_spec.rb +160 -0
- data/spec/models/get_org200_response_count_spec.rb +36 -0
- data/spec/models/get_org200_response_spec.rb +132 -0
- data/spec/models/get_org_branding200_response_spec.rb +48 -0
- data/spec/models/health_check200_response_spec.rb +48 -0
- data/spec/models/list_addresses200_response_data_inner_spec.rb +130 -0
- data/spec/models/list_addresses200_response_spec.rb +60 -0
- data/spec/models/list_api_tokens200_response_data_inner_created_by_spec.rb +48 -0
- data/spec/models/list_api_tokens200_response_data_inner_spec.rb +78 -0
- data/spec/models/list_api_tokens200_response_spec.rb +60 -0
- data/spec/models/list_api_tokens401_response_spec.rb +52 -0
- data/spec/models/list_available_carriers200_response_inner_required_fields_inner_spec.rb +70 -0
- data/spec/models/list_available_carriers200_response_inner_spec.rb +96 -0
- data/spec/models/list_carrier_product_service_points200_response_inner_address_spec.rb +66 -0
- data/spec/models/list_carrier_product_service_points200_response_inner_spec.rb +78 -0
- data/spec/models/list_carrier_product_service_points_request_spec.rb +66 -0
- data/spec/models/list_carrier_products200_response_inner_additional_parameters_inner_options_inner_spec.rb +48 -0
- data/spec/models/list_carrier_products200_response_inner_additional_parameters_inner_spec.rb +76 -0
- data/spec/models/list_carrier_products200_response_inner_services_inner_spec.rb +42 -0
- data/spec/models/list_carrier_products200_response_inner_spec.rb +100 -0
- data/spec/models/list_carrier_products200_response_inner_weight_limits_spec.rb +52 -0
- data/spec/models/list_carriers200_response_data_inner_config_value_spec.rb +21 -0
- data/spec/models/list_carriers200_response_data_inner_spec.rb +96 -0
- data/spec/models/list_carriers200_response_spec.rb +60 -0
- data/spec/models/list_orders200_response_data_inner_order_channel_spec.rb +52 -0
- data/spec/models/list_orders200_response_data_inner_spec.rb +106 -0
- data/spec/models/list_orders200_response_spec.rb +60 -0
- data/spec/models/list_org_webhook_deliveries200_response_data_inner_spec.rb +96 -0
- data/spec/models/list_org_webhook_deliveries200_response_spec.rb +60 -0
- data/spec/models/list_org_webhooks200_response_data_inner_spec.rb +72 -0
- data/spec/models/list_org_webhooks200_response_spec.rb +60 -0
- data/spec/models/list_shipments200_response_data_inner_address_spec.rb +130 -0
- data/spec/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_any_of_spec.rb +54 -0
- data/spec/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_spec.rb +21 -0
- data/spec/models/list_shipments200_response_data_inner_carrier_settings_spec.rb +54 -0
- data/spec/models/list_shipments200_response_data_inner_spec.rb +86 -0
- data/spec/models/list_shipments200_response_spec.rb +60 -0
- data/spec/models/list_shipping_rules200_response_data_inner_additional_parameters_inner_spec.rb +42 -0
- data/spec/models/list_shipping_rules200_response_data_inner_carrier_spec.rb +72 -0
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of1_spec.rb +78 -0
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of2_spec.rb +74 -0
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of3_spec.rb +68 -0
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of4_spec.rb +52 -0
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of_spec.rb +64 -0
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_spec.rb +32 -0
- data/spec/models/list_shipping_rules200_response_data_inner_label_printer_spec.rb +42 -0
- data/spec/models/list_shipping_rules200_response_data_inner_return_shipping_rule_spec.rb +42 -0
- data/spec/models/list_shipping_rules200_response_data_inner_spec.rb +238 -0
- data/spec/models/list_shipping_rules200_response_spec.rb +60 -0
- data/spec/models/revoke_api_token200_response_spec.rb +36 -0
- data/spec/models/send_shipment422_response_errors_inner_spec.rb +42 -0
- data/spec/models/send_shipment422_response_spec.rb +58 -0
- data/spec/models/split_shipment201_response_spec.rb +42 -0
- data/spec/models/split_shipment_parcel200_response_spec.rb +36 -0
- data/spec/models/split_shipment_parcel_request_parcels_inner_spec.rb +42 -0
- data/spec/models/split_shipment_parcel_request_spec.rb +36 -0
- data/spec/models/split_shipment_request_spec.rb +72 -0
- data/spec/models/test_org_webhook200_response_spec.rb +36 -0
- data/spec/models/track_shipment200_response_events_inner_spec.rb +70 -0
- data/spec/models/track_shipment200_response_spec.rb +64 -0
- data/spec/models/update_address_request_spec.rb +106 -0
- data/spec/models/update_api_token_request_spec.rb +36 -0
- data/spec/models/update_carrier_request_spec.rb +48 -0
- data/spec/models/update_order_request_spec.rb +100 -0
- data/spec/models/update_org200_response_spec.rb +126 -0
- data/spec/models/update_org_branding_request_spec.rb +42 -0
- data/spec/models/update_org_request_spec.rb +118 -0
- data/spec/models/update_org_webhook_request_spec.rb +58 -0
- data/spec/models/update_shipment_request_spec.rb +122 -0
- data/spec/models/update_shipping_rule_request_spec.rb +184 -0
- data/spec/models/verify_api_token200_response_spec.rb +66 -0
- data/spec/models/verify_api_token_request_spec.rb +36 -0
- data/spec/spec_helper.rb +111 -0
- data/zippendo.gemspec +39 -0
- metadata +715 -0
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# Zippendo::GetOrder200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique order ID. | |
|
|
8
|
+
| **order_number** | **String** | Human-readable order number. | |
|
|
9
|
+
| **external_id** | **String** | Identifier of the order in the source platform. | [optional] |
|
|
10
|
+
| **customer_name** | **String** | Customer full name. | [optional] |
|
|
11
|
+
| **customer_email** | **String** | Customer email address. | [optional] |
|
|
12
|
+
| **shipping_address** | [**CreateOrder201ResponseShippingAddress**](CreateOrder201ResponseShippingAddress.md) | | [optional] |
|
|
13
|
+
| **order_lines** | [**Array<CreateOrder201ResponseOrderLinesInner>**](CreateOrder201ResponseOrderLinesInner.md) | Line items in the order. | |
|
|
14
|
+
| **subtotal_amount** | **Float** | Order subtotal before shipping and tax. | [optional] |
|
|
15
|
+
| **total_amount** | **Float** | Order grand total. | [optional] |
|
|
16
|
+
| **currency** | **String** | ISO 4217 currency code. | [optional] |
|
|
17
|
+
| **status** | **String** | Order fulfilment status derived from its shipments. | |
|
|
18
|
+
| **shipping_rule_id** | **String** | ID of the applied shipping rule. | [optional] |
|
|
19
|
+
| **notes** | **String** | Free-form internal notes. | [optional] |
|
|
20
|
+
| **external_data** | **Hash<String, Object>** | Raw platform-specific payload for reference. | [optional] |
|
|
21
|
+
| **order_channel_id** | **String** | ID of the order channel this order belongs to. | |
|
|
22
|
+
| **org_id** | **String** | Owning organization ID. | |
|
|
23
|
+
| **created_at** | **String** | Creation timestamp (ISO 8601). | |
|
|
24
|
+
| **updated_at** | **String** | Last update timestamp (ISO 8601). | |
|
|
25
|
+
| **order_channel** | [**ListOrders200ResponseDataInnerOrderChannel**](ListOrders200ResponseDataInnerOrderChannel.md) | | |
|
|
26
|
+
| **shipping_rule** | [**GetOrder200ResponseShippingRule**](GetOrder200ResponseShippingRule.md) | | [optional] |
|
|
27
|
+
| **shipments** | [**Array<GetOrder200ResponseShipmentsInner>**](GetOrder200ResponseShipmentsInner.md) | | |
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
```ruby
|
|
32
|
+
require 'zippendo'
|
|
33
|
+
|
|
34
|
+
instance = Zippendo::GetOrder200Response.new(
|
|
35
|
+
id: clz9k2f0a0003abcd9012mnop,
|
|
36
|
+
order_number: #1042,
|
|
37
|
+
external_id: 5012345678901,
|
|
38
|
+
customer_name: Anna Jensen,
|
|
39
|
+
customer_email: anna@example.dk,
|
|
40
|
+
shipping_address: null,
|
|
41
|
+
order_lines: null,
|
|
42
|
+
subtotal_amount: 998,
|
|
43
|
+
total_amount: 1047,
|
|
44
|
+
currency: DKK,
|
|
45
|
+
status: processing,
|
|
46
|
+
shipping_rule_id: clz9k2f0a0002abcd5678ijkl,
|
|
47
|
+
notes: Leave at front desk,
|
|
48
|
+
external_data: null,
|
|
49
|
+
order_channel_id: clz9k2f0a0001abcd1234efgh,
|
|
50
|
+
org_id: clz9k2f0a0000abcd0000zzzz,
|
|
51
|
+
created_at: 2026-06-22T14:30:00.000Z,
|
|
52
|
+
updated_at: 2026-06-22T14:30:00.000Z,
|
|
53
|
+
order_channel: null,
|
|
54
|
+
shipping_rule: null,
|
|
55
|
+
shipments: null
|
|
56
|
+
)
|
|
57
|
+
```
|
|
58
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Zippendo::GetOrder200ResponseShipmentsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique shipment identifier. | |
|
|
8
|
+
| **reference** | **String** | Customer-facing shipment reference. | |
|
|
9
|
+
| **status** | **String** | Lifecycle status of the shipment. | |
|
|
10
|
+
| **type** | **String** | Direction of the shipment relative to the organization. | |
|
|
11
|
+
| **tracking** | [**CreateShipment201ResponseTracking**](CreateShipment201ResponseTracking.md) | | [optional] |
|
|
12
|
+
| **carrier_settings** | [**ListShipments200ResponseDataInnerCarrierSettings**](ListShipments200ResponseDataInnerCarrierSettings.md) | | |
|
|
13
|
+
| **created_at** | **String** | Timestamp when the shipment was created. | |
|
|
14
|
+
| **updated_at** | **String** | Timestamp when the shipment was last updated. | |
|
|
15
|
+
| **shipping_rule_id** | **String** | ID of the shipping rule used for this shipment. | [optional] |
|
|
16
|
+
| **documents** | [**Array<CreateShipment201ResponseDocumentsInner>**](CreateShipment201ResponseDocumentsInner.md) | Documents (labels, customs forms) for this shipment. | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'zippendo'
|
|
22
|
+
|
|
23
|
+
instance = Zippendo::GetOrder200ResponseShipmentsInner.new(
|
|
24
|
+
id: shp_4d9e7a2f,
|
|
25
|
+
reference: ORDER-1042,
|
|
26
|
+
status: pending,
|
|
27
|
+
type: outbound,
|
|
28
|
+
tracking: null,
|
|
29
|
+
carrier_settings: null,
|
|
30
|
+
created_at: 2026-06-22T14:30:00.000Z,
|
|
31
|
+
updated_at: 2026-06-22T14:30:00.000Z,
|
|
32
|
+
shipping_rule_id: clz9k2f0a0002abcd5678ijkl,
|
|
33
|
+
documents: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Zippendo::GetOrder200ResponseShippingRule
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique shipping rule identifier. | |
|
|
8
|
+
| **name** | **String** | Display name of the shipping rule. | |
|
|
9
|
+
| **carrier_id** | **String** | Carrier applied by the rule. | |
|
|
10
|
+
| **product_id** | **String** | Carrier product applied by the rule. | |
|
|
11
|
+
| **services** | **Array<String>** | Additional service codes applied by the rule. | |
|
|
12
|
+
| **address_id** | **String** | Sender address applied by the rule. | |
|
|
13
|
+
| **return_shipping_rule_id** | **String** | ID of the linked return shipping rule. | [optional] |
|
|
14
|
+
| **auto_create_return_shipment** | **Boolean** | Whether a return shipment is created automatically. | [optional] |
|
|
15
|
+
| **auto_print_labels** | **Boolean** | Whether labels are printed automatically on send. | [optional] |
|
|
16
|
+
| **auto_print_documents** | **Boolean** | Whether documents are printed automatically on send. | [optional] |
|
|
17
|
+
| **label_printer_id** | **String** | Printer used for labels. | [optional] |
|
|
18
|
+
| **document_printer_id** | **String** | Printer used for documents. | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'zippendo'
|
|
24
|
+
|
|
25
|
+
instance = Zippendo::GetOrder200ResponseShippingRule.new(
|
|
26
|
+
id: rule_3c4d5e6f,
|
|
27
|
+
name: Domestic standard,
|
|
28
|
+
carrier_id: car_pn_001,
|
|
29
|
+
product_id: prod_mypack_home,
|
|
30
|
+
services: ["A7"],
|
|
31
|
+
address_id: addr_7e8f9a0b,
|
|
32
|
+
return_shipping_rule_id: clz9k2f0a0004abcd3456qrst,
|
|
33
|
+
auto_create_return_shipment: false,
|
|
34
|
+
auto_print_labels: true,
|
|
35
|
+
auto_print_documents: false,
|
|
36
|
+
label_printer_id: prn_label_01,
|
|
37
|
+
document_printer_id: prn_doc_01
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Zippendo::GetOrg200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique organization identifier | |
|
|
8
|
+
| **name** | **String** | Organization name | |
|
|
9
|
+
| **slug** | **String** | Organization URL slug (unique identifier) | |
|
|
10
|
+
| **description** | **String** | Organization description | |
|
|
11
|
+
| **currency** | **String** | Billing currency (ISO 4217 code) | [default to 'DKK'] |
|
|
12
|
+
| **vat_number** | **String** | Company VAT/tax ID for invoices | [optional] |
|
|
13
|
+
| **billing_email** | **String** | Billing email for invoices | [optional] |
|
|
14
|
+
| **company_name** | **String** | Legal company name | [optional] |
|
|
15
|
+
| **address_line1** | **String** | Address line 1 | [optional] |
|
|
16
|
+
| **address_line2** | **String** | Address line 2 | [optional] |
|
|
17
|
+
| **city** | **String** | City | [optional] |
|
|
18
|
+
| **postal_code** | **String** | Postal code | [optional] |
|
|
19
|
+
| **country** | **String** | Country (ISO 3166-1 alpha-2 code) | [optional] |
|
|
20
|
+
| **customs** | **Hash<String, String>** | Customs identifiers keyed by type | [optional] |
|
|
21
|
+
| **created_at** | **String** | Creation timestamp (ISO 8601) | |
|
|
22
|
+
| **updated_at** | **String** | Last update timestamp (ISO 8601) | |
|
|
23
|
+
| **_count** | [**GetOrg200ResponseCount**](GetOrg200ResponseCount.md) | | |
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```ruby
|
|
28
|
+
require 'zippendo'
|
|
29
|
+
|
|
30
|
+
instance = Zippendo::GetOrg200Response.new(
|
|
31
|
+
id: org_4d8af01qw2,
|
|
32
|
+
name: Nordic Logistics ApS,
|
|
33
|
+
slug: nordic-logistics,
|
|
34
|
+
description: Parcel and freight logistics across the Nordics,
|
|
35
|
+
currency: DKK,
|
|
36
|
+
vat_number: DK12345678,
|
|
37
|
+
billing_email: billing@nordic-logistics.dk,
|
|
38
|
+
company_name: Nordic Logistics ApS,
|
|
39
|
+
address_line1: Havnegade 12,
|
|
40
|
+
address_line2: 3. sal,
|
|
41
|
+
city: København,
|
|
42
|
+
postal_code: 1058,
|
|
43
|
+
country: DK,
|
|
44
|
+
customs: {"eori":"DK12345678"},
|
|
45
|
+
created_at: 2026-06-22T14:30:00.000Z,
|
|
46
|
+
updated_at: 2026-06-22T14:30:00.000Z,
|
|
47
|
+
_count: null
|
|
48
|
+
)
|
|
49
|
+
```
|
|
50
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zippendo::GetOrg200ResponseCount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **members** | **Float** | Number of members in the organization | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zippendo'
|
|
13
|
+
|
|
14
|
+
instance = Zippendo::GetOrg200ResponseCount.new(
|
|
15
|
+
members: 8
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zippendo::GetOrgBranding200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **primary_color** | **String** | Primary brand color (hex) | |
|
|
8
|
+
| **secondary_color** | **String** | Secondary brand color (hex) | |
|
|
9
|
+
| **logo_url** | **String** | Authenticated URL to download the org logo image, or null if no logo is set | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zippendo'
|
|
15
|
+
|
|
16
|
+
instance = Zippendo::GetOrgBranding200Response.new(
|
|
17
|
+
primary_color: #1D4ED8,
|
|
18
|
+
secondary_color: #F59E0B,
|
|
19
|
+
logo_url: /orgs/org_123/branding/logo
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zippendo::HealthCheck200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | Service status | |
|
|
8
|
+
| **timestamp** | **String** | Current server time (ISO 8601) | |
|
|
9
|
+
| **version** | **String** | API version | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zippendo'
|
|
15
|
+
|
|
16
|
+
instance = Zippendo::HealthCheck200Response.new(
|
|
17
|
+
status: ok,
|
|
18
|
+
timestamp: 2026-06-22T14:30:00.000Z,
|
|
19
|
+
version: 1.0.0
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zippendo::ListAddresses200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<ListAddresses200ResponseDataInner>**](ListAddresses200ResponseDataInner.md) | Page of results | |
|
|
8
|
+
| **total** | **Float** | Total matching items across all pages | |
|
|
9
|
+
| **page** | **Float** | Current page number (1-based) | |
|
|
10
|
+
| **limit** | **Float** | Items per page | |
|
|
11
|
+
| **total_pages** | **Float** | Total number of pages | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zippendo'
|
|
17
|
+
|
|
18
|
+
instance = Zippendo::ListAddresses200Response.new(
|
|
19
|
+
data: null,
|
|
20
|
+
total: 137,
|
|
21
|
+
page: 1,
|
|
22
|
+
limit: 20,
|
|
23
|
+
total_pages: 7
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Zippendo::ListAddresses200ResponseDataInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique address identifier | |
|
|
8
|
+
| **name** | **String** | Name of the address | |
|
|
9
|
+
| **att_contact** | **String** | Attention contact person | |
|
|
10
|
+
| **address1** | **String** | Address line 1 | |
|
|
11
|
+
| **address2** | **String** | Address line 2 | |
|
|
12
|
+
| **zipcode** | **String** | Postal/ZIP code | |
|
|
13
|
+
| **city** | **String** | City | |
|
|
14
|
+
| **phone** | **String** | Phone number | |
|
|
15
|
+
| **country_code** | **String** | ISO country code | |
|
|
16
|
+
| **state** | **String** | State/Province | |
|
|
17
|
+
| **email** | **String** | Email address | |
|
|
18
|
+
| **customs** | **Hash<String, String>** | Customs identifiers keyed by type | [optional] |
|
|
19
|
+
| **address_types** | **Array<String>** | Address types (sender, pickup, return) | |
|
|
20
|
+
| **org_id** | **String** | Owning organization ID | |
|
|
21
|
+
| **created_at** | **String** | Creation timestamp (ISO 8601) | |
|
|
22
|
+
| **updated_at** | **String** | Last update timestamp (ISO 8601) | |
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
require 'zippendo'
|
|
28
|
+
|
|
29
|
+
instance = Zippendo::ListAddresses200ResponseDataInner.new(
|
|
30
|
+
id: addr_01HZX9K2QF,
|
|
31
|
+
name: Hovedlager,
|
|
32
|
+
att_contact: Mette Hansen,
|
|
33
|
+
address1: Vesterbrogade 1,
|
|
34
|
+
address2: 2. sal,
|
|
35
|
+
zipcode: 1620,
|
|
36
|
+
city: København,
|
|
37
|
+
phone: +4533123456,
|
|
38
|
+
country_code: DK,
|
|
39
|
+
state: null,
|
|
40
|
+
email: lager@example.dk,
|
|
41
|
+
customs: {"eori":"DK12345678"},
|
|
42
|
+
address_types: ["sender"],
|
|
43
|
+
org_id: org_01HZX9K2QF,
|
|
44
|
+
created_at: 2026-06-22T09:00:00.000Z,
|
|
45
|
+
updated_at: 2026-06-22T09:00:00.000Z
|
|
46
|
+
)
|
|
47
|
+
```
|
|
48
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zippendo::ListApiTokens200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<ListApiTokens200ResponseDataInner>**](ListApiTokens200ResponseDataInner.md) | Page of results | |
|
|
8
|
+
| **total** | **Float** | Total matching items across all pages | |
|
|
9
|
+
| **page** | **Float** | Current page number (1-based) | |
|
|
10
|
+
| **limit** | **Float** | Items per page | |
|
|
11
|
+
| **total_pages** | **Float** | Total number of pages | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zippendo'
|
|
17
|
+
|
|
18
|
+
instance = Zippendo::ListApiTokens200Response.new(
|
|
19
|
+
data: null,
|
|
20
|
+
total: 137,
|
|
21
|
+
page: 1,
|
|
22
|
+
limit: 20,
|
|
23
|
+
total_pages: 7
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Zippendo::ListApiTokens200ResponseDataInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique API token identifier | |
|
|
8
|
+
| **name** | **String** | Token name for identification | |
|
|
9
|
+
| **token_prefix** | **String** | First 12 chars of the token for identification | |
|
|
10
|
+
| **scopes** | **Array<String>** | Permission scopes granted by the token | |
|
|
11
|
+
| **last_used_at** | **String** | Timestamp the token was last used (ISO 8601), null if never used | |
|
|
12
|
+
| **expires_at** | **String** | Expiry timestamp (ISO 8601), null if it never expires | |
|
|
13
|
+
| **created_at** | **String** | Creation timestamp (ISO 8601) | |
|
|
14
|
+
| **created_by** | [**ListApiTokens200ResponseDataInnerCreatedBy**](ListApiTokens200ResponseDataInnerCreatedBy.md) | | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'zippendo'
|
|
20
|
+
|
|
21
|
+
instance = Zippendo::ListApiTokens200ResponseDataInner.new(
|
|
22
|
+
id: tok_6e2fa83ij9,
|
|
23
|
+
name: Warehouse integration,
|
|
24
|
+
token_prefix: zipp_live_8f,
|
|
25
|
+
scopes: ["read:shipments","write:shipments"],
|
|
26
|
+
last_used_at: 2026-06-22T14:30:00.000Z,
|
|
27
|
+
expires_at: 2026-09-20T14:30:00.000Z,
|
|
28
|
+
created_at: 2026-06-22T14:30:00.000Z,
|
|
29
|
+
created_by: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zippendo::ListApiTokens200ResponseDataInnerCreatedBy
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Creator user identifier | |
|
|
8
|
+
| **name** | **String** | Creator full name | |
|
|
9
|
+
| **email** | **String** | Creator email address | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zippendo'
|
|
15
|
+
|
|
16
|
+
instance = Zippendo::ListApiTokens200ResponseDataInnerCreatedBy.new(
|
|
17
|
+
id: usr_9f3kd92ld0,
|
|
18
|
+
name: Anna Jensen,
|
|
19
|
+
email: anna@example.dk
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zippendo::ListApiTokens401Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | Machine-readable error code (translate by this on the client) | [optional] |
|
|
8
|
+
| **error** | **String** | Short human title | |
|
|
9
|
+
| **message** | **String** | Human-readable English detail (i18n fallback) | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zippendo'
|
|
15
|
+
|
|
16
|
+
instance = Zippendo::ListApiTokens401Response.new(
|
|
17
|
+
code: CARRIER_GLS_WRONG_ADDRESS,
|
|
18
|
+
error: Bad Request,
|
|
19
|
+
message: Failed to create address
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Zippendo::ListAvailableCarriers200ResponseInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Display name of the carrier | |
|
|
8
|
+
| **slug** | **String** | Unique carrier slug identifier | |
|
|
9
|
+
| **group** | **String** | Carrier group or family name | [optional] |
|
|
10
|
+
| **description** | **String** | Short description of the carrier | [optional] |
|
|
11
|
+
| **logo** | **String** | URL to the carrier logo image | [optional] |
|
|
12
|
+
| **brand_color** | **String** | Carrier brand color (hex) | [optional] |
|
|
13
|
+
| **learn_more_url** | **String** | URL with more information about the carrier | [optional] |
|
|
14
|
+
| **required_fields** | [**Array<ListAvailableCarriers200ResponseInnerRequiredFieldsInner>**](ListAvailableCarriers200ResponseInnerRequiredFieldsInner.md) | Configuration fields that must be provided to connect the carrier | [optional] |
|
|
15
|
+
| **optional_fields** | [**Array<ListAvailableCarriers200ResponseInnerRequiredFieldsInner>**](ListAvailableCarriers200ResponseInnerRequiredFieldsInner.md) | Optional configuration fields for the carrier | [optional] |
|
|
16
|
+
| **deprecated** | **Boolean** | Whether this integration is deprecated (still works, but discouraged) | [optional] |
|
|
17
|
+
| **deprecation_message** | **String** | Guidance shown alongside the deprecated tag (e.g. what to migrate to) | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'zippendo'
|
|
23
|
+
|
|
24
|
+
instance = Zippendo::ListAvailableCarriers200ResponseInner.new(
|
|
25
|
+
name: PostNord,
|
|
26
|
+
slug: postnord,
|
|
27
|
+
group: Nordic,
|
|
28
|
+
description: Nordic postal and parcel carrier,
|
|
29
|
+
logo: https://cdn.zippendo.com/carriers/postnord.svg,
|
|
30
|
+
brand_color: #0072CE,
|
|
31
|
+
learn_more_url: https://www.postnord.dk,
|
|
32
|
+
required_fields: null,
|
|
33
|
+
optional_fields: null,
|
|
34
|
+
deprecated: true,
|
|
35
|
+
deprecation_message: The standalone Instabox API is deprecated. Migrate to the Instabee-powered Instabox integration.
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Zippendo::ListAvailableCarriers200ResponseInnerRequiredFieldsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Human-readable label for the configuration field | |
|
|
8
|
+
| **key** | **String** | Machine key used to store the field value | |
|
|
9
|
+
| **type** | **String** | Data type of the configuration field | |
|
|
10
|
+
| **options** | [**Array<ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner>**](ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.md) | Selectable options for enum-type fields | [optional] |
|
|
11
|
+
| **description** | **String** | Help text describing the field | |
|
|
12
|
+
| **required** | **Boolean** | Whether the field is mandatory | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'zippendo'
|
|
18
|
+
|
|
19
|
+
instance = Zippendo::ListAvailableCarriers200ResponseInnerRequiredFieldsInner.new(
|
|
20
|
+
name: Customer number,
|
|
21
|
+
key: customerNumber,
|
|
22
|
+
type: string,
|
|
23
|
+
options: null,
|
|
24
|
+
description: Your PostNord customer number,
|
|
25
|
+
required: true
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Zippendo::ListCarrierProductServicePoints200ResponseInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **lat** | **Float** | Latitude of the service point | |
|
|
8
|
+
| **lng** | **Float** | Longitude of the service point | |
|
|
9
|
+
| **name** | **String** | Name of the service point | |
|
|
10
|
+
| **service_point_id** | **String** | Unique service point identifier | |
|
|
11
|
+
| **opening_hours** | **Array<String>** | Opening hours of the service point | [optional] |
|
|
12
|
+
| **description** | **String** | Additional description of the service point | [optional] |
|
|
13
|
+
| **distance** | **Float** | Distance from the searched location in meters | [optional] |
|
|
14
|
+
| **address** | [**ListCarrierProductServicePoints200ResponseInnerAddress**](ListCarrierProductServicePoints200ResponseInnerAddress.md) | | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'zippendo'
|
|
20
|
+
|
|
21
|
+
instance = Zippendo::ListCarrierProductServicePoints200ResponseInner.new(
|
|
22
|
+
lat: 55.6761,
|
|
23
|
+
lng: 12.5683,
|
|
24
|
+
name: PostNord Pakkeshop Netto,
|
|
25
|
+
service_point_id: 1234567,
|
|
26
|
+
opening_hours: null,
|
|
27
|
+
description: Located inside Netto supermarket,
|
|
28
|
+
distance: 320,
|
|
29
|
+
address: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Zippendo::ListCarrierProductServicePoints200ResponseInnerAddress
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **address1** | **String** | Street address line 1 | |
|
|
8
|
+
| **address2** | **String** | Street address line 2 | [optional] |
|
|
9
|
+
| **postal_code** | **String** | Postal code | |
|
|
10
|
+
| **state** | **String** | State or region | [optional] |
|
|
11
|
+
| **city** | **String** | City name | |
|
|
12
|
+
| **country_code** | **String** | ISO 3166-1 alpha-2 country code | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'zippendo'
|
|
18
|
+
|
|
19
|
+
instance = Zippendo::ListCarrierProductServicePoints200ResponseInnerAddress.new(
|
|
20
|
+
address1: Vesterbrogade 1,
|
|
21
|
+
address2: 2. sal,
|
|
22
|
+
postal_code: 1620,
|
|
23
|
+
state: null,
|
|
24
|
+
city: København,
|
|
25
|
+
country_code: DK
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Zippendo::ListCarrierProductServicePointsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **address1** | **String** | Street address line 1 | |
|
|
8
|
+
| **address2** | **String** | Street address line 2 | [optional] |
|
|
9
|
+
| **postal_code** | **String** | Postal code | |
|
|
10
|
+
| **state** | **String** | State or region | [optional] |
|
|
11
|
+
| **city** | **String** | City name | |
|
|
12
|
+
| **country_code** | **String** | ISO 3166-1 alpha-2 country code | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'zippendo'
|
|
18
|
+
|
|
19
|
+
instance = Zippendo::ListCarrierProductServicePointsRequest.new(
|
|
20
|
+
address1: Vesterbrogade 1,
|
|
21
|
+
address2: 2. sal,
|
|
22
|
+
postal_code: 1620,
|
|
23
|
+
state: null,
|
|
24
|
+
city: København,
|
|
25
|
+
country_code: DK
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Zippendo::ListCarrierProducts200ResponseInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Display name of the shipping product | |
|
|
8
|
+
| **product_id** | **String** | Unique carrier product identifier | |
|
|
9
|
+
| **type** | **String** | Direction of the shipment for this product | |
|
|
10
|
+
| **description** | **String** | Description of the shipping product | [optional] |
|
|
11
|
+
| **available_countries** | **Array<String>** | Recipient countries supported by this product | |
|
|
12
|
+
| **available_sender_countries** | **Array<String>** | Sender countries supported by this product | |
|
|
13
|
+
| **is_service_point** | **Boolean** | Whether delivery is to a service point/pickup location | [default to false] |
|
|
14
|
+
| **is_pickup_available** | **Boolean** | Whether carrier pickup is available for this product | [default to false] |
|
|
15
|
+
| **services** | [**Array<ListCarrierProducts200ResponseInnerServicesInner>**](ListCarrierProducts200ResponseInnerServicesInner.md) | Additional services available for this product | [optional] |
|
|
16
|
+
| **additional_parameters** | [**Array<ListCarrierProducts200ResponseInnerAdditionalParametersInner>**](ListCarrierProducts200ResponseInnerAdditionalParametersInner.md) | Extra parameters that can or must be supplied for this product | [optional] |
|
|
17
|
+
| **weight_limits** | [**ListCarrierProducts200ResponseInnerWeightLimits**](ListCarrierProducts200ResponseInnerWeightLimits.md) | | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'zippendo'
|
|
23
|
+
|
|
24
|
+
instance = Zippendo::ListCarrierProducts200ResponseInner.new(
|
|
25
|
+
name: PostNord MyPack Home,
|
|
26
|
+
product_id: PNL13,
|
|
27
|
+
type: outbound,
|
|
28
|
+
description: Home delivery within Denmark,
|
|
29
|
+
available_countries: null,
|
|
30
|
+
available_sender_countries: null,
|
|
31
|
+
is_service_point: false,
|
|
32
|
+
is_pickup_available: true,
|
|
33
|
+
services: null,
|
|
34
|
+
additional_parameters: null,
|
|
35
|
+
weight_limits: null
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Zippendo::ListCarrierProducts200ResponseInnerAdditionalParametersInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Display label for the parameter | |
|
|
8
|
+
| **key** | **String** | Machine key the value is stored under | |
|
|
9
|
+
| **type** | **String** | Data type of the parameter | |
|
|
10
|
+
| **options** | [**Array<ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner>**](ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.md) | Selectable options for enum-type parameters | [optional] |
|
|
11
|
+
| **description** | **String** | Description of the parameter | |
|
|
12
|
+
| **is_required** | **Boolean** | Whether the parameter is mandatory | [default to false] |
|
|
13
|
+
| **required_service** | **Array<String>** | Service IDs for which this parameter is required | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'zippendo'
|
|
19
|
+
|
|
20
|
+
instance = Zippendo::ListCarrierProducts200ResponseInnerAdditionalParametersInner.new(
|
|
21
|
+
name: Return Mode,
|
|
22
|
+
key: returnFunctionality,
|
|
23
|
+
type: enum,
|
|
24
|
+
options: null,
|
|
25
|
+
description: Instruction shown to the delivery driver,
|
|
26
|
+
is_required: false,
|
|
27
|
+
required_service: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|