whatsapp-ruby-sdk 1.0.0

data/lib/whats_app_cloud_api/models/parameter.rb

@@ -0,0 +1,113 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Parameter Model.
+  class Parameter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Describes the parameter type. For text-based templates, the only supported
+    # parameter types are text, currency, date_time.
+    # @return [ParameterTypeEnum]
+    attr_accessor :type
+
+    # Required when type=text. The message’s text. For the header component, the
+    # character limit is 60 characters. For the body component, the character
+    # limit is 1024 characters.
+    # @return [String]
+    attr_accessor :text
+
+    # Required when type=currency.
+    # @return [Currency]
+    attr_accessor :currency
+
+    # Required when type=date_time.
+    # @return [DateTimeObject]
+    attr_accessor :date_time
+
+    # Required when type=image.
+    # @return [Image]
+    attr_accessor :image
+
+    # Required when type=document. Only PDF documents are supported for
+    # media-based message templates.
+    # @return [Document]
+    attr_accessor :document
+
+    # 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['type'] = 'type'
+      @_hash['text'] = 'text'
+      @_hash['currency'] = 'currency'
+      @_hash['date_time'] = 'date_time'
+      @_hash['image'] = 'image'
+      @_hash['document'] = 'document'
+      @_hash['video'] = 'video'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        text
+        currency
+        date_time
+        image
+        document
+        video
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(type = nil,
+                   text = nil,
+                   currency = nil,
+                   date_time = nil,
+                   image = nil,
+                   document = nil,
+                   video = nil)
+      @type = type unless type == SKIP
+      @text = text unless text == SKIP
+      @currency = currency unless currency == SKIP
+      @date_time = date_time unless date_time == SKIP
+      @image = image unless image == SKIP
+      @document = document unless document == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      text = hash.key?('text') ? hash['text'] : SKIP
+      currency = Currency.from_hash(hash['currency']) if hash['currency']
+      date_time = DateTimeObject.from_hash(hash['date_time']) if hash['date_time']
+      image = Image.from_hash(hash['image']) if hash['image']
+      document = Document.from_hash(hash['document']) if hash['document']
+      video = Video.from_hash(hash['video']) if hash['video']
+
+      # Create object from extracted values.
+      Parameter.new(type,
+                    text,
+                    currency,
+                    date_time,
+                    image,
+                    document,
+                    video)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/parameter_type_enum.rb

@@ -0,0 +1,29 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # ParameterType.
+  class ParameterTypeEnum
+    PARAMETER_TYPE_ENUM = [
+      # TODO: Write general description for TEXT
+      TEXT = 'text'.freeze,
+
+      # TODO: Write general description for CURRENCY
+      CURRENCY = 'currency'.freeze,
+
+      # TODO: Write general description for DATE_TIME
+      DATE_TIME = 'date_time'.freeze,
+
+      # TODO: Write general description for IMAGE
+      IMAGE = 'image'.freeze,
+
+      # TODO: Write general description for DOCUMENT
+      DOCUMENT = 'document'.freeze,
+
+      # TODO: Write general description for VIDEO
+      VIDEO = 'video'.freeze
+    ].freeze
+  end
+end

data/lib/whats_app_cloud_api/models/personal_information_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
+  # PersonalInformationType.
+  class PersonalInformationTypeEnum
+    PERSONAL_INFORMATION_TYPE_ENUM = [
+      # TODO: Write general description for HOME
+      HOME = 'HOME'.freeze,
+
+      # TODO: Write general description for WORK
+      WORK = 'WORK'.freeze
+    ].freeze
+  end
+end

data/lib/whats_app_cloud_api/models/phone_object.rb

@@ -0,0 +1,70 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # PhoneObject Model.
+  class PhoneObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Automatically populated with the wa_id value as a formatted phone number.
+    # @return [String]
+    attr_accessor :phone
+
+    # WhatsApp ID.
+    # @return [String]
+    attr_accessor :wa_id
+
+    # WhatsApp ID.
+    # @return [PhoneTypeEnum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['phone'] = 'phone'
+      @_hash['wa_id'] = 'wa_id'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        phone
+        wa_id
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(phone = nil,
+                   wa_id = nil,
+                   type = nil)
+      @phone = phone unless phone == SKIP
+      @wa_id = wa_id unless wa_id == 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.
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      wa_id = hash.key?('wa_id') ? hash['wa_id'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+
+      # Create object from extracted values.
+      PhoneObject.new(phone,
+                      wa_id,
+                      type)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/phone_type_enum.rb

@@ -0,0 +1,26 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # PhoneType.
+  class PhoneTypeEnum
+    PHONE_TYPE_ENUM = [
+      # TODO: Write general description for HOME
+      HOME = 'HOME'.freeze,
+
+      # TODO: Write general description for WORK
+      WORK = 'WORK'.freeze,
+
+      # TODO: Write general description for CELL
+      CELL = 'CELL'.freeze,
+
+      # TODO: Write general description for MAIN
+      MAIN = 'MAIN'.freeze,
+
+      # TODO: Write general description for IPHONE
+      IPHONE = 'IPHONE'.freeze
+    ].freeze
+  end
+end

data/lib/whats_app_cloud_api/models/quality_rating_enum.rb

@@ -0,0 +1,25 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # For more information relating to quality rating, see [About WhatsApp
+  # Business Account Message Quality
+  # Rating](https://www.facebook.com/business/help/896873687365001).
+  class QualityRatingEnum
+    QUALITY_RATING_ENUM = [
+      # High Quality.
+      GREEN = 'GREEN'.freeze,
+
+      # Medium Quality.
+      YELLOW = 'YELLOW'.freeze,
+
+      # Low Quality.
+      RED = 'RED'.freeze,
+
+      # Quality has not been determined.
+      NA = 'NA'.freeze
+    ].freeze
+  end
+end

data/lib/whats_app_cloud_api/models/register_phone_request.rb

@@ -0,0 +1,58 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # RegisterPhoneRequest Model.
+  class RegisterPhoneRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Messaging service used. In this case, use "whatsapp".
+    # @return [String]
+    attr_accessor :messaging_product
+
+    # A 6-digit pin you have previously set up - See Set Two-Step Verification.
+    # @return [String]
+    attr_accessor :pin
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['messaging_product'] = 'messaging_product'
+      @_hash['pin'] = 'pin'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      []
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(messaging_product = nil,
+                   pin = nil)
+      @messaging_product = messaging_product unless messaging_product == SKIP
+      @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.
+      messaging_product =
+        hash.key?('messaging_product') ? hash['messaging_product'] : SKIP
+      pin = hash.key?('pin') ? hash['pin'] : SKIP
+
+      # Create object from extracted values.
+      RegisterPhoneRequest.new(messaging_product,
+                               pin)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/request_verification_code_method_enum.rb

@@ -0,0 +1,17 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # RequestVerificationCodeMethod.
+  class RequestVerificationCodeMethodEnum
+    REQUEST_VERIFICATION_CODE_METHOD_ENUM = [
+      # TODO: Write general description for SMS
+      SMS = 'SMS'.freeze,
+
+      # TODO: Write general description for VOICE
+      VOICE = 'VOICE'.freeze
+    ].freeze
+  end
+end

data/lib/whats_app_cloud_api/models/request_verification_code_request.rb

@@ -0,0 +1,57 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # RequestVerificationCodeRequest Model.
+  class RequestVerificationCodeRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Chosen method for verification.
+    # @return [RequestVerificationCodeMethodEnum]
+    attr_accessor :code_method
+
+    # Your locale. For example: "en_US".
+    # @return [String]
+    attr_accessor :locale
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code_method'] = 'code_method'
+      @_hash['locale'] = 'locale'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      []
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(code_method = nil,
+                   locale = nil)
+      @code_method = code_method unless code_method == SKIP
+      @locale = locale unless locale == 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_method = hash.key?('code_method') ? hash['code_method'] : SKIP
+      locale = hash.key?('locale') ? hash['locale'] : SKIP
+
+      # Create object from extracted values.
+      RequestVerificationCodeRequest.new(code_method,
+                                         locale)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/response_contact.rb

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

data/lib/whats_app_cloud_api/models/response_message.rb

@@ -0,0 +1,48 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # ResponseMessage Model.
+  class ResponseMessage < 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.
+      ResponseMessage.new(id)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/retrieve_media_url_response.rb

@@ -0,0 +1,94 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # RetrieveMediaURLResponse Model.
+  class RetrieveMediaURLResponse < 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 [String]
+    attr_accessor :url
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :mime_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :sha256
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :file_size
+
+    # 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['messaging_product'] = 'messaging_product'
+      @_hash['url'] = 'url'
+      @_hash['mime_type'] = 'mime_type'
+      @_hash['sha256'] = 'sha256'
+      @_hash['file_size'] = 'file_size'
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      []
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(messaging_product = nil,
+                   url = nil,
+                   mime_type = nil,
+                   sha256 = nil,
+                   file_size = nil,
+                   id = nil)
+      @messaging_product = messaging_product unless messaging_product == SKIP
+      @url = url unless url == SKIP
+      @mime_type = mime_type unless mime_type == SKIP
+      @sha256 = sha256 unless sha256 == SKIP
+      @file_size = file_size unless file_size == 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.
+      messaging_product =
+        hash.key?('messaging_product') ? hash['messaging_product'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+      mime_type = hash.key?('mime_type') ? hash['mime_type'] : SKIP
+      sha256 = hash.key?('sha256') ? hash['sha256'] : SKIP
+      file_size = hash.key?('file_size') ? hash['file_size'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+
+      # Create object from extracted values.
+      RetrieveMediaURLResponse.new(messaging_product,
+                                   url,
+                                   mime_type,
+                                   sha256,
+                                   file_size,
+                                   id)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/row.rb

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