freeclimb 2.0.2 → 2.2.0

data/docs/Hangup.md

@@ -0,0 +1,17 @@
+# Freeclimb::Hangup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reason** | **String** | The user defined reason for the hangup. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the Call flows for the given application. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::Hangup.new(reason: nil)
+```
+
+

data/docs/HangupAllOf.md

@@ -0,0 +1,17 @@
+# Freeclimb::HangupAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reason** | **String** | The user defined reason for the hangup. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the Call flows for the given application. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::HangupAllOf.new(reason: nil)
+```
+
+

data/docs/MakeCallRequest.md

@@ -6,13 +6,14 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **from** | **String** | Phone number to use as the caller ID. This can be: (a) The To or From number provided in FreeClimb's initial request to your app or (b) Any incoming phone number you have purchased from FreeClimb. | 
 **to** | **String** | Phone number to place the Call to. | 
-**application_id** | **String** | ID of the application FreeClimb should use to handle this phone call. FreeClimb will use the `callConnectUrl` and `statusCallbackUrl` set on the application. The application must have a `callConnectUrl` associated with it or an error will be returned. The application’s `voiceUrl` parameter is not used for outbound calls. | 
+**application_id** | **String** | Required if no `parentCallId` or `callConnectUrl` has been provided. ID of the application FreeClimb should use to handle this phone call. FreeClimb will use the `callConnectUrl` and `statusCallbackUrl` set on the application unless the `callConnectUrl` attribute is also provided with the request. In this case, the URL specified in that `callConnectUrl` attribute will be used as a replacement of the `callConnectUrl` originally assigned in the application. If the `callConnectUrl` is not set as either an attribute of the request or as part of the specified application, an error will be provided. The application’s voiceUrl parameter is not used for outbound calls. | [optional] 
 **send_digits** | **String** | String of digits to dial after connecting to the number. It can include digits `0-9`, `*`, and `#`, and allows embedding a pause between the output of individual digits. The default pause is 500 milliseconds. So, a string such as *1234#* will be played in 2 seconds because of the 4 standard pauses implied within the string. A custom pause is specified by including a positive integer wrapped in curly braces: {n}. For more information, see **sendDigits examples** below. | [optional] 
 **if_machine** | **String** | Specifies how FreeClimb should handle this Call if an answering machine answers it. | [optional] 
 **if_machine_url** | **String** | This attribute specifies a URL to which FreeClimb will make a POST request when an answering machine or a fax machine is detected. This URL is required if the ifMachine flag is set to redirect. When ifMachine is set to hangup, ifMachineUrl must not be included in the request. For more information, see **ifMachineUrl example** below. | [optional] 
 **timeout** | **Integer** | Number of seconds that FreeClimb should allow the phone to ring before assuming there is no answer. Default is 30 seconds. Maximum allowed ring-time is determined by the target phone's provider. Note that most providers limit ring-time to 120 seconds. | [optional] 
-**parent_call_id** | **String** | The ID of the parent Call in the case that this new Call is meant to be treated as a child of an existing Call. This attribute should be included when possible to reduce latency when adding child calls to Conferences containing the parent Call. A call can only be used as a parent once the call is in progress or as an inbound call that is still ringing.  An outbound call is considered to be in progress once the outdialConnect or outdialApiConnect webhook is invoked.  An inbound call is ringing when the inbound webhook is invoked. | [optional] 
+**parent_call_id** | **String** | Required if no `applicationId` or `callConnectUrl` has been provided. The ID of the parent Call in the case that this new Call is meant to be treated as a child of an existing Call. This attribute should be included when possible to reduce latency when adding child calls to Conferences containing the parent Call. A call can only be used as a parent once the call is in progress or as an inbound call that is still ringing. An outbound call is considered to be in progress once the `outdialConnect` or `outdialApiConnect` webhook is invoked. An inbound call is ringing when the inbound webhook is invoked. If a `callConnectUrl` attribute is also included with the `parentCallId` in the request, this URL will be used as a replacement of the `callConnectUrl` originally assigned in the parent call. | [optional] 
 **privacy_mode** | **Boolean** | Activate privacy mode in order to obscure log data that can potentially expose private information. | [optional] 
+**call_connect_url** | **String** | The URL that FreeClimb should use to handle this phone call. If an applicationId or parentCallId have already been provided, this callConnectUrl attribute will be used as a replacement of the callConnectUrl originally assigned in the application or parent call. | [optional] 
 
 ## Code Sample
 
@@ -27,7 +28,8 @@ instance = Freeclimb::MakeCallRequest.new(from: nil,
                                  if_machine_url: nil,
                                  timeout: nil,
                                  parent_call_id: nil,
-                                 privacy_mode: nil)
+                                 privacy_mode: nil,
+                                 call_connect_url: nil)
 ```
 
 

data/docs/MessageResult.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional] 
 **account_id** | **String** | String that uniquely identifies this account resource. | [optional] 
 **message_id** | **String** | String that uniquely identifies this message resource | [optional] 
-**status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received | [optional] 
+**status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown | [optional] 
 **from** | **String** | Phone number in E.164 format that sent the message. | [optional] 
 **to** | **String** | Phone number in E.164 format that received the message. | [optional] 
 **text** | **String** | Message contents | [optional] 

data/docs/MessageResultAllOf.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **account_id** | **String** | String that uniquely identifies this account resource. | [optional] 
 **message_id** | **String** | String that uniquely identifies this message resource | [optional] 
-**status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received | [optional] 
+**status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown | [optional] 
 **from** | **String** | Phone number in E.164 format that sent the message. | [optional] 
 **to** | **String** | Phone number in E.164 format that received the message. | [optional] 
 **text** | **String** | Message contents | [optional] 

data/docs/RecordUtterance.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **max_length_sec** | **Integer** | Maximum length for the command execution in seconds. | [optional] 
 **play_beep** | **Boolean** | Indicates whether to play a beep sound before the start of the recording. If set to `false`, no beep is played. | [optional] 
 **auto_start** | **Boolean** | If `false`, recording begins immediately after the RecordUtterance command is processed. If `true`, recording begins when audio is present and if audio begins before the `maxLengthSec` timeout. If no audio begins before `maxLengthSec`, no recording is generated. | [optional] 
+**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] 
 
 ## Code Sample
 
@@ -21,7 +22,8 @@ instance = Freeclimb::RecordUtterance.new(action_url: nil,
                                  finish_on_key: nil,
                                  max_length_sec: nil,
                                  play_beep: nil,
-                                 auto_start: nil)
+                                 auto_start: nil,
+                                 privacy_mode: nil)
 ```
 
 

data/docs/RecordUtteranceAllOf.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **max_length_sec** | **Integer** | Maximum length for the command execution in seconds. | [optional] 
 **play_beep** | **Boolean** | Indicates whether to play a beep sound before the start of the recording. If set to `false`, no beep is played. | [optional] 
 **auto_start** | **Boolean** | If `false`, recording begins immediately after the RecordUtterance command is processed. If `true`, recording begins when audio is present and if audio begins before the `maxLengthSec` timeout. If no audio begins before `maxLengthSec`, no recording is generated. | [optional] 
+**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] 
 
 ## Code Sample
 
@@ -21,7 +22,8 @@ instance = Freeclimb::RecordUtteranceAllOf.new(action_url: nil,
                                  finish_on_key: nil,
                                  max_length_sec: nil,
                                  play_beep: nil,
-                                 auto_start: nil)
+                                 auto_start: nil,
+                                 privacy_mode: nil)
 ```
 
 

data/docs/Redirect.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**action_url** | **String** | Reason for the rejection. This can be any string value. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the call flows for the given application. | [optional] 
+**action_url** | **String** | URL to request a new PerCL script to continue with the current Call's processing. When `Redirect` invokes the `actionUrl`, an `inbound` Webhook is sent. This request therefore looks identical to the initial request (made to the `voiceUrl` of the number that was called) for an inbound Call. | 
 
 ## Code Sample
 

data/docs/RedirectAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**action_url** | **String** | Reason for the rejection. This can be any string value. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the call flows for the given application. | [optional] 
+**action_url** | **String** | URL to request a new PerCL script to continue with the current Call's processing. When `Redirect` invokes the `actionUrl`, an `inbound` Webhook is sent. This request therefore looks identical to the initial request (made to the `voiceUrl` of the number that was called) for an inbound Call. | 
 
 ## Code Sample
 

data/docs/Reject.md

@@ -0,0 +1,17 @@
+# Freeclimb::Reject
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reason** | **String** | Reason for the rejection. This can be any string value. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the call flows for the given application. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::Reject.new(reason: nil)
+```
+
+

data/docs/RejectAllOf.md

@@ -0,0 +1,17 @@
+# Freeclimb::RejectAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reason** | **String** | Reason for the rejection. This can be any string value. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the call flows for the given application. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::RejectAllOf.new(reason: nil)
+```
+
+

data/lib/freeclimb.rb

@@ -55,6 +55,8 @@ 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/hangup'
+require 'freeclimb/models/hangup_all_of'
 require 'freeclimb/models/incoming_number_list'
 require 'freeclimb/models/incoming_number_list_all_of'
 require 'freeclimb/models/incoming_number_request'
@@ -98,6 +100,8 @@ 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/reject'
+require 'freeclimb/models/reject_all_of'
 require 'freeclimb/models/remove_from_conference'
 require 'freeclimb/models/remove_from_conference_all_of'
 require 'freeclimb/models/say'

data/lib/freeclimb/api_client.rb

@@ -30,7 +30,7 @@ module Freeclimb
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "FreeClimbSDK/2.0.2/ruby"
+      @user_agent = "FreeClimbSDK/2.2.0/ruby"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/freeclimb/models/account_result.rb

@@ -29,8 +29,8 @@ module Freeclimb
     # String that uniquely identifies this account resource.
     attr_accessor :account_id
 
-    # The authorization token assigned to this account. This token must be kept a secret by the customer.
-    attr_accessor :auth_token
+    # The API key assigned to this account. This token must be kept a secret by the customer.
+    attr_accessor :api_key
 
     # A description for this account.
     attr_accessor :_alias
@@ -77,7 +77,7 @@ module Freeclimb
         :'date_updated' => :'dateUpdated',
         :'revision' => :'revision',
         :'account_id' => :'accountId',
-        :'auth_token' => :'authToken',
+        :'api_key' => :'apiKey',
         :'_alias' => :'alias',
         :'label' => :'label',
         :'type' => :'type',
@@ -94,7 +94,7 @@ module Freeclimb
         :'date_updated' => :'String',
         :'revision' => :'Integer',
         :'account_id' => :'String',
-        :'auth_token' => :'String',
+        :'api_key' => :'String',
         :'_alias' => :'String',
         :'label' => :'String',
         :'type' => :'String',
@@ -152,8 +152,8 @@ module Freeclimb
         self.account_id = attributes[:'account_id']
       end
 
-      if attributes.key?(:'auth_token')
-        self.auth_token = attributes[:'auth_token']
+      if attributes.key?(:'api_key')
+        self.api_key = attributes[:'api_key']
       end
 
       if attributes.key?(:'_alias')
@@ -212,7 +212,7 @@ module Freeclimb
           date_updated == o.date_updated &&
           revision == o.revision &&
           account_id == o.account_id &&
-          auth_token == o.auth_token &&
+          api_key == o.api_key &&
           _alias == o._alias &&
           label == o.label &&
           type == o.type &&
@@ -229,7 +229,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [uri, date_created, date_updated, revision, account_id, auth_token, _alias, label, type, status, subresource_uris].hash
+      [uri, date_created, date_updated, revision, account_id, api_key, _alias, label, type, status, subresource_uris].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/account_result_all_of.rb

@@ -17,8 +17,8 @@ module Freeclimb
     # String that uniquely identifies this account resource.
     attr_accessor :account_id
 
-    # The authorization token assigned to this account. This token must be kept a secret by the customer.
-    attr_accessor :auth_token
+    # The API key assigned to this account. This token must be kept a secret by the customer.
+    attr_accessor :api_key
 
     # A description for this account.
     attr_accessor :_alias
@@ -61,7 +61,7 @@ module Freeclimb
     def self.attribute_map
       {
         :'account_id' => :'accountId',
-        :'auth_token' => :'authToken',
+        :'api_key' => :'apiKey',
         :'_alias' => :'alias',
         :'label' => :'label',
         :'type' => :'type',
@@ -74,7 +74,7 @@ module Freeclimb
     def self.openapi_types
       {
         :'account_id' => :'String',
-        :'auth_token' => :'String',
+        :'api_key' => :'String',
         :'_alias' => :'String',
         :'label' => :'String',
         :'type' => :'String',
@@ -108,8 +108,8 @@ module Freeclimb
         self.account_id = attributes[:'account_id']
       end
 
-      if attributes.key?(:'auth_token')
-        self.auth_token = attributes[:'auth_token']
+      if attributes.key?(:'api_key')
+        self.api_key = attributes[:'api_key']
       end
 
       if attributes.key?(:'_alias')
@@ -164,7 +164,7 @@ module Freeclimb
       return true if self.equal?(o)
       self.class == o.class &&
           account_id == o.account_id &&
-          auth_token == o.auth_token &&
+          api_key == o.api_key &&
           _alias == o._alias &&
           label == o.label &&
           type == o.type &&
@@ -181,7 +181,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, auth_token, _alias, label, type, status, subresource_uris].hash
+      [account_id, api_key, _alias, label, type, status, subresource_uris].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/hangup.rb

@@ -0,0 +1,220 @@
+=begin
+#FreeClimb API
+
+#FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module Freeclimb
+  # The `Hangup` command terminates a Call. If `Hangup` is used as the first action in a PerCL response, it does not prevent FreeClimb from answering the Call and billing your account. See the `Reject` command to hang up at no charge.
+  class Hangup < PerclCommand
+    # The user defined reason for the hangup. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the Call flows for the given application.
+    attr_accessor :reason
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'reason' => :'reason'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'reason' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'HangupAllOf',
+      :'PerclCommand'
+      ]
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::Hangup` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::Hangup`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      # call parent's initialize
+      super(attributes)
+
+      if attributes.key?(:'reason')
+        self.reason = attributes[:'reason']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = super
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true && super
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          reason == o.reason && super(o)
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [reason].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      super(attributes)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        Freeclimb.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = super
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end