@streetlevel/api-clients 1.0.1

package/src/generated/settings/docs/SettingsApi.md

@@ -0,0 +1,137 @@
+# SettingsApi
+
+All URIs are relative to */api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getSettings**](SettingsApi.md#getsettings) | **GET** /settings | Get current settings |
+| [**updateSettings**](SettingsApi.md#updatesettingsoperation) | **PUT** /settings | Update settings |
+
+
+
+## getSettings
+
+> SettingsResponse getSettings()
+
+Get current settings
+
+Retrieve the current system-wide settings including ad display mode
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SettingsApi,
+} from '';
+import type { GetSettingsRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new SettingsApi();
+
+  try {
+    const data = await api.getSettings();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**SettingsResponse**](SettingsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Current settings |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateSettings
+
+> SettingsResponse updateSettings(updateSettingsRequest)
+
+Update settings
+
+Update system-wide settings including ad display mode
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SettingsApi,
+} from '';
+import type { UpdateSettingsOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new SettingsApi();
+
+  const body = {
+    // UpdateSettingsRequest
+    updateSettingsRequest: ...,
+  } satisfies UpdateSettingsOperationRequest;
+
+  try {
+    const data = await api.updateSettings(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **updateSettingsRequest** | [UpdateSettingsRequest](UpdateSettingsRequest.md) |  | |
+
+### Return type
+
+[**SettingsResponse**](SettingsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Settings updated |  -  |
+| **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)
+

package/src/generated/settings/docs/SettingsResponse.md

@@ -0,0 +1,43 @@
+
+# SettingsResponse
+
+System settings
+
+## Properties
+
+Name | Type
+------------ | -------------
+`adDisplayMode` | [AdDisplayMode](AdDisplayMode.md)
+`activePlaylistId` | string
+`activePlaylistName` | string
+`lastModifiedAt` | Date
+`lastModifiedBy` | string
+
+## Example
+
+```typescript
+import type { SettingsResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "adDisplayMode": null,
+  "activePlaylistId": null,
+  "activePlaylistName": null,
+  "lastModifiedAt": null,
+  "lastModifiedBy": null,
+} satisfies SettingsResponse
+
+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 SettingsResponse
+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/settings/docs/UpdateSettings400Response.md

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

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

@@ -0,0 +1,37 @@
+
+# UpdateSettingsRequest
+
+Request to update system settings
+
+## Properties
+
+Name | Type
+------------ | -------------
+`adDisplayMode` | [AdDisplayMode](AdDisplayMode.md)
+`activePlaylistId` | string
+
+## Example
+
+```typescript
+import type { UpdateSettingsRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "adDisplayMode": null,
+  "activePlaylistId": null,
+} satisfies UpdateSettingsRequest
+
+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 UpdateSettingsRequest
+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/settings/index.ts

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

package/src/generated/settings/models/AdDisplayMode.ts

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Settings API
+ * API for managing system-wide settings including ad display mode
+ *
+ * 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.
+ */
+
+
+/**
+ * Ad display mode:
+ * - ZONE: Ads shown based on screen location matching geographic zones
+ * - NETWORK: Single playlist plays across all screens network-wide
+ * 
+ * @export
+ */
+export const AdDisplayMode = {
+    Zone: 'ZONE',
+    Network: 'NETWORK'
+} as const;
+export type AdDisplayMode = typeof AdDisplayMode[keyof typeof AdDisplayMode];
+
+
+export function instanceOfAdDisplayMode(value: any): boolean {
+    for (const key in AdDisplayMode) {
+        if (Object.prototype.hasOwnProperty.call(AdDisplayMode, key)) {
+            if (AdDisplayMode[key as keyof typeof AdDisplayMode] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function AdDisplayModeFromJSON(json: any): AdDisplayMode {
+    return AdDisplayModeFromJSONTyped(json, false);
+}
+
+export function AdDisplayModeFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdDisplayMode {
+    return json as AdDisplayMode;
+}
+
+export function AdDisplayModeToJSON(value?: AdDisplayMode | null): any {
+    return value as any;
+}
+
+export function AdDisplayModeToJSONTyped(value: any, ignoreDiscriminator: boolean): AdDisplayMode {
+    return value as AdDisplayMode;
+}
+

package/src/generated/settings/models/SettingsResponse.ts

@@ -0,0 +1,109 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Settings API
+ * API for managing system-wide settings including ad display mode
+ *
+ * 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 { AdDisplayMode } from './AdDisplayMode';
+import {
+    AdDisplayModeFromJSON,
+    AdDisplayModeFromJSONTyped,
+    AdDisplayModeToJSON,
+    AdDisplayModeToJSONTyped,
+} from './AdDisplayMode';
+
+/**
+ * System settings
+ * @export
+ * @interface SettingsResponse
+ */
+export interface SettingsResponse {
+    /**
+     * 
+     * @type {AdDisplayMode}
+     * @memberof SettingsResponse
+     */
+    adDisplayMode: AdDisplayMode;
+    /**
+     * Currently active playlist (only set when in NETWORK mode)
+     * @type {string}
+     * @memberof SettingsResponse
+     */
+    activePlaylistId?: string;
+    /**
+     * Name of the active playlist (for display convenience)
+     * @type {string}
+     * @memberof SettingsResponse
+     */
+    activePlaylistName?: string;
+    /**
+     * When settings were last modified
+     * @type {Date}
+     * @memberof SettingsResponse
+     */
+    lastModifiedAt: Date;
+    /**
+     * User who last modified settings
+     * @type {string}
+     * @memberof SettingsResponse
+     */
+    lastModifiedBy?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the SettingsResponse interface.
+ */
+export function instanceOfSettingsResponse(value: object): value is SettingsResponse {
+    if (!('adDisplayMode' in value) || value['adDisplayMode'] === undefined) return false;
+    if (!('lastModifiedAt' in value) || value['lastModifiedAt'] === undefined) return false;
+    return true;
+}
+
+export function SettingsResponseFromJSON(json: any): SettingsResponse {
+    return SettingsResponseFromJSONTyped(json, false);
+}
+
+export function SettingsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SettingsResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'adDisplayMode': AdDisplayModeFromJSON(json['ad_display_mode']),
+        'activePlaylistId': json['active_playlist_id'] == null ? undefined : json['active_playlist_id'],
+        'activePlaylistName': json['active_playlist_name'] == null ? undefined : json['active_playlist_name'],
+        'lastModifiedAt': (new Date(json['last_modified_at'])),
+        'lastModifiedBy': json['last_modified_by'] == null ? undefined : json['last_modified_by'],
+    };
+}
+
+export function SettingsResponseToJSON(json: any): SettingsResponse {
+    return SettingsResponseToJSONTyped(json, false);
+}
+
+export function SettingsResponseToJSONTyped(value?: SettingsResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ad_display_mode': AdDisplayModeToJSON(value['adDisplayMode']),
+        'active_playlist_id': value['activePlaylistId'],
+        'active_playlist_name': value['activePlaylistName'],
+        'last_modified_at': value['lastModifiedAt'].toISOString(),
+        'last_modified_by': value['lastModifiedBy'],
+    };
+}
+

package/src/generated/settings/models/UpdateSettings400Response.ts

@@ -0,0 +1,101 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Settings API
+ * API for managing system-wide settings including ad display mode
+ *
+ * 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 { UpdateSettings400ResponseViolationsInner } from './UpdateSettings400ResponseViolationsInner';
+import {
+    UpdateSettings400ResponseViolationsInnerFromJSON,
+    UpdateSettings400ResponseViolationsInnerFromJSONTyped,
+    UpdateSettings400ResponseViolationsInnerToJSON,
+    UpdateSettings400ResponseViolationsInnerToJSONTyped,
+} from './UpdateSettings400ResponseViolationsInner';
+
+/**
+ * Validation error response
+ * @export
+ * @interface UpdateSettings400Response
+ */
+export interface UpdateSettings400Response {
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateSettings400Response
+     */
+    errorCode: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateSettings400Response
+     */
+    message: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof UpdateSettings400Response
+     */
+    timestamp: Date;
+    /**
+     * 
+     * @type {Array<UpdateSettings400ResponseViolationsInner>}
+     * @memberof UpdateSettings400Response
+     */
+    violations: Array<UpdateSettings400ResponseViolationsInner>;
+}
+
+/**
+ * Check if a given object implements the UpdateSettings400Response interface.
+ */
+export function instanceOfUpdateSettings400Response(value: object): value is UpdateSettings400Response {
+    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 UpdateSettings400ResponseFromJSON(json: any): UpdateSettings400Response {
+    return UpdateSettings400ResponseFromJSONTyped(json, false);
+}
+
+export function UpdateSettings400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSettings400Response {
+    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(UpdateSettings400ResponseViolationsInnerFromJSON)),
+    };
+}
+
+export function UpdateSettings400ResponseToJSON(json: any): UpdateSettings400Response {
+    return UpdateSettings400ResponseToJSONTyped(json, false);
+}
+
+export function UpdateSettings400ResponseToJSONTyped(value?: UpdateSettings400Response | 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(UpdateSettings400ResponseViolationsInnerToJSON)),
+    };
+}
+

package/src/generated/settings/models/UpdateSettings400ResponseViolationsInner.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Settings API
+ * API for managing system-wide settings including ad display mode
+ *
+ * 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 UpdateSettings400ResponseViolationsInner
+ */
+export interface UpdateSettings400ResponseViolationsInner {
+    /**
+     * Name of the field with violation
+     * @type {string}
+     * @memberof UpdateSettings400ResponseViolationsInner
+     */
+    field: string;
+    /**
+     * Description of the violation
+     * @type {string}
+     * @memberof UpdateSettings400ResponseViolationsInner
+     */
+    message: string;
+}
+
+/**
+ * Check if a given object implements the UpdateSettings400ResponseViolationsInner interface.
+ */
+export function instanceOfUpdateSettings400ResponseViolationsInner(value: object): value is UpdateSettings400ResponseViolationsInner {
+    if (!('field' in value) || value['field'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    return true;
+}
+
+export function UpdateSettings400ResponseViolationsInnerFromJSON(json: any): UpdateSettings400ResponseViolationsInner {
+    return UpdateSettings400ResponseViolationsInnerFromJSONTyped(json, false);
+}
+
+export function UpdateSettings400ResponseViolationsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSettings400ResponseViolationsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'field': json['field'],
+        'message': json['message'],
+    };
+}
+
+export function UpdateSettings400ResponseViolationsInnerToJSON(json: any): UpdateSettings400ResponseViolationsInner {
+    return UpdateSettings400ResponseViolationsInnerToJSONTyped(json, false);
+}
+
+export function UpdateSettings400ResponseViolationsInnerToJSONTyped(value?: UpdateSettings400ResponseViolationsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'field': value['field'],
+        'message': value['message'],
+    };
+}
+