syllable-sdk 1.0.1 → 1.0.2-rc.10

package/openapi.json

@@ -5553,7 +5553,91 @@
         ]
       }
     },
+    "/api/v1/pronunciations": {
+      "get": {
+        "tags": [
+          "pronunciations"
+        ],
+        "summary": "Get Pronunciations Dictionary",
+        "operationId": "pronunciations_get",
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PronunciationOverridesDictionary"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "APIKeyHeader": []
+          }
+        ]
+      }
+    },
+    "/api/v1/pronunciations/metadata": {
+      "get": {
+        "tags": [
+          "pronunciations"
+        ],
+        "summary": "Get Pronunciations Metadata",
+        "operationId": "pronunciations_get_metadata",
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DictionaryMetadata"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "APIKeyHeader": []
+          }
+        ]
+      }
+    },
     "/api/v1/pronunciations/csv": {
+      "get": {
+        "tags": [
+          "pronunciations"
+        ],
+        "summary": "Download Pronunciations Csv",
+        "operationId": "pronunciations_download_csv",
+        "responses": {
+          "200": {
+            "description": "CSV download",
+            "headers": {
+              "Content-Disposition": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            },
+            "content": {
+              "text/csv": {
+                "schema": {
+                  "type": "string",
+                  "format": "binary"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "APIKeyHeader": []
+          }
+        ]
+      },
       "post": {
         "tags": [
           "pronunciations"
@@ -5597,6 +5681,23 @@
             "APIKeyHeader": []
           }
         ]
+      },
+      "delete": {
+        "tags": [
+          "pronunciations"
+        ],
+        "summary": "Delete Pronunciations Dictionary",
+        "operationId": "pronunciations_delete_csv",
+        "responses": {
+          "204": {
+            "description": "Successful Response"
+          }
+        },
+        "security": [
+          {
+            "APIKeyHeader": []
+          }
+        ]
       }
     },
     "/api/v1/roles/": {
@@ -13086,7 +13187,7 @@
             "title": "Batch Id",
             "description": "Unique ID for conversation batch",
             "examples": [
-              "20251007.9"
+              "20251013.9"
             ]
           },
           "campaign_id": {
@@ -13110,7 +13211,7 @@
             "title": "Expires On",
             "description": "Timestamp of batch expiration",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-14T00:00:00Z"
             ]
           },
           "paused": {
@@ -13163,7 +13264,7 @@
             "title": "Created At",
             "description": "Timestamp of batch creation",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "deleted_at": {
@@ -13179,7 +13280,7 @@
             "title": "Deleted At",
             "description": "Timestamp of batch deletion",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "deleted_reason": {
@@ -13210,7 +13311,7 @@
             "title": "Last Updated At",
             "description": "Timestamp of last change to batch",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "last_updated_by": {
@@ -13549,7 +13650,8 @@
           "caller_id",
           "updated_at",
           "label",
-          "labels"
+          "labels",
+          "voicemail_detection"
         ],
         "title": "CampaignProperties"
       },
@@ -13964,7 +14066,7 @@
             "title": "Batch Id",
             "description": "Unique ID for conversation batch",
             "examples": [
-              "20251007.9"
+              "20251013.9"
             ]
           },
           "campaign_id": {
@@ -13988,7 +14090,7 @@
             "title": "Expires On",
             "description": "Timestamp of batch expiration",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-14T00:00:00Z"
             ]
           },
           "paused": {
@@ -14041,7 +14143,7 @@
             "title": "Created At",
             "description": "Timestamp of batch creation",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "deleted_at": {
@@ -14057,7 +14159,7 @@
             "title": "Deleted At",
             "description": "Timestamp of batch deletion",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "deleted_reason": {
@@ -14088,7 +14190,7 @@
             "title": "Last Updated At",
             "description": "Timestamp of last change to batch",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "last_updated_by": {
@@ -14131,7 +14233,7 @@
             "title": "Batch Id",
             "description": "Unique ID for conversation batch",
             "examples": [
-              "20251007.9"
+              "20251013.9"
             ]
           },
           "campaign_id": {
@@ -14155,7 +14257,7 @@
             "title": "Expires On",
             "description": "Timestamp of batch expiration",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-14T00:00:00Z"
             ]
           },
           "paused": {
@@ -14304,7 +14406,7 @@
             "title": "Created At",
             "description": "Timestamp of request creation",
             "examples": [
-              "2025-10-06T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "sent_at": {
@@ -14320,7 +14422,7 @@
             "title": "Sent At",
             "description": "Timestamp at which request was sent",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "attempt_count": {
@@ -15779,6 +15881,31 @@
         ],
         "title": "DialogToolCall"
       },
+      "DictionaryMetadata": {
+        "properties": {
+          "entries": {
+            "type": "integer",
+            "title": "Entries"
+          },
+          "hash": {
+            "type": "string",
+            "title": "Hash"
+          },
+          "source": {
+            "type": "string",
+            "title": "Source",
+            "default": ""
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "entries",
+          "hash"
+        ],
+        "title": "DictionaryMetadata",
+        "description": "Audit metadata associated with a dictionary."
+      },
       "DirectoryExtension": {
         "properties": {
           "name": {
@@ -16236,7 +16363,7 @@
             "title": "Created At",
             "description": "Timestamp at which insight upload folder was created",
             "examples": [
-              "2025-10-06T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "updated_at": {
@@ -16245,7 +16372,7 @@
             "title": "Updated At",
             "description": "Timestamp at which insight upload folder was last updated",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "last_updated_by": {
@@ -16397,7 +16524,8 @@
               }
             ],
             "title": "Sub Organization",
-            "description": "The name of the sub-organization",
+            "description": "The name of the sub-organization (DEPRECATED)",
+            "deprecated": true,
             "examples": [
               "SubOrg A"
             ]
@@ -16549,7 +16677,8 @@
               }
             ],
             "title": "Sub Organization",
-            "description": "The name of the sub-organization",
+            "description": "The name of the sub-organization (DEPRECATED)",
+            "deprecated": true,
             "examples": [
               "SubOrg A"
             ]
@@ -16716,7 +16845,8 @@
               }
             ],
             "title": "Sub Organization",
-            "description": "The name of the sub-organization",
+            "description": "The name of the sub-organization (DEPRECATED)",
+            "deprecated": true,
             "examples": [
               "SubOrg A"
             ]
@@ -16728,38 +16858,6 @@
             "examples": [
               1
             ]
-          },
-          "created_at": {
-            "anyOf": [
-              {
-                "type": "string",
-                "format": "date-time"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "title": "Created At",
-            "description": "Creation time of the incident",
-            "examples": [
-              "2023-10-01T08:00:00Z"
-            ]
-          },
-          "updated_at": {
-            "anyOf": [
-              {
-                "type": "string",
-                "format": "date-time"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "title": "Updated At",
-            "description": "Last update time of the incident",
-            "examples": [
-              "2023-10-01T08:00:00Z"
-            ]
           }
         },
         "type": "object",
@@ -16960,7 +17058,7 @@
             "title": "Created At",
             "description": "Timestamp of at which insight tool configuration was created",
             "examples": [
-              "2025-10-06T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "updated_at": {
@@ -16969,7 +17067,7 @@
             "title": "Updated At",
             "description": "Timestamp at which insight tool configuration was last updated",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "last_updated_by": {
@@ -17350,7 +17448,7 @@
             "title": "Start Datetime",
             "description": "Target session timestamp the workflow (backfill) should start. An empty value indicates start on activation - live sessions only",
             "examples": [
-              "2025-10-06T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "end_datetime": {
@@ -17366,7 +17464,7 @@
             "title": "End Datetime",
             "description": "Target session timestamp the workflow (backfill) should end. An empty value indicates no end, i.e., include live sessions until deactivation",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           }
         },
@@ -17441,7 +17539,7 @@
             "title": "Start Datetime",
             "description": "Target session timestamp the workflow (backfill) should start. An empty value indicates start on activation - live sessions only",
             "examples": [
-              "2025-10-06T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "end_datetime": {
@@ -17457,7 +17555,7 @@
             "title": "End Datetime",
             "description": "Target session timestamp the workflow (backfill) should end. An empty value indicates no end, i.e., include live sessions until deactivation",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "id": {
@@ -17510,7 +17608,7 @@
             "title": "Created At",
             "description": "Timestamp at which the insight workflow was created",
             "examples": [
-              "2025-10-06T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "updated_at": {
@@ -17519,7 +17617,7 @@
             "title": "Updated At",
             "description": "Timestamp of most recent update to the insight workflow",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "last_updated_by": {
@@ -17615,7 +17713,7 @@
             "title": "Created At",
             "description": "Timestamp at which insight upload folder was created",
             "examples": [
-              "2025-10-06T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "updated_at": {
@@ -17624,7 +17722,7 @@
             "title": "Updated At",
             "description": "Timestamp at which insight upload folder was last updated",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "last_updated_by": {
@@ -17859,7 +17957,7 @@
             "title": "Created At",
             "description": "Timestamp at which insight tool result was created",
             "examples": [
-              "2025-10-06T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "updated_at": {
@@ -17868,7 +17966,7 @@
             "title": "Updated At",
             "description": "Timestamp at which insight tool result was last updated",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           }
         },
@@ -18003,7 +18101,7 @@
             "title": "Start Time",
             "description": "Start time of the uploaded file",
             "examples": [
-              "2025-10-06T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "end_time": {
@@ -18019,7 +18117,7 @@
             "title": "End Time",
             "description": "End time of the uploaded file",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "error_message": {
@@ -18074,7 +18172,7 @@
             "title": "Created At",
             "description": "Timestamp at which insight upload file was created",
             "examples": [
-              "2025-10-06T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           }
         },
@@ -20440,6 +20538,15 @@
         "title": "LoginType",
         "description": "The type of login to use for the user."
       },
+      "MatchType": {
+        "type": "string",
+        "enum": [
+          "exact",
+          "substring"
+        ],
+        "title": "MatchType",
+        "description": "Matching strategy for override text."
+      },
       "OrderByDirection": {
         "type": "string",
         "enum": [
@@ -20993,6 +21100,35 @@
               "[\"mon\", \"tue\", \"wed\", \"thu\", \"fri\"]"
             ]
           },
+          "voicemail_detection": {
+            "anyOf": [
+              {
+                "additionalProperties": {
+                  "type": "number"
+                },
+                "type": "object"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Voicemail Detection",
+            "description": "Config for voicemail detection for voice campaigns",
+            "default": {
+              "voicemail_detection_overall_timeout": 30.0,
+              "voicemail_detection_speech_threshold": 2.4,
+              "voicemail_detection_pre_speech_timeout": 5.0,
+              "voicemail_detection_post_speech_timeout": 1.2
+            },
+            "examples": [
+              {
+                "voicemail_detection_overall_timeout": 30.0,
+                "voicemail_detection_post_speech_timeout": 1.2,
+                "voicemail_detection_pre_speech_timeout": 5.0,
+                "voicemail_detection_speech_threshold": 2.4
+              }
+            ]
+          },
           "id": {
             "type": "integer",
             "title": "Id",
@@ -21022,7 +21158,7 @@
             "title": "Created At",
             "description": "Timestamp of campaign creation",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "updated_at": {
@@ -21031,7 +21167,7 @@
             "title": "Updated At",
             "description": "Timestamp of campaign update",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "last_updated_by": {
@@ -21268,6 +21404,35 @@
             "examples": [
               "[\"mon\", \"tue\", \"wed\", \"thu\", \"fri\"]"
             ]
+          },
+          "voicemail_detection": {
+            "anyOf": [
+              {
+                "additionalProperties": {
+                  "type": "number"
+                },
+                "type": "object"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Voicemail Detection",
+            "description": "Config for voicemail detection for voice campaigns",
+            "default": {
+              "voicemail_detection_overall_timeout": 30.0,
+              "voicemail_detection_speech_threshold": 2.4,
+              "voicemail_detection_pre_speech_timeout": 5.0,
+              "voicemail_detection_post_speech_timeout": 1.2
+            },
+            "examples": [
+              {
+                "voicemail_detection_overall_timeout": 30.0,
+                "voicemail_detection_post_speech_timeout": 1.2,
+                "voicemail_detection_pre_speech_timeout": 5.0,
+                "voicemail_detection_speech_threshold": 2.4
+              }
+            ]
           }
         },
         "type": "object",
@@ -21437,6 +21602,21 @@
               false
             ]
           },
+          "edit_comments": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Edit Comments",
+            "description": "The comments for the most recent edit to the prompt",
+            "examples": [
+              "Updated prompt text to include requirement to not answer questions that aren't about weather."
+            ]
+          },
           "include_default_tools": {
             "type": "boolean",
             "title": "Include Default Tools",
@@ -21821,14 +22001,6 @@
               false
             ]
           },
-          "id": {
-            "type": "integer",
-            "title": "Id",
-            "description": "The internal ID of the prompt",
-            "examples": [
-              1
-            ]
-          },
           "edit_comments": {
             "anyOf": [
               {
@@ -21844,6 +22016,14 @@
               "Updated prompt text to include requirement to not answer questions that aren't about weather."
             ]
           },
+          "id": {
+            "type": "integer",
+            "title": "Id",
+            "description": "The internal ID of the prompt",
+            "examples": [
+              1
+            ]
+          },
           "last_updated": {
             "anyOf": [
               {
@@ -22012,14 +22192,6 @@
               false
             ]
           },
-          "id": {
-            "type": "integer",
-            "title": "Id",
-            "description": "The internal ID of the prompt",
-            "examples": [
-              1
-            ]
-          },
           "edit_comments": {
             "anyOf": [
               {
@@ -22035,6 +22207,14 @@
               "Updated prompt text to include requirement to not answer questions that aren't about weather."
             ]
           },
+          "id": {
+            "type": "integer",
+            "title": "Id",
+            "description": "The internal ID of the prompt",
+            "examples": [
+              1
+            ]
+          },
           "include_default_tools": {
             "type": "boolean",
             "title": "Include Default Tools",
@@ -22055,6 +22235,101 @@
         "title": "PromptUpdateRequest",
         "description": "Request model to update an existing prompt."
       },
+      "PronunciationOverride": {
+        "properties": {
+          "text": {
+            "type": "string",
+            "minLength": 1,
+            "title": "Text"
+          },
+          "replacement": {
+            "type": "string",
+            "minLength": 1,
+            "title": "Replacement"
+          },
+          "languages": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array",
+            "title": "Languages"
+          },
+          "provider": {
+            "type": "string",
+            "title": "Provider",
+            "default": ""
+          },
+          "voice": {
+            "type": "string",
+            "title": "Voice",
+            "default": ""
+          },
+          "match_type": {
+            "$ref": "#/components/schemas/MatchType",
+            "default": "exact"
+          },
+          "match_options": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array",
+            "title": "Match Options"
+          },
+          "enabled": {
+            "type": "boolean",
+            "title": "Enabled",
+            "default": true
+          },
+          "notes": {
+            "type": "string",
+            "title": "Notes",
+            "default": ""
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "text",
+          "replacement"
+        ],
+        "title": "PronunciationOverride",
+        "description": "A single text replacement rule."
+      },
+      "PronunciationOverridesDictionary": {
+        "properties": {
+          "type": {
+            "type": "string",
+            "pattern": "^pronunciations_v\\d+$",
+            "title": "Type",
+            "default": "pronunciations_v1"
+          },
+          "pronunciations": {
+            "items": {
+              "$ref": "#/components/schemas/PronunciationOverride"
+            },
+            "type": "array",
+            "title": "Pronunciations"
+          },
+          "voices": {
+            "additionalProperties": {
+              "$ref": "#/components/schemas/VoiceDisplayInfo"
+            },
+            "type": "object",
+            "title": "Voices"
+          },
+          "metadata": {
+            "$ref": "#/components/schemas/DictionaryMetadata"
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "pronunciations",
+          "metadata"
+        ],
+        "title": "PronunciationOverridesDictionary",
+        "description": "Container for all TTS pronunciation overrides belonging to the sub-organisation.\n\nStored in the `config_values` table via ConfigDao. The Syllable API persists uploaded CSV\npronunciation rules, and Bubblegum's PronunciationOverridesPlugin reads them to apply text\nreplacements before TTS processing.\n\nExample:\n    dao = ConfigDao(db_session)\n    await dao.register_model('tts.pronunciations', PronunciationOverridesDictionary)\n\n    pod = PronunciationOverridesDictionary(\n        pronunciations=[...],\n        metadata=DictionaryMetadata(entries=10, hash='sha256:...'),\n    )\n    result = await dao.upsert('pronunciations_v1', pod)\n\n    record = await dao.get('pronunciations_v1', PronunciationOverridesDictionary)\n    if record:\n        pronunciations = record.value.pronunciations"
+      },
       "PronunciationsCsvUploadResponse": {
         "properties": {
           "revision": {
@@ -22062,25 +22337,11 @@
             "title": "Revision"
           },
           "hash": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ],
+            "type": "string",
             "title": "Hash"
           },
           "entries": {
-            "anyOf": [
-              {
-                "type": "integer"
-              },
-              {
-                "type": "null"
-              }
-            ],
+            "type": "integer",
             "title": "Entries"
           },
           "uploaded_at": {
@@ -22089,20 +22350,16 @@
             "title": "Uploaded At"
           },
           "uploaded_by": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ],
+            "type": "string",
             "title": "Uploaded By"
           }
         },
         "type": "object",
         "required": [
-          "revision"
+          "revision",
+          "hash",
+          "entries",
+          "uploaded_by"
         ],
         "title": "PronunciationsCsvUploadResponse",
         "description": "Placeholder response returned after accepting a pronunciations CSV upload."
@@ -25518,6 +25775,26 @@
         ],
         "title": "ValidationError"
       },
+      "VoiceDisplayInfo": {
+        "properties": {
+          "display_name": {
+            "type": "string",
+            "title": "Display Name"
+          },
+          "provider": {
+            "type": "string",
+            "title": "Provider"
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "display_name",
+          "provider"
+        ],
+        "title": "VoiceDisplayInfo",
+        "description": "Display metadata for a canonical voice identifier."
+      },
       "VoiceSampleCreateRequest": {
         "properties": {
           "language_code": {