Class: DocuSign_eSign::SigningGroupsApi
- Inherits:
-
Object
- Object
- DocuSign_eSign::SigningGroupsApi
- Defined in:
- lib/docusign_esign/api/signing_groups_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_list(account_id, signing_group_information) ⇒ SigningGroupInformation
Creates a signing group.
-
#create_list_with_http_info(account_id, signing_group_information) ⇒ Array<(SigningGroupInformation, Fixnum, Hash)>
Creates a signing group.
-
#delete_list(account_id, signing_group_information) ⇒ SigningGroupInformation
Deletes one or more signing groups.
-
#delete_list_with_http_info(account_id, signing_group_information) ⇒ Array<(SigningGroupInformation, Fixnum, Hash)>
Deletes one or more signing groups.
-
#delete_users(account_id, signing_group_id, signing_group_users) ⇒ SigningGroupUsers
Deletes one or more members from a signing group.
-
#delete_users_with_http_info(account_id, signing_group_id, signing_group_users) ⇒ Array<(SigningGroupUsers, Fixnum, Hash)>
Deletes one or more members from a signing group.
-
#get(account_id, signing_group_id) ⇒ SigningGroup
Gets information about a signing group.
-
#get_with_http_info(account_id, signing_group_id) ⇒ Array<(SigningGroup, Fixnum, Hash)>
Gets information about a signing group.
-
#initialize(api_client = SigningGroupsApi.default) ⇒ SigningGroupsApi
constructor
A new instance of SigningGroupsApi.
-
#list(account_id, options = DocuSign_eSign::ListOptions.default) ⇒ SigningGroupInformation
Gets a list of the Signing Groups in an account.
-
#list_users(account_id, signing_group_id) ⇒ SigningGroupUsers
Gets a list of members in a Signing Group.
-
#list_users_with_http_info(account_id, signing_group_id) ⇒ Array<(SigningGroupUsers, Fixnum, Hash)>
Gets a list of members in a Signing Group.
-
#list_with_http_info(account_id, options = DocuSign_eSign::ListOptions.default) ⇒ Array<(SigningGroupInformation, Fixnum, Hash)>
Gets a list of the Signing Groups in an account.
-
#update(account_id, signing_group_id, signing_group) ⇒ SigningGroup
Updates a signing group.
-
#update_list(account_id, signing_group_information) ⇒ SigningGroupInformation
Updates signing group names.
-
#update_list_with_http_info(account_id, signing_group_information) ⇒ Array<(SigningGroupInformation, Fixnum, Hash)>
Updates signing group names.
-
#update_users(account_id, signing_group_id, signing_group_users) ⇒ SigningGroupUsers
Adds members to a signing group.
-
#update_users_with_http_info(account_id, signing_group_id, signing_group_users) ⇒ Array<(SigningGroupUsers, Fixnum, Hash)>
Adds members to a signing group.
-
#update_with_http_info(account_id, signing_group_id, signing_group) ⇒ Array<(SigningGroup, Fixnum, Hash)>
Updates a signing group.
Constructor Details
#initialize(api_client = SigningGroupsApi.default) ⇒ SigningGroupsApi
Returns a new instance of SigningGroupsApi.
32 33 34 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 32 def initialize(api_client = SigningGroupsApi.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
30 31 32 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 30 def api_client @api_client end |
Instance Method Details
#create_list(account_id, signing_group_information) ⇒ SigningGroupInformation
Creates a signing group. Creates one or more signing groups. Multiple signing groups can be created in one call. Only users with account administrator privileges can create signing groups. An account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members. Signing groups can be used by any account user.
41 42 43 44 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 41 def create_list(account_id, signing_group_information) data, _status_code, _headers = create_list_with_http_info(account_id, signing_group_information) return data end |
#create_list_with_http_info(account_id, signing_group_information) ⇒ Array<(SigningGroupInformation, Fixnum, Hash)>
Creates a signing group. Creates one or more signing groups. Multiple signing groups can be created in one call. Only users with account administrator privileges can create signing groups. An account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members. Signing groups can be used by any account user.
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 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 51 def create_list_with_http_info(account_id, signing_group_information) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SigningGroupsApi.create_list ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling SigningGroupsApi.create_list" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signing_groups".sub('{format}','json').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']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(signing_group_information) 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 => 'SigningGroupInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: SigningGroupsApi#create_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_list(account_id, signing_group_information) ⇒ SigningGroupInformation
Deletes one or more signing groups. Deletes one or more signing groups in the specified account.
92 93 94 95 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 92 def delete_list(account_id, signing_group_information) data, _status_code, _headers = delete_list_with_http_info(account_id, signing_group_information) return data end |
#delete_list_with_http_info(account_id, signing_group_information) ⇒ Array<(SigningGroupInformation, Fixnum, Hash)>
Deletes one or more signing groups. Deletes one or more signing groups in the specified account.
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 130 131 132 133 134 135 136 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 102 def delete_list_with_http_info(account_id, signing_group_information) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SigningGroupsApi.delete_list ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling SigningGroupsApi.delete_list" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signing_groups".sub('{format}','json').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']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(signing_group_information) 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 => 'SigningGroupInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: SigningGroupsApi#delete_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_users(account_id, signing_group_id, signing_group_users) ⇒ SigningGroupUsers
Deletes one or more members from a signing group. Deletes one or more members from the specified signing group.
144 145 146 147 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 144 def delete_users(account_id, signing_group_id, signing_group_users) data, _status_code, _headers = delete_users_with_http_info(account_id, signing_group_id, signing_group_users) return data end |
#delete_users_with_http_info(account_id, signing_group_id, signing_group_users) ⇒ Array<(SigningGroupUsers, Fixnum, Hash)>
Deletes one or more members from a signing group. Deletes one or more members from the specified signing group.
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 155 def delete_users_with_http_info(account_id, signing_group_id, signing_group_users) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SigningGroupsApi.delete_users ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling SigningGroupsApi.delete_users" if account_id.nil? # verify the required parameter 'signing_group_id' is set fail ArgumentError, "Missing the required parameter 'signing_group_id' when calling SigningGroupsApi.delete_users" if signing_group_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'signingGroupId' + '}', signing_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']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(signing_group_users) 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 => 'SigningGroupUsers') if @api_client.config.debugging @api_client.config.logger.debug "API called: SigningGroupsApi#delete_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get(account_id, signing_group_id) ⇒ SigningGroup
Gets information about a signing group. Retrieves information, including group member information, for the specified signing group.
198 199 200 201 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 198 def get(account_id, signing_group_id) data, _status_code, _headers = get_with_http_info(account_id, signing_group_id) return data end |
#get_with_http_info(account_id, signing_group_id) ⇒ Array<(SigningGroup, Fixnum, Hash)>
Gets information about a signing group. Retrieves information, including group member information, for the specified signing group.
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 208 def get_with_http_info(account_id, signing_group_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SigningGroupsApi.get ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling SigningGroupsApi.get" if account_id.nil? # verify the required parameter 'signing_group_id' is set fail ArgumentError, "Missing the required parameter 'signing_group_id' when calling SigningGroupsApi.get" if signing_group_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'signingGroupId' + '}', signing_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']) # 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 => 'SigningGroup') if @api_client.config.debugging @api_client.config.logger.debug "API called: SigningGroupsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list(account_id, options = DocuSign_eSign::ListOptions.default) ⇒ SigningGroupInformation
Gets a list of the Signing Groups in an account. Retrieves a list of all signing groups in the specified account.
251 252 253 254 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 251 def list(account_id, = DocuSign_eSign::ListOptions.default) data, _status_code, _headers = list_with_http_info(account_id, ) return data end |
#list_users(account_id, signing_group_id) ⇒ SigningGroupUsers
Gets a list of members in a Signing Group. Retrieves the list of members in the specified Signing Group.
304 305 306 307 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 304 def list_users(account_id, signing_group_id) data, _status_code, _headers = list_users_with_http_info(account_id, signing_group_id) return data end |
#list_users_with_http_info(account_id, signing_group_id) ⇒ Array<(SigningGroupUsers, Fixnum, Hash)>
Gets a list of members in a Signing Group. Retrieves the list of members in the specified Signing Group.
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 349 350 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 314 def list_users_with_http_info(account_id, signing_group_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SigningGroupsApi.list_users ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling SigningGroupsApi.list_users" if account_id.nil? # verify the required parameter 'signing_group_id' is set fail ArgumentError, "Missing the required parameter 'signing_group_id' when calling SigningGroupsApi.list_users" if signing_group_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'signingGroupId' + '}', signing_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']) # 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 => 'SigningGroupUsers') if @api_client.config.debugging @api_client.config.logger.debug "API called: SigningGroupsApi#list_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_with_http_info(account_id, options = DocuSign_eSign::ListOptions.default) ⇒ Array<(SigningGroupInformation, Fixnum, Hash)>
Gets a list of the Signing Groups in an account. Retrieves a list of all signing groups in the specified account.
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 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 261 def list_with_http_info(account_id, = DocuSign_eSign::ListOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SigningGroupsApi.list ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling SigningGroupsApi.list" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signing_groups".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'group_type'] = .group_type if !.group_type.nil? query_params[:'include_users'] = .include_users if !.include_users.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['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 => 'SigningGroupInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: SigningGroupsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update(account_id, signing_group_id, signing_group) ⇒ SigningGroup
Updates a signing group. Updates signing group name and member information. You can also add new members to the signing group. A signing group can have a maximum of 50 members.
358 359 360 361 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 358 def update(account_id, signing_group_id, signing_group) data, _status_code, _headers = update_with_http_info(account_id, signing_group_id, signing_group) return data end |
#update_list(account_id, signing_group_information) ⇒ SigningGroupInformation
Updates signing group names. Updates the name of one or more existing signing groups.
412 413 414 415 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 412 def update_list(account_id, signing_group_information) data, _status_code, _headers = update_list_with_http_info(account_id, signing_group_information) return data end |
#update_list_with_http_info(account_id, signing_group_information) ⇒ Array<(SigningGroupInformation, Fixnum, Hash)>
Updates signing group names. Updates the name of one or more existing signing groups.
422 423 424 425 426 427 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 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 422 def update_list_with_http_info(account_id, signing_group_information) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SigningGroupsApi.update_list ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling SigningGroupsApi.update_list" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signing_groups".sub('{format}','json').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']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(signing_group_information) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'SigningGroupInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: SigningGroupsApi#update_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_users(account_id, signing_group_id, signing_group_users) ⇒ SigningGroupUsers
Adds members to a signing group. Adds one or more new members to a signing group. A signing group can have a maximum of 50 members.
464 465 466 467 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 464 def update_users(account_id, signing_group_id, signing_group_users) data, _status_code, _headers = update_users_with_http_info(account_id, signing_group_id, signing_group_users) return data end |
#update_users_with_http_info(account_id, signing_group_id, signing_group_users) ⇒ Array<(SigningGroupUsers, Fixnum, Hash)>
Adds members to a signing group. Adds one or more new members to a signing group. A signing group can have a maximum of 50 members.
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 475 def update_users_with_http_info(account_id, signing_group_id, signing_group_users) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SigningGroupsApi.update_users ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling SigningGroupsApi.update_users" if account_id.nil? # verify the required parameter 'signing_group_id' is set fail ArgumentError, "Missing the required parameter 'signing_group_id' when calling SigningGroupsApi.update_users" if signing_group_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'signingGroupId' + '}', signing_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']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(signing_group_users) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'SigningGroupUsers') if @api_client.config.debugging @api_client.config.logger.debug "API called: SigningGroupsApi#update_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_with_http_info(account_id, signing_group_id, signing_group) ⇒ Array<(SigningGroup, Fixnum, Hash)>
Updates a signing group. Updates signing group name and member information. You can also add new members to the signing group. A signing group can have a maximum of 50 members.
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 |
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 369 def update_with_http_info(account_id, signing_group_id, signing_group) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SigningGroupsApi.update ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling SigningGroupsApi.update" if account_id.nil? # verify the required parameter 'signing_group_id' is set fail ArgumentError, "Missing the required parameter 'signing_group_id' when calling SigningGroupsApi.update" if signing_group_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'signingGroupId' + '}', signing_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']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(signing_group) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'SigningGroup') if @api_client.config.debugging @api_client.config.logger.debug "API called: SigningGroupsApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |