@streetlevel/api-clients 1.0.1

package/src/generated/adset/docs/AdSetsApi.md

@@ -0,0 +1,492 @@
+# AdSetsApi
+
+All URIs are relative to */api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**addAdToSet**](AdSetsApi.md#addadtoset) | **POST** /adsets/{adset_id}/ads/{ad_id} | Add an ad to the set |
+| [**createAdSet**](AdSetsApi.md#createadsetoperation) | **POST** /adsets | Create a new ad set |
+| [**deleteAdSet**](AdSetsApi.md#deleteadset) | **DELETE** /adsets/{adset_id} | Delete an ad set |
+| [**getAdSet**](AdSetsApi.md#getadset) | **GET** /adsets/{adset_id} | Get ad set by ID |
+| [**listAdSets**](AdSetsApi.md#listadsets) | **GET** /adsets | List ad sets |
+| [**removeAdFromSet**](AdSetsApi.md#removeadfromset) | **DELETE** /adsets/{adset_id}/ads/{ad_id} | Remove an ad from the set |
+| [**updateAdSet**](AdSetsApi.md#updateadsetoperation) | **PUT** /adsets/{adset_id} | Update an ad set |
+
+
+
+## addAdToSet
+
+> AdSetResponse addAdToSet(adsetId, adId)
+
+Add an ad to the set
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdSetsApi,
+} from '';
+import type { AddAdToSetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdSetsApi();
+
+  const body = {
+    // string
+    adsetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    adId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies AddAdToSetRequest;
+
+  try {
+    const data = await api.addAdToSet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **adsetId** | `string` |  | [Defaults to `undefined`] |
+| **adId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**AdSetResponse**](AdSetResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Ad added to set |  -  |
+| **404** | Ad set or ad 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)
+
+
+## createAdSet
+
+> AdSetResponse createAdSet(createAdSetRequest)
+
+Create a new ad set
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdSetsApi,
+} from '';
+import type { CreateAdSetOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdSetsApi();
+
+  const body = {
+    // CreateAdSetRequest
+    createAdSetRequest: ...,
+  } satisfies CreateAdSetOperationRequest;
+
+  try {
+    const data = await api.createAdSet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createAdSetRequest** | [CreateAdSetRequest](CreateAdSetRequest.md) |  | |
+
+### Return type
+
+[**AdSetResponse**](AdSetResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Ad set 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)
+
+
+## deleteAdSet
+
+> deleteAdSet(adsetId)
+
+Delete an ad set
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdSetsApi,
+} from '';
+import type { DeleteAdSetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdSetsApi();
+
+  const body = {
+    // string
+    adsetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteAdSetRequest;
+
+  try {
+    const data = await api.deleteAdSet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **adsetId** | `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** | Ad set deleted |  -  |
+| **404** | Ad set 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)
+
+
+## getAdSet
+
+> AdSetResponse getAdSet(adsetId)
+
+Get ad set by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdSetsApi,
+} from '';
+import type { GetAdSetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdSetsApi();
+
+  const body = {
+    // string
+    adsetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetAdSetRequest;
+
+  try {
+    const data = await api.getAdSet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **adsetId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**AdSetResponse**](AdSetResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Ad set found |  -  |
+| **404** | Ad set 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)
+
+
+## listAdSets
+
+> ListAdSetsResponse listAdSets(campaignId, offset, limit)
+
+List ad sets
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdSetsApi,
+} from '';
+import type { ListAdSetsRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdSetsApi();
+
+  const body = {
+    // string | Filter by campaign ID (optional)
+    campaignId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // number (optional)
+    offset: 56,
+    // number (optional)
+    limit: 56,
+  } satisfies ListAdSetsRequest;
+
+  try {
+    const data = await api.listAdSets(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **campaignId** | `string` | Filter by campaign ID | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` |  | [Optional] [Defaults to `0`] |
+| **limit** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**ListAdSetsResponse**](ListAdSetsResponse.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 ad sets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## removeAdFromSet
+
+> AdSetResponse removeAdFromSet(adsetId, adId)
+
+Remove an ad from the set
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdSetsApi,
+} from '';
+import type { RemoveAdFromSetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdSetsApi();
+
+  const body = {
+    // string
+    adsetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    adId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies RemoveAdFromSetRequest;
+
+  try {
+    const data = await api.removeAdFromSet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **adsetId** | `string` |  | [Defaults to `undefined`] |
+| **adId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**AdSetResponse**](AdSetResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Ad removed from set |  -  |
+| **404** | Ad set 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)
+
+
+## updateAdSet
+
+> AdSetResponse updateAdSet(adsetId, updateAdSetRequest)
+
+Update an ad set
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdSetsApi,
+} from '';
+import type { UpdateAdSetOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdSetsApi();
+
+  const body = {
+    // string
+    adsetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateAdSetRequest
+    updateAdSetRequest: ...,
+  } satisfies UpdateAdSetOperationRequest;
+
+  try {
+    const data = await api.updateAdSet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **adsetId** | `string` |  | [Defaults to `undefined`] |
+| **updateAdSetRequest** | [UpdateAdSetRequest](UpdateAdSetRequest.md) |  | |
+
+### Return type
+
+[**AdSetResponse**](AdSetResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Ad set updated |  -  |
+| **400** | Validation error |  -  |
+| **404** | Ad set 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/adset/docs/CreateAdSet400Response.md

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

@@ -0,0 +1,37 @@
+
+# CreateAdSet400ResponseViolationsInner
+
+Validation violation for a specific field
+
+## Properties
+
+Name | Type
+------------ | -------------
+`field` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { CreateAdSet400ResponseViolationsInner } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "field": null,
+  "message": null,
+} satisfies CreateAdSet400ResponseViolationsInner
+
+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 CreateAdSet400ResponseViolationsInner
+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/src/generated/adset/docs/CreateAdSetRequest.md

@@ -0,0 +1,43 @@
+
+# CreateAdSetRequest
+
+Request to create an ad set
+
+## Properties
+
+Name | Type
+------------ | -------------
+`campaignId` | string
+`name` | string
+`targeting` | [AdSetTargeting](AdSetTargeting.md)
+`dailyBudget` | number
+`adIds` | Array<string>
+
+## Example
+
+```typescript
+import type { CreateAdSetRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "campaignId": null,
+  "name": null,
+  "targeting": null,
+  "dailyBudget": null,
+  "adIds": null,
+} satisfies CreateAdSetRequest
+
+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 CreateAdSetRequest
+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/src/generated/adset/docs/GetAdSet404Response.md

@@ -0,0 +1,41 @@
+
+# GetAdSet404Response
+
+Standard error response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`errorCode` | string
+`message` | string
+`timestamp` | Date
+`details` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { GetAdSet404Response } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "errorCode": null,
+  "message": null,
+  "timestamp": null,
+  "details": null,
+} satisfies GetAdSet404Response
+
+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 GetAdSet404Response
+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/src/generated/adset/docs/ListAdSetsResponse.md

@@ -0,0 +1,41 @@
+
+# ListAdSetsResponse
+
+Paginated list of ad sets
+
+## Properties
+
+Name | Type
+------------ | -------------
+`adsets` | [Array<AdSetResponse>](AdSetResponse.md)
+`total` | number
+`offset` | number
+`limit` | number
+
+## Example
+
+```typescript
+import type { ListAdSetsResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "adsets": null,
+  "total": null,
+  "offset": null,
+  "limit": null,
+} satisfies ListAdSetsResponse
+
+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 ListAdSetsResponse
+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)
+
+