syllable-sdk 0.1.0-alpha.169 → 0.1.0-alpha.174
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -0
- package/docs/sdks/batches/README.md +4 -4
- package/docs/sdks/campaigns/README.md +18 -2
- package/docs/sdks/languagegroups/README.md +4 -4
- package/docs/sdks/numbers/README.md +164 -0
- package/docs/sdks/users/README.md +424 -1
- package/docs/sdks/v1/README.md +424 -1
- package/docs/sdks/workflows/README.md +8 -8
- package/funcs/channelsTwilioNumbersList.d.ts +17 -0
- package/funcs/channelsTwilioNumbersList.d.ts.map +1 -0
- package/funcs/channelsTwilioNumbersList.js +108 -0
- package/funcs/channelsTwilioNumbersList.js.map +1 -0
- package/funcs/channelsTwilioNumbersUpdate.d.ts +17 -0
- package/funcs/channelsTwilioNumbersUpdate.d.ts.map +1 -0
- package/funcs/channelsTwilioNumbersUpdate.js +111 -0
- package/funcs/channelsTwilioNumbersUpdate.js.map +1 -0
- package/funcs/usersCreate.d.ts +16 -0
- package/funcs/usersCreate.d.ts.map +1 -0
- package/funcs/usersCreate.js +102 -0
- package/funcs/usersCreate.js.map +1 -0
- package/funcs/usersDelete.d.ts +16 -0
- package/funcs/usersDelete.d.ts.map +1 -0
- package/funcs/usersDelete.js +103 -0
- package/funcs/usersDelete.js.map +1 -0
- package/funcs/usersList.d.ts +17 -0
- package/funcs/usersList.d.ts.map +1 -0
- package/funcs/usersList.js +114 -0
- package/funcs/usersList.js.map +1 -0
- package/funcs/usersUpdate.d.ts +16 -0
- package/funcs/usersUpdate.d.ts.map +1 -0
- package/funcs/usersUpdate.js +102 -0
- package/funcs/usersUpdate.js.map +1 -0
- package/funcs/usersUsersDeleteAccount.d.ts +4 -0
- package/funcs/usersUsersDeleteAccount.d.ts.map +1 -1
- package/funcs/usersUsersDeleteAccount.js +4 -0
- package/funcs/usersUsersDeleteAccount.js.map +1 -1
- package/funcs/usersUsersGetByEmail.d.ts +17 -0
- package/funcs/usersUsersGetByEmail.d.ts.map +1 -0
- package/funcs/usersUsersGetByEmail.js +108 -0
- package/funcs/usersUsersGetByEmail.js.map +1 -0
- package/funcs/v1Create.d.ts +16 -0
- package/funcs/v1Create.d.ts.map +1 -0
- package/funcs/v1Create.js +102 -0
- package/funcs/v1Create.js.map +1 -0
- package/funcs/v1Delete.d.ts +16 -0
- package/funcs/v1Delete.d.ts.map +1 -0
- package/funcs/v1Delete.js +103 -0
- package/funcs/v1Delete.js.map +1 -0
- package/funcs/v1List.d.ts +17 -0
- package/funcs/v1List.d.ts.map +1 -0
- package/funcs/v1List.js +114 -0
- package/funcs/v1List.js.map +1 -0
- package/funcs/v1Update.d.ts +16 -0
- package/funcs/v1Update.d.ts.map +1 -0
- package/funcs/v1Update.js +102 -0
- package/funcs/v1Update.js.map +1 -0
- package/funcs/v1UsersDeleteAccount.d.ts +4 -0
- package/funcs/v1UsersDeleteAccount.d.ts.map +1 -1
- package/funcs/v1UsersDeleteAccount.js +4 -0
- package/funcs/v1UsersDeleteAccount.js.map +1 -1
- package/funcs/v1UsersGetByEmail.d.ts +17 -0
- package/funcs/v1UsersGetByEmail.d.ts.map +1 -0
- package/funcs/v1UsersGetByEmail.js +108 -0
- package/funcs/v1UsersGetByEmail.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/models/components/campaignproperties.d.ts +3 -0
- package/models/components/campaignproperties.d.ts.map +1 -1
- package/models/components/campaignproperties.js +1 -0
- package/models/components/campaignproperties.js.map +1 -1
- package/models/components/index.d.ts +10 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +10 -0
- package/models/components/index.js.map +1 -1
- package/models/components/languagecode.d.ts +6 -0
- package/models/components/languagecode.d.ts.map +1 -1
- package/models/components/languagecode.js +2 -0
- package/models/components/languagecode.js.map +1 -1
- package/models/components/listresponseuserresponse.d.ts +53 -0
- package/models/components/listresponseuserresponse.d.ts.map +1 -0
- package/models/components/listresponseuserresponse.js +81 -0
- package/models/components/listresponseuserresponse.js.map +1 -0
- package/models/components/outboundcampaign.d.ts +8 -1
- package/models/components/outboundcampaign.d.ts.map +1 -1
- package/models/components/outboundcampaign.js +2 -0
- package/models/components/outboundcampaign.js.map +1 -1
- package/models/components/outboundcampaigninput.d.ts +8 -1
- package/models/components/outboundcampaigninput.d.ts.map +1 -1
- package/models/components/outboundcampaigninput.js +2 -0
- package/models/components/outboundcampaigninput.js.map +1 -1
- package/models/components/twiliolistnumbersresponse.d.ts +36 -0
- package/models/components/twiliolistnumbersresponse.d.ts.map +1 -0
- package/models/components/twiliolistnumbersresponse.js +69 -0
- package/models/components/twiliolistnumbersresponse.js.map +1 -0
- package/models/components/twilionumberupdaterequest.d.ts +40 -0
- package/models/components/twilionumberupdaterequest.d.ts.map +1 -0
- package/models/components/twilionumberupdaterequest.js +72 -0
- package/models/components/twilionumberupdaterequest.js.map +1 -0
- package/models/components/twilionumberupdateresponse.d.ts +35 -0
- package/models/components/twilionumberupdateresponse.d.ts.map +1 -0
- package/models/components/twilionumberupdateresponse.js +68 -0
- package/models/components/twilionumberupdateresponse.js.map +1 -0
- package/models/components/twiliophonenumber.d.ts +47 -0
- package/models/components/twiliophonenumber.d.ts.map +1 -0
- package/models/components/twiliophonenumber.js +78 -0
- package/models/components/twiliophonenumber.js.map +1 -0
- package/models/components/usercreaterequest.d.ts +50 -0
- package/models/components/usercreaterequest.d.ts.map +1 -0
- package/models/components/usercreaterequest.js +78 -0
- package/models/components/usercreaterequest.js.map +1 -0
- package/models/components/userdeleterequest.d.ts +40 -0
- package/models/components/userdeleterequest.d.ts.map +1 -0
- package/models/components/userdeleterequest.js +61 -0
- package/models/components/userdeleterequest.js.map +1 -0
- package/models/components/userproperties.d.ts +40 -0
- package/models/components/userproperties.d.ts.map +1 -0
- package/models/components/userproperties.js +55 -0
- package/models/components/userproperties.js.map +1 -0
- package/models/components/userresponse.d.ts +75 -0
- package/models/components/userresponse.d.ts.map +1 -0
- package/models/components/userresponse.js +97 -0
- package/models/components/userresponse.js.map +1 -0
- package/models/components/userupdaterequest.d.ts +55 -0
- package/models/components/userupdaterequest.d.ts.map +1 -0
- package/models/components/userupdaterequest.js +82 -0
- package/models/components/userupdaterequest.js.map +1 -0
- package/models/operations/channelstwilionumberslist.d.ts +29 -0
- package/models/operations/channelstwilionumberslist.d.ts.map +1 -0
- package/models/operations/channelstwilionumberslist.js +68 -0
- package/models/operations/channelstwilionumberslist.js.map +1 -0
- package/models/operations/channelstwilionumbersupdate.d.ts +32 -0
- package/models/operations/channelstwilionumbersupdate.d.ts.map +1 -0
- package/models/operations/channelstwilionumbersupdate.js +73 -0
- package/models/operations/channelstwilionumbersupdate.js.map +1 -0
- package/models/operations/index.d.ts +4 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +4 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/usersgetbyemail.d.ts +29 -0
- package/models/operations/usersgetbyemail.d.ts.map +1 -0
- package/models/operations/usersgetbyemail.js +68 -0
- package/models/operations/usersgetbyemail.js.map +1 -0
- package/models/operations/userslist.d.ts +73 -0
- package/models/operations/userslist.d.ts.map +1 -0
- package/models/operations/userslist.js +99 -0
- package/models/operations/userslist.js.map +1 -0
- package/openapi.json +1353 -343
- package/package.json +1 -1
- package/sdk/numbers.d.ts +14 -0
- package/sdk/numbers.d.ts.map +1 -1
- package/sdk/numbers.js +20 -0
- package/sdk/numbers.js.map +1 -1
- package/sdk/users.d.ts +41 -0
- package/sdk/users.d.ts.map +1 -1
- package/sdk/users.js +54 -0
- package/sdk/users.js.map +1 -1
- package/sdk/v1.d.ts +41 -0
- package/sdk/v1.d.ts.map +1 -1
- package/sdk/v1.js +54 -0
- package/sdk/v1.js.map +1 -1
- package/src/funcs/channelsTwilioNumbersList.ts +145 -0
- package/src/funcs/channelsTwilioNumbersUpdate.ts +148 -0
- package/src/funcs/usersCreate.ts +135 -0
- package/src/funcs/usersDelete.ts +136 -0
- package/src/funcs/usersList.ts +148 -0
- package/src/funcs/usersUpdate.ts +135 -0
- package/src/funcs/usersUsersDeleteAccount.ts +4 -0
- package/src/funcs/usersUsersGetByEmail.ts +142 -0
- package/src/funcs/v1Create.ts +135 -0
- package/src/funcs/v1Delete.ts +136 -0
- package/src/funcs/v1List.ts +148 -0
- package/src/funcs/v1Update.ts +135 -0
- package/src/funcs/v1UsersDeleteAccount.ts +4 -0
- package/src/funcs/v1UsersGetByEmail.ts +142 -0
- package/src/lib/config.ts +2 -2
- package/src/models/components/campaignproperties.ts +1 -0
- package/src/models/components/index.ts +10 -0
- package/src/models/components/languagecode.ts +2 -0
- package/src/models/components/listresponseuserresponse.ts +116 -0
- package/src/models/components/outboundcampaign.ts +10 -1
- package/src/models/components/outboundcampaigninput.ts +10 -1
- package/src/models/components/twiliolistnumbersresponse.ts +87 -0
- package/src/models/components/twilionumberupdaterequest.ts +90 -0
- package/src/models/components/twilionumberupdateresponse.ts +81 -0
- package/src/models/components/twiliophonenumber.ts +103 -0
- package/src/models/components/usercreaterequest.ts +106 -0
- package/src/models/components/userdeleterequest.ts +79 -0
- package/src/models/components/userproperties.ts +41 -0
- package/src/models/components/userresponse.ts +150 -0
- package/src/models/components/userupdaterequest.ts +115 -0
- package/src/models/operations/channelstwilionumberslist.ts +77 -0
- package/src/models/operations/channelstwilionumbersupdate.ts +87 -0
- package/src/models/operations/index.ts +4 -0
- package/src/models/operations/usersgetbyemail.ts +75 -0
- package/src/models/operations/userslist.ts +149 -0
- package/src/sdk/numbers.ts +36 -0
- package/src/sdk/users.ts +96 -0
- package/src/sdk/v1.ts +96 -0
package/openapi.json
CHANGED
|
@@ -883,6 +883,108 @@
|
|
|
883
883
|
}
|
|
884
884
|
}
|
|
885
885
|
}
|
|
886
|
+
},
|
|
887
|
+
"put": {
|
|
888
|
+
"tags": [
|
|
889
|
+
"channels.twilio.numbers"
|
|
890
|
+
],
|
|
891
|
+
"summary": "Update Twilio Number",
|
|
892
|
+
"description": "Update a Twilio number and associate it with a channel.",
|
|
893
|
+
"operationId": "channels_twilio_numbers_update",
|
|
894
|
+
"security": [
|
|
895
|
+
{
|
|
896
|
+
"APIKeyHeader": []
|
|
897
|
+
}
|
|
898
|
+
],
|
|
899
|
+
"parameters": [
|
|
900
|
+
{
|
|
901
|
+
"name": "channel_id",
|
|
902
|
+
"in": "path",
|
|
903
|
+
"required": true,
|
|
904
|
+
"schema": {
|
|
905
|
+
"type": "integer",
|
|
906
|
+
"title": "Channel Id"
|
|
907
|
+
}
|
|
908
|
+
}
|
|
909
|
+
],
|
|
910
|
+
"requestBody": {
|
|
911
|
+
"required": true,
|
|
912
|
+
"content": {
|
|
913
|
+
"application/json": {
|
|
914
|
+
"schema": {
|
|
915
|
+
"$ref": "#/components/schemas/TwilioNumberUpdateRequest"
|
|
916
|
+
}
|
|
917
|
+
}
|
|
918
|
+
}
|
|
919
|
+
},
|
|
920
|
+
"responses": {
|
|
921
|
+
"200": {
|
|
922
|
+
"description": "Successful Response",
|
|
923
|
+
"content": {
|
|
924
|
+
"application/json": {
|
|
925
|
+
"schema": {
|
|
926
|
+
"$ref": "#/components/schemas/TwilioNumberUpdateResponse"
|
|
927
|
+
}
|
|
928
|
+
}
|
|
929
|
+
}
|
|
930
|
+
},
|
|
931
|
+
"422": {
|
|
932
|
+
"description": "Validation Error",
|
|
933
|
+
"content": {
|
|
934
|
+
"application/json": {
|
|
935
|
+
"schema": {
|
|
936
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
937
|
+
}
|
|
938
|
+
}
|
|
939
|
+
}
|
|
940
|
+
}
|
|
941
|
+
}
|
|
942
|
+
},
|
|
943
|
+
"get": {
|
|
944
|
+
"tags": [
|
|
945
|
+
"channels.twilio.numbers"
|
|
946
|
+
],
|
|
947
|
+
"summary": "List Twilio Phone Numbers",
|
|
948
|
+
"description": "List Twilio phone numbers.",
|
|
949
|
+
"operationId": "channels_twilio_numbers_list",
|
|
950
|
+
"security": [
|
|
951
|
+
{
|
|
952
|
+
"APIKeyHeader": []
|
|
953
|
+
}
|
|
954
|
+
],
|
|
955
|
+
"parameters": [
|
|
956
|
+
{
|
|
957
|
+
"name": "channel_id",
|
|
958
|
+
"in": "path",
|
|
959
|
+
"required": true,
|
|
960
|
+
"schema": {
|
|
961
|
+
"type": "integer",
|
|
962
|
+
"title": "Channel Id"
|
|
963
|
+
}
|
|
964
|
+
}
|
|
965
|
+
],
|
|
966
|
+
"responses": {
|
|
967
|
+
"200": {
|
|
968
|
+
"description": "Successful Response",
|
|
969
|
+
"content": {
|
|
970
|
+
"application/json": {
|
|
971
|
+
"schema": {
|
|
972
|
+
"$ref": "#/components/schemas/TwilioListNumbersResponse"
|
|
973
|
+
}
|
|
974
|
+
}
|
|
975
|
+
}
|
|
976
|
+
},
|
|
977
|
+
"422": {
|
|
978
|
+
"description": "Validation Error",
|
|
979
|
+
"content": {
|
|
980
|
+
"application/json": {
|
|
981
|
+
"schema": {
|
|
982
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
983
|
+
}
|
|
984
|
+
}
|
|
985
|
+
}
|
|
986
|
+
}
|
|
987
|
+
}
|
|
886
988
|
}
|
|
887
989
|
},
|
|
888
990
|
"/api/v1/agents/test/messages": {
|
|
@@ -10819,95 +10921,499 @@
|
|
|
10819
10921
|
}
|
|
10820
10922
|
}
|
|
10821
10923
|
},
|
|
10822
|
-
"/api/v1/users/
|
|
10823
|
-
"
|
|
10924
|
+
"/api/v1/users/": {
|
|
10925
|
+
"get": {
|
|
10824
10926
|
"tags": [
|
|
10825
10927
|
"users",
|
|
10826
10928
|
"V1"
|
|
10827
10929
|
],
|
|
10828
|
-
"summary": "
|
|
10829
|
-
"
|
|
10830
|
-
"
|
|
10831
|
-
"200": {
|
|
10832
|
-
"description": "Successful Response",
|
|
10833
|
-
"content": {
|
|
10834
|
-
"application/json": {
|
|
10835
|
-
"schema": {}
|
|
10836
|
-
}
|
|
10837
|
-
}
|
|
10838
|
-
}
|
|
10839
|
-
},
|
|
10930
|
+
"summary": "List Users",
|
|
10931
|
+
"description": "List the existing users.",
|
|
10932
|
+
"operationId": "users_list",
|
|
10840
10933
|
"security": [
|
|
10841
10934
|
{
|
|
10842
10935
|
"APIKeyHeader": []
|
|
10843
10936
|
}
|
|
10844
|
-
]
|
|
10845
|
-
|
|
10846
|
-
|
|
10847
|
-
|
|
10848
|
-
|
|
10849
|
-
|
|
10850
|
-
|
|
10851
|
-
|
|
10852
|
-
|
|
10853
|
-
|
|
10854
|
-
|
|
10855
|
-
|
|
10856
|
-
|
|
10857
|
-
|
|
10858
|
-
|
|
10937
|
+
],
|
|
10938
|
+
"parameters": [
|
|
10939
|
+
{
|
|
10940
|
+
"name": "page",
|
|
10941
|
+
"in": "query",
|
|
10942
|
+
"required": false,
|
|
10943
|
+
"schema": {
|
|
10944
|
+
"anyOf": [
|
|
10945
|
+
{
|
|
10946
|
+
"type": "integer",
|
|
10947
|
+
"minimum": 0
|
|
10948
|
+
},
|
|
10949
|
+
{
|
|
10950
|
+
"type": "null"
|
|
10951
|
+
}
|
|
10952
|
+
],
|
|
10953
|
+
"description": "The page number from which to start (0-based)",
|
|
10954
|
+
"examples": [
|
|
10955
|
+
0
|
|
10956
|
+
],
|
|
10957
|
+
"default": 0,
|
|
10958
|
+
"title": "Page"
|
|
10959
|
+
},
|
|
10960
|
+
"description": "The page number from which to start (0-based)"
|
|
10859
10961
|
},
|
|
10860
|
-
|
|
10861
|
-
"
|
|
10862
|
-
|
|
10863
|
-
|
|
10962
|
+
{
|
|
10963
|
+
"name": "limit",
|
|
10964
|
+
"in": "query",
|
|
10965
|
+
"required": false,
|
|
10966
|
+
"schema": {
|
|
10967
|
+
"type": "integer",
|
|
10968
|
+
"minimum": 0,
|
|
10969
|
+
"description": "The maximum number of items to return",
|
|
10970
|
+
"examples": [
|
|
10971
|
+
25
|
|
10972
|
+
],
|
|
10973
|
+
"default": 25,
|
|
10974
|
+
"title": "Limit"
|
|
10975
|
+
},
|
|
10976
|
+
"description": "The maximum number of items to return"
|
|
10977
|
+
},
|
|
10978
|
+
{
|
|
10979
|
+
"name": "search_fields",
|
|
10980
|
+
"in": "query",
|
|
10981
|
+
"required": false,
|
|
10982
|
+
"schema": {
|
|
10983
|
+
"type": "array",
|
|
10984
|
+
"items": {
|
|
10985
|
+
"$ref": "#/components/schemas/UserProperties"
|
|
10864
10986
|
},
|
|
10865
|
-
|
|
10866
|
-
|
|
10867
|
-
|
|
10868
|
-
|
|
10869
|
-
|
|
10870
|
-
|
|
10871
|
-
|
|
10872
|
-
|
|
10873
|
-
]
|
|
10987
|
+
"description": "String names of fields to search. Correspond by index to search field values",
|
|
10988
|
+
"examples": [
|
|
10989
|
+
"name"
|
|
10990
|
+
],
|
|
10991
|
+
"default": [],
|
|
10992
|
+
"title": "Search Fields"
|
|
10993
|
+
},
|
|
10994
|
+
"description": "String names of fields to search. Correspond by index to search field values"
|
|
10874
10995
|
},
|
|
10875
|
-
|
|
10876
|
-
"
|
|
10877
|
-
|
|
10996
|
+
{
|
|
10997
|
+
"name": "search_field_values",
|
|
10998
|
+
"in": "query",
|
|
10999
|
+
"required": false,
|
|
11000
|
+
"schema": {
|
|
11001
|
+
"type": "array",
|
|
11002
|
+
"items": {
|
|
10878
11003
|
"type": "string"
|
|
10879
11004
|
},
|
|
10880
|
-
|
|
10881
|
-
|
|
10882
|
-
|
|
10883
|
-
|
|
10884
|
-
|
|
10885
|
-
|
|
10886
|
-
|
|
10887
|
-
"
|
|
10888
|
-
"Information"
|
|
10889
|
-
]
|
|
11005
|
+
"description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
|
|
11006
|
+
"examples": [
|
|
11007
|
+
"Some Object Name"
|
|
11008
|
+
],
|
|
11009
|
+
"default": [],
|
|
11010
|
+
"title": "Search Field Values"
|
|
11011
|
+
},
|
|
11012
|
+
"description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
|
|
10890
11013
|
},
|
|
10891
|
-
|
|
10892
|
-
"
|
|
10893
|
-
|
|
10894
|
-
|
|
10895
|
-
|
|
11014
|
+
{
|
|
11015
|
+
"name": "order_by",
|
|
11016
|
+
"in": "query",
|
|
11017
|
+
"required": false,
|
|
11018
|
+
"schema": {
|
|
11019
|
+
"anyOf": [
|
|
11020
|
+
{
|
|
11021
|
+
"$ref": "#/components/schemas/UserProperties"
|
|
10896
11022
|
},
|
|
10897
|
-
|
|
10898
|
-
|
|
10899
|
-
|
|
10900
|
-
|
|
10901
|
-
|
|
10902
|
-
|
|
10903
|
-
|
|
10904
|
-
|
|
10905
|
-
|
|
10906
|
-
|
|
10907
|
-
|
|
10908
|
-
|
|
10909
|
-
|
|
10910
|
-
|
|
11023
|
+
{
|
|
11024
|
+
"type": "null"
|
|
11025
|
+
}
|
|
11026
|
+
],
|
|
11027
|
+
"description": "The field whose value should be used to order the results",
|
|
11028
|
+
"examples": [
|
|
11029
|
+
"name"
|
|
11030
|
+
],
|
|
11031
|
+
"title": "Order By"
|
|
11032
|
+
},
|
|
11033
|
+
"description": "The field whose value should be used to order the results"
|
|
11034
|
+
},
|
|
11035
|
+
{
|
|
11036
|
+
"name": "order_by_direction",
|
|
11037
|
+
"in": "query",
|
|
11038
|
+
"required": false,
|
|
11039
|
+
"schema": {
|
|
11040
|
+
"anyOf": [
|
|
11041
|
+
{
|
|
11042
|
+
"$ref": "#/components/schemas/OrderByDirection"
|
|
11043
|
+
},
|
|
11044
|
+
{
|
|
11045
|
+
"type": "null"
|
|
11046
|
+
}
|
|
11047
|
+
],
|
|
11048
|
+
"description": "The direction in which to order the results",
|
|
11049
|
+
"title": "Order By Direction"
|
|
11050
|
+
},
|
|
11051
|
+
"description": "The direction in which to order the results"
|
|
11052
|
+
},
|
|
11053
|
+
{
|
|
11054
|
+
"name": "fields",
|
|
11055
|
+
"in": "query",
|
|
11056
|
+
"required": false,
|
|
11057
|
+
"schema": {
|
|
11058
|
+
"anyOf": [
|
|
11059
|
+
{
|
|
11060
|
+
"type": "array",
|
|
11061
|
+
"items": {
|
|
11062
|
+
"$ref": "#/components/schemas/UserProperties"
|
|
11063
|
+
}
|
|
11064
|
+
},
|
|
11065
|
+
{
|
|
11066
|
+
"type": "null"
|
|
11067
|
+
}
|
|
11068
|
+
],
|
|
11069
|
+
"description": "The fields to include in the response",
|
|
11070
|
+
"default": [],
|
|
11071
|
+
"title": "Fields"
|
|
11072
|
+
},
|
|
11073
|
+
"description": "The fields to include in the response"
|
|
11074
|
+
},
|
|
11075
|
+
{
|
|
11076
|
+
"name": "start_datetime",
|
|
11077
|
+
"in": "query",
|
|
11078
|
+
"required": false,
|
|
11079
|
+
"schema": {
|
|
11080
|
+
"anyOf": [
|
|
11081
|
+
{
|
|
11082
|
+
"type": "string"
|
|
11083
|
+
},
|
|
11084
|
+
{
|
|
11085
|
+
"type": "null"
|
|
11086
|
+
}
|
|
11087
|
+
],
|
|
11088
|
+
"description": "The start datetime for filtering results",
|
|
11089
|
+
"examples": [
|
|
11090
|
+
"2023-01-01T00:00:00Z"
|
|
11091
|
+
],
|
|
11092
|
+
"title": "Start Datetime"
|
|
11093
|
+
},
|
|
11094
|
+
"description": "The start datetime for filtering results"
|
|
11095
|
+
},
|
|
11096
|
+
{
|
|
11097
|
+
"name": "end_datetime",
|
|
11098
|
+
"in": "query",
|
|
11099
|
+
"required": false,
|
|
11100
|
+
"schema": {
|
|
11101
|
+
"anyOf": [
|
|
11102
|
+
{
|
|
11103
|
+
"type": "string"
|
|
11104
|
+
},
|
|
11105
|
+
{
|
|
11106
|
+
"type": "null"
|
|
11107
|
+
}
|
|
11108
|
+
],
|
|
11109
|
+
"description": "The end datetime for filtering results",
|
|
11110
|
+
"examples": [
|
|
11111
|
+
"2024-01-01T00:00:00Z"
|
|
11112
|
+
],
|
|
11113
|
+
"title": "End Datetime"
|
|
11114
|
+
},
|
|
11115
|
+
"description": "The end datetime for filtering results"
|
|
11116
|
+
}
|
|
11117
|
+
],
|
|
11118
|
+
"responses": {
|
|
11119
|
+
"200": {
|
|
11120
|
+
"description": "Successful Response",
|
|
11121
|
+
"content": {
|
|
11122
|
+
"application/json": {
|
|
11123
|
+
"schema": {
|
|
11124
|
+
"$ref": "#/components/schemas/ListResponse_UserResponse_"
|
|
11125
|
+
}
|
|
11126
|
+
}
|
|
11127
|
+
}
|
|
11128
|
+
},
|
|
11129
|
+
"422": {
|
|
11130
|
+
"description": "Validation Error",
|
|
11131
|
+
"content": {
|
|
11132
|
+
"application/json": {
|
|
11133
|
+
"schema": {
|
|
11134
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
11135
|
+
}
|
|
11136
|
+
}
|
|
11137
|
+
}
|
|
11138
|
+
}
|
|
11139
|
+
}
|
|
11140
|
+
},
|
|
11141
|
+
"post": {
|
|
11142
|
+
"tags": [
|
|
11143
|
+
"users",
|
|
11144
|
+
"V1"
|
|
11145
|
+
],
|
|
11146
|
+
"summary": "Create User",
|
|
11147
|
+
"description": "Create a new user.",
|
|
11148
|
+
"operationId": "users_create",
|
|
11149
|
+
"security": [
|
|
11150
|
+
{
|
|
11151
|
+
"APIKeyHeader": []
|
|
11152
|
+
}
|
|
11153
|
+
],
|
|
11154
|
+
"requestBody": {
|
|
11155
|
+
"required": true,
|
|
11156
|
+
"content": {
|
|
11157
|
+
"application/json": {
|
|
11158
|
+
"schema": {
|
|
11159
|
+
"$ref": "#/components/schemas/UserCreateRequest"
|
|
11160
|
+
}
|
|
11161
|
+
}
|
|
11162
|
+
}
|
|
11163
|
+
},
|
|
11164
|
+
"responses": {
|
|
11165
|
+
"200": {
|
|
11166
|
+
"description": "Successful Response",
|
|
11167
|
+
"content": {
|
|
11168
|
+
"application/json": {
|
|
11169
|
+
"schema": {
|
|
11170
|
+
"$ref": "#/components/schemas/UserResponse"
|
|
11171
|
+
}
|
|
11172
|
+
}
|
|
11173
|
+
}
|
|
11174
|
+
},
|
|
11175
|
+
"422": {
|
|
11176
|
+
"description": "Validation Error",
|
|
11177
|
+
"content": {
|
|
11178
|
+
"application/json": {
|
|
11179
|
+
"schema": {
|
|
11180
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
11181
|
+
}
|
|
11182
|
+
}
|
|
11183
|
+
}
|
|
11184
|
+
}
|
|
11185
|
+
}
|
|
11186
|
+
},
|
|
11187
|
+
"put": {
|
|
11188
|
+
"tags": [
|
|
11189
|
+
"users",
|
|
11190
|
+
"V1"
|
|
11191
|
+
],
|
|
11192
|
+
"summary": "Update User",
|
|
11193
|
+
"description": "Update an existing user.",
|
|
11194
|
+
"operationId": "users_update",
|
|
11195
|
+
"security": [
|
|
11196
|
+
{
|
|
11197
|
+
"APIKeyHeader": []
|
|
11198
|
+
}
|
|
11199
|
+
],
|
|
11200
|
+
"requestBody": {
|
|
11201
|
+
"required": true,
|
|
11202
|
+
"content": {
|
|
11203
|
+
"application/json": {
|
|
11204
|
+
"schema": {
|
|
11205
|
+
"$ref": "#/components/schemas/UserUpdateRequest"
|
|
11206
|
+
}
|
|
11207
|
+
}
|
|
11208
|
+
}
|
|
11209
|
+
},
|
|
11210
|
+
"responses": {
|
|
11211
|
+
"200": {
|
|
11212
|
+
"description": "Successful Response",
|
|
11213
|
+
"content": {
|
|
11214
|
+
"application/json": {
|
|
11215
|
+
"schema": {
|
|
11216
|
+
"$ref": "#/components/schemas/UserResponse"
|
|
11217
|
+
}
|
|
11218
|
+
}
|
|
11219
|
+
}
|
|
11220
|
+
},
|
|
11221
|
+
"422": {
|
|
11222
|
+
"description": "Validation Error",
|
|
11223
|
+
"content": {
|
|
11224
|
+
"application/json": {
|
|
11225
|
+
"schema": {
|
|
11226
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
11227
|
+
}
|
|
11228
|
+
}
|
|
11229
|
+
}
|
|
11230
|
+
}
|
|
11231
|
+
}
|
|
11232
|
+
},
|
|
11233
|
+
"delete": {
|
|
11234
|
+
"tags": [
|
|
11235
|
+
"users",
|
|
11236
|
+
"V1"
|
|
11237
|
+
],
|
|
11238
|
+
"summary": "Delete User",
|
|
11239
|
+
"description": "Delete a user.",
|
|
11240
|
+
"operationId": "users_delete",
|
|
11241
|
+
"security": [
|
|
11242
|
+
{
|
|
11243
|
+
"APIKeyHeader": []
|
|
11244
|
+
}
|
|
11245
|
+
],
|
|
11246
|
+
"requestBody": {
|
|
11247
|
+
"required": true,
|
|
11248
|
+
"content": {
|
|
11249
|
+
"application/json": {
|
|
11250
|
+
"schema": {
|
|
11251
|
+
"$ref": "#/components/schemas/UserDeleteRequest"
|
|
11252
|
+
}
|
|
11253
|
+
}
|
|
11254
|
+
}
|
|
11255
|
+
},
|
|
11256
|
+
"responses": {
|
|
11257
|
+
"200": {
|
|
11258
|
+
"description": "Successful Response",
|
|
11259
|
+
"content": {
|
|
11260
|
+
"application/json": {
|
|
11261
|
+
"schema": {}
|
|
11262
|
+
}
|
|
11263
|
+
}
|
|
11264
|
+
},
|
|
11265
|
+
"422": {
|
|
11266
|
+
"description": "Validation Error",
|
|
11267
|
+
"content": {
|
|
11268
|
+
"application/json": {
|
|
11269
|
+
"schema": {
|
|
11270
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
11271
|
+
}
|
|
11272
|
+
}
|
|
11273
|
+
}
|
|
11274
|
+
}
|
|
11275
|
+
}
|
|
11276
|
+
}
|
|
11277
|
+
},
|
|
11278
|
+
"/api/v1/users/{user_email}": {
|
|
11279
|
+
"get": {
|
|
11280
|
+
"tags": [
|
|
11281
|
+
"users",
|
|
11282
|
+
"V1"
|
|
11283
|
+
],
|
|
11284
|
+
"summary": "Get User",
|
|
11285
|
+
"description": "Fetch a given user.",
|
|
11286
|
+
"operationId": "users_get_by_email",
|
|
11287
|
+
"security": [
|
|
11288
|
+
{
|
|
11289
|
+
"APIKeyHeader": []
|
|
11290
|
+
}
|
|
11291
|
+
],
|
|
11292
|
+
"parameters": [
|
|
11293
|
+
{
|
|
11294
|
+
"name": "user_email",
|
|
11295
|
+
"in": "path",
|
|
11296
|
+
"required": true,
|
|
11297
|
+
"schema": {
|
|
11298
|
+
"type": "string",
|
|
11299
|
+
"title": "User Email"
|
|
11300
|
+
}
|
|
11301
|
+
}
|
|
11302
|
+
],
|
|
11303
|
+
"responses": {
|
|
11304
|
+
"200": {
|
|
11305
|
+
"description": "Successful Response",
|
|
11306
|
+
"content": {
|
|
11307
|
+
"application/json": {
|
|
11308
|
+
"schema": {
|
|
11309
|
+
"$ref": "#/components/schemas/UserResponse"
|
|
11310
|
+
}
|
|
11311
|
+
}
|
|
11312
|
+
}
|
|
11313
|
+
},
|
|
11314
|
+
"422": {
|
|
11315
|
+
"description": "Validation Error",
|
|
11316
|
+
"content": {
|
|
11317
|
+
"application/json": {
|
|
11318
|
+
"schema": {
|
|
11319
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
11320
|
+
}
|
|
11321
|
+
}
|
|
11322
|
+
}
|
|
11323
|
+
}
|
|
11324
|
+
}
|
|
11325
|
+
}
|
|
11326
|
+
},
|
|
11327
|
+
"/api/v1/users/delete_account": {
|
|
11328
|
+
"delete": {
|
|
11329
|
+
"tags": [
|
|
11330
|
+
"users",
|
|
11331
|
+
"V1"
|
|
11332
|
+
],
|
|
11333
|
+
"summary": "Request Removal Of This Account",
|
|
11334
|
+
"description": "Request removal of the account of the user calling this endpoint. Intended for removing trial\naccounts.",
|
|
11335
|
+
"operationId": "users_delete_account",
|
|
11336
|
+
"responses": {
|
|
11337
|
+
"200": {
|
|
11338
|
+
"description": "Successful Response",
|
|
11339
|
+
"content": {
|
|
11340
|
+
"application/json": {
|
|
11341
|
+
"schema": {}
|
|
11342
|
+
}
|
|
11343
|
+
}
|
|
11344
|
+
}
|
|
11345
|
+
},
|
|
11346
|
+
"security": [
|
|
11347
|
+
{
|
|
11348
|
+
"APIKeyHeader": []
|
|
11349
|
+
}
|
|
11350
|
+
]
|
|
11351
|
+
}
|
|
11352
|
+
}
|
|
11353
|
+
},
|
|
11354
|
+
"components": {
|
|
11355
|
+
"schemas": {
|
|
11356
|
+
"AgentCreate": {
|
|
11357
|
+
"properties": {
|
|
11358
|
+
"name": {
|
|
11359
|
+
"type": "string",
|
|
11360
|
+
"title": "Name",
|
|
11361
|
+
"description": "The agent name",
|
|
11362
|
+
"examples": [
|
|
11363
|
+
"Weather agent"
|
|
11364
|
+
]
|
|
11365
|
+
},
|
|
11366
|
+
"description": {
|
|
11367
|
+
"anyOf": [
|
|
11368
|
+
{
|
|
11369
|
+
"type": "string"
|
|
11370
|
+
},
|
|
11371
|
+
{
|
|
11372
|
+
"type": "null"
|
|
11373
|
+
}
|
|
11374
|
+
],
|
|
11375
|
+
"title": "Description",
|
|
11376
|
+
"description": "The agent description",
|
|
11377
|
+
"examples": [
|
|
11378
|
+
"Agent for answering questions about weather."
|
|
11379
|
+
]
|
|
11380
|
+
},
|
|
11381
|
+
"label": {
|
|
11382
|
+
"anyOf": [
|
|
11383
|
+
{
|
|
11384
|
+
"type": "string"
|
|
11385
|
+
},
|
|
11386
|
+
{
|
|
11387
|
+
"type": "null"
|
|
11388
|
+
}
|
|
11389
|
+
],
|
|
11390
|
+
"title": "Label",
|
|
11391
|
+
"description": "The agent label (DEPRECATED - use labels instead.)",
|
|
11392
|
+
"deprecated": true,
|
|
11393
|
+
"examples": [
|
|
11394
|
+
"Information"
|
|
11395
|
+
]
|
|
11396
|
+
},
|
|
11397
|
+
"labels": {
|
|
11398
|
+
"anyOf": [
|
|
11399
|
+
{
|
|
11400
|
+
"items": {
|
|
11401
|
+
"type": "string"
|
|
11402
|
+
},
|
|
11403
|
+
"type": "array"
|
|
11404
|
+
},
|
|
11405
|
+
{
|
|
11406
|
+
"type": "null"
|
|
11407
|
+
}
|
|
11408
|
+
],
|
|
11409
|
+
"title": "Labels",
|
|
11410
|
+
"description": "The agent labels",
|
|
11411
|
+
"examples": [
|
|
11412
|
+
[
|
|
11413
|
+
"Information",
|
|
11414
|
+
"Weather"
|
|
11415
|
+
]
|
|
11416
|
+
]
|
|
10911
11417
|
},
|
|
10912
11418
|
"type": {
|
|
10913
11419
|
"type": "string",
|
|
@@ -12059,7 +12565,7 @@
|
|
|
12059
12565
|
"title": "Batch Id",
|
|
12060
12566
|
"description": "Unique ID for conversation batch",
|
|
12061
12567
|
"examples": [
|
|
12062
|
-
"
|
|
12568
|
+
"20250603.9"
|
|
12063
12569
|
]
|
|
12064
12570
|
},
|
|
12065
12571
|
"campaign_id": {
|
|
@@ -12083,7 +12589,7 @@
|
|
|
12083
12589
|
"title": "Expires On",
|
|
12084
12590
|
"description": "Timestamp of batch expiration",
|
|
12085
12591
|
"examples": [
|
|
12086
|
-
"2025-
|
|
12592
|
+
"2025-06-04T00:00:00Z"
|
|
12087
12593
|
]
|
|
12088
12594
|
},
|
|
12089
12595
|
"paused": {
|
|
@@ -12136,7 +12642,7 @@
|
|
|
12136
12642
|
"title": "Created At",
|
|
12137
12643
|
"description": "Timestamp of batch creation",
|
|
12138
12644
|
"examples": [
|
|
12139
|
-
"2025-
|
|
12645
|
+
"2025-06-03T00:00:00Z"
|
|
12140
12646
|
]
|
|
12141
12647
|
},
|
|
12142
12648
|
"deleted_at": {
|
|
@@ -12152,7 +12658,7 @@
|
|
|
12152
12658
|
"title": "Deleted At",
|
|
12153
12659
|
"description": "Timestamp of batch deletion",
|
|
12154
12660
|
"examples": [
|
|
12155
|
-
"2025-
|
|
12661
|
+
"2025-06-03T00:00:00Z"
|
|
12156
12662
|
]
|
|
12157
12663
|
},
|
|
12158
12664
|
"deleted_reason": {
|
|
@@ -12183,7 +12689,7 @@
|
|
|
12183
12689
|
"title": "Last Updated At",
|
|
12184
12690
|
"description": "Timestamp of last change to batch",
|
|
12185
12691
|
"examples": [
|
|
12186
|
-
"2025-
|
|
12692
|
+
"2025-06-03T00:00:00Z"
|
|
12187
12693
|
]
|
|
12188
12694
|
},
|
|
12189
12695
|
"last_updated_by": {
|
|
@@ -12328,7 +12834,8 @@
|
|
|
12328
12834
|
"source",
|
|
12329
12835
|
"caller_id",
|
|
12330
12836
|
"updated_at",
|
|
12331
|
-
"label"
|
|
12837
|
+
"label",
|
|
12838
|
+
"labels"
|
|
12332
12839
|
],
|
|
12333
12840
|
"title": "CampaignProperties"
|
|
12334
12841
|
},
|
|
@@ -12698,7 +13205,7 @@
|
|
|
12698
13205
|
"title": "Batch Id",
|
|
12699
13206
|
"description": "Unique ID for conversation batch",
|
|
12700
13207
|
"examples": [
|
|
12701
|
-
"
|
|
13208
|
+
"20250603.9"
|
|
12702
13209
|
]
|
|
12703
13210
|
},
|
|
12704
13211
|
"campaign_id": {
|
|
@@ -12722,7 +13229,7 @@
|
|
|
12722
13229
|
"title": "Expires On",
|
|
12723
13230
|
"description": "Timestamp of batch expiration",
|
|
12724
13231
|
"examples": [
|
|
12725
|
-
"2025-
|
|
13232
|
+
"2025-06-04T00:00:00Z"
|
|
12726
13233
|
]
|
|
12727
13234
|
},
|
|
12728
13235
|
"paused": {
|
|
@@ -12775,7 +13282,7 @@
|
|
|
12775
13282
|
"title": "Created At",
|
|
12776
13283
|
"description": "Timestamp of batch creation",
|
|
12777
13284
|
"examples": [
|
|
12778
|
-
"2025-
|
|
13285
|
+
"2025-06-03T00:00:00Z"
|
|
12779
13286
|
]
|
|
12780
13287
|
},
|
|
12781
13288
|
"deleted_at": {
|
|
@@ -12791,7 +13298,7 @@
|
|
|
12791
13298
|
"title": "Deleted At",
|
|
12792
13299
|
"description": "Timestamp of batch deletion",
|
|
12793
13300
|
"examples": [
|
|
12794
|
-
"2025-
|
|
13301
|
+
"2025-06-03T00:00:00Z"
|
|
12795
13302
|
]
|
|
12796
13303
|
},
|
|
12797
13304
|
"deleted_reason": {
|
|
@@ -12822,7 +13329,7 @@
|
|
|
12822
13329
|
"title": "Last Updated At",
|
|
12823
13330
|
"description": "Timestamp of last change to batch",
|
|
12824
13331
|
"examples": [
|
|
12825
|
-
"2025-
|
|
13332
|
+
"2025-06-03T00:00:00Z"
|
|
12826
13333
|
]
|
|
12827
13334
|
},
|
|
12828
13335
|
"last_updated_by": {
|
|
@@ -12865,7 +13372,7 @@
|
|
|
12865
13372
|
"title": "Batch Id",
|
|
12866
13373
|
"description": "Unique ID for conversation batch",
|
|
12867
13374
|
"examples": [
|
|
12868
|
-
"
|
|
13375
|
+
"20250603.9"
|
|
12869
13376
|
]
|
|
12870
13377
|
},
|
|
12871
13378
|
"campaign_id": {
|
|
@@ -12889,7 +13396,7 @@
|
|
|
12889
13396
|
"title": "Expires On",
|
|
12890
13397
|
"description": "Timestamp of batch expiration",
|
|
12891
13398
|
"examples": [
|
|
12892
|
-
"2025-
|
|
13399
|
+
"2025-06-04T00:00:00Z"
|
|
12893
13400
|
]
|
|
12894
13401
|
},
|
|
12895
13402
|
"paused": {
|
|
@@ -13038,7 +13545,7 @@
|
|
|
13038
13545
|
"title": "Created At",
|
|
13039
13546
|
"description": "Timestamp of request creation",
|
|
13040
13547
|
"examples": [
|
|
13041
|
-
"2025-
|
|
13548
|
+
"2025-06-02T00:00:00Z"
|
|
13042
13549
|
]
|
|
13043
13550
|
},
|
|
13044
13551
|
"sent_at": {
|
|
@@ -13054,7 +13561,7 @@
|
|
|
13054
13561
|
"title": "Sent At",
|
|
13055
13562
|
"description": "Timestamp at which request was sent",
|
|
13056
13563
|
"examples": [
|
|
13057
|
-
"2025-
|
|
13564
|
+
"2025-06-03T00:00:00Z"
|
|
13058
13565
|
]
|
|
13059
13566
|
},
|
|
13060
13567
|
"attempt_count": {
|
|
@@ -14954,7 +15461,7 @@
|
|
|
14954
15461
|
"title": "Created At",
|
|
14955
15462
|
"description": "Timestamp at which insight upload folder was created",
|
|
14956
15463
|
"examples": [
|
|
14957
|
-
"2025-
|
|
15464
|
+
"2025-06-02T00:00:00Z"
|
|
14958
15465
|
]
|
|
14959
15466
|
},
|
|
14960
15467
|
"updated_at": {
|
|
@@ -14963,7 +15470,7 @@
|
|
|
14963
15470
|
"title": "Updated At",
|
|
14964
15471
|
"description": "Timestamp at which insight upload folder was last updated",
|
|
14965
15472
|
"examples": [
|
|
14966
|
-
"2025-
|
|
15473
|
+
"2025-06-03T00:00:00Z"
|
|
14967
15474
|
]
|
|
14968
15475
|
},
|
|
14969
15476
|
"last_updated_by": {
|
|
@@ -15678,7 +16185,7 @@
|
|
|
15678
16185
|
"title": "Created At",
|
|
15679
16186
|
"description": "Timestamp of at which insight tool configuration was created",
|
|
15680
16187
|
"examples": [
|
|
15681
|
-
"2025-
|
|
16188
|
+
"2025-06-02T00:00:00Z"
|
|
15682
16189
|
]
|
|
15683
16190
|
},
|
|
15684
16191
|
"updated_at": {
|
|
@@ -15687,7 +16194,7 @@
|
|
|
15687
16194
|
"title": "Updated At",
|
|
15688
16195
|
"description": "Timestamp at which insight tool configuration was last updated",
|
|
15689
16196
|
"examples": [
|
|
15690
|
-
"2025-
|
|
16197
|
+
"2025-06-03T00:00:00Z"
|
|
15691
16198
|
]
|
|
15692
16199
|
},
|
|
15693
16200
|
"last_updated_by": {
|
|
@@ -16042,7 +16549,7 @@
|
|
|
16042
16549
|
"title": "Start Datetime",
|
|
16043
16550
|
"description": "Timestamp for when the insight workflow should start. An empty value indicates start on activation",
|
|
16044
16551
|
"examples": [
|
|
16045
|
-
"2025-
|
|
16552
|
+
"2025-06-02T00:00:00Z"
|
|
16046
16553
|
]
|
|
16047
16554
|
},
|
|
16048
16555
|
"end_datetime": {
|
|
@@ -16058,7 +16565,7 @@
|
|
|
16058
16565
|
"title": "End Datetime",
|
|
16059
16566
|
"description": "Timestamp of when the insight workflow should end. An empty value indicates no end",
|
|
16060
16567
|
"examples": [
|
|
16061
|
-
"2025-
|
|
16568
|
+
"2025-06-03T00:00:00Z"
|
|
16062
16569
|
]
|
|
16063
16570
|
}
|
|
16064
16571
|
},
|
|
@@ -16132,7 +16639,7 @@
|
|
|
16132
16639
|
"title": "Start Datetime",
|
|
16133
16640
|
"description": "Timestamp for when the insight workflow should start. An empty value indicates start on activation",
|
|
16134
16641
|
"examples": [
|
|
16135
|
-
"2025-
|
|
16642
|
+
"2025-06-02T00:00:00Z"
|
|
16136
16643
|
]
|
|
16137
16644
|
},
|
|
16138
16645
|
"end_datetime": {
|
|
@@ -16148,7 +16655,7 @@
|
|
|
16148
16655
|
"title": "End Datetime",
|
|
16149
16656
|
"description": "Timestamp of when the insight workflow should end. An empty value indicates no end",
|
|
16150
16657
|
"examples": [
|
|
16151
|
-
"2025-
|
|
16658
|
+
"2025-06-03T00:00:00Z"
|
|
16152
16659
|
]
|
|
16153
16660
|
},
|
|
16154
16661
|
"id": {
|
|
@@ -16201,7 +16708,7 @@
|
|
|
16201
16708
|
"title": "Created At",
|
|
16202
16709
|
"description": "Timestamp at which the insight workflow was created",
|
|
16203
16710
|
"examples": [
|
|
16204
|
-
"2025-
|
|
16711
|
+
"2025-06-02T00:00:00Z"
|
|
16205
16712
|
]
|
|
16206
16713
|
},
|
|
16207
16714
|
"updated_at": {
|
|
@@ -16210,7 +16717,7 @@
|
|
|
16210
16717
|
"title": "Updated At",
|
|
16211
16718
|
"description": "Timestamp of most recent update to the insight workflow",
|
|
16212
16719
|
"examples": [
|
|
16213
|
-
"2025-
|
|
16720
|
+
"2025-06-03T00:00:00Z"
|
|
16214
16721
|
]
|
|
16215
16722
|
},
|
|
16216
16723
|
"last_updated_by": {
|
|
@@ -16306,7 +16813,7 @@
|
|
|
16306
16813
|
"title": "Created At",
|
|
16307
16814
|
"description": "Timestamp at which insight upload folder was created",
|
|
16308
16815
|
"examples": [
|
|
16309
|
-
"2025-
|
|
16816
|
+
"2025-06-02T00:00:00Z"
|
|
16310
16817
|
]
|
|
16311
16818
|
},
|
|
16312
16819
|
"updated_at": {
|
|
@@ -16315,7 +16822,7 @@
|
|
|
16315
16822
|
"title": "Updated At",
|
|
16316
16823
|
"description": "Timestamp at which insight upload folder was last updated",
|
|
16317
16824
|
"examples": [
|
|
16318
|
-
"2025-
|
|
16825
|
+
"2025-06-03T00:00:00Z"
|
|
16319
16826
|
]
|
|
16320
16827
|
},
|
|
16321
16828
|
"last_updated_by": {
|
|
@@ -16550,7 +17057,7 @@
|
|
|
16550
17057
|
"title": "Created At",
|
|
16551
17058
|
"description": "Timestamp at which insight tool result was created",
|
|
16552
17059
|
"examples": [
|
|
16553
|
-
"2025-
|
|
17060
|
+
"2025-06-02T00:00:00Z"
|
|
16554
17061
|
]
|
|
16555
17062
|
},
|
|
16556
17063
|
"updated_at": {
|
|
@@ -16559,7 +17066,7 @@
|
|
|
16559
17066
|
"title": "Updated At",
|
|
16560
17067
|
"description": "Timestamp at which insight tool result was last updated",
|
|
16561
17068
|
"examples": [
|
|
16562
|
-
"2025-
|
|
17069
|
+
"2025-06-03T00:00:00Z"
|
|
16563
17070
|
]
|
|
16564
17071
|
}
|
|
16565
17072
|
},
|
|
@@ -16694,7 +17201,7 @@
|
|
|
16694
17201
|
"title": "Start Time",
|
|
16695
17202
|
"description": "Start time of the uploaded file",
|
|
16696
17203
|
"examples": [
|
|
16697
|
-
"2025-
|
|
17204
|
+
"2025-06-02T00:00:00Z"
|
|
16698
17205
|
]
|
|
16699
17206
|
},
|
|
16700
17207
|
"end_time": {
|
|
@@ -16710,7 +17217,7 @@
|
|
|
16710
17217
|
"title": "End Time",
|
|
16711
17218
|
"description": "End time of the uploaded file",
|
|
16712
17219
|
"examples": [
|
|
16713
|
-
"2025-
|
|
17220
|
+
"2025-06-03T00:00:00Z"
|
|
16714
17221
|
]
|
|
16715
17222
|
},
|
|
16716
17223
|
"error_message": {
|
|
@@ -16765,7 +17272,7 @@
|
|
|
16765
17272
|
"title": "Created At",
|
|
16766
17273
|
"description": "Timestamp at which insight upload file was created",
|
|
16767
17274
|
"examples": [
|
|
16768
|
-
"2025-
|
|
17275
|
+
"2025-06-02T00:00:00Z"
|
|
16769
17276
|
]
|
|
16770
17277
|
}
|
|
16771
17278
|
},
|
|
@@ -16908,7 +17415,9 @@
|
|
|
16908
17415
|
"en-US",
|
|
16909
17416
|
"ko-KR",
|
|
16910
17417
|
"zh-CN",
|
|
17418
|
+
"fa-IR",
|
|
16911
17419
|
"es-US",
|
|
17420
|
+
"zh-TW",
|
|
16912
17421
|
"th-TH",
|
|
16913
17422
|
"vi-VN"
|
|
16914
17423
|
],
|
|
@@ -17057,7 +17566,7 @@
|
|
|
17057
17566
|
{
|
|
17058
17567
|
"dtmf_code": 2,
|
|
17059
17568
|
"language_code": "es-US",
|
|
17060
|
-
"voice_display_name": "
|
|
17569
|
+
"voice_display_name": "es-US-Neural2-B",
|
|
17061
17570
|
"voice_provider": "Google"
|
|
17062
17571
|
}
|
|
17063
17572
|
]
|
|
@@ -17136,7 +17645,7 @@
|
|
|
17136
17645
|
{
|
|
17137
17646
|
"dtmf_code": 2,
|
|
17138
17647
|
"language_code": "es-US",
|
|
17139
|
-
"voice_display_name": "
|
|
17648
|
+
"voice_display_name": "es-US-Neural2-B",
|
|
17140
17649
|
"voice_provider": "Google"
|
|
17141
17650
|
}
|
|
17142
17651
|
]
|
|
@@ -17269,7 +17778,7 @@
|
|
|
17269
17778
|
{
|
|
17270
17779
|
"dtmf_code": 2,
|
|
17271
17780
|
"language_code": "es-US",
|
|
17272
|
-
"voice_display_name": "
|
|
17781
|
+
"voice_display_name": "es-US-Neural2-B",
|
|
17273
17782
|
"voice_provider": "Google"
|
|
17274
17783
|
}
|
|
17275
17784
|
]
|
|
@@ -19050,7 +19559,73 @@
|
|
|
19050
19559
|
"page",
|
|
19051
19560
|
"page_size"
|
|
19052
19561
|
],
|
|
19053
|
-
"title": "ListResponse[ToolResponse]"
|
|
19562
|
+
"title": "ListResponse[ToolResponse]"
|
|
19563
|
+
},
|
|
19564
|
+
"ListResponse_UserResponse_": {
|
|
19565
|
+
"properties": {
|
|
19566
|
+
"items": {
|
|
19567
|
+
"items": {
|
|
19568
|
+
"$ref": "#/components/schemas/UserResponse"
|
|
19569
|
+
},
|
|
19570
|
+
"type": "array",
|
|
19571
|
+
"title": "Items",
|
|
19572
|
+
"description": "List of items returned from the query",
|
|
19573
|
+
"examples": []
|
|
19574
|
+
},
|
|
19575
|
+
"page": {
|
|
19576
|
+
"type": "integer",
|
|
19577
|
+
"title": "Page",
|
|
19578
|
+
"description": "The page number of the results (0-based)",
|
|
19579
|
+
"examples": [
|
|
19580
|
+
0
|
|
19581
|
+
]
|
|
19582
|
+
},
|
|
19583
|
+
"page_size": {
|
|
19584
|
+
"type": "integer",
|
|
19585
|
+
"title": "Page Size",
|
|
19586
|
+
"description": "The number of items returned per page",
|
|
19587
|
+
"examples": [
|
|
19588
|
+
25
|
|
19589
|
+
]
|
|
19590
|
+
},
|
|
19591
|
+
"total_pages": {
|
|
19592
|
+
"anyOf": [
|
|
19593
|
+
{
|
|
19594
|
+
"type": "integer"
|
|
19595
|
+
},
|
|
19596
|
+
{
|
|
19597
|
+
"type": "null"
|
|
19598
|
+
}
|
|
19599
|
+
],
|
|
19600
|
+
"title": "Total Pages",
|
|
19601
|
+
"description": "The total number of pages of results given the indicated page size",
|
|
19602
|
+
"examples": [
|
|
19603
|
+
4
|
|
19604
|
+
]
|
|
19605
|
+
},
|
|
19606
|
+
"total_count": {
|
|
19607
|
+
"anyOf": [
|
|
19608
|
+
{
|
|
19609
|
+
"type": "integer"
|
|
19610
|
+
},
|
|
19611
|
+
{
|
|
19612
|
+
"type": "null"
|
|
19613
|
+
}
|
|
19614
|
+
],
|
|
19615
|
+
"title": "Total Count",
|
|
19616
|
+
"description": "The total number of items returned from the query",
|
|
19617
|
+
"examples": [
|
|
19618
|
+
100
|
|
19619
|
+
]
|
|
19620
|
+
}
|
|
19621
|
+
},
|
|
19622
|
+
"type": "object",
|
|
19623
|
+
"required": [
|
|
19624
|
+
"items",
|
|
19625
|
+
"page",
|
|
19626
|
+
"page_size"
|
|
19627
|
+
],
|
|
19628
|
+
"title": "ListResponse[UserResponse]"
|
|
19054
19629
|
},
|
|
19055
19630
|
"OrderByDirection": {
|
|
19056
19631
|
"type": "string",
|
|
@@ -19096,12 +19671,34 @@
|
|
|
19096
19671
|
}
|
|
19097
19672
|
],
|
|
19098
19673
|
"title": "Label",
|
|
19099
|
-
"description": "Label for campaign",
|
|
19674
|
+
"description": "Label for campaign (DEPRECATED - use labels instead)",
|
|
19675
|
+
"deprecated": true,
|
|
19100
19676
|
"examples": [
|
|
19101
19677
|
"test",
|
|
19102
19678
|
"demo"
|
|
19103
19679
|
]
|
|
19104
19680
|
},
|
|
19681
|
+
"labels": {
|
|
19682
|
+
"anyOf": [
|
|
19683
|
+
{
|
|
19684
|
+
"items": {
|
|
19685
|
+
"type": "string"
|
|
19686
|
+
},
|
|
19687
|
+
"type": "array"
|
|
19688
|
+
},
|
|
19689
|
+
{
|
|
19690
|
+
"type": "null"
|
|
19691
|
+
}
|
|
19692
|
+
],
|
|
19693
|
+
"title": "Labels",
|
|
19694
|
+
"description": "Labels for campaign",
|
|
19695
|
+
"examples": [
|
|
19696
|
+
[
|
|
19697
|
+
"test",
|
|
19698
|
+
"demo"
|
|
19699
|
+
]
|
|
19700
|
+
]
|
|
19701
|
+
},
|
|
19105
19702
|
"campaign_variables": {
|
|
19106
19703
|
"additionalProperties": {
|
|
19107
19704
|
"type": "string"
|
|
@@ -19252,7 +19849,7 @@
|
|
|
19252
19849
|
"title": "Created At",
|
|
19253
19850
|
"description": "Timestamp of campaign creation",
|
|
19254
19851
|
"examples": [
|
|
19255
|
-
"2025-
|
|
19852
|
+
"2025-06-03T00:00:00Z"
|
|
19256
19853
|
]
|
|
19257
19854
|
},
|
|
19258
19855
|
"updated_at": {
|
|
@@ -19261,7 +19858,7 @@
|
|
|
19261
19858
|
"title": "Updated At",
|
|
19262
19859
|
"description": "Timestamp of campaign update",
|
|
19263
19860
|
"examples": [
|
|
19264
|
-
"2025-
|
|
19861
|
+
"2025-06-03T00:00:00Z"
|
|
19265
19862
|
]
|
|
19266
19863
|
},
|
|
19267
19864
|
"last_updated_by": {
|
|
@@ -19319,12 +19916,34 @@
|
|
|
19319
19916
|
}
|
|
19320
19917
|
],
|
|
19321
19918
|
"title": "Label",
|
|
19322
|
-
"description": "Label for campaign",
|
|
19919
|
+
"description": "Label for campaign (DEPRECATED - use labels instead)",
|
|
19920
|
+
"deprecated": true,
|
|
19323
19921
|
"examples": [
|
|
19324
19922
|
"test",
|
|
19325
19923
|
"demo"
|
|
19326
19924
|
]
|
|
19327
19925
|
},
|
|
19926
|
+
"labels": {
|
|
19927
|
+
"anyOf": [
|
|
19928
|
+
{
|
|
19929
|
+
"items": {
|
|
19930
|
+
"type": "string"
|
|
19931
|
+
},
|
|
19932
|
+
"type": "array"
|
|
19933
|
+
},
|
|
19934
|
+
{
|
|
19935
|
+
"type": "null"
|
|
19936
|
+
}
|
|
19937
|
+
],
|
|
19938
|
+
"title": "Labels",
|
|
19939
|
+
"description": "Labels for campaign",
|
|
19940
|
+
"examples": [
|
|
19941
|
+
[
|
|
19942
|
+
"test",
|
|
19943
|
+
"demo"
|
|
19944
|
+
]
|
|
19945
|
+
]
|
|
19946
|
+
},
|
|
19328
19947
|
"campaign_variables": {
|
|
19329
19948
|
"additionalProperties": {
|
|
19330
19949
|
"type": "string"
|
|
@@ -22328,18 +22947,264 @@
|
|
|
22328
22947
|
"title": "Service Id",
|
|
22329
22948
|
"description": "Internal ID of the service to which the tool belongs",
|
|
22330
22949
|
"examples": [
|
|
22331
|
-
1
|
|
22950
|
+
1
|
|
22951
|
+
]
|
|
22952
|
+
},
|
|
22953
|
+
"id": {
|
|
22954
|
+
"type": "integer",
|
|
22955
|
+
"title": "Id",
|
|
22956
|
+
"description": "The internal ID of the tool",
|
|
22957
|
+
"examples": [
|
|
22958
|
+
1
|
|
22959
|
+
]
|
|
22960
|
+
},
|
|
22961
|
+
"last_updated_comments": {
|
|
22962
|
+
"anyOf": [
|
|
22963
|
+
{
|
|
22964
|
+
"type": "string"
|
|
22965
|
+
},
|
|
22966
|
+
{
|
|
22967
|
+
"type": "null"
|
|
22968
|
+
}
|
|
22969
|
+
],
|
|
22970
|
+
"title": "Last Updated Comments",
|
|
22971
|
+
"description": "Comments for the most recent edit to the tool.",
|
|
22972
|
+
"examples": [
|
|
22973
|
+
"Updated to use new API endpoint"
|
|
22974
|
+
]
|
|
22975
|
+
},
|
|
22976
|
+
"service_name": {
|
|
22977
|
+
"anyOf": [
|
|
22978
|
+
{
|
|
22979
|
+
"type": "string"
|
|
22980
|
+
},
|
|
22981
|
+
{
|
|
22982
|
+
"type": "null"
|
|
22983
|
+
}
|
|
22984
|
+
],
|
|
22985
|
+
"title": "Service Name",
|
|
22986
|
+
"description": "The name of the service to which the tool belongs"
|
|
22987
|
+
},
|
|
22988
|
+
"prompts_info": {
|
|
22989
|
+
"anyOf": [
|
|
22990
|
+
{
|
|
22991
|
+
"items": {
|
|
22992
|
+
"$ref": "#/components/schemas/ToolPromptInfo"
|
|
22993
|
+
},
|
|
22994
|
+
"type": "array"
|
|
22995
|
+
},
|
|
22996
|
+
{
|
|
22997
|
+
"type": "null"
|
|
22998
|
+
}
|
|
22999
|
+
],
|
|
23000
|
+
"title": "Prompts Info",
|
|
23001
|
+
"description": "IDs and names of the prompts linked to the tool"
|
|
23002
|
+
},
|
|
23003
|
+
"agents_info": {
|
|
23004
|
+
"anyOf": [
|
|
23005
|
+
{
|
|
23006
|
+
"items": {
|
|
23007
|
+
"$ref": "#/components/schemas/ToolAgentInfo"
|
|
23008
|
+
},
|
|
23009
|
+
"type": "array"
|
|
23010
|
+
},
|
|
23011
|
+
{
|
|
23012
|
+
"type": "null"
|
|
23013
|
+
}
|
|
23014
|
+
],
|
|
23015
|
+
"title": "Agents Info",
|
|
23016
|
+
"description": "IDs and names of the agents linked to the tool via a prompt"
|
|
23017
|
+
},
|
|
23018
|
+
"last_updated": {
|
|
23019
|
+
"type": "string",
|
|
23020
|
+
"format": "date-time",
|
|
23021
|
+
"title": "Last Updated",
|
|
23022
|
+
"description": "The timestamp of the most recent update to the tool"
|
|
23023
|
+
},
|
|
23024
|
+
"last_updated_by": {
|
|
23025
|
+
"type": "string",
|
|
23026
|
+
"title": "Last Updated By",
|
|
23027
|
+
"description": "The email of the user who last updated the tool",
|
|
23028
|
+
"examples": [
|
|
23029
|
+
"user@email.com"
|
|
23030
|
+
]
|
|
23031
|
+
}
|
|
23032
|
+
},
|
|
23033
|
+
"type": "object",
|
|
23034
|
+
"required": [
|
|
23035
|
+
"name",
|
|
23036
|
+
"definition",
|
|
23037
|
+
"service_id",
|
|
23038
|
+
"id",
|
|
23039
|
+
"last_updated",
|
|
23040
|
+
"last_updated_by"
|
|
23041
|
+
],
|
|
23042
|
+
"title": "ToolResponse",
|
|
23043
|
+
"description": "Response model for tool operations.\nA tool is a function that an agent can call to perform actions like accessing databases,\nmaking API calls, or processing data. For an agent to have access to a tool, the prompt\nassociated with that agent should be linked to the tool and include instructions to use it.\nFor more information, see [Console docs](https://docs.syllable.ai/Resources/Tools)."
|
|
23044
|
+
},
|
|
23045
|
+
"ToolResultData": {
|
|
23046
|
+
"properties": {
|
|
23047
|
+
"tool_name": {
|
|
23048
|
+
"type": "string",
|
|
23049
|
+
"title": "Tool Name",
|
|
23050
|
+
"description": "Tool name",
|
|
23051
|
+
"examples": [
|
|
23052
|
+
"general_information_web"
|
|
23053
|
+
]
|
|
23054
|
+
},
|
|
23055
|
+
"tool_result": {
|
|
23056
|
+
"title": "Tool Result",
|
|
23057
|
+
"description": "Tool result data",
|
|
23058
|
+
"examples": [
|
|
23059
|
+
{
|
|
23060
|
+
"answer": "Syllable is a platform for building and managing AI voice agents..."
|
|
23061
|
+
}
|
|
23062
|
+
]
|
|
23063
|
+
}
|
|
23064
|
+
},
|
|
23065
|
+
"type": "object",
|
|
23066
|
+
"required": [
|
|
23067
|
+
"tool_name",
|
|
23068
|
+
"tool_result"
|
|
23069
|
+
],
|
|
23070
|
+
"title": "ToolResultData"
|
|
23071
|
+
},
|
|
23072
|
+
"ToolUpdateRequest": {
|
|
23073
|
+
"properties": {
|
|
23074
|
+
"name": {
|
|
23075
|
+
"type": "string",
|
|
23076
|
+
"title": "Name",
|
|
23077
|
+
"description": "The name of the tool",
|
|
23078
|
+
"examples": [
|
|
23079
|
+
"Weather Fetcher"
|
|
23080
|
+
]
|
|
23081
|
+
},
|
|
23082
|
+
"definition": {
|
|
23083
|
+
"$ref": "#/components/schemas/ToolDefinition",
|
|
23084
|
+
"description": "The definition of the tool",
|
|
23085
|
+
"examples": [
|
|
23086
|
+
{
|
|
23087
|
+
"endpoint": {
|
|
23088
|
+
"argument_location": "query",
|
|
23089
|
+
"method": "get",
|
|
23090
|
+
"url": "https://api.open-meteo.com/v1/forecast"
|
|
23091
|
+
},
|
|
23092
|
+
"tool": {
|
|
23093
|
+
"function": {
|
|
23094
|
+
"description": "Get the weather for a city",
|
|
23095
|
+
"name": "get_weather",
|
|
23096
|
+
"parameters": {
|
|
23097
|
+
"properties": {
|
|
23098
|
+
"latitude": {
|
|
23099
|
+
"description": "Latitude of the city",
|
|
23100
|
+
"type": "number"
|
|
23101
|
+
},
|
|
23102
|
+
"longitude": {
|
|
23103
|
+
"description": "Longitude of the city",
|
|
23104
|
+
"type": "number"
|
|
23105
|
+
},
|
|
23106
|
+
"current": {
|
|
23107
|
+
"default": "temperature_2m,relative_humidity_2m,precipitation,rain,showers",
|
|
23108
|
+
"description": "Information to retrieve from the open-meteo API, comma-separated",
|
|
23109
|
+
"type": "string"
|
|
23110
|
+
}
|
|
23111
|
+
},
|
|
23112
|
+
"required": [
|
|
23113
|
+
"latitude",
|
|
23114
|
+
"longitude",
|
|
23115
|
+
"current"
|
|
23116
|
+
],
|
|
23117
|
+
"type": "object"
|
|
23118
|
+
}
|
|
23119
|
+
},
|
|
23120
|
+
"type": "function"
|
|
23121
|
+
},
|
|
23122
|
+
"type": "endpoint"
|
|
23123
|
+
}
|
|
23124
|
+
]
|
|
23125
|
+
},
|
|
23126
|
+
"service_id": {
|
|
23127
|
+
"type": "integer",
|
|
23128
|
+
"title": "Service Id",
|
|
23129
|
+
"description": "Internal ID of the service to which the tool belongs",
|
|
23130
|
+
"examples": [
|
|
23131
|
+
1
|
|
23132
|
+
]
|
|
23133
|
+
},
|
|
23134
|
+
"id": {
|
|
23135
|
+
"type": "integer",
|
|
23136
|
+
"title": "Id",
|
|
23137
|
+
"description": "The internal ID of the tool",
|
|
23138
|
+
"examples": [
|
|
23139
|
+
1
|
|
23140
|
+
]
|
|
23141
|
+
},
|
|
23142
|
+
"last_updated_comments": {
|
|
23143
|
+
"anyOf": [
|
|
23144
|
+
{
|
|
23145
|
+
"type": "string"
|
|
23146
|
+
},
|
|
23147
|
+
{
|
|
23148
|
+
"type": "null"
|
|
23149
|
+
}
|
|
23150
|
+
],
|
|
23151
|
+
"title": "Last Updated Comments",
|
|
23152
|
+
"description": "Comments for the most recent edit to the tool.",
|
|
23153
|
+
"examples": [
|
|
23154
|
+
"Updated to use new API endpoint"
|
|
23155
|
+
]
|
|
23156
|
+
}
|
|
23157
|
+
},
|
|
23158
|
+
"type": "object",
|
|
23159
|
+
"required": [
|
|
23160
|
+
"name",
|
|
23161
|
+
"definition",
|
|
23162
|
+
"service_id",
|
|
23163
|
+
"id"
|
|
23164
|
+
],
|
|
23165
|
+
"title": "ToolUpdateRequest",
|
|
23166
|
+
"description": "Request model to update an existing tool."
|
|
23167
|
+
},
|
|
23168
|
+
"TtsProvider": {
|
|
23169
|
+
"type": "string",
|
|
23170
|
+
"enum": [
|
|
23171
|
+
"OpenAI",
|
|
23172
|
+
"ElevenLabs",
|
|
23173
|
+
"Google"
|
|
23174
|
+
],
|
|
23175
|
+
"title": "TtsProvider",
|
|
23176
|
+
"description": "TTS provider for an agent voice."
|
|
23177
|
+
},
|
|
23178
|
+
"TwilioChannelConfigCreate": {
|
|
23179
|
+
"properties": {
|
|
23180
|
+
"account_sid": {
|
|
23181
|
+
"type": "string",
|
|
23182
|
+
"title": "Account Sid",
|
|
23183
|
+
"description": "SID of the Twilio account",
|
|
23184
|
+
"examples": [
|
|
23185
|
+
"AC123..."
|
|
22332
23186
|
]
|
|
22333
23187
|
},
|
|
22334
|
-
"
|
|
22335
|
-
"type": "
|
|
22336
|
-
"title": "
|
|
22337
|
-
"description": "The
|
|
23188
|
+
"auth_token": {
|
|
23189
|
+
"type": "string",
|
|
23190
|
+
"title": "Auth Token",
|
|
23191
|
+
"description": "The Twilio auth token",
|
|
22338
23192
|
"examples": [
|
|
22339
|
-
|
|
23193
|
+
"sometoken"
|
|
22340
23194
|
]
|
|
22341
|
-
}
|
|
22342
|
-
|
|
23195
|
+
}
|
|
23196
|
+
},
|
|
23197
|
+
"type": "object",
|
|
23198
|
+
"required": [
|
|
23199
|
+
"account_sid",
|
|
23200
|
+
"auth_token"
|
|
23201
|
+
],
|
|
23202
|
+
"title": "TwilioChannelConfigCreate",
|
|
23203
|
+
"description": "Twilio channel config information."
|
|
23204
|
+
},
|
|
23205
|
+
"TwilioChannelConfigUpdate": {
|
|
23206
|
+
"properties": {
|
|
23207
|
+
"account_sid": {
|
|
22343
23208
|
"anyOf": [
|
|
22344
23209
|
{
|
|
22345
23210
|
"type": "string"
|
|
@@ -22348,13 +23213,13 @@
|
|
|
22348
23213
|
"type": "null"
|
|
22349
23214
|
}
|
|
22350
23215
|
],
|
|
22351
|
-
"title": "
|
|
22352
|
-
"description": "
|
|
23216
|
+
"title": "Account Sid",
|
|
23217
|
+
"description": "SID of the Twilio account",
|
|
22353
23218
|
"examples": [
|
|
22354
|
-
"
|
|
23219
|
+
"AC123..."
|
|
22355
23220
|
]
|
|
22356
23221
|
},
|
|
22357
|
-
"
|
|
23222
|
+
"auth_token": {
|
|
22358
23223
|
"anyOf": [
|
|
22359
23224
|
{
|
|
22360
23225
|
"type": "string"
|
|
@@ -22363,164 +23228,260 @@
|
|
|
22363
23228
|
"type": "null"
|
|
22364
23229
|
}
|
|
22365
23230
|
],
|
|
22366
|
-
"title": "
|
|
22367
|
-
"description": "The
|
|
23231
|
+
"title": "Auth Token",
|
|
23232
|
+
"description": "The Twilio auth token",
|
|
23233
|
+
"examples": [
|
|
23234
|
+
"sometoken"
|
|
23235
|
+
]
|
|
23236
|
+
}
|
|
23237
|
+
},
|
|
23238
|
+
"type": "object",
|
|
23239
|
+
"title": "TwilioChannelConfigUpdate",
|
|
23240
|
+
"description": "Twilio channel config information. If a field is passed as None, it will not be updated."
|
|
23241
|
+
},
|
|
23242
|
+
"TwilioChannelCreateRequest": {
|
|
23243
|
+
"properties": {
|
|
23244
|
+
"name": {
|
|
23245
|
+
"type": "string",
|
|
23246
|
+
"title": "Name",
|
|
23247
|
+
"description": "The channel name",
|
|
23248
|
+
"examples": [
|
|
23249
|
+
"syllable-webchat"
|
|
23250
|
+
]
|
|
22368
23251
|
},
|
|
22369
|
-
"
|
|
23252
|
+
"config": {
|
|
23253
|
+
"$ref": "#/components/schemas/TwilioChannelConfigCreate",
|
|
23254
|
+
"description": "The configuration of the channel"
|
|
23255
|
+
}
|
|
23256
|
+
},
|
|
23257
|
+
"type": "object",
|
|
23258
|
+
"required": [
|
|
23259
|
+
"name",
|
|
23260
|
+
"config"
|
|
23261
|
+
],
|
|
23262
|
+
"title": "TwilioChannelCreateRequest",
|
|
23263
|
+
"description": "Request model for creating a Twilio channel."
|
|
23264
|
+
},
|
|
23265
|
+
"TwilioChannelUpdateRequest": {
|
|
23266
|
+
"properties": {
|
|
23267
|
+
"id": {
|
|
23268
|
+
"type": "integer",
|
|
23269
|
+
"title": "Id",
|
|
23270
|
+
"description": "The internal ID of the channel",
|
|
23271
|
+
"examples": [
|
|
23272
|
+
1
|
|
23273
|
+
]
|
|
23274
|
+
},
|
|
23275
|
+
"name": {
|
|
22370
23276
|
"anyOf": [
|
|
22371
23277
|
{
|
|
22372
|
-
"
|
|
22373
|
-
"$ref": "#/components/schemas/ToolPromptInfo"
|
|
22374
|
-
},
|
|
22375
|
-
"type": "array"
|
|
23278
|
+
"type": "string"
|
|
22376
23279
|
},
|
|
22377
23280
|
{
|
|
22378
23281
|
"type": "null"
|
|
22379
23282
|
}
|
|
22380
23283
|
],
|
|
22381
|
-
"title": "
|
|
22382
|
-
"description": "
|
|
23284
|
+
"title": "Name",
|
|
23285
|
+
"description": "The name of the channel",
|
|
23286
|
+
"examples": [
|
|
23287
|
+
"syllable-webchat"
|
|
23288
|
+
]
|
|
22383
23289
|
},
|
|
22384
|
-
"
|
|
23290
|
+
"config": {
|
|
22385
23291
|
"anyOf": [
|
|
22386
23292
|
{
|
|
22387
|
-
"
|
|
22388
|
-
"$ref": "#/components/schemas/ToolAgentInfo"
|
|
22389
|
-
},
|
|
22390
|
-
"type": "array"
|
|
23293
|
+
"$ref": "#/components/schemas/TwilioChannelConfigUpdate"
|
|
22391
23294
|
},
|
|
22392
23295
|
{
|
|
22393
23296
|
"type": "null"
|
|
22394
23297
|
}
|
|
22395
23298
|
],
|
|
22396
|
-
"
|
|
22397
|
-
|
|
22398
|
-
|
|
22399
|
-
|
|
22400
|
-
|
|
22401
|
-
|
|
22402
|
-
|
|
22403
|
-
|
|
22404
|
-
|
|
22405
|
-
|
|
22406
|
-
|
|
22407
|
-
|
|
22408
|
-
|
|
23299
|
+
"description": "The configuration of the channel"
|
|
23300
|
+
}
|
|
23301
|
+
},
|
|
23302
|
+
"type": "object",
|
|
23303
|
+
"required": [
|
|
23304
|
+
"id"
|
|
23305
|
+
],
|
|
23306
|
+
"title": "TwilioChannelUpdateRequest",
|
|
23307
|
+
"description": "Request model for updating a Twilio channel."
|
|
23308
|
+
},
|
|
23309
|
+
"TwilioListNumbersResponse": {
|
|
23310
|
+
"properties": {
|
|
23311
|
+
"phone_numbers": {
|
|
23312
|
+
"items": {
|
|
23313
|
+
"$ref": "#/components/schemas/TwilioPhoneNumber"
|
|
23314
|
+
},
|
|
23315
|
+
"type": "array",
|
|
23316
|
+
"title": "Phone Numbers",
|
|
23317
|
+
"description": "List of phone numbers.",
|
|
22409
23318
|
"examples": [
|
|
22410
|
-
|
|
23319
|
+
[
|
|
23320
|
+
{
|
|
23321
|
+
"friendly_name": "Test number",
|
|
23322
|
+
"phone_number": "+19876543210",
|
|
23323
|
+
"sid": "PN123",
|
|
23324
|
+
"trunk_sid": "TK123"
|
|
23325
|
+
}
|
|
23326
|
+
]
|
|
22411
23327
|
]
|
|
22412
23328
|
}
|
|
22413
23329
|
},
|
|
22414
23330
|
"type": "object",
|
|
22415
23331
|
"required": [
|
|
22416
|
-
"
|
|
22417
|
-
"definition",
|
|
22418
|
-
"service_id",
|
|
22419
|
-
"id",
|
|
22420
|
-
"last_updated",
|
|
22421
|
-
"last_updated_by"
|
|
23332
|
+
"phone_numbers"
|
|
22422
23333
|
],
|
|
22423
|
-
"title": "
|
|
22424
|
-
"description": "Response model for
|
|
23334
|
+
"title": "TwilioListNumbersResponse",
|
|
23335
|
+
"description": "Response model for a list of Twilio phone numbers"
|
|
22425
23336
|
},
|
|
22426
|
-
"
|
|
23337
|
+
"TwilioNumberAddRequest": {
|
|
22427
23338
|
"properties": {
|
|
22428
|
-
"
|
|
23339
|
+
"friendly_name": {
|
|
22429
23340
|
"type": "string",
|
|
22430
|
-
"title": "
|
|
22431
|
-
"description": "
|
|
23341
|
+
"title": "Friendly Name",
|
|
23342
|
+
"description": "Friendly name for the Twilio number",
|
|
22432
23343
|
"examples": [
|
|
22433
|
-
"
|
|
23344
|
+
"Support Line"
|
|
22434
23345
|
]
|
|
22435
23346
|
},
|
|
22436
|
-
"
|
|
22437
|
-
"
|
|
22438
|
-
"
|
|
23347
|
+
"area_code": {
|
|
23348
|
+
"type": "string",
|
|
23349
|
+
"title": "Area Code",
|
|
23350
|
+
"description": "Area code for the Twilio number",
|
|
22439
23351
|
"examples": [
|
|
22440
|
-
|
|
22441
|
-
"answer": "Syllable is a platform for building and managing AI voice agents..."
|
|
22442
|
-
}
|
|
23352
|
+
"804"
|
|
22443
23353
|
]
|
|
22444
23354
|
}
|
|
22445
23355
|
},
|
|
22446
23356
|
"type": "object",
|
|
22447
23357
|
"required": [
|
|
22448
|
-
"
|
|
22449
|
-
"
|
|
23358
|
+
"friendly_name",
|
|
23359
|
+
"area_code"
|
|
22450
23360
|
],
|
|
22451
|
-
"title": "
|
|
23361
|
+
"title": "TwilioNumberAddRequest",
|
|
23362
|
+
"description": "Request model for purchasing a Twilio number and associating it with a channel."
|
|
22452
23363
|
},
|
|
22453
|
-
"
|
|
23364
|
+
"TwilioNumberAddResponse": {
|
|
22454
23365
|
"properties": {
|
|
22455
|
-
"
|
|
23366
|
+
"phone_number": {
|
|
22456
23367
|
"type": "string",
|
|
22457
|
-
"title": "
|
|
22458
|
-
"description": "The
|
|
23368
|
+
"title": "Phone Number",
|
|
23369
|
+
"description": "The purchased Twilio phone number",
|
|
22459
23370
|
"examples": [
|
|
22460
|
-
"
|
|
23371
|
+
"+18042221111"
|
|
23372
|
+
]
|
|
23373
|
+
}
|
|
23374
|
+
},
|
|
23375
|
+
"type": "object",
|
|
23376
|
+
"required": [
|
|
23377
|
+
"phone_number"
|
|
23378
|
+
],
|
|
23379
|
+
"title": "TwilioNumberAddResponse",
|
|
23380
|
+
"description": "Response model for purchasing a Twilio number and associating it with a channel."
|
|
23381
|
+
},
|
|
23382
|
+
"TwilioNumberUpdateRequest": {
|
|
23383
|
+
"properties": {
|
|
23384
|
+
"friendly_name": {
|
|
23385
|
+
"type": "string",
|
|
23386
|
+
"title": "Friendly Name",
|
|
23387
|
+
"description": "Friendly name for the Twilio number",
|
|
23388
|
+
"examples": [
|
|
23389
|
+
"Support Line"
|
|
22461
23390
|
]
|
|
22462
23391
|
},
|
|
22463
|
-
"
|
|
22464
|
-
"
|
|
22465
|
-
"
|
|
23392
|
+
"phone_sid": {
|
|
23393
|
+
"type": "string",
|
|
23394
|
+
"title": "Phone Sid",
|
|
23395
|
+
"description": "Twilio number SID",
|
|
22466
23396
|
"examples": [
|
|
22467
|
-
|
|
22468
|
-
"endpoint": {
|
|
22469
|
-
"argument_location": "query",
|
|
22470
|
-
"method": "get",
|
|
22471
|
-
"url": "https://api.open-meteo.com/v1/forecast"
|
|
22472
|
-
},
|
|
22473
|
-
"tool": {
|
|
22474
|
-
"function": {
|
|
22475
|
-
"description": "Get the weather for a city",
|
|
22476
|
-
"name": "get_weather",
|
|
22477
|
-
"parameters": {
|
|
22478
|
-
"properties": {
|
|
22479
|
-
"latitude": {
|
|
22480
|
-
"description": "Latitude of the city",
|
|
22481
|
-
"type": "number"
|
|
22482
|
-
},
|
|
22483
|
-
"longitude": {
|
|
22484
|
-
"description": "Longitude of the city",
|
|
22485
|
-
"type": "number"
|
|
22486
|
-
},
|
|
22487
|
-
"current": {
|
|
22488
|
-
"default": "temperature_2m,relative_humidity_2m,precipitation,rain,showers",
|
|
22489
|
-
"description": "Information to retrieve from the open-meteo API, comma-separated",
|
|
22490
|
-
"type": "string"
|
|
22491
|
-
}
|
|
22492
|
-
},
|
|
22493
|
-
"required": [
|
|
22494
|
-
"latitude",
|
|
22495
|
-
"longitude",
|
|
22496
|
-
"current"
|
|
22497
|
-
],
|
|
22498
|
-
"type": "object"
|
|
22499
|
-
}
|
|
22500
|
-
},
|
|
22501
|
-
"type": "function"
|
|
22502
|
-
},
|
|
22503
|
-
"type": "endpoint"
|
|
22504
|
-
}
|
|
23397
|
+
"PN123"
|
|
22505
23398
|
]
|
|
23399
|
+
}
|
|
23400
|
+
},
|
|
23401
|
+
"type": "object",
|
|
23402
|
+
"required": [
|
|
23403
|
+
"friendly_name",
|
|
23404
|
+
"phone_sid"
|
|
23405
|
+
],
|
|
23406
|
+
"title": "TwilioNumberUpdateRequest",
|
|
23407
|
+
"description": "Request model for updating a Twilio number and associating it with a channel."
|
|
23408
|
+
},
|
|
23409
|
+
"TwilioNumberUpdateResponse": {
|
|
23410
|
+
"properties": {
|
|
23411
|
+
"phone_number": {
|
|
23412
|
+
"type": "string",
|
|
23413
|
+
"title": "Phone Number",
|
|
23414
|
+
"description": "The updated Twilio phone number",
|
|
23415
|
+
"examples": [
|
|
23416
|
+
"+18042221111"
|
|
23417
|
+
]
|
|
23418
|
+
}
|
|
23419
|
+
},
|
|
23420
|
+
"type": "object",
|
|
23421
|
+
"required": [
|
|
23422
|
+
"phone_number"
|
|
23423
|
+
],
|
|
23424
|
+
"title": "TwilioNumberUpdateResponse",
|
|
23425
|
+
"description": "Response model for updating a Twilio number and associating it with a channel."
|
|
23426
|
+
},
|
|
23427
|
+
"TwilioPhoneNumber": {
|
|
23428
|
+
"properties": {
|
|
23429
|
+
"sid": {
|
|
23430
|
+
"type": "string",
|
|
23431
|
+
"title": "Sid",
|
|
23432
|
+
"description": "The unique identifier for the phone number."
|
|
22506
23433
|
},
|
|
22507
|
-
"
|
|
22508
|
-
"type": "
|
|
22509
|
-
"title": "
|
|
22510
|
-
"description": "
|
|
23434
|
+
"phone_number": {
|
|
23435
|
+
"type": "string",
|
|
23436
|
+
"title": "Phone Number",
|
|
23437
|
+
"description": "The phone number."
|
|
23438
|
+
},
|
|
23439
|
+
"friendly_name": {
|
|
23440
|
+
"type": "string",
|
|
23441
|
+
"title": "Friendly Name",
|
|
23442
|
+
"description": "A user-friendly name for the number."
|
|
23443
|
+
},
|
|
23444
|
+
"trunk_sid": {
|
|
23445
|
+
"type": "string",
|
|
23446
|
+
"title": "Trunk Sid",
|
|
23447
|
+
"description": "Associated trunk SID, if any."
|
|
23448
|
+
}
|
|
23449
|
+
},
|
|
23450
|
+
"type": "object",
|
|
23451
|
+
"required": [
|
|
23452
|
+
"sid",
|
|
23453
|
+
"phone_number",
|
|
23454
|
+
"friendly_name",
|
|
23455
|
+
"trunk_sid"
|
|
23456
|
+
],
|
|
23457
|
+
"title": "TwilioPhoneNumber"
|
|
23458
|
+
},
|
|
23459
|
+
"UserCreateRequest": {
|
|
23460
|
+
"properties": {
|
|
23461
|
+
"email": {
|
|
23462
|
+
"type": "string",
|
|
23463
|
+
"title": "Email",
|
|
23464
|
+
"description": "Email address of the user",
|
|
22511
23465
|
"examples": [
|
|
22512
|
-
|
|
23466
|
+
"user@email.com"
|
|
22513
23467
|
]
|
|
22514
23468
|
},
|
|
22515
|
-
"
|
|
22516
|
-
"
|
|
22517
|
-
|
|
22518
|
-
|
|
23469
|
+
"first_name": {
|
|
23470
|
+
"anyOf": [
|
|
23471
|
+
{
|
|
23472
|
+
"type": "string"
|
|
23473
|
+
},
|
|
23474
|
+
{
|
|
23475
|
+
"type": "null"
|
|
23476
|
+
}
|
|
23477
|
+
],
|
|
23478
|
+
"title": "First Name",
|
|
23479
|
+
"description": "First name of the user",
|
|
22519
23480
|
"examples": [
|
|
22520
|
-
|
|
23481
|
+
"Jane"
|
|
22521
23482
|
]
|
|
22522
23483
|
},
|
|
22523
|
-
"
|
|
23484
|
+
"last_name": {
|
|
22524
23485
|
"anyOf": [
|
|
22525
23486
|
{
|
|
22526
23487
|
"type": "string"
|
|
@@ -22529,63 +23490,78 @@
|
|
|
22529
23490
|
"type": "null"
|
|
22530
23491
|
}
|
|
22531
23492
|
],
|
|
22532
|
-
"title": "Last
|
|
22533
|
-
"description": "
|
|
23493
|
+
"title": "Last Name",
|
|
23494
|
+
"description": "Last name of the user",
|
|
22534
23495
|
"examples": [
|
|
22535
|
-
"
|
|
23496
|
+
"Smith"
|
|
23497
|
+
]
|
|
23498
|
+
},
|
|
23499
|
+
"role_id": {
|
|
23500
|
+
"type": "integer",
|
|
23501
|
+
"title": "Role Id",
|
|
23502
|
+
"description": "ID of the role assigned to the user",
|
|
23503
|
+
"examples": [
|
|
23504
|
+
1
|
|
22536
23505
|
]
|
|
22537
23506
|
}
|
|
22538
23507
|
},
|
|
22539
23508
|
"type": "object",
|
|
22540
23509
|
"required": [
|
|
22541
|
-
"
|
|
22542
|
-
"
|
|
22543
|
-
"service_id",
|
|
22544
|
-
"id"
|
|
22545
|
-
],
|
|
22546
|
-
"title": "ToolUpdateRequest",
|
|
22547
|
-
"description": "Request model to update an existing tool."
|
|
22548
|
-
},
|
|
22549
|
-
"TtsProvider": {
|
|
22550
|
-
"type": "string",
|
|
22551
|
-
"enum": [
|
|
22552
|
-
"OpenAI",
|
|
22553
|
-
"ElevenLabs",
|
|
22554
|
-
"Google"
|
|
23510
|
+
"email",
|
|
23511
|
+
"role_id"
|
|
22555
23512
|
],
|
|
22556
|
-
"title": "
|
|
22557
|
-
"description": "
|
|
23513
|
+
"title": "UserCreateRequest",
|
|
23514
|
+
"description": "Request model to create a user."
|
|
22558
23515
|
},
|
|
22559
|
-
"
|
|
23516
|
+
"UserDeleteRequest": {
|
|
22560
23517
|
"properties": {
|
|
22561
|
-
"
|
|
23518
|
+
"email": {
|
|
22562
23519
|
"type": "string",
|
|
22563
|
-
"title": "
|
|
22564
|
-
"description": "
|
|
23520
|
+
"title": "Email",
|
|
23521
|
+
"description": "The email address of the user to delete",
|
|
22565
23522
|
"examples": [
|
|
22566
|
-
"
|
|
23523
|
+
"user@email.com"
|
|
22567
23524
|
]
|
|
22568
23525
|
},
|
|
22569
|
-
"
|
|
23526
|
+
"reason": {
|
|
22570
23527
|
"type": "string",
|
|
22571
|
-
"title": "
|
|
22572
|
-
"description": "The
|
|
23528
|
+
"title": "Reason",
|
|
23529
|
+
"description": "The reason for deleting the user",
|
|
22573
23530
|
"examples": [
|
|
22574
|
-
"
|
|
23531
|
+
"User left the organization"
|
|
22575
23532
|
]
|
|
22576
23533
|
}
|
|
22577
23534
|
},
|
|
22578
23535
|
"type": "object",
|
|
22579
23536
|
"required": [
|
|
22580
|
-
"
|
|
22581
|
-
"
|
|
23537
|
+
"email",
|
|
23538
|
+
"reason"
|
|
22582
23539
|
],
|
|
22583
|
-
"title": "
|
|
22584
|
-
"description": "
|
|
23540
|
+
"title": "UserDeleteRequest",
|
|
23541
|
+
"description": "Request model to delete a user."
|
|
22585
23542
|
},
|
|
22586
|
-
"
|
|
23543
|
+
"UserProperties": {
|
|
23544
|
+
"type": "string",
|
|
23545
|
+
"enum": [
|
|
23546
|
+
"email",
|
|
23547
|
+
"first_name",
|
|
23548
|
+
"last_name",
|
|
23549
|
+
"role_id"
|
|
23550
|
+
],
|
|
23551
|
+
"title": "UserProperties",
|
|
23552
|
+
"description": "Names of user fields supported for filtering/sorting on list endpoint."
|
|
23553
|
+
},
|
|
23554
|
+
"UserResponse": {
|
|
22587
23555
|
"properties": {
|
|
22588
|
-
"
|
|
23556
|
+
"email": {
|
|
23557
|
+
"type": "string",
|
|
23558
|
+
"title": "Email",
|
|
23559
|
+
"description": "Email address of the user",
|
|
23560
|
+
"examples": [
|
|
23561
|
+
"user@email.com"
|
|
23562
|
+
]
|
|
23563
|
+
},
|
|
23564
|
+
"first_name": {
|
|
22589
23565
|
"anyOf": [
|
|
22590
23566
|
{
|
|
22591
23567
|
"type": "string"
|
|
@@ -22594,13 +23570,13 @@
|
|
|
22594
23570
|
"type": "null"
|
|
22595
23571
|
}
|
|
22596
23572
|
],
|
|
22597
|
-
"title": "
|
|
22598
|
-
"description": "
|
|
23573
|
+
"title": "First Name",
|
|
23574
|
+
"description": "First name of the user",
|
|
22599
23575
|
"examples": [
|
|
22600
|
-
"
|
|
23576
|
+
"Jane"
|
|
22601
23577
|
]
|
|
22602
23578
|
},
|
|
22603
|
-
"
|
|
23579
|
+
"last_name": {
|
|
22604
23580
|
"anyOf": [
|
|
22605
23581
|
{
|
|
22606
23582
|
"type": "string"
|
|
@@ -22609,51 +23585,50 @@
|
|
|
22609
23585
|
"type": "null"
|
|
22610
23586
|
}
|
|
22611
23587
|
],
|
|
22612
|
-
"title": "
|
|
22613
|
-
"description": "
|
|
23588
|
+
"title": "Last Name",
|
|
23589
|
+
"description": "Last name of the user",
|
|
22614
23590
|
"examples": [
|
|
22615
|
-
"
|
|
23591
|
+
"Smith"
|
|
22616
23592
|
]
|
|
22617
|
-
}
|
|
22618
|
-
|
|
22619
|
-
|
|
22620
|
-
|
|
22621
|
-
|
|
22622
|
-
},
|
|
22623
|
-
"TwilioChannelCreateRequest": {
|
|
22624
|
-
"properties": {
|
|
22625
|
-
"name": {
|
|
22626
|
-
"type": "string",
|
|
22627
|
-
"title": "Name",
|
|
22628
|
-
"description": "The channel name",
|
|
23593
|
+
},
|
|
23594
|
+
"role_id": {
|
|
23595
|
+
"type": "integer",
|
|
23596
|
+
"title": "Role Id",
|
|
23597
|
+
"description": "ID of the role assigned to the user",
|
|
22629
23598
|
"examples": [
|
|
22630
|
-
|
|
23599
|
+
1
|
|
23600
|
+
]
|
|
23601
|
+
},
|
|
23602
|
+
"last_updated_comments": {
|
|
23603
|
+
"anyOf": [
|
|
23604
|
+
{
|
|
23605
|
+
"type": "string"
|
|
23606
|
+
},
|
|
23607
|
+
{
|
|
23608
|
+
"type": "null"
|
|
23609
|
+
}
|
|
23610
|
+
],
|
|
23611
|
+
"title": "Last Updated Comments",
|
|
23612
|
+
"description": "Comments for the most recent edit to the user.",
|
|
23613
|
+
"examples": [
|
|
23614
|
+
"Updated to change which role was assigned"
|
|
22631
23615
|
]
|
|
22632
23616
|
},
|
|
22633
|
-
"config": {
|
|
22634
|
-
"$ref": "#/components/schemas/TwilioChannelConfigCreate",
|
|
22635
|
-
"description": "The configuration of the channel"
|
|
22636
|
-
}
|
|
22637
|
-
},
|
|
22638
|
-
"type": "object",
|
|
22639
|
-
"required": [
|
|
22640
|
-
"name",
|
|
22641
|
-
"config"
|
|
22642
|
-
],
|
|
22643
|
-
"title": "TwilioChannelCreateRequest",
|
|
22644
|
-
"description": "Request model for creating a Twilio channel."
|
|
22645
|
-
},
|
|
22646
|
-
"TwilioChannelUpdateRequest": {
|
|
22647
|
-
"properties": {
|
|
22648
23617
|
"id": {
|
|
22649
23618
|
"type": "integer",
|
|
22650
23619
|
"title": "Id",
|
|
22651
|
-
"description": "
|
|
23620
|
+
"description": "Internal ID of the user",
|
|
22652
23621
|
"examples": [
|
|
22653
23622
|
1
|
|
22654
23623
|
]
|
|
22655
23624
|
},
|
|
22656
|
-
"
|
|
23625
|
+
"last_updated": {
|
|
23626
|
+
"type": "string",
|
|
23627
|
+
"format": "date-time",
|
|
23628
|
+
"title": "Last Updated",
|
|
23629
|
+
"description": "The timestamp of the most recent update to the user"
|
|
23630
|
+
},
|
|
23631
|
+
"last_updated_by": {
|
|
22657
23632
|
"anyOf": [
|
|
22658
23633
|
{
|
|
22659
23634
|
"type": "string"
|
|
@@ -22662,75 +23637,110 @@
|
|
|
22662
23637
|
"type": "null"
|
|
22663
23638
|
}
|
|
22664
23639
|
],
|
|
22665
|
-
"title": "
|
|
22666
|
-
"description": "The
|
|
23640
|
+
"title": "Last Updated By",
|
|
23641
|
+
"description": "The email address of the user who last updated the user",
|
|
22667
23642
|
"examples": [
|
|
22668
|
-
"
|
|
23643
|
+
"admin@email.com"
|
|
22669
23644
|
]
|
|
22670
23645
|
},
|
|
22671
|
-
"
|
|
23646
|
+
"last_session_at": {
|
|
22672
23647
|
"anyOf": [
|
|
22673
23648
|
{
|
|
22674
|
-
"
|
|
23649
|
+
"type": "string",
|
|
23650
|
+
"format": "date-time"
|
|
22675
23651
|
},
|
|
22676
23652
|
{
|
|
22677
23653
|
"type": "null"
|
|
22678
23654
|
}
|
|
22679
23655
|
],
|
|
22680
|
-
"
|
|
23656
|
+
"title": "Last Session At",
|
|
23657
|
+
"description": "The timestamp of the user's last session",
|
|
23658
|
+
"examples": [
|
|
23659
|
+
"2025-01-01T12:00:00Z"
|
|
23660
|
+
]
|
|
22681
23661
|
}
|
|
22682
23662
|
},
|
|
22683
23663
|
"type": "object",
|
|
22684
23664
|
"required": [
|
|
22685
|
-
"
|
|
23665
|
+
"email",
|
|
23666
|
+
"role_id",
|
|
23667
|
+
"id",
|
|
23668
|
+
"last_updated"
|
|
22686
23669
|
],
|
|
22687
|
-
"title": "
|
|
22688
|
-
"description": "
|
|
23670
|
+
"title": "UserResponse",
|
|
23671
|
+
"description": "Information about a user."
|
|
22689
23672
|
},
|
|
22690
|
-
"
|
|
23673
|
+
"UserUpdateRequest": {
|
|
22691
23674
|
"properties": {
|
|
22692
|
-
"
|
|
23675
|
+
"email": {
|
|
22693
23676
|
"type": "string",
|
|
22694
|
-
"title": "
|
|
22695
|
-
"description": "
|
|
23677
|
+
"title": "Email",
|
|
23678
|
+
"description": "Email address of the user",
|
|
22696
23679
|
"examples": [
|
|
22697
|
-
"
|
|
23680
|
+
"user@email.com"
|
|
22698
23681
|
]
|
|
22699
23682
|
},
|
|
22700
|
-
"
|
|
22701
|
-
"
|
|
22702
|
-
|
|
22703
|
-
|
|
23683
|
+
"first_name": {
|
|
23684
|
+
"anyOf": [
|
|
23685
|
+
{
|
|
23686
|
+
"type": "string"
|
|
23687
|
+
},
|
|
23688
|
+
{
|
|
23689
|
+
"type": "null"
|
|
23690
|
+
}
|
|
23691
|
+
],
|
|
23692
|
+
"title": "First Name",
|
|
23693
|
+
"description": "First name of the user",
|
|
22704
23694
|
"examples": [
|
|
22705
|
-
"
|
|
23695
|
+
"Jane"
|
|
22706
23696
|
]
|
|
22707
|
-
}
|
|
22708
|
-
|
|
22709
|
-
|
|
22710
|
-
|
|
22711
|
-
|
|
22712
|
-
|
|
22713
|
-
|
|
22714
|
-
|
|
22715
|
-
|
|
22716
|
-
|
|
22717
|
-
|
|
22718
|
-
|
|
22719
|
-
"phone_number": {
|
|
22720
|
-
"type": "string",
|
|
22721
|
-
"title": "Phone Number",
|
|
22722
|
-
"description": "The purchased Twilio phone number",
|
|
23697
|
+
},
|
|
23698
|
+
"last_name": {
|
|
23699
|
+
"anyOf": [
|
|
23700
|
+
{
|
|
23701
|
+
"type": "string"
|
|
23702
|
+
},
|
|
23703
|
+
{
|
|
23704
|
+
"type": "null"
|
|
23705
|
+
}
|
|
23706
|
+
],
|
|
23707
|
+
"title": "Last Name",
|
|
23708
|
+
"description": "Last name of the user",
|
|
22723
23709
|
"examples": [
|
|
22724
|
-
"
|
|
23710
|
+
"Smith"
|
|
23711
|
+
]
|
|
23712
|
+
},
|
|
23713
|
+
"role_id": {
|
|
23714
|
+
"type": "integer",
|
|
23715
|
+
"title": "Role Id",
|
|
23716
|
+
"description": "ID of the role assigned to the user",
|
|
23717
|
+
"examples": [
|
|
23718
|
+
1
|
|
23719
|
+
]
|
|
23720
|
+
},
|
|
23721
|
+
"last_updated_comments": {
|
|
23722
|
+
"anyOf": [
|
|
23723
|
+
{
|
|
23724
|
+
"type": "string"
|
|
23725
|
+
},
|
|
23726
|
+
{
|
|
23727
|
+
"type": "null"
|
|
23728
|
+
}
|
|
23729
|
+
],
|
|
23730
|
+
"title": "Last Updated Comments",
|
|
23731
|
+
"description": "Comments for the most recent edit to the user.",
|
|
23732
|
+
"examples": [
|
|
23733
|
+
"Updated to change which role was assigned"
|
|
22725
23734
|
]
|
|
22726
23735
|
}
|
|
22727
23736
|
},
|
|
22728
23737
|
"type": "object",
|
|
22729
23738
|
"required": [
|
|
22730
|
-
"
|
|
23739
|
+
"email",
|
|
23740
|
+
"role_id"
|
|
22731
23741
|
],
|
|
22732
|
-
"title": "
|
|
22733
|
-
"description": "
|
|
23742
|
+
"title": "UserUpdateRequest",
|
|
23743
|
+
"description": "Request model to update an existing user."
|
|
22734
23744
|
},
|
|
22735
23745
|
"ValidationError": {
|
|
22736
23746
|
"properties": {
|