Class: DocuSign_Admin::DSGroupsApi
- Inherits:
-
Object
- Object
- DocuSign_Admin::DSGroupsApi
- Defined in:
- lib/docusign_admin/api/ds_groups_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#add_ds_group(organization_id, account_id, add_request) ⇒ DSGroupResponse
Add a new DSGroup Required scopes: user_write.
-
#add_ds_group_users(organization_id, account_id, ds_group_id, d_s_group_users_add_request) ⇒ AddDSGroupAndUsersResponse
Add list of users to a DSGroup Required scopes: user_write.
-
#add_ds_group_users_with_http_info(organization_id, account_id, ds_group_id, d_s_group_users_add_request) ⇒ Array<(AddDSGroupAndUsersResponse, Fixnum, Hash)>
Add list of users to a DSGroup Required scopes: user_write.
-
#add_ds_group_with_http_info(organization_id, account_id, add_request) ⇒ Array<(DSGroupResponse, Fixnum, Hash)>
Add a new DSGroup Required scopes: user_write.
-
#delete_ds_group(organization_id, account_id, ds_group_id) ⇒ nil
Delete a DSGroup Required scopes: user_write.
-
#delete_ds_group_with_http_info(organization_id, account_id, ds_group_id) ⇒ Array<(nil, Fixnum, Hash)>
Delete a DSGroup Required scopes: user_write.
-
#get_ds_group(organization_id, account_id, ds_group_id) ⇒ DSGroupResponse
Get list of DSGroup Required scopes: user_read.
-
#get_ds_group_users(organization_id, account_id, ds_group_id, options = DocuSign_Admin::GetDSGroupUsersOptions.default) ⇒ DSGroupAndUsersResponse
Get list of users in a DSGroup Required scopes: user_read.
-
#get_ds_group_users_with_http_info(organization_id, account_id, ds_group_id, options = DocuSign_Admin::GetDSGroupUsersOptions.default) ⇒ Array<(DSGroupAndUsersResponse, Fixnum, Hash)>
Get list of users in a DSGroup Required scopes: user_read.
-
#get_ds_group_with_http_info(organization_id, account_id, ds_group_id) ⇒ Array<(DSGroupResponse, Fixnum, Hash)>
Get list of DSGroup Required scopes: user_read.
-
#get_ds_groups(organization_id, account_id, options = DocuSign_Admin::GetDSGroupsOptions.default) ⇒ DSGroupListResponse
Get list of DSGroups Required scopes: user_read.
-
#get_ds_groups_with_http_info(organization_id, account_id, options = DocuSign_Admin::GetDSGroupsOptions.default) ⇒ Array<(DSGroupListResponse, Fixnum, Hash)>
Get list of DSGroups Required scopes: user_read.
-
#initialize(api_client = DSGroupsApi.default) ⇒ DSGroupsApi
constructor
A new instance of DSGroupsApi.
-
#remove_ds_group_users(organization_id, account_id, ds_group_id, d_s_group_users_remove_request) ⇒ RemoveDSGroupUsersResponse
Remove users from a DSGroup Required scopes: user_write.
-
#remove_ds_group_users_with_http_info(organization_id, account_id, ds_group_id, d_s_group_users_remove_request) ⇒ Array<(RemoveDSGroupUsersResponse, Fixnum, Hash)>
Remove users from a DSGroup Required scopes: user_write.
Constructor Details
#initialize(api_client = DSGroupsApi.default) ⇒ DSGroupsApi
Returns a new instance of DSGroupsApi.
44 45 46 |
# File 'lib/docusign_admin/api/ds_groups_api.rb', line 44 def initialize(api_client = DSGroupsApi.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
42 43 44 |
# File 'lib/docusign_admin/api/ds_groups_api.rb', line 42 def api_client @api_client end |
Instance Method Details
#add_ds_group(organization_id, account_id, add_request) ⇒ DSGroupResponse
Add a new DSGroup Required scopes: user_write
54 55 56 57 |
# File 'lib/docusign_admin/api/ds_groups_api.rb', line 54 def add_ds_group(organization_id, account_id, add_request) data, _status_code, _headers = add_ds_group_with_http_info(organization_id, account_id, add_request) return data end |
#add_ds_group_users(organization_id, account_id, ds_group_id, d_s_group_users_add_request) ⇒ AddDSGroupAndUsersResponse
Add list of users to a DSGroup Required scopes: user_write
114 115 116 117 |
# File 'lib/docusign_admin/api/ds_groups_api.rb', line 114 def add_ds_group_users(organization_id, account_id, ds_group_id, d_s_group_users_add_request) data, _status_code, _headers = add_ds_group_users_with_http_info(organization_id, account_id, ds_group_id, d_s_group_users_add_request) return data end |
#add_ds_group_users_with_http_info(organization_id, account_id, ds_group_id, d_s_group_users_add_request) ⇒ Array<(AddDSGroupAndUsersResponse, Fixnum, Hash)>
Add list of users to a DSGroup Required scopes: user_write
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 161 162 163 164 165 166 167 168 |
# File 'lib/docusign_admin/api/ds_groups_api.rb', line 126 def add_ds_group_users_with_http_info(organization_id, account_id, ds_group_id, d_s_group_users_add_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: DSGroupsApi.add_ds_group_users ..." end # verify the required parameter 'organization_id' is set fail ArgumentError, "Missing the required parameter 'organization_id' when calling DSGroupsApi.add_ds_group_users" if organization_id.nil? # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling DSGroupsApi.add_ds_group_users" if account_id.nil? # verify the required parameter 'ds_group_id' is set fail ArgumentError, "Missing the required parameter 'ds_group_id' when calling DSGroupsApi.add_ds_group_users" if ds_group_id.nil? # verify the required parameter 'd_s_group_users_add_request' is set fail ArgumentError, "Missing the required parameter 'd_s_group_users_add_request' when calling DSGroupsApi.add_ds_group_users" if d_s_group_users_add_request.nil? # resource path local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}/users".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'dsGroupId' + '}', ds_group_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(d_s_group_users_add_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 => 'AddDSGroupAndUsersResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: DSGroupsApi#add_ds_group_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#add_ds_group_with_http_info(organization_id, account_id, add_request) ⇒ Array<(DSGroupResponse, Fixnum, Hash)>
Add a new DSGroup Required scopes: user_write
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 100 101 102 103 104 105 |
# File 'lib/docusign_admin/api/ds_groups_api.rb', line 65 def add_ds_group_with_http_info(organization_id, account_id, add_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: DSGroupsApi.add_ds_group ..." end # verify the required parameter 'organization_id' is set fail ArgumentError, "Missing the required parameter 'organization_id' when calling DSGroupsApi.add_ds_group" if organization_id.nil? # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling DSGroupsApi.add_ds_group" if account_id.nil? # verify the required parameter 'add_request' is set fail ArgumentError, "Missing the required parameter 'add_request' when calling DSGroupsApi.add_ds_group" if add_request.nil? # resource path local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', account_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(add_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 => 'DSGroupResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: DSGroupsApi#add_ds_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_ds_group(organization_id, account_id, ds_group_id) ⇒ nil
Delete a DSGroup Required scopes: user_write
176 177 178 179 |
# File 'lib/docusign_admin/api/ds_groups_api.rb', line 176 def delete_ds_group(organization_id, account_id, ds_group_id) delete_ds_group_with_http_info(organization_id, account_id, ds_group_id) return nil end |
#delete_ds_group_with_http_info(organization_id, account_id, ds_group_id) ⇒ Array<(nil, Fixnum, Hash)>
Delete a DSGroup Required scopes: user_write
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 |
# File 'lib/docusign_admin/api/ds_groups_api.rb', line 187 def delete_ds_group_with_http_info(organization_id, account_id, ds_group_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: DSGroupsApi.delete_ds_group ..." end # verify the required parameter 'organization_id' is set fail ArgumentError, "Missing the required parameter 'organization_id' when calling DSGroupsApi.delete_ds_group" if organization_id.nil? # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling DSGroupsApi.delete_ds_group" if account_id.nil? # verify the required parameter 'ds_group_id' is set fail ArgumentError, "Missing the required parameter 'ds_group_id' when calling DSGroupsApi.delete_ds_group" if ds_group_id.nil? # resource path local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'dsGroupId' + '}', ds_group_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(: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: DSGroupsApi#delete_ds_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_ds_group(organization_id, account_id, ds_group_id) ⇒ DSGroupResponse
Get list of DSGroup Required scopes: user_read
234 235 236 237 |
# File 'lib/docusign_admin/api/ds_groups_api.rb', line 234 def get_ds_group(organization_id, account_id, ds_group_id) data, _status_code, _headers = get_ds_group_with_http_info(organization_id, account_id, ds_group_id) return data end |
#get_ds_group_users(organization_id, account_id, ds_group_id, options = DocuSign_Admin::GetDSGroupUsersOptions.default) ⇒ DSGroupAndUsersResponse
Get list of users in a DSGroup Required scopes: user_read
294 295 296 297 |
# File 'lib/docusign_admin/api/ds_groups_api.rb', line 294 def get_ds_group_users(organization_id, account_id, ds_group_id, = DocuSign_Admin::GetDSGroupUsersOptions.default) data, _status_code, _headers = get_ds_group_users_with_http_info(organization_id, account_id, ds_group_id, ) return data end |
#get_ds_group_users_with_http_info(organization_id, account_id, ds_group_id, options = DocuSign_Admin::GetDSGroupUsersOptions.default) ⇒ Array<(DSGroupAndUsersResponse, Fixnum, Hash)>
Get list of users in a DSGroup Required scopes: user_read
306 307 308 309 310 311 312 313 314 315 316 317 318 319 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 |
# File 'lib/docusign_admin/api/ds_groups_api.rb', line 306 def get_ds_group_users_with_http_info(organization_id, account_id, ds_group_id, = DocuSign_Admin::GetDSGroupUsersOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: DSGroupsApi.get_ds_group_users ..." end # verify the required parameter 'organization_id' is set fail ArgumentError, "Missing the required parameter 'organization_id' when calling DSGroupsApi.get_ds_group_users" if organization_id.nil? # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling DSGroupsApi.get_ds_group_users" if account_id.nil? # verify the required parameter 'ds_group_id' is set fail ArgumentError, "Missing the required parameter 'ds_group_id' when calling DSGroupsApi.get_ds_group_users" if ds_group_id.nil? # resource path local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}/users".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'dsGroupId' + '}', ds_group_id.to_s) # query parameters query_params = {} query_params[:'page'] = .page if !.page.nil? query_params[:'page_size'] = .page_size if !.page_size.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 => 'DSGroupAndUsersResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: DSGroupsApi#get_ds_group_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_ds_group_with_http_info(organization_id, account_id, ds_group_id) ⇒ Array<(DSGroupResponse, Fixnum, Hash)>
Get list of DSGroup Required scopes: user_read
245 246 247 248 249 250 251 252 253 254 255 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 |
# File 'lib/docusign_admin/api/ds_groups_api.rb', line 245 def get_ds_group_with_http_info(organization_id, account_id, ds_group_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: DSGroupsApi.get_ds_group ..." end # verify the required parameter 'organization_id' is set fail ArgumentError, "Missing the required parameter 'organization_id' when calling DSGroupsApi.get_ds_group" if organization_id.nil? # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling DSGroupsApi.get_ds_group" if account_id.nil? # verify the required parameter 'ds_group_id' is set fail ArgumentError, "Missing the required parameter 'ds_group_id' when calling DSGroupsApi.get_ds_group" if ds_group_id.nil? # resource path local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'dsGroupId' + '}', ds_group_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 => 'DSGroupResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: DSGroupsApi#get_ds_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_ds_groups(organization_id, account_id, options = DocuSign_Admin::GetDSGroupsOptions.default) ⇒ DSGroupListResponse
Get list of DSGroups Required scopes: user_read
356 357 358 359 |
# File 'lib/docusign_admin/api/ds_groups_api.rb', line 356 def get_ds_groups(organization_id, account_id, = DocuSign_Admin::GetDSGroupsOptions.default) data, _status_code, _headers = get_ds_groups_with_http_info(organization_id, account_id, ) return data end |
#get_ds_groups_with_http_info(organization_id, account_id, options = DocuSign_Admin::GetDSGroupsOptions.default) ⇒ Array<(DSGroupListResponse, Fixnum, Hash)>
Get list of DSGroups Required scopes: user_read
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 |
# File 'lib/docusign_admin/api/ds_groups_api.rb', line 367 def get_ds_groups_with_http_info(organization_id, account_id, = DocuSign_Admin::GetDSGroupsOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: DSGroupsApi.get_ds_groups ..." end # verify the required parameter 'organization_id' is set fail ArgumentError, "Missing the required parameter 'organization_id' when calling DSGroupsApi.get_ds_groups" if organization_id.nil? # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling DSGroupsApi.get_ds_groups" if account_id.nil? # resource path local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'page'] = .page if !.page.nil? query_params[:'page_size'] = .page_size if !.page_size.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 => 'DSGroupListResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: DSGroupsApi#get_ds_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#remove_ds_group_users(organization_id, account_id, ds_group_id, d_s_group_users_remove_request) ⇒ RemoveDSGroupUsersResponse
Remove users from a DSGroup Required scopes: user_write
416 417 418 419 |
# File 'lib/docusign_admin/api/ds_groups_api.rb', line 416 def remove_ds_group_users(organization_id, account_id, ds_group_id, d_s_group_users_remove_request) data, _status_code, _headers = remove_ds_group_users_with_http_info(organization_id, account_id, ds_group_id, d_s_group_users_remove_request) return data end |
#remove_ds_group_users_with_http_info(organization_id, account_id, ds_group_id, d_s_group_users_remove_request) ⇒ Array<(RemoveDSGroupUsersResponse, Fixnum, Hash)>
Remove users from a DSGroup Required scopes: user_write
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 |
# File 'lib/docusign_admin/api/ds_groups_api.rb', line 428 def remove_ds_group_users_with_http_info(organization_id, account_id, ds_group_id, d_s_group_users_remove_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: DSGroupsApi.remove_ds_group_users ..." end # verify the required parameter 'organization_id' is set fail ArgumentError, "Missing the required parameter 'organization_id' when calling DSGroupsApi.remove_ds_group_users" if organization_id.nil? # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling DSGroupsApi.remove_ds_group_users" if account_id.nil? # verify the required parameter 'ds_group_id' is set fail ArgumentError, "Missing the required parameter 'ds_group_id' when calling DSGroupsApi.remove_ds_group_users" if ds_group_id.nil? # verify the required parameter 'd_s_group_users_remove_request' is set fail ArgumentError, "Missing the required parameter 'd_s_group_users_remove_request' when calling DSGroupsApi.remove_ds_group_users" if d_s_group_users_remove_request.nil? # resource path local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}/users".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'dsGroupId' + '}', ds_group_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(d_s_group_users_remove_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 => 'RemoveDSGroupUsersResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: DSGroupsApi#remove_ds_group_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |