freeclimb 5.2.0 → 5.3.0

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]
+```
+

data/lib/freeclimb/api/default_api.rb

@@ -276,6 +276,68 @@ module Freeclimb
       [data, status_code, headers]
     end
 
+    # Create an Export
+    # @param [Hash] opts the optional parameters
+    # @option opts [ExportRequest] :export_request A JSON object containing export creation parameters
+    # @return [ExportResult]
+    def create_export(opts = {})
+      data, _status_code, _headers = create_export_with_http_info(opts)
+      data
+    end
+
+    # Create an Export
+    # @param [Hash] opts the optional parameters
+    # @option opts [ExportRequest] :export_request A JSON object containing export creation parameters
+    # @return [Array<(ExportResult, Integer, Hash)>] ExportResult data, response status code and response headers
+    def create_export_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DefaultApi.create_export ..."
+      end
+      # resource path
+      local_var_path = "/Accounts/{accountId}/Exports".sub("{" + "accountId" + "}", CGI.escape(account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params["Accept"] = @api_client.select_header_accept(["application/json"])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(["application/json"])
+      if !content_type.nil?
+        header_params["Content-Type"] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:export_request])
+
+      # return_type
+      return_type = opts[:debug_return_type] || "ExportResult"
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ["fc"]
+
+      new_options = opts.merge(
+        operation: :"DefaultApi.create_export",
+        header_params: header_params,
+        query_params: query_params,
+        form_params: form_params,
+        body: post_body,
+        auth_names: auth_names,
+        return_type: return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#create_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
     # Query the knowledge base
     # @param knowledge_base_id [String] A string that uniquely identifies the KnowledgeBase resource.
     # @param [Hash] opts the optional parameters
@@ -465,6 +527,66 @@ module Freeclimb
       [data, status_code, headers]
     end
 
+    # Delete an Export
+    # @param export_id [String] A string that uniquely identifies this export resource.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_an_export(export_id, opts = {})
+      delete_an_export_with_http_info(export_id, opts)
+      nil
+    end
+
+    # Delete an Export
+    # @param export_id [String] A string that uniquely identifies this export resource.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_an_export_with_http_info(export_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DefaultApi.delete_an_export ..."
+      end
+
+      # verify the required parameter 'export_id' is set
+      if @api_client.config.client_side_validation && export_id.nil?
+        fail ArgumentError, "Missing the required parameter 'export_id' when calling DefaultApi.delete_an_export"
+      end
+      # resource path
+      local_var_path = "/Accounts/{accountId}/Exports/{exportId}".sub("{" + "accountId" + "}", CGI.escape(account_id.to_s)).sub("{" + "exportId" + "}", CGI.escape(export_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ["fc"]
+
+      new_options = opts.merge(
+        operation: :"DefaultApi.delete_an_export",
+        header_params: header_params,
+        query_params: query_params,
+        form_params: form_params,
+        body: post_body,
+        auth_names: auth_names,
+        return_type: return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#delete_an_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
     # Delete an Incoming Number
     # @param phone_number_id [String] String that uniquely identifies this phone number resource.
     # @param [Hash] opts the optional parameters
@@ -718,6 +840,68 @@ module Freeclimb
       [data, status_code, headers]
     end
 
+    # Download an Export
+    # @param export_id [String] A string that uniquely identifies this export resource.
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def download_an_export(export_id, opts = {})
+      data, _status_code, _headers = download_an_export_with_http_info(export_id, opts)
+      data
+    end
+
+    # Download an Export
+    # @param export_id [String] A string that uniquely identifies this export resource.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def download_an_export_with_http_info(export_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DefaultApi.download_an_export ..."
+      end
+
+      # verify the required parameter 'export_id' is set
+      if @api_client.config.client_side_validation && export_id.nil?
+        fail ArgumentError, "Missing the required parameter 'export_id' when calling DefaultApi.download_an_export"
+      end
+      # resource path
+      local_var_path = "/Accounts/{accountId}/Exports/{exportId}/Download".sub("{" + "accountId" + "}", CGI.escape(account_id.to_s)).sub("{" + "exportId" + "}", CGI.escape(export_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params["Accept"] = @api_client.select_header_accept(["text/csv"])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || "String"
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ["fc"]
+
+      new_options = opts.merge(
+        operation: :"DefaultApi.download_an_export",
+        header_params: header_params,
+        query_params: query_params,
+        form_params: form_params,
+        body: post_body,
+        auth_names: auth_names,
+        return_type: return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#download_an_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
     # Filter Logs
     # @param filter_logs_request [FilterLogsRequest] Filter logs request paramters
     # @param [Hash] opts the optional parameters
@@ -1288,6 +1472,68 @@ module Freeclimb
       [data, status_code, headers]
     end
 
+    # Get an Export
+    # @param export_id [String] A string that uniquely identifies this export resource.
+    # @param [Hash] opts the optional parameters
+    # @return [ExportResult]
+    def get_an_export(export_id, opts = {})
+      data, _status_code, _headers = get_an_export_with_http_info(export_id, opts)
+      data
+    end
+
+    # Get an Export
+    # @param export_id [String] A string that uniquely identifies this export resource.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ExportResult, Integer, Hash)>] ExportResult data, response status code and response headers
+    def get_an_export_with_http_info(export_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DefaultApi.get_an_export ..."
+      end
+
+      # verify the required parameter 'export_id' is set
+      if @api_client.config.client_side_validation && export_id.nil?
+        fail ArgumentError, "Missing the required parameter 'export_id' when calling DefaultApi.get_an_export"
+      end
+      # resource path
+      local_var_path = "/Accounts/{accountId}/Exports/{exportId}".sub("{" + "accountId" + "}", CGI.escape(account_id.to_s)).sub("{" + "exportId" + "}", CGI.escape(export_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params["Accept"] = @api_client.select_header_accept(["application/json"])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || "ExportResult"
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ["fc"]
+
+      new_options = opts.merge(
+        operation: :"DefaultApi.get_an_export",
+        header_params: header_params,
+        query_params: query_params,
+        form_params: form_params,
+        body: post_body,
+        auth_names: auth_names,
+        return_type: return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#get_an_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
     # Get an Incoming Number
     # @param phone_number_id [String] String that uniquely identifies this phone number resource.
     # @param [Hash] opts the optional parameters
@@ -2341,6 +2587,8 @@ module Freeclimb
     # @option opts [String] :end_time Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss.
     # @option opts [String] :parent_call_id Only show Calls spawned by the call with this ID.
     # @option opts [Array<String>] :application_id Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications.
+    # @option opts [Integer] :risk_score_min The minimum riskScore that should be included in the list.
+    # @option opts [Integer] :risk_score_max The maximum riskScore that should be included in the list.
     # @return [CallList]
     def list_calls(opts = {})
       data, _status_code, _headers = list_calls_with_http_info(opts)
@@ -2357,6 +2605,8 @@ module Freeclimb
     # @option opts [String] :end_time Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss.
     # @option opts [String] :parent_call_id Only show Calls spawned by the call with this ID.
     # @option opts [Array<String>] :application_id Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications.
+    # @option opts [Integer] :risk_score_min The minimum riskScore that should be included in the list.
+    # @option opts [Integer] :risk_score_max The maximum riskScore that should be included in the list.
     # @return [Array<(CallList, Integer, Hash)>] CallList data, response status code and response headers
     def list_calls_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -2379,6 +2629,8 @@ module Freeclimb
       query_params[:endTime] = opts[:end_time] if !opts[:end_time].nil?
       query_params[:parentCallId] = opts[:parent_call_id] if !opts[:parent_call_id].nil?
       query_params[:applicationId] = @api_client.build_collection_param(opts[:application_id], :multi) if !opts[:application_id].nil?
+      query_params[:riskScoreMin] = opts[:risk_score_min] if !opts[:risk_score_min].nil?
+      query_params[:riskScoreMax] = opts[:risk_score_max] if !opts[:risk_score_max].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -2549,6 +2801,67 @@ module Freeclimb
       [data, status_code, headers]
     end
 
+    # List Exports
+    # @param [Hash] opts the optional parameters
+    # @option opts [ExportStatus] :status Status of export
+    # @option opts [String] :cursor Used to reference pages of a list of exports
+    # @return [ExportList]
+    def list_exports(opts = {})
+      data, _status_code, _headers = list_exports_with_http_info(opts)
+      data
+    end
+
+    # List Exports
+    # @param [Hash] opts the optional parameters
+    # @option opts [ExportStatus] :status Status of export
+    # @option opts [String] :cursor Used to reference pages of a list of exports
+    # @return [Array<(ExportList, Integer, Hash)>] ExportList data, response status code and response headers
+    def list_exports_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DefaultApi.list_exports ..."
+      end
+      # resource path
+      local_var_path = "/Accounts/{accountId}/Exports".sub("{" + "accountId" + "}", CGI.escape(account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:status] = opts[:status] if !opts[:status].nil?
+      query_params[:cursor] = opts[:cursor] if !opts[:cursor].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params["Accept"] = @api_client.select_header_accept(["application/json"])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || "ExportList"
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ["fc"]
+
+      new_options = opts.merge(
+        operation: :"DefaultApi.list_exports",
+        header_params: header_params,
+        query_params: query_params,
+        form_params: form_params,
+        body: post_body,
+        auth_names: auth_names,
+        return_type: return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#list_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
     # List Incoming Numbers
     # @param [Hash] opts the optional parameters
     # @option opts [String] :phone_number Only show incoming phone number resources that match this PCRE-compatible regular expression.

data/lib/freeclimb/models/call_result.rb

@@ -43,7 +43,7 @@ module Freeclimb
     # 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).
     attr_accessor :phone_number_id
 
-    attr_accessor :call_status
+    attr_accessor :status
 
     # 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.
     attr_accessor :start_time
@@ -105,7 +105,7 @@ module Freeclimb
         from: :from,
         to: :to,
         phone_number_id: :phoneNumberId,
-        call_status: :callStatus,
+        status: :status,
         start_time: :startTime,
         connect_time: :connectTime,
         end_time: :endTime,
@@ -136,7 +136,7 @@ module Freeclimb
         from: :String,
         to: :String,
         phone_number_id: :String,
-        call_status: :CallStatus,
+        status: :CallStatus,
         start_time: :String,
         connect_time: :String,
         end_time: :String,
@@ -158,7 +158,7 @@ module Freeclimb
         :from,
         :to,
         :phone_number_id,
-        :call_status,
+        :status,
         :start_time,
         :connect_time,
         :end_time,
@@ -233,8 +233,8 @@ module Freeclimb
         self.phone_number_id = attributes[:phone_number_id]
       end
 
-      if attributes.key?(:call_status)
-        self.call_status = attributes[:call_status]
+      if attributes.key?(:status)
+        self.status = attributes[:status]
       end
 
       if attributes.key?(:start_time)
@@ -305,7 +305,7 @@ module Freeclimb
         from == other.from &&
         to == other.to &&
         phone_number_id == other.phone_number_id &&
-        call_status == other.call_status &&
+        status == other.status &&
         start_time == other.start_time &&
         connect_time == other.connect_time &&
         end_time == other.end_time &&
@@ -326,7 +326,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [uri, date_created, date_updated, revision, call_id, parent_call_id, account_id, from, to, phone_number_id, call_status, start_time, connect_time, end_time, duration, connect_duration, direction, answered_by, subresource_uris, application_id].hash
+      [uri, date_created, date_updated, revision, call_id, parent_call_id, account_id, from, to, phone_number_id, status, start_time, connect_time, end_time, duration, connect_duration, direction, answered_by, subresource_uris, application_id].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/create_conference.rb

@@ -31,6 +31,9 @@ module Freeclimb
     # 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.
     attr_accessor :wait_url
 
+    # ID of the Call that created this leg (child call).
+    attr_accessor :parent_call_id
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -61,7 +64,8 @@ module Freeclimb
         play_beep: :playBeep,
         record: :record,
         status_callback_url: :statusCallbackUrl,
-        wait_url: :waitUrl
+        wait_url: :waitUrl,
+        parent_call_id: :parentCallId
       }
     end
 
@@ -74,11 +78,12 @@ module Freeclimb
     def self.openapi_types
       {
         action_url: :String,
-        _alias: :Boolean,
+        _alias: :String,
         play_beep: :PlayBeep,
         record: :Boolean,
         status_callback_url: :String,
-        wait_url: :String
+        wait_url: :String,
+        parent_call_id: :String
       }
     end
 
@@ -137,6 +142,10 @@ module Freeclimb
       if attributes.key?(:wait_url)
         self.wait_url = attributes[:wait_url]
       end
+
+      if attributes.key?(:parent_call_id)
+        self.parent_call_id = attributes[:parent_call_id]
+      end
       self.command = "CreateConference"
     end
 
@@ -171,7 +180,8 @@ module Freeclimb
         play_beep == other.play_beep &&
         record == other.record &&
         status_callback_url == other.status_callback_url &&
-        wait_url == other.wait_url && super
+        wait_url == other.wait_url &&
+        parent_call_id == other.parent_call_id && super
     end
 
     # @see the `==` method
@@ -183,7 +193,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action_url, _alias, play_beep, record, status_callback_url, wait_url].hash
+      [action_url, _alias, play_beep, record, status_callback_url, wait_url, parent_call_id].hash
     end
 
     # Builds the object from hash