=begin #Brevo API #Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | OpenAPI spec version: 3.0.0 Contact: contact@brevo.com Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.19 =end require 'uri' module Brevo class WhatsAppCampaignsApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Set custom user_agent if explicitly passed in api # default will still remain Swagger-Codegen/#{VERSION}/ruby def setUserAgent(user_agent) @user_agent = user_agent if user_agent.is_a?(String) && user_agent.downcase.start_with?('brevo_') @api_client.default_headers['User-Agent'] = @user_agent end end # Create and Send a WhatsApp campaign # @param whats_app_campaigns Values to create a campaign # @param [Hash] opts the optional parameters # @return [CreateModel] def create_whats_app_campaign(whats_app_campaigns, opts = {}) data, _status_code, _headers = create_whats_app_campaign_with_http_info(whats_app_campaigns, opts) data end # Create and Send a WhatsApp campaign # @param whats_app_campaigns Values to create a campaign # @param [Hash] opts the optional parameters # @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers def create_whats_app_campaign_with_http_info(whats_app_campaigns, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.create_whats_app_campaign ...' end # verify the required parameter 'whats_app_campaigns' is set if @api_client.config.client_side_validation && whats_app_campaigns.nil? fail ArgumentError, "Missing the required parameter 'whats_app_campaigns' when calling WhatsAppCampaignsApi.create_whats_app_campaign" end # resource path local_var_path = '/whatsappCampaigns' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(whats_app_campaigns) auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CreateModel') if @api_client.config.debugging @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#create_whats_app_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Create a WhatsApp template # @param whats_app_templates Values to create a template # @param [Hash] opts the optional parameters # @return [CreateModel] def create_whats_app_template(whats_app_templates, opts = {}) data, _status_code, _headers = create_whats_app_template_with_http_info(whats_app_templates, opts) data end # Create a WhatsApp template # @param whats_app_templates Values to create a template # @param [Hash] opts the optional parameters # @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers def create_whats_app_template_with_http_info(whats_app_templates, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.create_whats_app_template ...' end # verify the required parameter 'whats_app_templates' is set if @api_client.config.client_side_validation && whats_app_templates.nil? fail ArgumentError, "Missing the required parameter 'whats_app_templates' when calling WhatsAppCampaignsApi.create_whats_app_template" end # resource path local_var_path = '/whatsppCampaigns/template' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(whats_app_templates) auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CreateModel') if @api_client.config.debugging @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#create_whats_app_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Delete a WhatsApp campaign # @param campaign_id id of the campaign # @param [Hash] opts the optional parameters # @return [nil] def delete_whats_app_campaign(campaign_id, opts = {}) delete_whats_app_campaign_with_http_info(campaign_id, opts) nil end # Delete a WhatsApp campaign # @param campaign_id id of the campaign # @param [Hash] opts the optional parameters # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers def delete_whats_app_campaign_with_http_info(campaign_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.delete_whats_app_campaign ...' end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling WhatsAppCampaignsApi.delete_whats_app_campaign" end # resource path local_var_path = '/whatsappCampaigns/{campaignId}'.sub('{' + 'campaignId' + '}', campaign_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#delete_whats_app_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get a WhatsApp campaign # @param campaign_id Id of the campaign # @param [Hash] opts the optional parameters # @return [GetWhatsappCampaignOverview] def get_whats_app_campaign(campaign_id, opts = {}) data, _status_code, _headers = get_whats_app_campaign_with_http_info(campaign_id, opts) data end # Get a WhatsApp campaign # @param campaign_id Id of the campaign # @param [Hash] opts the optional parameters # @return [Array<(GetWhatsappCampaignOverview, Fixnum, Hash)>] GetWhatsappCampaignOverview data, response status code and response headers def get_whats_app_campaign_with_http_info(campaign_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.get_whats_app_campaign ...' end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling WhatsAppCampaignsApi.get_whats_app_campaign" end # resource path local_var_path = '/whatsappCampaigns/{campaignId}'.sub('{' + 'campaignId' + '}', campaign_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GetWhatsappCampaignOverview') if @api_client.config.debugging @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#get_whats_app_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Return all your created WhatsApp campaigns # @param [Hash] opts the optional parameters # @option opts [String] :start_date **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** # @option opts [String] :end_date **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** # @option opts [Integer] :limit Number of documents per page (default to 50) # @option opts [Integer] :offset Index of the first document in the page (default to 0) # @option opts [String] :sort Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed (default to desc) # @return [GetWhatsappCampaigns] def get_whats_app_campaigns(opts = {}) data, _status_code, _headers = get_whats_app_campaigns_with_http_info(opts) data end # Return all your created WhatsApp campaigns # @param [Hash] opts the optional parameters # @option opts [String] :start_date **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** # @option opts [String] :end_date **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** # @option opts [Integer] :limit Number of documents per page # @option opts [Integer] :offset Index of the first document in the page # @option opts [String] :sort Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed # @return [Array<(GetWhatsappCampaigns, Fixnum, Hash)>] GetWhatsappCampaigns data, response status code and response headers def get_whats_app_campaigns_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.get_whats_app_campaigns ...' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling WhatsAppCampaignsApi.get_whats_app_campaigns, must be smaller than or equal to 100.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling WhatsAppCampaignsApi.get_whats_app_campaigns, must be greater than or equal to 0.' end if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort']) fail ArgumentError, 'invalid value for "sort", must be one of asc, desc' end # resource path local_var_path = '/whatsappCampaigns' # query parameters query_params = {} query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil? query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GetWhatsappCampaigns') if @api_client.config.debugging @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#get_whats_app_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get your WhatsApp API account information # @param [Hash] opts the optional parameters # @return [GetWhatsAppConfig] def get_whats_app_config(opts = {}) data, _status_code, _headers = get_whats_app_config_with_http_info(opts) data end # Get your WhatsApp API account information # @param [Hash] opts the optional parameters # @return [Array<(GetWhatsAppConfig, Fixnum, Hash)>] GetWhatsAppConfig data, response status code and response headers def get_whats_app_config_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.get_whats_app_config ...' end # resource path local_var_path = '/whatsappCampaigns/config' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GetWhatsAppConfig') if @api_client.config.debugging @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#get_whats_app_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Return all your created WhatsApp templates # @param [Hash] opts the optional parameters # @option opts [String] :start_date **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** # @option opts [String] :end_date **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** # @option opts [Integer] :limit Number of documents per page (default to 50) # @option opts [Integer] :offset Index of the first document in the page (default to 0) # @option opts [String] :sort Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed (default to desc) # @option opts [String] :source source of the template # @return [GetWATemplates] def get_whats_app_templates(opts = {}) data, _status_code, _headers = get_whats_app_templates_with_http_info(opts) data end # Return all your created WhatsApp templates # @param [Hash] opts the optional parameters # @option opts [String] :start_date **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** # @option opts [String] :end_date **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** # @option opts [Integer] :limit Number of documents per page # @option opts [Integer] :offset Index of the first document in the page # @option opts [String] :sort Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed # @option opts [String] :source source of the template # @return [Array<(GetWATemplates, Fixnum, Hash)>] GetWATemplates data, response status code and response headers def get_whats_app_templates_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.get_whats_app_templates ...' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling WhatsAppCampaignsApi.get_whats_app_templates, must be smaller than or equal to 100.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling WhatsAppCampaignsApi.get_whats_app_templates, must be greater than or equal to 0.' end if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort']) fail ArgumentError, 'invalid value for "sort", must be one of asc, desc' end if @api_client.config.client_side_validation && opts[:'source'] && !['Automation', 'Conversations'].include?(opts[:'source']) fail ArgumentError, 'invalid value for "source", must be one of Automation, Conversations' end # resource path local_var_path = '/whatsappCampaigns/template-list' # query parameters query_params = {} query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil? query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GetWATemplates') if @api_client.config.debugging @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#get_whats_app_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Send your WhatsApp template for approval # @param template_id id of the campaign # @param [Hash] opts the optional parameters # @return [nil] def send_whats_app_template_approval(template_id, opts = {}) send_whats_app_template_approval_with_http_info(template_id, opts) nil end # Send your WhatsApp template for approval # @param template_id id of the campaign # @param [Hash] opts the optional parameters # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers def send_whats_app_template_approval_with_http_info(template_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.send_whats_app_template_approval ...' end # verify the required parameter 'template_id' is set if @api_client.config.client_side_validation && template_id.nil? fail ArgumentError, "Missing the required parameter 'template_id' when calling WhatsAppCampaignsApi.send_whats_app_template_approval" end # resource path local_var_path = '/whatsappCampaigns/template/approval/{templateId}'.sub('{' + 'templateId' + '}', template_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#send_whats_app_template_approval\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Update a WhatsApp campaign # @param campaign_id Id of the campaign # @param [Hash] opts the optional parameters # @option opts [UpdateWhatsAppCampaign] :whats_app_campaign values to update WhatsApp Campaign # @return [nil] def update_whats_app_campaign(campaign_id, opts = {}) update_whats_app_campaign_with_http_info(campaign_id, opts) nil end # Update a WhatsApp campaign # @param campaign_id Id of the campaign # @param [Hash] opts the optional parameters # @option opts [UpdateWhatsAppCampaign] :whats_app_campaign values to update WhatsApp Campaign # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers def update_whats_app_campaign_with_http_info(campaign_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.update_whats_app_campaign ...' end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling WhatsAppCampaignsApi.update_whats_app_campaign" end # resource path local_var_path = '/whatsappCampaigns/{campaignId}'.sub('{' + 'campaignId' + '}', campaign_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'whats_app_campaign']) auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#update_whats_app_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end