freeclimb 3.0.2 → 4.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (336) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/Gemfile +4 -1
  4. data/Gemfile.lock +33 -19
  5. data/README.md +40 -35
  6. data/docs/AccountRequest.md +9 -8
  7. data/docs/AccountResult.md +27 -26
  8. data/docs/AccountResultAllOf.md +19 -18
  9. data/docs/AddToConference.md +25 -24
  10. data/docs/AddToConferenceAllOf.md +25 -24
  11. data/docs/ApplicationList.md +21 -20
  12. data/docs/ApplicationListAllOf.md +7 -6
  13. data/docs/ApplicationRequest.md +19 -18
  14. data/docs/ApplicationResult.md +31 -30
  15. data/docs/ApplicationResultAllOf.md +23 -22
  16. data/docs/AvailableNumber.md +19 -14
  17. data/docs/AvailableNumberList.md +21 -20
  18. data/docs/AvailableNumberListAllOf.md +7 -6
  19. data/docs/BuyIncomingNumberRequest.md +11 -10
  20. data/docs/CallList.md +21 -20
  21. data/docs/CallListAllOf.md +7 -6
  22. data/docs/CallResult.md +43 -42
  23. data/docs/CallResultAllOf.md +35 -34
  24. data/docs/Capabilities.md +26 -0
  25. data/docs/ConferenceList.md +21 -20
  26. data/docs/ConferenceListAllOf.md +7 -6
  27. data/docs/ConferenceParticipantList.md +21 -20
  28. data/docs/ConferenceParticipantListAllOf.md +7 -6
  29. data/docs/ConferenceParticipantResult.md +25 -24
  30. data/docs/ConferenceParticipantResultAllOf.md +17 -16
  31. data/docs/ConferenceResult.md +33 -32
  32. data/docs/ConferenceResultAllOf.md +25 -24
  33. data/docs/CreateConference.md +17 -16
  34. data/docs/CreateConferenceAllOf.md +17 -16
  35. data/docs/CreateConferenceRequest.md +15 -14
  36. data/docs/DefaultApi.md +1625 -647
  37. data/docs/Dequeue.md +3 -4
  38. data/docs/Enqueue.md +13 -12
  39. data/docs/EnqueueAllOf.md +13 -12
  40. data/docs/FilterLogsRequest.md +7 -6
  41. data/docs/GetDigits.md +23 -22
  42. data/docs/GetDigitsAllOf.md +23 -22
  43. data/docs/GetSpeech.md +31 -30
  44. data/docs/GetSpeechAllOf.md +31 -30
  45. data/docs/Hangup.md +7 -6
  46. data/docs/HangupAllOf.md +7 -6
  47. data/docs/IncomingNumberList.md +21 -20
  48. data/docs/IncomingNumberListAllOf.md +7 -6
  49. data/docs/IncomingNumberRequest.md +9 -8
  50. data/docs/IncomingNumberResult.md +35 -30
  51. data/docs/IncomingNumberResultAllOf.md +27 -22
  52. data/docs/LogList.md +21 -20
  53. data/docs/LogListAllOf.md +7 -6
  54. data/docs/LogResult.md +19 -18
  55. data/docs/MakeCallRequest.md +25 -24
  56. data/docs/MessageRequest.md +23 -22
  57. data/docs/MessageRequestAllOf.md +15 -14
  58. data/docs/MessageResult.md +29 -28
  59. data/docs/MessageResultAllOf.md +21 -20
  60. data/docs/MessagesList.md +21 -20
  61. data/docs/MessagesListAllOf.md +7 -6
  62. data/docs/MutableResourceModel.md +13 -12
  63. data/docs/OutDial.md +25 -24
  64. data/docs/OutDialAllOf.md +25 -24
  65. data/docs/PaginationModel.md +19 -18
  66. data/docs/Park.md +22 -0
  67. data/docs/ParkAllOf.md +22 -0
  68. data/docs/Pause.md +7 -6
  69. data/docs/PauseAllOf.md +7 -6
  70. data/docs/PerclCommand.md +7 -6
  71. data/docs/PerclScript.md +7 -6
  72. data/docs/Play.md +13 -12
  73. data/docs/PlayAllOf.md +13 -12
  74. data/docs/PlayEarlyMedia.md +7 -6
  75. data/docs/PlayEarlyMediaAllOf.md +7 -6
  76. data/docs/QueueList.md +21 -20
  77. data/docs/QueueListAllOf.md +7 -6
  78. data/docs/QueueMember.md +15 -14
  79. data/docs/QueueMemberList.md +21 -20
  80. data/docs/QueueMemberListAllOf.md +7 -6
  81. data/docs/QueueRequest.md +9 -8
  82. data/docs/QueueResult.md +27 -26
  83. data/docs/QueueResultAllOf.md +19 -18
  84. data/docs/RecordUtterance.md +19 -18
  85. data/docs/RecordUtteranceAllOf.md +19 -18
  86. data/docs/RecordingList.md +21 -20
  87. data/docs/RecordingListAllOf.md +7 -6
  88. data/docs/RecordingResult.md +23 -22
  89. data/docs/RecordingResultAllOf.md +15 -14
  90. data/docs/Redirect.md +7 -6
  91. data/docs/RedirectAllOf.md +7 -6
  92. data/docs/Reject.md +7 -6
  93. data/docs/RejectAllOf.md +7 -6
  94. data/docs/RemoveFromConference.md +7 -6
  95. data/docs/RemoveFromConferenceAllOf.md +7 -6
  96. data/docs/Say.md +15 -14
  97. data/docs/SayAllOf.md +15 -14
  98. data/docs/SendDigits.md +11 -10
  99. data/docs/SendDigitsAllOf.md +11 -10
  100. data/docs/SetListen.md +9 -8
  101. data/docs/SetListenAllOf.md +9 -8
  102. data/docs/SetTalk.md +9 -8
  103. data/docs/SetTalkAllOf.md +9 -8
  104. data/docs/Sms.md +13 -12
  105. data/docs/SmsAllOf.md +13 -12
  106. data/docs/StartRecordCall.md +3 -4
  107. data/docs/TerminateConference.md +7 -6
  108. data/docs/TerminateConferenceAllOf.md +7 -6
  109. data/docs/Unpark.md +15 -0
  110. data/docs/UpdateCallRequest.md +7 -6
  111. data/docs/UpdateConferenceParticipantRequest.md +9 -8
  112. data/docs/UpdateConferenceRequest.md +11 -10
  113. data/freeclimb.gemspec +3 -4
  114. data/lib/freeclimb/api/default_api.rb +434 -278
  115. data/lib/freeclimb/api_client.rb +55 -51
  116. data/lib/freeclimb/api_error.rb +2 -2
  117. data/lib/freeclimb/configuration.rb +41 -11
  118. data/lib/freeclimb/models/account_request.rb +20 -8
  119. data/lib/freeclimb/models/account_result.rb +39 -8
  120. data/lib/freeclimb/models/account_result_all_of.rb +39 -8
  121. data/lib/freeclimb/models/add_to_conference.rb +21 -8
  122. data/lib/freeclimb/models/add_to_conference_all_of.rb +20 -8
  123. data/lib/freeclimb/models/application_list.rb +28 -8
  124. data/lib/freeclimb/models/application_list_all_of.rb +21 -8
  125. data/lib/freeclimb/models/application_request.rb +20 -8
  126. data/lib/freeclimb/models/application_result.rb +29 -8
  127. data/lib/freeclimb/models/application_result_all_of.rb +29 -8
  128. data/lib/freeclimb/models/available_number.rb +46 -9
  129. data/lib/freeclimb/models/available_number_list.rb +28 -8
  130. data/lib/freeclimb/models/available_number_list_all_of.rb +21 -8
  131. data/lib/freeclimb/models/buy_incoming_number_request.rb +20 -8
  132. data/lib/freeclimb/models/call_list.rb +28 -8
  133. data/lib/freeclimb/models/call_list_all_of.rb +21 -8
  134. data/lib/freeclimb/models/call_result.rb +35 -8
  135. data/lib/freeclimb/models/call_result_all_of.rb +35 -8
  136. data/lib/freeclimb/models/capabilities.rb +265 -0
  137. data/lib/freeclimb/models/conference_list.rb +28 -8
  138. data/lib/freeclimb/models/conference_list_all_of.rb +21 -8
  139. data/lib/freeclimb/models/conference_participant_list.rb +28 -8
  140. data/lib/freeclimb/models/conference_participant_list_all_of.rb +21 -8
  141. data/lib/freeclimb/models/conference_participant_result.rb +26 -8
  142. data/lib/freeclimb/models/conference_participant_result_all_of.rb +26 -8
  143. data/lib/freeclimb/models/conference_result.rb +30 -8
  144. data/lib/freeclimb/models/conference_result_all_of.rb +30 -8
  145. data/lib/freeclimb/models/create_conference.rb +21 -8
  146. data/lib/freeclimb/models/create_conference_all_of.rb +20 -8
  147. data/lib/freeclimb/models/create_conference_request.rb +20 -8
  148. data/lib/freeclimb/models/dequeue.rb +21 -8
  149. data/lib/freeclimb/models/enqueue.rb +21 -8
  150. data/lib/freeclimb/models/enqueue_all_of.rb +20 -8
  151. data/lib/freeclimb/models/filter_logs_request.rb +20 -8
  152. data/lib/freeclimb/models/get_digits.rb +21 -8
  153. data/lib/freeclimb/models/get_digits_all_of.rb +20 -8
  154. data/lib/freeclimb/models/get_speech.rb +21 -8
  155. data/lib/freeclimb/models/get_speech_all_of.rb +20 -8
  156. data/lib/freeclimb/models/hangup.rb +21 -8
  157. data/lib/freeclimb/models/hangup_all_of.rb +20 -8
  158. data/lib/freeclimb/models/incoming_number_list.rb +28 -8
  159. data/lib/freeclimb/models/incoming_number_list_all_of.rb +21 -8
  160. data/lib/freeclimb/models/incoming_number_request.rb +20 -8
  161. data/lib/freeclimb/models/incoming_number_result.rb +50 -9
  162. data/lib/freeclimb/models/incoming_number_result_all_of.rb +50 -9
  163. data/lib/freeclimb/models/log_list.rb +28 -8
  164. data/lib/freeclimb/models/log_list_all_of.rb +21 -8
  165. data/lib/freeclimb/models/log_result.rb +27 -8
  166. data/lib/freeclimb/models/make_call_request.rb +22 -8
  167. data/lib/freeclimb/models/message_request.rb +20 -8
  168. data/lib/freeclimb/models/message_request_all_of.rb +20 -8
  169. data/lib/freeclimb/models/message_result.rb +28 -8
  170. data/lib/freeclimb/models/message_result_all_of.rb +28 -8
  171. data/lib/freeclimb/models/messages_list.rb +28 -8
  172. data/lib/freeclimb/models/messages_list_all_of.rb +21 -8
  173. data/lib/freeclimb/models/mutable_resource_model.rb +20 -8
  174. data/lib/freeclimb/models/out_dial.rb +21 -8
  175. data/lib/freeclimb/models/out_dial_all_of.rb +20 -8
  176. data/lib/freeclimb/models/pagination_model.rb +27 -8
  177. data/lib/freeclimb/models/park.rb +263 -0
  178. data/lib/freeclimb/models/park_all_of.rb +249 -0
  179. data/lib/freeclimb/models/pause.rb +21 -8
  180. data/lib/freeclimb/models/pause_all_of.rb +20 -8
  181. data/lib/freeclimb/models/percl_command.rb +38 -8
  182. data/lib/freeclimb/models/percl_script.rb +24 -8
  183. data/lib/freeclimb/models/play.rb +21 -8
  184. data/lib/freeclimb/models/play_all_of.rb +20 -8
  185. data/lib/freeclimb/models/play_early_media.rb +21 -8
  186. data/lib/freeclimb/models/play_early_media_all_of.rb +20 -8
  187. data/lib/freeclimb/models/queue_list.rb +28 -8
  188. data/lib/freeclimb/models/queue_list_all_of.rb +21 -8
  189. data/lib/freeclimb/models/queue_member.rb +25 -8
  190. data/lib/freeclimb/models/queue_member_list.rb +28 -8
  191. data/lib/freeclimb/models/queue_member_list_all_of.rb +21 -8
  192. data/lib/freeclimb/models/queue_request.rb +22 -8
  193. data/lib/freeclimb/models/queue_result.rb +27 -8
  194. data/lib/freeclimb/models/queue_result_all_of.rb +27 -8
  195. data/lib/freeclimb/models/record_utterance.rb +21 -8
  196. data/lib/freeclimb/models/record_utterance_all_of.rb +20 -8
  197. data/lib/freeclimb/models/recording_list.rb +28 -8
  198. data/lib/freeclimb/models/recording_list_all_of.rb +21 -8
  199. data/lib/freeclimb/models/recording_result.rb +25 -8
  200. data/lib/freeclimb/models/recording_result_all_of.rb +25 -8
  201. data/lib/freeclimb/models/redirect.rb +21 -8
  202. data/lib/freeclimb/models/redirect_all_of.rb +20 -8
  203. data/lib/freeclimb/models/reject.rb +21 -8
  204. data/lib/freeclimb/models/reject_all_of.rb +20 -8
  205. data/lib/freeclimb/models/remove_from_conference.rb +21 -8
  206. data/lib/freeclimb/models/remove_from_conference_all_of.rb +20 -8
  207. data/lib/freeclimb/models/say.rb +23 -8
  208. data/lib/freeclimb/models/say_all_of.rb +22 -8
  209. data/lib/freeclimb/models/send_digits.rb +21 -8
  210. data/lib/freeclimb/models/send_digits_all_of.rb +20 -8
  211. data/lib/freeclimb/models/set_listen.rb +21 -8
  212. data/lib/freeclimb/models/set_listen_all_of.rb +20 -8
  213. data/lib/freeclimb/models/set_talk.rb +21 -8
  214. data/lib/freeclimb/models/set_talk_all_of.rb +20 -8
  215. data/lib/freeclimb/models/sms.rb +21 -8
  216. data/lib/freeclimb/models/sms_all_of.rb +20 -8
  217. data/lib/freeclimb/models/start_record_call.rb +21 -8
  218. data/lib/freeclimb/models/terminate_conference.rb +21 -8
  219. data/lib/freeclimb/models/terminate_conference_all_of.rb +20 -8
  220. data/lib/freeclimb/models/unpark.rb +222 -0
  221. data/lib/freeclimb/models/update_call_request.rb +20 -8
  222. data/lib/freeclimb/models/update_conference_participant_request.rb +20 -8
  223. data/lib/freeclimb/models/update_conference_request.rb +20 -8
  224. data/lib/freeclimb/version.rb +3 -3
  225. data/lib/freeclimb.rb +28 -52
  226. data/spec/api/default_api_spec.rb +1004 -21
  227. data/spec/api_client_spec.rb +5 -5
  228. data/spec/configuration_spec.rb +10 -10
  229. data/spec/factories.rb +80 -0
  230. data/spec/models/account_request_spec.rb +5 -12
  231. data/spec/models/account_result_spec.rb +10 -13
  232. data/spec/models/add_to_conference_spec.rb +5 -12
  233. data/spec/models/application_list_spec.rb +5 -12
  234. data/spec/models/application_request_spec.rb +5 -12
  235. data/spec/models/application_result_spec.rb +5 -12
  236. data/spec/models/available_number_list_spec.rb +5 -12
  237. data/spec/models/available_number_spec.rb +11 -12
  238. data/spec/models/buy_incoming_number_request_spec.rb +5 -12
  239. data/spec/models/call_list_spec.rb +5 -12
  240. data/spec/models/call_result_spec.rb +6 -13
  241. data/spec/models/{say_all_of_spec.rb → capabilities_spec.rb} +13 -20
  242. data/spec/models/conference_list_spec.rb +5 -12
  243. data/spec/models/conference_participant_list_spec.rb +5 -12
  244. data/spec/models/conference_participant_result_spec.rb +5 -12
  245. data/spec/models/conference_result_spec.rb +7 -14
  246. data/spec/models/create_conference_request_spec.rb +6 -13
  247. data/spec/models/create_conference_spec.rb +5 -12
  248. data/spec/models/dequeue_spec.rb +5 -12
  249. data/spec/models/enqueue_spec.rb +5 -12
  250. data/spec/models/filter_logs_request_spec.rb +5 -12
  251. data/spec/models/get_digits_spec.rb +5 -12
  252. data/spec/models/get_speech_spec.rb +5 -12
  253. data/spec/models/hangup_spec.rb +5 -12
  254. data/spec/models/incoming_number_list_spec.rb +5 -12
  255. data/spec/models/incoming_number_request_spec.rb +5 -12
  256. data/spec/models/incoming_number_result_spec.rb +11 -12
  257. data/spec/models/log_list_spec.rb +5 -12
  258. data/spec/models/log_result_spec.rb +6 -13
  259. data/spec/models/make_call_request_spec.rb +5 -12
  260. data/spec/models/message_request_spec.rb +5 -12
  261. data/spec/models/message_result_spec.rb +6 -13
  262. data/spec/models/messages_list_spec.rb +5 -12
  263. data/spec/models/mutable_resource_model_spec.rb +5 -12
  264. data/spec/models/out_dial_spec.rb +5 -12
  265. data/spec/models/pagination_model_spec.rb +5 -12
  266. data/spec/models/{enqueue_all_of_spec.rb → park_spec.rb} +11 -24
  267. data/spec/models/pause_spec.rb +5 -12
  268. data/spec/models/percl_command_spec.rb +5 -12
  269. data/spec/models/percl_script_spec.rb +5 -12
  270. data/spec/models/play_early_media_spec.rb +5 -12
  271. data/spec/models/play_spec.rb +5 -12
  272. data/spec/models/queue_list_spec.rb +5 -12
  273. data/spec/models/queue_member_list_spec.rb +5 -12
  274. data/spec/models/queue_member_spec.rb +5 -12
  275. data/spec/models/queue_request_spec.rb +5 -12
  276. data/spec/models/queue_result_spec.rb +5 -12
  277. data/spec/models/record_utterance_spec.rb +5 -12
  278. data/spec/models/recording_list_spec.rb +5 -12
  279. data/spec/models/recording_result_spec.rb +5 -12
  280. data/spec/models/redirect_spec.rb +5 -12
  281. data/spec/models/reject_spec.rb +5 -12
  282. data/spec/models/remove_from_conference_spec.rb +5 -12
  283. data/spec/models/say_spec.rb +5 -12
  284. data/spec/models/send_digits_spec.rb +5 -12
  285. data/spec/models/set_listen_spec.rb +5 -12
  286. data/spec/models/set_talk_spec.rb +5 -12
  287. data/spec/models/sms_spec.rb +5 -12
  288. data/spec/models/start_record_call_spec.rb +5 -12
  289. data/spec/models/terminate_conference_spec.rb +5 -12
  290. data/spec/models/{pause_all_of_spec.rb → unpark_spec.rb} +8 -21
  291. data/spec/models/update_call_request_spec.rb +6 -13
  292. data/spec/models/update_conference_participant_request_spec.rb +5 -12
  293. data/spec/models/update_conference_request_spec.rb +6 -13
  294. data/spec/quickstart_spec.rb +10 -0
  295. data/spec/spec_helper.rb +61 -2
  296. metadata +75 -162
  297. data/lib/freeclimb/utils.rb +0 -34
  298. data/spec/api/web_mocks.rb +0 -473
  299. data/spec/models/account_result_all_of_spec.rb +0 -81
  300. data/spec/models/add_to_conference_all_of_spec.rb +0 -95
  301. data/spec/models/application_list_all_of_spec.rb +0 -41
  302. data/spec/models/application_result_all_of_spec.rb +0 -89
  303. data/spec/models/available_number_list_all_of_spec.rb +0 -41
  304. data/spec/models/call_list_all_of_spec.rb +0 -41
  305. data/spec/models/call_result_all_of_spec.rb +0 -129
  306. data/spec/models/conference_list_all_of_spec.rb +0 -41
  307. data/spec/models/conference_participant_list_all_of_spec.rb +0 -41
  308. data/spec/models/conference_participant_result_all_of_spec.rb +0 -71
  309. data/spec/models/conference_result_all_of_spec.rb +0 -103
  310. data/spec/models/create_conference_all_of_spec.rb +0 -71
  311. data/spec/models/get_digits_all_of_spec.rb +0 -89
  312. data/spec/models/get_speech_all_of_spec.rb +0 -113
  313. data/spec/models/hangup_all_of_spec.rb +0 -41
  314. data/spec/models/incoming_number_list_all_of_spec.rb +0 -41
  315. data/spec/models/incoming_number_result_all_of_spec.rb +0 -89
  316. data/spec/models/log_list_all_of_spec.rb +0 -41
  317. data/spec/models/message_request_all_of_spec.rb +0 -65
  318. data/spec/models/message_result_all_of_spec.rb +0 -87
  319. data/spec/models/messages_list_all_of_spec.rb +0 -41
  320. data/spec/models/out_dial_all_of_spec.rb +0 -95
  321. data/spec/models/play_all_of_spec.rb +0 -59
  322. data/spec/models/play_early_media_all_of_spec.rb +0 -41
  323. data/spec/models/queue_list_all_of_spec.rb +0 -41
  324. data/spec/models/queue_member_list_all_of_spec.rb +0 -41
  325. data/spec/models/queue_result_all_of_spec.rb +0 -77
  326. data/spec/models/record_utterance_all_of_spec.rb +0 -77
  327. data/spec/models/recording_list_all_of_spec.rb +0 -41
  328. data/spec/models/recording_result_all_of_spec.rb +0 -65
  329. data/spec/models/redirect_all_of_spec.rb +0 -41
  330. data/spec/models/reject_all_of_spec.rb +0 -41
  331. data/spec/models/remove_from_conference_all_of_spec.rb +0 -41
  332. data/spec/models/send_digits_all_of_spec.rb +0 -53
  333. data/spec/models/set_listen_all_of_spec.rb +0 -47
  334. data/spec/models/set_talk_all_of_spec.rb +0 -47
  335. data/spec/models/sms_all_of_spec.rb +0 -59
  336. data/spec/models/terminate_conference_all_of_spec.rb +0 -41
@@ -2,40 +2,45 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional]
8
- **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
9
- **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
10
- **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional]
11
- **phone_number_id** | **String** | String that uniquely identifies this phone number resource. | [optional]
12
- **account_id** | **String** | ID of the account that owns this phone number. | [optional]
13
- **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]
14
- **phone_number** | **String** | Phone number in E.164 format. | [optional]
15
- **_alias** | **String** | Description for this phone number. Typically the conventionally-formatted version of the phone number. | [optional]
16
- **region** | **String** | State or province of this phone number. | [optional]
17
- **country** | **String** | Country of this phone number. | [optional]
18
- **voice_enabled** | **Boolean** | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional]
19
- **sms_enabled** | **Boolean** | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional] |
8
+ | **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
9
+ | **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
10
+ | **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional] |
11
+ | **capabilities** | [**Capabilities**](Capabilities.md) | | [optional] |
12
+ | **campaign_id** | **String** | The campaign ID generated by the campaign registry | [optional] |
13
+ | **phone_number_id** | **String** | String that uniquely identifies this phone number resource. | [optional] |
14
+ | **account_id** | **String** | ID of the account that owns this phone number. | [optional] |
15
+ | **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] |
16
+ | **phone_number** | **String** | Phone number in E.164 format. | [optional] |
17
+ | **_alias** | **String** | Description for this phone number. Typically the conventionally-formatted version of the phone number. | [optional] |
18
+ | **region** | **String** | State or province of this phone number. | [optional] |
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] |
20
22
 
21
- ## Code Sample
23
+ ## Example
22
24
 
23
25
  ```ruby
24
26
  require 'freeclimb'
25
27
 
26
- instance = Freeclimb::IncomingNumberResult.new(uri: nil,
27
- date_created: nil,
28
- date_updated: nil,
29
- revision: nil,
30
- phone_number_id: nil,
31
- account_id: nil,
32
- application_id: nil,
33
- phone_number: nil,
34
- _alias: nil,
35
- region: nil,
36
- country: nil,
37
- voice_enabled: nil,
38
- sms_enabled: nil)
28
+ instance = Freeclimb::IncomingNumberResult.new(
29
+ uri: null,
30
+ date_created: null,
31
+ date_updated: null,
32
+ revision: null,
33
+ capabilities: null,
34
+ campaign_id: null,
35
+ phone_number_id: null,
36
+ account_id: null,
37
+ application_id: null,
38
+ phone_number: null,
39
+ _alias: null,
40
+ region: null,
41
+ country: null,
42
+ voice_enabled: null,
43
+ sms_enabled: null
44
+ )
39
45
  ```
40
46
 
41
-
@@ -2,32 +2,37 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **phone_number_id** | **String** | String that uniquely identifies this phone number resource. | [optional]
8
- **account_id** | **String** | ID of the account that owns this phone number. | [optional]
9
- **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]
10
- **phone_number** | **String** | Phone number in E.164 format. | [optional]
11
- **_alias** | **String** | Description for this phone number. Typically the conventionally-formatted version of the phone number. | [optional]
12
- **region** | **String** | State or province of this phone number. | [optional]
13
- **country** | **String** | Country of this phone number. | [optional]
14
- **voice_enabled** | **Boolean** | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional]
15
- **sms_enabled** | **Boolean** | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **capabilities** | [**Capabilities**](Capabilities.md) | | [optional] |
8
+ | **campaign_id** | **String** | The campaign ID generated by the campaign registry | [optional] |
9
+ | **phone_number_id** | **String** | String that uniquely identifies this phone number resource. | [optional] |
10
+ | **account_id** | **String** | ID of the account that owns this phone number. | [optional] |
11
+ | **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] |
12
+ | **phone_number** | **String** | Phone number in E.164 format. | [optional] |
13
+ | **_alias** | **String** | Description for this phone number. Typically the conventionally-formatted version of the phone number. | [optional] |
14
+ | **region** | **String** | State or province of this phone number. | [optional] |
15
+ | **country** | **String** | Country of this phone number. | [optional] |
16
+ | **voice_enabled** | **Boolean** | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional] |
17
+ | **sms_enabled** | **Boolean** | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional] |
16
18
 
17
- ## Code Sample
19
+ ## Example
18
20
 
19
21
  ```ruby
20
22
  require 'freeclimb'
21
23
 
22
- instance = Freeclimb::IncomingNumberResultAllOf.new(phone_number_id: nil,
23
- account_id: nil,
24
- application_id: nil,
25
- phone_number: nil,
26
- _alias: nil,
27
- region: nil,
28
- country: nil,
29
- voice_enabled: nil,
30
- sms_enabled: nil)
24
+ instance = Freeclimb::IncomingNumberResultAllOf.new(
25
+ capabilities: null,
26
+ campaign_id: null,
27
+ phone_number_id: null,
28
+ account_id: null,
29
+ application_id: null,
30
+ phone_number: null,
31
+ _alias: null,
32
+ region: null,
33
+ country: null,
34
+ voice_enabled: null,
35
+ sms_enabled: null
36
+ )
31
37
  ```
32
38
 
33
-
data/docs/LogList.md CHANGED
@@ -2,30 +2,31 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **total** | **Integer** | Total amount of requested resource. | [optional]
8
- **start** | **Integer** | Resource index at start of current page | [optional]
9
- **_end** | **Integer** | Resource index at end of current page | [optional]
10
- **page** | **Integer** | Current page | [optional]
11
- **num_pages** | **Integer** | Total number of pages | [optional]
12
- **page_size** | **Integer** | Number of items per page | [optional]
13
- **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional]
14
- **logs** | [**Array<LogResult>**](LogResult.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **total** | **Integer** | Total amount of requested resource. | [optional] |
8
+ | **start** | **Integer** | Resource index at start of current page | [optional] |
9
+ | **_end** | **Integer** | Resource index at end of current page | [optional] |
10
+ | **page** | **Integer** | Current page | [optional] |
11
+ | **num_pages** | **Integer** | Total number of pages | [optional] |
12
+ | **page_size** | **Integer** | Number of items per page | [optional] |
13
+ | **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional] |
14
+ | **logs** | [**Array<LogResult>**](LogResult.md) | | [optional] |
15
15
 
16
- ## Code Sample
16
+ ## Example
17
17
 
18
18
  ```ruby
19
19
  require 'freeclimb'
20
20
 
21
- instance = Freeclimb::LogList.new(total: nil,
22
- start: nil,
23
- _end: nil,
24
- page: nil,
25
- num_pages: nil,
26
- page_size: nil,
27
- next_page_uri: nil,
28
- logs: nil)
21
+ instance = Freeclimb::LogList.new(
22
+ total: null,
23
+ start: null,
24
+ _end: null,
25
+ page: null,
26
+ num_pages: null,
27
+ page_size: null,
28
+ next_page_uri: null,
29
+ logs: null
30
+ )
29
31
  ```
30
32
 
31
-
data/docs/LogListAllOf.md CHANGED
@@ -2,16 +2,17 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **logs** | [**Array<LogResult>**](LogResult.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **logs** | [**Array<LogResult>**](LogResult.md) | | [optional] |
8
8
 
9
- ## Code Sample
9
+ ## Example
10
10
 
11
11
  ```ruby
12
12
  require 'freeclimb'
13
13
 
14
- instance = Freeclimb::LogListAllOf.new(logs: nil)
14
+ instance = Freeclimb::LogListAllOf.new(
15
+ logs: null
16
+ )
15
17
  ```
16
18
 
17
-
data/docs/LogResult.md CHANGED
@@ -2,28 +2,29 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **timestamp** | **Integer** | Time that the log was generated. The time is represented as microseconds since the Unix Epoch. | [optional]
8
- **level** | **String** | Level of the log. Possible values are info, warning, and error. | [optional]
9
- **request_id** | **String** | ID of the request associated with the log. The requestId is propagated across all logs generated by FreeClimb when processing a request. | [optional]
10
- **account_id** | **String** | ID of the account that this log was generated under. | [optional]
11
- **call_id** | **String** | ID of the Call associated with the log. Can be set to null if the log was generated without regard to a specific Call. | [optional]
12
- **message** | **String** | A simple string describing the event being logged. | [optional]
13
- **metadata** | [**Object**](.md) | JSON document containing metadata about the event. Some log messages may include request and response header content in this field. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **timestamp** | **Integer** | Time that the log was generated. The time is represented as microseconds since the Unix Epoch. | [optional] |
8
+ | **level** | **String** | Level of the log. Possible values are info, warning, and error. | [optional] |
9
+ | **request_id** | **String** | ID of the request associated with the log. The requestId is propagated across all logs generated by FreeClimb when processing a request. | [optional] |
10
+ | **account_id** | **String** | ID of the account that this log was generated under. | [optional] |
11
+ | **call_id** | **String** | ID of the Call associated with the log. Can be set to null if the log was generated without regard to a specific Call. | [optional] |
12
+ | **message** | **String** | A simple string describing the event being logged. | [optional] |
13
+ | **metadata** | **Object** | JSON document containing metadata about the event. Some log messages may include request and response header content in this field. | [optional] |
14
14
 
15
- ## Code Sample
15
+ ## Example
16
16
 
17
17
  ```ruby
18
18
  require 'freeclimb'
19
19
 
20
- instance = Freeclimb::LogResult.new(timestamp: nil,
21
- level: nil,
22
- request_id: nil,
23
- account_id: nil,
24
- call_id: nil,
25
- message: nil,
26
- metadata: nil)
20
+ instance = Freeclimb::LogResult.new(
21
+ timestamp: null,
22
+ level: null,
23
+ request_id: null,
24
+ account_id: null,
25
+ call_id: null,
26
+ message: null,
27
+ metadata: null
28
+ )
27
29
  ```
28
30
 
29
-
@@ -2,34 +2,35 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **from** | **String** | Phone number to use as the caller ID. This can be: (a) The To or From number provided in FreeClimb's initial request to your app or (b) Any incoming phone number you have purchased from FreeClimb. |
8
- **to** | **String** | Phone number to place the Call to. |
9
- **application_id** | **String** | Required if no `parentCallId` or `callConnectUrl` has been provided. ID of the application FreeClimb should use to handle this phone call. FreeClimb will use the `callConnectUrl` and `statusCallbackUrl` set on the application unless the `callConnectUrl` attribute is also provided with the request. In this case, the URL specified in that `callConnectUrl` attribute will be used as a replacement of the `callConnectUrl` originally assigned in the application. If the `callConnectUrl` is not set as either an attribute of the request or as part of the specified application, an error will be provided. The application’s voiceUrl parameter is not used for outbound calls. | [optional]
10
- **send_digits** | **String** | String of digits to dial after connecting to the number. It can include digits `0-9`, `*`, and `#`, and allows embedding a pause between the output of individual digits. The default pause is 500 milliseconds. So, a string such as *1234#* will be played in 2 seconds because of the 4 standard pauses implied within the string. A custom pause is specified by including a positive integer wrapped in curly braces: {n}. For more information, see **sendDigits examples** below. | [optional]
11
- **if_machine** | **String** | Specifies how FreeClimb should handle this Call if an answering machine answers it. | [optional]
12
- **if_machine_url** | **String** | This attribute specifies a URL to which FreeClimb will make a POST request when an answering machine or a fax machine is detected. This URL is required if the ifMachine flag is set to redirect. When ifMachine is set to hangup, ifMachineUrl must not be included in the request. For more information, see **ifMachineUrl example** below. | [optional]
13
- **timeout** | **Integer** | Number of seconds that FreeClimb should allow the phone to ring before assuming there is no answer. Default is 30 seconds. Maximum allowed ring-time is determined by the target phone's provider. Note that most providers limit ring-time to 120 seconds. | [optional]
14
- **parent_call_id** | **String** | Required if no `applicationId` or `callConnectUrl` has been provided. The ID of the parent Call in the case that this new Call is meant to be treated as a child of an existing Call. This attribute should be included when possible to reduce latency when adding child calls to Conferences containing the parent Call. A call can only be used as a parent once the call is in progress or as an inbound call that is still ringing. An outbound call is considered to be in progress once the `outdialConnect` or `outdialApiConnect` webhook is invoked. An inbound call is ringing when the inbound webhook is invoked. If a `callConnectUrl` attribute is also included with the `parentCallId` in the request, this URL will be used as a replacement of the `callConnectUrl` originally assigned in the parent call. | [optional]
15
- **privacy_mode** | **Boolean** | Activate privacy mode in order to obscure log data that can potentially expose private information. | [optional]
16
- **call_connect_url** | **String** | The URL that FreeClimb should use to handle this phone call. If an applicationId or parentCallId have already been provided, this callConnectUrl attribute will be used as a replacement of the callConnectUrl originally assigned in the application or parent call. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **from** | **String** | Phone number to use as the caller ID. This can be: (a) The To or From number provided in FreeClimb's initial request to your app or (b) Any incoming phone number you have purchased from FreeClimb. | |
8
+ | **to** | **String** | Phone number to place the Call to. | |
9
+ | **application_id** | **String** | Required if no `parentCallId` or `callConnectUrl` has been provided. ID of the application FreeClimb should use to handle this phone call. FreeClimb will use the `callConnectUrl` and `statusCallbackUrl` set on the application unless the `callConnectUrl` attribute is also provided with the request. In this case, the URL specified in that `callConnectUrl` attribute will be used as a replacement of the `callConnectUrl` originally assigned in the application. If the `callConnectUrl` is not set as either an attribute of the request or as part of the specified application, an error will be provided. The application’s voiceUrl parameter is not used for outbound calls. | [optional] |
10
+ | **send_digits** | **String** | String of digits to dial after connecting to the number. It can include digits `0-9`, `*`, and `#`, and allows embedding a pause between the output of individual digits. The default pause is 500 milliseconds. So, a string such as *1234#* will be played in 2 seconds because of the 4 standard pauses implied within the string. A custom pause is specified by including a positive integer wrapped in curly braces: {n}. For more information, see **sendDigits examples** below. | [optional] |
11
+ | **if_machine** | **String** | Specifies how FreeClimb should handle this Call if an answering machine answers it. | [optional] |
12
+ | **if_machine_url** | **String** | This attribute specifies a URL to which FreeClimb will make a POST request when an answering machine or a fax machine is detected. This URL is required if the ifMachine flag is set to redirect. When ifMachine is set to hangup, ifMachineUrl must not be included in the request. For more information, see **ifMachineUrl example** below. | [optional] |
13
+ | **timeout** | **Integer** | Number of seconds that FreeClimb should allow the phone to ring before assuming there is no answer. Default is 30 seconds. Maximum allowed ring-time is determined by the target phone's provider. Note that most providers limit ring-time to 120 seconds. | [optional][default to 30] |
14
+ | **parent_call_id** | **String** | Required if no `applicationId` or `callConnectUrl` has been provided. The ID of the parent Call in the case that this new Call is meant to be treated as a child of an existing Call. This attribute should be included when possible to reduce latency when adding child calls to Conferences containing the parent Call. A call can only be used as a parent once the call is in progress or as an inbound call that is still ringing. An outbound call is considered to be in progress once the `outdialConnect` or `outdialApiConnect` webhook is invoked. An inbound call is ringing when the inbound webhook is invoked. If a `callConnectUrl` attribute is also included with the `parentCallId` in the request, this URL will be used as a replacement of the `callConnectUrl` originally assigned in the parent call. | [optional] |
15
+ | **privacy_mode** | **Boolean** | Activate privacy mode in order to obscure log data that can potentially expose private information. | [optional] |
16
+ | **call_connect_url** | **String** | The URL that FreeClimb should use to handle this phone call. If an applicationId or parentCallId have already been provided, this callConnectUrl attribute will be used as a replacement of the callConnectUrl originally assigned in the application or parent call. | [optional] |
17
17
 
18
- ## Code Sample
18
+ ## Example
19
19
 
20
20
  ```ruby
21
21
  require 'freeclimb'
22
22
 
23
- instance = Freeclimb::MakeCallRequest.new(from: nil,
24
- to: nil,
25
- application_id: nil,
26
- send_digits: nil,
27
- if_machine: nil,
28
- if_machine_url: nil,
29
- timeout: nil,
30
- parent_call_id: nil,
31
- privacy_mode: nil,
32
- call_connect_url: nil)
23
+ instance = Freeclimb::MakeCallRequest.new(
24
+ from: null,
25
+ to: null,
26
+ application_id: null,
27
+ send_digits: null,
28
+ if_machine: null,
29
+ if_machine_url: null,
30
+ timeout: null,
31
+ parent_call_id: null,
32
+ privacy_mode: null,
33
+ call_connect_url: null
34
+ )
33
35
  ```
34
36
 
35
-
@@ -2,32 +2,33 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional]
8
- **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
9
- **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
10
- **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional]
11
- **from** | **String** | Phone number to use as the sender. This must be an incoming phone number that you have purchased from FreeClimb. |
12
- **to** | **String** | Phone number to receive the message. Must be within FreeClimb's service area. |
13
- **text** | **String** | Text contained in the message (maximum 160 characters). **Note:** For text, only ASCII characters are supported. |
14
- **notification_url** | **String** | When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters. **Note:** This is a notification only; any PerCL returned is ignored. | [optional]
15
- **account_id** | **String** | String that uniquely identifies this account resource. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional] |
8
+ | **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
9
+ | **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
10
+ | **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional] |
11
+ | **from** | **String** | Phone number to use as the sender. This must be an incoming phone number that you have purchased from FreeClimb. | |
12
+ | **to** | **String** | Phone number to receive the message. Must be within FreeClimb's service area. | |
13
+ | **text** | **String** | Text contained in the message (maximum 160 characters). **Note:** For text, only ASCII characters are supported. | |
14
+ | **notification_url** | **String** | When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters. **Note:** This is a notification only; any PerCL returned is ignored. | [optional] |
15
+ | **account_id** | **String** | String that uniquely identifies this account resource. | [optional] |
16
16
 
17
- ## Code Sample
17
+ ## Example
18
18
 
19
19
  ```ruby
20
20
  require 'freeclimb'
21
21
 
22
- instance = Freeclimb::MessageRequest.new(uri: nil,
23
- date_created: nil,
24
- date_updated: nil,
25
- revision: nil,
26
- from: nil,
27
- to: nil,
28
- text: nil,
29
- notification_url: nil,
30
- account_id: nil)
22
+ instance = Freeclimb::MessageRequest.new(
23
+ uri: null,
24
+ date_created: null,
25
+ date_updated: null,
26
+ revision: null,
27
+ from: null,
28
+ to: null,
29
+ text: null,
30
+ notification_url: null,
31
+ account_id: null
32
+ )
31
33
  ```
32
34
 
33
-
@@ -2,24 +2,25 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **from** | **String** | Phone number to use as the sender. This must be an incoming phone number that you have purchased from FreeClimb. |
8
- **to** | **String** | Phone number to receive the message. Must be within FreeClimb's service area. |
9
- **text** | **String** | Text contained in the message (maximum 160 characters). **Note:** For text, only ASCII characters are supported. |
10
- **notification_url** | **String** | When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters. **Note:** This is a notification only; any PerCL returned is ignored. | [optional]
11
- **account_id** | **String** | String that uniquely identifies this account resource. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **from** | **String** | Phone number to use as the sender. This must be an incoming phone number that you have purchased from FreeClimb. | |
8
+ | **to** | **String** | Phone number to receive the message. Must be within FreeClimb's service area. | |
9
+ | **text** | **String** | Text contained in the message (maximum 160 characters). **Note:** For text, only ASCII characters are supported. | |
10
+ | **notification_url** | **String** | When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters. **Note:** This is a notification only; any PerCL returned is ignored. | [optional] |
11
+ | **account_id** | **String** | String that uniquely identifies this account resource. | [optional] |
12
12
 
13
- ## Code Sample
13
+ ## Example
14
14
 
15
15
  ```ruby
16
16
  require 'freeclimb'
17
17
 
18
- instance = Freeclimb::MessageRequestAllOf.new(from: nil,
19
- to: nil,
20
- text: nil,
21
- notification_url: nil,
22
- account_id: nil)
18
+ instance = Freeclimb::MessageRequestAllOf.new(
19
+ from: null,
20
+ to: null,
21
+ text: null,
22
+ notification_url: null,
23
+ account_id: null
24
+ )
23
25
  ```
24
26
 
25
-
@@ -2,38 +2,39 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional]
8
- **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
9
- **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
10
- **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional]
11
- **account_id** | **String** | String that uniquely identifies this account resource. | [optional]
12
- **message_id** | **String** | String that uniquely identifies this message resource | [optional]
13
- **status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown | [optional]
14
- **from** | **String** | Phone number in E.164 format that sent the message. | [optional]
15
- **to** | **String** | Phone number in E.164 format that received the message. | [optional]
16
- **text** | **String** | Message contents | [optional]
17
- **direction** | **String** | Noting whether the message was inbound or outbound | [optional]
18
- **notification_url** | **String** | URL invoked when message sent | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional] |
8
+ | **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
9
+ | **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
10
+ | **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional] |
11
+ | **account_id** | **String** | String that uniquely identifies this account resource. | [optional] |
12
+ | **message_id** | **String** | String that uniquely identifies this message resource | [optional] |
13
+ | **status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown | [optional] |
14
+ | **from** | **String** | Phone number in E.164 format that sent the message. | [optional] |
15
+ | **to** | **String** | Phone number in E.164 format that received the message. | [optional] |
16
+ | **text** | **String** | Message contents | [optional] |
17
+ | **direction** | **String** | Noting whether the message was inbound or outbound | [optional] |
18
+ | **notification_url** | **String** | URL invoked when message sent | [optional] |
19
19
 
20
- ## Code Sample
20
+ ## Example
21
21
 
22
22
  ```ruby
23
23
  require 'freeclimb'
24
24
 
25
- instance = Freeclimb::MessageResult.new(uri: nil,
26
- date_created: nil,
27
- date_updated: nil,
28
- revision: nil,
29
- account_id: nil,
30
- message_id: nil,
31
- status: nil,
32
- from: nil,
33
- to: nil,
34
- text: nil,
35
- direction: nil,
36
- notification_url: nil)
25
+ instance = Freeclimb::MessageResult.new(
26
+ uri: null,
27
+ date_created: null,
28
+ date_updated: null,
29
+ revision: null,
30
+ account_id: null,
31
+ message_id: null,
32
+ status: null,
33
+ from: null,
34
+ to: null,
35
+ text: null,
36
+ direction: null,
37
+ notification_url: null
38
+ )
37
39
  ```
38
40
 
39
-
@@ -2,30 +2,31 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **account_id** | **String** | String that uniquely identifies this account resource. | [optional]
8
- **message_id** | **String** | String that uniquely identifies this message resource | [optional]
9
- **status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown | [optional]
10
- **from** | **String** | Phone number in E.164 format that sent the message. | [optional]
11
- **to** | **String** | Phone number in E.164 format that received the message. | [optional]
12
- **text** | **String** | Message contents | [optional]
13
- **direction** | **String** | Noting whether the message was inbound or outbound | [optional]
14
- **notification_url** | **String** | URL invoked when message sent | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_id** | **String** | String that uniquely identifies this account resource. | [optional] |
8
+ | **message_id** | **String** | String that uniquely identifies this message resource | [optional] |
9
+ | **status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown | [optional] |
10
+ | **from** | **String** | Phone number in E.164 format that sent the message. | [optional] |
11
+ | **to** | **String** | Phone number in E.164 format that received the message. | [optional] |
12
+ | **text** | **String** | Message contents | [optional] |
13
+ | **direction** | **String** | Noting whether the message was inbound or outbound | [optional] |
14
+ | **notification_url** | **String** | URL invoked when message sent | [optional] |
15
15
 
16
- ## Code Sample
16
+ ## Example
17
17
 
18
18
  ```ruby
19
19
  require 'freeclimb'
20
20
 
21
- instance = Freeclimb::MessageResultAllOf.new(account_id: nil,
22
- message_id: nil,
23
- status: nil,
24
- from: nil,
25
- to: nil,
26
- text: nil,
27
- direction: nil,
28
- notification_url: nil)
21
+ instance = Freeclimb::MessageResultAllOf.new(
22
+ account_id: null,
23
+ message_id: null,
24
+ status: null,
25
+ from: null,
26
+ to: null,
27
+ text: null,
28
+ direction: null,
29
+ notification_url: null
30
+ )
29
31
  ```
30
32
 
31
-
data/docs/MessagesList.md CHANGED
@@ -2,30 +2,31 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **total** | **Integer** | Total amount of requested resource. | [optional]
8
- **start** | **Integer** | Resource index at start of current page | [optional]
9
- **_end** | **Integer** | Resource index at end of current page | [optional]
10
- **page** | **Integer** | Current page | [optional]
11
- **num_pages** | **Integer** | Total number of pages | [optional]
12
- **page_size** | **Integer** | Number of items per page | [optional]
13
- **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional]
14
- **messages** | [**Array<MessageResult>**](MessageResult.md) | Array of messages | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **total** | **Integer** | Total amount of requested resource. | [optional] |
8
+ | **start** | **Integer** | Resource index at start of current page | [optional] |
9
+ | **_end** | **Integer** | Resource index at end of current page | [optional] |
10
+ | **page** | **Integer** | Current page | [optional] |
11
+ | **num_pages** | **Integer** | Total number of pages | [optional] |
12
+ | **page_size** | **Integer** | Number of items per page | [optional] |
13
+ | **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional] |
14
+ | **messages** | [**Array<MessageResult>**](MessageResult.md) | Array of messages | [optional] |
15
15
 
16
- ## Code Sample
16
+ ## Example
17
17
 
18
18
  ```ruby
19
19
  require 'freeclimb'
20
20
 
21
- instance = Freeclimb::MessagesList.new(total: nil,
22
- start: nil,
23
- _end: nil,
24
- page: nil,
25
- num_pages: nil,
26
- page_size: nil,
27
- next_page_uri: nil,
28
- messages: nil)
21
+ instance = Freeclimb::MessagesList.new(
22
+ total: null,
23
+ start: null,
24
+ _end: null,
25
+ page: null,
26
+ num_pages: null,
27
+ page_size: null,
28
+ next_page_uri: null,
29
+ messages: null
30
+ )
29
31
  ```
30
32
 
31
-