freeclimb 5.1.0 → 5.3.0

data/docs/DefaultApi.md

@@ -12,12 +12,16 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**create_an_application**](DefaultApi.md#create_an_application) | **POST** /Accounts/{accountId}/Applications | Create an application |
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
+| [**create_export**](DefaultApi.md#create_export) | **POST** /Accounts/{accountId}/Exports | Create an Export |
+| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**create_knowledge_base_completion**](DefaultApi.md#create_knowledge_base_completion) | **POST** /Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion | Query the knowledge base |
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**delete_a_recording**](DefaultApi.md#delete_a_recording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording |
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**delete_an_application**](DefaultApi.md#delete_an_application) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application |
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
+| [**delete_an_export**](DefaultApi.md#delete_an_export) | **DELETE** /Accounts/{accountId}/Exports/{exportId} | Delete an Export |
+| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**delete_an_incoming_number**](DefaultApi.md#delete_an_incoming_number) | **DELETE** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number |
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**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*
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**download_a_recording_file**](DefaultApi.md#download_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Download | Download a Recording File |
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
+| [**download_an_export**](DefaultApi.md#download_an_export) | **GET** /Accounts/{accountId}/Exports/{exportId}/Download | Download an Export |
+| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**filter_logs**](DefaultApi.md#filter_logs) | **POST** /Accounts/{accountId}/Logs | Filter Logs |
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**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*
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**get_an_application**](DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application |
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
+| [**get_an_export**](DefaultApi.md#get_an_export) | **GET** /Accounts/{accountId}/Exports/{exportId} | Get an Export |
+| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**get_an_incoming_number**](DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number |
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**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*
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**list_conferences**](DefaultApi.md#list_conferences) | **GET** /Accounts/{accountId}/Conferences | List Conferences |
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
+| [**list_exports**](DefaultApi.md#list_exports) | **GET** /Accounts/{accountId}/Exports | List Exports |
+| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**list_incoming_numbers**](DefaultApi.md#list_incoming_numbers) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers | List Incoming Numbers |
 | [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
 | [**list_members**](DefaultApi.md#list_members) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members | List Members |
@@ -209,7 +219,7 @@ end
 api_instance = Freeclimb::DefaultApi.new
 
 opts = {
-  create_conference_request: Freeclimb::CreateConferenceRequest.new # CreateConferenceRequest | Conference to create
+  create_conference_request: Freeclimb::CreateConferenceRequest.new({status_callback_url: 'status_callback_url_example'}) # CreateConferenceRequest | Conference to create
 }
 
 begin
@@ -403,6 +413,77 @@ end
 - **Accept**: application/json
 
 
+## create_export
+
+Create an Export
+
+### Examples
+
+```ruby
+require 'time'
+require 'freeclimb'
+# setup authorization
+Freeclimb.configure do |config|
+  # Configure HTTP basic authorization: fc
+  config.username = 'ACCOUNT_ID'
+  config.password = 'API_KEY'
+end
+
+api_instance = Freeclimb::DefaultApi.new
+
+opts = {
+  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
+}
+
+begin
+
+  # Create an Export
+  result = api_instance.create_export(opts)
+  p result
+rescue Freeclimb::ApiError => e
+  puts "Error when calling DefaultApi->create_export: #{e}"
+end
+```
+
+#### Using the create_export_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExportResult>, Integer, Hash)> create_export_with_http_info(account_id, opts)
+
+```ruby
+begin
+  # Create an Export
+  data, status_code, headers = api_instance.create_export_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExportResult>
+rescue Freeclimb::ApiError => e
+  puts "Error when calling DefaultApi->create_export_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **export_request** | [**ExportRequest**](ExportRequest.md) | A JSON object containing export creation parameters | [optional] |
+
+
+### Return type
+
+[**ExportResult**](ExportResult.md)
+
+### Authorization
+
+[fc](../README.md#fc)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## create_knowledge_base_completion
 
 Query the knowledge base
@@ -615,6 +696,75 @@ nil (empty response body)
 - **Accept**: Not defined
 
 
+## delete_an_export
+
+Delete an Export
+
+### Examples
+
+```ruby
+require 'time'
+require 'freeclimb'
+# setup authorization
+Freeclimb.configure do |config|
+  # Configure HTTP basic authorization: fc
+  config.username = 'ACCOUNT_ID'
+  config.password = 'API_KEY'
+end
+
+api_instance = Freeclimb::DefaultApi.new
+
+export_id = 'export_id_example' # String | A string that uniquely identifies this export resource.
+
+
+begin
+
+  # Delete an Export
+  api_instance.delete_an_export(export_id)
+rescue Freeclimb::ApiError => e
+  puts "Error when calling DefaultApi->delete_an_export: #{e}"
+end
+```
+
+#### Using the delete_an_export_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_an_export_with_http_info(account_id, export_id)
+
+```ruby
+begin
+  # Delete an Export
+  data, status_code, headers = api_instance.delete_an_export_with_http_info(export_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Freeclimb::ApiError => e
+  puts "Error when calling DefaultApi->delete_an_export_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **export_id** | **String** | A string that uniquely identifies this export resource. |  |
+
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[fc](../README.md#fc)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
 ## delete_an_incoming_number
 
 Delete an Incoming Number
@@ -897,6 +1047,76 @@ end
 - **Accept**: audio/x-wav
 
 
+## download_an_export
+
+Download an Export
+
+### Examples
+
+```ruby
+require 'time'
+require 'freeclimb'
+# setup authorization
+Freeclimb.configure do |config|
+  # Configure HTTP basic authorization: fc
+  config.username = 'ACCOUNT_ID'
+  config.password = 'API_KEY'
+end
+
+api_instance = Freeclimb::DefaultApi.new
+
+export_id = 'export_id_example' # String | A string that uniquely identifies this export resource.
+
+
+begin
+
+  # Download an Export
+  result = api_instance.download_an_export(export_id)
+  p result
+rescue Freeclimb::ApiError => e
+  puts "Error when calling DefaultApi->download_an_export: #{e}"
+end
+```
+
+#### Using the download_an_export_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> download_an_export_with_http_info(account_id, export_id)
+
+```ruby
+begin
+  # Download an Export
+  data, status_code, headers = api_instance.download_an_export_with_http_info(export_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue Freeclimb::ApiError => e
+  puts "Error when calling DefaultApi->download_an_export_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **export_id** | **String** | A string that uniquely identifies this export resource. |  |
+
+
+### Return type
+
+**String**
+
+### Authorization
+
+[fc](../README.md#fc)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/csv
+
+
 ## filter_logs
 
 Filter Logs
@@ -1530,6 +1750,76 @@ end
 - **Accept**: application/json
 
 
+## get_an_export
+
+Get an Export
+
+### Examples
+
+```ruby
+require 'time'
+require 'freeclimb'
+# setup authorization
+Freeclimb.configure do |config|
+  # Configure HTTP basic authorization: fc
+  config.username = 'ACCOUNT_ID'
+  config.password = 'API_KEY'
+end
+
+api_instance = Freeclimb::DefaultApi.new
+
+export_id = 'export_id_example' # String | A string that uniquely identifies this export resource.
+
+
+begin
+
+  # Get an Export
+  result = api_instance.get_an_export(export_id)
+  p result
+rescue Freeclimb::ApiError => e
+  puts "Error when calling DefaultApi->get_an_export: #{e}"
+end
+```
+
+#### Using the get_an_export_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExportResult>, Integer, Hash)> get_an_export_with_http_info(account_id, export_id)
+
+```ruby
+begin
+  # Get an Export
+  data, status_code, headers = api_instance.get_an_export_with_http_info(export_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExportResult>
+rescue Freeclimb::ApiError => e
+  puts "Error when calling DefaultApi->get_an_export_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **export_id** | **String** | A string that uniquely identifies this export resource. |  |
+
+
+### Return type
+
+[**ExportResult**](ExportResult.md)
+
+### Authorization
+
+[fc](../README.md#fc)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_an_incoming_number
 
 Get an Incoming Number
@@ -2764,7 +3054,9 @@ opts = {
   start_time: 'start_time_example', # String | Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss.
   end_time: 'end_time_example', # String | Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss.
   parent_call_id: 'parent_call_id_example', # String | Only show Calls spawned by the call with this ID.
-  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.
+  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.
+  risk_score_min: 56, # Integer | The minimum riskScore that should be included in the list.
+  risk_score_max: 56 # Integer | The maximum riskScore that should be included in the list.
 }
 
 begin
@@ -2807,6 +3099,8 @@ end
 | **end_time** | **String** | Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss. | [optional] |
 | **parent_call_id** | **String** | Only show Calls spawned by the call with this ID. | [optional] |
 | **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] |
+| **risk_score_min** | **Integer** | The minimum riskScore that should be included in the list. | [optional] |
+| **risk_score_max** | **Integer** | The maximum riskScore that should be included in the list. | [optional] |
 
 
 ### Return type
@@ -2976,6 +3270,79 @@ end
 - **Accept**: application/json
 
 
+## list_exports
+
+List Exports
+
+### Examples
+
+```ruby
+require 'time'
+require 'freeclimb'
+# setup authorization
+Freeclimb.configure do |config|
+  # Configure HTTP basic authorization: fc
+  config.username = 'ACCOUNT_ID'
+  config.password = 'API_KEY'
+end
+
+api_instance = Freeclimb::DefaultApi.new
+
+opts = {
+  status: Freeclimb::ExportStatus::INTAKING, # ExportStatus | Status of export
+  cursor: 'cursor_example' # String | Used to reference pages of a list of exports
+}
+
+begin
+
+  # List Exports
+  result = api_instance.list_exports(opts)
+  p result
+rescue Freeclimb::ApiError => e
+  puts "Error when calling DefaultApi->list_exports: #{e}"
+end
+```
+
+#### Using the list_exports_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExportList>, Integer, Hash)> list_exports_with_http_info(account_id, opts)
+
+```ruby
+begin
+  # List Exports
+  data, status_code, headers = api_instance.list_exports_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExportList>
+rescue Freeclimb::ApiError => e
+  puts "Error when calling DefaultApi->list_exports_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**ExportStatus**](.md) | Status of export | [optional] |
+| **cursor** | **String** | Used to reference pages of a list of exports | [optional] |
+
+
+### Return type
+
+[**ExportList**](ExportList.md)
+
+### Authorization
+
+[fc](../README.md#fc)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_incoming_numbers
 
 List Incoming Numbers

data/docs/ExportList.md

@@ -0,0 +1,32 @@
+# Freeclimb::ExportList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** | Total amount of requested resource. | [optional] |
+| **start** | **Integer** | Resource index at start of current page | [optional] |
+| **_end** | **Integer** | Resource index at end of current page | [optional] |
+| **page** | **Integer** | Current page | [optional] |
+| **num_pages** | **Integer** | Total number of pages | [optional] |
+| **page_size** | **Integer** | Number of items per page | [optional] |
+| **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional] |
+| **exports** | [**Array<ExportResult>**](ExportResult.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ExportList.new(
+  total: null,
+  start: null,
+  _end: null,
+  page: null,
+  num_pages: null,
+  page_size: null,
+  next_page_uri: null,
+  exports: null
+)
+```
+

data/docs/ExportOutputType.md

@@ -0,0 +1,16 @@
+# Freeclimb::ExportOutputType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **CSV** | **ExportOutputType** |  | Represented in Ruby as "csv" |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ExportOutputType::[NAME OF ENUM]
+```
+

data/docs/ExportRequest.md

@@ -0,0 +1,24 @@
+# Freeclimb::ExportRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **resource_type** | [**ExportResourceType**](ExportResourceType.md) |  |  |
+| **format** | **Array<String>** |  | [optional] |
+| **output** | [**ExportRequestOutput**](ExportRequestOutput.md) |  |  |
+| **query** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ExportRequest.new(
+  resource_type: null,
+  format: null,
+  output: null,
+  query: null
+)
+```
+

data/docs/ExportRequestOutput.md

@@ -0,0 +1,18 @@
+# Freeclimb::ExportRequestOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ExportOutputType**](ExportOutputType.md) |  |  |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ExportRequestOutput.new(
+  type: null
+)
+```
+

data/docs/ExportResourceType.md

@@ -0,0 +1,17 @@
+# Freeclimb::ExportResourceType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **MESSAGES** | **ExportResourceType** |  | Represented in Ruby as "Messages" |
+| **CALLS** | **ExportResourceType** |  | Represented in Ruby as "Calls" |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ExportResourceType::[NAME OF ENUM]
+```
+

data/docs/ExportResult.md

@@ -0,0 +1,40 @@
+# Freeclimb::ExportResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | String that uniquely identifies this account resource. |  |
+| **uri** | **String** |  |  |
+| **date_created** | **String** |  |  |
+| **date_updated** | **String** |  |  |
+| **revision** | **Integer** |  |  |
+| **export_id** | **String** | String that uniquely identifies this export resource |  |
+| **status** | [**ExportStatus**](ExportStatus.md) |  |  |
+| **size** | **Integer** |  |  |
+| **resource_type** | [**ExportResourceType**](ExportResourceType.md) |  |  |
+| **query** | **Object** | Query params used to filter exported documents |  |
+| **format** | **Array<String>** | Desired fields of exported documents |  |
+| **output** | [**ExportResultOutput**](ExportResultOutput.md) |  |  |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ExportResult.new(
+  account_id: null,
+  uri: null,
+  date_created: null,
+  date_updated: null,
+  revision: null,
+  export_id: null,
+  status: null,
+  size: null,
+  resource_type: null,
+  query: null,
+  format: null,
+  output: null
+)
+```
+

data/docs/ExportResultOutput.md

@@ -0,0 +1,18 @@
+# Freeclimb::ExportResultOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ExportOutputType**](ExportOutputType.md) |  |  |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ExportResultOutput.new(
+  type: null
+)
+```
+

data/docs/ExportStatus.md

@@ -0,0 +1,21 @@
+# Freeclimb::ExportStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **INTAKING** | **ExportStatus** |  | Represented in Ruby as "intaking" |
+| **QUEUED** | **ExportStatus** |  | Represented in Ruby as "queued" |
+| **IN_PROGRESS** | **ExportStatus** |  | Represented in Ruby as "inProgress" |
+| **COMPLETED** | **ExportStatus** |  | Represented in Ruby as "completed" |
+| **FAILED** | **ExportStatus** |  | Represented in Ruby as "failed" |
+| **DELETED** | **ExportStatus** |  | Represented in Ruby as "deleted" |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::ExportStatus::[NAME OF ENUM]
+```
+