@coval/sdk 0.2.1 → 0.4.0

package/src/generated/models/CovalPersonasAPIListBackgroundSoundsResponse.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * 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.js';
+import type { CovalPersonasAPIBackgroundSoundResource } from './CovalPersonasAPIBackgroundSoundResource.js';
+import {
+    CovalPersonasAPIBackgroundSoundResourceFromJSON,
+    CovalPersonasAPIBackgroundSoundResourceFromJSONTyped,
+    CovalPersonasAPIBackgroundSoundResourceToJSON,
+    CovalPersonasAPIBackgroundSoundResourceToJSONTyped,
+} from './CovalPersonasAPIBackgroundSoundResource.js';
+
+/**
+ * 
+ * @export
+ * @interface CovalPersonasAPIListBackgroundSoundsResponse
+ */
+export interface CovalPersonasAPIListBackgroundSoundsResponse {
+    /**
+     * 
+     * @type {Array<CovalPersonasAPIBackgroundSoundResource>}
+     * @memberof CovalPersonasAPIListBackgroundSoundsResponse
+     */
+    background_sounds: Array<CovalPersonasAPIBackgroundSoundResource>;
+}
+
+/**
+ * Check if a given object implements the CovalPersonasAPIListBackgroundSoundsResponse interface.
+ */
+export function instanceOfCovalPersonasAPIListBackgroundSoundsResponse(value: object): value is CovalPersonasAPIListBackgroundSoundsResponse {
+    if (!('background_sounds' in value) || value['background_sounds'] === undefined) return false;
+    return true;
+}
+
+export function CovalPersonasAPIListBackgroundSoundsResponseFromJSON(json: any): CovalPersonasAPIListBackgroundSoundsResponse {
+    return CovalPersonasAPIListBackgroundSoundsResponseFromJSONTyped(json, false);
+}
+
+export function CovalPersonasAPIListBackgroundSoundsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CovalPersonasAPIListBackgroundSoundsResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'background_sounds': ((json['background_sounds'] as Array<any>).map(CovalPersonasAPIBackgroundSoundResourceFromJSON)),
+    };
+}
+
+export function CovalPersonasAPIListBackgroundSoundsResponseToJSON(json: any): CovalPersonasAPIListBackgroundSoundsResponse {
+    return CovalPersonasAPIListBackgroundSoundsResponseToJSONTyped(json, false);
+}
+
+export function CovalPersonasAPIListBackgroundSoundsResponseToJSONTyped(value?: CovalPersonasAPIListBackgroundSoundsResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'background_sounds': ((value['background_sounds'] as Array<any>).map(CovalPersonasAPIBackgroundSoundResourceToJSON)),
+    };
+}
+

package/src/generated/models/CovalPersonasAPIListPersonaTagsResponse.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * 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.js';
+import type { CovalPersonasAPIPersonaTagResource } from './CovalPersonasAPIPersonaTagResource.js';
+import {
+    CovalPersonasAPIPersonaTagResourceFromJSON,
+    CovalPersonasAPIPersonaTagResourceFromJSONTyped,
+    CovalPersonasAPIPersonaTagResourceToJSON,
+    CovalPersonasAPIPersonaTagResourceToJSONTyped,
+} from './CovalPersonasAPIPersonaTagResource.js';
+
+/**
+ * 
+ * @export
+ * @interface CovalPersonasAPIListPersonaTagsResponse
+ */
+export interface CovalPersonasAPIListPersonaTagsResponse {
+    /**
+     * 
+     * @type {Array<CovalPersonasAPIPersonaTagResource>}
+     * @memberof CovalPersonasAPIListPersonaTagsResponse
+     */
+    tags: Array<CovalPersonasAPIPersonaTagResource>;
+}
+
+/**
+ * Check if a given object implements the CovalPersonasAPIListPersonaTagsResponse interface.
+ */
+export function instanceOfCovalPersonasAPIListPersonaTagsResponse(value: object): value is CovalPersonasAPIListPersonaTagsResponse {
+    if (!('tags' in value) || value['tags'] === undefined) return false;
+    return true;
+}
+
+export function CovalPersonasAPIListPersonaTagsResponseFromJSON(json: any): CovalPersonasAPIListPersonaTagsResponse {
+    return CovalPersonasAPIListPersonaTagsResponseFromJSONTyped(json, false);
+}
+
+export function CovalPersonasAPIListPersonaTagsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CovalPersonasAPIListPersonaTagsResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'tags': ((json['tags'] as Array<any>).map(CovalPersonasAPIPersonaTagResourceFromJSON)),
+    };
+}
+
+export function CovalPersonasAPIListPersonaTagsResponseToJSON(json: any): CovalPersonasAPIListPersonaTagsResponse {
+    return CovalPersonasAPIListPersonaTagsResponseToJSONTyped(json, false);
+}
+
+export function CovalPersonasAPIListPersonaTagsResponseToJSONTyped(value?: CovalPersonasAPIListPersonaTagsResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'tags': ((value['tags'] as Array<any>).map(CovalPersonasAPIPersonaTagResourceToJSON)),
+    };
+}
+

package/src/generated/models/CovalPersonasAPIListPersonaVersionsResponse.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * 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.js';
+import type { CovalPersonasAPIPersonaVersionResource } from './CovalPersonasAPIPersonaVersionResource.js';
+import {
+    CovalPersonasAPIPersonaVersionResourceFromJSON,
+    CovalPersonasAPIPersonaVersionResourceFromJSONTyped,
+    CovalPersonasAPIPersonaVersionResourceToJSON,
+    CovalPersonasAPIPersonaVersionResourceToJSONTyped,
+} from './CovalPersonasAPIPersonaVersionResource.js';
+
+/**
+ * Response for GET /v1/personas/{persona_id}/versions (newest first)
+ * @export
+ * @interface CovalPersonasAPIListPersonaVersionsResponse
+ */
+export interface CovalPersonasAPIListPersonaVersionsResponse {
+    /**
+     * 
+     * @type {Array<CovalPersonasAPIPersonaVersionResource>}
+     * @memberof CovalPersonasAPIListPersonaVersionsResponse
+     */
+    versions: Array<CovalPersonasAPIPersonaVersionResource>;
+}
+
+/**
+ * Check if a given object implements the CovalPersonasAPIListPersonaVersionsResponse interface.
+ */
+export function instanceOfCovalPersonasAPIListPersonaVersionsResponse(value: object): value is CovalPersonasAPIListPersonaVersionsResponse {
+    if (!('versions' in value) || value['versions'] === undefined) return false;
+    return true;
+}
+
+export function CovalPersonasAPIListPersonaVersionsResponseFromJSON(json: any): CovalPersonasAPIListPersonaVersionsResponse {
+    return CovalPersonasAPIListPersonaVersionsResponseFromJSONTyped(json, false);
+}
+
+export function CovalPersonasAPIListPersonaVersionsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CovalPersonasAPIListPersonaVersionsResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'versions': ((json['versions'] as Array<any>).map(CovalPersonasAPIPersonaVersionResourceFromJSON)),
+    };
+}
+
+export function CovalPersonasAPIListPersonaVersionsResponseToJSON(json: any): CovalPersonasAPIListPersonaVersionsResponse {
+    return CovalPersonasAPIListPersonaVersionsResponseToJSONTyped(json, false);
+}
+
+export function CovalPersonasAPIListPersonaVersionsResponseToJSONTyped(value?: CovalPersonasAPIListPersonaVersionsResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'versions': ((value['versions'] as Array<any>).map(CovalPersonasAPIPersonaVersionResourceToJSON)),
+    };
+}
+

package/src/generated/models/CovalPersonasAPIPersonaResource.ts

@@ -61,11 +61,11 @@ export interface CovalPersonasAPIPersonaResource {
      */
     language_code?: string | null;
     /**
-     * Background noise type
-     * @type {CovalPersonasAPIPersonaResourceBackgroundSoundEnum}
+     * Built-in background sound id, or custom:<background_sound_id> for an active custom sound returned by GET /personas/background-sounds.
+     * @type {string}
      * @memberof CovalPersonasAPIPersonaResource
      */
-    background_sound?: CovalPersonasAPIPersonaResourceBackgroundSoundEnum | null;
+    background_sound?: string | null;
     /**
      * Volume level for background sound (>= 0.0, no upper limit). Default is provider-controlled when omitted.
      * @type {number}
@@ -112,6 +112,21 @@ export interface CovalPersonasAPIPersonaResource {
      * @memberof CovalPersonasAPIPersonaResource
      */
     hold_music_timeout_seconds?: number | null;
+    /**
+     * Persona placement preset.
+     * - speakerphone-easy: User speaking from a distance from the microphone
+     * - speakerphone-hard: User speaking from a distance from the microphone in an acoustically challenging environment.
+     * 
+     * @type {CovalPersonasAPIPersonaResourceSituateSpeakerEnum}
+     * @memberof CovalPersonasAPIPersonaResource
+     */
+    situate_speaker?: CovalPersonasAPIPersonaResourceSituateSpeakerEnum | null;
+    /**
+     * Tags associated with this persona
+     * @type {Array<string>}
+     * @memberof CovalPersonasAPIPersonaResource
+     */
+    tags?: Array<string>;
     /**
      * Persona creation timestamp (ISO 8601)
      * @type {Date}
@@ -130,38 +145,20 @@ export interface CovalPersonasAPIPersonaResource {
 /**
  * @export
  */
-export const CovalPersonasAPIPersonaResourceBackgroundSoundEnum = {
-    Off: 'off',
-    Office: 'office',
-    Lounge: 'lounge',
-    Crowd: 'crowd',
-    Airport: 'airport',
-    Bus: 'bus',
-    Playground: 'playground',
-    Doorbell: 'doorbell',
-    TrainArrival: 'train-arrival',
-    PortableAirConditioner: 'portable-air-conditioner',
-    Skatepark: 'skatepark',
-    SmallDogBark: 'small-dog-bark',
-    Cafe: 'cafe',
-    FerryAndAnnouncement: 'ferry-and-announcement',
-    HeavyRain: 'heavy-rain',
-    ModerateWind: 'moderate-wind',
-    NewbornBabyCrying: 'newborn-baby-crying',
-    OfficeWithAlarm: 'office-with-alarm',
-    StreetWithSirens: 'street-with-sirens',
-    ConstructionWork: 'construction-work'
+export const CovalPersonasAPIPersonaResourceConversationInitiationEnum = {
+    SpeakFirst: 'speak_first',
+    WaitForUser: 'wait_for_user'
 } as const;
-export type CovalPersonasAPIPersonaResourceBackgroundSoundEnum = typeof CovalPersonasAPIPersonaResourceBackgroundSoundEnum[keyof typeof CovalPersonasAPIPersonaResourceBackgroundSoundEnum];
+export type CovalPersonasAPIPersonaResourceConversationInitiationEnum = typeof CovalPersonasAPIPersonaResourceConversationInitiationEnum[keyof typeof CovalPersonasAPIPersonaResourceConversationInitiationEnum];
 
 /**
  * @export
  */
-export const CovalPersonasAPIPersonaResourceConversationInitiationEnum = {
-    SpeakFirst: 'speak_first',
-    WaitForUser: 'wait_for_user'
+export const CovalPersonasAPIPersonaResourceSituateSpeakerEnum = {
+    SpeakerphoneEasy: 'speakerphone-easy',
+    SpeakerphoneHard: 'speakerphone-hard'
 } as const;
-export type CovalPersonasAPIPersonaResourceConversationInitiationEnum = typeof CovalPersonasAPIPersonaResourceConversationInitiationEnum[keyof typeof CovalPersonasAPIPersonaResourceConversationInitiationEnum];
+export type CovalPersonasAPIPersonaResourceSituateSpeakerEnum = typeof CovalPersonasAPIPersonaResourceSituateSpeakerEnum[keyof typeof CovalPersonasAPIPersonaResourceSituateSpeakerEnum];
 
 
 /**
@@ -199,6 +196,8 @@ export function CovalPersonasAPIPersonaResourceFromJSONTyped(json: any, ignoreDi
         'conversation_initiation': json['conversation_initiation'] == null ? undefined : json['conversation_initiation'],
         'multi_language_stt': json['multi_language_stt'] == null ? undefined : json['multi_language_stt'],
         'hold_music_timeout_seconds': json['hold_music_timeout_seconds'] == null ? undefined : json['hold_music_timeout_seconds'],
+        'situate_speaker': json['situate_speaker'] == null ? undefined : json['situate_speaker'],
+        'tags': json['tags'] == null ? undefined : json['tags'],
         'create_time': (new Date(json['create_time'])),
         'update_time': json['update_time'] == null ? undefined : (new Date(json['update_time'])),
     };
@@ -229,6 +228,8 @@ export function CovalPersonasAPIPersonaResourceToJSONTyped(value?: CovalPersonas
         'conversation_initiation': value['conversation_initiation'],
         'multi_language_stt': value['multi_language_stt'],
         'hold_music_timeout_seconds': value['hold_music_timeout_seconds'],
+        'situate_speaker': value['situate_speaker'],
+        'tags': value['tags'],
         'create_time': value['create_time'].toISOString(),
         'update_time': value['update_time'] == null ? value['update_time'] : value['update_time'].toISOString(),
     };

package/src/generated/models/CovalPersonasAPIPersonaTagResource.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * 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.js';
+/**
+ * 
+ * @export
+ * @interface CovalPersonasAPIPersonaTagResource
+ */
+export interface CovalPersonasAPIPersonaTagResource {
+    /**
+     * The tag value.
+     * @type {string}
+     * @memberof CovalPersonasAPIPersonaTagResource
+     */
+    tag: string;
+    /**
+     * Always null on the public API (tag colors are UI-only).
+     * @type {string}
+     * @memberof CovalPersonasAPIPersonaTagResource
+     */
+    color?: string | null;
+}
+
+/**
+ * Check if a given object implements the CovalPersonasAPIPersonaTagResource interface.
+ */
+export function instanceOfCovalPersonasAPIPersonaTagResource(value: object): value is CovalPersonasAPIPersonaTagResource {
+    if (!('tag' in value) || value['tag'] === undefined) return false;
+    return true;
+}
+
+export function CovalPersonasAPIPersonaTagResourceFromJSON(json: any): CovalPersonasAPIPersonaTagResource {
+    return CovalPersonasAPIPersonaTagResourceFromJSONTyped(json, false);
+}
+
+export function CovalPersonasAPIPersonaTagResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): CovalPersonasAPIPersonaTagResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'tag': json['tag'],
+        'color': json['color'] == null ? undefined : json['color'],
+    };
+}
+
+export function CovalPersonasAPIPersonaTagResourceToJSON(json: any): CovalPersonasAPIPersonaTagResource {
+    return CovalPersonasAPIPersonaTagResourceToJSONTyped(json, false);
+}
+
+export function CovalPersonasAPIPersonaTagResourceToJSONTyped(value?: CovalPersonasAPIPersonaTagResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'tag': value['tag'],
+        'color': value['color'],
+    };
+}
+

package/src/generated/models/CovalPersonasAPIPersonaVersionResource.ts

@@ -0,0 +1,161 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * 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.js';
+/**
+ * A prior, displaced snapshot of a persona's behavioral config.
+ * @export
+ * @interface CovalPersonasAPIPersonaVersionResource
+ */
+export interface CovalPersonasAPIPersonaVersionResource {
+    /**
+     * Resource name
+     * @type {string}
+     * @memberof CovalPersonasAPIPersonaVersionResource
+     */
+    name: string;
+    /**
+     * Version identifier (26-char ULID)
+     * @type {string}
+     * @memberof CovalPersonasAPIPersonaVersionResource
+     */
+    ulid: string;
+    /**
+     * Per-persona monotonic version number, 1-based
+     * @type {number}
+     * @memberof CovalPersonasAPIPersonaVersionResource
+     */
+    version_number: number;
+    /**
+     * How this version came about. A revert is a save whose new state mirrors an older version.
+     * @type {CovalPersonasAPIPersonaVersionResourceChangeTypeEnum}
+     * @memberof CovalPersonasAPIPersonaVersionResource
+     */
+    change_type: CovalPersonasAPIPersonaVersionResourceChangeTypeEnum;
+    /**
+     * Optional user-supplied tag
+     * @type {string}
+     * @memberof CovalPersonasAPIPersonaVersionResource
+     */
+    label?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CovalPersonasAPIPersonaVersionResource
+     */
+    persona_prompt?: string | null;
+    /**
+     * Verbatim behavioral-config snapshot
+     * @type {{ [key: string]: any; }}
+     * @memberof CovalPersonasAPIPersonaVersionResource
+     */
+    metadata?: { [key: string]: any; };
+    /**
+     * 
+     * @type {string}
+     * @memberof CovalPersonasAPIPersonaVersionResource
+     */
+    voice_name?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CovalPersonasAPIPersonaVersionResource
+     */
+    language_code?: string | null;
+    /**
+     * Who created this version (user ULID)
+     * @type {string}
+     * @memberof CovalPersonasAPIPersonaVersionResource
+     */
+    created_by: string;
+    /**
+     * When this version became current
+     * @type {Date}
+     * @memberof CovalPersonasAPIPersonaVersionResource
+     */
+    create_time?: Date | null;
+}
+
+
+/**
+ * @export
+ */
+export const CovalPersonasAPIPersonaVersionResourceChangeTypeEnum = {
+    Save: 'save',
+    Revert: 'revert'
+} as const;
+export type CovalPersonasAPIPersonaVersionResourceChangeTypeEnum = typeof CovalPersonasAPIPersonaVersionResourceChangeTypeEnum[keyof typeof CovalPersonasAPIPersonaVersionResourceChangeTypeEnum];
+
+
+/**
+ * Check if a given object implements the CovalPersonasAPIPersonaVersionResource interface.
+ */
+export function instanceOfCovalPersonasAPIPersonaVersionResource(value: object): value is CovalPersonasAPIPersonaVersionResource {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('ulid' in value) || value['ulid'] === undefined) return false;
+    if (!('version_number' in value) || value['version_number'] === undefined) return false;
+    if (!('change_type' in value) || value['change_type'] === undefined) return false;
+    if (!('created_by' in value) || value['created_by'] === undefined) return false;
+    return true;
+}
+
+export function CovalPersonasAPIPersonaVersionResourceFromJSON(json: any): CovalPersonasAPIPersonaVersionResource {
+    return CovalPersonasAPIPersonaVersionResourceFromJSONTyped(json, false);
+}
+
+export function CovalPersonasAPIPersonaVersionResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): CovalPersonasAPIPersonaVersionResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'ulid': json['ulid'],
+        'version_number': json['version_number'],
+        'change_type': json['change_type'],
+        'label': json['label'] == null ? undefined : json['label'],
+        'persona_prompt': json['persona_prompt'] == null ? undefined : json['persona_prompt'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+        'voice_name': json['voice_name'] == null ? undefined : json['voice_name'],
+        'language_code': json['language_code'] == null ? undefined : json['language_code'],
+        'created_by': json['created_by'],
+        'create_time': json['create_time'] == null ? undefined : (new Date(json['create_time'])),
+    };
+}
+
+export function CovalPersonasAPIPersonaVersionResourceToJSON(json: any): CovalPersonasAPIPersonaVersionResource {
+    return CovalPersonasAPIPersonaVersionResourceToJSONTyped(json, false);
+}
+
+export function CovalPersonasAPIPersonaVersionResourceToJSONTyped(value?: CovalPersonasAPIPersonaVersionResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'ulid': value['ulid'],
+        'version_number': value['version_number'],
+        'change_type': value['change_type'],
+        'label': value['label'],
+        'persona_prompt': value['persona_prompt'],
+        'metadata': value['metadata'],
+        'voice_name': value['voice_name'],
+        'language_code': value['language_code'],
+        'created_by': value['created_by'],
+        'create_time': value['create_time'] == null ? value['create_time'] : value['create_time'].toISOString(),
+    };
+}
+

package/src/generated/models/CovalPersonasAPIUpdateBackgroundSoundRequest.ts

@@ -0,0 +1,112 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * 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.js';
+/**
+ * All fields are optional. Send status=archived to archive or status=active to restore.
+ * @export
+ * @interface CovalPersonasAPIUpdateBackgroundSoundRequest
+ */
+export interface CovalPersonasAPIUpdateBackgroundSoundRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof CovalPersonasAPIUpdateBackgroundSoundRequest
+     */
+    display_name?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof CovalPersonasAPIUpdateBackgroundSoundRequest
+     */
+    default_volume?: number;
+    /**
+     * Acoustic rendering behavior for this sound.
+     * - ambient: mixed like room ambience.
+     * - point_source: rendered from a specific location when a situate_speaker preset is set; otherwise mixed like ambient.
+     * 
+     * @type {CovalPersonasAPIUpdateBackgroundSoundRequestAcousticSourceTypeEnum}
+     * @memberof CovalPersonasAPIUpdateBackgroundSoundRequest
+     */
+    acoustic_source_type?: CovalPersonasAPIUpdateBackgroundSoundRequestAcousticSourceTypeEnum | null;
+    /**
+     * 
+     * @type {CovalPersonasAPIUpdateBackgroundSoundRequestStatusEnum}
+     * @memberof CovalPersonasAPIUpdateBackgroundSoundRequest
+     */
+    status?: CovalPersonasAPIUpdateBackgroundSoundRequestStatusEnum;
+}
+
+
+/**
+ * @export
+ */
+export const CovalPersonasAPIUpdateBackgroundSoundRequestAcousticSourceTypeEnum = {
+    Ambient: 'ambient',
+    PointSource: 'point_source'
+} as const;
+export type CovalPersonasAPIUpdateBackgroundSoundRequestAcousticSourceTypeEnum = typeof CovalPersonasAPIUpdateBackgroundSoundRequestAcousticSourceTypeEnum[keyof typeof CovalPersonasAPIUpdateBackgroundSoundRequestAcousticSourceTypeEnum];
+
+/**
+ * @export
+ */
+export const CovalPersonasAPIUpdateBackgroundSoundRequestStatusEnum = {
+    Active: 'active',
+    Archived: 'archived'
+} as const;
+export type CovalPersonasAPIUpdateBackgroundSoundRequestStatusEnum = typeof CovalPersonasAPIUpdateBackgroundSoundRequestStatusEnum[keyof typeof CovalPersonasAPIUpdateBackgroundSoundRequestStatusEnum];
+
+
+/**
+ * Check if a given object implements the CovalPersonasAPIUpdateBackgroundSoundRequest interface.
+ */
+export function instanceOfCovalPersonasAPIUpdateBackgroundSoundRequest(value: object): value is CovalPersonasAPIUpdateBackgroundSoundRequest {
+    return true;
+}
+
+export function CovalPersonasAPIUpdateBackgroundSoundRequestFromJSON(json: any): CovalPersonasAPIUpdateBackgroundSoundRequest {
+    return CovalPersonasAPIUpdateBackgroundSoundRequestFromJSONTyped(json, false);
+}
+
+export function CovalPersonasAPIUpdateBackgroundSoundRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CovalPersonasAPIUpdateBackgroundSoundRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'display_name': json['display_name'] == null ? undefined : json['display_name'],
+        'default_volume': json['default_volume'] == null ? undefined : json['default_volume'],
+        'acoustic_source_type': json['acoustic_source_type'] == null ? undefined : json['acoustic_source_type'],
+        'status': json['status'] == null ? undefined : json['status'],
+    };
+}
+
+export function CovalPersonasAPIUpdateBackgroundSoundRequestToJSON(json: any): CovalPersonasAPIUpdateBackgroundSoundRequest {
+    return CovalPersonasAPIUpdateBackgroundSoundRequestToJSONTyped(json, false);
+}
+
+export function CovalPersonasAPIUpdateBackgroundSoundRequestToJSONTyped(value?: CovalPersonasAPIUpdateBackgroundSoundRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'display_name': value['display_name'],
+        'default_volume': value['default_volume'],
+        'acoustic_source_type': value['acoustic_source_type'],
+        'status': value['status'],
+    };
+}
+