freeclimb 5.2.0 → 5.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -1
  3. data/Gemfile.lock +3 -3
  4. data/README.md +17 -4
  5. data/docs/CallResult.md +2 -2
  6. data/docs/CreateConference.md +4 -2
  7. data/docs/DefaultApi.md +368 -1
  8. data/docs/ExportList.md +32 -0
  9. data/docs/ExportOutputType.md +16 -0
  10. data/docs/ExportRequest.md +24 -0
  11. data/docs/ExportRequestOutput.md +18 -0
  12. data/docs/ExportResourceType.md +17 -0
  13. data/docs/ExportResult.md +40 -0
  14. data/docs/ExportResultOutput.md +18 -0
  15. data/docs/ExportStatus.md +21 -0
  16. data/lib/freeclimb/api/default_api.rb +313 -0
  17. data/lib/freeclimb/models/call_result.rb +8 -8
  18. data/lib/freeclimb/models/create_conference.rb +15 -5
  19. data/lib/freeclimb/models/export_list.rb +304 -0
  20. data/lib/freeclimb/models/export_output_type.rb +34 -0
  21. data/lib/freeclimb/models/export_request.rb +276 -0
  22. data/lib/freeclimb/models/export_request_output.rb +243 -0
  23. data/lib/freeclimb/models/export_resource_type.rb +35 -0
  24. data/lib/freeclimb/models/export_result.rb +405 -0
  25. data/lib/freeclimb/models/export_result_output.rb +243 -0
  26. data/lib/freeclimb/models/export_status.rb +39 -0
  27. data/lib/freeclimb/version.rb +1 -1
  28. data/lib/freeclimb.rb +8 -0
  29. data/openapi.json +370 -2
  30. data/spec/api/default_api_spec.rb +141 -2
  31. data/spec/models/call_result_spec.rb +36 -36
  32. data/spec/models/create_conference_spec.rb +83 -35
  33. data/spec/models/export_list_spec.rb +502 -0
  34. data/spec/models/export_output_type_spec.rb +43 -0
  35. data/spec/models/export_request_output_spec.rb +162 -0
  36. data/spec/models/export_request_spec.rb +320 -0
  37. data/spec/models/export_resource_type_spec.rb +59 -0
  38. data/spec/models/export_result_output_spec.rb +162 -0
  39. data/spec/models/export_result_spec.rb +718 -0
  40. data/spec/models/export_status_spec.rb +123 -0
  41. data/yarn.lock +29 -29
  42. metadata +26 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 880ffb4633a794489fdfb9482a2dcd70f50ce5d365d3a22820d3a3373bb45fad
4
- data.tar.gz: c41a3d5090955b815536f14a0a83de33c645ae9264298ab245ef9e4385fc8e39
3
+ metadata.gz: 19724be086a3f951d898dcd13317fa2f02e70c89e3d842d77206ebc09d659521
4
+ data.tar.gz: ec0db4ac52c9c4e2b829b5cf9a4a81c01480df7bcbf4c7b31bb1b05ef72128fd
5
5
  SHA512:
6
- metadata.gz: c9b436194212c9d1bb3d12b3f29721f6234ed65d26d3d06eacc1f9eba6a2e736476ecb6311133fece84ac1a34ca12a4c01871de8d0c5062efd3feb11bc622ec1
7
- data.tar.gz: c500a695ff1edc382f76e34609a0928258b755454a69fe9e55d342898482229a473cac5339c75f32c2ce13a0022c5279ea673d345867a1b3f947e4a3a74bbcd8
6
+ metadata.gz: bf48e731b5a6f2c64912af974cbcc0954bf3559ed47fc7d90af667dd6bc54637b08266f8f8d5d461074d0120062c931e87f21e9e7b1c5b04468427260816493b
7
+ data.tar.gz: 5796ee95c99fcd151bdf683f9daabb6b400316b354bb3047db94e311f494ea5f1e93e03f69f03085c525ebd2b2239b579370d70d390fd44c602f83843cd8b545
data/CHANGELOG.md CHANGED
@@ -8,8 +8,20 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
8
8
  ## [Unreleased]
9
9
 
10
10
  None
11
+ <a name="5.3.0"></a>
11
12
 
12
- <a name="5.1.1"></a>
13
+ ## [5.3.0] - 2025-09-23
14
+
15
+ ### Added
16
+
17
+ - Add models for ExportResult and ExportRequest
18
+
19
+ ### Changed
20
+
21
+ - CallResult.callStatus -> CallResult.status
22
+ - CreateConference now includes parentCallId
23
+
24
+ <a name="5.2.0"></a>
13
25
 
14
26
  ## [5.2.0] - 2025-02-18
15
27
 
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- freeclimb (5.2.0)
4
+ freeclimb (5.3.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -39,7 +39,7 @@ GEM
39
39
  facets (3.1.0)
40
40
  factory_bot (6.5.0)
41
41
  activesupport (>= 5.0.0)
42
- ffi (1.17.1)
42
+ ffi (1.17.2)
43
43
  hashdiff (1.1.2)
44
44
  i18n (1.14.6)
45
45
  concurrent-ruby (~> 1.0)
@@ -64,7 +64,7 @@ GEM
64
64
  rainbow (3.1.1)
65
65
  rake (13.0.6)
66
66
  regexp_parser (2.10.0)
67
- rexml (3.4.0)
67
+ rexml (3.4.4)
68
68
  rspec (3.13.0)
69
69
  rspec-core (~> 3.13.0)
70
70
  rspec-expectations (~> 3.13.0)
data/README.md CHANGED
@@ -7,7 +7,7 @@ FreeClimb is a cloud-based application programming interface (API) that puts the
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 1.0.0
10
- - Package version: 5.2.0
10
+ - Package version: 5.3.0
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [https://www.freeclimb.com/support/](https://www.freeclimb.com/support/)
13
13
 
@@ -15,7 +15,7 @@ For more information, please visit [https://www.freeclimb.com/support/](https://
15
15
 
16
16
  Add this to the Gemfile:
17
17
 
18
- gem 'freeclimb', '~> 5.2.0'
18
+ gem 'freeclimb', '~> 5.3.0'
19
19
 
20
20
  and run from your terminal
21
21
 
@@ -44,9 +44,9 @@ gem build freeclimb.gemspec
44
44
  Then either install the gem locally:
45
45
 
46
46
  ```shell
47
- gem install ./freeclimb-5.2.0.gem
47
+ gem install ./freeclimb-5.3.0.gem
48
48
  ```
49
- (for development, run `gem install --dev ./freeclimb-5.2.0.gem` to install the development dependencies)
49
+ (for development, run `gem install --dev ./freeclimb-5.3.0.gem` to install the development dependencies)
50
50
 
51
51
  ## Getting Started
52
52
 
@@ -103,13 +103,16 @@ Class | Method | HTTP request | Description
103
103
  *Freeclimb::DefaultApi* | [**create_a_conference**](docs/DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference
104
104
  *Freeclimb::DefaultApi* | [**create_a_queue**](docs/DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue
105
105
  *Freeclimb::DefaultApi* | [**create_an_application**](docs/DefaultApi.md#create_an_application) | **POST** /Accounts/{accountId}/Applications | Create an application
106
+ *Freeclimb::DefaultApi* | [**create_export**](docs/DefaultApi.md#create_export) | **POST** /Accounts/{accountId}/Exports | Create an Export
106
107
  *Freeclimb::DefaultApi* | [**create_knowledge_base_completion**](docs/DefaultApi.md#create_knowledge_base_completion) | **POST** /Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion | Query the knowledge base
107
108
  *Freeclimb::DefaultApi* | [**delete_a_recording**](docs/DefaultApi.md#delete_a_recording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording
108
109
  *Freeclimb::DefaultApi* | [**delete_an_application**](docs/DefaultApi.md#delete_an_application) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application
110
+ *Freeclimb::DefaultApi* | [**delete_an_export**](docs/DefaultApi.md#delete_an_export) | **DELETE** /Accounts/{accountId}/Exports/{exportId} | Delete an Export
109
111
  *Freeclimb::DefaultApi* | [**delete_an_incoming_number**](docs/DefaultApi.md#delete_an_incoming_number) | **DELETE** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number
110
112
  *Freeclimb::DefaultApi* | [**dequeue_a_member**](docs/DefaultApi.md#dequeue_a_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Dequeue a Member
111
113
  *Freeclimb::DefaultApi* | [**dequeue_head_member**](docs/DefaultApi.md#dequeue_head_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Dequeue Head Member
112
114
  *Freeclimb::DefaultApi* | [**download_a_recording_file**](docs/DefaultApi.md#download_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Download | Download a Recording File
115
+ *Freeclimb::DefaultApi* | [**download_an_export**](docs/DefaultApi.md#download_an_export) | **GET** /Accounts/{accountId}/Exports/{exportId}/Download | Download an Export
113
116
  *Freeclimb::DefaultApi* | [**filter_logs**](docs/DefaultApi.md#filter_logs) | **POST** /Accounts/{accountId}/Logs | Filter Logs
114
117
  *Freeclimb::DefaultApi* | [**get_a_call**](docs/DefaultApi.md#get_a_call) | **GET** /Accounts/{accountId}/Calls/{callId} | Get a Call
115
118
  *Freeclimb::DefaultApi* | [**get_a_conference**](docs/DefaultApi.md#get_a_conference) | **GET** /Accounts/{accountId}/Conferences/{conferenceId} | Get a Conference
@@ -119,6 +122,7 @@ Class | Method | HTTP request | Description
119
122
  *Freeclimb::DefaultApi* | [**get_a_recording**](docs/DefaultApi.md#get_a_recording) | **GET** /Accounts/{accountId}/Recordings/{recordingId} | Get a Recording
120
123
  *Freeclimb::DefaultApi* | [**get_an_account**](docs/DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
121
124
  *Freeclimb::DefaultApi* | [**get_an_application**](docs/DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application
125
+ *Freeclimb::DefaultApi* | [**get_an_export**](docs/DefaultApi.md#get_an_export) | **GET** /Accounts/{accountId}/Exports/{exportId} | Get an Export
122
126
  *Freeclimb::DefaultApi* | [**get_an_incoming_number**](docs/DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number
123
127
  *Freeclimb::DefaultApi* | [**get_an_sms_message**](docs/DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message
124
128
  *Freeclimb::DefaultApi* | [**get_head_member**](docs/DefaultApi.md#get_head_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Get Head Member
@@ -139,6 +143,7 @@ Class | Method | HTTP request | Description
139
143
  *Freeclimb::DefaultApi* | [**list_calls**](docs/DefaultApi.md#list_calls) | **GET** /Accounts/{accountId}/Calls | List Calls
140
144
  *Freeclimb::DefaultApi* | [**list_conference_recordings**](docs/DefaultApi.md#list_conference_recordings) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Recordings | List Conference Recordings
141
145
  *Freeclimb::DefaultApi* | [**list_conferences**](docs/DefaultApi.md#list_conferences) | **GET** /Accounts/{accountId}/Conferences | List Conferences
146
+ *Freeclimb::DefaultApi* | [**list_exports**](docs/DefaultApi.md#list_exports) | **GET** /Accounts/{accountId}/Exports | List Exports
142
147
  *Freeclimb::DefaultApi* | [**list_incoming_numbers**](docs/DefaultApi.md#list_incoming_numbers) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers | List Incoming Numbers
143
148
  *Freeclimb::DefaultApi* | [**list_members**](docs/DefaultApi.md#list_members) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members | List Members
144
149
  *Freeclimb::DefaultApi* | [**list_participants**](docs/DefaultApi.md#list_participants) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants | List Participants
@@ -200,6 +205,14 @@ Class | Method | HTTP request | Description
200
205
  - [Freeclimb::Dequeue](docs/Dequeue.md)
201
206
  - [Freeclimb::DequeueWebhook](docs/DequeueWebhook.md)
202
207
  - [Freeclimb::Enqueue](docs/Enqueue.md)
208
+ - [Freeclimb::ExportList](docs/ExportList.md)
209
+ - [Freeclimb::ExportOutputType](docs/ExportOutputType.md)
210
+ - [Freeclimb::ExportRequest](docs/ExportRequest.md)
211
+ - [Freeclimb::ExportRequestOutput](docs/ExportRequestOutput.md)
212
+ - [Freeclimb::ExportResourceType](docs/ExportResourceType.md)
213
+ - [Freeclimb::ExportResult](docs/ExportResult.md)
214
+ - [Freeclimb::ExportResultOutput](docs/ExportResultOutput.md)
215
+ - [Freeclimb::ExportStatus](docs/ExportStatus.md)
203
216
  - [Freeclimb::FilterLogsRequest](docs/FilterLogsRequest.md)
204
217
  - [Freeclimb::GetDigits](docs/GetDigits.md)
205
218
  - [Freeclimb::GetDigitsReason](docs/GetDigitsReason.md)
data/docs/CallResult.md CHANGED
@@ -14,7 +14,7 @@
14
14
  | **from** | **String** | Phone number that initiated this Call. | [optional] |
15
15
  | **to** | **String** | Phone number that received this Call. | [optional] |
16
16
  | **phone_number_id** | **String** | If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI). | [optional] |
17
- | **call_status** | [**CallStatus**](CallStatus.md) | | [optional] |
17
+ | **status** | [**CallStatus**](CallStatus.md) | | [optional] |
18
18
  | **start_time** | **String** | Start time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional] |
19
19
  | **connect_time** | **String** | Time the Call was answered (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional] |
20
20
  | **end_time** | **String** | End time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call did not complete successfully. | [optional] |
@@ -41,7 +41,7 @@ instance = Freeclimb::CallResult.new(
41
41
  from: null,
42
42
  to: null,
43
43
  phone_number_id: null,
44
- call_status: null,
44
+ status: null,
45
45
  start_time: null,
46
46
  connect_time: null,
47
47
  end_time: null,
data/docs/CreateConference.md CHANGED
@@ -5,11 +5,12 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
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] |
8
+ | **_alias** | **String** | Descriptive name for the Conference. | [optional] |
9
9
  | **play_beep** | [**PlayBeep**](PlayBeep.md) | | [optional] |
10
10
  | **record** | **Boolean** | When set to &#x60;true&#x60;, the entire Conference is recorded. The &#x60;statusCallbackUrl&#x60; of the Conference will receive a &#x60;conferenceRecordingEnded&#x60; Webhook when the Conference transitions from the &#x60;inProgress&#x60; to empty state. | [optional] |
11
11
  | **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] |
12
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
+ | **parent_call_id** | **String** | ID of the Call that created this leg (child call). | [optional] |
13
14
 
14
15
  ## Example
15
16
 
@@ -22,7 +23,8 @@ instance = Freeclimb::CreateConference.new(
22
23
  play_beep: null,
23
24
  record: null,
24
25
  status_callback_url: null,
25
- wait_url: null
26
+ wait_url: null,
27
+ parent_call_id: null
26
28
  )
27
29
  ```
28
30
 
data/docs/DefaultApi.md CHANGED
@@ -12,12 +12,16 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
12
12
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
13
13
  | [**create_an_application**](DefaultApi.md#create_an_application) | **POST** /Accounts/{accountId}/Applications | Create an application |
14
14
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
15
+ | [**create_export**](DefaultApi.md#create_export) | **POST** /Accounts/{accountId}/Exports | Create an Export |
16
+ | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
15
17
  | [**create_knowledge_base_completion**](DefaultApi.md#create_knowledge_base_completion) | **POST** /Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion | Query the knowledge base |
16
18
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
17
19
  | [**delete_a_recording**](DefaultApi.md#delete_a_recording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording |
18
20
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
19
21
  | [**delete_an_application**](DefaultApi.md#delete_an_application) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application |
20
22
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
23
+ | [**delete_an_export**](DefaultApi.md#delete_an_export) | **DELETE** /Accounts/{accountId}/Exports/{exportId} | Delete an Export |
24
+ | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
21
25
  | [**delete_an_incoming_number**](DefaultApi.md#delete_an_incoming_number) | **DELETE** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number |
22
26
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
23
27
  | [**dequeue_a_member**](DefaultApi.md#dequeue_a_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Dequeue a Member |
@@ -26,6 +30,8 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
26
30
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
27
31
  | [**download_a_recording_file**](DefaultApi.md#download_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Download | Download a Recording File |
28
32
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
33
+ | [**download_an_export**](DefaultApi.md#download_an_export) | **GET** /Accounts/{accountId}/Exports/{exportId}/Download | Download an Export |
34
+ | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
29
35
  | [**filter_logs**](DefaultApi.md#filter_logs) | **POST** /Accounts/{accountId}/Logs | Filter Logs |
30
36
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
31
37
  | [**get_a_call**](DefaultApi.md#get_a_call) | **GET** /Accounts/{accountId}/Calls/{callId} | Get a Call |
@@ -44,6 +50,8 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
44
50
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
45
51
  | [**get_an_application**](DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application |
46
52
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
53
+ | [**get_an_export**](DefaultApi.md#get_an_export) | **GET** /Accounts/{accountId}/Exports/{exportId} | Get an Export |
54
+ | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
47
55
  | [**get_an_incoming_number**](DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number |
48
56
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
49
57
  | [**get_an_sms_message**](DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message |
@@ -84,6 +92,8 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
84
92
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
85
93
  | [**list_conferences**](DefaultApi.md#list_conferences) | **GET** /Accounts/{accountId}/Conferences | List Conferences |
86
94
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
95
+ | [**list_exports**](DefaultApi.md#list_exports) | **GET** /Accounts/{accountId}/Exports | List Exports |
96
+ | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
87
97
  | [**list_incoming_numbers**](DefaultApi.md#list_incoming_numbers) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers | List Incoming Numbers |
88
98
  | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
89
99
  | [**list_members**](DefaultApi.md#list_members) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members | List Members |
@@ -403,6 +413,77 @@ end
403
413
  - **Accept**: application/json
404
414
 
405
415
 
416
+ ## create_export
417
+
418
+ Create an Export
419
+
420
+ ### Examples
421
+
422
+ ```ruby
423
+ require 'time'
424
+ require 'freeclimb'
425
+ # setup authorization
426
+ Freeclimb.configure do |config|
427
+ # Configure HTTP basic authorization: fc
428
+ config.username = 'ACCOUNT_ID'
429
+ config.password = 'API_KEY'
430
+ end
431
+
432
+ api_instance = Freeclimb::DefaultApi.new
433
+
434
+ opts = {
435
+ export_request: Freeclimb::ExportRequest.new({resource_type: Freeclimb::ExportResourceType::MESSAGES, output: Freeclimb::ExportRequestOutput.new({type: Freeclimb::ExportOutputType::CSV})}) # ExportRequest | A JSON object containing export creation parameters
436
+ }
437
+
438
+ begin
439
+
440
+ # Create an Export
441
+ result = api_instance.create_export(opts)
442
+ p result
443
+ rescue Freeclimb::ApiError => e
444
+ puts "Error when calling DefaultApi->create_export: #{e}"
445
+ end
446
+ ```
447
+
448
+ #### Using the create_export_with_http_info variant
449
+
450
+ This returns an Array which contains the response data, status code and headers.
451
+
452
+ > <Array(<ExportResult>, Integer, Hash)> create_export_with_http_info(account_id, opts)
453
+
454
+ ```ruby
455
+ begin
456
+ # Create an Export
457
+ data, status_code, headers = api_instance.create_export_with_http_info(opts)
458
+ p status_code # => 2xx
459
+ p headers # => { ... }
460
+ p data # => <ExportResult>
461
+ rescue Freeclimb::ApiError => e
462
+ puts "Error when calling DefaultApi->create_export_with_http_info: #{e}"
463
+ end
464
+ ```
465
+
466
+ ### Parameters
467
+
468
+ | Name | Type | Description | Notes |
469
+ | ---- | ---- | ----------- | ----- |
470
+ | **export_request** | [**ExportRequest**](ExportRequest.md) | A JSON object containing export creation parameters | [optional] |
471
+
472
+
473
+ ### Return type
474
+
475
+ [**ExportResult**](ExportResult.md)
476
+
477
+ ### Authorization
478
+
479
+ [fc](../README.md#fc)
480
+
481
+ ### HTTP request headers
482
+
483
+ - **Content-Type**: application/json
484
+ - **Accept**: application/json
485
+
486
+
406
487
  ## create_knowledge_base_completion
407
488
 
408
489
  Query the knowledge base
@@ -615,6 +696,75 @@ nil (empty response body)
615
696
  - **Accept**: Not defined
616
697
 
617
698
 
699
+ ## delete_an_export
700
+
701
+ Delete an Export
702
+
703
+ ### Examples
704
+
705
+ ```ruby
706
+ require 'time'
707
+ require 'freeclimb'
708
+ # setup authorization
709
+ Freeclimb.configure do |config|
710
+ # Configure HTTP basic authorization: fc
711
+ config.username = 'ACCOUNT_ID'
712
+ config.password = 'API_KEY'
713
+ end
714
+
715
+ api_instance = Freeclimb::DefaultApi.new
716
+
717
+ export_id = 'export_id_example' # String | A string that uniquely identifies this export resource.
718
+
719
+
720
+ begin
721
+
722
+ # Delete an Export
723
+ api_instance.delete_an_export(export_id)
724
+ rescue Freeclimb::ApiError => e
725
+ puts "Error when calling DefaultApi->delete_an_export: #{e}"
726
+ end
727
+ ```
728
+
729
+ #### Using the delete_an_export_with_http_info variant
730
+
731
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
732
+
733
+ > <Array(nil, Integer, Hash)> delete_an_export_with_http_info(account_id, export_id)
734
+
735
+ ```ruby
736
+ begin
737
+ # Delete an Export
738
+ data, status_code, headers = api_instance.delete_an_export_with_http_info(export_id)
739
+ p status_code # => 2xx
740
+ p headers # => { ... }
741
+ p data # => nil
742
+ rescue Freeclimb::ApiError => e
743
+ puts "Error when calling DefaultApi->delete_an_export_with_http_info: #{e}"
744
+ end
745
+ ```
746
+
747
+ ### Parameters
748
+
749
+ | Name | Type | Description | Notes |
750
+ | ---- | ---- | ----------- | ----- |
751
+ | **export_id** | **String** | A string that uniquely identifies this export resource. | |
752
+
753
+
754
+ ### Return type
755
+
756
+ nil (empty response body)
757
+
758
+ ### Authorization
759
+
760
+ [fc](../README.md#fc)
761
+
762
+ ### HTTP request headers
763
+
764
+ - **Content-Type**: Not defined
765
+ - **Accept**: Not defined
766
+
767
+
618
768
  ## delete_an_incoming_number
619
769
 
620
770
  Delete an Incoming Number
@@ -897,6 +1047,76 @@ end
897
1047
  - **Accept**: audio/x-wav
898
1048
 
899
1049
 
1050
+ ## download_an_export
1051
+
1052
+ Download an Export
1053
+
1054
+ ### Examples
1055
+
1056
+ ```ruby
1057
+ require 'time'
1058
+ require 'freeclimb'
1059
+ # setup authorization
1060
+ Freeclimb.configure do |config|
1061
+ # Configure HTTP basic authorization: fc
1062
+ config.username = 'ACCOUNT_ID'
1063
+ config.password = 'API_KEY'
1064
+ end
1065
+
1066
+ api_instance = Freeclimb::DefaultApi.new
1067
+
1068
+ export_id = 'export_id_example' # String | A string that uniquely identifies this export resource.
1069
+
1070
+
1071
+ begin
1072
+
1073
+ # Download an Export
1074
+ result = api_instance.download_an_export(export_id)
1075
+ p result
1076
+ rescue Freeclimb::ApiError => e
1077
+ puts "Error when calling DefaultApi->download_an_export: #{e}"
1078
+ end
1079
+ ```
1080
+
1081
+ #### Using the download_an_export_with_http_info variant
1082
+
1083
+ This returns an Array which contains the response data, status code and headers.
1084
+
1085
+ > <Array(String, Integer, Hash)> download_an_export_with_http_info(account_id, export_id)
1086
+
1087
+ ```ruby
1088
+ begin
1089
+ # Download an Export
1090
+ data, status_code, headers = api_instance.download_an_export_with_http_info(export_id)
1091
+ p status_code # => 2xx
1092
+ p headers # => { ... }
1093
+ p data # => String
1094
+ rescue Freeclimb::ApiError => e
1095
+ puts "Error when calling DefaultApi->download_an_export_with_http_info: #{e}"
1096
+ end
1097
+ ```
1098
+
1099
+ ### Parameters
1100
+
1101
+ | Name | Type | Description | Notes |
1102
+ | ---- | ---- | ----------- | ----- |
1103
+ | **export_id** | **String** | A string that uniquely identifies this export resource. | |
1104
+
1105
+
1106
+ ### Return type
1107
+
1108
+ **String**
1109
+
1110
+ ### Authorization
1111
+
1112
+ [fc](../README.md#fc)
1113
+
1114
+ ### HTTP request headers
1115
+
1116
+ - **Content-Type**: Not defined
1117
+ - **Accept**: text/csv
1118
+
1119
+
900
1120
  ## filter_logs
901
1121
 
902
1122
  Filter Logs
@@ -1530,6 +1750,76 @@ end
1530
1750
  - **Accept**: application/json
1531
1751
 
1532
1752
 
1753
+ ## get_an_export
1754
+
1755
+ Get an Export
1756
+
1757
+ ### Examples
1758
+
1759
+ ```ruby
1760
+ require 'time'
1761
+ require 'freeclimb'
1762
+ # setup authorization
1763
+ Freeclimb.configure do |config|
1764
+ # Configure HTTP basic authorization: fc
1765
+ config.username = 'ACCOUNT_ID'
1766
+ config.password = 'API_KEY'
1767
+ end
1768
+
1769
+ api_instance = Freeclimb::DefaultApi.new
1770
+
1771
+ export_id = 'export_id_example' # String | A string that uniquely identifies this export resource.
1772
+
1773
+
1774
+ begin
1775
+
1776
+ # Get an Export
1777
+ result = api_instance.get_an_export(export_id)
1778
+ p result
1779
+ rescue Freeclimb::ApiError => e
1780
+ puts "Error when calling DefaultApi->get_an_export: #{e}"
1781
+ end
1782
+ ```
1783
+
1784
+ #### Using the get_an_export_with_http_info variant
1785
+
1786
+ This returns an Array which contains the response data, status code and headers.
1787
+
1788
+ > <Array(<ExportResult>, Integer, Hash)> get_an_export_with_http_info(account_id, export_id)
1789
+
1790
+ ```ruby
1791
+ begin
1792
+ # Get an Export
1793
+ data, status_code, headers = api_instance.get_an_export_with_http_info(export_id)
1794
+ p status_code # => 2xx
1795
+ p headers # => { ... }
1796
+ p data # => <ExportResult>
1797
+ rescue Freeclimb::ApiError => e
1798
+ puts "Error when calling DefaultApi->get_an_export_with_http_info: #{e}"
1799
+ end
1800
+ ```
1801
+
1802
+ ### Parameters
1803
+
1804
+ | Name | Type | Description | Notes |
1805
+ | ---- | ---- | ----------- | ----- |
1806
+ | **export_id** | **String** | A string that uniquely identifies this export resource. | |
1807
+
1808
+
1809
+ ### Return type
1810
+
1811
+ [**ExportResult**](ExportResult.md)
1812
+
1813
+ ### Authorization
1814
+
1815
+ [fc](../README.md#fc)
1816
+
1817
+ ### HTTP request headers
1818
+
1819
+ - **Content-Type**: Not defined
1820
+ - **Accept**: application/json
1821
+
1822
+
1533
1823
  ## get_an_incoming_number
1534
1824
 
1535
1825
  Get an Incoming Number
@@ -2764,7 +3054,9 @@ opts = {
2764
3054
  start_time: 'start_time_example', # String | Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss.
2765
3055
  end_time: 'end_time_example', # String | Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss.
2766
3056
  parent_call_id: 'parent_call_id_example', # String | Only show Calls spawned by the call with this ID.
2767
- application_id: ['inner_example'] # Array<String> | Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications.
3057
+ application_id: ['inner_example'], # Array<String> | Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications.
3058
+ risk_score_min: 56, # Integer | The minimum riskScore that should be included in the list.
3059
+ risk_score_max: 56 # Integer | The maximum riskScore that should be included in the list.
2768
3060
  }
2769
3061
 
2770
3062
  begin
@@ -2807,6 +3099,8 @@ end
2807
3099
  | **end_time** | **String** | Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss. | [optional] |
2808
3100
  | **parent_call_id** | **String** | Only show Calls spawned by the call with this ID. | [optional] |
2809
3101
  | **application_id** | [**Array&lt;String&gt;**](String.md) | Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications. | [optional] |
3102
+ | **risk_score_min** | **Integer** | The minimum riskScore that should be included in the list. | [optional] |
3103
+ | **risk_score_max** | **Integer** | The maximum riskScore that should be included in the list. | [optional] |
2810
3104
 
2811
3105
 
2812
3106
  ### Return type
@@ -2976,6 +3270,79 @@ end
2976
3270
  - **Accept**: application/json
2977
3271
 
2978
3272
 
3273
+ ## list_exports
3274
+
3275
+ List Exports
3276
+
3277
+ ### Examples
3278
+
3279
+ ```ruby
3280
+ require 'time'
3281
+ require 'freeclimb'
3282
+ # setup authorization
3283
+ Freeclimb.configure do |config|
3284
+ # Configure HTTP basic authorization: fc
3285
+ config.username = 'ACCOUNT_ID'
3286
+ config.password = 'API_KEY'
3287
+ end
3288
+
3289
+ api_instance = Freeclimb::DefaultApi.new
3290
+
3291
+ opts = {
3292
+ status: Freeclimb::ExportStatus::INTAKING, # ExportStatus | Status of export
3293
+ cursor: 'cursor_example' # String | Used to reference pages of a list of exports
3294
+ }
3295
+
3296
+ begin
3297
+
3298
+ # List Exports
3299
+ result = api_instance.list_exports(opts)
3300
+ p result
3301
+ rescue Freeclimb::ApiError => e
3302
+ puts "Error when calling DefaultApi->list_exports: #{e}"
3303
+ end
3304
+ ```
3305
+
3306
+ #### Using the list_exports_with_http_info variant
3307
+
3308
+ This returns an Array which contains the response data, status code and headers.
3309
+
3310
+ > <Array(<ExportList>, Integer, Hash)> list_exports_with_http_info(account_id, opts)
3311
+
3312
+ ```ruby
3313
+ begin
3314
+ # List Exports
3315
+ data, status_code, headers = api_instance.list_exports_with_http_info(opts)
3316
+ p status_code # => 2xx
3317
+ p headers # => { ... }
3318
+ p data # => <ExportList>
3319
+ rescue Freeclimb::ApiError => e
3320
+ puts "Error when calling DefaultApi->list_exports_with_http_info: #{e}"
3321
+ end
3322
+ ```
3323
+
3324
+ ### Parameters
3325
+
3326
+ | Name | Type | Description | Notes |
3327
+ | ---- | ---- | ----------- | ----- |
3328
+ | **status** | [**ExportStatus**](.md) | Status of export | [optional] |
3329
+ | **cursor** | **String** | Used to reference pages of a list of exports | [optional] |
3330
+
3331
+
3332
+ ### Return type
3333
+
3334
+ [**ExportList**](ExportList.md)
3335
+
3336
+ ### Authorization
3337
+
3338
+ [fc](../README.md#fc)
3339
+
3340
+ ### HTTP request headers
3341
+
3342
+ - **Content-Type**: Not defined
3343
+ - **Accept**: application/json
3344
+
3345
+
2979
3346
  ## list_incoming_numbers
2980
3347
 
2981
3348
  List Incoming Numbers
data/docs/ExportList.md ADDED
@@ -0,0 +1,32 @@
1
+ # Freeclimb::ExportList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **total** | **Integer** | Total amount of requested resource. | [optional] |
8
+ | **start** | **Integer** | Resource index at start of current page | [optional] |
9
+ | **_end** | **Integer** | Resource index at end of current page | [optional] |
10
+ | **page** | **Integer** | Current page | [optional] |
11
+ | **num_pages** | **Integer** | Total number of pages | [optional] |
12
+ | **page_size** | **Integer** | Number of items per page | [optional] |
13
+ | **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional] |
14
+ | **exports** | [**Array&lt;ExportResult&gt;**](ExportResult.md) | | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'freeclimb'
20
+
21
+ instance = Freeclimb::ExportList.new(
22
+ total: null,
23
+ start: null,
24
+ _end: null,
25
+ page: null,
26
+ num_pages: null,
27
+ page_size: null,
28
+ next_page_uri: null,
29
+ exports: null
30
+ )
31
+ ```
32
+
data/docs/ExportOutputType.md ADDED
@@ -0,0 +1,16 @@
1
+ # Freeclimb::ExportOutputType
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **CSV** | **ExportOutputType** | | Represented in Ruby as "csv" |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'freeclimb'
13
+
14
+ instance = Freeclimb::ExportOutputType::[NAME OF ENUM]
15
+ ```
16
+