freeclimb 4.5.2 → 4.6.0

data/lib/freeclimb/models/create_web_rtc_token.rb

@@ -0,0 +1,278 @@
+=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
+Contact: support@freeclimb.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Freeclimb
+  class CreateWebRTCToken
+    # E.164 formatted phone number to which calls using this token will be made.
+    attr_accessor :to
+
+    # E.164 formatted phone number owned by the reqeusting account from which calls using this token will be made.
+    attr_accessor :from
+
+    # number of times this token may be used for a WebRTC call
+    attr_accessor :uses
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'to' => :'to',
+        :'from' => :'from',
+        :'uses' => :'uses'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'to' => :'String',
+        :'from' => :'String',
+        :'uses' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::CreateWebRTCToken` 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::CreateWebRTCToken`. 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
+      }
+
+      if attributes.key?(:'to')
+        self.to = attributes[:'to']
+      end
+
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
+      end
+
+      if attributes.key?(:'uses')
+        self.uses = attributes[:'uses']
+      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 = Array.new
+      if @to.nil?
+        invalid_properties.push('invalid value for "to", to cannot be nil.')
+      end
+
+      if @from.nil?
+        invalid_properties.push('invalid value for "from", from cannot be nil.')
+      end
+
+      if @uses.nil?
+        invalid_properties.push('invalid value for "uses", uses cannot be nil.')
+      end
+
+      if @uses < 1
+        invalid_properties.push('invalid value for "uses", must be greater than or equal to 1.')
+      end
+
+      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?
+      
+      if @to.nil?
+        false
+      elsif @from.nil?
+        false
+      elsif @uses.nil?
+        false
+      else
+        list_invalid_properties.length() == 0
+      end
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] uses Value to be assigned
+    def uses=(uses)
+      if uses.nil?
+        fail ArgumentError, 'uses cannot be nil'
+      end
+
+      if uses < 1
+        fail ArgumentError, 'invalid value for "uses", must be greater than or equal to 1.'
+      end
+
+      @uses = uses
+    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 &&
+          to == o.to &&
+          from == o.from &&
+          uses == o.uses
+    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
+      [to, from, uses].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)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = Freeclimb.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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 = {}
+      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

data/lib/freeclimb/models/get_digits.rb

@@ -70,7 +70,7 @@ module Freeclimb
         :'digit_timeout_ms' => :'Integer',
         :'finish_on_key' => :'String',
         :'flush_buffer' => :'Boolean',
-        :'initial_timeout_ms' => :'String',
+        :'initial_timeout_ms' => :'Integer',
         :'max_digits' => :'Integer',
         :'min_digits' => :'Integer',
         :'prompts' => :'Array<PerclCommand>',

data/lib/freeclimb/models/get_digits_all_of.rb

@@ -69,7 +69,7 @@ module Freeclimb
         :'digit_timeout_ms' => :'Integer',
         :'finish_on_key' => :'String',
         :'flush_buffer' => :'Boolean',
-        :'initial_timeout_ms' => :'String',
+        :'initial_timeout_ms' => :'Integer',
         :'max_digits' => :'Integer',
         :'min_digits' => :'Integer',
         :'prompts' => :'Array<PerclCommand>',

data/lib/freeclimb/models/incoming_number_result.rb

@@ -62,6 +62,8 @@ module Freeclimb
     # The offnet field is a boolean representing whether the number is offnet registered or not. This field will be rendered only for requests to the IncomingPhone number resource.
     attr_accessor :offnet
 
+    attr_accessor :tfn
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -80,7 +82,8 @@ module Freeclimb
         :'country' => :'country',
         :'voice_enabled' => :'voiceEnabled',
         :'sms_enabled' => :'smsEnabled',
-        :'offnet' => :'offnet'
+        :'offnet' => :'offnet',
+        :'tfn' => :'tfn'
       }
     end
 
@@ -107,7 +110,8 @@ module Freeclimb
         :'country' => :'String',
         :'voice_enabled' => :'Boolean',
         :'sms_enabled' => :'Boolean',
-        :'offnet' => :'Boolean'
+        :'offnet' => :'Boolean',
+        :'tfn' => :'TFN'
       }
     end
 
@@ -124,7 +128,7 @@ module Freeclimb
         :'country',
         :'voice_enabled',
         :'sms_enabled',
-        :'offnet'
+        :'offnet',
       ])
     end
 
@@ -214,6 +218,10 @@ module Freeclimb
       if attributes.key?(:'offnet')
         self.offnet = attributes[:'offnet']
       end
+
+      if attributes.key?(:'tfn')
+        self.tfn = attributes[:'tfn']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -237,6 +245,8 @@ module Freeclimb
         false
       elsif @capabilities.nil?
         false
+      elsif @tfn.nil?
+        false
       else
         list_invalid_properties.length() == 0
       end
@@ -262,7 +272,8 @@ module Freeclimb
           country == o.country &&
           voice_enabled == o.voice_enabled &&
           sms_enabled == o.sms_enabled &&
-          offnet == o.offnet
+          offnet == o.offnet &&
+          tfn == o.tfn
     end
 
     # @see the `==` method
@@ -274,7 +285,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [uri, date_created, date_updated, revision, capabilities, campaign_id, phone_number_id, account_id, application_id, phone_number, _alias, region, country, voice_enabled, sms_enabled, offnet].hash
+      [uri, date_created, date_updated, revision, capabilities, campaign_id, phone_number_id, account_id, application_id, phone_number, _alias, region, country, voice_enabled, sms_enabled, offnet, tfn].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/incoming_number_result_all_of.rb

@@ -50,6 +50,8 @@ module Freeclimb
     # The offnet field is a boolean representing whether the number is offnet registered or not. This field will be rendered only for requests to the IncomingPhone number resource.
     attr_accessor :offnet
 
+    attr_accessor :tfn
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -64,7 +66,8 @@ module Freeclimb
         :'country' => :'country',
         :'voice_enabled' => :'voiceEnabled',
         :'sms_enabled' => :'smsEnabled',
-        :'offnet' => :'offnet'
+        :'offnet' => :'offnet',
+        :'tfn' => :'tfn'
       }
     end
 
@@ -87,7 +90,8 @@ module Freeclimb
         :'country' => :'String',
         :'voice_enabled' => :'Boolean',
         :'sms_enabled' => :'Boolean',
-        :'offnet' => :'Boolean'
+        :'offnet' => :'Boolean',
+        :'tfn' => :'TFN'
       }
     end
 
@@ -104,7 +108,7 @@ module Freeclimb
         :'country',
         :'voice_enabled',
         :'sms_enabled',
-        :'offnet'
+        :'offnet',
       ])
     end
 
@@ -170,6 +174,10 @@ module Freeclimb
       if attributes.key?(:'offnet')
         self.offnet = attributes[:'offnet']
       end
+
+      if attributes.key?(:'tfn')
+        self.tfn = attributes[:'tfn']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -185,6 +193,8 @@ module Freeclimb
       
       if @capabilities.nil?
         false
+      elsif @tfn.nil?
+        false
       else
         list_invalid_properties.length() == 0
       end
@@ -206,7 +216,8 @@ module Freeclimb
           country == o.country &&
           voice_enabled == o.voice_enabled &&
           sms_enabled == o.sms_enabled &&
-          offnet == o.offnet
+          offnet == o.offnet &&
+          tfn == o.tfn
     end
 
     # @see the `==` method
@@ -218,7 +229,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [capabilities, campaign_id, phone_number_id, account_id, application_id, phone_number, _alias, region, country, voice_enabled, sms_enabled, offnet].hash
+      [capabilities, campaign_id, phone_number_id, account_id, application_id, phone_number, _alias, region, country, voice_enabled, sms_enabled, offnet, tfn].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/message_request.rb

@@ -39,8 +39,8 @@ module Freeclimb
     # When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters.  **Note:** This is a notification only; any PerCL returned is ignored.
     attr_accessor :notification_url
 
-    # String that uniquely identifies this account resource.
-    attr_accessor :account_id
+    # an array of HTTP URLs which are to be used as attachments to the message. This will force the message into being an MMS message and must be done using a from number which is MMS capabile.
+    attr_accessor :media_urls
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -53,7 +53,7 @@ module Freeclimb
         :'to' => :'to',
         :'text' => :'text',
         :'notification_url' => :'notificationUrl',
-        :'account_id' => :'accountId'
+        :'media_urls' => :'mediaUrls'
       }
     end
 
@@ -73,7 +73,7 @@ module Freeclimb
         :'to' => :'String',
         :'text' => :'String',
         :'notification_url' => :'String',
-        :'account_id' => :'String'
+        :'media_urls' => :'Array<String>'
       }
     end
 
@@ -138,8 +138,10 @@ module Freeclimb
         self.notification_url = attributes[:'notification_url']
       end
 
-      if attributes.key?(:'account_id')
-        self.account_id = attributes[:'account_id']
+      if attributes.key?(:'media_urls')
+        if (value = attributes[:'media_urls']).is_a?(Array)
+          self.media_urls = value
+        end
       end
     end
 
@@ -182,7 +184,7 @@ module Freeclimb
         false
       elsif @notification_url.nil?
         false
-      elsif @account_id.nil?
+      elsif @media_urls.nil?
         false
       else
         list_invalid_properties.length() == 0
@@ -202,7 +204,7 @@ module Freeclimb
           to == o.to &&
           text == o.text &&
           notification_url == o.notification_url &&
-          account_id == o.account_id
+          media_urls == o.media_urls
     end
 
     # @see the `==` method
@@ -214,7 +216,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [uri, date_created, date_updated, revision, from, to, text, notification_url, account_id].hash
+      [uri, date_created, date_updated, revision, from, to, text, notification_url, media_urls].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/message_request_all_of.rb

@@ -27,8 +27,8 @@ module Freeclimb
     # When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters.  **Note:** This is a notification only; any PerCL returned is ignored.
     attr_accessor :notification_url
 
-    # String that uniquely identifies this account resource.
-    attr_accessor :account_id
+    # an array of HTTP URLs which are to be used as attachments to the message. This will force the message into being an MMS message and must be done using a from number which is MMS capabile.
+    attr_accessor :media_urls
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -37,7 +37,7 @@ module Freeclimb
         :'to' => :'to',
         :'text' => :'text',
         :'notification_url' => :'notificationUrl',
-        :'account_id' => :'accountId'
+        :'media_urls' => :'mediaUrls'
       }
     end
 
@@ -53,7 +53,7 @@ module Freeclimb
         :'to' => :'String',
         :'text' => :'String',
         :'notification_url' => :'String',
-        :'account_id' => :'String'
+        :'media_urls' => :'Array<String>'
       }
     end
 
@@ -94,8 +94,10 @@ module Freeclimb
         self.notification_url = attributes[:'notification_url']
       end
 
-      if attributes.key?(:'account_id')
-        self.account_id = attributes[:'account_id']
+      if attributes.key?(:'media_urls')
+        if (value = attributes[:'media_urls']).is_a?(Array)
+          self.media_urls = value
+        end
       end
     end
 
@@ -130,7 +132,7 @@ module Freeclimb
         false
       elsif @notification_url.nil?
         false
-      elsif @account_id.nil?
+      elsif @media_urls.nil?
         false
       else
         list_invalid_properties.length() == 0
@@ -146,7 +148,7 @@ module Freeclimb
           to == o.to &&
           text == o.text &&
           notification_url == o.notification_url &&
-          account_id == o.account_id
+          media_urls == o.media_urls
     end
 
     # @see the `==` method
@@ -158,7 +160,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [from, to, text, notification_url, account_id].hash
+      [from, to, text, notification_url, media_urls].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/message_result.rb

@@ -59,6 +59,9 @@ module Freeclimb
     # The number of segments into which the message was split
     attr_accessor :segment_count
 
+    # an array of HTTP URLs which were attached this this message
+    attr_accessor :media_urls
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -76,7 +79,8 @@ module Freeclimb
         :'notification_url' => :'notificationUrl',
         :'brand_id' => :'brandId',
         :'campaign_id' => :'campaignId',
-        :'segment_count' => :'segmentCount'
+        :'segment_count' => :'segmentCount',
+        :'media_urls' => :'mediaUrls'
       }
     end
 
@@ -102,7 +106,8 @@ module Freeclimb
         :'notification_url' => :'String',
         :'brand_id' => :'String',
         :'campaign_id' => :'String',
-        :'segment_count' => :'Float'
+        :'segment_count' => :'Float',
+        :'media_urls' => :'Array<String>'
       }
     end
 
@@ -119,7 +124,7 @@ module Freeclimb
         :'notification_url',
         :'brand_id',
         :'campaign_id',
-        :'segment_count'
+        :'segment_count',
       ])
     end
 
@@ -205,6 +210,12 @@ module Freeclimb
       if attributes.key?(:'segment_count')
         self.segment_count = attributes[:'segment_count']
       end
+
+      if attributes.key?(:'media_urls')
+        if (value = attributes[:'media_urls']).is_a?(Array)
+          self.media_urls = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -226,6 +237,8 @@ module Freeclimb
         false
       elsif @revision.nil?
         false
+      elsif @media_urls.nil?
+        false
       else
         list_invalid_properties.length() == 0
       end
@@ -250,7 +263,8 @@ module Freeclimb
           notification_url == o.notification_url &&
           brand_id == o.brand_id &&
           campaign_id == o.campaign_id &&
-          segment_count == o.segment_count
+          segment_count == o.segment_count &&
+          media_urls == o.media_urls
     end
 
     # @see the `==` method
@@ -262,7 +276,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [uri, date_created, date_updated, revision, account_id, message_id, status, from, to, text, direction, notification_url, brand_id, campaign_id, segment_count].hash
+      [uri, date_created, date_updated, revision, account_id, message_id, status, from, to, text, direction, notification_url, brand_id, campaign_id, segment_count, media_urls].hash
     end
 
     # Builds the object from hash