Class: BrevoRuby::UserApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserApi

Returns a new instance of UserApi.



19
20
21
 
# File 'lib/brevo-ruby/api/user_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/user_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_invited_users_list(opts = {}) ⇒ GetInvitedUsersList

Get the list of all your users

Parameters:

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

    the optional parameters

Returns:



35
36
37
38
 
# File 'lib/brevo-ruby/api/user_api.rb', line 35

def get_invited_users_list(opts = {})
  data, _status_code, _headers = get_invited_users_list_with_http_info(opts)
  data
end

#get_invited_users_list_with_http_info(opts = {}) ⇒ Array<(GetInvitedUsersList, Fixnum, Hash)>

Get the list of all your users

Parameters:

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

    the optional parameters

Returns:

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

    GetInvitedUsersList data, response status code and response headers



43
44
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
 
# File 'lib/brevo-ruby/api/user_api.rb', line 43

def get_invited_users_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.get_invited_users_list ...'
  end
  # resource path
  local_var_path = '/organization/invited/users'

  # 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 => 'GetInvitedUsersList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#get_invited_users_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_permission(email, opts = {}) ⇒ GetUserPermission

Check user permission

Parameters:

  • email —

    Email of the invited user.

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

    the optional parameters

Returns:



82
83
84
85
 
# File 'lib/brevo-ruby/api/user_api.rb', line 82

def get_user_permission(email, opts = {})
  data, _status_code, _headers = get_user_permission_with_http_info(email, opts)
  data
end

#get_user_permission_with_http_info(email, opts = {}) ⇒ Array<(GetUserPermission, Fixnum, Hash)>

Check user permission

Parameters:

  • email —

    Email of the invited user.

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

    the optional parameters

Returns:

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

    GetUserPermission data, response status code and response headers



91
92
93
94
95
96
97
98
99
100
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
 
# File 'lib/brevo-ruby/api/user_api.rb', line 91

def get_user_permission_with_http_info(email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.get_user_permission ...'
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling UserApi.get_user_permission"
  end
  # resource path
  local_var_path = '/organization/user/{email}/permissions'.sub('{' + 'email' + '}', email.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 => 'GetUserPermission')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#get_user_permission\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/user_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