Class: BrevoRuby::ProcessApi

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo-ruby/api/process_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProcessApi

Returns a new instance of ProcessApi.



19
20
21
 
# File 'lib/brevo-ruby/api/process_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/brevo-ruby/api/process_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_process(process_id, opts = {}) ⇒ GetProcess

Return the informations for a process

Parameters:

  • process_id —

    Id of the process

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



36
37
38
39
 
# File 'lib/brevo-ruby/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 = {}) ⇒ Array<(GetProcess, Fixnum, Hash)>

Return the informations for a process

Parameters:

  • process_id —

    Id of the process

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetProcess, Fixnum, Hash)>) —

    GetProcess data, response status code and response headers



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/brevo-ruby/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 = {}) ⇒ GetProcesses

Return all the processes for your account

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number limitation for the result returned (default to 10)

  • :offset (Integer) —

    Beginning point in the list to retrieve from. (default to 0)

  • :sort (String) —

    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)

Returns:



90
91
92
93
 
# File 'lib/brevo-ruby/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 = {}) ⇒ Array<(GetProcesses, Fixnum, Hash)>

Return all the processes for your account

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number limitation for the result returned

  • :offset (Integer) —

    Beginning point in the list to retrieve from.

  • :sort (String) —

    Sort the results in the ascending/descending order of record creation. Default order is descending if &#x60;sort&#x60; is not passed

Returns:

  • (Array<(GetProcesses, Fixnum, Hash)>) —

    GetProcesses data, response status code and response headers



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/brevo-ruby/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[:'limit'].nil? && opts[:'limit'] < 0
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ProcessApi.get_processes, 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 = '/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) ⇒ Object

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



25
26
27
28
29
30
 
# File 'lib/brevo-ruby/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?('brevo_')
    @api_client.default_headers['User-Agent'] = @user_agent
  end
end