syllable-sdk 1.0.2-rc.1 → 1.0.2-rc.11

package/openapi.json

@@ -5614,7 +5614,22 @@
         "operationId": "pronunciations_download_csv",
         "responses": {
           "200": {
-            "description": "Successful Response"
+            "description": "CSV download",
+            "headers": {
+              "Content-Disposition": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            },
+            "content": {
+              "text/csv": {
+                "schema": {
+                  "type": "string",
+                  "format": "binary"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -5666,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/": {
@@ -13155,7 +13187,7 @@
             "title": "Batch Id",
             "description": "Unique ID for conversation batch",
             "examples": [
-              "20251008.9"
+              "20251013.9"
             ]
           },
           "campaign_id": {
@@ -13179,7 +13211,7 @@
             "title": "Expires On",
             "description": "Timestamp of batch expiration",
             "examples": [
-              "2025-10-09T00:00:00Z"
+              "2025-10-14T00:00:00Z"
             ]
           },
           "paused": {
@@ -13232,7 +13264,7 @@
             "title": "Created At",
             "description": "Timestamp of batch creation",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "deleted_at": {
@@ -13248,7 +13280,7 @@
             "title": "Deleted At",
             "description": "Timestamp of batch deletion",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "deleted_reason": {
@@ -13279,7 +13311,7 @@
             "title": "Last Updated At",
             "description": "Timestamp of last change to batch",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "last_updated_by": {
@@ -13618,7 +13650,8 @@
           "caller_id",
           "updated_at",
           "label",
-          "labels"
+          "labels",
+          "voicemail_detection"
         ],
         "title": "CampaignProperties"
       },
@@ -14033,7 +14066,7 @@
             "title": "Batch Id",
             "description": "Unique ID for conversation batch",
             "examples": [
-              "20251008.9"
+              "20251013.9"
             ]
           },
           "campaign_id": {
@@ -14057,7 +14090,7 @@
             "title": "Expires On",
             "description": "Timestamp of batch expiration",
             "examples": [
-              "2025-10-09T00:00:00Z"
+              "2025-10-14T00:00:00Z"
             ]
           },
           "paused": {
@@ -14110,7 +14143,7 @@
             "title": "Created At",
             "description": "Timestamp of batch creation",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "deleted_at": {
@@ -14126,7 +14159,7 @@
             "title": "Deleted At",
             "description": "Timestamp of batch deletion",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "deleted_reason": {
@@ -14157,7 +14190,7 @@
             "title": "Last Updated At",
             "description": "Timestamp of last change to batch",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "last_updated_by": {
@@ -14200,7 +14233,7 @@
             "title": "Batch Id",
             "description": "Unique ID for conversation batch",
             "examples": [
-              "20251008.9"
+              "20251013.9"
             ]
           },
           "campaign_id": {
@@ -14224,7 +14257,7 @@
             "title": "Expires On",
             "description": "Timestamp of batch expiration",
             "examples": [
-              "2025-10-09T00:00:00Z"
+              "2025-10-14T00:00:00Z"
             ]
           },
           "paused": {
@@ -14373,7 +14406,7 @@
             "title": "Created At",
             "description": "Timestamp of request creation",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "sent_at": {
@@ -14389,7 +14422,7 @@
             "title": "Sent At",
             "description": "Timestamp at which request was sent",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "attempt_count": {
@@ -15859,15 +15892,9 @@
             "title": "Hash"
           },
           "source": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "title": "Source"
+            "type": "string",
+            "title": "Source",
+            "default": ""
           }
         },
         "additionalProperties": false,
@@ -16336,7 +16363,7 @@
             "title": "Created At",
             "description": "Timestamp at which insight upload folder was created",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "updated_at": {
@@ -16345,7 +16372,7 @@
             "title": "Updated At",
             "description": "Timestamp at which insight upload folder was last updated",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "last_updated_by": {
@@ -16497,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"
             ]
@@ -16649,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"
             ]
@@ -16816,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"
             ]
@@ -16828,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",
@@ -17060,7 +17058,7 @@
             "title": "Created At",
             "description": "Timestamp of at which insight tool configuration was created",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "updated_at": {
@@ -17069,7 +17067,7 @@
             "title": "Updated At",
             "description": "Timestamp at which insight tool configuration was last updated",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "last_updated_by": {
@@ -17450,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-07T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "end_datetime": {
@@ -17466,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-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           }
         },
@@ -17541,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-07T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "end_datetime": {
@@ -17557,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-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "id": {
@@ -17610,7 +17608,7 @@
             "title": "Created At",
             "description": "Timestamp at which the insight workflow was created",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "updated_at": {
@@ -17619,7 +17617,7 @@
             "title": "Updated At",
             "description": "Timestamp of most recent update to the insight workflow",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "last_updated_by": {
@@ -17715,7 +17713,7 @@
             "title": "Created At",
             "description": "Timestamp at which insight upload folder was created",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "updated_at": {
@@ -17724,7 +17722,7 @@
             "title": "Updated At",
             "description": "Timestamp at which insight upload folder was last updated",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "last_updated_by": {
@@ -17959,7 +17957,7 @@
             "title": "Created At",
             "description": "Timestamp at which insight tool result was created",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "updated_at": {
@@ -17968,7 +17966,7 @@
             "title": "Updated At",
             "description": "Timestamp at which insight tool result was last updated",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           }
         },
@@ -18103,7 +18101,7 @@
             "title": "Start Time",
             "description": "Start time of the uploaded file",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           },
           "end_time": {
@@ -18119,7 +18117,7 @@
             "title": "End Time",
             "description": "End time of the uploaded file",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "error_message": {
@@ -18174,7 +18172,7 @@
             "title": "Created At",
             "description": "Timestamp at which insight upload file was created",
             "examples": [
-              "2025-10-07T00:00:00Z"
+              "2025-10-12T00:00:00Z"
             ]
           }
         },
@@ -20543,7 +20541,8 @@
       "MatchType": {
         "type": "string",
         "enum": [
-          "exact"
+          "exact",
+          "substring"
         ],
         "title": "MatchType",
         "description": "Matching strategy for override text."
@@ -21101,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",
@@ -21130,7 +21158,7 @@
             "title": "Created At",
             "description": "Timestamp of campaign creation",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "updated_at": {
@@ -21139,7 +21167,7 @@
             "title": "Updated At",
             "description": "Timestamp of campaign update",
             "examples": [
-              "2025-10-08T00:00:00Z"
+              "2025-10-13T00:00:00Z"
             ]
           },
           "last_updated_by": {
@@ -21376,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",
@@ -21545,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",
@@ -21929,14 +22001,6 @@
               false
             ]
           },
-          "id": {
-            "type": "integer",
-            "title": "Id",
-            "description": "The internal ID of the prompt",
-            "examples": [
-              1
-            ]
-          },
           "edit_comments": {
             "anyOf": [
               {
@@ -21952,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": [
               {
@@ -22120,14 +22192,6 @@
               false
             ]
           },
-          "id": {
-            "type": "integer",
-            "title": "Id",
-            "description": "The internal ID of the prompt",
-            "examples": [
-              1
-            ]
-          },
           "edit_comments": {
             "anyOf": [
               {
@@ -22143,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",
@@ -22175,44 +22247,22 @@
             "minLength": 1,
             "title": "Replacement"
           },
-          "language": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "items": {
-                  "type": "string"
-                },
-                "type": "array"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "title": "Language"
+          "languages": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array",
+            "title": "Languages"
           },
           "provider": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "title": "Provider"
+            "type": "string",
+            "title": "Provider",
+            "default": ""
           },
           "voice": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "title": "Voice"
+            "type": "string",
+            "title": "Voice",
+            "default": ""
           },
           "match_type": {
             "$ref": "#/components/schemas/MatchType",
@@ -22231,15 +22281,9 @@
             "default": true
           },
           "notes": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "title": "Notes"
+            "type": "string",
+            "title": "Notes",
+            "default": ""
           }
         },
         "additionalProperties": false,
@@ -22293,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": {
@@ -22320,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."
@@ -25821,6 +25847,18 @@
             "examples": [
               0.0
             ]
+          },
+          "text": {
+            "type": "string",
+            "title": "Text",
+            "description": "Text to generate for this voice.",
+            "default": ""
+          },
+          "apply_pronunciation_overrides": {
+            "type": "boolean",
+            "title": "Apply Pronunciation Overrides",
+            "description": "Apply TTS pronunciation fixes.",
+            "default": false
           }
         },
         "type": "object",