freeclimb 5.3.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 (55) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +9 -1
  3. data/Gemfile.lock +1 -1
  4. data/README.md +18 -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/CreateBlobRequest.md +22 -0
  9. data/docs/DefaultApi.md +449 -6
  10. data/docs/IncomingNumberResult.md +0 -4
  11. data/docs/ModifyBlobRequest.md +20 -0
  12. data/docs/PlatformError.md +24 -0
  13. data/docs/ReplaceBlobRequest.md +18 -0
  14. data/docs/Say.md +2 -0
  15. data/docs/TTSEngine.md +20 -0
  16. data/docs/TTSEngineName.md +18 -0
  17. data/lib/freeclimb/api/default_api.rb +715 -8
  18. data/lib/freeclimb/models/available_number.rb +1 -23
  19. data/lib/freeclimb/models/blob_list_response.rb +303 -0
  20. data/lib/freeclimb/models/blob_result.rb +332 -0
  21. data/lib/freeclimb/models/create_blob_request.rb +255 -0
  22. data/lib/freeclimb/models/incoming_number_result.rb +1 -23
  23. data/lib/freeclimb/models/modify_blob_request.rb +245 -0
  24. data/lib/freeclimb/models/platform_error.rb +244 -0
  25. data/lib/freeclimb/models/replace_blob_request.rb +221 -0
  26. data/lib/freeclimb/models/say.rb +10 -1
  27. data/lib/freeclimb/models/tts_engine.rb +250 -0
  28. data/lib/freeclimb/models/tts_engine_name.rb +36 -0
  29. data/lib/freeclimb/version.rb +1 -1
  30. data/lib/freeclimb.rb +8 -0
  31. data/openapi.json +894 -97
  32. data/spec/api/default_api_spec.rb +188 -32
  33. data/spec/models/account_result_spec.rb +3 -3
  34. data/spec/models/available_number_spec.rb +3 -98
  35. data/spec/models/blob_list_response_spec.rb +502 -0
  36. data/spec/models/blob_result_spec.rb +489 -0
  37. data/spec/models/call_result_spec.rb +3 -3
  38. data/spec/models/conference_result_spec.rb +3 -3
  39. data/spec/models/create_blob_request_spec.rb +273 -0
  40. data/spec/models/export_request_spec.rb +6 -6
  41. data/spec/models/export_result_spec.rb +6 -6
  42. data/spec/models/incoming_number_result_spec.rb +6 -102
  43. data/spec/models/log_result_spec.rb +3 -3
  44. data/spec/models/message_result_spec.rb +3 -3
  45. data/spec/models/modify_blob_request_spec.rb +226 -0
  46. data/spec/models/platform_error_spec.rb +318 -0
  47. data/spec/models/queue_result_spec.rb +3 -3
  48. data/spec/models/replace_blob_request_spec.rb +176 -0
  49. data/spec/models/say_spec.rb +50 -0
  50. data/spec/models/sms_ten_dlc_partner_campaign_spec.rb +3 -3
  51. data/spec/models/transcribe_utterance_spec.rb +3 -3
  52. data/spec/models/tts_engine_name_spec.rb +75 -0
  53. data/spec/models/tts_engine_spec.rb +183 -0
  54. data/spec/spec_helper.rb +1 -1
  55. metadata +26 -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"],
@@ -2419,12 +2432,30 @@
2419
2432
  "$ref": "#/components/schemas/PerclCommand"
2420
2433
  },
2421
2434
  {
2422
- "required": [],
2423
2435
  "type": "object",
2424
2436
  "properties": {}
2425
2437
  }
2426
2438
  ]
2427
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
+ },
2428
2459
  "Say": {
2429
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.",
2430
2461
  "allOf": [
@@ -2443,6 +2474,9 @@
2443
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.",
2444
2475
  "type": "string"
2445
2476
  },
2477
+ "engine": {
2478
+ "$ref": "#/components/schemas/TTSEngine"
2479
+ },
2446
2480
  "loop": {
2447
2481
  "description": "Number of times the text is said. Specifying '0' causes the `Say` action to loop until the Call is hung up.",
2448
2482
  "type": "integer",
@@ -2489,7 +2523,6 @@
2489
2523
  "$ref": "#/components/schemas/PerclCommand"
2490
2524
  },
2491
2525
  {
2492
- "required": [],
2493
2526
  "type": "object",
2494
2527
  "properties": {
2495
2528
  "listen": {
@@ -2507,7 +2540,6 @@
2507
2540
  "$ref": "#/components/schemas/PerclCommand"
2508
2541
  },
2509
2542
  {
2510
- "required": [],
2511
2543
  "type": "object",
2512
2544
  "properties": {
2513
2545
  "talk": {
@@ -2525,7 +2557,6 @@
2525
2557
  "$ref": "#/components/schemas/PerclCommand"
2526
2558
  },
2527
2559
  {
2528
- "required": [],
2529
2560
  "type": "object",
2530
2561
  "properties": {
2531
2562
  "dtmfPassThrough": {
@@ -2585,7 +2616,6 @@
2585
2616
  "$ref": "#/components/schemas/PerclCommand"
2586
2617
  },
2587
2618
  {
2588
- "required": [],
2589
2619
  "type": "object",
2590
2620
  "properties": {}
2591
2621
  }
@@ -3662,9 +3692,7 @@
3662
3692
  },
3663
3693
  "CreateConferenceRequest": {
3664
3694
  "type": "object",
3665
- "required": [
3666
- "statusCallbackUrl"
3667
- ],
3695
+ "required": ["statusCallbackUrl"],
3668
3696
  "properties": {
3669
3697
  "alias": {
3670
3698
  "type": "string",
@@ -4850,23 +4878,16 @@
4850
4878
  "ExportResourceType": {
4851
4879
  "type": "string",
4852
4880
  "description": "platform resource type",
4853
- "enum": [
4854
- "Messages",
4855
- "Calls"
4856
- ]
4881
+ "enum": ["Messages", "Calls"]
4857
4882
  },
4858
4883
  "ExportOutputType": {
4859
4884
  "type": "string",
4860
4885
  "description": "output type of the export",
4861
- "enum": [
4862
- "csv"
4863
- ]
4886
+ "enum": ["csv"]
4864
4887
  },
4865
4888
  "ExportRequestOutput": {
4866
4889
  "type": "object",
4867
- "required": [
4868
- "type"
4869
- ],
4890
+ "required": ["type"],
4870
4891
  "properties": {
4871
4892
  "type": {
4872
4893
  "$ref": "#/components/schemas/ExportOutputType"
@@ -4875,9 +4896,7 @@
4875
4896
  },
4876
4897
  "ExportResultOutput": {
4877
4898
  "type": "object",
4878
- "required": [
4879
- "type"
4880
- ],
4899
+ "required": ["type"],
4881
4900
  "properties": {
4882
4901
  "type": {
4883
4902
  "$ref": "#/components/schemas/ExportOutputType"
@@ -4962,12 +4981,7 @@
4962
4981
  "query": {
4963
4982
  "direction": "inbound"
4964
4983
  },
4965
- "format": [
4966
- "messageId",
4967
- "dateUpdated",
4968
- "segmentCount",
4969
- "status"
4970
- ],
4984
+ "format": ["messageId", "dateUpdated", "segmentCount", "status"],
4971
4985
  "output": {
4972
4986
  "type": "csv"
4973
4987
  }
@@ -4994,10 +5008,7 @@
4994
5008
  },
4995
5009
  "ExportRequest": {
4996
5010
  "type": "object",
4997
- "required": [
4998
- "resourceType",
4999
- "output"
5000
- ],
5011
+ "required": ["resourceType", "output"],
5001
5012
  "properties": {
5002
5013
  "resourceType": {
5003
5014
  "$ref": "#/components/schemas/ExportResourceType"
@@ -5015,6 +5026,240 @@
5015
5026
  "type": "object"
5016
5027
  }
5017
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
+ }
5018
5263
  }
5019
5264
  }
5020
5265
  },
@@ -5026,7 +5271,7 @@
5026
5271
  "paths": {
5027
5272
  "/Accounts/{accountId}": {
5028
5273
  "get": {
5029
- "tags": [],
5274
+ "tags": ["Accounts"],
5030
5275
  "summary": "Get an Account",
5031
5276
  "operationId": "get-an-account",
5032
5277
  "parameters": [
@@ -5049,7 +5294,7 @@
5049
5294
  }
5050
5295
  },
5051
5296
  "post": {
5052
- "tags": [],
5297
+ "tags": ["Accounts"],
5053
5298
  "summary": "Manage an account",
5054
5299
  "operationId": "update-an-account",
5055
5300
  "parameters": [
@@ -5076,7 +5321,7 @@
5076
5321
  },
5077
5322
  "/Accounts/{accountId}/Applications/{applicationId}": {
5078
5323
  "get": {
5079
- "tags": [],
5324
+ "tags": ["Applications"],
5080
5325
  "summary": "Get an Application",
5081
5326
  "operationId": "get-an-application",
5082
5327
  "parameters": [
@@ -5108,7 +5353,7 @@
5108
5353
  }
5109
5354
  },
5110
5355
  "post": {
5111
- "tags": [],
5356
+ "tags": ["Applications"],
5112
5357
  "summary": "Update an application",
5113
5358
  "operationId": "update-an-application",
5114
5359
  "parameters": [
@@ -5150,7 +5395,7 @@
5150
5395
  }
5151
5396
  },
5152
5397
  "delete": {
5153
- "tags": [],
5398
+ "tags": ["Applications"],
5154
5399
  "summary": "Delete an application",
5155
5400
  "operationId": "delete-an-application",
5156
5401
  "parameters": [
@@ -5177,7 +5422,7 @@
5177
5422
  },
5178
5423
  "/Accounts/{accountId}/Applications": {
5179
5424
  "get": {
5180
- "tags": [],
5425
+ "tags": ["Applications"],
5181
5426
  "summary": "List applications",
5182
5427
  "operationId": "list-applications",
5183
5428
  "parameters": [
@@ -5209,7 +5454,7 @@
5209
5454
  }
5210
5455
  },
5211
5456
  "post": {
5212
- "tags": [],
5457
+ "tags": ["Applications"],
5213
5458
  "summary": "Create an application",
5214
5459
  "operationId": "create-an-application",
5215
5460
  "parameters": [
@@ -5244,7 +5489,7 @@
5244
5489
  },
5245
5490
  "/AvailablePhoneNumbers": {
5246
5491
  "get": {
5247
- "tags": [],
5492
+ "tags": ["AvailablePhoneNumbers"],
5248
5493
  "summary": "List available numbers",
5249
5494
  "operationId": "list-available-numbers",
5250
5495
  "parameters": [
@@ -5328,7 +5573,7 @@
5328
5573
  },
5329
5574
  "/Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId}": {
5330
5575
  "get": {
5331
- "tags": [],
5576
+ "tags": ["IncomingPhoneNumbers"],
5332
5577
  "summary": "Get an Incoming Number",
5333
5578
  "operationId": "get-an-incoming-number",
5334
5579
  "parameters": [
@@ -5360,7 +5605,7 @@
5360
5605
  }
5361
5606
  },
5362
5607
  "post": {
5363
- "tags": [],
5608
+ "tags": ["IncomingPhoneNumbers"],
5364
5609
  "summary": "Update an Incoming Number",
5365
5610
  "operationId": "update-an-incoming-number",
5366
5611
  "parameters": [
@@ -5402,7 +5647,7 @@
5402
5647
  }
5403
5648
  },
5404
5649
  "delete": {
5405
- "tags": [],
5650
+ "tags": ["IncomingPhoneNumbers"],
5406
5651
  "summary": "Delete an Incoming Number",
5407
5652
  "operationId": "delete-an-incoming-number",
5408
5653
  "parameters": [
@@ -5429,7 +5674,7 @@
5429
5674
  },
5430
5675
  "/Accounts/{accountId}/IncomingPhoneNumbers": {
5431
5676
  "get": {
5432
- "tags": [],
5677
+ "tags": ["IncomingPhoneNumbers"],
5433
5678
  "summary": "List Incoming Numbers",
5434
5679
  "operationId": "list-incoming-numbers",
5435
5680
  "parameters": [
@@ -5571,7 +5816,7 @@
5571
5816
  }
5572
5817
  },
5573
5818
  "post": {
5574
- "tags": [],
5819
+ "tags": ["IncomingPhoneNumbers"],
5575
5820
  "summary": "Buy a Phone Number",
5576
5821
  "operationId": "buy-a-phone-number",
5577
5822
  "parameters": [
@@ -5607,7 +5852,7 @@
5607
5852
  },
5608
5853
  "/Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion": {
5609
5854
  "post": {
5610
- "tags": [],
5855
+ "tags": ["KnowledgeBases"],
5611
5856
  "summary": "Query the knowledge base",
5612
5857
  "operationId": "create-knowledge-base-completion",
5613
5858
  "parameters": [
@@ -5651,7 +5896,7 @@
5651
5896
  },
5652
5897
  "/Accounts/{accountId}/Calls/{callId}": {
5653
5898
  "get": {
5654
- "tags": [],
5899
+ "tags": ["Calls"],
5655
5900
  "summary": "Get a Call",
5656
5901
  "operationId": "get-a-call",
5657
5902
  "parameters": [
@@ -5683,7 +5928,7 @@
5683
5928
  }
5684
5929
  },
5685
5930
  "post": {
5686
- "tags": [],
5931
+ "tags": ["Calls"],
5687
5932
  "summary": "Update a Live Call",
5688
5933
  "operationId": "update-a-live-call",
5689
5934
  "parameters": [
@@ -5721,7 +5966,7 @@
5721
5966
  },
5722
5967
  "/Accounts/{accountId}/Calls": {
5723
5968
  "post": {
5724
- "tags": [],
5969
+ "tags": ["Calls"],
5725
5970
  "summary": "Make a Call",
5726
5971
  "operationId": "make-a-call",
5727
5972
  "parameters": [
@@ -5754,7 +5999,7 @@
5754
5999
  }
5755
6000
  },
5756
6001
  "get": {
5757
- "tags": [],
6002
+ "tags": ["Calls"],
5758
6003
  "summary": "List Calls",
5759
6004
  "operationId": "list-calls",
5760
6005
  "parameters": [
@@ -5876,7 +6121,7 @@
5876
6121
  },
5877
6122
  "/Accounts/{accountId}/Calls/{callId}/Recordings": {
5878
6123
  "get": {
5879
- "tags": [],
6124
+ "tags": ["Calls"],
5880
6125
  "summary": "List Call Recordings",
5881
6126
  "operationId": "list-call-recordings",
5882
6127
  "parameters": [
@@ -5919,7 +6164,7 @@
5919
6164
  },
5920
6165
  "/Accounts/{accountId}/Calls/{callId}/Logs": {
5921
6166
  "get": {
5922
- "tags": [],
6167
+ "tags": ["Calls"],
5923
6168
  "summary": "List Call Logs",
5924
6169
  "operationId": "list-call-logs",
5925
6170
  "parameters": [
@@ -5953,6 +6198,7 @@
5953
6198
  },
5954
6199
  "/Accounts/{accountId}/Calls/WebRTC/Token": {
5955
6200
  "post": {
6201
+ "tags": ["Calls"],
5956
6202
  "summary": "Make a JWT for WebRTC calling",
5957
6203
  "operationId": "make-a-webrtc-jwt",
5958
6204
  "parameters": [
@@ -5988,7 +6234,7 @@
5988
6234
  },
5989
6235
  "/Accounts/{accountId}/Conferences": {
5990
6236
  "post": {
5991
- "tags": [],
6237
+ "tags": ["Conferences"],
5992
6238
  "summary": "Create a Conference",
5993
6239
  "operationId": "create-a-conference",
5994
6240
  "parameters": [
@@ -6021,7 +6267,7 @@
6021
6267
  }
6022
6268
  },
6023
6269
  "get": {
6024
- "tags": [],
6270
+ "tags": ["Conferences"],
6025
6271
  "summary": "List Conferences",
6026
6272
  "operationId": "list-conferences",
6027
6273
  "parameters": [
@@ -6082,7 +6328,7 @@
6082
6328
  },
6083
6329
  "/Accounts/{accountId}/Conferences/{conferenceId}": {
6084
6330
  "post": {
6085
- "tags": [],
6331
+ "tags": ["Conferences"],
6086
6332
  "summary": "Update a Conference",
6087
6333
  "operationId": "update-a-conference",
6088
6334
  "parameters": [
@@ -6117,7 +6363,7 @@
6117
6363
  }
6118
6364
  },
6119
6365
  "get": {
6120
- "tags": [],
6366
+ "tags": ["Conferences"],
6121
6367
  "summary": "Get a Conference",
6122
6368
  "operationId": "get-a-conference",
6123
6369
  "parameters": [
@@ -6151,7 +6397,7 @@
6151
6397
  },
6152
6398
  "/Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId}": {
6153
6399
  "post": {
6154
- "tags": [],
6400
+ "tags": ["Conferences"],
6155
6401
  "summary": "Update a Participant",
6156
6402
  "operationId": "update-a-participant",
6157
6403
  "parameters": [
@@ -6202,7 +6448,7 @@
6202
6448
  }
6203
6449
  },
6204
6450
  "get": {
6205
- "tags": [],
6451
+ "tags": ["Conferences"],
6206
6452
  "summary": "Get a Participant",
6207
6453
  "operationId": "get-a-participant",
6208
6454
  "parameters": [
@@ -6243,7 +6489,7 @@
6243
6489
  }
6244
6490
  },
6245
6491
  "delete": {
6246
- "tags": [],
6492
+ "tags": ["Conferences"],
6247
6493
  "summary": "Remove a Participant",
6248
6494
  "operationId": "remove-a-participant",
6249
6495
  "parameters": [
@@ -6279,7 +6525,7 @@
6279
6525
  },
6280
6526
  "/Accounts/{accountId}/Conferences/{conferenceId}/Participants": {
6281
6527
  "get": {
6282
- "tags": [],
6528
+ "tags": ["Conferences"],
6283
6529
  "summary": "List Participants",
6284
6530
  "operationId": "list-participants",
6285
6531
  "parameters": [
@@ -6340,7 +6586,7 @@
6340
6586
  },
6341
6587
  "/Accounts/{accountId}/Conferences/{conferenceId}/Recordings": {
6342
6588
  "get": {
6343
- "tags": [],
6589
+ "tags": ["Conferences"],
6344
6590
  "summary": "List Conference Recordings",
6345
6591
  "operationId": "list-conference-recordings",
6346
6592
  "parameters": [
@@ -6392,7 +6638,7 @@
6392
6638
  },
6393
6639
  "/Accounts/{accountId}/Queues/{queueId}": {
6394
6640
  "post": {
6395
- "tags": [],
6641
+ "tags": ["Queues"],
6396
6642
  "summary": "Update a Queue",
6397
6643
  "operationId": "update-a-queue",
6398
6644
  "parameters": [
@@ -6434,7 +6680,7 @@
6434
6680
  }
6435
6681
  },
6436
6682
  "get": {
6437
- "tags": [],
6683
+ "tags": ["Queues"],
6438
6684
  "summary": "Get a Queue",
6439
6685
  "operationId": "get-a-queue",
6440
6686
  "parameters": [
@@ -6468,7 +6714,7 @@
6468
6714
  },
6469
6715
  "/Accounts/{accountId}/Queues": {
6470
6716
  "get": {
6471
- "tags": [],
6717
+ "tags": ["Queues"],
6472
6718
  "summary": "List Active Queues",
6473
6719
  "operationId": "list-active-queues",
6474
6720
  "parameters": [
@@ -6500,7 +6746,7 @@
6500
6746
  }
6501
6747
  },
6502
6748
  "post": {
6503
- "tags": [],
6749
+ "tags": ["Queues"],
6504
6750
  "summary": "Create a Queue",
6505
6751
  "operationId": "create-a-queue",
6506
6752
  "parameters": [
@@ -6535,7 +6781,7 @@
6535
6781
  },
6536
6782
  "/Accounts/{accountId}/Queues/{queueId}/Members/Front": {
6537
6783
  "get": {
6538
- "tags": [],
6784
+ "tags": ["Queues"],
6539
6785
  "summary": "Get Head Member",
6540
6786
  "operationId": "get-head-member",
6541
6787
  "parameters": [
@@ -6567,7 +6813,7 @@
6567
6813
  }
6568
6814
  },
6569
6815
  "post": {
6570
- "tags": [],
6816
+ "tags": ["Queues"],
6571
6817
  "summary": "Dequeue Head Member",
6572
6818
  "operationId": "dequeue-head-member",
6573
6819
  "parameters": [
@@ -6601,7 +6847,7 @@
6601
6847
  },
6602
6848
  "/Accounts/{accountId}/Queues/{queueId}/Members": {
6603
6849
  "get": {
6604
- "tags": [],
6850
+ "tags": ["Queues"],
6605
6851
  "summary": "List Members",
6606
6852
  "operationId": "list-members",
6607
6853
  "parameters": [
@@ -6635,7 +6881,7 @@
6635
6881
  },
6636
6882
  "/Accounts/{accountId}/Queues/{queueId}/Members/{callId}": {
6637
6883
  "get": {
6638
- "tags": [],
6884
+ "tags": ["Queues"],
6639
6885
  "summary": "Get a Member",
6640
6886
  "operationId": "get-a-member",
6641
6887
  "parameters": [
@@ -6676,7 +6922,7 @@
6676
6922
  }
6677
6923
  },
6678
6924
  "post": {
6679
- "tags": [],
6925
+ "tags": ["Queues"],
6680
6926
  "summary": "Dequeue a Member",
6681
6927
  "operationId": "dequeue-a-member",
6682
6928
  "parameters": [
@@ -6719,7 +6965,7 @@
6719
6965
  },
6720
6966
  "/Accounts/{accountId}/Logs": {
6721
6967
  "get": {
6722
- "tags": [],
6968
+ "tags": ["Logs"],
6723
6969
  "summary": "List All Account Logs",
6724
6970
  "operationId": "list-all-account-logs",
6725
6971
  "parameters": [
@@ -6742,7 +6988,7 @@
6742
6988
  }
6743
6989
  },
6744
6990
  "post": {
6745
- "tags": [],
6991
+ "tags": ["Logs"],
6746
6992
  "summary": "Filter Logs",
6747
6993
  "operationId": "filter-logs",
6748
6994
  "parameters": [
@@ -6778,7 +7024,7 @@
6778
7024
  },
6779
7025
  "/Accounts/{accountId}/Recordings": {
6780
7026
  "get": {
6781
- "tags": [],
7027
+ "tags": ["Recordings"],
6782
7028
  "summary": "List Recordings",
6783
7029
  "operationId": "list-recordings",
6784
7030
  "parameters": [
@@ -6830,7 +7076,7 @@
6830
7076
  },
6831
7077
  "/Accounts/{accountId}/Recordings/{recordingId}": {
6832
7078
  "get": {
6833
- "tags": [],
7079
+ "tags": ["Recordings"],
6834
7080
  "summary": "Get a Recording",
6835
7081
  "operationId": "get-a-recording",
6836
7082
  "parameters": [
@@ -6862,7 +7108,7 @@
6862
7108
  "deprecated": false
6863
7109
  },
6864
7110
  "delete": {
6865
- "tags": [],
7111
+ "tags": ["Recordings"],
6866
7112
  "summary": "Delete a Recording",
6867
7113
  "operationId": "delete-a-recording",
6868
7114
  "parameters": [
@@ -6889,7 +7135,7 @@
6889
7135
  },
6890
7136
  "/Accounts/{accountId}/Recordings/{recordingId}/Stream": {
6891
7137
  "get": {
6892
- "tags": [],
7138
+ "tags": ["Recordings"],
6893
7139
  "summary": "Stream a Recording File",
6894
7140
  "operationId": "stream-a-recording-file",
6895
7141
  "parameters": [
@@ -6908,9 +7154,9 @@
6908
7154
  ],
6909
7155
  "responses": {
6910
7156
  "200": {
6911
- "description": "Streaming a Recording represented with audio/x-wav mime-type",
7157
+ "description": "Streaming a Recording represented with audio/wav mime-type",
6912
7158
  "content": {
6913
- "audio/x-wav": {
7159
+ "audio/wav": {
6914
7160
  "schema": {
6915
7161
  "type": "string",
6916
7162
  "format": "binary"
@@ -6924,7 +7170,7 @@
6924
7170
  },
6925
7171
  "/Accounts/{accountId}/Recordings/{recordingId}/Download": {
6926
7172
  "get": {
6927
- "tags": [],
7173
+ "tags": ["Recordings"],
6928
7174
  "summary": "Download a Recording File",
6929
7175
  "operationId": "download-a-recording-file",
6930
7176
  "parameters": [
@@ -6943,9 +7189,9 @@
6943
7189
  ],
6944
7190
  "responses": {
6945
7191
  "200": {
6946
- "description": "Download a Recording file represented with audio/x-wav mime-type",
7192
+ "description": "Download a Recording file represented with audio/wav mime-type",
6947
7193
  "content": {
6948
- "audio/x-wav": {
7194
+ "audio/wav": {
6949
7195
  "schema": {
6950
7196
  "type": "string",
6951
7197
  "format": "binary"
@@ -6959,7 +7205,7 @@
6959
7205
  },
6960
7206
  "/Accounts/{accountId}/Messages": {
6961
7207
  "get": {
6962
- "tags": [],
7208
+ "tags": ["Messages"],
6963
7209
  "summary": "List SMS Messages",
6964
7210
  "operationId": "list-sms-messages",
6965
7211
  "parameters": [
@@ -7054,7 +7300,7 @@
7054
7300
  "deprecated": false
7055
7301
  },
7056
7302
  "post": {
7057
- "tags": [],
7303
+ "tags": ["Messages"],
7058
7304
  "summary": "Send an SMS Message",
7059
7305
  "operationId": "send-an-sms-message",
7060
7306
  "parameters": [
@@ -7090,7 +7336,7 @@
7090
7336
  },
7091
7337
  "/Accounts/{accountId}/Messages/{messageId}": {
7092
7338
  "get": {
7093
- "tags": [],
7339
+ "tags": ["Messages"],
7094
7340
  "summary": "Get an SMS Message",
7095
7341
  "operationId": "get-an-sms-message",
7096
7342
  "parameters": [
@@ -7124,7 +7370,7 @@
7124
7370
  },
7125
7371
  "/Accounts/{accountId}/Messages/10DLC/Campaigns": {
7126
7372
  "get": {
7127
- "tags": [],
7373
+ "tags": ["Messages"],
7128
7374
  "summary": "Get list of SMS 10DLC Campaigns",
7129
7375
  "operationId": "get-tenDLC-sms-campaigns",
7130
7376
  "parameters": [
@@ -7202,7 +7448,7 @@
7202
7448
  },
7203
7449
  "/Accounts/{accountId}/Messages/10DLC/Campaigns/{campaignId}": {
7204
7450
  "get": {
7205
- "tags": [],
7451
+ "tags": ["Messages"],
7206
7452
  "summary": "Get a 10DLC SMS Campaign",
7207
7453
  "operationId": "get-tenDLC-sms-campaign",
7208
7454
  "parameters": [
@@ -7236,7 +7482,7 @@
7236
7482
  },
7237
7483
  "/Accounts/{accountId}/Messages/10DLC/PartnerCampaigns": {
7238
7484
  "get": {
7239
- "tags": [],
7485
+ "tags": ["Messages"],
7240
7486
  "summary": "Get list of SMS 10DLC Partner Campaigns",
7241
7487
  "operationId": "get-tenDLC-sms-partnerCampaigns",
7242
7488
  "parameters": [
@@ -7323,7 +7569,7 @@
7323
7569
  },
7324
7570
  "/Accounts/{accountId}/Messages/10DLC/PartnerCampaigns/{campaignId}": {
7325
7571
  "get": {
7326
- "tags": [],
7572
+ "tags": ["Messages"],
7327
7573
  "summary": "Get a 10DLC SMS Partner Campaign",
7328
7574
  "operationId": "get-tenDLC-sms-partnerCampaign",
7329
7575
  "parameters": [
@@ -7357,7 +7603,7 @@
7357
7603
  },
7358
7604
  "/Accounts/{accountId}/Messages/10DLC/Brands": {
7359
7605
  "get": {
7360
- "tags": [],
7606
+ "tags": ["Messages"],
7361
7607
  "summary": "Get list of SMS 10DLC Brands",
7362
7608
  "operationId": "get-tenDLC-sms-brands",
7363
7609
  "parameters": [
@@ -7424,7 +7670,7 @@
7424
7670
  },
7425
7671
  "/Accounts/{accountId}/Messages/10DLC/Brands/{brandId}": {
7426
7672
  "get": {
7427
- "tags": [],
7673
+ "tags": ["Messages"],
7428
7674
  "summary": "Get a 10DLC SMS Brand",
7429
7675
  "operationId": "get-tenDLC-sms-brand",
7430
7676
  "parameters": [
@@ -7458,7 +7704,7 @@
7458
7704
  },
7459
7705
  "/Accounts/{accountId}/Messages/TollFree/Campaigns": {
7460
7706
  "get": {
7461
- "tags": [],
7707
+ "tags": ["Messages"],
7462
7708
  "summary": "Get list of TollFree Campaigns",
7463
7709
  "operationId": "get-tollFree-sms-campaigns",
7464
7710
  "parameters": [
@@ -7503,7 +7749,7 @@
7503
7749
  },
7504
7750
  "/Accounts/{accountId}/Messages/TollFree/Campaigns/{campaignId}": {
7505
7751
  "get": {
7506
- "tags": [],
7752
+ "tags": ["Messages"],
7507
7753
  "summary": "Get a TollFree SMS Campaign",
7508
7754
  "operationId": "get-tollFree-sms-campaign",
7509
7755
  "parameters": [
@@ -7537,7 +7783,7 @@
7537
7783
  },
7538
7784
  "/Accounts/{accountId}/Exports": {
7539
7785
  "get": {
7540
- "tags": [],
7786
+ "tags": ["Exports"],
7541
7787
  "summary": "List Exports",
7542
7788
  "operationId": "list-exports",
7543
7789
  "responses": {
@@ -7577,7 +7823,7 @@
7577
7823
  "post": {
7578
7824
  "summary": "Create an Export",
7579
7825
  "operationId": "create-export",
7580
- "tags": [],
7826
+ "tags": ["Exports"],
7581
7827
  "requestBody": {
7582
7828
  "description": "A JSON object containing export creation parameters",
7583
7829
  "content": {
@@ -7609,7 +7855,7 @@
7609
7855
  },
7610
7856
  "/Accounts/{accountId}/Exports/{exportId}": {
7611
7857
  "get": {
7612
- "tags": [],
7858
+ "tags": ["Exports"],
7613
7859
  "summary": "Get an Export",
7614
7860
  "operationId": "get-an-export",
7615
7861
  "parameters": [
@@ -7641,7 +7887,7 @@
7641
7887
  }
7642
7888
  },
7643
7889
  "delete": {
7644
- "tags": [],
7890
+ "tags": ["Exports"],
7645
7891
  "summary": "Delete an Export",
7646
7892
  "operationId": "delete-an-export",
7647
7893
  "parameters": [
@@ -7668,7 +7914,7 @@
7668
7914
  },
7669
7915
  "/Accounts/{accountId}/Exports/{exportId}/Download": {
7670
7916
  "get": {
7671
- "tags": [],
7917
+ "tags": ["Exports"],
7672
7918
  "summary": "Download an Export",
7673
7919
  "operationId": "download-an-export",
7674
7920
  "parameters": [
@@ -7699,8 +7945,559 @@
7699
7945
  }
7700
7946
  }
7701
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
+ }
7702
8445
  }
7703
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
+ ],
7704
8501
  "x-headers": [],
7705
8502
  "x-explorer-enabled": true,
7706
8503
  "x-proxy-enabled": true,