freeclimb 2.1.2 → 3.0.2

data/lib/freeclimb/api/default_api.rb

@@ -1171,6 +1171,12 @@ module Freeclimb
     # Get an Incoming Number
     # @param phone_number_id [String] String that uniquely identifies this phone number resource.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :region State or province of this phone number.
+    # @option opts [String] :country Country of this phone number.
+    # @option opts [Boolean] :voice_enabled Indicates whether the phone number can handle Calls. Typically set to true for all numbers. (default to true)
+    # @option opts [Boolean] :sms_enabled Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. (default to true)
+    # @option opts [String] :application_id ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId.
+    # @option opts [Boolean] :has_application Indication of whether the phone number has an application linked to it. (default to false)
     # @return [IncomingNumberResult]
     def get_an_incoming_number(phone_number_id, opts = {})
       data, _status_code, _headers = get_an_incoming_number_with_http_info(phone_number_id, opts)
@@ -1180,6 +1186,12 @@ module Freeclimb
     # Get an Incoming Number
     # @param phone_number_id [String] String that uniquely identifies this phone number resource.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :region State or province of this phone number.
+    # @option opts [String] :country Country of this phone number.
+    # @option opts [Boolean] :voice_enabled Indicates whether the phone number can handle Calls. Typically set to true for all numbers.
+    # @option opts [Boolean] :sms_enabled Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.
+    # @option opts [String] :application_id ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId.
+    # @option opts [Boolean] :has_application Indication of whether the phone number has an application linked to it.
     # @return [Array<(IncomingNumberResult, Integer, Hash)>] IncomingNumberResult data, response status code and response headers
     def get_an_incoming_number_with_http_info(phone_number_id, opts = {})
       if @api_client.config.debugging
@@ -1194,6 +1206,12 @@ module Freeclimb
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'region'] = opts[:'region'] if !opts[:'region'].nil?
+      query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
+      query_params[:'voiceEnabled'] = opts[:'voice_enabled'] if !opts[:'voice_enabled'].nil?
+      query_params[:'smsEnabled'] = opts[:'sms_enabled'] if !opts[:'sms_enabled'].nil?
+      query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil?
+      query_params[:'hasApplication'] = opts[:'has_application'] if !opts[:'has_application'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -1518,8 +1536,11 @@ module Freeclimb
 
     # List available numbers
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :_alias Filter on numbers based on the formatted string of the phone number.
     # @option opts [String] :phone_number PCRE-compatible regular expression to filter against &#x60;phoneNumber&#x60; field, which is in E.164 format.
+    # @option opts [String] :region State or province of this phone number.
+    # @option opts [String] :country Country of this phone number.
+    # @option opts [Boolean] :voice_enabled Indicates whether the phone number can handle Calls. Typically set to true for all numbers. (default to true)
+    # @option opts [Boolean] :sms_enabled Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. (default to true)
     # @return [AvailableNumberList]
     def list_available_numbers(opts = {})
       data, _status_code, _headers = list_available_numbers_with_http_info(opts)
@@ -1528,8 +1549,11 @@ module Freeclimb
 
     # List available numbers
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :_alias Filter on numbers based on the formatted string of the phone number.
     # @option opts [String] :phone_number PCRE-compatible regular expression to filter against &#x60;phoneNumber&#x60; field, which is in E.164 format.
+    # @option opts [String] :region State or province of this phone number.
+    # @option opts [String] :country Country of this phone number.
+    # @option opts [Boolean] :voice_enabled Indicates whether the phone number can handle Calls. Typically set to true for all numbers.
+    # @option opts [Boolean] :sms_enabled Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.
     # @return [Array<(AvailableNumberList, Integer, Hash)>] AvailableNumberList data, response status code and response headers
     def list_available_numbers_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -1540,8 +1564,11 @@ module Freeclimb
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'alias'] = opts[:'_alias'] if !opts[:'_alias'].nil?
       query_params[:'phoneNumber'] = opts[:'phone_number'] if !opts[:'phone_number'].nil?
+      query_params[:'region'] = opts[:'region'] if !opts[:'region'].nil?
+      query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
+      query_params[:'voiceEnabled'] = opts[:'voice_enabled'] if !opts[:'voice_enabled'].nil?
+      query_params[:'smsEnabled'] = opts[:'sms_enabled'] if !opts[:'sms_enabled'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -1701,6 +1728,7 @@ module Freeclimb
 
     # List Calls
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :active If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query. (default to false)
     # @option opts [String] :to Only show Calls to this phone number.
     # @option opts [String] :from Only show Calls from this phone number.
     # @option opts [String] :status Only show Calls currently in this status. May be &#x60;queued&#x60;, &#x60;ringing&#x60;, &#x60;inProgress&#x60;, &#x60;canceled&#x60;, &#x60;completed&#x60;, &#x60;failed&#x60;, &#x60;busy&#x60;, or &#x60;noAnswer&#x60;.
@@ -1715,6 +1743,7 @@ module Freeclimb
 
     # List Calls
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :active If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query.
     # @option opts [String] :to Only show Calls to this phone number.
     # @option opts [String] :from Only show Calls from this phone number.
     # @option opts [String] :status Only show Calls currently in this status. May be &#x60;queued&#x60;, &#x60;ringing&#x60;, &#x60;inProgress&#x60;, &#x60;canceled&#x60;, &#x60;completed&#x60;, &#x60;failed&#x60;, &#x60;busy&#x60;, or &#x60;noAnswer&#x60;.
@@ -1731,6 +1760,7 @@ module Freeclimb
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'active'] = opts[:'active'] if !opts[:'active'].nil?
       query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
       query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
       query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?

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.1.2/ruby"
+      @user_agent = "FreeClimbSDK/3.0.2/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 key 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 key 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/add_to_conference.rb

@@ -158,10 +158,6 @@ module Freeclimb
         invalid_properties.push('invalid value for "conference_id", conference_id cannot be nil.')
       end
 
-      if @call_id.nil?
-        invalid_properties.push('invalid value for "call_id", call_id cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -169,7 +165,6 @@ module Freeclimb
     # @return true if the model is valid
     def valid?
       return false if @conference_id.nil?
-      return false if @call_id.nil?
       true && super
     end
 

data/lib/freeclimb/models/add_to_conference_all_of.rb

@@ -146,10 +146,6 @@ module Freeclimb
         invalid_properties.push('invalid value for "conference_id", conference_id cannot be nil.')
       end
 
-      if @call_id.nil?
-        invalid_properties.push('invalid value for "call_id", call_id cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -157,7 +153,6 @@ module Freeclimb
     # @return true if the model is valid
     def valid?
       return false if @conference_id.nil?
-      return false if @call_id.nil?
       true
     end
 

data/lib/freeclimb/models/available_number.rb

@@ -23,9 +23,6 @@ module Freeclimb
     # Indicates whether the phone number can send and receive SMS messages.
     attr_accessor :sms_enabled
 
-    # A nicely-formatted version of the phone number.
-    attr_accessor :_alias
-
     # The state or province of this phone number.
     attr_accessor :region
 
@@ -38,7 +35,6 @@ module Freeclimb
         :'phone_number' => :'phoneNumber',
         :'voice_enabled' => :'voiceEnabled',
         :'sms_enabled' => :'smsEnabled',
-        :'_alias' => :'alias',
         :'region' => :'region',
         :'country' => :'country'
       }
@@ -50,7 +46,6 @@ module Freeclimb
         :'phone_number' => :'String',
         :'voice_enabled' => :'Boolean',
         :'sms_enabled' => :'Boolean',
-        :'_alias' => :'String',
         :'region' => :'String',
         :'country' => :'String'
       }
@@ -89,10 +84,6 @@ module Freeclimb
         self.sms_enabled = attributes[:'sms_enabled']
       end
 
-      if attributes.key?(:'_alias')
-        self._alias = attributes[:'_alias']
-      end
-
       if attributes.key?(:'region')
         self.region = attributes[:'region']
       end
@@ -123,7 +114,6 @@ module Freeclimb
           phone_number == o.phone_number &&
           voice_enabled == o.voice_enabled &&
           sms_enabled == o.sms_enabled &&
-          _alias == o._alias &&
           region == o.region &&
           country == o.country
     end
@@ -137,7 +127,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [phone_number, voice_enabled, sms_enabled, _alias, region, country].hash
+      [phone_number, voice_enabled, sms_enabled, region, country].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/percl_command.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.0-SNAPSHOT
 require 'date'
 
 module Freeclimb
+  # An individual command used in a PerCLScript.
   class PerclCommand
     attr_accessor :command
 

data/lib/freeclimb/utils.rb

@@ -0,0 +1,34 @@
+require 'json'
+require 'cgi'
+require 'date'
+require 'openssl'
+
+module FreeClimb
+  class Utils
+    def self.verify_request(requestBody, signatureHeader, signingSecret, tolerance=5*60*1000)
+      signatureArr = signatureHeader.split(',')
+      signatureHash = {}
+      signatureArr.each { |queryStr|
+        hash = CGI.parse(queryStr)
+        if (signatureHash.key?(hash.keys[0])) 
+          signatureHash[hash.keys[0]] = [signatureHash[hash.keys[0]]].append(hash.values[0][0])
+        else
+          signatureHash[hash.keys[0]] = hash.values[0][0]
+        end
+      }
+
+      currentTime = DateTime.now.strftime('%s')
+      signatureAge = currentTime.to_i - signatureHash["t"].to_i
+      if (tolerance < signatureAge)
+        raise StandardError.new "Request rejected - signature's timestamp failed against current tolerance of #{tolerance} milliseconds. Signature age: #{signatureAge} milliseconds";
+      end
+
+      data = signatureHash["t"] + "." + requestBody
+      hmac = OpenSSL::HMAC.hexdigest('sha256', signingSecret, data)
+
+      if (!signatureHash["v1"].include? hmac)
+        raise StandardError.new "Unverified Request Signature - FreeClimb was unable to verify that this request originated from FreeClimb. If this request was unexpected, it may be from a bad actor. Please proceed with caution. If this request was expected, to fix this issue try checking for any typos or misspelling of your signing secret.";
+      end
+    end
+  end
+end

data/lib/freeclimb/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.0-SNAPSHOT
 =end
 
 module Freeclimb
-  VERSION = '2.1.2'
+  VERSION = '3.0.2'
 end