freeclimb 4.9.0 → 5.0.0

data/lib/freeclimb/models/{call_result_all_of.rb → machine_detected_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,144 +14,147 @@ require 'date'
 require 'time'
 
 module Freeclimb
-  class CallResultAllOf
-    # String that uniquely identifies this Call resource.
-    attr_accessor :call_id
+  # An outbound call spawned by OutDial detected an answer by a machine (answering machine or fax/modem machine) and ifMachineUrl is being invoked. A PerCL response is expected.
+  class MachineDetectedWebhook < 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
+      MachineDetectedWebhook.new(hash)
+    end
+    # Context or reason why this request is being made. Will be machineDetected - An outbound call spawned by OutDial was answered by a machine and the ifMachineUrl is being invoked.
+    attr_accessor :request_type
 
-    # ID of the Call that created this leg (child Call).
-    attr_accessor :parent_call_id
+    # Unique ID for this Call, generated by FreeClimb.
+    attr_accessor :call_id
 
-    # ID of the account that owns this Call.
+    # Account ID associated with your account.
     attr_accessor :account_id
 
-    # Phone number that initiated this Call.
+    # Phone number of the party that initiated the Call (in E.164 format).
     attr_accessor :from
 
-    # Phone number that received this Call.
+    # Phone number provisioned to you and to which this Call is directed (in E.164 format).
     attr_accessor :to
 
-    # If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI).
-    attr_accessor :phone_number_id
-
     attr_accessor :call_status
 
-    # Start time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed.
-    attr_accessor :start_time
-
-    # Time the Call was answered (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed.
-    attr_accessor :connect_time
-
-    # End time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call did not complete successfully.
-    attr_accessor :end_time
-
-    # Total length of the Call in seconds. Measures time between startTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls.
-    attr_accessor :duration
+    attr_accessor :direction
 
-    # Length of time that the Call was connected in seconds. Measures time between connectTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls.
-    attr_accessor :connect_duration
+    # This is only populated if request pertains to a Conference. Otherwise, it is set to null.
+    attr_accessor :conference_id
 
-    attr_accessor :direction
+    # This is only populated if the request pertains to a Queue. Otherwise, it is set to null.
+    attr_accessor :queue_id
 
-    attr_accessor :answered_by
+    # Call ID of the leg which initiated the OutDial.
+    attr_accessor :parent_call_id
 
-    # The list of subresources for this Call. These include things like logs and recordings associated with the Call.
-    attr_accessor :subresource_uris
+    attr_accessor :machine_type
+
+    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
 
-    # ApplicationId associated with the Call.
-    attr_accessor :application_id
+      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',
-        :'parent_call_id' => :'parentCallId',
         :'account_id' => :'accountId',
         :'from' => :'from',
         :'to' => :'to',
-        :'phone_number_id' => :'phoneNumberId',
         :'call_status' => :'callStatus',
-        :'start_time' => :'startTime',
-        :'connect_time' => :'connectTime',
-        :'end_time' => :'endTime',
-        :'duration' => :'duration',
-        :'connect_duration' => :'connectDuration',
         :'direction' => :'direction',
-        :'answered_by' => :'answeredBy',
-        :'subresource_uris' => :'subresourceUris',
-        :'application_id' => :'applicationId'
+        :'conference_id' => :'conferenceId',
+        :'queue_id' => :'queueId',
+        :'parent_call_id' => :'parentCallId',
+        :'machine_type' => :'machineType'
       }
     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',
-        :'parent_call_id' => :'String',
         :'account_id' => :'String',
         :'from' => :'String',
         :'to' => :'String',
-        :'phone_number_id' => :'String',
         :'call_status' => :'CallStatus',
-        :'start_time' => :'String',
-        :'connect_time' => :'String',
-        :'end_time' => :'String',
-        :'duration' => :'Integer',
-        :'connect_duration' => :'Integer',
         :'direction' => :'CallDirection',
-        :'answered_by' => :'AnsweredBy',
-        :'subresource_uris' => :'Object',
-        :'application_id' => :'String'
+        :'conference_id' => :'String',
+        :'queue_id' => :'String',
+        :'parent_call_id' => :'String',
+        :'machine_type' => :'MachineType'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'call_id',
-        :'parent_call_id',
-        :'account_id',
-        :'from',
-        :'to',
-        :'phone_number_id',
         :'call_status',
-        :'start_time',
-        :'connect_time',
-        :'end_time',
-        :'duration',
-        :'connect_duration',
         :'direction',
-        :'answered_by',
-        :'subresource_uris',
-        :'application_id'
+        :'conference_id',
+        :'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::CallResultAllOf` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::MachineDetectedWebhook` 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::CallResultAllOf`. 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::MachineDetectedWebhook`. 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?(:'call_id')
-        self.call_id = attributes[:'call_id']
+      # call parent's initialize
+      super(attributes)
+
+      if attributes.key?(:'request_type')
+        self.request_type = attributes[:'request_type']
       end
 
-      if attributes.key?(:'parent_call_id')
-        self.parent_call_id = attributes[:'parent_call_id']
+      if attributes.key?(:'call_id')
+        self.call_id = attributes[:'call_id']
       end
 
       if attributes.key?(:'account_id')
@@ -166,55 +169,35 @@ module Freeclimb
         self.to = attributes[:'to']
       end
 
-      if attributes.key?(:'phone_number_id')
-        self.phone_number_id = attributes[:'phone_number_id']
-      end
-
       if attributes.key?(:'call_status')
         self.call_status = attributes[:'call_status']
       end
 
-      if attributes.key?(:'start_time')
-        self.start_time = attributes[:'start_time']
-      end
-
-      if attributes.key?(:'connect_time')
-        self.connect_time = attributes[:'connect_time']
-      end
-
-      if attributes.key?(:'end_time')
-        self.end_time = attributes[:'end_time']
-      end
-
-      if attributes.key?(:'duration')
-        self.duration = attributes[:'duration']
-      end
-
-      if attributes.key?(:'connect_duration')
-        self.connect_duration = attributes[:'connect_duration']
-      end
-
       if attributes.key?(:'direction')
         self.direction = attributes[:'direction']
       end
 
-      if attributes.key?(:'answered_by')
-        self.answered_by = attributes[:'answered_by']
+      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?(:'subresource_uris')
-        self.subresource_uris = attributes[:'subresource_uris']
+      if attributes.key?(:'parent_call_id')
+        self.parent_call_id = attributes[:'parent_call_id']
       end
 
-      if attributes.key?(:'application_id')
-        self.application_id = attributes[:'application_id']
+      if attributes.key?(:'machine_type')
+        self.machine_type = attributes[:'machine_type']
       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
 
@@ -222,7 +205,7 @@ module Freeclimb
     # @return true if the model is valid
     def valid?
       
-      if @call_id.nil?
+      if @request_type.nil?
         false
       else
         list_invalid_properties.length() == 0
@@ -234,22 +217,17 @@ module Freeclimb
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          request_type == o.request_type &&
           call_id == o.call_id &&
-          parent_call_id == o.parent_call_id &&
           account_id == o.account_id &&
           from == o.from &&
           to == o.to &&
-          phone_number_id == o.phone_number_id &&
           call_status == o.call_status &&
-          start_time == o.start_time &&
-          connect_time == o.connect_time &&
-          end_time == o.end_time &&
-          duration == o.duration &&
-          connect_duration == o.connect_duration &&
           direction == o.direction &&
-          answered_by == o.answered_by &&
-          subresource_uris == o.subresource_uris &&
-          application_id == o.application_id
+          conference_id == o.conference_id &&
+          queue_id == o.queue_id &&
+          parent_call_id == o.parent_call_id &&
+          machine_type == o.machine_type && super(o)
     end
 
     # @see the `==` method
@@ -261,7 +239,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [call_id, parent_call_id, account_id, from, to, phone_number_id, call_status, start_time, connect_time, end_time, duration, connect_duration, direction, answered_by, subresource_uris, application_id].hash
+      [request_type, call_id, account_id, from, to, call_status, direction, conference_id, queue_id, parent_call_id, machine_type].hash
     end
 
     # Builds the object from hash
@@ -276,6 +254,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)
@@ -351,7 +330,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?
@@ -381,7 +360,5 @@ module Freeclimb
         value
       end
     end
-
   end
-
 end

data/lib/freeclimb/models/machine_type.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
 
@@ -15,8 +15,8 @@ require 'time'
 
 module Freeclimb
   class MachineType
-    ANSWERING_MACHINE = "answeringMachine".freeze
-    FAX_MACHINE = "faxMachine".freeze
+    ANSWERING_MACHINE = "answering machine".freeze
+    FAX_MODEM = "fax modem".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

data/lib/freeclimb/models/make_call_request.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
 
@@ -318,7 +318,5 @@ module Freeclimb
         value
       end
     end
-
   end
-
 end