Class: OrderCloud::SecurityProfileApi

Inherits:
Object
  • Object
show all
Defined in:
lib/order_cloud/api/security_profile_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SecurityProfileApi

Returns a new instance of SecurityProfileApi.



30
31
32
 
# File 'lib/order_cloud/api/security_profile_api.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/order_cloud/api/security_profile_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#delete_assignment(buyer_id, security_profile_id, opts = {}) ⇒ nil

Parameters:

  • buyer_id —

    ID of the buyer.

  • security_profile_id —

    ID of the security profile.

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

    the optional parameters

Options Hash (opts):

  • :user_id (String) —

    ID of the user.

  • :user_group_id (String) —

    ID of the user group.

Returns:

  • (nil) 


42
43
44
45
 
# File 'lib/order_cloud/api/security_profile_api.rb', line 42

def delete_assignment(buyer_id, security_profile_id, opts = {})
  delete_assignment_with_http_info(buyer_id, security_profile_id, opts)
  return nil
end

#delete_assignment_with_http_info(buyer_id, security_profile_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • security_profile_id —

    ID of the security profile.

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

    the optional parameters

Options Hash (opts):

  • :user_id (String) —

    ID of the user.

  • :user_group_id (String) —

    ID of the user group.

Returns:

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

    nil, response status code and response headers



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
98
99
 
# File 'lib/order_cloud/api/security_profile_api.rb', line 55

def delete_assignment_with_http_info(buyer_id, security_profile_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityProfileApi.delete_assignment ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling SecurityProfileApi.delete_assignment" if buyer_id.nil?
  # verify the required parameter 'security_profile_id' is set
  fail ArgumentError, "Missing the required parameter 'security_profile_id' when calling SecurityProfileApi.delete_assignment" if security_profile_id.nil?
  # resource path
  local_var_path = "/SecurityProfiles/{securityProfileID}/assignments".sub('{format}','json').sub('{' + 'securityProfileID' + '}', security_profile_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'buyerID'] = buyer_id
  query_params[:'userID'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'userGroupID'] = opts[:'user_group_id'] if !opts[:'user_group_id'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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 = ['application/json', 'text/plain; charset=utf-8']
  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 = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, 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: SecurityProfileApi#delete_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(security_profile_id, opts = {}) ⇒ SecurityProfile

Parameters:

  • security_profile_id —

    ID of the security profile.

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

    the optional parameters

Returns:



106
107
108
109
 
# File 'lib/order_cloud/api/security_profile_api.rb', line 106

def get(security_profile_id, opts = {})
  data, _status_code, _headers = get_with_http_info(security_profile_id, opts)
  return data
end

#get_with_http_info(security_profile_id, opts = {}) ⇒ Array<(SecurityProfile, Fixnum, Hash)>

Returns SecurityProfile data, response status code and response headers.

Parameters:

  • security_profile_id —

    ID of the security profile.

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

    the optional parameters

Returns:

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

    SecurityProfile data, response status code and response headers



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
 
# File 'lib/order_cloud/api/security_profile_api.rb', line 116

def get_with_http_info(security_profile_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityProfileApi.get ..."
  end
  # verify the required parameter 'security_profile_id' is set
  fail ArgumentError, "Missing the required parameter 'security_profile_id' when calling SecurityProfileApi.get" if security_profile_id.nil?
  # resource path
  local_var_path = "/SecurityProfiles/{securityProfileID}".sub('{format}','json').sub('{' + 'securityProfileID' + '}', security_profile_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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 = ['application/json', 'text/plain; charset=utf-8']
  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 = ['oauth2']
  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 => 'SecurityProfile')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityProfileApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ ListSecurityProfile

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

    Number of results to return per page. Default: 20, max: 100.

  • :filters (Hash<String, String>) —

    Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39;

Returns:



168
169
170
171
 
# File 'lib/order_cloud/api/security_profile_api.rb', line 168

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

#list_assignments(buyer_id, opts = {}) ⇒ ListSecurityProfileAssignment

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Options Hash (opts):

  • :security_profile_id (String) —

    ID of the security profile.

  • :user_id (String) —

    ID of the user.

  • :user_group_id (String) —

    ID of the user group.

  • :level (String) —

    Level of the security profile.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

    Number of results to return per page. Default: 20, max: 100.

Returns:



240
241
242
243
 
# File 'lib/order_cloud/api/security_profile_api.rb', line 240

def list_assignments(buyer_id, opts = {})
  data, _status_code, _headers = list_assignments_with_http_info(buyer_id, opts)
  return data
end

#list_assignments_with_http_info(buyer_id, opts = {}) ⇒ Array<(ListSecurityProfileAssignment, Fixnum, Hash)>

Returns ListSecurityProfileAssignment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Options Hash (opts):

  • :security_profile_id (String) —

    ID of the security profile.

  • :user_id (String) —

    ID of the user.

  • :user_group_id (String) —

    ID of the user group.

  • :level (String) —

    Level of the security profile.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

    Number of results to return per page. Default: 20, max: 100.

Returns:



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/order_cloud/api/security_profile_api.rb', line 256

def list_assignments_with_http_info(buyer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityProfileApi.list_assignments ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling SecurityProfileApi.list_assignments" if buyer_id.nil?
  # resource path
  local_var_path = "/SecurityProfiles/assignments".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'buyerID'] = buyer_id
  query_params[:'securityProfileID'] = opts[:'security_profile_id'] if !opts[:'security_profile_id'].nil?
  query_params[:'userID'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'userGroupID'] = opts[:'user_group_id'] if !opts[:'user_group_id'].nil?
  query_params[:'level'] = opts[:'level'] if !opts[:'level'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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 = ['application/json', 'text/plain; charset=utf-8']
  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 = ['oauth2']
  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 => 'ListSecurityProfileAssignment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityProfileApi#list_assignments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_with_http_info(opts = {}) ⇒ Array<(ListSecurityProfile, Fixnum, Hash)>

Returns ListSecurityProfile data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

    Number of results to return per page. Default: 20, max: 100.

  • :filters (Hash<String, String>) —

    Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39;

Returns:

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

    ListSecurityProfile data, response status code and response headers



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
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/order_cloud/api/security_profile_api.rb', line 183

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityProfileApi.list ..."
  end
  # resource path
  local_var_path = "/SecurityProfiles".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'searchOn'] = opts[:'search_on'] if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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 = ['application/json', 'text/plain; charset=utf-8']
  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 = ['oauth2']
  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 => 'ListSecurityProfile')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityProfileApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#save_assignment(assignment, opts = {}) ⇒ nil

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


310
311
312
313
 
# File 'lib/order_cloud/api/security_profile_api.rb', line 310

def save_assignment(assignment, opts = {})
  save_assignment_with_http_info(assignment, opts)
  return nil
end

#save_assignment_with_http_info(assignment, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/order_cloud/api/security_profile_api.rb', line 320

def save_assignment_with_http_info(assignment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityProfileApi.save_assignment ..."
  end
  # verify the required parameter 'assignment' is set
  fail ArgumentError, "Missing the required parameter 'assignment' when calling SecurityProfileApi.save_assignment" if assignment.nil?
  # resource path
  local_var_path = "/SecurityProfiles/assignments".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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 = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(assignment)
  auth_names = ['oauth2']
  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: SecurityProfileApi#save_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end