@zippendo/sdk 1.0.0

package/docs/BillingApi.md

@@ -0,0 +1,82 @@
+# BillingApi
+
+All URIs are relative to *https://api.zippendo.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getBillingUsage**](BillingApi.md#getbillingusage) | **GET** /orgs/{orgId}/billing/usage | Get usage |
+
+
+
+## getBillingUsage
+
+> GetBillingUsage200Response getBillingUsage(orgId)
+
+Get usage
+
+Get detailed usage statistics for the current billing period.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BillingApi,
+} from '@zippendo/sdk';
+import type { GetBillingUsageRequest } from '@zippendo/sdk';
+
+async function example() {
+  console.log("🚀 Testing @zippendo/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BillingApi(config);
+
+  const body = {
+    // string | Organization ID
+    orgId: org_8f3kd92ld0,
+  } satisfies GetBillingUsageRequest;
+
+  try {
+    const data = await api.getBillingUsage(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **orgId** | `string` | Organization ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetBillingUsage200Response**](GetBillingUsage200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Default Response |  -  |
+| **401** | Default Response |  -  |
+| **403** | Default Response |  -  |
+
+[[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/CarrierCatalogApi.md

@@ -0,0 +1,83 @@
+# CarrierCatalogApi
+
+All URIs are relative to *https://api.zippendo.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**listAvailableCarriers**](CarrierCatalogApi.md#listavailablecarriers) | **GET** /orgs/{orgId}/available-carriers | List available carriers |
+
+
+
+## listAvailableCarriers
+
+> Array<ListAvailableCarriers200ResponseInner> listAvailableCarriers(orgId)
+
+List available carriers
+
+Returns the carriers available to connect, as supported by the carrier server.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarrierCatalogApi,
+} from '@zippendo/sdk';
+import type { ListAvailableCarriersRequest } from '@zippendo/sdk';
+
+async function example() {
+  console.log("🚀 Testing @zippendo/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new CarrierCatalogApi(config);
+
+  const body = {
+    // string | Organization ID
+    orgId: org_01HZX9K2QF,
+  } satisfies ListAvailableCarriersRequest;
+
+  try {
+    const data = await api.listAvailableCarriers(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **orgId** | `string` | Organization ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<ListAvailableCarriers200ResponseInner>**](ListAvailableCarriers200ResponseInner.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Default Response |  -  |
+| **403** | Default Response |  -  |
+| **404** | Default Response |  -  |
+| **500** | Default Response |  -  |
+
+[[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/CarriersApi.md

@@ -0,0 +1,560 @@
+# CarriersApi
+
+All URIs are relative to *https://api.zippendo.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**connectCarrier**](CarriersApi.md#connectcarrieroperation) | **POST** /orgs/{orgId}/carriers | Connect carrier |
+| [**disconnectCarrier**](CarriersApi.md#disconnectcarrier) | **DELETE** /orgs/{orgId}/carriers/{carrierId} | Disconnect carrier |
+| [**getCarrier**](CarriersApi.md#getcarrier) | **GET** /orgs/{orgId}/carriers/{carrierId} | Get carrier |
+| [**listCarrierProductServicePoints**](CarriersApi.md#listcarrierproductservicepointsoperation) | **POST** /orgs/{orgId}/carriers/{carrierId}/products/{productId}/service-points | List product service points |
+| [**listCarrierProducts**](CarriersApi.md#listcarrierproducts) | **GET** /orgs/{orgId}/carriers/{carrierId}/products | List carrier products |
+| [**listCarriers**](CarriersApi.md#listcarriers) | **GET** /orgs/{orgId}/carriers | List carriers |
+| [**updateCarrier**](CarriersApi.md#updatecarrieroperation) | **PUT** /orgs/{orgId}/carriers/{carrierId} | Update carrier |
+
+
+
+## connectCarrier
+
+> ListCarriers200ResponseDataInner connectCarrier(orgId, connectCarrierRequest)
+
+Connect carrier
+
+Connects a new carrier to the organization with its configuration.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarriersApi,
+} from '@zippendo/sdk';
+import type { ConnectCarrierOperationRequest } from '@zippendo/sdk';
+
+async function example() {
+  console.log("🚀 Testing @zippendo/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new CarriersApi(config);
+
+  const body = {
+    // string | Organization ID
+    orgId: org_01HZX9K2QF,
+    // ConnectCarrierRequest
+    connectCarrierRequest: ...,
+  } satisfies ConnectCarrierOperationRequest;
+
+  try {
+    const data = await api.connectCarrier(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **orgId** | `string` | Organization ID | [Defaults to `undefined`] |
+| **connectCarrierRequest** | [ConnectCarrierRequest](ConnectCarrierRequest.md) |  | |
+
+### Return type
+
+[**ListCarriers200ResponseDataInner**](ListCarriers200ResponseDataInner.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Default Response |  -  |
+| **400** | Default Response |  -  |
+| **403** | Default Response |  -  |
+| **404** | Default Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## disconnectCarrier
+
+> string disconnectCarrier(orgId, carrierId)
+
+Disconnect carrier
+
+Disconnects a carrier from the organization.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarriersApi,
+} from '@zippendo/sdk';
+import type { DisconnectCarrierRequest } from '@zippendo/sdk';
+
+async function example() {
+  console.log("🚀 Testing @zippendo/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new CarriersApi(config);
+
+  const body = {
+    // string | Organization ID
+    orgId: org_01HZX9K2QF,
+    // string | Carrier ID
+    carrierId: carr_01HZX9K2QF,
+  } satisfies DisconnectCarrierRequest;
+
+  try {
+    const data = await api.disconnectCarrier(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **orgId** | `string` | Organization ID | [Defaults to `undefined`] |
+| **carrierId** | `string` | Carrier ID | [Defaults to `undefined`] |
+
+### Return type
+
+**string**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Default Response |  -  |
+| **403** | Default Response |  -  |
+| **404** | Default Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getCarrier
+
+> ListCarriers200ResponseDataInner getCarrier(orgId, carrierId)
+
+Get carrier
+
+Returns a single connected carrier.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarriersApi,
+} from '@zippendo/sdk';
+import type { GetCarrierRequest } from '@zippendo/sdk';
+
+async function example() {
+  console.log("🚀 Testing @zippendo/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new CarriersApi(config);
+
+  const body = {
+    // string | Organization ID
+    orgId: org_01HZX9K2QF,
+    // string | Carrier ID
+    carrierId: carr_01HZX9K2QF,
+  } satisfies GetCarrierRequest;
+
+  try {
+    const data = await api.getCarrier(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **orgId** | `string` | Organization ID | [Defaults to `undefined`] |
+| **carrierId** | `string` | Carrier ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**ListCarriers200ResponseDataInner**](ListCarriers200ResponseDataInner.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Default Response |  -  |
+| **403** | Default Response |  -  |
+| **404** | Default Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listCarrierProductServicePoints
+
+> Array<ListCarrierProductServicePoints200ResponseInner> listCarrierProductServicePoints(orgId, carrierId, productId, listCarrierProductServicePointsRequest)
+
+List product service points
+
+Returns pickup service points near a location for a specific carrier product.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarriersApi,
+} from '@zippendo/sdk';
+import type { ListCarrierProductServicePointsOperationRequest } from '@zippendo/sdk';
+
+async function example() {
+  console.log("🚀 Testing @zippendo/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new CarriersApi(config);
+
+  const body = {
+    // string | Organization ID
+    orgId: org_01HZX9K2QF,
+    // string | Carrier ID
+    carrierId: carr_01HZX9K2QF,
+    // string | Carrier product ID
+    productId: PNL13,
+    // ListCarrierProductServicePointsRequest
+    listCarrierProductServicePointsRequest: ...,
+  } satisfies ListCarrierProductServicePointsOperationRequest;
+
+  try {
+    const data = await api.listCarrierProductServicePoints(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **orgId** | `string` | Organization ID | [Defaults to `undefined`] |
+| **carrierId** | `string` | Carrier ID | [Defaults to `undefined`] |
+| **productId** | `string` | Carrier product ID | [Defaults to `undefined`] |
+| **listCarrierProductServicePointsRequest** | [ListCarrierProductServicePointsRequest](ListCarrierProductServicePointsRequest.md) |  | |
+
+### Return type
+
+[**Array<ListCarrierProductServicePoints200ResponseInner>**](ListCarrierProductServicePoints200ResponseInner.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Default Response |  -  |
+| **403** | Default Response |  -  |
+| **404** | Default Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listCarrierProducts
+
+> Array<ListCarrierProducts200ResponseInner> listCarrierProducts(orgId, carrierId)
+
+List carrier products
+
+Returns the shipping products available for a connected carrier.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarriersApi,
+} from '@zippendo/sdk';
+import type { ListCarrierProductsRequest } from '@zippendo/sdk';
+
+async function example() {
+  console.log("🚀 Testing @zippendo/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new CarriersApi(config);
+
+  const body = {
+    // string | Organization ID
+    orgId: org_01HZX9K2QF,
+    // string | Carrier ID
+    carrierId: carr_01HZX9K2QF,
+  } satisfies ListCarrierProductsRequest;
+
+  try {
+    const data = await api.listCarrierProducts(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **orgId** | `string` | Organization ID | [Defaults to `undefined`] |
+| **carrierId** | `string` | Carrier ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<ListCarrierProducts200ResponseInner>**](ListCarrierProducts200ResponseInner.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Default Response |  -  |
+| **403** | Default Response |  -  |
+| **404** | Default Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listCarriers
+
+> ListCarriers200Response listCarriers(orgId, page, limit)
+
+List carriers
+
+Returns a paginated list of carriers connected to the organization.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarriersApi,
+} from '@zippendo/sdk';
+import type { ListCarriersRequest } from '@zippendo/sdk';
+
+async function example() {
+  console.log("🚀 Testing @zippendo/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new CarriersApi(config);
+
+  const body = {
+    // string | Organization ID
+    orgId: org_01HZX9K2QF,
+    // number | Page number (1-based) (optional)
+    page: 1,
+    // number | Items per page (max 100) (optional)
+    limit: 20,
+  } satisfies ListCarriersRequest;
+
+  try {
+    const data = await api.listCarriers(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **orgId** | `string` | Organization ID | [Defaults to `undefined`] |
+| **page** | `number` | Page number (1-based) | [Optional] [Defaults to `1`] |
+| **limit** | `number` | Items per page (max 100) | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**ListCarriers200Response**](ListCarriers200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Default Response |  -  |
+| **403** | Default Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateCarrier
+
+> ListCarriers200ResponseDataInner updateCarrier(orgId, carrierId, updateCarrierRequest)
+
+Update carrier
+
+Updates a connected carrier\'s configuration or name.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarriersApi,
+} from '@zippendo/sdk';
+import type { UpdateCarrierOperationRequest } from '@zippendo/sdk';
+
+async function example() {
+  console.log("🚀 Testing @zippendo/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new CarriersApi(config);
+
+  const body = {
+    // string | Organization ID
+    orgId: org_01HZX9K2QF,
+    // string | Carrier ID
+    carrierId: carr_01HZX9K2QF,
+    // UpdateCarrierRequest
+    updateCarrierRequest: ...,
+  } satisfies UpdateCarrierOperationRequest;
+
+  try {
+    const data = await api.updateCarrier(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **orgId** | `string` | Organization ID | [Defaults to `undefined`] |
+| **carrierId** | `string` | Carrier ID | [Defaults to `undefined`] |
+| **updateCarrierRequest** | [UpdateCarrierRequest](UpdateCarrierRequest.md) |  | |
+
+### Return type
+
+[**ListCarriers200ResponseDataInner**](ListCarriers200ResponseDataInner.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Default Response |  -  |
+| **400** | Default Response |  -  |
+| **403** | Default Response |  -  |
+| **404** | Default Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+