freeclimb 4.9.0 → 5.1.0

data/lib/freeclimb/models/{message_result_all_of.rb → message_delivery_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,126 +14,119 @@ require 'date'
 require 'time'
 
 module Freeclimb
-  class MessageResultAllOf
-    # String that uniquely identifies this account resource.
-    attr_accessor :account_id
-
-    # String that uniquely identifies this message resource
-    attr_accessor :message_id
+  # An SMS has been received by the platform and is being delivered to the smsUrl of the customer application that is associated with the destination number. A PerCL response will be ignored.
+  class MessageDeliveryWebhook < 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
+      MessageDeliveryWebhook.new(hash)
+    end
+    # Value will be messageDelivery - An SMS message has been received by the platform and is being delivered to the customer application associated with the destination number.
+    attr_accessor :request_type
 
-    attr_accessor :status
+    # Account ID associated with your account.
+    attr_accessor :account_id
 
-    # Phone number in E.164 format that sent the message.
+    # Phone number of the party that initiated the Call (in E.164 format).
     attr_accessor :from
 
-    # Phone number in E.164 format that received the message.
+    # Phone number provisioned to you and to which this Call is directed (in E.164 format).
     attr_accessor :to
 
-    # Message contents
+    # Body of the SMS message.
     attr_accessor :text
 
-    # Noting whether the message was inbound or outbound
+    # Value will be inbound to indicate the receipt of a message into the FreeClimb platform.
     attr_accessor :direction
 
-    # URL invoked when message sent
-    attr_accessor :notification_url
-
-    # The unique identifier for the brand associated with the message
-    attr_accessor :brand_id
+    # ID of the application to which the destination number is assigned.
+    attr_accessor :application_id
 
-    # The unique identifier for the campaign associated with the message
-    attr_accessor :campaign_id
+    # Value will be received to indicate that the platform has successfully received the incoming message.
+    attr_accessor :status
 
-    # The number of segments into which the message was split
-    attr_accessor :segment_count
+    # ID of the destination phone number.
+    attr_accessor :phone_number_id
 
-    # an array of HTTP URLs which were attached this this message
-    attr_accessor :media_urls
+    # The URI for this resource, relative to the API base URL
+    attr_accessor :uri
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'request_type' => :'requestType',
         :'account_id' => :'accountId',
-        :'message_id' => :'messageId',
-        :'status' => :'status',
         :'from' => :'from',
         :'to' => :'to',
         :'text' => :'text',
         :'direction' => :'direction',
-        :'notification_url' => :'notificationUrl',
-        :'brand_id' => :'brandId',
-        :'campaign_id' => :'campaignId',
-        :'segment_count' => :'segmentCount',
-        :'media_urls' => :'mediaUrls'
+        :'application_id' => :'applicationId',
+        :'status' => :'status',
+        :'phone_number_id' => :'phoneNumberId',
+        :'uri' => :'uri'
       }
     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',
         :'account_id' => :'String',
-        :'message_id' => :'String',
-        :'status' => :'MessageStatus',
         :'from' => :'String',
         :'to' => :'String',
         :'text' => :'String',
         :'direction' => :'String',
-        :'notification_url' => :'String',
-        :'brand_id' => :'String',
-        :'campaign_id' => :'String',
-        :'segment_count' => :'Float',
-        :'media_urls' => :'Array<String>'
+        :'application_id' => :'String',
+        :'status' => :'String',
+        :'phone_number_id' => :'String',
+        :'uri' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'account_id',
-        :'message_id',
-        :'status',
-        :'from',
-        :'to',
-        :'text',
-        :'direction',
-        :'notification_url',
-        :'brand_id',
-        :'campaign_id',
-        :'segment_count',
-        :'media_urls'
       ])
     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::MessageResultAllOf` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::MessageDeliveryWebhook` 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::MessageResultAllOf`. 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::MessageDeliveryWebhook`. 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?(:'account_id')
-        self.account_id = attributes[:'account_id']
-      end
+      # call parent's initialize
+      super(attributes)
 
-      if attributes.key?(:'message_id')
-        self.message_id = attributes[:'message_id']
+      if attributes.key?(:'request_type')
+        self.request_type = attributes[:'request_type']
       end
 
-      if attributes.key?(:'status')
-        self.status = attributes[:'status']
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
       end
 
       if attributes.key?(:'from')
@@ -152,33 +145,27 @@ module Freeclimb
         self.direction = attributes[:'direction']
       end
 
-      if attributes.key?(:'notification_url')
-        self.notification_url = attributes[:'notification_url']
+      if attributes.key?(:'application_id')
+        self.application_id = attributes[:'application_id']
       end
 
-      if attributes.key?(:'brand_id')
-        self.brand_id = attributes[:'brand_id']
-      end
-
-      if attributes.key?(:'campaign_id')
-        self.campaign_id = attributes[:'campaign_id']
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
       end
 
-      if attributes.key?(:'segment_count')
-        self.segment_count = attributes[:'segment_count']
+      if attributes.key?(:'phone_number_id')
+        self.phone_number_id = attributes[:'phone_number_id']
       end
 
-      if attributes.key?(:'media_urls')
-        if (value = attributes[:'media_urls']).is_a?(Array)
-          self.media_urls = value
-        end
+      if attributes.key?(:'uri')
+        self.uri = attributes[:'uri']
       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
 
@@ -186,7 +173,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
@@ -198,18 +185,16 @@ module Freeclimb
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          request_type == o.request_type &&
           account_id == o.account_id &&
-          message_id == o.message_id &&
-          status == o.status &&
           from == o.from &&
           to == o.to &&
           text == o.text &&
           direction == o.direction &&
-          notification_url == o.notification_url &&
-          brand_id == o.brand_id &&
-          campaign_id == o.campaign_id &&
-          segment_count == o.segment_count &&
-          media_urls == o.media_urls
+          application_id == o.application_id &&
+          status == o.status &&
+          phone_number_id == o.phone_number_id &&
+          uri == o.uri && super(o)
     end
 
     # @see the `==` method
@@ -221,7 +206,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, message_id, status, from, to, text, direction, notification_url, brand_id, campaign_id, segment_count, media_urls].hash
+      [request_type, account_id, from, to, text, direction, application_id, status, phone_number_id, uri].hash
     end
 
     # Builds the object from hash
@@ -236,6 +221,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)
@@ -311,7 +297,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?
@@ -341,7 +327,5 @@ module Freeclimb
         value
       end
     end
-
   end
-
 end

data/lib/freeclimb/models/message_direction.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
 

data/lib/freeclimb/models/message_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
 
@@ -87,7 +87,6 @@ module Freeclimb
     # List of class defined in allOf (OpenAPI v3)
     def self.openapi_all_of
       [
-      :'MessageRequestAllOf',
       :'MutableResourceModel'
       ]
     end
@@ -321,7 +320,5 @@ module Freeclimb
         value
       end
     end
-
   end
-
 end

data/lib/freeclimb/models/message_result.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
 
@@ -62,6 +62,36 @@ module Freeclimb
     # an array of HTTP URLs which were attached this this message
     attr_accessor :media_urls
 
+    attr_accessor :tfn
+
+    # String that uniquely identifies the phoneNumber resource used to send this Message
+    attr_accessor :phone_number_id
+
+    # String that uniquely identifies the Application resource used to send this Message
+    attr_accessor :application_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
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -80,7 +110,10 @@ module Freeclimb
         :'brand_id' => :'brandId',
         :'campaign_id' => :'campaignId',
         :'segment_count' => :'segmentCount',
-        :'media_urls' => :'mediaUrls'
+        :'media_urls' => :'mediaUrls',
+        :'tfn' => :'tfn',
+        :'phone_number_id' => :'phoneNumberId',
+        :'application_id' => :'applicationId'
       }
     end
 
@@ -107,7 +140,10 @@ module Freeclimb
         :'brand_id' => :'String',
         :'campaign_id' => :'String',
         :'segment_count' => :'Float',
-        :'media_urls' => :'Array<String>'
+        :'media_urls' => :'Array<String>',
+        :'tfn' => :'TFN',
+        :'phone_number_id' => :'String',
+        :'application_id' => :'String'
       }
     end
 
@@ -125,14 +161,15 @@ module Freeclimb
         :'brand_id',
         :'campaign_id',
         :'segment_count',
-        :'media_urls'
+        :'media_urls',
+        :'phone_number_id',
+        :'application_id'
       ])
     end
 
     # List of class defined in allOf (OpenAPI v3)
     def self.openapi_all_of
       [
-      :'MessageResultAllOf',
       :'MutableResourceModel'
       ]
     end
@@ -217,6 +254,18 @@ module Freeclimb
           self.media_urls = value
         end
       end
+
+      if attributes.key?(:'tfn')
+        self.tfn = attributes[:'tfn']
+      end
+
+      if attributes.key?(:'phone_number_id')
+        self.phone_number_id = attributes[:'phone_number_id']
+      end
+
+      if attributes.key?(:'application_id')
+        self.application_id = attributes[:'application_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -257,7 +306,10 @@ module Freeclimb
           brand_id == o.brand_id &&
           campaign_id == o.campaign_id &&
           segment_count == o.segment_count &&
-          media_urls == o.media_urls
+          media_urls == o.media_urls &&
+          tfn == o.tfn &&
+          phone_number_id == o.phone_number_id &&
+          application_id == o.application_id
     end
 
     # @see the `==` method
@@ -269,7 +321,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, media_urls].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, tfn, phone_number_id, application_id].hash
     end
 
     # Builds the object from hash
@@ -389,7 +441,5 @@ module Freeclimb
         value
       end
     end
-
   end
-
 end

data/lib/freeclimb/models/message_status.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