@elevenlabs/elevenlabs-js 2.2.0 → 2.3.0

package/.mock/definition/history.yml

@@ -1,270 +0,0 @@
-types:
-  HistoryListRequestSource:
-    enum:
-      - TTS
-      - STS
-    source:
-      openapi: openapi.json
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    list:
-      path: /v1/history
-      method: GET
-      auth: false
-      docs: Returns a list of your generated audio.
-      source:
-        openapi: openapi.json
-      display-name: Get generated items
-      request:
-        name: HistoryListRequest
-        query-parameters:
-          page_size:
-            type: optional<integer>
-            default: 100
-            docs: >-
-              How many history items to return at maximum. Can not exceed 1000,
-              defaults to 100.
-          start_after_history_item_id:
-            type: optional<string>
-            docs: >-
-              After which ID to start fetching, use this parameter to paginate
-              across a large collection of history items. In case this parameter
-              is not provided history items will be fetched starting from the
-              most recently created one ordered descending by their creation
-              date.
-          voice_id:
-            type: optional<string>
-            docs: >-
-              ID of the voice to be filtered for. You can use the [Get
-              voices](/docs/api-reference/voices/search) endpoint list all the
-              available voices.
-          search:
-            type: optional<string>
-            docs: >-
-              Search term used for filtering history items. If provided, source
-              becomes required.
-          source:
-            type: optional<HistoryListRequestSource>
-            docs: Source of the generated history item
-      response:
-        docs: Successful Response
-        type: root.GetSpeechHistoryResponse
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - response:
-            body:
-              history:
-                - history_item_id: ja9xsmfGhxYcymxGcOGB
-                  request_id: BF0BZg4IwLGBlaVjv9Im
-                  voice_id: 21m00Tcm4TlvDq8ikWAM
-                  model_id: eleven_multilingual_v2
-                  voice_name: Rachel
-                  voice_category: premade
-                  text: Hello, world!
-                  date_unix: 1714650306
-                  character_count_change_from: 17189
-                  character_count_change_to: 17231
-                  content_type: audio/mpeg
-                  state: created
-                  settings:
-                    similarity_boost: 0.5
-                    stability: 0.71
-                    style: 0
-                    use_speaker_boost: true
-                  feedback:
-                    thumbs_up: true
-                    feedback: This is an example of test feedback.
-                    emotions: true
-                    inaccurate_clone: false
-                    glitches: true
-                    audio_quality: true
-                    other: false
-                    review_status: not_reviewed
-                  share_link_id: share_link_id
-                  source: TTS
-                  alignments:
-                    alignment:
-                      characters:
-                        - characters
-                      character_start_times_seconds:
-                        - 1.1
-                      character_end_times_seconds:
-                        - 1.1
-                    normalized_alignment:
-                      characters:
-                        - characters
-                      character_start_times_seconds:
-                        - 1.1
-                      character_end_times_seconds:
-                        - 1.1
-                  dialogue:
-                    - text: text
-                      voice_id: voice_id
-                      voice_name: voice_name
-              last_history_item_id: ja9xsmfGhxYcymxGcOGB
-              has_more: true
-    get:
-      path: /v1/history/{history_item_id}
-      method: GET
-      auth: false
-      docs: Retrieves a history item.
-      source:
-        openapi: openapi.json
-      path-parameters:
-        history_item_id:
-          type: string
-          docs: >-
-            ID of the history item to be used. You can use the [Get generated
-            items](/docs/api-reference/history/get-all) endpoint to retrieve a
-            list of history items.
-      display-name: Get history item
-      response:
-        docs: Successful Response
-        type: root.SpeechHistoryItemResponse
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - path-parameters:
-            history_item_id: VW7YKqPnjY4h39yTbx2L
-          response:
-            body:
-              history_item_id: ja9xsmfGhxYcymxGcOGB
-              request_id: BF0BZg4IwLGBlaVjv9Im
-              voice_id: 21m00Tcm4TlvDq8ikWAM
-              model_id: eleven_multilingual_v2
-              voice_name: Rachel
-              voice_category: premade
-              text: Hello, world!
-              date_unix: 1714650306
-              character_count_change_from: 17189
-              character_count_change_to: 17231
-              content_type: audio/mpeg
-              state: created
-              settings:
-                similarity_boost: 0.5
-                stability: 0.71
-                style: 0
-                use_speaker_boost: true
-              feedback:
-                thumbs_up: true
-                feedback: This is an example of test feedback.
-                emotions: true
-                inaccurate_clone: false
-                glitches: true
-                audio_quality: true
-                other: false
-                review_status: not_reviewed
-              share_link_id: share_link_id
-              source: TTS
-              alignments:
-                alignment:
-                  characters:
-                    - characters
-                  character_start_times_seconds:
-                    - 1.1
-                  character_end_times_seconds:
-                    - 1.1
-                normalized_alignment:
-                  characters:
-                    - characters
-                  character_start_times_seconds:
-                    - 1.1
-                  character_end_times_seconds:
-                    - 1.1
-              dialogue:
-                - text: text
-                  voice_id: voice_id
-                  voice_name: voice_name
-    delete:
-      path: /v1/history/{history_item_id}
-      method: DELETE
-      auth: false
-      docs: Delete a history item by its ID
-      source:
-        openapi: openapi.json
-      path-parameters:
-        history_item_id:
-          type: string
-          docs: >-
-            ID of the history item to be used. You can use the [Get generated
-            items](/docs/api-reference/history/get-all) endpoint to retrieve a
-            list of history items.
-      display-name: Delete history item
-      response:
-        docs: Successful Response
-        type: root.DeleteHistoryItemResponse
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - path-parameters:
-            history_item_id: VW7YKqPnjY4h39yTbx2L
-          response:
-            body:
-              status: ok
-    get_audio:
-      path: /v1/history/{history_item_id}/audio
-      method: GET
-      auth: false
-      docs: Returns the audio of an history item.
-      source:
-        openapi: openapi.json
-      path-parameters:
-        history_item_id:
-          type: string
-          docs: >-
-            ID of the history item to be used. You can use the [Get generated
-            items](/docs/api-reference/history/get-all) endpoint to retrieve a
-            list of history items.
-      display-name: Get audio from history item
-      response:
-        docs: The audio file of the history item.
-        type: file
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-    download:
-      path: /v1/history/download
-      method: POST
-      auth: false
-      docs: >-
-        Download one or more history items. If one history item ID is provided,
-        we will return a single audio file. If more than one history item IDs
-        are provided, we will provide the history items packed into a .zip file.
-      source:
-        openapi: openapi.json
-      display-name: Download history items
-      request:
-        name: DownloadHistoryRequest
-        body:
-          properties:
-            history_item_ids:
-              docs: >-
-                A list of history items to download, you can get IDs of history
-                items and other metadata using the GET
-                https://api.elevenlabs.io/v1/history endpoint.
-              type: list<string>
-            output_format:
-              type: optional<string>
-              docs: >-
-                Output format to transcode the audio file, can be wav or
-                default.
-        content-type: application/json
-      response:
-        docs: >-
-          The requested audio file, or a zip file containing multiple audio
-          files when multiple history items are requested.
-        type: file
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnprocessableEntityError
-  source:
-    openapi: openapi.json

package/.mock/definition/models.yml

@@ -1,49 +0,0 @@
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    list:
-      path: /v1/models
-      method: GET
-      auth: false
-      docs: Gets a list of available models.
-      source:
-        openapi: openapi.json
-      display-name: List models
-      response:
-        docs: Successful Response
-        type: list<root.Model>
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - response:
-            body:
-              - model_id: eleven_multilingual_v2
-                name: Eleven Multilingual v2
-                can_be_finetuned: true
-                can_do_text_to_speech: true
-                can_do_voice_conversion: true
-                can_use_style: true
-                can_use_speaker_boost: true
-                serves_pro_voices: false
-                token_cost_factor: 1
-                description: >-
-                  Our state of the art multilingual speech synthesis model, able
-                  to generate life-like speech in 29 languages.
-                requires_alpha_access: false
-                max_characters_request_free_user: 2500
-                max_characters_request_subscribed_user: 5000
-                maximum_text_length_per_request: 1000000
-                languages:
-                  - language_id: en
-                    name: English
-                model_rates:
-                  character_cost_multiplier: 1
-                concurrency_group: standard
-  source:
-    openapi: openapi.json
-  display-name: Models
-docs: Access the different models of the platform.

package/.mock/definition/pronunciationDictionaries/rules.yml

@@ -1,99 +0,0 @@
-imports:
-  root: ../__package__.yml
-types:
-  PronunciationDictionaryRule:
-    discriminant: type
-    base-properties: {}
-    union:
-      alias:
-        type: root.PronunciationDictionaryAliasRuleRequestModel
-      phoneme:
-        type: root.PronunciationDictionaryPhonemeRuleRequestModel
-    source:
-      openapi: openapi.json
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    add:
-      path: /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/add-rules
-      method: POST
-      auth: false
-      docs: Add rules to the pronunciation dictionary
-      source:
-        openapi: openapi.json
-      path-parameters:
-        pronunciation_dictionary_id:
-          type: string
-          docs: The id of the pronunciation dictionary
-      display-name: Add pronunciation dictionary rules
-      request:
-        name: PronunciationDictionary
-        body:
-          properties:
-            rules:
-              docs: |-
-                List of pronunciation rules. Rule can be either:
-                    an alias rule: {'string_to_replace': 'a', 'type': 'alias', 'alias': 'b', }
-                    or a phoneme rule: {'string_to_replace': 'a', 'type': 'phoneme', 'phoneme': 'b', 'alphabet': 'ipa' }
-              type: list<PronunciationDictionaryRule>
-        content-type: application/json
-      response:
-        docs: Successful Response
-        type: root.PronunciationDictionaryRulesResponseModel
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - path-parameters:
-            pronunciation_dictionary_id: 21m00Tcm4TlvDq8ikWAM
-          request:
-            rules:
-              - string_to_replace: Thailand
-                alias: tie-land
-                type: alias
-          response:
-            body:
-              id: 5xM3yVvZQKV0EfqQpLrJ
-              version_id: 5xM3yVvZQKV0EfqQpLr2
-              version_rules_num: 1
-    remove:
-      path: >-
-        /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/remove-rules
-      method: POST
-      auth: false
-      docs: Remove rules from the pronunciation dictionary
-      source:
-        openapi: openapi.json
-      path-parameters:
-        pronunciation_dictionary_id:
-          type: string
-          docs: The id of the pronunciation dictionary
-      display-name: Remove pronunciation dictionary rules
-      request:
-        name: RemovePronunciationDictionaryRulesRequest
-        body:
-          properties:
-            rule_strings:
-              docs: List of strings to remove from the pronunciation dictionary.
-              type: list<string>
-        content-type: application/json
-      response:
-        docs: Successful Response
-        type: root.PronunciationDictionaryRulesResponseModel
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - path-parameters:
-            pronunciation_dictionary_id: 21m00Tcm4TlvDq8ikWAM
-          request:
-            rule_strings:
-              - rule_strings
-          response:
-            body:
-              id: 5xM3yVvZQKV0EfqQpLrJ
-              version_id: 5xM3yVvZQKV0EfqQpLr2
-              version_rules_num: 1
-  source:
-    openapi: openapi.json

package/.mock/definition/pronunciationDictionaries.yml

@@ -1,262 +0,0 @@
-types:
-  PronunciationDictionariesCreateFromFileRequestWorkspaceAccess:
-    enum:
-      - admin
-      - editor
-      - viewer
-    inline: true
-    source:
-      openapi: openapi.json
-  BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPostRulesItem:
-    discriminant: type
-    base-properties: {}
-    union:
-      alias:
-        type: root.PronunciationDictionaryAliasRuleRequestModel
-      phoneme:
-        type: root.PronunciationDictionaryPhonemeRuleRequestModel
-    source:
-      openapi: openapi.json
-  BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPostWorkspaceAccess:
-    enum:
-      - admin
-      - editor
-      - viewer
-    inline: true
-    source:
-      openapi: openapi.json
-  PronunciationDictionariesListRequestSort:
-    enum:
-      - creation_time_unix
-      - name
-    source:
-      openapi: openapi.json
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    create_from_file:
-      path: /v1/pronunciation-dictionaries/add-from-file
-      method: POST
-      auth: false
-      docs: Creates a new pronunciation dictionary from a lexicon .PLS file
-      source:
-        openapi: openapi.json
-      display-name: Create a pronunciation dictionary from a file
-      request:
-        name: >-
-          Body_Add_a_pronunciation_dictionary_v1_pronunciation_dictionaries_add_from_file_post
-        body:
-          properties:
-            name:
-              type: string
-              docs: >-
-                The name of the pronunciation dictionary, used for
-                identification only.
-            file:
-              type: optional<file>
-              docs: >-
-                A lexicon .pls file which we will use to initialize the project
-                with.
-            description:
-              type: optional<string>
-              docs: >-
-                A description of the pronunciation dictionary, used for
-                identification only.
-            workspace_access:
-              type: >-
-                optional<PronunciationDictionariesCreateFromFileRequestWorkspaceAccess>
-              docs: >-
-                Should be one of 'admin', 'editor' or 'viewer'. If not provided,
-                defaults to no access.
-        content-type: multipart/form-data
-      response:
-        docs: Successful Response
-        type: root.AddPronunciationDictionaryResponseModel
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - request:
-            name: name
-          response:
-            body:
-              id: 5xM3yVvZQKV0EfqQpLrJ
-              name: My Dictionary
-              created_by: ar6633Es2kUjFXBdR1iVc9ztsXl1
-              creation_time_unix: 1714156800
-              version_id: 5xM3yVvZQKV0EfqQpLrJ
-              version_rules_num: 1
-              description: This is a test dictionary
-              permission_on_resource: admin
-    create_from_rules:
-      path: /v1/pronunciation-dictionaries/add-from-rules
-      method: POST
-      auth: false
-      docs: Creates a new pronunciation dictionary from provided rules.
-      source:
-        openapi: openapi.json
-      display-name: Create a pronunciation dictionary from rules
-      request:
-        name: >-
-          BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPost
-        body:
-          properties:
-            rules:
-              docs: |-
-                List of pronunciation rules. Rule can be either:
-                    an alias rule: {'string_to_replace': 'a', 'type': 'alias', 'alias': 'b', }
-                    or a phoneme rule: {'string_to_replace': 'a', 'type': 'phoneme', 'phoneme': 'b', 'alphabet': 'ipa' }
-              type: >-
-                list<BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPostRulesItem>
-            name:
-              type: string
-              docs: >-
-                The name of the pronunciation dictionary, used for
-                identification only.
-            description:
-              type: optional<string>
-              docs: >-
-                A description of the pronunciation dictionary, used for
-                identification only.
-            workspace_access:
-              type: >-
-                optional<BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPostWorkspaceAccess>
-              docs: >-
-                Should be one of 'admin', 'editor' or 'viewer'. If not provided,
-                defaults to no access.
-        content-type: application/json
-      response:
-        docs: Successful Response
-        type: root.AddPronunciationDictionaryResponseModel
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - request:
-            rules:
-              - string_to_replace: Thailand
-                alias: tie-land
-                type: alias
-            name: My Dictionary
-          response:
-            body:
-              id: 5xM3yVvZQKV0EfqQpLrJ
-              name: My Dictionary
-              created_by: ar6633Es2kUjFXBdR1iVc9ztsXl1
-              creation_time_unix: 1714156800
-              version_id: 5xM3yVvZQKV0EfqQpLrJ
-              version_rules_num: 1
-              description: This is a test dictionary
-              permission_on_resource: admin
-    download:
-      path: /v1/pronunciation-dictionaries/{dictionary_id}/{version_id}/download
-      method: GET
-      auth: false
-      docs: Get a PLS file with a pronunciation dictionary version rules
-      source:
-        openapi: openapi.json
-      path-parameters:
-        dictionary_id:
-          type: string
-          docs: The id of the pronunciation dictionary
-        version_id:
-          type: string
-          docs: The id of the version of the pronunciation dictionary
-      display-name: Get pronunciation dictionary by version
-      response:
-        docs: The PLS file containing pronunciation dictionary rules
-        type: file
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-    get:
-      path: /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/
-      method: GET
-      auth: false
-      docs: Get metadata for a pronunciation dictionary
-      source:
-        openapi: openapi.json
-      path-parameters:
-        pronunciation_dictionary_id:
-          type: string
-          docs: The id of the pronunciation dictionary
-      display-name: Get pronunciation dictionary
-      response:
-        docs: Successful Response
-        type: root.GetPronunciationDictionaryMetadataResponse
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - path-parameters:
-            pronunciation_dictionary_id: 21m00Tcm4TlvDq8ikWAM
-          response:
-            body:
-              id: 5xM3yVvZQKV0EfqQpLrJ
-              latest_version_id: 5xM3yVvZQKV0EfqQpLr2
-              latest_version_rules_num: 2
-              name: My Dictionary
-              permission_on_resource: admin
-              created_by: ar6633Es2kUjFXBdR1iVc9ztsXl1
-              creation_time_unix: 1714156800
-              archived_time_unix: 1
-              description: This is a test dictionary
-    list:
-      path: /v1/pronunciation-dictionaries/
-      method: GET
-      auth: false
-      docs: >-
-        Get a list of the pronunciation dictionaries you have access to and
-        their metadata
-      source:
-        openapi: openapi.json
-      display-name: List pronunciation dictionaries
-      request:
-        name: PronunciationDictionariesListRequest
-        query-parameters:
-          cursor:
-            type: optional<string>
-            docs: Used for fetching next page. Cursor is returned in the response.
-          page_size:
-            type: optional<integer>
-            default: 30
-            docs: >-
-              How many pronunciation dictionaries to return at maximum. Can not
-              exceed 100, defaults to 30.
-            validation:
-              min: 1
-              max: 100
-          sort:
-            type: optional<PronunciationDictionariesListRequestSort>
-            docs: Which field to sort by, one of 'created_at_unix' or 'name'.
-          sort_direction:
-            type: optional<string>
-            docs: >-
-              Which direction to sort the voices in. 'ascending' or
-              'descending'.
-      response:
-        docs: Successful Response
-        type: root.GetPronunciationDictionariesMetadataResponseModel
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - response:
-            body:
-              pronunciation_dictionaries:
-                - id: 5xM3yVvZQKV0EfqQpLrJ
-                  latest_version_id: 5xM3yVvZQKV0EfqQpLr2
-                  latest_version_rules_num: 2
-                  name: My Dictionary
-                  permission_on_resource: admin
-                  created_by: ar6633Es2kUjFXBdR1iVc9ztsXl1
-                  creation_time_unix: 1714156800
-                  archived_time_unix: 1
-                  description: This is a test dictionary
-              next_cursor: 5xM3yVvZQKV0EfqQpLr2
-              has_more: false
-  source:
-    openapi: openapi.json