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,20 @@
|
|
|
1
|
+
# Zippendo::ListShippingRules200ResponseDataInnerAdditionalParametersInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Carrier parameter key | |
|
|
8
|
+
| **val** | **String** | Parameter value (stringified) | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zippendo'
|
|
14
|
+
|
|
15
|
+
instance = Zippendo::ListShippingRules200ResponseDataInnerAdditionalParametersInner.new(
|
|
16
|
+
name: returnFunctionality,
|
|
17
|
+
val: LABELLESS
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Zippendo::ListShippingRules200ResponseDataInnerCarrier
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique carrier identifier | |
|
|
8
|
+
| **name** | **String** | Carrier display name | |
|
|
9
|
+
| **carrier_slug** | **String** | Carrier slug identifier | |
|
|
10
|
+
| **config** | [**Hash<String, ListCarriers200ResponseDataInnerConfigValue>**](ListCarriers200ResponseDataInnerConfigValue.md) | Carrier configuration (required and optional fields) | |
|
|
11
|
+
| **org_id** | **String** | Owning organization ID | |
|
|
12
|
+
| **created_at** | **String** | Creation timestamp (ISO 8601) | |
|
|
13
|
+
| **updated_at** | **String** | Last update timestamp (ISO 8601) | |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'zippendo'
|
|
19
|
+
|
|
20
|
+
instance = Zippendo::ListShippingRules200ResponseDataInnerCarrier.new(
|
|
21
|
+
id: carr_01HZX9K2QF,
|
|
22
|
+
name: PostNord,
|
|
23
|
+
carrier_slug: postnord,
|
|
24
|
+
config: {"customerNumber":"123456"},
|
|
25
|
+
org_id: org_01HZX9K2QF,
|
|
26
|
+
created_at: 2026-06-22T09:00:00.000Z,
|
|
27
|
+
updated_at: 2026-06-22T09:00:00.000Z
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# Zippendo::ListShippingRules200ResponseDataInnerConditionsInner
|
|
2
|
+
|
|
3
|
+
## Class instance methods
|
|
4
|
+
|
|
5
|
+
### `openapi_one_of`
|
|
6
|
+
|
|
7
|
+
Returns the list of classes defined in oneOf.
|
|
8
|
+
|
|
9
|
+
#### Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zippendo'
|
|
13
|
+
|
|
14
|
+
Zippendo::ListShippingRules200ResponseDataInnerConditionsInner.openapi_one_of
|
|
15
|
+
# =>
|
|
16
|
+
# [
|
|
17
|
+
# :'ListShippingRules200ResponseDataInnerConditionsInnerOneOf',
|
|
18
|
+
# :'ListShippingRules200ResponseDataInnerConditionsInnerOneOf1',
|
|
19
|
+
# :'ListShippingRules200ResponseDataInnerConditionsInnerOneOf2',
|
|
20
|
+
# :'ListShippingRules200ResponseDataInnerConditionsInnerOneOf3',
|
|
21
|
+
# :'ListShippingRules200ResponseDataInnerConditionsInnerOneOf4'
|
|
22
|
+
# ]
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### build
|
|
26
|
+
|
|
27
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
|
28
|
+
|
|
29
|
+
#### Example
|
|
30
|
+
|
|
31
|
+
```ruby
|
|
32
|
+
require 'zippendo'
|
|
33
|
+
|
|
34
|
+
Zippendo::ListShippingRules200ResponseDataInnerConditionsInner.build(data)
|
|
35
|
+
# => #<ListShippingRules200ResponseDataInnerConditionsInnerOneOf:0x00007fdd4aab02a0>
|
|
36
|
+
|
|
37
|
+
Zippendo::ListShippingRules200ResponseDataInnerConditionsInner.build(data_that_doesnt_match)
|
|
38
|
+
# => nil
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
#### Parameters
|
|
42
|
+
|
|
43
|
+
| Name | Type | Description |
|
|
44
|
+
| ---- | ---- | ----------- |
|
|
45
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
|
46
|
+
|
|
47
|
+
#### Return type
|
|
48
|
+
|
|
49
|
+
- `ListShippingRules200ResponseDataInnerConditionsInnerOneOf`
|
|
50
|
+
- `ListShippingRules200ResponseDataInnerConditionsInnerOneOf1`
|
|
51
|
+
- `ListShippingRules200ResponseDataInnerConditionsInnerOneOf2`
|
|
52
|
+
- `ListShippingRules200ResponseDataInnerConditionsInnerOneOf3`
|
|
53
|
+
- `ListShippingRules200ResponseDataInnerConditionsInnerOneOf4`
|
|
54
|
+
- `nil` (if no type matches)
|
|
55
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zippendo::ListShippingRules200ResponseDataInnerConditionsInnerOneOf
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | Condition type discriminator | |
|
|
8
|
+
| **min** | **Float** | Minimum weight in kg (inclusive) | |
|
|
9
|
+
| **max** | **Float** | Maximum weight in kg (inclusive) | |
|
|
10
|
+
| **shipping_price** | **Float** | Shipping price when condition matches | |
|
|
11
|
+
| **currency** | **String** | ISO 4217 currency code | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zippendo'
|
|
17
|
+
|
|
18
|
+
instance = Zippendo::ListShippingRules200ResponseDataInnerConditionsInnerOneOf.new(
|
|
19
|
+
type: weight,
|
|
20
|
+
min: 0,
|
|
21
|
+
max: 5,
|
|
22
|
+
shipping_price: 39,
|
|
23
|
+
currency: DKK
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Zippendo::ListShippingRules200ResponseDataInnerConditionsInnerOneOf1
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | Condition type discriminator | |
|
|
8
|
+
| **price_type** | **String** | Whether to compare against subtotal (before discounts) or total (after discounts) | [default to 'total'] |
|
|
9
|
+
| **operator** | **String** | Comparison operator | |
|
|
10
|
+
| **value** | **Float** | Price value to compare against | |
|
|
11
|
+
| **shipping_price** | **Float** | Shipping price when condition matches | |
|
|
12
|
+
| **currency** | **String** | ISO 4217 currency code | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'zippendo'
|
|
18
|
+
|
|
19
|
+
instance = Zippendo::ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.new(
|
|
20
|
+
type: price,
|
|
21
|
+
price_type: total,
|
|
22
|
+
operator: gte,
|
|
23
|
+
value: 500,
|
|
24
|
+
shipping_price: 0,
|
|
25
|
+
currency: DKK
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Zippendo::ListShippingRules200ResponseDataInnerConditionsInnerOneOf2
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | Condition type discriminator | |
|
|
8
|
+
| **price_type** | **String** | Whether to compare against subtotal (before discounts) or total (after discounts) | [default to 'total'] |
|
|
9
|
+
| **min** | **Float** | Minimum cart value (inclusive) | |
|
|
10
|
+
| **max** | **Float** | Maximum cart value (inclusive) | |
|
|
11
|
+
| **shipping_price** | **Float** | Shipping price when condition matches | |
|
|
12
|
+
| **currency** | **String** | ISO 4217 currency code | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'zippendo'
|
|
18
|
+
|
|
19
|
+
instance = Zippendo::ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.new(
|
|
20
|
+
type: priceRange,
|
|
21
|
+
price_type: total,
|
|
22
|
+
min: 0,
|
|
23
|
+
max: 499,
|
|
24
|
+
shipping_price: 49,
|
|
25
|
+
currency: DKK
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zippendo::ListShippingRules200ResponseDataInnerConditionsInnerOneOf3
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | Condition type discriminator | |
|
|
8
|
+
| **operator** | **String** | Comparison operator | |
|
|
9
|
+
| **value** | **Integer** | Quantity value to compare against | |
|
|
10
|
+
| **shipping_price** | **Float** | Shipping price when condition matches | |
|
|
11
|
+
| **currency** | **String** | ISO 4217 currency code | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zippendo'
|
|
17
|
+
|
|
18
|
+
instance = Zippendo::ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.new(
|
|
19
|
+
type: quantity,
|
|
20
|
+
operator: gte,
|
|
21
|
+
value: 3,
|
|
22
|
+
shipping_price: 0,
|
|
23
|
+
currency: DKK
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zippendo::ListShippingRules200ResponseDataInnerConditionsInnerOneOf4
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | Condition type discriminator | |
|
|
8
|
+
| **shipping_price** | **Float** | Flat shipping price | |
|
|
9
|
+
| **currency** | **String** | ISO 4217 currency code | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zippendo'
|
|
15
|
+
|
|
16
|
+
instance = Zippendo::ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.new(
|
|
17
|
+
type: flatRate,
|
|
18
|
+
shipping_price: 39,
|
|
19
|
+
currency: DKK
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zippendo::ListShippingRules200ResponseDataInnerLabelPrinter
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Printer ID | |
|
|
8
|
+
| **name** | **String** | Printer name | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zippendo'
|
|
14
|
+
|
|
15
|
+
instance = Zippendo::ListShippingRules200ResponseDataInnerLabelPrinter.new(
|
|
16
|
+
id: prn_01HZX9K2QF,
|
|
17
|
+
name: Zebra ZD420 Lager
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zippendo::ListShippingRules200ResponseDataInnerReturnShippingRule
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Return shipping rule ID | |
|
|
8
|
+
| **name** | **String** | Return shipping rule name | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zippendo'
|
|
14
|
+
|
|
15
|
+
instance = Zippendo::ListShippingRules200ResponseDataInnerReturnShippingRule.new(
|
|
16
|
+
id: rule_01HZX9K2QF,
|
|
17
|
+
name: Retur DK
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/OrdersApi.md
ADDED
|
@@ -0,0 +1,379 @@
|
|
|
1
|
+
# Zippendo::OrdersApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.zippendo.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_order**](OrdersApi.md#create_order) | **POST** /orgs/{orgId}/orders | Create order |
|
|
8
|
+
| [**delete_order**](OrdersApi.md#delete_order) | **DELETE** /orgs/{orgId}/orders/{orderId} | Delete order |
|
|
9
|
+
| [**get_order**](OrdersApi.md#get_order) | **GET** /orgs/{orgId}/orders/{orderId} | Get order |
|
|
10
|
+
| [**list_orders**](OrdersApi.md#list_orders) | **GET** /orgs/{orgId}/orders | List orders |
|
|
11
|
+
| [**update_order**](OrdersApi.md#update_order) | **PATCH** /orgs/{orgId}/orders/{orderId} | Update order |
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## create_order
|
|
15
|
+
|
|
16
|
+
> <CreateOrder201Response> create_order(org_id, create_order_request)
|
|
17
|
+
|
|
18
|
+
Create order
|
|
19
|
+
|
|
20
|
+
Creates a new order under an existing order channel for the organization.
|
|
21
|
+
|
|
22
|
+
### Examples
|
|
23
|
+
|
|
24
|
+
```ruby
|
|
25
|
+
require 'time'
|
|
26
|
+
require 'zippendo'
|
|
27
|
+
# setup authorization
|
|
28
|
+
Zippendo.configure do |config|
|
|
29
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
30
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
api_instance = Zippendo::OrdersApi.new
|
|
34
|
+
org_id = 'org_8f3kd92ld0' # String | Organization ID
|
|
35
|
+
create_order_request = Zippendo::CreateOrderRequest.new({order_number: '#1042', order_channel_id: 'clz9k2f0a0001abcd1234efgh', order_lines: [Zippendo::CreateOrderRequestOrderLinesInner.new({name: 'Wool Sweater', quantity: 2})]}) # CreateOrderRequest |
|
|
36
|
+
|
|
37
|
+
begin
|
|
38
|
+
# Create order
|
|
39
|
+
result = api_instance.create_order(org_id, create_order_request)
|
|
40
|
+
p result
|
|
41
|
+
rescue Zippendo::ApiError => e
|
|
42
|
+
puts "Error when calling OrdersApi->create_order: #{e}"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
#### Using the create_order_with_http_info variant
|
|
47
|
+
|
|
48
|
+
This returns an Array which contains the response data, status code and headers.
|
|
49
|
+
|
|
50
|
+
> <Array(<CreateOrder201Response>, Integer, Hash)> create_order_with_http_info(org_id, create_order_request)
|
|
51
|
+
|
|
52
|
+
```ruby
|
|
53
|
+
begin
|
|
54
|
+
# Create order
|
|
55
|
+
data, status_code, headers = api_instance.create_order_with_http_info(org_id, create_order_request)
|
|
56
|
+
p status_code # => 2xx
|
|
57
|
+
p headers # => { ... }
|
|
58
|
+
p data # => <CreateOrder201Response>
|
|
59
|
+
rescue Zippendo::ApiError => e
|
|
60
|
+
puts "Error when calling OrdersApi->create_order_with_http_info: #{e}"
|
|
61
|
+
end
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Parameters
|
|
65
|
+
|
|
66
|
+
| Name | Type | Description | Notes |
|
|
67
|
+
| ---- | ---- | ----------- | ----- |
|
|
68
|
+
| **org_id** | **String** | Organization ID | |
|
|
69
|
+
| **create_order_request** | [**CreateOrderRequest**](CreateOrderRequest.md) | | |
|
|
70
|
+
|
|
71
|
+
### Return type
|
|
72
|
+
|
|
73
|
+
[**CreateOrder201Response**](CreateOrder201Response.md)
|
|
74
|
+
|
|
75
|
+
### Authorization
|
|
76
|
+
|
|
77
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
78
|
+
|
|
79
|
+
### HTTP request headers
|
|
80
|
+
|
|
81
|
+
- **Content-Type**: application/json
|
|
82
|
+
- **Accept**: application/json
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
## delete_order
|
|
86
|
+
|
|
87
|
+
> <RevokeApiToken200Response> delete_order(org_id, order_id)
|
|
88
|
+
|
|
89
|
+
Delete order
|
|
90
|
+
|
|
91
|
+
Deletes an order. Fails if the order has associated shipments.
|
|
92
|
+
|
|
93
|
+
### Examples
|
|
94
|
+
|
|
95
|
+
```ruby
|
|
96
|
+
require 'time'
|
|
97
|
+
require 'zippendo'
|
|
98
|
+
# setup authorization
|
|
99
|
+
Zippendo.configure do |config|
|
|
100
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
101
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
api_instance = Zippendo::OrdersApi.new
|
|
105
|
+
org_id = 'clz9k2f0a0000abcd0000zzzz' # String | Organization ID.
|
|
106
|
+
order_id = 'clz9k2f0a0003abcd9012mnop' # String | Order ID.
|
|
107
|
+
|
|
108
|
+
begin
|
|
109
|
+
# Delete order
|
|
110
|
+
result = api_instance.delete_order(org_id, order_id)
|
|
111
|
+
p result
|
|
112
|
+
rescue Zippendo::ApiError => e
|
|
113
|
+
puts "Error when calling OrdersApi->delete_order: #{e}"
|
|
114
|
+
end
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
#### Using the delete_order_with_http_info variant
|
|
118
|
+
|
|
119
|
+
This returns an Array which contains the response data, status code and headers.
|
|
120
|
+
|
|
121
|
+
> <Array(<RevokeApiToken200Response>, Integer, Hash)> delete_order_with_http_info(org_id, order_id)
|
|
122
|
+
|
|
123
|
+
```ruby
|
|
124
|
+
begin
|
|
125
|
+
# Delete order
|
|
126
|
+
data, status_code, headers = api_instance.delete_order_with_http_info(org_id, order_id)
|
|
127
|
+
p status_code # => 2xx
|
|
128
|
+
p headers # => { ... }
|
|
129
|
+
p data # => <RevokeApiToken200Response>
|
|
130
|
+
rescue Zippendo::ApiError => e
|
|
131
|
+
puts "Error when calling OrdersApi->delete_order_with_http_info: #{e}"
|
|
132
|
+
end
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Parameters
|
|
136
|
+
|
|
137
|
+
| Name | Type | Description | Notes |
|
|
138
|
+
| ---- | ---- | ----------- | ----- |
|
|
139
|
+
| **org_id** | **String** | Organization ID. | |
|
|
140
|
+
| **order_id** | **String** | Order ID. | |
|
|
141
|
+
|
|
142
|
+
### Return type
|
|
143
|
+
|
|
144
|
+
[**RevokeApiToken200Response**](RevokeApiToken200Response.md)
|
|
145
|
+
|
|
146
|
+
### Authorization
|
|
147
|
+
|
|
148
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
149
|
+
|
|
150
|
+
### HTTP request headers
|
|
151
|
+
|
|
152
|
+
- **Content-Type**: Not defined
|
|
153
|
+
- **Accept**: application/json
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
## get_order
|
|
157
|
+
|
|
158
|
+
> <GetOrder200Response> get_order(org_id, order_id)
|
|
159
|
+
|
|
160
|
+
Get order
|
|
161
|
+
|
|
162
|
+
Returns a single order with its channel, shipping rule, shipments, and documents.
|
|
163
|
+
|
|
164
|
+
### Examples
|
|
165
|
+
|
|
166
|
+
```ruby
|
|
167
|
+
require 'time'
|
|
168
|
+
require 'zippendo'
|
|
169
|
+
# setup authorization
|
|
170
|
+
Zippendo.configure do |config|
|
|
171
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
172
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
api_instance = Zippendo::OrdersApi.new
|
|
176
|
+
org_id = 'clz9k2f0a0000abcd0000zzzz' # String | Organization ID.
|
|
177
|
+
order_id = 'clz9k2f0a0003abcd9012mnop' # String | Order ID.
|
|
178
|
+
|
|
179
|
+
begin
|
|
180
|
+
# Get order
|
|
181
|
+
result = api_instance.get_order(org_id, order_id)
|
|
182
|
+
p result
|
|
183
|
+
rescue Zippendo::ApiError => e
|
|
184
|
+
puts "Error when calling OrdersApi->get_order: #{e}"
|
|
185
|
+
end
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
#### Using the get_order_with_http_info variant
|
|
189
|
+
|
|
190
|
+
This returns an Array which contains the response data, status code and headers.
|
|
191
|
+
|
|
192
|
+
> <Array(<GetOrder200Response>, Integer, Hash)> get_order_with_http_info(org_id, order_id)
|
|
193
|
+
|
|
194
|
+
```ruby
|
|
195
|
+
begin
|
|
196
|
+
# Get order
|
|
197
|
+
data, status_code, headers = api_instance.get_order_with_http_info(org_id, order_id)
|
|
198
|
+
p status_code # => 2xx
|
|
199
|
+
p headers # => { ... }
|
|
200
|
+
p data # => <GetOrder200Response>
|
|
201
|
+
rescue Zippendo::ApiError => e
|
|
202
|
+
puts "Error when calling OrdersApi->get_order_with_http_info: #{e}"
|
|
203
|
+
end
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
### Parameters
|
|
207
|
+
|
|
208
|
+
| Name | Type | Description | Notes |
|
|
209
|
+
| ---- | ---- | ----------- | ----- |
|
|
210
|
+
| **org_id** | **String** | Organization ID. | |
|
|
211
|
+
| **order_id** | **String** | Order ID. | |
|
|
212
|
+
|
|
213
|
+
### Return type
|
|
214
|
+
|
|
215
|
+
[**GetOrder200Response**](GetOrder200Response.md)
|
|
216
|
+
|
|
217
|
+
### Authorization
|
|
218
|
+
|
|
219
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
220
|
+
|
|
221
|
+
### HTTP request headers
|
|
222
|
+
|
|
223
|
+
- **Content-Type**: Not defined
|
|
224
|
+
- **Accept**: application/json
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
## list_orders
|
|
228
|
+
|
|
229
|
+
> <ListOrders200Response> list_orders(org_id, opts)
|
|
230
|
+
|
|
231
|
+
List orders
|
|
232
|
+
|
|
233
|
+
Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
|
|
234
|
+
|
|
235
|
+
### Examples
|
|
236
|
+
|
|
237
|
+
```ruby
|
|
238
|
+
require 'time'
|
|
239
|
+
require 'zippendo'
|
|
240
|
+
# setup authorization
|
|
241
|
+
Zippendo.configure do |config|
|
|
242
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
243
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
244
|
+
end
|
|
245
|
+
|
|
246
|
+
api_instance = Zippendo::OrdersApi.new
|
|
247
|
+
org_id = 'org_8f3kd92ld0' # String | Organization ID
|
|
248
|
+
opts = {
|
|
249
|
+
page: 1, # Integer | Page number (1-based)
|
|
250
|
+
limit: 20, # Integer | Items per page (max 100)
|
|
251
|
+
status: 'pending', # String | Order fulfilment status derived from its shipments.
|
|
252
|
+
order_channel_id: 'clz9k2f0a0001abcd1234efgh', # String | Filter by order channel ID.
|
|
253
|
+
search: 'Anna' # String | Search by order number or customer name/email.
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
begin
|
|
257
|
+
# List orders
|
|
258
|
+
result = api_instance.list_orders(org_id, opts)
|
|
259
|
+
p result
|
|
260
|
+
rescue Zippendo::ApiError => e
|
|
261
|
+
puts "Error when calling OrdersApi->list_orders: #{e}"
|
|
262
|
+
end
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
#### Using the list_orders_with_http_info variant
|
|
266
|
+
|
|
267
|
+
This returns an Array which contains the response data, status code and headers.
|
|
268
|
+
|
|
269
|
+
> <Array(<ListOrders200Response>, Integer, Hash)> list_orders_with_http_info(org_id, opts)
|
|
270
|
+
|
|
271
|
+
```ruby
|
|
272
|
+
begin
|
|
273
|
+
# List orders
|
|
274
|
+
data, status_code, headers = api_instance.list_orders_with_http_info(org_id, opts)
|
|
275
|
+
p status_code # => 2xx
|
|
276
|
+
p headers # => { ... }
|
|
277
|
+
p data # => <ListOrders200Response>
|
|
278
|
+
rescue Zippendo::ApiError => e
|
|
279
|
+
puts "Error when calling OrdersApi->list_orders_with_http_info: #{e}"
|
|
280
|
+
end
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
### Parameters
|
|
284
|
+
|
|
285
|
+
| Name | Type | Description | Notes |
|
|
286
|
+
| ---- | ---- | ----------- | ----- |
|
|
287
|
+
| **org_id** | **String** | Organization ID | |
|
|
288
|
+
| **page** | **Integer** | Page number (1-based) | [optional][default to 1] |
|
|
289
|
+
| **limit** | **Integer** | Items per page (max 100) | [optional][default to 20] |
|
|
290
|
+
| **status** | **String** | Order fulfilment status derived from its shipments. | [optional] |
|
|
291
|
+
| **order_channel_id** | **String** | Filter by order channel ID. | [optional] |
|
|
292
|
+
| **search** | **String** | Search by order number or customer name/email. | [optional] |
|
|
293
|
+
|
|
294
|
+
### Return type
|
|
295
|
+
|
|
296
|
+
[**ListOrders200Response**](ListOrders200Response.md)
|
|
297
|
+
|
|
298
|
+
### Authorization
|
|
299
|
+
|
|
300
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
301
|
+
|
|
302
|
+
### HTTP request headers
|
|
303
|
+
|
|
304
|
+
- **Content-Type**: Not defined
|
|
305
|
+
- **Accept**: application/json
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
## update_order
|
|
309
|
+
|
|
310
|
+
> <CreateOrder201Response> update_order(org_id, order_id, update_order_request)
|
|
311
|
+
|
|
312
|
+
Update order
|
|
313
|
+
|
|
314
|
+
Updates an order that is not yet fulfilled or cancelled.
|
|
315
|
+
|
|
316
|
+
### Examples
|
|
317
|
+
|
|
318
|
+
```ruby
|
|
319
|
+
require 'time'
|
|
320
|
+
require 'zippendo'
|
|
321
|
+
# setup authorization
|
|
322
|
+
Zippendo.configure do |config|
|
|
323
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
324
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
325
|
+
end
|
|
326
|
+
|
|
327
|
+
api_instance = Zippendo::OrdersApi.new
|
|
328
|
+
org_id = 'clz9k2f0a0000abcd0000zzzz' # String | Organization ID.
|
|
329
|
+
order_id = 'clz9k2f0a0003abcd9012mnop' # String | Order ID.
|
|
330
|
+
update_order_request = Zippendo::UpdateOrderRequest.new # UpdateOrderRequest |
|
|
331
|
+
|
|
332
|
+
begin
|
|
333
|
+
# Update order
|
|
334
|
+
result = api_instance.update_order(org_id, order_id, update_order_request)
|
|
335
|
+
p result
|
|
336
|
+
rescue Zippendo::ApiError => e
|
|
337
|
+
puts "Error when calling OrdersApi->update_order: #{e}"
|
|
338
|
+
end
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
#### Using the update_order_with_http_info variant
|
|
342
|
+
|
|
343
|
+
This returns an Array which contains the response data, status code and headers.
|
|
344
|
+
|
|
345
|
+
> <Array(<CreateOrder201Response>, Integer, Hash)> update_order_with_http_info(org_id, order_id, update_order_request)
|
|
346
|
+
|
|
347
|
+
```ruby
|
|
348
|
+
begin
|
|
349
|
+
# Update order
|
|
350
|
+
data, status_code, headers = api_instance.update_order_with_http_info(org_id, order_id, update_order_request)
|
|
351
|
+
p status_code # => 2xx
|
|
352
|
+
p headers # => { ... }
|
|
353
|
+
p data # => <CreateOrder201Response>
|
|
354
|
+
rescue Zippendo::ApiError => e
|
|
355
|
+
puts "Error when calling OrdersApi->update_order_with_http_info: #{e}"
|
|
356
|
+
end
|
|
357
|
+
```
|
|
358
|
+
|
|
359
|
+
### Parameters
|
|
360
|
+
|
|
361
|
+
| Name | Type | Description | Notes |
|
|
362
|
+
| ---- | ---- | ----------- | ----- |
|
|
363
|
+
| **org_id** | **String** | Organization ID. | |
|
|
364
|
+
| **order_id** | **String** | Order ID. | |
|
|
365
|
+
| **update_order_request** | [**UpdateOrderRequest**](UpdateOrderRequest.md) | | |
|
|
366
|
+
|
|
367
|
+
### Return type
|
|
368
|
+
|
|
369
|
+
[**CreateOrder201Response**](CreateOrder201Response.md)
|
|
370
|
+
|
|
371
|
+
### Authorization
|
|
372
|
+
|
|
373
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
374
|
+
|
|
375
|
+
### HTTP request headers
|
|
376
|
+
|
|
377
|
+
- **Content-Type**: application/json
|
|
378
|
+
- **Accept**: application/json
|
|
379
|
+
|