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/docs/DefaultApi.md CHANGED
@@ -12,6 +12,8 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
12
12
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
13
13
  | [**create_an_application**](DefaultApi.md#create_an_application) | **POST** /Accounts/{accountId}/Applications | Create an application |
14
14
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
15
+ | [**create_blob**](DefaultApi.md#create_blob) | **POST** /Accounts/{accountId}/Blobs | Create a Blob |
16
+ | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
15
17
  | [**create_export**](DefaultApi.md#create_export) | **POST** /Accounts/{accountId}/Exports | Create an Export |
16
18
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
17
19
  | [**create_knowledge_base_completion**](DefaultApi.md#create_knowledge_base_completion) | **POST** /Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion | Query the knowledge base |
@@ -24,6 +26,8 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
24
26
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
25
27
  | [**delete_an_incoming_number**](DefaultApi.md#delete_an_incoming_number) | **DELETE** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number |
26
28
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
29
+ | [**delete_blob**](DefaultApi.md#delete_blob) | **DELETE** /Accounts/{accountId}/Blobs/{blobId} | Delete Blob |
30
+ | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
27
31
  | [**dequeue_a_member**](DefaultApi.md#dequeue_a_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Dequeue a Member |
28
32
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
29
33
  | [**dequeue_head_member**](DefaultApi.md#dequeue_head_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Dequeue Head Member |
@@ -56,6 +60,8 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
56
60
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
57
61
  | [**get_an_sms_message**](DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message |
58
62
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
63
+ | [**get_blob**](DefaultApi.md#get_blob) | **GET** /Accounts/{accountId}/Blobs/{blobId} | Get Blob |
64
+ | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
59
65
  | [**get_head_member**](DefaultApi.md#get_head_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Get Head Member |
60
66
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
61
67
  | [**get_ten_dlc_sms_brand**](DefaultApi.md#get_ten_dlc_sms_brand) | **GET** /Accounts/{accountId}/Messages/10DLC/Brands/{brandId} | Get a 10DLC SMS Brand |
@@ -82,6 +88,8 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
82
88
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
83
89
  | [**list_available_numbers**](DefaultApi.md#list_available_numbers) | **GET** /AvailablePhoneNumbers | List available numbers |
84
90
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
91
+ | [**list_blobs**](DefaultApi.md#list_blobs) | **GET** /Accounts/{accountId}/Blobs | List Blobs belonging to an account. |
92
+ | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
85
93
  | [**list_call_logs**](DefaultApi.md#list_call_logs) | **GET** /Accounts/{accountId}/Calls/{callId}/Logs | List Call Logs |
86
94
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
87
95
  | [**list_call_recordings**](DefaultApi.md#list_call_recordings) | **GET** /Accounts/{accountId}/Calls/{callId}/Recordings | List Call Recordings |
@@ -108,8 +116,12 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
108
116
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
109
117
  | [**make_a_webrtc_jwt**](DefaultApi.md#make_a_webrtc_jwt) | **POST** /Accounts/{accountId}/Calls/WebRTC/Token | Make a JWT for WebRTC calling |
110
118
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
119
+ | [**modify_blob**](DefaultApi.md#modify_blob) | **PATCH** /Accounts/{accountId}/Blobs/{blobId} | Modify Blob |
120
+ | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
111
121
  | [**remove_a_participant**](DefaultApi.md#remove_a_participant) | **DELETE** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Remove a Participant |
112
122
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
123
+ | [**replace_blob**](DefaultApi.md#replace_blob) | **PUT** /Accounts/{accountId}/Blobs/{blobId} | Replace Blob |
124
+ | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
113
125
  | [**send_an_sms_message**](DefaultApi.md#send_an_sms_message) | **POST** /Accounts/{accountId}/Messages | Send an SMS Message |
114
126
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
115
127
  | [**stream_a_recording_file**](DefaultApi.md#stream_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Stream | Stream a Recording File |
@@ -413,6 +425,78 @@ end
413
425
  - **Accept**: application/json
414
426
 
415
427
 
428
+ ## create_blob
429
+
430
+ Create a Blob
431
+
432
+ Create a new Blob belonging to the requesting account.
433
+
434
+ ### Examples
435
+
436
+ ```ruby
437
+ require 'time'
438
+ require 'freeclimb'
439
+ # setup authorization
440
+ Freeclimb.configure do |config|
441
+ # Configure HTTP basic authorization: fc
442
+ config.username = 'ACCOUNT_ID'
443
+ config.password = 'API_KEY'
444
+ end
445
+
446
+ api_instance = Freeclimb::DefaultApi.new
447
+
448
+ create_blob_request = Freeclimb::CreateBlobRequest.new({blob: 3.56}) # CreateBlobRequest | An object defining a new blob. A request body must be provided but the blob may be empty.
449
+
450
+
451
+ begin
452
+
453
+ # Create a Blob
454
+ result = api_instance.create_blob(create_blob_request)
455
+ p result
456
+ rescue Freeclimb::ApiError => e
457
+ puts "Error when calling DefaultApi->create_blob: #{e}"
458
+ end
459
+ ```
460
+
461
+ #### Using the create_blob_with_http_info variant
462
+
463
+ This returns an Array which contains the response data, status code and headers.
464
+
465
+ > <Array(<BlobResult>, Integer, Hash)> create_blob_with_http_info(account_id, create_blob_request)
466
+
467
+ ```ruby
468
+ begin
469
+ # Create a Blob
470
+ data, status_code, headers = api_instance.create_blob_with_http_info(create_blob_request)
471
+ p status_code # => 2xx
472
+ p headers # => { ... }
473
+ p data # => <BlobResult>
474
+ rescue Freeclimb::ApiError => e
475
+ puts "Error when calling DefaultApi->create_blob_with_http_info: #{e}"
476
+ end
477
+ ```
478
+
479
+ ### Parameters
480
+
481
+ | Name | Type | Description | Notes |
482
+ | ---- | ---- | ----------- | ----- |
483
+ | **create_blob_request** | [**CreateBlobRequest**](CreateBlobRequest.md) | An object defining a new blob. A request body must be provided but the blob may be empty. | |
484
+
485
+
486
+ ### Return type
487
+
488
+ [**BlobResult**](BlobResult.md)
489
+
490
+ ### Authorization
491
+
492
+ [fc](../README.md#fc)
493
+
494
+ ### HTTP request headers
495
+
496
+ - **Content-Type**: application/json
497
+ - **Accept**: application/json
498
+
499
+
416
500
  ## create_export
417
501
 
418
502
  Create an Export
@@ -834,6 +918,78 @@ nil (empty response body)
834
918
  - **Accept**: Not defined
835
919
 
836
920
 
921
+ ## delete_blob
922
+
923
+ Delete Blob
924
+
925
+ 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).
926
+
927
+ ### Examples
928
+
929
+ ```ruby
930
+ require 'time'
931
+ require 'freeclimb'
932
+ # setup authorization
933
+ Freeclimb.configure do |config|
934
+ # Configure HTTP basic authorization: fc
935
+ config.username = 'ACCOUNT_ID'
936
+ config.password = 'API_KEY'
937
+ end
938
+
939
+ api_instance = Freeclimb::DefaultApi.new
940
+
941
+ blob_id = 'blob_id_example' # String | String that uniquely identifies this Blob resource.
942
+
943
+
944
+ begin
945
+
946
+ # Delete Blob
947
+ result = api_instance.delete_blob(blob_id)
948
+ p result
949
+ rescue Freeclimb::ApiError => e
950
+ puts "Error when calling DefaultApi->delete_blob: #{e}"
951
+ end
952
+ ```
953
+
954
+ #### Using the delete_blob_with_http_info variant
955
+
956
+ This returns an Array which contains the response data, status code and headers.
957
+
958
+ > <Array(<BlobResult>, Integer, Hash)> delete_blob_with_http_info(account_id, blob_id)
959
+
960
+ ```ruby
961
+ begin
962
+ # Delete Blob
963
+ data, status_code, headers = api_instance.delete_blob_with_http_info(blob_id)
964
+ p status_code # => 2xx
965
+ p headers # => { ... }
966
+ p data # => <BlobResult>
967
+ rescue Freeclimb::ApiError => e
968
+ puts "Error when calling DefaultApi->delete_blob_with_http_info: #{e}"
969
+ end
970
+ ```
971
+
972
+ ### Parameters
973
+
974
+ | Name | Type | Description | Notes |
975
+ | ---- | ---- | ----------- | ----- |
976
+ | **blob_id** | **String** | String that uniquely identifies this Blob resource. | |
977
+
978
+
979
+ ### Return type
980
+
981
+ [**BlobResult**](BlobResult.md)
982
+
983
+ ### Authorization
984
+
985
+ [fc](../README.md#fc)
986
+
987
+ ### HTTP request headers
988
+
989
+ - **Content-Type**: Not defined
990
+ - **Accept**: application/json
991
+
992
+
837
993
  ## dequeue_a_member
838
994
 
839
995
  Dequeue a Member
@@ -1044,7 +1200,7 @@ end
1044
1200
  ### HTTP request headers
1045
1201
 
1046
1202
  - **Content-Type**: Not defined
1047
- - **Accept**: audio/x-wav
1203
+ - **Accept**: audio/wav
1048
1204
 
1049
1205
 
1050
1206
  ## download_an_export
@@ -1960,6 +2116,78 @@ end
1960
2116
  - **Accept**: application/json
1961
2117
 
1962
2118
 
2119
+ ## get_blob
2120
+
2121
+ Get Blob
2122
+
2123
+ Retrieves a specified blob
2124
+
2125
+ ### Examples
2126
+
2127
+ ```ruby
2128
+ require 'time'
2129
+ require 'freeclimb'
2130
+ # setup authorization
2131
+ Freeclimb.configure do |config|
2132
+ # Configure HTTP basic authorization: fc
2133
+ config.username = 'ACCOUNT_ID'
2134
+ config.password = 'API_KEY'
2135
+ end
2136
+
2137
+ api_instance = Freeclimb::DefaultApi.new
2138
+
2139
+ blob_id = 'blob_id_example' # String | String that uniquely identifies this Blob resource.
2140
+
2141
+
2142
+ begin
2143
+
2144
+ # Get Blob
2145
+ result = api_instance.get_blob(blob_id)
2146
+ p result
2147
+ rescue Freeclimb::ApiError => e
2148
+ puts "Error when calling DefaultApi->get_blob: #{e}"
2149
+ end
2150
+ ```
2151
+
2152
+ #### Using the get_blob_with_http_info variant
2153
+
2154
+ This returns an Array which contains the response data, status code and headers.
2155
+
2156
+ > <Array(<BlobResult>, Integer, Hash)> get_blob_with_http_info(account_id, blob_id)
2157
+
2158
+ ```ruby
2159
+ begin
2160
+ # Get Blob
2161
+ data, status_code, headers = api_instance.get_blob_with_http_info(blob_id)
2162
+ p status_code # => 2xx
2163
+ p headers # => { ... }
2164
+ p data # => <BlobResult>
2165
+ rescue Freeclimb::ApiError => e
2166
+ puts "Error when calling DefaultApi->get_blob_with_http_info: #{e}"
2167
+ end
2168
+ ```
2169
+
2170
+ ### Parameters
2171
+
2172
+ | Name | Type | Description | Notes |
2173
+ | ---- | ---- | ----------- | ----- |
2174
+ | **blob_id** | **String** | String that uniquely identifies this Blob resource. | |
2175
+
2176
+
2177
+ ### Return type
2178
+
2179
+ [**BlobResult**](BlobResult.md)
2180
+
2181
+ ### Authorization
2182
+
2183
+ [fc](../README.md#fc)
2184
+
2185
+ ### HTTP request headers
2186
+
2187
+ - **Content-Type**: Not defined
2188
+ - **Accept**: application/json
2189
+
2190
+
1963
2191
  ## get_head_member
1964
2192
 
1965
2193
  Get Head Member
@@ -2884,6 +3112,75 @@ end
2884
3112
  - **Accept**: application/json
2885
3113
 
2886
3114
 
3115
+ ## list_blobs
3116
+
3117
+ List Blobs belonging to an account.
3118
+
3119
+ List Blobs belonging to an account. Results are returned in paginated lists mirroring other listing features in the API.
3120
+
3121
+ ### Examples
3122
+
3123
+ ```ruby
3124
+ require 'time'
3125
+ require 'freeclimb'
3126
+ # setup authorization
3127
+ Freeclimb.configure do |config|
3128
+ # Configure HTTP basic authorization: fc
3129
+ config.username = 'ACCOUNT_ID'
3130
+ config.password = 'API_KEY'
3131
+ end
3132
+
3133
+ api_instance = Freeclimb::DefaultApi.new
3134
+
3135
+
3136
+ begin
3137
+
3138
+ # List Blobs belonging to an account.
3139
+ result = api_instance.list_blobs()
3140
+ p result
3141
+ rescue Freeclimb::ApiError => e
3142
+ puts "Error when calling DefaultApi->list_blobs: #{e}"
3143
+ end
3144
+ ```
3145
+
3146
+ #### Using the list_blobs_with_http_info variant
3147
+
3148
+ This returns an Array which contains the response data, status code and headers.
3149
+
3150
+ > <Array(<BlobListResponse>, Integer, Hash)> list_blobs_with_http_info(account_id)
3151
+
3152
+ ```ruby
3153
+ begin
3154
+ # List Blobs belonging to an account.
3155
+ data, status_code, headers = api_instance.list_blobs_with_http_info()
3156
+ p status_code # => 2xx
3157
+ p headers # => { ... }
3158
+ p data # => <BlobListResponse>
3159
+ rescue Freeclimb::ApiError => e
3160
+ puts "Error when calling DefaultApi->list_blobs_with_http_info: #{e}"
3161
+ end
3162
+ ```
3163
+
3164
+ ### Parameters
3165
+
3166
+ | Name | Type | Description | Notes |
3167
+ | ---- | ---- | ----------- | ----- |
3168
+
3169
+
3170
+ ### Return type
3171
+
3172
+ [**BlobListResponse**](BlobListResponse.md)
3173
+
3174
+ ### Authorization
3175
+
3176
+ [fc](../README.md#fc)
3177
+
3178
+ ### HTTP request headers
3179
+
3180
+ - **Content-Type**: Not defined
3181
+ - **Accept**: application/json
3182
+
3183
+
2887
3184
  ## list_call_logs
2888
3185
 
2889
3186
  List Call Logs
@@ -3368,8 +3665,6 @@ opts = {
3368
3665
  country: 'country_example', # String | Country of this phone number.
3369
3666
  application_id: 'application_id_example', # String | ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId.
3370
3667
  has_application: true, # Boolean | Indication of whether the phone number has an application linked to it.
3371
- voice_enabled: true, # Boolean | Indicates whether the phone number can handle Calls. Typically set to true for all numbers.
3372
- sms_enabled: true, # Boolean | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.
3373
3668
  has_campaign: true, # Boolean | Indication of whether the phone number has a campaign associated with it
3374
3669
  capabilities_voice: true, # Boolean |
3375
3670
  capabilities_sms: true, # Boolean |
@@ -3418,8 +3713,6 @@ end
3418
3713
  | **country** | **String** | Country of this phone number. | [optional] |
3419
3714
  | **application_id** | **String** | ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId. | [optional] |
3420
3715
  | **has_application** | **Boolean** | Indication of whether the phone number has an application linked to it. | [optional][default to false] |
3421
- | **voice_enabled** | **Boolean** | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional][default to true] |
3422
- | **sms_enabled** | **Boolean** | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional][default to true] |
3423
3716
  | **has_campaign** | **Boolean** | Indication of whether the phone number has a campaign associated with it | [optional] |
3424
3717
  | **capabilities_voice** | **Boolean** | | [optional] |
3425
3718
  | **capabilities_sms** | **Boolean** | | [optional] |
@@ -3893,6 +4186,81 @@ end
3893
4186
  - **Accept**: text/plain
3894
4187
 
3895
4188
 
4189
+ ## modify_blob
4190
+
4191
+ Modify Blob
4192
+
4193
+ Modifys a pre existing blob by either adding new fields, or modifying existing fields
4194
+
4195
+ ### Examples
4196
+
4197
+ ```ruby
4198
+ require 'time'
4199
+ require 'freeclimb'
4200
+ # setup authorization
4201
+ Freeclimb.configure do |config|
4202
+ # Configure HTTP basic authorization: fc
4203
+ config.username = 'ACCOUNT_ID'
4204
+ config.password = 'API_KEY'
4205
+ end
4206
+
4207
+ api_instance = Freeclimb::DefaultApi.new
4208
+
4209
+ blob_id = 'blob_id_example' # String | String that uniquely identifies this Blob resource.
4210
+
4211
+ modify_blob_request = Freeclimb::ModifyBlobRequest.new({blob: 3.56}) # ModifyBlobRequest | Request body to specify keys to modify. Or new keys to add onto the already existing blob
4212
+
4213
+
4214
+ begin
4215
+
4216
+ # Modify Blob
4217
+ result = api_instance.modify_blob(blob_id, modify_blob_request)
4218
+ p result
4219
+ rescue Freeclimb::ApiError => e
4220
+ puts "Error when calling DefaultApi->modify_blob: #{e}"
4221
+ end
4222
+ ```
4223
+
4224
+ #### Using the modify_blob_with_http_info variant
4225
+
4226
+ This returns an Array which contains the response data, status code and headers.
4227
+
4228
+ > <Array(<BlobResult>, Integer, Hash)> modify_blob_with_http_info(account_id, blob_id, modify_blob_request)
4229
+
4230
+ ```ruby
4231
+ begin
4232
+ # Modify Blob
4233
+ data, status_code, headers = api_instance.modify_blob_with_http_info(blob_id, modify_blob_request)
4234
+ p status_code # => 2xx
4235
+ p headers # => { ... }
4236
+ p data # => <BlobResult>
4237
+ rescue Freeclimb::ApiError => e
4238
+ puts "Error when calling DefaultApi->modify_blob_with_http_info: #{e}"
4239
+ end
4240
+ ```
4241
+
4242
+ ### Parameters
4243
+
4244
+ | Name | Type | Description | Notes |
4245
+ | ---- | ---- | ----------- | ----- |
4246
+ | **blob_id** | **String** | String that uniquely identifies this Blob resource. | |
4247
+ | **modify_blob_request** | [**ModifyBlobRequest**](ModifyBlobRequest.md) | Request body to specify keys to modify. Or new keys to add onto the already existing blob | |
4248
+
4249
+
4250
+ ### Return type
4251
+
4252
+ [**BlobResult**](BlobResult.md)
4253
+
4254
+ ### Authorization
4255
+
4256
+ [fc](../README.md#fc)
4257
+
4258
+ ### HTTP request headers
4259
+
4260
+ - **Content-Type**: application/json
4261
+ - **Accept**: application/json
4262
+
4263
+
3896
4264
  ## remove_a_participant
3897
4265
 
3898
4266
  Remove a Participant
@@ -3965,6 +4333,81 @@ nil (empty response body)
3965
4333
  - **Accept**: Not defined
3966
4334
 
3967
4335
 
4336
+ ## replace_blob
4337
+
4338
+ Replace Blob
4339
+
4340
+ Replaces the blob content with the provided values.
4341
+
4342
+ ### Examples
4343
+
4344
+ ```ruby
4345
+ require 'time'
4346
+ require 'freeclimb'
4347
+ # setup authorization
4348
+ Freeclimb.configure do |config|
4349
+ # Configure HTTP basic authorization: fc
4350
+ config.username = 'ACCOUNT_ID'
4351
+ config.password = 'API_KEY'
4352
+ end
4353
+
4354
+ api_instance = Freeclimb::DefaultApi.new
4355
+
4356
+ blob_id = 'blob_id_example' # String | String that uniquely identifies this Blob resource.
4357
+
4358
+ replace_blob_request = Freeclimb::ReplaceBlobRequest.new({blob: 3.56}) # ReplaceBlobRequest | JSON object containing blob key the contents of which will be used to override the enitre blob contents.
4359
+
4360
+
4361
+ begin
4362
+
4363
+ # Replace Blob
4364
+ result = api_instance.replace_blob(blob_id, replace_blob_request)
4365
+ p result
4366
+ rescue Freeclimb::ApiError => e
4367
+ puts "Error when calling DefaultApi->replace_blob: #{e}"
4368
+ end
4369
+ ```
4370
+
4371
+ #### Using the replace_blob_with_http_info variant
4372
+
4373
+ This returns an Array which contains the response data, status code and headers.
4374
+
4375
+ > <Array(<BlobResult>, Integer, Hash)> replace_blob_with_http_info(account_id, blob_id, replace_blob_request)
4376
+
4377
+ ```ruby
4378
+ begin
4379
+ # Replace Blob
4380
+ data, status_code, headers = api_instance.replace_blob_with_http_info(blob_id, replace_blob_request)
4381
+ p status_code # => 2xx
4382
+ p headers # => { ... }
4383
+ p data # => <BlobResult>
4384
+ rescue Freeclimb::ApiError => e
4385
+ puts "Error when calling DefaultApi->replace_blob_with_http_info: #{e}"
4386
+ end
4387
+ ```
4388
+
4389
+ ### Parameters
4390
+
4391
+ | Name | Type | Description | Notes |
4392
+ | ---- | ---- | ----------- | ----- |
4393
+ | **blob_id** | **String** | String that uniquely identifies this Blob resource. | |
4394
+ | **replace_blob_request** | [**ReplaceBlobRequest**](ReplaceBlobRequest.md) | JSON object containing blob key the contents of which will be used to override the enitre blob contents. | |
4395
+
4396
+
4397
+ ### Return type
4398
+
4399
+ [**BlobResult**](BlobResult.md)
4400
+
4401
+ ### Authorization
4402
+
4403
+ [fc](../README.md#fc)
4404
+
4405
+ ### HTTP request headers
4406
+
4407
+ - **Content-Type**: application/json
4408
+ - **Accept**: application/json
4409
+
4410
+
3968
4411
  ## send_an_sms_message
3969
4412
 
3970
4413
  Send an SMS Message
@@ -4102,7 +4545,7 @@ end
4102
4545
  ### HTTP request headers
4103
4546
 
4104
4547
  - **Content-Type**: Not defined
4105
- - **Accept**: audio/x-wav
4548
+ - **Accept**: audio/wav
4106
4549
 
4107
4550
 
4108
4551
  ## update_a_conference
@@ -17,8 +17,6 @@
17
17
  | **_alias** | **String** | Description for this phone number. Typically the conventionally-formatted version of the phone number. | [optional] |
18
18
  | **region** | **String** | State or province of this phone number. | [optional] |
19
19
  | **country** | **String** | Country of this phone number. | [optional] |
20
- | **voice_enabled** | **Boolean** | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional] |
21
- | **sms_enabled** | **Boolean** | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional] |
22
20
  | **offnet** | **Boolean** | The offnet field is a boolean representing whether the number is offnet registered or not. This field will be rendered only for requests to the IncomingPhone number resource. | [optional] |
23
21
  | **tfn** | [**TFN**](TFN.md) | | [optional] |
24
22
 
@@ -41,8 +39,6 @@ instance = Freeclimb::IncomingNumberResult.new(
41
39
  _alias: null,
42
40
  region: null,
43
41
  country: null,
44
- voice_enabled: null,
45
- sms_enabled: null,
46
42
  offnet: null,
47
43
  tfn: null
48
44
  )
@@ -0,0 +1,20 @@
1
+ # Freeclimb::ModifyBlobRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **blob** | **Object** | | |
8
+ | **_alias** | **String** | Custom identifier for this blob that is unique for the owning account. It will be set to the blobId by default if not provided. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'freeclimb'
14
+
15
+ instance = Freeclimb::ModifyBlobRequest.new(
16
+ blob: null,
17
+ _alias: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # Freeclimb::PlatformError
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **code** | **Integer** | | [optional] |
8
+ | **call** | **String** | | [optional] |
9
+ | **url** | **String** | | [optional] |
10
+ | **details** | **Object** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'freeclimb'
16
+
17
+ instance = Freeclimb::PlatformError.new(
18
+ code: null,
19
+ call: null,
20
+ url: null,
21
+ details: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # Freeclimb::ReplaceBlobRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **blob** | **Object** | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'freeclimb'
13
+
14
+ instance = Freeclimb::ReplaceBlobRequest.new(
15
+ blob: null
16
+ )
17
+ ```
18
+
data/docs/Say.md CHANGED
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **text** | **String** | The message to be played to the caller using TTS. The size of the string is limited to 4 KB (or 4,096 bytes). An empty string will cause the command to be skipped. | |
8
8
  | **language** | **String** | 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. | [optional] |
9
+ | **engine** | [**TTSEngine**](TTSEngine.md) | | [optional] |
9
10
  | **loop** | **Integer** | Number of times the text is said. Specifying &#39;0&#39; causes the &#x60;Say&#x60; action to loop until the Call is hung up. | [optional][default to 1] |
10
11
  | **privacy_mode** | **Boolean** | Parameter &#x60;privacyMode&#x60; will not log the &#x60;text&#x60; as required by PCI compliance. | [optional] |
11
12
 
@@ -17,6 +18,7 @@ require 'freeclimb'
17
18
  instance = Freeclimb::Say.new(
18
19
  text: null,
19
20
  language: null,
21
+ engine: null,
20
22
  loop: null,
21
23
  privacy_mode: null
22
24
  )
data/docs/TTSEngine.md ADDED
@@ -0,0 +1,20 @@
1
+ # Freeclimb::TTSEngine
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | [**TTSEngineName**](TTSEngineName.md) | | [optional] |
8
+ | **parameters** | **Hash&lt;String, Object&gt;** | Parameters for the TTS engine. The parameters are specific to the engine and are documented in the engine&#39;s documentation. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'freeclimb'
14
+
15
+ instance = Freeclimb::TTSEngine.new(
16
+ name: null,
17
+ parameters: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # Freeclimb::TTSEngineName
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **FREECLIMB_STANDARD** | **TTSEngineName** | | Represented in Ruby as "freeclimb.standard" |
8
+ | **FREECLIMB_NEURAL** | **TTSEngineName** | | Represented in Ruby as "freeclimb.neural" |
9
+ | **ELEVEN_LABS** | **TTSEngineName** | | Represented in Ruby as "ElevenLabs" |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'freeclimb'
15
+
16
+ instance = Freeclimb::TTSEngineName::[NAME OF ENUM]
17
+ ```
18
+