freeclimb 4.9.0 → 5.1.0

data/lib/freeclimb/models/add_to_conference_notification_webhook.rb

@@ -0,0 +1,384 @@
+=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: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Freeclimb
+  # A Call has been bridged to a Conference and the AddToConference command’s notificationUrl is being invoked. This is a notification only; any PerCL returned will be ignored.
+  class AddToConferenceNotificationWebhook < Webhook
+    def self.deserialize(payload)
+      return nil if payload.nil? || payload.empty?
+      data = JSON.parse("[#{payload}]")[0]
+      inverted_attributes = self.attribute_map.invert
+      hash = self.acceptable_attributes.uniq.map { |k| [inverted_attributes[k], data[k.to_s]] }.to_h
+      AddToConferenceNotificationWebhook.new(hash)
+    end
+    # Context or reason why this request is being made. Will be addToConferenceNotification - A Call has been bridged to a conference and the addToConference command’s notificationUrl is being invoked.
+    attr_accessor :request_type
+
+    # Unique ID for this Call, generated by FreeClimb.
+    attr_accessor :call_id
+
+    # Account ID associated with your account.
+    attr_accessor :account_id
+
+    # Phone number of the party that initiated the Call (in E.164 format).
+    attr_accessor :from
+
+    # Phone number provisioned to you and to which this Call is directed (in E.164 format).
+    attr_accessor :to
+
+    attr_accessor :call_status
+
+    attr_accessor :direction
+
+    # Unique ID of the Conference.
+    attr_accessor :conference_id
+
+    # This is only populated if the request pertains to a Queue. Otherwise, it is set to null.
+    attr_accessor :queue_id
+
+    attr_accessor :status
+
+    # URL of the Conference’s recorded audio. Populated only if a Recording exists and the Conference was emptied.
+    attr_accessor :recording_url
+
+    # Unique ID of the Recording from this Conference. Populated only if a recording exists and the Conference was emptied.
+    attr_accessor :recording_id
+
+    # Duration of the recorded audio (in seconds), rounded up to the nearest second. Populated only if a Recording exists and the Conference was emptied.
+    attr_accessor :recording_duration_sec
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'request_type' => :'requestType',
+        :'call_id' => :'callId',
+        :'account_id' => :'accountId',
+        :'from' => :'from',
+        :'to' => :'to',
+        :'call_status' => :'callStatus',
+        :'direction' => :'direction',
+        :'conference_id' => :'conferenceId',
+        :'queue_id' => :'queueId',
+        :'status' => :'status',
+        :'recording_url' => :'recordingUrl',
+        :'recording_id' => :'recordingId',
+        :'recording_duration_sec' => :'recordingDurationSec'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about, including the ones defined in its parent(s)
+    def self.acceptable_attributes
+      attribute_map.values.concat(superclass.acceptable_attributes)
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'request_type' => :'String',
+        :'call_id' => :'String',
+        :'account_id' => :'String',
+        :'from' => :'String',
+        :'to' => :'String',
+        :'call_status' => :'CallStatus',
+        :'direction' => :'CallDirection',
+        :'conference_id' => :'String',
+        :'queue_id' => :'String',
+        :'status' => :'ConferenceStatus',
+        :'recording_url' => :'String',
+        :'recording_id' => :'String',
+        :'recording_duration_sec' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'call_status',
+        :'direction',
+        :'queue_id',
+        :'status',
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'Webhook'
+      ]
+    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::AddToConferenceNotificationWebhook` 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::AddToConferenceNotificationWebhook`. 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?(:'request_type')
+        self.request_type = attributes[:'request_type']
+      end
+
+      if attributes.key?(:'call_id')
+        self.call_id = attributes[:'call_id']
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
+      end
+
+      if attributes.key?(:'to')
+        self.to = attributes[:'to']
+      end
+
+      if attributes.key?(:'call_status')
+        self.call_status = attributes[:'call_status']
+      end
+
+      if attributes.key?(:'direction')
+        self.direction = attributes[:'direction']
+      end
+
+      if attributes.key?(:'conference_id')
+        self.conference_id = attributes[:'conference_id']
+      end
+
+      if attributes.key?(:'queue_id')
+        self.queue_id = attributes[:'queue_id']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'recording_url')
+        self.recording_url = attributes[:'recording_url']
+      end
+
+      if attributes.key?(:'recording_id')
+        self.recording_id = attributes[:'recording_id']
+      end
+
+      if attributes.key?(:'recording_duration_sec')
+        self.recording_duration_sec = attributes[:'recording_duration_sec']
+      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?
+      
+      if @request_type.nil?
+        false
+      else
+        list_invalid_properties.length() == 0
+      end
+    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 &&
+          request_type == o.request_type &&
+          call_id == o.call_id &&
+          account_id == o.account_id &&
+          from == o.from &&
+          to == o.to &&
+          call_status == o.call_status &&
+          direction == o.direction &&
+          conference_id == o.conference_id &&
+          queue_id == o.queue_id &&
+          status == o.status &&
+          recording_url == o.recording_url &&
+          recording_id == o.recording_id &&
+          recording_duration_sec == o.recording_duration_sec && 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
+      [request_type, call_id, account_id, from, to, call_status, direction, conference_id, queue_id, status, recording_url, recording_id, recording_duration_sec].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 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 = 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

data/lib/freeclimb/models/{conference_participant_result_all_of.rb → add_to_queue_notification_webhook.rb}

@@ -6,7 +6,7 @@
 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
+OpenAPI Generator version: 7.9.0
 
 =end
 
@@ -14,120 +14,172 @@ require 'date'
 require 'time'
 
 module Freeclimb
-  class ConferenceParticipantResultAllOf
-    # ID of the account that created this participant.
+  # A Call has been added to a Queue and the Enqueue command’s notificationUrl is being invoked. This is a notification only; any PerCL returned will be ignored.
+  class AddToQueueNotificationWebhook < Webhook
+    def self.deserialize(payload)
+      return nil if payload.nil? || payload.empty?
+      data = JSON.parse("[#{payload}]")[0]
+      inverted_attributes = self.attribute_map.invert
+      hash = self.acceptable_attributes.uniq.map { |k| [inverted_attributes[k], data[k.to_s]] }.to_h
+      AddToQueueNotificationWebhook.new(hash)
+    end
+    # Context or reason why this request is being made. Will be addToQueueNotification - A call has been added to a queue and the Enqueue command’s notificationUrl is being invoked.
+    attr_accessor :request_type
+
+    # Unique ID for this Call, generated by FreeClimb.
+    attr_accessor :call_id
+
+    # Account ID associated with your account.
     attr_accessor :account_id
 
-    # ID of the conference this participant is in.
-    attr_accessor :conference_id
+    # Phone number of the party that initiated the Call (in E.164 format).
+    attr_accessor :from
 
-    # ID of the Call associated with this Participant.
-    attr_accessor :call_id
+    # Phone number provisioned to you and to which this Call is directed (in E.164 format).
+    attr_accessor :to
+
+    attr_accessor :call_status
 
-    # True if this Participant has talk privileges in the Conference. False otherwise.
-    attr_accessor :talk
+    attr_accessor :direction
 
-    # True if this Participant has listen privileges in the Conference. False otherwise.
-    attr_accessor :listen
+    # Unique ID of the Conference.
+    attr_accessor :conference_id
 
-    # True if this Participant had dtmfPassThrough privileges in the Conference. False otherwise.
-    attr_accessor :dtmf_pass_through
+    # This is only populated if the request pertains to a Queue. Otherwise, it is set to null.
+    attr_accessor :queue_id
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
 
-    # True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise.
-    attr_accessor :start_conf_on_enter
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'request_type' => :'requestType',
+        :'call_id' => :'callId',
         :'account_id' => :'accountId',
+        :'from' => :'from',
+        :'to' => :'to',
+        :'call_status' => :'callStatus',
+        :'direction' => :'direction',
         :'conference_id' => :'conferenceId',
-        :'call_id' => :'callId',
-        :'talk' => :'talk',
-        :'listen' => :'listen',
-        :'dtmf_pass_through' => :'dtmfPassThrough',
-        :'start_conf_on_enter' => :'startConfOnEnter'
+        :'queue_id' => :'queueId'
       }
     end
 
-    # Returns all the JSON keys this model knows about
+    # Returns all the JSON keys this model knows about, including the ones defined in its parent(s)
     def self.acceptable_attributes
-      attribute_map.values
+      attribute_map.values.concat(superclass.acceptable_attributes)
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'request_type' => :'String',
+        :'call_id' => :'String',
         :'account_id' => :'String',
+        :'from' => :'String',
+        :'to' => :'String',
+        :'call_status' => :'CallStatus',
+        :'direction' => :'CallDirection',
         :'conference_id' => :'String',
-        :'call_id' => :'String',
-        :'talk' => :'Boolean',
-        :'listen' => :'Boolean',
-        :'dtmf_pass_through' => :'Boolean',
-        :'start_conf_on_enter' => :'Boolean'
+        :'queue_id' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'account_id',
-        :'conference_id',
-        :'call_id',
-        :'talk',
-        :'listen',
-        :'dtmf_pass_through',
-        :'start_conf_on_enter'
+        :'call_status',
+        :'direction',
+        :'queue_id'
       ])
     end
 
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'Webhook'
+      ]
+    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::ConferenceParticipantResultAllOf` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::AddToQueueNotificationWebhook` 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::ConferenceParticipantResultAllOf`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::AddToQueueNotificationWebhook`. 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?(:'request_type')
+        self.request_type = attributes[:'request_type']
+      end
+
+      if attributes.key?(:'call_id')
+        self.call_id = attributes[:'call_id']
+      end
+
       if attributes.key?(:'account_id')
         self.account_id = attributes[:'account_id']
       end
 
-      if attributes.key?(:'conference_id')
-        self.conference_id = attributes[:'conference_id']
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
       end
 
-      if attributes.key?(:'call_id')
-        self.call_id = attributes[:'call_id']
+      if attributes.key?(:'to')
+        self.to = attributes[:'to']
       end
 
-      if attributes.key?(:'talk')
-        self.talk = attributes[:'talk']
+      if attributes.key?(:'call_status')
+        self.call_status = attributes[:'call_status']
       end
 
-      if attributes.key?(:'listen')
-        self.listen = attributes[:'listen']
+      if attributes.key?(:'direction')
+        self.direction = attributes[:'direction']
       end
 
-      if attributes.key?(:'dtmf_pass_through')
-        self.dtmf_pass_through = attributes[:'dtmf_pass_through']
+      if attributes.key?(:'conference_id')
+        self.conference_id = attributes[:'conference_id']
       end
 
-      if attributes.key?(:'start_conf_on_enter')
-        self.start_conf_on_enter = attributes[:'start_conf_on_enter']
+      if attributes.key?(:'queue_id')
+        self.queue_id = attributes[:'queue_id']
       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
+      invalid_properties = super
       invalid_properties
     end
 
@@ -135,7 +187,7 @@ module Freeclimb
     # @return true if the model is valid
     def valid?
       
-      if @account_id.nil?
+      if @request_type.nil?
         false
       else
         list_invalid_properties.length() == 0
@@ -147,13 +199,15 @@ module Freeclimb
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          request_type == o.request_type &&
+          call_id == o.call_id &&
           account_id == o.account_id &&
+          from == o.from &&
+          to == o.to &&
+          call_status == o.call_status &&
+          direction == o.direction &&
           conference_id == o.conference_id &&
-          call_id == o.call_id &&
-          talk == o.talk &&
-          listen == o.listen &&
-          dtmf_pass_through == o.dtmf_pass_through &&
-          start_conf_on_enter == o.start_conf_on_enter
+          queue_id == o.queue_id && super(o)
     end
 
     # @see the `==` method
@@ -165,7 +219,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, conference_id, call_id, talk, listen, dtmf_pass_through, start_conf_on_enter].hash
+      [request_type, call_id, account_id, from, to, call_status, direction, conference_id, queue_id].hash
     end
 
     # Builds the object from hash
@@ -180,6 +234,7 @@ module Freeclimb
     # @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 attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
           self.send("#{key}=", nil)
@@ -255,7 +310,7 @@ module Freeclimb
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
-      hash = {}
+      hash = super
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         if value.nil?
@@ -285,7 +340,5 @@ module Freeclimb
         value
       end
     end
-
   end
-
 end

data/lib/freeclimb/models/answered_by.rb

@@ -6,7 +6,7 @@
 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
+OpenAPI Generator version: 7.9.0
 
 =end