Module: Zippendo

Defined in:
lib/zippendo/version.rb,
lib/zippendo.rb,
lib/zippendo/api_error.rb,
lib/zippendo/api_client.rb,
lib/zippendo/api/orgs_api.rb,
lib/zippendo/api/rules_api.rb,
lib/zippendo/configuration.rb,
lib/zippendo/api/orders_api.rb,
lib/zippendo/api/quotes_api.rb,
lib/zippendo/api/system_api.rb,
lib/zippendo/api/tokens_api.rb,
lib/zippendo/api_model_base.rb,
lib/zippendo/api/billing_api.rb,
lib/zippendo/api/carriers_api.rb,
lib/zippendo/api/webhooks_api.rb,
lib/zippendo/api/addresses_api.rb,
lib/zippendo/api/shipments_api.rb,
lib/zippendo/api/carrier_catalog_api.rb,
lib/zippendo/models/update_org_request.rb,
lib/zippendo/models/get_org200_response.rb,
lib/zippendo/models/create_order_request.rb,
lib/zippendo/models/update_order_request.rb,
lib/zippendo/models/get_order200_response.rb,
lib/zippendo/models/create_address_request.rb,
lib/zippendo/models/split_shipment_request.rb,
lib/zippendo/models/update_address_request.rb,
lib/zippendo/models/update_carrier_request.rb,
lib/zippendo/models/update_org200_response.rb,
lib/zippendo/models/connect_carrier_request.rb,
lib/zippendo/models/create_shipment_request.rb,
lib/zippendo/models/list_orders200_response.rb,
lib/zippendo/models/update_shipment_request.rb,
lib/zippendo/models/create_api_token_request.rb,
lib/zippendo/models/create_order201_response.rb,
lib/zippendo/models/health_check200_response.rb,
lib/zippendo/models/update_api_token_request.rb,
lib/zippendo/models/verify_api_token_request.rb,
lib/zippendo/models/get_org200_response_count.rb,
lib/zippendo/models/list_carriers200_response.rb,
lib/zippendo/models/send_shipment422_response.rb,
lib/zippendo/models/create_org_webhook_request.rb,
lib/zippendo/models/list_addresses200_response.rb,
lib/zippendo/models/list_shipments200_response.rb,
lib/zippendo/models/split_shipment201_response.rb,
lib/zippendo/models/track_shipment200_response.rb,
lib/zippendo/models/update_org_webhook_request.rb,
lib/zippendo/models/create_shipment201_response.rb,
lib/zippendo/models/list_api_tokens200_response.rb,
lib/zippendo/models/list_api_tokens401_response.rb,
lib/zippendo/models/update_org_branding_request.rb,
lib/zippendo/models/batch_send_shipments_request.rb,
lib/zippendo/models/batch_split_shipment_request.rb,
lib/zippendo/models/create_api_token201_response.rb,
lib/zippendo/models/create_shipping_rule_request.rb,
lib/zippendo/models/get_org_branding200_response.rb,
lib/zippendo/models/revoke_api_token200_response.rb,
lib/zippendo/models/test_org_webhook200_response.rb,
lib/zippendo/models/update_shipping_rule_request.rb,
lib/zippendo/models/verify_api_token200_response.rb,
lib/zippendo/models/create_shipping_quote_request.rb,
lib/zippendo/models/get_billing_usage200_response.rb,
lib/zippendo/models/list_org_webhooks200_response.rb,
lib/zippendo/models/split_shipment_parcel_request.rb,
lib/zippendo/models/create_org_webhook201_response.rb,
lib/zippendo/models/delete_org_webhook200_response.rb,
lib/zippendo/models/list_shipping_rules200_response.rb,
lib/zippendo/models/batch_send_shipments200_response.rb,
lib/zippendo/models/batch_split_shipment201_response.rb,
lib/zippendo/models/create_shipping_rule201_response.rb,
lib/zippendo/models/delete_shipping_rule200_response.rb,
lib/zippendo/models/create_shipping_quote200_response.rb,
lib/zippendo/models/create_shipping_quote400_response.rb,
lib/zippendo/models/create_shipping_quote404_response.rb,
lib/zippendo/models/split_shipment_parcel200_response.rb,
lib/zippendo/models/list_orders200_response_data_inner.rb,
lib/zippendo/models/get_order200_response_shipping_rule.rb,
lib/zippendo/models/create_shipment201_response_tracking.rb,
lib/zippendo/models/get_billing_usage200_response_limits.rb,
lib/zippendo/models/list_carriers200_response_data_inner.rb,
lib/zippendo/models/create_order_request_shipping_address.rb,
lib/zippendo/models/create_shipment_request_parcels_inner.rb,
lib/zippendo/models/create_shipment_request_parties_inner.rb,
lib/zippendo/models/get_order200_response_shipments_inner.rb,
lib/zippendo/models/list_addresses200_response_data_inner.rb,
lib/zippendo/models/list_shipments200_response_data_inner.rb,
lib/zippendo/models/create_order_request_order_lines_inner.rb,
lib/zippendo/models/create_shipment201_response_logs_inner.rb,
lib/zippendo/models/create_shipment_request_pickup_details.rb,
lib/zippendo/models/list_api_tokens200_response_data_inner.rb,
lib/zippendo/models/send_shipment422_response_errors_inner.rb,
lib/zippendo/models/get_billing_usage200_response_shipments.rb,
lib/zippendo/models/list_carrier_products200_response_inner.rb,
lib/zippendo/models/list_org_webhook_deliveries200_response.rb,
lib/zippendo/models/track_shipment200_response_events_inner.rb,
lib/zippendo/models/batch_send_shipments200_response_summary.rb,
lib/zippendo/models/create_shipment201_response_errors_inner.rb,
lib/zippendo/models/create_shipment_request_carrier_settings.rb,
lib/zippendo/models/list_org_webhooks200_response_data_inner.rb,
lib/zippendo/models/create_order201_response_shipping_address.rb,
lib/zippendo/models/create_shipment201_response_parcels_inner.rb,
lib/zippendo/models/create_shipment201_response_parties_inner.rb,
lib/zippendo/models/create_shipment201_response_shipping_rule.rb,
lib/zippendo/models/create_shipping_quote_request_destination.rb,
lib/zippendo/models/create_shipping_quote_request_items_inner.rb,
lib/zippendo/models/list_available_carriers200_response_inner.rb,
lib/zippendo/models/create_order201_response_order_lines_inner.rb,
lib/zippendo/models/create_shipment201_response_pickup_details.rb,
lib/zippendo/models/list_shipping_rules200_response_data_inner.rb,
lib/zippendo/models/create_shipment201_response_documents_inner.rb,
lib/zippendo/models/get_billing_usage200_response_add_ons_inner.rb,
lib/zippendo/models/list_carrier_product_service_points_request.rb,
lib/zippendo/models/split_shipment_parcel_request_parcels_inner.rb,
lib/zippendo/models/batch_split_shipment_request_shipments_inner.rb,
lib/zippendo/models/create_shipment201_response_activities_inner.rb,
lib/zippendo/models/get_billing_usage200_response_current_period.rb,
lib/zippendo/models/create_shipping_quote200_response_rates_inner.rb,
lib/zippendo/models/create_shipping_rule_request_conditions_inner.rb,
lib/zippendo/models/list_shipments200_response_data_inner_address.rb,
lib/zippendo/models/batch_send_shipments200_response_results_inner.rb,
lib/zippendo/models/create_shipment_request_parcels_inner_dimensions.rb,
lib/zippendo/models/list_orders200_response_data_inner_order_channel.rb,
lib/zippendo/models/get_billing_usage200_response_limits_team_members.rb,
lib/zippendo/models/list_api_tokens200_response_data_inner_created_by.rb,
lib/zippendo/models/list_carriers200_response_data_inner_config_value.rb,
lib/zippendo/models/create_shipping_rule_request_additional_parameters.rb,
lib/zippendo/models/list_org_webhook_deliveries200_response_data_inner.rb,
lib/zippendo/models/list_shipping_rules200_response_data_inner_carrier.rb,
lib/zippendo/models/create_shipment201_response_parcels_inner_dimensions.rb,
lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of.rb,
lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of1.rb,
lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of2.rb,
lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of3.rb,
lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of4.rb,
lib/zippendo/models/list_carrier_product_service_points200_response_inner.rb,
lib/zippendo/models/list_carrier_products200_response_inner_weight_limits.rb,
lib/zippendo/models/create_shipment_request_parties_inner_attributes_inner.rb,
lib/zippendo/models/list_carrier_products200_response_inner_services_inner.rb,
lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings.rb,
lib/zippendo/models/create_shipment_request_parcels_inner_order_lines_inner.rb,
lib/zippendo/models/list_shipping_rules200_response_data_inner_label_printer.rb,
lib/zippendo/models/create_shipment201_response_parties_inner_attributes_inner.rb,
lib/zippendo/models/create_shipment201_response_parcels_inner_order_lines_inner.rb,
lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner.rb,
lib/zippendo/models/list_carrier_product_service_points200_response_inner_address.rb,
lib/zippendo/models/batch_split_shipment_request_shipments_inner_order_lines_inner.rb,
lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_inner.rb,
lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value.rb,
lib/zippendo/models/list_available_carriers200_response_inner_required_fields_inner.rb,
lib/zippendo/models/list_shipping_rules200_response_data_inner_return_shipping_rule.rb,
lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of.rb,
lib/zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner.rb,
lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of1.rb,
lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of2.rb,
lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of3.rb,
lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of4.rb,
lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of.rb,
lib/zippendo/models/list_shipping_rules200_response_data_inner_additional_parameters_inner.rb,
lib/zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner_options_inner.rb,
lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value.rb,
lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_coordinates_inner.rb,
lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_any_of.rb

Overview

#Zippendo Public API

#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).

The version of the OpenAPI document: 1.0.0 Contact: support@zippendo.com Generated by: https://openapi-generator.tech Generator version: 7.24.0

Defined Under Namespace

Modules: CreateShippingRuleRequestAdditionalParameters, CreateShippingRuleRequestAdditionalParametersAnyOfValue, CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner, CreateShippingRuleRequestConditionsInner, ListCarriers200ResponseDataInnerConfigValue, ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue, ListShippingRules200ResponseDataInnerConditionsInner Classes: AddressesApi, ApiClient, ApiError, ApiModelBase, BatchSendShipments200Response, BatchSendShipments200ResponseResultsInner, BatchSendShipments200ResponseSummary, BatchSendShipmentsRequest, BatchSplitShipment201Response, BatchSplitShipmentRequest, BatchSplitShipmentRequestShipmentsInner, BatchSplitShipmentRequestShipmentsInnerOrderLinesInner, BillingApi, CarrierCatalogApi, CarriersApi, Configuration, ConnectCarrierRequest, CreateAddressRequest, CreateApiToken201Response, CreateApiTokenRequest, CreateOrder201Response, CreateOrder201ResponseOrderLinesInner, CreateOrder201ResponseShippingAddress, CreateOrderRequest, CreateOrderRequestOrderLinesInner, CreateOrderRequestShippingAddress, CreateOrgWebhook201Response, CreateOrgWebhookRequest, CreateShipment201Response, CreateShipment201ResponseActivitiesInner, CreateShipment201ResponseDocumentsInner, CreateShipment201ResponseErrorsInner, CreateShipment201ResponseLogsInner, CreateShipment201ResponseParcelsInner, CreateShipment201ResponseParcelsInnerDimensions, CreateShipment201ResponseParcelsInnerOrderLinesInner, CreateShipment201ResponsePartiesInner, CreateShipment201ResponsePartiesInnerAttributesInner, CreateShipment201ResponsePickupDetails, CreateShipment201ResponseShippingRule, CreateShipment201ResponseTracking, CreateShipmentRequest, CreateShipmentRequestCarrierSettings, CreateShipmentRequestParcelsInner, CreateShipmentRequestParcelsInnerDimensions, CreateShipmentRequestParcelsInnerOrderLinesInner, CreateShipmentRequestPartiesInner, CreateShipmentRequestPartiesInnerAttributesInner, CreateShipmentRequestPickupDetails, CreateShippingQuote200Response, CreateShippingQuote200ResponseRatesInner, CreateShippingQuote400Response, CreateShippingQuote404Response, CreateShippingQuoteRequest, CreateShippingQuoteRequestDestination, CreateShippingQuoteRequestItemsInner, CreateShippingRule201Response, CreateShippingRuleRequest, CreateShippingRuleRequestAdditionalParametersAnyOfInner, CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf, CreateShippingRuleRequestConditionsInnerOneOf, CreateShippingRuleRequestConditionsInnerOneOf1, CreateShippingRuleRequestConditionsInnerOneOf2, CreateShippingRuleRequestConditionsInnerOneOf3, CreateShippingRuleRequestConditionsInnerOneOf4, DeleteOrgWebhook200Response, DeleteShippingRule200Response, GetBillingUsage200Response, GetBillingUsage200ResponseAddOnsInner, GetBillingUsage200ResponseCurrentPeriod, GetBillingUsage200ResponseLimits, GetBillingUsage200ResponseLimitsTeamMembers, GetBillingUsage200ResponseShipments, GetOrder200Response, GetOrder200ResponseShipmentsInner, GetOrder200ResponseShippingRule, GetOrg200Response, GetOrg200ResponseCount, GetOrgBranding200Response, HealthCheck200Response, ListAddresses200Response, ListAddresses200ResponseDataInner, ListApiTokens200Response, ListApiTokens200ResponseDataInner, ListApiTokens200ResponseDataInnerCreatedBy, ListApiTokens401Response, ListAvailableCarriers200ResponseInner, ListAvailableCarriers200ResponseInnerRequiredFieldsInner, ListCarrierProductServicePoints200ResponseInner, ListCarrierProductServicePoints200ResponseInnerAddress, ListCarrierProductServicePointsRequest, ListCarrierProducts200ResponseInner, ListCarrierProducts200ResponseInnerAdditionalParametersInner, ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner, ListCarrierProducts200ResponseInnerServicesInner, ListCarrierProducts200ResponseInnerWeightLimits, ListCarriers200Response, ListCarriers200ResponseDataInner, ListOrders200Response, ListOrders200ResponseDataInner, ListOrders200ResponseDataInnerOrderChannel, ListOrgWebhookDeliveries200Response, ListOrgWebhookDeliveries200ResponseDataInner, ListOrgWebhooks200Response, ListOrgWebhooks200ResponseDataInner, ListShipments200Response, ListShipments200ResponseDataInner, ListShipments200ResponseDataInnerAddress, ListShipments200ResponseDataInnerCarrierSettings, ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf, ListShippingRules200Response, ListShippingRules200ResponseDataInner, ListShippingRules200ResponseDataInnerAdditionalParametersInner, ListShippingRules200ResponseDataInnerCarrier, ListShippingRules200ResponseDataInnerConditionsInnerOneOf, ListShippingRules200ResponseDataInnerConditionsInnerOneOf1, ListShippingRules200ResponseDataInnerConditionsInnerOneOf2, ListShippingRules200ResponseDataInnerConditionsInnerOneOf3, ListShippingRules200ResponseDataInnerConditionsInnerOneOf4, ListShippingRules200ResponseDataInnerLabelPrinter, ListShippingRules200ResponseDataInnerReturnShippingRule, OrdersApi, OrgsApi, QuotesApi, RevokeApiToken200Response, RulesApi, SendShipment422Response, SendShipment422ResponseErrorsInner, ShipmentsApi, SplitShipment201Response, SplitShipmentParcel200Response, SplitShipmentParcelRequest, SplitShipmentParcelRequestParcelsInner, SplitShipmentRequest, SystemApi, TestOrgWebhook200Response, TokensApi, TrackShipment200Response, TrackShipment200ResponseEventsInner, UpdateAddressRequest, UpdateApiTokenRequest, UpdateCarrierRequest, UpdateOrderRequest, UpdateOrg200Response, UpdateOrgBrandingRequest, UpdateOrgRequest, UpdateOrgWebhookRequest, UpdateShipmentRequest, UpdateShippingRuleRequest, VerifyApiToken200Response, VerifyApiTokenRequest, WebhooksApi

Constant Summary collapse

VERSION = 
'1.0.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block. Zippendo.configure do |config| config.username = "xxx" config.password = "xxx" end If no block given, return the default Configuration object.



187
188
189
190
191
192
193
 
# File 'lib/zippendo.rb', line 187

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end