docusign_esign 3.14.0 → 3.15.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +59 -0
- data/lib/docusign_esign/client/api_client.rb +1 -1
- data/lib/docusign_esign/models/account_settings_information.rb +2 -2
- data/lib/docusign_esign/models/agent.rb +11 -1
- data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +203 -0
- data/lib/docusign_esign/models/bulk_send_batch_status.rb +21 -1
- data/lib/docusign_esign/models/carbon_copy.rb +11 -1
- data/lib/docusign_esign/models/certified_delivery.rb +11 -1
- data/lib/docusign_esign/models/checkbox.rb +38 -1
- data/lib/docusign_esign/models/delayed_routing_api_model.rb +12 -12
- data/lib/docusign_esign/models/editor.rb +11 -1
- data/lib/docusign_esign/models/envelope_delay_rule_api_model.rb +3 -2
- data/lib/docusign_esign/models/folder_item_v2.rb +11 -1
- data/lib/docusign_esign/models/intermediary.rb +11 -1
- data/lib/docusign_esign/models/list.rb +20 -1
- data/lib/docusign_esign/models/notary_recipient.rb +11 -1
- data/lib/docusign_esign/models/payment_details.rb +11 -1
- data/lib/docusign_esign/models/radio_group.rb +42 -4
- data/lib/docusign_esign/models/scheduled_sending_api_model.rb +12 -12
- data/lib/docusign_esign/models/signer.rb +11 -1
- data/lib/docusign_esign/models/witness.rb +11 -1
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +1 -0
- data/tests/spec/unit_tests_using_jwt_spec.rb +604 -448
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 98b3242e6d94f473aa2c047a16339235a963359c584685f546ae680ca026f991
|
4
|
+
data.tar.gz: 3b7a1128e7e8e279a83e61eb576701f6bcc5a87277765396c0499bdc862d7681
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 36efcee69919d028304748affaba7eca7392eb0dd95aaac12148df8579a3906353ca0274740358aa38a207b90898f0d6f70f2d7fe140bbdbee8a19d98587257b
|
7
|
+
data.tar.gz: 29553be78d24f4d17d8784d16b626e6fe3aa20c411143dea43ef8703625e3a63297187fd493404e762f7a5a40bdc19b263073a5a244dc36b6dbc5ba877891043
|
data/CHANGELOG.md
CHANGED
@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.
|
|
3
3
|
|
4
4
|
See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
|
5
5
|
|
6
|
+
## [v3.15.0] - eSignature API v2.1-21.4.02.00 - 2022-02-08
|
7
|
+
### Changed
|
8
|
+
- Added support for version v2.1-21.4.02.00 of the DocuSign ESignature API.
|
9
|
+
- Updated the SDK release version.
|
10
|
+
|
6
11
|
## [v3.14.0] - eSignature API v2.1-21.4.01.00 - 2022-01-06
|
7
12
|
### Changed
|
8
13
|
- Added support for version v2.1-21.4.01.00 of the DocuSign ESignature API.
|
@@ -560,6 +560,65 @@ module DocuSign_eSign
|
|
560
560
|
return data, status_code, headers
|
561
561
|
end
|
562
562
|
|
563
|
+
# Initiate a specific bulk send batch action
|
564
|
+
#
|
565
|
+
# @param account_id The external account number (int) or account ID Guid.
|
566
|
+
# @param bulk_action
|
567
|
+
# @param bulk_send_batch_id
|
568
|
+
# @param bulk_send_batch_action_request (optional parameter)
|
569
|
+
# @return [BulkSendBatchStatus]
|
570
|
+
def update_bulk_send_batch_action(account_id, bulk_action, bulk_send_batch_id, bulk_send_batch_action_request)
|
571
|
+
data, _status_code, _headers = update_bulk_send_batch_action_with_http_info(account_id, bulk_action, bulk_send_batch_id, bulk_send_batch_action_request)
|
572
|
+
return data
|
573
|
+
end
|
574
|
+
|
575
|
+
# Initiate a specific bulk send batch action
|
576
|
+
#
|
577
|
+
# @param account_id The external account number (int) or account ID Guid.
|
578
|
+
# @param bulk_action
|
579
|
+
# @param bulk_send_batch_id
|
580
|
+
# @param bulk_send_batch_action_request (optional parameter)
|
581
|
+
# @return [Array<(BulkSendBatchStatus, Fixnum, Hash)>] BulkSendBatchStatus data, response status code and response headers
|
582
|
+
def update_bulk_send_batch_action_with_http_info(account_id, bulk_action, bulk_send_batch_id, bulk_send_batch_action_request)
|
583
|
+
if @api_client.config.debugging
|
584
|
+
@api_client.config.logger.debug "Calling API: BulkEnvelopesApi.update_bulk_send_batch_action ..."
|
585
|
+
end
|
586
|
+
# verify the required parameter 'account_id' is set
|
587
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.update_bulk_send_batch_action" if account_id.nil?
|
588
|
+
# verify the required parameter 'bulk_action' is set
|
589
|
+
fail ArgumentError, "Missing the required parameter 'bulk_action' when calling BulkEnvelopesApi.update_bulk_send_batch_action" if bulk_action.nil?
|
590
|
+
# verify the required parameter 'bulk_send_batch_id' is set
|
591
|
+
fail ArgumentError, "Missing the required parameter 'bulk_send_batch_id' when calling BulkEnvelopesApi.update_bulk_send_batch_action" if bulk_send_batch_id.nil?
|
592
|
+
# resource path
|
593
|
+
local_var_path = "/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkAction' + '}', bulk_action.to_s).sub('{' + 'bulkSendBatchId' + '}', bulk_send_batch_id.to_s)
|
594
|
+
|
595
|
+
# query parameters
|
596
|
+
query_params = {}
|
597
|
+
|
598
|
+
# header parameters
|
599
|
+
header_params = {}
|
600
|
+
# HTTP header 'Accept' (if needed)
|
601
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
602
|
+
|
603
|
+
# form parameters
|
604
|
+
form_params = {}
|
605
|
+
|
606
|
+
# http body (model)
|
607
|
+
post_body = @api_client.object_to_http_body(bulk_send_batch_action_request)
|
608
|
+
auth_names = []
|
609
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
610
|
+
:header_params => header_params,
|
611
|
+
:query_params => query_params,
|
612
|
+
:form_params => form_params,
|
613
|
+
:body => post_body,
|
614
|
+
:auth_names => auth_names,
|
615
|
+
:return_type => 'BulkSendBatchStatus')
|
616
|
+
if @api_client.config.debugging
|
617
|
+
@api_client.config.logger.debug "API called: BulkEnvelopesApi#update_bulk_send_batch_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
618
|
+
end
|
619
|
+
return data, status_code, headers
|
620
|
+
end
|
621
|
+
|
563
622
|
# Put/Update a specific bulk send batch status
|
564
623
|
#
|
565
624
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -35,7 +35,7 @@ module DocuSign_eSign
|
|
35
35
|
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
36
36
|
def initialize(config = Configuration.default)
|
37
37
|
@config = config
|
38
|
-
@user_agent = "Swagger-Codegen/3.
|
38
|
+
@user_agent = "Swagger-Codegen/3.15.0/ruby"
|
39
39
|
@default_headers = {
|
40
40
|
'Content-Type' => "application/json",
|
41
41
|
'User-Agent' => @user_agent
|
@@ -116,7 +116,7 @@ module DocuSign_eSign
|
|
116
116
|
|
117
117
|
attr_accessor :allow_data_download_metadata
|
118
118
|
|
119
|
-
#
|
119
|
+
# \"true\" if the account has permission to use the delayed routing feature to insert delays before routing an envelope to a recipient, \"false\" otherwise.
|
120
120
|
attr_accessor :allow_delayed_routing
|
121
121
|
|
122
122
|
attr_accessor :allow_delayed_routing_metadata
|
@@ -351,7 +351,7 @@ module DocuSign_eSign
|
|
351
351
|
|
352
352
|
attr_accessor :allow_safe_bio_pharma_signer_certificate_metadata
|
353
353
|
|
354
|
-
#
|
354
|
+
# \"true\" if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, \"false\" otherwise.
|
355
355
|
attr_accessor :allow_scheduled_sending
|
356
356
|
|
357
357
|
attr_accessor :allow_scheduled_sending_metadata
|
@@ -70,6 +70,9 @@ module DocuSign_eSign
|
|
70
70
|
|
71
71
|
attr_accessor :email_notification
|
72
72
|
|
73
|
+
#
|
74
|
+
attr_accessor :email_recipient_post_signing_url
|
75
|
+
|
73
76
|
# Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
|
74
77
|
attr_accessor :embedded_recipient_start_url
|
75
78
|
|
@@ -228,6 +231,7 @@ module DocuSign_eSign
|
|
228
231
|
:'email' => :'email',
|
229
232
|
:'email_metadata' => :'emailMetadata',
|
230
233
|
:'email_notification' => :'emailNotification',
|
234
|
+
:'email_recipient_post_signing_url' => :'emailRecipientPostSigningURL',
|
231
235
|
:'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
|
232
236
|
:'error_details' => :'errorDetails',
|
233
237
|
:'excluded_documents' => :'excludedDocuments',
|
@@ -305,6 +309,7 @@ module DocuSign_eSign
|
|
305
309
|
:'email' => :'String',
|
306
310
|
:'email_metadata' => :'PropertyMetadata',
|
307
311
|
:'email_notification' => :'RecipientEmailNotification',
|
312
|
+
:'email_recipient_post_signing_url' => :'String',
|
308
313
|
:'embedded_recipient_start_url' => :'String',
|
309
314
|
:'error_details' => :'ErrorDetails',
|
310
315
|
:'excluded_documents' => :'Array<String>',
|
@@ -453,6 +458,10 @@ module DocuSign_eSign
|
|
453
458
|
self.email_notification = attributes[:'emailNotification']
|
454
459
|
end
|
455
460
|
|
461
|
+
if attributes.has_key?(:'emailRecipientPostSigningURL')
|
462
|
+
self.email_recipient_post_signing_url = attributes[:'emailRecipientPostSigningURL']
|
463
|
+
end
|
464
|
+
|
456
465
|
if attributes.has_key?(:'embeddedRecipientStartURL')
|
457
466
|
self.embedded_recipient_start_url = attributes[:'embeddedRecipientStartURL']
|
458
467
|
end
|
@@ -706,6 +715,7 @@ module DocuSign_eSign
|
|
706
715
|
email == o.email &&
|
707
716
|
email_metadata == o.email_metadata &&
|
708
717
|
email_notification == o.email_notification &&
|
718
|
+
email_recipient_post_signing_url == o.email_recipient_post_signing_url &&
|
709
719
|
embedded_recipient_start_url == o.embedded_recipient_start_url &&
|
710
720
|
error_details == o.error_details &&
|
711
721
|
excluded_documents == o.excluded_documents &&
|
@@ -768,7 +778,7 @@ module DocuSign_eSign
|
|
768
778
|
# Calculates hash code according to all attributes.
|
769
779
|
# @return [Fixnum] Hash code
|
770
780
|
def hash
|
771
|
-
[access_code, access_code_metadata, add_access_code_to_email, additional_notifications, allow_system_override_for_locked_recipient, auto_responded_reason, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
|
781
|
+
[access_code, access_code_metadata, add_access_code_to_email, additional_notifications, allow_system_override_for_locked_recipient, auto_responded_reason, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
|
772
782
|
end
|
773
783
|
|
774
784
|
# Builds the object from hash
|
@@ -0,0 +1,203 @@
|
|
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.1
|
7
|
+
Contact: devcenter@docusign.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
=end
|
11
|
+
|
12
|
+
require 'date'
|
13
|
+
|
14
|
+
module DocuSign_eSign
|
15
|
+
class BulkSendBatchActionRequest
|
16
|
+
#
|
17
|
+
attr_accessor :action
|
18
|
+
|
19
|
+
attr_accessor :notification
|
20
|
+
|
21
|
+
#
|
22
|
+
attr_accessor :void_reason
|
23
|
+
|
24
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
25
|
+
def self.attribute_map
|
26
|
+
{
|
27
|
+
:'action' => :'action',
|
28
|
+
:'notification' => :'notification',
|
29
|
+
:'void_reason' => :'voidReason'
|
30
|
+
}
|
31
|
+
end
|
32
|
+
|
33
|
+
# Attribute type mapping.
|
34
|
+
def self.swagger_types
|
35
|
+
{
|
36
|
+
:'action' => :'String',
|
37
|
+
:'notification' => :'Notification',
|
38
|
+
:'void_reason' => :'String'
|
39
|
+
}
|
40
|
+
end
|
41
|
+
|
42
|
+
# Initializes the object
|
43
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
44
|
+
def initialize(attributes = {})
|
45
|
+
return unless attributes.is_a?(Hash)
|
46
|
+
|
47
|
+
# convert string to symbol for hash key
|
48
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
49
|
+
|
50
|
+
if attributes.has_key?(:'action')
|
51
|
+
self.action = attributes[:'action']
|
52
|
+
end
|
53
|
+
|
54
|
+
if attributes.has_key?(:'notification')
|
55
|
+
self.notification = attributes[:'notification']
|
56
|
+
end
|
57
|
+
|
58
|
+
if attributes.has_key?(:'voidReason')
|
59
|
+
self.void_reason = attributes[:'voidReason']
|
60
|
+
end
|
61
|
+
end
|
62
|
+
|
63
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
64
|
+
# @return Array for valid properties with the reasons
|
65
|
+
def list_invalid_properties
|
66
|
+
invalid_properties = Array.new
|
67
|
+
invalid_properties
|
68
|
+
end
|
69
|
+
|
70
|
+
# Check to see if the all the properties in the model are valid
|
71
|
+
# @return true if the model is valid
|
72
|
+
def valid?
|
73
|
+
true
|
74
|
+
end
|
75
|
+
|
76
|
+
# Checks equality by comparing each attribute.
|
77
|
+
# @param [Object] Object to be compared
|
78
|
+
def ==(o)
|
79
|
+
return true if self.equal?(o)
|
80
|
+
self.class == o.class &&
|
81
|
+
action == o.action &&
|
82
|
+
notification == o.notification &&
|
83
|
+
void_reason == o.void_reason
|
84
|
+
end
|
85
|
+
|
86
|
+
# @see the `==` method
|
87
|
+
# @param [Object] Object to be compared
|
88
|
+
def eql?(o)
|
89
|
+
self == o
|
90
|
+
end
|
91
|
+
|
92
|
+
# Calculates hash code according to all attributes.
|
93
|
+
# @return [Fixnum] Hash code
|
94
|
+
def hash
|
95
|
+
[action, notification, void_reason].hash
|
96
|
+
end
|
97
|
+
|
98
|
+
# Builds the object from hash
|
99
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
100
|
+
# @return [Object] Returns the model itself
|
101
|
+
def build_from_hash(attributes)
|
102
|
+
return nil unless attributes.is_a?(Hash)
|
103
|
+
self.class.swagger_types.each_pair do |key, type|
|
104
|
+
if type =~ /\AArray<(.*)>/i
|
105
|
+
# check to ensure the input is an array given that the attribute
|
106
|
+
# is documented as an array but the input is not
|
107
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
108
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
109
|
+
end
|
110
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
111
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
112
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
113
|
+
end
|
114
|
+
|
115
|
+
self
|
116
|
+
end
|
117
|
+
|
118
|
+
# Deserializes the data based on type
|
119
|
+
# @param string type Data type
|
120
|
+
# @param string value Value to be deserialized
|
121
|
+
# @return [Object] Deserialized data
|
122
|
+
def _deserialize(type, value)
|
123
|
+
case type.to_sym
|
124
|
+
when :DateTime
|
125
|
+
DateTime.parse(value)
|
126
|
+
when :Date
|
127
|
+
Date.parse(value)
|
128
|
+
when :String
|
129
|
+
value.to_s
|
130
|
+
when :Integer
|
131
|
+
value.to_i
|
132
|
+
when :Float
|
133
|
+
value.to_f
|
134
|
+
when :BOOLEAN
|
135
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
136
|
+
true
|
137
|
+
else
|
138
|
+
false
|
139
|
+
end
|
140
|
+
when :Object
|
141
|
+
# generic object (usually a Hash), return directly
|
142
|
+
value
|
143
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
144
|
+
inner_type = Regexp.last_match[:inner_type]
|
145
|
+
value.map { |v| _deserialize(inner_type, v) }
|
146
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
147
|
+
k_type = Regexp.last_match[:k_type]
|
148
|
+
v_type = Regexp.last_match[:v_type]
|
149
|
+
{}.tap do |hash|
|
150
|
+
value.each do |k, v|
|
151
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
152
|
+
end
|
153
|
+
end
|
154
|
+
else # model
|
155
|
+
temp_model = DocuSign_eSign.const_get(type).new
|
156
|
+
temp_model.build_from_hash(value)
|
157
|
+
end
|
158
|
+
end
|
159
|
+
|
160
|
+
# Returns the string representation of the object
|
161
|
+
# @return [String] String presentation of the object
|
162
|
+
def to_s
|
163
|
+
to_hash.to_s
|
164
|
+
end
|
165
|
+
|
166
|
+
# to_body is an alias to to_hash (backward compatibility)
|
167
|
+
# @return [Hash] Returns the object in the form of hash
|
168
|
+
def to_body
|
169
|
+
to_hash
|
170
|
+
end
|
171
|
+
|
172
|
+
# Returns the object in the form of hash
|
173
|
+
# @return [Hash] Returns the object in the form of hash
|
174
|
+
def to_hash
|
175
|
+
hash = {}
|
176
|
+
self.class.attribute_map.each_pair do |attr, param|
|
177
|
+
value = self.send(attr)
|
178
|
+
next if value.nil?
|
179
|
+
hash[param] = _to_hash(value)
|
180
|
+
end
|
181
|
+
hash
|
182
|
+
end
|
183
|
+
|
184
|
+
# Outputs non-array value in the form of hash
|
185
|
+
# For object, use to_hash. Otherwise, just return the value
|
186
|
+
# @param [Object] value Any valid value
|
187
|
+
# @return [Hash] Returns the value in the form of hash
|
188
|
+
def _to_hash(value)
|
189
|
+
if value.is_a?(Array)
|
190
|
+
value.compact.map { |v| _to_hash(v) }
|
191
|
+
elsif value.is_a?(Hash)
|
192
|
+
{}.tap do |hash|
|
193
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
194
|
+
end
|
195
|
+
elsif value.respond_to? :to_hash
|
196
|
+
value.to_hash
|
197
|
+
else
|
198
|
+
value
|
199
|
+
end
|
200
|
+
end
|
201
|
+
|
202
|
+
end
|
203
|
+
end
|
@@ -13,6 +13,12 @@ require 'date'
|
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
class BulkSendBatchStatus
|
16
|
+
#
|
17
|
+
attr_accessor :action
|
18
|
+
|
19
|
+
#
|
20
|
+
attr_accessor :action_status
|
21
|
+
|
16
22
|
#
|
17
23
|
attr_accessor :batch_id
|
18
24
|
|
@@ -60,6 +66,8 @@ module DocuSign_eSign
|
|
60
66
|
# Attribute mapping from ruby-style variable name to JSON key.
|
61
67
|
def self.attribute_map
|
62
68
|
{
|
69
|
+
:'action' => :'action',
|
70
|
+
:'action_status' => :'actionStatus',
|
63
71
|
:'batch_id' => :'batchId',
|
64
72
|
:'batch_name' => :'batchName',
|
65
73
|
:'batch_size' => :'batchSize',
|
@@ -81,6 +89,8 @@ module DocuSign_eSign
|
|
81
89
|
# Attribute type mapping.
|
82
90
|
def self.swagger_types
|
83
91
|
{
|
92
|
+
:'action' => :'String',
|
93
|
+
:'action_status' => :'String',
|
84
94
|
:'batch_id' => :'String',
|
85
95
|
:'batch_name' => :'String',
|
86
96
|
:'batch_size' => :'String',
|
@@ -107,6 +117,14 @@ module DocuSign_eSign
|
|
107
117
|
# convert string to symbol for hash key
|
108
118
|
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
109
119
|
|
120
|
+
if attributes.has_key?(:'action')
|
121
|
+
self.action = attributes[:'action']
|
122
|
+
end
|
123
|
+
|
124
|
+
if attributes.has_key?(:'actionStatus')
|
125
|
+
self.action_status = attributes[:'actionStatus']
|
126
|
+
end
|
127
|
+
|
110
128
|
if attributes.has_key?(:'batchId')
|
111
129
|
self.batch_id = attributes[:'batchId']
|
112
130
|
end
|
@@ -188,6 +206,8 @@ module DocuSign_eSign
|
|
188
206
|
def ==(o)
|
189
207
|
return true if self.equal?(o)
|
190
208
|
self.class == o.class &&
|
209
|
+
action == o.action &&
|
210
|
+
action_status == o.action_status &&
|
191
211
|
batch_id == o.batch_id &&
|
192
212
|
batch_name == o.batch_name &&
|
193
213
|
batch_size == o.batch_size &&
|
@@ -214,7 +234,7 @@ module DocuSign_eSign
|
|
214
234
|
# Calculates hash code according to all attributes.
|
215
235
|
# @return [Fixnum] Hash code
|
216
236
|
def hash
|
217
|
-
[batch_id, batch_name, batch_size, bulk_errors, envelope_id_or_template_id, envelopes_info, envelopes_uri, failed, mailing_list_id, mailing_list_name, owner_user_id, queued, sender_user_id, sent, submitted_date].hash
|
237
|
+
[action, action_status, batch_id, batch_name, batch_size, bulk_errors, envelope_id_or_template_id, envelopes_info, envelopes_uri, failed, mailing_list_id, mailing_list_name, owner_user_id, queued, sender_user_id, sent, submitted_date].hash
|
218
238
|
end
|
219
239
|
|
220
240
|
# Builds the object from hash
|
@@ -75,6 +75,9 @@ module DocuSign_eSign
|
|
75
75
|
|
76
76
|
attr_accessor :email_notification
|
77
77
|
|
78
|
+
#
|
79
|
+
attr_accessor :email_recipient_post_signing_url
|
80
|
+
|
78
81
|
# Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
|
79
82
|
attr_accessor :embedded_recipient_start_url
|
80
83
|
|
@@ -242,6 +245,7 @@ module DocuSign_eSign
|
|
242
245
|
:'email' => :'email',
|
243
246
|
:'email_metadata' => :'emailMetadata',
|
244
247
|
:'email_notification' => :'emailNotification',
|
248
|
+
:'email_recipient_post_signing_url' => :'emailRecipientPostSigningURL',
|
245
249
|
:'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
|
246
250
|
:'error_details' => :'errorDetails',
|
247
251
|
:'excluded_documents' => :'excludedDocuments',
|
@@ -324,6 +328,7 @@ module DocuSign_eSign
|
|
324
328
|
:'email' => :'String',
|
325
329
|
:'email_metadata' => :'PropertyMetadata',
|
326
330
|
:'email_notification' => :'RecipientEmailNotification',
|
331
|
+
:'email_recipient_post_signing_url' => :'String',
|
327
332
|
:'embedded_recipient_start_url' => :'String',
|
328
333
|
:'error_details' => :'ErrorDetails',
|
329
334
|
:'excluded_documents' => :'Array<String>',
|
@@ -483,6 +488,10 @@ module DocuSign_eSign
|
|
483
488
|
self.email_notification = attributes[:'emailNotification']
|
484
489
|
end
|
485
490
|
|
491
|
+
if attributes.has_key?(:'emailRecipientPostSigningURL')
|
492
|
+
self.email_recipient_post_signing_url = attributes[:'emailRecipientPostSigningURL']
|
493
|
+
end
|
494
|
+
|
486
495
|
if attributes.has_key?(:'embeddedRecipientStartURL')
|
487
496
|
self.embedded_recipient_start_url = attributes[:'embeddedRecipientStartURL']
|
488
497
|
end
|
@@ -750,6 +759,7 @@ module DocuSign_eSign
|
|
750
759
|
email == o.email &&
|
751
760
|
email_metadata == o.email_metadata &&
|
752
761
|
email_notification == o.email_notification &&
|
762
|
+
email_recipient_post_signing_url == o.email_recipient_post_signing_url &&
|
753
763
|
embedded_recipient_start_url == o.embedded_recipient_start_url &&
|
754
764
|
error_details == o.error_details &&
|
755
765
|
excluded_documents == o.excluded_documents &&
|
@@ -815,7 +825,7 @@ module DocuSign_eSign
|
|
815
825
|
# Calculates hash code according to all attributes.
|
816
826
|
# @return [Fixnum] Hash code
|
817
827
|
def hash
|
818
|
-
[access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_responded_reason, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, last_name, last_name_metadata, linked_account_configuration_id, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
|
828
|
+
[access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_responded_reason, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, last_name, last_name_metadata, linked_account_configuration_id, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
|
819
829
|
end
|
820
830
|
|
821
831
|
# Builds the object from hash
|
@@ -75,6 +75,9 @@ module DocuSign_eSign
|
|
75
75
|
|
76
76
|
attr_accessor :email_notification
|
77
77
|
|
78
|
+
#
|
79
|
+
attr_accessor :email_recipient_post_signing_url
|
80
|
+
|
78
81
|
# Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
|
79
82
|
attr_accessor :embedded_recipient_start_url
|
80
83
|
|
@@ -237,6 +240,7 @@ module DocuSign_eSign
|
|
237
240
|
:'email' => :'email',
|
238
241
|
:'email_metadata' => :'emailMetadata',
|
239
242
|
:'email_notification' => :'emailNotification',
|
243
|
+
:'email_recipient_post_signing_url' => :'emailRecipientPostSigningURL',
|
240
244
|
:'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
|
241
245
|
:'error_details' => :'errorDetails',
|
242
246
|
:'excluded_documents' => :'excludedDocuments',
|
@@ -317,6 +321,7 @@ module DocuSign_eSign
|
|
317
321
|
:'email' => :'String',
|
318
322
|
:'email_metadata' => :'PropertyMetadata',
|
319
323
|
:'email_notification' => :'RecipientEmailNotification',
|
324
|
+
:'email_recipient_post_signing_url' => :'String',
|
320
325
|
:'embedded_recipient_start_url' => :'String',
|
321
326
|
:'error_details' => :'ErrorDetails',
|
322
327
|
:'excluded_documents' => :'Array<String>',
|
@@ -474,6 +479,10 @@ module DocuSign_eSign
|
|
474
479
|
self.email_notification = attributes[:'emailNotification']
|
475
480
|
end
|
476
481
|
|
482
|
+
if attributes.has_key?(:'emailRecipientPostSigningURL')
|
483
|
+
self.email_recipient_post_signing_url = attributes[:'emailRecipientPostSigningURL']
|
484
|
+
end
|
485
|
+
|
477
486
|
if attributes.has_key?(:'embeddedRecipientStartURL')
|
478
487
|
self.embedded_recipient_start_url = attributes[:'embeddedRecipientStartURL']
|
479
488
|
end
|
@@ -733,6 +742,7 @@ module DocuSign_eSign
|
|
733
742
|
email == o.email &&
|
734
743
|
email_metadata == o.email_metadata &&
|
735
744
|
email_notification == o.email_notification &&
|
745
|
+
email_recipient_post_signing_url == o.email_recipient_post_signing_url &&
|
736
746
|
embedded_recipient_start_url == o.embedded_recipient_start_url &&
|
737
747
|
error_details == o.error_details &&
|
738
748
|
excluded_documents == o.excluded_documents &&
|
@@ -796,7 +806,7 @@ module DocuSign_eSign
|
|
796
806
|
# Calculates hash code according to all attributes.
|
797
807
|
# @return [Fixnum] Hash code
|
798
808
|
def hash
|
799
|
-
[access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_responded_reason, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
|
809
|
+
[access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_responded_reason, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
|
800
810
|
end
|
801
811
|
|
802
812
|
# Builds the object from hash
|