freeclimb 4.6.1 → 4.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/Gemfile.lock +2 -2
- data/LICENSE.txt +1 -1
- data/README.md +5 -5
- data/docs/DefaultApi.md +134 -113
- data/docs/SMSTenDLCCampaign.md +1 -1
- data/lib/freeclimb/api/default_api.rb +58 -2
- data/lib/freeclimb/models/add_to_conference.rb +1 -1
- data/lib/freeclimb/version.rb +1 -1
- data/openapi.json +168 -2
- data/spec/api/default_api_spec.rb +505 -1
- metadata +83 -83
data/docs/DefaultApi.md
CHANGED
@@ -5,61 +5,117 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**buy_a_phone_number**](DefaultApi.md#buy_a_phone_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers | Buy a Phone Number |
|
8
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
8
9
|
| [**create_a_conference**](DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference |
|
10
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
9
11
|
| [**create_a_queue**](DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue |
|
12
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
10
13
|
| [**create_an_application**](DefaultApi.md#create_an_application) | **POST** /Accounts/{accountId}/Applications | Create an application |
|
14
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
11
15
|
| [**delete_a_recording**](DefaultApi.md#delete_a_recording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording |
|
16
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
12
17
|
| [**delete_an_application**](DefaultApi.md#delete_an_application) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application |
|
18
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
13
19
|
| [**delete_an_incoming_number**](DefaultApi.md#delete_an_incoming_number) | **DELETE** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number |
|
20
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
14
21
|
| [**dequeue_a_member**](DefaultApi.md#dequeue_a_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Dequeue a Member |
|
22
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
15
23
|
| [**dequeue_head_member**](DefaultApi.md#dequeue_head_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Dequeue Head Member |
|
24
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
16
25
|
| [**download_a_recording_file**](DefaultApi.md#download_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Download | Download a Recording File |
|
26
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
17
27
|
| [**filter_logs**](DefaultApi.md#filter_logs) | **POST** /Accounts/{accountId}/Logs | Filter Logs |
|
28
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
18
29
|
| [**get_a_call**](DefaultApi.md#get_a_call) | **GET** /Accounts/{accountId}/Calls/{callId} | Get a Call |
|
30
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
19
31
|
| [**get_a_conference**](DefaultApi.md#get_a_conference) | **GET** /Accounts/{accountId}/Conferences/{conferenceId} | Get a Conference |
|
32
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
20
33
|
| [**get_a_member**](DefaultApi.md#get_a_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Get a Member |
|
34
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
21
35
|
| [**get_a_participant**](DefaultApi.md#get_a_participant) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Get a Participant |
|
36
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
22
37
|
| [**get_a_queue**](DefaultApi.md#get_a_queue) | **GET** /Accounts/{accountId}/Queues/{queueId} | Get a Queue |
|
38
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
23
39
|
| [**get_a_recording**](DefaultApi.md#get_a_recording) | **GET** /Accounts/{accountId}/Recordings/{recordingId} | Get a Recording |
|
40
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
24
41
|
| [**get_an_account**](DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account |
|
42
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
25
43
|
| [**get_an_application**](DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application |
|
44
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
26
45
|
| [**get_an_incoming_number**](DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number |
|
46
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
27
47
|
| [**get_an_sms_message**](DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message |
|
48
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
28
49
|
| [**get_head_member**](DefaultApi.md#get_head_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Get Head Member |
|
50
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
29
51
|
| [**get_ten_dlc_sms_brand**](DefaultApi.md#get_ten_dlc_sms_brand) | **GET** /Accounts/{accountId}/Messages/10DLC/Brands/{brandId} | Get a 10DLC SMS Brand |
|
52
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
30
53
|
| [**get_ten_dlc_sms_brands**](DefaultApi.md#get_ten_dlc_sms_brands) | **GET** /Accounts/{accountId}/Messages/10DLC/Brands | Get list of SMS 10DLC Brands |
|
54
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
31
55
|
| [**get_ten_dlc_sms_campaign**](DefaultApi.md#get_ten_dlc_sms_campaign) | **GET** /Accounts/{accountId}/Messages/10DLC/Campaigns/{campaignId} | Get a 10DLC SMS Campaign |
|
56
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
32
57
|
| [**get_ten_dlc_sms_campaigns**](DefaultApi.md#get_ten_dlc_sms_campaigns) | **GET** /Accounts/{accountId}/Messages/10DLC/Campaigns | Get list of SMS 10DLC Campaigns |
|
58
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
33
59
|
| [**get_ten_dlc_sms_partner_campaign**](DefaultApi.md#get_ten_dlc_sms_partner_campaign) | **GET** /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns/{campaignId} | Get a 10DLC SMS Partner Campaign |
|
60
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
34
61
|
| [**get_ten_dlc_sms_partner_campaigns**](DefaultApi.md#get_ten_dlc_sms_partner_campaigns) | **GET** /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns | Get list of SMS 10DLC Partner Campaigns |
|
62
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
35
63
|
| [**get_toll_free_sms_campaign**](DefaultApi.md#get_toll_free_sms_campaign) | **GET** /Accounts/{accountId}/Messages/TollFree/Campaigns/{campaignId} | Get a TollFree SMS Campaign |
|
64
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
36
65
|
| [**get_toll_free_sms_campaigns**](DefaultApi.md#get_toll_free_sms_campaigns) | **GET** /Accounts/{accountId}/Messages/TollFree/Campaigns | Get list of TollFree Campaigns |
|
66
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
37
67
|
| [**list_active_queues**](DefaultApi.md#list_active_queues) | **GET** /Accounts/{accountId}/Queues | List Active Queues |
|
68
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
38
69
|
| [**list_all_account_logs**](DefaultApi.md#list_all_account_logs) | **GET** /Accounts/{accountId}/Logs | List All Account Logs |
|
70
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
39
71
|
| [**list_applications**](DefaultApi.md#list_applications) | **GET** /Accounts/{accountId}/Applications | List applications |
|
72
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
40
73
|
| [**list_available_numbers**](DefaultApi.md#list_available_numbers) | **GET** /AvailablePhoneNumbers | List available numbers |
|
74
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
41
75
|
| [**list_call_logs**](DefaultApi.md#list_call_logs) | **GET** /Accounts/{accountId}/Calls/{callId}/Logs | List Call Logs |
|
76
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
42
77
|
| [**list_call_recordings**](DefaultApi.md#list_call_recordings) | **GET** /Accounts/{accountId}/Calls/{callId}/Recordings | List Call Recordings |
|
78
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
43
79
|
| [**list_calls**](DefaultApi.md#list_calls) | **GET** /Accounts/{accountId}/Calls | List Calls |
|
80
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
44
81
|
| [**list_conference_recordings**](DefaultApi.md#list_conference_recordings) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Recordings | List Conference Recordings |
|
82
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
45
83
|
| [**list_conferences**](DefaultApi.md#list_conferences) | **GET** /Accounts/{accountId}/Conferences | List Conferences |
|
84
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
46
85
|
| [**list_incoming_numbers**](DefaultApi.md#list_incoming_numbers) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers | List Incoming Numbers |
|
86
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
47
87
|
| [**list_members**](DefaultApi.md#list_members) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members | List Members |
|
88
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
48
89
|
| [**list_participants**](DefaultApi.md#list_participants) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants | List Participants |
|
90
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
49
91
|
| [**list_recordings**](DefaultApi.md#list_recordings) | **GET** /Accounts/{accountId}/Recordings | List Recordings |
|
92
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
50
93
|
| [**list_sms_messages**](DefaultApi.md#list_sms_messages) | **GET** /Accounts/{accountId}/Messages | List SMS Messages |
|
94
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
51
95
|
| [**make_a_call**](DefaultApi.md#make_a_call) | **POST** /Accounts/{accountId}/Calls | Make a Call |
|
96
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
52
97
|
| [**make_a_webrtc_jwt**](DefaultApi.md#make_a_webrtc_jwt) | **POST** /Accounts/{accountId}/Calls/WebRTC/Token | Make a JWT for WebRTC calling |
|
98
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
53
99
|
| [**remove_a_participant**](DefaultApi.md#remove_a_participant) | **DELETE** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Remove a Participant |
|
100
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
54
101
|
| [**send_an_sms_message**](DefaultApi.md#send_an_sms_message) | **POST** /Accounts/{accountId}/Messages | Send an SMS Message |
|
102
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
55
103
|
| [**stream_a_recording_file**](DefaultApi.md#stream_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Stream | Stream a Recording File |
|
104
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
56
105
|
| [**update_a_conference**](DefaultApi.md#update_a_conference) | **POST** /Accounts/{accountId}/Conferences/{conferenceId} | Update a Conference |
|
106
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
57
107
|
| [**update_a_live_call**](DefaultApi.md#update_a_live_call) | **POST** /Accounts/{accountId}/Calls/{callId} | Update a Live Call |
|
108
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
58
109
|
| [**update_a_participant**](DefaultApi.md#update_a_participant) | **POST** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Update a Participant |
|
110
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
59
111
|
| [**update_a_queue**](DefaultApi.md#update_a_queue) | **POST** /Accounts/{accountId}/Queues/{queueId} | Update a Queue |
|
112
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
60
113
|
| [**update_an_account**](DefaultApi.md#update_an_account) | **POST** /Accounts/{accountId} | Manage an account |
|
114
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
61
115
|
| [**update_an_application**](DefaultApi.md#update_an_application) | **POST** /Accounts/{accountId}/Applications/{applicationId} | Update an application |
|
116
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
62
117
|
| [**update_an_incoming_number**](DefaultApi.md#update_an_incoming_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Update an Incoming Number |
|
118
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
63
119
|
|
64
120
|
|
65
121
|
## buy_a_phone_number
|
@@ -115,7 +171,6 @@ end
|
|
115
171
|
|
116
172
|
| Name | Type | Description | Notes |
|
117
173
|
| ---- | ---- | ----------- | ----- |
|
118
|
-
|
119
174
|
| **buy_incoming_number_request** | [**BuyIncomingNumberRequest**](BuyIncomingNumberRequest.md) | Incoming Number transaction details | |
|
120
175
|
|
121
176
|
|
@@ -187,7 +242,6 @@ end
|
|
187
242
|
|
188
243
|
| Name | Type | Description | Notes |
|
189
244
|
| ---- | ---- | ----------- | ----- |
|
190
|
-
|
191
245
|
| **create_conference_request** | [**CreateConferenceRequest**](CreateConferenceRequest.md) | Conference to create | [optional] |
|
192
246
|
|
193
247
|
|
@@ -259,7 +313,6 @@ end
|
|
259
313
|
|
260
314
|
| Name | Type | Description | Notes |
|
261
315
|
| ---- | ---- | ----------- | ----- |
|
262
|
-
|
263
316
|
| **queue_request** | [**QueueRequest**](QueueRequest.md) | Queue details used to create a queue | [optional] |
|
264
317
|
|
265
318
|
|
@@ -331,7 +384,6 @@ end
|
|
331
384
|
|
332
385
|
| Name | Type | Description | Notes |
|
333
386
|
| ---- | ---- | ----------- | ----- |
|
334
|
-
|
335
387
|
| **application_request** | [**ApplicationRequest**](ApplicationRequest.md) | Application Details | [optional] |
|
336
388
|
|
337
389
|
|
@@ -401,7 +453,6 @@ end
|
|
401
453
|
|
402
454
|
| Name | Type | Description | Notes |
|
403
455
|
| ---- | ---- | ----------- | ----- |
|
404
|
-
|
405
456
|
| **recording_id** | **String** | String that uniquely identifies this recording resource. | |
|
406
457
|
|
407
458
|
|
@@ -471,7 +522,6 @@ end
|
|
471
522
|
|
472
523
|
| Name | Type | Description | Notes |
|
473
524
|
| ---- | ---- | ----------- | ----- |
|
474
|
-
|
475
525
|
| **application_id** | **String** | String that uniquely identifies this application resource. | |
|
476
526
|
|
477
527
|
|
@@ -541,7 +591,6 @@ end
|
|
541
591
|
|
542
592
|
| Name | Type | Description | Notes |
|
543
593
|
| ---- | ---- | ----------- | ----- |
|
544
|
-
|
545
594
|
| **phone_number_id** | **String** | String that uniquely identifies this phone number resource. | |
|
546
595
|
|
547
596
|
|
@@ -614,9 +663,7 @@ end
|
|
614
663
|
|
615
664
|
| Name | Type | Description | Notes |
|
616
665
|
| ---- | ---- | ----------- | ----- |
|
617
|
-
|
618
666
|
| **queue_id** | **String** | String that uniquely identifies the Queue that the Member belongs to. | |
|
619
|
-
|
620
667
|
| **call_id** | **String** | ID if the Call that the Member belongs to | |
|
621
668
|
|
622
669
|
|
@@ -687,7 +734,6 @@ end
|
|
687
734
|
|
688
735
|
| Name | Type | Description | Notes |
|
689
736
|
| ---- | ---- | ----------- | ----- |
|
690
|
-
|
691
737
|
| **queue_id** | **String** | String that uniquely identifies this queue resource. | |
|
692
738
|
|
693
739
|
|
@@ -758,7 +804,6 @@ end
|
|
758
804
|
|
759
805
|
| Name | Type | Description | Notes |
|
760
806
|
| ---- | ---- | ----------- | ----- |
|
761
|
-
|
762
807
|
| **recording_id** | **String** | String that uniquely identifies this recording resource. | |
|
763
808
|
|
764
809
|
|
@@ -829,7 +874,6 @@ end
|
|
829
874
|
|
830
875
|
| Name | Type | Description | Notes |
|
831
876
|
| ---- | ---- | ----------- | ----- |
|
832
|
-
|
833
877
|
| **filter_logs_request** | [**FilterLogsRequest**](FilterLogsRequest.md) | Filter logs request paramters | |
|
834
878
|
|
835
879
|
|
@@ -900,7 +944,6 @@ end
|
|
900
944
|
|
901
945
|
| Name | Type | Description | Notes |
|
902
946
|
| ---- | ---- | ----------- | ----- |
|
903
|
-
|
904
947
|
| **call_id** | **String** | String that uniquely identifies this call resource. | |
|
905
948
|
|
906
949
|
|
@@ -971,7 +1014,6 @@ end
|
|
971
1014
|
|
972
1015
|
| Name | Type | Description | Notes |
|
973
1016
|
| ---- | ---- | ----------- | ----- |
|
974
|
-
|
975
1017
|
| **conference_id** | **String** | A string that uniquely identifies this conference resource. | |
|
976
1018
|
|
977
1019
|
|
@@ -1044,9 +1086,7 @@ end
|
|
1044
1086
|
|
1045
1087
|
| Name | Type | Description | Notes |
|
1046
1088
|
| ---- | ---- | ----------- | ----- |
|
1047
|
-
|
1048
1089
|
| **queue_id** | **String** | String that uniquely identifies the Queue that the Member belongs to. | |
|
1049
|
-
|
1050
1090
|
| **call_id** | **String** | ID of the Call that the Member belongs to | |
|
1051
1091
|
|
1052
1092
|
|
@@ -1119,9 +1159,7 @@ end
|
|
1119
1159
|
|
1120
1160
|
| Name | Type | Description | Notes |
|
1121
1161
|
| ---- | ---- | ----------- | ----- |
|
1122
|
-
|
1123
1162
|
| **conference_id** | **String** | ID of the conference this participant is in. | |
|
1124
|
-
|
1125
1163
|
| **call_id** | **String** | ID of the Call associated with this participant. | |
|
1126
1164
|
|
1127
1165
|
|
@@ -1192,7 +1230,6 @@ end
|
|
1192
1230
|
|
1193
1231
|
| Name | Type | Description | Notes |
|
1194
1232
|
| ---- | ---- | ----------- | ----- |
|
1195
|
-
|
1196
1233
|
| **queue_id** | **String** | A string that uniquely identifies this queue resource. | |
|
1197
1234
|
|
1198
1235
|
|
@@ -1263,7 +1300,6 @@ end
|
|
1263
1300
|
|
1264
1301
|
| Name | Type | Description | Notes |
|
1265
1302
|
| ---- | ---- | ----------- | ----- |
|
1266
|
-
|
1267
1303
|
| **recording_id** | **String** | String that uniquely identifies this recording resource. | |
|
1268
1304
|
|
1269
1305
|
|
@@ -1401,7 +1437,6 @@ end
|
|
1401
1437
|
|
1402
1438
|
| Name | Type | Description | Notes |
|
1403
1439
|
| ---- | ---- | ----------- | ----- |
|
1404
|
-
|
1405
1440
|
| **application_id** | **String** | A string that uniquely identifies this application resource. | |
|
1406
1441
|
|
1407
1442
|
|
@@ -1472,7 +1507,6 @@ end
|
|
1472
1507
|
|
1473
1508
|
| Name | Type | Description | Notes |
|
1474
1509
|
| ---- | ---- | ----------- | ----- |
|
1475
|
-
|
1476
1510
|
| **phone_number_id** | **String** | String that uniquely identifies this phone number resource. | |
|
1477
1511
|
|
1478
1512
|
|
@@ -1543,7 +1577,6 @@ end
|
|
1543
1577
|
|
1544
1578
|
| Name | Type | Description | Notes |
|
1545
1579
|
| ---- | ---- | ----------- | ----- |
|
1546
|
-
|
1547
1580
|
| **message_id** | **String** | String that uniquely identifies this Message resource. | |
|
1548
1581
|
|
1549
1582
|
|
@@ -1614,7 +1647,6 @@ end
|
|
1614
1647
|
|
1615
1648
|
| Name | Type | Description | Notes |
|
1616
1649
|
| ---- | ---- | ----------- | ----- |
|
1617
|
-
|
1618
1650
|
| **queue_id** | **String** | String that uniquely identifies the Queue that the Member belongs to. | |
|
1619
1651
|
|
1620
1652
|
|
@@ -1685,7 +1717,6 @@ end
|
|
1685
1717
|
|
1686
1718
|
| Name | Type | Description | Notes |
|
1687
1719
|
| ---- | ---- | ----------- | ----- |
|
1688
|
-
|
1689
1720
|
| **brand_id** | **String** | String that uniquely identifies this brand resource. | |
|
1690
1721
|
|
1691
1722
|
|
@@ -1823,7 +1854,6 @@ end
|
|
1823
1854
|
|
1824
1855
|
| Name | Type | Description | Notes |
|
1825
1856
|
| ---- | ---- | ----------- | ----- |
|
1826
|
-
|
1827
1857
|
| **campaign_id** | **String** | String that uniquely identifies this campaign resource. | |
|
1828
1858
|
|
1829
1859
|
|
@@ -1895,7 +1925,6 @@ end
|
|
1895
1925
|
|
1896
1926
|
| Name | Type | Description | Notes |
|
1897
1927
|
| ---- | ---- | ----------- | ----- |
|
1898
|
-
|
1899
1928
|
| **brand_id** | **String** | The unique identifier for a brand | [optional] |
|
1900
1929
|
|
1901
1930
|
|
@@ -1966,7 +1995,6 @@ end
|
|
1966
1995
|
|
1967
1996
|
| Name | Type | Description | Notes |
|
1968
1997
|
| ---- | ---- | ----------- | ----- |
|
1969
|
-
|
1970
1998
|
| **campaign_id** | **String** | String that uniquely identifies this campaign resource. | |
|
1971
1999
|
|
1972
2000
|
|
@@ -2038,7 +2066,6 @@ end
|
|
2038
2066
|
|
2039
2067
|
| Name | Type | Description | Notes |
|
2040
2068
|
| ---- | ---- | ----------- | ----- |
|
2041
|
-
|
2042
2069
|
| **brand_id** | **String** | The unique identifier for a brand | [optional] |
|
2043
2070
|
|
2044
2071
|
|
@@ -2109,7 +2136,6 @@ end
|
|
2109
2136
|
|
2110
2137
|
| Name | Type | Description | Notes |
|
2111
2138
|
| ---- | ---- | ----------- | ----- |
|
2112
|
-
|
2113
2139
|
| **campaign_id** | **String** | String that uniquely identifies this TollFree Campaign resource. | |
|
2114
2140
|
|
2115
2141
|
|
@@ -2248,7 +2274,6 @@ end
|
|
2248
2274
|
|
2249
2275
|
| Name | Type | Description | Notes |
|
2250
2276
|
| ---- | ---- | ----------- | ----- |
|
2251
|
-
|
2252
2277
|
| **_alias** | **String** | Return only the Queue resources with aliases that exactly match this name. | [optional] |
|
2253
2278
|
|
2254
2279
|
|
@@ -2387,7 +2412,6 @@ end
|
|
2387
2412
|
|
2388
2413
|
| Name | Type | Description | Notes |
|
2389
2414
|
| ---- | ---- | ----------- | ----- |
|
2390
|
-
|
2391
2415
|
| **_alias** | **String** | Return only applications with aliases that exactly match this value. | [optional] |
|
2392
2416
|
|
2393
2417
|
|
@@ -2468,25 +2492,15 @@ end
|
|
2468
2492
|
|
2469
2493
|
| Name | Type | Description | Notes |
|
2470
2494
|
| ---- | ---- | ----------- | ----- |
|
2471
|
-
|
2472
2495
|
| **phone_number** | **String** | PCRE-compatible regular expression to filter against `phoneNumber` field, which is in E.164 format. | [optional] |
|
2473
|
-
|
2474
2496
|
| **region** | **String** | State or province of this phone number. | [optional] |
|
2475
|
-
|
2476
2497
|
| **country** | **String** | Country of this phone number. | [optional] |
|
2477
|
-
|
2478
2498
|
| **voice_enabled** | **Boolean** | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional][default to true] |
|
2479
|
-
|
2480
2499
|
| **sms_enabled** | **Boolean** | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional][default to true] |
|
2481
|
-
|
2482
2500
|
| **capabilities_voice** | **Boolean** | | [optional] |
|
2483
|
-
|
2484
2501
|
| **capabilities_sms** | **Boolean** | | [optional] |
|
2485
|
-
|
2486
2502
|
| **capabilities_toll_free** | **Boolean** | | [optional] |
|
2487
|
-
|
2488
2503
|
| **capabilities_ten_dlc** | **Boolean** | | [optional] |
|
2489
|
-
|
2490
2504
|
| **capabilities_short_code** | **Boolean** | | [optional] |
|
2491
2505
|
|
2492
2506
|
|
@@ -2557,7 +2571,6 @@ end
|
|
2557
2571
|
|
2558
2572
|
| Name | Type | Description | Notes |
|
2559
2573
|
| ---- | ---- | ----------- | ----- |
|
2560
|
-
|
2561
2574
|
| **call_id** | **String** | String that uniquely identifies this call resource. | |
|
2562
2575
|
|
2563
2576
|
|
@@ -2631,9 +2644,7 @@ end
|
|
2631
2644
|
|
2632
2645
|
| Name | Type | Description | Notes |
|
2633
2646
|
| ---- | ---- | ----------- | ----- |
|
2634
|
-
|
2635
2647
|
| **call_id** | **String** | String that uniquely identifies this call resource. | |
|
2636
|
-
|
2637
2648
|
| **date_created** | **String** | Only show recordings created on the specified date, in the form *YYYY-MM-DD*. | [optional] |
|
2638
2649
|
|
2639
2650
|
|
@@ -2712,21 +2723,13 @@ end
|
|
2712
2723
|
|
2713
2724
|
| Name | Type | Description | Notes |
|
2714
2725
|
| ---- | ---- | ----------- | ----- |
|
2715
|
-
|
2716
2726
|
| **active** | **Boolean** | If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query. | [optional][default to false] |
|
2717
|
-
|
2718
2727
|
| **to** | **String** | Only show Calls to this phone number. | [optional] |
|
2719
|
-
|
2720
2728
|
| **from** | **String** | Only show Calls from this phone number. | [optional] |
|
2721
|
-
|
2722
2729
|
| **status** | [**CallStatus**](.md) | Only show Calls currently in this status. May be `queued`, `ringing`, `inProgress`, `canceled`, `completed`, `failed`, `busy`, or `noAnswer`. | [optional] |
|
2723
|
-
|
2724
2730
|
| **start_time** | **String** | Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional] |
|
2725
|
-
|
2726
2731
|
| **end_time** | **String** | Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss. | [optional] |
|
2727
|
-
|
2728
2732
|
| **parent_call_id** | **String** | Only show Calls spawned by the call with this ID. | [optional] |
|
2729
|
-
|
2730
2733
|
| **application_id** | [**Array<String>**](String.md) | Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications. | [optional] |
|
2731
2734
|
|
2732
2735
|
|
@@ -2801,11 +2804,8 @@ end
|
|
2801
2804
|
|
2802
2805
|
| Name | Type | Description | Notes |
|
2803
2806
|
| ---- | ---- | ----------- | ----- |
|
2804
|
-
|
2805
2807
|
| **conference_id** | **String** | Show only Recordings made during the conference with this ID. | |
|
2806
|
-
|
2807
2808
|
| **call_id** | **String** | Show only Recordings made during the Call with this ID. | [optional] |
|
2808
|
-
|
2809
2809
|
| **date_created** | **String** | Only show Recordings created on this date, formatted as *YYYY-MM-DD*. | [optional] |
|
2810
2810
|
|
2811
2811
|
|
@@ -2880,13 +2880,9 @@ end
|
|
2880
2880
|
|
2881
2881
|
| Name | Type | Description | Notes |
|
2882
2882
|
| ---- | ---- | ----------- | ----- |
|
2883
|
-
|
2884
2883
|
| **status** | **String** | Only show conferences that currently have the specified status. Valid values: `empty`, `populated`, `inProgress`, or `terminated`. | [optional] |
|
2885
|
-
|
2886
2884
|
| **_alias** | **String** | List Conferences whose alias exactly matches this string. | [optional] |
|
2887
|
-
|
2888
2885
|
| **date_created** | **String** | Only show Conferences that were created on the specified date, in the form *YYYY-MM-DD*. | [optional] |
|
2889
|
-
|
2890
2886
|
| **date_updated** | **String** | Only show Conferences that were last updated on the specified date, in the form *YYYY-MM-DD*. | [optional] |
|
2891
2887
|
|
2892
2888
|
|
@@ -2973,37 +2969,21 @@ end
|
|
2973
2969
|
|
2974
2970
|
| Name | Type | Description | Notes |
|
2975
2971
|
| ---- | ---- | ----------- | ----- |
|
2976
|
-
|
2977
2972
|
| **phone_number** | **String** | Only show incoming phone number resources that match this PCRE-compatible regular expression. | [optional] |
|
2978
|
-
|
2979
2973
|
| **_alias** | **String** | Only show incoming phone numbers with aliases that exactly match this value. | [optional] |
|
2980
|
-
|
2981
2974
|
| **region** | **String** | State or province of this phone number. | [optional] |
|
2982
|
-
|
2983
2975
|
| **country** | **String** | Country of this phone number. | [optional] |
|
2984
|
-
|
2985
2976
|
| **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] |
|
2986
|
-
|
2987
2977
|
| **has_application** | **Boolean** | Indication of whether the phone number has an application linked to it. | [optional][default to false] |
|
2988
|
-
|
2989
2978
|
| **voice_enabled** | **Boolean** | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional][default to true] |
|
2990
|
-
|
2991
2979
|
| **sms_enabled** | **Boolean** | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional][default to true] |
|
2992
|
-
|
2993
2980
|
| **has_campaign** | **Boolean** | Indication of whether the phone number has a campaign associated with it | [optional] |
|
2994
|
-
|
2995
2981
|
| **capabilities_voice** | **Boolean** | | [optional] |
|
2996
|
-
|
2997
2982
|
| **capabilities_sms** | **Boolean** | | [optional] |
|
2998
|
-
|
2999
2983
|
| **capabilities_toll_free** | **Boolean** | | [optional] |
|
3000
|
-
|
3001
2984
|
| **capabilities_ten_dlc** | **Boolean** | | [optional] |
|
3002
|
-
|
3003
2985
|
| **capabilities_short_code** | **Boolean** | | [optional] |
|
3004
|
-
|
3005
2986
|
| **tfn_campaign_id** | **String** | Only show incoming phone number resources that have been assigned to the provided TFNCampaign ID. | [optional] |
|
3006
|
-
|
3007
2987
|
| **offnet** | **Boolean** | Indication of whether the phone number was registered as an offnet number. This field will be rendered only for requests to the IncomingPhone number resource. | [optional] |
|
3008
2988
|
|
3009
2989
|
|
@@ -3074,7 +3054,6 @@ end
|
|
3074
3054
|
|
3075
3055
|
| Name | Type | Description | Notes |
|
3076
3056
|
| ---- | ---- | ----------- | ----- |
|
3077
|
-
|
3078
3057
|
| **queue_id** | **String** | String that uniquely identifies the Queue that the Member belongs to. | |
|
3079
3058
|
|
3080
3059
|
|
@@ -3149,11 +3128,8 @@ end
|
|
3149
3128
|
|
3150
3129
|
| Name | Type | Description | Notes |
|
3151
3130
|
| ---- | ---- | ----------- | ----- |
|
3152
|
-
|
3153
3131
|
| **conference_id** | **String** | ID of the conference this participant is in. | |
|
3154
|
-
|
3155
3132
|
| **talk** | **Boolean** | Only show Participants with the talk privilege. | [optional] |
|
3156
|
-
|
3157
3133
|
| **listen** | **Boolean** | Only show Participants with the listen privilege. | [optional] |
|
3158
3134
|
|
3159
3135
|
|
@@ -3227,11 +3203,8 @@ end
|
|
3227
3203
|
|
3228
3204
|
| Name | Type | Description | Notes |
|
3229
3205
|
| ---- | ---- | ----------- | ----- |
|
3230
|
-
|
3231
3206
|
| **call_id** | **String** | Show only Recordings made during the Call with this ID. | [optional] |
|
3232
|
-
|
3233
3207
|
| **conference_id** | **String** | Show only Recordings made during the conference with this ID. | [optional] |
|
3234
|
-
|
3235
3208
|
| **date_created** | **String** | Only show Recordings created on this date, formatted as *YYYY-MM-DD*. | [optional] |
|
3236
3209
|
|
3237
3210
|
|
@@ -3310,21 +3283,13 @@ end
|
|
3310
3283
|
|
3311
3284
|
| Name | Type | Description | Notes |
|
3312
3285
|
| ---- | ---- | ----------- | ----- |
|
3313
|
-
|
3314
3286
|
| **to** | **String** | Only show Messages to this phone number. | [optional] |
|
3315
|
-
|
3316
3287
|
| **from** | **String** | Only show Messages from this phone number. | [optional] |
|
3317
|
-
|
3318
3288
|
| **begin_time** | **String** | Only show Messages sent at or after this time (GMT), given as *YYYY-MM-DD hh:mm:ss*. | [optional] |
|
3319
|
-
|
3320
3289
|
| **end_time** | **String** | Only show messages sent at or before this time (GMT), given as *YYYY-MM-DD hh:mm*.. | [optional] |
|
3321
|
-
|
3322
3290
|
| **direction** | [**MessageDirection**](.md) | Either `inbound` or `outbound`. Only show Messages that were either *sent from* or *received by* FreeClimb. | [optional] |
|
3323
|
-
|
3324
3291
|
| **campaign_id** | **String** | Only show messages associated with this campaign ID. | [optional] |
|
3325
|
-
|
3326
3292
|
| **brand_id** | **String** | Only show messages associated with this brand ID | [optional] |
|
3327
|
-
|
3328
3293
|
| **is10_dlc** | **Boolean** | Only show messages that were sent as part of a 10DLC campaign. | [optional] |
|
3329
3294
|
|
3330
3295
|
|
@@ -3396,7 +3361,6 @@ end
|
|
3396
3361
|
|
3397
3362
|
| Name | Type | Description | Notes |
|
3398
3363
|
| ---- | ---- | ----------- | ----- |
|
3399
|
-
|
3400
3364
|
| **make_call_request** | [**MakeCallRequest**](MakeCallRequest.md) | Call details for making a call | [optional] |
|
3401
3365
|
|
3402
3366
|
|
@@ -3418,8 +3382,6 @@ end
|
|
3418
3382
|
|
3419
3383
|
Make a JWT for WebRTC calling
|
3420
3384
|
|
3421
|
-
Make a JWT for WebRTC calling
|
3422
|
-
|
3423
3385
|
### Examples
|
3424
3386
|
|
3425
3387
|
```ruby
|
@@ -3469,7 +3431,6 @@ end
|
|
3469
3431
|
|
3470
3432
|
| Name | Type | Description | Notes |
|
3471
3433
|
| ---- | ---- | ----------- | ----- |
|
3472
|
-
|
3473
3434
|
| **create_web_rtc_token** | [**CreateWebRTCToken**](CreateWebRTCToken.md) | Information needed to craft a JWT compatible with the platforms WebRTC APIs | |
|
3474
3435
|
|
3475
3436
|
|
@@ -3541,9 +3502,7 @@ end
|
|
3541
3502
|
|
3542
3503
|
| Name | Type | Description | Notes |
|
3543
3504
|
| ---- | ---- | ----------- | ----- |
|
3544
|
-
|
3545
3505
|
| **conference_id** | **String** | ID of the conference this participant is in. | |
|
3546
|
-
|
3547
3506
|
| **call_id** | **String** | ID of the Call associated with this participant. | |
|
3548
3507
|
|
3549
3508
|
|
@@ -3614,7 +3573,6 @@ end
|
|
3614
3573
|
|
3615
3574
|
| Name | Type | Description | Notes |
|
3616
3575
|
| ---- | ---- | ----------- | ----- |
|
3617
|
-
|
3618
3576
|
| **message_request** | [**MessageRequest**](MessageRequest.md) | Details to create a message | |
|
3619
3577
|
|
3620
3578
|
|
@@ -3685,7 +3643,6 @@ end
|
|
3685
3643
|
|
3686
3644
|
| Name | Type | Description | Notes |
|
3687
3645
|
| ---- | ---- | ----------- | ----- |
|
3688
|
-
|
3689
3646
|
| **recording_id** | **String** | String that uniquely identifies this recording resource. | |
|
3690
3647
|
|
3691
3648
|
|
@@ -3758,9 +3715,7 @@ end
|
|
3758
3715
|
|
3759
3716
|
| Name | Type | Description | Notes |
|
3760
3717
|
| ---- | ---- | ----------- | ----- |
|
3761
|
-
|
3762
3718
|
| **conference_id** | **String** | String that uniquely identifies this conference resource. | |
|
3763
|
-
|
3764
3719
|
| **update_conference_request** | [**UpdateConferenceRequest**](UpdateConferenceRequest.md) | Conference Details to update | [optional] |
|
3765
3720
|
|
3766
3721
|
|
@@ -3832,9 +3787,7 @@ end
|
|
3832
3787
|
|
3833
3788
|
| Name | Type | Description | Notes |
|
3834
3789
|
| ---- | ---- | ----------- | ----- |
|
3835
|
-
|
3836
3790
|
| **call_id** | **String** | String that uniquely identifies this call resource. | |
|
3837
|
-
|
3838
3791
|
| **update_call_request** | [**UpdateCallRequest**](UpdateCallRequest.md) | Call details to update | |
|
3839
3792
|
|
3840
3793
|
|
@@ -3910,11 +3863,8 @@ end
|
|
3910
3863
|
|
3911
3864
|
| Name | Type | Description | Notes |
|
3912
3865
|
| ---- | ---- | ----------- | ----- |
|
3913
|
-
|
3914
3866
|
| **conference_id** | **String** | ID of the conference this participant is in. | |
|
3915
|
-
|
3916
3867
|
| **call_id** | **String** | ID of the Call associated with this participant. | |
|
3917
|
-
|
3918
3868
|
| **update_conference_participant_request** | [**UpdateConferenceParticipantRequest**](UpdateConferenceParticipantRequest.md) | Conference participant details to update | [optional] |
|
3919
3869
|
|
3920
3870
|
|
@@ -3988,9 +3938,7 @@ end
|
|
3988
3938
|
|
3989
3939
|
| Name | Type | Description | Notes |
|
3990
3940
|
| ---- | ---- | ----------- | ----- |
|
3991
|
-
|
3992
3941
|
| **queue_id** | **String** | A string that uniquely identifies this Queue resource. | |
|
3993
|
-
|
3994
3942
|
| **queue_request** | [**QueueRequest**](QueueRequest.md) | Queue Details to update | [optional] |
|
3995
3943
|
|
3996
3944
|
|
@@ -4061,7 +4009,6 @@ end
|
|
4061
4009
|
|
4062
4010
|
| Name | Type | Description | Notes |
|
4063
4011
|
| ---- | ---- | ----------- | ----- |
|
4064
|
-
|
4065
4012
|
| **account_request** | [**AccountRequest**](AccountRequest.md) | Account details to update | [optional] |
|
4066
4013
|
|
4067
4014
|
|
@@ -4135,9 +4082,7 @@ end
|
|
4135
4082
|
|
4136
4083
|
| Name | Type | Description | Notes |
|
4137
4084
|
| ---- | ---- | ----------- | ----- |
|
4138
|
-
|
4139
4085
|
| **application_id** | **String** | A string that uniquely identifies this application resource. | |
|
4140
|
-
|
4141
4086
|
| **application_request** | [**ApplicationRequest**](ApplicationRequest.md) | Application details to update. | [optional] |
|
4142
4087
|
|
4143
4088
|
|
@@ -4211,9 +4156,7 @@ end
|
|
4211
4156
|
|
4212
4157
|
| Name | Type | Description | Notes |
|
4213
4158
|
| ---- | ---- | ----------- | ----- |
|
4214
|
-
|
4215
4159
|
| **phone_number_id** | **String** | String that uniquely identifies this phone number resource. | |
|
4216
|
-
|
4217
4160
|
| **incoming_number_request** | [**IncomingNumberRequest**](IncomingNumberRequest.md) | Incoming Number details to update | [optional] |
|
4218
4161
|
|
4219
4162
|
|
@@ -4230,3 +4173,81 @@ end
|
|
4230
4173
|
- **Content-Type**: application/json
|
4231
4174
|
- **Accept**: application/json
|
4232
4175
|
|
4176
|
+
## get_next_page
|
4177
|
+
|
4178
|
+
Get next page of a paginated resource
|
4179
|
+
|
4180
|
+
|
4181
|
+
### Examples
|
4182
|
+
|
4183
|
+
```ruby
|
4184
|
+
require 'time'
|
4185
|
+
require 'freeclimb'
|
4186
|
+
# setup authorization
|
4187
|
+
Freeclimb.configure do |config|
|
4188
|
+
# Configure HTTP basic authorization: fc
|
4189
|
+
config.username = 'ACCOUNT_ID'
|
4190
|
+
config.password = 'API_KEY'
|
4191
|
+
end
|
4192
|
+
|
4193
|
+
api_instance = Freeclimb::DefaultApi.new
|
4194
|
+
|
4195
|
+
opts = {
|
4196
|
+
_alias: '_alias_example' # String | Return only applications with aliases that exactly match this value.
|
4197
|
+
}
|
4198
|
+
|
4199
|
+
begin
|
4200
|
+
|
4201
|
+
# List applications
|
4202
|
+
result = api_instance.list_applications(opts)
|
4203
|
+
p result
|
4204
|
+
# Get next page of applications
|
4205
|
+
next_page_result = api_instance.get_next_page(result)
|
4206
|
+
p next_page_result
|
4207
|
+
rescue Freeclimb::ApiError => e
|
4208
|
+
puts "Error: #{e}"
|
4209
|
+
end
|
4210
|
+
```
|
4211
|
+
|
4212
|
+
#### Using the get_next_page_with_http_info variant
|
4213
|
+
|
4214
|
+
This returns an Array which contains the response data, status code and headers.
|
4215
|
+
|
4216
|
+
> <Array(, Integer, Hash)> get_next_page_with_http_info(response, opts)
|
4217
|
+
|
4218
|
+
```ruby
|
4219
|
+
begin
|
4220
|
+
# List applications
|
4221
|
+
data, status_code, headers = api_instance.list_applications_with_http_info(opts)
|
4222
|
+
p status_code # => 2xx
|
4223
|
+
p headers # => { ... }
|
4224
|
+
p data # => <ApplicationList>
|
4225
|
+
# Get next page of applications
|
4226
|
+
next_page_data, next_page_status_code, next_page_headers = api_instance.get_next_page(data)
|
4227
|
+
p next_page_data
|
4228
|
+
p next_page_status_code
|
4229
|
+
p next_page_headers
|
4230
|
+
rescue Freeclimb::ApiError => e
|
4231
|
+
puts "Error: #{e}"
|
4232
|
+
end
|
4233
|
+
```
|
4234
|
+
|
4235
|
+
### Parameters
|
4236
|
+
|
4237
|
+
| Name | Type | Description | Notes |
|
4238
|
+
| ---- | ---- | ----------- | ----- |
|
4239
|
+
| response | Object | Response from request to get a paginated resource | |
|
4240
|
+
|
4241
|
+
### Return type
|
4242
|
+
|
4243
|
+
Type of response parameter
|
4244
|
+
|
4245
|
+
### Authorization
|
4246
|
+
|
4247
|
+
[fc](../README.md#fc)
|
4248
|
+
|
4249
|
+
### HTTP request headers
|
4250
|
+
|
4251
|
+
- **Content-Type**: Not defined
|
4252
|
+
- **Accept**: application/json
|
4253
|
+
|