zippendo 1.0.3 → 1.1.2
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 +4 -4
- data/README.md +32 -8
- data/docs/BatchSplitShipmentRequest.md +1 -1
- data/docs/BrandsApi.md +733 -0
- data/docs/CheckBrandSlug200Response.md +20 -0
- data/docs/CreateOrgBrandRequest.md +42 -0
- data/docs/CreateShipment201ResponseParcelsInner.md +2 -2
- data/docs/CreateShipment201ResponseTracking.md +2 -2
- data/docs/CreateShipmentRequestCarrierSettings.md +1 -1
- data/docs/CreateShipmentRequestParcelsInner.md +2 -2
- data/docs/CreateShippingRule201Response.md +2 -2
- data/docs/CreateShippingRuleRequest.md +2 -2
- data/docs/{CreateShippingRuleRequestAdditionalParametersAnyOfValue.md → CreateShippingRuleRequestAdditionalParametersValue.md} +3 -3
- data/docs/{CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.md → CreateShippingRuleRequestAdditionalParametersValueAnyOf.md} +3 -3
- data/docs/ListOrgBrands200Response.md +18 -0
- data/docs/ListOrgBrands200ResponseDataInner.md +54 -0
- data/docs/ListShipments200ResponseDataInnerCarrierSettings.md +1 -1
- data/docs/ListShippingRules200ResponseDataInner.md +2 -2
- data/docs/{ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.md → ListShippingRules200ResponseDataInnerAdditionalParametersValue.md} +3 -3
- data/docs/{ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.md → ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.md} +3 -3
- data/docs/{ListShippingRules200ResponseDataInnerAdditionalParametersInner.md → ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.md} +2 -7
- data/docs/ShipmentsApi.md +1 -1
- data/docs/SplitShipmentRequest.md +1 -1
- data/docs/UpdateOrgBrandRequest.md +42 -0
- data/docs/UpdateShippingRuleRequest.md +2 -2
- data/lib/zippendo/api/addresses_api.rb +1 -1
- data/lib/zippendo/api/billing_api.rb +1 -1
- data/lib/zippendo/api/brands_api.rb +750 -0
- data/lib/zippendo/api/carrier_catalog_api.rb +1 -1
- data/lib/zippendo/api/carriers_api.rb +1 -1
- data/lib/zippendo/api/orders_api.rb +1 -1
- data/lib/zippendo/api/orgs_api.rb +1 -1
- data/lib/zippendo/api/quotes_api.rb +1 -1
- data/lib/zippendo/api/rules_api.rb +1 -1
- data/lib/zippendo/api/shipments_api.rb +1 -1
- data/lib/zippendo/api/system_api.rb +1 -1
- data/lib/zippendo/api/tokens_api.rb +1 -1
- data/lib/zippendo/api/webhooks_api.rb +1 -1
- data/lib/zippendo/api_client.rb +1 -1
- data/lib/zippendo/api_error.rb +1 -1
- data/lib/zippendo/api_model_base.rb +1 -1
- data/lib/zippendo/configuration.rb +1 -1
- data/lib/zippendo/models/batch_send_shipments200_response.rb +1 -1
- data/lib/zippendo/models/batch_send_shipments200_response_results_inner.rb +1 -1
- data/lib/zippendo/models/batch_send_shipments200_response_summary.rb +1 -1
- data/lib/zippendo/models/batch_send_shipments_request.rb +1 -1
- data/lib/zippendo/models/batch_split_shipment201_response.rb +1 -1
- data/lib/zippendo/models/batch_split_shipment_request.rb +3 -3
- data/lib/zippendo/models/batch_split_shipment_request_shipments_inner.rb +1 -1
- data/lib/zippendo/models/batch_split_shipment_request_shipments_inner_order_lines_inner.rb +1 -1
- data/lib/zippendo/models/{create_shipping_rule_request_additional_parameters_any_of_inner.rb → check_brand_slug200_response.rb} +37 -46
- data/lib/zippendo/models/connect_carrier_request.rb +1 -1
- data/lib/zippendo/models/create_address_request.rb +1 -1
- data/lib/zippendo/models/create_api_token201_response.rb +1 -1
- data/lib/zippendo/models/create_api_token_request.rb +1 -1
- data/lib/zippendo/models/create_order201_response.rb +1 -1
- data/lib/zippendo/models/create_order201_response_order_lines_inner.rb +1 -1
- data/lib/zippendo/models/create_order201_response_shipping_address.rb +1 -1
- data/lib/zippendo/models/create_order_request.rb +1 -1
- data/lib/zippendo/models/create_order_request_order_lines_inner.rb +1 -1
- data/lib/zippendo/models/create_order_request_shipping_address.rb +1 -1
- data/lib/zippendo/models/create_org_brand_request.rb +502 -0
- data/lib/zippendo/models/create_org_webhook201_response.rb +1 -1
- data/lib/zippendo/models/create_org_webhook_request.rb +1 -1
- data/lib/zippendo/models/create_shipment201_response.rb +1 -1
- data/lib/zippendo/models/create_shipment201_response_activities_inner.rb +1 -1
- data/lib/zippendo/models/create_shipment201_response_documents_inner.rb +1 -1
- data/lib/zippendo/models/create_shipment201_response_errors_inner.rb +1 -1
- data/lib/zippendo/models/create_shipment201_response_logs_inner.rb +1 -1
- data/lib/zippendo/models/create_shipment201_response_parcels_inner.rb +3 -3
- data/lib/zippendo/models/create_shipment201_response_parcels_inner_dimensions.rb +1 -1
- data/lib/zippendo/models/create_shipment201_response_parcels_inner_order_lines_inner.rb +1 -1
- data/lib/zippendo/models/create_shipment201_response_parties_inner.rb +1 -1
- data/lib/zippendo/models/create_shipment201_response_parties_inner_attributes_inner.rb +1 -1
- data/lib/zippendo/models/create_shipment201_response_pickup_details.rb +1 -1
- data/lib/zippendo/models/create_shipment201_response_shipping_rule.rb +1 -1
- data/lib/zippendo/models/create_shipment201_response_tracking.rb +3 -3
- data/lib/zippendo/models/create_shipment_request.rb +1 -1
- data/lib/zippendo/models/create_shipment_request_carrier_settings.rb +2 -2
- data/lib/zippendo/models/create_shipment_request_parcels_inner.rb +3 -3
- data/lib/zippendo/models/create_shipment_request_parcels_inner_dimensions.rb +1 -1
- data/lib/zippendo/models/create_shipment_request_parcels_inner_order_lines_inner.rb +1 -1
- data/lib/zippendo/models/create_shipment_request_parties_inner.rb +1 -1
- data/lib/zippendo/models/create_shipment_request_parties_inner_attributes_inner.rb +1 -1
- data/lib/zippendo/models/create_shipment_request_pickup_details.rb +1 -1
- data/lib/zippendo/models/create_shipping_quote200_response.rb +1 -1
- data/lib/zippendo/models/create_shipping_quote200_response_rates_inner.rb +1 -1
- data/lib/zippendo/models/create_shipping_quote400_response.rb +1 -1
- data/lib/zippendo/models/create_shipping_quote404_response.rb +1 -1
- data/lib/zippendo/models/create_shipping_quote_request.rb +1 -1
- data/lib/zippendo/models/create_shipping_quote_request_destination.rb +1 -1
- data/lib/zippendo/models/create_shipping_quote_request_items_inner.rb +1 -1
- data/lib/zippendo/models/create_shipping_rule201_response.rb +4 -4
- data/lib/zippendo/models/create_shipping_rule_request.rb +6 -3
- data/lib/zippendo/models/{list_shipments200_response_data_inner_carrier_settings_additional_parameters_value.rb → create_shipping_rule_request_additional_parameters_value.rb} +3 -3
- data/lib/zippendo/models/{create_shipping_rule_request_additional_parameters_any_of_value_any_of.rb → create_shipping_rule_request_additional_parameters_value_any_of.rb} +5 -5
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner.rb +1 -1
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of.rb +1 -1
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of1.rb +1 -1
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of2.rb +1 -1
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of3.rb +1 -1
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of4.rb +1 -1
- data/lib/zippendo/models/delete_org_webhook200_response.rb +1 -1
- data/lib/zippendo/models/delete_shipping_rule200_response.rb +1 -1
- data/lib/zippendo/models/get_billing_usage200_response.rb +1 -1
- data/lib/zippendo/models/get_billing_usage200_response_add_ons_inner.rb +1 -1
- data/lib/zippendo/models/get_billing_usage200_response_current_period.rb +1 -1
- data/lib/zippendo/models/get_billing_usage200_response_limits.rb +1 -1
- data/lib/zippendo/models/get_billing_usage200_response_limits_team_members.rb +1 -1
- data/lib/zippendo/models/get_billing_usage200_response_shipments.rb +1 -1
- data/lib/zippendo/models/get_order200_response.rb +1 -1
- data/lib/zippendo/models/get_order200_response_shipments_inner.rb +1 -1
- data/lib/zippendo/models/get_order200_response_shipping_rule.rb +1 -1
- data/lib/zippendo/models/get_org200_response.rb +1 -1
- data/lib/zippendo/models/get_org200_response_count.rb +1 -1
- data/lib/zippendo/models/get_org_branding200_response.rb +1 -1
- data/lib/zippendo/models/health_check200_response.rb +1 -1
- data/lib/zippendo/models/list_addresses200_response.rb +1 -1
- data/lib/zippendo/models/list_addresses200_response_data_inner.rb +1 -1
- data/lib/zippendo/models/list_api_tokens200_response.rb +1 -1
- data/lib/zippendo/models/list_api_tokens200_response_data_inner.rb +1 -1
- data/lib/zippendo/models/list_api_tokens200_response_data_inner_created_by.rb +1 -1
- data/lib/zippendo/models/list_api_tokens401_response.rb +1 -1
- data/lib/zippendo/models/list_available_carriers200_response_inner.rb +1 -1
- data/lib/zippendo/models/list_available_carriers200_response_inner_required_fields_inner.rb +1 -1
- data/lib/zippendo/models/list_carrier_product_service_points200_response_inner.rb +1 -1
- data/lib/zippendo/models/list_carrier_product_service_points200_response_inner_address.rb +1 -1
- data/lib/zippendo/models/list_carrier_product_service_points_request.rb +1 -1
- data/lib/zippendo/models/list_carrier_products200_response_inner.rb +1 -1
- data/lib/zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner.rb +1 -1
- data/lib/zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner_options_inner.rb +1 -1
- data/lib/zippendo/models/list_carrier_products200_response_inner_services_inner.rb +1 -1
- data/lib/zippendo/models/list_carrier_products200_response_inner_weight_limits.rb +1 -1
- data/lib/zippendo/models/list_carriers200_response.rb +1 -1
- data/lib/zippendo/models/list_carriers200_response_data_inner.rb +1 -1
- data/lib/zippendo/models/list_carriers200_response_data_inner_config_value.rb +1 -1
- data/lib/zippendo/models/list_orders200_response.rb +1 -1
- data/lib/zippendo/models/list_orders200_response_data_inner.rb +1 -1
- data/lib/zippendo/models/list_orders200_response_data_inner_order_channel.rb +1 -1
- data/lib/zippendo/models/{list_shipping_rules200_response_data_inner_additional_parameters_inner.rb → list_org_brands200_response.rb} +22 -57
- data/lib/zippendo/models/list_org_brands200_response_data_inner.rb +613 -0
- data/lib/zippendo/models/list_org_webhook_deliveries200_response.rb +1 -1
- data/lib/zippendo/models/list_org_webhook_deliveries200_response_data_inner.rb +1 -1
- data/lib/zippendo/models/list_org_webhooks200_response.rb +1 -1
- data/lib/zippendo/models/list_org_webhooks200_response_data_inner.rb +1 -1
- data/lib/zippendo/models/list_shipments200_response.rb +1 -1
- data/lib/zippendo/models/list_shipments200_response_data_inner.rb +1 -1
- data/lib/zippendo/models/list_shipments200_response_data_inner_address.rb +1 -1
- data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings.rb +2 -2
- data/lib/zippendo/models/list_shipping_rules200_response.rb +1 -1
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner.rb +4 -4
- data/lib/zippendo/models/{create_shipping_rule_request_additional_parameters_any_of_value.rb → list_shipping_rules200_response_data_inner_additional_parameters_value.rb} +3 -3
- data/lib/zippendo/models/{list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_any_of.rb → list_shipping_rules200_response_data_inner_additional_parameters_value_any_of.rb} +5 -5
- data/lib/zippendo/models/{create_shipping_rule_request_additional_parameters_any_of_value_any_of_coordinates_inner.rb → list_shipping_rules200_response_data_inner_additional_parameters_value_any_of_coordinates_inner.rb} +2 -2
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_carrier.rb +1 -1
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner.rb +1 -1
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of.rb +1 -1
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of1.rb +1 -1
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of2.rb +1 -1
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of3.rb +1 -1
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of4.rb +1 -1
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_label_printer.rb +1 -1
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_return_shipping_rule.rb +1 -1
- data/lib/zippendo/models/revoke_api_token200_response.rb +1 -1
- data/lib/zippendo/models/send_shipment422_response.rb +1 -1
- data/lib/zippendo/models/send_shipment422_response_errors_inner.rb +1 -1
- data/lib/zippendo/models/split_shipment201_response.rb +1 -1
- data/lib/zippendo/models/split_shipment_parcel200_response.rb +1 -1
- data/lib/zippendo/models/split_shipment_parcel_request.rb +1 -1
- data/lib/zippendo/models/split_shipment_parcel_request_parcels_inner.rb +1 -1
- data/lib/zippendo/models/split_shipment_request.rb +3 -3
- data/lib/zippendo/models/test_org_webhook200_response.rb +1 -1
- data/lib/zippendo/models/track_shipment200_response.rb +1 -1
- data/lib/zippendo/models/track_shipment200_response_events_inner.rb +1 -1
- data/lib/zippendo/models/update_address_request.rb +1 -1
- data/lib/zippendo/models/update_api_token_request.rb +1 -1
- data/lib/zippendo/models/update_carrier_request.rb +1 -1
- data/lib/zippendo/models/update_order_request.rb +1 -1
- data/lib/zippendo/models/update_org200_response.rb +1 -1
- data/lib/zippendo/models/update_org_brand_request.rb +495 -0
- data/lib/zippendo/models/update_org_branding_request.rb +1 -1
- data/lib/zippendo/models/update_org_request.rb +1 -1
- data/lib/zippendo/models/update_org_webhook_request.rb +1 -1
- data/lib/zippendo/models/update_shipment_request.rb +1 -1
- data/lib/zippendo/models/update_shipping_rule_request.rb +6 -3
- data/lib/zippendo/models/verify_api_token200_response.rb +1 -1
- data/lib/zippendo/models/verify_api_token_request.rb +1 -1
- data/lib/zippendo/version.rb +2 -2
- data/lib/zippendo.rb +12 -9
- data/spec/spec_helper.rb +1 -1
- data/zippendo.gemspec +2 -2
- metadata +29 -328
- data/docs/CreateShippingRuleRequestAdditionalParameters.md +0 -15
- data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfInner.md +0 -20
- data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.md +0 -15
- data/lib/zippendo/models/create_shipping_rule_request_additional_parameters.rb +0 -104
- data/spec/api/addresses_api_spec.rb +0 -103
- data/spec/api/billing_api_spec.rb +0 -47
- data/spec/api/carrier_catalog_api_spec.rb +0 -47
- data/spec/api/carriers_api_spec.rb +0 -130
- data/spec/api/orders_api_spec.rb +0 -106
- data/spec/api/orgs_api_spec.rb +0 -122
- data/spec/api/quotes_api_spec.rb +0 -48
- data/spec/api/rules_api_spec.rb +0 -102
- data/spec/api/shipments_api_spec.rb +0 -213
- data/spec/api/system_api_spec.rb +0 -46
- data/spec/api/tokens_api_spec.rb +0 -114
- data/spec/api/webhooks_api_spec.rb +0 -130
- data/spec/models/batch_send_shipments200_response_results_inner_spec.rb +0 -68
- data/spec/models/batch_send_shipments200_response_spec.rb +0 -42
- data/spec/models/batch_send_shipments200_response_summary_spec.rb +0 -48
- data/spec/models/batch_send_shipments_request_spec.rb +0 -36
- data/spec/models/batch_split_shipment201_response_spec.rb +0 -42
- data/spec/models/batch_split_shipment_request_shipments_inner_order_lines_inner_spec.rb +0 -42
- data/spec/models/batch_split_shipment_request_shipments_inner_spec.rb +0 -42
- data/spec/models/batch_split_shipment_request_spec.rb +0 -66
- data/spec/models/connect_carrier_request_spec.rb +0 -48
- data/spec/models/create_address_request_spec.rb +0 -106
- data/spec/models/create_api_token201_response_spec.rb +0 -84
- data/spec/models/create_api_token_request_spec.rb +0 -58
- data/spec/models/create_order201_response_order_lines_inner_spec.rb +0 -148
- data/spec/models/create_order201_response_shipping_address_spec.rb +0 -108
- data/spec/models/create_order201_response_spec.rb +0 -142
- data/spec/models/create_order_request_order_lines_inner_spec.rb +0 -148
- data/spec/models/create_order_request_shipping_address_spec.rb +0 -108
- data/spec/models/create_order_request_spec.rb +0 -102
- data/spec/models/create_org_webhook201_response_spec.rb +0 -78
- data/spec/models/create_org_webhook_request_spec.rb +0 -58
- data/spec/models/create_shipment201_response_activities_inner_spec.rb +0 -64
- data/spec/models/create_shipment201_response_documents_inner_spec.rb +0 -90
- data/spec/models/create_shipment201_response_errors_inner_spec.rb +0 -60
- data/spec/models/create_shipment201_response_logs_inner_spec.rb +0 -82
- data/spec/models/create_shipment201_response_parcels_inner_dimensions_spec.rb +0 -48
- data/spec/models/create_shipment201_response_parcels_inner_order_lines_inner_spec.rb +0 -90
- data/spec/models/create_shipment201_response_parcels_inner_spec.rb +0 -100
- data/spec/models/create_shipment201_response_parties_inner_attributes_inner_spec.rb +0 -42
- data/spec/models/create_shipment201_response_parties_inner_spec.rb +0 -100
- data/spec/models/create_shipment201_response_pickup_details_spec.rb +0 -54
- data/spec/models/create_shipment201_response_shipping_rule_spec.rb +0 -102
- data/spec/models/create_shipment201_response_spec.rb +0 -182
- data/spec/models/create_shipment201_response_tracking_spec.rb +0 -66
- data/spec/models/create_shipment_request_carrier_settings_spec.rb +0 -54
- data/spec/models/create_shipment_request_parcels_inner_dimensions_spec.rb +0 -48
- data/spec/models/create_shipment_request_parcels_inner_order_lines_inner_spec.rb +0 -90
- data/spec/models/create_shipment_request_parcels_inner_spec.rb +0 -100
- data/spec/models/create_shipment_request_parties_inner_attributes_inner_spec.rb +0 -42
- data/spec/models/create_shipment_request_parties_inner_spec.rb +0 -100
- data/spec/models/create_shipment_request_pickup_details_spec.rb +0 -54
- data/spec/models/create_shipment_request_spec.rb +0 -116
- data/spec/models/create_shipping_quote200_response_rates_inner_spec.rb +0 -96
- data/spec/models/create_shipping_quote200_response_spec.rb +0 -36
- data/spec/models/create_shipping_quote400_response_spec.rb +0 -42
- data/spec/models/create_shipping_quote404_response_spec.rb +0 -42
- data/spec/models/create_shipping_quote_request_destination_spec.rb +0 -66
- data/spec/models/create_shipping_quote_request_items_inner_spec.rb +0 -72
- data/spec/models/create_shipping_quote_request_spec.rb +0 -54
- data/spec/models/create_shipping_rule201_response_spec.rb +0 -208
- data/spec/models/create_shipping_rule_request_additional_parameters_any_of_inner_spec.rb +0 -42
- data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_coordinates_inner_spec.rb +0 -21
- data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_spec.rb +0 -54
- data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_spec.rb +0 -21
- data/spec/models/create_shipping_rule_request_additional_parameters_spec.rb +0 -21
- data/spec/models/create_shipping_rule_request_conditions_inner_one_of1_spec.rb +0 -78
- data/spec/models/create_shipping_rule_request_conditions_inner_one_of2_spec.rb +0 -74
- data/spec/models/create_shipping_rule_request_conditions_inner_one_of3_spec.rb +0 -68
- data/spec/models/create_shipping_rule_request_conditions_inner_one_of4_spec.rb +0 -52
- data/spec/models/create_shipping_rule_request_conditions_inner_one_of_spec.rb +0 -64
- data/spec/models/create_shipping_rule_request_conditions_inner_spec.rb +0 -32
- data/spec/models/create_shipping_rule_request_spec.rb +0 -184
- data/spec/models/delete_org_webhook200_response_spec.rb +0 -36
- data/spec/models/delete_shipping_rule200_response_spec.rb +0 -36
- data/spec/models/get_billing_usage200_response_add_ons_inner_spec.rb +0 -58
- data/spec/models/get_billing_usage200_response_current_period_spec.rb +0 -42
- data/spec/models/get_billing_usage200_response_limits_spec.rb +0 -72
- data/spec/models/get_billing_usage200_response_limits_team_members_spec.rb +0 -42
- data/spec/models/get_billing_usage200_response_shipments_spec.rb +0 -54
- data/spec/models/get_billing_usage200_response_spec.rb +0 -54
- data/spec/models/get_order200_response_shipments_inner_spec.rb +0 -98
- data/spec/models/get_order200_response_shipping_rule_spec.rb +0 -102
- data/spec/models/get_order200_response_spec.rb +0 -160
- data/spec/models/get_org200_response_count_spec.rb +0 -36
- data/spec/models/get_org200_response_spec.rb +0 -132
- data/spec/models/get_org_branding200_response_spec.rb +0 -48
- data/spec/models/health_check200_response_spec.rb +0 -48
- data/spec/models/list_addresses200_response_data_inner_spec.rb +0 -130
- data/spec/models/list_addresses200_response_spec.rb +0 -60
- data/spec/models/list_api_tokens200_response_data_inner_created_by_spec.rb +0 -48
- data/spec/models/list_api_tokens200_response_data_inner_spec.rb +0 -84
- data/spec/models/list_api_tokens200_response_spec.rb +0 -60
- data/spec/models/list_api_tokens401_response_spec.rb +0 -52
- data/spec/models/list_available_carriers200_response_inner_required_fields_inner_spec.rb +0 -70
- data/spec/models/list_available_carriers200_response_inner_spec.rb +0 -96
- data/spec/models/list_carrier_product_service_points200_response_inner_address_spec.rb +0 -66
- data/spec/models/list_carrier_product_service_points200_response_inner_spec.rb +0 -78
- data/spec/models/list_carrier_product_service_points_request_spec.rb +0 -66
- data/spec/models/list_carrier_products200_response_inner_additional_parameters_inner_options_inner_spec.rb +0 -48
- data/spec/models/list_carrier_products200_response_inner_additional_parameters_inner_spec.rb +0 -76
- data/spec/models/list_carrier_products200_response_inner_services_inner_spec.rb +0 -42
- data/spec/models/list_carrier_products200_response_inner_spec.rb +0 -100
- data/spec/models/list_carrier_products200_response_inner_weight_limits_spec.rb +0 -52
- data/spec/models/list_carriers200_response_data_inner_config_value_spec.rb +0 -21
- data/spec/models/list_carriers200_response_data_inner_spec.rb +0 -96
- data/spec/models/list_carriers200_response_spec.rb +0 -60
- data/spec/models/list_orders200_response_data_inner_order_channel_spec.rb +0 -52
- data/spec/models/list_orders200_response_data_inner_spec.rb +0 -112
- data/spec/models/list_orders200_response_spec.rb +0 -60
- data/spec/models/list_org_webhook_deliveries200_response_data_inner_spec.rb +0 -96
- data/spec/models/list_org_webhook_deliveries200_response_spec.rb +0 -60
- data/spec/models/list_org_webhooks200_response_data_inner_spec.rb +0 -72
- data/spec/models/list_org_webhooks200_response_spec.rb +0 -60
- data/spec/models/list_shipments200_response_data_inner_address_spec.rb +0 -130
- data/spec/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_any_of_spec.rb +0 -54
- data/spec/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_spec.rb +0 -21
- data/spec/models/list_shipments200_response_data_inner_carrier_settings_spec.rb +0 -54
- data/spec/models/list_shipments200_response_data_inner_spec.rb +0 -92
- data/spec/models/list_shipments200_response_spec.rb +0 -60
- data/spec/models/list_shipping_rules200_response_data_inner_additional_parameters_inner_spec.rb +0 -42
- data/spec/models/list_shipping_rules200_response_data_inner_carrier_spec.rb +0 -72
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of1_spec.rb +0 -78
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of2_spec.rb +0 -74
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of3_spec.rb +0 -68
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of4_spec.rb +0 -52
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of_spec.rb +0 -64
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_spec.rb +0 -32
- data/spec/models/list_shipping_rules200_response_data_inner_label_printer_spec.rb +0 -42
- data/spec/models/list_shipping_rules200_response_data_inner_return_shipping_rule_spec.rb +0 -42
- data/spec/models/list_shipping_rules200_response_data_inner_spec.rb +0 -238
- data/spec/models/list_shipping_rules200_response_spec.rb +0 -60
- data/spec/models/revoke_api_token200_response_spec.rb +0 -36
- data/spec/models/send_shipment422_response_errors_inner_spec.rb +0 -42
- data/spec/models/send_shipment422_response_spec.rb +0 -58
- data/spec/models/split_shipment201_response_spec.rb +0 -42
- data/spec/models/split_shipment_parcel200_response_spec.rb +0 -36
- data/spec/models/split_shipment_parcel_request_parcels_inner_spec.rb +0 -42
- data/spec/models/split_shipment_parcel_request_spec.rb +0 -36
- data/spec/models/split_shipment_request_spec.rb +0 -72
- data/spec/models/test_org_webhook200_response_spec.rb +0 -36
- data/spec/models/track_shipment200_response_events_inner_spec.rb +0 -70
- data/spec/models/track_shipment200_response_spec.rb +0 -64
- data/spec/models/update_address_request_spec.rb +0 -106
- data/spec/models/update_api_token_request_spec.rb +0 -36
- data/spec/models/update_carrier_request_spec.rb +0 -48
- data/spec/models/update_order_request_spec.rb +0 -100
- data/spec/models/update_org200_response_spec.rb +0 -126
- data/spec/models/update_org_branding_request_spec.rb +0 -42
- data/spec/models/update_org_request_spec.rb +0 -118
- data/spec/models/update_org_webhook_request_spec.rb +0 -58
- data/spec/models/update_shipment_request_spec.rb +0 -122
- data/spec/models/update_shipping_rule_request_spec.rb +0 -184
- data/spec/models/verify_api_token200_response_spec.rb +0 -66
- data/spec/models/verify_api_token_request_spec.rb +0 -36
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zippendo::CheckBrandSlug200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **slug** | **String** | The slug that was checked | |
|
|
8
|
+
| **available** | **Boolean** | Whether the slug is free within this organization | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zippendo'
|
|
14
|
+
|
|
15
|
+
instance = Zippendo::CheckBrandSlug200Response.new(
|
|
16
|
+
slug: acme,
|
|
17
|
+
available: true
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Zippendo::CreateOrgBrandRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **company_name** | **String** | Legal entity name printed on this brand's documents | [optional] |
|
|
8
|
+
| **vat_number** | **String** | VAT/tax ID for this brand's shipments and documents | [optional] |
|
|
9
|
+
| **customs** | **Hash<String, String>** | Customs identifiers keyed by type | [optional] |
|
|
10
|
+
| **address_line1** | **String** | Street address line 1 | [optional] |
|
|
11
|
+
| **address_line2** | **String** | Street address line 2 | [optional] |
|
|
12
|
+
| **city** | **String** | City | [optional] |
|
|
13
|
+
| **postal_code** | **String** | Postal code | [optional] |
|
|
14
|
+
| **country** | **String** | Country (ISO 3166-1 alpha-2) | [optional] |
|
|
15
|
+
| **primary_color** | **String** | Primary brand colour — document title and table headers | [optional] |
|
|
16
|
+
| **secondary_color** | **String** | Secondary brand colour — subtitle, section headings, totals accent | [optional] |
|
|
17
|
+
| **name** | **String** | Brand display name | |
|
|
18
|
+
| **slug** | **String** | URL-safe identifier, unique within the org. Derived from the name when omitted. | [optional] |
|
|
19
|
+
| **use_org_customs** | **Boolean** | Whether this brand ships under the organization's fiscal identity. True (the default) declares the organization's VAT number and customs identifiers and ignores the brand's own. False makes the brand's own values the sole source — nothing falls back to the organization, so an identifier the brand has not set is not declared at all. | [optional] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'zippendo'
|
|
25
|
+
|
|
26
|
+
instance = Zippendo::CreateOrgBrandRequest.new(
|
|
27
|
+
company_name: Acme ApS,
|
|
28
|
+
vat_number: DK12345678,
|
|
29
|
+
customs: {"eori":"DK12345678"},
|
|
30
|
+
address_line1: Vestergade 12,
|
|
31
|
+
address_line2: 3. sal,
|
|
32
|
+
city: København,
|
|
33
|
+
postal_code: 1456,
|
|
34
|
+
country: DK,
|
|
35
|
+
primary_color: #1D4ED8,
|
|
36
|
+
secondary_color: #F59E0B,
|
|
37
|
+
name: Acme,
|
|
38
|
+
slug: acme,
|
|
39
|
+
use_org_customs: true
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|
|
@@ -13,8 +13,8 @@
|
|
|
13
13
|
| **tracking_url** | **String** | Public carrier tracking URL for this parcel. | [optional] |
|
|
14
14
|
| **label_free_code** | **String** | Label-free drop-off code for the parcel. | [optional] |
|
|
15
15
|
| **qr_code_link** | **String** | DEPRECATED — use `qrCodeDataUri` (embeddable data URI) or `qrCodeUrl` (hosted link). Catch-all that carries whichever applies, kept populated for backwards compatibility during the migration and until it is disabled. | [optional] |
|
|
16
|
-
| **qr_code_data_uri** | **String** | Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email.
|
|
17
|
-
| **qr_code_url** | **String** | Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it.
|
|
16
|
+
| **qr_code_data_uri** | **String** | Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email. Populated whenever the image bytes are available, including for carriers that host the image (it is fetched and inlined); null if the carrier published no QR code or its image could not be retrieved. | [optional] |
|
|
17
|
+
| **qr_code_url** | **String** | Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it. Independent of `qrCodeDataUri` — both are set when the hosted image was inlined successfully; null for carriers that only return embedded bytes. | [optional] |
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
|
@@ -8,8 +8,8 @@
|
|
|
8
8
|
| **number** | **String** | Carrier tracking number. | [optional] |
|
|
9
9
|
| **label_free_code** | **String** | Label-free drop-off code. | [optional] |
|
|
10
10
|
| **qr_code_link** | **String** | DEPRECATED — use `qrCodeDataUri` (embeddable data URI) or `qrCodeUrl` (hosted link). Catch-all that carries whichever applies, kept populated for backwards compatibility during the migration and until it is disabled. | [optional] |
|
|
11
|
-
| **qr_code_data_uri** | **String** | Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email.
|
|
12
|
-
| **qr_code_url** | **String** | Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it.
|
|
11
|
+
| **qr_code_data_uri** | **String** | Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email. Populated whenever the image bytes are available, including for carriers that host the image (it is fetched and inlined); null if the carrier published no QR code or its image could not be retrieved. | [optional] |
|
|
12
|
+
| **qr_code_url** | **String** | Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it. Independent of `qrCodeDataUri` — both are set when the hosted image was inlined successfully; null for carriers that only return embedded bytes. | [optional] |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **carrier_id** | **String** | Identifier of the carrier to use. | |
|
|
8
8
|
| **product_id** | **String** | Identifier of the carrier product/service. | |
|
|
9
9
|
| **services** | **Array<String>** | Additional service codes requested from the carrier. | |
|
|
10
|
-
| **additional_parameters** | [**Hash<String,
|
|
10
|
+
| **additional_parameters** | [**Hash<String, CreateShippingRuleRequestAdditionalParametersValue>**](CreateShippingRuleRequestAdditionalParametersValue.md) | Carrier-specific extra parameters as key/value pairs. | |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -13,8 +13,8 @@
|
|
|
13
13
|
| **tracking_url** | **String** | Public carrier tracking URL for this parcel. | [optional] |
|
|
14
14
|
| **label_free_code** | **String** | Label-free drop-off code for the parcel. | [optional] |
|
|
15
15
|
| **qr_code_link** | **String** | DEPRECATED — use `qrCodeDataUri` (embeddable data URI) or `qrCodeUrl` (hosted link). Catch-all that carries whichever applies, kept populated for backwards compatibility during the migration and until it is disabled. | [optional] |
|
|
16
|
-
| **qr_code_data_uri** | **String** | Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email.
|
|
17
|
-
| **qr_code_url** | **String** | Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it.
|
|
16
|
+
| **qr_code_data_uri** | **String** | Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email. Populated whenever the image bytes are available, including for carriers that host the image (it is fetched and inlined); null if the carrier published no QR code or its image could not be retrieved. | [optional] |
|
|
17
|
+
| **qr_code_url** | **String** | Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it. Independent of `qrCodeDataUri` — both are set when the hosted image was inlined successfully; null for carriers that only return embedded bytes. | [optional] |
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
| **carrier_id** | **String** | Carrier ID | |
|
|
12
12
|
| **product_id** | **String** | Product ID from carrier | |
|
|
13
13
|
| **services** | **Array<String>** | List of selected services | |
|
|
14
|
-
| **additional_parameters** | [**
|
|
14
|
+
| **additional_parameters** | [**Hash<String, ListShippingRules200ResponseDataInnerAdditionalParametersValue>**](ListShippingRules200ResponseDataInnerAdditionalParametersValue.md) | Carrier-specific extra parameters, keyed by the carrier parameter `key` from the product's `additionalParameters[].key`. | |
|
|
15
15
|
| **address_id** | **String** | Sender address ID | |
|
|
16
16
|
| **receiving_countries** | **Array<String>** | List of supported country codes | |
|
|
17
17
|
| **email_notification** | **Boolean** | Send email notification to recipient | [default to false] |
|
|
@@ -47,7 +47,7 @@ instance = Zippendo::CreateShippingRule201Response.new(
|
|
|
47
47
|
carrier_id: carr_01HZX9K2QF,
|
|
48
48
|
product_id: PNL13,
|
|
49
49
|
services: ["EMAIL_NOTIFICATION"],
|
|
50
|
-
additional_parameters:
|
|
50
|
+
additional_parameters: {"returnFunctionality":"LABELLESS","returnQrEmail":true},
|
|
51
51
|
address_id: addr_01HZX9K2QF,
|
|
52
52
|
receiving_countries: ["DK","SE"],
|
|
53
53
|
email_notification: true,
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **carrier_id** | **String** | Carrier ID | |
|
|
11
11
|
| **product_id** | **String** | Product ID from carrier | |
|
|
12
12
|
| **services** | **Array<String>** | List of selected services | |
|
|
13
|
-
| **additional_parameters** | [**
|
|
13
|
+
| **additional_parameters** | [**Hash<String, CreateShippingRuleRequestAdditionalParametersValue>**](CreateShippingRuleRequestAdditionalParametersValue.md) | Carrier-specific extra parameters, keyed by the carrier parameter `key` from the product's `additionalParameters[].key` (e.g. `returnFunctionality`). | [optional] |
|
|
14
14
|
| **address_id** | **String** | Sender address ID | |
|
|
15
15
|
| **receiving_countries** | **Array<String>** | List of supported country codes | |
|
|
16
16
|
| **email_notification** | **Boolean** | Send email notification to recipient | [optional][default to false] |
|
|
@@ -42,7 +42,7 @@ instance = Zippendo::CreateShippingRuleRequest.new(
|
|
|
42
42
|
carrier_id: carr_01HZX9K2QF,
|
|
43
43
|
product_id: PNL13,
|
|
44
44
|
services: ["EMAIL_NOTIFICATION"],
|
|
45
|
-
additional_parameters:
|
|
45
|
+
additional_parameters: {"returnFunctionality":"LABELLESS","returnQrEmail":true},
|
|
46
46
|
address_id: addr_01HZX9K2QF,
|
|
47
47
|
receiving_countries: ["DK","SE"],
|
|
48
48
|
email_notification: true,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zippendo::
|
|
1
|
+
# Zippendo::CreateShippingRuleRequestAdditionalParametersValue
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -7,14 +7,14 @@
|
|
|
7
7
|
| **id** | **String** | Identifier of the selected service point. | |
|
|
8
8
|
| **name** | **String** | Display name of the service point. | |
|
|
9
9
|
| **address** | **String** | Formatted address of the service point. | |
|
|
10
|
-
| **coordinates** | [**Array<
|
|
10
|
+
| **coordinates** | [**Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>**](ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.md) | Latitude/longitude of the service point. | [optional] |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
15
|
require 'zippendo'
|
|
16
16
|
|
|
17
|
-
instance = Zippendo::
|
|
17
|
+
instance = Zippendo::CreateShippingRuleRequestAdditionalParametersValue.new(
|
|
18
18
|
id: sp_pn_4521,
|
|
19
19
|
name: Føtex Nørrebro,
|
|
20
20
|
address: Nørrebrogade 20, 2200 København N,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zippendo::
|
|
1
|
+
# Zippendo::CreateShippingRuleRequestAdditionalParametersValueAnyOf
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -7,14 +7,14 @@
|
|
|
7
7
|
| **id** | **String** | Identifier of the selected service point. | |
|
|
8
8
|
| **name** | **String** | Display name of the service point. | |
|
|
9
9
|
| **address** | **String** | Formatted address of the service point. | |
|
|
10
|
-
| **coordinates** | [**Array<
|
|
10
|
+
| **coordinates** | [**Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>**](ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.md) | Latitude/longitude of the service point. | [optional] |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
15
|
require 'zippendo'
|
|
16
16
|
|
|
17
|
-
instance = Zippendo::
|
|
17
|
+
instance = Zippendo::CreateShippingRuleRequestAdditionalParametersValueAnyOf.new(
|
|
18
18
|
id: sp_pn_4521,
|
|
19
19
|
name: Føtex Nørrebro,
|
|
20
20
|
address: Nørrebrogade 20, 2200 København N,
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zippendo::ListOrgBrands200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<ListOrgBrands200ResponseDataInner>**](ListOrgBrands200ResponseDataInner.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zippendo'
|
|
13
|
+
|
|
14
|
+
instance = Zippendo::ListOrgBrands200Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Zippendo::ListOrgBrands200ResponseDataInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **company_name** | **String** | Legal entity name printed on this brand's documents | [optional] |
|
|
8
|
+
| **vat_number** | **String** | VAT/tax ID for this brand's shipments and documents | [optional] |
|
|
9
|
+
| **customs** | **Hash<String, String>** | Customs identifiers keyed by type | [optional] |
|
|
10
|
+
| **address_line1** | **String** | Street address line 1 | [optional] |
|
|
11
|
+
| **address_line2** | **String** | Street address line 2 | [optional] |
|
|
12
|
+
| **city** | **String** | City | [optional] |
|
|
13
|
+
| **postal_code** | **String** | Postal code | [optional] |
|
|
14
|
+
| **country** | **String** | Country (ISO 3166-1 alpha-2) | [optional] |
|
|
15
|
+
| **primary_color** | **String** | Primary brand colour — document title and table headers | [optional] |
|
|
16
|
+
| **secondary_color** | **String** | Secondary brand colour — subtitle, section headings, totals accent | [optional] |
|
|
17
|
+
| **id** | **String** | Unique brand identifier | |
|
|
18
|
+
| **org_id** | **String** | Owning organization | |
|
|
19
|
+
| **name** | **String** | Brand display name | |
|
|
20
|
+
| **slug** | **String** | URL-safe identifier, unique within the organization | |
|
|
21
|
+
| **use_org_customs** | **Boolean** | Whether this brand ships under the organization's fiscal identity. True (the default) declares the organization's VAT number and customs identifiers and ignores the brand's own. False makes the brand's own values the sole source — nothing falls back to the organization, so an identifier the brand has not set is not declared at all. | |
|
|
22
|
+
| **logo_url** | **String** | Authenticated URL for the brand logo, or null when none is set | |
|
|
23
|
+
| **archived_at** | **String** | When the brand was archived; null when active | |
|
|
24
|
+
| **created_at** | **String** | Creation timestamp (ISO 8601) | |
|
|
25
|
+
| **updated_at** | **String** | Last update timestamp (ISO 8601) | |
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'zippendo'
|
|
31
|
+
|
|
32
|
+
instance = Zippendo::ListOrgBrands200ResponseDataInner.new(
|
|
33
|
+
company_name: Acme ApS,
|
|
34
|
+
vat_number: DK12345678,
|
|
35
|
+
customs: {"eori":"DK12345678"},
|
|
36
|
+
address_line1: Vestergade 12,
|
|
37
|
+
address_line2: 3. sal,
|
|
38
|
+
city: København,
|
|
39
|
+
postal_code: 1456,
|
|
40
|
+
country: DK,
|
|
41
|
+
primary_color: #1D4ED8,
|
|
42
|
+
secondary_color: #F59E0B,
|
|
43
|
+
id: brnd_8f3kd92ld0,
|
|
44
|
+
org_id: org_8f3kd92ld0,
|
|
45
|
+
name: Acme,
|
|
46
|
+
slug: acme,
|
|
47
|
+
use_org_customs: true,
|
|
48
|
+
logo_url: /orgs/org_1/brands/brnd_1/logo,
|
|
49
|
+
archived_at: 2026-08-05T10:00:00.000Z,
|
|
50
|
+
created_at: 2026-06-22T14:30:00.000Z,
|
|
51
|
+
updated_at: 2026-06-22T14:30:00.000Z
|
|
52
|
+
)
|
|
53
|
+
```
|
|
54
|
+
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **carrier_id** | **String** | Identifier of the carrier to use. | |
|
|
8
8
|
| **product_id** | **String** | Identifier of the carrier product/service. | |
|
|
9
9
|
| **services** | **Array<String>** | Additional service codes requested from the carrier. | |
|
|
10
|
-
| **additional_parameters** | [**Hash<String,
|
|
10
|
+
| **additional_parameters** | [**Hash<String, ListShippingRules200ResponseDataInnerAdditionalParametersValue>**](ListShippingRules200ResponseDataInnerAdditionalParametersValue.md) | Carrier-specific extra parameters as key/value pairs. | |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
| **carrier_id** | **String** | Carrier ID | |
|
|
12
12
|
| **product_id** | **String** | Product ID from carrier | |
|
|
13
13
|
| **services** | **Array<String>** | List of selected services | |
|
|
14
|
-
| **additional_parameters** | [**
|
|
14
|
+
| **additional_parameters** | [**Hash<String, ListShippingRules200ResponseDataInnerAdditionalParametersValue>**](ListShippingRules200ResponseDataInnerAdditionalParametersValue.md) | Carrier-specific extra parameters, keyed by the carrier parameter `key` from the product's `additionalParameters[].key`. | |
|
|
15
15
|
| **address_id** | **String** | Sender address ID | |
|
|
16
16
|
| **receiving_countries** | **Array<String>** | List of supported country codes | |
|
|
17
17
|
| **email_notification** | **Boolean** | Send email notification to recipient | [default to false] |
|
|
@@ -52,7 +52,7 @@ instance = Zippendo::ListShippingRules200ResponseDataInner.new(
|
|
|
52
52
|
carrier_id: carr_01HZX9K2QF,
|
|
53
53
|
product_id: PNL13,
|
|
54
54
|
services: ["EMAIL_NOTIFICATION"],
|
|
55
|
-
additional_parameters:
|
|
55
|
+
additional_parameters: {"returnFunctionality":"LABELLESS","returnQrEmail":true},
|
|
56
56
|
address_id: addr_01HZX9K2QF,
|
|
57
57
|
receiving_countries: ["DK","SE"],
|
|
58
58
|
email_notification: true,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zippendo::
|
|
1
|
+
# Zippendo::ListShippingRules200ResponseDataInnerAdditionalParametersValue
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -7,14 +7,14 @@
|
|
|
7
7
|
| **id** | **String** | Identifier of the selected service point. | |
|
|
8
8
|
| **name** | **String** | Display name of the service point. | |
|
|
9
9
|
| **address** | **String** | Formatted address of the service point. | |
|
|
10
|
-
| **coordinates** | [**Array<
|
|
10
|
+
| **coordinates** | [**Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>**](ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.md) | Latitude/longitude of the service point. | [optional] |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
15
|
require 'zippendo'
|
|
16
16
|
|
|
17
|
-
instance = Zippendo::
|
|
17
|
+
instance = Zippendo::ListShippingRules200ResponseDataInnerAdditionalParametersValue.new(
|
|
18
18
|
id: sp_pn_4521,
|
|
19
19
|
name: Føtex Nørrebro,
|
|
20
20
|
address: Nørrebrogade 20, 2200 København N,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zippendo::
|
|
1
|
+
# Zippendo::ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -7,14 +7,14 @@
|
|
|
7
7
|
| **id** | **String** | Identifier of the selected service point. | |
|
|
8
8
|
| **name** | **String** | Display name of the service point. | |
|
|
9
9
|
| **address** | **String** | Formatted address of the service point. | |
|
|
10
|
-
| **coordinates** | [**Array<
|
|
10
|
+
| **coordinates** | [**Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>**](ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.md) | Latitude/longitude of the service point. | [optional] |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
15
|
require 'zippendo'
|
|
16
16
|
|
|
17
|
-
instance = Zippendo::
|
|
17
|
+
instance = Zippendo::ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.new(
|
|
18
18
|
id: sp_pn_4521,
|
|
19
19
|
name: Føtex Nørrebro,
|
|
20
20
|
address: Nørrebrogade 20, 2200 København N,
|
|
@@ -1,20 +1,15 @@
|
|
|
1
|
-
# Zippendo::
|
|
1
|
+
# Zippendo::ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **name** | **String** | Carrier parameter key | |
|
|
8
|
-
| **val** | **String** | Parameter value (stringified) | |
|
|
9
7
|
|
|
10
8
|
## Example
|
|
11
9
|
|
|
12
10
|
```ruby
|
|
13
11
|
require 'zippendo'
|
|
14
12
|
|
|
15
|
-
instance = Zippendo::
|
|
16
|
-
name: returnFunctionality,
|
|
17
|
-
val: LABELLESS
|
|
18
|
-
)
|
|
13
|
+
instance = Zippendo::ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.new()
|
|
19
14
|
```
|
|
20
15
|
|
data/docs/ShipmentsApi.md
CHANGED
|
@@ -255,7 +255,7 @@ end
|
|
|
255
255
|
|
|
256
256
|
api_instance = Zippendo::ShipmentsApi.new
|
|
257
257
|
org_id = 'org_8f3kd92ld0' # String | Organization ID
|
|
258
|
-
create_shipment_request = Zippendo::CreateShipmentRequest.new({type: 'outbound', carrier_settings: Zippendo::CreateShipmentRequestCarrierSettings.new({carrier_id: 'car_pn_001', product_id: 'prod_mypack_home', services: ["A7"], additional_parameters: { key: Zippendo::
|
|
258
|
+
create_shipment_request = Zippendo::CreateShipmentRequest.new({type: 'outbound', carrier_settings: Zippendo::CreateShipmentRequestCarrierSettings.new({carrier_id: 'car_pn_001', product_id: 'prod_mypack_home', services: ["A7"], additional_parameters: { key: Zippendo::CreateShippingRuleRequestAdditionalParametersValue.new({id: 'sp_pn_4521', name: 'Føtex Nørrebro', address: 'Nørrebrogade 20, 2200 København N'})}})}) # CreateShipmentRequest |
|
|
259
259
|
|
|
260
260
|
begin
|
|
261
261
|
# Create shipment
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **carrier_id** | **String** | Carrier for the new shipment. Copied from the original if omitted. | [optional] |
|
|
10
10
|
| **product_id** | **String** | Carrier product for the new shipment. Copied from the original if omitted. | [optional] |
|
|
11
11
|
| **services** | **Array<String>** | Service codes for the new shipment. Copied from the original if omitted. | [optional] |
|
|
12
|
-
| **additional_parameters** | **Hash<String,
|
|
12
|
+
| **additional_parameters** | [**Hash<String, CreateShippingRuleRequestAdditionalParametersValue>**](CreateShippingRuleRequestAdditionalParametersValue.md) | Carrier-specific parameters for the new shipment. Copied from the original if omitted. | [optional] |
|
|
13
13
|
| **reference** | **String** | Reference for the new shipment. Defaults to the original reference with a suffix. | [optional] |
|
|
14
14
|
|
|
15
15
|
## Example
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Zippendo::UpdateOrgBrandRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **company_name** | **String** | Legal entity name printed on this brand's documents | [optional] |
|
|
8
|
+
| **vat_number** | **String** | VAT/tax ID for this brand's shipments and documents | [optional] |
|
|
9
|
+
| **customs** | **Hash<String, String>** | Customs identifiers keyed by type | [optional] |
|
|
10
|
+
| **address_line1** | **String** | Street address line 1 | [optional] |
|
|
11
|
+
| **address_line2** | **String** | Street address line 2 | [optional] |
|
|
12
|
+
| **city** | **String** | City | [optional] |
|
|
13
|
+
| **postal_code** | **String** | Postal code | [optional] |
|
|
14
|
+
| **country** | **String** | Country (ISO 3166-1 alpha-2) | [optional] |
|
|
15
|
+
| **primary_color** | **String** | Primary brand colour — document title and table headers | [optional] |
|
|
16
|
+
| **secondary_color** | **String** | Secondary brand colour — subtitle, section headings, totals accent | [optional] |
|
|
17
|
+
| **name** | **String** | Brand display name | [optional] |
|
|
18
|
+
| **slug** | **String** | URL-safe identifier, unique within the org | [optional] |
|
|
19
|
+
| **use_org_customs** | **Boolean** | Whether this brand ships under the organization's fiscal identity. True (the default) declares the organization's VAT number and customs identifiers and ignores the brand's own. False makes the brand's own values the sole source — nothing falls back to the organization, so an identifier the brand has not set is not declared at all. | [optional] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'zippendo'
|
|
25
|
+
|
|
26
|
+
instance = Zippendo::UpdateOrgBrandRequest.new(
|
|
27
|
+
company_name: Acme ApS,
|
|
28
|
+
vat_number: DK12345678,
|
|
29
|
+
customs: {"eori":"DK12345678"},
|
|
30
|
+
address_line1: Vestergade 12,
|
|
31
|
+
address_line2: 3. sal,
|
|
32
|
+
city: København,
|
|
33
|
+
postal_code: 1456,
|
|
34
|
+
country: DK,
|
|
35
|
+
primary_color: #1D4ED8,
|
|
36
|
+
secondary_color: #F59E0B,
|
|
37
|
+
name: Acme,
|
|
38
|
+
slug: acme,
|
|
39
|
+
use_org_customs: true
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **carrier_id** | **String** | Carrier ID | [optional] |
|
|
11
11
|
| **product_id** | **String** | Product ID from carrier | [optional] |
|
|
12
12
|
| **services** | **Array<String>** | List of selected services | [optional] |
|
|
13
|
-
| **additional_parameters** | [**
|
|
13
|
+
| **additional_parameters** | [**Hash<String, CreateShippingRuleRequestAdditionalParametersValue>**](CreateShippingRuleRequestAdditionalParametersValue.md) | Carrier-specific extra parameters, keyed by the carrier parameter `key` from the product's `additionalParameters[].key`. Omit to leave the rule's parameters unchanged. | [optional] |
|
|
14
14
|
| **address_id** | **String** | Sender address ID | [optional] |
|
|
15
15
|
| **receiving_countries** | **Array<String>** | List of supported country codes | [optional] |
|
|
16
16
|
| **email_notification** | **Boolean** | Send email notification to recipient | [optional][default to false] |
|
|
@@ -42,7 +42,7 @@ instance = Zippendo::UpdateShippingRuleRequest.new(
|
|
|
42
42
|
carrier_id: carr_01HZX9K2QF,
|
|
43
43
|
product_id: PNL13,
|
|
44
44
|
services: ["EMAIL_NOTIFICATION"],
|
|
45
|
-
additional_parameters:
|
|
45
|
+
additional_parameters: {"returnFunctionality":"LABELLESS"},
|
|
46
46
|
address_id: addr_01HZX9K2QF,
|
|
47
47
|
receiving_countries: ["DK","SE"],
|
|
48
48
|
email_notification: true,
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Zippendo Public API
|
|
3
3
|
|
|
4
|
-
#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand's team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand's id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
4
|
+
#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand's team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand's id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan's limit returns `403`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@zippendo.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Zippendo Public API
|
|
3
3
|
|
|
4
|
-
#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand's team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand's id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
4
|
+
#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand's team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand's id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan's limit returns `403`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@zippendo.com
|