freeclimb 4.9.0 → 5.0.0

data/docs/AccountResultAllOf.md

@@ -1,30 +0,0 @@
-# Freeclimb::AccountResultAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **account_id** | **String** | String that uniquely identifies this account resource. | [optional] |
-| **api_key** | **String** | The API key assigned to this account. This key must be kept a secret by the customer. | [optional] |
-| **_alias** | **String** | A description for this account. | [optional] |
-| **label** | **String** | A string that identifies a category or group to which the account belongs. | [optional] |
-| **type** | [**AccountType**](AccountType.md) |  | [optional] |
-| **status** | [**AccountStatus**](AccountStatus.md) |  | [optional] |
-| **subresource_uris** | **Object** | The list of subresources for this account. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::AccountResultAllOf.new(
-  account_id: null,
-  api_key: null,
-  _alias: null,
-  label: null,
-  type: null,
-  status: null,
-  subresource_uris: null
-)
-```
-

data/docs/AddToConferenceAllOf.md

@@ -1,36 +0,0 @@
-# Freeclimb::AddToConferenceAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **allow_call_control** | **Boolean** | If `true`, Call control will be enabled for this Participant's Call leg. | [optional] |
-| **call_control_sequence** | **String** | Defines a sequence of digits that, when entered by this caller, invokes the `callControlUrl`. Only digits plus '*', and '#' may be used. | [optional] |
-| **call_control_url** | **String** | URL to be invoked when this Participant enters the digit sequence defined in the `callControlSequence` attribute. | [optional] |
-| **conference_id** | **String** | ID of the Conference to which to add the Participant (Call leg). Conference must exist or an error will result. |  |
-| **leave_conference_url** | **String** | URL to be invoked when the Participant leaves the Conference.  | [optional] |
-| **listen** | **Boolean** | If `true`, the Participant joins the Conference with listen privileges. This may be modified later via the REST API or `SetListen` PerCL command. | [optional] |
-| **notification_url** | **String** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional] |
-| **start_conf_on_enter** | **Boolean** | Flag that indicates whether a Conference starts upon entry of this particular Participant. This is usually set to `true` for moderators and `false` for all other Participants. | [optional] |
-| **talk** | **Boolean** | If `true`, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or `SetTalk` PerCL command.  | [optional] |
-| **dtmf_pass_through** | **Boolean** | If `true`, the Participant joins the Conference with dtmfPassThrough privileges. This may be modified later via the REST API or `SetDTMFPassThrough` PerCL command.  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::AddToConferenceAllOf.new(
-  allow_call_control: null,
-  call_control_sequence: null,
-  call_control_url: null,
-  conference_id: null,
-  leave_conference_url: null,
-  listen: null,
-  notification_url: null,
-  start_conf_on_enter: null,
-  talk: null,
-  dtmf_pass_through: null
-)
-```
-

data/docs/ApplicationListAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::ApplicationListAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **applications** | [**Array<ApplicationResult>**](ApplicationResult.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::ApplicationListAllOf.new(
-  applications: null
-)
-```
-

data/docs/ApplicationResultAllOf.md

@@ -1,34 +0,0 @@
-# Freeclimb::ApplicationResultAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **account_id** | **String** | ID of the account that owns this phone number. | [optional] |
-| **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] |
-| **_alias** | **String** | Description for this phone number. Typically the conventionally-formatted version of the phone number. | [optional] |
-| **voice_url** | **String** | The URL FreeClimb will request when a phone number assigned to this Application receives a Call. Used for inbound calls only. | [optional] |
-| **voice_fallback_url** | **String** | The URL that FreeClimb will request if it times out waiting for a response from the voiceUrl. Used for inbound calls only. | [optional] |
-| **call_connect_url** | **String** | The URL to which FreeClimb will make a POST request informing the result of the outbound Call request. The status property of the request message specifies if the Call was connected or not. | [optional] |
-| **status_callback_url** | **String** | A URL to which FreeClimb will make a POST request when the Call ends to notify this app. | [optional] |
-| **sms_url** | **String** | The URL FreeClimb will request when a phone number assigned to this Application receives an incoming SMS message. Used for inbound SMS only. | [optional] |
-| **sms_fallback_url** | **String** | The URL that FreeClimb will request if it times out waiting for a response from the smsUrl. Used for inbound SMS only. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::ApplicationResultAllOf.new(
-  account_id: null,
-  application_id: null,
-  _alias: null,
-  voice_url: null,
-  voice_fallback_url: null,
-  call_connect_url: null,
-  status_callback_url: null,
-  sms_url: null,
-  sms_fallback_url: null
-)
-```
-

data/docs/AvailableNumberListAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::AvailableNumberListAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **available_phone_numbers** | [**Array<AvailableNumber>**](AvailableNumber.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::AvailableNumberListAllOf.new(
-  available_phone_numbers: null
-)
-```
-

data/docs/CallListAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::CallListAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **calls** | [**Array<CallResult>**](CallResult.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::CallListAllOf.new(
-  calls: null
-)
-```
-

data/docs/CallResultAllOf.md

@@ -1,48 +0,0 @@
-# Freeclimb::CallResultAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **call_id** | **String** | String that uniquely identifies this Call resource. | [optional] |
-| **parent_call_id** | **String** | ID of the Call that created this leg (child Call). | [optional] |
-| **account_id** | **String** | ID of the account that owns this Call. | [optional] |
-| **from** | **String** | Phone number that initiated this Call. | [optional] |
-| **to** | **String** | Phone number that received this Call. | [optional] |
-| **phone_number_id** | **String** | If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI). | [optional] |
-| **call_status** | [**CallStatus**](CallStatus.md) |  | [optional] |
-| **start_time** | **String** | Start time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional] |
-| **connect_time** | **String** | Time the Call was answered (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional] |
-| **end_time** | **String** | End time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call did not complete successfully. | [optional] |
-| **duration** | **Integer** | Total length of the Call in seconds. Measures time between startTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional] |
-| **connect_duration** | **Integer** | Length of time that the Call was connected in seconds. Measures time between connectTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional] |
-| **direction** | [**CallDirection**](CallDirection.md) |  | [optional] |
-| **answered_by** | [**AnsweredBy**](AnsweredBy.md) |  | [optional] |
-| **subresource_uris** | **Object** | The list of subresources for this Call. These include things like logs and recordings associated with the Call. | [optional] |
-| **application_id** | **String** | ApplicationId associated with the Call. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::CallResultAllOf.new(
-  call_id: null,
-  parent_call_id: null,
-  account_id: null,
-  from: null,
-  to: null,
-  phone_number_id: null,
-  call_status: null,
-  start_time: null,
-  connect_time: null,
-  end_time: null,
-  duration: null,
-  connect_duration: null,
-  direction: null,
-  answered_by: null,
-  subresource_uris: null,
-  application_id: null
-)
-```
-

data/docs/ConferenceListAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::ConferenceListAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **conferences** | [**Array<ConferenceResult>**](ConferenceResult.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::ConferenceListAllOf.new(
-  conferences: null
-)
-```
-

data/docs/ConferenceParticipantListAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::ConferenceParticipantListAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **participants** | [**Array<ConferenceParticipantResult>**](ConferenceParticipantResult.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::ConferenceParticipantListAllOf.new(
-  participants: null
-)
-```
-

data/docs/ConferenceParticipantResultAllOf.md

@@ -1,30 +0,0 @@
-# Freeclimb::ConferenceParticipantResultAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **account_id** | **String** | ID of the account that created this participant. | [optional] |
-| **conference_id** | **String** | ID of the conference this participant is in. | [optional] |
-| **call_id** | **String** | ID of the Call associated with this Participant. | [optional] |
-| **talk** | **Boolean** | True if this Participant has talk privileges in the Conference. False otherwise. | [optional] |
-| **listen** | **Boolean** | True if this Participant has listen privileges in the Conference. False otherwise. | [optional] |
-| **dtmf_pass_through** | **Boolean** | True if this Participant had dtmfPassThrough privileges in the Conference. False otherwise. | [optional] |
-| **start_conf_on_enter** | **Boolean** | True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::ConferenceParticipantResultAllOf.new(
-  account_id: null,
-  conference_id: null,
-  call_id: null,
-  talk: null,
-  listen: null,
-  dtmf_pass_through: null,
-  start_conf_on_enter: null
-)
-```
-

data/docs/ConferenceResultAllOf.md

@@ -1,36 +0,0 @@
-# Freeclimb::ConferenceResultAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **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'] |
-| **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] |
-| **action_url** | **String** | URL invoked once the Conference is successfully created. | [optional] |
-| **status_callback_url** | **String** | URL to inform that the Conference status has changed. | [optional] |
-| **subresource_uris** | **Object** | The list of subresources for this Conference. This includes participants and/or recordings. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::ConferenceResultAllOf.new(
-  conference_id: null,
-  account_id: null,
-  _alias: null,
-  play_beep: null,
-  record: null,
-  status: null,
-  wait_url: null,
-  action_url: null,
-  status_callback_url: null,
-  subresource_uris: null
-)
-```
-

data/docs/CreateConferenceAllOf.md

@@ -1,28 +0,0 @@
-# Freeclimb::CreateConferenceAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **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'] |
-| **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] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::CreateConferenceAllOf.new(
-  action_url: null,
-  _alias: null,
-  play_beep: null,
-  record: null,
-  status_callback_url: null,
-  wait_url: null
-)
-```
-

data/docs/EnqueueAllOf.md

@@ -1,24 +0,0 @@
-# Freeclimb::EnqueueAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **action_url** | **String** | A request is made to this URL when the Call leaves the Queue, which can occur if enqueue of the Call fails or when the call is dequeued via the `Dequeue` command, the REST API (POST to Queue Member resource), or the caller hangs up. |  |
-| **notification_url** | **String** | URL to be invoked when the call enters the queue. The request to the URL contains the standard request parameters.This is a notification only; any PerCL returned will be ignored. | [optional] |
-| **queue_id** | **String** | ID of the Queue to which to add the Call. If the Queue does not exist, it will be created. The ID must start with QU followed by 40 hex characters. |  |
-| **wait_url** | **String** | A request is made to this URL when the Call leaves the Queue, which can occur if enqueue of the Call fails or when the call is dequeued via the `Dequeue` command, the REST API (POST to Queue Member resource), or the caller hangs up. |  |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::EnqueueAllOf.new(
-  action_url: null,
-  notification_url: null,
-  queue_id: null,
-  wait_url: null
-)
-```
-

data/docs/GetDigitsAllOf.md

@@ -1,34 +0,0 @@
-# Freeclimb::GetDigitsAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **action_url** | **String** | When the Caller has finished entering digits, FreeClimb will make an HTTP POST request to this URL. A PerCL response is expected to continue handling the Call. Make sure to keep “http://“ in the URL. |  |
-| **digit_timeout_ms** | **Integer** |  Maximum time in milliseconds that FreeClimb will wait for the Caller to press any digit after the last digit entered, before making a determination that a `timeout` has occurred and moving on to make the request to the actionUrl to submit the results of the `GetDigits` command. This timeout interval begins and resets after each digit entered. | [optional] |
-| **finish_on_key** | **String** | Digit that causes the input sequence to be deemed complete. This attribute defers to the `timeout` attribute – so, if a `timeout` occurs, then the command terminates regardless of the value of `finishOnKey`. | [optional] |
-| **flush_buffer** | **Boolean** | If set to true, the FreeClimb platform starts with an empty DTMF buffer to store the digits entered by the caller. If set to false, FreeClimb will append the user inputs to the end of the existing digits buffer and will return digits from the start of the digits buffer. | [optional] |
-| **initial_timeout_ms** | **Integer** | Maximum time in milliseconds that FreeClimb will wait for the Caller to press the first digit before making a determination that a `timeout` has occurred and moving on to make the request to the `actionUrl` to submit the results of the `GetDigits` command. This timeout interval begins when all nested commands have been fully executed. | [optional] |
-| **max_digits** | **Integer** | Maximum number of digits expected in the input. If the terminating digit is not entered and the caller has entered the maximum number of digits allowed, the `GetDigits` command terminates regardless of the value of `finishOnKey`. | [optional] |
-| **min_digits** | **Integer** | Minimum number of digits expected in the input. If specified, FreeClimb will return the collected digits only if the Caller has entered at least that many digits. | [optional] |
-| **prompts** | [**Array<PerclCommand>**](PerclCommand.md) | JSON array of PerCL commands to nest within the `GetDigits` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the Caller. | [optional] |
-| **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::GetDigitsAllOf.new(
-  action_url: null,
-  digit_timeout_ms: null,
-  finish_on_key: null,
-  flush_buffer: null,
-  initial_timeout_ms: null,
-  max_digits: null,
-  min_digits: null,
-  prompts: null,
-  privacy_mode: null
-)
-```
-

data/docs/GetSpeechAllOf.md

@@ -1,42 +0,0 @@
-# Freeclimb::GetSpeechAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **action_url** | **String** | When the caller has finished speaking or the command has timed out, FreeClimb will make a POST request to this URL. A PerCL response is expected to continue handling the call. |  |
-| **grammar_type** | [**GrammarType**](GrammarType.md) |  | [optional] |
-| **grammar_file** | **String** | The grammar file to use for speech recognition. If grammarType is set to URL, this attribute is specified as a download URL. |  |
-| **grammar_rule** | **String** | The grammar rule within the specified grammar file to use for speech recognition. This attribute is optional if `grammarType` is `URL` and ignored if `grammarType` is `BUILTIN`. | [optional] |
-| **play_beep** | **Boolean** | Indicates whether a beep should be played just before speech recognition is initiated so that the speaker can start to speak. | [optional] |
-| **prompts** | [**Array<PerclCommand>**](PerclCommand.md) | The JSON array of PerCL commands to nest within the `GetSpeech` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the caller. This allows for playing menu options to the caller and to prompt for the expected input. These commands stop executing when the caller begins to input speech. | [optional] |
-| **no_input_timeout_ms** | **Integer** | When recognition is started and there is no speech detected for `noInputTimeoutMs` milliseconds, the recognizer will terminate the recognition operation. | [optional] |
-| **recognition_timeout_ms** | **Integer** | When playback of prompts ends and there is no match for `recognitionTimeoutMs` milliseconds, the recognizer will terminate the recognition operation. | [optional] |
-| **confidence_threshold** | **Float** | When a recognition resource recognizes a spoken phrase, it associates a confidence level with that match. Parameter `confidenceThreshold` specifies what confidence level is considered a successful match. Values are between 0.0 and 1.0. | [optional] |
-| **sensitivity_level** | **Float** | The speech recognizer supports a variable level of sound sensitivity. The sensitivityLevel attribute allows for filtering out background noise, so it is not mistaken for speech. Values are between 0.0 and 1.0  | [optional] |
-| **speech_complete_timeout_ms** | **Integer** | Parameter `speechCompleteTimeoutMs` specifies the length of silence required following user speech before the speech recognizer finalizes a result. This timeout applies when the recognizer currently has a complete match against an active grammar. Reasonable speech complete timeout values are typically in the range of 0.3 seconds to 1.0 seconds. | [optional] |
-| **speech_incomplete_timeout_ms** | **Integer** | Parameter `speechIncompleteTimeoutMs` specifies the length of silence following user speech after which a recognizer finalizes a result. This timeout applies when the speech prior to the silence is an incomplete match of all active grammars. Timeout `speechIncompleteTimeoutMs` is usually longer than `speechCompleteTimeoutMs` to allow users to pause mid-utterance. | [optional] |
-| **privacy_mode** | **Boolean** | Parameter privacyMode will not log the `text` as required by PCI compliance. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::GetSpeechAllOf.new(
-  action_url: null,
-  grammar_type: null,
-  grammar_file: null,
-  grammar_rule: null,
-  play_beep: null,
-  prompts: null,
-  no_input_timeout_ms: null,
-  recognition_timeout_ms: null,
-  confidence_threshold: null,
-  sensitivity_level: null,
-  speech_complete_timeout_ms: null,
-  speech_incomplete_timeout_ms: null,
-  privacy_mode: null
-)
-```
-

data/docs/HangupAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::HangupAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **reason** | **String** | The user defined reason for the hangup. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the Call flows for the given application. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::HangupAllOf.new(
-  reason: null
-)
-```
-

data/docs/IncomingNumberListAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::IncomingNumberListAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **incoming_phone_numbers** | [**Array<IncomingNumberResult>**](IncomingNumberResult.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::IncomingNumberListAllOf.new(
-  incoming_phone_numbers: null
-)
-```
-

data/docs/IncomingNumberResultAllOf.md

@@ -1,42 +0,0 @@
-# Freeclimb::IncomingNumberResultAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **capabilities** | [**Capabilities**](Capabilities.md) |  | [optional] |
-| **campaign_id** | **String** | The campaign ID generated by the campaign registry | [optional] |
-| **phone_number_id** | **String** | String that uniquely identifies this phone number resource. | [optional] |
-| **account_id** | **String** | ID of the account that owns this phone number. | [optional] |
-| **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] |
-| **phone_number** | **String** | Phone number in E.164 format. | [optional] |
-| **_alias** | **String** | Description for this phone number. Typically the conventionally-formatted version of the phone number. | [optional] |
-| **region** | **String** | State or province of this phone number. | [optional] |
-| **country** | **String** | Country of this phone number. | [optional] |
-| **voice_enabled** | **Boolean** | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional] |
-| **sms_enabled** | **Boolean** | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional] |
-| **offnet** | **Boolean** | The offnet field is a boolean representing whether the number is offnet registered or not. This field will be rendered only for requests to the IncomingPhone number resource. | [optional] |
-| **tfn** | [**TFN**](TFN.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::IncomingNumberResultAllOf.new(
-  capabilities: null,
-  campaign_id: null,
-  phone_number_id: null,
-  account_id: null,
-  application_id: null,
-  phone_number: null,
-  _alias: null,
-  region: null,
-  country: null,
-  voice_enabled: null,
-  sms_enabled: null,
-  offnet: null,
-  tfn: null
-)
-```
-

data/docs/LogListAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::LogListAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **logs** | [**Array<LogResult>**](LogResult.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::LogListAllOf.new(
-  logs: null
-)
-```
-

data/docs/MessageRequestAllOf.md

@@ -1,26 +0,0 @@
-# Freeclimb::MessageRequestAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **from** | **String** | Phone number to use as the sender. This must be an incoming phone number that you have purchased from FreeClimb. |  |
-| **to** | **String** | Phone number to receive the message. Must be within FreeClimb's service area. |  |
-| **text** | **String** | Text contained in the message (maximum 160 characters).   **Note:** For text, only ASCII characters are supported. |  |
-| **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] |
-| **media_urls** | **Array<String>** | an array of HTTP URLs which are to be used as attachments to the message. This will force the message into being an MMS message and must be done using a from number which is MMS capabile. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::MessageRequestAllOf.new(
-  from: null,
-  to: null,
-  text: null,
-  notification_url: null,
-  media_urls: null
-)
-```
-

data/docs/MessageResultAllOf.md

@@ -1,40 +0,0 @@
-# Freeclimb::MessageResultAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **account_id** | **String** | String that uniquely identifies this account resource. | [optional] |
-| **message_id** | **String** | String that uniquely identifies this message resource | [optional] |
-| **status** | [**MessageStatus**](MessageStatus.md) |  | [optional] |
-| **from** | **String** | Phone number in E.164 format that sent the message. | [optional] |
-| **to** | **String** | Phone number in E.164 format that received the message. | [optional] |
-| **text** | **String** | Message contents | [optional] |
-| **direction** | **String** | Noting whether the message was inbound or outbound | [optional] |
-| **notification_url** | **String** | URL invoked when message sent | [optional] |
-| **brand_id** | **String** | The unique identifier for the brand associated with the message | [optional] |
-| **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] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::MessageResultAllOf.new(
-  account_id: null,
-  message_id: null,
-  status: null,
-  from: null,
-  to: null,
-  text: null,
-  direction: null,
-  notification_url: null,
-  brand_id: null,
-  campaign_id: null,
-  segment_count: null,
-  media_urls: null
-)
-```
-

data/docs/MessagesListAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::MessagesListAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **messages** | [**Array<MessageResult>**](MessageResult.md) | Array of messages | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::MessagesListAllOf.new(
-  messages: null
-)
-```
-