freeclimb 5.2.0 → 5.3.0

data/openapi.json

@@ -1968,7 +1968,7 @@
               },
               "alias": {
                 "description": "Descriptive name for the Conference. ",
-                "type": "boolean"
+                "type": "string"
               },
               "playBeep": {
                 "$ref": "#/components/schemas/PlayBeep"
@@ -1986,6 +1986,10 @@
                 "description": "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.",
                 "format": "uri",
                 "type": "string"
+              },
+              "parentCallId": {
+                "description": "ID of the Call that created this leg (child call).",
+                "type": "string"
               }
             }
           }
@@ -3113,7 +3117,7 @@
                 "description": "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).",
                 "nullable": true
               },
-              "callStatus": {
+              "status": {
                 "$ref": "#/components/schemas/CallStatus"
               },
               "startTime": {
@@ -4830,6 +4834,187 @@
             "minimum": 1
           }
         }
+      },
+      "ExportStatus": {
+        "type": "string",
+        "description": "platform export status",
+        "enum": [
+          "intaking",
+          "queued",
+          "inProgress",
+          "completed",
+          "failed",
+          "deleted"
+        ]
+      },
+      "ExportResourceType": {
+        "type": "string",
+        "description": "platform resource type",
+        "enum": [
+          "Messages",
+          "Calls"
+        ]
+      },
+      "ExportOutputType": {
+        "type": "string",
+        "description": "output type of the export",
+        "enum": [
+          "csv"
+        ]
+      },
+      "ExportRequestOutput": {
+        "type": "object",
+        "required": [
+          "type"
+        ],
+        "properties": {
+          "type": {
+            "$ref": "#/components/schemas/ExportOutputType"
+          }
+        }
+      },
+      "ExportResultOutput": {
+        "type": "object",
+        "required": [
+          "type"
+        ],
+        "properties": {
+          "type": {
+            "$ref": "#/components/schemas/ExportOutputType"
+          }
+        }
+      },
+      "ExportResult": {
+        "type": "object",
+        "required": [
+          "accountId",
+          "uri",
+          "dateCreated",
+          "dateUpdated",
+          "revision",
+          "exportId",
+          "status",
+          "size",
+          "resourceType",
+          "query",
+          "format",
+          "output"
+        ],
+        "properties": {
+          "accountId": {
+            "type": "string",
+            "description": "String that uniquely identifies this account resource.",
+            "nullable": true
+          },
+          "uri": {
+            "type": "string",
+            "format": "uri-reference"
+          },
+          "dateCreated": {
+            "type": "string"
+          },
+          "dateUpdated": {
+            "type": "string"
+          },
+          "revision": {
+            "type": "integer",
+            "minimum": 0
+          },
+          "exportId": {
+            "type": "string",
+            "description": "String that uniquely identifies this export resource",
+            "nullable": true
+          },
+          "status": {
+            "$ref": "#/components/schemas/ExportStatus"
+          },
+          "size": {
+            "type": "integer"
+          },
+          "resourceType": {
+            "$ref": "#/components/schemas/ExportResourceType"
+          },
+          "query": {
+            "description": "Query params used to filter exported documents",
+            "type": "object"
+          },
+          "format": {
+            "description": "Desired fields of exported documents",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "output": {
+            "$ref": "#/components/schemas/ExportResultOutput"
+          }
+        },
+        "example": {
+          "accountId": "AC3ff5d5aed7fde9e6659673d850cbd18ea8bfca78",
+          "uri": "/Accounts/AC3ff5d5aed7fde9e6659673d850cbd18ea8bfca78/Exports/EX4d7500862e3abf4b9f4da24d54f559d3024252f8",
+          "dateCreated": "Wed, 26 Jun 2024 15:45:06 UTC",
+          "dateUpdated": "Wed, 26 Jun 2024 15:45:06 UTC",
+          "revision": 1,
+          "exportId": "EX4d7500862e3abf4b9f4da24d54f559d3024252f8",
+          "status": "completed",
+          "size": 12893786,
+          "resourceType": "Messages",
+          "query": {
+            "direction": "inbound"
+          },
+          "format": [
+            "messageId",
+            "dateUpdated",
+            "segmentCount",
+            "status"
+          ],
+          "output": {
+            "type": "csv"
+          }
+        }
+      },
+      "ExportList": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/PaginationModel"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "exports": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/ExportResult"
+                },
+                "nullable": true
+              }
+            }
+          }
+        ]
+      },
+      "ExportRequest": {
+        "type": "object",
+        "required": [
+          "resourceType",
+          "output"
+        ],
+        "properties": {
+          "resourceType": {
+            "$ref": "#/components/schemas/ExportResourceType"
+          },
+          "format": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "output": {
+            "$ref": "#/components/schemas/ExportRequestOutput"
+          },
+          "query": {
+            "type": "object"
+          }
+        }
       }
     }
   },
@@ -5654,6 +5839,24 @@
           },
           {
             "$ref": "#/components/parameters/AccountId"
+          },
+          {
+            "name": "riskScoreMin",
+            "in": "query",
+            "description": "The minimum riskScore that should be included in the list.",
+            "required": false,
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "name": "riskScoreMax",
+            "in": "query",
+            "description": "The maximum riskScore that should be included in the list.",
+            "required": false,
+            "schema": {
+              "type": "integer"
+            }
           }
         ],
         "deprecated": false,
@@ -7331,6 +7534,171 @@
         },
         "deprecated": false
       }
+    },
+    "/Accounts/{accountId}/Exports": {
+      "get": {
+        "tags": [],
+        "summary": "List Exports",
+        "operationId": "list-exports",
+        "responses": {
+          "200": {
+            "description": "Successful retrieved export list",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ExportList"
+                }
+              }
+            }
+          }
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountId"
+          },
+          {
+            "schema": {
+              "$ref": "#/components/schemas/ExportStatus"
+            },
+            "in": "query",
+            "name": "status",
+            "description": "Status of export"
+          },
+          {
+            "schema": {
+              "type": "string"
+            },
+            "in": "query",
+            "name": "cursor",
+            "description": "Used to reference pages of a list of exports"
+          }
+        ]
+      },
+      "post": {
+        "summary": "Create an Export",
+        "operationId": "create-export",
+        "tags": [],
+        "requestBody": {
+          "description": "A JSON object containing export creation parameters",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ExportRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Export successfully created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ExportResult"
+                }
+              }
+            }
+          }
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountId"
+          }
+        ]
+      }
+    },
+    "/Accounts/{accountId}/Exports/{exportId}": {
+      "get": {
+        "tags": [],
+        "summary": "Get an Export",
+        "operationId": "get-an-export",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountId"
+          },
+          {
+            "name": "exportId",
+            "in": "path",
+            "description": "A string that uniquely identifies this export resource.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "deprecated": false,
+        "responses": {
+          "200": {
+            "description": "Export Details",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ExportResult"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "tags": [],
+        "summary": "Delete an Export",
+        "operationId": "delete-an-export",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountId"
+          },
+          {
+            "name": "exportId",
+            "in": "path",
+            "description": "A string that uniquely identifies this export resource.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "deprecated": false,
+        "responses": {
+          "204": {
+            "description": "Successful Export deletion"
+          }
+        }
+      }
+    },
+    "/Accounts/{accountId}/Exports/{exportId}/Download": {
+      "get": {
+        "tags": [],
+        "summary": "Download an Export",
+        "operationId": "download-an-export",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountId"
+          },
+          {
+            "name": "exportId",
+            "in": "path",
+            "description": "A string that uniquely identifies this export resource.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "deprecated": false,
+        "responses": {
+          "200": {
+            "description": "Export Details",
+            "content": {
+              "text/csv": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "x-headers": [],

data/spec/api/default_api_spec.rb

@@ -252,6 +252,12 @@ describe "DefaultApi" do
     @knowledge_base_id_create_knowledge_base_completion_test_value = "knowledgeBaseId_example"
 
     @completion_request_create_knowledge_base_completion_test_value = Freeclimb::CompletionRequest.new({query: "query_example"})
+
+    @export_id_download_an_export_test_value = "download_exportId_example"
+
+    @export_id_delete_an_export_test_value = "delete_exportId_example"
+
+    @export_id_get_an_export_test_value = "get_exportId_example"
   end
 
   after do
@@ -348,6 +354,27 @@ describe "DefaultApi" do
     end
   end
 
+  # unit tests for create_export
+  # Create an Export
+  # @param [Hash] opts the optional parameters
+  # @option opts [ExportRequest] :export_request A JSON object containing export creation parameters
+  # @return [ExportResult]
+  describe "create_export test" do
+    it "should work" do
+      export_request = @export_request_create_export_test_value
+
+      result = @api_instance.create_export(
+        {
+          export_request: export_request
+        }
+      )
+
+      expect(result).to be_a Freeclimb::ExportResult
+
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for create_knowledge_base_completion
   # Query the knowledge base
   # @param knowledge_base_id A string that uniquely identifies the KnowledgeBase resource.
@@ -410,6 +437,25 @@ describe "DefaultApi" do
     end
   end
 
+  # unit tests for delete_an_export
+  # Delete an Export
+  # @param export_id A string that uniquely identifies this export resource.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe "delete_an_export test" do
+    it "should work" do
+      export_id = @export_id_delete_an_export_test_value
+
+      result = @api_instance.delete_an_export(
+        export_id,
+        {}
+      )
+
+      expect(result).to be_nil
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for delete_an_incoming_number
   # Delete an Incoming Number
   # @param phone_number_id String that uniquely identifies this phone number resource.
@@ -491,6 +537,25 @@ describe "DefaultApi" do
     end
   end
 
+  # unit tests for download_an_export
+  # Download an Export
+  # @param export_id A string that uniquely identifies this export resource.
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe "download_an_export test" do
+    it "should work" do
+      export_id = @export_id_download_an_export_test_value
+
+      result = @api_instance.download_an_export(
+        export_id,
+        {}
+      )
+      expect(result).to be_a String
+
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for filter_logs
   # Filter Logs
   # @param filter_logs_request Filter logs request paramters
@@ -671,6 +736,26 @@ describe "DefaultApi" do
     end
   end
 
+  # unit tests for get_an_export
+  # Get an Export
+  # @param export_id A string that uniquely identifies this export resource.
+  # @param [Hash] opts the optional parameters
+  # @return [ExportResult]
+  describe "get_an_export test" do
+    it "should work" do
+      export_id = @export_id_get_an_export_test_value
+
+      result = @api_instance.get_an_export(
+        export_id,
+        {}
+      )
+
+      expect(result).to be_a Freeclimb::ExportResult
+
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_an_incoming_number
   # Get an Incoming Number
   # @param phone_number_id String that uniquely identifies this phone number resource.
@@ -1037,6 +1122,8 @@ describe "DefaultApi" do
   # @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]
   describe "list_calls test" do
     it "should work" do
@@ -1048,10 +1135,12 @@ describe "DefaultApi" do
       end_time = @end_time_list_calls_test_value
       parent_call_id = @parent_call_id_list_calls_test_value
       application_id = @application_id_list_calls_test_value
+      risk_score_min = @risk_score_min_list_calls_test_value
+      risk_score_max = @risk_score_max_list_calls_test_value
 
       result = @api_instance.list_calls(
         {
-          active: active, to: to, from: from, status: status, start_time: start_time, end_time: end_time, parent_call_id: parent_call_id, application_id: application_id
+          active: active, to: to, from: from, status: status, start_time: start_time, end_time: end_time, parent_call_id: parent_call_id, application_id: application_id, risk_score_min: risk_score_min, risk_score_max: risk_score_max
         }
       )
 
@@ -1114,6 +1203,29 @@ describe "DefaultApi" do
     end
   end
 
+  # unit tests for list_exports
+  # 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]
+  describe "list_exports test" do
+    it "should work" do
+      status = @status_list_exports_test_value
+      cursor = @cursor_list_exports_test_value
+
+      result = @api_instance.list_exports(
+        {
+          status: status, cursor: cursor
+        }
+      )
+
+      expect(result).to be_a Freeclimb::ExportList
+
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for list_incoming_numbers
   # List Incoming Numbers
   # @param [Hash] opts the optional parameters
@@ -1782,6 +1894,8 @@ describe "DefaultApi" do
   # @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]
   describe "list_calls_get_next_page test" do
     it "should work" do
@@ -1793,10 +1907,12 @@ describe "DefaultApi" do
       end_time = @end_time_list_calls_test_value
       parent_call_id = @parent_call_id_list_calls_test_value
       application_id = @application_id_list_calls_test_value
+      risk_score_min = @risk_score_min_list_calls_test_value
+      risk_score_max = @risk_score_max_list_calls_test_value
 
       result = @api_instance.list_calls(
         {
-          active: active, to: to, from: from, status: status, start_time: start_time, end_time: end_time, parent_call_id: parent_call_id, application_id: application_id
+          active: active, to: to, from: from, status: status, start_time: start_time, end_time: end_time, parent_call_id: parent_call_id, application_id: application_id, risk_score_min: risk_score_min, risk_score_max: risk_score_max
         }
       )
       result.next_page_uri = "/Accounts/{accountId}/Calls?cursor=1"
@@ -1859,6 +1975,29 @@ describe "DefaultApi" do
     end
   end
 
+  # unit tests for get_next_page list_exports
+  # 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]
+  describe "list_exports_get_next_page test" do
+    it "should work" do
+      status = @status_list_exports_test_value
+      cursor = @cursor_list_exports_test_value
+
+      result = @api_instance.list_exports(
+        {
+          status: status, cursor: cursor
+        }
+      )
+      result.next_page_uri = "/Accounts/{accountId}/Exports?cursor=1"
+      next_page_result = @api_instance.get_next_page(result)
+      expect(next_page_result).to be_a Freeclimb::ExportList
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_next_page list_incoming_numbers
   # List Incoming Numbers
   # @param [Hash] opts the optional parameters