Class: DocuSign_Admin::ProductPermissionProfilesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_admin/api/product_permission_profiles_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ProductPermissionProfilesApi.default) ⇒ ProductPermissionProfilesApi

Returns a new instance of ProductPermissionProfilesApi.



29
30
31
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 29

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



27
28
29
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 27

def api_client
  @api_client
end

Instance Method Details

#add_user_product_permission_profiles(organization_id, account_id, user_id, product_permission_profiles_request) ⇒ UserProductPermissionProfilesResponse

Assign user to permission profiles for one or more products Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

  • user_id —

    The user ID GUID

  • product_permission_profiles_request —

    Request object

Returns:



40
41
42
43
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 40

def add_user_product_permission_profiles(organization_id, , user_id, product_permission_profiles_request)
  data, _status_code, _headers = add_user_product_permission_profiles_with_http_info(organization_id, , user_id,  product_permission_profiles_request)
  return data
end

#add_user_product_permission_profiles_by_email(organization_id, account_id, user_product_permission_profiles_request) ⇒ UserProductPermissionProfilesResponse

Assign user to permission profiles for one or more products Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

  • user_product_permission_profiles_request —

    Request object

Returns:



102
103
104
105
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 102

def add_user_product_permission_profiles_by_email(organization_id, , user_product_permission_profiles_request)
  data, _status_code, _headers = add_user_product_permission_profiles_by_email_with_http_info(organization_id, ,  user_product_permission_profiles_request)
  return data
end

#add_user_product_permission_profiles_by_email_with_http_info(organization_id, account_id, user_product_permission_profiles_request) ⇒ Array<(UserProductPermissionProfilesResponse, Fixnum, Hash)>

Assign user to permission profiles for one or more products Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

  • user_product_permission_profiles_request —

    Request object

Returns:



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
150
151
152
153
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 113

def add_user_product_permission_profiles_by_email_with_http_info(organization_id, , user_product_permission_profiles_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProductPermissionProfilesApi.add_user_product_permission_profiles_by_email ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProductPermissionProfilesApi.add_user_product_permission_profiles_by_email" if organization_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ProductPermissionProfilesApi.add_user_product_permission_profiles_by_email" if .nil?
  # verify the required parameter 'user_product_permission_profiles_request' is set
  fail ArgumentError, "Missing the required parameter 'user_product_permission_profiles_request' when calling ProductPermissionProfilesApi.add_user_product_permission_profiles_by_email" if user_product_permission_profiles_request.nil?
  # resource path
  local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/products/permission_profiles/users".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', .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 = @api_client.object_to_http_body(user_product_permission_profiles_request)
  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 => 'UserProductPermissionProfilesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductPermissionProfilesApi#add_user_product_permission_profiles_by_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_user_product_permission_profiles_with_http_info(organization_id, account_id, user_id, product_permission_profiles_request) ⇒ Array<(UserProductPermissionProfilesResponse, Fixnum, Hash)>

Assign user to permission profiles for one or more products Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

  • user_id —

    The user ID GUID

  • product_permission_profiles_request —

    Request object

Returns:



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
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 52

def add_user_product_permission_profiles_with_http_info(organization_id, , user_id, product_permission_profiles_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProductPermissionProfilesApi.add_user_product_permission_profiles ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProductPermissionProfilesApi.add_user_product_permission_profiles" if organization_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ProductPermissionProfilesApi.add_user_product_permission_profiles" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling ProductPermissionProfilesApi.add_user_product_permission_profiles" if user_id.nil?
  # verify the required parameter 'product_permission_profiles_request' is set
  fail ArgumentError, "Missing the required parameter 'product_permission_profiles_request' when calling ProductPermissionProfilesApi.add_user_product_permission_profiles" if product_permission_profiles_request.nil?
  # resource path
  local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/products/users/{userId}/permission_profiles".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', .to_s).sub('{' + 'userId' + '}', user_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 = @api_client.object_to_http_body(product_permission_profiles_request)
  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 => 'UserProductPermissionProfilesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductPermissionProfilesApi#add_user_product_permission_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_product_permission_profiles(organization_id, account_id) ⇒ ProductPermissionProfilesResponse

Get products associated with the account and the available permission profiles Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

Returns:



160
161
162
163
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 160

def get_product_permission_profiles(organization_id, )
  data, _status_code, _headers = get_product_permission_profiles_with_http_info(organization_id, )
  return data
end

#get_product_permission_profiles_with_http_info(organization_id, account_id) ⇒ Array<(ProductPermissionProfilesResponse, Fixnum, Hash)>

Get products associated with the account and the available permission profiles Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

Returns:



170
171
172
173
174
175
176
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
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 170

def get_product_permission_profiles_with_http_info(organization_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProductPermissionProfilesApi.get_product_permission_profiles ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProductPermissionProfilesApi.get_product_permission_profiles" if organization_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ProductPermissionProfilesApi.get_product_permission_profiles" if .nil?
  # resource path
  local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/products/permission_profiles".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', .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 = []
  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 => 'ProductPermissionProfilesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductPermissionProfilesApi#get_product_permission_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_product_permission_profiles(organization_id, account_id, user_id) ⇒ ProductPermissionProfilesResponse

Retrieve list of user’s permission profiles for each account’s product Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

  • user_id —

    The user ID GUID

Returns:



216
217
218
219
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 216

def get_user_product_permission_profiles(organization_id, , user_id)
  data, _status_code, _headers = get_user_product_permission_profiles_with_http_info(organization_id, , user_id)
  return data
end

#get_user_product_permission_profiles_by_email(organization_id, account_id, options = DocuSign_Admin::GetUserProductPermissionProfilesByEmailOptions.default) ⇒ UserProductPermissionProfilesResponse

Remove user from permission profiles for one or more products Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

  • DocuSign_Admin::GetUserProductPermissionProfilesByEmailOptions —

    Options for modifying the behavior of the function.

Returns:



275
276
277
278
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 275

def get_user_product_permission_profiles_by_email(organization_id, , options = DocuSign_Admin::GetUserProductPermissionProfilesByEmailOptions.default)
  data, _status_code, _headers = get_user_product_permission_profiles_by_email_with_http_info(organization_id, , options)
  return data
end

#get_user_product_permission_profiles_by_email_with_http_info(organization_id, account_id, options = DocuSign_Admin::GetUserProductPermissionProfilesByEmailOptions.default) ⇒ Array<(UserProductPermissionProfilesResponse, Fixnum, Hash)>

Remove user from permission profiles for one or more products Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

  • DocuSign_Admin::GetUserProductPermissionProfilesByEmailOptions —

    Options for modifying the behavior of the function.

Returns:



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 286

def get_user_product_permission_profiles_by_email_with_http_info(organization_id, , options = DocuSign_Admin::GetUserProductPermissionProfilesByEmailOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProductPermissionProfilesApi.get_user_product_permission_profiles_by_email ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProductPermissionProfilesApi.get_user_product_permission_profiles_by_email" if organization_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ProductPermissionProfilesApi.get_user_product_permission_profiles_by_email" if .nil?
  # resource path
  local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/products/permission_profiles/users".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'email'] = options.email if !options.email.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 = []
  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 => 'UserProductPermissionProfilesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductPermissionProfilesApi#get_user_product_permission_profiles_by_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_product_permission_profiles_with_http_info(organization_id, account_id, user_id) ⇒ Array<(ProductPermissionProfilesResponse, Fixnum, Hash)>

Retrieve list of user&#39;s permission profiles for each account&#39;s product Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

  • user_id —

    The user ID GUID

Returns:



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 227

def get_user_product_permission_profiles_with_http_info(organization_id, , user_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProductPermissionProfilesApi.get_user_product_permission_profiles ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProductPermissionProfilesApi.get_user_product_permission_profiles" if organization_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ProductPermissionProfilesApi.get_user_product_permission_profiles" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling ProductPermissionProfilesApi.get_user_product_permission_profiles" if user_id.nil?
  # resource path
  local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/products/users/{userId}/permission_profiles".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', .to_s).sub('{' + 'userId' + '}', user_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 = []
  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 => 'ProductPermissionProfilesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductPermissionProfilesApi#get_user_product_permission_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_user_product_permission(organization_id, account_id, user_product_permission_profiles_request) ⇒ RemoveUserProductsResponse

Remove user from permission profiles for one or more products Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

  • user_product_permission_profiles_request —

    Request object

Returns:



333
334
335
336
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 333

def remove_user_product_permission(organization_id, , user_product_permission_profiles_request)
  data, _status_code, _headers = remove_user_product_permission_with_http_info(organization_id, ,  user_product_permission_profiles_request)
  return data
end

#remove_user_product_permission_with_http_info(organization_id, account_id, user_product_permission_profiles_request) ⇒ Array<(RemoveUserProductsResponse, Fixnum, Hash)>

Remove user from permission profiles for one or more products Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

  • user_product_permission_profiles_request —

    Request object

Returns:

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

    RemoveUserProductsResponse data, response status code and response headers



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/docusign_admin/api/product_permission_profiles_api.rb', line 344

def remove_user_product_permission_with_http_info(organization_id, , user_product_permission_profiles_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProductPermissionProfilesApi.remove_user_product_permission ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ProductPermissionProfilesApi.remove_user_product_permission" if organization_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ProductPermissionProfilesApi.remove_user_product_permission" if .nil?
  # verify the required parameter 'user_product_permission_profiles_request' is set
  fail ArgumentError, "Missing the required parameter 'user_product_permission_profiles_request' when calling ProductPermissionProfilesApi.remove_user_product_permission" if user_product_permission_profiles_request.nil?
  # resource path
  local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/products/users".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', .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 = @api_client.object_to_http_body(user_product_permission_profiles_request)
  auth_names = []
  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,
    :return_type => 'RemoveUserProductsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductPermissionProfilesApi#remove_user_product_permission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end