@zippendo/sdk 1.1.1 → 1.1.3
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.
- package/README.md +11 -0
- package/dist/apis/AddressesApi.d.ts +12 -1
- package/dist/apis/AddressesApi.js +16 -2
- package/dist/apis/BillingApi.d.ts +1 -1
- package/dist/apis/BillingApi.js +1 -1
- package/dist/apis/BrandsApi.d.ts +1 -1
- package/dist/apis/BrandsApi.js +1 -1
- package/dist/apis/CarrierCatalogApi.d.ts +1 -1
- package/dist/apis/CarrierCatalogApi.js +1 -1
- package/dist/apis/CarriersApi.d.ts +12 -1
- package/dist/apis/CarriersApi.js +16 -2
- package/dist/apis/OrdersApi.d.ts +11 -1
- package/dist/apis/OrdersApi.js +13 -2
- package/dist/apis/OrgsApi.d.ts +1 -1
- package/dist/apis/OrgsApi.js +1 -1
- package/dist/apis/QuotesApi.d.ts +1 -1
- package/dist/apis/QuotesApi.js +1 -1
- package/dist/apis/RulesApi.d.ts +12 -1
- package/dist/apis/RulesApi.js +16 -2
- package/dist/apis/ShipmentsApi.d.ts +11 -1
- package/dist/apis/ShipmentsApi.js +13 -2
- package/dist/apis/SystemApi.d.ts +1 -1
- package/dist/apis/SystemApi.js +1 -1
- package/dist/apis/TokensApi.d.ts +1 -1
- package/dist/apis/TokensApi.js +1 -1
- package/dist/apis/WebhooksApi.d.ts +12 -1
- package/dist/apis/WebhooksApi.js +16 -2
- package/dist/esm/apis/AddressesApi.d.ts +12 -1
- package/dist/esm/apis/AddressesApi.js +15 -1
- package/dist/esm/apis/BillingApi.d.ts +1 -1
- package/dist/esm/apis/BillingApi.js +1 -1
- package/dist/esm/apis/BrandsApi.d.ts +1 -1
- package/dist/esm/apis/BrandsApi.js +1 -1
- package/dist/esm/apis/CarrierCatalogApi.d.ts +1 -1
- package/dist/esm/apis/CarrierCatalogApi.js +1 -1
- package/dist/esm/apis/CarriersApi.d.ts +12 -1
- package/dist/esm/apis/CarriersApi.js +15 -1
- package/dist/esm/apis/OrdersApi.d.ts +11 -1
- package/dist/esm/apis/OrdersApi.js +12 -1
- package/dist/esm/apis/OrgsApi.d.ts +1 -1
- package/dist/esm/apis/OrgsApi.js +1 -1
- package/dist/esm/apis/QuotesApi.d.ts +1 -1
- package/dist/esm/apis/QuotesApi.js +1 -1
- package/dist/esm/apis/RulesApi.d.ts +12 -1
- package/dist/esm/apis/RulesApi.js +15 -1
- package/dist/esm/apis/ShipmentsApi.d.ts +11 -1
- package/dist/esm/apis/ShipmentsApi.js +12 -1
- package/dist/esm/apis/SystemApi.d.ts +1 -1
- package/dist/esm/apis/SystemApi.js +1 -1
- package/dist/esm/apis/TokensApi.d.ts +1 -1
- package/dist/esm/apis/TokensApi.js +1 -1
- package/dist/esm/apis/WebhooksApi.d.ts +12 -1
- package/dist/esm/apis/WebhooksApi.js +15 -1
- package/dist/esm/models/BatchSendShipments200Response.d.ts +1 -1
- package/dist/esm/models/BatchSendShipments200Response.js +1 -1
- package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +7 -1
- package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +8 -2
- package/dist/esm/models/BatchSendShipments200ResponseSummary.d.ts +1 -1
- package/dist/esm/models/BatchSendShipments200ResponseSummary.js +1 -1
- package/dist/esm/models/BatchSendShipmentsRequest.d.ts +1 -1
- package/dist/esm/models/BatchSendShipmentsRequest.js +1 -1
- package/dist/esm/models/BatchSplitShipment201Response.d.ts +1 -1
- package/dist/esm/models/BatchSplitShipment201Response.js +1 -1
- package/dist/esm/models/BatchSplitShipmentRequest.d.ts +1 -1
- package/dist/esm/models/BatchSplitShipmentRequest.js +1 -1
- package/dist/esm/models/BatchSplitShipmentRequestShipmentsInner.d.ts +1 -1
- package/dist/esm/models/BatchSplitShipmentRequestShipmentsInner.js +1 -1
- package/dist/esm/models/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.d.ts +1 -1
- package/dist/esm/models/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.js +1 -1
- package/dist/esm/models/CheckBrandSlug200Response.d.ts +1 -1
- package/dist/esm/models/CheckBrandSlug200Response.js +1 -1
- package/dist/esm/models/ConnectCarrierRequest.d.ts +7 -1
- package/dist/esm/models/ConnectCarrierRequest.js +3 -1
- package/dist/esm/models/CreateAddressRequest.d.ts +7 -1
- package/dist/esm/models/CreateAddressRequest.js +3 -1
- package/dist/esm/models/CreateApiToken201Response.d.ts +1 -1
- package/dist/esm/models/CreateApiToken201Response.js +1 -1
- package/dist/esm/models/CreateApiTokenRequest.d.ts +1 -1
- package/dist/esm/models/CreateApiTokenRequest.js +1 -1
- package/dist/esm/models/CreateOrder201Response.d.ts +1 -1
- package/dist/esm/models/CreateOrder201Response.js +1 -1
- package/dist/esm/models/CreateOrder201ResponseOrderLinesInner.d.ts +1 -1
- package/dist/esm/models/CreateOrder201ResponseOrderLinesInner.js +1 -1
- package/dist/esm/models/CreateOrder201ResponseShippingAddress.d.ts +1 -1
- package/dist/esm/models/CreateOrder201ResponseShippingAddress.js +1 -1
- package/dist/esm/models/CreateOrderRequest.d.ts +1 -1
- package/dist/esm/models/CreateOrderRequest.js +1 -1
- package/dist/esm/models/CreateOrderRequestOrderLinesInner.d.ts +1 -1
- package/dist/esm/models/CreateOrderRequestOrderLinesInner.js +1 -1
- package/dist/esm/models/CreateOrderRequestShippingAddress.d.ts +1 -1
- package/dist/esm/models/CreateOrderRequestShippingAddress.js +1 -1
- package/dist/esm/models/CreateOrgBrandRequest.d.ts +1 -1
- package/dist/esm/models/CreateOrgBrandRequest.js +1 -1
- package/dist/esm/models/CreateOrgWebhook201Response.d.ts +7 -1
- package/dist/esm/models/CreateOrgWebhook201Response.js +5 -1
- package/dist/esm/models/CreateOrgWebhookRequest.d.ts +7 -1
- package/dist/esm/models/CreateOrgWebhookRequest.js +3 -1
- package/dist/esm/models/CreateShipment201Response.d.ts +1 -1
- package/dist/esm/models/CreateShipment201Response.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseActivitiesInner.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponseActivitiesInner.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseDocumentsInner.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponseDocumentsInner.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseErrorsInner.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponseErrorsInner.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseLogsInner.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponseLogsInner.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseParcelsInner.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponseParcelsInner.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseParcelsInnerDimensions.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponseParcelsInnerDimensions.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.js +1 -1
- package/dist/esm/models/CreateShipment201ResponsePartiesInner.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponsePartiesInner.js +1 -1
- package/dist/esm/models/CreateShipment201ResponsePartiesInnerAttributesInner.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponsePartiesInnerAttributesInner.js +1 -1
- package/dist/esm/models/CreateShipment201ResponsePickupDetails.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponsePickupDetails.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseShippingRule.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponseShippingRule.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseTracking.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponseTracking.js +1 -1
- package/dist/esm/models/CreateShipmentRequest.d.ts +1 -1
- package/dist/esm/models/CreateShipmentRequest.js +1 -1
- package/dist/esm/models/CreateShipmentRequestCarrierSettings.d.ts +1 -1
- package/dist/esm/models/CreateShipmentRequestCarrierSettings.js +1 -1
- package/dist/esm/models/CreateShipmentRequestParcelsInner.d.ts +1 -1
- package/dist/esm/models/CreateShipmentRequestParcelsInner.js +1 -1
- package/dist/esm/models/CreateShipmentRequestParcelsInnerDimensions.d.ts +1 -1
- package/dist/esm/models/CreateShipmentRequestParcelsInnerDimensions.js +1 -1
- package/dist/esm/models/CreateShipmentRequestParcelsInnerOrderLinesInner.d.ts +1 -1
- package/dist/esm/models/CreateShipmentRequestParcelsInnerOrderLinesInner.js +1 -1
- package/dist/esm/models/CreateShipmentRequestPartiesInner.d.ts +1 -1
- package/dist/esm/models/CreateShipmentRequestPartiesInner.js +1 -1
- package/dist/esm/models/CreateShipmentRequestPartiesInnerAttributesInner.d.ts +1 -1
- package/dist/esm/models/CreateShipmentRequestPartiesInnerAttributesInner.js +1 -1
- package/dist/esm/models/CreateShipmentRequestPickupDetails.d.ts +1 -1
- package/dist/esm/models/CreateShipmentRequestPickupDetails.js +1 -1
- package/dist/esm/models/CreateShippingQuote200Response.d.ts +1 -1
- package/dist/esm/models/CreateShippingQuote200Response.js +1 -1
- package/dist/esm/models/CreateShippingQuote200ResponseRatesInner.d.ts +1 -1
- package/dist/esm/models/CreateShippingQuote200ResponseRatesInner.js +1 -1
- package/dist/esm/models/CreateShippingQuote400Response.d.ts +1 -1
- package/dist/esm/models/CreateShippingQuote400Response.js +1 -1
- package/dist/esm/models/CreateShippingQuote404Response.d.ts +1 -1
- package/dist/esm/models/CreateShippingQuote404Response.js +1 -1
- package/dist/esm/models/CreateShippingQuoteRequest.d.ts +1 -1
- package/dist/esm/models/CreateShippingQuoteRequest.js +1 -1
- package/dist/esm/models/CreateShippingQuoteRequestDestination.d.ts +1 -1
- package/dist/esm/models/CreateShippingQuoteRequestDestination.js +1 -1
- package/dist/esm/models/CreateShippingQuoteRequestItemsInner.d.ts +1 -1
- package/dist/esm/models/CreateShippingQuoteRequestItemsInner.js +1 -1
- package/dist/esm/models/CreateShippingRule201Response.d.ts +7 -1
- package/dist/esm/models/CreateShippingRule201Response.js +5 -1
- package/dist/esm/models/CreateShippingRuleRequest.d.ts +7 -1
- package/dist/esm/models/CreateShippingRuleRequest.js +3 -1
- package/dist/esm/models/CreateShippingRuleRequestAdditionalParametersValue.d.ts +1 -1
- package/dist/esm/models/CreateShippingRuleRequestAdditionalParametersValue.js +1 -1
- package/dist/esm/models/CreateShippingRuleRequestAdditionalParametersValueAnyOf.d.ts +1 -1
- package/dist/esm/models/CreateShippingRuleRequestAdditionalParametersValueAnyOf.js +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInner.d.ts +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInner.js +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf.d.ts +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf.js +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf1.d.ts +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf1.js +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf2.d.ts +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf2.js +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf3.d.ts +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf3.js +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf4.d.ts +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf4.js +1 -1
- package/dist/esm/models/DeleteOrgWebhook200Response.d.ts +1 -1
- package/dist/esm/models/DeleteOrgWebhook200Response.js +1 -1
- package/dist/esm/models/DeleteShippingRule200Response.d.ts +1 -1
- package/dist/esm/models/DeleteShippingRule200Response.js +1 -1
- package/dist/esm/models/GetBillingUsage200Response.d.ts +8 -1
- package/dist/esm/models/GetBillingUsage200Response.js +4 -1
- package/dist/esm/models/GetBillingUsage200ResponseAddOnsInner.d.ts +2 -1
- package/dist/esm/models/GetBillingUsage200ResponseAddOnsInner.js +3 -2
- package/dist/esm/models/GetBillingUsage200ResponseCurrentPeriod.d.ts +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseCurrentPeriod.js +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseLimits.d.ts +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseLimits.js +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseLimitsTeamMembers.d.ts +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseLimitsTeamMembers.js +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseShipments.d.ts +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseShipments.js +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseZippyMessages.d.ts +38 -0
- package/dist/esm/models/GetBillingUsage200ResponseZippyMessages.js +47 -0
- package/dist/esm/models/GetOrder200Response.d.ts +1 -1
- package/dist/esm/models/GetOrder200Response.js +1 -1
- package/dist/esm/models/GetOrder200ResponseShipmentsInner.d.ts +1 -1
- package/dist/esm/models/GetOrder200ResponseShipmentsInner.js +1 -1
- package/dist/esm/models/GetOrder200ResponseShippingRule.d.ts +1 -1
- package/dist/esm/models/GetOrder200ResponseShippingRule.js +1 -1
- package/dist/esm/models/GetOrg200Response.d.ts +1 -1
- package/dist/esm/models/GetOrg200Response.js +1 -1
- package/dist/esm/models/GetOrg200ResponseCount.d.ts +1 -1
- package/dist/esm/models/GetOrg200ResponseCount.js +1 -1
- package/dist/esm/models/GetOrgBranding200Response.d.ts +1 -1
- package/dist/esm/models/GetOrgBranding200Response.js +1 -1
- package/dist/esm/models/HealthCheck200Response.d.ts +1 -1
- package/dist/esm/models/HealthCheck200Response.js +1 -1
- package/dist/esm/models/ListAddresses200Response.d.ts +1 -1
- package/dist/esm/models/ListAddresses200Response.js +1 -1
- package/dist/esm/models/ListAddresses200ResponseDataInner.d.ts +7 -1
- package/dist/esm/models/ListAddresses200ResponseDataInner.js +5 -1
- package/dist/esm/models/ListApiTokens200Response.d.ts +1 -1
- package/dist/esm/models/ListApiTokens200Response.js +1 -1
- package/dist/esm/models/ListApiTokens200ResponseDataInner.d.ts +1 -1
- package/dist/esm/models/ListApiTokens200ResponseDataInner.js +1 -1
- package/dist/esm/models/ListApiTokens200ResponseDataInnerCreatedBy.d.ts +1 -1
- package/dist/esm/models/ListApiTokens200ResponseDataInnerCreatedBy.js +1 -1
- package/dist/esm/models/ListApiTokens401Response.d.ts +7 -1
- package/dist/esm/models/ListApiTokens401Response.js +8 -2
- package/dist/esm/models/ListAvailableCarriers200ResponseInner.d.ts +1 -1
- package/dist/esm/models/ListAvailableCarriers200ResponseInner.js +1 -1
- package/dist/esm/models/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.d.ts +1 -1
- package/dist/esm/models/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.js +1 -1
- package/dist/esm/models/ListCarrierProductServicePoints200ResponseInner.d.ts +1 -1
- package/dist/esm/models/ListCarrierProductServicePoints200ResponseInner.js +1 -1
- package/dist/esm/models/ListCarrierProductServicePoints200ResponseInnerAddress.d.ts +1 -1
- package/dist/esm/models/ListCarrierProductServicePoints200ResponseInnerAddress.js +1 -1
- package/dist/esm/models/ListCarrierProductServicePointsRequest.d.ts +1 -1
- package/dist/esm/models/ListCarrierProductServicePointsRequest.js +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInner.d.ts +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInner.js +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInnerAdditionalParametersInner.d.ts +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInnerAdditionalParametersInner.js +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.d.ts +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.js +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInnerServicesInner.d.ts +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInnerServicesInner.js +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInnerWeightLimits.d.ts +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInnerWeightLimits.js +1 -1
- package/dist/esm/models/ListCarriers200Response.d.ts +1 -1
- package/dist/esm/models/ListCarriers200Response.js +1 -1
- package/dist/esm/models/ListCarriers200ResponseDataInner.d.ts +7 -1
- package/dist/esm/models/ListCarriers200ResponseDataInner.js +5 -1
- package/dist/esm/models/ListCarriers200ResponseDataInnerConfigValue.d.ts +1 -1
- package/dist/esm/models/ListCarriers200ResponseDataInnerConfigValue.js +1 -1
- package/dist/esm/models/ListOrders200Response.d.ts +1 -1
- package/dist/esm/models/ListOrders200Response.js +1 -1
- package/dist/esm/models/ListOrders200ResponseDataInner.d.ts +1 -1
- package/dist/esm/models/ListOrders200ResponseDataInner.js +1 -1
- package/dist/esm/models/ListOrders200ResponseDataInnerOrderChannel.d.ts +1 -1
- package/dist/esm/models/ListOrders200ResponseDataInnerOrderChannel.js +1 -1
- package/dist/esm/models/ListOrgBrands200Response.d.ts +1 -1
- package/dist/esm/models/ListOrgBrands200Response.js +1 -1
- package/dist/esm/models/ListOrgBrands200ResponseDataInner.d.ts +1 -1
- package/dist/esm/models/ListOrgBrands200ResponseDataInner.js +1 -1
- package/dist/esm/models/ListOrgWebhookDeliveries200Response.d.ts +1 -1
- package/dist/esm/models/ListOrgWebhookDeliveries200Response.js +1 -1
- package/dist/esm/models/ListOrgWebhookDeliveries200ResponseDataInner.d.ts +1 -1
- package/dist/esm/models/ListOrgWebhookDeliveries200ResponseDataInner.js +1 -1
- package/dist/esm/models/ListOrgWebhooks200Response.d.ts +1 -1
- package/dist/esm/models/ListOrgWebhooks200Response.js +1 -1
- package/dist/esm/models/ListOrgWebhooks200ResponseDataInner.d.ts +7 -1
- package/dist/esm/models/ListOrgWebhooks200ResponseDataInner.js +5 -1
- package/dist/esm/models/ListShipments200Response.d.ts +1 -1
- package/dist/esm/models/ListShipments200Response.js +1 -1
- package/dist/esm/models/ListShipments200ResponseDataInner.d.ts +1 -1
- package/dist/esm/models/ListShipments200ResponseDataInner.js +1 -1
- package/dist/esm/models/ListShipments200ResponseDataInnerAddress.d.ts +7 -1
- package/dist/esm/models/ListShipments200ResponseDataInnerAddress.js +5 -1
- package/dist/esm/models/ListShipments200ResponseDataInnerCarrierSettings.d.ts +1 -1
- package/dist/esm/models/ListShipments200ResponseDataInnerCarrierSettings.js +1 -1
- package/dist/esm/models/ListShippingRules200Response.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200Response.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInner.d.ts +7 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInner.js +5 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerAdditionalParametersValue.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerAdditionalParametersValue.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerCarrier.d.ts +7 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerCarrier.js +5 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInner.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInner.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerLabelPrinter.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerLabelPrinter.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerReturnShippingRule.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerReturnShippingRule.js +1 -1
- package/dist/esm/models/RevokeApiToken200Response.d.ts +1 -1
- package/dist/esm/models/RevokeApiToken200Response.js +1 -1
- package/dist/esm/models/SendShipment422Response.d.ts +7 -1
- package/dist/esm/models/SendShipment422Response.js +8 -2
- package/dist/esm/models/SendShipment422ResponseErrorsInner.d.ts +1 -1
- package/dist/esm/models/SendShipment422ResponseErrorsInner.js +1 -1
- package/dist/esm/models/SplitShipment201Response.d.ts +1 -1
- package/dist/esm/models/SplitShipment201Response.js +1 -1
- package/dist/esm/models/SplitShipmentParcel200Response.d.ts +1 -1
- package/dist/esm/models/SplitShipmentParcel200Response.js +1 -1
- package/dist/esm/models/SplitShipmentParcelRequest.d.ts +1 -1
- package/dist/esm/models/SplitShipmentParcelRequest.js +1 -1
- package/dist/esm/models/SplitShipmentParcelRequestParcelsInner.d.ts +1 -1
- package/dist/esm/models/SplitShipmentParcelRequestParcelsInner.js +1 -1
- package/dist/esm/models/SplitShipmentRequest.d.ts +1 -1
- package/dist/esm/models/SplitShipmentRequest.js +1 -1
- package/dist/esm/models/TestOrgWebhook200Response.d.ts +1 -1
- package/dist/esm/models/TestOrgWebhook200Response.js +1 -1
- package/dist/esm/models/TrackShipment200Response.d.ts +1 -1
- package/dist/esm/models/TrackShipment200Response.js +1 -1
- package/dist/esm/models/TrackShipment200ResponseEventsInner.d.ts +1 -1
- package/dist/esm/models/TrackShipment200ResponseEventsInner.js +1 -1
- package/dist/esm/models/UpdateAddressRequest.d.ts +7 -1
- package/dist/esm/models/UpdateAddressRequest.js +3 -1
- package/dist/esm/models/UpdateApiTokenRequest.d.ts +1 -1
- package/dist/esm/models/UpdateApiTokenRequest.js +1 -1
- package/dist/esm/models/UpdateCarrierRequest.d.ts +7 -1
- package/dist/esm/models/UpdateCarrierRequest.js +3 -1
- package/dist/esm/models/UpdateOrderRequest.d.ts +1 -1
- package/dist/esm/models/UpdateOrderRequest.js +1 -1
- package/dist/esm/models/UpdateOrg200Response.d.ts +1 -1
- package/dist/esm/models/UpdateOrg200Response.js +1 -1
- package/dist/esm/models/UpdateOrgBrandRequest.d.ts +1 -1
- package/dist/esm/models/UpdateOrgBrandRequest.js +1 -1
- package/dist/esm/models/UpdateOrgBrandingRequest.d.ts +1 -1
- package/dist/esm/models/UpdateOrgBrandingRequest.js +1 -1
- package/dist/esm/models/UpdateOrgRequest.d.ts +1 -1
- package/dist/esm/models/UpdateOrgRequest.js +1 -1
- package/dist/esm/models/UpdateOrgWebhookRequest.d.ts +7 -1
- package/dist/esm/models/UpdateOrgWebhookRequest.js +3 -1
- package/dist/esm/models/UpdateShipmentRequest.d.ts +1 -1
- package/dist/esm/models/UpdateShipmentRequest.js +1 -1
- package/dist/esm/models/UpdateShippingRuleRequest.d.ts +7 -1
- package/dist/esm/models/UpdateShippingRuleRequest.js +3 -1
- package/dist/esm/models/VerifyApiToken200Response.d.ts +1 -1
- package/dist/esm/models/VerifyApiToken200Response.js +1 -1
- package/dist/esm/models/VerifyApiTokenRequest.d.ts +1 -1
- package/dist/esm/models/VerifyApiTokenRequest.js +1 -1
- package/dist/esm/models/index.d.ts +1 -0
- package/dist/esm/models/index.js +1 -0
- package/dist/esm/runtime.d.ts +1 -1
- package/dist/esm/runtime.js +1 -1
- package/dist/models/BatchSendShipments200Response.d.ts +1 -1
- package/dist/models/BatchSendShipments200Response.js +1 -1
- package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +7 -1
- package/dist/models/BatchSendShipments200ResponseResultsInner.js +8 -2
- package/dist/models/BatchSendShipments200ResponseSummary.d.ts +1 -1
- package/dist/models/BatchSendShipments200ResponseSummary.js +1 -1
- package/dist/models/BatchSendShipmentsRequest.d.ts +1 -1
- package/dist/models/BatchSendShipmentsRequest.js +1 -1
- package/dist/models/BatchSplitShipment201Response.d.ts +1 -1
- package/dist/models/BatchSplitShipment201Response.js +1 -1
- package/dist/models/BatchSplitShipmentRequest.d.ts +1 -1
- package/dist/models/BatchSplitShipmentRequest.js +1 -1
- package/dist/models/BatchSplitShipmentRequestShipmentsInner.d.ts +1 -1
- package/dist/models/BatchSplitShipmentRequestShipmentsInner.js +1 -1
- package/dist/models/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.d.ts +1 -1
- package/dist/models/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.js +1 -1
- package/dist/models/CheckBrandSlug200Response.d.ts +1 -1
- package/dist/models/CheckBrandSlug200Response.js +1 -1
- package/dist/models/ConnectCarrierRequest.d.ts +7 -1
- package/dist/models/ConnectCarrierRequest.js +3 -1
- package/dist/models/CreateAddressRequest.d.ts +7 -1
- package/dist/models/CreateAddressRequest.js +3 -1
- package/dist/models/CreateApiToken201Response.d.ts +1 -1
- package/dist/models/CreateApiToken201Response.js +1 -1
- package/dist/models/CreateApiTokenRequest.d.ts +1 -1
- package/dist/models/CreateApiTokenRequest.js +1 -1
- package/dist/models/CreateOrder201Response.d.ts +1 -1
- package/dist/models/CreateOrder201Response.js +1 -1
- package/dist/models/CreateOrder201ResponseOrderLinesInner.d.ts +1 -1
- package/dist/models/CreateOrder201ResponseOrderLinesInner.js +1 -1
- package/dist/models/CreateOrder201ResponseShippingAddress.d.ts +1 -1
- package/dist/models/CreateOrder201ResponseShippingAddress.js +1 -1
- package/dist/models/CreateOrderRequest.d.ts +1 -1
- package/dist/models/CreateOrderRequest.js +1 -1
- package/dist/models/CreateOrderRequestOrderLinesInner.d.ts +1 -1
- package/dist/models/CreateOrderRequestOrderLinesInner.js +1 -1
- package/dist/models/CreateOrderRequestShippingAddress.d.ts +1 -1
- package/dist/models/CreateOrderRequestShippingAddress.js +1 -1
- package/dist/models/CreateOrgBrandRequest.d.ts +1 -1
- package/dist/models/CreateOrgBrandRequest.js +1 -1
- package/dist/models/CreateOrgWebhook201Response.d.ts +7 -1
- package/dist/models/CreateOrgWebhook201Response.js +5 -1
- package/dist/models/CreateOrgWebhookRequest.d.ts +7 -1
- package/dist/models/CreateOrgWebhookRequest.js +3 -1
- package/dist/models/CreateShipment201Response.d.ts +1 -1
- package/dist/models/CreateShipment201Response.js +1 -1
- package/dist/models/CreateShipment201ResponseActivitiesInner.d.ts +1 -1
- package/dist/models/CreateShipment201ResponseActivitiesInner.js +1 -1
- package/dist/models/CreateShipment201ResponseDocumentsInner.d.ts +1 -1
- package/dist/models/CreateShipment201ResponseDocumentsInner.js +1 -1
- package/dist/models/CreateShipment201ResponseErrorsInner.d.ts +1 -1
- package/dist/models/CreateShipment201ResponseErrorsInner.js +1 -1
- package/dist/models/CreateShipment201ResponseLogsInner.d.ts +1 -1
- package/dist/models/CreateShipment201ResponseLogsInner.js +1 -1
- package/dist/models/CreateShipment201ResponseParcelsInner.d.ts +1 -1
- package/dist/models/CreateShipment201ResponseParcelsInner.js +1 -1
- package/dist/models/CreateShipment201ResponseParcelsInnerDimensions.d.ts +1 -1
- package/dist/models/CreateShipment201ResponseParcelsInnerDimensions.js +1 -1
- package/dist/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.d.ts +1 -1
- package/dist/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.js +1 -1
- package/dist/models/CreateShipment201ResponsePartiesInner.d.ts +1 -1
- package/dist/models/CreateShipment201ResponsePartiesInner.js +1 -1
- package/dist/models/CreateShipment201ResponsePartiesInnerAttributesInner.d.ts +1 -1
- package/dist/models/CreateShipment201ResponsePartiesInnerAttributesInner.js +1 -1
- package/dist/models/CreateShipment201ResponsePickupDetails.d.ts +1 -1
- package/dist/models/CreateShipment201ResponsePickupDetails.js +1 -1
- package/dist/models/CreateShipment201ResponseShippingRule.d.ts +1 -1
- package/dist/models/CreateShipment201ResponseShippingRule.js +1 -1
- package/dist/models/CreateShipment201ResponseTracking.d.ts +1 -1
- package/dist/models/CreateShipment201ResponseTracking.js +1 -1
- package/dist/models/CreateShipmentRequest.d.ts +1 -1
- package/dist/models/CreateShipmentRequest.js +1 -1
- package/dist/models/CreateShipmentRequestCarrierSettings.d.ts +1 -1
- package/dist/models/CreateShipmentRequestCarrierSettings.js +1 -1
- package/dist/models/CreateShipmentRequestParcelsInner.d.ts +1 -1
- package/dist/models/CreateShipmentRequestParcelsInner.js +1 -1
- package/dist/models/CreateShipmentRequestParcelsInnerDimensions.d.ts +1 -1
- package/dist/models/CreateShipmentRequestParcelsInnerDimensions.js +1 -1
- package/dist/models/CreateShipmentRequestParcelsInnerOrderLinesInner.d.ts +1 -1
- package/dist/models/CreateShipmentRequestParcelsInnerOrderLinesInner.js +1 -1
- package/dist/models/CreateShipmentRequestPartiesInner.d.ts +1 -1
- package/dist/models/CreateShipmentRequestPartiesInner.js +1 -1
- package/dist/models/CreateShipmentRequestPartiesInnerAttributesInner.d.ts +1 -1
- package/dist/models/CreateShipmentRequestPartiesInnerAttributesInner.js +1 -1
- package/dist/models/CreateShipmentRequestPickupDetails.d.ts +1 -1
- package/dist/models/CreateShipmentRequestPickupDetails.js +1 -1
- package/dist/models/CreateShippingQuote200Response.d.ts +1 -1
- package/dist/models/CreateShippingQuote200Response.js +1 -1
- package/dist/models/CreateShippingQuote200ResponseRatesInner.d.ts +1 -1
- package/dist/models/CreateShippingQuote200ResponseRatesInner.js +1 -1
- package/dist/models/CreateShippingQuote400Response.d.ts +1 -1
- package/dist/models/CreateShippingQuote400Response.js +1 -1
- package/dist/models/CreateShippingQuote404Response.d.ts +1 -1
- package/dist/models/CreateShippingQuote404Response.js +1 -1
- package/dist/models/CreateShippingQuoteRequest.d.ts +1 -1
- package/dist/models/CreateShippingQuoteRequest.js +1 -1
- package/dist/models/CreateShippingQuoteRequestDestination.d.ts +1 -1
- package/dist/models/CreateShippingQuoteRequestDestination.js +1 -1
- package/dist/models/CreateShippingQuoteRequestItemsInner.d.ts +1 -1
- package/dist/models/CreateShippingQuoteRequestItemsInner.js +1 -1
- package/dist/models/CreateShippingRule201Response.d.ts +7 -1
- package/dist/models/CreateShippingRule201Response.js +5 -1
- package/dist/models/CreateShippingRuleRequest.d.ts +7 -1
- package/dist/models/CreateShippingRuleRequest.js +3 -1
- package/dist/models/CreateShippingRuleRequestAdditionalParametersValue.d.ts +1 -1
- package/dist/models/CreateShippingRuleRequestAdditionalParametersValue.js +1 -1
- package/dist/models/CreateShippingRuleRequestAdditionalParametersValueAnyOf.d.ts +1 -1
- package/dist/models/CreateShippingRuleRequestAdditionalParametersValueAnyOf.js +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInner.d.ts +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInner.js +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf.d.ts +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf.js +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf1.d.ts +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf1.js +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf2.d.ts +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf2.js +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf3.d.ts +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf3.js +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf4.d.ts +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf4.js +1 -1
- package/dist/models/DeleteOrgWebhook200Response.d.ts +1 -1
- package/dist/models/DeleteOrgWebhook200Response.js +1 -1
- package/dist/models/DeleteShippingRule200Response.d.ts +1 -1
- package/dist/models/DeleteShippingRule200Response.js +1 -1
- package/dist/models/GetBillingUsage200Response.d.ts +8 -1
- package/dist/models/GetBillingUsage200Response.js +4 -1
- package/dist/models/GetBillingUsage200ResponseAddOnsInner.d.ts +2 -1
- package/dist/models/GetBillingUsage200ResponseAddOnsInner.js +3 -2
- package/dist/models/GetBillingUsage200ResponseCurrentPeriod.d.ts +1 -1
- package/dist/models/GetBillingUsage200ResponseCurrentPeriod.js +1 -1
- package/dist/models/GetBillingUsage200ResponseLimits.d.ts +1 -1
- package/dist/models/GetBillingUsage200ResponseLimits.js +1 -1
- package/dist/models/GetBillingUsage200ResponseLimitsTeamMembers.d.ts +1 -1
- package/dist/models/GetBillingUsage200ResponseLimitsTeamMembers.js +1 -1
- package/dist/models/GetBillingUsage200ResponseShipments.d.ts +1 -1
- package/dist/models/GetBillingUsage200ResponseShipments.js +1 -1
- package/dist/models/GetBillingUsage200ResponseZippyMessages.d.ts +38 -0
- package/dist/models/GetBillingUsage200ResponseZippyMessages.js +54 -0
- package/dist/models/GetOrder200Response.d.ts +1 -1
- package/dist/models/GetOrder200Response.js +1 -1
- package/dist/models/GetOrder200ResponseShipmentsInner.d.ts +1 -1
- package/dist/models/GetOrder200ResponseShipmentsInner.js +1 -1
- package/dist/models/GetOrder200ResponseShippingRule.d.ts +1 -1
- package/dist/models/GetOrder200ResponseShippingRule.js +1 -1
- package/dist/models/GetOrg200Response.d.ts +1 -1
- package/dist/models/GetOrg200Response.js +1 -1
- package/dist/models/GetOrg200ResponseCount.d.ts +1 -1
- package/dist/models/GetOrg200ResponseCount.js +1 -1
- package/dist/models/GetOrgBranding200Response.d.ts +1 -1
- package/dist/models/GetOrgBranding200Response.js +1 -1
- package/dist/models/HealthCheck200Response.d.ts +1 -1
- package/dist/models/HealthCheck200Response.js +1 -1
- package/dist/models/ListAddresses200Response.d.ts +1 -1
- package/dist/models/ListAddresses200Response.js +1 -1
- package/dist/models/ListAddresses200ResponseDataInner.d.ts +7 -1
- package/dist/models/ListAddresses200ResponseDataInner.js +5 -1
- package/dist/models/ListApiTokens200Response.d.ts +1 -1
- package/dist/models/ListApiTokens200Response.js +1 -1
- package/dist/models/ListApiTokens200ResponseDataInner.d.ts +1 -1
- package/dist/models/ListApiTokens200ResponseDataInner.js +1 -1
- package/dist/models/ListApiTokens200ResponseDataInnerCreatedBy.d.ts +1 -1
- package/dist/models/ListApiTokens200ResponseDataInnerCreatedBy.js +1 -1
- package/dist/models/ListApiTokens401Response.d.ts +7 -1
- package/dist/models/ListApiTokens401Response.js +8 -2
- package/dist/models/ListAvailableCarriers200ResponseInner.d.ts +1 -1
- package/dist/models/ListAvailableCarriers200ResponseInner.js +1 -1
- package/dist/models/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.d.ts +1 -1
- package/dist/models/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.js +1 -1
- package/dist/models/ListCarrierProductServicePoints200ResponseInner.d.ts +1 -1
- package/dist/models/ListCarrierProductServicePoints200ResponseInner.js +1 -1
- package/dist/models/ListCarrierProductServicePoints200ResponseInnerAddress.d.ts +1 -1
- package/dist/models/ListCarrierProductServicePoints200ResponseInnerAddress.js +1 -1
- package/dist/models/ListCarrierProductServicePointsRequest.d.ts +1 -1
- package/dist/models/ListCarrierProductServicePointsRequest.js +1 -1
- package/dist/models/ListCarrierProducts200ResponseInner.d.ts +1 -1
- package/dist/models/ListCarrierProducts200ResponseInner.js +1 -1
- package/dist/models/ListCarrierProducts200ResponseInnerAdditionalParametersInner.d.ts +1 -1
- package/dist/models/ListCarrierProducts200ResponseInnerAdditionalParametersInner.js +1 -1
- package/dist/models/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.d.ts +1 -1
- package/dist/models/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.js +1 -1
- package/dist/models/ListCarrierProducts200ResponseInnerServicesInner.d.ts +1 -1
- package/dist/models/ListCarrierProducts200ResponseInnerServicesInner.js +1 -1
- package/dist/models/ListCarrierProducts200ResponseInnerWeightLimits.d.ts +1 -1
- package/dist/models/ListCarrierProducts200ResponseInnerWeightLimits.js +1 -1
- package/dist/models/ListCarriers200Response.d.ts +1 -1
- package/dist/models/ListCarriers200Response.js +1 -1
- package/dist/models/ListCarriers200ResponseDataInner.d.ts +7 -1
- package/dist/models/ListCarriers200ResponseDataInner.js +5 -1
- package/dist/models/ListCarriers200ResponseDataInnerConfigValue.d.ts +1 -1
- package/dist/models/ListCarriers200ResponseDataInnerConfigValue.js +1 -1
- package/dist/models/ListOrders200Response.d.ts +1 -1
- package/dist/models/ListOrders200Response.js +1 -1
- package/dist/models/ListOrders200ResponseDataInner.d.ts +1 -1
- package/dist/models/ListOrders200ResponseDataInner.js +1 -1
- package/dist/models/ListOrders200ResponseDataInnerOrderChannel.d.ts +1 -1
- package/dist/models/ListOrders200ResponseDataInnerOrderChannel.js +1 -1
- package/dist/models/ListOrgBrands200Response.d.ts +1 -1
- package/dist/models/ListOrgBrands200Response.js +1 -1
- package/dist/models/ListOrgBrands200ResponseDataInner.d.ts +1 -1
- package/dist/models/ListOrgBrands200ResponseDataInner.js +1 -1
- package/dist/models/ListOrgWebhookDeliveries200Response.d.ts +1 -1
- package/dist/models/ListOrgWebhookDeliveries200Response.js +1 -1
- package/dist/models/ListOrgWebhookDeliveries200ResponseDataInner.d.ts +1 -1
- package/dist/models/ListOrgWebhookDeliveries200ResponseDataInner.js +1 -1
- package/dist/models/ListOrgWebhooks200Response.d.ts +1 -1
- package/dist/models/ListOrgWebhooks200Response.js +1 -1
- package/dist/models/ListOrgWebhooks200ResponseDataInner.d.ts +7 -1
- package/dist/models/ListOrgWebhooks200ResponseDataInner.js +5 -1
- package/dist/models/ListShipments200Response.d.ts +1 -1
- package/dist/models/ListShipments200Response.js +1 -1
- package/dist/models/ListShipments200ResponseDataInner.d.ts +1 -1
- package/dist/models/ListShipments200ResponseDataInner.js +1 -1
- package/dist/models/ListShipments200ResponseDataInnerAddress.d.ts +7 -1
- package/dist/models/ListShipments200ResponseDataInnerAddress.js +5 -1
- package/dist/models/ListShipments200ResponseDataInnerCarrierSettings.d.ts +1 -1
- package/dist/models/ListShipments200ResponseDataInnerCarrierSettings.js +1 -1
- package/dist/models/ListShippingRules200Response.d.ts +1 -1
- package/dist/models/ListShippingRules200Response.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInner.d.ts +7 -1
- package/dist/models/ListShippingRules200ResponseDataInner.js +5 -1
- package/dist/models/ListShippingRules200ResponseDataInnerAdditionalParametersValue.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerAdditionalParametersValue.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerCarrier.d.ts +7 -1
- package/dist/models/ListShippingRules200ResponseDataInnerCarrier.js +5 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInner.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInner.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerLabelPrinter.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerLabelPrinter.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerReturnShippingRule.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerReturnShippingRule.js +1 -1
- package/dist/models/RevokeApiToken200Response.d.ts +1 -1
- package/dist/models/RevokeApiToken200Response.js +1 -1
- package/dist/models/SendShipment422Response.d.ts +7 -1
- package/dist/models/SendShipment422Response.js +8 -2
- package/dist/models/SendShipment422ResponseErrorsInner.d.ts +1 -1
- package/dist/models/SendShipment422ResponseErrorsInner.js +1 -1
- package/dist/models/SplitShipment201Response.d.ts +1 -1
- package/dist/models/SplitShipment201Response.js +1 -1
- package/dist/models/SplitShipmentParcel200Response.d.ts +1 -1
- package/dist/models/SplitShipmentParcel200Response.js +1 -1
- package/dist/models/SplitShipmentParcelRequest.d.ts +1 -1
- package/dist/models/SplitShipmentParcelRequest.js +1 -1
- package/dist/models/SplitShipmentParcelRequestParcelsInner.d.ts +1 -1
- package/dist/models/SplitShipmentParcelRequestParcelsInner.js +1 -1
- package/dist/models/SplitShipmentRequest.d.ts +1 -1
- package/dist/models/SplitShipmentRequest.js +1 -1
- package/dist/models/TestOrgWebhook200Response.d.ts +1 -1
- package/dist/models/TestOrgWebhook200Response.js +1 -1
- package/dist/models/TrackShipment200Response.d.ts +1 -1
- package/dist/models/TrackShipment200Response.js +1 -1
- package/dist/models/TrackShipment200ResponseEventsInner.d.ts +1 -1
- package/dist/models/TrackShipment200ResponseEventsInner.js +1 -1
- package/dist/models/UpdateAddressRequest.d.ts +7 -1
- package/dist/models/UpdateAddressRequest.js +3 -1
- package/dist/models/UpdateApiTokenRequest.d.ts +1 -1
- package/dist/models/UpdateApiTokenRequest.js +1 -1
- package/dist/models/UpdateCarrierRequest.d.ts +7 -1
- package/dist/models/UpdateCarrierRequest.js +3 -1
- package/dist/models/UpdateOrderRequest.d.ts +1 -1
- package/dist/models/UpdateOrderRequest.js +1 -1
- package/dist/models/UpdateOrg200Response.d.ts +1 -1
- package/dist/models/UpdateOrg200Response.js +1 -1
- package/dist/models/UpdateOrgBrandRequest.d.ts +1 -1
- package/dist/models/UpdateOrgBrandRequest.js +1 -1
- package/dist/models/UpdateOrgBrandingRequest.d.ts +1 -1
- package/dist/models/UpdateOrgBrandingRequest.js +1 -1
- package/dist/models/UpdateOrgRequest.d.ts +1 -1
- package/dist/models/UpdateOrgRequest.js +1 -1
- package/dist/models/UpdateOrgWebhookRequest.d.ts +7 -1
- package/dist/models/UpdateOrgWebhookRequest.js +3 -1
- package/dist/models/UpdateShipmentRequest.d.ts +1 -1
- package/dist/models/UpdateShipmentRequest.js +1 -1
- package/dist/models/UpdateShippingRuleRequest.d.ts +7 -1
- package/dist/models/UpdateShippingRuleRequest.js +3 -1
- package/dist/models/VerifyApiToken200Response.d.ts +1 -1
- package/dist/models/VerifyApiToken200Response.js +1 -1
- package/dist/models/VerifyApiTokenRequest.d.ts +1 -1
- package/dist/models/VerifyApiTokenRequest.js +1 -1
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/dist/runtime.d.ts +1 -1
- package/dist/runtime.js +1 -1
- package/docs/AddressesApi.md +8 -1
- package/docs/CarriersApi.md +7 -1
- package/docs/ConnectCarrierRequest.md +2 -0
- package/docs/CreateAddressRequest.md +2 -0
- package/docs/CreateOrgWebhook201Response.md +2 -0
- package/docs/CreateOrgWebhookRequest.md +2 -0
- package/docs/CreateShippingRule201Response.md +2 -0
- package/docs/CreateShippingRuleRequest.md +2 -0
- package/docs/GetBillingUsage200Response.md +2 -0
- package/docs/GetBillingUsage200ResponseZippyMessages.md +37 -0
- package/docs/ListAddresses200ResponseDataInner.md +2 -0
- package/docs/ListCarriers200ResponseDataInner.md +2 -0
- package/docs/ListOrgWebhooks200ResponseDataInner.md +2 -0
- package/docs/ListShipments200ResponseDataInnerAddress.md +2 -0
- package/docs/ListShippingRules200ResponseDataInner.md +2 -0
- package/docs/ListShippingRules200ResponseDataInnerCarrier.md +2 -0
- package/docs/OrdersApi.md +4 -1
- package/docs/RulesApi.md +8 -1
- package/docs/ShipmentsApi.md +4 -1
- package/docs/UpdateAddressRequest.md +2 -0
- package/docs/UpdateCarrierRequest.md +2 -0
- package/docs/UpdateOrgWebhookRequest.md +2 -0
- package/docs/UpdateShippingRuleRequest.md +2 -0
- package/docs/WebhooksApi.md +8 -1
- package/package.json +1 -1
- package/src/apis/AddressesApi.ts +20 -1
- package/src/apis/BillingApi.ts +1 -1
- package/src/apis/BrandsApi.ts +1 -1
- package/src/apis/CarrierCatalogApi.ts +1 -1
- package/src/apis/CarriersApi.ts +21 -1
- package/src/apis/OrdersApi.ts +15 -1
- package/src/apis/OrgsApi.ts +1 -1
- package/src/apis/QuotesApi.ts +1 -1
- package/src/apis/RulesApi.ts +21 -1
- package/src/apis/ShipmentsApi.ts +15 -1
- package/src/apis/SystemApi.ts +1 -1
- package/src/apis/TokensApi.ts +1 -1
- package/src/apis/WebhooksApi.ts +21 -1
- package/src/models/BatchSendShipments200Response.ts +1 -1
- package/src/models/BatchSendShipments200ResponseResultsInner.ts +8 -2
- package/src/models/BatchSendShipments200ResponseSummary.ts +1 -1
- package/src/models/BatchSendShipmentsRequest.ts +1 -1
- package/src/models/BatchSplitShipment201Response.ts +1 -1
- package/src/models/BatchSplitShipmentRequest.ts +1 -1
- package/src/models/BatchSplitShipmentRequestShipmentsInner.ts +1 -1
- package/src/models/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.ts +1 -1
- package/src/models/CheckBrandSlug200Response.ts +1 -1
- package/src/models/ConnectCarrierRequest.ts +9 -1
- package/src/models/CreateAddressRequest.ts +9 -1
- package/src/models/CreateApiToken201Response.ts +1 -1
- package/src/models/CreateApiTokenRequest.ts +1 -1
- package/src/models/CreateOrder201Response.ts +1 -1
- package/src/models/CreateOrder201ResponseOrderLinesInner.ts +1 -1
- package/src/models/CreateOrder201ResponseShippingAddress.ts +1 -1
- package/src/models/CreateOrderRequest.ts +1 -1
- package/src/models/CreateOrderRequestOrderLinesInner.ts +1 -1
- package/src/models/CreateOrderRequestShippingAddress.ts +1 -1
- package/src/models/CreateOrgBrandRequest.ts +1 -1
- package/src/models/CreateOrgWebhook201Response.ts +10 -1
- package/src/models/CreateOrgWebhookRequest.ts +9 -1
- package/src/models/CreateShipment201Response.ts +1 -1
- package/src/models/CreateShipment201ResponseActivitiesInner.ts +1 -1
- package/src/models/CreateShipment201ResponseDocumentsInner.ts +1 -1
- package/src/models/CreateShipment201ResponseErrorsInner.ts +1 -1
- package/src/models/CreateShipment201ResponseLogsInner.ts +1 -1
- package/src/models/CreateShipment201ResponseParcelsInner.ts +1 -1
- package/src/models/CreateShipment201ResponseParcelsInnerDimensions.ts +1 -1
- package/src/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.ts +1 -1
- package/src/models/CreateShipment201ResponsePartiesInner.ts +1 -1
- package/src/models/CreateShipment201ResponsePartiesInnerAttributesInner.ts +1 -1
- package/src/models/CreateShipment201ResponsePickupDetails.ts +1 -1
- package/src/models/CreateShipment201ResponseShippingRule.ts +1 -1
- package/src/models/CreateShipment201ResponseTracking.ts +1 -1
- package/src/models/CreateShipmentRequest.ts +1 -1
- package/src/models/CreateShipmentRequestCarrierSettings.ts +1 -1
- package/src/models/CreateShipmentRequestParcelsInner.ts +1 -1
- package/src/models/CreateShipmentRequestParcelsInnerDimensions.ts +1 -1
- package/src/models/CreateShipmentRequestParcelsInnerOrderLinesInner.ts +1 -1
- package/src/models/CreateShipmentRequestPartiesInner.ts +1 -1
- package/src/models/CreateShipmentRequestPartiesInnerAttributesInner.ts +1 -1
- package/src/models/CreateShipmentRequestPickupDetails.ts +1 -1
- package/src/models/CreateShippingQuote200Response.ts +1 -1
- package/src/models/CreateShippingQuote200ResponseRatesInner.ts +1 -1
- package/src/models/CreateShippingQuote400Response.ts +1 -1
- package/src/models/CreateShippingQuote404Response.ts +1 -1
- package/src/models/CreateShippingQuoteRequest.ts +1 -1
- package/src/models/CreateShippingQuoteRequestDestination.ts +1 -1
- package/src/models/CreateShippingQuoteRequestItemsInner.ts +1 -1
- package/src/models/CreateShippingRule201Response.ts +10 -1
- package/src/models/CreateShippingRuleRequest.ts +9 -1
- package/src/models/CreateShippingRuleRequestAdditionalParametersValue.ts +1 -1
- package/src/models/CreateShippingRuleRequestAdditionalParametersValueAnyOf.ts +1 -1
- package/src/models/CreateShippingRuleRequestConditionsInner.ts +1 -1
- package/src/models/CreateShippingRuleRequestConditionsInnerOneOf.ts +1 -1
- package/src/models/CreateShippingRuleRequestConditionsInnerOneOf1.ts +1 -1
- package/src/models/CreateShippingRuleRequestConditionsInnerOneOf2.ts +1 -1
- package/src/models/CreateShippingRuleRequestConditionsInnerOneOf3.ts +1 -1
- package/src/models/CreateShippingRuleRequestConditionsInnerOneOf4.ts +1 -1
- package/src/models/DeleteOrgWebhook200Response.ts +1 -1
- package/src/models/DeleteShippingRule200Response.ts +1 -1
- package/src/models/GetBillingUsage200Response.ts +16 -1
- package/src/models/GetBillingUsage200ResponseAddOnsInner.ts +3 -2
- package/src/models/GetBillingUsage200ResponseCurrentPeriod.ts +1 -1
- package/src/models/GetBillingUsage200ResponseLimits.ts +1 -1
- package/src/models/GetBillingUsage200ResponseLimitsTeamMembers.ts +1 -1
- package/src/models/GetBillingUsage200ResponseShipments.ts +1 -1
- package/src/models/GetBillingUsage200ResponseZippyMessages.ts +75 -0
- package/src/models/GetOrder200Response.ts +1 -1
- package/src/models/GetOrder200ResponseShipmentsInner.ts +1 -1
- package/src/models/GetOrder200ResponseShippingRule.ts +1 -1
- package/src/models/GetOrg200Response.ts +1 -1
- package/src/models/GetOrg200ResponseCount.ts +1 -1
- package/src/models/GetOrgBranding200Response.ts +1 -1
- package/src/models/HealthCheck200Response.ts +1 -1
- package/src/models/ListAddresses200Response.ts +1 -1
- package/src/models/ListAddresses200ResponseDataInner.ts +10 -1
- package/src/models/ListApiTokens200Response.ts +1 -1
- package/src/models/ListApiTokens200ResponseDataInner.ts +1 -1
- package/src/models/ListApiTokens200ResponseDataInnerCreatedBy.ts +1 -1
- package/src/models/ListApiTokens401Response.ts +8 -2
- package/src/models/ListAvailableCarriers200ResponseInner.ts +1 -1
- package/src/models/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.ts +1 -1
- package/src/models/ListCarrierProductServicePoints200ResponseInner.ts +1 -1
- package/src/models/ListCarrierProductServicePoints200ResponseInnerAddress.ts +1 -1
- package/src/models/ListCarrierProductServicePointsRequest.ts +1 -1
- package/src/models/ListCarrierProducts200ResponseInner.ts +1 -1
- package/src/models/ListCarrierProducts200ResponseInnerAdditionalParametersInner.ts +1 -1
- package/src/models/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.ts +1 -1
- package/src/models/ListCarrierProducts200ResponseInnerServicesInner.ts +1 -1
- package/src/models/ListCarrierProducts200ResponseInnerWeightLimits.ts +1 -1
- package/src/models/ListCarriers200Response.ts +1 -1
- package/src/models/ListCarriers200ResponseDataInner.ts +10 -1
- package/src/models/ListCarriers200ResponseDataInnerConfigValue.ts +1 -1
- package/src/models/ListOrders200Response.ts +1 -1
- package/src/models/ListOrders200ResponseDataInner.ts +1 -1
- package/src/models/ListOrders200ResponseDataInnerOrderChannel.ts +1 -1
- package/src/models/ListOrgBrands200Response.ts +1 -1
- package/src/models/ListOrgBrands200ResponseDataInner.ts +1 -1
- package/src/models/ListOrgWebhookDeliveries200Response.ts +1 -1
- package/src/models/ListOrgWebhookDeliveries200ResponseDataInner.ts +1 -1
- package/src/models/ListOrgWebhooks200Response.ts +1 -1
- package/src/models/ListOrgWebhooks200ResponseDataInner.ts +10 -1
- package/src/models/ListShipments200Response.ts +1 -1
- package/src/models/ListShipments200ResponseDataInner.ts +1 -1
- package/src/models/ListShipments200ResponseDataInnerAddress.ts +10 -1
- package/src/models/ListShipments200ResponseDataInnerCarrierSettings.ts +1 -1
- package/src/models/ListShippingRules200Response.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInner.ts +10 -1
- package/src/models/ListShippingRules200ResponseDataInnerAdditionalParametersValue.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerCarrier.ts +10 -1
- package/src/models/ListShippingRules200ResponseDataInnerConditionsInner.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerLabelPrinter.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerReturnShippingRule.ts +1 -1
- package/src/models/RevokeApiToken200Response.ts +1 -1
- package/src/models/SendShipment422Response.ts +8 -2
- package/src/models/SendShipment422ResponseErrorsInner.ts +1 -1
- package/src/models/SplitShipment201Response.ts +1 -1
- package/src/models/SplitShipmentParcel200Response.ts +1 -1
- package/src/models/SplitShipmentParcelRequest.ts +1 -1
- package/src/models/SplitShipmentParcelRequestParcelsInner.ts +1 -1
- package/src/models/SplitShipmentRequest.ts +1 -1
- package/src/models/TestOrgWebhook200Response.ts +1 -1
- package/src/models/TrackShipment200Response.ts +1 -1
- package/src/models/TrackShipment200ResponseEventsInner.ts +1 -1
- package/src/models/UpdateAddressRequest.ts +9 -1
- package/src/models/UpdateApiTokenRequest.ts +1 -1
- package/src/models/UpdateCarrierRequest.ts +9 -1
- package/src/models/UpdateOrderRequest.ts +1 -1
- package/src/models/UpdateOrg200Response.ts +1 -1
- package/src/models/UpdateOrgBrandRequest.ts +1 -1
- package/src/models/UpdateOrgBrandingRequest.ts +1 -1
- package/src/models/UpdateOrgRequest.ts +1 -1
- package/src/models/UpdateOrgWebhookRequest.ts +9 -1
- package/src/models/UpdateShipmentRequest.ts +1 -1
- package/src/models/UpdateShippingRuleRequest.ts +9 -1
- package/src/models/VerifyApiToken200Response.ts +1 -1
- package/src/models/VerifyApiTokenRequest.ts +1 -1
- package/src/models/index.ts +1 -0
- package/src/runtime.ts +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Zippendo Public API
|
|
3
|
-
* 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`.
|
|
3
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0.0
|
|
6
6
|
* Contact: support@zippendo.com
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Zippendo Public API
|
|
6
|
-
* 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`.
|
|
6
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 1.0.0
|
|
9
9
|
* Contact: support@zippendo.com
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Zippendo Public API
|
|
3
|
-
* 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`.
|
|
3
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0.0
|
|
6
6
|
* Contact: support@zippendo.com
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Zippendo Public API
|
|
6
|
-
* 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`.
|
|
6
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 1.0.0
|
|
9
9
|
* Contact: support@zippendo.com
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Zippendo Public API
|
|
3
|
-
* 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`.
|
|
3
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0.0
|
|
6
6
|
* Contact: support@zippendo.com
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Zippendo Public API
|
|
6
|
-
* 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`.
|
|
6
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 1.0.0
|
|
9
9
|
* Contact: support@zippendo.com
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Zippendo Public API
|
|
3
|
-
* 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`.
|
|
3
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0.0
|
|
6
6
|
* Contact: support@zippendo.com
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { GetBillingUsage200ResponseZippyMessages } from './GetBillingUsage200ResponseZippyMessages';
|
|
12
13
|
import type { GetBillingUsage200ResponseAddOnsInner } from './GetBillingUsage200ResponseAddOnsInner';
|
|
13
14
|
import type { GetBillingUsage200ResponseShipments } from './GetBillingUsage200ResponseShipments';
|
|
14
15
|
import type { GetBillingUsage200ResponseCurrentPeriod } from './GetBillingUsage200ResponseCurrentPeriod';
|
|
@@ -43,6 +44,12 @@ export interface GetBillingUsage200Response {
|
|
|
43
44
|
* @memberof GetBillingUsage200Response
|
|
44
45
|
*/
|
|
45
46
|
addOns: Array<GetBillingUsage200ResponseAddOnsInner>;
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {GetBillingUsage200ResponseZippyMessages}
|
|
50
|
+
* @memberof GetBillingUsage200Response
|
|
51
|
+
*/
|
|
52
|
+
zippyMessages?: GetBillingUsage200ResponseZippyMessages;
|
|
46
53
|
}
|
|
47
54
|
/**
|
|
48
55
|
* Check if a given object implements the GetBillingUsage200Response interface.
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Zippendo Public API
|
|
6
|
-
* 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`.
|
|
6
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 1.0.0
|
|
9
9
|
* Contact: support@zippendo.com
|
|
@@ -18,6 +18,7 @@ exports.GetBillingUsage200ResponseFromJSON = GetBillingUsage200ResponseFromJSON;
|
|
|
18
18
|
exports.GetBillingUsage200ResponseFromJSONTyped = GetBillingUsage200ResponseFromJSONTyped;
|
|
19
19
|
exports.GetBillingUsage200ResponseToJSON = GetBillingUsage200ResponseToJSON;
|
|
20
20
|
exports.GetBillingUsage200ResponseToJSONTyped = GetBillingUsage200ResponseToJSONTyped;
|
|
21
|
+
const GetBillingUsage200ResponseZippyMessages_1 = require("./GetBillingUsage200ResponseZippyMessages");
|
|
21
22
|
const GetBillingUsage200ResponseAddOnsInner_1 = require("./GetBillingUsage200ResponseAddOnsInner");
|
|
22
23
|
const GetBillingUsage200ResponseShipments_1 = require("./GetBillingUsage200ResponseShipments");
|
|
23
24
|
const GetBillingUsage200ResponseCurrentPeriod_1 = require("./GetBillingUsage200ResponseCurrentPeriod");
|
|
@@ -48,6 +49,7 @@ function GetBillingUsage200ResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
48
49
|
'shipments': (0, GetBillingUsage200ResponseShipments_1.GetBillingUsage200ResponseShipmentsFromJSON)(json['shipments']),
|
|
49
50
|
'limits': (0, GetBillingUsage200ResponseLimits_1.GetBillingUsage200ResponseLimitsFromJSON)(json['limits']),
|
|
50
51
|
'addOns': (json['addOns'].map(GetBillingUsage200ResponseAddOnsInner_1.GetBillingUsage200ResponseAddOnsInnerFromJSON)),
|
|
52
|
+
'zippyMessages': json['zippyMessages'] == null ? undefined : (0, GetBillingUsage200ResponseZippyMessages_1.GetBillingUsage200ResponseZippyMessagesFromJSON)(json['zippyMessages']),
|
|
51
53
|
};
|
|
52
54
|
}
|
|
53
55
|
function GetBillingUsage200ResponseToJSON(json) {
|
|
@@ -62,5 +64,6 @@ function GetBillingUsage200ResponseToJSONTyped(value, ignoreDiscriminator = fals
|
|
|
62
64
|
'shipments': (0, GetBillingUsage200ResponseShipments_1.GetBillingUsage200ResponseShipmentsToJSON)(value['shipments']),
|
|
63
65
|
'limits': (0, GetBillingUsage200ResponseLimits_1.GetBillingUsage200ResponseLimitsToJSON)(value['limits']),
|
|
64
66
|
'addOns': (value['addOns'].map(GetBillingUsage200ResponseAddOnsInner_1.GetBillingUsage200ResponseAddOnsInnerToJSON)),
|
|
67
|
+
'zippyMessages': (0, GetBillingUsage200ResponseZippyMessages_1.GetBillingUsage200ResponseZippyMessagesToJSON)(value['zippyMessages']),
|
|
65
68
|
};
|
|
66
69
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Zippendo Public API
|
|
3
|
-
* 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`.
|
|
3
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0.0
|
|
6
6
|
* Contact: support@zippendo.com
|
|
@@ -46,6 +46,7 @@ export interface GetBillingUsage200ResponseAddOnsInner {
|
|
|
46
46
|
export declare const GetBillingUsage200ResponseAddOnsInnerTypeEnum: {
|
|
47
47
|
readonly ExtraCarrier: "extra_carrier";
|
|
48
48
|
readonly ExtraChannel: "extra_channel";
|
|
49
|
+
readonly Zippy: "zippy";
|
|
49
50
|
};
|
|
50
51
|
export type GetBillingUsage200ResponseAddOnsInnerTypeEnum = typeof GetBillingUsage200ResponseAddOnsInnerTypeEnum[keyof typeof GetBillingUsage200ResponseAddOnsInnerTypeEnum];
|
|
51
52
|
/**
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Zippendo Public API
|
|
6
|
-
* 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`.
|
|
6
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 1.0.0
|
|
9
9
|
* Contact: support@zippendo.com
|
|
@@ -24,7 +24,8 @@ exports.GetBillingUsage200ResponseAddOnsInnerToJSONTyped = GetBillingUsage200Res
|
|
|
24
24
|
*/
|
|
25
25
|
exports.GetBillingUsage200ResponseAddOnsInnerTypeEnum = {
|
|
26
26
|
ExtraCarrier: 'extra_carrier',
|
|
27
|
-
ExtraChannel: 'extra_channel'
|
|
27
|
+
ExtraChannel: 'extra_channel',
|
|
28
|
+
Zippy: 'zippy'
|
|
28
29
|
};
|
|
29
30
|
/**
|
|
30
31
|
* Check if a given object implements the GetBillingUsage200ResponseAddOnsInner interface.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Zippendo Public API
|
|
3
|
-
* 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`.
|
|
3
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0.0
|
|
6
6
|
* Contact: support@zippendo.com
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Zippendo Public API
|
|
6
|
-
* 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`.
|
|
6
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 1.0.0
|
|
9
9
|
* Contact: support@zippendo.com
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Zippendo Public API
|
|
3
|
-
* 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`.
|
|
3
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0.0
|
|
6
6
|
* Contact: support@zippendo.com
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Zippendo Public API
|
|
6
|
-
* 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`.
|
|
6
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 1.0.0
|
|
9
9
|
* Contact: support@zippendo.com
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Zippendo Public API
|
|
3
|
-
* 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`.
|
|
3
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0.0
|
|
6
6
|
* Contact: support@zippendo.com
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Zippendo Public API
|
|
6
|
-
* 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`.
|
|
6
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 1.0.0
|
|
9
9
|
* Contact: support@zippendo.com
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Zippendo Public API
|
|
3
|
-
* 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`.
|
|
3
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0.0
|
|
6
6
|
* Contact: support@zippendo.com
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Zippendo Public API
|
|
6
|
-
* 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`.
|
|
6
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 1.0.0
|
|
9
9
|
* Contact: support@zippendo.com
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Zippendo Public API
|
|
3
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: support@zippendo.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Zippy AI message usage this period (present when Zippy access is enabled)
|
|
14
|
+
* @export
|
|
15
|
+
* @interface GetBillingUsage200ResponseZippyMessages
|
|
16
|
+
*/
|
|
17
|
+
export interface GetBillingUsage200ResponseZippyMessages {
|
|
18
|
+
/**
|
|
19
|
+
* Zippy messages used this period
|
|
20
|
+
* @type {number}
|
|
21
|
+
* @memberof GetBillingUsage200ResponseZippyMessages
|
|
22
|
+
*/
|
|
23
|
+
used: number;
|
|
24
|
+
/**
|
|
25
|
+
* Zippy message charges so far, in øre
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof GetBillingUsage200ResponseZippyMessages
|
|
28
|
+
*/
|
|
29
|
+
charges: number;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the GetBillingUsage200ResponseZippyMessages interface.
|
|
33
|
+
*/
|
|
34
|
+
export declare function instanceOfGetBillingUsage200ResponseZippyMessages(value: object): value is GetBillingUsage200ResponseZippyMessages;
|
|
35
|
+
export declare function GetBillingUsage200ResponseZippyMessagesFromJSON(json: any): GetBillingUsage200ResponseZippyMessages;
|
|
36
|
+
export declare function GetBillingUsage200ResponseZippyMessagesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetBillingUsage200ResponseZippyMessages;
|
|
37
|
+
export declare function GetBillingUsage200ResponseZippyMessagesToJSON(json: any): GetBillingUsage200ResponseZippyMessages;
|
|
38
|
+
export declare function GetBillingUsage200ResponseZippyMessagesToJSONTyped(value?: GetBillingUsage200ResponseZippyMessages | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Zippendo Public API
|
|
6
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: support@zippendo.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfGetBillingUsage200ResponseZippyMessages = instanceOfGetBillingUsage200ResponseZippyMessages;
|
|
17
|
+
exports.GetBillingUsage200ResponseZippyMessagesFromJSON = GetBillingUsage200ResponseZippyMessagesFromJSON;
|
|
18
|
+
exports.GetBillingUsage200ResponseZippyMessagesFromJSONTyped = GetBillingUsage200ResponseZippyMessagesFromJSONTyped;
|
|
19
|
+
exports.GetBillingUsage200ResponseZippyMessagesToJSON = GetBillingUsage200ResponseZippyMessagesToJSON;
|
|
20
|
+
exports.GetBillingUsage200ResponseZippyMessagesToJSONTyped = GetBillingUsage200ResponseZippyMessagesToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the GetBillingUsage200ResponseZippyMessages interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfGetBillingUsage200ResponseZippyMessages(value) {
|
|
25
|
+
if (!('used' in value) || value['used'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('charges' in value) || value['charges'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
return true;
|
|
30
|
+
}
|
|
31
|
+
function GetBillingUsage200ResponseZippyMessagesFromJSON(json) {
|
|
32
|
+
return GetBillingUsage200ResponseZippyMessagesFromJSONTyped(json, false);
|
|
33
|
+
}
|
|
34
|
+
function GetBillingUsage200ResponseZippyMessagesFromJSONTyped(json, ignoreDiscriminator) {
|
|
35
|
+
if (json == null) {
|
|
36
|
+
return json;
|
|
37
|
+
}
|
|
38
|
+
return {
|
|
39
|
+
'used': json['used'],
|
|
40
|
+
'charges': json['charges'],
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
function GetBillingUsage200ResponseZippyMessagesToJSON(json) {
|
|
44
|
+
return GetBillingUsage200ResponseZippyMessagesToJSONTyped(json, false);
|
|
45
|
+
}
|
|
46
|
+
function GetBillingUsage200ResponseZippyMessagesToJSONTyped(value, ignoreDiscriminator = false) {
|
|
47
|
+
if (value == null) {
|
|
48
|
+
return value;
|
|
49
|
+
}
|
|
50
|
+
return {
|
|
51
|
+
'used': value['used'],
|
|
52
|
+
'charges': value['charges'],
|
|
53
|
+
};
|
|
54
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Zippendo Public API
|
|
3
|
-
* 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`.
|
|
3
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0.0
|
|
6
6
|
* Contact: support@zippendo.com
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Zippendo Public API
|
|
6
|
-
* 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`.
|
|
6
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 1.0.0
|
|
9
9
|
* Contact: support@zippendo.com
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Zippendo Public API
|
|
3
|
-
* 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`.
|
|
3
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0.0
|
|
6
6
|
* Contact: support@zippendo.com
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Zippendo Public API
|
|
6
|
-
* 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`.
|
|
6
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 1.0.0
|
|
9
9
|
* Contact: support@zippendo.com
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Zippendo Public API
|
|
3
|
-
* 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`.
|
|
3
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0.0
|
|
6
6
|
* Contact: support@zippendo.com
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Zippendo Public API
|
|
6
|
-
* 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`.
|
|
6
|
+
* 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. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. 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`.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 1.0.0
|
|
9
9
|
* Contact: support@zippendo.com
|