Class: Echosign::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/echosign/client.rb,
lib/echosign/widget/client.rb,
lib/echosign/agreement/client.rb,
lib/echosign/mega_sign/client.rb,
lib/echosign/library_documents/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(token) ⇒ Echochamber::Client

Initializes the Client object

Parameters:

  • token (String) —

    Access token or integration key



13
14
15
16
 
# File 'lib/echosign/client.rb', line 13

def initialize(token)
  @token = token
  @base_uri = nil
end

Instance Attribute Details

#token ⇒ Object (readonly)

Returns the value of attribute token.



7
8
9
 
# File 'lib/echosign/client.rb', line 7

def token
  @token
end

Instance Method Details

#agreement_combined_pdf(agreement_id, file_path = nil, versionId = nil, participantEmail = nil, attachSupportingDocuments = true, auditReport = false) ⇒ String

Gets a single combined PDF document for the documents associated with an agreement.

Parameters:

  • agreement_id (String) —

    (REQUIRED)

  • file_path (String) (defaults to: nil) —

    File path to save the document. If no file path is given, nothing is saved to disk.

  • versionId (String) (defaults to: nil) —

    The version identifier of agreement as provided by get_agreement. If not provided then latest version will be used

  • participantEmail (String) (defaults to: nil) —

    The email address of the participant to be used to retrieve documents. If none is given, the auth token will be used to determine the user

  • attachSupportingDocuments (Boolean) (defaults to: true) —

    When set to YES, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true.

  • auditReport (Boolean) (defaults to: false) —

    When set to YES, attach an audit report to the signed agreement PDF. Default value is false

Returns:

  • (String) —

    Raw bytes from document file



97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/echosign/agreement/client.rb', line 97

def agreement_combined_pdf(agreement_id, file_path = nil, versionId = nil, participantEmail = nil,
                           attachSupportingDocuments = true, auditReport = false)
  response = request(:agreement_combined_pdf, agreement_id, versionId, participantEmail, attachSupportingDocuments,
                     auditReport)
  unless file_path.nil?
    file = File.new(file_path, 'wb')
    file.write(response)
    file.close
  end
  response
end

#agreement_document_file(agreement_id, document_id, file_path = nil) ⇒ String

Retrieve a document file from an agreement

Parameters:

  • agreement_id (String) —

    (REQUIRED)

  • document_id (String) —

    (REQUIRED)

  • file_path (String) (defaults to: nil) —

    File path to save the document. If no file path is given, nothing is saved to disk.

Returns:

  • (String) —

    Raw bytes from document file



66
67
68
69
70
71
72
73
74
 
# File 'lib/echosign/agreement/client.rb', line 66

def agreement_document_file(agreement_id, document_id, file_path = nil)
  response = request(:agreement_document_file, agreement_id, document_id)
  unless file_path.nil?
    file = File.new(file_path, 'wb')
    file.write(response)
    file.close
  end
  response
end

#agreement_documents(agreement_id, recipient_email, format, version_id = nil) ⇒ Array

All documents relating to an agreement

Parameters:

  • agreement_id (String) —

    (REQUIRED)

  • recipient_email (String) —

    The email address of the participant to be used to retrieve documents. (REQUIRED)

  • format (String) —

    Content format of the supported documents. It can have two possible values ORIGINAL or CONVERTED_PDF. (REQUIRED)

  • version_id (String) (defaults to: nil) —

    Version of the agreement as provided by agreement_info(). If not provided, the latest version of the agreement is used.

Returns:

  • (Array) —

    Documents relating to agreement.



56
57
58
 
# File 'lib/echosign/agreement/client.rb', line 56

def agreement_documents(agreement_id, recipient_email, format, version_id = nil)
  result = request(:agreement_documents, agreement_id, recipient_email, format, version_id)
end

#agreement_form_data(agreement_id, file_path = nil) ⇒ String

Retrieves library document audit trail file

Parameters:

  • agreement_id (String) —

    (REQUIRED)

  • file_path (String) (defaults to: nil) —

    File path where to save the CSV file. If no file path is given, nothing is saved to disk.

Returns:

  • (String) —

    Raw bytes representing CSV file



115
116
117
118
119
120
121
122
123
 
# File 'lib/echosign/agreement/client.rb', line 115

def agreement_form_data(agreement_id, file_path = nil)
  response = request(:agreement_form_data, agreement_id)
  unless file_path.nil?
    file = File.new(file_path, 'wb')
    file.write(response)
    file.close
  end
  response
end

#agreement_info(agreement_id) ⇒ Hash

Gets detailed info on an agreement

Parameters:

  • agreement_id (String) —

    ID of agreement to retrieve info on.

Returns:

  • (Hash) —

    Detailed agreement info



26
27
28
 
# File 'lib/echosign/agreement/client.rb', line 26

def agreement_info(agreement_id)
  request(:agreement_info, agreement_id)
end

#agreement_signing_urls(agreement_id) ⇒ Hash

Retrieves the URL for the eSign page for the current signer(s) of an agreement

Parameters:

  • agreement_id (String) —

    (REQUIRED)

Returns:

  • (Hash) —

    URL information for the eSign page of the agreement



80
81
82
 
# File 'lib/echosign/agreement/client.rb', line 80

def agreement_signing_urls(agreement_id)
  response = request(:agreement_signing_urls, agreement_id)
end

#audit_trail_pdf(agreement_id, file_path = nil) ⇒ String

Retrieve a PDF audit file for an agreement

Parameters:

  • agreement_id (String) —

    (REQUIRED)

  • file_path (String) (defaults to: nil) —

    File path to save the document. If no file path is given, nothing is saved to disk.

Returns:

  • (String) —

    Raw bytes from document file



51
52
53
54
55
56
57
58
59
 
# File 'lib/echosign/client.rb', line 51

def audit_trail_pdf(agreement_id, file_path = nil)
  response = request(:audit_trail_pdf, agreement_id)
  unless file_path.nil?
    file = File.new(file_path, 'wb')
    file.write(response)
    file.close
  end
  response
end

#cancel_agreement(agreement_id, notify_signer = false, comment = nil) ⇒ String

Cancel agreement

Parameters:

  • agreement_id (String) —

    (REQUIRED)

  • notify_signer (Boolean) (defaults to: false) —

    Whether to notify the signer by email of the cancellation. Default is false.

  • comment (String) (defaults to: nil) —

    Comment regarding this cancellation.

Returns:

  • (String) —

    Result of the operation



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/echosign/agreement/client.rb', line 36

def cancel_agreement(agreement_id, notify_signer = false, comment = nil)
  request_body = {
    "value" => "CANCEL",
    "notifySigner" => notify_signer
  }
  request_body[:comment] = comment unless comment.nil?

  agreement_status_response = request(:update_agreement_status, agreement_id, request_body)
  agreement_status_response.fetch('result')
end

#cancel_mega_sign(mega_sign_id, notify_signer = false, comment = nil) ⇒ String

Cancel mega_sign

Parameters:

  • mega_sign_id (String) —

    (REQUIRED)

  • notify_signer (Boolean) (defaults to: false) —

    Whether to notify the signer by email of the cancellation. Default is false.

  • comment (String) (defaults to: nil) —

    Comment regarding this cancellation.

Returns:

  • (String) —

    Result of the operation



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/echosign/mega_sign/client.rb', line 35

def cancel_mega_sign(mega_sign_id, notify_signer = false, comment = nil)
  request_body = {
    "value" => "CANCEL",
    "notifySigner" => notify_signer
  }
  request_body[:comment] = comment unless comment.nil?

  mega_sign_status_response = request(:update_mega_sign_status, mega_sign_id, request_body)
  mega_sign_status_response.fetch('result')
end

#create_agreement(agreement) ⇒ String

Creates an agreement

Parameters:

Returns:

  • (String) —

    Agreement ID



7
8
9
10
11
12
 
# File 'lib/echosign/agreement/client.rb', line 7

def create_agreement(agreement)
  agreement_response = request(:create_agreement, agreement, agreement.user_id, agreement.user_email)
  return agreement_response['agreementId'] if agreement_response.has_key?('agreementId')

  raise "Error creating agreement - response was #{agreement_response}"
end

#create_mega_sign(mega_sign) ⇒ String

Creates an mega_sign

Parameters:

Returns:

  • (String) —

    Agreement ID



7
8
9
10
11
 
# File 'lib/echosign/mega_sign/client.rb', line 7

def create_mega_sign(mega_sign)
  mega_sign_response = request(:create_mega_sign, mega_sign, mega_sign.user_id, mega_sign.user_email)
  puts mega_sign_response.inspect
  mega_sign_response.fetch("mega_signId")
end

#create_reminder(reminder) ⇒ String

Creates a reminder

Parameters:

Returns:

  • (String) —

    Reminder ID



31
32
33
 
# File 'lib/echosign/client.rb', line 31

def create_reminder(reminder)
  reminder_response = request(:create_reminder, reminder)
end

#create_transient_document(file_name, mime_type, file_handle) ⇒ String

Creates a transient document for later referral

Parameters:

  • file_name (String)
  • mime_type (String)
  • file_handle (File)

Returns:

  • (String) —

    Transient document ID



41
42
43
44
 
# File 'lib/echosign/client.rb', line 41

def create_transient_document(file_name, mime_type, file_handle)
  transient_document_response = request(:create_transient_document, file_name, file_handle, mime_type)
  transient_document_response.fetch("transientDocumentId")
end

#create_user(user) ⇒ String

Creates a user for the current application

Parameters:

Returns:

  • (String) —

    User ID of new Echosign user



22
23
24
25
 
# File 'lib/echosign/client.rb', line 22

def create_user(user)
  user_response = request(:create_user, user)
  user_response.fetch("userId")
end

#create_widget(widget) ⇒ Hash

Creates a widget and returns the Javascript snippet and URL to access the widget and widgetID in response to

the client

Parameters:

Returns:

  • (Hash) 


8
9
10
 
# File 'lib/echosign/widget/client.rb', line 8

def create_widget(widget)
  request(:create_widget, widget)
end

#get_agreements ⇒ Hash

Gets list of agreements

Returns:

  • (Hash) —

    An array of user agreement items



17
18
19
20
 
# File 'lib/echosign/agreement/client.rb', line 17

def get_agreements
  get_agreements_response = request(:get_agreements)
  get_agreements_response.fetch("userAgreementList")
end

#get_library_document(library_document_id) ⇒ Hash

Retrieves library document metadata

Parameters:

  • library_document_id (String) —

    (REQUIRED)

Returns:

  • (Hash) —

    Library document metadata



18
19
20
 
# File 'lib/echosign/library_documents/client.rb', line 18

def get_library_document(library_document_id)
  request(:get_library_document, library_document_id)
end

#get_library_document_file(library_document_id, file_id, file_path = nil) ⇒ String

Retrieves library document file data

Parameters:

  • library_document_id (REQUIRED)
  • file_id (String) —

    (REQUIRED)

  • file_path (String) (defaults to: nil) —

    File path for saving the document. If none is given, nothing will be saved to disk.

Returns:

  • (String) —

    Raw library document file data



36
37
38
39
40
41
42
43
44
 
# File 'lib/echosign/library_documents/client.rb', line 36

def get_library_document_file(library_document_id, file_id, file_path = nil)
  response = request(:get_library_document_file, library_document_id, file_id)
  unless file_path.nil?
    file = File.new(file_path, 'wb')
    file.write(response)
    file.close
  end
  response
end

#get_library_document_files(library_document_id) ⇒ Hash

Retrieves library document files metadata

Parameters:

  • library_document_id (String) —

    (REQUIRED)

Returns:

  • (Hash) —

    Library document files metadata



26
27
28
 
# File 'lib/echosign/library_documents/client.rb', line 26

def get_library_document_files(library_document_id)
  request(:get_library_document_files, library_document_id)
end

#get_library_documents(user_id = nil, user_email = nil) ⇒ Hash

Retrieves library documents metadata for a user.

Parameters:

  • user_id (String) (defaults to: nil) —

    The ID of the user whose library documents are being requested.

  • user_email (String) (defaults to: nil) —

    The email address of the user whose library documents are being requested. If both user_id and user_email are provided then user_id is given preference. If neither is specified then the user is inferred from the access token.

Returns:

  • (Hash) —

    Library documents metadata



10
11
12
 
# File 'lib/echosign/library_documents/client.rb', line 10

def get_library_documents(user_id = nil, user_email = nil)
  request(:get_library_documents, user_id, user_email)
end

#get_mega_signs ⇒ Hash

Gets list of mega_signs

Returns:

  • (Hash) —

    An array of mega sign parent agreements



16
17
18
19
 
# File 'lib/echosign/mega_sign/client.rb', line 16

def get_mega_signs
  get_mega_signs_response = request(:get_mega_signs)
  get_mega_signs_response.fetch("megaSignList")
end

#get_user(user_id) ⇒ Hash

Gets all the users in an account that the caller has permissions to access.

Parameters:

  • user_id (String)

Returns:

  • (Hash) —

    User info hash



73
74
75
 
# File 'lib/echosign/client.rb', line 73

def get_user(user_id)
  request(:get_user, user_id)
end

#get_users(user_email) ⇒ Hash

Gets all the users in an account that the caller has permissions to access.

Parameters:

  • user_email (String) —

    The email address of the user whose details are being requested (REQUIRED)

Returns:

  • (Hash) —

    User info hash



65
66
67
 
# File 'lib/echosign/client.rb', line 65

def get_users(user_email)
  request(:get_users, user_email)
end

#get_widget(widget_id) ⇒ Hash

Retrieves the details of a widget

Parameters:

  • widget_id

Returns:

  • (Hash) —

    Detailed widget info



45
46
47
 
# File 'lib/echosign/widget/client.rb', line 45

def get_widget(widget_id)
  request(:get_widget, widget_id)
end

#get_widget_audit_trail(widget_id, file_path = nil) ⇒ String

Note:

SEEMINGLY NOT YET IMPLEMENTED SERVER-SIDE

Retrieves the audit trail of a widget identified by widgetId

Parameters:

  • widget_id (String)
  • file_path (String) (defaults to: nil) —

    File path where to save the document. If none is given, nothing will be saved to file.

Returns:

  • (String) —

    Raw file stream



82
83
84
85
86
87
88
89
90
 
# File 'lib/echosign/widget/client.rb', line 82

def get_widget_audit_trail(widget_id, file_path = nil)
  response = request(:get_widget_audit_trail, widget_id)
  unless file_path.nil?
    file = File.new(file_path, 'wb')
    file.write(response)
    file.close
  end
  response
end

#get_widget_combined_pdf(widget_id, file_path = nil) ⇒ String

Note:

SEEMINGLY NOT YET IMPLEMENTED SERVER-SIDE

Gets a single combined PDF document for the documents associated with a widget.

Parameters:

  • widget_id (String)
  • file_path (String) (defaults to: nil) —

    File path where to save the document. If none is given, nothing will be saved to file.

Returns:

  • (String) —

    Raw file stream



98
99
100
101
102
103
104
105
106
 
# File 'lib/echosign/widget/client.rb', line 98

def get_widget_combined_pdf(widget_id, file_path = nil)
  response = request(:get_widget_combined_pdf, widget_id)
  unless file_path.nil?
    file = File.new(file_path, 'wb')
    file.write(response)
    file.close
  end
  response
end

#get_widget_document_file(widget_id, document_id, file_path = nil) ⇒ String

Retrieves the file stream of a document of a widget

Parameters:

  • widget_id (String)
  • document_id (String)
  • file_path (String) (defaults to: nil) —

    File path where to save the document. If none is given, nothing will be saved to file.

Returns:

  • (String) —

    Raw file stream



66
67
68
69
70
71
72
73
74
 
# File 'lib/echosign/widget/client.rb', line 66

def get_widget_document_file(widget_id, document_id, file_path = nil)
  response = request(:get_widget_document_file, widget_id, document_id)
  unless file_path.nil?
    file = File.new(file_path, 'wb')
    file.write(response)
    file.close
  end
  response
end

#get_widget_documents(widget_id, version_id = nil, participant_email = nil) ⇒ Hash

Retrieves the IDs of the documents associated with widget.

Parameters:

  • widget_id (String)
  • version_id (String) (defaults to: nil) —

    The version identifier of widget as provided by get_widget. If not provided then latest version will be used.

  • participant_email (String) (defaults to: nil) —

    The email address of the participant to be used to retrieve documents

Returns:

  • (Hash) —

    Info about widget documents



56
57
58
 
# File 'lib/echosign/widget/client.rb', line 56

def get_widget_documents(widget_id, version_id = nil, participant_email = nil)
  request(:get_widget_documents, widget_id, version_id, participant_email)
end

#get_widget_form_data(widget_id, file_path = nil) ⇒ String

Note:

SEEMINGLY NOT YET IMPLEMENTED SERVER-SIDE

Retrieves data entered by the user into interactive form fields at the time they signed the widget

Parameters:

  • widget_id (String)
  • file_path (String) (defaults to: nil) —

    File path where to save the document. If none is given, nothing will be saved to file.

Returns:

  • (String) —

    Raw file stream



114
115
116
117
118
119
120
121
122
 
# File 'lib/echosign/widget/client.rb', line 114

def get_widget_form_data(widget_id, file_path = nil)
  response = request(:get_widget_form_data, widget_id)
  unless file_path.nil?
    file = File.new(file_path, 'wb')
    file.write(response)
    file.close
  end
  response
end

#get_widgets(user_id = nil, user_email = nil) ⇒ Hash

Retrieves widgets for a user

Parameters:

  • user_id (String) (defaults to: nil) —

    The ID of the user whose widgets are being requested

  • user_email (String) (defaults to: nil) —

    The email address of the user whose widgets are being requested. If both user_id and user_email are provided then user_id is given preference. If neither is specified then the user is inferred from the access token

Returns:

  • (Hash) —

    Widgets info



37
38
39
 
# File 'lib/echosign/widget/client.rb', line 37

def get_widgets(user_id = nil, user_email = nil)
  request(:get_widgets, user_id, user_email)
end

#library_combined_document(library_document_id, file_path = nil, auditReport = false) ⇒ String

Retrieves library combined document file

Parameters:

  • library_document_id (REQUIRED)
  • file_path (String) (defaults to: nil) —

    File path for saving the document. If none is given, nothing will be saved to disk.

  • auditReport (Boolean) (defaults to: false) —

    When set to YES attach an audit report to the library document PDF. Default value will be false.

Returns:

  • (String) —

    Raw library combined document file data



68
69
70
71
72
73
74
75
76
 
# File 'lib/echosign/library_documents/client.rb', line 68

def library_combined_document(library_document_id, file_path = nil, auditReport = false)
  response = request(:library_combined_document, library_document_id, auditReport)
  unless file_path.nil?
    file = File.new(file_path, 'wb')
    file.write(response)
    file.close
  end
  response
end

#library_document_audit_trail(library_document_id, file_path = nil) ⇒ String

Retrieves library document audit trail file

Parameters:

  • library_document_id (REQUIRED)
  • file_path (String) (defaults to: nil) —

    File path for saving the document. If none is given, nothing will be saved to disk.

Returns:

  • (String) —

    Raw library document file data



51
52
53
54
55
56
57
58
59
 
# File 'lib/echosign/library_documents/client.rb', line 51

def library_document_audit_trail(library_document_id, file_path = nil)
  response = request(:library_document_audit_trail, library_document_id)
  unless file_path.nil?
    file = File.new(file_path, 'wb')
    file.write(response)
    file.close
  end
  response
end

#mega_sign_combined_pdf(mega_sign_id, file_path = nil, versionId = nil, participantEmail = nil, attachSupportingDocuments = true, auditReport = false) ⇒ String

Gets a single combined PDF document for the documents associated with an mega_sign.

Parameters:

  • mega_sign_id (String) —

    (REQUIRED)

  • file_path (String) (defaults to: nil) —

    File path to save the document. If no file path is given, nothing is saved to disk.

  • versionId (String) (defaults to: nil) —

    The version identifier of mega_sign as provided by get_mega_sign. If not provided then latest version will be used

  • participantEmail (String) (defaults to: nil) —

    The email address of the participant to be used to retrieve documents. If none is given, the auth token will be used to determine the user

  • attachSupportingDocuments (Boolean) (defaults to: true) —

    When set to YES, attach corresponding supporting documents to the signed mega_sign PDF. Default value of this parameter is true.

  • auditReport (Boolean) (defaults to: false) —

    When set to YES, attach an audit report to the signed mega_sign PDF. Default value is false

Returns:

  • (String) —

    Raw bytes from document file



96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/echosign/mega_sign/client.rb', line 96

def mega_sign_combined_pdf(mega_sign_id, file_path = nil, versionId = nil, participantEmail = nil,
                           attachSupportingDocuments = true, auditReport = false)
  response = request(:mega_sign_combined_pdf, mega_sign_id, versionId, participantEmail, attachSupportingDocuments,
                     auditReport)
  unless file_path.nil?
    file = File.new(file_path, 'wb')
    file.write(response)
    file.close
  end
  response
end

#mega_sign_document_file(mega_sign_id, document_id, file_path = nil) ⇒ String

Retrieve a document file from an mega_sign

Parameters:

  • mega_sign_id (String) —

    (REQUIRED)

  • document_id (String) —

    (REQUIRED)

  • file_path (String) (defaults to: nil) —

    File path to save the document. If no file path is given, nothing is saved to disk.

Returns:

  • (String) —

    Raw bytes from document file



65
66
67
68
69
70
71
72
73
 
# File 'lib/echosign/mega_sign/client.rb', line 65

def mega_sign_document_file(mega_sign_id, document_id, file_path = nil)
  response = request(:mega_sign_document_file, mega_sign_id, document_id)
  unless file_path.nil?
    file = File.new(file_path, 'wb')
    file.write(response)
    file.close
  end
  response
end

#mega_sign_documents(mega_sign_id, recipient_email, format, version_id = nil) ⇒ Array

All documents relating to an mega_sign

Parameters:

  • mega_sign_id (String) —

    (REQUIRED)

  • recipient_email (String) —

    The email address of the participant to be used to retrieve documents. (REQUIRED)

  • format (String) —

    Content format of the supported documents. It can have two possible values ORIGINAL or CONVERTED_PDF. (REQUIRED)

  • version_id (String) (defaults to: nil) —

    Version of the mega_sign as provided by mega_sign_info(). If not provided, the latest version of the mega_sign is used.

Returns:

  • (Array) —

    Documents relating to mega_sign.



55
56
57
 
# File 'lib/echosign/mega_sign/client.rb', line 55

def mega_sign_documents(mega_sign_id, recipient_email, format, version_id = nil)
  result = request(:mega_sign_documents, mega_sign_id, recipient_email, format, version_id)
end

#mega_sign_form_data(mega_sign_id, file_path = nil) ⇒ String

Retrieves library document audit trail file

Parameters:

  • mega_sign_id (String) —

    (REQUIRED)

  • file_path (String) (defaults to: nil) —

    File path where to save the CSV file. If no file path is given, nothing is saved to disk.

Returns:

  • (String) —

    Raw bytes representing CSV file



114
115
116
117
118
119
120
121
122
 
# File 'lib/echosign/mega_sign/client.rb', line 114

def mega_sign_form_data(mega_sign_id, file_path = nil)
  response = request(:mega_sign_form_data, mega_sign_id)
  unless file_path.nil?
    file = File.new(file_path, 'wb')
    file.write(response)
    file.close
  end
  response
end

#mega_sign_info(mega_sign_id) ⇒ Hash

Gets detailed info on an mega_sign

Parameters:

  • mega_sign_id (String) —

    ID of mega_sign to retrieve info on.

Returns:

  • (Hash) —

    Detailed mega_sign info



25
26
27
 
# File 'lib/echosign/mega_sign/client.rb', line 25

def mega_sign_info(mega_sign_id)
  request(:mega_sign_info, mega_sign_id)
end

#mega_sign_signing_urls(mega_sign_id) ⇒ Hash

Retrieves the URL for the eSign page for the current signer(s) of an mega_sign

Parameters:

  • mega_sign_id (String) —

    (REQUIRED)

Returns:

  • (Hash) —

    URL information for the eSign page of the mega_sign



79
80
81
 
# File 'lib/echosign/mega_sign/client.rb', line 79

def mega_sign_signing_urls(mega_sign_id)
  response = request(:mega_sign_signing_urls, mega_sign_id)
end

#personalize_widget(widget_id, personalization) ⇒ Hash

Personalize the widget to a signable document for a specific known user

Parameters:

Returns:

  • (Hash) —

    Operation result



17
18
19
 
# File 'lib/echosign/widget/client.rb', line 17

def personalize_widget(widget_id, personalization)
  request(:personalize_widget, widget_id, personalization)
end

#update_widget_status(widget_id, status) ⇒ Hash

Enables or Disables a widget

Parameters:

Returns:

  • (Hash) —

    Widget status



26
27
28
 
# File 'lib/echosign/widget/client.rb', line 26

def update_widget_status(widget_id, status)
  request(:update_widget_status, widget_id, status)
end