freeclimb 5.2.0 → 5.4.0

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.
Files changed (83) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -2
  3. data/Gemfile.lock +3 -3
  4. data/README.md +31 -4
  5. data/docs/AvailableNumber.md +0 -4
  6. data/docs/BlobListResponse.md +32 -0
  7. data/docs/BlobResult.md +32 -0
  8. data/docs/CallResult.md +2 -2
  9. data/docs/CreateBlobRequest.md +22 -0
  10. data/docs/CreateConference.md +4 -2
  11. data/docs/DefaultApi.md +835 -25
  12. data/docs/ExportList.md +32 -0
  13. data/docs/ExportOutputType.md +16 -0
  14. data/docs/ExportRequest.md +24 -0
  15. data/docs/ExportRequestOutput.md +18 -0
  16. data/docs/ExportResourceType.md +17 -0
  17. data/docs/ExportResult.md +40 -0
  18. data/docs/ExportResultOutput.md +18 -0
  19. data/docs/ExportStatus.md +21 -0
  20. data/docs/IncomingNumberResult.md +0 -4
  21. data/docs/ModifyBlobRequest.md +20 -0
  22. data/docs/PlatformError.md +24 -0
  23. data/docs/ReplaceBlobRequest.md +18 -0
  24. data/docs/Say.md +2 -0
  25. data/docs/TTSEngine.md +20 -0
  26. data/docs/TTSEngineName.md +18 -0
  27. data/lib/freeclimb/api/default_api.rb +1032 -12
  28. data/lib/freeclimb/models/available_number.rb +1 -23
  29. data/lib/freeclimb/models/blob_list_response.rb +303 -0
  30. data/lib/freeclimb/models/blob_result.rb +332 -0
  31. data/lib/freeclimb/models/call_result.rb +8 -8
  32. data/lib/freeclimb/models/create_blob_request.rb +255 -0
  33. data/lib/freeclimb/models/create_conference.rb +15 -5
  34. data/lib/freeclimb/models/export_list.rb +304 -0
  35. data/lib/freeclimb/models/export_output_type.rb +34 -0
  36. data/lib/freeclimb/models/export_request.rb +276 -0
  37. data/lib/freeclimb/models/export_request_output.rb +243 -0
  38. data/lib/freeclimb/models/export_resource_type.rb +35 -0
  39. data/lib/freeclimb/models/export_result.rb +405 -0
  40. data/lib/freeclimb/models/export_result_output.rb +243 -0
  41. data/lib/freeclimb/models/export_status.rb +39 -0
  42. data/lib/freeclimb/models/incoming_number_result.rb +1 -23
  43. data/lib/freeclimb/models/modify_blob_request.rb +245 -0
  44. data/lib/freeclimb/models/platform_error.rb +244 -0
  45. data/lib/freeclimb/models/replace_blob_request.rb +221 -0
  46. data/lib/freeclimb/models/say.rb +10 -1
  47. data/lib/freeclimb/models/tts_engine.rb +250 -0
  48. data/lib/freeclimb/models/tts_engine_name.rb +36 -0
  49. data/lib/freeclimb/version.rb +1 -1
  50. data/lib/freeclimb.rb +16 -0
  51. data/openapi.json +1245 -80
  52. data/spec/api/default_api_spec.rb +328 -33
  53. data/spec/models/account_result_spec.rb +3 -3
  54. data/spec/models/available_number_spec.rb +3 -98
  55. data/spec/models/blob_list_response_spec.rb +502 -0
  56. data/spec/models/blob_result_spec.rb +489 -0
  57. data/spec/models/call_result_spec.rb +39 -39
  58. data/spec/models/conference_result_spec.rb +3 -3
  59. data/spec/models/create_blob_request_spec.rb +273 -0
  60. data/spec/models/create_conference_spec.rb +83 -35
  61. data/spec/models/export_list_spec.rb +502 -0
  62. data/spec/models/export_output_type_spec.rb +43 -0
  63. data/spec/models/export_request_output_spec.rb +162 -0
  64. data/spec/models/export_request_spec.rb +320 -0
  65. data/spec/models/export_resource_type_spec.rb +59 -0
  66. data/spec/models/export_result_output_spec.rb +162 -0
  67. data/spec/models/export_result_spec.rb +718 -0
  68. data/spec/models/export_status_spec.rb +123 -0
  69. data/spec/models/incoming_number_result_spec.rb +6 -102
  70. data/spec/models/log_result_spec.rb +3 -3
  71. data/spec/models/message_result_spec.rb +3 -3
  72. data/spec/models/modify_blob_request_spec.rb +226 -0
  73. data/spec/models/platform_error_spec.rb +318 -0
  74. data/spec/models/queue_result_spec.rb +3 -3
  75. data/spec/models/replace_blob_request_spec.rb +176 -0
  76. data/spec/models/say_spec.rb +50 -0
  77. data/spec/models/sms_ten_dlc_partner_campaign_spec.rb +3 -3
  78. data/spec/models/transcribe_utterance_spec.rb +3 -3
  79. data/spec/models/tts_engine_name_spec.rb +75 -0
  80. data/spec/models/tts_engine_spec.rb +183 -0
  81. data/spec/spec_helper.rb +1 -1
  82. data/yarn.lock +29 -29
  83. metadata +50 -2
data/openapi.json CHANGED
@@ -23,7 +23,9 @@
23
23
  "description": "ID of the account",
24
24
  "required": true,
25
25
  "schema": {
26
- "type": "string"
26
+ "type": "string",
27
+ "pattern": "AC[0-9a-fA-F]{40}",
28
+ "example": "AC170e4c66d358aa1755931da0452561933d1b8fd5"
27
29
  }
28
30
  },
29
31
  "Capabilities.Voice": {
@@ -80,6 +82,17 @@
80
82
  }
81
83
  },
82
84
  "schemas": {
85
+ "accountId": {
86
+ "type": "string",
87
+ "pattern": "AC[0-9a-fA-F]{40}",
88
+ "example": "AC0534faec6b32da45f36166674d65b3903f784141"
89
+ },
90
+ "blobId": {
91
+ "type": "string",
92
+ "description": "Identifier which can be used to reference this blob in future interations.",
93
+ "pattern": "BL[0-9a-fA-F]{40}",
94
+ "example": "BL88615a9b4ca7e9aad57d9057773fc74268b9caf7"
95
+ },
83
96
  "AccountStatus": {
84
97
  "type": "string",
85
98
  "enum": ["closed", "suspended", "active"],
@@ -1968,7 +1981,7 @@
1968
1981
  },
1969
1982
  "alias": {
1970
1983
  "description": "Descriptive name for the Conference. ",
1971
- "type": "boolean"
1984
+ "type": "string"
1972
1985
  },
1973
1986
  "playBeep": {
1974
1987
  "$ref": "#/components/schemas/PlayBeep"
@@ -1986,6 +1999,10 @@
1986
1999
  "description": "If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb.",
1987
2000
  "format": "uri",
1988
2001
  "type": "string"
2002
+ },
2003
+ "parentCallId": {
2004
+ "description": "ID of the Call that created this leg (child call).",
2005
+ "type": "string"
1989
2006
  }
1990
2007
  }
1991
2008
  }
@@ -2415,12 +2432,30 @@
2415
2432
  "$ref": "#/components/schemas/PerclCommand"
2416
2433
  },
2417
2434
  {
2418
- "required": [],
2419
2435
  "type": "object",
2420
2436
  "properties": {}
2421
2437
  }
2422
2438
  ]
2423
2439
  },
2440
+ "TTSEngineName": {
2441
+ "description": "The engine to use for the TTS. The complete list of valid values for the engine attribute is shown below.",
2442
+ "type": "string",
2443
+ "enum": ["freeclimb.standard", "freeclimb.neural", "ElevenLabs"]
2444
+ },
2445
+ "TTSEngine": {
2446
+ "type": "object",
2447
+ "properties": {
2448
+ "name": {
2449
+ "$ref": "#/components/schemas/TTSEngineName"
2450
+ },
2451
+ "parameters": {
2452
+ "description": "Parameters for the TTS engine. The parameters are specific to the engine and are documented in the engine's documentation.",
2453
+ "type": "object",
2454
+ "properties": {},
2455
+ "additionalProperties": true
2456
+ }
2457
+ }
2458
+ },
2424
2459
  "Say": {
2425
2460
  "description": "The `Say` command provides Text-To-Speech (TTS) support. It converts text to speech and then renders it in a female voice back to the caller. `Say` is useful in cases where it's difficult to pre-record a prompt for any reason. `Say` does not allow barge-in unless nested within a `GetSpeech` command. The file will always be played to completion unless nested.",
2426
2461
  "allOf": [
@@ -2439,6 +2474,9 @@
2439
2474
  "description": "Language and (by implication) the locale to use. This implies the accent and pronunciations to be usde for the TTS. The complete list of valid values for the language attribute is shown below.",
2440
2475
  "type": "string"
2441
2476
  },
2477
+ "engine": {
2478
+ "$ref": "#/components/schemas/TTSEngine"
2479
+ },
2442
2480
  "loop": {
2443
2481
  "description": "Number of times the text is said. Specifying '0' causes the `Say` action to loop until the Call is hung up.",
2444
2482
  "type": "integer",
@@ -2485,7 +2523,6 @@
2485
2523
  "$ref": "#/components/schemas/PerclCommand"
2486
2524
  },
2487
2525
  {
2488
- "required": [],
2489
2526
  "type": "object",
2490
2527
  "properties": {
2491
2528
  "listen": {
@@ -2503,7 +2540,6 @@
2503
2540
  "$ref": "#/components/schemas/PerclCommand"
2504
2541
  },
2505
2542
  {
2506
- "required": [],
2507
2543
  "type": "object",
2508
2544
  "properties": {
2509
2545
  "talk": {
@@ -2521,7 +2557,6 @@
2521
2557
  "$ref": "#/components/schemas/PerclCommand"
2522
2558
  },
2523
2559
  {
2524
- "required": [],
2525
2560
  "type": "object",
2526
2561
  "properties": {
2527
2562
  "dtmfPassThrough": {
@@ -2581,7 +2616,6 @@
2581
2616
  "$ref": "#/components/schemas/PerclCommand"
2582
2617
  },
2583
2618
  {
2584
- "required": [],
2585
2619
  "type": "object",
2586
2620
  "properties": {}
2587
2621
  }
@@ -3113,7 +3147,7 @@
3113
3147
  "description": "If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI).",
3114
3148
  "nullable": true
3115
3149
  },
3116
- "callStatus": {
3150
+ "status": {
3117
3151
  "$ref": "#/components/schemas/CallStatus"
3118
3152
  },
3119
3153
  "startTime": {
@@ -3658,9 +3692,7 @@
3658
3692
  },
3659
3693
  "CreateConferenceRequest": {
3660
3694
  "type": "object",
3661
- "required": [
3662
- "statusCallbackUrl"
3663
- ],
3695
+ "required": ["statusCallbackUrl"],
3664
3696
  "properties": {
3665
3697
  "alias": {
3666
3698
  "type": "string",
@@ -4830,6 +4862,404 @@
4830
4862
  "minimum": 1
4831
4863
  }
4832
4864
  }
4865
+ },
4866
+ "ExportStatus": {
4867
+ "type": "string",
4868
+ "description": "platform export status",
4869
+ "enum": [
4870
+ "intaking",
4871
+ "queued",
4872
+ "inProgress",
4873
+ "completed",
4874
+ "failed",
4875
+ "deleted"
4876
+ ]
4877
+ },
4878
+ "ExportResourceType": {
4879
+ "type": "string",
4880
+ "description": "platform resource type",
4881
+ "enum": ["Messages", "Calls"]
4882
+ },
4883
+ "ExportOutputType": {
4884
+ "type": "string",
4885
+ "description": "output type of the export",
4886
+ "enum": ["csv"]
4887
+ },
4888
+ "ExportRequestOutput": {
4889
+ "type": "object",
4890
+ "required": ["type"],
4891
+ "properties": {
4892
+ "type": {
4893
+ "$ref": "#/components/schemas/ExportOutputType"
4894
+ }
4895
+ }
4896
+ },
4897
+ "ExportResultOutput": {
4898
+ "type": "object",
4899
+ "required": ["type"],
4900
+ "properties": {
4901
+ "type": {
4902
+ "$ref": "#/components/schemas/ExportOutputType"
4903
+ }
4904
+ }
4905
+ },
4906
+ "ExportResult": {
4907
+ "type": "object",
4908
+ "required": [
4909
+ "accountId",
4910
+ "uri",
4911
+ "dateCreated",
4912
+ "dateUpdated",
4913
+ "revision",
4914
+ "exportId",
4915
+ "status",
4916
+ "size",
4917
+ "resourceType",
4918
+ "query",
4919
+ "format",
4920
+ "output"
4921
+ ],
4922
+ "properties": {
4923
+ "accountId": {
4924
+ "type": "string",
4925
+ "description": "String that uniquely identifies this account resource.",
4926
+ "nullable": true
4927
+ },
4928
+ "uri": {
4929
+ "type": "string",
4930
+ "format": "uri-reference"
4931
+ },
4932
+ "dateCreated": {
4933
+ "type": "string"
4934
+ },
4935
+ "dateUpdated": {
4936
+ "type": "string"
4937
+ },
4938
+ "revision": {
4939
+ "type": "integer",
4940
+ "minimum": 0
4941
+ },
4942
+ "exportId": {
4943
+ "type": "string",
4944
+ "description": "String that uniquely identifies this export resource",
4945
+ "nullable": true
4946
+ },
4947
+ "status": {
4948
+ "$ref": "#/components/schemas/ExportStatus"
4949
+ },
4950
+ "size": {
4951
+ "type": "integer"
4952
+ },
4953
+ "resourceType": {
4954
+ "$ref": "#/components/schemas/ExportResourceType"
4955
+ },
4956
+ "query": {
4957
+ "description": "Query params used to filter exported documents",
4958
+ "type": "object"
4959
+ },
4960
+ "format": {
4961
+ "description": "Desired fields of exported documents",
4962
+ "type": "array",
4963
+ "items": {
4964
+ "type": "string"
4965
+ }
4966
+ },
4967
+ "output": {
4968
+ "$ref": "#/components/schemas/ExportResultOutput"
4969
+ }
4970
+ },
4971
+ "example": {
4972
+ "accountId": "AC3ff5d5aed7fde9e6659673d850cbd18ea8bfca78",
4973
+ "uri": "/Accounts/AC3ff5d5aed7fde9e6659673d850cbd18ea8bfca78/Exports/EX4d7500862e3abf4b9f4da24d54f559d3024252f8",
4974
+ "dateCreated": "Wed, 26 Jun 2024 15:45:06 UTC",
4975
+ "dateUpdated": "Wed, 26 Jun 2024 15:45:06 UTC",
4976
+ "revision": 1,
4977
+ "exportId": "EX4d7500862e3abf4b9f4da24d54f559d3024252f8",
4978
+ "status": "completed",
4979
+ "size": 12893786,
4980
+ "resourceType": "Messages",
4981
+ "query": {
4982
+ "direction": "inbound"
4983
+ },
4984
+ "format": ["messageId", "dateUpdated", "segmentCount", "status"],
4985
+ "output": {
4986
+ "type": "csv"
4987
+ }
4988
+ }
4989
+ },
4990
+ "ExportList": {
4991
+ "allOf": [
4992
+ {
4993
+ "$ref": "#/components/schemas/PaginationModel"
4994
+ },
4995
+ {
4996
+ "type": "object",
4997
+ "properties": {
4998
+ "exports": {
4999
+ "type": "array",
5000
+ "items": {
5001
+ "$ref": "#/components/schemas/ExportResult"
5002
+ },
5003
+ "nullable": true
5004
+ }
5005
+ }
5006
+ }
5007
+ ]
5008
+ },
5009
+ "ExportRequest": {
5010
+ "type": "object",
5011
+ "required": ["resourceType", "output"],
5012
+ "properties": {
5013
+ "resourceType": {
5014
+ "$ref": "#/components/schemas/ExportResourceType"
5015
+ },
5016
+ "format": {
5017
+ "type": "array",
5018
+ "items": {
5019
+ "type": "string"
5020
+ }
5021
+ },
5022
+ "output": {
5023
+ "$ref": "#/components/schemas/ExportRequestOutput"
5024
+ },
5025
+ "query": {
5026
+ "type": "object"
5027
+ }
5028
+ }
5029
+ },
5030
+ "CreateBlobRequest": {
5031
+ "type": "object",
5032
+ "required": ["blob"],
5033
+ "properties": {
5034
+ "alias": {
5035
+ "type": "string",
5036
+ "description": "Custom identifier for this blob that is unique for the owning account. It will be set to the blobId by default if not provided.",
5037
+ "maxLength": 64
5038
+ },
5039
+ "expiresAt": {
5040
+ "type": "string",
5041
+ "description": "An RFC3339 timestamp with millisecond resolution. This timestamp defines the time at which this blob will delete itself. It must not be more than 48 hours in the future and will default to 9 hours in the future if not provided.",
5042
+ "example": "2006-01-02T15:04:05.000Z"
5043
+ },
5044
+ "blob": {
5045
+ "type": "object"
5046
+ }
5047
+ },
5048
+ "additionalProperties": false
5049
+ },
5050
+ "ModifyBlobRequest": {
5051
+ "type": "object",
5052
+ "required": ["blob"],
5053
+ "properties": {
5054
+ "blob": {
5055
+ "type": "object"
5056
+ },
5057
+ "alias": {
5058
+ "type": "string",
5059
+ "description": "Custom identifier for this blob that is unique for the owning account. It will be set to the blobId by default if not provided.",
5060
+ "maxLength": 64
5061
+ }
5062
+ }
5063
+ },
5064
+ "ReplaceBlobRequest": {
5065
+ "type": "object",
5066
+ "required": ["blob"],
5067
+ "properties": {
5068
+ "blob": {
5069
+ "type": "object"
5070
+ }
5071
+ }
5072
+ },
5073
+ "BlobResult": {
5074
+ "type": "object",
5075
+ "properties": {
5076
+ "blobId": {
5077
+ "$ref": "#/components/schemas/blobId"
5078
+ },
5079
+ "accountId": {
5080
+ "$ref": "#/components/schemas/accountId"
5081
+ },
5082
+ "alias": {
5083
+ "type": "string",
5084
+ "description": "Custom identifier for this blob that is unique for the owning account. It will be set to the blobId by default if not provided in the creation request.",
5085
+ "maxLength": 64
5086
+ },
5087
+ "revision": {
5088
+ "type": "integer"
5089
+ },
5090
+ "dateCreated": {
5091
+ "type": "string",
5092
+ "format": "date-time",
5093
+ "description": "An RFC3339 timestamp with millisecond resolution. It represents the time this blob was created."
5094
+ },
5095
+ "dateUpdated": {
5096
+ "type": "string",
5097
+ "format": "date-time",
5098
+ "description": "An RFC3339 timestamp with millisecond resolution. It represents the time this blob was last modified, which at creation will always equal dateCreated."
5099
+ },
5100
+ "expiresAt": {
5101
+ "type": "string",
5102
+ "format": "date-time",
5103
+ "description": "An RFC3339 timestamp with millisecond resolution. It represents the time at which this blob will expire and self delete."
5104
+ },
5105
+ "blob": {
5106
+ "type": "object",
5107
+ "description": "Blob content"
5108
+ }
5109
+ }
5110
+ },
5111
+ "BlobListResponse": {
5112
+ "type": "object",
5113
+ "allOf": [
5114
+ {
5115
+ "$ref": "#/components/schemas/PaginationModel"
5116
+ },
5117
+ {
5118
+ "type": "object",
5119
+ "properties": {
5120
+ "blobs": {
5121
+ "type": "array",
5122
+ "items": {
5123
+ "$ref": "#/components/schemas/BlobResult"
5124
+ }
5125
+ }
5126
+ }
5127
+ }
5128
+ ]
5129
+ },
5130
+ "PlatformError": {
5131
+ "description": "Standard error structure returned by platform.",
5132
+ "type": "object",
5133
+ "properties": {
5134
+ "code": {
5135
+ "type": "integer"
5136
+ },
5137
+ "call": {
5138
+ "type": "string"
5139
+ },
5140
+ "url": {
5141
+ "type": "string",
5142
+ "format": "uri-reference"
5143
+ },
5144
+ "details": {
5145
+ "type": "object"
5146
+ }
5147
+ },
5148
+ "example": {
5149
+ "code": 0,
5150
+ "call": "Internal Failure",
5151
+ "url": "https://docs.freeclimb.com/reference/error-and-warning-dictionary#0"
5152
+ }
5153
+ }
5154
+ },
5155
+ "responses": {
5156
+ "success204": {
5157
+ "description": "Successful operation"
5158
+ },
5159
+ "error400": {
5160
+ "description": "Generic platform bad request.",
5161
+ "content": {
5162
+ "application/json": {
5163
+ "schema": {
5164
+ "$ref": "#/components/schemas/PlatformError"
5165
+ },
5166
+ "example": {
5167
+ "code": 80,
5168
+ "call": "Missing Required Parameter(s)",
5169
+ "url": "https://docs.freeclimb.com/reference/error-and-warning-dictionary#80"
5170
+ }
5171
+ }
5172
+ }
5173
+ },
5174
+ "error404": {
5175
+ "description": "Generic platform not found error.",
5176
+ "content": {
5177
+ "application/json": {
5178
+ "schema": {
5179
+ "$ref": "#/components/schemas/PlatformError"
5180
+ },
5181
+ "example": {
5182
+ "code": 1,
5183
+ "call": "Not Found",
5184
+ "url": "https://docs.freeclimb.com/reference/error-and-warning-dictionary#1"
5185
+ }
5186
+ }
5187
+ }
5188
+ },
5189
+ "error409": {
5190
+ "description": "Generic platform status conflict error.",
5191
+ "content": {
5192
+ "application/json": {
5193
+ "schema": {
5194
+ "$ref": "#/components/schemas/PlatformError"
5195
+ },
5196
+ "example": {
5197
+ "code": 108,
5198
+ "call": "ResourceConflict",
5199
+ "url": "https://docs.freeclimb.com/reference/error-and-warning-dictionary#108"
5200
+ }
5201
+ }
5202
+ }
5203
+ },
5204
+ "error413": {
5205
+ "description": "Generic platform status request entity too large.",
5206
+ "content": {
5207
+ "application/json": {
5208
+ "schema": {
5209
+ "$ref": "#/components/schemas/PlatformError"
5210
+ },
5211
+ "example": {
5212
+ "code": 3,
5213
+ "call": "BadRequestBody",
5214
+ "url": "https://docs.freeclimb.com/reference/error-and-warning-dictionary#3"
5215
+ }
5216
+ }
5217
+ }
5218
+ },
5219
+ "error422": {
5220
+ "description": "Generic platform unprocessible entity response.",
5221
+ "content": {
5222
+ "application/json": {
5223
+ "schema": {
5224
+ "$ref": "#/components/schemas/PlatformError"
5225
+ },
5226
+ "example": {
5227
+ "code": 9,
5228
+ "call": "Invalid JSON",
5229
+ "url": "https://docs.freeclimb.com/reference/error-and-warning-dictionary#9"
5230
+ }
5231
+ }
5232
+ }
5233
+ },
5234
+ "error500": {
5235
+ "description": "Generic platform internal error.",
5236
+ "content": {
5237
+ "application/json": {
5238
+ "schema": {
5239
+ "$ref": "#/components/schemas/PlatformError"
5240
+ },
5241
+ "example": {
5242
+ "code": 0,
5243
+ "call": "Internal Failure",
5244
+ "url": "https://docs.freeclimb.com/reference/error-and-warning-dictionary#0"
5245
+ }
5246
+ }
5247
+ }
5248
+ },
5249
+ "error504": {
5250
+ "description": "gateway timeout error",
5251
+ "content": {
5252
+ "application/json": {
5253
+ "schema": {
5254
+ "$ref": "#/components/schemas/PlatformError"
5255
+ },
5256
+ "example": {
5257
+ "code": 0,
5258
+ "call": "Internal Failure",
5259
+ "url": "https://docs.freeclimb.com/reference/error-and-warning-dictionary#0"
5260
+ }
5261
+ }
5262
+ }
4833
5263
  }
4834
5264
  }
4835
5265
  },
@@ -4841,7 +5271,7 @@
4841
5271
  "paths": {
4842
5272
  "/Accounts/{accountId}": {
4843
5273
  "get": {
4844
- "tags": [],
5274
+ "tags": ["Accounts"],
4845
5275
  "summary": "Get an Account",
4846
5276
  "operationId": "get-an-account",
4847
5277
  "parameters": [
@@ -4864,7 +5294,7 @@
4864
5294
  }
4865
5295
  },
4866
5296
  "post": {
4867
- "tags": [],
5297
+ "tags": ["Accounts"],
4868
5298
  "summary": "Manage an account",
4869
5299
  "operationId": "update-an-account",
4870
5300
  "parameters": [
@@ -4891,7 +5321,7 @@
4891
5321
  },
4892
5322
  "/Accounts/{accountId}/Applications/{applicationId}": {
4893
5323
  "get": {
4894
- "tags": [],
5324
+ "tags": ["Applications"],
4895
5325
  "summary": "Get an Application",
4896
5326
  "operationId": "get-an-application",
4897
5327
  "parameters": [
@@ -4923,7 +5353,7 @@
4923
5353
  }
4924
5354
  },
4925
5355
  "post": {
4926
- "tags": [],
5356
+ "tags": ["Applications"],
4927
5357
  "summary": "Update an application",
4928
5358
  "operationId": "update-an-application",
4929
5359
  "parameters": [
@@ -4965,7 +5395,7 @@
4965
5395
  }
4966
5396
  },
4967
5397
  "delete": {
4968
- "tags": [],
5398
+ "tags": ["Applications"],
4969
5399
  "summary": "Delete an application",
4970
5400
  "operationId": "delete-an-application",
4971
5401
  "parameters": [
@@ -4992,7 +5422,7 @@
4992
5422
  },
4993
5423
  "/Accounts/{accountId}/Applications": {
4994
5424
  "get": {
4995
- "tags": [],
5425
+ "tags": ["Applications"],
4996
5426
  "summary": "List applications",
4997
5427
  "operationId": "list-applications",
4998
5428
  "parameters": [
@@ -5024,7 +5454,7 @@
5024
5454
  }
5025
5455
  },
5026
5456
  "post": {
5027
- "tags": [],
5457
+ "tags": ["Applications"],
5028
5458
  "summary": "Create an application",
5029
5459
  "operationId": "create-an-application",
5030
5460
  "parameters": [
@@ -5059,7 +5489,7 @@
5059
5489
  },
5060
5490
  "/AvailablePhoneNumbers": {
5061
5491
  "get": {
5062
- "tags": [],
5492
+ "tags": ["AvailablePhoneNumbers"],
5063
5493
  "summary": "List available numbers",
5064
5494
  "operationId": "list-available-numbers",
5065
5495
  "parameters": [
@@ -5143,7 +5573,7 @@
5143
5573
  },
5144
5574
  "/Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId}": {
5145
5575
  "get": {
5146
- "tags": [],
5576
+ "tags": ["IncomingPhoneNumbers"],
5147
5577
  "summary": "Get an Incoming Number",
5148
5578
  "operationId": "get-an-incoming-number",
5149
5579
  "parameters": [
@@ -5175,7 +5605,7 @@
5175
5605
  }
5176
5606
  },
5177
5607
  "post": {
5178
- "tags": [],
5608
+ "tags": ["IncomingPhoneNumbers"],
5179
5609
  "summary": "Update an Incoming Number",
5180
5610
  "operationId": "update-an-incoming-number",
5181
5611
  "parameters": [
@@ -5217,7 +5647,7 @@
5217
5647
  }
5218
5648
  },
5219
5649
  "delete": {
5220
- "tags": [],
5650
+ "tags": ["IncomingPhoneNumbers"],
5221
5651
  "summary": "Delete an Incoming Number",
5222
5652
  "operationId": "delete-an-incoming-number",
5223
5653
  "parameters": [
@@ -5244,7 +5674,7 @@
5244
5674
  },
5245
5675
  "/Accounts/{accountId}/IncomingPhoneNumbers": {
5246
5676
  "get": {
5247
- "tags": [],
5677
+ "tags": ["IncomingPhoneNumbers"],
5248
5678
  "summary": "List Incoming Numbers",
5249
5679
  "operationId": "list-incoming-numbers",
5250
5680
  "parameters": [
@@ -5386,7 +5816,7 @@
5386
5816
  }
5387
5817
  },
5388
5818
  "post": {
5389
- "tags": [],
5819
+ "tags": ["IncomingPhoneNumbers"],
5390
5820
  "summary": "Buy a Phone Number",
5391
5821
  "operationId": "buy-a-phone-number",
5392
5822
  "parameters": [
@@ -5422,7 +5852,7 @@
5422
5852
  },
5423
5853
  "/Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion": {
5424
5854
  "post": {
5425
- "tags": [],
5855
+ "tags": ["KnowledgeBases"],
5426
5856
  "summary": "Query the knowledge base",
5427
5857
  "operationId": "create-knowledge-base-completion",
5428
5858
  "parameters": [
@@ -5466,7 +5896,7 @@
5466
5896
  },
5467
5897
  "/Accounts/{accountId}/Calls/{callId}": {
5468
5898
  "get": {
5469
- "tags": [],
5899
+ "tags": ["Calls"],
5470
5900
  "summary": "Get a Call",
5471
5901
  "operationId": "get-a-call",
5472
5902
  "parameters": [
@@ -5498,7 +5928,7 @@
5498
5928
  }
5499
5929
  },
5500
5930
  "post": {
5501
- "tags": [],
5931
+ "tags": ["Calls"],
5502
5932
  "summary": "Update a Live Call",
5503
5933
  "operationId": "update-a-live-call",
5504
5934
  "parameters": [
@@ -5536,7 +5966,7 @@
5536
5966
  },
5537
5967
  "/Accounts/{accountId}/Calls": {
5538
5968
  "post": {
5539
- "tags": [],
5969
+ "tags": ["Calls"],
5540
5970
  "summary": "Make a Call",
5541
5971
  "operationId": "make-a-call",
5542
5972
  "parameters": [
@@ -5569,7 +5999,7 @@
5569
5999
  }
5570
6000
  },
5571
6001
  "get": {
5572
- "tags": [],
6002
+ "tags": ["Calls"],
5573
6003
  "summary": "List Calls",
5574
6004
  "operationId": "list-calls",
5575
6005
  "parameters": [
@@ -5654,15 +6084,33 @@
5654
6084
  },
5655
6085
  {
5656
6086
  "$ref": "#/components/parameters/AccountId"
5657
- }
5658
- ],
5659
- "deprecated": false,
5660
- "responses": {
5661
- "200": {
5662
- "description": "Successful retrieved call list",
5663
- "content": {
5664
- "application/json": {
5665
- "schema": {
6087
+ },
6088
+ {
6089
+ "name": "riskScoreMin",
6090
+ "in": "query",
6091
+ "description": "The minimum riskScore that should be included in the list.",
6092
+ "required": false,
6093
+ "schema": {
6094
+ "type": "integer"
6095
+ }
6096
+ },
6097
+ {
6098
+ "name": "riskScoreMax",
6099
+ "in": "query",
6100
+ "description": "The maximum riskScore that should be included in the list.",
6101
+ "required": false,
6102
+ "schema": {
6103
+ "type": "integer"
6104
+ }
6105
+ }
6106
+ ],
6107
+ "deprecated": false,
6108
+ "responses": {
6109
+ "200": {
6110
+ "description": "Successful retrieved call list",
6111
+ "content": {
6112
+ "application/json": {
6113
+ "schema": {
5666
6114
  "$ref": "#/components/schemas/CallList"
5667
6115
  }
5668
6116
  }
@@ -5673,7 +6121,7 @@
5673
6121
  },
5674
6122
  "/Accounts/{accountId}/Calls/{callId}/Recordings": {
5675
6123
  "get": {
5676
- "tags": [],
6124
+ "tags": ["Calls"],
5677
6125
  "summary": "List Call Recordings",
5678
6126
  "operationId": "list-call-recordings",
5679
6127
  "parameters": [
@@ -5716,7 +6164,7 @@
5716
6164
  },
5717
6165
  "/Accounts/{accountId}/Calls/{callId}/Logs": {
5718
6166
  "get": {
5719
- "tags": [],
6167
+ "tags": ["Calls"],
5720
6168
  "summary": "List Call Logs",
5721
6169
  "operationId": "list-call-logs",
5722
6170
  "parameters": [
@@ -5750,6 +6198,7 @@
5750
6198
  },
5751
6199
  "/Accounts/{accountId}/Calls/WebRTC/Token": {
5752
6200
  "post": {
6201
+ "tags": ["Calls"],
5753
6202
  "summary": "Make a JWT for WebRTC calling",
5754
6203
  "operationId": "make-a-webrtc-jwt",
5755
6204
  "parameters": [
@@ -5785,7 +6234,7 @@
5785
6234
  },
5786
6235
  "/Accounts/{accountId}/Conferences": {
5787
6236
  "post": {
5788
- "tags": [],
6237
+ "tags": ["Conferences"],
5789
6238
  "summary": "Create a Conference",
5790
6239
  "operationId": "create-a-conference",
5791
6240
  "parameters": [
@@ -5818,7 +6267,7 @@
5818
6267
  }
5819
6268
  },
5820
6269
  "get": {
5821
- "tags": [],
6270
+ "tags": ["Conferences"],
5822
6271
  "summary": "List Conferences",
5823
6272
  "operationId": "list-conferences",
5824
6273
  "parameters": [
@@ -5879,7 +6328,7 @@
5879
6328
  },
5880
6329
  "/Accounts/{accountId}/Conferences/{conferenceId}": {
5881
6330
  "post": {
5882
- "tags": [],
6331
+ "tags": ["Conferences"],
5883
6332
  "summary": "Update a Conference",
5884
6333
  "operationId": "update-a-conference",
5885
6334
  "parameters": [
@@ -5914,7 +6363,7 @@
5914
6363
  }
5915
6364
  },
5916
6365
  "get": {
5917
- "tags": [],
6366
+ "tags": ["Conferences"],
5918
6367
  "summary": "Get a Conference",
5919
6368
  "operationId": "get-a-conference",
5920
6369
  "parameters": [
@@ -5948,7 +6397,7 @@
5948
6397
  },
5949
6398
  "/Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId}": {
5950
6399
  "post": {
5951
- "tags": [],
6400
+ "tags": ["Conferences"],
5952
6401
  "summary": "Update a Participant",
5953
6402
  "operationId": "update-a-participant",
5954
6403
  "parameters": [
@@ -5999,7 +6448,7 @@
5999
6448
  }
6000
6449
  },
6001
6450
  "get": {
6002
- "tags": [],
6451
+ "tags": ["Conferences"],
6003
6452
  "summary": "Get a Participant",
6004
6453
  "operationId": "get-a-participant",
6005
6454
  "parameters": [
@@ -6040,7 +6489,7 @@
6040
6489
  }
6041
6490
  },
6042
6491
  "delete": {
6043
- "tags": [],
6492
+ "tags": ["Conferences"],
6044
6493
  "summary": "Remove a Participant",
6045
6494
  "operationId": "remove-a-participant",
6046
6495
  "parameters": [
@@ -6076,7 +6525,7 @@
6076
6525
  },
6077
6526
  "/Accounts/{accountId}/Conferences/{conferenceId}/Participants": {
6078
6527
  "get": {
6079
- "tags": [],
6528
+ "tags": ["Conferences"],
6080
6529
  "summary": "List Participants",
6081
6530
  "operationId": "list-participants",
6082
6531
  "parameters": [
@@ -6137,7 +6586,7 @@
6137
6586
  },
6138
6587
  "/Accounts/{accountId}/Conferences/{conferenceId}/Recordings": {
6139
6588
  "get": {
6140
- "tags": [],
6589
+ "tags": ["Conferences"],
6141
6590
  "summary": "List Conference Recordings",
6142
6591
  "operationId": "list-conference-recordings",
6143
6592
  "parameters": [
@@ -6189,7 +6638,7 @@
6189
6638
  },
6190
6639
  "/Accounts/{accountId}/Queues/{queueId}": {
6191
6640
  "post": {
6192
- "tags": [],
6641
+ "tags": ["Queues"],
6193
6642
  "summary": "Update a Queue",
6194
6643
  "operationId": "update-a-queue",
6195
6644
  "parameters": [
@@ -6231,7 +6680,7 @@
6231
6680
  }
6232
6681
  },
6233
6682
  "get": {
6234
- "tags": [],
6683
+ "tags": ["Queues"],
6235
6684
  "summary": "Get a Queue",
6236
6685
  "operationId": "get-a-queue",
6237
6686
  "parameters": [
@@ -6265,7 +6714,7 @@
6265
6714
  },
6266
6715
  "/Accounts/{accountId}/Queues": {
6267
6716
  "get": {
6268
- "tags": [],
6717
+ "tags": ["Queues"],
6269
6718
  "summary": "List Active Queues",
6270
6719
  "operationId": "list-active-queues",
6271
6720
  "parameters": [
@@ -6297,7 +6746,7 @@
6297
6746
  }
6298
6747
  },
6299
6748
  "post": {
6300
- "tags": [],
6749
+ "tags": ["Queues"],
6301
6750
  "summary": "Create a Queue",
6302
6751
  "operationId": "create-a-queue",
6303
6752
  "parameters": [
@@ -6332,7 +6781,7 @@
6332
6781
  },
6333
6782
  "/Accounts/{accountId}/Queues/{queueId}/Members/Front": {
6334
6783
  "get": {
6335
- "tags": [],
6784
+ "tags": ["Queues"],
6336
6785
  "summary": "Get Head Member",
6337
6786
  "operationId": "get-head-member",
6338
6787
  "parameters": [
@@ -6364,7 +6813,7 @@
6364
6813
  }
6365
6814
  },
6366
6815
  "post": {
6367
- "tags": [],
6816
+ "tags": ["Queues"],
6368
6817
  "summary": "Dequeue Head Member",
6369
6818
  "operationId": "dequeue-head-member",
6370
6819
  "parameters": [
@@ -6398,7 +6847,7 @@
6398
6847
  },
6399
6848
  "/Accounts/{accountId}/Queues/{queueId}/Members": {
6400
6849
  "get": {
6401
- "tags": [],
6850
+ "tags": ["Queues"],
6402
6851
  "summary": "List Members",
6403
6852
  "operationId": "list-members",
6404
6853
  "parameters": [
@@ -6432,7 +6881,7 @@
6432
6881
  },
6433
6882
  "/Accounts/{accountId}/Queues/{queueId}/Members/{callId}": {
6434
6883
  "get": {
6435
- "tags": [],
6884
+ "tags": ["Queues"],
6436
6885
  "summary": "Get a Member",
6437
6886
  "operationId": "get-a-member",
6438
6887
  "parameters": [
@@ -6473,7 +6922,7 @@
6473
6922
  }
6474
6923
  },
6475
6924
  "post": {
6476
- "tags": [],
6925
+ "tags": ["Queues"],
6477
6926
  "summary": "Dequeue a Member",
6478
6927
  "operationId": "dequeue-a-member",
6479
6928
  "parameters": [
@@ -6516,7 +6965,7 @@
6516
6965
  },
6517
6966
  "/Accounts/{accountId}/Logs": {
6518
6967
  "get": {
6519
- "tags": [],
6968
+ "tags": ["Logs"],
6520
6969
  "summary": "List All Account Logs",
6521
6970
  "operationId": "list-all-account-logs",
6522
6971
  "parameters": [
@@ -6539,7 +6988,7 @@
6539
6988
  }
6540
6989
  },
6541
6990
  "post": {
6542
- "tags": [],
6991
+ "tags": ["Logs"],
6543
6992
  "summary": "Filter Logs",
6544
6993
  "operationId": "filter-logs",
6545
6994
  "parameters": [
@@ -6575,7 +7024,7 @@
6575
7024
  },
6576
7025
  "/Accounts/{accountId}/Recordings": {
6577
7026
  "get": {
6578
- "tags": [],
7027
+ "tags": ["Recordings"],
6579
7028
  "summary": "List Recordings",
6580
7029
  "operationId": "list-recordings",
6581
7030
  "parameters": [
@@ -6627,7 +7076,7 @@
6627
7076
  },
6628
7077
  "/Accounts/{accountId}/Recordings/{recordingId}": {
6629
7078
  "get": {
6630
- "tags": [],
7079
+ "tags": ["Recordings"],
6631
7080
  "summary": "Get a Recording",
6632
7081
  "operationId": "get-a-recording",
6633
7082
  "parameters": [
@@ -6659,7 +7108,7 @@
6659
7108
  "deprecated": false
6660
7109
  },
6661
7110
  "delete": {
6662
- "tags": [],
7111
+ "tags": ["Recordings"],
6663
7112
  "summary": "Delete a Recording",
6664
7113
  "operationId": "delete-a-recording",
6665
7114
  "parameters": [
@@ -6686,7 +7135,7 @@
6686
7135
  },
6687
7136
  "/Accounts/{accountId}/Recordings/{recordingId}/Stream": {
6688
7137
  "get": {
6689
- "tags": [],
7138
+ "tags": ["Recordings"],
6690
7139
  "summary": "Stream a Recording File",
6691
7140
  "operationId": "stream-a-recording-file",
6692
7141
  "parameters": [
@@ -6705,9 +7154,9 @@
6705
7154
  ],
6706
7155
  "responses": {
6707
7156
  "200": {
6708
- "description": "Streaming a Recording represented with audio/x-wav mime-type",
7157
+ "description": "Streaming a Recording represented with audio/wav mime-type",
6709
7158
  "content": {
6710
- "audio/x-wav": {
7159
+ "audio/wav": {
6711
7160
  "schema": {
6712
7161
  "type": "string",
6713
7162
  "format": "binary"
@@ -6721,7 +7170,7 @@
6721
7170
  },
6722
7171
  "/Accounts/{accountId}/Recordings/{recordingId}/Download": {
6723
7172
  "get": {
6724
- "tags": [],
7173
+ "tags": ["Recordings"],
6725
7174
  "summary": "Download a Recording File",
6726
7175
  "operationId": "download-a-recording-file",
6727
7176
  "parameters": [
@@ -6740,9 +7189,9 @@
6740
7189
  ],
6741
7190
  "responses": {
6742
7191
  "200": {
6743
- "description": "Download a Recording file represented with audio/x-wav mime-type",
7192
+ "description": "Download a Recording file represented with audio/wav mime-type",
6744
7193
  "content": {
6745
- "audio/x-wav": {
7194
+ "audio/wav": {
6746
7195
  "schema": {
6747
7196
  "type": "string",
6748
7197
  "format": "binary"
@@ -6756,7 +7205,7 @@
6756
7205
  },
6757
7206
  "/Accounts/{accountId}/Messages": {
6758
7207
  "get": {
6759
- "tags": [],
7208
+ "tags": ["Messages"],
6760
7209
  "summary": "List SMS Messages",
6761
7210
  "operationId": "list-sms-messages",
6762
7211
  "parameters": [
@@ -6851,7 +7300,7 @@
6851
7300
  "deprecated": false
6852
7301
  },
6853
7302
  "post": {
6854
- "tags": [],
7303
+ "tags": ["Messages"],
6855
7304
  "summary": "Send an SMS Message",
6856
7305
  "operationId": "send-an-sms-message",
6857
7306
  "parameters": [
@@ -6887,7 +7336,7 @@
6887
7336
  },
6888
7337
  "/Accounts/{accountId}/Messages/{messageId}": {
6889
7338
  "get": {
6890
- "tags": [],
7339
+ "tags": ["Messages"],
6891
7340
  "summary": "Get an SMS Message",
6892
7341
  "operationId": "get-an-sms-message",
6893
7342
  "parameters": [
@@ -6921,7 +7370,7 @@
6921
7370
  },
6922
7371
  "/Accounts/{accountId}/Messages/10DLC/Campaigns": {
6923
7372
  "get": {
6924
- "tags": [],
7373
+ "tags": ["Messages"],
6925
7374
  "summary": "Get list of SMS 10DLC Campaigns",
6926
7375
  "operationId": "get-tenDLC-sms-campaigns",
6927
7376
  "parameters": [
@@ -6999,7 +7448,7 @@
6999
7448
  },
7000
7449
  "/Accounts/{accountId}/Messages/10DLC/Campaigns/{campaignId}": {
7001
7450
  "get": {
7002
- "tags": [],
7451
+ "tags": ["Messages"],
7003
7452
  "summary": "Get a 10DLC SMS Campaign",
7004
7453
  "operationId": "get-tenDLC-sms-campaign",
7005
7454
  "parameters": [
@@ -7033,7 +7482,7 @@
7033
7482
  },
7034
7483
  "/Accounts/{accountId}/Messages/10DLC/PartnerCampaigns": {
7035
7484
  "get": {
7036
- "tags": [],
7485
+ "tags": ["Messages"],
7037
7486
  "summary": "Get list of SMS 10DLC Partner Campaigns",
7038
7487
  "operationId": "get-tenDLC-sms-partnerCampaigns",
7039
7488
  "parameters": [
@@ -7120,7 +7569,7 @@
7120
7569
  },
7121
7570
  "/Accounts/{accountId}/Messages/10DLC/PartnerCampaigns/{campaignId}": {
7122
7571
  "get": {
7123
- "tags": [],
7572
+ "tags": ["Messages"],
7124
7573
  "summary": "Get a 10DLC SMS Partner Campaign",
7125
7574
  "operationId": "get-tenDLC-sms-partnerCampaign",
7126
7575
  "parameters": [
@@ -7154,7 +7603,7 @@
7154
7603
  },
7155
7604
  "/Accounts/{accountId}/Messages/10DLC/Brands": {
7156
7605
  "get": {
7157
- "tags": [],
7606
+ "tags": ["Messages"],
7158
7607
  "summary": "Get list of SMS 10DLC Brands",
7159
7608
  "operationId": "get-tenDLC-sms-brands",
7160
7609
  "parameters": [
@@ -7221,7 +7670,7 @@
7221
7670
  },
7222
7671
  "/Accounts/{accountId}/Messages/10DLC/Brands/{brandId}": {
7223
7672
  "get": {
7224
- "tags": [],
7673
+ "tags": ["Messages"],
7225
7674
  "summary": "Get a 10DLC SMS Brand",
7226
7675
  "operationId": "get-tenDLC-sms-brand",
7227
7676
  "parameters": [
@@ -7255,7 +7704,7 @@
7255
7704
  },
7256
7705
  "/Accounts/{accountId}/Messages/TollFree/Campaigns": {
7257
7706
  "get": {
7258
- "tags": [],
7707
+ "tags": ["Messages"],
7259
7708
  "summary": "Get list of TollFree Campaigns",
7260
7709
  "operationId": "get-tollFree-sms-campaigns",
7261
7710
  "parameters": [
@@ -7300,7 +7749,7 @@
7300
7749
  },
7301
7750
  "/Accounts/{accountId}/Messages/TollFree/Campaigns/{campaignId}": {
7302
7751
  "get": {
7303
- "tags": [],
7752
+ "tags": ["Messages"],
7304
7753
  "summary": "Get a TollFree SMS Campaign",
7305
7754
  "operationId": "get-tollFree-sms-campaign",
7306
7755
  "parameters": [
@@ -7331,8 +7780,724 @@
7331
7780
  },
7332
7781
  "deprecated": false
7333
7782
  }
7783
+ },
7784
+ "/Accounts/{accountId}/Exports": {
7785
+ "get": {
7786
+ "tags": ["Exports"],
7787
+ "summary": "List Exports",
7788
+ "operationId": "list-exports",
7789
+ "responses": {
7790
+ "200": {
7791
+ "description": "Successful retrieved export list",
7792
+ "content": {
7793
+ "application/json": {
7794
+ "schema": {
7795
+ "$ref": "#/components/schemas/ExportList"
7796
+ }
7797
+ }
7798
+ }
7799
+ }
7800
+ },
7801
+ "parameters": [
7802
+ {
7803
+ "$ref": "#/components/parameters/AccountId"
7804
+ },
7805
+ {
7806
+ "schema": {
7807
+ "$ref": "#/components/schemas/ExportStatus"
7808
+ },
7809
+ "in": "query",
7810
+ "name": "status",
7811
+ "description": "Status of export"
7812
+ },
7813
+ {
7814
+ "schema": {
7815
+ "type": "string"
7816
+ },
7817
+ "in": "query",
7818
+ "name": "cursor",
7819
+ "description": "Used to reference pages of a list of exports"
7820
+ }
7821
+ ]
7822
+ },
7823
+ "post": {
7824
+ "summary": "Create an Export",
7825
+ "operationId": "create-export",
7826
+ "tags": ["Exports"],
7827
+ "requestBody": {
7828
+ "description": "A JSON object containing export creation parameters",
7829
+ "content": {
7830
+ "application/json": {
7831
+ "schema": {
7832
+ "$ref": "#/components/schemas/ExportRequest"
7833
+ }
7834
+ }
7835
+ }
7836
+ },
7837
+ "responses": {
7838
+ "200": {
7839
+ "description": "Export successfully created",
7840
+ "content": {
7841
+ "application/json": {
7842
+ "schema": {
7843
+ "$ref": "#/components/schemas/ExportResult"
7844
+ }
7845
+ }
7846
+ }
7847
+ }
7848
+ },
7849
+ "parameters": [
7850
+ {
7851
+ "$ref": "#/components/parameters/AccountId"
7852
+ }
7853
+ ]
7854
+ }
7855
+ },
7856
+ "/Accounts/{accountId}/Exports/{exportId}": {
7857
+ "get": {
7858
+ "tags": ["Exports"],
7859
+ "summary": "Get an Export",
7860
+ "operationId": "get-an-export",
7861
+ "parameters": [
7862
+ {
7863
+ "$ref": "#/components/parameters/AccountId"
7864
+ },
7865
+ {
7866
+ "name": "exportId",
7867
+ "in": "path",
7868
+ "description": "A string that uniquely identifies this export resource.",
7869
+ "required": true,
7870
+ "schema": {
7871
+ "type": "string"
7872
+ }
7873
+ }
7874
+ ],
7875
+ "deprecated": false,
7876
+ "responses": {
7877
+ "200": {
7878
+ "description": "Export Details",
7879
+ "content": {
7880
+ "application/json": {
7881
+ "schema": {
7882
+ "$ref": "#/components/schemas/ExportResult"
7883
+ }
7884
+ }
7885
+ }
7886
+ }
7887
+ }
7888
+ },
7889
+ "delete": {
7890
+ "tags": ["Exports"],
7891
+ "summary": "Delete an Export",
7892
+ "operationId": "delete-an-export",
7893
+ "parameters": [
7894
+ {
7895
+ "$ref": "#/components/parameters/AccountId"
7896
+ },
7897
+ {
7898
+ "name": "exportId",
7899
+ "in": "path",
7900
+ "description": "A string that uniquely identifies this export resource.",
7901
+ "required": true,
7902
+ "schema": {
7903
+ "type": "string"
7904
+ }
7905
+ }
7906
+ ],
7907
+ "deprecated": false,
7908
+ "responses": {
7909
+ "204": {
7910
+ "description": "Successful Export deletion"
7911
+ }
7912
+ }
7913
+ }
7914
+ },
7915
+ "/Accounts/{accountId}/Exports/{exportId}/Download": {
7916
+ "get": {
7917
+ "tags": ["Exports"],
7918
+ "summary": "Download an Export",
7919
+ "operationId": "download-an-export",
7920
+ "parameters": [
7921
+ {
7922
+ "$ref": "#/components/parameters/AccountId"
7923
+ },
7924
+ {
7925
+ "name": "exportId",
7926
+ "in": "path",
7927
+ "description": "A string that uniquely identifies this export resource.",
7928
+ "required": true,
7929
+ "schema": {
7930
+ "type": "string"
7931
+ }
7932
+ }
7933
+ ],
7934
+ "deprecated": false,
7935
+ "responses": {
7936
+ "200": {
7937
+ "description": "Export Details",
7938
+ "content": {
7939
+ "text/csv": {
7940
+ "schema": {
7941
+ "type": "string"
7942
+ }
7943
+ }
7944
+ }
7945
+ }
7946
+ }
7947
+ }
7948
+ },
7949
+ "/Accounts/{accountId}/Blobs": {
7950
+ "summary": "Operations affecting the whole set of Blobs belonging to an account.",
7951
+ "parameters": [
7952
+ {
7953
+ "$ref": "#/components/parameters/AccountId"
7954
+ }
7955
+ ],
7956
+ "get": {
7957
+ "summary": "List Blobs belonging to an account.",
7958
+ "description": "List Blobs belonging to an account. Results are returned in paginated lists mirroring other listing features in the API.",
7959
+ "tags": ["Blobs"],
7960
+ "responses": {
7961
+ "200": {
7962
+ "description": "Single page of blob list results.",
7963
+ "content": {
7964
+ "application/json": {
7965
+ "schema": {
7966
+ "$ref": "#/components/schemas/BlobListResponse"
7967
+ },
7968
+ "example": {
7969
+ "total": 2,
7970
+ "start": 0,
7971
+ "end": 1,
7972
+ "page": 0,
7973
+ "numPages": 1,
7974
+ "pageSize": 100,
7975
+ "nextPageUri": null,
7976
+ "blobs": [
7977
+ {
7978
+ "blobId": "BL387ec3f6e03b340553f35f29c8f118cdf3eae08a",
7979
+ "accountId": "AC3ff5d5aed7fde9e6659673d850cbd18ea8bfca78",
7980
+ "alias": "my-blob-alias",
7981
+ "revision": 1,
7982
+ "dateCreated": "2006-01-02T15:04:05.000Z",
7983
+ "dateUpdated": "2006-01-02T15:04:05.000Z",
7984
+ "expiresAt": "2006-01-02T15:04:05.000Z",
7985
+ "blob": {
7986
+ "field0": "value0",
7987
+ "field1": 1,
7988
+ "field2": true
7989
+ }
7990
+ },
7991
+ {
7992
+ "blobId": "BL487ec3f6e03b340553f35f29c8f118cdf3eae08b",
7993
+ "accountId": "AC3ff5d5aed7fde9e6659673d850cbd18ea8bfca78",
7994
+ "alias": "another-blob",
7995
+ "revision": 1,
7996
+ "dateCreated": "2006-01-02T16:04:05.000Z",
7997
+ "dateUpdated": "2006-01-02T16:04:05.000Z",
7998
+ "expiresAt": "2006-01-02T16:04:05.000Z",
7999
+ "blob": {
8000
+ "data": "example"
8001
+ }
8002
+ }
8003
+ ]
8004
+ }
8005
+ }
8006
+ }
8007
+ },
8008
+ "400": {
8009
+ "$ref": "#/components/responses/error400"
8010
+ },
8011
+ "500": {
8012
+ "$ref": "#/components/responses/error500"
8013
+ },
8014
+ "504": {
8015
+ "$ref": "#/components/responses/error504"
8016
+ }
8017
+ },
8018
+ "operationId": "list-blobs",
8019
+ "parameters": [
8020
+ {
8021
+ "schema": {
8022
+ "type": "string"
8023
+ },
8024
+ "in": "query",
8025
+ "name": "alias",
8026
+ "description": "Filter blobs by alias"
8027
+ },
8028
+ {
8029
+ "schema": {
8030
+ "type": "string"
8031
+ },
8032
+ "in": "query",
8033
+ "name": "cursor",
8034
+ "description": "Used to reference pages of a list of blobs"
8035
+ }
8036
+ ]
8037
+ },
8038
+ "post": {
8039
+ "tags": ["Blobs"],
8040
+ "summary": "Create a Blob",
8041
+ "description": "Create a new Blob belonging to the requesting account.",
8042
+ "operationId": "create-blob",
8043
+ "requestBody": {
8044
+ "description": "An object defining a new blob. A request body must be provided but the blob may be empty.",
8045
+ "content": {
8046
+ "application/json": {
8047
+ "schema": {
8048
+ "$ref": "#/components/schemas/CreateBlobRequest"
8049
+ },
8050
+ "examples": {
8051
+ "plain_empty_blob": {
8052
+ "value": {
8053
+ "blob": {}
8054
+ }
8055
+ },
8056
+ "setting_blob_content": {
8057
+ "value": {
8058
+ "blob": {
8059
+ "key0": "value0",
8060
+ "key1": 1,
8061
+ "key2": {
8062
+ "keyA": true,
8063
+ "keyB": [1, 1, 2, 3, 5, 8, 13, 21]
8064
+ }
8065
+ }
8066
+ }
8067
+ },
8068
+ "setting_alias_blob": {
8069
+ "value": {
8070
+ "alias": "my_custom_blob_identifier",
8071
+ "blob": {
8072
+ "key": "value"
8073
+ }
8074
+ }
8075
+ },
8076
+ "setting_expiresAt_blob": {
8077
+ "value": {
8078
+ "expiresAt": "2025-01-04T15:04:05.060Z",
8079
+ "blob": {
8080
+ "key": 45
8081
+ }
8082
+ }
8083
+ },
8084
+ "setting_everything_blob": {
8085
+ "value": {
8086
+ "alias": "my_custom_blob_identifier",
8087
+ "expiresAt": "2025-01-04T15:04:05.060Z",
8088
+ "blob": {
8089
+ "key0": "value",
8090
+ "key1": 45
8091
+ }
8092
+ }
8093
+ }
8094
+ }
8095
+ }
8096
+ },
8097
+ "required": true
8098
+ },
8099
+ "responses": {
8100
+ "201": {
8101
+ "description": "Successful creation of a new blob.",
8102
+ "content": {
8103
+ "application/json": {
8104
+ "schema": {
8105
+ "$ref": "#/components/schemas/BlobResult"
8106
+ },
8107
+ "examples": {
8108
+ "plain_empty_blob": {
8109
+ "value": {
8110
+ "revision": 1,
8111
+ "dateCreated": "2025-01-02T15:04:05.000Z",
8112
+ "dateUpdated": "2025-01-02T15:04:05.000Z",
8113
+ "accountId": "AC387ec3f6e03b340553f35f29c8f118cdf3eae08a",
8114
+ "alias": "BL387ec3f6e03b340553f35f29c8f118cdf3eae08a",
8115
+ "blobId": "BL387ec3f6e03b340553f35f29c8f118cdf3eae08a",
8116
+ "expiresAt": "2025-01-03T00:04:05.000Z",
8117
+ "blob": {}
8118
+ }
8119
+ },
8120
+ "setting_blob_content": {
8121
+ "value": {
8122
+ "revision": 1,
8123
+ "dateCreated": "2025-01-02T15:04:05.000Z",
8124
+ "dateUpdated": "2025-01-02T15:04:05.000Z",
8125
+ "accountId": "AC387ec3f6e03b340553f35f29c8f118cdf3eae08a",
8126
+ "alias": "BL387ec3f6e03b340553f35f29c8f118cdf3eae08a",
8127
+ "blobId": "BL387ec3f6e03b340553f35f29c8f118cdf3eae08a",
8128
+ "expiresAt": "2025-01-03T00:04:05.000Z",
8129
+ "blob": {
8130
+ "key0": "value0",
8131
+ "key1": 1,
8132
+ "key2": {
8133
+ "keyA": true,
8134
+ "keyB": [1, 1, 2, 3, 5, 8, 13, 21]
8135
+ }
8136
+ }
8137
+ }
8138
+ },
8139
+ "setting_alias_blob": {
8140
+ "value": {
8141
+ "revision": 1,
8142
+ "dateCreated": "2025-01-02T15:04:05.000Z",
8143
+ "dateUpdated": "2025-01-02T15:04:05.000Z",
8144
+ "accountId": "AC387ec3f6e03b340553f35f29c8f118cdf3eae08a",
8145
+ "alias": "my_custom_blob_identifier",
8146
+ "blobId": "BL387ec3f6e03b340553f35f29c8f118cdf3eae08a",
8147
+ "expiresAt": "2025-01-03T00:04:05.000Z",
8148
+ "blob": {
8149
+ "key": "value"
8150
+ }
8151
+ }
8152
+ },
8153
+ "setting_expiresAt_blob": {
8154
+ "value": {
8155
+ "revision": 1,
8156
+ "dateCreated": "2025-01-02T15:04:05.000Z",
8157
+ "dateUpdated": "2025-01-02T15:04:05.000Z",
8158
+ "accountId": "AC387ec3f6e03b340553f35f29c8f118cdf3eae08a",
8159
+ "alias": "BL387ec3f6e03b340553f35f29c8f118cdf3eae08a",
8160
+ "blobId": "BL387ec3f6e03b340553f35f29c8f118cdf3eae08a",
8161
+ "expiresAt": "2025-01-04T15:04:05.060Z",
8162
+ "blob": {
8163
+ "key": 45
8164
+ }
8165
+ }
8166
+ },
8167
+ "setting_everything_blob": {
8168
+ "value": {
8169
+ "revision": 1,
8170
+ "dateCreated": "2025-01-02T15:04:05.000Z",
8171
+ "dateUpdated": "2025-01-02T15:04:05.000Z",
8172
+ "accountId": "AC387ec3f6e03b340553f35f29c8f118cdf3eae08a",
8173
+ "blobId": "BL387ec3f6e03b340553f35f29c8f118cdf3eae08a",
8174
+ "alias": "my_custom_blob_identifier",
8175
+ "expiresAt": "2025-01-04T15:04:05.060Z",
8176
+ "blob": {
8177
+ "key0": "value",
8178
+ "key1": 45
8179
+ }
8180
+ }
8181
+ }
8182
+ }
8183
+ }
8184
+ }
8185
+ },
8186
+ "400": {
8187
+ "$ref": "#/components/responses/error400"
8188
+ },
8189
+ "409": {
8190
+ "description": "A blob with the provided alias already exists oln the requesting account and so this new blob is rejected as there cannot be duplicate alises.",
8191
+ "content": {
8192
+ "application/json": {
8193
+ "schema": {
8194
+ "$ref": "#/components/schemas/PlatformError"
8195
+ },
8196
+ "example": {
8197
+ "code": 108,
8198
+ "call": "Request conflicts with another resource",
8199
+ "url": "https://docs.freeclimb.com/reference/error-and-warning-dictionary#108",
8200
+ "details": {
8201
+ "explanation": "alias already exists for another blob on this account"
8202
+ }
8203
+ }
8204
+ }
8205
+ }
8206
+ },
8207
+ "413": {
8208
+ "description": "The blob exceeded one of the size limits. Either it itself is too large or it would push the total sum of all blobs over the account's limit.",
8209
+ "content": {
8210
+ "application/json": {
8211
+ "schema": {
8212
+ "$ref": "#/components/schemas/PlatformError"
8213
+ },
8214
+ "example": {
8215
+ "code": 80,
8216
+ "call": "Missing Required Parameter(s)",
8217
+ "url": "https://docs.freeclimb.com/reference/error-and-warning-dictionary#80",
8218
+ "details": {
8219
+ "explanation": "blob exceeds per-blob size limit"
8220
+ }
8221
+ }
8222
+ }
8223
+ }
8224
+ },
8225
+ "422": {
8226
+ "$ref": "#/components/responses/error422"
8227
+ },
8228
+ "500": {
8229
+ "$ref": "#/components/responses/error500"
8230
+ }
8231
+ }
8232
+ }
8233
+ },
8234
+ "/Accounts/{accountId}/Blobs/{blobId}": {
8235
+ "summary": "Operations affecting an individual blob belonging to an account.",
8236
+ "parameters": [
8237
+ {
8238
+ "$ref": "#/components/parameters/AccountId"
8239
+ },
8240
+ {
8241
+ "name": "blobId",
8242
+ "in": "path",
8243
+ "description": "String that uniquely identifies this Blob resource.",
8244
+ "required": true,
8245
+ "schema": {
8246
+ "$ref": "#/components/schemas/blobId"
8247
+ }
8248
+ }
8249
+ ],
8250
+ "get": {
8251
+ "summary": "Get Blob",
8252
+ "tags": ["Blobs"],
8253
+ "responses": {
8254
+ "200": {
8255
+ "description": "Retrieve a Blob.",
8256
+ "content": {
8257
+ "application/json": {
8258
+ "schema": {
8259
+ "$ref": "#/components/schemas/BlobResult"
8260
+ },
8261
+ "example": {
8262
+ "blobId": "BL387ec3f6e03b340553f35f29c8f118cdf3eae08a",
8263
+ "accountId": "AC3ff5d5aed7fde9e6659673d850cbd18ea8bfca78",
8264
+ "alias": "my-blob-alias",
8265
+ "revision": 1,
8266
+ "dateCreated": "2006-01-02T15:04:05.000Z",
8267
+ "dateUpdated": "2006-01-02T15:04:05.000Z",
8268
+ "expiresAt": "2006-01-02T15:04:05.000Z",
8269
+ "blob": {
8270
+ "field0": "value0",
8271
+ "field1": 1,
8272
+ "field2": true
8273
+ }
8274
+ }
8275
+ }
8276
+ }
8277
+ },
8278
+ "404": {
8279
+ "$ref": "#/components/responses/error404"
8280
+ },
8281
+ "500": {
8282
+ "$ref": "#/components/responses/error500"
8283
+ },
8284
+ "504": {
8285
+ "$ref": "#/components/responses/error504"
8286
+ }
8287
+ },
8288
+ "operationId": "get-blob",
8289
+ "description": "Retrieves a specified blob"
8290
+ },
8291
+ "delete": {
8292
+ "summary": "Delete Blob",
8293
+ "tags": ["Blobs"],
8294
+ "responses": {
8295
+ "200": {
8296
+ "description": "Blob keys deleted successfully, remaining blob returned.",
8297
+ "content": {
8298
+ "application/json": {
8299
+ "schema": {
8300
+ "$ref": "#/components/schemas/BlobResult"
8301
+ }
8302
+ }
8303
+ }
8304
+ },
8305
+ "204": {
8306
+ "$ref": "#/components/responses/success204"
8307
+ },
8308
+ "404": {
8309
+ "$ref": "#/components/responses/error404"
8310
+ },
8311
+ "422": {
8312
+ "$ref": "#/components/responses/error422"
8313
+ },
8314
+ "500": {
8315
+ "$ref": "#/components/responses/error500"
8316
+ },
8317
+ "504": {
8318
+ "$ref": "#/components/responses/error504"
8319
+ }
8320
+ },
8321
+ "operationId": "delete-blob",
8322
+ "description": "Deletes a blob or specific keys from a blob. If no keys are specified in the request body, the entire blob is deleted (returns 204). If specific keys are provided, only those keys are removed and the remaining blob is returned (returns 200)."
8323
+ },
8324
+ "patch": {
8325
+ "summary": "Modify Blob",
8326
+ "tags": ["Blobs"],
8327
+ "responses": {
8328
+ "200": {
8329
+ "description": "Blob keys successfully modified, updated blob returned.",
8330
+ "content": {
8331
+ "application/json": {
8332
+ "schema": {
8333
+ "$ref": "#/components/schemas/BlobResult"
8334
+ },
8335
+ "example": {
8336
+ "blobId": "BL387ec3f6e03b340553f35f29c8f118cdf3eae08a",
8337
+ "accountId": "AC3ff5d5aed7fde9e6659673d850cbd18ea8bfca78",
8338
+ "alias": "new_conversation_id",
8339
+ "revision": 2,
8340
+ "dateCreated": "2006-01-02T15:04:05.000Z",
8341
+ "dateUpdated": "2006-01-02T15:04:05.000Z",
8342
+ "expiresAt": "2006-01-02T15:04:05.000Z",
8343
+ "blob": {
8344
+ "field0": "value0_redux",
8345
+ "field4": "value4"
8346
+ }
8347
+ }
8348
+ }
8349
+ }
8350
+ },
8351
+ "404": {
8352
+ "$ref": "#/components/responses/error404"
8353
+ },
8354
+ "409": {
8355
+ "$ref": "#/components/responses/error409"
8356
+ },
8357
+ "413": {
8358
+ "$ref": "#/components/responses/error413"
8359
+ },
8360
+ "500": {
8361
+ "$ref": "#/components/responses/error500"
8362
+ }
8363
+ },
8364
+ "operationId": "modify-blob",
8365
+ "requestBody": {
8366
+ "description": "Request body to specify keys to modify. Or new keys to add onto the already existing blob",
8367
+ "required": true,
8368
+ "content": {
8369
+ "application/json": {
8370
+ "schema": {
8371
+ "$ref": "#/components/schemas/ModifyBlobRequest"
8372
+ },
8373
+ "example": {
8374
+ "alias": "new_conversation_id",
8375
+ "blob": {
8376
+ "field0": "value0_redux",
8377
+ "field4": "value4"
8378
+ }
8379
+ }
8380
+ }
8381
+ }
8382
+ },
8383
+ "description": "Modifys a pre existing blob by either adding new fields, or modifying existing fields"
8384
+ },
8385
+ "put": {
8386
+ "summary": "Replace Blob",
8387
+ "tags": ["Blobs"],
8388
+ "responses": {
8389
+ "200": {
8390
+ "description": "Replaces all keys in blob with those provided.",
8391
+ "content": {
8392
+ "application/json": {
8393
+ "schema": {
8394
+ "$ref": "#/components/schemas/BlobResult"
8395
+ },
8396
+ "example": {
8397
+ "blobId": "BL387ec3f6e03b340553f35f29c8f118cdf3eae08a",
8398
+ "accountId": "AC3ff5d5aed7fde9e6659673d850cbd18ea8bfca78",
8399
+ "alias": "new_conversation_id",
8400
+ "revision": 2,
8401
+ "dateCreated": "2006-01-02T15:04:05.000Z",
8402
+ "dateUpdated": "2006-01-02T15:04:05.000Z",
8403
+ "expiresAt": "2006-01-02T15:04:05.000Z",
8404
+ "blob": {
8405
+ "field0": "value0_redux",
8406
+ "field4": "value4"
8407
+ }
8408
+ }
8409
+ }
8410
+ }
8411
+ },
8412
+ "404": {
8413
+ "$ref": "#/components/responses/error404"
8414
+ },
8415
+ "409": {
8416
+ "$ref": "#/components/responses/error409"
8417
+ },
8418
+ "413": {
8419
+ "$ref": "#/components/responses/error413"
8420
+ },
8421
+ "500": {
8422
+ "$ref": "#/components/responses/error500"
8423
+ }
8424
+ },
8425
+ "operationId": "replace-blob",
8426
+ "requestBody": {
8427
+ "description": "JSON object containing blob key the contents of which will be used to override the enitre blob contents.",
8428
+ "required": true,
8429
+ "content": {
8430
+ "application/json": {
8431
+ "schema": {
8432
+ "$ref": "#/components/schemas/ReplaceBlobRequest"
8433
+ },
8434
+ "example": {
8435
+ "blob": {
8436
+ "field0": "value0_redux",
8437
+ "field4": "value4"
8438
+ }
8439
+ }
8440
+ }
8441
+ }
8442
+ },
8443
+ "description": "Replaces the blob content with the provided values."
8444
+ }
7334
8445
  }
7335
8446
  },
8447
+ "tags": [
8448
+ {
8449
+ "name": "Accounts",
8450
+ "description": "API for managing whole Accounts"
8451
+ },
8452
+ {
8453
+ "name": "Applications",
8454
+ "description": "API for managing Applications"
8455
+ },
8456
+ {
8457
+ "name": "AvailablePhoneNumbers",
8458
+ "description": "API for managing AvailablePhoneNumbers"
8459
+ },
8460
+ {
8461
+ "name": "IncomingPhoneNumbers",
8462
+ "description": "API for managing IncomingPhoneNumbers"
8463
+ },
8464
+ {
8465
+ "name": "KnowledgeBases",
8466
+ "description": "API for managing KnowledgeBases"
8467
+ },
8468
+ {
8469
+ "name": "Calls",
8470
+ "description": "API for managing Calls"
8471
+ },
8472
+ {
8473
+ "name": "Conferences",
8474
+ "description": "API for managing Conferences"
8475
+ },
8476
+ {
8477
+ "name": "Queues",
8478
+ "description": "API for managing Queues"
8479
+ },
8480
+ {
8481
+ "name": "Logs",
8482
+ "description": "API for managing Logs"
8483
+ },
8484
+ {
8485
+ "name": "Recordings",
8486
+ "description": "API for managing Recordings"
8487
+ },
8488
+ {
8489
+ "name": "Messages",
8490
+ "description": "API for managing Messages"
8491
+ },
8492
+ {
8493
+ "name": "Exports",
8494
+ "description": "API for managing Exports"
8495
+ },
8496
+ {
8497
+ "name": "Blobs",
8498
+ "description": "API for managing Blobs"
8499
+ }
8500
+ ],
7336
8501
  "x-headers": [],
7337
8502
  "x-explorer-enabled": true,
7338
8503
  "x-proxy-enabled": true,