freeclimb 1.0.0 → 2.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +69 -50
- data/docs/AccountRequest.md +3 -5
- data/docs/AccountResult.md +12 -12
- data/docs/AccountResultAllOf.md +8 -8
- data/docs/AddToConference.md +35 -0
- data/docs/AddToConferenceAllOf.md +35 -0
- data/docs/ApplicationList.md +9 -9
- data/docs/ApplicationListAllOf.md +2 -2
- data/docs/ApplicationRequest.md +8 -10
- data/docs/ApplicationResult.md +14 -14
- data/docs/ApplicationResultAllOf.md +10 -10
- data/docs/AvailableNumber.md +7 -7
- data/docs/AvailableNumberList.md +9 -9
- data/docs/AvailableNumberListAllOf.md +2 -2
- data/docs/BuyIncomingNumberRequest.md +4 -6
- data/docs/CallList.md +9 -9
- data/docs/CallListAllOf.md +2 -2
- data/docs/CallResult.md +20 -20
- data/docs/CallResultAllOf.md +16 -16
- data/docs/ConferenceList.md +9 -9
- data/docs/ConferenceListAllOf.md +2 -2
- data/docs/ConferenceParticipantList.md +9 -9
- data/docs/ConferenceParticipantListAllOf.md +2 -2
- data/docs/ConferenceParticipantResult.md +11 -11
- data/docs/ConferenceParticipantResultAllOf.md +7 -7
- data/docs/ConferenceResult.md +15 -15
- data/docs/ConferenceResultAllOf.md +11 -11
- data/docs/CreateConference.md +27 -0
- data/docs/CreateConferenceAllOf.md +27 -0
- data/docs/CreateConferenceRequest.md +6 -8
- data/docs/DefaultApi.md +70 -86
- data/docs/Dequeue.md +16 -0
- data/docs/Enqueue.md +23 -0
- data/docs/EnqueueAllOf.md +23 -0
- data/docs/FilterLogsRequest.md +2 -4
- data/docs/GetDigits.md +33 -0
- data/docs/GetDigitsAllOf.md +33 -0
- data/docs/GetSpeech.md +41 -0
- data/docs/GetSpeechAllOf.md +41 -0
- data/docs/IncomingNumberList.md +9 -9
- data/docs/IncomingNumberListAllOf.md +2 -2
- data/docs/IncomingNumberRequest.md +3 -5
- data/docs/IncomingNumberResult.md +14 -14
- data/docs/IncomingNumberResultAllOf.md +10 -10
- data/docs/LogList.md +9 -9
- data/docs/LogListAllOf.md +2 -2
- data/docs/LogResult.md +8 -8
- data/docs/MakeCallRequest.md +11 -11
- data/docs/MessageRequest.md +10 -12
- data/docs/MessageRequestAllOf.md +6 -8
- data/docs/MessageResult.md +13 -13
- data/docs/MessageResultAllOf.md +9 -9
- data/docs/MessagesList.md +9 -9
- data/docs/MessagesListAllOf.md +2 -2
- data/docs/MutableResourceModel.md +5 -5
- data/docs/OutDial.md +35 -0
- data/docs/OutDialAllOf.md +35 -0
- data/docs/PaginationModel.md +8 -8
- data/docs/Pause.md +17 -0
- data/docs/PauseAllOf.md +17 -0
- data/docs/PerclCommand.md +17 -0
- data/docs/PerclScript.md +17 -0
- data/docs/Play.md +23 -0
- data/docs/PlayAllOf.md +23 -0
- data/docs/PlayEarlyMedia.md +17 -0
- data/docs/PlayEarlyMediaAllOf.md +17 -0
- data/docs/QueueList.md +9 -9
- data/docs/QueueListAllOf.md +2 -2
- data/docs/QueueMember.md +6 -6
- data/docs/QueueMemberList.md +9 -9
- data/docs/QueueMemberListAllOf.md +2 -2
- data/docs/QueueRequest.md +3 -5
- data/docs/QueueResult.md +12 -12
- data/docs/QueueResultAllOf.md +8 -8
- data/docs/RecordUtterance.md +27 -0
- data/docs/RecordUtteranceAllOf.md +27 -0
- data/docs/RecordingList.md +9 -9
- data/docs/RecordingListAllOf.md +2 -2
- data/docs/RecordingResult.md +10 -10
- data/docs/RecordingResultAllOf.md +6 -6
- data/docs/Redirect.md +17 -0
- data/docs/RedirectAllOf.md +17 -0
- data/docs/RemoveFromConference.md +17 -0
- data/docs/RemoveFromConferenceAllOf.md +17 -0
- data/docs/Say.md +25 -0
- data/docs/SayAllOf.md +25 -0
- data/docs/SendDigits.md +21 -0
- data/docs/SendDigitsAllOf.md +21 -0
- data/docs/SetListen.md +19 -0
- data/docs/SetListenAllOf.md +19 -0
- data/docs/SetTalk.md +19 -0
- data/docs/SetTalkAllOf.md +19 -0
- data/docs/Sms.md +23 -0
- data/docs/SmsAllOf.md +23 -0
- data/docs/StartRecordCall.md +16 -0
- data/docs/TerminateConference.md +17 -0
- data/docs/TerminateConferenceAllOf.md +17 -0
- data/docs/UpdateCallRequest.md +2 -4
- data/docs/UpdateConferenceParticipantRequest.md +3 -5
- data/docs/UpdateConferenceRequest.md +4 -6
- data/lib/freeclimb.rb +69 -2
- data/lib/freeclimb/api/default_api.rb +96 -88
- data/lib/freeclimb/api_client.rb +1 -1
- data/lib/freeclimb/models/account_request.rb +4 -14
- data/lib/freeclimb/models/add_to_conference.rb +320 -0
- data/lib/freeclimb/models/add_to_conference_all_of.rb +307 -0
- data/lib/freeclimb/models/application_request.rb +4 -14
- data/lib/freeclimb/models/buy_incoming_number_request.rb +4 -14
- data/lib/freeclimb/models/create_conference.rb +275 -0
- data/lib/freeclimb/models/create_conference_all_of.rb +262 -0
- data/lib/freeclimb/models/create_conference_request.rb +4 -14
- data/lib/freeclimb/models/dequeue.rb +209 -0
- data/lib/freeclimb/models/enqueue.rb +265 -0
- data/lib/freeclimb/models/enqueue_all_of.rb +252 -0
- data/lib/freeclimb/models/filter_logs_request.rb +4 -14
- data/lib/freeclimb/models/get_digits.rb +307 -0
- data/lib/freeclimb/models/get_digits_all_of.rb +294 -0
- data/lib/freeclimb/models/get_speech.rb +352 -0
- data/lib/freeclimb/models/get_speech_all_of.rb +339 -0
- data/lib/freeclimb/models/incoming_number_request.rb +4 -14
- data/lib/freeclimb/models/make_call_request.rb +14 -14
- data/lib/freeclimb/models/message_request.rb +1 -11
- data/lib/freeclimb/models/message_request_all_of.rb +1 -11
- data/lib/freeclimb/models/out_dial.rb +330 -0
- data/lib/freeclimb/models/out_dial_all_of.rb +317 -0
- data/lib/freeclimb/models/pause.rb +225 -0
- data/lib/freeclimb/models/{dequeue_member_request.rb → pause_all_of.rb} +16 -11
- data/lib/freeclimb/models/percl_command.rb +211 -0
- data/lib/freeclimb/models/percl_script.rb +210 -0
- data/lib/freeclimb/models/play.rb +255 -0
- data/lib/freeclimb/models/play_all_of.rb +242 -0
- data/lib/freeclimb/models/play_early_media.rb +225 -0
- data/lib/freeclimb/models/play_early_media_all_of.rb +212 -0
- data/lib/freeclimb/models/queue_request.rb +4 -14
- data/lib/freeclimb/models/record_utterance.rb +275 -0
- data/lib/freeclimb/models/record_utterance_all_of.rb +262 -0
- data/lib/freeclimb/models/redirect.rb +220 -0
- data/lib/freeclimb/models/redirect_all_of.rb +207 -0
- data/lib/freeclimb/models/remove_from_conference.rb +225 -0
- data/lib/freeclimb/models/remove_from_conference_all_of.rb +212 -0
- data/lib/freeclimb/models/say.rb +265 -0
- data/lib/freeclimb/models/say_all_of.rb +252 -0
- data/lib/freeclimb/models/send_digits.rb +245 -0
- data/lib/freeclimb/models/send_digits_all_of.rb +232 -0
- data/lib/freeclimb/models/set_listen.rb +235 -0
- data/lib/freeclimb/models/set_listen_all_of.rb +222 -0
- data/lib/freeclimb/models/set_talk.rb +235 -0
- data/lib/freeclimb/models/set_talk_all_of.rb +222 -0
- data/lib/freeclimb/models/sms.rb +265 -0
- data/lib/freeclimb/models/sms_all_of.rb +252 -0
- data/lib/freeclimb/models/start_record_call.rb +209 -0
- data/lib/freeclimb/models/terminate_conference.rb +225 -0
- data/lib/freeclimb/models/terminate_conference_all_of.rb +212 -0
- data/lib/freeclimb/models/update_call_request.rb +4 -14
- data/lib/freeclimb/models/update_conference_participant_request.rb +4 -14
- data/lib/freeclimb/models/update_conference_request.rb +4 -14
- data/lib/freeclimb/version.rb +1 -1
- data/spec/api/default_api_spec.rb +9 -24
- data/spec/models/add_to_conference_spec.rb +95 -0
- data/spec/models/create_conference_spec.rb +71 -0
- data/spec/models/{dequeue_member_request_spec.rb → dequeue_spec.rb} +8 -7
- data/spec/models/enqueue_spec.rb +59 -0
- data/spec/models/get_digits_spec.rb +83 -0
- data/spec/models/get_speech_spec.rb +113 -0
- data/spec/models/out_dial_spec.rb +89 -0
- data/spec/models/pause_spec.rb +41 -0
- data/spec/models/percl_command_spec.rb +41 -0
- data/spec/models/percl_script_spec.rb +41 -0
- data/spec/models/play_early_media_spec.rb +41 -0
- data/spec/models/play_spec.rb +53 -0
- data/spec/models/record_utterance_spec.rb +71 -0
- data/spec/models/redirect_spec.rb +41 -0
- data/spec/models/remove_from_conference_spec.rb +41 -0
- data/spec/models/say_spec.rb +65 -0
- data/spec/models/send_digits_spec.rb +47 -0
- data/spec/models/set_listen_spec.rb +47 -0
- data/spec/models/set_talk_spec.rb +47 -0
- data/spec/models/sms_spec.rb +59 -0
- data/spec/models/start_record_call_spec.rb +35 -0
- data/spec/models/terminate_conference_spec.rb +41 -0
- metadata +126 -35
- data/docs/DequeueMemberRequest.md +0 -17
- data/docs/Percl.md +0 -697
- data/git_push.sh +0 -58
- data/lib/percl/calls.rb +0 -43
- data/lib/percl/conference_participants.rb +0 -40
- data/lib/percl/conferences.rb +0 -21
- data/lib/percl/ivr.rb +0 -63
- data/lib/percl/jsonable.rb +0 -23
- data/lib/percl/percl.rb +0 -29
- data/lib/percl/queue_members.rb +0 -15
- data/lib/percl/recordings.rb +0 -15
- data/lib/percl/sms.rb +0 -11
- data/spec/percl/calls_spec.rb +0 -111
- data/spec/percl/conference_participant_spec.rb +0 -96
- data/spec/percl/conference_spec.rb +0 -46
- data/spec/percl/ivr_spec.rb +0 -155
- data/spec/percl/jsonable_spec.rb +0 -28
- data/spec/percl/percl_spec.rb +0 -31
- data/spec/percl/queue_members_spec.rb +0 -35
- data/spec/percl/recordings_spec.rb +0 -32
- data/spec/percl/sms_spec.rb +0 -29
@@ -18,18 +18,18 @@ Name | Type | Description | Notes
|
|
18
18
|
## Code Sample
|
19
19
|
|
20
20
|
```ruby
|
21
|
-
require '
|
21
|
+
require 'freeclimb'
|
22
22
|
|
23
|
-
instance = Freeclimb::ConferenceResultAllOf.new(conference_id:
|
24
|
-
account_id:
|
25
|
-
_alias:
|
26
|
-
play_beep:
|
27
|
-
record:
|
28
|
-
status:
|
29
|
-
wait_url:
|
30
|
-
action_url:
|
31
|
-
status_callback_url:
|
32
|
-
subresource_uris:
|
23
|
+
instance = Freeclimb::ConferenceResultAllOf.new(conference_id: nil,
|
24
|
+
account_id: nil,
|
25
|
+
_alias: nil,
|
26
|
+
play_beep: nil,
|
27
|
+
record: nil,
|
28
|
+
status: nil,
|
29
|
+
wait_url: nil,
|
30
|
+
action_url: nil,
|
31
|
+
status_callback_url: nil,
|
32
|
+
subresource_uris: nil)
|
33
33
|
```
|
34
34
|
|
35
35
|
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# Freeclimb::CreateConference
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
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. |
|
8
|
+
**_alias** | **Boolean** | Descriptive name for the Conference. | [optional]
|
9
|
+
**play_beep** | **String** | Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` | [optional]
|
10
|
+
**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]
|
11
|
+
**status_callback_url** | **Boolean** | This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. | [optional]
|
12
|
+
**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]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'freeclimb'
|
18
|
+
|
19
|
+
instance = Freeclimb::CreateConference.new(action_url: nil,
|
20
|
+
_alias: nil,
|
21
|
+
play_beep: nil,
|
22
|
+
record: nil,
|
23
|
+
status_callback_url: nil,
|
24
|
+
wait_url: nil)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# Freeclimb::CreateConferenceAllOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
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. |
|
8
|
+
**_alias** | **Boolean** | Descriptive name for the Conference. | [optional]
|
9
|
+
**play_beep** | **String** | Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` | [optional]
|
10
|
+
**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]
|
11
|
+
**status_callback_url** | **Boolean** | This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. | [optional]
|
12
|
+
**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]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'freeclimb'
|
18
|
+
|
19
|
+
instance = Freeclimb::CreateConferenceAllOf.new(action_url: nil,
|
20
|
+
_alias: nil,
|
21
|
+
play_beep: nil,
|
22
|
+
record: nil,
|
23
|
+
status_callback_url: nil,
|
24
|
+
wait_url: nil)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -9,19 +9,17 @@ Name | Type | Description | Notes
|
|
9
9
|
**record** | **Boolean** | Setting to `true` records the entire Conference. | [optional]
|
10
10
|
**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]
|
11
11
|
**status_callback_url** | **String** | This URL is invoked when the status of the Conference changes. For more information, see **statusCallbackUrl** (below). | [optional]
|
12
|
-
**request_id** | **String** | The requestId for this request starting with prefix \"RQ\" followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request will include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response (e.g., X-Pulse-Request-Id: <requestId>). | [optional]
|
13
12
|
|
14
13
|
## Code Sample
|
15
14
|
|
16
15
|
```ruby
|
17
|
-
require '
|
16
|
+
require 'freeclimb'
|
18
17
|
|
19
|
-
instance = Freeclimb::CreateConferenceRequest.new(_alias:
|
20
|
-
play_beep:
|
21
|
-
record:
|
22
|
-
wait_url:
|
23
|
-
status_callback_url:
|
24
|
-
request_id: null)
|
18
|
+
instance = Freeclimb::CreateConferenceRequest.new(_alias: nil,
|
19
|
+
play_beep: nil,
|
20
|
+
record: nil,
|
21
|
+
wait_url: nil,
|
22
|
+
status_callback_url: nil)
|
25
23
|
```
|
26
24
|
|
27
25
|
|
data/docs/DefaultApi.md
CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**get_an_account**](DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
|
7
8
|
[**buy_a_phone_number**](DefaultApi.md#buy_a_phone_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers | Buy a Phone Number
|
8
9
|
[**create_a_conference**](DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference
|
9
10
|
[**create_a_queue**](DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue
|
@@ -21,7 +22,6 @@ Method | HTTP request | Description
|
|
21
22
|
[**get_a_participant**](DefaultApi.md#get_a_participant) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Get a Participant
|
22
23
|
[**get_a_queue**](DefaultApi.md#get_a_queue) | **GET** /Accounts/{accountId}/Queues/{queueId} | Get a Queue
|
23
24
|
[**get_a_recording**](DefaultApi.md#get_a_recording) | **GET** /Accounts/{accountId}/Recordings/{recordingId} | Get a Recording
|
24
|
-
[**get_an_account**](DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
|
25
25
|
[**get_an_application**](DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application
|
26
26
|
[**get_an_incoming_number**](DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number
|
27
27
|
[**get_an_sms_message**](DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message
|
@@ -53,9 +53,56 @@ Method | HTTP request | Description
|
|
53
53
|
|
54
54
|
|
55
55
|
|
56
|
+
## get_an_account
|
57
|
+
|
58
|
+
> AccountResult get_an_account
|
59
|
+
|
60
|
+
Get an Account
|
61
|
+
|
62
|
+
### Example
|
63
|
+
|
64
|
+
```ruby
|
65
|
+
# load the gem
|
66
|
+
require 'freeclimb'
|
67
|
+
# setup authorization
|
68
|
+
Freeclimb.configure do |config|
|
69
|
+
# Configure HTTP basic authorization: fc
|
70
|
+
config.username = 'ACCOUNT ID'
|
71
|
+
config.password = 'AUTH TOKEN'
|
72
|
+
end
|
73
|
+
|
74
|
+
api_instance = Freeclimb::DefaultApi.new
|
75
|
+
|
76
|
+
begin
|
77
|
+
#Get an Account
|
78
|
+
result = api_instance.get_an_account
|
79
|
+
p result
|
80
|
+
rescue Freeclimb::ApiError => e
|
81
|
+
puts "Exception when calling DefaultApi->get_an_account: #{e}"
|
82
|
+
end
|
83
|
+
```
|
84
|
+
|
85
|
+
### Parameters
|
86
|
+
|
87
|
+
This endpoint does not need any parameter.
|
88
|
+
|
89
|
+
### Return type
|
90
|
+
|
91
|
+
[**AccountResult**](AccountResult.md)
|
92
|
+
|
93
|
+
### Authorization
|
94
|
+
|
95
|
+
[fc](../README.md#fc)
|
96
|
+
|
97
|
+
### HTTP request headers
|
98
|
+
|
99
|
+
- **Content-Type**: Not defined
|
100
|
+
- **Accept**: application/json
|
101
|
+
|
102
|
+
|
56
103
|
## buy_a_phone_number
|
57
104
|
|
58
|
-
> IncomingNumberResult buy_a_phone_number(
|
105
|
+
> IncomingNumberResult buy_a_phone_number(buy_incoming_number_request)
|
59
106
|
|
60
107
|
Buy a Phone Number
|
61
108
|
|
@@ -72,13 +119,11 @@ Freeclimb.configure do |config|
|
|
72
119
|
end
|
73
120
|
|
74
121
|
api_instance = Freeclimb::DefaultApi.new
|
75
|
-
|
76
|
-
buy_incoming_number_request: Freeclimb::BuyIncomingNumberRequest.new # BuyIncomingNumberRequest | Incoming Number transaction details
|
77
|
-
}
|
122
|
+
buy_incoming_number_request = Freeclimb::BuyIncomingNumberRequest.new # BuyIncomingNumberRequest | Incoming Number transaction details
|
78
123
|
|
79
124
|
begin
|
80
125
|
#Buy a Phone Number
|
81
|
-
result = api_instance.buy_a_phone_number(
|
126
|
+
result = api_instance.buy_a_phone_number(buy_incoming_number_request)
|
82
127
|
p result
|
83
128
|
rescue Freeclimb::ApiError => e
|
84
129
|
puts "Exception when calling DefaultApi->buy_a_phone_number: #{e}"
|
@@ -90,7 +135,7 @@ end
|
|
90
135
|
|
91
136
|
Name | Type | Description | Notes
|
92
137
|
------------- | ------------- | ------------- | -------------
|
93
|
-
**buy_incoming_number_request** | [**BuyIncomingNumberRequest**](BuyIncomingNumberRequest.md)| Incoming Number transaction details |
|
138
|
+
**buy_incoming_number_request** | [**BuyIncomingNumberRequest**](BuyIncomingNumberRequest.md)| Incoming Number transaction details |
|
94
139
|
|
95
140
|
### Return type
|
96
141
|
|
@@ -417,7 +462,7 @@ nil (empty response body)
|
|
417
462
|
|
418
463
|
## dequeue_a_member
|
419
464
|
|
420
|
-
> QueueMember dequeue_a_member(queue_id, call_id
|
465
|
+
> QueueMember dequeue_a_member(queue_id, call_id)
|
421
466
|
|
422
467
|
Dequeue a Member
|
423
468
|
|
@@ -436,13 +481,10 @@ end
|
|
436
481
|
api_instance = Freeclimb::DefaultApi.new
|
437
482
|
queue_id = 'queue_id_example' # String | String that uniquely identifies the Queue that the Member belongs to.
|
438
483
|
call_id = 'call_id_example' # String | ID if the Call that the Member belongs to
|
439
|
-
opts = {
|
440
|
-
dequeue_member_request: Freeclimb::DequeueMemberRequest.new # DequeueMemberRequest | Dequeue member request details
|
441
|
-
}
|
442
484
|
|
443
485
|
begin
|
444
486
|
#Dequeue a Member
|
445
|
-
result = api_instance.dequeue_a_member(queue_id, call_id
|
487
|
+
result = api_instance.dequeue_a_member(queue_id, call_id)
|
446
488
|
p result
|
447
489
|
rescue Freeclimb::ApiError => e
|
448
490
|
puts "Exception when calling DefaultApi->dequeue_a_member: #{e}"
|
@@ -456,7 +498,6 @@ Name | Type | Description | Notes
|
|
456
498
|
------------- | ------------- | ------------- | -------------
|
457
499
|
**queue_id** | **String**| String that uniquely identifies the Queue that the Member belongs to. |
|
458
500
|
**call_id** | **String**| ID if the Call that the Member belongs to |
|
459
|
-
**dequeue_member_request** | [**DequeueMemberRequest**](DequeueMemberRequest.md)| Dequeue member request details | [optional]
|
460
501
|
|
461
502
|
### Return type
|
462
503
|
|
@@ -468,13 +509,13 @@ Name | Type | Description | Notes
|
|
468
509
|
|
469
510
|
### HTTP request headers
|
470
511
|
|
471
|
-
- **Content-Type**:
|
512
|
+
- **Content-Type**: Not defined
|
472
513
|
- **Accept**: application/json
|
473
514
|
|
474
515
|
|
475
516
|
## dequeue_head_member
|
476
517
|
|
477
|
-
> QueueMember dequeue_head_member(queue_id
|
518
|
+
> QueueMember dequeue_head_member(queue_id)
|
478
519
|
|
479
520
|
Dequeue Head Member
|
480
521
|
|
@@ -492,13 +533,10 @@ end
|
|
492
533
|
|
493
534
|
api_instance = Freeclimb::DefaultApi.new
|
494
535
|
queue_id = 'queue_id_example' # String | String that uniquely identifies this queue resource.
|
495
|
-
opts = {
|
496
|
-
dequeue_member_request: Freeclimb::DequeueMemberRequest.new # DequeueMemberRequest | Dequeue head member request details
|
497
|
-
}
|
498
536
|
|
499
537
|
begin
|
500
538
|
#Dequeue Head Member
|
501
|
-
result = api_instance.dequeue_head_member(queue_id
|
539
|
+
result = api_instance.dequeue_head_member(queue_id)
|
502
540
|
p result
|
503
541
|
rescue Freeclimb::ApiError => e
|
504
542
|
puts "Exception when calling DefaultApi->dequeue_head_member: #{e}"
|
@@ -511,7 +549,6 @@ end
|
|
511
549
|
Name | Type | Description | Notes
|
512
550
|
------------- | ------------- | ------------- | -------------
|
513
551
|
**queue_id** | **String**| String that uniquely identifies this queue resource. |
|
514
|
-
**dequeue_member_request** | [**DequeueMemberRequest**](DequeueMemberRequest.md)| Dequeue head member request details | [optional]
|
515
552
|
|
516
553
|
### Return type
|
517
554
|
|
@@ -523,7 +560,7 @@ Name | Type | Description | Notes
|
|
523
560
|
|
524
561
|
### HTTP request headers
|
525
562
|
|
526
|
-
- **Content-Type**:
|
563
|
+
- **Content-Type**: Not defined
|
527
564
|
- **Accept**: application/json
|
528
565
|
|
529
566
|
|
@@ -580,7 +617,7 @@ Name | Type | Description | Notes
|
|
580
617
|
|
581
618
|
## filter_logs
|
582
619
|
|
583
|
-
> LogList filter_logs(
|
620
|
+
> LogList filter_logs(filter_logs_request)
|
584
621
|
|
585
622
|
Filter Logs
|
586
623
|
|
@@ -597,13 +634,11 @@ Freeclimb.configure do |config|
|
|
597
634
|
end
|
598
635
|
|
599
636
|
api_instance = Freeclimb::DefaultApi.new
|
600
|
-
|
601
|
-
filter_logs_request: Freeclimb::FilterLogsRequest.new # FilterLogsRequest | Filter logs request paramters
|
602
|
-
}
|
637
|
+
filter_logs_request = Freeclimb::FilterLogsRequest.new # FilterLogsRequest | Filter logs request paramters
|
603
638
|
|
604
639
|
begin
|
605
640
|
#Filter Logs
|
606
|
-
result = api_instance.filter_logs(
|
641
|
+
result = api_instance.filter_logs(filter_logs_request)
|
607
642
|
p result
|
608
643
|
rescue Freeclimb::ApiError => e
|
609
644
|
puts "Exception when calling DefaultApi->filter_logs: #{e}"
|
@@ -615,7 +650,7 @@ end
|
|
615
650
|
|
616
651
|
Name | Type | Description | Notes
|
617
652
|
------------- | ------------- | ------------- | -------------
|
618
|
-
**filter_logs_request** | [**FilterLogsRequest**](FilterLogsRequest.md)| Filter logs request paramters |
|
653
|
+
**filter_logs_request** | [**FilterLogsRequest**](FilterLogsRequest.md)| Filter logs request paramters |
|
619
654
|
|
620
655
|
### Return type
|
621
656
|
|
@@ -941,53 +976,6 @@ Name | Type | Description | Notes
|
|
941
976
|
- **Accept**: application/json
|
942
977
|
|
943
978
|
|
944
|
-
## get_an_account
|
945
|
-
|
946
|
-
> AccountResult get_an_account
|
947
|
-
|
948
|
-
Get an Account
|
949
|
-
|
950
|
-
### Example
|
951
|
-
|
952
|
-
```ruby
|
953
|
-
# load the gem
|
954
|
-
require 'freeclimb'
|
955
|
-
# setup authorization
|
956
|
-
Freeclimb.configure do |config|
|
957
|
-
# Configure HTTP basic authorization: fc
|
958
|
-
config.username = 'ACCOUNT ID'
|
959
|
-
config.password = 'AUTH TOKEN'
|
960
|
-
end
|
961
|
-
|
962
|
-
api_instance = Freeclimb::DefaultApi.new
|
963
|
-
|
964
|
-
begin
|
965
|
-
#Get an Account
|
966
|
-
result = api_instance.get_an_account
|
967
|
-
p result
|
968
|
-
rescue Freeclimb::ApiError => e
|
969
|
-
puts "Exception when calling DefaultApi->get_an_account: #{e}"
|
970
|
-
end
|
971
|
-
```
|
972
|
-
|
973
|
-
### Parameters
|
974
|
-
|
975
|
-
This endpoint does not need any parameter.
|
976
|
-
|
977
|
-
### Return type
|
978
|
-
|
979
|
-
[**AccountResult**](AccountResult.md)
|
980
|
-
|
981
|
-
### Authorization
|
982
|
-
|
983
|
-
[fc](../README.md#fc)
|
984
|
-
|
985
|
-
### HTTP request headers
|
986
|
-
|
987
|
-
- **Content-Type**: Not defined
|
988
|
-
- **Accept**: application/json
|
989
|
-
|
990
|
-
|
991
979
|
## get_an_application
|
992
980
|
|
993
981
|
> ApplicationResult get_an_application(application_id)
|
@@ -2018,7 +2006,7 @@ nil (empty response body)
|
|
2018
2006
|
|
2019
2007
|
## send_an_sms_message
|
2020
2008
|
|
2021
|
-
> MessageResult send_an_sms_message(
|
2009
|
+
> MessageResult send_an_sms_message(message_request)
|
2022
2010
|
|
2023
2011
|
Send an SMS Message
|
2024
2012
|
|
@@ -2035,13 +2023,11 @@ Freeclimb.configure do |config|
|
|
2035
2023
|
end
|
2036
2024
|
|
2037
2025
|
api_instance = Freeclimb::DefaultApi.new
|
2038
|
-
|
2039
|
-
message_request: Freeclimb::MessageRequest.new # MessageRequest | Details to create a message
|
2040
|
-
}
|
2026
|
+
message_request = Freeclimb::MessageRequest.new # MessageRequest | Details to create a message
|
2041
2027
|
|
2042
2028
|
begin
|
2043
2029
|
#Send an SMS Message
|
2044
|
-
result = api_instance.send_an_sms_message(
|
2030
|
+
result = api_instance.send_an_sms_message(message_request)
|
2045
2031
|
p result
|
2046
2032
|
rescue Freeclimb::ApiError => e
|
2047
2033
|
puts "Exception when calling DefaultApi->send_an_sms_message: #{e}"
|
@@ -2053,7 +2039,7 @@ end
|
|
2053
2039
|
|
2054
2040
|
Name | Type | Description | Notes
|
2055
2041
|
------------- | ------------- | ------------- | -------------
|
2056
|
-
**message_request** | [**MessageRequest**](MessageRequest.md)| Details to create a message |
|
2042
|
+
**message_request** | [**MessageRequest**](MessageRequest.md)| Details to create a message |
|
2057
2043
|
|
2058
2044
|
### Return type
|
2059
2045
|
|
@@ -2177,7 +2163,7 @@ Name | Type | Description | Notes
|
|
2177
2163
|
|
2178
2164
|
## update_a_live_call
|
2179
2165
|
|
2180
|
-
> update_a_live_call(call_id,
|
2166
|
+
> update_a_live_call(call_id, update_call_request)
|
2181
2167
|
|
2182
2168
|
Update a Live Call
|
2183
2169
|
|
@@ -2195,13 +2181,11 @@ end
|
|
2195
2181
|
|
2196
2182
|
api_instance = Freeclimb::DefaultApi.new
|
2197
2183
|
call_id = 'call_id_example' # String | String that uniquely identifies this call resource.
|
2198
|
-
|
2199
|
-
update_call_request: Freeclimb::UpdateCallRequest.new # UpdateCallRequest | Call details to update
|
2200
|
-
}
|
2184
|
+
update_call_request = Freeclimb::UpdateCallRequest.new # UpdateCallRequest | Call details to update
|
2201
2185
|
|
2202
2186
|
begin
|
2203
2187
|
#Update a Live Call
|
2204
|
-
api_instance.update_a_live_call(call_id,
|
2188
|
+
api_instance.update_a_live_call(call_id, update_call_request)
|
2205
2189
|
rescue Freeclimb::ApiError => e
|
2206
2190
|
puts "Exception when calling DefaultApi->update_a_live_call: #{e}"
|
2207
2191
|
end
|
@@ -2213,7 +2197,7 @@ end
|
|
2213
2197
|
Name | Type | Description | Notes
|
2214
2198
|
------------- | ------------- | ------------- | -------------
|
2215
2199
|
**call_id** | **String**| String that uniquely identifies this call resource. |
|
2216
|
-
**update_call_request** | [**UpdateCallRequest**](UpdateCallRequest.md)| Call details to update |
|
2200
|
+
**update_call_request** | [**UpdateCallRequest**](UpdateCallRequest.md)| Call details to update |
|
2217
2201
|
|
2218
2202
|
### Return type
|
2219
2203
|
|
data/docs/Dequeue.md
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
# Freeclimb::Dequeue
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
|
8
|
+
## Code Sample
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'freeclimb'
|
12
|
+
|
13
|
+
instance = Freeclimb::Dequeue.new()
|
14
|
+
```
|
15
|
+
|
16
|
+
|