Class: WhiteLabelMachineName::UserAccountRoleService

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/api/user_account_role_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserAccountRoleService 



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/user_account_role_service_api.rb', line 24

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/user_account_role_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#add_role(user_id, account_id, role_id, opts = {}) ⇒ UserAccountRole

Add Role This operation grants the role to the given user with in the given account.

Options Hash (opts):

  • :applies_on_subaccount (BOOLEAN) —

    Whether the role applies only on subaccount.



36
37
38
39
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/user_account_role_service_api.rb', line 36

def add_role(user_id, , role_id, opts = {})
  data, _status_code, _headers = add_role_with_http_info(user_id, , role_id, opts)
  return data
end

#add_role_with_http_info(user_id, account_id, role_id, opts = {}) ⇒ Array<(UserAccountRole, Fixnum, Hash)>

Add Role This operation grants the role to the given user with in the given account.

Options Hash (opts):

  • :applies_on_subaccount (BOOLEAN) —

    Whether the role applies only on subaccount.



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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/user_account_role_service_api.rb', line 49

def add_role_with_http_info(user_id, , role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserAccountRoleService.add_role ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UserAccountRoleService.add_role" if user_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UserAccountRoleService.add_role" if .nil?
  # verify the required parameter 'role_id' is set
  fail ArgumentError, "Missing the required parameter 'role_id' when calling UserAccountRoleService.add_role" if role_id.nil?
  # resource path
  local_var_path = "/user-account-role/addRole".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'userId'] = user_id
  query_params[:'accountId'] = 
  query_params[:'roleId'] = role_id
  query_params[:'appliesOnSubaccount'] = opts[:'applies_on_subaccount'] if !opts[:'applies_on_subaccount'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'UserAccountRole')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserAccountRoleService#add_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(user_id, account_id, opts = {}) ⇒ Array<UserAccountRole>

List Roles List all the roles that are assigned to the given user in the given account.



105
106
107
108
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/user_account_role_service_api.rb', line 105

def list(user_id, , opts = {})
  data, _status_code, _headers = list_with_http_info(user_id, , opts)
  return data
end

#list_with_http_info(user_id, account_id, opts = {}) ⇒ Array<(Array<UserAccountRole>, Fixnum, Hash)>

List Roles List all the roles that are assigned to the given user in the given account.



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
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/user_account_role_service_api.rb', line 116

def list_with_http_info(user_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserAccountRoleService.list ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UserAccountRoleService.list" if user_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UserAccountRoleService.list" if .nil?
  # resource path
  local_var_path = "/user-account-role/list".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'userId'] = user_id
  query_params[:'accountId'] = 

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'Array<UserAccountRole>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserAccountRoleService#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_role(id, opts = {}) ⇒ nil

Remove Role This operation removes the specified user account role.



167
168
169
170
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/user_account_role_service_api.rb', line 167

def remove_role(id, opts = {})
  remove_role_with_http_info(id, opts)
  return nil
end

#remove_role_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Remove Role This operation removes the specified user account role.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/user_account_role_service_api.rb', line 177

def remove_role_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserAccountRoleService.remove_role ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling UserAccountRoleService.remove_role" if id.nil?
  # resource path
  local_var_path = "/user-account-role/removeRole".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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: UserAccountRoleService#remove_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end