freeclimb 4.9.0 → 5.1.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 (442) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +25 -0
  3. data/Gemfile +2 -1
  4. data/Gemfile.lock +49 -27
  5. data/README.md +44 -51
  6. data/docs/AddToConferenceNotificationWebhook.md +42 -0
  7. data/docs/AddToQueueNotificationWebhook.md +34 -0
  8. data/docs/BargeInReason.md +18 -0
  9. data/docs/CallControlWebhook.md +26 -0
  10. data/docs/CallEndedReason.md +38 -0
  11. data/docs/CallStatusWebhook.md +36 -0
  12. data/docs/CompletionResult.md +1 -1
  13. data/docs/CompletionResultStatus.md +17 -0
  14. data/docs/ConferenceRecordingStatusWebhook.md +42 -0
  15. data/docs/ConferenceResult.md +1 -1
  16. data/docs/ConferenceStatusWebhook.md +42 -0
  17. data/docs/CreateConference.md +1 -1
  18. data/docs/CreateConferenceRequest.md +1 -1
  19. data/docs/CreateConferenceWebhook.md +42 -0
  20. data/docs/DequeueWebhook.md +38 -0
  21. data/docs/GetDigitsReason.md +19 -0
  22. data/docs/GetDigitsWebhook.md +40 -0
  23. data/docs/GetSpeechWebhook.md +50 -0
  24. data/docs/InboundCallWebhook.md +36 -0
  25. data/docs/LeaveConferenceWebhook.md +34 -0
  26. data/docs/MachineDetectedWebhook.md +38 -0
  27. data/docs/MachineType.md +2 -2
  28. data/docs/MessageDeliveryWebhook.md +36 -0
  29. data/docs/MessageResult.md +7 -1
  30. data/docs/MessageStatusWebhook.md +38 -0
  31. data/docs/OutDialApiConnectWebhook.md +36 -0
  32. data/docs/OutDialConnectWebhook.md +36 -0
  33. data/docs/OutDialStartWebhook.md +38 -0
  34. data/docs/QueueWaitWebhook.md +40 -0
  35. data/docs/RecordWebhook.md +50 -0
  36. data/docs/RedirectWebhook.md +36 -0
  37. data/docs/RemoveFromQueueNotificationWebhook.md +38 -0
  38. data/docs/SMSTenDLCBrand.md +6 -6
  39. data/docs/SMSTenDLCBrandAltBusinessIdType.md +19 -0
  40. data/docs/SMSTenDLCBrandEntityType.md +20 -0
  41. data/docs/SMSTenDLCBrandIdentityStatus.md +19 -0
  42. data/docs/SMSTenDLCBrandRelationship.md +20 -0
  43. data/docs/SMSTenDLCBrandStockExchange.md +42 -0
  44. data/docs/SMSTenDLCCampaign.md +1 -1
  45. data/docs/SMSTenDLCCampaignStatus.md +17 -0
  46. data/docs/SMSTenDLCPartnerCampaign.md +1 -1
  47. data/docs/SMSTenDLCPartnerCampaignStatus.md +17 -0
  48. data/docs/SMSTollFreeCampaign.md +1 -1
  49. data/docs/SMSTollFreeCampaignRegistrationStatus.md +20 -0
  50. data/docs/TFNCampaign.md +34 -0
  51. data/docs/TranscribeReason.md +20 -0
  52. data/docs/TranscribeTermReason.md +17 -0
  53. data/docs/TranscribeUtterance.md +2 -2
  54. data/docs/TranscribeWebhook.md +62 -0
  55. data/docs/UpdateConferenceRequest.md +1 -1
  56. data/docs/Webhook.md +18 -0
  57. data/freeclimb.gemspec +1 -1
  58. data/lib/freeclimb/api/default_api.rb +18 -18
  59. data/lib/freeclimb/api_client.rb +1 -1
  60. data/lib/freeclimb/api_error.rb +1 -1
  61. data/lib/freeclimb/configuration.rb +2 -4
  62. data/lib/freeclimb/models/account_request.rb +1 -3
  63. data/lib/freeclimb/models/account_result.rb +23 -4
  64. data/lib/freeclimb/models/account_status.rb +1 -1
  65. data/lib/freeclimb/models/account_type.rb +1 -1
  66. data/lib/freeclimb/models/add_to_conference.rb +1 -4
  67. data/lib/freeclimb/models/add_to_conference_notification_webhook.rb +384 -0
  68. data/lib/freeclimb/models/{conference_participant_result_all_of.rb → add_to_queue_notification_webhook.rb} +112 -59
  69. data/lib/freeclimb/models/answered_by.rb +1 -1
  70. data/lib/freeclimb/models/application_list.rb +1 -4
  71. data/lib/freeclimb/models/application_request.rb +1 -3
  72. data/lib/freeclimb/models/application_result.rb +1 -4
  73. data/lib/freeclimb/models/available_number.rb +1 -3
  74. data/lib/freeclimb/models/available_number_list.rb +1 -4
  75. data/lib/freeclimb/models/barge_in_reason.rb +38 -0
  76. data/lib/freeclimb/models/buy_incoming_number_request.rb +1 -3
  77. data/lib/freeclimb/models/{recording_result_all_of.rb → call_control_webhook.rb} +57 -45
  78. data/lib/freeclimb/models/call_direction.rb +1 -1
  79. data/lib/freeclimb/models/call_ended_reason.rb +58 -0
  80. data/lib/freeclimb/models/call_list.rb +1 -4
  81. data/lib/freeclimb/models/call_result.rb +23 -4
  82. data/lib/freeclimb/models/call_status.rb +1 -1
  83. data/lib/freeclimb/models/call_status_webhook.rb +354 -0
  84. data/lib/freeclimb/models/capabilities.rb +1 -3
  85. data/lib/freeclimb/models/completion_request.rb +1 -3
  86. data/lib/freeclimb/models/completion_result.rb +2 -15
  87. data/lib/freeclimb/models/completion_result_status.rb +37 -0
  88. data/lib/freeclimb/models/conference_list.rb +1 -4
  89. data/lib/freeclimb/models/conference_participant_list.rb +1 -4
  90. data/lib/freeclimb/models/conference_participant_result.rb +1 -4
  91. data/lib/freeclimb/models/conference_recording_status_webhook.rb +384 -0
  92. data/lib/freeclimb/models/conference_result.rb +23 -6
  93. data/lib/freeclimb/models/conference_status.rb +1 -1
  94. data/lib/freeclimb/models/conference_status_webhook.rb +387 -0
  95. data/lib/freeclimb/models/create_conference.rb +23 -6
  96. data/lib/freeclimb/models/create_conference_request.rb +23 -5
  97. data/lib/freeclimb/models/create_conference_webhook.rb +387 -0
  98. data/lib/freeclimb/models/create_web_rtc_token.rb +1 -3
  99. data/lib/freeclimb/models/dequeue.rb +3 -7
  100. data/lib/freeclimb/models/dequeue_webhook.rb +365 -0
  101. data/lib/freeclimb/models/enqueue.rb +1 -4
  102. data/lib/freeclimb/models/filter_logs_request.rb +1 -3
  103. data/lib/freeclimb/models/get_digits.rb +1 -4
  104. data/lib/freeclimb/models/get_digits_reason.rb +39 -0
  105. data/lib/freeclimb/models/get_digits_webhook.rb +373 -0
  106. data/lib/freeclimb/models/get_speech.rb +23 -4
  107. data/lib/freeclimb/models/get_speech_reason.rb +1 -1
  108. data/lib/freeclimb/models/get_speech_webhook.rb +423 -0
  109. data/lib/freeclimb/models/grammar_file_built_in.rb +1 -1
  110. data/lib/freeclimb/models/grammar_type.rb +1 -1
  111. data/lib/freeclimb/models/hangup.rb +1 -4
  112. data/lib/freeclimb/models/if_machine.rb +1 -1
  113. data/lib/freeclimb/models/inbound_call_webhook.rb +355 -0
  114. data/lib/freeclimb/models/incoming_number_list.rb +1 -4
  115. data/lib/freeclimb/models/incoming_number_request.rb +1 -3
  116. data/lib/freeclimb/models/incoming_number_result.rb +1 -4
  117. data/lib/freeclimb/models/language.rb +1 -1
  118. data/lib/freeclimb/models/{conference_result_all_of.rb → leave_conference_webhook.rb} +110 -89
  119. data/lib/freeclimb/models/log_level.rb +1 -1
  120. data/lib/freeclimb/models/log_list.rb +1 -4
  121. data/lib/freeclimb/models/log_result.rb +23 -3
  122. data/lib/freeclimb/models/{call_result_all_of.rb → machine_detected_webhook.rb} +96 -119
  123. data/lib/freeclimb/models/machine_type.rb +3 -3
  124. data/lib/freeclimb/models/make_call_request.rb +1 -3
  125. data/lib/freeclimb/models/{message_result_all_of.rb → message_delivery_webhook.rb} +71 -87
  126. data/lib/freeclimb/models/message_direction.rb +1 -1
  127. data/lib/freeclimb/models/message_request.rb +1 -4
  128. data/lib/freeclimb/models/message_result.rb +59 -9
  129. data/lib/freeclimb/models/message_status.rb +1 -1
  130. data/lib/freeclimb/models/{incoming_number_result_all_of.rb → message_status_webhook.rb} +117 -107
  131. data/lib/freeclimb/models/messages_list.rb +1 -4
  132. data/lib/freeclimb/models/mutable_resource_model.rb +1 -3
  133. data/lib/freeclimb/models/out_dial.rb +23 -4
  134. data/lib/freeclimb/models/out_dial_api_connect_webhook.rb +355 -0
  135. data/lib/freeclimb/models/out_dial_connect_webhook.rb +355 -0
  136. data/lib/freeclimb/models/out_dial_start_webhook.rb +366 -0
  137. data/lib/freeclimb/models/pagination_model.rb +1 -3
  138. data/lib/freeclimb/models/park.rb +1 -4
  139. data/lib/freeclimb/models/pause.rb +1 -4
  140. data/lib/freeclimb/models/percl_command.rb +3 -5
  141. data/lib/freeclimb/models/percl_script.rb +2 -4
  142. data/lib/freeclimb/models/play.rb +2 -5
  143. data/lib/freeclimb/models/play_beep.rb +1 -1
  144. data/lib/freeclimb/models/play_early_media.rb +2 -5
  145. data/lib/freeclimb/models/queue_list.rb +2 -5
  146. data/lib/freeclimb/models/queue_member.rb +1 -3
  147. data/lib/freeclimb/models/queue_member_list.rb +2 -5
  148. data/lib/freeclimb/models/queue_request.rb +1 -3
  149. data/lib/freeclimb/models/queue_result.rb +2 -5
  150. data/lib/freeclimb/models/queue_result_status.rb +1 -1
  151. data/lib/freeclimb/models/queue_wait_webhook.rb +375 -0
  152. data/lib/freeclimb/models/record_utterance.rb +2 -5
  153. data/lib/freeclimb/models/record_utterance_term_reason.rb +1 -1
  154. data/lib/freeclimb/models/record_webhook.rb +424 -0
  155. data/lib/freeclimb/models/recording_list.rb +2 -5
  156. data/lib/freeclimb/models/recording_result.rb +2 -5
  157. data/lib/freeclimb/models/redirect.rb +2 -5
  158. data/lib/freeclimb/models/redirect_webhook.rb +355 -0
  159. data/lib/freeclimb/models/reject.rb +2 -5
  160. data/lib/freeclimb/models/remove_from_conference.rb +3 -7
  161. data/lib/freeclimb/models/remove_from_queue_notification_webhook.rb +364 -0
  162. data/lib/freeclimb/models/request_type.rb +1 -1
  163. data/lib/freeclimb/models/say.rb +2 -5
  164. data/lib/freeclimb/models/send_digits.rb +2 -5
  165. data/lib/freeclimb/models/set_dtmf_pass_through.rb +2 -5
  166. data/lib/freeclimb/models/set_listen.rb +2 -5
  167. data/lib/freeclimb/models/set_talk.rb +2 -5
  168. data/lib/freeclimb/models/sms.rb +2 -5
  169. data/lib/freeclimb/models/sms_ten_dlc_brand.rb +6 -67
  170. data/lib/freeclimb/models/sms_ten_dlc_brand_alt_business_id_type.rb +39 -0
  171. data/lib/freeclimb/models/sms_ten_dlc_brand_entity_type.rb +40 -0
  172. data/lib/freeclimb/models/sms_ten_dlc_brand_identity_status.rb +39 -0
  173. data/lib/freeclimb/models/sms_ten_dlc_brand_relationship.rb +40 -0
  174. data/lib/freeclimb/models/sms_ten_dlc_brand_stock_exchange.rb +62 -0
  175. data/lib/freeclimb/models/sms_ten_dlc_brands_list_result.rb +2 -5
  176. data/lib/freeclimb/models/sms_ten_dlc_campaign.rb +2 -15
  177. data/lib/freeclimb/models/sms_ten_dlc_campaign_status.rb +37 -0
  178. data/lib/freeclimb/models/sms_ten_dlc_campaigns_list_result.rb +2 -5
  179. data/lib/freeclimb/models/sms_ten_dlc_partner_campaign.rb +2 -15
  180. data/lib/freeclimb/models/sms_ten_dlc_partner_campaign_brand.rb +1 -3
  181. data/lib/freeclimb/models/sms_ten_dlc_partner_campaign_status.rb +37 -0
  182. data/lib/freeclimb/models/sms_ten_dlc_partner_campaigns_list_result.rb +2 -5
  183. data/lib/freeclimb/models/sms_toll_free_campaign.rb +2 -15
  184. data/lib/freeclimb/models/sms_toll_free_campaign_registration_status.rb +40 -0
  185. data/lib/freeclimb/models/sms_toll_free_campaigns_list_result.rb +2 -5
  186. data/lib/freeclimb/models/start_record_call.rb +3 -7
  187. data/lib/freeclimb/models/terminate_conference.rb +3 -7
  188. data/lib/freeclimb/models/tfn.rb +1 -3
  189. data/lib/freeclimb/models/{application_result_all_of.rb → tfn_campaign.rb} +129 -72
  190. data/lib/freeclimb/models/transcribe_reason.rb +40 -0
  191. data/lib/freeclimb/models/transcribe_term_reason.rb +37 -0
  192. data/lib/freeclimb/models/transcribe_utterance.rb +4 -7
  193. data/lib/freeclimb/models/{transcribe_utterance_all_of_record.rb → transcribe_utterance_record.rb} +8 -10
  194. data/lib/freeclimb/models/transcribe_webhook.rb +481 -0
  195. data/lib/freeclimb/models/unpark.rb +3 -7
  196. data/lib/freeclimb/models/update_call_request.rb +23 -3
  197. data/lib/freeclimb/models/update_call_request_status.rb +1 -1
  198. data/lib/freeclimb/models/update_conference_participant_request.rb +1 -3
  199. data/lib/freeclimb/models/update_conference_request.rb +23 -5
  200. data/lib/freeclimb/models/update_conference_request_status.rb +1 -1
  201. data/lib/freeclimb/models/{call_list_all_of.rb → webhook.rb} +18 -17
  202. data/lib/freeclimb/utils/request_verifier.rb +51 -51
  203. data/lib/freeclimb/utils/signature_information.rb +34 -34
  204. data/lib/freeclimb/version.rb +2 -2
  205. data/lib/freeclimb.rb +42 -49
  206. data/openapi.json +1756 -648
  207. data/package.json +3 -1
  208. data/spec/api/default_api_spec.rb +97 -149
  209. data/spec/factories.rb +78 -78
  210. data/spec/models/account_request_spec.rb +168 -19
  211. data/spec/models/account_result_spec.rb +878 -91
  212. data/spec/models/account_status_spec.rb +2 -1
  213. data/spec/models/account_type_spec.rb +2 -1
  214. data/spec/models/add_to_conference_notification_webhook_spec.rb +1515 -0
  215. data/spec/models/add_to_conference_spec.rb +725 -43
  216. data/spec/models/add_to_queue_notification_webhook_spec.rb +1106 -0
  217. data/spec/models/answered_by_spec.rb +2 -1
  218. data/spec/models/application_list_spec.rb +504 -41
  219. data/spec/models/application_request_spec.rb +553 -34
  220. data/spec/models/application_result_spec.rb +997 -52
  221. data/spec/models/available_number_list_spec.rb +504 -41
  222. data/spec/models/available_number_spec.rb +536 -49
  223. data/spec/models/barge_in_reason_spec.rb +78 -0
  224. data/spec/models/buy_incoming_number_request_spec.rb +245 -22
  225. data/spec/models/call_control_webhook_spec.rb +664 -0
  226. data/spec/models/call_direction_spec.rb +2 -1
  227. data/spec/models/call_ended_reason_spec.rb +398 -0
  228. data/spec/models/call_list_spec.rb +504 -41
  229. data/spec/models/call_result_spec.rb +1712 -272
  230. data/spec/models/call_status_spec.rb +2 -1
  231. data/spec/models/call_status_webhook_spec.rb +1292 -0
  232. data/spec/models/capabilities_spec.rb +309 -28
  233. data/spec/models/completion_request_spec.rb +89 -17
  234. data/spec/models/completion_result_spec.rb +184 -47
  235. data/spec/models/completion_result_status_spec.rb +62 -0
  236. data/spec/models/conference_list_spec.rb +504 -41
  237. data/spec/models/conference_participant_list_spec.rb +504 -41
  238. data/spec/models/conference_participant_result_spec.rb +804 -48
  239. data/spec/models/conference_recording_status_webhook_spec.rb +1515 -0
  240. data/spec/models/conference_result_spec.rb +1215 -224
  241. data/spec/models/conference_status_spec.rb +2 -1
  242. data/spec/models/conference_status_webhook_spec.rb +1515 -0
  243. data/spec/models/create_conference_request_spec.rb +391 -46
  244. data/spec/models/create_conference_spec.rb +450 -49
  245. data/spec/models/create_conference_webhook_spec.rb +1515 -0
  246. data/spec/models/create_web_rtc_token_spec.rb +227 -22
  247. data/spec/models/dequeue_spec.rb +2 -1
  248. data/spec/models/dequeue_webhook_spec.rb +1300 -0
  249. data/spec/models/enqueue_spec.rb +322 -25
  250. data/spec/models/filter_logs_request_spec.rb +91 -16
  251. data/spec/models/get_digits_reason_spec.rb +94 -0
  252. data/spec/models/get_digits_spec.rb +581 -44
  253. data/spec/models/get_digits_webhook_spec.rb +1426 -0
  254. data/spec/models/get_speech_reason_spec.rb +2 -1
  255. data/spec/models/get_speech_spec.rb +856 -69
  256. data/spec/models/get_speech_webhook_spec.rb +1927 -0
  257. data/spec/models/grammar_file_built_in_spec.rb +2 -1
  258. data/spec/models/grammar_type_spec.rb +2 -1
  259. data/spec/models/hangup_spec.rb +91 -16
  260. data/spec/models/if_machine_spec.rb +2 -1
  261. data/spec/models/inbound_call_webhook_spec.rb +1211 -0
  262. data/spec/models/incoming_number_list_spec.rb +504 -41
  263. data/spec/models/incoming_number_request_spec.rb +245 -22
  264. data/spec/models/incoming_number_result_spec.rb +1430 -235
  265. data/spec/models/language_spec.rb +2 -1
  266. data/spec/models/leave_conference_webhook_spec.rb +1106 -0
  267. data/spec/models/log_level_spec.rb +2 -1
  268. data/spec/models/log_list_spec.rb +504 -41
  269. data/spec/models/log_result_spec.rb +556 -57
  270. data/spec/models/machine_detected_webhook_spec.rb +1313 -0
  271. data/spec/models/machine_type_spec.rb +11 -10
  272. data/spec/models/make_call_request_spec.rb +749 -44
  273. data/spec/models/message_delivery_webhook_spec.rb +1189 -0
  274. data/spec/models/message_direction_spec.rb +2 -1
  275. data/spec/models/message_request_spec.rb +672 -41
  276. data/spec/models/message_result_spec.rb +1644 -204
  277. data/spec/models/message_status_spec.rb +2 -1
  278. data/spec/models/message_status_webhook_spec.rb +1327 -0
  279. data/spec/models/messages_list_spec.rb +504 -41
  280. data/spec/models/mutable_resource_model_spec.rb +304 -25
  281. data/spec/models/out_dial_api_connect_webhook_spec.rb +1211 -0
  282. data/spec/models/out_dial_connect_webhook_spec.rb +1211 -0
  283. data/spec/models/out_dial_spec.rb +759 -62
  284. data/spec/models/out_dial_start_webhook_spec.rb +1316 -0
  285. data/spec/models/pagination_model_spec.rb +445 -34
  286. data/spec/models/park_spec.rb +245 -22
  287. data/spec/models/pause_spec.rb +73 -16
  288. data/spec/models/percl_command_spec.rb +88 -16
  289. data/spec/models/percl_script_spec.rb +73 -20
  290. data/spec/models/play_beep_spec.rb +2 -1
  291. data/spec/models/play_early_media_spec.rb +91 -16
  292. data/spec/models/play_spec.rb +209 -22
  293. data/spec/models/queue_list_spec.rb +504 -41
  294. data/spec/models/queue_member_list_spec.rb +504 -41
  295. data/spec/models/queue_member_spec.rb +363 -28
  296. data/spec/models/queue_request_spec.rb +150 -19
  297. data/spec/models/queue_result_spec.rb +801 -52
  298. data/spec/models/queue_result_status_spec.rb +2 -1
  299. data/spec/models/queue_wait_webhook_spec.rb +1389 -0
  300. data/spec/models/record_utterance_spec.rb +463 -34
  301. data/spec/models/record_utterance_term_reason_spec.rb +2 -1
  302. data/spec/models/record_webhook_spec.rb +1917 -0
  303. data/spec/models/recording_list_spec.rb +504 -41
  304. data/spec/models/recording_result_spec.rb +672 -41
  305. data/spec/models/redirect_spec.rb +91 -16
  306. data/spec/models/redirect_webhook_spec.rb +1211 -0
  307. data/spec/models/reject_spec.rb +91 -16
  308. data/spec/models/remove_from_conference_spec.rb +2 -1
  309. data/spec/models/remove_from_queue_notification_webhook_spec.rb +1305 -0
  310. data/spec/models/request_type_spec.rb +2 -1
  311. data/spec/models/say_spec.rb +286 -25
  312. data/spec/models/send_digits_spec.rb +209 -22
  313. data/spec/models/set_dtmf_pass_through_spec.rb +73 -16
  314. data/spec/models/set_listen_spec.rb +73 -16
  315. data/spec/models/set_talk_spec.rb +73 -16
  316. data/spec/models/sms_spec.rb +322 -25
  317. data/spec/models/sms_ten_dlc_brand_alt_business_id_type_spec.rb +94 -0
  318. data/spec/models/sms_ten_dlc_brand_entity_type_spec.rb +110 -0
  319. data/spec/models/sms_ten_dlc_brand_identity_status_spec.rb +94 -0
  320. data/spec/models/sms_ten_dlc_brand_relationship_spec.rb +110 -0
  321. data/spec/models/sms_ten_dlc_brand_spec.rb +2585 -484
  322. data/spec/models/sms_ten_dlc_brand_stock_exchange_spec.rb +462 -0
  323. data/spec/models/sms_ten_dlc_brands_list_result_spec.rb +504 -41
  324. data/spec/models/sms_ten_dlc_campaign_spec.rb +2604 -274
  325. data/spec/models/sms_ten_dlc_campaign_status_spec.rb +62 -0
  326. data/spec/models/sms_ten_dlc_campaigns_list_result_spec.rb +504 -41
  327. data/spec/models/sms_ten_dlc_partner_campaign_brand_spec.rb +835 -55
  328. data/spec/models/sms_ten_dlc_partner_campaign_spec.rb +2078 -166
  329. data/spec/models/sms_ten_dlc_partner_campaign_status_spec.rb +62 -0
  330. data/spec/models/sms_ten_dlc_partner_campaigns_list_result_spec.rb +504 -41
  331. data/spec/models/sms_toll_free_campaign_registration_status_spec.rb +110 -0
  332. data/spec/models/sms_toll_free_campaign_spec.rb +555 -71
  333. data/spec/models/sms_toll_free_campaigns_list_result_spec.rb +504 -41
  334. data/spec/models/start_record_call_spec.rb +2 -1
  335. data/spec/models/terminate_conference_spec.rb +2 -1
  336. data/spec/models/tfn_campaign_spec.rb +1089 -0
  337. data/spec/models/tfn_spec.rb +91 -16
  338. data/spec/models/transcribe_reason_spec.rb +110 -0
  339. data/spec/models/transcribe_term_reason_spec.rb +62 -0
  340. data/spec/models/{transcribe_utterance_all_of_record_spec.rb → transcribe_utterance_record_spec.rb} +214 -45
  341. data/spec/models/transcribe_utterance_spec.rb +424 -47
  342. data/spec/models/transcribe_webhook_spec.rb +2418 -0
  343. data/spec/models/unpark_spec.rb +2 -1
  344. data/spec/models/update_call_request_spec.rb +101 -34
  345. data/spec/models/update_call_request_status_spec.rb +2 -1
  346. data/spec/models/update_conference_participant_request_spec.rb +219 -19
  347. data/spec/models/update_conference_request_spec.rb +265 -58
  348. data/spec/models/update_conference_request_status_spec.rb +2 -1
  349. data/spec/models/webhook_spec.rb +228 -0
  350. data/spec/quickstart_spec.rb +7 -7
  351. data/spec/spec_helper.rb +1 -1
  352. data/spec/utils/request_verifier_spec.rb +123 -123
  353. data/spec/utils/signature_information_spec.rb +36 -36
  354. data/yarn.lock +91 -91
  355. metadata +247 -186
  356. data/docs/AccountResultAllOf.md +0 -30
  357. data/docs/AddToConferenceAllOf.md +0 -36
  358. data/docs/ApplicationListAllOf.md +0 -18
  359. data/docs/ApplicationResultAllOf.md +0 -34
  360. data/docs/AvailableNumberListAllOf.md +0 -18
  361. data/docs/CallListAllOf.md +0 -18
  362. data/docs/CallResultAllOf.md +0 -48
  363. data/docs/ConferenceListAllOf.md +0 -18
  364. data/docs/ConferenceParticipantListAllOf.md +0 -18
  365. data/docs/ConferenceParticipantResultAllOf.md +0 -30
  366. data/docs/ConferenceResultAllOf.md +0 -36
  367. data/docs/CreateConferenceAllOf.md +0 -28
  368. data/docs/EnqueueAllOf.md +0 -24
  369. data/docs/GetDigitsAllOf.md +0 -34
  370. data/docs/GetSpeechAllOf.md +0 -42
  371. data/docs/HangupAllOf.md +0 -18
  372. data/docs/IncomingNumberListAllOf.md +0 -18
  373. data/docs/IncomingNumberResultAllOf.md +0 -42
  374. data/docs/LogListAllOf.md +0 -18
  375. data/docs/MessageRequestAllOf.md +0 -26
  376. data/docs/MessageResultAllOf.md +0 -40
  377. data/docs/MessagesListAllOf.md +0 -18
  378. data/docs/OutDialAllOf.md +0 -36
  379. data/docs/ParkAllOf.md +0 -22
  380. data/docs/PauseAllOf.md +0 -18
  381. data/docs/PlayAllOf.md +0 -22
  382. data/docs/PlayEarlyMediaAllOf.md +0 -18
  383. data/docs/QueueListAllOf.md +0 -18
  384. data/docs/QueueMemberListAllOf.md +0 -18
  385. data/docs/QueueResultAllOf.md +0 -30
  386. data/docs/RecordUtteranceAllOf.md +0 -30
  387. data/docs/RecordingListAllOf.md +0 -18
  388. data/docs/RecordingResultAllOf.md +0 -26
  389. data/docs/RedirectAllOf.md +0 -18
  390. data/docs/RejectAllOf.md +0 -18
  391. data/docs/RemoveFromConferenceAllOf.md +0 -18
  392. data/docs/SMSTenDLCBrandsListResultAllOf.md +0 -18
  393. data/docs/SMSTenDLCCampaignsListResultAllOf.md +0 -18
  394. data/docs/SMSTenDLCPartnerCampaignsListResultAllOf.md +0 -18
  395. data/docs/SMSTollFreeCampaignsListResultAllOf.md +0 -18
  396. data/docs/SayAllOf.md +0 -24
  397. data/docs/SendDigitsAllOf.md +0 -22
  398. data/docs/SetDTMFPassThroughAllOf.md +0 -18
  399. data/docs/SetListenAllOf.md +0 -18
  400. data/docs/SetTalkAllOf.md +0 -18
  401. data/docs/SmsAllOf.md +0 -24
  402. data/docs/TerminateConferenceAllOf.md +0 -18
  403. data/docs/TranscribeUtteranceAllOf.md +0 -28
  404. data/docs/TranscribeUtteranceAllOfRecord.md +0 -22
  405. data/lib/freeclimb/models/account_result_all_of.rb +0 -289
  406. data/lib/freeclimb/models/add_to_conference_all_of.rb +0 -318
  407. data/lib/freeclimb/models/application_list_all_of.rb +0 -226
  408. data/lib/freeclimb/models/available_number_list_all_of.rb +0 -226
  409. data/lib/freeclimb/models/conference_list_all_of.rb +0 -226
  410. data/lib/freeclimb/models/conference_participant_list_all_of.rb +0 -226
  411. data/lib/freeclimb/models/create_conference_all_of.rb +0 -280
  412. data/lib/freeclimb/models/enqueue_all_of.rb +0 -266
  413. data/lib/freeclimb/models/get_digits_all_of.rb +0 -310
  414. data/lib/freeclimb/models/get_speech_all_of.rb +0 -354
  415. data/lib/freeclimb/models/hangup_all_of.rb +0 -224
  416. data/lib/freeclimb/models/incoming_number_list_all_of.rb +0 -226
  417. data/lib/freeclimb/models/log_list_all_of.rb +0 -226
  418. data/lib/freeclimb/models/message_request_all_of.rb +0 -279
  419. data/lib/freeclimb/models/messages_list_all_of.rb +0 -227
  420. data/lib/freeclimb/models/out_dial_all_of.rb +0 -329
  421. data/lib/freeclimb/models/park_all_of.rb +0 -252
  422. data/lib/freeclimb/models/pause_all_of.rb +0 -228
  423. data/lib/freeclimb/models/play_all_of.rb +0 -248
  424. data/lib/freeclimb/models/play_early_media_all_of.rb +0 -228
  425. data/lib/freeclimb/models/queue_list_all_of.rb +0 -226
  426. data/lib/freeclimb/models/queue_member_list_all_of.rb +0 -226
  427. data/lib/freeclimb/models/queue_result_all_of.rb +0 -291
  428. data/lib/freeclimb/models/record_utterance_all_of.rb +0 -288
  429. data/lib/freeclimb/models/recording_list_all_of.rb +0 -226
  430. data/lib/freeclimb/models/redirect_all_of.rb +0 -228
  431. data/lib/freeclimb/models/reject_all_of.rb +0 -224
  432. data/lib/freeclimb/models/say_all_of.rb +0 -260
  433. data/lib/freeclimb/models/send_digits_all_of.rb +0 -248
  434. data/lib/freeclimb/models/set_dtmf_pass_through_all_of.rb +0 -224
  435. data/lib/freeclimb/models/set_listen_all_of.rb +0 -224
  436. data/lib/freeclimb/models/set_talk_all_of.rb +0 -224
  437. data/lib/freeclimb/models/sms_all_of.rb +0 -266
  438. data/lib/freeclimb/models/sms_ten_dlc_brands_list_result_all_of.rb +0 -226
  439. data/lib/freeclimb/models/sms_ten_dlc_campaigns_list_result_all_of.rb +0 -226
  440. data/lib/freeclimb/models/sms_ten_dlc_partner_campaigns_list_result_all_of.rb +0 -226
  441. data/lib/freeclimb/models/sms_toll_free_campaigns_list_result_all_of.rb +0 -226
  442. data/lib/freeclimb/models/transcribe_utterance_all_of.rb +0 -281
@@ -0,0 +1,40 @@
1
+ # Freeclimb::QueueWaitWebhook
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_type** | **String** | Context or reason why this request is being made. Will be queueWait - A queued call is requesting instructions to execute during the wait in the queue and the corresponding waitUrl is being invoked. | [optional] |
8
+ | **account_id** | **String** | Account ID associated with your account. | [optional] |
9
+ | **call_id** | **String** | Unique identifier for this Call, generated by FreeClimb | [optional] |
10
+ | **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
11
+ | **to** | **String** | Phone number provisioned to the customer and to which this Call is directed (in E.164 format). | [optional] |
12
+ | **call_status** | [**CallStatus**](CallStatus.md) | | [optional] |
13
+ | **direction** | [**CallDirection**](CallDirection.md) | | [optional] |
14
+ | **conference_id** | **String** | This is only populated if request pertains to a conference. Otherwise, it is set to null. | [optional] |
15
+ | **queue_id** | **String** | This is only populated if the request pertains to a queue. Otherwise, it is set to null. | [optional] |
16
+ | **queue_position** | **String** | Current queue position of the enqueued Call. | [optional] |
17
+ | **queue_time** | **Integer** | Time (in seconds) the Call spent in the Queue. This is only available if the Call was actually enqueued. | [optional] |
18
+ | **current_queue_size** | **Integer** | Current number of enqueued Calls in this Queue. | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'freeclimb'
24
+
25
+ instance = Freeclimb::QueueWaitWebhook.new(
26
+ request_type: null,
27
+ account_id: null,
28
+ call_id: null,
29
+ from: null,
30
+ to: null,
31
+ call_status: null,
32
+ direction: null,
33
+ conference_id: null,
34
+ queue_id: null,
35
+ queue_position: null,
36
+ queue_time: null,
37
+ current_queue_size: null
38
+ )
39
+ ```
40
+
@@ -0,0 +1,50 @@
1
+ # Freeclimb::RecordWebhook
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_type** | **String** | The context or reason why this request is being made. Will be record - The RecordUtterance command has completed and its actionUrl is being invoked. | [optional] |
8
+ | **account_id** | **String** | Account ID associated with your account. | [optional] |
9
+ | **call_id** | **String** | Unique identifier for this Call, generated by FreeClimb | [optional] |
10
+ | **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
11
+ | **to** | **String** | Phone number provisioned to the customer and to which this Call is directed (in E.164 format). | [optional] |
12
+ | **call_status** | [**CallStatus**](CallStatus.md) | | [optional] |
13
+ | **direction** | [**CallDirection**](CallDirection.md) | | [optional] |
14
+ | **conference_id** | **String** | This is only populated if request pertains to a conference. Otherwise, it is set to null. | [optional] |
15
+ | **queue_id** | **String** | This is only populated if the request pertains to a queue. Otherwise, it is set to null. | [optional] |
16
+ | **recording_id** | **String** | ID of the recording. | [optional] |
17
+ | **recording_url** | **String** | URL of the recorded audio file. This URL can be used as is in a Play command to play the recording (no authentication needed). It can also be used to download a recording file via the REST API. | [optional] |
18
+ | **recording_size** | **String** | Size of the recording in bytes | [optional] |
19
+ | **recording_format** | **String** | File type of the recording (audio/wav) | [optional] |
20
+ | **recording_duration_sec** | **Integer** | Duration of the recorded audio rounded up to the nearest second (in seconds) | [optional] |
21
+ | **term_reason** | [**RecordUtteranceTermReason**](RecordUtteranceTermReason.md) | | [optional] |
22
+ | **parent_call_id** | **String** | ID of Call that created this leg (child call). | [optional] |
23
+ | **privacy_mode** | **Boolean** | If true then it indicates the recording will only be available for download for two minutes prior to it being deleted. This is to minimize risk of anyone else getting access to the url and attempting to access it. | [optional] |
24
+
25
+ ## Example
26
+
27
+ ```ruby
28
+ require 'freeclimb'
29
+
30
+ instance = Freeclimb::RecordWebhook.new(
31
+ request_type: null,
32
+ account_id: null,
33
+ call_id: null,
34
+ from: null,
35
+ to: null,
36
+ call_status: null,
37
+ direction: null,
38
+ conference_id: null,
39
+ queue_id: null,
40
+ recording_id: null,
41
+ recording_url: null,
42
+ recording_size: null,
43
+ recording_format: null,
44
+ recording_duration_sec: null,
45
+ term_reason: null,
46
+ parent_call_id: null,
47
+ privacy_mode: null
48
+ )
49
+ ```
50
+
@@ -0,0 +1,36 @@
1
+ # Freeclimb::RedirectWebhook
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_type** | **String** | Context or reason why this request is being made. Will be redirect - The Redirect command is executing and its actionUrl is being invoked. | [optional] |
8
+ | **account_id** | **String** | Account ID associated with your account. | [optional] |
9
+ | **call_id** | **String** | Unique identifier for this Call, generated by FreeClimb | [optional] |
10
+ | **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
11
+ | **to** | **String** | Phone number provisioned to the customer and to which this Call is directed (in E.164 format). | [optional] |
12
+ | **call_status** | [**CallStatus**](CallStatus.md) | | [optional] |
13
+ | **direction** | [**CallDirection**](CallDirection.md) | | [optional] |
14
+ | **conference_id** | **String** | This is only populated if request pertains to a conference. Otherwise, it is set to null. | [optional] |
15
+ | **queue_id** | **String** | This is only populated if the request pertains to a queue. Otherwise, it is set to null. | [optional] |
16
+ | **parent_call_id** | **String** | ID of Call that created this leg (child call). | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'freeclimb'
22
+
23
+ instance = Freeclimb::RedirectWebhook.new(
24
+ request_type: null,
25
+ account_id: null,
26
+ call_id: null,
27
+ from: null,
28
+ to: null,
29
+ call_status: null,
30
+ direction: null,
31
+ conference_id: null,
32
+ queue_id: null,
33
+ parent_call_id: null
34
+ )
35
+ ```
36
+
@@ -0,0 +1,38 @@
1
+ # Freeclimb::RemoveFromQueueNotificationWebhook
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_type** | **String** | Context or reason why this request is being made. Will be removeFromQueueNotification - A Call has been removed from a Queue and the Enqueue command’s actionUrl is being invoked. | [optional] |
8
+ | **account_id** | **String** | Account ID associated with your account. | [optional] |
9
+ | **call_id** | **String** | Unique identifier for this Call, generated by FreeClimb | [optional] |
10
+ | **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
11
+ | **to** | **String** | Phone number provisioned to the customer and to which this Call is directed (in E.164 format). | [optional] |
12
+ | **call_status** | [**CallStatus**](CallStatus.md) | | [optional] |
13
+ | **direction** | [**CallDirection**](CallDirection.md) | | [optional] |
14
+ | **conference_id** | **String** | This is only populated if request pertains to a conference. Otherwise, it is set to null. | [optional] |
15
+ | **queue_id** | **String** | This is only populated if the request pertains to a queue. Otherwise, it is set to null. | [optional] |
16
+ | **queue_result** | [**QueueResultStatus**](QueueResultStatus.md) | | [optional] |
17
+ | **queue_time** | **Integer** | Time (in seconds) the Call spent in the Queue. This is only available if the Call was actually enqueued. | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'freeclimb'
23
+
24
+ instance = Freeclimb::RemoveFromQueueNotificationWebhook.new(
25
+ request_type: null,
26
+ account_id: null,
27
+ call_id: null,
28
+ from: null,
29
+ to: null,
30
+ call_status: null,
31
+ direction: null,
32
+ conference_id: null,
33
+ queue_id: null,
34
+ queue_result: null,
35
+ queue_time: null
36
+ )
37
+ ```
38
+
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **account_id** | **String** | ID of the account that created this Queue. | [optional] |
8
- | **entity_type** | **String** | Entity type behind the brand. This is the form of business establishment. | |
8
+ | **entity_type** | [**SMSTenDLCBrandEntityType**](SMSTenDLCBrandEntityType.md) | | |
9
9
  | **csp_id** | **String** | Unique identifier assigned to the csp by the registry. | [optional][readonly] |
10
10
  | **brand_id** | **String** | Unique identifier assigned to the brand by the registry. | [optional][readonly] |
11
11
  | **first_name** | **String** | First or given name. | [optional] |
@@ -22,18 +22,18 @@
22
22
  | **country** | **String** | ISO2 2 characters country code. Example: US - United States | |
23
23
  | **email** | **String** | Valid email address of brand support contact. | |
24
24
  | **stock_symbol** | **String** | (Required for public company) stock symbol. | [optional] |
25
- | **stock_exchange** | **String** | (Required for public company) stock exchange. | [optional] |
25
+ | **stock_exchange** | [**SMSTenDLCBrandStockExchange**](SMSTenDLCBrandStockExchange.md) | | [optional] |
26
26
  | **ip_address** | **String** | IP address of the browser requesting to create brand identity. | [optional] |
27
27
  | **website** | **String** | Brand website URL. | [optional] |
28
- | **brand_relationship** | **String** | Brand relationship to the CSP | |
28
+ | **brand_relationship** | [**SMSTenDLCBrandRelationship**](SMSTenDLCBrandRelationship.md) | | |
29
29
  | **vertical** | **String** | Vertical or industry segment of the brand. | |
30
30
  | **alt_business_id** | **String** | Alternate business identifier such as DUNS, LEI, or GIIN | [optional] |
31
- | **alt_business_id_type** | **String** | The type of the Alternative business identifier | [optional] |
31
+ | **alt_business_id_type** | [**SMSTenDLCBrandAltBusinessIdType**](SMSTenDLCBrandAltBusinessIdType.md) | | [optional] |
32
32
  | **universal_ein** | **String** | Universal EIN of Brand, Read Only. | [optional][readonly] |
33
33
  | **reference_id** | **String** | Caller supplied brand reference ID. If supplied, the value must be unique across all submitted brands. Can be used to prevent duplicate brand registrations. | [optional] |
34
34
  | **optional_attributes** | **Hash<String, Object>** | Optional brand attributes. Please refer to GET /enum/optionalAttributeNames for dictionary of optional attribute names. | [optional] |
35
35
  | **mock** | **Boolean** | Test brand. | |
36
- | **identity_status** | **String** | TCR assessment of the brand identification status. | |
36
+ | **identity_status** | [**SMSTenDLCBrandIdentityStatus**](SMSTenDLCBrandIdentityStatus.md) | | |
37
37
  | **create_date** | **Time** | Unix timestamp when brand was created. | [optional] |
38
38
 
39
39
  ## Example
@@ -60,7 +60,7 @@ instance = Freeclimb::SMSTenDLCBrand.new(
60
60
  country: US,
61
61
  email: null,
62
62
  stock_symbol: ABC,
63
- stock_exchange: NASDAQ,
63
+ stock_exchange: null,
64
64
  ip_address: null,
65
65
  website: http://www.abcmobile.com,
66
66
  brand_relationship: null,
@@ -0,0 +1,19 @@
1
+ # Freeclimb::SMSTenDLCBrandAltBusinessIdType
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **NONE** | **SMSTenDLCBrandAltBusinessIdType** | | Represented in Ruby as "NONE" |
8
+ | **DUNS** | **SMSTenDLCBrandAltBusinessIdType** | | Represented in Ruby as "DUNS" |
9
+ | **GIIN** | **SMSTenDLCBrandAltBusinessIdType** | | Represented in Ruby as "GIIN" |
10
+ | **LEI** | **SMSTenDLCBrandAltBusinessIdType** | | Represented in Ruby as "LEI" |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'freeclimb'
16
+
17
+ instance = Freeclimb::SMSTenDLCBrandAltBusinessIdType::[NAME OF ENUM]
18
+ ```
19
+
@@ -0,0 +1,20 @@
1
+ # Freeclimb::SMSTenDLCBrandEntityType
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **PRIVATE_PROFIT** | **SMSTenDLCBrandEntityType** | | Represented in Ruby as "PRIVATE_PROFIT" |
8
+ | **PUBLIC_PROFIT** | **SMSTenDLCBrandEntityType** | | Represented in Ruby as "PUBLIC_PROFIT" |
9
+ | **NON_PROFIT** | **SMSTenDLCBrandEntityType** | | Represented in Ruby as "NON_PROFIT" |
10
+ | **GOVERNMENT** | **SMSTenDLCBrandEntityType** | | Represented in Ruby as "GOVERNMENT" |
11
+ | **SOLE_PROPRIETOR** | **SMSTenDLCBrandEntityType** | | Represented in Ruby as "SOLE_PROPRIETOR" |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'freeclimb'
17
+
18
+ instance = Freeclimb::SMSTenDLCBrandEntityType::[NAME OF ENUM]
19
+ ```
20
+
@@ -0,0 +1,19 @@
1
+ # Freeclimb::SMSTenDLCBrandIdentityStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **SELF_DECLARED** | **SMSTenDLCBrandIdentityStatus** | | Represented in Ruby as "SELF_DECLARED" |
8
+ | **UNVERIFIED** | **SMSTenDLCBrandIdentityStatus** | | Represented in Ruby as "UNVERIFIED" |
9
+ | **VERIFIED** | **SMSTenDLCBrandIdentityStatus** | | Represented in Ruby as "VERIFIED" |
10
+ | **VETTED_VERIFIED** | **SMSTenDLCBrandIdentityStatus** | | Represented in Ruby as "VETTED_VERIFIED" |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'freeclimb'
16
+
17
+ instance = Freeclimb::SMSTenDLCBrandIdentityStatus::[NAME OF ENUM]
18
+ ```
19
+
@@ -0,0 +1,20 @@
1
+ # Freeclimb::SMSTenDLCBrandRelationship
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **BASIC_ACCOUNT** | **SMSTenDLCBrandRelationship** | | Represented in Ruby as "BASIC_ACCOUNT" |
8
+ | **SMALL_ACCOUNT** | **SMSTenDLCBrandRelationship** | | Represented in Ruby as "SMALL_ACCOUNT" |
9
+ | **MEDIUM_ACCOUNT** | **SMSTenDLCBrandRelationship** | | Represented in Ruby as "MEDIUM_ACCOUNT" |
10
+ | **LARGE_ACCOUNT** | **SMSTenDLCBrandRelationship** | | Represented in Ruby as "LARGE_ACCOUNT" |
11
+ | **KEY_ACCOUNT** | **SMSTenDLCBrandRelationship** | | Represented in Ruby as "KEY_ACCOUNT" |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'freeclimb'
17
+
18
+ instance = Freeclimb::SMSTenDLCBrandRelationship::[NAME OF ENUM]
19
+ ```
20
+
@@ -0,0 +1,42 @@
1
+ # Freeclimb::SMSTenDLCBrandStockExchange
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **NONE** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "NONE" |
8
+ | **NASDAQ** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "NASDAQ" |
9
+ | **NYSE** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "NYSE" |
10
+ | **AMEX** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "AMEX" |
11
+ | **AMX** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "AMX" |
12
+ | **ASX** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "ASX" |
13
+ | **B3** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "B3" |
14
+ | **BME** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "BME" |
15
+ | **BSE** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "BSE" |
16
+ | **FRA** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "FRA" |
17
+ | **ICEX** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "ICEX" |
18
+ | **JPX** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "JPX" |
19
+ | **JSE** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "JSE" |
20
+ | **KRX** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "KRX" |
21
+ | **LON** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "LON" |
22
+ | **NSE** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "NSE" |
23
+ | **OMX** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "OMX" |
24
+ | **SEHK** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "SEHK" |
25
+ | **SGX** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "SGX" |
26
+ | **SSE** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "SSE" |
27
+ | **STO** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "STO" |
28
+ | **SWX** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "SWX" |
29
+ | **SZSE** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "SZSE" |
30
+ | **TSX** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "TSX" |
31
+ | **TWSE** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "TWSE" |
32
+ | **VSE** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "VSE" |
33
+ | **OTHER** | **SMSTenDLCBrandStockExchange** | | Represented in Ruby as "OTHER" |
34
+
35
+ ## Example
36
+
37
+ ```ruby
38
+ require 'freeclimb'
39
+
40
+ instance = Freeclimb::SMSTenDLCBrandStockExchange::[NAME OF ENUM]
41
+ ```
42
+
@@ -8,7 +8,7 @@
8
8
  | **campaign_id** | **String** | Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC. | |
9
9
  | **csp_id** | **String** | Alphanumeric identifier of the CSP associated with this campaign. | |
10
10
  | **reseller_id** | **String** | Alphanumeric identifier of the reseller that you want to associate with this campaign. | [optional] |
11
- | **status** | **String** | Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. | [optional] |
11
+ | **status** | [**SMSTenDLCCampaignStatus**](SMSTenDLCCampaignStatus.md) | | [optional] |
12
12
  | **create_date** | **Time** | Unix timestamp when campaign was created. | [optional] |
13
13
  | **auto_renewal** | **Boolean** | Campaign subscription auto-renewal status. | [optional] |
14
14
  | **billed_date** | **Time** | Campaign recent billed date. | [optional] |
@@ -0,0 +1,17 @@
1
+ # Freeclimb::SMSTenDLCCampaignStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **ACTIVE** | **SMSTenDLCCampaignStatus** | | Represented in Ruby as "ACTIVE" |
8
+ | **EXPIRED** | **SMSTenDLCCampaignStatus** | | Represented in Ruby as "EXPIRED" |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'freeclimb'
14
+
15
+ instance = Freeclimb::SMSTenDLCCampaignStatus::[NAME OF ENUM]
16
+ ```
17
+
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **account_id** | **String** | ID of the account that created this Queue. | [optional] |
8
8
  | **campaign_id** | **String** | Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC. | |
9
- | **status** | **String** | Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. | [optional] |
9
+ | **status** | [**SMSTenDLCPartnerCampaignStatus**](SMSTenDLCPartnerCampaignStatus.md) | | [optional] |
10
10
  | **create_date** | **Time** | Unix timestamp when campaign was created. | [optional] |
11
11
  | **brand_id** | **String** | Alphanumeric identifier of the brand associated with this campaign. | |
12
12
  | **usecase** | **String** | Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand. | |
@@ -0,0 +1,17 @@
1
+ # Freeclimb::SMSTenDLCPartnerCampaignStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **ACTIVE** | **SMSTenDLCPartnerCampaignStatus** | | Represented in Ruby as "ACTIVE" |
8
+ | **EXPIRED** | **SMSTenDLCPartnerCampaignStatus** | | Represented in Ruby as "EXPIRED" |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'freeclimb'
14
+
15
+ instance = Freeclimb::SMSTenDLCPartnerCampaignStatus::[NAME OF ENUM]
16
+ ```
17
+
@@ -7,7 +7,7 @@
7
7
  | **account_id** | **String** | ID of the account that created this toll-free campaign | |
8
8
  | **campaign_id** | **String** | Alphanumeric identifier used by the platform to identify this toll-free campaign | |
9
9
  | **use_case** | **String** | | |
10
- | **registration_status** | **String** | Current toll-free campaign registration status.Possible values: UNREGISTERED,INITIATED,PENDING,DECLINED,REGISTERED. A newly created campaign defaults to INITIATED status. | |
10
+ | **registration_status** | [**SMSTollFreeCampaignRegistrationStatus**](SMSTollFreeCampaignRegistrationStatus.md) | | |
11
11
  | **date_created** | **String** | | |
12
12
  | **date_updated** | **String** | | |
13
13
  | **revision** | **Integer** | | |
@@ -0,0 +1,20 @@
1
+ # Freeclimb::SMSTollFreeCampaignRegistrationStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **UNREGISTERED** | **SMSTollFreeCampaignRegistrationStatus** | | Represented in Ruby as "UNREGISTERED" |
8
+ | **INITIATED** | **SMSTollFreeCampaignRegistrationStatus** | | Represented in Ruby as "INITIATED" |
9
+ | **PENDING** | **SMSTollFreeCampaignRegistrationStatus** | | Represented in Ruby as "PENDING" |
10
+ | **DECLINED** | **SMSTollFreeCampaignRegistrationStatus** | | Represented in Ruby as "DECLINED" |
11
+ | **REGISTERED** | **SMSTollFreeCampaignRegistrationStatus** | | Represented in Ruby as "REGISTERED" |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'freeclimb'
17
+
18
+ instance = Freeclimb::SMSTollFreeCampaignRegistrationStatus::[NAME OF ENUM]
19
+ ```
20
+
@@ -0,0 +1,34 @@
1
+ # Freeclimb::TFNCampaign
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_id** | **String** | ID of the account that created this participant. | |
8
+ | **campaign_id** | **String** | TFNCampaignId | |
9
+ | **use_case** | **String** | | |
10
+ | **registration_status** | [**SMSTollFreeCampaignRegistrationStatus**](SMSTollFreeCampaignRegistrationStatus.md) | | |
11
+ | **date_created** | **String** | | |
12
+ | **date_updated** | **String** | | |
13
+ | **date_created_iso** | **String** | | |
14
+ | **date_updated_iso** | **String** | | |
15
+ | **revision** | **Integer** | | |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'freeclimb'
21
+
22
+ instance = Freeclimb::TFNCampaign.new(
23
+ account_id: null,
24
+ campaign_id: cmptfn_387ec3f6e03b340553f35f29c8f118cdf3eae08a,
25
+ use_case: null,
26
+ registration_status: null,
27
+ date_created: null,
28
+ date_updated: null,
29
+ date_created_iso: null,
30
+ date_updated_iso: null,
31
+ revision: null
32
+ )
33
+ ```
34
+
@@ -0,0 +1,20 @@
1
+ # Freeclimb::TranscribeReason
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **INTERNAL_ERROR** | **TranscribeReason** | | Represented in Ruby as "internalError" |
8
+ | **HANGUP** | **TranscribeReason** | | Represented in Ruby as "hangup" |
9
+ | **MAX_LENGTH** | **TranscribeReason** | | Represented in Ruby as "maxLength" |
10
+ | **DIGIT** | **TranscribeReason** | | Represented in Ruby as "digit" |
11
+ | **NO_INPUT** | **TranscribeReason** | | Represented in Ruby as "noInput" |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'freeclimb'
17
+
18
+ instance = Freeclimb::TranscribeReason::[NAME OF ENUM]
19
+ ```
20
+
@@ -0,0 +1,17 @@
1
+ # Freeclimb::TranscribeTermReason
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **ERROR** | **TranscribeTermReason** | | Represented in Ruby as "error" |
8
+ | **COMPLETED** | **TranscribeTermReason** | | Represented in Ruby as "completed" |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'freeclimb'
14
+
15
+ instance = Freeclimb::TranscribeTermReason::[NAME OF ENUM]
16
+ ```
17
+
@@ -6,10 +6,10 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **action_url** | **String** | | |
8
8
  | **play_beep** | **Boolean** | | [optional][default to false] |
9
- | **record** | [**TranscribeUtteranceAllOfRecord**](TranscribeUtteranceAllOfRecord.md) | | [optional] |
9
+ | **record** | [**TranscribeUtteranceRecord**](TranscribeUtteranceRecord.md) | | [optional] |
10
10
  | **privacy_for_logging** | **Boolean** | | [optional][default to false] |
11
11
  | **privacy_for_recording** | **Boolean** | | [optional][default to false] |
12
- | **prompts** | **Array<Object>** | | [optional] |
12
+ | **prompts** | [**Array<PerclCommand>**](PerclCommand.md) | | [optional] |
13
13
 
14
14
  ## Example
15
15
 
@@ -0,0 +1,62 @@
1
+ # Freeclimb::TranscribeWebhook
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_type** | **String** | The context or reason why this request is being made. Will be transcribe - The TranscribeUtterance command has completed and its actionUrl is being invoked. | [optional] |
8
+ | **account_id** | **String** | Account ID associated with your account. | [optional] |
9
+ | **call_id** | **String** | Unique identifier for this Call, generated by FreeClimb | [optional] |
10
+ | **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
11
+ | **to** | **String** | Phone number provisioned to the customer and to which this Call is directed (in E.164 format). | [optional] |
12
+ | **recording_id** | **String** | The ID of the recording. If no recording was made due to errors or the 'saveRecording' flag being disabled this field will be set to null. | [optional] |
13
+ | **recording_url** | **String** | The URL of the recorded audio file. This URL can be used as is in a Play command to play the recording (no authentication needed). It can also be used to download the recording file via the REST API. | [optional] |
14
+ | **recording_size** | **Integer** | The size of the recording in bytes. | [optional] |
15
+ | **recording_format** | **String** | The media type of the recording. | [optional] |
16
+ | **recording_duration_ms** | **Integer** | The duration of the recorded audio in milliseconds. | [optional] |
17
+ | **term_reason** | [**TranscribeTermReason**](TranscribeTermReason.md) | | [optional] |
18
+ | **record_term_reason** | [**RecordUtteranceTermReason**](RecordUtteranceTermReason.md) | | [optional] |
19
+ | **digit** | **String** | If recordTermReason is digit, this will be the digit that was pressed. Otherwise it will be null. | [optional] |
20
+ | **privacy_for_logging** | **Boolean** | Echo back of the privacyForLogging flag as specified in the transcribe utterance command – confirmation of logging protection has been applied. Can be used by application to know it should also apply protection when handling this request. | [optional] |
21
+ | **privacy_for_recording** | **Boolean** | Echo back of the privacyForRecording flag as specified in the transcribe utterance command – confirmation of logging protection has been applied. Can be used by application to know it should also apply protection when handling this request. | [optional] |
22
+ | **barge_in_reason** | [**BargeInReason**](BargeInReason.md) | | [optional] |
23
+ | **barged_in_prompt_no** | **Integer** | | [optional] |
24
+ | **barged_in_prompt_ms** | **Integer** | duration in ms bargedInPromptNo prompt was executing until barge-in occurred. | [optional] |
25
+ | **barged_in_prompt_loop_no** | **Integer** | | [optional] |
26
+ | **barge_in_time_ms** | **Integer** | epoch time in ms | [optional] |
27
+ | **transcript** | **String** | Transcribed text of the recording. Can be empty or null. null means there was a failure in transcribing the audio, refer to transcribeReason for detailed failure reason. | [optional] |
28
+ | **transcribe_reason** | [**TranscribeReason**](TranscribeReason.md) | | [optional] |
29
+ | **transcription_duration_ms** | **Integer** | The duration of the audio being transcribed in milliseconds | [optional] |
30
+
31
+ ## Example
32
+
33
+ ```ruby
34
+ require 'freeclimb'
35
+
36
+ instance = Freeclimb::TranscribeWebhook.new(
37
+ request_type: null,
38
+ account_id: null,
39
+ call_id: null,
40
+ from: null,
41
+ to: null,
42
+ recording_id: null,
43
+ recording_url: null,
44
+ recording_size: null,
45
+ recording_format: null,
46
+ recording_duration_ms: null,
47
+ term_reason: null,
48
+ record_term_reason: null,
49
+ digit: null,
50
+ privacy_for_logging: null,
51
+ privacy_for_recording: null,
52
+ barge_in_reason: null,
53
+ barged_in_prompt_no: null,
54
+ barged_in_prompt_ms: null,
55
+ barged_in_prompt_loop_no: null,
56
+ barge_in_time_ms: null,
57
+ transcript: null,
58
+ transcribe_reason: null,
59
+ transcription_duration_ms: null
60
+ )
61
+ ```
62
+
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **_alias** | **String** | Description for this conference. Maximum 64 characters. | [optional] |
8
- | **play_beep** | [**PlayBeep**](PlayBeep.md) | | [optional][default to 'always'] |
8
+ | **play_beep** | [**PlayBeep**](PlayBeep.md) | | [optional] |
9
9
  | **status** | [**UpdateConferenceRequestStatus**](UpdateConferenceRequestStatus.md) | | [optional] |
10
10
 
11
11
  ## Example
data/docs/Webhook.md ADDED
@@ -0,0 +1,18 @@
1
+ # Freeclimb::Webhook
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_type** | **String** | Type of webhook request | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'freeclimb'
13
+
14
+ instance = Freeclimb::Webhook.new(
15
+ request_type: null
16
+ )
17
+ ```
18
+
data/freeclimb.gemspec CHANGED
@@ -8,7 +8,7 @@
8
8
  The version of the OpenAPI document: 1.0.0
9
9
  Contact: support@freeclimb.com
10
10
  Generated by: https://openapi-generator.tech
11
- OpenAPI Generator version: 5.4.0
11
+ OpenAPI Generator version: 7.9.0
12
12
 
13
13
  =end
14
14