class SibApiV3Sdk::SMSCampaignsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

create_sms_campaign(create_sms_campaign, opts = {}) click to toggle source

Creates an SMS campaign @param create_sms_campaign Values to create an SMS Campaign @param [Hash] opts the optional parameters @return [CreateModel]

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 36
def create_sms_campaign(create_sms_campaign, opts = {})
  data, _status_code, _headers = create_sms_campaign_with_http_info(create_sms_campaign, opts)
  data
end
create_sms_campaign_with_http_info(create_sms_campaign, opts = {}) click to toggle source

Creates an SMS campaign @param create_sms_campaign Values to create an SMS Campaign @param [Hash] opts the optional parameters @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 45
def create_sms_campaign_with_http_info(create_sms_campaign, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.create_sms_campaign ...'
  end
  # verify the required parameter 'create_sms_campaign' is set
  if @api_client.config.client_side_validation && create_sms_campaign.nil?
    fail ArgumentError, "Missing the required parameter 'create_sms_campaign' when calling SMSCampaignsApi.create_sms_campaign"
  end
  # resource path
  local_var_path = '/smsCampaigns'

  # 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(create_sms_campaign)
  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: SMSCampaignsApi#create_sms_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_sms_campaign(campaign_id, opts = {}) click to toggle source

Delete an SMS campaign @param campaign_id id of the SMS campaign @param [Hash] opts the optional parameters @return [nil]

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 88
def delete_sms_campaign(campaign_id, opts = {})
  delete_sms_campaign_with_http_info(campaign_id, opts)
  nil
end
delete_sms_campaign_with_http_info(campaign_id, opts = {}) click to toggle source

Delete an SMS campaign @param campaign_id id of the SMS campaign @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 97
def delete_sms_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.delete_sms_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 SMSCampaignsApi.delete_sms_campaign"
  end
  # resource path
  local_var_path = '/smsCampaigns/{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: SMSCampaignsApi#delete_sms_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_sms_campaign(campaign_id, opts = {}) click to toggle source

Get an SMS campaign @param campaign_id id of the SMS campaign @param [Hash] opts the optional parameters @return [GetSmsCampaign]

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 139
def get_sms_campaign(campaign_id, opts = {})
  data, _status_code, _headers = get_sms_campaign_with_http_info(campaign_id, opts)
  data
end
get_sms_campaign_with_http_info(campaign_id, opts = {}) click to toggle source

Get an SMS campaign @param campaign_id id of the SMS campaign @param [Hash] opts the optional parameters @return [Array<(GetSmsCampaign, Fixnum, Hash)>] GetSmsCampaign data, response status code and response headers

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 148
def get_sms_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.get_sms_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 SMSCampaignsApi.get_sms_campaign"
  end
  # resource path
  local_var_path = '/smsCampaigns/{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 => 'GetSmsCampaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SMSCampaignsApi#get_sms_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_sms_campaigns(opts = {}) click to toggle source

Returns the information for all your created SMS campaigns @param [Hash] opts the optional parameters @option opts [String] :status Status of campaign. @option opts [String] :start_date Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either &#39;status&#39; not passed and if passed is set to &#39;sent&#39; ) @option opts [String] :end_date Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either &#39;status&#39; not passed and if passed is set to &#39;sent&#39; ) @option opts [Integer] :limit Number limitation for the result returned (default to 500) @option opts [Integer] :offset Beginning point in the list to retrieve from. (default to 0) @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is descending if &#x60;sort&#x60; is not passed (default to desc) @return [GetSmsCampaigns]

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 196
def get_sms_campaigns(opts = {})
  data, _status_code, _headers = get_sms_campaigns_with_http_info(opts)
  data
end
get_sms_campaigns_with_http_info(opts = {}) click to toggle source

Returns the information for all your created SMS campaigns @param [Hash] opts the optional parameters @option opts [String] :status Status of campaign. @option opts [String] :start_date Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either &#39;status&#39; not passed and if passed is set to &#39;sent&#39; ) @option opts [String] :end_date Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either &#39;status&#39; not passed and if passed is set to &#39;sent&#39; ) @option opts [Integer] :limit Number limitation for the result returned @option opts [Integer] :offset Beginning point in the list to retrieve from. @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is descending if &#x60;sort&#x60; is not passed @return [Array<(GetSmsCampaigns, Fixnum, Hash)>] GetSmsCampaigns data, response status code and response headers

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 210
def get_sms_campaigns_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.get_sms_campaigns ...'
  end
  if @api_client.config.client_side_validation && opts[:'status'] && !['suspended', 'archive', 'sent', 'queued', 'draft', 'inProcess'].include?(opts[:'status'])
    fail ArgumentError, 'invalid value for "status", must be one of suspended, archive, sent, queued, draft, inProcess'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMSCampaignsApi.get_sms_campaigns, must be smaller than or equal to 1000.'
  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 = '/smsCampaigns'

  # query parameters
  query_params = {}
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  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 => 'GetSmsCampaigns')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SMSCampaignsApi#get_sms_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
request_sms_recipient_export(campaign_id, opts = {}) click to toggle source

Export an SMS campaign's recipients It returns the background process ID which on completion calls the notify URL that you have set in the input. @param campaign_id id of the campaign @param [Hash] opts the optional parameters @option opts [RequestSmsRecipientExport] :recipient_export Values to send for a recipient export request @return [CreatedProcessId]

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 267
def request_sms_recipient_export(campaign_id, opts = {})
  data, _status_code, _headers = request_sms_recipient_export_with_http_info(campaign_id, opts)
  data
end
request_sms_recipient_export_with_http_info(campaign_id, opts = {}) click to toggle source

Export an SMS campaign&#39;s recipients It returns the background process ID which on completion calls the notify URL that you have set in the input. @param campaign_id id of the campaign @param [Hash] opts the optional parameters @option opts [RequestSmsRecipientExport] :recipient_export Values to send for a recipient export request @return [Array<(CreatedProcessId, Fixnum, Hash)>] CreatedProcessId data, response status code and response headers

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 278
def request_sms_recipient_export_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.request_sms_recipient_export ...'
  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 SMSCampaignsApi.request_sms_recipient_export"
  end
  # resource path
  local_var_path = '/smsCampaigns/{campaignId}/exportRecipients'.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[:'recipient_export'])
  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 => 'CreatedProcessId')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SMSCampaignsApi#request_sms_recipient_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
send_sms_campaign_now(campaign_id, opts = {}) click to toggle source

Send your SMS campaign immediately @param campaign_id id of the campaign @param [Hash] opts the optional parameters @return [nil]

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 321
def send_sms_campaign_now(campaign_id, opts = {})
  send_sms_campaign_now_with_http_info(campaign_id, opts)
  nil
end
send_sms_campaign_now_with_http_info(campaign_id, opts = {}) click to toggle source

Send your SMS campaign immediately @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

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 330
def send_sms_campaign_now_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.send_sms_campaign_now ...'
  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 SMSCampaignsApi.send_sms_campaign_now"
  end
  # resource path
  local_var_path = '/smsCampaigns/{campaignId}/sendNow'.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(: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: SMSCampaignsApi#send_sms_campaign_now\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
send_sms_report(campaign_id, send_report, opts = {}) click to toggle source

Send an SMS campaign's report Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. @param campaign_id id of the campaign @param send_report Values for send a report @param [Hash] opts the optional parameters @return [nil]

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 374
def send_sms_report(campaign_id, send_report, opts = {})
  send_sms_report_with_http_info(campaign_id, send_report, opts)
  nil
end
send_sms_report_with_http_info(campaign_id, send_report, opts = {}) click to toggle source

Send an SMS campaign&#39;s report Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. @param campaign_id id of the campaign @param send_report Values for send a report @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 385
def send_sms_report_with_http_info(campaign_id, send_report, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.send_sms_report ...'
  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 SMSCampaignsApi.send_sms_report"
  end
  # verify the required parameter 'send_report' is set
  if @api_client.config.client_side_validation && send_report.nil?
    fail ArgumentError, "Missing the required parameter 'send_report' when calling SMSCampaignsApi.send_sms_report"
  end
  # resource path
  local_var_path = '/smsCampaigns/{campaignId}/sendReport'.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(send_report)
  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: SMSCampaignsApi#send_sms_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
send_test_sms(campaign_id, phone_number, opts = {}) click to toggle source

Send a test SMS campaign @param campaign_id Id of the SMS campaign @param phone_number Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted @param [Hash] opts the optional parameters @return [nil]

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 432
def send_test_sms(campaign_id, phone_number, opts = {})
  send_test_sms_with_http_info(campaign_id, phone_number, opts)
  nil
end
send_test_sms_with_http_info(campaign_id, phone_number, opts = {}) click to toggle source

Send a test SMS campaign @param campaign_id Id of the SMS campaign @param phone_number Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 442
def send_test_sms_with_http_info(campaign_id, phone_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.send_test_sms ...'
  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 SMSCampaignsApi.send_test_sms"
  end
  # verify the required parameter 'phone_number' is set
  if @api_client.config.client_side_validation && phone_number.nil?
    fail ArgumentError, "Missing the required parameter 'phone_number' when calling SMSCampaignsApi.send_test_sms"
  end
  # resource path
  local_var_path = '/smsCampaigns/{campaignId}/sendTest'.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(phone_number)
  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: SMSCampaignsApi#send_test_sms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
setUserAgent(user_agent) click to toggle source

Set custom user_agent if explicitly passed in api default will still remain Swagger-Codegen/#{VERSION}/ruby

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 25
def setUserAgent(user_agent)
  @user_agent = user_agent
  if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
    @api_client.default_headers['User-Agent'] = @user_agent
  end
end
update_sms_campaign(campaign_id, update_sms_campaign, opts = {}) click to toggle source

Update an SMS campaign @param campaign_id id of the SMS campaign @param update_sms_campaign Values to update an SMS Campaign @param [Hash] opts the optional parameters @return [nil]

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 489
def update_sms_campaign(campaign_id, update_sms_campaign, opts = {})
  update_sms_campaign_with_http_info(campaign_id, update_sms_campaign, opts)
  nil
end
update_sms_campaign_status(campaign_id, status, opts = {}) click to toggle source

Update a campaign's status @param campaign_id id of the campaign @param status Status of the campaign. @param [Hash] opts the optional parameters @return [nil]

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 546
def update_sms_campaign_status(campaign_id, status, opts = {})
  update_sms_campaign_status_with_http_info(campaign_id, status, opts)
  nil
end
update_sms_campaign_status_with_http_info(campaign_id, status, opts = {}) click to toggle source

Update a campaign&#39;s status @param campaign_id id of the campaign @param status Status of the campaign. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 556
def update_sms_campaign_status_with_http_info(campaign_id, status, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.update_sms_campaign_status ...'
  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 SMSCampaignsApi.update_sms_campaign_status"
  end
  # verify the required parameter 'status' is set
  if @api_client.config.client_side_validation && status.nil?
    fail ArgumentError, "Missing the required parameter 'status' when calling SMSCampaignsApi.update_sms_campaign_status"
  end
  # resource path
  local_var_path = '/smsCampaigns/{campaignId}/status'.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(status)
  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: SMSCampaignsApi#update_sms_campaign_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_sms_campaign_with_http_info(campaign_id, update_sms_campaign, opts = {}) click to toggle source

Update an SMS campaign @param campaign_id id of the SMS campaign @param update_sms_campaign Values to update an SMS Campaign @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/sib-api-v3-sdk/api/sms_campaigns_api.rb, line 499
def update_sms_campaign_with_http_info(campaign_id, update_sms_campaign, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SMSCampaignsApi.update_sms_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 SMSCampaignsApi.update_sms_campaign"
  end
  # verify the required parameter 'update_sms_campaign' is set
  if @api_client.config.client_side_validation && update_sms_campaign.nil?
    fail ArgumentError, "Missing the required parameter 'update_sms_campaign' when calling SMSCampaignsApi.update_sms_campaign"
  end
  # resource path
  local_var_path = '/smsCampaigns/{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(update_sms_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: SMSCampaignsApi#update_sms_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end