whatsapp-ruby-sdk 1.0.0

data/lib/whats_app_cloud_api/models/section.rb

@@ -0,0 +1,72 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Section Model.
+  class Section < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Required if the message has more than one section. Title of the section.
+    # @return [String]
+    attr_accessor :title
+
+    # Required for List Messages. Contains a list of rows. You can have a total
+    # of 10 rows across your sections. Each row must have a title (Maximum
+    # length: 24 characters) and an ID (Maximum length: 200 characters). You can
+    # add a description (Maximum length: 72 characters), but it is optional.
+    # @return [List of Row]
+    attr_accessor :rows
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['title'] = 'title'
+      @_hash['rows'] = 'rows'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        title
+        rows
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(title = nil,
+                   rows = nil)
+      @title = title unless title == SKIP
+      @rows = rows unless rows == 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.
+      title = hash.key?('title') ? hash['title'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      rows = nil
+      unless hash['rows'].nil?
+        rows = []
+        hash['rows'].each do |structure|
+          rows << (Row.from_hash(structure) if structure)
+        end
+      end
+
+      rows = SKIP unless hash.key?('rows')
+
+      # Create object from extracted values.
+      Section.new(title,
+                  rows)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/send_message_response.rb

@@ -0,0 +1,85 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # SendMessageResponse Model.
+  class SendMessageResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :messaging_product
+
+    # TODO: Write general description for this method
+    # @return [List of ResponseContact]
+    attr_accessor :contacts
+
+    # TODO: Write general description for this method
+    # @return [List of ResponseMessage]
+    attr_accessor :messages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['messaging_product'] = 'messaging_product'
+      @_hash['contacts'] = 'contacts'
+      @_hash['messages'] = 'messages'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      []
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(messaging_product = nil,
+                   contacts = nil,
+                   messages = nil)
+      @messaging_product = messaging_product unless messaging_product == SKIP
+      @contacts = contacts unless contacts == SKIP
+      @messages = messages unless messages == 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
+      # Parameter is an array, so we need to iterate through it
+      contacts = nil
+      unless hash['contacts'].nil?
+        contacts = []
+        hash['contacts'].each do |structure|
+          contacts << (ResponseContact.from_hash(structure) if structure)
+        end
+      end
+
+      contacts = SKIP unless hash.key?('contacts')
+      # Parameter is an array, so we need to iterate through it
+      messages = nil
+      unless hash['messages'].nil?
+        messages = []
+        hash['messages'].each do |structure|
+          messages << (ResponseMessage.from_hash(structure) if structure)
+        end
+      end
+
+      messages = SKIP unless hash.key?('messages')
+
+      # Create object from extracted values.
+      SendMessageResponse.new(messaging_product,
+                              contacts,
+                              messages)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/set_two_step_verification_code_request.rb

@@ -0,0 +1,48 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # A 6-digit pin you wish to use for two-step authentication.
+  class SetTwoStepVerificationCodeRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :pin
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pin'] = 'pin'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      []
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(pin = nil)
+      @pin = pin unless pin == 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.
+      pin = hash.key?('pin') ? hash['pin'] : SKIP
+
+      # Create object from extracted values.
+      SetTwoStepVerificationCodeRequest.new(pin)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/sticker.rb

@@ -0,0 +1,61 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Sticker Model.
+  class Sticker < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The protocol and URL of the media to be sent. Use only with HTTP/HTTPS
+    # URLs. Required when you are not using an uploaded media ID.
+    # @return [String]
+    attr_accessor :link
+
+    # The media object ID. Required when you are not using a link.
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['link'] = 'link'
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        link
+        id
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(link = nil,
+                   id = nil)
+      @link = link unless link == SKIP
+      @id = id unless id == 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.
+      link = hash.key?('link') ? hash['link'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+
+      # Create object from extracted values.
+      Sticker.new(link,
+                  id)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/sub_type_enum.rb

@@ -0,0 +1,20 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # SubType.
+  class SubTypeEnum
+    SUB_TYPE_ENUM = [
+      # Refers to a previously created quick reply button that allows for the
+      # customer to return a predefined message.
+      QUICKREPLY = 'quick_reply'.freeze,
+
+      # Refers to a previously created button that allows the customer to visit
+      # the URL generated by appending the text parameter to the predefined
+      # prefix URL in the template.
+      URL = 'url'.freeze
+    ].freeze
+  end
+end

data/lib/whats_app_cloud_api/models/success_response.rb

@@ -0,0 +1,48 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # SuccessResponse Model.
+  class SuccessResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Boolean]
+    attr_accessor :success
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['success'] = 'success'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      []
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(success = nil)
+      @success = success unless success == 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.
+      success = hash.key?('success') ? hash['success'] : SKIP
+
+      # Create object from extracted values.
+      SuccessResponse.new(success)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/template.rb

@@ -0,0 +1,78 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Template Model.
+  class Template < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the template.
+    # @return [String]
+    attr_accessor :name
+
+    # Specifies the language the template may be rendered in. Only the
+    # deterministic language policy works with media template messages.
+    # @return [Language]
+    attr_accessor :language
+
+    # Array of components objects containing the parameters of the message.
+    # @return [List of Component]
+    attr_accessor :components
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['language'] = 'language'
+      @_hash['components'] = 'components'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        components
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(name = nil,
+                   language = nil,
+                   components = nil)
+      @name = name unless name == SKIP
+      @language = language unless language == SKIP
+      @components = components unless components == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      language = Language.from_hash(hash['language']) if hash['language']
+      # Parameter is an array, so we need to iterate through it
+      components = nil
+      unless hash['components'].nil?
+        components = []
+        hash['components'].each do |structure|
+          components << (Component.from_hash(structure) if structure)
+        end
+      end
+
+      components = SKIP unless hash.key?('components')
+
+      # Create object from extracted values.
+      Template.new(name,
+                   language,
+                   components)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/text.rb

@@ -0,0 +1,72 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Text Model.
+  class Text < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Required for text messages. The text of the text message which can contain
+    # URLs which begin with http:// or https:// and formatting. See available
+    # formatting options here. If you include URLs in your text and want to
+    # include a preview box in text messages (preview_url: true), make sure the
+    # URL starts with http:// or https:// —https:// URLs are preferred. You must
+    # include a hostname, since IP addresses will not be matched.
+    # @return [String]
+    attr_accessor :body
+
+    # By default, WhatsApp recognizes URLs and makes them clickable, but you can
+    # also include a preview box with more information about the link. Set this
+    # field to true if you want to include a URL preview box. The majority of
+    # the time, the receiver will see a URL they can click on when you send an
+    # URL, set preview_url to true, and provide a body object with a http or
+    # https link. URL previews are only rendered after one of the following has
+    # happened: The business has sent a message template to the user. The user
+    # initiates a conversation with a "click to chat" link. The user adds the
+    # business phone number to their address book and initiates a conversation.
+    # @return [Boolean]
+    attr_accessor :preview_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['body'] = 'body'
+      @_hash['preview_url'] = 'preview_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        preview_url
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(body = nil,
+                   preview_url = false)
+      @body = body unless body == SKIP
+      @preview_url = preview_url unless preview_url == 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.
+      body = hash.key?('body') ? hash['body'] : SKIP
+      preview_url = hash['preview_url'] ||= false
+
+      # Create object from extracted values.
+      Text.new(body,
+               preview_url)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/update_business_profile_request.rb

@@ -0,0 +1,116 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # UpdateBusinessProfileRequest Model.
+  class UpdateBusinessProfileRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The messaging service used for the request. Always set it to "whatsapp" if
+    # you are using the WhatsApp Business API.
+    # @return [String]
+    attr_accessor :messaging_product
+
+    # Address of the business.
+    # @return [String]
+    attr_accessor :address
+
+    # Description of the business.
+    # @return [String]
+    attr_accessor :description
+
+    # Industry of the business. This can be either an empty string or one of the
+    # accepted values.
+    # @return [VerticalEnum]
+    attr_accessor :vertical
+
+    # The contact email address (in valid email format) of the business.
+    # @return [String]
+    attr_accessor :email
+
+    # The URLs associated with the business. For instance, a website, Facebook
+    # Page, or Instagram. You must include the http:// or https:// portion of
+    # the URL.
+    # @return [List of String]
+    attr_accessor :websites
+
+    # URL of the profile picture generated from a call to the Resumable Upload
+    # API.
+    # @return [String]
+    attr_accessor :profile_picture_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['messaging_product'] = 'messaging_product'
+      @_hash['address'] = 'address'
+      @_hash['description'] = 'description'
+      @_hash['vertical'] = 'vertical'
+      @_hash['email'] = 'email'
+      @_hash['websites'] = 'websites'
+      @_hash['profile_picture_url'] = 'profile_picture_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        address
+        description
+        vertical
+        email
+        websites
+        profile_picture_url
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(messaging_product = nil,
+                   address = nil,
+                   description = nil,
+                   vertical = nil,
+                   email = nil,
+                   websites = nil,
+                   profile_picture_url = nil)
+      @messaging_product = messaging_product unless messaging_product == SKIP
+      @address = address unless address == SKIP
+      @description = description unless description == SKIP
+      @vertical = vertical unless vertical == SKIP
+      @email = email unless email == SKIP
+      @websites = websites unless websites == SKIP
+      @profile_picture_url = profile_picture_url unless profile_picture_url == 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
+      address = hash.key?('address') ? hash['address'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      vertical = hash.key?('vertical') ? hash['vertical'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      websites = hash.key?('websites') ? hash['websites'] : SKIP
+      profile_picture_url =
+        hash.key?('profile_picture_url') ? hash['profile_picture_url'] : SKIP
+
+      # Create object from extracted values.
+      UpdateBusinessProfileRequest.new(messaging_product,
+                                       address,
+                                       description,
+                                       vertical,
+                                       email,
+                                       websites,
+                                       profile_picture_url)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/upload_media.rb

@@ -0,0 +1,48 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # UploadMedia Model.
+  class UploadMedia < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      []
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(id = nil)
+      @id = id unless id == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+
+      # Create object from extracted values.
+      UploadMedia.new(id)
+    end
+  end
+end