@zippendo/sdk 1.0.0

package/docs/ListAddresses200ResponseDataInner.md

@@ -0,0 +1,64 @@
+
+# ListAddresses200ResponseDataInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`attContact` | string
+`address1` | string
+`address2` | string
+`zipcode` | string
+`city` | string
+`phone` | string
+`countryCode` | string
+`state` | string
+`email` | string
+`customs` | { [key: string]: string; }
+`addressTypes` | Array<string>
+`orgId` | string
+`createdAt` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { ListAddresses200ResponseDataInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": addr_01HZX9K2QF,
+  "name": Hovedlager,
+  "attContact": Mette Hansen,
+  "address1": Vesterbrogade 1,
+  "address2": 2. sal,
+  "zipcode": 1620,
+  "city": København,
+  "phone": +4533123456,
+  "countryCode": DK,
+  "state": null,
+  "email": lager@example.dk,
+  "customs": {"eori":"DK12345678"},
+  "addressTypes": ["sender"],
+  "orgId": org_01HZX9K2QF,
+  "createdAt": 2026-06-22T09:00:00.000Z,
+  "updatedAt": 2026-06-22T09:00:00.000Z,
+} satisfies ListAddresses200ResponseDataInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListAddresses200ResponseDataInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListApiTokens200Response.md

@@ -0,0 +1,42 @@
+
+# ListApiTokens200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<ListApiTokens200ResponseDataInner>](ListApiTokens200ResponseDataInner.md)
+`total` | number
+`page` | number
+`limit` | number
+`totalPages` | number
+
+## Example
+
+```typescript
+import type { ListApiTokens200Response } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "total": 137,
+  "page": 1,
+  "limit": 20,
+  "totalPages": 7,
+} satisfies ListApiTokens200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListApiTokens200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListApiTokens200ResponseDataInner.md

@@ -0,0 +1,48 @@
+
+# ListApiTokens200ResponseDataInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`tokenPrefix` | string
+`scopes` | Array<string>
+`lastUsedAt` | string
+`expiresAt` | string
+`createdAt` | string
+`createdBy` | [ListApiTokens200ResponseDataInnerCreatedBy](ListApiTokens200ResponseDataInnerCreatedBy.md)
+
+## Example
+
+```typescript
+import type { ListApiTokens200ResponseDataInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": tok_6e2fa83ij9,
+  "name": Warehouse integration,
+  "tokenPrefix": zipp_live_8f,
+  "scopes": ["read:shipments","write:shipments"],
+  "lastUsedAt": 2026-06-22T14:30:00.000Z,
+  "expiresAt": 2026-09-20T14:30:00.000Z,
+  "createdAt": 2026-06-22T14:30:00.000Z,
+  "createdBy": null,
+} satisfies ListApiTokens200ResponseDataInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListApiTokens200ResponseDataInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListApiTokens200ResponseDataInnerCreatedBy.md

@@ -0,0 +1,38 @@
+
+# ListApiTokens200ResponseDataInnerCreatedBy
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`email` | string
+
+## Example
+
+```typescript
+import type { ListApiTokens200ResponseDataInnerCreatedBy } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": usr_9f3kd92ld0,
+  "name": Anna Jensen,
+  "email": anna@example.dk,
+} satisfies ListApiTokens200ResponseDataInnerCreatedBy
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListApiTokens200ResponseDataInnerCreatedBy
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListApiTokens401Response.md

@@ -0,0 +1,38 @@
+
+# ListApiTokens401Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`error` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { ListApiTokens401Response } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": CARRIER_GLS_WRONG_ADDRESS,
+  "error": Bad Request,
+  "message": Failed to create address,
+} satisfies ListApiTokens401Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListApiTokens401Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListAvailableCarriers200ResponseInner.md

@@ -0,0 +1,54 @@
+
+# ListAvailableCarriers200ResponseInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`slug` | string
+`group` | string
+`description` | string
+`logo` | string
+`brandColor` | string
+`learnMoreUrl` | string
+`requiredFields` | [Array<ListAvailableCarriers200ResponseInnerRequiredFieldsInner>](ListAvailableCarriers200ResponseInnerRequiredFieldsInner.md)
+`optionalFields` | [Array<ListAvailableCarriers200ResponseInnerRequiredFieldsInner>](ListAvailableCarriers200ResponseInnerRequiredFieldsInner.md)
+`deprecated` | boolean
+`deprecationMessage` | string
+
+## Example
+
+```typescript
+import type { ListAvailableCarriers200ResponseInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": PostNord,
+  "slug": postnord,
+  "group": Nordic,
+  "description": Nordic postal and parcel carrier,
+  "logo": https://cdn.zippendo.com/carriers/postnord.svg,
+  "brandColor": #0072CE,
+  "learnMoreUrl": https://www.postnord.dk,
+  "requiredFields": null,
+  "optionalFields": null,
+  "deprecated": true,
+  "deprecationMessage": The standalone Instabox API is deprecated. Migrate to the Instabee-powered Instabox integration.,
+} satisfies ListAvailableCarriers200ResponseInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListAvailableCarriers200ResponseInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.md

@@ -0,0 +1,44 @@
+
+# ListAvailableCarriers200ResponseInnerRequiredFieldsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`key` | string
+`type` | string
+`options` | [Array<ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner>](ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.md)
+`description` | string
+`required` | boolean
+
+## Example
+
+```typescript
+import type { ListAvailableCarriers200ResponseInnerRequiredFieldsInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": Customer number,
+  "key": customerNumber,
+  "type": string,
+  "options": null,
+  "description": Your PostNord customer number,
+  "required": true,
+} satisfies ListAvailableCarriers200ResponseInnerRequiredFieldsInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListAvailableCarriers200ResponseInnerRequiredFieldsInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListCarrierProductServicePoints200ResponseInner.md

@@ -0,0 +1,48 @@
+
+# ListCarrierProductServicePoints200ResponseInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`lat` | number
+`lng` | number
+`name` | string
+`servicePointId` | string
+`openingHours` | Array<string>
+`description` | string
+`distance` | number
+`address` | [ListCarrierProductServicePoints200ResponseInnerAddress](ListCarrierProductServicePoints200ResponseInnerAddress.md)
+
+## Example
+
+```typescript
+import type { ListCarrierProductServicePoints200ResponseInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "lat": 55.6761,
+  "lng": 12.5683,
+  "name": PostNord Pakkeshop Netto,
+  "servicePointId": 1234567,
+  "openingHours": null,
+  "description": Located inside Netto supermarket,
+  "distance": 320,
+  "address": null,
+} satisfies ListCarrierProductServicePoints200ResponseInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListCarrierProductServicePoints200ResponseInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListCarrierProductServicePoints200ResponseInnerAddress.md

@@ -0,0 +1,45 @@
+
+# ListCarrierProductServicePoints200ResponseInnerAddress
+
+Postal address of the service point
+
+## Properties
+
+Name | Type
+------------ | -------------
+`address1` | string
+`address2` | string
+`postalCode` | string
+`state` | string
+`city` | string
+`countryCode` | string
+
+## Example
+
+```typescript
+import type { ListCarrierProductServicePoints200ResponseInnerAddress } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "address1": Vesterbrogade 1,
+  "address2": 2. sal,
+  "postalCode": 1620,
+  "state": null,
+  "city": København,
+  "countryCode": DK,
+} satisfies ListCarrierProductServicePoints200ResponseInnerAddress
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListCarrierProductServicePoints200ResponseInnerAddress
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListCarrierProductServicePointsRequest.md

@@ -0,0 +1,44 @@
+
+# ListCarrierProductServicePointsRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`address1` | string
+`address2` | string
+`postalCode` | string
+`state` | string
+`city` | string
+`countryCode` | string
+
+## Example
+
+```typescript
+import type { ListCarrierProductServicePointsRequest } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "address1": Vesterbrogade 1,
+  "address2": 2. sal,
+  "postalCode": 1620,
+  "state": null,
+  "city": København,
+  "countryCode": DK,
+} satisfies ListCarrierProductServicePointsRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListCarrierProductServicePointsRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListCarrierProducts200ResponseInner.md

@@ -0,0 +1,54 @@
+
+# ListCarrierProducts200ResponseInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`productId` | string
+`type` | string
+`description` | string
+`availableCountries` | Array<string>
+`availableSenderCountries` | Array<string>
+`isServicePoint` | boolean
+`isPickupAvailable` | boolean
+`services` | [Array<ListCarrierProducts200ResponseInnerServicesInner>](ListCarrierProducts200ResponseInnerServicesInner.md)
+`additionalParameters` | [Array<ListCarrierProducts200ResponseInnerAdditionalParametersInner>](ListCarrierProducts200ResponseInnerAdditionalParametersInner.md)
+`weightLimits` | [ListCarrierProducts200ResponseInnerWeightLimits](ListCarrierProducts200ResponseInnerWeightLimits.md)
+
+## Example
+
+```typescript
+import type { ListCarrierProducts200ResponseInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": PostNord MyPack Home,
+  "productId": PNL13,
+  "type": outbound,
+  "description": Home delivery within Denmark,
+  "availableCountries": null,
+  "availableSenderCountries": null,
+  "isServicePoint": false,
+  "isPickupAvailable": true,
+  "services": null,
+  "additionalParameters": null,
+  "weightLimits": null,
+} satisfies ListCarrierProducts200ResponseInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListCarrierProducts200ResponseInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListCarrierProducts200ResponseInnerAdditionalParametersInner.md

@@ -0,0 +1,46 @@
+
+# ListCarrierProducts200ResponseInnerAdditionalParametersInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`key` | string
+`type` | string
+`options` | [Array<ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner>](ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.md)
+`description` | string
+`isRequired` | boolean
+`requiredService` | Array<string>
+
+## Example
+
+```typescript
+import type { ListCarrierProducts200ResponseInnerAdditionalParametersInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": Return Mode,
+  "key": returnFunctionality,
+  "type": enum,
+  "options": null,
+  "description": Instruction shown to the delivery driver,
+  "isRequired": false,
+  "requiredService": null,
+} satisfies ListCarrierProducts200ResponseInnerAdditionalParametersInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListCarrierProducts200ResponseInnerAdditionalParametersInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.md

@@ -0,0 +1,38 @@
+
+# ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`key` | string
+`value` | string
+
+## Example
+
+```typescript
+import type { ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": Standard,
+  "key": standard,
+  "value": STD,
+} satisfies ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListCarrierProducts200ResponseInnerServicesInner.md

@@ -0,0 +1,36 @@
+
+# ListCarrierProducts200ResponseInnerServicesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`serviceId` | string
+
+## Example
+
+```typescript
+import type { ListCarrierProducts200ResponseInnerServicesInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": Flex delivery,
+  "serviceId": A6,
+} satisfies ListCarrierProducts200ResponseInnerServicesInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListCarrierProducts200ResponseInnerServicesInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListCarrierProducts200ResponseInnerWeightLimits.md

@@ -0,0 +1,39 @@
+
+# ListCarrierProducts200ResponseInnerWeightLimits
+
+Allowed weight range for parcels using this product
+
+## Properties
+
+Name | Type
+------------ | -------------
+`min` | number
+`max` | number
+`unit` | string
+
+## Example
+
+```typescript
+import type { ListCarrierProducts200ResponseInnerWeightLimits } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "min": 0.1,
+  "max": 35,
+  "unit": kg,
+} satisfies ListCarrierProducts200ResponseInnerWeightLimits
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListCarrierProducts200ResponseInnerWeightLimits
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+