Class: DocuSign_Rooms::ESignPermissionProfilesApi
- Inherits:
-
Object
- Object
- DocuSign_Rooms::ESignPermissionProfilesApi
- Defined in:
- lib/docusign_rooms/api/e_sign_permission_profiles_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_e_sign_permission_profiles(account_id) ⇒ ESignPermissionProfileList
Gets permission profiles from the associated eSign account.
-
#get_e_sign_permission_profiles_with_http_info(account_id) ⇒ Array<(ESignPermissionProfileList, Fixnum, Hash)>
Gets permission profiles from the associated eSign account.
-
#initialize(api_client = ESignPermissionProfilesApi.default) ⇒ ESignPermissionProfilesApi
constructor
A new instance of ESignPermissionProfilesApi.
Constructor Details
#initialize(api_client = ESignPermissionProfilesApi.default) ⇒ ESignPermissionProfilesApi
Returns a new instance of ESignPermissionProfilesApi.
20 21 22 |
# File 'lib/docusign_rooms/api/e_sign_permission_profiles_api.rb', line 20 def initialize(api_client = ESignPermissionProfilesApi.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
18 19 20 |
# File 'lib/docusign_rooms/api/e_sign_permission_profiles_api.rb', line 18 def api_client @api_client end |
Instance Method Details
#get_e_sign_permission_profiles(account_id) ⇒ ESignPermissionProfileList
Gets permission profiles from the associated eSign account. When you create or invite a new member in Rooms, the system creates an eSignature account for the member at the same time. This method returns a list of the eSignature permission profiles that the current user may be able to assign to a new member. The current user may not assign a permission higher than their own permission.
28 29 30 31 |
# File 'lib/docusign_rooms/api/e_sign_permission_profiles_api.rb', line 28 def (account_id) data, _status_code, _headers = (account_id) return data end |
#get_e_sign_permission_profiles_with_http_info(account_id) ⇒ Array<(ESignPermissionProfileList, Fixnum, Hash)>
Gets permission profiles from the associated eSign account. When you create or invite a new member in Rooms, the system creates an eSignature account for the member at the same time. This method returns a list of the eSignature permission profiles that the current user may be able to assign to a new member. The current user may not assign a permission higher than their own permission.
37 38 39 40 41 42 43 44 45 46 47 48 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 |
# File 'lib/docusign_rooms/api/e_sign_permission_profiles_api.rb', line 37 def (account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ESignPermissionProfilesApi.get_e_sign_permission_profiles ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling ESignPermissionProfilesApi.get_e_sign_permission_profiles" if account_id.nil? # resource path local_var_path = "/v2/accounts/{accountId}/esign_permission_profiles".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(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', '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 => 'ESignPermissionProfileList') if @api_client.config.debugging @api_client.config.logger.debug "API called: ESignPermissionProfilesApi#get_e_sign_permission_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |