freeclimb 1.0.1 → 2.0.3

data/docs/SetTalkAllOf.md

@@ -0,0 +1,19 @@
+# Freeclimb::SetTalkAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**call_id** | **String** | ID of the call leg that is to be muted or unmuted. The Call must be in a Conference or an error will be triggered. | 
+**talk** | **Boolean** | Specifying `false` mutes the Participant. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SetTalkAllOf.new(call_id: nil,
+                                 talk: nil)
+```
+
+

data/docs/Sms.md

@@ -0,0 +1,23 @@
+# Freeclimb::Sms
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**to** | **String** | E.164 representation of the phone number to which the message will be sent. Must be within FreeClimb's service area and E.164 formatting (e.g., +18003608245). | 
+**from** | **String** | E.164 representation of the phone number to use as the sender. This must be an incoming phone number you have purchased from FreeClimb. | 
+**text** | **String** | Text contained in the message (maximum 160 characters). | 
+**notification_url** | **String** | When the message changes status, this URL will be invoked using HTTP POST with the messageStatus parameters. This is a notification only; any PerCL returned will be ignored. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::Sms.new(to: nil,
+                                 from: nil,
+                                 text: nil,
+                                 notification_url: nil)
+```
+
+

data/docs/SmsAllOf.md

@@ -0,0 +1,23 @@
+# Freeclimb::SmsAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**to** | **String** | E.164 representation of the phone number to which the message will be sent. Must be within FreeClimb's service area and E.164 formatting (e.g., +18003608245). | 
+**from** | **String** | E.164 representation of the phone number to use as the sender. This must be an incoming phone number you have purchased from FreeClimb. | 
+**text** | **String** | Text contained in the message (maximum 160 characters). | 
+**notification_url** | **String** | When the message changes status, this URL will be invoked using HTTP POST with the messageStatus parameters. This is a notification only; any PerCL returned will be ignored. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SmsAllOf.new(to: nil,
+                                 from: nil,
+                                 text: nil,
+                                 notification_url: nil)
+```
+
+

data/docs/StartRecordCall.md

@@ -0,0 +1,16 @@
+# Freeclimb::StartRecordCall
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::StartRecordCall.new()
+```
+
+

data/docs/TerminateConference.md

@@ -0,0 +1,17 @@
+# Freeclimb::TerminateConference
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conference_id** | **String** | ID of the conference to terminate. | 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::TerminateConference.new(conference_id: nil)
+```
+
+

data/docs/TerminateConferenceAllOf.md

@@ -0,0 +1,17 @@
+# Freeclimb::TerminateConferenceAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conference_id** | **String** | ID of the conference to terminate. | 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::TerminateConferenceAllOf.new(conference_id: nil)
+```
+
+

data/docs/UpdateCallRequest.md

@@ -5,15 +5,13 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **status** | **String** | Either `canceled` or `completed`.  Specifying `canceled` attempts to hang up calls that are queued without affecting calls already in progress. Specifying `completed` attempts to hang up a call already in progress. | 
-**request_id** | **String** | RequestId for this request starting with prefix `RQ` followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request will include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response (e.g. `X-Pulse-Request-Id: <requestId>`). | [optional] 
 
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::UpdateCallRequest.new(status: null,
-                                 request_id: null)
+instance = Freeclimb::UpdateCallRequest.new(status: nil)
 ```
 
 

data/docs/UpdateConferenceParticipantRequest.md

@@ -6,16 +6,14 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **talk** | **Boolean** | (Optional) Default is `true`. Setting to `false` mutes the Participant. FreeClimb returns an error and ignores any other value. | [optional] 
 **listen** | **Boolean** | (Optional) Default is `true`. Setting to `false` silences the Conference for this Participant. FreeClimb returns an error and ignores any other value. | [optional] 
-**request_id** | **String** | ID of this request starting with prefix *RQ* followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request include this requestId. If this value is not provided, FreeClimb generates a requestId and returns it as a header in the response (e.g., X-Pulse-Request-Id: <requestId>). | [optional] 
 
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::UpdateConferenceParticipantRequest.new(talk: null,
-                                 listen: null,
-                                 request_id: null)
+instance = Freeclimb::UpdateConferenceParticipantRequest.new(talk: nil,
+                                 listen: nil)
 ```
 
 

data/docs/UpdateConferenceRequest.md

@@ -7,17 +7,15 @@ Name | Type | Description | Notes
 **_alias** | **String** | Description for this conference. Maximum 64 characters. | [optional] 
 **play_beep** | **String** | Controls when a beep is played. Valid values: `always`, `never`, `entryOnly`, `exitOnly`. | [optional] [default to 'always']
 **status** | **String** | New status of the conference. Valid values: `empty` or `terminated`. For more information, see **Status Parameter** below.** | [optional] 
-**request_id** | **String** | ID for this request starting with prefix *RQ* followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request will include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response (e.g. X-Pulse-Request-Id: <requestId>). | [optional] 
 
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::UpdateConferenceRequest.new(_alias: null,
-                                 play_beep: null,
-                                 status: null,
-                                 request_id: null)
+instance = Freeclimb::UpdateConferenceRequest.new(_alias: nil,
+                                 play_beep: nil,
+                                 status: nil)
 ```
 
 

data/lib/freeclimb.rb

@@ -15,11 +15,14 @@ require 'freeclimb/api_client'
 require 'freeclimb/api_error'
 require 'freeclimb/version'
 require 'freeclimb/configuration'
-require 'percl/percl'
+require 'freeclimb/models/percl_command'
+
 # Models
 require 'freeclimb/models/account_request'
 require 'freeclimb/models/account_result'
 require 'freeclimb/models/account_result_all_of'
+require 'freeclimb/models/add_to_conference'
+require 'freeclimb/models/add_to_conference_all_of'
 require 'freeclimb/models/application_list'
 require 'freeclimb/models/application_list_all_of'
 require 'freeclimb/models/application_request'
@@ -41,9 +44,17 @@ require 'freeclimb/models/conference_participant_result'
 require 'freeclimb/models/conference_participant_result_all_of'
 require 'freeclimb/models/conference_result'
 require 'freeclimb/models/conference_result_all_of'
+require 'freeclimb/models/create_conference'
+require 'freeclimb/models/create_conference_all_of'
 require 'freeclimb/models/create_conference_request'
-require 'freeclimb/models/dequeue_member_request'
+require 'freeclimb/models/dequeue'
+require 'freeclimb/models/enqueue'
+require 'freeclimb/models/enqueue_all_of'
 require 'freeclimb/models/filter_logs_request'
+require 'freeclimb/models/get_digits'
+require 'freeclimb/models/get_digits_all_of'
+require 'freeclimb/models/get_speech'
+require 'freeclimb/models/get_speech_all_of'
 require 'freeclimb/models/incoming_number_list'
 require 'freeclimb/models/incoming_number_list_all_of'
 require 'freeclimb/models/incoming_number_request'
@@ -60,7 +71,17 @@ require 'freeclimb/models/message_result_all_of'
 require 'freeclimb/models/messages_list'
 require 'freeclimb/models/messages_list_all_of'
 require 'freeclimb/models/mutable_resource_model'
+require 'freeclimb/models/out_dial'
+require 'freeclimb/models/out_dial_all_of'
 require 'freeclimb/models/pagination_model'
+require 'freeclimb/models/pause'
+require 'freeclimb/models/pause_all_of'
+require 'freeclimb/models/percl_command'
+require 'freeclimb/models/percl_script'
+require 'freeclimb/models/play'
+require 'freeclimb/models/play_all_of'
+require 'freeclimb/models/play_early_media'
+require 'freeclimb/models/play_early_media_all_of'
 require 'freeclimb/models/queue_list'
 require 'freeclimb/models/queue_list_all_of'
 require 'freeclimb/models/queue_member'
@@ -69,10 +90,29 @@ require 'freeclimb/models/queue_member_list_all_of'
 require 'freeclimb/models/queue_request'
 require 'freeclimb/models/queue_result'
 require 'freeclimb/models/queue_result_all_of'
+require 'freeclimb/models/record_utterance'
+require 'freeclimb/models/record_utterance_all_of'
 require 'freeclimb/models/recording_list'
 require 'freeclimb/models/recording_list_all_of'
 require 'freeclimb/models/recording_result'
 require 'freeclimb/models/recording_result_all_of'
+require 'freeclimb/models/redirect'
+require 'freeclimb/models/redirect_all_of'
+require 'freeclimb/models/remove_from_conference'
+require 'freeclimb/models/remove_from_conference_all_of'
+require 'freeclimb/models/say'
+require 'freeclimb/models/say_all_of'
+require 'freeclimb/models/send_digits'
+require 'freeclimb/models/send_digits_all_of'
+require 'freeclimb/models/set_listen'
+require 'freeclimb/models/set_listen_all_of'
+require 'freeclimb/models/set_talk'
+require 'freeclimb/models/set_talk_all_of'
+require 'freeclimb/models/sms'
+require 'freeclimb/models/sms_all_of'
+require 'freeclimb/models/start_record_call'
+require 'freeclimb/models/terminate_conference'
+require 'freeclimb/models/terminate_conference_all_of'
 require 'freeclimb/models/update_call_request'
 require 'freeclimb/models/update_conference_participant_request'
 require 'freeclimb/models/update_conference_request'
@@ -96,4 +136,31 @@ module Freeclimb
       end
     end
   end
+
+  def self.percl_list_to_hash(percl_list)
+    percl_list_hash = []
+    percl_list.each_with_index do | command, index |
+      class_name = command.class.name.split('::').last
+      percl_hash = Hash.new
+      if command.respond_to?(:prompts) && command.prompts != nil && command.prompts.any?
+        percl_hash[class_name] = to_hash_with_prompts(command)
+      else
+        percl_hash[class_name] = command.to_hash
+      end
+      percl_list_hash.push(percl_hash)
+    end
+    percl_list_hash
+  end
+
+  def self.to_hash_with_prompts(command)
+    prompts_hash = percl_list_to_hash(command.prompts)
+    command.prompts = nil
+    hash = command.to_hash
+    hash[:prompts] = prompts_hash
+    hash
+  end
+
+  def self.percl_to_json(percl_script)
+    percl_list_to_hash(percl_script.commands).to_json
+  end
 end

data/lib/freeclimb/api/default_api.rb

@@ -79,22 +79,26 @@ module Freeclimb
     end
 
     # Buy a Phone Number
+    # @param buy_incoming_number_request [BuyIncomingNumberRequest] Incoming Number transaction details
     # @param [Hash] opts the optional parameters
-    # @option opts [BuyIncomingNumberRequest] :buy_incoming_number_request Incoming Number transaction details
     # @return [IncomingNumberResult]
-    def buy_a_phone_number(opts = {})
-      data, _status_code, _headers = buy_a_phone_number_with_http_info(opts)
+    def buy_a_phone_number(buy_incoming_number_request, opts = {})
+      data, _status_code, _headers = buy_a_phone_number_with_http_info(buy_incoming_number_request, opts)
       data
     end
 
     # Buy a Phone Number
+    # @param buy_incoming_number_request [BuyIncomingNumberRequest] Incoming Number transaction details
     # @param [Hash] opts the optional parameters
-    # @option opts [BuyIncomingNumberRequest] :buy_incoming_number_request Incoming Number transaction details
     # @return [Array<(IncomingNumberResult, Integer, Hash)>] IncomingNumberResult data, response status code and response headers
-    def buy_a_phone_number_with_http_info(opts = {})
+    def buy_a_phone_number_with_http_info(buy_incoming_number_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DefaultApi.buy_a_phone_number ...'
       end
+      # verify the required parameter 'buy_incoming_number_request' is set
+      if @api_client.config.client_side_validation && buy_incoming_number_request.nil?
+        fail ArgumentError, "Missing the required parameter 'buy_incoming_number_request' when calling DefaultApi.buy_a_phone_number"
+      end
       # resource path
       local_var_path = '/Accounts/{accountId}/IncomingPhoneNumbers'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s))
 
@@ -112,7 +116,7 @@ module Freeclimb
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'buy_incoming_number_request']) 
+      post_body = opts[:body] || @api_client.object_to_http_body(buy_incoming_number_request) 
 
       # return_type
       return_type = opts[:return_type] || 'IncomingNumberResult' 
@@ -488,7 +492,6 @@ module Freeclimb
     # @param queue_id [String] String that uniquely identifies the Queue that the Member belongs to.
     # @param call_id [String] ID if the Call that the Member belongs to
     # @param [Hash] opts the optional parameters
-    # @option opts [DequeueMemberRequest] :dequeue_member_request Dequeue member request details
     # @return [QueueMember]
     def dequeue_a_member(queue_id, call_id, opts = {})
       data, _status_code, _headers = dequeue_a_member_with_http_info(queue_id, call_id, opts)
@@ -499,7 +502,6 @@ module Freeclimb
     # @param queue_id [String] String that uniquely identifies the Queue that the Member belongs to.
     # @param call_id [String] ID if the Call that the Member belongs to
     # @param [Hash] opts the optional parameters
-    # @option opts [DequeueMemberRequest] :dequeue_member_request Dequeue member request details
     # @return [Array<(QueueMember, Integer, Hash)>] QueueMember data, response status code and response headers
     def dequeue_a_member_with_http_info(queue_id, call_id, opts = {})
       if @api_client.config.debugging
@@ -523,14 +525,12 @@ module Freeclimb
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'dequeue_member_request']) 
+      post_body = opts[:body] 
 
       # return_type
       return_type = opts[:return_type] || 'QueueMember' 
@@ -557,7 +557,6 @@ module Freeclimb
     # Dequeue Head Member
     # @param queue_id [String] String that uniquely identifies this queue resource.
     # @param [Hash] opts the optional parameters
-    # @option opts [DequeueMemberRequest] :dequeue_member_request Dequeue head member request details
     # @return [QueueMember]
     def dequeue_head_member(queue_id, opts = {})
       data, _status_code, _headers = dequeue_head_member_with_http_info(queue_id, opts)
@@ -567,7 +566,6 @@ module Freeclimb
     # Dequeue Head Member
     # @param queue_id [String] String that uniquely identifies this queue resource.
     # @param [Hash] opts the optional parameters
-    # @option opts [DequeueMemberRequest] :dequeue_member_request Dequeue head member request details
     # @return [Array<(QueueMember, Integer, Hash)>] QueueMember data, response status code and response headers
     def dequeue_head_member_with_http_info(queue_id, opts = {})
       if @api_client.config.debugging
@@ -587,14 +585,12 @@ module Freeclimb
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'dequeue_member_request']) 
+      post_body = opts[:body] 
 
       # return_type
       return_type = opts[:return_type] || 'QueueMember' 
@@ -679,22 +675,26 @@ module Freeclimb
     end
 
     # Filter Logs
+    # @param filter_logs_request [FilterLogsRequest] Filter logs request paramters
     # @param [Hash] opts the optional parameters
-    # @option opts [FilterLogsRequest] :filter_logs_request Filter logs request paramters
     # @return [LogList]
-    def filter_logs(opts = {})
-      data, _status_code, _headers = filter_logs_with_http_info(opts)
+    def filter_logs(filter_logs_request, opts = {})
+      data, _status_code, _headers = filter_logs_with_http_info(filter_logs_request, opts)
       data
     end
 
     # Filter Logs
+    # @param filter_logs_request [FilterLogsRequest] Filter logs request paramters
     # @param [Hash] opts the optional parameters
-    # @option opts [FilterLogsRequest] :filter_logs_request Filter logs request paramters
     # @return [Array<(LogList, Integer, Hash)>] LogList data, response status code and response headers
-    def filter_logs_with_http_info(opts = {})
+    def filter_logs_with_http_info(filter_logs_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DefaultApi.filter_logs ...'
       end
+      # verify the required parameter 'filter_logs_request' is set
+      if @api_client.config.client_side_validation && filter_logs_request.nil?
+        fail ArgumentError, "Missing the required parameter 'filter_logs_request' when calling DefaultApi.filter_logs"
+      end
       # resource path
       local_var_path = '/Accounts/{accountId}/Logs'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s))
 
@@ -712,7 +712,7 @@ module Freeclimb
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'filter_logs_request']) 
+      post_body = opts[:body] || @api_client.object_to_http_body(filter_logs_request) 
 
       # return_type
       return_type = opts[:return_type] || 'LogList' 
@@ -2281,22 +2281,26 @@ module Freeclimb
     end
 
     # Send an SMS Message
+    # @param message_request [MessageRequest] Details to create a message
     # @param [Hash] opts the optional parameters
-    # @option opts [MessageRequest] :message_request Details to create a message
     # @return [MessageResult]
-    def send_an_sms_message(opts = {})
-      data, _status_code, _headers = send_an_sms_message_with_http_info(opts)
+    def send_an_sms_message(message_request, opts = {})
+      data, _status_code, _headers = send_an_sms_message_with_http_info(message_request, opts)
       data
     end
 
     # Send an SMS Message
+    # @param message_request [MessageRequest] Details to create a message
     # @param [Hash] opts the optional parameters
-    # @option opts [MessageRequest] :message_request Details to create a message
     # @return [Array<(MessageResult, Integer, Hash)>] MessageResult data, response status code and response headers
-    def send_an_sms_message_with_http_info(opts = {})
+    def send_an_sms_message_with_http_info(message_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DefaultApi.send_an_sms_message ...'
       end
+      # verify the required parameter 'message_request' is set
+      if @api_client.config.client_side_validation && message_request.nil?
+        fail ArgumentError, "Missing the required parameter 'message_request' when calling DefaultApi.send_an_sms_message"
+      end
       # resource path
       local_var_path = '/Accounts/{accountId}/Messages'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s))
 
@@ -2314,7 +2318,7 @@ module Freeclimb
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'message_request']) 
+      post_body = opts[:body] || @api_client.object_to_http_body(message_request) 
 
       # return_type
       return_type = opts[:return_type] || 'MessageResult' 
@@ -2464,20 +2468,20 @@ module Freeclimb
 
     # Update a Live Call
     # @param call_id [String] String that uniquely identifies this call resource.
+    # @param update_call_request [UpdateCallRequest] Call details to update
     # @param [Hash] opts the optional parameters
-    # @option opts [UpdateCallRequest] :update_call_request Call details to update
     # @return [nil]
-    def update_a_live_call(call_id, opts = {})
-      update_a_live_call_with_http_info(call_id, opts)
+    def update_a_live_call(call_id, update_call_request, opts = {})
+      update_a_live_call_with_http_info(call_id, update_call_request, opts)
       nil
     end
 
     # Update a Live Call
     # @param call_id [String] String that uniquely identifies this call resource.
+    # @param update_call_request [UpdateCallRequest] Call details to update
     # @param [Hash] opts the optional parameters
-    # @option opts [UpdateCallRequest] :update_call_request Call details to update
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def update_a_live_call_with_http_info(call_id, opts = {})
+    def update_a_live_call_with_http_info(call_id, update_call_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DefaultApi.update_a_live_call ...'
       end
@@ -2485,6 +2489,10 @@ module Freeclimb
       if @api_client.config.client_side_validation && call_id.nil?
         fail ArgumentError, "Missing the required parameter 'call_id' when calling DefaultApi.update_a_live_call"
       end
+      # verify the required parameter 'update_call_request' is set
+      if @api_client.config.client_side_validation && update_call_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_call_request' when calling DefaultApi.update_a_live_call"
+      end
       # resource path
       local_var_path = '/Accounts/{accountId}/Calls/{callId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_id.to_s))
 
@@ -2500,7 +2508,7 @@ module Freeclimb
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'update_call_request']) 
+      post_body = opts[:body] || @api_client.object_to_http_body(update_call_request) 
 
       # return_type
       return_type = opts[:return_type]