docusign_esign 2.1.0 → 2.2.0.pre.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +1 -1
- data/docusign_esign-3.1.0.pre.rc1.gem +0 -0
- data/lib/docusign_esign.rb +450 -383
- data/{tests → lib/docusign_esign/api}/.DS_Store +0 -0
- data/lib/docusign_esign/api/accounts_api.rb +69 -8
- data/lib/docusign_esign/api/connect_api.rb +400 -0
- data/lib/docusign_esign/api/envelopes_api.rb +18 -6
- data/lib/docusign_esign/api/organizations_api.rb +232 -0
- data/lib/docusign_esign/api/tsps_api.rb +256 -0
- data/lib/docusign_esign/models/access_code_format.rb +273 -0
- data/lib/docusign_esign/models/account_notification.rb +206 -0
- data/lib/docusign_esign/models/account_ui_settings.rb +330 -0
- data/lib/docusign_esign/models/bcc_email_archive.rb +276 -0
- data/lib/docusign_esign/models/bcc_email_archive_history.rb +237 -0
- data/lib/docusign_esign/models/bcc_email_archive_history_list.rb +250 -0
- data/lib/docusign_esign/models/bcc_email_archive_list.rb +250 -0
- data/lib/docusign_esign/models/bulk_send_request.rb +188 -0
- data/lib/docusign_esign/models/bulk_send_response.rb +222 -0
- data/lib/docusign_esign/models/bulk_send_test_response.rb +212 -0
- data/lib/docusign_esign/models/bulk_sending_copy.rb +222 -0
- data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +198 -0
- data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +382 -0
- data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +198 -0
- data/lib/docusign_esign/models/bulk_sending_list.rb +210 -0
- data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +190 -0
- data/lib/docusign_esign/models/bulk_sending_list_summary.rb +218 -0
- data/lib/docusign_esign/models/carbon_copy.rb +19 -1
- data/lib/docusign_esign/models/certified_delivery.rb +19 -1
- data/lib/docusign_esign/models/comment.rb +392 -0
- data/lib/docusign_esign/models/comment_history_result.rb +220 -0
- data/lib/docusign_esign/models/comment_publish.rb +244 -0
- data/lib/docusign_esign/models/comment_thread.rb +961 -0
- data/lib/docusign_esign/models/comments_publish.rb +190 -0
- data/lib/docusign_esign/models/connect_salesforce_field.rb +258 -0
- data/lib/docusign_esign/models/connect_salesforce_object.rb +272 -0
- data/lib/docusign_esign/models/connect_user_object.rb +230 -0
- data/lib/docusign_esign/models/direct_debit_processor_information.rb +298 -0
- data/lib/docusign_esign/models/display_appliance_document.rb +258 -0
- data/lib/docusign_esign/models/display_appliance_document_page.rb +278 -0
- data/lib/docusign_esign/models/display_appliance_envelope.rb +328 -0
- data/lib/docusign_esign/models/display_appliance_info.rb +235 -0
- data/lib/docusign_esign/models/display_appliance_page.rb +278 -0
- data/lib/docusign_esign/models/display_appliance_pdf.rb +267 -0
- data/lib/docusign_esign/models/display_appliance_recipient.rb +388 -0
- data/lib/docusign_esign/models/display_appliance_signer_attachment.rb +248 -0
- data/lib/docusign_esign/models/document_fields_information.rb +1 -1
- data/lib/docusign_esign/models/document_html_display_settings.rb +11 -1
- data/lib/docusign_esign/models/envelope_document.rb +11 -1
- data/lib/docusign_esign/models/envelope_metadata.rb +208 -0
- data/lib/docusign_esign/models/envelope_purge_configuration.rb +218 -0
- data/lib/docusign_esign/models/envelope_transfer_rule.rb +273 -0
- data/lib/docusign_esign/models/envelope_transfer_rule_information.rb +250 -0
- data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +279 -0
- data/lib/docusign_esign/models/external_claim.rb +218 -0
- data/lib/docusign_esign/models/external_document_sources.rb +273 -0
- data/lib/docusign_esign/models/favorite_templates_content_item.rb +207 -0
- data/lib/docusign_esign/models/favorite_templates_info.rb +209 -0
- data/lib/docusign_esign/models/feature_available_metadata.rb +198 -0
- data/lib/docusign_esign/models/folder_shared_item.rb +289 -0
- data/lib/docusign_esign/models/form_data_item.rb +227 -0
- data/lib/docusign_esign/models/graphics_context.rb +208 -0
- data/lib/docusign_esign/models/id_check_configuration.rb +210 -0
- data/lib/docusign_esign/models/id_check_security_step.rb +188 -0
- data/lib/docusign_esign/models/locale_policy.rb +595 -0
- data/lib/docusign_esign/models/locale_policy_tab.rb +298 -0
- data/lib/docusign_esign/models/new_account_definition.rb +11 -1
- data/lib/docusign_esign/models/notification_default_settings.rb +196 -0
- data/lib/docusign_esign/models/notification_defaults.rb +196 -0
- data/lib/docusign_esign/models/offline_attributes.rb +238 -0
- data/lib/docusign_esign/models/page_size.rb +198 -0
- data/lib/docusign_esign/models/path_extended_element.rb +208 -0
- data/lib/docusign_esign/models/pay_pal_legacy_settings.rb +228 -0
- data/lib/docusign_esign/models/payment_gateway_account_setting.rb +218 -0
- data/lib/docusign_esign/models/payment_method_with_options.rb +200 -0
- data/lib/docusign_esign/models/poly_line.rb +218 -0
- data/lib/docusign_esign/models/poly_line_overlay.rb +885 -0
- data/lib/docusign_esign/models/recipient_email_notification.rb +1 -1
- data/lib/docusign_esign/models/recipient_preview_request.rb +278 -0
- data/lib/docusign_esign/models/recipient_proof_file.rb +188 -0
- data/lib/docusign_esign/models/signature_properties.rb +198 -0
- data/lib/docusign_esign/models/signer.rb +11 -2
- data/lib/docusign_esign/models/smart_section_display_settings.rb +11 -1
- data/lib/docusign_esign/models/tab_group.rb +911 -0
- data/lib/docusign_esign/models/usage_history.rb +1 -1
- data/lib/docusign_esign/models/user_information.rb +1 -1
- data/lib/docusign_esign/models/witness.rb +10 -1
- data/lib/docusign_esign/models/workspace_settings.rb +188 -0
- data/lib/docusign_esign/version.rb +1 -1
- data/tests/Gemfile.lock +1 -1
- data/tests/spec/unit_tests_using_jwt_spec.rb +6 -3
- metadata +74 -7
- data/Gemfile.lock +0 -73
- data/lib/docusign_esign/api/trust_service_providers_api.rb +0 -73
@@ -181,6 +181,15 @@ module DocuSign_eSign
|
|
181
181
|
end
|
182
182
|
end
|
183
183
|
|
184
|
+
class ListDocumentsOptions
|
185
|
+
#
|
186
|
+
attr_accessor :include_document_size
|
187
|
+
|
188
|
+
def self.default
|
189
|
+
@@default ||= ListDocumentsOptions.new
|
190
|
+
end
|
191
|
+
end
|
192
|
+
|
184
193
|
class ListRecipientsOptions
|
185
194
|
# When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response.
|
186
195
|
attr_accessor :include_anchor_tab_locations
|
@@ -296,7 +305,7 @@ module DocuSign_eSign
|
|
296
305
|
end
|
297
306
|
|
298
307
|
class ListTemplatesOptions
|
299
|
-
# The possible values are: matching_applied
|
308
|
+
# The possible values are: matching_applied ââ¬â This returns template matching information for the template.
|
300
309
|
attr_accessor :include
|
301
310
|
|
302
311
|
def self.default
|
@@ -2222,7 +2231,7 @@ module DocuSign_eSign
|
|
2222
2231
|
# Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
|
2223
2232
|
# @param account_id The external account number (int) or account ID Guid.
|
2224
2233
|
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
2225
|
-
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
2234
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
2226
2235
|
# @param recipient_id The ID of the recipient being accessed.
|
2227
2236
|
# @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
|
2228
2237
|
# @return [ConsumerDisclosure]
|
@@ -2235,7 +2244,7 @@ module DocuSign_eSign
|
|
2235
2244
|
# Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
|
2236
2245
|
# @param account_id The external account number (int) or account ID Guid.
|
2237
2246
|
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
2238
|
-
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
2247
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
2239
2248
|
# @param recipient_id The ID of the recipient being accessed.
|
2240
2249
|
# @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
|
2241
2250
|
# @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
|
@@ -3499,9 +3508,10 @@ module DocuSign_eSign
|
|
3499
3508
|
# Retrieves a list of documents associated with the specified envelope.
|
3500
3509
|
# @param account_id The external account number (int) or account ID Guid.
|
3501
3510
|
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
3511
|
+
# @param DocuSign_eSign::ListDocumentsOptions Options for modifying the behavior of the function.
|
3502
3512
|
# @return [EnvelopeDocumentsResult]
|
3503
|
-
def list_documents(account_id, envelope_id)
|
3504
|
-
data, _status_code, _headers = list_documents_with_http_info(account_id, envelope_id)
|
3513
|
+
def list_documents(account_id, envelope_id, options = DocuSign_eSign::ListDocumentsOptions.default)
|
3514
|
+
data, _status_code, _headers = list_documents_with_http_info(account_id, envelope_id, options)
|
3505
3515
|
return data
|
3506
3516
|
end
|
3507
3517
|
|
@@ -3509,8 +3519,9 @@ module DocuSign_eSign
|
|
3509
3519
|
# Retrieves a list of documents associated with the specified envelope.
|
3510
3520
|
# @param account_id The external account number (int) or account ID Guid.
|
3511
3521
|
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
3522
|
+
# @param DocuSign_eSign::ListDocumentsOptions Options for modifying the behavior of the function.
|
3512
3523
|
# @return [Array<(EnvelopeDocumentsResult, Fixnum, Hash)>] EnvelopeDocumentsResult data, response status code and response headers
|
3513
|
-
def list_documents_with_http_info(account_id, envelope_id)
|
3524
|
+
def list_documents_with_http_info(account_id, envelope_id, options = DocuSign_eSign::ListDocumentsOptions.default)
|
3514
3525
|
if @api_client.config.debugging
|
3515
3526
|
@api_client.config.logger.debug "Calling API: EnvelopesApi.list_documents ..."
|
3516
3527
|
end
|
@@ -3523,6 +3534,7 @@ module DocuSign_eSign
|
|
3523
3534
|
|
3524
3535
|
# query parameters
|
3525
3536
|
query_params = {}
|
3537
|
+
query_params[:'include_document_size'] = options.include_document_size if !options.include_document_size.nil?
|
3526
3538
|
|
3527
3539
|
# header parameters
|
3528
3540
|
header_params = {}
|
@@ -0,0 +1,232 @@
|
|
1
|
+
=begin
|
2
|
+
#DocuSign REST API
|
3
|
+
|
4
|
+
#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
|
5
|
+
|
6
|
+
OpenAPI spec version: v2
|
7
|
+
Contact: devcenter@docusign.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
=end
|
11
|
+
|
12
|
+
require "uri"
|
13
|
+
|
14
|
+
module DocuSign_eSign
|
15
|
+
|
16
|
+
|
17
|
+
class OrganizationsApi
|
18
|
+
attr_accessor :api_client
|
19
|
+
|
20
|
+
def initialize(api_client = OrganizationsApi.default)
|
21
|
+
@api_client = api_client
|
22
|
+
end
|
23
|
+
|
24
|
+
# Retrieves org level report by correlation id and site.
|
25
|
+
#
|
26
|
+
# @param organization_id
|
27
|
+
# @param report_correlation_id
|
28
|
+
# @return [nil]
|
29
|
+
def delete_report(organization_id, report_correlation_id)
|
30
|
+
delete_report_with_http_info(organization_id, report_correlation_id)
|
31
|
+
return nil
|
32
|
+
end
|
33
|
+
|
34
|
+
# Retrieves org level report by correlation id and site.
|
35
|
+
#
|
36
|
+
# @param organization_id
|
37
|
+
# @param report_correlation_id
|
38
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
39
|
+
def delete_report_with_http_info(organization_id, report_correlation_id)
|
40
|
+
if @api_client.config.debugging
|
41
|
+
@api_client.config.logger.debug "Calling API: OrganizationsApi.delete_report ..."
|
42
|
+
end
|
43
|
+
# verify the required parameter 'organization_id' is set
|
44
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.delete_report" if organization_id.nil?
|
45
|
+
# verify the required parameter 'report_correlation_id' is set
|
46
|
+
fail ArgumentError, "Missing the required parameter 'report_correlation_id' when calling OrganizationsApi.delete_report" if report_correlation_id.nil?
|
47
|
+
# resource path
|
48
|
+
local_var_path = "/v2/organization_reporting/{organizationId}/reports/{reportCorrelationId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'reportCorrelationId' + '}', report_correlation_id.to_s)
|
49
|
+
|
50
|
+
# query parameters
|
51
|
+
query_params = {}
|
52
|
+
|
53
|
+
# header parameters
|
54
|
+
header_params = {}
|
55
|
+
# HTTP header 'Accept' (if needed)
|
56
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
57
|
+
|
58
|
+
# form parameters
|
59
|
+
form_params = {}
|
60
|
+
|
61
|
+
# http body (model)
|
62
|
+
post_body = nil
|
63
|
+
auth_names = []
|
64
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
65
|
+
:header_params => header_params,
|
66
|
+
:query_params => query_params,
|
67
|
+
:form_params => form_params,
|
68
|
+
:body => post_body,
|
69
|
+
:auth_names => auth_names)
|
70
|
+
if @api_client.config.debugging
|
71
|
+
@api_client.config.logger.debug "API called: OrganizationsApi#delete_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
72
|
+
end
|
73
|
+
return data, status_code, headers
|
74
|
+
end
|
75
|
+
|
76
|
+
# Retrieves an account settings comparison.
|
77
|
+
#
|
78
|
+
# @param organization_id
|
79
|
+
# @param result_id
|
80
|
+
# @return [nil]
|
81
|
+
def get_account_settings_export(organization_id, result_id)
|
82
|
+
get_account_settings_export_with_http_info(organization_id, result_id)
|
83
|
+
return nil
|
84
|
+
end
|
85
|
+
|
86
|
+
# Retrieves an account settings comparison.
|
87
|
+
#
|
88
|
+
# @param organization_id
|
89
|
+
# @param result_id
|
90
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
91
|
+
def get_account_settings_export_with_http_info(organization_id, result_id)
|
92
|
+
if @api_client.config.debugging
|
93
|
+
@api_client.config.logger.debug "Calling API: OrganizationsApi.get_account_settings_export ..."
|
94
|
+
end
|
95
|
+
# verify the required parameter 'organization_id' is set
|
96
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_account_settings_export" if organization_id.nil?
|
97
|
+
# verify the required parameter 'result_id' is set
|
98
|
+
fail ArgumentError, "Missing the required parameter 'result_id' when calling OrganizationsApi.get_account_settings_export" if result_id.nil?
|
99
|
+
# resource path
|
100
|
+
local_var_path = "/v2/organization_exports/{organizationId}/account_settings/{resultId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'resultId' + '}', result_id.to_s)
|
101
|
+
|
102
|
+
# query parameters
|
103
|
+
query_params = {}
|
104
|
+
|
105
|
+
# header parameters
|
106
|
+
header_params = {}
|
107
|
+
# HTTP header 'Accept' (if needed)
|
108
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
109
|
+
|
110
|
+
# form parameters
|
111
|
+
form_params = {}
|
112
|
+
|
113
|
+
# http body (model)
|
114
|
+
post_body = nil
|
115
|
+
auth_names = []
|
116
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
117
|
+
:header_params => header_params,
|
118
|
+
:query_params => query_params,
|
119
|
+
:form_params => form_params,
|
120
|
+
:body => post_body,
|
121
|
+
:auth_names => auth_names)
|
122
|
+
if @api_client.config.debugging
|
123
|
+
@api_client.config.logger.debug "API called: OrganizationsApi#get_account_settings_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
124
|
+
end
|
125
|
+
return data, status_code, headers
|
126
|
+
end
|
127
|
+
|
128
|
+
# Retrieves org level report by correlation id and site.
|
129
|
+
#
|
130
|
+
# @param organization_id
|
131
|
+
# @param report_correlation_id
|
132
|
+
# @return [nil]
|
133
|
+
def get_report(organization_id, report_correlation_id)
|
134
|
+
get_report_with_http_info(organization_id, report_correlation_id)
|
135
|
+
return nil
|
136
|
+
end
|
137
|
+
|
138
|
+
# Retrieves org level report by correlation id and site.
|
139
|
+
#
|
140
|
+
# @param organization_id
|
141
|
+
# @param report_correlation_id
|
142
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
143
|
+
def get_report_with_http_info(organization_id, report_correlation_id)
|
144
|
+
if @api_client.config.debugging
|
145
|
+
@api_client.config.logger.debug "Calling API: OrganizationsApi.get_report ..."
|
146
|
+
end
|
147
|
+
# verify the required parameter 'organization_id' is set
|
148
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_report" if organization_id.nil?
|
149
|
+
# verify the required parameter 'report_correlation_id' is set
|
150
|
+
fail ArgumentError, "Missing the required parameter 'report_correlation_id' when calling OrganizationsApi.get_report" if report_correlation_id.nil?
|
151
|
+
# resource path
|
152
|
+
local_var_path = "/v2/organization_reporting/{organizationId}/reports/{reportCorrelationId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'reportCorrelationId' + '}', report_correlation_id.to_s)
|
153
|
+
|
154
|
+
# query parameters
|
155
|
+
query_params = {}
|
156
|
+
|
157
|
+
# header parameters
|
158
|
+
header_params = {}
|
159
|
+
# HTTP header 'Accept' (if needed)
|
160
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
161
|
+
|
162
|
+
# form parameters
|
163
|
+
form_params = {}
|
164
|
+
|
165
|
+
# http body (model)
|
166
|
+
post_body = nil
|
167
|
+
auth_names = []
|
168
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
169
|
+
:header_params => header_params,
|
170
|
+
:query_params => query_params,
|
171
|
+
:form_params => form_params,
|
172
|
+
:body => post_body,
|
173
|
+
:auth_names => auth_names)
|
174
|
+
if @api_client.config.debugging
|
175
|
+
@api_client.config.logger.debug "API called: OrganizationsApi#get_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
176
|
+
end
|
177
|
+
return data, status_code, headers
|
178
|
+
end
|
179
|
+
|
180
|
+
# Retrieves UserList Export Results data.
|
181
|
+
#
|
182
|
+
# @param organization_id
|
183
|
+
# @param result_id
|
184
|
+
# @return [nil]
|
185
|
+
def get_user_list_export(organization_id, result_id)
|
186
|
+
get_user_list_export_with_http_info(organization_id, result_id)
|
187
|
+
return nil
|
188
|
+
end
|
189
|
+
|
190
|
+
# Retrieves UserList Export Results data.
|
191
|
+
#
|
192
|
+
# @param organization_id
|
193
|
+
# @param result_id
|
194
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
195
|
+
def get_user_list_export_with_http_info(organization_id, result_id)
|
196
|
+
if @api_client.config.debugging
|
197
|
+
@api_client.config.logger.debug "Calling API: OrganizationsApi.get_user_list_export ..."
|
198
|
+
end
|
199
|
+
# verify the required parameter 'organization_id' is set
|
200
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_user_list_export" if organization_id.nil?
|
201
|
+
# verify the required parameter 'result_id' is set
|
202
|
+
fail ArgumentError, "Missing the required parameter 'result_id' when calling OrganizationsApi.get_user_list_export" if result_id.nil?
|
203
|
+
# resource path
|
204
|
+
local_var_path = "/v2/organization_exports/{organizationId}/user_list/{resultId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'resultId' + '}', result_id.to_s)
|
205
|
+
|
206
|
+
# query parameters
|
207
|
+
query_params = {}
|
208
|
+
|
209
|
+
# header parameters
|
210
|
+
header_params = {}
|
211
|
+
# HTTP header 'Accept' (if needed)
|
212
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
213
|
+
|
214
|
+
# form parameters
|
215
|
+
form_params = {}
|
216
|
+
|
217
|
+
# http body (model)
|
218
|
+
post_body = nil
|
219
|
+
auth_names = []
|
220
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
221
|
+
:header_params => header_params,
|
222
|
+
:query_params => query_params,
|
223
|
+
:form_params => form_params,
|
224
|
+
:body => post_body,
|
225
|
+
:auth_names => auth_names)
|
226
|
+
if @api_client.config.debugging
|
227
|
+
@api_client.config.logger.debug "API called: OrganizationsApi#get_user_list_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
228
|
+
end
|
229
|
+
return data, status_code, headers
|
230
|
+
end
|
231
|
+
end
|
232
|
+
end
|
@@ -0,0 +1,256 @@
|
|
1
|
+
=begin
|
2
|
+
#DocuSign REST API
|
3
|
+
|
4
|
+
#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
|
5
|
+
|
6
|
+
OpenAPI spec version: v2
|
7
|
+
Contact: devcenter@docusign.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
=end
|
11
|
+
|
12
|
+
require "uri"
|
13
|
+
|
14
|
+
module DocuSign_eSign
|
15
|
+
|
16
|
+
|
17
|
+
class TSPsApi
|
18
|
+
attr_accessor :api_client
|
19
|
+
|
20
|
+
def initialize(api_client = TSPsApi.default)
|
21
|
+
@api_client = api_client
|
22
|
+
end
|
23
|
+
|
24
|
+
# Complete Sign Hash
|
25
|
+
#
|
26
|
+
# @param complete_sign_request (optional parameter)
|
27
|
+
# @return [CompleteSignHashResponse]
|
28
|
+
def complete_sign_hash(complete_sign_request)
|
29
|
+
data, _status_code, _headers = complete_sign_hash_with_http_info( complete_sign_request)
|
30
|
+
return data
|
31
|
+
end
|
32
|
+
|
33
|
+
# Complete Sign Hash
|
34
|
+
#
|
35
|
+
# @param complete_sign_request (optional parameter)
|
36
|
+
# @return [Array<(CompleteSignHashResponse, Fixnum, Hash)>] CompleteSignHashResponse data, response status code and response headers
|
37
|
+
def complete_sign_hash_with_http_info(complete_sign_request)
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug "Calling API: TSPsApi.complete_sign_hash ..."
|
40
|
+
end
|
41
|
+
# resource path
|
42
|
+
local_var_path = "/v2/signature/completesignhash".sub('{format}','json')
|
43
|
+
|
44
|
+
# query parameters
|
45
|
+
query_params = {}
|
46
|
+
|
47
|
+
# header parameters
|
48
|
+
header_params = {}
|
49
|
+
# HTTP header 'Accept' (if needed)
|
50
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
51
|
+
|
52
|
+
# form parameters
|
53
|
+
form_params = {}
|
54
|
+
|
55
|
+
# http body (model)
|
56
|
+
post_body = @api_client.object_to_http_body(complete_sign_request)
|
57
|
+
auth_names = []
|
58
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
59
|
+
:header_params => header_params,
|
60
|
+
:query_params => query_params,
|
61
|
+
:form_params => form_params,
|
62
|
+
:body => post_body,
|
63
|
+
:auth_names => auth_names,
|
64
|
+
:return_type => 'CompleteSignHashResponse')
|
65
|
+
if @api_client.config.debugging
|
66
|
+
@api_client.config.logger.debug "API called: TSPsApi#complete_sign_hash\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
67
|
+
end
|
68
|
+
return data, status_code, headers
|
69
|
+
end
|
70
|
+
|
71
|
+
# Get User Info To Sign Document
|
72
|
+
#
|
73
|
+
# @return [UserInfoResponse]
|
74
|
+
def get_user_info()
|
75
|
+
data, _status_code, _headers = get_user_info_with_http_info()
|
76
|
+
return data
|
77
|
+
end
|
78
|
+
|
79
|
+
# Get User Info To Sign Document
|
80
|
+
#
|
81
|
+
# @return [Array<(UserInfoResponse, Fixnum, Hash)>] UserInfoResponse data, response status code and response headers
|
82
|
+
def get_user_info_with_http_info()
|
83
|
+
if @api_client.config.debugging
|
84
|
+
@api_client.config.logger.debug "Calling API: TSPsApi.get_user_info ..."
|
85
|
+
end
|
86
|
+
# resource path
|
87
|
+
local_var_path = "/v2/signature/userInfo".sub('{format}','json')
|
88
|
+
|
89
|
+
# query parameters
|
90
|
+
query_params = {}
|
91
|
+
|
92
|
+
# header parameters
|
93
|
+
header_params = {}
|
94
|
+
# HTTP header 'Accept' (if needed)
|
95
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
96
|
+
|
97
|
+
# form parameters
|
98
|
+
form_params = {}
|
99
|
+
|
100
|
+
# http body (model)
|
101
|
+
post_body = nil
|
102
|
+
auth_names = []
|
103
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
104
|
+
:header_params => header_params,
|
105
|
+
:query_params => query_params,
|
106
|
+
:form_params => form_params,
|
107
|
+
:body => post_body,
|
108
|
+
:auth_names => auth_names,
|
109
|
+
:return_type => 'UserInfoResponse')
|
110
|
+
if @api_client.config.debugging
|
111
|
+
@api_client.config.logger.debug "API called: TSPsApi#get_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
112
|
+
end
|
113
|
+
return data, status_code, headers
|
114
|
+
end
|
115
|
+
|
116
|
+
# Report status from the TSP to DocuSign
|
117
|
+
#
|
118
|
+
# @param tsp_health_check_request (optional parameter)
|
119
|
+
# @return [nil]
|
120
|
+
def health_check(tsp_health_check_request)
|
121
|
+
health_check_with_http_info( tsp_health_check_request)
|
122
|
+
return nil
|
123
|
+
end
|
124
|
+
|
125
|
+
# Report status from the TSP to DocuSign
|
126
|
+
#
|
127
|
+
# @param tsp_health_check_request (optional parameter)
|
128
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
129
|
+
def health_check_with_http_info(tsp_health_check_request)
|
130
|
+
if @api_client.config.debugging
|
131
|
+
@api_client.config.logger.debug "Calling API: TSPsApi.health_check ..."
|
132
|
+
end
|
133
|
+
# resource path
|
134
|
+
local_var_path = "/v2/signature/healthcheck".sub('{format}','json')
|
135
|
+
|
136
|
+
# query parameters
|
137
|
+
query_params = {}
|
138
|
+
|
139
|
+
# header parameters
|
140
|
+
header_params = {}
|
141
|
+
# HTTP header 'Accept' (if needed)
|
142
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
143
|
+
|
144
|
+
# form parameters
|
145
|
+
form_params = {}
|
146
|
+
|
147
|
+
# http body (model)
|
148
|
+
post_body = @api_client.object_to_http_body(tsp_health_check_request)
|
149
|
+
auth_names = []
|
150
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
151
|
+
:header_params => header_params,
|
152
|
+
:query_params => query_params,
|
153
|
+
:form_params => form_params,
|
154
|
+
:body => post_body,
|
155
|
+
:auth_names => auth_names)
|
156
|
+
if @api_client.config.debugging
|
157
|
+
@api_client.config.logger.debug "API called: TSPsApi#health_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
158
|
+
end
|
159
|
+
return data, status_code, headers
|
160
|
+
end
|
161
|
+
|
162
|
+
# Get Signature Session Info To Sign Document Hash
|
163
|
+
#
|
164
|
+
# @param sign_session_info_request (optional parameter)
|
165
|
+
# @return [SignHashSessionInfoResponse]
|
166
|
+
def sign_hash_session_info(sign_session_info_request)
|
167
|
+
data, _status_code, _headers = sign_hash_session_info_with_http_info( sign_session_info_request)
|
168
|
+
return data
|
169
|
+
end
|
170
|
+
|
171
|
+
# Get Signature Session Info To Sign Document Hash
|
172
|
+
#
|
173
|
+
# @param sign_session_info_request (optional parameter)
|
174
|
+
# @return [Array<(SignHashSessionInfoResponse, Fixnum, Hash)>] SignHashSessionInfoResponse data, response status code and response headers
|
175
|
+
def sign_hash_session_info_with_http_info(sign_session_info_request)
|
176
|
+
if @api_client.config.debugging
|
177
|
+
@api_client.config.logger.debug "Calling API: TSPsApi.sign_hash_session_info ..."
|
178
|
+
end
|
179
|
+
# resource path
|
180
|
+
local_var_path = "/v2/signature/signhashsessioninfo".sub('{format}','json')
|
181
|
+
|
182
|
+
# query parameters
|
183
|
+
query_params = {}
|
184
|
+
|
185
|
+
# header parameters
|
186
|
+
header_params = {}
|
187
|
+
# HTTP header 'Accept' (if needed)
|
188
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
189
|
+
|
190
|
+
# form parameters
|
191
|
+
form_params = {}
|
192
|
+
|
193
|
+
# http body (model)
|
194
|
+
post_body = @api_client.object_to_http_body(sign_session_info_request)
|
195
|
+
auth_names = []
|
196
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
197
|
+
:header_params => header_params,
|
198
|
+
:query_params => query_params,
|
199
|
+
:form_params => form_params,
|
200
|
+
:body => post_body,
|
201
|
+
:auth_names => auth_names,
|
202
|
+
:return_type => 'SignHashSessionInfoResponse')
|
203
|
+
if @api_client.config.debugging
|
204
|
+
@api_client.config.logger.debug "API called: TSPsApi#sign_hash_session_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
205
|
+
end
|
206
|
+
return data, status_code, headers
|
207
|
+
end
|
208
|
+
|
209
|
+
# Report an error from the tsp to docusign
|
210
|
+
#
|
211
|
+
# @param update_transaction_request (optional parameter)
|
212
|
+
# @return [UpdateTransactionResponse]
|
213
|
+
def update_transaction(update_transaction_request)
|
214
|
+
data, _status_code, _headers = update_transaction_with_http_info( update_transaction_request)
|
215
|
+
return data
|
216
|
+
end
|
217
|
+
|
218
|
+
# Report an error from the tsp to docusign
|
219
|
+
#
|
220
|
+
# @param update_transaction_request (optional parameter)
|
221
|
+
# @return [Array<(UpdateTransactionResponse, Fixnum, Hash)>] UpdateTransactionResponse data, response status code and response headers
|
222
|
+
def update_transaction_with_http_info(update_transaction_request)
|
223
|
+
if @api_client.config.debugging
|
224
|
+
@api_client.config.logger.debug "Calling API: TSPsApi.update_transaction ..."
|
225
|
+
end
|
226
|
+
# resource path
|
227
|
+
local_var_path = "/v2/signature/updatetransaction".sub('{format}','json')
|
228
|
+
|
229
|
+
# query parameters
|
230
|
+
query_params = {}
|
231
|
+
|
232
|
+
# header parameters
|
233
|
+
header_params = {}
|
234
|
+
# HTTP header 'Accept' (if needed)
|
235
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
236
|
+
|
237
|
+
# form parameters
|
238
|
+
form_params = {}
|
239
|
+
|
240
|
+
# http body (model)
|
241
|
+
post_body = @api_client.object_to_http_body(update_transaction_request)
|
242
|
+
auth_names = []
|
243
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
244
|
+
:header_params => header_params,
|
245
|
+
:query_params => query_params,
|
246
|
+
:form_params => form_params,
|
247
|
+
:body => post_body,
|
248
|
+
:auth_names => auth_names,
|
249
|
+
:return_type => 'UpdateTransactionResponse')
|
250
|
+
if @api_client.config.debugging
|
251
|
+
@api_client.config.logger.debug "API called: TSPsApi#update_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
252
|
+
end
|
253
|
+
return data, status_code, headers
|
254
|
+
end
|
255
|
+
end
|
256
|
+
end
|