freeclimb 4.9.0 → 5.1.0

data/docs/ConferenceRecordingStatusWebhook.md

@@ -0,0 +1,42 @@
+# Freeclimb::ConferenceRecordingStatusWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Context or reason why this request is being made. Will be conferenceRecordingStatus - The statusCallbackUrl request includes Recording information for a Conference that ended. | [optional] |
+| **call_id** | **String** | Unique ID for this Call, generated by FreeClimb. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number provisioned to you and to which this Call is directed (in E.164 format). | [optional] |
+| **call_status** | [**CallStatus**](CallStatus.md) |  | [optional] |
+| **direction** | [**CallDirection**](CallDirection.md) |  | [optional] |
+| **conference_id** | **String** | Unique ID of the Conference. | [optional] |
+| **queue_id** | **String** | This is only populated if the request pertains to a Queue. Otherwise, it is set to null. | [optional] |
+| **status** | [**ConferenceStatus**](ConferenceStatus.md) |  | [optional] |
+| **recording_url** | **String** | URL of the Conference’s recorded audio. Populated only if a Recording exists and the Conference was emptied. | [optional] |
+| **recording_id** | **String** | Unique ID of the Recording from this Conference. Populated only if a recording exists and the Conference was emptied. | [optional] |
+| **recording_duration_sec** | **Integer** | Duration of the recorded audio (in seconds), rounded up to the nearest second. Populated only if a Recording exists and the Conference was emptied. | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ConferenceRecordingStatusWebhook.new(
+  request_type: null,
+  call_id: null,
+  account_id: null,
+  from: null,
+  to: null,
+  call_status: null,
+  direction: null,
+  conference_id: null,
+  queue_id: null,
+  status: null,
+  recording_url: null,
+  recording_id: null,
+  recording_duration_sec: null
+)
+```
+

data/docs/ConferenceResult.md

@@ -11,7 +11,7 @@
 | **conference_id** | **String** | A string that uniquely identifies this Conference resource. | [optional] |
 | **account_id** | **String** | ID of the account that created this Conference. | [optional] |
 | **_alias** | **String** | A description for this Conference. | [optional] |
-| **play_beep** | [**PlayBeep**](PlayBeep.md) |  | [optional][default to 'always'] |
+| **play_beep** | [**PlayBeep**](PlayBeep.md) |  | [optional] |
 | **record** | **Boolean** | Flag indicating whether recording is enabled for this Conference. | [optional] |
 | **status** | [**ConferenceStatus**](ConferenceStatus.md) |  | [optional] |
 | **wait_url** | **String** | URL referencing the audio file to be used as default wait music for the Conference when it is in the populated state. | [optional] |

data/docs/ConferenceStatusWebhook.md

@@ -0,0 +1,42 @@
+# Freeclimb::ConferenceStatusWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Context or reason why this request is being made. Will be conferenceRecordingStatus - The statusCallbackUrl request includes Recording information for a Conference that ended. | [optional] |
+| **call_id** | **String** | Unique ID for this Call, generated by FreeClimb. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number provisioned to you and to which this Call is directed (in E.164 format). | [optional] |
+| **call_status** | [**CallStatus**](CallStatus.md) |  | [optional] |
+| **direction** | [**CallDirection**](CallDirection.md) |  | [optional] |
+| **conference_id** | **String** | Unique ID of the Conference. | [optional] |
+| **queue_id** | **String** | This is only populated if the request pertains to a Queue. Otherwise, it is set to null. | [optional] |
+| **status** | [**ConferenceStatus**](ConferenceStatus.md) |  | [optional] |
+| **recording_url** | **String** | The URL of the Conference’s recorded audio. Populated only if a Recording exists and the Conference was emptied. Present only if statusCallbackUrl is being invoked. | [optional] |
+| **recording_id** | **String** | The unique ID of the Recording from this Conference. Populated only if a Recording exists and the Conference was emptied. Present only if statusCallbackUrl is being invoked. | [optional] |
+| **recording_duration_sec** | **Integer** | The duration of the recorded audio rounded up to the nearest second (in seconds). Populated only if a Recording exists and the Conference was emptied. Present only if statusCallbackUrl is being invoked. | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ConferenceStatusWebhook.new(
+  request_type: null,
+  call_id: null,
+  account_id: null,
+  from: null,
+  to: null,
+  call_status: null,
+  direction: null,
+  conference_id: null,
+  queue_id: null,
+  status: null,
+  recording_url: null,
+  recording_id: null,
+  recording_duration_sec: null
+)
+```
+

data/docs/CreateConference.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **action_url** | **String** |  This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response.  |  |
 | **_alias** | **Boolean** | Descriptive name for the Conference.  | [optional] |
-| **play_beep** | [**PlayBeep**](PlayBeep.md) |  | [optional][default to 'always'] |
+| **play_beep** | [**PlayBeep**](PlayBeep.md) |  | [optional] |
 | **record** | **Boolean** | When set to `true`, the entire Conference is recorded. The `statusCallbackUrl` of the Conference will receive a `conferenceRecordingEnded` Webhook when the Conference transitions from the `inProgress` to empty state. | [optional] |
 | **status_callback_url** | **String** | This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. | [optional] |
 | **wait_url** | **String** | If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb. | [optional] |

data/docs/CreateConferenceRequest.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **_alias** | **String** | A description for this Conference. Maximum 64 characters. | [optional] |
-| **play_beep** | [**PlayBeep**](PlayBeep.md) |  | [optional][default to 'always'] |
+| **play_beep** | [**PlayBeep**](PlayBeep.md) |  | [optional] |
 | **record** | **Boolean** | Setting to `true` records the entire Conference. | [optional] |
 | **wait_url** | **String** | If specified, a URL for the audio file that provides custom hold music for the Conference when it is in the populated state. Otherwise, FreeClimb uses a system default audio file. This is always fetched using HTTP GET and is fetched just once — when the Conference is created. | [optional] |
 | **status_callback_url** | **String** | This URL is invoked when the status of the Conference changes. For more information, see **statusCallbackUrl** (below). | [optional] |

data/docs/CreateConferenceWebhook.md

@@ -0,0 +1,42 @@
+# Freeclimb::CreateConferenceWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Context or reason why this request is being made. Will be createConference - A Conference has been created and its statusCallbackUrl or actionUrl is being invoked. | [optional] |
+| **call_id** | **String** | Unique ID for this Call, generated by FreeClimb. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number provisioned to you and to which this Call is directed (in E.164 format). | [optional] |
+| **call_status** | [**CallStatus**](CallStatus.md) |  | [optional] |
+| **direction** | [**CallDirection**](CallDirection.md) |  | [optional] |
+| **conference_id** | **String** | Unique ID of the Conference. | [optional] |
+| **queue_id** | **String** | This is only populated if the request pertains to a Queue. Otherwise, it is set to null. | [optional] |
+| **status** | [**ConferenceStatus**](ConferenceStatus.md) |  | [optional] |
+| **recording_url** | **String** | The URL of the Conference’s recorded audio. Populated only if a Recording exists and the Conference was emptied. Present only if statusCallbackUrl is being invoked. | [optional] |
+| **recording_id** | **String** | The unique ID of the Recording from this Conference. Populated only if a Recording exists and the Conference was emptied. Present only if statusCallbackUrl is being invoked. | [optional] |
+| **recording_duration_sec** | **Integer** | The duration of the recorded audio rounded up to the nearest second (in seconds). Populated only if a Recording exists and the Conference was emptied. Present only if statusCallbackUrl is being invoked. | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::CreateConferenceWebhook.new(
+  request_type: null,
+  call_id: null,
+  account_id: null,
+  from: null,
+  to: null,
+  call_status: null,
+  direction: null,
+  conference_id: null,
+  queue_id: null,
+  status: null,
+  recording_url: null,
+  recording_id: null,
+  recording_duration_sec: null
+)
+```
+

data/docs/DequeueWebhook.md

@@ -0,0 +1,38 @@
+# Freeclimb::DequeueWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Context or reason why this request is being made. Will be dequeue - A queued call has been dequeued and the actionUrl of the corresponding Enqueue action is being invoked. | [optional] |
+| **call_id** | **String** | Unique ID for this Call, generated by FreeClimb. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number provisioned to you and to which this Call is directed (in E.164 format). | [optional] |
+| **call_status** | [**CallStatus**](CallStatus.md) |  | [optional] |
+| **direction** | [**CallDirection**](CallDirection.md) |  | [optional] |
+| **conference_id** | **String** | Unique ID of the Conference. | [optional] |
+| **queue_id** | **String** | This is only populated if the request pertains to a Queue. Otherwise, it is set to null. | [optional] |
+| **queue_result** | **String** | The final result of the enqueued Call. Valid values are: •dequeued - Enqueued caller exited the Queue via a Dequeue action (Dequeue command or Queue Members POST REST API). | [optional] |
+| **queue_time** | **Integer** | Time (in seconds) the call spent in the Queue. This is only available if the Call was actually enqueued. | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::DequeueWebhook.new(
+  request_type: null,
+  call_id: null,
+  account_id: null,
+  from: null,
+  to: null,
+  call_status: null,
+  direction: null,
+  conference_id: null,
+  queue_id: null,
+  queue_result: null,
+  queue_time: null
+)
+```
+

data/docs/GetDigitsReason.md

@@ -0,0 +1,19 @@
+# Freeclimb::GetDigitsReason
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **FINISH_KEY** | **GetDigitsReason** |  | Represented in Ruby as "finishKey" |
+| **TIMEOUT** | **GetDigitsReason** |  | Represented in Ruby as "timeout" |
+| **MAX_DIGITS** | **GetDigitsReason** |  | Represented in Ruby as "maxDigits" |
+| **TONE** | **GetDigitsReason** |  | Represented in Ruby as "tone" |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::GetDigitsReason::[NAME OF ENUM]
+```
+

data/docs/GetDigitsWebhook.md

@@ -0,0 +1,40 @@
+# Freeclimb::GetDigitsWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Context or reason why this request is being made. Will be getDigits - The GetDigits command has completed and its actionUrl is being invoked. | [optional] |
+| **call_id** | **String** | Unique ID for this Call, generated by FreeClimb. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number provisioned to you and to which this Call is directed (in E.164 format). | [optional] |
+| **call_status** | [**CallStatus**](CallStatus.md) |  | [optional] |
+| **direction** | [**CallDirection**](CallDirection.md) |  | [optional] |
+| **conference_id** | **String** | Unique ID of the Conference. | [optional] |
+| **queue_id** | **String** | This is only populated if the request pertains to a Queue. Otherwise, it is set to null. | [optional] |
+| **digits** | **String** | tring of digits entered by the Caller, excluding the terminating digit (if used). The string of digits will be replaced by 'xxxxx' when privacyMode is set to true | [optional] |
+| **reason** | [**GetDigitsReason**](GetDigitsReason.md) |  | [optional] |
+| **parent_call_id** | **String** | ID of the Call that created this leg (child call). | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::GetDigitsWebhook.new(
+  request_type: null,
+  call_id: null,
+  account_id: null,
+  from: null,
+  to: null,
+  call_status: null,
+  direction: null,
+  conference_id: null,
+  queue_id: null,
+  digits: null,
+  reason: null,
+  parent_call_id: null
+)
+```
+

data/docs/GetSpeechWebhook.md

@@ -0,0 +1,50 @@
+# Freeclimb::GetSpeechWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Context or reason why this request is being made. Will be getSpeech - The GetSpeech command has completed and its actionUrl is being invoked. | [optional] |
+| **call_id** | **String** | Unique ID for this Call, generated by FreeClimb. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number provisioned to you and to which this Call is directed (in E.164 format). | [optional] |
+| **call_status** | [**CallStatus**](CallStatus.md) |  | [optional] |
+| **direction** | [**CallDirection**](CallDirection.md) |  | [optional] |
+| **conference_id** | **String** | Unique ID of the Conference. | [optional] |
+| **queue_id** | **String** | This is only populated if the request pertains to a Queue. Otherwise, it is set to null. | [optional] |
+| **reason** | [**GetSpeechReason**](GetSpeechReason.md) |  | [optional] |
+| **recognition_result** | **String** | Semantic content (either a string if speech was recognized or a digit if a digit was input instead of speech) returned from the entry or tag that was recognized within the grammar. The content will be replaced by 'xxxxx' when privacyMode is set to true. This field is populated only if the reason field is set to recognition or digit. | [optional] |
+| **confidence** | **Integer** | Level of confidence in the obtained result. This is a value in the range 0 to 100 – with 0 being total lack of confidence and 100 being absolute certainty in the recognition. This field is populated only if the reason field is set to recognition. | [optional] |
+| **parent_call_id** | **String** | ID of the Call that created this leg (child call). | [optional] |
+| **completion_reason** | **String** | Advanced diagnostic information if reason was error. See RFC 6787 section 9.4.12 - speech recognition. | [optional] |
+| **completion_cause** | **String** | Advanced diagnostic information if reason was error. See RFC 6787 section 9.4.11 - speech recognition. | [optional] |
+| **mrcp_code** | **Integer** | Advanced diagnostic information if reason was error. See RFC 6787 section 5.4 - MRCPv2 specification. | [optional] |
+| **mrcp_diagnostic** | **String** | Advanced diagnostic information if reason was error. See RFC 6787 section 5.4 - MRCPv2 specification. | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::GetSpeechWebhook.new(
+  request_type: null,
+  call_id: null,
+  account_id: null,
+  from: null,
+  to: null,
+  call_status: null,
+  direction: null,
+  conference_id: null,
+  queue_id: null,
+  reason: null,
+  recognition_result: null,
+  confidence: null,
+  parent_call_id: null,
+  completion_reason: null,
+  completion_cause: null,
+  mrcp_code: null,
+  mrcp_diagnostic: null
+)
+```
+

data/docs/InboundCallWebhook.md

@@ -0,0 +1,36 @@
+# Freeclimb::InboundCallWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Context or reason why this request is being made. Will be inboundCall - An inbound call was received and the voiceUrl is being invoked. | [optional] |
+| **call_id** | **String** | Unique ID for this Call, generated by FreeClimb. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number provisioned to you and to which this Call is directed (in E.164 format). | [optional] |
+| **call_status** | [**CallStatus**](CallStatus.md) |  | [optional] |
+| **direction** | [**CallDirection**](CallDirection.md) |  | [optional] |
+| **conference_id** | **String** | This is only populated if request pertains to a Conference. Otherwise, it is set to null. | [optional] |
+| **queue_id** | **String** | This is only populated if the request pertains to a Queue. Otherwise, it is set to null. | [optional] |
+| **parent_call_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::InboundCallWebhook.new(
+  request_type: null,
+  call_id: null,
+  account_id: null,
+  from: null,
+  to: null,
+  call_status: null,
+  direction: null,
+  conference_id: null,
+  queue_id: null,
+  parent_call_id: null
+)
+```
+

data/docs/LeaveConferenceWebhook.md

@@ -0,0 +1,34 @@
+# Freeclimb::LeaveConferenceWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Context or reason why this request is being made. Will be leaveConference - Call has been unbridged from a Conference and its leaveConferenceUrl is being invoked. | [optional] |
+| **call_id** | **String** | Unique ID for this Call, generated by FreeClimb. This is the call leg which has left the Conference | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number provisioned to you and to which this Call is directed (in E.164 format). | [optional] |
+| **call_status** | [**CallStatus**](CallStatus.md) |  | [optional] |
+| **direction** | [**CallDirection**](CallDirection.md) |  | [optional] |
+| **conference_id** | **String** | This is only populated if request pertains to a Conference. Otherwise, it is set to null. | [optional] |
+| **queue_id** | **String** | This is only populated if the request pertains to a Queue. Otherwise, it is set to null. | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::LeaveConferenceWebhook.new(
+  request_type: null,
+  call_id: null,
+  account_id: null,
+  from: null,
+  to: null,
+  call_status: null,
+  direction: null,
+  conference_id: null,
+  queue_id: null
+)
+```
+

data/docs/MachineDetectedWebhook.md

@@ -0,0 +1,38 @@
+# Freeclimb::MachineDetectedWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Context or reason why this request is being made. Will be machineDetected - An outbound call spawned by OutDial was answered by a machine and the ifMachineUrl is being invoked. | [optional] |
+| **call_id** | **String** | Unique ID for this Call, generated by FreeClimb. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number provisioned to you and to which this Call is directed (in E.164 format). | [optional] |
+| **call_status** | [**CallStatus**](CallStatus.md) |  | [optional] |
+| **direction** | [**CallDirection**](CallDirection.md) |  | [optional] |
+| **conference_id** | **String** | This is only populated if request pertains to a Conference. Otherwise, it is set to null. | [optional] |
+| **queue_id** | **String** | This is only populated if the request pertains to a Queue. Otherwise, it is set to null. | [optional] |
+| **parent_call_id** | **String** | Call ID of the leg which initiated the OutDial. | [optional] |
+| **machine_type** | [**MachineType**](MachineType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::MachineDetectedWebhook.new(
+  request_type: null,
+  call_id: null,
+  account_id: null,
+  from: null,
+  to: null,
+  call_status: null,
+  direction: null,
+  conference_id: null,
+  queue_id: null,
+  parent_call_id: null,
+  machine_type: null
+)
+```
+

data/docs/MachineType.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **ANSWERING_MACHINE** | **MachineType** |  | Represented in Ruby as "answeringMachine" |
-| **FAX_MACHINE** | **MachineType** |  | Represented in Ruby as "faxMachine" |
+| **ANSWERING_MACHINE** | **MachineType** |  | Represented in Ruby as "answering machine" |
+| **FAX_MODEM** | **MachineType** |  | Represented in Ruby as "fax modem" |
 
 ## Example
 

data/docs/MessageDeliveryWebhook.md

@@ -0,0 +1,36 @@
+# Freeclimb::MessageDeliveryWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Value will be messageDelivery - An SMS message has been received by the platform and is being delivered to the customer application associated with the destination number. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number provisioned to you and to which this Call is directed (in E.164 format). | [optional] |
+| **text** | **String** | Body of the SMS message. | [optional] |
+| **direction** | **String** | Value will be inbound to indicate the receipt of a message into the FreeClimb platform. | [optional] |
+| **application_id** | **String** | ID of the application to which the destination number is assigned. | [optional] |
+| **status** | **String** | Value will be received to indicate that the platform has successfully received the incoming message. | [optional] |
+| **phone_number_id** | **String** | ID of the destination phone number. | [optional] |
+| **uri** | **String** | The URI for this resource, relative to the API base URL | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::MessageDeliveryWebhook.new(
+  request_type: null,
+  account_id: null,
+  from: null,
+  to: null,
+  text: null,
+  direction: null,
+  application_id: null,
+  status: null,
+  phone_number_id: null,
+  uri: null
+)
+```
+

data/docs/MessageResult.md

@@ -20,6 +20,9 @@
 | **campaign_id** | **String** | The unique identifier for the campaign associated with the message | [optional] |
 | **segment_count** | **Float** | The number of segments into which the message was split | [optional] |
 | **media_urls** | **Array<String>** | an array of HTTP URLs which were attached this this message | [optional] |
+| **tfn** | [**TFN**](TFN.md) |  | [optional] |
+| **phone_number_id** | **String** | String that uniquely identifies the phoneNumber resource used to send this Message | [optional] |
+| **application_id** | **String** | String that uniquely identifies the Application resource used to send this Message | [optional] |
 
 ## Example
 
@@ -42,7 +45,10 @@ instance = Freeclimb::MessageResult.new(
   brand_id: null,
   campaign_id: null,
   segment_count: null,
-  media_urls: null
+  media_urls: null,
+  tfn: null,
+  phone_number_id: null,
+  application_id: null
 )
 ```
 

data/docs/MessageStatusWebhook.md

@@ -0,0 +1,38 @@
+# Freeclimb::MessageStatusWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Value will be messageStatus - An outbound SMS has changed status and the Sms command's notificationUrl is being invoked. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **message_id** | **String** | Unique ID for this message, generated by FreeClimb. | [optional] |
+| **call_id** | **String** | Unique ID for the Call in the context of which the Sms PerCL command was issued. | [optional] |
+| **from** | **String** | aPhone number used to initiate the SMS message (in E.164 format). | [optional] |
+| **to** | **String** | Destination number of the SMS message (in E.164 format). | [optional] |
+| **text** | **String** | Body of the SMS message. | [optional] |
+| **direction** | **String** | Value will be outbound to indicate an outgoing SMS from FreeClimb. | [optional] |
+| **application_id** | **String** | ID of the application to which the destination number is assigned. May be null if the originating number is invalid in some way or is not registered to an application. | [optional] |
+| **status** | [**MessageStatus**](MessageStatus.md) |  | [optional] |
+| **phone_number_id** | **String** | ID of the destination phone number. | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::MessageStatusWebhook.new(
+  request_type: null,
+  account_id: null,
+  message_id: null,
+  call_id: null,
+  from: null,
+  to: null,
+  text: null,
+  direction: null,
+  application_id: null,
+  status: null,
+  phone_number_id: null
+)
+```
+

data/docs/OutDialApiConnectWebhook.md

@@ -0,0 +1,36 @@
+# Freeclimb::OutDialApiConnectWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Context or reason why this request is being made. Will be outDialApiConnect - An outbound call spawned by the REST API has connected and the callConnectUrl specified in the API request is being invoked. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **call_id** | **String** | Unique identifier for this Call, generated by FreeClimb | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number or SIP URL of the party that is receiving the call (phone number in E.164 format). | [optional] |
+| **call_status** | [**CallStatus**](CallStatus.md) |  | [optional] |
+| **direction** | [**CallDirection**](CallDirection.md) |  | [optional] |
+| **conference_id** | **String** | This is only populated if request pertains to a conference. Otherwise, it is set to null. | [optional] |
+| **queue_id** | **String** | This is only populated if the request pertains to a queue. Otherwise, it is set to null. | [optional] |
+| **parent_call_id** | **String** | ID of the Call that created this leg (child call). | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::OutDialApiConnectWebhook.new(
+  request_type: null,
+  account_id: null,
+  call_id: null,
+  from: null,
+  to: null,
+  call_status: null,
+  direction: null,
+  conference_id: null,
+  queue_id: null,
+  parent_call_id: null
+)
+```
+

data/docs/OutDialConnectWebhook.md

@@ -0,0 +1,36 @@
+# Freeclimb::OutDialConnectWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Context or reason why this request is being made. Will be outDialConnect - A Call generated by OutDial has connected and the callConnectUrl is being invoked. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **call_id** | **String** | Unique identifier for this Call, generated by FreeClimb | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number or SIP URL of the party that is receiving the call (phone number in E.164 format). | [optional] |
+| **call_status** | [**CallStatus**](CallStatus.md) |  | [optional] |
+| **direction** | [**CallDirection**](CallDirection.md) |  | [optional] |
+| **conference_id** | **String** | This is only populated if request pertains to a conference. Otherwise, it is set to null. | [optional] |
+| **queue_id** | **String** | This is only populated if the request pertains to a queue. Otherwise, it is set to null. | [optional] |
+| **parent_call_id** | **String** | ID of the Call that created this leg (child call). | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::OutDialConnectWebhook.new(
+  request_type: null,
+  account_id: null,
+  call_id: null,
+  from: null,
+  to: null,
+  call_status: null,
+  direction: null,
+  conference_id: null,
+  queue_id: null,
+  parent_call_id: null
+)
+```
+

data/docs/OutDialStartWebhook.md

@@ -0,0 +1,38 @@
+# Freeclimb::OutDialStartWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_type** | **String** | Context or reason why this request is being made. Will be outDialStart - The OutDial command has started and the actionUrl is being invoked. | [optional] |
+| **account_id** | **String** | Account ID associated with your account. | [optional] |
+| **call_id** | **String** | Unique identifier for this Call, generated by FreeClimb | [optional] |
+| **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
+| **to** | **String** | Phone number provisioned to the customer and to which this Call is directed (in E.164 format). | [optional] |
+| **call_status** | [**CallStatus**](CallStatus.md) |  | [optional] |
+| **direction** | [**CallDirection**](CallDirection.md) |  | [optional] |
+| **conference_id** | **String** | This is only populated if request pertains to a conference. Otherwise, it is set to null. | [optional] |
+| **queue_id** | **String** | This is only populated if the request pertains to a queue. Otherwise, it is set to null. | [optional] |
+| **dial_call_id** | **String** | ID of the child call that was generated as a result of the Outdial. | [optional] |
+| **parent_call_id** | **String** | ID of the Call that created this leg (child call). If this was an inbound call or call created via REST API with no parent, this field will be null. | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::OutDialStartWebhook.new(
+  request_type: null,
+  account_id: null,
+  call_id: null,
+  from: null,
+  to: null,
+  call_status: null,
+  direction: null,
+  conference_id: null,
+  queue_id: null,
+  dial_call_id: null,
+  parent_call_id: null
+)
+```
+