@streetlevel/api-clients 1.0.1

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

@@ -0,0 +1,90 @@
+/* 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 { PlaylistAdInput } from './PlaylistAdInput';
+import {
+    PlaylistAdInputFromJSON,
+    PlaylistAdInputFromJSONTyped,
+    PlaylistAdInputToJSON,
+    PlaylistAdInputToJSONTyped,
+} from './PlaylistAdInput';
+
+/**
+ * Request to create a playlist
+ * @export
+ * @interface CreatePlaylistRequest
+ */
+export interface CreatePlaylistRequest {
+    /**
+     * Playlist name
+     * @type {string}
+     * @memberof CreatePlaylistRequest
+     */
+    name: string;
+    /**
+     * Playlist description
+     * @type {string}
+     * @memberof CreatePlaylistRequest
+     */
+    description?: string;
+    /**
+     * Ordered list of ads in the playlist
+     * @type {Array<PlaylistAdInput>}
+     * @memberof CreatePlaylistRequest
+     */
+    ads?: Array<PlaylistAdInput>;
+}
+
+/**
+ * Check if a given object implements the CreatePlaylistRequest interface.
+ */
+export function instanceOfCreatePlaylistRequest(value: object): value is CreatePlaylistRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function CreatePlaylistRequestFromJSON(json: any): CreatePlaylistRequest {
+    return CreatePlaylistRequestFromJSONTyped(json, false);
+}
+
+export function CreatePlaylistRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePlaylistRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'ads': json['ads'] == null ? undefined : ((json['ads'] as Array<any>).map(PlaylistAdInputFromJSON)),
+    };
+}
+
+export function CreatePlaylistRequestToJSON(json: any): CreatePlaylistRequest {
+    return CreatePlaylistRequestToJSONTyped(json, false);
+}
+
+export function CreatePlaylistRequestToJSONTyped(value?: CreatePlaylistRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'ads': value['ads'] == null ? undefined : ((value['ads'] as Array<any>).map(PlaylistAdInputToJSON)),
+    };
+}
+

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

@@ -0,0 +1,92 @@
+/* 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';
+/**
+ * Standard error response
+ * @export
+ * @interface GetPlaylist404Response
+ */
+export interface GetPlaylist404Response {
+    /**
+     * Machine-readable error code
+     * @type {string}
+     * @memberof GetPlaylist404Response
+     */
+    errorCode: string;
+    /**
+     * Human-readable error message
+     * @type {string}
+     * @memberof GetPlaylist404Response
+     */
+    message: string;
+    /**
+     * Time when the error occurred
+     * @type {Date}
+     * @memberof GetPlaylist404Response
+     */
+    timestamp: Date;
+    /**
+     * Additional error details
+     * @type {{ [key: string]: any; }}
+     * @memberof GetPlaylist404Response
+     */
+    details?: { [key: string]: any; };
+}
+
+/**
+ * Check if a given object implements the GetPlaylist404Response interface.
+ */
+export function instanceOfGetPlaylist404Response(value: object): value is GetPlaylist404Response {
+    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;
+    return true;
+}
+
+export function GetPlaylist404ResponseFromJSON(json: any): GetPlaylist404Response {
+    return GetPlaylist404ResponseFromJSONTyped(json, false);
+}
+
+export function GetPlaylist404ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPlaylist404Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'errorCode': json['error_code'],
+        'message': json['message'],
+        'timestamp': (new Date(json['timestamp'])),
+        'details': json['details'] == null ? undefined : json['details'],
+    };
+}
+
+export function GetPlaylist404ResponseToJSON(json: any): GetPlaylist404Response {
+    return GetPlaylist404ResponseToJSONTyped(json, false);
+}
+
+export function GetPlaylist404ResponseToJSONTyped(value?: GetPlaylist404Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'error_code': value['errorCode'],
+        'message': value['message'],
+        'timestamp': value['timestamp'].toISOString(),
+        'details': value['details'],
+    };
+}
+

package/src/generated/playlist/models/ListPlaylistsResponse.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 { PlaylistResponse } from './PlaylistResponse';
+import {
+    PlaylistResponseFromJSON,
+    PlaylistResponseFromJSONTyped,
+    PlaylistResponseToJSON,
+    PlaylistResponseToJSONTyped,
+} from './PlaylistResponse';
+
+/**
+ * Paginated list of playlists
+ * @export
+ * @interface ListPlaylistsResponse
+ */
+export interface ListPlaylistsResponse {
+    /**
+     * 
+     * @type {Array<PlaylistResponse>}
+     * @memberof ListPlaylistsResponse
+     */
+    playlists: Array<PlaylistResponse>;
+    /**
+     * 
+     * @type {number}
+     * @memberof ListPlaylistsResponse
+     */
+    total: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ListPlaylistsResponse
+     */
+    offset: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ListPlaylistsResponse
+     */
+    limit: number;
+}
+
+/**
+ * Check if a given object implements the ListPlaylistsResponse interface.
+ */
+export function instanceOfListPlaylistsResponse(value: object): value is ListPlaylistsResponse {
+    if (!('playlists' in value) || value['playlists'] === undefined) return false;
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('offset' in value) || value['offset'] === undefined) return false;
+    if (!('limit' in value) || value['limit'] === undefined) return false;
+    return true;
+}
+
+export function ListPlaylistsResponseFromJSON(json: any): ListPlaylistsResponse {
+    return ListPlaylistsResponseFromJSONTyped(json, false);
+}
+
+export function ListPlaylistsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListPlaylistsResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'playlists': ((json['playlists'] as Array<any>).map(PlaylistResponseFromJSON)),
+        'total': json['total'],
+        'offset': json['offset'],
+        'limit': json['limit'],
+    };
+}
+
+export function ListPlaylistsResponseToJSON(json: any): ListPlaylistsResponse {
+    return ListPlaylistsResponseToJSONTyped(json, false);
+}
+
+export function ListPlaylistsResponseToJSONTyped(value?: ListPlaylistsResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'playlists': ((value['playlists'] as Array<any>).map(PlaylistResponseToJSON)),
+        'total': value['total'],
+        'offset': value['offset'],
+        'limit': value['limit'],
+    };
+}
+

package/src/generated/playlist/models/PlaylistAd.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';
+/**
+ * An ad entry in a playlist
+ * @export
+ * @interface PlaylistAd
+ */
+export interface PlaylistAd {
+    /**
+     * Reference to the ad
+     * @type {string}
+     * @memberof PlaylistAd
+     */
+    adId: string;
+    /**
+     * Campaign this ad belongs to
+     * @type {string}
+     * @memberof PlaylistAd
+     */
+    campaignId: string;
+    /**
+     * Name of the ad (for display convenience)
+     * @type {string}
+     * @memberof PlaylistAd
+     */
+    adName?: string;
+    /**
+     * How long to display this ad in seconds
+     * @type {number}
+     * @memberof PlaylistAd
+     */
+    durationSeconds: number;
+    /**
+     * Position in the playlist (0-indexed)
+     * @type {number}
+     * @memberof PlaylistAd
+     */
+    order: number;
+}
+
+/**
+ * Check if a given object implements the PlaylistAd interface.
+ */
+export function instanceOfPlaylistAd(value: object): value is PlaylistAd {
+    if (!('adId' in value) || value['adId'] === undefined) return false;
+    if (!('campaignId' in value) || value['campaignId'] === undefined) return false;
+    if (!('durationSeconds' in value) || value['durationSeconds'] === undefined) return false;
+    if (!('order' in value) || value['order'] === undefined) return false;
+    return true;
+}
+
+export function PlaylistAdFromJSON(json: any): PlaylistAd {
+    return PlaylistAdFromJSONTyped(json, false);
+}
+
+export function PlaylistAdFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlaylistAd {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'adId': json['ad_id'],
+        'campaignId': json['campaign_id'],
+        'adName': json['ad_name'] == null ? undefined : json['ad_name'],
+        'durationSeconds': json['duration_seconds'],
+        'order': json['order'],
+    };
+}
+
+export function PlaylistAdToJSON(json: any): PlaylistAd {
+    return PlaylistAdToJSONTyped(json, false);
+}
+
+export function PlaylistAdToJSONTyped(value?: PlaylistAd | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ad_id': value['adId'],
+        'campaign_id': value['campaignId'],
+        'ad_name': value['adName'],
+        'duration_seconds': value['durationSeconds'],
+        'order': value['order'],
+    };
+}
+

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

@@ -0,0 +1,84 @@
+/* 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';
+/**
+ * Input for adding an ad to a playlist
+ * @export
+ * @interface PlaylistAdInput
+ */
+export interface PlaylistAdInput {
+    /**
+     * Reference to the ad
+     * @type {string}
+     * @memberof PlaylistAdInput
+     */
+    adId: string;
+    /**
+     * Campaign this ad belongs to
+     * @type {string}
+     * @memberof PlaylistAdInput
+     */
+    campaignId: string;
+    /**
+     * How long to display this ad in seconds
+     * @type {number}
+     * @memberof PlaylistAdInput
+     */
+    durationSeconds: number;
+}
+
+/**
+ * Check if a given object implements the PlaylistAdInput interface.
+ */
+export function instanceOfPlaylistAdInput(value: object): value is PlaylistAdInput {
+    if (!('adId' in value) || value['adId'] === undefined) return false;
+    if (!('campaignId' in value) || value['campaignId'] === undefined) return false;
+    if (!('durationSeconds' in value) || value['durationSeconds'] === undefined) return false;
+    return true;
+}
+
+export function PlaylistAdInputFromJSON(json: any): PlaylistAdInput {
+    return PlaylistAdInputFromJSONTyped(json, false);
+}
+
+export function PlaylistAdInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlaylistAdInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'adId': json['ad_id'],
+        'campaignId': json['campaign_id'],
+        'durationSeconds': json['duration_seconds'],
+    };
+}
+
+export function PlaylistAdInputToJSON(json: any): PlaylistAdInput {
+    return PlaylistAdInputToJSONTyped(json, false);
+}
+
+export function PlaylistAdInputToJSONTyped(value?: PlaylistAdInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ad_id': value['adId'],
+        'campaign_id': value['campaignId'],
+        'duration_seconds': value['durationSeconds'],
+    };
+}
+

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

@@ -0,0 +1,143 @@
+/* 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 { PlaylistAd } from './PlaylistAd';
+import {
+    PlaylistAdFromJSON,
+    PlaylistAdFromJSONTyped,
+    PlaylistAdToJSON,
+    PlaylistAdToJSONTyped,
+} from './PlaylistAd';
+
+/**
+ * Playlist information
+ * @export
+ * @interface PlaylistResponse
+ */
+export interface PlaylistResponse {
+    /**
+     * Playlist unique identifier
+     * @type {string}
+     * @memberof PlaylistResponse
+     */
+    id: string;
+    /**
+     * Playlist name
+     * @type {string}
+     * @memberof PlaylistResponse
+     */
+    name: string;
+    /**
+     * Playlist description
+     * @type {string}
+     * @memberof PlaylistResponse
+     */
+    description?: string;
+    /**
+     * Ordered list of ads in the playlist
+     * @type {Array<PlaylistAd>}
+     * @memberof PlaylistResponse
+     */
+    ads?: Array<PlaylistAd>;
+    /**
+     * Whether this playlist is currently active
+     * @type {boolean}
+     * @memberof PlaylistResponse
+     */
+    active: boolean;
+    /**
+     * Total duration of all ads in the playlist
+     * @type {number}
+     * @memberof PlaylistResponse
+     */
+    totalDurationSeconds: number;
+    /**
+     * Number of ads in the playlist
+     * @type {number}
+     * @memberof PlaylistResponse
+     */
+    adCount?: number;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof PlaylistResponse
+     */
+    createdAt: Date;
+    /**
+     * Last modification timestamp
+     * @type {Date}
+     * @memberof PlaylistResponse
+     */
+    lastModifiedAt: Date;
+}
+
+/**
+ * Check if a given object implements the PlaylistResponse interface.
+ */
+export function instanceOfPlaylistResponse(value: object): value is PlaylistResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('active' in value) || value['active'] === undefined) return false;
+    if (!('totalDurationSeconds' in value) || value['totalDurationSeconds'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('lastModifiedAt' in value) || value['lastModifiedAt'] === undefined) return false;
+    return true;
+}
+
+export function PlaylistResponseFromJSON(json: any): PlaylistResponse {
+    return PlaylistResponseFromJSONTyped(json, false);
+}
+
+export function PlaylistResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlaylistResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'ads': json['ads'] == null ? undefined : ((json['ads'] as Array<any>).map(PlaylistAdFromJSON)),
+        'active': json['active'],
+        'totalDurationSeconds': json['total_duration_seconds'],
+        'adCount': json['ad_count'] == null ? undefined : json['ad_count'],
+        'createdAt': (new Date(json['created_at'])),
+        'lastModifiedAt': (new Date(json['last_modified_at'])),
+    };
+}
+
+export function PlaylistResponseToJSON(json: any): PlaylistResponse {
+    return PlaylistResponseToJSONTyped(json, false);
+}
+
+export function PlaylistResponseToJSONTyped(value?: PlaylistResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'ads': value['ads'] == null ? undefined : ((value['ads'] as Array<any>).map(PlaylistAdToJSON)),
+        'active': value['active'],
+        'total_duration_seconds': value['totalDurationSeconds'],
+        'ad_count': value['adCount'],
+        'created_at': value['createdAt'].toISOString(),
+        'last_modified_at': value['lastModifiedAt'].toISOString(),
+    };
+}
+

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

@@ -0,0 +1,89 @@
+/* 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 { PlaylistAdInput } from './PlaylistAdInput';
+import {
+    PlaylistAdInputFromJSON,
+    PlaylistAdInputFromJSONTyped,
+    PlaylistAdInputToJSON,
+    PlaylistAdInputToJSONTyped,
+} from './PlaylistAdInput';
+
+/**
+ * Request to update a playlist
+ * @export
+ * @interface UpdatePlaylistRequest
+ */
+export interface UpdatePlaylistRequest {
+    /**
+     * Playlist name
+     * @type {string}
+     * @memberof UpdatePlaylistRequest
+     */
+    name?: string;
+    /**
+     * Playlist description
+     * @type {string}
+     * @memberof UpdatePlaylistRequest
+     */
+    description?: string;
+    /**
+     * Ordered list of ads in the playlist (replaces existing)
+     * @type {Array<PlaylistAdInput>}
+     * @memberof UpdatePlaylistRequest
+     */
+    ads?: Array<PlaylistAdInput>;
+}
+
+/**
+ * Check if a given object implements the UpdatePlaylistRequest interface.
+ */
+export function instanceOfUpdatePlaylistRequest(value: object): value is UpdatePlaylistRequest {
+    return true;
+}
+
+export function UpdatePlaylistRequestFromJSON(json: any): UpdatePlaylistRequest {
+    return UpdatePlaylistRequestFromJSONTyped(json, false);
+}
+
+export function UpdatePlaylistRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdatePlaylistRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'ads': json['ads'] == null ? undefined : ((json['ads'] as Array<any>).map(PlaylistAdInputFromJSON)),
+    };
+}
+
+export function UpdatePlaylistRequestToJSON(json: any): UpdatePlaylistRequest {
+    return UpdatePlaylistRequestToJSONTyped(json, false);
+}
+
+export function UpdatePlaylistRequestToJSONTyped(value?: UpdatePlaylistRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'ads': value['ads'] == null ? undefined : ((value['ads'] as Array<any>).map(PlaylistAdInputToJSON)),
+    };
+}
+