Skip to content

Commit

Permalink
Use latest specification and generate new models;
Browse files Browse the repository at this point in the history
  • Loading branch information
ngarg-vail committed Dec 4, 2024
1 parent c57f331 commit 8faea13
Show file tree
Hide file tree
Showing 36 changed files with 1,045 additions and 163 deletions.
9 changes: 6 additions & 3 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ docs/SMSTollFreeCampaignRegistrationStatus.md
docs/SMSTollFreeCampaignsListResult.md
docs/Say.md
docs/SendDigits.md
docs/SetDTMFPassThrough.md
docs/SetListen.md
docs/SetTalk.md
docs/Sms.md
Expand All @@ -134,7 +135,7 @@ docs/TerminateConference.md
docs/TranscribeReason.md
docs/TranscribeTermReason.md
docs/TranscribeUtterance.md
docs/TranscribeUtteranceAllOfRecord.md
docs/TranscribeUtteranceRecord.md
docs/TranscribeWebhook.md
docs/Unpark.md
docs/UpdateCallRequest.md
Expand Down Expand Up @@ -252,6 +253,7 @@ lib/freeclimb/models/remove_from_queue_notification_webhook.rb
lib/freeclimb/models/request_type.rb
lib/freeclimb/models/say.rb
lib/freeclimb/models/send_digits.rb
lib/freeclimb/models/set_dtmf_pass_through.rb
lib/freeclimb/models/set_listen.rb
lib/freeclimb/models/set_talk.rb
lib/freeclimb/models/sms.rb
Expand All @@ -278,7 +280,7 @@ lib/freeclimb/models/tfn.rb
lib/freeclimb/models/transcribe_reason.rb
lib/freeclimb/models/transcribe_term_reason.rb
lib/freeclimb/models/transcribe_utterance.rb
lib/freeclimb/models/transcribe_utterance_all_of_record.rb
lib/freeclimb/models/transcribe_utterance_record.rb
lib/freeclimb/models/transcribe_webhook.rb
lib/freeclimb/models/unpark.rb
lib/freeclimb/models/update_call_request.rb
Expand Down Expand Up @@ -391,6 +393,7 @@ spec/models/remove_from_queue_notification_webhook_spec.rb
spec/models/request_type_spec.rb
spec/models/say_spec.rb
spec/models/send_digits_spec.rb
spec/models/set_dtmf_pass_through_spec.rb
spec/models/set_listen_spec.rb
spec/models/set_talk_spec.rb
spec/models/sms_spec.rb
Expand All @@ -416,7 +419,7 @@ spec/models/terminate_conference_spec.rb
spec/models/tfn_spec.rb
spec/models/transcribe_reason_spec.rb
spec/models/transcribe_term_reason_spec.rb
spec/models/transcribe_utterance_all_of_record_spec.rb
spec/models/transcribe_utterance_record_spec.rb
spec/models/transcribe_utterance_spec.rb
spec/models/transcribe_webhook_spec.rb
spec/models/unpark_spec.rb
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,7 @@ Class | Method | HTTP request | Description
- [Freeclimb::SMSTollFreeCampaignsListResult](docs/SMSTollFreeCampaignsListResult.md)
- [Freeclimb::Say](docs/Say.md)
- [Freeclimb::SendDigits](docs/SendDigits.md)
- [Freeclimb::SetDTMFPassThrough](docs/SetDTMFPassThrough.md)
- [Freeclimb::SetListen](docs/SetListen.md)
- [Freeclimb::SetTalk](docs/SetTalk.md)
- [Freeclimb::Sms](docs/Sms.md)
Expand All @@ -289,7 +290,7 @@ Class | Method | HTTP request | Description
- [Freeclimb::TranscribeReason](docs/TranscribeReason.md)
- [Freeclimb::TranscribeTermReason](docs/TranscribeTermReason.md)
- [Freeclimb::TranscribeUtterance](docs/TranscribeUtterance.md)
- [Freeclimb::TranscribeUtteranceAllOfRecord](docs/TranscribeUtteranceAllOfRecord.md)
- [Freeclimb::TranscribeUtteranceRecord](docs/TranscribeUtteranceRecord.md)
- [Freeclimb::TranscribeWebhook](docs/TranscribeWebhook.md)
- [Freeclimb::Unpark](docs/Unpark.md)
- [Freeclimb::UpdateCallRequest](docs/UpdateCallRequest.md)
Expand Down
4 changes: 3 additions & 1 deletion docs/AddToConference.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
| **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

Expand All @@ -28,7 +29,8 @@ instance = Freeclimb::AddToConference.new(
listen: null,
notification_url: null,
start_conf_on_enter: null,
talk: null
talk: null,
dtmf_pass_through: null
)
```

4 changes: 3 additions & 1 deletion docs/CallResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
| **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

Expand All @@ -48,7 +49,8 @@ instance = Freeclimb::CallResult.new(
connect_duration: null,
direction: null,
answered_by: null,
subresource_uris: null
subresource_uris: null,
application_id: null
)
```

2 changes: 2 additions & 0 deletions docs/ConferenceParticipantResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
| **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
Expand All @@ -30,6 +31,7 @@ instance = Freeclimb::ConferenceParticipantResult.new(
call_id: null,
talk: null,
listen: null,
dtmf_pass_through: null,
start_conf_on_enter: null
)
```
Expand Down
2 changes: 1 addition & 1 deletion docs/ConferenceResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -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] |
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateConference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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] |
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateConferenceRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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] |
Expand Down
4 changes: 3 additions & 1 deletion docs/DefaultApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -3169,7 +3169,8 @@ conference_id = 'conference_id_example' # String | ID of the conference this par

opts = {
talk: true, # Boolean | Only show Participants with the talk privilege.
listen: true # Boolean | Only show Participants with the listen privilege.
listen: true, # Boolean | Only show Participants with the listen privilege.
dtmf_pass_through: true # Boolean | Only show Participants with the dtmfPassThrough privilege.
}

begin
Expand Down Expand Up @@ -3207,6 +3208,7 @@ end
| **conference_id** | **String** | ID of the conference this participant is in. | |
| **talk** | **Boolean** | Only show Participants with the talk privilege. | [optional] |
| **listen** | **Boolean** | Only show Participants with the listen privilege. | [optional] |
| **dtmf_pass_through** | **Boolean** | Only show Participants with the dtmfPassThrough privilege. | [optional] |


### Return type
Expand Down
18 changes: 18 additions & 0 deletions docs/SetDTMFPassThrough.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Freeclimb::SetDTMFPassThrough

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **dtmf_pass_through** | **Boolean** | Specifying `false` mutes the Participant's dtmf audio. | [optional] |

## Example

```ruby
require 'freeclimb'

instance = Freeclimb::SetDTMFPassThrough.new(
dtmf_pass_through: null
)
```

4 changes: 2 additions & 2 deletions docs/TranscribeUtterance.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
| ---- | ---- | ----------- | ----- |
| **action_url** | **String** | | |
| **play_beep** | **Boolean** | | [optional][default to false] |
| **record** | [**TranscribeUtteranceAllOfRecord**](TranscribeUtteranceAllOfRecord.md) | | [optional] |
| **record** | [**TranscribeUtteranceRecord**](TranscribeUtteranceRecord.md) | | [optional] |
| **privacy_for_logging** | **Boolean** | | [optional][default to false] |
| **privacy_for_recording** | **Boolean** | | [optional][default to false] |
| **prompts** | **Array<Object>** | | [optional] |
| **prompts** | [**Array<PerclCommand>**](PerclCommand.md) | | [optional] |

## Example

Expand Down
4 changes: 3 additions & 1 deletion docs/UpdateConferenceParticipantRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
| ---- | ---- | ----------- | ----- |
| **talk** | **Boolean** | (Optional) Default is `true`. Setting to `false` mutes the Participant. FreeClimb returns an error and ignores any other value. | [optional] |
| **listen** | **Boolean** | (Optional) Default is `true`. Setting to `false` silences the Conference for this Participant. FreeClimb returns an error and ignores any other value. | [optional] |
| **dtmf_pass_through** | **Boolean** | (Optional) Default is `true`. Setting to `false` mutes dtmf audio for this Participant. FreeClimb returns an error and ignores any other value. | [optional] |

## Example

Expand All @@ -14,7 +15,8 @@ require 'freeclimb'

instance = Freeclimb::UpdateConferenceParticipantRequest.new(
talk: null,
listen: null
listen: null,
dtmf_pass_through: null
)
```

2 changes: 1 addition & 1 deletion docs/UpdateConferenceRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **_alias** | **String** | Description for this conference. Maximum 64 characters. | [optional] |
| **play_beep** | [**PlayBeep**](PlayBeep.md) | | [optional][default to 'always'] |
| **play_beep** | [**PlayBeep**](PlayBeep.md) | | [optional] |
| **status** | [**UpdateConferenceRequestStatus**](UpdateConferenceRequestStatus.md) | | [optional] |

## Example
Expand Down
3 changes: 2 additions & 1 deletion lib/freeclimb.rb
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
require 'freeclimb/models/tfn'
require 'freeclimb/models/transcribe_reason'
require 'freeclimb/models/transcribe_term_reason'
require 'freeclimb/models/transcribe_utterance_all_of_record'
require 'freeclimb/models/transcribe_utterance_record'
require 'freeclimb/models/update_call_request'
require 'freeclimb/models/update_call_request_status'
require 'freeclimb/models/update_conference_participant_request'
Expand Down Expand Up @@ -147,6 +147,7 @@
require 'freeclimb/models/remove_from_queue_notification_webhook'
require 'freeclimb/models/say'
require 'freeclimb/models/send_digits'
require 'freeclimb/models/set_dtmf_pass_through'
require 'freeclimb/models/set_listen'
require 'freeclimb/models/set_talk'
require 'freeclimb/models/sms'
Expand Down
3 changes: 3 additions & 0 deletions lib/freeclimb/api/default_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2720,6 +2720,7 @@ def list_members_with_http_info(queue_id, opts = {})
# @param [Hash] opts the optional parameters
# @option opts [Boolean] :talk Only show Participants with the talk privilege.
# @option opts [Boolean] :listen Only show Participants with the listen privilege.
# @option opts [Boolean] :dtmf_pass_through Only show Participants with the dtmfPassThrough privilege.
# @return [ConferenceParticipantList]
def list_participants(conference_id, opts = {})
data, _status_code, _headers = list_participants_with_http_info(conference_id, opts)
Expand All @@ -2731,6 +2732,7 @@ def list_participants(conference_id, opts = {})
# @param [Hash] opts the optional parameters
# @option opts [Boolean] :talk Only show Participants with the talk privilege.
# @option opts [Boolean] :listen Only show Participants with the listen privilege.
# @option opts [Boolean] :dtmf_pass_through Only show Participants with the dtmfPassThrough privilege.
# @return [Array<(ConferenceParticipantList, Integer, Hash)>] ConferenceParticipantList data, response status code and response headers
def list_participants_with_http_info(conference_id, opts = {})
if @api_client.config.debugging
Expand All @@ -2748,6 +2750,7 @@ def list_participants_with_http_info(conference_id, opts = {})
query_params = opts[:query_params] || {}
query_params[:'talk'] = opts[:'talk'] if !opts[:'talk'].nil?
query_params[:'listen'] = opts[:'listen'] if !opts[:'listen'].nil?
query_params[:'dtmfPassThrough'] = opts[:'dtmf_pass_through'] if !opts[:'dtmf_pass_through'].nil?

# header parameters
header_params = opts[:header_params] || {}
Expand Down
18 changes: 14 additions & 4 deletions lib/freeclimb/models/add_to_conference.rb
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ class AddToConference < PerclCommand
# If `true`, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or `SetTalk` PerCL command.
attr_accessor :talk

# If `true`, the Participant joins the Conference with dtmfPassThrough privileges. This may be modified later via the REST API or `SetDTMFPassThrough` PerCL command.
attr_accessor :dtmf_pass_through

# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
Expand All @@ -54,7 +57,8 @@ def self.attribute_map
:'listen' => :'listen',
:'notification_url' => :'notificationUrl',
:'start_conf_on_enter' => :'startConfOnEnter',
:'talk' => :'talk'
:'talk' => :'talk',
:'dtmf_pass_through' => :'dtmfPassThrough'
}
end

Expand All @@ -74,7 +78,8 @@ def self.openapi_types
:'listen' => :'Boolean',
:'notification_url' => :'String',
:'start_conf_on_enter' => :'Boolean',
:'talk' => :'Boolean'
:'talk' => :'Boolean',
:'dtmf_pass_through' => :'Boolean'
}
end

Expand Down Expand Up @@ -144,6 +149,10 @@ def initialize(attributes = {})
if attributes.key?(:'talk')
self.talk = attributes[:'talk']
end

if attributes.key?(:'dtmf_pass_through')
self.dtmf_pass_through = attributes[:'dtmf_pass_through']
end
self.command = "AddToConference"
end

Expand Down Expand Up @@ -182,7 +191,8 @@ def ==(o)
listen == o.listen &&
notification_url == o.notification_url &&
start_conf_on_enter == o.start_conf_on_enter &&
talk == o.talk && super(o)
talk == o.talk &&
dtmf_pass_through == o.dtmf_pass_through && super(o)
end

# @see the `==` method
Expand All @@ -194,7 +204,7 @@ def eql?(o)
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
def hash
[allow_call_control, call_control_sequence, call_control_url, conference_id, leave_conference_url, listen, notification_url, start_conf_on_enter, talk].hash
[allow_call_control, call_control_sequence, call_control_url, conference_id, leave_conference_url, listen, notification_url, start_conf_on_enter, talk, dtmf_pass_through].hash
end

# Builds the object from hash
Expand Down
21 changes: 16 additions & 5 deletions lib/freeclimb/models/call_result.rb
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@ class CallResult
# The list of subresources for this Call. These include things like logs and recordings associated with the Call.
attr_accessor :subresource_uris

# ApplicationId associated with the Call.
attr_accessor :application_id

class EnumAttributeValidator
attr_reader :datatype
attr_reader :allowable_values
Expand Down Expand Up @@ -112,7 +115,8 @@ def self.attribute_map
:'connect_duration' => :'connectDuration',
:'direction' => :'direction',
:'answered_by' => :'answeredBy',
:'subresource_uris' => :'subresourceUris'
:'subresource_uris' => :'subresourceUris',
:'application_id' => :'applicationId'
}
end

Expand Down Expand Up @@ -142,7 +146,8 @@ def self.openapi_types
:'connect_duration' => :'Integer',
:'direction' => :'CallDirection',
:'answered_by' => :'AnsweredBy',
:'subresource_uris' => :'Object'
:'subresource_uris' => :'Object',
:'application_id' => :'String'
}
end

Expand All @@ -163,7 +168,8 @@ def self.openapi_nullable
:'connect_duration',
:'direction',
:'answered_by',
:'subresource_uris'
:'subresource_uris',
:'application_id'
])
end

Expand Down Expand Up @@ -264,6 +270,10 @@ def initialize(attributes = {})
if attributes.key?(:'subresource_uris')
self.subresource_uris = attributes[:'subresource_uris']
end

if attributes.key?(:'application_id')
self.application_id = attributes[:'application_id']
end
end

# Show invalid properties with the reasons. Usually used together with valid?
Expand Down Expand Up @@ -307,7 +317,8 @@ def ==(o)
connect_duration == o.connect_duration &&
direction == o.direction &&
answered_by == o.answered_by &&
subresource_uris == o.subresource_uris
subresource_uris == o.subresource_uris &&
application_id == o.application_id
end

# @see the `==` method
Expand All @@ -319,7 +330,7 @@ def eql?(o)
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
def hash
[uri, date_created, date_updated, revision, call_id, parent_call_id, account_id, from, to, phone_number_id, call_status, start_time, connect_time, end_time, duration, connect_duration, direction, answered_by, subresource_uris].hash
[uri, date_created, date_updated, revision, call_id, parent_call_id, account_id, from, to, phone_number_id, call_status, start_time, connect_time, end_time, duration, connect_duration, direction, answered_by, subresource_uris, application_id].hash
end

# Builds the object from hash
Expand Down
Loading

0 comments on commit 8faea13

Please sign in to comment.