Class: DocuSign_eSign::TemplatesApi
- Inherits:
-
Object
- Object
- DocuSign_eSign::TemplatesApi
- Defined in:
- lib/docusign_esign/api/templates_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_custom_fields(account_id, template_id, template_custom_fields) ⇒ CustomFields
Creates custom document fields in an existing template document.
-
#create_custom_fields_with_http_info(account_id, template_id, template_custom_fields) ⇒ Array<(CustomFields, Fixnum, Hash)>
Creates custom document fields in an existing template document.
-
#create_document_fields(account_id, document_id, template_id, document_fields_information) ⇒ DocumentFieldsInformation
Creates custom document fields in an existing template document.
-
#create_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information) ⇒ Array<(DocumentFieldsInformation, Fixnum, Hash)>
Creates custom document fields in an existing template document.
-
#create_edit_view(account_id, template_id, return_url_request) ⇒ ViewUrl
Provides a URL to start an edit view of the Template UI.
-
#create_edit_view_with_http_info(account_id, template_id, return_url_request) ⇒ Array<(ViewUrl, Fixnum, Hash)>
Provides a URL to start an edit view of the Template UI.
-
#create_lock(account_id, template_id, lock_request) ⇒ LockInformation
Lock a template.
-
#create_lock_with_http_info(account_id, template_id, lock_request) ⇒ Array<(LockInformation, Fixnum, Hash)>
Lock a template.
-
#create_recipients(account_id, template_id, template_recipients, options = DocuSign_eSign::CreateRecipientsOptions.default) ⇒ Recipients
Adds tabs for a recipient.
-
#create_recipients_with_http_info(account_id, template_id, template_recipients, options = DocuSign_eSign::CreateRecipientsOptions.default) ⇒ Array<(Recipients, Fixnum, Hash)>
Adds tabs for a recipient.
-
#create_tabs(account_id, recipient_id, template_id, template_tabs) ⇒ Tabs
Adds tabs for a recipient.
-
#create_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Adds tabs for a recipient.
-
#create_template(account_id, envelope_template) ⇒ TemplateSummary
Creates an envelope from a template.
-
#create_template_document_responsive_html_preview(account_id, document_id, template_id, document_html_definition) ⇒ DocumentHtmlDefinitions
Post Responsive HTML Preview for a document in a template.
-
#create_template_document_responsive_html_preview_with_http_info(account_id, document_id, template_id, document_html_definition) ⇒ Array<(DocumentHtmlDefinitions, Fixnum, Hash)>
Post Responsive HTML Preview for a document in a template.
-
#create_template_document_tabs(account_id, document_id, template_id, template_tabs) ⇒ Tabs
Adds the tabs to a tempate.
-
#create_template_document_tabs_with_http_info(account_id, document_id, template_id, template_tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Adds the tabs to a tempate.
-
#create_template_recipient_preview(account_id, template_id, recipient_preview_request) ⇒ ViewUrl
Provides a URL to start a recipient view of the Envelope UI.
-
#create_template_recipient_preview_with_http_info(account_id, template_id, recipient_preview_request) ⇒ Array<(ViewUrl, Fixnum, Hash)>
Provides a URL to start a recipient view of the Envelope UI.
-
#create_template_responsive_html_preview(account_id, template_id, document_html_definition) ⇒ DocumentHtmlDefinitions
Get Responsive HTML Preview for all documents in a template.
-
#create_template_responsive_html_preview_with_http_info(account_id, template_id, document_html_definition) ⇒ Array<(DocumentHtmlDefinitions, Fixnum, Hash)>
Get Responsive HTML Preview for all documents in a template.
-
#create_template_with_http_info(account_id, envelope_template) ⇒ Array<(TemplateSummary, Fixnum, Hash)>
Creates an envelope from a template.
-
#delete_bulk_recipients(account_id, recipient_id, template_id) ⇒ BulkRecipientsUpdateResponse
Deletes the bulk recipient list on a template.
-
#delete_bulk_recipients_with_http_info(account_id, recipient_id, template_id) ⇒ Array<(BulkRecipientsUpdateResponse, Fixnum, Hash)>
Deletes the bulk recipient list on a template.
-
#delete_custom_fields(account_id, template_id, template_custom_fields) ⇒ CustomFields
Deletes envelope custom fields in a template.
-
#delete_custom_fields_with_http_info(account_id, template_id, template_custom_fields) ⇒ Array<(CustomFields, Fixnum, Hash)>
Deletes envelope custom fields in a template.
-
#delete_document_fields(account_id, document_id, template_id, document_fields_information) ⇒ DocumentFieldsInformation
Deletes custom document fields from an existing template document.
-
#delete_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information) ⇒ Array<(DocumentFieldsInformation, Fixnum, Hash)>
Deletes custom document fields from an existing template document.
-
#delete_document_page(account_id, document_id, page_number, template_id, page_request) ⇒ nil
Deletes a page from a document in an template.
-
#delete_document_page_with_http_info(account_id, document_id, page_number, template_id, page_request) ⇒ Array<(nil, Fixnum, Hash)>
Deletes a page from a document in an template.
-
#delete_documents(account_id, template_id, envelope_definition) ⇒ TemplateDocumentsResult
Deletes documents from a template.
-
#delete_documents_with_http_info(account_id, template_id, envelope_definition) ⇒ Array<(TemplateDocumentsResult, Fixnum, Hash)>
Deletes documents from a template.
-
#delete_group_share(account_id, template_id, template_part, group_information) ⇒ GroupInformation
Removes a member group’s sharing permissions for a template.
-
#delete_group_share_with_http_info(account_id, template_id, template_part, group_information) ⇒ Array<(GroupInformation, Fixnum, Hash)>
Removes a member group's sharing permissions for a template.
-
#delete_lock(account_id, template_id, lock_request) ⇒ LockInformation
Deletes a template lock.
-
#delete_lock_with_http_info(account_id, template_id, lock_request) ⇒ Array<(LockInformation, Fixnum, Hash)>
Deletes a template lock.
-
#delete_recipient(account_id, recipient_id, template_id, template_recipients) ⇒ Recipients
Deletes the specified recipient file from a template.
-
#delete_recipient_with_http_info(account_id, recipient_id, template_id, template_recipients) ⇒ Array<(Recipients, Fixnum, Hash)>
Deletes the specified recipient file from a template.
-
#delete_recipients(account_id, template_id, template_recipients) ⇒ Recipients
Deletes recipients from a template.
-
#delete_recipients_with_http_info(account_id, template_id, template_recipients) ⇒ Array<(Recipients, Fixnum, Hash)>
Deletes recipients from a template.
-
#delete_tabs(account_id, recipient_id, template_id, template_tabs) ⇒ Tabs
Deletes the tabs associated with a recipient in a template.
-
#delete_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Deletes the tabs associated with a recipient in a template.
-
#delete_template_document_tabs(account_id, document_id, template_id, template_tabs) ⇒ Tabs
Deletes tabs from an envelope document.
-
#delete_template_document_tabs_with_http_info(account_id, document_id, template_id, template_tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Deletes tabs from an envelope document.
-
#get(account_id, template_id, options = DocuSign_eSign::GetOptions.default) ⇒ EnvelopeTemplate
Gets a list of templates for a specified account.
-
#get_document(account_id, document_id, template_id, options = DocuSign_eSign::GetDocumentOptions.default) ⇒ File
Gets PDF documents from a template.
-
#get_document_page_image(account_id, document_id, page_number, template_id, options = DocuSign_eSign::GetDocumentPageImageOptions.default) ⇒ File
Gets a page image from a template for display.
-
#get_document_page_image_with_http_info(account_id, document_id, page_number, template_id, options = DocuSign_eSign::GetDocumentPageImageOptions.default) ⇒ Array<(File, Fixnum, Hash)>
Gets a page image from a template for display.
-
#get_document_tabs(account_id, document_id, template_id, options = DocuSign_eSign::GetDocumentTabsOptions.default) ⇒ Tabs
Returns tabs on the document.
-
#get_document_tabs_with_http_info(account_id, document_id, template_id, options = DocuSign_eSign::GetDocumentTabsOptions.default) ⇒ Array<(Tabs, Fixnum, Hash)>
Returns tabs on the document.
-
#get_document_with_http_info(account_id, document_id, template_id, options = DocuSign_eSign::GetDocumentOptions.default) ⇒ Array<(File, Fixnum, Hash)>
Gets PDF documents from a template.
-
#get_lock(account_id, template_id) ⇒ LockInformation
Gets template lock information.
-
#get_lock_with_http_info(account_id, template_id) ⇒ Array<(LockInformation, Fixnum, Hash)>
Gets template lock information.
-
#get_notification_settings(account_id, template_id) ⇒ Notification
Gets template notification information.
-
#get_notification_settings_with_http_info(account_id, template_id) ⇒ Array<(Notification, Fixnum, Hash)>
Gets template notification information.
-
#get_page_tabs(account_id, document_id, page_number, template_id) ⇒ Tabs
Returns tabs on the specified page.
-
#get_page_tabs_with_http_info(account_id, document_id, page_number, template_id) ⇒ Array<(Tabs, Fixnum, Hash)>
Returns tabs on the specified page.
-
#get_pages(account_id, document_id, template_id, options = DocuSign_eSign::GetPagesOptions.default) ⇒ PageImages
Returns document page image(s) based on input.
-
#get_pages_with_http_info(account_id, document_id, template_id, options = DocuSign_eSign::GetPagesOptions.default) ⇒ Array<(PageImages, Fixnum, Hash)>
Returns document page image(s) based on input.
-
#get_template_document_html_definitions(account_id, document_id, template_id) ⇒ DocumentHtmlDefinitionOriginals
Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
-
#get_template_document_html_definitions_with_http_info(account_id, document_id, template_id) ⇒ Array<(DocumentHtmlDefinitionOriginals, Fixnum, Hash)>
Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
-
#get_template_html_definitions(account_id, template_id) ⇒ DocumentHtmlDefinitionOriginals
Get the Original HTML Definition used to generate the Responsive HTML for the template.
-
#get_template_html_definitions_with_http_info(account_id, template_id) ⇒ Array<(DocumentHtmlDefinitionOriginals, Fixnum, Hash)>
Get the Original HTML Definition used to generate the Responsive HTML for the template.
-
#get_with_http_info(account_id, template_id, options = DocuSign_eSign::GetOptions.default) ⇒ Array<(EnvelopeTemplate, Fixnum, Hash)>
Gets a list of templates for a specified account.
-
#initialize(api_client = TemplatesApi.default) ⇒ TemplatesApi
constructor
A new instance of TemplatesApi.
-
#list_bulk_recipients(account_id, recipient_id, template_id, options = DocuSign_eSign::ListBulkRecipientsOptions.default) ⇒ BulkRecipientsResponse
Gets the bulk recipient file from a template.
-
#list_bulk_recipients_with_http_info(account_id, recipient_id, template_id, options = DocuSign_eSign::ListBulkRecipientsOptions.default) ⇒ Array<(BulkRecipientsResponse, Fixnum, Hash)>
Gets the bulk recipient file from a template.
-
#list_custom_fields(account_id, template_id) ⇒ CustomFields
Gets the custom document fields from a template.
-
#list_custom_fields_with_http_info(account_id, template_id) ⇒ Array<(CustomFields, Fixnum, Hash)>
Gets the custom document fields from a template.
-
#list_document_fields(account_id, document_id, template_id) ⇒ DocumentFieldsInformation
Gets the custom document fields for a an existing template document.
-
#list_document_fields_with_http_info(account_id, document_id, template_id) ⇒ Array<(DocumentFieldsInformation, Fixnum, Hash)>
Gets the custom document fields for a an existing template document.
-
#list_documents(account_id, template_id, options = DocuSign_eSign::ListDocumentsOptions.default) ⇒ TemplateDocumentsResult
Gets a list of documents associated with a template.
-
#list_documents_with_http_info(account_id, template_id, options = DocuSign_eSign::ListDocumentsOptions.default) ⇒ Array<(TemplateDocumentsResult, Fixnum, Hash)>
Gets a list of documents associated with a template.
-
#list_recipients(account_id, template_id, options = DocuSign_eSign::ListRecipientsOptions.default) ⇒ Recipients
Gets recipient information from a template.
-
#list_recipients_with_http_info(account_id, template_id, options = DocuSign_eSign::ListRecipientsOptions.default) ⇒ Array<(Recipients, Fixnum, Hash)>
Gets recipient information from a template.
-
#list_tabs(account_id, recipient_id, template_id, options = DocuSign_eSign::ListTabsOptions.default) ⇒ Tabs
Gets the tabs information for a signer or sign-in-person recipient in a template.
-
#list_tabs_with_http_info(account_id, recipient_id, template_id, options = DocuSign_eSign::ListTabsOptions.default) ⇒ Array<(Tabs, Fixnum, Hash)>
Gets the tabs information for a signer or sign-in-person recipient in a template.
-
#list_templates(account_id, options = DocuSign_eSign::ListTemplatesOptions.default) ⇒ EnvelopeTemplateResults
Gets the definition of a template.
-
#list_templates_with_http_info(account_id, options = DocuSign_eSign::ListTemplatesOptions.default) ⇒ Array<(EnvelopeTemplateResults, Fixnum, Hash)>
Gets the definition of a template.
-
#rotate_document_page(account_id, document_id, page_number, template_id, page_request) ⇒ nil
Rotates page image from a template for display.
-
#rotate_document_page_with_http_info(account_id, document_id, page_number, template_id, page_request) ⇒ Array<(nil, Fixnum, Hash)>
Rotates page image from a template for display.
-
#update(account_id, template_id, envelope_template) ⇒ TemplateUpdateSummary
Updates an existing template.
-
#update_bulk_recipients(account_id, recipient_id, template_id, bulk_recipients_request) ⇒ BulkRecipientsSummaryResponse
Adds or replaces the bulk recipients list in a template.
-
#update_bulk_recipients_with_http_info(account_id, recipient_id, template_id, bulk_recipients_request) ⇒ Array<(BulkRecipientsSummaryResponse, Fixnum, Hash)>
Adds or replaces the bulk recipients list in a template.
-
#update_custom_fields(account_id, template_id, template_custom_fields) ⇒ CustomFields
Updates envelope custom fields in a template.
-
#update_custom_fields_with_http_info(account_id, template_id, template_custom_fields) ⇒ Array<(CustomFields, Fixnum, Hash)>
Updates envelope custom fields in a template.
-
#update_document(account_id, document_id, template_id, envelope_definition, options = DocuSign_eSign::UpdateDocumentOptions.default) ⇒ EnvelopeDocument
Adds a document to a template document.
-
#update_document_fields(account_id, document_id, template_id, document_fields_information) ⇒ DocumentFieldsInformation
Updates existing custom document fields in an existing template document.
-
#update_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information) ⇒ Array<(DocumentFieldsInformation, Fixnum, Hash)>
Updates existing custom document fields in an existing template document.
-
#update_document_with_http_info(account_id, document_id, template_id, envelope_definition, options = DocuSign_eSign::UpdateDocumentOptions.default) ⇒ Array<(EnvelopeDocument, Fixnum, Hash)>
Adds a document to a template document.
-
#update_documents(account_id, template_id, envelope_definition) ⇒ TemplateDocumentsResult
Adds documents to a template document.
-
#update_documents_with_http_info(account_id, template_id, envelope_definition) ⇒ Array<(TemplateDocumentsResult, Fixnum, Hash)>
Adds documents to a template document.
-
#update_group_share(account_id, template_id, template_part, group_information) ⇒ GroupInformation
Shares a template with a group Shares a template with the specified members group.
-
#update_group_share_with_http_info(account_id, template_id, template_part, group_information) ⇒ Array<(GroupInformation, Fixnum, Hash)>
Shares a template with a group Shares a template with the specified members group.
-
#update_lock(account_id, template_id, lock_request) ⇒ LockInformation
Updates a template lock.
-
#update_lock_with_http_info(account_id, template_id, lock_request) ⇒ Array<(LockInformation, Fixnum, Hash)>
Updates a template lock.
-
#update_notification_settings(account_id, template_id, template_notification_request) ⇒ Notification
Updates the notification structure for an existing template.
-
#update_notification_settings_with_http_info(account_id, template_id, template_notification_request) ⇒ Array<(Notification, Fixnum, Hash)>
Updates the notification structure for an existing template.
-
#update_recipients(account_id, template_id, template_recipients, options = DocuSign_eSign::UpdateRecipientsOptions.default) ⇒ RecipientsUpdateSummary
Updates recipients in a template.
-
#update_recipients_with_http_info(account_id, template_id, template_recipients, options = DocuSign_eSign::UpdateRecipientsOptions.default) ⇒ Array<(RecipientsUpdateSummary, Fixnum, Hash)>
Updates recipients in a template.
-
#update_tabs(account_id, recipient_id, template_id, template_tabs) ⇒ Tabs
Updates the tabs for a recipient.
-
#update_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Updates the tabs for a recipient.
-
#update_template_document_tabs(account_id, document_id, template_id, template_tabs) ⇒ Tabs
Updates the tabs for a template.
-
#update_template_document_tabs_with_http_info(account_id, document_id, template_id, template_tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Updates the tabs for a template.
-
#update_with_http_info(account_id, template_id, envelope_template) ⇒ Array<(TemplateUpdateSummary, Fixnum, Hash)>
Updates an existing template.
Constructor Details
#initialize(api_client = TemplatesApi.default) ⇒ TemplatesApi
Returns a new instance of TemplatesApi.
242 243 244 |
# File 'lib/docusign_esign/api/templates_api.rb', line 242 def initialize(api_client = TemplatesApi.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
240 241 242 |
# File 'lib/docusign_esign/api/templates_api.rb', line 240 def api_client @api_client end |
Instance Method Details
#create_custom_fields(account_id, template_id, template_custom_fields) ⇒ CustomFields
Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.
252 253 254 255 |
# File 'lib/docusign_esign/api/templates_api.rb', line 252 def create_custom_fields(account_id, template_id, template_custom_fields) data, _status_code, _headers = create_custom_fields_with_http_info(account_id, template_id, template_custom_fields) return data end |
#create_custom_fields_with_http_info(account_id, template_id, template_custom_fields) ⇒ Array<(CustomFields, Fixnum, Hash)>
Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.
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 298 299 |
# File 'lib/docusign_esign/api/templates_api.rb', line 263 def create_custom_fields_with_http_info(account_id, template_id, template_custom_fields) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.create_custom_fields ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_custom_fields" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.create_custom_fields" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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(template_custom_fields) 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 => 'CustomFields') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#create_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_document_fields(account_id, document_id, template_id, document_fields_information) ⇒ DocumentFieldsInformation
Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.
308 309 310 311 |
# File 'lib/docusign_esign/api/templates_api.rb', line 308 def create_document_fields(account_id, document_id, template_id, document_fields_information) data, _status_code, _headers = create_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information) return data end |
#create_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information) ⇒ Array<(DocumentFieldsInformation, Fixnum, Hash)>
Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.
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 351 352 353 354 355 356 357 358 |
# File 'lib/docusign_esign/api/templates_api.rb', line 320 def create_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.create_document_fields ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_document_fields" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.create_document_fields" if document_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.create_document_fields" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_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(document_fields_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 => 'DocumentFieldsInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#create_document_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_edit_view(account_id, template_id, return_url_request) ⇒ ViewUrl
Provides a URL to start an edit view of the Template UI
366 367 368 369 |
# File 'lib/docusign_esign/api/templates_api.rb', line 366 def create_edit_view(account_id, template_id, return_url_request) data, _status_code, _headers = create_edit_view_with_http_info(account_id, template_id, return_url_request) return data end |
#create_edit_view_with_http_info(account_id, template_id, return_url_request) ⇒ Array<(ViewUrl, Fixnum, Hash)>
Provides a URL to start an edit view of the Template UI
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 408 409 410 411 412 413 |
# File 'lib/docusign_esign/api/templates_api.rb', line 377 def create_edit_view_with_http_info(account_id, template_id, return_url_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.create_edit_view ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_edit_view" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.create_edit_view" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/views/edit".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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(return_url_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 => 'ViewUrl') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#create_edit_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_lock(account_id, template_id, lock_request) ⇒ LockInformation
Lock a template. Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property ‘canLockEnvelopes` must be set to true for the user).
421 422 423 424 |
# File 'lib/docusign_esign/api/templates_api.rb', line 421 def create_lock(account_id, template_id, lock_request) data, _status_code, _headers = create_lock_with_http_info(account_id, template_id, lock_request) return data end |
#create_lock_with_http_info(account_id, template_id, lock_request) ⇒ Array<(LockInformation, Fixnum, Hash)>
Lock a template. Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property `canLockEnvelopes` must be set to true for the user).
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 |
# File 'lib/docusign_esign/api/templates_api.rb', line 432 def create_lock_with_http_info(account_id, template_id, lock_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.create_lock ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_lock" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.create_lock" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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(lock_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 => 'LockInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#create_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_recipients(account_id, template_id, template_recipients, options = DocuSign_eSign::CreateRecipientsOptions.default) ⇒ Recipients
Adds tabs for a recipient. Adds one or more recipients to a template.
477 478 479 480 |
# File 'lib/docusign_esign/api/templates_api.rb', line 477 def create_recipients(account_id, template_id, template_recipients, = DocuSign_eSign::CreateRecipientsOptions.default) data, _status_code, _headers = create_recipients_with_http_info(account_id, template_id, template_recipients, ) return data end |
#create_recipients_with_http_info(account_id, template_id, template_recipients, options = DocuSign_eSign::CreateRecipientsOptions.default) ⇒ Array<(Recipients, Fixnum, Hash)>
Adds tabs for a recipient. Adds one or more recipients to a template.
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 |
# File 'lib/docusign_esign/api/templates_api.rb', line 489 def create_recipients_with_http_info(account_id, template_id, template_recipients, = DocuSign_eSign::CreateRecipientsOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.create_recipients ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_recipients" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.create_recipients" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s) # query parameters query_params = {} query_params[:'resend_envelope'] = .resend_envelope if !.resend_envelope.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 = @api_client.object_to_http_body(template_recipients) 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 => 'Recipients') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#create_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_tabs(account_id, recipient_id, template_id, template_tabs) ⇒ Tabs
Adds tabs for a recipient. Adds one or more tabs for a recipient.
535 536 537 538 |
# File 'lib/docusign_esign/api/templates_api.rb', line 535 def create_tabs(account_id, recipient_id, template_id, template_tabs) data, _status_code, _headers = create_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs) return data end |
#create_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Adds tabs for a recipient. Adds one or more tabs for a recipient.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 |
# File 'lib/docusign_esign/api/templates_api.rb', line 547 def create_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.create_tabs ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_tabs" if account_id.nil? # verify the required parameter 'recipient_id' is set fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.create_tabs" if recipient_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.create_tabs" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_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(template_tabs) 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 => 'Tabs') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#create_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_template(account_id, envelope_template) ⇒ TemplateSummary
Creates an envelope from a template. Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient’s role name, are added to the ‘emailSubject` property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient’s name in the subject line add the following text in the ‘emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` To add a recipient’s email address in the subject line add the following text in the ‘emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient’s contents of the ‘roleName` property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.
592 593 594 595 |
# File 'lib/docusign_esign/api/templates_api.rb', line 592 def create_template(account_id, envelope_template) data, _status_code, _headers = create_template_with_http_info(account_id, envelope_template) return data end |
#create_template_document_responsive_html_preview(account_id, document_id, template_id, document_html_definition) ⇒ DocumentHtmlDefinitions
Post Responsive HTML Preview for a document in a template.
645 646 647 648 |
# File 'lib/docusign_esign/api/templates_api.rb', line 645 def create_template_document_responsive_html_preview(account_id, document_id, template_id, document_html_definition) data, _status_code, _headers = create_template_document_responsive_html_preview_with_http_info(account_id, document_id, template_id, document_html_definition) return data end |
#create_template_document_responsive_html_preview_with_http_info(account_id, document_id, template_id, document_html_definition) ⇒ Array<(DocumentHtmlDefinitions, Fixnum, Hash)>
Post Responsive HTML Preview for a document in a template.
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 |
# File 'lib/docusign_esign/api/templates_api.rb', line 657 def create_template_document_responsive_html_preview_with_http_info(account_id, document_id, template_id, document_html_definition) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.create_template_document_responsive_html_preview ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_template_document_responsive_html_preview" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.create_template_document_responsive_html_preview" if document_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.create_template_document_responsive_html_preview" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_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(document_html_definition) 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 => 'DocumentHtmlDefinitions') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#create_template_document_responsive_html_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_template_document_tabs(account_id, document_id, template_id, template_tabs) ⇒ Tabs
Adds the tabs to a tempate
704 705 706 707 |
# File 'lib/docusign_esign/api/templates_api.rb', line 704 def create_template_document_tabs(account_id, document_id, template_id, template_tabs) data, _status_code, _headers = create_template_document_tabs_with_http_info(account_id, document_id, template_id, template_tabs) return data end |
#create_template_document_tabs_with_http_info(account_id, document_id, template_id, template_tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Adds the tabs to a tempate
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 |
# File 'lib/docusign_esign/api/templates_api.rb', line 716 def create_template_document_tabs_with_http_info(account_id, document_id, template_id, template_tabs) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.create_template_document_tabs ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_template_document_tabs" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.create_template_document_tabs" if document_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.create_template_document_tabs" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_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(template_tabs) 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 => 'Tabs') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#create_template_document_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_template_recipient_preview(account_id, template_id, recipient_preview_request) ⇒ ViewUrl
Provides a URL to start a recipient view of the Envelope UI
762 763 764 765 |
# File 'lib/docusign_esign/api/templates_api.rb', line 762 def create_template_recipient_preview(account_id, template_id, recipient_preview_request) data, _status_code, _headers = create_template_recipient_preview_with_http_info(account_id, template_id, recipient_preview_request) return data end |
#create_template_recipient_preview_with_http_info(account_id, template_id, recipient_preview_request) ⇒ Array<(ViewUrl, Fixnum, Hash)>
Provides a URL to start a recipient view of the Envelope UI
773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 |
# File 'lib/docusign_esign/api/templates_api.rb', line 773 def create_template_recipient_preview_with_http_info(account_id, template_id, recipient_preview_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.create_template_recipient_preview ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_template_recipient_preview" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.create_template_recipient_preview" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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(recipient_preview_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 => 'ViewUrl') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#create_template_recipient_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_template_responsive_html_preview(account_id, template_id, document_html_definition) ⇒ DocumentHtmlDefinitions
Get Responsive HTML Preview for all documents in a template.
817 818 819 820 |
# File 'lib/docusign_esign/api/templates_api.rb', line 817 def create_template_responsive_html_preview(account_id, template_id, document_html_definition) data, _status_code, _headers = create_template_responsive_html_preview_with_http_info(account_id, template_id, document_html_definition) return data end |
#create_template_responsive_html_preview_with_http_info(account_id, template_id, document_html_definition) ⇒ Array<(DocumentHtmlDefinitions, Fixnum, Hash)>
Get Responsive HTML Preview for all documents in a template.
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 |
# File 'lib/docusign_esign/api/templates_api.rb', line 828 def create_template_responsive_html_preview_with_http_info(account_id, template_id, document_html_definition) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.create_template_responsive_html_preview ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_template_responsive_html_preview" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.create_template_responsive_html_preview" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/responsive_html_preview".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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(document_html_definition) 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 => 'DocumentHtmlDefinitions') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#create_template_responsive_html_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_template_with_http_info(account_id, envelope_template) ⇒ Array<(TemplateSummary, Fixnum, Hash)>
Creates an envelope from a template. Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's role name, are added to the `emailSubject` property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` To add a recipient's email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's contents of the `roleName` property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 |
# File 'lib/docusign_esign/api/templates_api.rb', line 602 def create_template_with_http_info(account_id, envelope_template) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.create_template ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_template" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates".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(envelope_template) 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 => 'TemplateSummary') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#create_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_bulk_recipients(account_id, recipient_id, template_id) ⇒ BulkRecipientsUpdateResponse
Deletes the bulk recipient list on a template. Deletes the bulk recipient list on a template.
872 873 874 875 |
# File 'lib/docusign_esign/api/templates_api.rb', line 872 def delete_bulk_recipients(account_id, recipient_id, template_id) data, _status_code, _headers = delete_bulk_recipients_with_http_info(account_id, recipient_id, template_id) return data end |
#delete_bulk_recipients_with_http_info(account_id, recipient_id, template_id) ⇒ Array<(BulkRecipientsUpdateResponse, Fixnum, Hash)>
Deletes the bulk recipient list on a template. Deletes the bulk recipient list on a template.
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 |
# File 'lib/docusign_esign/api/templates_api.rb', line 883 def delete_bulk_recipients_with_http_info(account_id, recipient_id, template_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.delete_bulk_recipients ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_bulk_recipients" if account_id.nil? # verify the required parameter 'recipient_id' is set fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.delete_bulk_recipients" if recipient_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_bulk_recipients" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_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(: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 => 'BulkRecipientsUpdateResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#delete_bulk_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_custom_fields(account_id, template_id, template_custom_fields) ⇒ CustomFields
Deletes envelope custom fields in a template. Deletes envelope custom fields in a template.
929 930 931 932 |
# File 'lib/docusign_esign/api/templates_api.rb', line 929 def delete_custom_fields(account_id, template_id, template_custom_fields) data, _status_code, _headers = delete_custom_fields_with_http_info(account_id, template_id, template_custom_fields) return data end |
#delete_custom_fields_with_http_info(account_id, template_id, template_custom_fields) ⇒ Array<(CustomFields, Fixnum, Hash)>
Deletes envelope custom fields in a template. Deletes envelope custom fields in a template.
940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 |
# File 'lib/docusign_esign/api/templates_api.rb', line 940 def delete_custom_fields_with_http_info(account_id, template_id, template_custom_fields) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.delete_custom_fields ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_custom_fields" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_custom_fields" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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(template_custom_fields) 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 => 'CustomFields') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#delete_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_document_fields(account_id, document_id, template_id, document_fields_information) ⇒ DocumentFieldsInformation
Deletes custom document fields from an existing template document. Deletes custom document fields from an existing template document.
985 986 987 988 |
# File 'lib/docusign_esign/api/templates_api.rb', line 985 def delete_document_fields(account_id, document_id, template_id, document_fields_information) data, _status_code, _headers = delete_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information) return data end |
#delete_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information) ⇒ Array<(DocumentFieldsInformation, Fixnum, Hash)>
Deletes custom document fields from an existing template document. Deletes custom document fields from an existing template document.
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 |
# File 'lib/docusign_esign/api/templates_api.rb', line 997 def delete_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.delete_document_fields ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_document_fields" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.delete_document_fields" if document_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_document_fields" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_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(document_fields_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 => 'DocumentFieldsInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#delete_document_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_document_page(account_id, document_id, page_number, template_id, page_request) ⇒ nil
Deletes a page from a document in an template. Deletes a page from a document in a template based on the page number.
1045 1046 1047 1048 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1045 def delete_document_page(account_id, document_id, page_number, template_id, page_request) delete_document_page_with_http_info(account_id, document_id, page_number, template_id, page_request) return nil end |
#delete_document_page_with_http_info(account_id, document_id, page_number, template_id, page_request) ⇒ Array<(nil, Fixnum, Hash)>
Deletes a page from a document in an template. Deletes a page from a document in a template based on the page number.
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1058 def delete_document_page_with_http_info(account_id, document_id, page_number, template_id, page_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.delete_document_page ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_document_page" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.delete_document_page" if document_id.nil? # verify the required parameter 'page_number' is set fail ArgumentError, "Missing the required parameter 'page_number' when calling TemplatesApi.delete_document_page" if page_number.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_document_page" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'templateId' + '}', template_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(page_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) if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#delete_document_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_documents(account_id, template_id, envelope_definition) ⇒ TemplateDocumentsResult
Deletes documents from a template. Deletes one or more documents from an existing template.
1105 1106 1107 1108 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1105 def delete_documents(account_id, template_id, envelope_definition) data, _status_code, _headers = delete_documents_with_http_info(account_id, template_id, envelope_definition) return data end |
#delete_documents_with_http_info(account_id, template_id, envelope_definition) ⇒ Array<(TemplateDocumentsResult, Fixnum, Hash)>
Deletes documents from a template. Deletes one or more documents from an existing template.
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1116 def delete_documents_with_http_info(account_id, template_id, envelope_definition) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.delete_documents ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_documents" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_documents" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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(envelope_definition) 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 => 'TemplateDocumentsResult') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#delete_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_group_share(account_id, template_id, template_part, group_information) ⇒ GroupInformation
Removes a member group’s sharing permissions for a template. Removes a member group’s sharing permissions for a specified template.
1161 1162 1163 1164 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1161 def delete_group_share(account_id, template_id, template_part, group_information) data, _status_code, _headers = delete_group_share_with_http_info(account_id, template_id, template_part, group_information) return data end |
#delete_group_share_with_http_info(account_id, template_id, template_part, group_information) ⇒ Array<(GroupInformation, Fixnum, Hash)>
Removes a member group's sharing permissions for a template. Removes a member group's sharing permissions for a specified template.
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1173 def delete_group_share_with_http_info(account_id, template_id, template_part, group_information) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.delete_group_share ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_group_share" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_group_share" if template_id.nil? # verify the required parameter 'template_part' is set fail ArgumentError, "Missing the required parameter 'template_part' when calling TemplatesApi.delete_group_share" if template_part.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s).sub('{' + 'templatePart' + '}', template_part.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(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 => 'GroupInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#delete_group_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_lock(account_id, template_id, lock_request) ⇒ LockInformation
Deletes a template lock. Deletes the lock from the specified template. The ‘X-DocuSign-Edit` header must be included in the request.
1219 1220 1221 1222 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1219 def delete_lock(account_id, template_id, lock_request) data, _status_code, _headers = delete_lock_with_http_info(account_id, template_id, lock_request) return data end |
#delete_lock_with_http_info(account_id, template_id, lock_request) ⇒ Array<(LockInformation, Fixnum, Hash)>
Deletes a template lock. Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1230 def delete_lock_with_http_info(account_id, template_id, lock_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.delete_lock ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_lock" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_lock" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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(lock_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 => 'LockInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#delete_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_recipient(account_id, recipient_id, template_id, template_recipients) ⇒ Recipients
Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template.
1275 1276 1277 1278 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1275 def delete_recipient(account_id, recipient_id, template_id, template_recipients) data, _status_code, _headers = delete_recipient_with_http_info(account_id, recipient_id, template_id, template_recipients) return data end |
#delete_recipient_with_http_info(account_id, recipient_id, template_id, template_recipients) ⇒ Array<(Recipients, Fixnum, Hash)>
Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template.
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1287 def delete_recipient_with_http_info(account_id, recipient_id, template_id, template_recipients) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.delete_recipient ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_recipient" if account_id.nil? # verify the required parameter 'recipient_id' is set fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.delete_recipient" if recipient_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_recipient" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_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(template_recipients) 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 => 'Recipients') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#delete_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_recipients(account_id, template_id, template_recipients) ⇒ Recipients
Deletes recipients from a template. Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the ‘recipientId` being used as the key for deleting recipients.
1333 1334 1335 1336 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1333 def delete_recipients(account_id, template_id, template_recipients) data, _status_code, _headers = delete_recipients_with_http_info(account_id, template_id, template_recipients) return data end |
#delete_recipients_with_http_info(account_id, template_id, template_recipients) ⇒ Array<(Recipients, Fixnum, Hash)>
Deletes recipients from a template. Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1344 def delete_recipients_with_http_info(account_id, template_id, template_recipients) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.delete_recipients ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_recipients" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_recipients" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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(template_recipients) 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 => 'Recipients') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#delete_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_tabs(account_id, recipient_id, template_id, template_tabs) ⇒ Tabs
Deletes the tabs associated with a recipient in a template. Deletes one or more tabs associated with a recipient in a template.
1389 1390 1391 1392 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1389 def delete_tabs(account_id, recipient_id, template_id, template_tabs) data, _status_code, _headers = delete_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs) return data end |
#delete_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Deletes the tabs associated with a recipient in a template. Deletes one or more tabs associated with a recipient in a template.
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1401 def delete_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.delete_tabs ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_tabs" if account_id.nil? # verify the required parameter 'recipient_id' is set fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.delete_tabs" if recipient_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_tabs" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_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(template_tabs) 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 => 'Tabs') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#delete_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_template_document_tabs(account_id, document_id, template_id, template_tabs) ⇒ Tabs
Deletes tabs from an envelope document
1448 1449 1450 1451 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1448 def delete_template_document_tabs(account_id, document_id, template_id, template_tabs) data, _status_code, _headers = delete_template_document_tabs_with_http_info(account_id, document_id, template_id, template_tabs) return data end |
#delete_template_document_tabs_with_http_info(account_id, document_id, template_id, template_tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Deletes tabs from an envelope document
1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1460 def delete_template_document_tabs_with_http_info(account_id, document_id, template_id, template_tabs) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.delete_template_document_tabs ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_template_document_tabs" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.delete_template_document_tabs" if document_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_template_document_tabs" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_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(template_tabs) 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 => 'Tabs') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#delete_template_document_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get(account_id, template_id, options = DocuSign_eSign::GetOptions.default) ⇒ EnvelopeTemplate
Gets a list of templates for a specified account. Retrieves the definition of the specified template.
1506 1507 1508 1509 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1506 def get(account_id, template_id, = DocuSign_eSign::GetOptions.default) data, _status_code, _headers = get_with_http_info(account_id, template_id, ) return data end |
#get_document(account_id, document_id, template_id, options = DocuSign_eSign::GetDocumentOptions.default) ⇒ File
Gets PDF documents from a template. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify ‘combined` to retrieve all documents in the template as one pdf.
1563 1564 1565 1566 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1563 def get_document(account_id, document_id, template_id, = DocuSign_eSign::GetDocumentOptions.default) data, _status_code, _headers = get_document_with_http_info(account_id, document_id, template_id, ) return data end |
#get_document_page_image(account_id, document_id, page_number, template_id, options = DocuSign_eSign::GetDocumentPageImageOptions.default) ⇒ File
Gets a page image from a template for display. Retrieves a page image for display from the specified template.
1625 1626 1627 1628 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1625 def get_document_page_image(account_id, document_id, page_number, template_id, = DocuSign_eSign::GetDocumentPageImageOptions.default) data, _status_code, _headers = get_document_page_image_with_http_info(account_id, document_id, page_number, template_id, ) return data end |
#get_document_page_image_with_http_info(account_id, document_id, page_number, template_id, options = DocuSign_eSign::GetDocumentPageImageOptions.default) ⇒ Array<(File, Fixnum, Hash)>
Gets a page image from a template for display. Retrieves a page image for display from the specified template.
1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1638 def get_document_page_image_with_http_info(account_id, document_id, page_number, template_id, = DocuSign_eSign::GetDocumentPageImageOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.get_document_page_image ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.get_document_page_image" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.get_document_page_image" if document_id.nil? # verify the required parameter 'page_number' is set fail ArgumentError, "Missing the required parameter 'page_number' when calling TemplatesApi.get_document_page_image" if page_number.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.get_document_page_image" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'templateId' + '}', template_id.to_s) # query parameters query_params = {} query_params[:'dpi'] = .dpi if !.dpi.nil? query_params[:'max_height'] = .max_height if !.max_height.nil? query_params[:'max_width'] = .max_width if !.max_width.nil? query_params[:'show_changes'] = .show_changes if !.show_changes.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['image/png']) # 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 => 'File') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#get_document_page_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_document_tabs(account_id, document_id, template_id, options = DocuSign_eSign::GetDocumentTabsOptions.default) ⇒ Tabs
Returns tabs on the document.
1691 1692 1693 1694 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1691 def get_document_tabs(account_id, document_id, template_id, = DocuSign_eSign::GetDocumentTabsOptions.default) data, _status_code, _headers = get_document_tabs_with_http_info(account_id, document_id, template_id, ) return data end |
#get_document_tabs_with_http_info(account_id, document_id, template_id, options = DocuSign_eSign::GetDocumentTabsOptions.default) ⇒ Array<(Tabs, Fixnum, Hash)>
Returns tabs on the document.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1703 def get_document_tabs_with_http_info(account_id, document_id, template_id, = DocuSign_eSign::GetDocumentTabsOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.get_document_tabs ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.get_document_tabs" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.get_document_tabs" if document_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.get_document_tabs" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s) # query parameters query_params = {} query_params[:'page_numbers'] = .page_numbers if !.page_numbers.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 => 'Tabs') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#get_document_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_document_with_http_info(account_id, document_id, template_id, options = DocuSign_eSign::GetDocumentOptions.default) ⇒ Array<(File, Fixnum, Hash)>
Gets PDF documents from a template. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf.
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1575 def get_document_with_http_info(account_id, document_id, template_id, = DocuSign_eSign::GetDocumentOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.get_document ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.get_document" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.get_document" if document_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.get_document" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s) # query parameters query_params = {} query_params[:'encrypt'] = .encrypt if !.encrypt.nil? query_params[:'show_changes'] = .show_changes if !.show_changes.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/pdf']) # 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 => 'File') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#get_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_lock(account_id, template_id) ⇒ LockInformation
Gets template lock information. Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the ‘X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
1749 1750 1751 1752 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1749 def get_lock(account_id, template_id) data, _status_code, _headers = get_lock_with_http_info(account_id, template_id) return data end |
#get_lock_with_http_info(account_id, template_id) ⇒ Array<(LockInformation, Fixnum, Hash)>
Gets template lock information. Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1759 def get_lock_with_http_info(account_id, template_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.get_lock ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.get_lock" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.get_lock" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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 => 'LockInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#get_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_notification_settings(account_id, template_id) ⇒ Notification
Gets template notification information. Retrieves the envelope notification, reminders and expirations, information for an existing template.
1802 1803 1804 1805 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1802 def get_notification_settings(account_id, template_id) data, _status_code, _headers = get_notification_settings_with_http_info(account_id, template_id) return data end |
#get_notification_settings_with_http_info(account_id, template_id) ⇒ Array<(Notification, Fixnum, Hash)>
Gets template notification information. Retrieves the envelope notification, reminders and expirations, information for an existing template.
1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1812 def get_notification_settings_with_http_info(account_id, template_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.get_notification_settings ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.get_notification_settings" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.get_notification_settings" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/notification".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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 => 'Notification') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#get_notification_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_page_tabs(account_id, document_id, page_number, template_id) ⇒ Tabs
Returns tabs on the specified page.
1857 1858 1859 1860 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1857 def get_page_tabs(account_id, document_id, page_number, template_id) data, _status_code, _headers = get_page_tabs_with_http_info(account_id, document_id, page_number, template_id) return data end |
#get_page_tabs_with_http_info(account_id, document_id, page_number, template_id) ⇒ Array<(Tabs, Fixnum, Hash)>
Returns tabs on the specified page.
1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1869 def get_page_tabs_with_http_info(account_id, document_id, page_number, template_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.get_page_tabs ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.get_page_tabs" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.get_page_tabs" if document_id.nil? # verify the required parameter 'page_number' is set fail ArgumentError, "Missing the required parameter 'page_number' when calling TemplatesApi.get_page_tabs" if page_number.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.get_page_tabs" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'templateId' + '}', template_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 => 'Tabs') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#get_page_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_pages(account_id, document_id, template_id, options = DocuSign_eSign::GetPagesOptions.default) ⇒ PageImages
Returns document page image(s) based on input.
1918 1919 1920 1921 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1918 def get_pages(account_id, document_id, template_id, = DocuSign_eSign::GetPagesOptions.default) data, _status_code, _headers = get_pages_with_http_info(account_id, document_id, template_id, ) return data end |
#get_pages_with_http_info(account_id, document_id, template_id, options = DocuSign_eSign::GetPagesOptions.default) ⇒ Array<(PageImages, Fixnum, Hash)>
Returns document page image(s) based on input.
1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1930 def get_pages_with_http_info(account_id, document_id, template_id, = DocuSign_eSign::GetPagesOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.get_pages ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.get_pages" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.get_pages" if document_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.get_pages" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s) # query parameters query_params = {} query_params[:'count'] = .count if !.count.nil? query_params[:'dpi'] = .dpi if !.dpi.nil? query_params[:'max_height'] = .max_height if !.max_height.nil? query_params[:'max_width'] = .max_width if !.max_width.nil? query_params[:'nocache'] = .nocache if !.nocache.nil? query_params[:'show_changes'] = .show_changes if !.show_changes.nil? query_params[:'start_position'] = .start_position if !.start_position.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 => 'PageImages') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#get_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_template_document_html_definitions(account_id, document_id, template_id) ⇒ DocumentHtmlDefinitionOriginals
Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
1983 1984 1985 1986 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1983 def get_template_document_html_definitions(account_id, document_id, template_id) data, _status_code, _headers = get_template_document_html_definitions_with_http_info(account_id, document_id, template_id) return data end |
#get_template_document_html_definitions_with_http_info(account_id, document_id, template_id) ⇒ Array<(DocumentHtmlDefinitionOriginals, Fixnum, Hash)>
Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1994 def get_template_document_html_definitions_with_http_info(account_id, document_id, template_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.get_template_document_html_definitions ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.get_template_document_html_definitions" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.get_template_document_html_definitions" if document_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.get_template_document_html_definitions" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_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 => 'DocumentHtmlDefinitionOriginals') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#get_template_document_html_definitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_template_html_definitions(account_id, template_id) ⇒ DocumentHtmlDefinitionOriginals
Get the Original HTML Definition used to generate the Responsive HTML for the template.
2039 2040 2041 2042 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2039 def get_template_html_definitions(account_id, template_id) data, _status_code, _headers = get_template_html_definitions_with_http_info(account_id, template_id) return data end |
#get_template_html_definitions_with_http_info(account_id, template_id) ⇒ Array<(DocumentHtmlDefinitionOriginals, Fixnum, Hash)>
Get the Original HTML Definition used to generate the Responsive HTML for the template.
2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2049 def get_template_html_definitions_with_http_info(account_id, template_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.get_template_html_definitions ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.get_template_html_definitions" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.get_template_html_definitions" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/html_definitions".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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 => 'DocumentHtmlDefinitionOriginals') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#get_template_html_definitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_with_http_info(account_id, template_id, options = DocuSign_eSign::GetOptions.default) ⇒ Array<(EnvelopeTemplate, Fixnum, Hash)>
Gets a list of templates for a specified account. Retrieves the definition of the specified template.
1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 |
# File 'lib/docusign_esign/api/templates_api.rb', line 1517 def get_with_http_info(account_id, template_id, = DocuSign_eSign::GetOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.get ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.get" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.get" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s) # query parameters query_params = {} query_params[:'include'] = .include if !.include.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 => 'EnvelopeTemplate') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_bulk_recipients(account_id, recipient_id, template_id, options = DocuSign_eSign::ListBulkRecipientsOptions.default) ⇒ BulkRecipientsResponse
Gets the bulk recipient file from a template. Retrieves the bulk recipient file information from a template that has a bulk recipient.
2094 2095 2096 2097 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2094 def list_bulk_recipients(account_id, recipient_id, template_id, = DocuSign_eSign::ListBulkRecipientsOptions.default) data, _status_code, _headers = list_bulk_recipients_with_http_info(account_id, recipient_id, template_id, ) return data end |
#list_bulk_recipients_with_http_info(account_id, recipient_id, template_id, options = DocuSign_eSign::ListBulkRecipientsOptions.default) ⇒ Array<(BulkRecipientsResponse, Fixnum, Hash)>
Gets the bulk recipient file from a template. Retrieves the bulk recipient file information from a template that has a bulk recipient.
2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2106 def list_bulk_recipients_with_http_info(account_id, recipient_id, template_id, = DocuSign_eSign::ListBulkRecipientsOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.list_bulk_recipients ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.list_bulk_recipients" if account_id.nil? # verify the required parameter 'recipient_id' is set fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.list_bulk_recipients" if recipient_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.list_bulk_recipients" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s) # query parameters query_params = {} query_params[:'include_tabs'] = .include_tabs if !.include_tabs.nil? query_params[:'start_position'] = .start_position if !.start_position.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 => 'BulkRecipientsResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#list_bulk_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_custom_fields(account_id, template_id) ⇒ CustomFields
Gets the custom document fields from a template. Retrieves the custom document field information from an existing template.
2153 2154 2155 2156 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2153 def list_custom_fields(account_id, template_id) data, _status_code, _headers = list_custom_fields_with_http_info(account_id, template_id) return data end |
#list_custom_fields_with_http_info(account_id, template_id) ⇒ Array<(CustomFields, Fixnum, Hash)>
Gets the custom document fields from a template. Retrieves the custom document field information from an existing template.
2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2163 def list_custom_fields_with_http_info(account_id, template_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.list_custom_fields ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.list_custom_fields" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.list_custom_fields" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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 => 'CustomFields') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#list_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_document_fields(account_id, document_id, template_id) ⇒ DocumentFieldsInformation
Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template document.
2207 2208 2209 2210 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2207 def list_document_fields(account_id, document_id, template_id) data, _status_code, _headers = list_document_fields_with_http_info(account_id, document_id, template_id) return data end |
#list_document_fields_with_http_info(account_id, document_id, template_id) ⇒ Array<(DocumentFieldsInformation, Fixnum, Hash)>
Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template document.
2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2218 def list_document_fields_with_http_info(account_id, document_id, template_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.list_document_fields ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.list_document_fields" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.list_document_fields" if document_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.list_document_fields" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_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 => 'DocumentFieldsInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#list_document_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_documents(account_id, template_id, options = DocuSign_eSign::ListDocumentsOptions.default) ⇒ TemplateDocumentsResult
Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template.
2264 2265 2266 2267 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2264 def list_documents(account_id, template_id, = DocuSign_eSign::ListDocumentsOptions.default) data, _status_code, _headers = list_documents_with_http_info(account_id, template_id, ) return data end |
#list_documents_with_http_info(account_id, template_id, options = DocuSign_eSign::ListDocumentsOptions.default) ⇒ Array<(TemplateDocumentsResult, Fixnum, Hash)>
Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template.
2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2275 def list_documents_with_http_info(account_id, template_id, = DocuSign_eSign::ListDocumentsOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.list_documents ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.list_documents" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.list_documents" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s) # query parameters query_params = {} query_params[:'include_tabs'] = .include_tabs if !.include_tabs.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 => 'TemplateDocumentsResult') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#list_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_recipients(account_id, template_id, options = DocuSign_eSign::ListRecipientsOptions.default) ⇒ Recipients
Gets recipient information from a template. Retrieves the information for all recipients in the specified template.
2320 2321 2322 2323 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2320 def list_recipients(account_id, template_id, = DocuSign_eSign::ListRecipientsOptions.default) data, _status_code, _headers = list_recipients_with_http_info(account_id, template_id, ) return data end |
#list_recipients_with_http_info(account_id, template_id, options = DocuSign_eSign::ListRecipientsOptions.default) ⇒ Array<(Recipients, Fixnum, Hash)>
Gets recipient information from a template. Retrieves the information for all recipients in the specified template.
2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2331 def list_recipients_with_http_info(account_id, template_id, = DocuSign_eSign::ListRecipientsOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.list_recipients ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.list_recipients" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.list_recipients" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s) # query parameters query_params = {} query_params[:'include_anchor_tab_locations'] = .include_anchor_tab_locations if !.include_anchor_tab_locations.nil? query_params[:'include_extended'] = .include_extended if !.include_extended.nil? query_params[:'include_tabs'] = .include_tabs if !.include_tabs.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 => 'Recipients') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#list_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_tabs(account_id, recipient_id, template_id, options = DocuSign_eSign::ListTabsOptions.default) ⇒ Tabs
Gets the tabs information for a signer or sign-in-person recipient in a template. Gets the tabs information for a signer or sign-in-person recipient in a template.
2379 2380 2381 2382 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2379 def list_tabs(account_id, recipient_id, template_id, = DocuSign_eSign::ListTabsOptions.default) data, _status_code, _headers = list_tabs_with_http_info(account_id, recipient_id, template_id, ) return data end |
#list_tabs_with_http_info(account_id, recipient_id, template_id, options = DocuSign_eSign::ListTabsOptions.default) ⇒ Array<(Tabs, Fixnum, Hash)>
Gets the tabs information for a signer or sign-in-person recipient in a template. Gets the tabs information for a signer or sign-in-person recipient in a template.
2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2391 def list_tabs_with_http_info(account_id, recipient_id, template_id, = DocuSign_eSign::ListTabsOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.list_tabs ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.list_tabs" if account_id.nil? # verify the required parameter 'recipient_id' is set fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.list_tabs" if recipient_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.list_tabs" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s) # query parameters query_params = {} query_params[:'include_anchor_tab_locations'] = .include_anchor_tab_locations if !.include_anchor_tab_locations.nil? query_params[:'include_metadata'] = . if !..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 => 'Tabs') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#list_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_templates(account_id, options = DocuSign_eSign::ListTemplatesOptions.default) ⇒ EnvelopeTemplateResults
Gets the definition of a template. Retrieves the list of templates for the specified account. The request can be limited to a specific folder.
2438 2439 2440 2441 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2438 def list_templates(account_id, = DocuSign_eSign::ListTemplatesOptions.default) data, _status_code, _headers = list_templates_with_http_info(account_id, ) return data end |
#list_templates_with_http_info(account_id, options = DocuSign_eSign::ListTemplatesOptions.default) ⇒ Array<(EnvelopeTemplateResults, Fixnum, Hash)>
Gets the definition of a template. Retrieves the list of templates for the specified account. The request can be limited to a specific folder.
2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2448 def list_templates_with_http_info(account_id, = DocuSign_eSign::ListTemplatesOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.list_templates ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.list_templates" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'count'] = .count if !.count.nil? query_params[:'created_from_date'] = .created_from_date if !.created_from_date.nil? query_params[:'created_to_date'] = .created_to_date if !.created_to_date.nil? query_params[:'folder_ids'] = .folder_ids if !.folder_ids.nil? query_params[:'folder_types'] = .folder_types if !.folder_types.nil? query_params[:'from_date'] = .from_date if !.from_date.nil? query_params[:'include'] = .include if !.include.nil? query_params[:'is_download'] = .is_download if !.is_download.nil? query_params[:'modified_from_date'] = .modified_from_date if !.modified_from_date.nil? query_params[:'modified_to_date'] = .modified_to_date if !.modified_to_date.nil? query_params[:'order'] = .order if !.order.nil? query_params[:'order_by'] = .order_by if !.order_by.nil? query_params[:'search_fields'] = .search_fields if !.search_fields.nil? query_params[:'search_text'] = .search_text if !.search_text.nil? query_params[:'shared_by_me'] = .shared_by_me if !.shared_by_me.nil? query_params[:'start_position'] = .start_position if !.start_position.nil? query_params[:'template_ids'] = .template_ids if !.template_ids.nil? query_params[:'to_date'] = .to_date if !.to_date.nil? query_params[:'used_from_date'] = .used_from_date if !.used_from_date.nil? query_params[:'used_to_date'] = .used_to_date if !.used_to_date.nil? query_params[:'user_filter'] = .user_filter if !.user_filter.nil? query_params[:'user_id'] = .user_id if !.user_id.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 => 'EnvelopeTemplateResults') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#list_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#rotate_document_page(account_id, document_id, page_number, template_id, page_request) ⇒ nil
Rotates page image from a template for display. Rotates page image from a template for display. The page image can be rotated to the left or right.
2514 2515 2516 2517 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2514 def rotate_document_page(account_id, document_id, page_number, template_id, page_request) rotate_document_page_with_http_info(account_id, document_id, page_number, template_id, page_request) return nil end |
#rotate_document_page_with_http_info(account_id, document_id, page_number, template_id, page_request) ⇒ Array<(nil, Fixnum, Hash)>
Rotates page image from a template for display. Rotates page image from a template for display. The page image can be rotated to the left or right.
2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2527 def rotate_document_page_with_http_info(account_id, document_id, page_number, template_id, page_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.rotate_document_page ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.rotate_document_page" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.rotate_document_page" if document_id.nil? # verify the required parameter 'page_number' is set fail ArgumentError, "Missing the required parameter 'page_number' when calling TemplatesApi.rotate_document_page" if page_number.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.rotate_document_page" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'templateId' + '}', template_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(page_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) if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#rotate_document_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update(account_id, template_id, envelope_template) ⇒ TemplateUpdateSummary
Updates an existing template. Updates an existing template.
2574 2575 2576 2577 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2574 def update(account_id, template_id, envelope_template) data, _status_code, _headers = update_with_http_info(account_id, template_id, envelope_template) return data end |
#update_bulk_recipients(account_id, recipient_id, template_id, bulk_recipients_request) ⇒ BulkRecipientsSummaryResponse
Adds or replaces the bulk recipients list in a template. Updates the bulk recipients in a template using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
2630 2631 2632 2633 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2630 def update_bulk_recipients(account_id, recipient_id, template_id, bulk_recipients_request) data, _status_code, _headers = update_bulk_recipients_with_http_info(account_id, recipient_id, template_id, bulk_recipients_request) return data end |
#update_bulk_recipients_with_http_info(account_id, recipient_id, template_id, bulk_recipients_request) ⇒ Array<(BulkRecipientsSummaryResponse, Fixnum, Hash)>
Adds or replaces the bulk recipients list in a template. Updates the bulk recipients in a template using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2642 def update_bulk_recipients_with_http_info(account_id, recipient_id, template_id, bulk_recipients_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.update_bulk_recipients ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_bulk_recipients" if account_id.nil? # verify the required parameter 'recipient_id' is set fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.update_bulk_recipients" if recipient_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_bulk_recipients" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_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(bulk_recipients_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 => 'BulkRecipientsSummaryResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#update_bulk_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_custom_fields(account_id, template_id, template_custom_fields) ⇒ CustomFields
Updates envelope custom fields in a template. Updates the custom fields in a template. Each custom field used in a template must have a unique name.
2688 2689 2690 2691 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2688 def update_custom_fields(account_id, template_id, template_custom_fields) data, _status_code, _headers = update_custom_fields_with_http_info(account_id, template_id, template_custom_fields) return data end |
#update_custom_fields_with_http_info(account_id, template_id, template_custom_fields) ⇒ Array<(CustomFields, Fixnum, Hash)>
Updates envelope custom fields in a template. Updates the custom fields in a template. Each custom field used in a template must have a unique name.
2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2699 def update_custom_fields_with_http_info(account_id, template_id, template_custom_fields) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.update_custom_fields ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_custom_fields" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_custom_fields" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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(template_custom_fields) 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 => 'CustomFields') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#update_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_document(account_id, document_id, template_id, envelope_definition, options = DocuSign_eSign::UpdateDocumentOptions.default) ⇒ EnvelopeDocument
Adds a document to a template document. Adds the specified document to an existing template document.
2745 2746 2747 2748 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2745 def update_document(account_id, document_id, template_id, envelope_definition, = DocuSign_eSign::UpdateDocumentOptions.default) data, _status_code, _headers = update_document_with_http_info(account_id, document_id, template_id, envelope_definition, ) return data end |
#update_document_fields(account_id, document_id, template_id, document_fields_information) ⇒ DocumentFieldsInformation
Updates existing custom document fields in an existing template document. Updates existing custom document fields in an existing template document.
2806 2807 2808 2809 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2806 def update_document_fields(account_id, document_id, template_id, document_fields_information) data, _status_code, _headers = update_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information) return data end |
#update_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information) ⇒ Array<(DocumentFieldsInformation, Fixnum, Hash)>
Updates existing custom document fields in an existing template document. Updates existing custom document fields in an existing template document.
2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2818 def update_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.update_document_fields ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_document_fields" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.update_document_fields" if document_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_document_fields" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_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(document_fields_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 => 'DocumentFieldsInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#update_document_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_document_with_http_info(account_id, document_id, template_id, envelope_definition, options = DocuSign_eSign::UpdateDocumentOptions.default) ⇒ Array<(EnvelopeDocument, Fixnum, Hash)>
Adds a document to a template document. Adds the specified document to an existing template document.
2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2758 def update_document_with_http_info(account_id, document_id, template_id, envelope_definition, = DocuSign_eSign::UpdateDocumentOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.update_document ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_document" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.update_document" if document_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_document" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s) # query parameters query_params = {} query_params[:'is_envelope_definition'] = .is_envelope_definition if !.is_envelope_definition.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 = @api_client.object_to_http_body(envelope_definition) 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 => 'EnvelopeDocument') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#update_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_documents(account_id, template_id, envelope_definition) ⇒ TemplateDocumentsResult
Adds documents to a template document. Adds one or more documents to an existing template document.
2864 2865 2866 2867 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2864 def update_documents(account_id, template_id, envelope_definition) data, _status_code, _headers = update_documents_with_http_info(account_id, template_id, envelope_definition) return data end |
#update_documents_with_http_info(account_id, template_id, envelope_definition) ⇒ Array<(TemplateDocumentsResult, Fixnum, Hash)>
Adds documents to a template document. Adds one or more documents to an existing template document.
2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2875 def update_documents_with_http_info(account_id, template_id, envelope_definition) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.update_documents ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_documents" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_documents" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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(envelope_definition) 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 => 'TemplateDocumentsResult') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#update_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_group_share(account_id, template_id, template_part, group_information) ⇒ GroupInformation
Shares a template with a group Shares a template with the specified members group.
2920 2921 2922 2923 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2920 def update_group_share(account_id, template_id, template_part, group_information) data, _status_code, _headers = update_group_share_with_http_info(account_id, template_id, template_part, group_information) return data end |
#update_group_share_with_http_info(account_id, template_id, template_part, group_information) ⇒ Array<(GroupInformation, Fixnum, Hash)>
Shares a template with a group Shares a template with the specified members group.
2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2932 def update_group_share_with_http_info(account_id, template_id, template_part, group_information) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.update_group_share ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_group_share" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_group_share" if template_id.nil? # verify the required parameter 'template_part' is set fail ArgumentError, "Missing the required parameter 'template_part' when calling TemplatesApi.update_group_share" if template_part.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s).sub('{' + 'templatePart' + '}', template_part.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(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 => 'GroupInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#update_group_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_lock(account_id, template_id, lock_request) ⇒ LockInformation
Updates a template lock. Updates the lock duration time or update the ‘lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
2978 2979 2980 2981 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2978 def update_lock(account_id, template_id, lock_request) data, _status_code, _headers = update_lock_with_http_info(account_id, template_id, lock_request) return data end |
#update_lock_with_http_info(account_id, template_id, lock_request) ⇒ Array<(LockInformation, Fixnum, Hash)>
Updates a template lock. Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2989 def update_lock_with_http_info(account_id, template_id, lock_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.update_lock ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_lock" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_lock" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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(lock_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 => 'LockInformation') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#update_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_notification_settings(account_id, template_id, template_notification_request) ⇒ Notification
Updates the notification structure for an existing template. Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.
3033 3034 3035 3036 |
# File 'lib/docusign_esign/api/templates_api.rb', line 3033 def update_notification_settings(account_id, template_id, template_notification_request) data, _status_code, _headers = update_notification_settings_with_http_info(account_id, template_id, template_notification_request) return data end |
#update_notification_settings_with_http_info(account_id, template_id, template_notification_request) ⇒ Array<(Notification, Fixnum, Hash)>
Updates the notification structure for an existing template. Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.
3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 |
# File 'lib/docusign_esign/api/templates_api.rb', line 3044 def update_notification_settings_with_http_info(account_id, template_id, template_notification_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.update_notification_settings ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_notification_settings" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_notification_settings" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/notification".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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(template_notification_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 => 'Notification') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#update_notification_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_recipients(account_id, template_id, template_recipients, options = DocuSign_eSign::UpdateRecipientsOptions.default) ⇒ RecipientsUpdateSummary
Updates recipients in a template. Updates recipients in a template. You can edit the following properties: ‘email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.
3089 3090 3091 3092 |
# File 'lib/docusign_esign/api/templates_api.rb', line 3089 def update_recipients(account_id, template_id, template_recipients, = DocuSign_eSign::UpdateRecipientsOptions.default) data, _status_code, _headers = update_recipients_with_http_info(account_id, template_id, template_recipients, ) return data end |
#update_recipients_with_http_info(account_id, template_id, template_recipients, options = DocuSign_eSign::UpdateRecipientsOptions.default) ⇒ Array<(RecipientsUpdateSummary, Fixnum, Hash)>
Updates recipients in a template. Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.
3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 |
# File 'lib/docusign_esign/api/templates_api.rb', line 3101 def update_recipients_with_http_info(account_id, template_id, template_recipients, = DocuSign_eSign::UpdateRecipientsOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.update_recipients ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_recipients" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_recipients" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s) # query parameters query_params = {} query_params[:'resend_envelope'] = .resend_envelope if !.resend_envelope.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 = @api_client.object_to_http_body(template_recipients) 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 => 'RecipientsUpdateSummary') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#update_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_tabs(account_id, recipient_id, template_id, template_tabs) ⇒ Tabs
Updates the tabs for a recipient. Updates one or more tabs for a recipient in a template.
3147 3148 3149 3150 |
# File 'lib/docusign_esign/api/templates_api.rb', line 3147 def update_tabs(account_id, recipient_id, template_id, template_tabs) data, _status_code, _headers = update_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs) return data end |
#update_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Updates the tabs for a recipient. Updates one or more tabs for a recipient in a template.
3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 |
# File 'lib/docusign_esign/api/templates_api.rb', line 3159 def update_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.update_tabs ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_tabs" if account_id.nil? # verify the required parameter 'recipient_id' is set fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.update_tabs" if recipient_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_tabs" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_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(template_tabs) 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 => 'Tabs') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#update_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_template_document_tabs(account_id, document_id, template_id, template_tabs) ⇒ Tabs
Updates the tabs for a template
3206 3207 3208 3209 |
# File 'lib/docusign_esign/api/templates_api.rb', line 3206 def update_template_document_tabs(account_id, document_id, template_id, template_tabs) data, _status_code, _headers = update_template_document_tabs_with_http_info(account_id, document_id, template_id, template_tabs) return data end |
#update_template_document_tabs_with_http_info(account_id, document_id, template_id, template_tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Updates the tabs for a template
3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 |
# File 'lib/docusign_esign/api/templates_api.rb', line 3218 def update_template_document_tabs_with_http_info(account_id, document_id, template_id, template_tabs) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.update_template_document_tabs ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_template_document_tabs" if account_id.nil? # verify the required parameter 'document_id' is set fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.update_template_document_tabs" if document_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_template_document_tabs" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_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(template_tabs) 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 => 'Tabs') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#update_template_document_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_with_http_info(account_id, template_id, envelope_template) ⇒ Array<(TemplateUpdateSummary, Fixnum, Hash)>
Updates an existing template. Updates an existing template.
2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 |
# File 'lib/docusign_esign/api/templates_api.rb', line 2585 def update_with_http_info(account_id, template_id, envelope_template) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TemplatesApi.update ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update" if account_id.nil? # verify the required parameter 'template_id' is set fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update" if template_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_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(envelope_template) 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 => 'TemplateUpdateSummary') if @api_client.config.debugging @api_client.config.logger.debug "API called: TemplatesApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |