Class: DocuSign_eSign::FoldersApi
- Inherits:
-
Object
- Object
- DocuSign_eSign::FoldersApi
- Defined in:
- lib/docusign_esign/api/folders_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = FoldersApi.default) ⇒ FoldersApi
constructor
A new instance of FoldersApi.
-
#list(account_id, options = DocuSign_eSign::ListOptions.default) ⇒ FoldersResponse
Gets a list of the folders for the account.
-
#list_items(account_id, folder_id, options = DocuSign_eSign::ListItemsOptions.default) ⇒ FolderItemsResponse
Gets a list of the envelopes in the specified folder.
-
#list_items_with_http_info(account_id, folder_id, options = DocuSign_eSign::ListItemsOptions.default) ⇒ Array<(FolderItemsResponse, Fixnum, Hash)>
Gets a list of the envelopes in the specified folder.
-
#list_with_http_info(account_id, options = DocuSign_eSign::ListOptions.default) ⇒ Array<(FoldersResponse, Fixnum, Hash)>
Gets a list of the folders for the account.
-
#move_envelopes(account_id, folder_id, folders_request) ⇒ FoldersResponse
Moves an envelope from its current folder to the specified folder.
-
#move_envelopes_with_http_info(account_id, folder_id, folders_request) ⇒ Array<(FoldersResponse, Fixnum, Hash)>
Moves an envelope from its current folder to the specified folder.
-
#search(account_id, search_folder_id, options = DocuSign_eSign::SearchOptions.default) ⇒ FolderItemResponse
Gets a list of envelopes in folders matching the specified criteria.
-
#search_with_http_info(account_id, search_folder_id, options = DocuSign_eSign::SearchOptions.default) ⇒ Array<(FolderItemResponse, Fixnum, Hash)>
Gets a list of envelopes in folders matching the specified criteria.
Constructor Details
#initialize(api_client = FoldersApi.default) ⇒ FoldersApi
Returns a new instance of FoldersApi.
101 102 103 |
# File 'lib/docusign_esign/api/folders_api.rb', line 101 def initialize(api_client = FoldersApi.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
99 100 101 |
# File 'lib/docusign_esign/api/folders_api.rb', line 99 def api_client @api_client end |
Instance Method Details
#list(account_id, options = DocuSign_eSign::ListOptions.default) ⇒ FoldersResponse
Gets a list of the folders for the account. Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the ‘template` query string parameter.
110 111 112 113 |
# File 'lib/docusign_esign/api/folders_api.rb', line 110 def list(account_id, = DocuSign_eSign::ListOptions.default) data, _status_code, _headers = list_with_http_info(account_id, ) return data end |
#list_items(account_id, folder_id, options = DocuSign_eSign::ListItemsOptions.default) ⇒ FolderItemsResponse
Gets a list of the envelopes in the specified folder. Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.
167 168 169 170 |
# File 'lib/docusign_esign/api/folders_api.rb', line 167 def list_items(account_id, folder_id, = DocuSign_eSign::ListItemsOptions.default) data, _status_code, _headers = list_items_with_http_info(account_id, folder_id, ) return data end |
#list_items_with_http_info(account_id, folder_id, options = DocuSign_eSign::ListItemsOptions.default) ⇒ Array<(FolderItemsResponse, Fixnum, Hash)>
Gets a list of the envelopes in the specified folder. Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.
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 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/docusign_esign/api/folders_api.rb', line 178 def list_items_with_http_info(account_id, folder_id, = DocuSign_eSign::ListItemsOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: FoldersApi.list_items ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling FoldersApi.list_items" if account_id.nil? # verify the required parameter 'folder_id' is set fail ArgumentError, "Missing the required parameter 'folder_id' when calling FoldersApi.list_items" if folder_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/folders/{folderId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s) # query parameters query_params = {} query_params[:'from_date'] = .from_date if !.from_date.nil? query_params[:'include_items'] = .include_items if !.include_items.nil? query_params[:'owner_email'] = .owner_email if !.owner_email.nil? query_params[:'owner_name'] = .owner_name if !.owner_name.nil? query_params[:'search_text'] = .search_text if !.search_text.nil? query_params[:'start_position'] = .start_position if !.start_position.nil? query_params[:'status'] = .status if !.status.nil? query_params[:'to_date'] = .to_date if !.to_date.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 => 'FolderItemsResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: FoldersApi#list_items\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<(FoldersResponse, Fixnum, Hash)>
Gets a list of the folders for the account. Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the `template` query string parameter.
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 154 155 156 157 158 159 |
# File 'lib/docusign_esign/api/folders_api.rb', line 120 def list_with_http_info(account_id, = DocuSign_eSign::ListOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: FoldersApi.list ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling FoldersApi.list" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/folders".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'include'] = .include if !.include.nil? query_params[:'include_items'] = .include_items if !.include_items.nil? query_params[:'start_position'] = .start_position if !.start_position.nil? query_params[:'template'] = .template if !.template.nil? query_params[:'user_filter'] = .user_filter if !.user_filter.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 => 'FoldersResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: FoldersApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#move_envelopes(account_id, folder_id, folders_request) ⇒ FoldersResponse
Moves an envelope from its current folder to the specified folder. Moves envelopes to the specified folder.
230 231 232 233 |
# File 'lib/docusign_esign/api/folders_api.rb', line 230 def move_envelopes(account_id, folder_id, folders_request) data, _status_code, _headers = move_envelopes_with_http_info(account_id, folder_id, folders_request) return data end |
#move_envelopes_with_http_info(account_id, folder_id, folders_request) ⇒ Array<(FoldersResponse, Fixnum, Hash)>
Moves an envelope from its current folder to the specified folder. Moves envelopes to the specified folder.
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 268 269 270 271 272 273 274 275 276 277 |
# File 'lib/docusign_esign/api/folders_api.rb', line 241 def move_envelopes_with_http_info(account_id, folder_id, folders_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: FoldersApi.move_envelopes ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling FoldersApi.move_envelopes" if account_id.nil? # verify the required parameter 'folder_id' is set fail ArgumentError, "Missing the required parameter 'folder_id' when calling FoldersApi.move_envelopes" if folder_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/folders/{folderId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'folderId' + '}', folder_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(folders_request) 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 => 'FoldersResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: FoldersApi#move_envelopes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#search(account_id, search_folder_id, options = DocuSign_eSign::SearchOptions.default) ⇒ FolderItemResponse
Gets a list of envelopes in folders matching the specified criteria. Retrieves a list of envelopes that match the criteria specified in the query. If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.
285 286 287 288 |
# File 'lib/docusign_esign/api/folders_api.rb', line 285 def search(account_id, search_folder_id, = DocuSign_eSign::SearchOptions.default) data, _status_code, _headers = search_with_http_info(account_id, search_folder_id, ) return data end |
#search_with_http_info(account_id, search_folder_id, options = DocuSign_eSign::SearchOptions.default) ⇒ Array<(FolderItemResponse, Fixnum, Hash)>
Gets a list of envelopes in folders matching the specified criteria. Retrieves a list of envelopes that match the criteria specified in the query. If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.
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 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 |
# File 'lib/docusign_esign/api/folders_api.rb', line 296 def search_with_http_info(account_id, search_folder_id, = DocuSign_eSign::SearchOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: FoldersApi.search ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling FoldersApi.search" if account_id.nil? # verify the required parameter 'search_folder_id' is set fail ArgumentError, "Missing the required parameter 'search_folder_id' when calling FoldersApi.search" if search_folder_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/search_folders/{searchFolderId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'searchFolderId' + '}', search_folder_id.to_s) # query parameters query_params = {} query_params[:'all'] = .all if !.all.nil? query_params[:'count'] = .count if !.count.nil? query_params[:'from_date'] = .from_date if !.from_date.nil? query_params[:'include_recipients'] = .include_recipients if !.include_recipients.nil? query_params[:'order'] = .order if !.order.nil? query_params[:'order_by'] = .order_by if !.order_by.nil? query_params[:'start_position'] = .start_position if !.start_position.nil? query_params[:'to_date'] = .to_date if !.to_date.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 => 'FolderItemResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: FoldersApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |