@streetlevel/api-clients 1.0.1

package/src/generated/playlist/docs/PlaylistsApi.md

@@ -0,0 +1,489 @@
+# PlaylistsApi
+
+All URIs are relative to */api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**activatePlaylist**](PlaylistsApi.md#activateplaylist) | **POST** /playlists/{playlist_id}/activate | Activate a playlist |
+| [**createPlaylist**](PlaylistsApi.md#createplaylistoperation) | **POST** /playlists | Create a new playlist |
+| [**deactivatePlaylist**](PlaylistsApi.md#deactivateplaylist) | **POST** /playlists/{playlist_id}/deactivate | Deactivate a playlist |
+| [**deletePlaylist**](PlaylistsApi.md#deleteplaylist) | **DELETE** /playlists/{playlist_id} | Delete a playlist |
+| [**getPlaylist**](PlaylistsApi.md#getplaylist) | **GET** /playlists/{playlist_id} | Get playlist by ID |
+| [**listPlaylists**](PlaylistsApi.md#listplaylists) | **GET** /playlists | List playlists |
+| [**updatePlaylist**](PlaylistsApi.md#updateplaylistoperation) | **PUT** /playlists/{playlist_id} | Update a playlist |
+
+
+
+## activatePlaylist
+
+> PlaylistResponse activatePlaylist(playlistId)
+
+Activate a playlist
+
+Marks the playlist as active. Only one playlist can be active at a time.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlaylistsApi,
+} from '';
+import type { ActivatePlaylistRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new PlaylistsApi();
+
+  const body = {
+    // string
+    playlistId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ActivatePlaylistRequest;
+
+  try {
+    const data = await api.activatePlaylist(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **playlistId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**PlaylistResponse**](PlaylistResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Playlist activated |  -  |
+| **404** | Playlist 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)
+
+
+## createPlaylist
+
+> PlaylistResponse createPlaylist(createPlaylistRequest)
+
+Create a new playlist
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlaylistsApi,
+} from '';
+import type { CreatePlaylistOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new PlaylistsApi();
+
+  const body = {
+    // CreatePlaylistRequest
+    createPlaylistRequest: ...,
+  } satisfies CreatePlaylistOperationRequest;
+
+  try {
+    const data = await api.createPlaylist(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createPlaylistRequest** | [CreatePlaylistRequest](CreatePlaylistRequest.md) |  | |
+
+### Return type
+
+[**PlaylistResponse**](PlaylistResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Playlist 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)
+
+
+## deactivatePlaylist
+
+> PlaylistResponse deactivatePlaylist(playlistId)
+
+Deactivate a playlist
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlaylistsApi,
+} from '';
+import type { DeactivatePlaylistRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new PlaylistsApi();
+
+  const body = {
+    // string
+    playlistId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeactivatePlaylistRequest;
+
+  try {
+    const data = await api.deactivatePlaylist(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **playlistId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**PlaylistResponse**](PlaylistResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Playlist deactivated |  -  |
+| **404** | Playlist 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)
+
+
+## deletePlaylist
+
+> deletePlaylist(playlistId)
+
+Delete a playlist
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlaylistsApi,
+} from '';
+import type { DeletePlaylistRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new PlaylistsApi();
+
+  const body = {
+    // string
+    playlistId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeletePlaylistRequest;
+
+  try {
+    const data = await api.deletePlaylist(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **playlistId** | `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** | Playlist deleted |  -  |
+| **404** | Playlist not found |  -  |
+| **409** | Cannot delete active playlist |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getPlaylist
+
+> PlaylistResponse getPlaylist(playlistId)
+
+Get playlist by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlaylistsApi,
+} from '';
+import type { GetPlaylistRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new PlaylistsApi();
+
+  const body = {
+    // string
+    playlistId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetPlaylistRequest;
+
+  try {
+    const data = await api.getPlaylist(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **playlistId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**PlaylistResponse**](PlaylistResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Playlist found |  -  |
+| **404** | Playlist 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)
+
+
+## listPlaylists
+
+> ListPlaylistsResponse listPlaylists(active, offset, limit)
+
+List playlists
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlaylistsApi,
+} from '';
+import type { ListPlaylistsRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new PlaylistsApi();
+
+  const body = {
+    // boolean | Filter by active status (optional)
+    active: true,
+    // number (optional)
+    offset: 56,
+    // number (optional)
+    limit: 56,
+  } satisfies ListPlaylistsRequest;
+
+  try {
+    const data = await api.listPlaylists(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **active** | `boolean` | Filter by active status | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` |  | [Optional] [Defaults to `0`] |
+| **limit** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**ListPlaylistsResponse**](ListPlaylistsResponse.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 playlists |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updatePlaylist
+
+> PlaylistResponse updatePlaylist(playlistId, updatePlaylistRequest)
+
+Update a playlist
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlaylistsApi,
+} from '';
+import type { UpdatePlaylistOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new PlaylistsApi();
+
+  const body = {
+    // string
+    playlistId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdatePlaylistRequest
+    updatePlaylistRequest: ...,
+  } satisfies UpdatePlaylistOperationRequest;
+
+  try {
+    const data = await api.updatePlaylist(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **playlistId** | `string` |  | [Defaults to `undefined`] |
+| **updatePlaylistRequest** | [UpdatePlaylistRequest](UpdatePlaylistRequest.md) |  | |
+
+### Return type
+
+[**PlaylistResponse**](PlaylistResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Playlist updated |  -  |
+| **400** | Validation error |  -  |
+| **404** | Playlist 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/playlist/docs/UpdatePlaylistRequest.md

@@ -0,0 +1,39 @@
+
+# UpdatePlaylistRequest
+
+Request to update a playlist
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`ads` | [Array<PlaylistAdInput>](PlaylistAdInput.md)
+
+## Example
+
+```typescript
+import type { UpdatePlaylistRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "ads": null,
+} satisfies UpdatePlaylistRequest
+
+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 UpdatePlaylistRequest
+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/playlist/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/src/generated/playlist/models/CreatePlaylist400Response.ts

@@ -0,0 +1,101 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Playlist API
+ * API for managing network-wide ad playlists
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { CreatePlaylist400ResponseViolationsInner } from './CreatePlaylist400ResponseViolationsInner';
+import {
+    CreatePlaylist400ResponseViolationsInnerFromJSON,
+    CreatePlaylist400ResponseViolationsInnerFromJSONTyped,
+    CreatePlaylist400ResponseViolationsInnerToJSON,
+    CreatePlaylist400ResponseViolationsInnerToJSONTyped,
+} from './CreatePlaylist400ResponseViolationsInner';
+
+/**
+ * Validation error response
+ * @export
+ * @interface CreatePlaylist400Response
+ */
+export interface CreatePlaylist400Response {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePlaylist400Response
+     */
+    errorCode: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePlaylist400Response
+     */
+    message: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CreatePlaylist400Response
+     */
+    timestamp: Date;
+    /**
+     * 
+     * @type {Array<CreatePlaylist400ResponseViolationsInner>}
+     * @memberof CreatePlaylist400Response
+     */
+    violations: Array<CreatePlaylist400ResponseViolationsInner>;
+}
+
+/**
+ * Check if a given object implements the CreatePlaylist400Response interface.
+ */
+export function instanceOfCreatePlaylist400Response(value: object): value is CreatePlaylist400Response {
+    if (!('errorCode' in value) || value['errorCode'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
+    if (!('violations' in value) || value['violations'] === undefined) return false;
+    return true;
+}
+
+export function CreatePlaylist400ResponseFromJSON(json: any): CreatePlaylist400Response {
+    return CreatePlaylist400ResponseFromJSONTyped(json, false);
+}
+
+export function CreatePlaylist400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePlaylist400Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'errorCode': json['error_code'],
+        'message': json['message'],
+        'timestamp': (new Date(json['timestamp'])),
+        'violations': ((json['violations'] as Array<any>).map(CreatePlaylist400ResponseViolationsInnerFromJSON)),
+    };
+}
+
+export function CreatePlaylist400ResponseToJSON(json: any): CreatePlaylist400Response {
+    return CreatePlaylist400ResponseToJSONTyped(json, false);
+}
+
+export function CreatePlaylist400ResponseToJSONTyped(value?: CreatePlaylist400Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'error_code': value['errorCode'],
+        'message': value['message'],
+        'timestamp': value['timestamp'].toISOString(),
+        'violations': ((value['violations'] as Array<any>).map(CreatePlaylist400ResponseViolationsInnerToJSON)),
+    };
+}
+

package/src/generated/playlist/models/CreatePlaylist400ResponseViolationsInner.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Playlist API
+ * API for managing network-wide ad playlists
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Validation violation for a specific field
+ * @export
+ * @interface CreatePlaylist400ResponseViolationsInner
+ */
+export interface CreatePlaylist400ResponseViolationsInner {
+    /**
+     * Name of the field with violation
+     * @type {string}
+     * @memberof CreatePlaylist400ResponseViolationsInner
+     */
+    field: string;
+    /**
+     * Description of the violation
+     * @type {string}
+     * @memberof CreatePlaylist400ResponseViolationsInner
+     */
+    message: string;
+}
+
+/**
+ * Check if a given object implements the CreatePlaylist400ResponseViolationsInner interface.
+ */
+export function instanceOfCreatePlaylist400ResponseViolationsInner(value: object): value is CreatePlaylist400ResponseViolationsInner {
+    if (!('field' in value) || value['field'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    return true;
+}
+
+export function CreatePlaylist400ResponseViolationsInnerFromJSON(json: any): CreatePlaylist400ResponseViolationsInner {
+    return CreatePlaylist400ResponseViolationsInnerFromJSONTyped(json, false);
+}
+
+export function CreatePlaylist400ResponseViolationsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePlaylist400ResponseViolationsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'field': json['field'],
+        'message': json['message'],
+    };
+}
+
+export function CreatePlaylist400ResponseViolationsInnerToJSON(json: any): CreatePlaylist400ResponseViolationsInner {
+    return CreatePlaylist400ResponseViolationsInnerToJSONTyped(json, false);
+}
+
+export function CreatePlaylist400ResponseViolationsInnerToJSONTyped(value?: CreatePlaylist400ResponseViolationsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'field': value['field'],
+        'message': value['message'],
+    };
+}
+