@streetlevel/api-clients 1.0.1

package/src/generated/ad/docs/AdResponse.md

@@ -0,0 +1,61 @@
+
+# AdResponse
+
+Ad information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`campaignId` | string
+`name` | string
+`description` | string
+`fileKey` | string
+`fileUrl` | string
+`uploadUrl` | string
+`contentType` | string
+`fileSize` | number
+`durationSeconds` | number
+`status` | [AdStatus](AdStatus.md)
+`rejectionReason` | string
+`createdAt` | Date
+`lastModifiedAt` | Date
+
+## Example
+
+```typescript
+import type { AdResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "campaignId": null,
+  "name": null,
+  "description": null,
+  "fileKey": null,
+  "fileUrl": null,
+  "uploadUrl": null,
+  "contentType": null,
+  "fileSize": null,
+  "durationSeconds": null,
+  "status": null,
+  "rejectionReason": null,
+  "createdAt": null,
+  "lastModifiedAt": null,
+} satisfies AdResponse
+
+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 AdResponse
+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/ad/docs/AdStatus.md

@@ -0,0 +1,33 @@
+
+# AdStatus
+
+Ad lifecycle status
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { AdStatus } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies AdStatus
+
+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 AdStatus
+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/ad/docs/AdsApi.md

@@ -0,0 +1,560 @@
+# AdsApi
+
+All URIs are relative to */api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**approveAd**](AdsApi.md#approvead) | **POST** /ads/{ad_id}/approve | Approve an ad |
+| [**createAd**](AdsApi.md#createadoperation) | **POST** /ads | Create a new ad |
+| [**deleteAd**](AdsApi.md#deletead) | **DELETE** /ads/{ad_id} | Delete an ad |
+| [**getAd**](AdsApi.md#getad) | **GET** /ads/{ad_id} | Get ad by ID |
+| [**getAdUploadUrl**](AdsApi.md#getaduploadurl) | **GET** /ads/{ad_id}/upload-url | Get presigned URL for ad file upload |
+| [**listAds**](AdsApi.md#listads) | **GET** /ads | List ads |
+| [**rejectAd**](AdsApi.md#rejectadoperation) | **POST** /ads/{ad_id}/reject | Reject an ad |
+| [**submitAd**](AdsApi.md#submitad) | **POST** /ads/{ad_id}/submit | Submit ad for approval (triggers file upload to LED cloud) |
+
+
+
+## approveAd
+
+> AdResponse approveAd(adId)
+
+Approve an ad
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdsApi,
+} from '';
+import type { ApproveAdRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdsApi();
+
+  const body = {
+    // string
+    adId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ApproveAdRequest;
+
+  try {
+    const data = await api.approveAd(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **adId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**AdResponse**](AdResponse.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 approved |  -  |
+| **404** | Ad not found |  -  |
+| **409** | Invalid ad state |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## createAd
+
+> AdResponse createAd(createAdRequest)
+
+Create a new ad
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdsApi,
+} from '';
+import type { CreateAdOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdsApi();
+
+  const body = {
+    // CreateAdRequest
+    createAdRequest: ...,
+  } satisfies CreateAdOperationRequest;
+
+  try {
+    const data = await api.createAd(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createAdRequest** | [CreateAdRequest](CreateAdRequest.md) |  | |
+
+### Return type
+
+[**AdResponse**](AdResponse.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 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)
+
+
+## deleteAd
+
+> deleteAd(adId)
+
+Delete an ad
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdsApi,
+} from '';
+import type { DeleteAdRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdsApi();
+
+  const body = {
+    // string
+    adId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteAdRequest;
+
+  try {
+    const data = await api.deleteAd(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **adId** | `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 deleted |  -  |
+| **404** | 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)
+
+
+## getAd
+
+> AdResponse getAd(adId)
+
+Get ad by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdsApi,
+} from '';
+import type { GetAdRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdsApi();
+
+  const body = {
+    // string
+    adId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetAdRequest;
+
+  try {
+    const data = await api.getAd(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **adId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**AdResponse**](AdResponse.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 found |  -  |
+| **404** | 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)
+
+
+## getAdUploadUrl
+
+> UploadUrlResponse getAdUploadUrl(adId)
+
+Get presigned URL for ad file upload
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdsApi,
+} from '';
+import type { GetAdUploadUrlRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdsApi();
+
+  const body = {
+    // string
+    adId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetAdUploadUrlRequest;
+
+  try {
+    const data = await api.getAdUploadUrl(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **adId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**UploadUrlResponse**](UploadUrlResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Upload URL generated |  -  |
+| **404** | 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)
+
+
+## listAds
+
+> ListAdsResponse listAds(campaignId, status, offset, limit)
+
+List ads
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdsApi,
+} from '';
+import type { ListAdsRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdsApi();
+
+  const body = {
+    // string | Filter by campaign ID (optional)
+    campaignId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // AdStatus (optional)
+    status: ...,
+    // number (optional)
+    offset: 56,
+    // number (optional)
+    limit: 56,
+  } satisfies ListAdsRequest;
+
+  try {
+    const data = await api.listAds(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`] |
+| **status** | `AdStatus` |  | [Optional] [Defaults to `undefined`] [Enum: PENDING_UPLOAD, UPLOADED, PENDING_APPROVAL, APPROVED, REJECTED] |
+| **offset** | `number` |  | [Optional] [Defaults to `0`] |
+| **limit** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**ListAdsResponse**](ListAdsResponse.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 ads |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## rejectAd
+
+> AdResponse rejectAd(adId, rejectAdRequest)
+
+Reject an ad
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdsApi,
+} from '';
+import type { RejectAdOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdsApi();
+
+  const body = {
+    // string
+    adId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // RejectAdRequest
+    rejectAdRequest: ...,
+  } satisfies RejectAdOperationRequest;
+
+  try {
+    const data = await api.rejectAd(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **adId** | `string` |  | [Defaults to `undefined`] |
+| **rejectAdRequest** | [RejectAdRequest](RejectAdRequest.md) |  | |
+
+### Return type
+
+[**AdResponse**](AdResponse.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 rejected |  -  |
+| **404** | Ad not found |  -  |
+| **409** | Invalid ad state |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## submitAd
+
+> AdResponse submitAd(adId)
+
+Submit ad for approval (triggers file upload to LED cloud)
+
+Transitions ad from PENDING_UPLOAD to PENDING_APPROVAL. Requires the file to have been uploaded to S3 first. This transition triggers the media upload to the LED cloud provider. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdsApi,
+} from '';
+import type { SubmitAdRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new AdsApi();
+
+  const body = {
+    // string
+    adId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies SubmitAdRequest;
+
+  try {
+    const data = await api.submitAd(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **adId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**AdResponse**](AdResponse.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 submitted for approval |  -  |
+| **404** | Ad not found |  -  |
+| **409** | Invalid ad state (file not uploaded or wrong status) |  -  |
+
+[[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/ad/docs/CreateAd400Response.md

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