Class: DocuSign_Rooms::RoomFoldersApi
- Inherits:
-
Object
- Object
- DocuSign_Rooms::RoomFoldersApi
- Defined in:
- lib/docusign_rooms/api/room_folders_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_room_folders(room_id, account_id, options = DocuSign_Rooms::GetRoomFoldersOptions.default) ⇒ RoomFolderList
Gets room folders accessible to the calling user.
-
#get_room_folders_with_http_info(room_id, account_id, options = DocuSign_Rooms::GetRoomFoldersOptions.default) ⇒ Array<(RoomFolderList, Fixnum, Hash)>
Gets room folders accessible to the calling user.
-
#initialize(api_client = RoomFoldersApi.default) ⇒ RoomFoldersApi
constructor
A new instance of RoomFoldersApi.
Constructor Details
#initialize(api_client = RoomFoldersApi.default) ⇒ RoomFoldersApi
Returns a new instance of RoomFoldersApi.
32 33 34 |
# File 'lib/docusign_rooms/api/room_folders_api.rb', line 32 def initialize(api_client = RoomFoldersApi.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_rooms/api/room_folders_api.rb', line 30 def api_client @api_client end |
Instance Method Details
#get_room_folders(room_id, account_id, options = DocuSign_Rooms::GetRoomFoldersOptions.default) ⇒ RoomFolderList
Gets room folders accessible to the calling user. Gets a list of room folders in the specified room that are accessible to the current user.
42 43 44 45 |
# File 'lib/docusign_rooms/api/room_folders_api.rb', line 42 def get_room_folders(room_id, account_id, = DocuSign_Rooms::GetRoomFoldersOptions.default) data, _status_code, _headers = get_room_folders_with_http_info(room_id, account_id, ) return data end |
#get_room_folders_with_http_info(room_id, account_id, options = DocuSign_Rooms::GetRoomFoldersOptions.default) ⇒ Array<(RoomFolderList, Fixnum, Hash)>
Gets room folders accessible to the calling user. Gets a list of room folders in the specified room that are accessible to the current user.
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 |
# File 'lib/docusign_rooms/api/room_folders_api.rb', line 53 def get_room_folders_with_http_info(room_id, account_id, = DocuSign_Rooms::GetRoomFoldersOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoomFoldersApi.get_room_folders ..." end # verify the required parameter 'room_id' is set fail ArgumentError, "Missing the required parameter 'room_id' when calling RoomFoldersApi.get_room_folders" if room_id.nil? # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomFoldersApi.get_room_folders" if account_id.nil? # resource path local_var_path = "/v2/accounts/{accountId}/rooms/{roomId}/room_folders".sub('{format}','json').sub('{' + 'roomId' + '}', room_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'startPosition'] = .start_position if !.start_position.nil? query_params[:'count'] = .count if !.count.nil? # 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 => 'RoomFolderList') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoomFoldersApi#get_room_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |