Skip to content

Latest commit

 

History

History
129 lines (90 loc) · 3.67 KB

ProcessApi.md

File metadata and controls

129 lines (90 loc) · 3.67 KB
Raw

Brevo::ProcessApi

All URIs are relative to https://api.brevo.com/v3

Method HTTP request Description
get_process GET /processes/{processId} Return the informations for a process
get_processes GET /processes Return all the processes for your account

get_process

GetProcess get_process(process_id)

Return the informations for a process

Example

# load the gem
require 'brevo'
# setup authorization
Brevo.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'

  # Configure API key authorization: partner-key
  config.api_key['partner-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['partner-key'] = 'Bearer'
end

api_instance = Brevo::ProcessApi.new

process_id = 789 # Integer | Id of the process


begin
  #Return the informations for a process
  result = api_instance.get_process(process_id)
  p result
rescue Brevo::ApiError => e
  puts "Exception when calling ProcessApi->get_process: #{e}"
end

Parameters

Name Type Description Notes
process_id Integer Id of the process

Return type

GetProcess

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

get_processes

GetProcesses get_processes(opts)

Return all the processes for your account

Example

# load the gem
require 'brevo'
# setup authorization
Brevo.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'

  # Configure API key authorization: partner-key
  config.api_key['partner-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['partner-key'] = 'Bearer'
end

api_instance = Brevo::ProcessApi.new

opts = { 
  limit: 10, # Integer | Number limitation for the result returned
  offset: 0, # Integer | Beginning point in the list to retrieve from.
  sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
}

begin
  #Return all the processes for your account
  result = api_instance.get_processes(opts)
  p result
rescue Brevo::ApiError => e
  puts "Exception when calling ProcessApi->get_processes: #{e}"
end

Parameters

Name Type Description Notes
limit Integer Number limitation for the result returned [optional] [default to 10]
offset Integer Beginning point in the list to retrieve from. [optional] [default to 0]
sort String Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed [optional] [default to desc]

Return type

GetProcesses

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json