class SibApiV3Sdk::ProcessApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

get_process(process_id, opts = {}) click to toggle source

Return the informations for a process @param process_id Id of the process @param [Hash] opts the optional parameters @return [GetProcess]

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

Return the informations for a process @param process_id Id of the process @param [Hash] opts the optional parameters @return [Array<(GetProcess, Fixnum, Hash)>] GetProcess data, response status code and response headers

# File lib/sib-api-v3-sdk/api/process_api.rb, line 45
def get_process_with_http_info(process_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProcessApi.get_process ...'
  end
  # verify the required parameter 'process_id' is set
  if @api_client.config.client_side_validation && process_id.nil?
    fail ArgumentError, "Missing the required parameter 'process_id' when calling ProcessApi.get_process"
  end
  # resource path
  local_var_path = '/processes/{processId}'.sub('{' + 'processId' + '}', process_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 => 'GetProcess')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProcessApi#get_process\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_processes(opts = {}) click to toggle source

Return all the processes for your account @param [Hash] opts the optional parameters @option opts [Integer] :limit Number limitation for the result returned (default to 10) @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 [GetProcesses]

# File lib/sib-api-v3-sdk/api/process_api.rb, line 90
def get_processes(opts = {})
  data, _status_code, _headers = get_processes_with_http_info(opts)
  data
end
get_processes_with_http_info(opts = {}) click to toggle source

Return all the processes for your account @param [Hash] opts the optional parameters @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<(GetProcesses, Fixnum, Hash)>] GetProcesses data, response status code and response headers

# File lib/sib-api-v3-sdk/api/process_api.rb, line 101
def get_processes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProcessApi.get_processes ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 50
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ProcessApi.get_processes, must be smaller than or equal to 50.'
  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 = '/processes'

  # query parameters
  query_params = {}
  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 => 'GetProcesses')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProcessApi#get_processes\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/process_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