docusign_esign 3.11.0 → 3.13.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (60) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -0
  3. data/docusign_esign.gemspec +1 -0
  4. data/lib/docusign_esign/api/accounts_api.rb +8 -8
  5. data/lib/docusign_esign/api/billing_api.rb +6 -2
  6. data/lib/docusign_esign/api/connect_api.rb +91 -5
  7. data/lib/docusign_esign/api/envelopes_api.rb +137 -3
  8. data/lib/docusign_esign/client/api_client.rb +3 -2
  9. data/lib/docusign_esign/configuration.rb +2 -1
  10. data/lib/docusign_esign/models/account_billing_plan.rb +21 -1
  11. data/lib/docusign_esign/models/account_billing_plan_response.rb +20 -1
  12. data/lib/docusign_esign/models/account_settings_information.rb +144 -1
  13. data/lib/docusign_esign/models/account_signature_definition.rb +11 -1
  14. data/lib/docusign_esign/models/agent.rb +1 -10
  15. data/lib/docusign_esign/models/app_store_receipt.rb +21 -1
  16. data/lib/docusign_esign/models/billing_charge.rb +1 -1
  17. data/lib/docusign_esign/models/carbon_copy.rb +1 -10
  18. data/lib/docusign_esign/models/certified_delivery.rb +1 -10
  19. data/lib/docusign_esign/models/checkbox.rb +20 -1
  20. data/lib/docusign_esign/models/connect_custom_configuration.rb +14 -4
  21. data/lib/docusign_esign/models/connect_delete_failure_result.rb +174 -0
  22. data/lib/docusign_esign/models/connect_user_info.rb +224 -0
  23. data/lib/docusign_esign/models/credit_card_information.rb +24 -4
  24. data/lib/docusign_esign/models/date.rb +20 -1
  25. data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +44 -4
  26. data/lib/docusign_esign/models/downgrade_plan_update_response.rb +64 -4
  27. data/lib/docusign_esign/models/downgrade_request_information.rb +204 -0
  28. data/lib/docusign_esign/models/editor.rb +1 -10
  29. data/lib/docusign_esign/models/email.rb +20 -1
  30. data/lib/docusign_esign/models/event_notification.rb +11 -1
  31. data/lib/docusign_esign/models/formula_tab.rb +20 -1
  32. data/lib/docusign_esign/models/integrated_connect_user_info_list.rb +246 -0
  33. data/lib/docusign_esign/models/intermediary.rb +1 -10
  34. data/lib/docusign_esign/models/list.rb +20 -1
  35. data/lib/docusign_esign/models/notary_recipient.rb +1 -10
  36. data/lib/docusign_esign/models/number.rb +20 -1
  37. data/lib/docusign_esign/models/radio_group.rb +20 -1
  38. data/lib/docusign_esign/models/recipient_identity_phone_number.rb +41 -4
  39. data/lib/docusign_esign/models/recipient_identity_verification.rb +13 -4
  40. data/lib/docusign_esign/models/recipient_proof_file.rb +11 -1
  41. data/lib/docusign_esign/models/report_in_product_run_response_row_fields.rb +31 -1
  42. data/lib/docusign_esign/models/signer.rb +1 -10
  43. data/lib/docusign_esign/models/ssn.rb +20 -1
  44. data/lib/docusign_esign/models/template_role.rb +10 -1
  45. data/lib/docusign_esign/models/text.rb +20 -1
  46. data/lib/docusign_esign/models/user_account_management_granular_information.rb +20 -1
  47. data/lib/docusign_esign/models/user_signature_definition.rb +11 -1
  48. data/lib/docusign_esign/models/witness.rb +1 -10
  49. data/lib/docusign_esign/models/zip.rb +20 -1
  50. data/lib/docusign_esign/version.rb +1 -1
  51. data/lib/docusign_esign.rb +4 -1
  52. data/runLinter.sh +1 -0
  53. metadata +53 -34
  54. data/Gemfile.lock +0 -73
  55. data/lib/docusign_esign/.DS_Store +0 -0
  56. data/lib/docusign_esign/api/.DS_Store +0 -0
  57. data/lib/docusign_esign/client/.DS_Store +0 -0
  58. data/tests/.DS_Store +0 -0
  59. data/tests/Gemfile.lock +0 -42
  60. data/tests/docs/private.pem +0 -27
@@ -20,7 +20,7 @@ module DocuSign_eSign
20
20
  # Reserved: TBD
21
21
  attr_accessor :blocked
22
22
 
23
- # Provides information on what services the charge item is for. The following table provides a description of the different chargeName values available at this time. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
23
+ # Provides information on what services the charge item is for. The following table provides a description of the different chargeName values available at this time. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
24
24
  attr_accessor :charge_name
25
25
 
26
26
  # Reserved: TBD
@@ -138,8 +138,6 @@ module DocuSign_eSign
138
138
 
139
139
  attr_accessor :phone_number
140
140
 
141
- attr_accessor :phone_number_metadata
142
-
143
141
  attr_accessor :proof_file
144
142
 
145
143
  # Reserved:
@@ -269,7 +267,6 @@ module DocuSign_eSign
269
267
  :'note_metadata' => :'noteMetadata',
270
268
  :'phone_authentication' => :'phoneAuthentication',
271
269
  :'phone_number' => :'phoneNumber',
272
- :'phone_number_metadata' => :'phoneNumberMetadata',
273
270
  :'proof_file' => :'proofFile',
274
271
  :'recipient_attachments' => :'recipientAttachments',
275
272
  :'recipient_authentication_status' => :'recipientAuthenticationStatus',
@@ -352,7 +349,6 @@ module DocuSign_eSign
352
349
  :'note_metadata' => :'PropertyMetadata',
353
350
  :'phone_authentication' => :'RecipientPhoneAuthentication',
354
351
  :'phone_number' => :'RecipientPhoneNumber',
355
- :'phone_number_metadata' => :'PropertyMetadata',
356
352
  :'proof_file' => :'RecipientProofFile',
357
353
  :'recipient_attachments' => :'Array<RecipientAttachment>',
358
354
  :'recipient_authentication_status' => :'AuthenticationStatus',
@@ -589,10 +585,6 @@ module DocuSign_eSign
589
585
  self.phone_number = attributes[:'phoneNumber']
590
586
  end
591
587
 
592
- if attributes.has_key?(:'phoneNumberMetadata')
593
- self.phone_number_metadata = attributes[:'phoneNumberMetadata']
594
- end
595
-
596
588
  if attributes.has_key?(:'proofFile')
597
589
  self.proof_file = attributes[:'proofFile']
598
590
  end
@@ -783,7 +775,6 @@ module DocuSign_eSign
783
775
  note_metadata == o.note_metadata &&
784
776
  phone_authentication == o.phone_authentication &&
785
777
  phone_number == o.phone_number &&
786
- phone_number_metadata == o.phone_number_metadata &&
787
778
  proof_file == o.proof_file &&
788
779
  recipient_attachments == o.recipient_attachments &&
789
780
  recipient_authentication_status == o.recipient_authentication_status &&
@@ -824,7 +815,7 @@ module DocuSign_eSign
824
815
  # Calculates hash code according to all attributes.
825
816
  # @return [Fixnum] Hash code
826
817
  def hash
827
- [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, phone_number_metadata, 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
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
819
  end
829
820
 
830
821
  # Builds the object from hash
@@ -135,8 +135,6 @@ module DocuSign_eSign
135
135
 
136
136
  attr_accessor :phone_number
137
137
 
138
- attr_accessor :phone_number_metadata
139
-
140
138
  attr_accessor :proof_file
141
139
 
142
140
  # Reserved:
@@ -263,7 +261,6 @@ module DocuSign_eSign
263
261
  :'note_metadata' => :'noteMetadata',
264
262
  :'phone_authentication' => :'phoneAuthentication',
265
263
  :'phone_number' => :'phoneNumber',
266
- :'phone_number_metadata' => :'phoneNumberMetadata',
267
264
  :'proof_file' => :'proofFile',
268
265
  :'recipient_attachments' => :'recipientAttachments',
269
266
  :'recipient_authentication_status' => :'recipientAuthenticationStatus',
@@ -344,7 +341,6 @@ module DocuSign_eSign
344
341
  :'note_metadata' => :'PropertyMetadata',
345
342
  :'phone_authentication' => :'RecipientPhoneAuthentication',
346
343
  :'phone_number' => :'RecipientPhoneNumber',
347
- :'phone_number_metadata' => :'PropertyMetadata',
348
344
  :'proof_file' => :'RecipientProofFile',
349
345
  :'recipient_attachments' => :'Array<RecipientAttachment>',
350
346
  :'recipient_authentication_status' => :'AuthenticationStatus',
@@ -576,10 +572,6 @@ module DocuSign_eSign
576
572
  self.phone_number = attributes[:'phoneNumber']
577
573
  end
578
574
 
579
- if attributes.has_key?(:'phoneNumberMetadata')
580
- self.phone_number_metadata = attributes[:'phoneNumberMetadata']
581
- end
582
-
583
575
  if attributes.has_key?(:'proofFile')
584
576
  self.proof_file = attributes[:'proofFile']
585
577
  end
@@ -765,7 +757,6 @@ module DocuSign_eSign
765
757
  note_metadata == o.note_metadata &&
766
758
  phone_authentication == o.phone_authentication &&
767
759
  phone_number == o.phone_number &&
768
- phone_number_metadata == o.phone_number_metadata &&
769
760
  proof_file == o.proof_file &&
770
761
  recipient_attachments == o.recipient_attachments &&
771
762
  recipient_authentication_status == o.recipient_authentication_status &&
@@ -805,7 +796,7 @@ module DocuSign_eSign
805
796
  # Calculates hash code according to all attributes.
806
797
  # @return [Fixnum] Hash code
807
798
  def hash
808
- [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, phone_number_metadata, 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
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
800
  end
810
801
 
811
802
  # Builds the object from hash
@@ -180,6 +180,11 @@ module DocuSign_eSign
180
180
 
181
181
  attr_accessor :shared_metadata
182
182
 
183
+ #
184
+ attr_accessor :share_to_recipients
185
+
186
+ attr_accessor :share_to_recipients_metadata
187
+
183
188
  attr_accessor :smart_contract_information
184
189
 
185
190
  #
@@ -320,6 +325,8 @@ module DocuSign_eSign
320
325
  :'selected_metadata' => :'selectedMetadata',
321
326
  :'shared' => :'shared',
322
327
  :'shared_metadata' => :'sharedMetadata',
328
+ :'share_to_recipients' => :'shareToRecipients',
329
+ :'share_to_recipients_metadata' => :'shareToRecipientsMetadata',
323
330
  :'smart_contract_information' => :'smartContractInformation',
324
331
  :'source' => :'source',
325
332
  :'status' => :'status',
@@ -421,6 +428,8 @@ module DocuSign_eSign
421
428
  :'selected_metadata' => :'PropertyMetadata',
422
429
  :'shared' => :'String',
423
430
  :'shared_metadata' => :'PropertyMetadata',
431
+ :'share_to_recipients' => :'String',
432
+ :'share_to_recipients_metadata' => :'PropertyMetadata',
424
433
  :'smart_contract_information' => :'SmartContractInformation',
425
434
  :'source' => :'String',
426
435
  :'status' => :'String',
@@ -728,6 +737,14 @@ module DocuSign_eSign
728
737
  self.shared_metadata = attributes[:'sharedMetadata']
729
738
  end
730
739
 
740
+ if attributes.has_key?(:'shareToRecipients')
741
+ self.share_to_recipients = attributes[:'shareToRecipients']
742
+ end
743
+
744
+ if attributes.has_key?(:'shareToRecipientsMetadata')
745
+ self.share_to_recipients_metadata = attributes[:'shareToRecipientsMetadata']
746
+ end
747
+
731
748
  if attributes.has_key?(:'smartContractInformation')
732
749
  self.smart_contract_information = attributes[:'smartContractInformation']
733
750
  end
@@ -928,6 +945,8 @@ module DocuSign_eSign
928
945
  selected_metadata == o.selected_metadata &&
929
946
  shared == o.shared &&
930
947
  shared_metadata == o.shared_metadata &&
948
+ share_to_recipients == o.share_to_recipients &&
949
+ share_to_recipients_metadata == o.share_to_recipients_metadata &&
931
950
  smart_contract_information == o.smart_contract_information &&
932
951
  source == o.source &&
933
952
  status == o.status &&
@@ -967,7 +986,7 @@ module DocuSign_eSign
967
986
  # Calculates hash code according to all attributes.
968
987
  # @return [Fixnum] Hash code
969
988
  def hash
970
- [anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locked, locked_metadata, merge_field, merge_field_xml, name, name_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, required, required_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, selected, selected_metadata, shared, shared_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
989
+ [anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locked, locked_metadata, merge_field, merge_field_xml, name, name_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, required, required_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, selected, selected_metadata, shared, shared_metadata, share_to_recipients, share_to_recipients_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
971
990
  end
972
991
 
973
992
  # Builds the object from hash
@@ -28,10 +28,13 @@ module DocuSign_eSign
28
28
  # Specifies the DocuSign generated ID for the Connect configuration.
29
29
  attr_accessor :connect_id
30
30
 
31
+ #
32
+ attr_accessor :delivery_mode
33
+
31
34
  # This turns Connect logging on or off. When set to **true**, logging is turned on.
32
35
  attr_accessor :enable_log
33
36
 
34
- # A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided.
37
+ # A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided.
35
38
  attr_accessor :envelope_events
36
39
 
37
40
  attr_accessor :event_data
@@ -72,7 +75,7 @@ module DocuSign_eSign
72
75
  #
73
76
  attr_accessor :password
74
77
 
75
- # A comma separated list of �Recipient� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.
78
+ # A comma separated list of �Recipient� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.
76
79
  attr_accessor :recipient_events
77
80
 
78
81
  #
@@ -111,7 +114,7 @@ module DocuSign_eSign
111
114
  # This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address.
112
115
  attr_accessor :url_to_publish_to
113
116
 
114
- # A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to �false� then you must provide a list of user id�s.
117
+ # A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to �false� then you must provide a list of user id�s.
115
118
  attr_accessor :user_ids
116
119
 
117
120
  #
@@ -128,6 +131,7 @@ module DocuSign_eSign
128
131
  :'all_users' => :'allUsers',
129
132
  :'configuration_type' => :'configurationType',
130
133
  :'connect_id' => :'connectId',
134
+ :'delivery_mode' => :'deliveryMode',
131
135
  :'enable_log' => :'enableLog',
132
136
  :'envelope_events' => :'envelopeEvents',
133
137
  :'event_data' => :'eventData',
@@ -170,6 +174,7 @@ module DocuSign_eSign
170
174
  :'all_users' => :'String',
171
175
  :'configuration_type' => :'String',
172
176
  :'connect_id' => :'String',
177
+ :'delivery_mode' => :'String',
173
178
  :'enable_log' => :'String',
174
179
  :'envelope_events' => :'Array<String>',
175
180
  :'event_data' => :'ConnectEventData',
@@ -232,6 +237,10 @@ module DocuSign_eSign
232
237
  self.connect_id = attributes[:'connectId']
233
238
  end
234
239
 
240
+ if attributes.has_key?(:'deliveryMode')
241
+ self.delivery_mode = attributes[:'deliveryMode']
242
+ end
243
+
235
244
  if attributes.has_key?(:'enableLog')
236
245
  self.enable_log = attributes[:'enableLog']
237
246
  end
@@ -390,6 +399,7 @@ module DocuSign_eSign
390
399
  all_users == o.all_users &&
391
400
  configuration_type == o.configuration_type &&
392
401
  connect_id == o.connect_id &&
402
+ delivery_mode == o.delivery_mode &&
393
403
  enable_log == o.enable_log &&
394
404
  envelope_events == o.envelope_events &&
395
405
  event_data == o.event_data &&
@@ -432,7 +442,7 @@ module DocuSign_eSign
432
442
  # Calculates hash code according to all attributes.
433
443
  # @return [Fixnum] Hash code
434
444
  def hash
435
- [allow_envelope_publish, allow_salesforce_publish, all_users, configuration_type, connect_id, enable_log, envelope_events, event_data, external_folder_id, external_folder_label, include_certificate_of_completion, include_cert_soap_header, include_document_fields, include_documents, include_envelope_void_reason, include_hmac, include_sender_accountas_custom_field, include_time_zone_information, name, password, recipient_events, require_mutual_tls, requires_acknowledgement, salesforce_api_version, salesforce_authcode, salesforce_call_back_url, salesforce_documents_as_content_files, sender_override, sender_selectable_items, sf_objects, sign_message_with_x509_certificate, soap_namespace, url_to_publish_to, user_ids, user_name, use_soap_interface].hash
445
+ [allow_envelope_publish, allow_salesforce_publish, all_users, configuration_type, connect_id, delivery_mode, enable_log, envelope_events, event_data, external_folder_id, external_folder_label, include_certificate_of_completion, include_cert_soap_header, include_document_fields, include_documents, include_envelope_void_reason, include_hmac, include_sender_accountas_custom_field, include_time_zone_information, name, password, recipient_events, require_mutual_tls, requires_acknowledgement, salesforce_api_version, salesforce_authcode, salesforce_call_back_url, salesforce_documents_as_content_files, sender_override, sender_selectable_items, sf_objects, sign_message_with_x509_certificate, soap_namespace, url_to_publish_to, user_ids, user_name, use_soap_interface].hash
436
446
  end
437
447
 
438
448
  # Builds the object from hash
@@ -0,0 +1,174 @@
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 ConnectDeleteFailureResult
16
+ # Attribute mapping from ruby-style variable name to JSON key.
17
+ def self.attribute_map
18
+ {
19
+ }
20
+ end
21
+
22
+ # Attribute type mapping.
23
+ def self.swagger_types
24
+ {
25
+ }
26
+ end
27
+
28
+ # Initializes the object
29
+ # @param [Hash] attributes Model attributes in the form of hash
30
+ def initialize(attributes = {})
31
+ return unless attributes.is_a?(Hash)
32
+
33
+ # convert string to symbol for hash key
34
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
35
+ end
36
+
37
+ # Show invalid properties with the reasons. Usually used together with valid?
38
+ # @return Array for valid properties with the reasons
39
+ def list_invalid_properties
40
+ invalid_properties = Array.new
41
+ invalid_properties
42
+ end
43
+
44
+ # Check to see if the all the properties in the model are valid
45
+ # @return true if the model is valid
46
+ def valid?
47
+ true
48
+ end
49
+
50
+ # Checks equality by comparing each attribute.
51
+ # @param [Object] Object to be compared
52
+ def ==(o)
53
+ return true if self.equal?(o)
54
+ self.class == o.class
55
+ end
56
+
57
+ # @see the `==` method
58
+ # @param [Object] Object to be compared
59
+ def eql?(o)
60
+ self == o
61
+ end
62
+
63
+ # Calculates hash code according to all attributes.
64
+ # @return [Fixnum] Hash code
65
+ def hash
66
+ [].hash
67
+ end
68
+
69
+ # Builds the object from hash
70
+ # @param [Hash] attributes Model attributes in the form of hash
71
+ # @return [Object] Returns the model itself
72
+ def build_from_hash(attributes)
73
+ return nil unless attributes.is_a?(Hash)
74
+ self.class.swagger_types.each_pair do |key, type|
75
+ if type =~ /\AArray<(.*)>/i
76
+ # check to ensure the input is an array given that the attribute
77
+ # is documented as an array but the input is not
78
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
79
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
80
+ end
81
+ elsif !attributes[self.class.attribute_map[key]].nil?
82
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
83
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
84
+ end
85
+
86
+ self
87
+ end
88
+
89
+ # Deserializes the data based on type
90
+ # @param string type Data type
91
+ # @param string value Value to be deserialized
92
+ # @return [Object] Deserialized data
93
+ def _deserialize(type, value)
94
+ case type.to_sym
95
+ when :DateTime
96
+ DateTime.parse(value)
97
+ when :Date
98
+ Date.parse(value)
99
+ when :String
100
+ value.to_s
101
+ when :Integer
102
+ value.to_i
103
+ when :Float
104
+ value.to_f
105
+ when :BOOLEAN
106
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
107
+ true
108
+ else
109
+ false
110
+ end
111
+ when :Object
112
+ # generic object (usually a Hash), return directly
113
+ value
114
+ when /\AArray<(?<inner_type>.+)>\z/
115
+ inner_type = Regexp.last_match[:inner_type]
116
+ value.map { |v| _deserialize(inner_type, v) }
117
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
118
+ k_type = Regexp.last_match[:k_type]
119
+ v_type = Regexp.last_match[:v_type]
120
+ {}.tap do |hash|
121
+ value.each do |k, v|
122
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
123
+ end
124
+ end
125
+ else # model
126
+ temp_model = DocuSign_eSign.const_get(type).new
127
+ temp_model.build_from_hash(value)
128
+ end
129
+ end
130
+
131
+ # Returns the string representation of the object
132
+ # @return [String] String presentation of the object
133
+ def to_s
134
+ to_hash.to_s
135
+ end
136
+
137
+ # to_body is an alias to to_hash (backward compatibility)
138
+ # @return [Hash] Returns the object in the form of hash
139
+ def to_body
140
+ to_hash
141
+ end
142
+
143
+ # Returns the object in the form of hash
144
+ # @return [Hash] Returns the object in the form of hash
145
+ def to_hash
146
+ hash = {}
147
+ self.class.attribute_map.each_pair do |attr, param|
148
+ value = self.send(attr)
149
+ next if value.nil?
150
+ hash[param] = _to_hash(value)
151
+ end
152
+ hash
153
+ end
154
+
155
+ # Outputs non-array value in the form of hash
156
+ # For object, use to_hash. Otherwise, just return the value
157
+ # @param [Object] value Any valid value
158
+ # @return [Hash] Returns the value in the form of hash
159
+ def _to_hash(value)
160
+ if value.is_a?(Array)
161
+ value.compact.map { |v| _to_hash(v) }
162
+ elsif value.is_a?(Hash)
163
+ {}.tap do |hash|
164
+ value.each { |k, v| hash[k] = _to_hash(v) }
165
+ end
166
+ elsif value.respond_to? :to_hash
167
+ value.to_hash
168
+ else
169
+ value
170
+ end
171
+ end
172
+
173
+ end
174
+ end
@@ -0,0 +1,224 @@
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 ConnectUserInfo
16
+ #
17
+ attr_accessor :email
18
+
19
+ #
20
+ attr_accessor :is_included
21
+
22
+ #
23
+ attr_accessor :is_part_of_domain
24
+
25
+ #
26
+ attr_accessor :user_id
27
+
28
+ #
29
+ attr_accessor :user_name
30
+
31
+ # Attribute mapping from ruby-style variable name to JSON key.
32
+ def self.attribute_map
33
+ {
34
+ :'email' => :'email',
35
+ :'is_included' => :'isIncluded',
36
+ :'is_part_of_domain' => :'isPartOfDomain',
37
+ :'user_id' => :'userId',
38
+ :'user_name' => :'userName'
39
+ }
40
+ end
41
+
42
+ # Attribute type mapping.
43
+ def self.swagger_types
44
+ {
45
+ :'email' => :'String',
46
+ :'is_included' => :'String',
47
+ :'is_part_of_domain' => :'String',
48
+ :'user_id' => :'String',
49
+ :'user_name' => :'String'
50
+ }
51
+ end
52
+
53
+ # Initializes the object
54
+ # @param [Hash] attributes Model attributes in the form of hash
55
+ def initialize(attributes = {})
56
+ return unless attributes.is_a?(Hash)
57
+
58
+ # convert string to symbol for hash key
59
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
60
+
61
+ if attributes.has_key?(:'email')
62
+ self.email = attributes[:'email']
63
+ end
64
+
65
+ if attributes.has_key?(:'isIncluded')
66
+ self.is_included = attributes[:'isIncluded']
67
+ end
68
+
69
+ if attributes.has_key?(:'isPartOfDomain')
70
+ self.is_part_of_domain = attributes[:'isPartOfDomain']
71
+ end
72
+
73
+ if attributes.has_key?(:'userId')
74
+ self.user_id = attributes[:'userId']
75
+ end
76
+
77
+ if attributes.has_key?(:'userName')
78
+ self.user_name = attributes[:'userName']
79
+ end
80
+ end
81
+
82
+ # Show invalid properties with the reasons. Usually used together with valid?
83
+ # @return Array for valid properties with the reasons
84
+ def list_invalid_properties
85
+ invalid_properties = Array.new
86
+ invalid_properties
87
+ end
88
+
89
+ # Check to see if the all the properties in the model are valid
90
+ # @return true if the model is valid
91
+ def valid?
92
+ true
93
+ end
94
+
95
+ # Checks equality by comparing each attribute.
96
+ # @param [Object] Object to be compared
97
+ def ==(o)
98
+ return true if self.equal?(o)
99
+ self.class == o.class &&
100
+ email == o.email &&
101
+ is_included == o.is_included &&
102
+ is_part_of_domain == o.is_part_of_domain &&
103
+ user_id == o.user_id &&
104
+ user_name == o.user_name
105
+ end
106
+
107
+ # @see the `==` method
108
+ # @param [Object] Object to be compared
109
+ def eql?(o)
110
+ self == o
111
+ end
112
+
113
+ # Calculates hash code according to all attributes.
114
+ # @return [Fixnum] Hash code
115
+ def hash
116
+ [email, is_included, is_part_of_domain, user_id, user_name].hash
117
+ end
118
+
119
+ # Builds the object from hash
120
+ # @param [Hash] attributes Model attributes in the form of hash
121
+ # @return [Object] Returns the model itself
122
+ def build_from_hash(attributes)
123
+ return nil unless attributes.is_a?(Hash)
124
+ self.class.swagger_types.each_pair do |key, type|
125
+ if type =~ /\AArray<(.*)>/i
126
+ # check to ensure the input is an array given that the attribute
127
+ # is documented as an array but the input is not
128
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
129
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
130
+ end
131
+ elsif !attributes[self.class.attribute_map[key]].nil?
132
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
133
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
134
+ end
135
+
136
+ self
137
+ end
138
+
139
+ # Deserializes the data based on type
140
+ # @param string type Data type
141
+ # @param string value Value to be deserialized
142
+ # @return [Object] Deserialized data
143
+ def _deserialize(type, value)
144
+ case type.to_sym
145
+ when :DateTime
146
+ DateTime.parse(value)
147
+ when :Date
148
+ Date.parse(value)
149
+ when :String
150
+ value.to_s
151
+ when :Integer
152
+ value.to_i
153
+ when :Float
154
+ value.to_f
155
+ when :BOOLEAN
156
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
157
+ true
158
+ else
159
+ false
160
+ end
161
+ when :Object
162
+ # generic object (usually a Hash), return directly
163
+ value
164
+ when /\AArray<(?<inner_type>.+)>\z/
165
+ inner_type = Regexp.last_match[:inner_type]
166
+ value.map { |v| _deserialize(inner_type, v) }
167
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
168
+ k_type = Regexp.last_match[:k_type]
169
+ v_type = Regexp.last_match[:v_type]
170
+ {}.tap do |hash|
171
+ value.each do |k, v|
172
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
173
+ end
174
+ end
175
+ else # model
176
+ temp_model = DocuSign_eSign.const_get(type).new
177
+ temp_model.build_from_hash(value)
178
+ end
179
+ end
180
+
181
+ # Returns the string representation of the object
182
+ # @return [String] String presentation of the object
183
+ def to_s
184
+ to_hash.to_s
185
+ end
186
+
187
+ # to_body is an alias to to_hash (backward compatibility)
188
+ # @return [Hash] Returns the object in the form of hash
189
+ def to_body
190
+ to_hash
191
+ end
192
+
193
+ # Returns the object in the form of hash
194
+ # @return [Hash] Returns the object in the form of hash
195
+ def to_hash
196
+ hash = {}
197
+ self.class.attribute_map.each_pair do |attr, param|
198
+ value = self.send(attr)
199
+ next if value.nil?
200
+ hash[param] = _to_hash(value)
201
+ end
202
+ hash
203
+ end
204
+
205
+ # Outputs non-array value in the form of hash
206
+ # For object, use to_hash. Otherwise, just return the value
207
+ # @param [Object] value Any valid value
208
+ # @return [Hash] Returns the value in the form of hash
209
+ def _to_hash(value)
210
+ if value.is_a?(Array)
211
+ value.compact.map { |v| _to_hash(v) }
212
+ elsif value.is_a?(Hash)
213
+ {}.tap do |hash|
214
+ value.each { |k, v| hash[k] = _to_hash(v) }
215
+ end
216
+ elsif value.respond_to? :to_hash
217
+ value.to_hash
218
+ else
219
+ value
220
+ end
221
+ end
222
+
223
+ end
224
+ end