whatsapp-ruby-sdk 1.0.0

data/lib/whats_app_cloud_api/controllers/business_profiles_controller.rb

@@ -0,0 +1,94 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # BusinessProfilesController
+  class BusinessProfilesController < BaseController
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Use this endpoint to update your business’ profile information such as the
+    # business description, email or address.
+    # @param [String] phone_number_id Required parameter: Example:
+    # @param [UpdateBusinessProfileRequest] body Required parameter: Example:
+    # @return [SuccessResponse] response from the API call
+    def update_business_profile(phone_number_id,
+                                body)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/{Phone-Number-ID}/whatsapp_business_profile'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'Phone-Number-ID' => { 'value' => phone_number_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      SuccessResponse.from_hash(decoded)
+    end
+
+    # Use this endpoint to retrieve your business’ profile. This business
+    # profile is visible to consumers in the chat thread next to the profile
+    # photo. The profile information will contain a business profile ID which
+    # you can use to make API calls.
+    # @param [String] phone_number_id Required parameter: Example:
+    # @param [String] fields Optional parameter: Here you can specify what you
+    # want to know from your business as a comma separated list of fields.
+    # Available fields include: id, about, messaging_product, address,
+    # description, vertical, email, websites, profile_picture_url
+    # @return [GetBusinessProfileIDResponse] response from the API call
+    def get_business_profile_id(phone_number_id,
+                                fields: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/{Phone-Number-ID}/whatsapp_business_profile'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'Phone-Number-ID' => { 'value' => phone_number_id, 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'fields' => fields
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      GetBusinessProfileIDResponse.from_hash(decoded)
+    end
+  end
+end

data/lib/whats_app_cloud_api/controllers/media_controller.rb

@@ -0,0 +1,142 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # MediaController
+  class MediaController < BaseController
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # This endpoint can be used for deleting a media object.
+    # @param [String] media_id Required parameter: Media object ID from either
+    # uploading media endpoint or media message Webhooks
+    # @return [SuccessResponse] response from the API call
+    def delete_media(media_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/{Media-ID}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'Media-ID' => { 'value' => media_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      SuccessResponse.from_hash(decoded)
+    end
+
+    # To retrieve your media’s URL, make a request to this endpoint. Later, you
+    # can use this URL to download the media file.
+    # @param [String] media_id Required parameter: Media object ID from either
+    # uploading media endpoint or media message Webhooks
+    # @return [RetrieveMediaURLResponse] response from the API call
+    def retrieve_media_url(media_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/{Media-ID}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'Media-ID' => { 'value' => media_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      RetrieveMediaURLResponse.from_hash(decoded)
+    end
+
+    # Used to upload media. All media files sent through this endpoint are
+    # encrypted and persist for 30 days.
+    # @param [String] phone_number_id Required parameter: Example:
+    # @param [String] messaging_product Required parameter: Messaging service
+    # used for the request. In this case, use whatsapp.
+    # @param [String] file Required parameter: Path to the file stored in your
+    # local directory. For example: "@/local/path/file.jpg".
+    # @param [String] type Required parameter: Type of media file being
+    # uploaded. See Supported Media Types for more information.    Supported
+    # options for images are: `image/jpeg`, `image/png`    Supported options for
+    # documents are: `text/plain`, `application/pdf`,
+    # `application/vnd.ms-powerpoint`, `application/msword`,
+    # `application/vnd.ms-excel`,
+    # `application/vnd.openxmlformats-officedocument.wordprocessingml.document`,
+    # `application/vnd.openxmlformats-officedocument.presentationml.presentation
+    # `, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` 
+    # Supported options for audio are: `audio/aac`, `audio/mp4`, `audio/mpeg`,
+    # `audio/amr`, `audio/ogg`, `audio/opus`  Supported options for video are:
+    # `video/mp4`, `video/3gp`  Supported options for stickers are:
+    # `image/webp`
+    # @return [UploadMedia] response from the API call
+    def upload_media(phone_number_id,
+                     messaging_product,
+                     file,
+                     type)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/{Phone-Number-ID}/media'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'Phone-Number-ID' => { 'value' => phone_number_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare form parameters.
+      _parameters = {
+        'messaging_product' => messaging_product,
+        'file' => file,
+        'type' => type
+      }
+      _parameters = APIHelper.form_encode_parameters(_parameters)
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: _parameters
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      UploadMedia.from_hash(decoded)
+    end
+  end
+end

data/lib/whats_app_cloud_api/controllers/messages_controller.rb

@@ -0,0 +1,51 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # MessagesController
+  class MessagesController < BaseController
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Use this endpoint to send text messages, media, message templates to your
+    # customers.
+    # @param [String] phone_number_id Required parameter: Example:
+    # @param [Message] body Required parameter: To send a message, you must
+    # first assemble a message object with the content you want to send.
+    # @return [SendMessageResponse] response from the API call
+    def send_message(phone_number_id,
+                     body)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/{Phone-Number-ID}/messages'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'Phone-Number-ID' => { 'value' => phone_number_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      SendMessageResponse.from_hash(decoded)
+    end
+  end
+end

data/lib/whats_app_cloud_api/controllers/phone_numbers_controller.rb

@@ -0,0 +1,141 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # PhoneNumbersController
+  class PhoneNumbersController < BaseController
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Used to verify a phone number's ownership. After you have received a SMS
+    # or Voice request code for verification, you need to verify the code that
+    # was sent to you.
+    # @param [String] phone_number_id Required parameter: Example:
+    # @param [String] code Required parameter: The code you received after
+    # calling FROM_PHONE_NUMBER_ID/request_code.
+    # @return [SuccessResponse] response from the API call
+    def verify_code(phone_number_id,
+                    code)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/{Phone-Number-ID}/verify_code'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'Phone-Number-ID' => { 'value' => phone_number_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare form parameters.
+      _parameters = {
+        'code' => code
+      }
+      _parameters = APIHelper.form_encode_parameters(_parameters)
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: _parameters
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      SuccessResponse.from_hash(decoded)
+    end
+
+    # When you query all the phone numbers for a WhatsApp Business Account, each
+    # phone number has an id. You can directly query for a phone number using
+    # this id.
+    # @param [String] phone_number_id Required parameter: Example:
+    # @return [GetPhoneNumberByIDResponse] response from the API call
+    def get_phone_number_by_id(phone_number_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/{Phone-Number-ID}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'Phone-Number-ID' => { 'value' => phone_number_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      GetPhoneNumberByIDResponse.from_hash(decoded)
+    end
+
+    # Used to request a code to verify a phone number's ownership. You need to
+    # verify the phone number you want to use to send messages to your
+    # customers. Phone numbers must be verified through SMS/voice call. The
+    # verification process can be done through the Graph API calls specified
+    # below.
+    # @param [String] phone_number_id Required parameter: Example:
+    # @param [RequestVerificationCodeMethodEnum] code_method Required parameter:
+    # Chosen method for verification.
+    # @param [String] locale Required parameter: Your locale. For example:
+    # "en_US".
+    # @return [SuccessResponse] response from the API call
+    def request_verification_code(phone_number_id,
+                                  code_method,
+                                  locale)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/{Phone-Number-ID}/request_code'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'Phone-Number-ID' => { 'value' => phone_number_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare form parameters.
+      _parameters = {
+        'code_method' => code_method,
+        'locale' => locale
+      }
+      _parameters = APIHelper.form_encode_parameters(_parameters)
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: _parameters
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      SuccessResponse.from_hash(decoded)
+    end
+  end
+end

data/lib/whats_app_cloud_api/controllers/registration_controller.rb

@@ -0,0 +1,91 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # RegistrationController
+  class RegistrationController < BaseController
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Used to register a phone number or to migrate WhatsApp Business Accounts
+    # from a current On-Premises deployment to the new Cloud-Based API. Business
+    # Solution Providers (BSPs) must authenticate themselves with an access
+    # token with the whatsapp_business_management permission.
+    # @param [String] phone_number_id Required parameter: Example:
+    # @param [RegisterPhoneRequest] body Required parameter: Example:
+    # @return [SuccessResponse] response from the API call
+    def register_phone(phone_number_id,
+                       body)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/{Phone-Number-ID}/register'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'Phone-Number-ID' => { 'value' => phone_number_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      SuccessResponse.from_hash(decoded)
+    end
+
+    # Used to deregister a phone number. Deregister phone removes a previously
+    # registered phone. You can always re-register your phone using by repeating
+    # the registration process. Business Solution Providers (BSPs) must
+    # authenticate themselves with an access token with the
+    # whatsapp_business_management permission.
+    # @param [ContentTypeEnum] content_type Required parameter: Example:
+    # @param [String] phone_number_id Required parameter: Example:
+    # @return [SuccessResponse] response from the API call
+    def deregister_phone(content_type,
+                         phone_number_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/{Phone-Number-ID}/deregister'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'Phone-Number-ID' => { 'value' => phone_number_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => content_type
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      SuccessResponse.from_hash(decoded)
+    end
+  end
+end

data/lib/whats_app_cloud_api/controllers/two_step_verification_controller.rb

@@ -0,0 +1,57 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # TwoStepVerificationController
+  class TwoStepVerificationController < BaseController
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # You are required to set up two-step verification for your phone number, as
+    # this provides an extra layer of security to the business accounts. You can
+    # use this endpoint to change two-step verification code associated with
+    # your account.
+    # After you change the verification code, future requests like changing the
+    # name, must use the new code.
+    # You set up two-factor verification and register a phone number in the same
+    # API call.
+    # @param [String] phone_number_id Required parameter: Example:
+    # @param [SetTwoStepVerificationCodeRequest] body Required parameter:
+    # Example:
+    # @return [SuccessResponse] response from the API call
+    def set_two_step_verification_code(phone_number_id,
+                                       body)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/{Phone-Number-ID}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'Phone-Number-ID' => { 'value' => phone_number_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      SuccessResponse.from_hash(decoded)
+    end
+  end
+end

data/lib/whats_app_cloud_api/exceptions/api_exception.rb

@@ -0,0 +1,20 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < StandardError
+    attr_reader :response, :response_code
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason)
+      @response = response
+      @response_code = response.status_code
+    end
+  end
+end

data/lib/whats_app_cloud_api/http/auth/o_auth2.rb

@@ -0,0 +1,17 @@
+# whats_app_cloud_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WhatsAppCloudApi
+  # Utility class for OAuth 2 authorization and token management.
+  class OAuth2
+    # Add OAuth2 authentication to the http request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    def self.apply(config, http_request)
+      token = config.access_token
+      http_request.headers['Authorization'] = "Bearer #{token}"
+    end
+  end
+end