whatsapp-ruby-sdk 1.0.0

data/lib/whats_app_cloud_api/models/body.rb

@@ -0,0 +1,49 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Body Model.
+  class Body < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The body content of the message. Emojis and markdown are supported. Links
+    # are supported.
+    # @return [String]
+    attr_accessor :text
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['text'] = 'text'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      []
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(text = nil)
+      @text = text unless text == 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.
+      text = hash.key?('text') ? hash['text'] : SKIP
+
+      # Create object from extracted values.
+      Body.new(text)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/business_profile.rb

@@ -0,0 +1,123 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # BusinessProfile Model.
+  class BusinessProfile < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID of the business profile object.
+    # @return [String]
+    attr_accessor :id
+
+    # 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['id'] = 'id'
+      @_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[
+        vertical
+        email
+        websites
+        profile_picture_url
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   messaging_product = nil,
+                   address = nil,
+                   description = nil,
+                   vertical = nil,
+                   email = nil,
+                   websites = nil,
+                   profile_picture_url = nil)
+      @id = id unless id == SKIP
+      @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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      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.
+      BusinessProfile.new(id,
+                          messaging_product,
+                          address,
+                          description,
+                          vertical,
+                          email,
+                          websites,
+                          profile_picture_url)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/button.rb

@@ -0,0 +1,71 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Button Model.
+  class Button < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # Button title. It cannot be an empty string and must be unique within the
+    # message. Emojis are supported, markdown is not.
+    # @return [String]
+    attr_accessor :title
+
+    # Unique identifier for your button. This ID is returned in the webhook when
+    # the button is clicked by the user.
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['title'] = 'title'
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        title
+        id
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(type = 'reply',
+                   title = nil,
+                   id = nil)
+      @type = type unless type == SKIP
+      @title = title unless title == 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.
+      type = hash['type'] ||= 'reply'
+      title = hash.key?('title') ? hash['title'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+
+      # Create object from extracted values.
+      Button.new(type,
+                 title,
+                 id)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/button_parameter.rb

@@ -0,0 +1,72 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # ButtonParameter Model.
+  class ButtonParameter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates the type of parameter for the button.
+    # @return [ButtonParameterTypeEnum]
+    attr_accessor :type
+
+    # Required for quick_reply buttons. Developer-defined payload that is
+    # returned when the button is clicked in addition to the display text on the
+    # button.
+    # @return [String]
+    attr_accessor :payload
+
+    # Required for URL buttons. Developer-provided suffix that is appended to
+    # the predefined prefix URL in the template.
+    # @return [String]
+    attr_accessor :text
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['payload'] = 'payload'
+      @_hash['text'] = 'text'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        payload
+        text
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(type = nil,
+                   payload = nil,
+                   text = nil)
+      @type = type unless type == SKIP
+      @payload = payload unless payload == SKIP
+      @text = text unless text == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      payload = hash.key?('payload') ? hash['payload'] : SKIP
+      text = hash.key?('text') ? hash['text'] : SKIP
+
+      # Create object from extracted values.
+      ButtonParameter.new(type,
+                          payload,
+                          text)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/button_parameter_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
+  # ButtonParameterType.
+  class ButtonParameterTypeEnum
+    BUTTON_PARAMETER_TYPE_ENUM = [
+      # TODO: Write general description for PAYLOAD
+      PAYLOAD = 'payload'.freeze,
+
+      # TODO: Write general description for TEXT
+      TEXT = 'text'.freeze
+    ].freeze
+  end
+end

data/lib/whats_app_cloud_api/models/component.rb

@@ -0,0 +1,83 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Component Model.
+  class Component < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Describes the component type. For text-based templates, we only support
+    # the type=body.
+    # @return [ComponentTypeEnum]
+    attr_accessor :type
+
+    # Required when type=button. Not used for the other types. Type of button to
+    # create.
+    # @return [SubTypeEnum]
+    attr_accessor :sub_type
+
+    # Required when type=button. Array of parameter objects with the content of
+    # the message. For components of type=button, see the button parameter
+    # object.
+    # @return [List of Object]
+    attr_accessor :parameters
+
+    # Required when type=button. Not used for the other types. Position index of
+    # the button. You can have up to 3 buttons using index values of 0 to 2.
+    # @return [String]
+    attr_accessor :index
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['sub_type'] = 'sub_type'
+      @_hash['parameters'] = 'parameters'
+      @_hash['index'] = 'index'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        sub_type
+        index
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(type = nil,
+                   parameters = nil,
+                   sub_type = nil,
+                   index = nil)
+      @type = type unless type == SKIP
+      @sub_type = sub_type unless sub_type == SKIP
+      @parameters = parameters unless parameters == SKIP
+      @index = index unless index == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      parameters = hash.key?('parameters') ? hash['parameters'] : SKIP
+      sub_type = hash.key?('sub_type') ? hash['sub_type'] : SKIP
+      index = hash.key?('index') ? hash['index'] : SKIP
+
+      # Create object from extracted values.
+      Component.new(type,
+                    parameters,
+                    sub_type,
+                    index)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/component_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
+  # ComponentType.
+  class ComponentTypeEnum
+    COMPONENT_TYPE_ENUM = [
+      # TODO: Write general description for HEADER
+      HEADER = 'header'.freeze,
+
+      # TODO: Write general description for BODY
+      BODY = 'body'.freeze,
+
+      # TODO: Write general description for BUTTON
+      BUTTON = 'button'.freeze
+    ].freeze
+  end
+end

data/lib/whats_app_cloud_api/models/contact.rb

@@ -0,0 +1,145 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Contact Model.
+  class Contact < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Full contact address(es)
+    # @return [List of Address]
+    attr_accessor :addresses
+
+    # Full contact address(es)
+    # @return [String]
+    attr_accessor :birthday
+
+    # Contact email address(es)
+    # @return [List of EmailObject]
+    attr_accessor :emails
+
+    # Full contact name
+    # @return [Name]
+    attr_accessor :name
+
+    # Contact organization information
+    # @return [Org]
+    attr_accessor :org
+
+    # Contact phone number(s)
+    # @return [List of PhoneObject]
+    attr_accessor :phones
+
+    # Contact URL(s)
+    # @return [List of UrlObject]
+    attr_accessor :urls
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['addresses'] = 'addresses'
+      @_hash['birthday'] = 'birthday'
+      @_hash['emails'] = 'emails'
+      @_hash['name'] = 'name'
+      @_hash['org'] = 'org'
+      @_hash['phones'] = 'phones'
+      @_hash['urls'] = 'urls'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        addresses
+        birthday
+        emails
+        org
+        phones
+        urls
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(name = nil,
+                   addresses = nil,
+                   birthday = 'YYYY-MM-DD formatted string.',
+                   emails = nil,
+                   org = nil,
+                   phones = nil,
+                   urls = nil)
+      @addresses = addresses unless addresses == SKIP
+      @birthday = birthday unless birthday == SKIP
+      @emails = emails unless emails == SKIP
+      @name = name unless name == SKIP
+      @org = org unless org == SKIP
+      @phones = phones unless phones == SKIP
+      @urls = urls unless urls == 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 = Name.from_hash(hash['name']) if hash['name']
+      # Parameter is an array, so we need to iterate through it
+      addresses = nil
+      unless hash['addresses'].nil?
+        addresses = []
+        hash['addresses'].each do |structure|
+          addresses << (Address.from_hash(structure) if structure)
+        end
+      end
+
+      addresses = SKIP unless hash.key?('addresses')
+      birthday = hash['birthday'] ||= 'YYYY-MM-DD formatted string.'
+      # Parameter is an array, so we need to iterate through it
+      emails = nil
+      unless hash['emails'].nil?
+        emails = []
+        hash['emails'].each do |structure|
+          emails << (EmailObject.from_hash(structure) if structure)
+        end
+      end
+
+      emails = SKIP unless hash.key?('emails')
+      org = Org.from_hash(hash['org']) if hash['org']
+      # Parameter is an array, so we need to iterate through it
+      phones = nil
+      unless hash['phones'].nil?
+        phones = []
+        hash['phones'].each do |structure|
+          phones << (PhoneObject.from_hash(structure) if structure)
+        end
+      end
+
+      phones = SKIP unless hash.key?('phones')
+      # Parameter is an array, so we need to iterate through it
+      urls = nil
+      unless hash['urls'].nil?
+        urls = []
+        hash['urls'].each do |structure|
+          urls << (UrlObject.from_hash(structure) if structure)
+        end
+      end
+
+      urls = SKIP unless hash.key?('urls')
+
+      # Create object from extracted values.
+      Contact.new(name,
+                  addresses,
+                  birthday,
+                  emails,
+                  org,
+                  phones,
+                  urls)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/content_type_enum.rb

@@ -0,0 +1,14 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Content-Type.
+  class ContentTypeEnum
+    CONTENT_TYPE_ENUM = [
+      # TODO: Write general description for ENUM_APPLICATIONJSON
+      ENUM_APPLICATIONJSON = 'application/json'.freeze
+    ].freeze
+  end
+end

data/lib/whats_app_cloud_api/models/currency.rb

@@ -0,0 +1,67 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Currency Model.
+  class Currency < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Default text if localization fails.
+    # @return [String]
+    attr_accessor :fallback_value
+
+    # Currency code as defined in ISO 4217.
+    # @return [String]
+    attr_accessor :code
+
+    # Amount multiplied by 1000.
+    # @return [Integer]
+    attr_accessor :amount_1000
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fallback_value'] = 'fallback_value'
+      @_hash['code'] = 'code'
+      @_hash['amount_1000'] = 'amount_1000'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      []
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(fallback_value = nil,
+                   code = nil,
+                   amount_1000 = nil)
+      @fallback_value = fallback_value unless fallback_value == SKIP
+      @code = code unless code == SKIP
+      @amount_1000 = amount_1000 unless amount_1000 == 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.
+      fallback_value =
+        hash.key?('fallback_value') ? hash['fallback_value'] : SKIP
+      code = hash.key?('code') ? hash['code'] : SKIP
+      amount_1000 = hash.key?('amount_1000') ? hash['amount_1000'] : SKIP
+
+      # Create object from extracted values.
+      Currency.new(fallback_value,
+                   code,
+                   amount_1000)
+    end
+  end
+end