@streetlevel/api-clients 1.0.1

package/src/generated/campaign/docs/CampaignsApi.md

@@ -0,0 +1,695 @@
+# CampaignsApi
+
+All URIs are relative to */api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**activateCampaign**](CampaignsApi.md#activatecampaign) | **POST** /campaigns/{campaign_id}/activate | Activate a campaign |
+| [**cancelCampaign**](CampaignsApi.md#cancelcampaign) | **POST** /campaigns/{campaign_id}/cancel | Cancel a campaign |
+| [**completeCampaign**](CampaignsApi.md#completecampaign) | **POST** /campaigns/{campaign_id}/complete | Complete a campaign |
+| [**createCampaign**](CampaignsApi.md#createcampaignoperation) | **POST** /campaigns | Create a new campaign |
+| [**deleteCampaign**](CampaignsApi.md#deletecampaign) | **DELETE** /campaigns/{campaign_id} | Delete a campaign |
+| [**getCampaign**](CampaignsApi.md#getcampaign) | **GET** /campaigns/{campaign_id} | Get campaign by ID |
+| [**listCampaigns**](CampaignsApi.md#listcampaigns) | **GET** /campaigns | List campaigns |
+| [**pauseCampaign**](CampaignsApi.md#pausecampaign) | **POST** /campaigns/{campaign_id}/pause | Pause a campaign |
+| [**submitCampaign**](CampaignsApi.md#submitcampaign) | **POST** /campaigns/{campaign_id}/submit | Submit a campaign for approval |
+| [**updateCampaign**](CampaignsApi.md#updatecampaignoperation) | **PUT** /campaigns/{campaign_id} | Update a campaign |
+
+
+
+## activateCampaign
+
+> CampaignResponse activateCampaign(campaignId)
+
+Activate a campaign
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CampaignsApi,
+} from '';
+import type { ActivateCampaignRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CampaignsApi();
+
+  const body = {
+    // string
+    campaignId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ActivateCampaignRequest;
+
+  try {
+    const data = await api.activateCampaign(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **campaignId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CampaignResponse**](CampaignResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Campaign activated |  -  |
+| **404** | Campaign not found |  -  |
+| **409** | Invalid campaign state |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## cancelCampaign
+
+> CampaignResponse cancelCampaign(campaignId)
+
+Cancel a campaign
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CampaignsApi,
+} from '';
+import type { CancelCampaignRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CampaignsApi();
+
+  const body = {
+    // string
+    campaignId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies CancelCampaignRequest;
+
+  try {
+    const data = await api.cancelCampaign(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **campaignId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CampaignResponse**](CampaignResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Campaign cancelled |  -  |
+| **404** | Campaign not found |  -  |
+| **409** | Invalid campaign state |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## completeCampaign
+
+> CampaignResponse completeCampaign(campaignId)
+
+Complete a campaign
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CampaignsApi,
+} from '';
+import type { CompleteCampaignRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CampaignsApi();
+
+  const body = {
+    // string
+    campaignId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies CompleteCampaignRequest;
+
+  try {
+    const data = await api.completeCampaign(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **campaignId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CampaignResponse**](CampaignResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Campaign completed |  -  |
+| **404** | Campaign not found |  -  |
+| **409** | Invalid campaign state |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## createCampaign
+
+> CampaignResponse createCampaign(createCampaignRequest)
+
+Create a new campaign
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CampaignsApi,
+} from '';
+import type { CreateCampaignOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CampaignsApi();
+
+  const body = {
+    // CreateCampaignRequest
+    createCampaignRequest: ...,
+  } satisfies CreateCampaignOperationRequest;
+
+  try {
+    const data = await api.createCampaign(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createCampaignRequest** | [CreateCampaignRequest](CreateCampaignRequest.md) |  | |
+
+### Return type
+
+[**CampaignResponse**](CampaignResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Campaign created |  -  |
+| **400** | Validation error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteCampaign
+
+> deleteCampaign(campaignId)
+
+Delete a campaign
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CampaignsApi,
+} from '';
+import type { DeleteCampaignRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CampaignsApi();
+
+  const body = {
+    // string
+    campaignId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteCampaignRequest;
+
+  try {
+    const data = await api.deleteCampaign(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **campaignId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Campaign deleted |  -  |
+| **404** | Campaign not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getCampaign
+
+> CampaignResponse getCampaign(campaignId)
+
+Get campaign by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CampaignsApi,
+} from '';
+import type { GetCampaignRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CampaignsApi();
+
+  const body = {
+    // string
+    campaignId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetCampaignRequest;
+
+  try {
+    const data = await api.getCampaign(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **campaignId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CampaignResponse**](CampaignResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Campaign found |  -  |
+| **404** | Campaign not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listCampaigns
+
+> ListCampaignsResponse listCampaigns(clientId, status, offset, limit)
+
+List campaigns
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CampaignsApi,
+} from '';
+import type { ListCampaignsRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CampaignsApi();
+
+  const body = {
+    // string | Filter by client ID (optional)
+    clientId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // CampaignStatus (optional)
+    status: ...,
+    // number (optional)
+    offset: 56,
+    // number (optional)
+    limit: 56,
+  } satisfies ListCampaignsRequest;
+
+  try {
+    const data = await api.listCampaigns(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientId** | `string` | Filter by client ID | [Optional] [Defaults to `undefined`] |
+| **status** | `CampaignStatus` |  | [Optional] [Defaults to `undefined`] [Enum: DRAFT, PENDING_APPROVAL, ACTIVE, PAUSED, COMPLETED, CANCELLED] |
+| **offset** | `number` |  | [Optional] [Defaults to `0`] |
+| **limit** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**ListCampaignsResponse**](ListCampaignsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of campaigns |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## pauseCampaign
+
+> CampaignResponse pauseCampaign(campaignId)
+
+Pause a campaign
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CampaignsApi,
+} from '';
+import type { PauseCampaignRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CampaignsApi();
+
+  const body = {
+    // string
+    campaignId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies PauseCampaignRequest;
+
+  try {
+    const data = await api.pauseCampaign(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **campaignId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CampaignResponse**](CampaignResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Campaign paused |  -  |
+| **404** | Campaign not found |  -  |
+| **409** | Invalid campaign state |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## submitCampaign
+
+> CampaignResponse submitCampaign(campaignId)
+
+Submit a campaign for approval
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CampaignsApi,
+} from '';
+import type { SubmitCampaignRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CampaignsApi();
+
+  const body = {
+    // string
+    campaignId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies SubmitCampaignRequest;
+
+  try {
+    const data = await api.submitCampaign(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **campaignId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CampaignResponse**](CampaignResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Campaign submitted for approval |  -  |
+| **404** | Campaign not found |  -  |
+| **409** | Invalid campaign state |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateCampaign
+
+> CampaignResponse updateCampaign(campaignId, updateCampaignRequest)
+
+Update a campaign
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CampaignsApi,
+} from '';
+import type { UpdateCampaignOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new CampaignsApi();
+
+  const body = {
+    // string
+    campaignId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateCampaignRequest
+    updateCampaignRequest: ...,
+  } satisfies UpdateCampaignOperationRequest;
+
+  try {
+    const data = await api.updateCampaign(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **campaignId** | `string` |  | [Defaults to `undefined`] |
+| **updateCampaignRequest** | [UpdateCampaignRequest](UpdateCampaignRequest.md) |  | |
+
+### Return type
+
+[**CampaignResponse**](CampaignResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Campaign updated |  -  |
+| **400** | Validation error |  -  |
+| **404** | Campaign not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/src/generated/campaign/docs/CreateCampaign400Response.md

@@ -0,0 +1,41 @@
+
+# CreateCampaign400Response
+
+Validation error response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`errorCode` | string
+`message` | string
+`timestamp` | Date
+`violations` | [Array<CreateCampaign400ResponseViolationsInner>](CreateCampaign400ResponseViolationsInner.md)
+
+## Example
+
+```typescript
+import type { CreateCampaign400Response } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "errorCode": VALIDATION_ERROR,
+  "message": null,
+  "timestamp": null,
+  "violations": null,
+} satisfies CreateCampaign400Response
+
+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 CreateCampaign400Response
+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)
+
+