whatsapp-ruby-sdk 1.0.0

data/lib/whats_app_cloud_api/models/interactive.rb

@@ -0,0 +1,87 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Interactive Model.
+  class Interactive < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Action you want the user to perform after reading the message.
+    # @return [Action]
+    attr_accessor :action
+
+    # The body of the message. Emojis and markdown are supported.
+    # @return [Body]
+    attr_accessor :body
+
+    # The footer of the message. Emojis and markdown are supported.
+    # @return [Footer]
+    attr_accessor :footer
+
+    # Header content displayed on top of a message.
+    # @return [Header]
+    attr_accessor :header
+
+    # The type of interactive message you want to send.
+    # @return [InteractiveTypeEnum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['action'] = 'action'
+      @_hash['body'] = 'body'
+      @_hash['footer'] = 'footer'
+      @_hash['header'] = 'header'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        footer
+        header
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(action = nil,
+                   body = nil,
+                   type = nil,
+                   footer = nil,
+                   header = nil)
+      @action = action unless action == SKIP
+      @body = body unless body == SKIP
+      @footer = footer unless footer == SKIP
+      @header = header unless header == SKIP
+      @type = type unless type == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      action = Action.from_hash(hash['action']) if hash['action']
+      body = Body.from_hash(hash['body']) if hash['body']
+      type = hash.key?('type') ? hash['type'] : SKIP
+      footer = Footer.from_hash(hash['footer']) if hash['footer']
+      header = Header.from_hash(hash['header']) if hash['header']
+
+      # Create object from extracted values.
+      Interactive.new(action,
+                      body,
+                      type,
+                      footer,
+                      header)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/interactive_type_enum.rb

@@ -0,0 +1,17 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # The type of interactive message you want to send.
+  class InteractiveTypeEnum
+    INTERACTIVE_TYPE_ENUM = [
+      # TODO: Write general description for LIST
+      LIST = 'list'.freeze,
+
+      # TODO: Write general description for BUTTON
+      BUTTON = 'button'.freeze
+    ].freeze
+  end
+end

data/lib/whats_app_cloud_api/models/language.rb

@@ -0,0 +1,60 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Language Model.
+  class Language < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The code of the language or locale to use. Accepts both language and
+    # language_locale formats (e.g., en and en_US).
+    # @return [String]
+    attr_accessor :code
+
+    # The language policy the message should follow.
+    # @return [String]
+    attr_accessor :policy
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['policy'] = 'policy'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        policy
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(code = nil,
+                   policy = 'deterministic')
+      @code = code unless code == SKIP
+      @policy = policy unless policy == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      policy = hash['policy'] ||= 'deterministic'
+
+      # Create object from extracted values.
+      Language.new(code,
+                   policy)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/location.rb

@@ -0,0 +1,78 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Location Model.
+  class Location < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Latitude of the location.
+    # @return [String]
+    attr_accessor :latitude
+
+    # Longitude of the location.
+    # @return [String]
+    attr_accessor :longitude
+
+    # Name of the location.
+    # @return [String]
+    attr_accessor :name
+
+    # Address of the location. Only displayed if name is present.
+    # @return [String]
+    attr_accessor :address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['latitude'] = 'latitude'
+      @_hash['longitude'] = 'longitude'
+      @_hash['name'] = 'name'
+      @_hash['address'] = 'address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        name
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(latitude = nil,
+                   longitude = nil,
+                   name = nil,
+                   address = nil)
+      @latitude = latitude unless latitude == SKIP
+      @longitude = longitude unless longitude == SKIP
+      @name = name unless name == SKIP
+      @address = address unless address == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      latitude = hash.key?('latitude') ? hash['latitude'] : SKIP
+      longitude = hash.key?('longitude') ? hash['longitude'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      address = hash.key?('address') ? hash['address'] : SKIP
+
+      # Create object from extracted values.
+      Location.new(latitude,
+                   longitude,
+                   name,
+                   address)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/message.rb

@@ -0,0 +1,194 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Message Model.
+  class Message < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A media object containing audio. Required when type=audio.
+    # @return [Audio]
+    attr_accessor :audio
+
+    # A contact object. Required when type=contacts.
+    # @return [List of Contact]
+    attr_accessor :contacts
+
+    # A media object containing a document. Required when type=document.
+    # @return [Document]
+    attr_accessor :document
+
+    # A media object containing an image. Required when type=image.
+    # @return [Image]
+    attr_accessor :image
+
+    # This option is used to send List Messages and Reply Buttons. The
+    # components of each interactive object generally follow a consistent
+    # pattern: header, body, footer, and action. Required when type=interactive.
+    # @return [Interactive]
+    attr_accessor :interactive
+
+    # A location object. Required when type=location.
+    # @return [Location]
+    attr_accessor :location
+
+    # Messaging service used for the request.
+    # @return [String]
+    attr_accessor :messaging_product
+
+    # Currently, you can only send messages to individuals.
+    # @return [String]
+    attr_accessor :recipient_type
+
+    # A media object containing a sticker. Currently, we support inbound both
+    # and outbound stickers: For outbound, we only support static third-party
+    # stickers. For inbound, we support all types of stickers. The sticker needs
+    # to be 512x512 pixels and the file’s size needs to be less than 100 KB.
+    # Required when type=sticker.
+    # @return [Sticker]
+    attr_accessor :sticker
+
+    # A template object. Required when type=template.
+    # @return [Template]
+    attr_accessor :template
+
+    # Required for text messages.
+    # @return [Text]
+    attr_accessor :text
+
+    # WhatsApp ID or phone number for the person you want to send a message to.
+    # @return [String]
+    attr_accessor :to
+
+    # The type of message you want to send.
+    # @return [MessageTypeEnum]
+    attr_accessor :type
+
+    # A media object containing a video. Required when type=video.
+    # @return [Video]
+    attr_accessor :video
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['audio'] = 'audio'
+      @_hash['contacts'] = 'contacts'
+      @_hash['document'] = 'document'
+      @_hash['image'] = 'image'
+      @_hash['interactive'] = 'interactive'
+      @_hash['location'] = 'location'
+      @_hash['messaging_product'] = 'messaging_product'
+      @_hash['recipient_type'] = 'recipient_type'
+      @_hash['sticker'] = 'sticker'
+      @_hash['template'] = 'template'
+      @_hash['text'] = 'text'
+      @_hash['to'] = 'to'
+      @_hash['type'] = 'type'
+      @_hash['video'] = 'video'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        audio
+        contacts
+        document
+        image
+        interactive
+        location
+        recipient_type
+        sticker
+        template
+        text
+        type
+        video
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(messaging_product = nil,
+                   to = nil,
+                   audio = nil,
+                   contacts = nil,
+                   document = nil,
+                   image = nil,
+                   interactive = nil,
+                   location = nil,
+                   recipient_type = 'individual',
+                   sticker = nil,
+                   template = nil,
+                   text = nil,
+                   type = nil,
+                   video = nil)
+      @audio = audio unless audio == SKIP
+      @contacts = contacts unless contacts == SKIP
+      @document = document unless document == SKIP
+      @image = image unless image == SKIP
+      @interactive = interactive unless interactive == SKIP
+      @location = location unless location == SKIP
+      @messaging_product = messaging_product unless messaging_product == SKIP
+      @recipient_type = recipient_type unless recipient_type == SKIP
+      @sticker = sticker unless sticker == SKIP
+      @template = template unless template == SKIP
+      @text = text unless text == SKIP
+      @to = to unless to == SKIP
+      @type = type unless type == SKIP
+      @video = video unless video == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      messaging_product =
+        hash.key?('messaging_product') ? hash['messaging_product'] : SKIP
+      to = hash.key?('to') ? hash['to'] : SKIP
+      audio = Audio.from_hash(hash['audio']) if hash['audio']
+      # Parameter is an array, so we need to iterate through it
+      contacts = nil
+      unless hash['contacts'].nil?
+        contacts = []
+        hash['contacts'].each do |structure|
+          contacts << (Contact.from_hash(structure) if structure)
+        end
+      end
+
+      contacts = SKIP unless hash.key?('contacts')
+      document = Document.from_hash(hash['document']) if hash['document']
+      image = Image.from_hash(hash['image']) if hash['image']
+      interactive = Interactive.from_hash(hash['interactive']) if hash['interactive']
+      location = Location.from_hash(hash['location']) if hash['location']
+      recipient_type = hash['recipient_type'] ||= 'individual'
+      sticker = Sticker.from_hash(hash['sticker']) if hash['sticker']
+      template = Template.from_hash(hash['template']) if hash['template']
+      text = Text.from_hash(hash['text']) if hash['text']
+      type = hash.key?('type') ? hash['type'] : SKIP
+      video = Video.from_hash(hash['video']) if hash['video']
+
+      # Create object from extracted values.
+      Message.new(messaging_product,
+                  to,
+                  audio,
+                  contacts,
+                  document,
+                  image,
+                  interactive,
+                  location,
+                  recipient_type,
+                  sticker,
+                  template,
+                  text,
+                  type,
+                  video)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/message_type_enum.rb

@@ -0,0 +1,41 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # MessageType.
+  class MessageTypeEnum
+    MESSAGE_TYPE_ENUM = [
+      # TODO: Write general description for TEXT
+      TEXT = 'text'.freeze,
+
+      # TODO: Write general description for AUDIO
+      AUDIO = 'audio'.freeze,
+
+      # TODO: Write general description for CONTACTS
+      CONTACTS = 'contacts'.freeze,
+
+      # TODO: Write general description for DOCUMENT
+      DOCUMENT = 'document'.freeze,
+
+      # TODO: Write general description for IMAGE
+      IMAGE = 'image'.freeze,
+
+      # TODO: Write general description for INTERACTIVE
+      INTERACTIVE = 'interactive'.freeze,
+
+      # TODO: Write general description for LOCATION
+      LOCATION = 'location'.freeze,
+
+      # TODO: Write general description for STICKER
+      STICKER = 'sticker'.freeze,
+
+      # TODO: Write general description for TEMPLATE
+      TEMPLATE = 'template'.freeze,
+
+      # TODO: Write general description for VIDEO
+      VIDEO = 'video'.freeze
+    ].freeze
+  end
+end

data/lib/whats_app_cloud_api/models/name.rb

@@ -0,0 +1,100 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Name Model.
+  class Name < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Full name, as it normally appears.
+    # @return [String]
+    attr_accessor :formatted_name
+
+    # Full name, as it normally appears.
+    # @return [String]
+    attr_accessor :first_name
+
+    # Full name, as it normally appears.
+    # @return [String]
+    attr_accessor :last_name
+
+    # Full name, as it normally appears.
+    # @return [String]
+    attr_accessor :middle_name
+
+    # Full name, as it normally appears.
+    # @return [String]
+    attr_accessor :suffix
+
+    # Full name, as it normally appears.
+    # @return [String]
+    attr_accessor :prefix
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['formatted_name'] = 'formatted_name'
+      @_hash['first_name'] = 'first_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['middle_name'] = 'middle_name'
+      @_hash['suffix'] = 'suffix'
+      @_hash['prefix'] = 'prefix'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        first_name
+        last_name
+        middle_name
+        suffix
+        prefix
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(formatted_name = nil,
+                   first_name = nil,
+                   last_name = nil,
+                   middle_name = nil,
+                   suffix = nil,
+                   prefix = nil)
+      @formatted_name = formatted_name unless formatted_name == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @middle_name = middle_name unless middle_name == SKIP
+      @suffix = suffix unless suffix == SKIP
+      @prefix = prefix unless prefix == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      formatted_name =
+        hash.key?('formatted_name') ? hash['formatted_name'] : SKIP
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      middle_name = hash.key?('middle_name') ? hash['middle_name'] : SKIP
+      suffix = hash.key?('suffix') ? hash['suffix'] : SKIP
+      prefix = hash.key?('prefix') ? hash['prefix'] : SKIP
+
+      # Create object from extracted values.
+      Name.new(formatted_name,
+               first_name,
+               last_name,
+               middle_name,
+               suffix,
+               prefix)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/org.rb

@@ -0,0 +1,70 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Org Model.
+  class Org < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the contact's company.
+    # @return [String]
+    attr_accessor :company
+
+    # Name of the contact's department.
+    # @return [String]
+    attr_accessor :department
+
+    # Contact's business title.
+    # @return [String]
+    attr_accessor :title
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['company'] = 'company'
+      @_hash['department'] = 'department'
+      @_hash['title'] = 'title'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        company
+        department
+        title
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(company = nil,
+                   department = nil,
+                   title = nil)
+      @company = company unless company == SKIP
+      @department = department unless department == SKIP
+      @title = title unless title == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      company = hash.key?('company') ? hash['company'] : SKIP
+      department = hash.key?('department') ? hash['department'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+
+      # Create object from extracted values.
+      Org.new(company,
+              department,
+              title)
+    end
+  end
+end