hume 0.11.5-beta.1 → 0.12.0

package/.mock/definition/empathic-voice/customVoices.yml

@@ -1,283 +0,0 @@
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    list-custom-voices:
-      path: /v0/evi/custom_voices
-      method: GET
-      auth: true
-      docs: >-
-        Fetches a paginated list of **Custom Voices**.
-
-
-        Refer to our [voices
-        guide](/docs/empathic-voice-interface-evi/configuration/voices) for
-        details on creating a custom voice.
-      pagination:
-        offset: $request.page_number
-        results: $response.custom_voices_page
-      source:
-        openapi: evi-openapi.json
-      display-name: List custom voices
-      request:
-        name: CustomVoicesListCustomVoicesRequest
-        query-parameters:
-          page_number:
-            type: optional<integer>
-            default: 0
-            docs: >-
-              Specifies the page number to retrieve, enabling pagination.
-
-
-              This parameter uses zero-based indexing. For example, setting
-              `page_number` to 0 retrieves the first page of results (items 0-9
-              if `page_size` is 10), setting `page_number` to 1 retrieves the
-              second page (items 10-19), and so on. Defaults to 0, which
-              retrieves the first page.
-          page_size:
-            type: optional<integer>
-            docs: >-
-              Specifies the maximum number of results to include per page,
-              enabling pagination. The value must be between 1 and 100,
-              inclusive.
-
-
-              For example, if `page_size` is set to 10, each page will include
-              up to 10 items. Defaults to 10.
-          name:
-            type: optional<string>
-            docs: Filter to only include custom voices with name.
-      response:
-        docs: Success
-        type: root.ReturnPagedCustomVoices
-        status-code: 200
-      errors:
-        - root.BadRequestError
-      examples:
-        - response:
-            body:
-              page_number: 1
-              page_size: 1
-              total_pages: 1
-              custom_voices_page:
-                - id: id
-                  version: 1
-                  name: name
-                  created_on: 1000000
-                  modified_on: 1000000
-                  base_voice: ITO
-                  parameter_model: 20241004-11parameter
-                  parameters: {}
-    create-custom-voice:
-      path: /v0/evi/custom_voices
-      method: POST
-      auth: true
-      docs: >-
-        Creates a **Custom Voice** that can be added to an [EVI
-        configuration](/reference/empathic-voice-interface-evi/configs/create-config).
-
-
-        Refer to our [voices
-        guide](/docs/empathic-voice-interface-evi/configuration/voices) for
-        details on creating a custom voice.
-      source:
-        openapi: evi-openapi.json
-      display-name: Create custom voice
-      request:
-        body: root.PostedCustomVoice
-        content-type: application/json
-      response:
-        docs: Created
-        type: root.ReturnCustomVoice
-        status-code: 201
-      errors:
-        - root.BadRequestError
-      examples:
-        - request:
-            name: name
-            base_voice: ITO
-            parameter_model: 20241004-11parameter
-          response:
-            body:
-              id: id
-              version: 1
-              name: name
-              created_on: 1000000
-              modified_on: 1000000
-              base_voice: ITO
-              parameter_model: 20241004-11parameter
-              parameters:
-                gender: 1
-                assertiveness: 1
-                buoyancy: 1
-                confidence: 1
-                enthusiasm: 1
-                nasality: 1
-                relaxedness: 1
-                smoothness: 1
-                tepidity: 1
-                tightness: 1
-    get-custom-voice:
-      path: /v0/evi/custom_voices/{id}
-      method: GET
-      auth: true
-      docs: >-
-        Fetches a specific **Custom Voice** by ID.
-
-
-        Refer to our [voices
-        guide](/docs/empathic-voice-interface-evi/configuration/voices) for
-        details on creating a custom voice.
-      source:
-        openapi: evi-openapi.json
-      path-parameters:
-        id:
-          type: string
-          docs: Identifier for a Custom Voice. Formatted as a UUID.
-      display-name: Get specific custom voice by ID
-      response:
-        docs: Success
-        type: root.ReturnCustomVoice
-        status-code: 200
-      errors:
-        - root.BadRequestError
-      examples:
-        - path-parameters:
-            id: id
-          response:
-            body:
-              id: id
-              version: 1
-              name: name
-              created_on: 1000000
-              modified_on: 1000000
-              base_voice: ITO
-              parameter_model: 20241004-11parameter
-              parameters:
-                gender: 1
-                assertiveness: 1
-                buoyancy: 1
-                confidence: 1
-                enthusiasm: 1
-                nasality: 1
-                relaxedness: 1
-                smoothness: 1
-                tepidity: 1
-                tightness: 1
-    create-custom-voice-version:
-      path: /v0/evi/custom_voices/{id}
-      method: POST
-      auth: true
-      docs: >-
-        Updates a **Custom Voice** by creating a new version of the **Custom
-        Voice**.
-
-
-        Refer to our [voices
-        guide](/docs/empathic-voice-interface-evi/configuration/voices) for
-        details on creating a custom voice.
-      source:
-        openapi: evi-openapi.json
-      path-parameters:
-        id:
-          type: string
-          docs: Identifier for a Custom Voice. Formatted as a UUID.
-      display-name: Create new version of existing custom voice
-      request:
-        body: root.PostedCustomVoice
-        content-type: application/json
-      response:
-        docs: Created
-        type: root.ReturnCustomVoice
-        status-code: 201
-      errors:
-        - root.BadRequestError
-      examples:
-        - path-parameters:
-            id: id
-          request:
-            name: name
-            base_voice: ITO
-            parameter_model: 20241004-11parameter
-          response:
-            body:
-              id: id
-              version: 1
-              name: name
-              created_on: 1000000
-              modified_on: 1000000
-              base_voice: ITO
-              parameter_model: 20241004-11parameter
-              parameters:
-                gender: 1
-                assertiveness: 1
-                buoyancy: 1
-                confidence: 1
-                enthusiasm: 1
-                nasality: 1
-                relaxedness: 1
-                smoothness: 1
-                tepidity: 1
-                tightness: 1
-    delete-custom-voice:
-      path: /v0/evi/custom_voices/{id}
-      method: DELETE
-      auth: true
-      docs: >-
-        Deletes a **Custom Voice** and its versions.
-
-
-        Refer to our [voices
-        guide](/docs/empathic-voice-interface-evi/configuration/voices) for
-        details on creating a custom voice.
-      source:
-        openapi: evi-openapi.json
-      path-parameters:
-        id:
-          type: string
-          docs: Identifier for a Custom Voice. Formatted as a UUID.
-      display-name: Delete a custom voice
-      errors:
-        - root.BadRequestError
-      examples:
-        - path-parameters:
-            id: id
-    update-custom-voice-name:
-      path: /v0/evi/custom_voices/{id}
-      method: PATCH
-      auth: true
-      docs: >-
-        Updates the name of a **Custom Voice**.
-
-
-        Refer to our [voices
-        guide](/docs/empathic-voice-interface-evi/configuration/voices) for
-        details on creating a custom voice.
-      source:
-        openapi: evi-openapi.json
-      path-parameters:
-        id:
-          type: string
-          docs: Identifier for a Custom Voice. Formatted as a UUID.
-      display-name: Update custom voice name
-      request:
-        name: PostedCustomVoiceName
-        body:
-          properties:
-            name:
-              type: string
-              docs: >-
-                The name of the Custom Voice. Maximum length of 75 characters.
-                Will be converted to all-uppercase. (e.g., "sample voice"
-                becomes "SAMPLE VOICE")
-        content-type: application/json
-      response:
-        docs: Success
-        type: text
-        status-code: 200
-      errors:
-        - root.BadRequestError
-  source:
-    openapi: evi-openapi.json

package/api/resources/empathicVoice/resources/customVoices/client/Client.d.ts

@@ -1,135 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../../../environments";
-import * as core from "../../../../../../core";
-import * as Hume from "../../../../../index";
-export declare namespace CustomVoices {
-    interface Options {
-        environment?: core.Supplier<environments.HumeEnvironment | string>;
-        /** Specify a custom URL to connect the client to. */
-        baseUrl?: core.Supplier<string>;
-        apiKey?: core.Supplier<string | undefined>;
-        /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
-        fetcher?: core.FetchFunction;
-    }
-    interface RequestOptions {
-        /** The maximum time to wait for a response in seconds. */
-        timeoutInSeconds?: number;
-        /** The number of times to retry the request. Defaults to 2. */
-        maxRetries?: number;
-        /** A hook to abort the request. */
-        abortSignal?: AbortSignal;
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
-    }
-}
-export declare class CustomVoices {
-    protected readonly _options: CustomVoices.Options;
-    constructor(_options?: CustomVoices.Options);
-    /**
-     * Fetches a paginated list of **Custom Voices**.
-     *
-     * Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
-     *
-     * @param {Hume.empathicVoice.CustomVoicesListCustomVoicesRequest} request
-     * @param {CustomVoices.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Hume.empathicVoice.BadRequestError}
-     *
-     * @example
-     *     await client.empathicVoice.customVoices.listCustomVoices()
-     */
-    listCustomVoices(request?: Hume.empathicVoice.CustomVoicesListCustomVoicesRequest, requestOptions?: CustomVoices.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnCustomVoice>>;
-    /**
-     * Creates a **Custom Voice** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
-     *
-     * Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
-     *
-     * @param {Hume.empathicVoice.PostedCustomVoice} request
-     * @param {CustomVoices.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Hume.empathicVoice.BadRequestError}
-     *
-     * @example
-     *     await client.empathicVoice.customVoices.createCustomVoice({
-     *         name: "name",
-     *         baseVoice: "ITO",
-     *         parameterModel: "20241004-11parameter"
-     *     })
-     */
-    createCustomVoice(request: Hume.empathicVoice.PostedCustomVoice, requestOptions?: CustomVoices.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnCustomVoice>;
-    private __createCustomVoice;
-    /**
-     * Fetches a specific **Custom Voice** by ID.
-     *
-     * Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
-     *
-     * @param {string} id - Identifier for a Custom Voice. Formatted as a UUID.
-     * @param {CustomVoices.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Hume.empathicVoice.BadRequestError}
-     *
-     * @example
-     *     await client.empathicVoice.customVoices.getCustomVoice("id")
-     */
-    getCustomVoice(id: string, requestOptions?: CustomVoices.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnCustomVoice>;
-    private __getCustomVoice;
-    /**
-     * Updates a **Custom Voice** by creating a new version of the **Custom Voice**.
-     *
-     * Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
-     *
-     * @param {string} id - Identifier for a Custom Voice. Formatted as a UUID.
-     * @param {Hume.empathicVoice.PostedCustomVoice} request
-     * @param {CustomVoices.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Hume.empathicVoice.BadRequestError}
-     *
-     * @example
-     *     await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
-     *         name: "name",
-     *         baseVoice: "ITO",
-     *         parameterModel: "20241004-11parameter"
-     *     })
-     */
-    createCustomVoiceVersion(id: string, request: Hume.empathicVoice.PostedCustomVoice, requestOptions?: CustomVoices.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnCustomVoice>;
-    private __createCustomVoiceVersion;
-    /**
-     * Deletes a **Custom Voice** and its versions.
-     *
-     * Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
-     *
-     * @param {string} id - Identifier for a Custom Voice. Formatted as a UUID.
-     * @param {CustomVoices.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Hume.empathicVoice.BadRequestError}
-     *
-     * @example
-     *     await client.empathicVoice.customVoices.deleteCustomVoice("id")
-     */
-    deleteCustomVoice(id: string, requestOptions?: CustomVoices.RequestOptions): core.HttpResponsePromise<void>;
-    private __deleteCustomVoice;
-    /**
-     * Updates the name of a **Custom Voice**.
-     *
-     * Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
-     *
-     * @param {string} id - Identifier for a Custom Voice. Formatted as a UUID.
-     * @param {Hume.empathicVoice.PostedCustomVoiceName} request
-     * @param {CustomVoices.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Hume.empathicVoice.BadRequestError}
-     *
-     * @example
-     *     await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
-     *         name: "name"
-     *     })
-     */
-    updateCustomVoiceName(id: string, request: Hume.empathicVoice.PostedCustomVoiceName, requestOptions?: CustomVoices.RequestOptions): core.HttpResponsePromise<string>;
-    private __updateCustomVoiceName;
-    protected _getCustomAuthorizationHeaders(): Promise<{
-        "X-Hume-Api-Key": string | undefined;
-    }>;
-}