whatsapp-ruby-sdk 1.0.0

data/lib/whats_app_cloud_api/http/faraday_client.rb

@@ -0,0 +1,97 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'faraday/http_cache'
+require 'faraday/retry'
+require 'faraday/multipart'
+require 'faraday/follow_redirects'
+require 'faraday/gzip'
+
+module WhatsAppCloudApi
+  # An implementation of HttpClient.
+  class FaradayClient < HttpClient
+    # The attribute readers for properties.
+    attr_reader :connection
+
+    # The constructor.
+    def initialize(timeout:, max_retries:, retry_interval:,
+                   backoff_factor:, retry_statuses:, retry_methods:,
+                   connection:, adapter:, cache: false, verify: true)
+      @connection = if connection.nil?
+                      create_connection(timeout: timeout, max_retries: max_retries,
+                                        retry_interval: retry_interval, backoff_factor: backoff_factor,
+                                        retry_statuses: retry_statuses, retry_methods: retry_methods,
+                                        adapter: adapter, cache: cache, verify: verify)
+                    else
+                      connection
+                    end
+    end
+
+    # Method to initialize connection.
+    def create_connection(timeout:, max_retries:, retry_interval:,
+                          backoff_factor:, retry_statuses:, retry_methods:,
+                          adapter:, cache: false, verify: true)
+      Faraday.new do |faraday|
+        faraday.use Faraday::HttpCache, serializer: Marshal if cache
+        faraday.use Faraday::FollowRedirects::Middleware
+        faraday.request :gzip
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.ssl[:ca_file] = Certifi.where
+        faraday.ssl[:verify] = verify
+        faraday.request :retry, max: max_retries, interval: retry_interval,
+                                backoff_factor: backoff_factor,
+                                retry_statuses: retry_statuses,
+                                methods: retry_methods,
+                                retry_if: proc { |env, _exc|
+                                            env.request.context['forced_retry'] ||= false
+                                          }
+        faraday.adapter adapter
+        faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
+        faraday.options[:timeout] = timeout if timeout.positive?
+      end
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_string(http_request)
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
+        request.headers = http_request.headers.map { |k, v| [k.to_s, v.to_s] }
+        request.options.context ||= {}
+        request.options.context.merge!(http_request.context)
+        unless http_request.http_method == HttpMethodEnum::GET &&
+               http_request.parameters.empty?
+          request.body = http_request.parameters
+        end
+      end
+      convert_response(response, http_request)
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_binary(http_request)
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
+        request.headers = http_request.headers
+        request.options.context ||= {}
+        request.options.context.merge!(http_request.context)
+        unless http_request.http_method == HttpMethodEnum::GET &&
+               http_request.parameters.empty?
+          request.body = http_request.parameters
+        end
+      end
+      convert_response(response, http_request)
+    end
+
+    # Method overridden from HttpClient.
+    def convert_response(response, http_request)
+      HttpResponse.new(response.status, response.reason_phrase,
+                       response.headers, response.body, http_request)
+    end
+  end
+end

data/lib/whats_app_cloud_api/http/http_call_back.rb

@@ -0,0 +1,24 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack
+    # A controller will call this method before making an HTTP Request.
+    # @param [HttpRequest] The HttpRequest object which the HttpClient
+    # will execute.
+    def on_before_request(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # A controller will call this method after making an HTTP Request.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def on_after_response(_http_response)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+  end
+end

data/lib/whats_app_cloud_api/http/http_client.rb

@@ -0,0 +1,123 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # An interface for the methods that an HTTP Client must implement.
+  #
+  # This class should not be instantiated but should be used as a base class
+  # for HTTP Client classes.
+  class HttpClient
+    # Execute an HttpRequest when the response is expected to be a string.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_string(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Execute an HttpRequest when the response is expected to be binary.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_binary(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Converts the HTTP Response from the client to an HttpResponse object.
+    # @param [Dynamic] The response object received from the client.
+    def convert_response(_response)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Get a GET HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
+    def get(query_url,
+            headers: {},
+            context: {})
+      HttpRequest.new(HttpMethodEnum::GET,
+                      query_url,
+                      headers: headers,
+                      context: context)
+    end
+
+    # Get a HEAD HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
+    def head(query_url,
+             headers: {},
+             context: {})
+      HttpRequest.new(HttpMethodEnum::HEAD,
+                      query_url,
+                      headers: headers,
+                      context: context)
+    end
+
+    # Get a POST HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
+    def post(query_url,
+             headers: {},
+             parameters: {},
+             context: {})
+      HttpRequest.new(HttpMethodEnum::POST,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters,
+                      context: context)
+    end
+
+    # Get a PUT HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
+    def put(query_url,
+            headers: {},
+            parameters: {},
+            context: {})
+      HttpRequest.new(HttpMethodEnum::PUT,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters,
+                      context: context)
+    end
+
+    # Get a PATCH HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
+    def patch(query_url,
+              headers: {},
+              parameters: {},
+              context: {})
+      HttpRequest.new(HttpMethodEnum::PATCH,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters,
+                      context: context)
+    end
+
+    # Get a DELETE HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
+    def delete(query_url,
+               headers: {},
+               parameters: {},
+               context: {})
+      HttpRequest.new(HttpMethodEnum::DELETE,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters,
+                      context: context)
+    end
+  end
+end

data/lib/whats_app_cloud_api/http/http_method_enum.rb

@@ -0,0 +1,13 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum
+    HTTPMETHODENUM = [GET = 'GET'.freeze, POST = 'POST'.freeze,
+                      PUT = 'PUT'.freeze, PATCH = 'PATCH'.freeze,
+                      DELETE = 'DELETE'.freeze, HEAD = 'HEAD'.freeze].freeze
+  end
+end

data/lib/whats_app_cloud_api/http/http_request.rb

@@ -0,0 +1,54 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Represents a single Http Request.
+  class HttpRequest
+    attr_accessor :http_method, :query_url, :headers,
+                  :parameters, :username, :password,
+                  :context
+
+    # The constructor.
+    # @param [HttpMethodEnum] The HTTP method.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
+    def initialize(http_method,
+                   query_url,
+                   headers: {},
+                   parameters: {},
+                   context: {})
+      @http_method = http_method
+      @query_url = query_url
+      @headers = headers
+      @parameters = parameters
+      @context = context
+    end
+
+    # Add a header to the HttpRequest.
+    # @param [String] The name of the header.
+    # @param [String] The value of the header.
+    def add_header(name, value)
+      @headers[name] = value
+    end
+
+    # Add a parameter to the HttpRequest.
+    # @param [String] The name of the parameter.
+    # @param [String] The value of the parameter.
+    def add_parameter(name, value)
+      @parameters[name] = value
+    end
+
+    # Add a query parameter to the HttpRequest.
+    # @param [String] The name of the query parameter.
+    # @param [String] The value of the query parameter.
+    def add_query_parameter(name, value)
+      @query_url = APIHelper.append_url_with_query_parameters(@query_url,
+                                                              name => value)
+      @query_url = APIHelper.clean_url(@query_url)
+    end
+  end
+end

data/lib/whats_app_cloud_api/http/http_response.rb

@@ -0,0 +1,29 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Http response received.
+  class HttpResponse
+    attr_reader :status_code, :reason_phrase, :headers, :raw_body, :request
+
+    # The constructor
+    # @param [Integer] The status code returned by the server.
+    # @param [String] The reason phrase returned by the server.
+    # @param [Hash] The headers sent by the server in the response.
+    # @param [String] The raw body of the response.
+    # @param [HttpRequest] The request that resulted in this response.
+    def initialize(status_code,
+                   reason_phrase,
+                   headers,
+                   raw_body,
+                   request)
+      @status_code = status_code
+      @reason_phrase = reason_phrase
+      @headers = headers
+      @raw_body = raw_body
+      @request = request
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/action.rb

@@ -0,0 +1,91 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Action Model.
+  class Action < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Required for List Messages. Button content. It cannot be an empty string
+    # and must be unique within the message. Emojis are supported, markdown is
+    # not.
+    # @return [String]
+    attr_accessor :button
+
+    # Required for Reply Buttons. You can have up to 3 buttons. You cannot have
+    # leading or trailing spaces when setting the ID.
+    # @return [List of Button]
+    attr_accessor :buttons
+
+    # Required for List Messages.
+    # @return [List of Section]
+    attr_accessor :sections
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['button'] = 'button'
+      @_hash['buttons'] = 'buttons'
+      @_hash['sections'] = 'sections'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        button
+        buttons
+        sections
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(button = nil,
+                   buttons = nil,
+                   sections = nil)
+      @button = button unless button == SKIP
+      @buttons = buttons unless buttons == SKIP
+      @sections = sections unless sections == 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.
+      button = hash.key?('button') ? hash['button'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      buttons = nil
+      unless hash['buttons'].nil?
+        buttons = []
+        hash['buttons'].each do |structure|
+          buttons << (Button.from_hash(structure) if structure)
+        end
+      end
+
+      buttons = SKIP unless hash.key?('buttons')
+      # Parameter is an array, so we need to iterate through it
+      sections = nil
+      unless hash['sections'].nil?
+        sections = []
+        hash['sections'].each do |structure|
+          sections << (Section.from_hash(structure) if structure)
+        end
+      end
+
+      sections = SKIP unless hash.key?('sections')
+
+      # Create object from extracted values.
+      Action.new(button,
+                 buttons,
+                 sections)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/address.rb

@@ -0,0 +1,110 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Address Model.
+  class Address < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Street number and name
+    # @return [String]
+    attr_accessor :street
+
+    # City name.
+    # @return [String]
+    attr_accessor :city
+
+    # State abbreviation.
+    # @return [String]
+    attr_accessor :state
+
+    # ZIP code.
+    # @return [String]
+    attr_accessor :zip
+
+    # Full country name.
+    # @return [String]
+    attr_accessor :country
+
+    # Two-letter country abbreviation.
+    # @return [String]
+    attr_accessor :country_code
+
+    # Two-letter country abbreviation.
+    # @return [PersonalInformationTypeEnum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['street'] = 'street'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['zip'] = 'zip'
+      @_hash['country'] = 'country'
+      @_hash['country_code'] = 'country_code'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        street
+        city
+        state
+        zip
+        country
+        country_code
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(street = nil,
+                   city = nil,
+                   state = nil,
+                   zip = nil,
+                   country = nil,
+                   country_code = nil,
+                   type = nil)
+      @street = street unless street == SKIP
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @zip = zip unless zip == SKIP
+      @country = country unless country == SKIP
+      @country_code = country_code unless country_code == 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.
+      street = hash.key?('street') ? hash['street'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      zip = hash.key?('zip') ? hash['zip'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+
+      # Create object from extracted values.
+      Address.new(street,
+                  city,
+                  state,
+                  zip,
+                  country,
+                  country_code,
+                  type)
+    end
+  end
+end

data/lib/whats_app_cloud_api/models/audio.rb

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

data/lib/whats_app_cloud_api/models/base_model.rb

@@ -0,0 +1,58 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Base model.
+  class BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        key = self.class.names.key?(name) ? self.class.names[name] : name
+
+        optional_fields = optionals if respond_to? 'optionals'
+        nullable_fields = nullables if respond_to? 'nullables'
+        if value.nil?
+          next unless nullable_fields.include?(name)
+
+          if !optional_fields.include?(name) && !nullable_fields.include?(name)
+            raise ArgumentError,
+                  "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+          end
+        end
+
+        hash[key] = nil
+        unless value.nil?
+          if respond_to?("to_#{name}")
+            if (value.instance_of? Array) || (value.instance_of? Hash)
+              params = [hash, key]
+              hash[key] = send("to_#{name}", *params)
+            else
+              hash[key] = send("to_#{name}")
+            end
+          elsif value.instance_of? Array
+            hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+          elsif value.instance_of? Hash
+            hash[key] = {}
+            value.each do |k, v|
+              hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+            end
+          else
+            hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+          end
+        end
+      end
+      hash
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+end