Class: DocuSign_eSign::UserSettingsInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/user_settings_information.rb

Overview

Properties that configure the settings for a user. Some elements of this object have a ‘metadata` property, which includes the following: - `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`) - `uiHint`: Internally used to build UIs (can be `available` or `hidden`) - `options`: The values supported for this setting (not all settings have this element)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserSettingsInformation

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
# File 'lib/docusign_esign/models/user_settings_information.rb', line 746

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'accountAgreementsAccessType')
    self. = attributes[:'accountAgreementsAccessType']
  end

  if attributes.has_key?(:'accountAgreementsAccessTypeMetadata')
    self. = attributes[:'accountAgreementsAccessTypeMetadata']
  end

  if attributes.has_key?(:'accountManagementGranular')
    self. = attributes[:'accountManagementGranular']
  end

  if attributes.has_key?(:'adminOnly')
    self.admin_only = attributes[:'adminOnly']
  end

  if attributes.has_key?(:'adminOnlyMetadata')
    self. = attributes[:'adminOnlyMetadata']
  end

  if attributes.has_key?(:'allowAccessToAllAccountAgreements')
    self. = attributes[:'allowAccessToAllAccountAgreements']
  end

  if attributes.has_key?(:'allowAccessToAllAccountAgreementsMetadata')
    self. = attributes[:'allowAccessToAllAccountAgreementsMetadata']
  end

  if attributes.has_key?(:'allowAutoTagging')
    self.allow_auto_tagging = attributes[:'allowAutoTagging']
  end

  if attributes.has_key?(:'allowedOrchestrationAccess')
    self.allowed_orchestration_access = attributes[:'allowedOrchestrationAccess']
  end

  if attributes.has_key?(:'allowedOrchestrationAccessMetadata')
    self. = attributes[:'allowedOrchestrationAccessMetadata']
  end

  if attributes.has_key?(:'allowEnvelopeTransferTo')
    self.allow_envelope_transfer_to = attributes[:'allowEnvelopeTransferTo']
  end

  if attributes.has_key?(:'allowEnvelopeTransferToMetadata')
    self. = attributes[:'allowEnvelopeTransferToMetadata']
  end

  if attributes.has_key?(:'allowEsealRecipients')
    self.allow_eseal_recipients = attributes[:'allowEsealRecipients']
  end

  if attributes.has_key?(:'allowEsealRecipientsMetadata')
    self. = attributes[:'allowEsealRecipientsMetadata']
  end

  if attributes.has_key?(:'allowPowerFormsAdminToAccessAllPowerFormEnvelope')
    self.allow_power_forms_admin_to_access_all_power_form_envelope = attributes[:'allowPowerFormsAdminToAccessAllPowerFormEnvelope']
  end

  if attributes.has_key?(:'allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata')
    self. = attributes[:'allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata']
  end

  if attributes.has_key?(:'allowRecipientLanguageSelection')
    self.allow_recipient_language_selection = attributes[:'allowRecipientLanguageSelection']
  end

  if attributes.has_key?(:'allowRecipientLanguageSelectionMetadata')
    self. = attributes[:'allowRecipientLanguageSelectionMetadata']
  end

  if attributes.has_key?(:'allowSendOnBehalfOf')
    self.allow_send_on_behalf_of = attributes[:'allowSendOnBehalfOf']
  end

  if attributes.has_key?(:'allowSendOnBehalfOfMetadata')
    self. = attributes[:'allowSendOnBehalfOfMetadata']
  end

  if attributes.has_key?(:'allowSupplementalDocuments')
    self.allow_supplemental_documents = attributes[:'allowSupplementalDocuments']
  end

  if attributes.has_key?(:'allowSupplementalDocumentsMetadata')
    self. = attributes[:'allowSupplementalDocumentsMetadata']
  end

  if attributes.has_key?(:'allowTransactions')
    self.allow_transactions = attributes[:'allowTransactions']
  end

  if attributes.has_key?(:'allowTransactionsMetadata')
    self. = attributes[:'allowTransactionsMetadata']
  end

  if attributes.has_key?(:'anchorTagVersionedPlacementEnabled')
    self.anchor_tag_versioned_placement_enabled = attributes[:'anchorTagVersionedPlacementEnabled']
  end

  if attributes.has_key?(:'apiAccountWideAccess')
    self. = attributes[:'apiAccountWideAccess']
  end

  if attributes.has_key?(:'apiAccountWideAccessMetadata')
    self. = attributes[:'apiAccountWideAccessMetadata']
  end

  if attributes.has_key?(:'apiCanExportAC')
    self.api_can_export_ac = attributes[:'apiCanExportAC']
  end

  if attributes.has_key?(:'apiCanExportACMetadata')
    self. = attributes[:'apiCanExportACMetadata']
  end

  if attributes.has_key?(:'bulkSend')
    self.bulk_send = attributes[:'bulkSend']
  end

  if attributes.has_key?(:'bulkSendMetadata')
    self. = attributes[:'bulkSendMetadata']
  end

  if attributes.has_key?(:'canBulkUploadAgreements')
    self.can_bulk_upload_agreements = attributes[:'canBulkUploadAgreements']
  end

  if attributes.has_key?(:'canBulkUploadAgreementsMetadata')
    self. = attributes[:'canBulkUploadAgreementsMetadata']
  end

  if attributes.has_key?(:'canChargeAccount')
    self. = attributes[:'canChargeAccount']
  end

  if attributes.has_key?(:'canChargeAccountMetadata')
    self. = attributes[:'canChargeAccountMetadata']
  end

  if attributes.has_key?(:'canCreateTransaction')
    self.can_create_transaction = attributes[:'canCreateTransaction']
  end

  if attributes.has_key?(:'canCreateTransactionMetadata')
    self. = attributes[:'canCreateTransactionMetadata']
  end

  if attributes.has_key?(:'canDeleteDocumentsInTransaction')
    self.can_delete_documents_in_transaction = attributes[:'canDeleteDocumentsInTransaction']
  end

  if attributes.has_key?(:'canDeleteDocumentsInTransactionMetadata')
    self. = attributes[:'canDeleteDocumentsInTransactionMetadata']
  end

  if attributes.has_key?(:'canDeleteTransaction')
    self.can_delete_transaction = attributes[:'canDeleteTransaction']
  end

  if attributes.has_key?(:'canDeleteTransactionMetadata')
    self. = attributes[:'canDeleteTransactionMetadata']
  end

  if attributes.has_key?(:'canEditSharedAddressbook')
    self.can_edit_shared_addressbook = attributes[:'canEditSharedAddressbook']
  end

  if attributes.has_key?(:'canEditSharedAddressbookMetadata')
    self. = attributes[:'canEditSharedAddressbookMetadata']
  end

  if attributes.has_key?(:'canLockEnvelopes')
    self.can_lock_envelopes = attributes[:'canLockEnvelopes']
  end

  if attributes.has_key?(:'canLockEnvelopesMetadata')
    self. = attributes[:'canLockEnvelopesMetadata']
  end

  if attributes.has_key?(:'canManageAccount')
    self. = attributes[:'canManageAccount']
  end

  if attributes.has_key?(:'canManageAccountMetadata')
    self. = attributes[:'canManageAccountMetadata']
  end

  if attributes.has_key?(:'canManageAgreementParties')
    self.can_manage_agreement_parties = attributes[:'canManageAgreementParties']
  end

  if attributes.has_key?(:'canManageAgreementPartiesMetadata')
    self. = attributes[:'canManageAgreementPartiesMetadata']
  end

  if attributes.has_key?(:'canManageDistributor')
    self.can_manage_distributor = attributes[:'canManageDistributor']
  end

  if attributes.has_key?(:'canManageDistributorMetadata')
    self. = attributes[:'canManageDistributorMetadata']
  end

  if attributes.has_key?(:'canManageTemplates')
    self.can_manage_templates = attributes[:'canManageTemplates']
  end

  if attributes.has_key?(:'canManageTemplatesMetadata')
    self. = attributes[:'canManageTemplatesMetadata']
  end

  if attributes.has_key?(:'canSendAPIRequests')
    self.can_send_api_requests = attributes[:'canSendAPIRequests']
  end

  if attributes.has_key?(:'canSendAPIRequestsMetadata')
    self. = attributes[:'canSendAPIRequestsMetadata']
  end

  if attributes.has_key?(:'canSendEnvelope')
    self.can_send_envelope = attributes[:'canSendEnvelope']
  end

  if attributes.has_key?(:'canSendEnvelopeMetadata')
    self. = attributes[:'canSendEnvelopeMetadata']
  end

  if attributes.has_key?(:'canSendEnvelopesViaSMS')
    self.can_send_envelopes_via_sms = attributes[:'canSendEnvelopesViaSMS']
  end

  if attributes.has_key?(:'canSendEnvelopesViaSMSMetadata')
    self. = attributes[:'canSendEnvelopesViaSMSMetadata']
  end

  if attributes.has_key?(:'canSignEnvelope')
    self.can_sign_envelope = attributes[:'canSignEnvelope']
  end

  if attributes.has_key?(:'canSignEnvelopeMetadata')
    self. = attributes[:'canSignEnvelopeMetadata']
  end

  if attributes.has_key?(:'canUseScratchpad')
    self.can_use_scratchpad = attributes[:'canUseScratchpad']
  end

  if attributes.has_key?(:'canUseScratchpadMetadata')
    self. = attributes[:'canUseScratchpadMetadata']
  end

  if attributes.has_key?(:'canUseSmartContracts')
    self.can_use_smart_contracts = attributes[:'canUseSmartContracts']
  end

  if attributes.has_key?(:'canUseSmartContractsMetadata')
    self. = attributes[:'canUseSmartContractsMetadata']
  end

  if attributes.has_key?(:'disableDocumentUpload')
    self.disable_document_upload = attributes[:'disableDocumentUpload']
  end

  if attributes.has_key?(:'disableDocumentUploadMetadata')
    self. = attributes[:'disableDocumentUploadMetadata']
  end

  if attributes.has_key?(:'disableOtherActions')
    self.disable_other_actions = attributes[:'disableOtherActions']
  end

  if attributes.has_key?(:'disableOtherActionsMetadata')
    self. = attributes[:'disableOtherActionsMetadata']
  end

  if attributes.has_key?(:'enableDSPro')
    self.enable_ds_pro = attributes[:'enableDSPro']
  end

  if attributes.has_key?(:'enableDSProMetadata')
    self. = attributes[:'enableDSProMetadata']
  end

  if attributes.has_key?(:'enableKeyTermsSuggestionsByDocumentType')
    self.enable_key_terms_suggestions_by_document_type = attributes[:'enableKeyTermsSuggestionsByDocumentType']
  end

  if attributes.has_key?(:'enableKeyTermsSuggestionsByDocumentTypeMetadata')
    self. = attributes[:'enableKeyTermsSuggestionsByDocumentTypeMetadata']
  end

  if attributes.has_key?(:'enableSequentialSigningAPI')
    self.enable_sequential_signing_api = attributes[:'enableSequentialSigningAPI']
  end

  if attributes.has_key?(:'enableSequentialSigningAPIMetadata')
    self. = attributes[:'enableSequentialSigningAPIMetadata']
  end

  if attributes.has_key?(:'enableSequentialSigningUI')
    self.enable_sequential_signing_ui = attributes[:'enableSequentialSigningUI']
  end

  if attributes.has_key?(:'enableSequentialSigningUIMetadata')
    self. = attributes[:'enableSequentialSigningUIMetadata']
  end

  if attributes.has_key?(:'enableSignerAttachments')
    self.enable_signer_attachments = attributes[:'enableSignerAttachments']
  end

  if attributes.has_key?(:'enableSignerAttachmentsMetadata')
    self. = attributes[:'enableSignerAttachmentsMetadata']
  end

  if attributes.has_key?(:'enableSignOnPaperOverride')
    self.enable_sign_on_paper_override = attributes[:'enableSignOnPaperOverride']
  end

  if attributes.has_key?(:'enableSignOnPaperOverrideMetadata')
    self. = attributes[:'enableSignOnPaperOverrideMetadata']
  end

  if attributes.has_key?(:'enableTransactionPoint')
    self.enable_transaction_point = attributes[:'enableTransactionPoint']
  end

  if attributes.has_key?(:'enableTransactionPointMetadata')
    self. = attributes[:'enableTransactionPointMetadata']
  end

  if attributes.has_key?(:'enableVaulting')
    self.enable_vaulting = attributes[:'enableVaulting']
  end

  if attributes.has_key?(:'enableVaultingMetadata')
    self. = attributes[:'enableVaultingMetadata']
  end

  if attributes.has_key?(:'expressSendOnly')
    self.express_send_only = attributes[:'expressSendOnly']
  end

  if attributes.has_key?(:'locale')
    self.locale = attributes[:'locale']
  end

  if attributes.has_key?(:'localeMetadata')
    self. = attributes[:'localeMetadata']
  end

  if attributes.has_key?(:'localePolicy')
    self.locale_policy = attributes[:'localePolicy']
  end

  if attributes.has_key?(:'manageClickwrapsMode')
    self.manage_clickwraps_mode = attributes[:'manageClickwrapsMode']
  end

  if attributes.has_key?(:'manageClickwrapsModeMetadata')
    self. = attributes[:'manageClickwrapsModeMetadata']
  end

  if attributes.has_key?(:'modifiedBy')
    self.modified_by = attributes[:'modifiedBy']
  end

  if attributes.has_key?(:'modifiedByMetadata')
    self. = attributes[:'modifiedByMetadata']
  end

  if attributes.has_key?(:'modifiedDate')
    self.modified_date = attributes[:'modifiedDate']
  end

  if attributes.has_key?(:'modifiedDateMetadata')
    self. = attributes[:'modifiedDateMetadata']
  end

  if attributes.has_key?(:'modifiedPage')
    self.modified_page = attributes[:'modifiedPage']
  end

  if attributes.has_key?(:'modifiedPageMetadata')
    self. = attributes[:'modifiedPageMetadata']
  end

  if attributes.has_key?(:'newSendUI')
    self.new_send_ui = attributes[:'newSendUI']
  end

  if attributes.has_key?(:'newSendUIMetadata')
    self. = attributes[:'newSendUIMetadata']
  end

  if attributes.has_key?(:'powerFormMode')
    self.power_form_mode = attributes[:'powerFormMode']
  end

  if attributes.has_key?(:'powerFormModeMetadata')
    self. = attributes[:'powerFormModeMetadata']
  end

  if attributes.has_key?(:'recipientViewedNotification')
    self.recipient_viewed_notification = attributes[:'recipientViewedNotification']
  end

  if attributes.has_key?(:'recipientViewedNotificationMetadata')
    self. = attributes[:'recipientViewedNotificationMetadata']
  end

  if attributes.has_key?(:'sealIdentifiers')
    if (value = attributes[:'sealIdentifiers']).is_a?(Array)
      self.seal_identifiers = value
    end
  end

  if attributes.has_key?(:'selfSignedRecipientEmailDocument')
    self.self_signed_recipient_email_document = attributes[:'selfSignedRecipientEmailDocument']
  end

  if attributes.has_key?(:'selfSignedRecipientEmailDocumentMetadata')
    self. = attributes[:'selfSignedRecipientEmailDocumentMetadata']
  end

  if attributes.has_key?(:'senderEmailNotifications')
    self.sender_email_notifications = attributes[:'senderEmailNotifications']
  end

  if attributes.has_key?(:'signerEmailNotifications')
    self.signer_email_notifications = attributes[:'signerEmailNotifications']
  end

  if attributes.has_key?(:'supplementalDocumentIncludeInDownload')
    self.supplemental_document_include_in_download = attributes[:'supplementalDocumentIncludeInDownload']
  end

  if attributes.has_key?(:'supplementalDocumentsMustAccept')
    self.supplemental_documents_must_accept = attributes[:'supplementalDocumentsMustAccept']
  end

  if attributes.has_key?(:'supplementalDocumentsMustAcceptMetadata')
    self. = attributes[:'supplementalDocumentsMustAcceptMetadata']
  end

  if attributes.has_key?(:'supplementalDocumentsMustRead')
    self.supplemental_documents_must_read = attributes[:'supplementalDocumentsMustRead']
  end

  if attributes.has_key?(:'supplementalDocumentsMustReadMetadata')
    self. = attributes[:'supplementalDocumentsMustReadMetadata']
  end

  if attributes.has_key?(:'supplementalDocumentsMustView')
    self.supplemental_documents_must_view = attributes[:'supplementalDocumentsMustView']
  end

  if attributes.has_key?(:'supplementalDocumentsMustViewMetadata')
    self. = attributes[:'supplementalDocumentsMustViewMetadata']
  end

  if attributes.has_key?(:'templateActiveCreation')
    self.template_active_creation = attributes[:'templateActiveCreation']
  end

  if attributes.has_key?(:'templateActiveCreationMetadata')
    self. = attributes[:'templateActiveCreationMetadata']
  end

  if attributes.has_key?(:'templateApplyNotify')
    self.template_apply_notify = attributes[:'templateApplyNotify']
  end

  if attributes.has_key?(:'templateApplyNotifyMetadata')
    self. = attributes[:'templateApplyNotifyMetadata']
  end

  if attributes.has_key?(:'templateAutoMatching')
    self.template_auto_matching = attributes[:'templateAutoMatching']
  end

  if attributes.has_key?(:'templateAutoMatchingMetadata')
    self. = attributes[:'templateAutoMatchingMetadata']
  end

  if attributes.has_key?(:'templateMatchingSensitivity')
    self.template_matching_sensitivity = attributes[:'templateMatchingSensitivity']
  end

  if attributes.has_key?(:'templateMatchingSensitivityMetadata')
    self. = attributes[:'templateMatchingSensitivityMetadata']
  end

  if attributes.has_key?(:'templatePageLevelMatching')
    self.template_page_level_matching = attributes[:'templatePageLevelMatching']
  end

  if attributes.has_key?(:'templatePageLevelMatchingMetadata')
    self. = attributes[:'templatePageLevelMatchingMetadata']
  end

  if attributes.has_key?(:'timezoneDST')
    self.timezone_dst = attributes[:'timezoneDST']
  end

  if attributes.has_key?(:'timezoneDSTMetadata')
    self. = attributes[:'timezoneDSTMetadata']
  end

  if attributes.has_key?(:'timezoneMask')
    self.timezone_mask = attributes[:'timezoneMask']
  end

  if attributes.has_key?(:'timezoneMaskMetadata')
    self. = attributes[:'timezoneMaskMetadata']
  end

  if attributes.has_key?(:'timezoneOffset')
    self.timezone_offset = attributes[:'timezoneOffset']
  end

  if attributes.has_key?(:'timezoneOffsetMetadata')
    self. = attributes[:'timezoneOffsetMetadata']
  end

  if attributes.has_key?(:'timezoneSendingPref')
    self.timezone_sending_pref = attributes[:'timezoneSendingPref']
  end

  if attributes.has_key?(:'timezoneSendingPrefMetadata')
    self. = attributes[:'timezoneSendingPrefMetadata']
  end

  if attributes.has_key?(:'timezoneSigningPref')
    self.timezone_signing_pref = attributes[:'timezoneSigningPref']
  end

  if attributes.has_key?(:'timezoneSigningPrefMetadata')
    self. = attributes[:'timezoneSigningPrefMetadata']
  end

  if attributes.has_key?(:'transactionPointSiteNameURL')
    self.transaction_point_site_name_url = attributes[:'transactionPointSiteNameURL']
  end

  if attributes.has_key?(:'transactionPointSiteNameURLMetadata')
    self. = attributes[:'transactionPointSiteNameURLMetadata']
  end

  if attributes.has_key?(:'transactionPointUserName')
    self.transaction_point_user_name = attributes[:'transactionPointUserName']
  end

  if attributes.has_key?(:'transactionPointUserNameMetadata')
    self. = attributes[:'transactionPointUserNameMetadata']
  end

  if attributes.has_key?(:'vaultingMode')
    self.vaulting_mode = attributes[:'vaultingMode']
  end

  if attributes.has_key?(:'vaultingModeMetadata')
    self. = attributes[:'vaultingModeMetadata']
  end

  if attributes.has_key?(:'webForms')
    self.web_forms = attributes[:'webForms']
  end

  if attributes.has_key?(:'webFormsMetadata')
    self. = attributes[:'webFormsMetadata']
  end
end

Instance Attribute Details

#account_agreements_access_typeObject

Returns the value of attribute account_agreements_access_type.



18
19
20
# File 'lib/docusign_esign/models/user_settings_information.rb', line 18

def 
  @account_agreements_access_type
end

#account_agreements_access_type_metadataObject

Returns the value of attribute account_agreements_access_type_metadata.



21
22
23
# File 'lib/docusign_esign/models/user_settings_information.rb', line 21

def 
  @account_agreements_access_type_metadata
end

#account_management_granularObject

Describes which account management capabilities a user has.



24
25
26
# File 'lib/docusign_esign/models/user_settings_information.rb', line 24

def 
  @account_management_granular
end

#admin_onlyObject

Returns the value of attribute admin_only.



27
28
29
# File 'lib/docusign_esign/models/user_settings_information.rb', line 27

def admin_only
  @admin_only
end

#admin_only_metadataObject

Reserved for DocuSign.



30
31
32
# File 'lib/docusign_esign/models/user_settings_information.rb', line 30

def 
  @admin_only_metadata
end

#allow_access_to_all_account_agreementsObject

Returns the value of attribute allow_access_to_all_account_agreements.



33
34
35
# File 'lib/docusign_esign/models/user_settings_information.rb', line 33

def 
  @allow_access_to_all_account_agreements
end

#allow_access_to_all_account_agreements_metadataObject

Returns the value of attribute allow_access_to_all_account_agreements_metadata.



36
37
38
# File 'lib/docusign_esign/models/user_settings_information.rb', line 36

def 
  @allow_access_to_all_account_agreements_metadata
end

#allow_auto_taggingObject

Returns the value of attribute allow_auto_tagging.



39
40
41
# File 'lib/docusign_esign/models/user_settings_information.rb', line 39

def allow_auto_tagging
  @allow_auto_tagging
end

#allow_envelope_transfer_toObject

Returns the value of attribute allow_envelope_transfer_to.



48
49
50
# File 'lib/docusign_esign/models/user_settings_information.rb', line 48

def allow_envelope_transfer_to
  @allow_envelope_transfer_to
end

#allow_envelope_transfer_to_metadataObject

Reserved for DocuSign.



51
52
53
# File 'lib/docusign_esign/models/user_settings_information.rb', line 51

def 
  @allow_envelope_transfer_to_metadata
end

#allow_eseal_recipientsObject

Returns the value of attribute allow_eseal_recipients.



54
55
56
# File 'lib/docusign_esign/models/user_settings_information.rb', line 54

def allow_eseal_recipients
  @allow_eseal_recipients
end

#allow_eseal_recipients_metadataObject

Metadata about the ‘allowEsealRecipientsMetadata` property.



57
58
59
# File 'lib/docusign_esign/models/user_settings_information.rb', line 57

def 
  @allow_eseal_recipients_metadata
end

#allow_power_forms_admin_to_access_all_power_form_envelopeObject

Returns the value of attribute allow_power_forms_admin_to_access_all_power_form_envelope.



60
61
62
# File 'lib/docusign_esign/models/user_settings_information.rb', line 60

def allow_power_forms_admin_to_access_all_power_form_envelope
  @allow_power_forms_admin_to_access_all_power_form_envelope
end

#allow_power_forms_admin_to_access_all_power_form_envelope_metadataObject

Metadata about the ‘allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata` property.



63
64
65
# File 'lib/docusign_esign/models/user_settings_information.rb', line 63

def 
  @allow_power_forms_admin_to_access_all_power_form_envelope_metadata
end

#allow_recipient_language_selectionObject

Returns the value of attribute allow_recipient_language_selection.



66
67
68
# File 'lib/docusign_esign/models/user_settings_information.rb', line 66

def allow_recipient_language_selection
  @allow_recipient_language_selection
end

#allow_recipient_language_selection_metadataObject

Metadata for allowRecipientLanguageSelection.



69
70
71
# File 'lib/docusign_esign/models/user_settings_information.rb', line 69

def 
  @allow_recipient_language_selection_metadata
end

#allow_send_on_behalf_ofObject

Returns the value of attribute allow_send_on_behalf_of.



72
73
74
# File 'lib/docusign_esign/models/user_settings_information.rb', line 72

def allow_send_on_behalf_of
  @allow_send_on_behalf_of
end

#allow_send_on_behalf_of_metadataObject

Metadata for allowSendOnBehalfOf.



75
76
77
# File 'lib/docusign_esign/models/user_settings_information.rb', line 75

def 
  @allow_send_on_behalf_of_metadata
end

#allow_supplemental_documentsObject

Returns the value of attribute allow_supplemental_documents.



78
79
80
# File 'lib/docusign_esign/models/user_settings_information.rb', line 78

def allow_supplemental_documents
  @allow_supplemental_documents
end

#allow_supplemental_documents_metadataObject

Metadata that indicates whether the ‘allowSupplementalDocuments` property is editable.



81
82
83
# File 'lib/docusign_esign/models/user_settings_information.rb', line 81

def 
  @allow_supplemental_documents_metadata
end

#allow_transactionsObject

Returns the value of attribute allow_transactions.



84
85
86
# File 'lib/docusign_esign/models/user_settings_information.rb', line 84

def allow_transactions
  @allow_transactions
end

#allow_transactions_metadataObject

Returns the value of attribute allow_transactions_metadata.



87
88
89
# File 'lib/docusign_esign/models/user_settings_information.rb', line 87

def 
  @allow_transactions_metadata
end

#allowed_orchestration_accessObject

Returns the value of attribute allowed_orchestration_access.



42
43
44
# File 'lib/docusign_esign/models/user_settings_information.rb', line 42

def allowed_orchestration_access
  @allowed_orchestration_access
end

#allowed_orchestration_access_metadataObject

Returns the value of attribute allowed_orchestration_access_metadata.



45
46
47
# File 'lib/docusign_esign/models/user_settings_information.rb', line 45

def 
  @allowed_orchestration_access_metadata
end

#anchor_tag_versioned_placement_enabledObject

Returns the value of attribute anchor_tag_versioned_placement_enabled.



90
91
92
# File 'lib/docusign_esign/models/user_settings_information.rb', line 90

def anchor_tag_versioned_placement_enabled
  @anchor_tag_versioned_placement_enabled
end

#api_account_wide_accessObject

Returns the value of attribute api_account_wide_access.



93
94
95
# File 'lib/docusign_esign/models/user_settings_information.rb', line 93

def 
  @api_account_wide_access
end

#api_account_wide_access_metadataObject

Metadata for apiAccountWideAccess.



96
97
98
# File 'lib/docusign_esign/models/user_settings_information.rb', line 96

def 
  @api_account_wide_access_metadata
end

#api_can_export_acObject

Returns the value of attribute api_can_export_ac.



99
100
101
# File 'lib/docusign_esign/models/user_settings_information.rb', line 99

def api_can_export_ac
  @api_can_export_ac
end

#api_can_export_ac_metadataObject

Metadata about the ‘apiCanExportACMetadata` property.



102
103
104
# File 'lib/docusign_esign/models/user_settings_information.rb', line 102

def 
  @api_can_export_ac_metadata
end

#bulk_sendObject

Returns the value of attribute bulk_send.



105
106
107
# File 'lib/docusign_esign/models/user_settings_information.rb', line 105

def bulk_send
  @bulk_send
end

#bulk_send_metadataObject

Metadata that indicates whether the ‘bulkSend` property is editable.



108
109
110
# File 'lib/docusign_esign/models/user_settings_information.rb', line 108

def 
  @bulk_send_metadata
end

#can_bulk_upload_agreementsObject

Returns the value of attribute can_bulk_upload_agreements.



111
112
113
# File 'lib/docusign_esign/models/user_settings_information.rb', line 111

def can_bulk_upload_agreements
  @can_bulk_upload_agreements
end

#can_bulk_upload_agreements_metadataObject

Returns the value of attribute can_bulk_upload_agreements_metadata.



114
115
116
# File 'lib/docusign_esign/models/user_settings_information.rb', line 114

def 
  @can_bulk_upload_agreements_metadata
end

#can_charge_accountObject

Returns the value of attribute can_charge_account.



117
118
119
# File 'lib/docusign_esign/models/user_settings_information.rb', line 117

def 
  @can_charge_account
end

#can_charge_account_metadataObject

Reserved for DocuSign.



120
121
122
# File 'lib/docusign_esign/models/user_settings_information.rb', line 120

def 
  @can_charge_account_metadata
end

#can_create_transactionObject

Returns the value of attribute can_create_transaction.



123
124
125
# File 'lib/docusign_esign/models/user_settings_information.rb', line 123

def can_create_transaction
  @can_create_transaction
end

#can_create_transaction_metadataObject

Returns the value of attribute can_create_transaction_metadata.



126
127
128
# File 'lib/docusign_esign/models/user_settings_information.rb', line 126

def 
  @can_create_transaction_metadata
end

#can_delete_documents_in_transactionObject

Returns the value of attribute can_delete_documents_in_transaction.



129
130
131
# File 'lib/docusign_esign/models/user_settings_information.rb', line 129

def can_delete_documents_in_transaction
  @can_delete_documents_in_transaction
end

#can_delete_documents_in_transaction_metadataObject

Returns the value of attribute can_delete_documents_in_transaction_metadata.



132
133
134
# File 'lib/docusign_esign/models/user_settings_information.rb', line 132

def 
  @can_delete_documents_in_transaction_metadata
end

#can_delete_transactionObject

Returns the value of attribute can_delete_transaction.



135
136
137
# File 'lib/docusign_esign/models/user_settings_information.rb', line 135

def can_delete_transaction
  @can_delete_transaction
end

#can_delete_transaction_metadataObject

Returns the value of attribute can_delete_transaction_metadata.



138
139
140
# File 'lib/docusign_esign/models/user_settings_information.rb', line 138

def 
  @can_delete_transaction_metadata
end

#can_edit_shared_addressbookObject

Returns the value of attribute can_edit_shared_addressbook.



141
142
143
# File 'lib/docusign_esign/models/user_settings_information.rb', line 141

def can_edit_shared_addressbook
  @can_edit_shared_addressbook
end

#can_edit_shared_addressbook_metadataObject

Metadata about the ‘canEditSharedAddressbookMetadata` property.



144
145
146
# File 'lib/docusign_esign/models/user_settings_information.rb', line 144

def 
  @can_edit_shared_addressbook_metadata
end

#can_lock_envelopesObject

Returns the value of attribute can_lock_envelopes.



147
148
149
# File 'lib/docusign_esign/models/user_settings_information.rb', line 147

def can_lock_envelopes
  @can_lock_envelopes
end

#can_lock_envelopes_metadataObject

Metadata about the ‘canLockEnvelopes` property.



150
151
152
# File 'lib/docusign_esign/models/user_settings_information.rb', line 150

def 
  @can_lock_envelopes_metadata
end

#can_manage_accountObject

Returns the value of attribute can_manage_account.



153
154
155
# File 'lib/docusign_esign/models/user_settings_information.rb', line 153

def 
  @can_manage_account
end

#can_manage_account_metadataObject

Metadata about the ‘canManageAccountMetadata` property.



156
157
158
# File 'lib/docusign_esign/models/user_settings_information.rb', line 156

def 
  @can_manage_account_metadata
end

#can_manage_agreement_partiesObject

Returns the value of attribute can_manage_agreement_parties.



159
160
161
# File 'lib/docusign_esign/models/user_settings_information.rb', line 159

def can_manage_agreement_parties
  @can_manage_agreement_parties
end

#can_manage_agreement_parties_metadataObject

Returns the value of attribute can_manage_agreement_parties_metadata.



162
163
164
# File 'lib/docusign_esign/models/user_settings_information.rb', line 162

def 
  @can_manage_agreement_parties_metadata
end

#can_manage_distributorObject

Returns the value of attribute can_manage_distributor.



165
166
167
# File 'lib/docusign_esign/models/user_settings_information.rb', line 165

def can_manage_distributor
  @can_manage_distributor
end

#can_manage_distributor_metadataObject

Metadata about the ‘canManageDistributor` property.



168
169
170
# File 'lib/docusign_esign/models/user_settings_information.rb', line 168

def 
  @can_manage_distributor_metadata
end

#can_manage_templatesObject

Returns the value of attribute can_manage_templates.



171
172
173
# File 'lib/docusign_esign/models/user_settings_information.rb', line 171

def can_manage_templates
  @can_manage_templates
end

#can_manage_templates_metadataObject

Metadata about the ‘canManageTemplates` property.



174
175
176
# File 'lib/docusign_esign/models/user_settings_information.rb', line 174

def 
  @can_manage_templates_metadata
end

#can_send_api_requestsObject

Returns the value of attribute can_send_api_requests.



177
178
179
# File 'lib/docusign_esign/models/user_settings_information.rb', line 177

def can_send_api_requests
  @can_send_api_requests
end

#can_send_api_requests_metadataObject

Metadata about the ‘canSendAPIRequests` property.



180
181
182
# File 'lib/docusign_esign/models/user_settings_information.rb', line 180

def 
  @can_send_api_requests_metadata
end

#can_send_envelopeObject

Returns the value of attribute can_send_envelope.



183
184
185
# File 'lib/docusign_esign/models/user_settings_information.rb', line 183

def can_send_envelope
  @can_send_envelope
end

#can_send_envelope_metadataObject

Metadata about the ‘canSendEnvelope` property.



186
187
188
# File 'lib/docusign_esign/models/user_settings_information.rb', line 186

def 
  @can_send_envelope_metadata
end

#can_send_envelopes_via_smsObject

Returns the value of attribute can_send_envelopes_via_sms.



189
190
191
# File 'lib/docusign_esign/models/user_settings_information.rb', line 189

def can_send_envelopes_via_sms
  @can_send_envelopes_via_sms
end

#can_send_envelopes_via_sms_metadataObject

Returns the value of attribute can_send_envelopes_via_sms_metadata.



192
193
194
# File 'lib/docusign_esign/models/user_settings_information.rb', line 192

def 
  @can_send_envelopes_via_sms_metadata
end

#can_sign_envelopeObject

Returns the value of attribute can_sign_envelope.



195
196
197
# File 'lib/docusign_esign/models/user_settings_information.rb', line 195

def can_sign_envelope
  @can_sign_envelope
end

#can_sign_envelope_metadataObject

Metadata about the ‘canSignEnvelope` property.



198
199
200
# File 'lib/docusign_esign/models/user_settings_information.rb', line 198

def 
  @can_sign_envelope_metadata
end

#can_use_scratchpadObject

Returns the value of attribute can_use_scratchpad.



201
202
203
# File 'lib/docusign_esign/models/user_settings_information.rb', line 201

def can_use_scratchpad
  @can_use_scratchpad
end

#can_use_scratchpad_metadataObject

Metadata about the ‘canUseScratchpad` property.



204
205
206
# File 'lib/docusign_esign/models/user_settings_information.rb', line 204

def 
  @can_use_scratchpad_metadata
end

#can_use_smart_contractsObject

Returns the value of attribute can_use_smart_contracts.



207
208
209
# File 'lib/docusign_esign/models/user_settings_information.rb', line 207

def can_use_smart_contracts
  @can_use_smart_contracts
end

#can_use_smart_contracts_metadataObject

Reserved for DocuSign.



210
211
212
# File 'lib/docusign_esign/models/user_settings_information.rb', line 210

def 
  @can_use_smart_contracts_metadata
end

#disable_document_uploadObject

Returns the value of attribute disable_document_upload.



213
214
215
# File 'lib/docusign_esign/models/user_settings_information.rb', line 213

def disable_document_upload
  @disable_document_upload
end

#disable_document_upload_metadataObject

Metadata that indicates whether the ‘disableDocumentUpload` property is editable.



216
217
218
# File 'lib/docusign_esign/models/user_settings_information.rb', line 216

def 
  @disable_document_upload_metadata
end

#disable_other_actionsObject

Returns the value of attribute disable_other_actions.



219
220
221
# File 'lib/docusign_esign/models/user_settings_information.rb', line 219

def disable_other_actions
  @disable_other_actions
end

#disable_other_actions_metadataObject

Metadata that indicates whether the ‘disableOtherActions` property is editable.



222
223
224
# File 'lib/docusign_esign/models/user_settings_information.rb', line 222

def 
  @disable_other_actions_metadata
end

#enable_ds_proObject

Returns the value of attribute enable_ds_pro.



225
226
227
# File 'lib/docusign_esign/models/user_settings_information.rb', line 225

def enable_ds_pro
  @enable_ds_pro
end

#enable_ds_pro_metadataObject

Metadata that indicates whether the ‘enableDSPro` property is editable.



228
229
230
# File 'lib/docusign_esign/models/user_settings_information.rb', line 228

def 
  @enable_ds_pro_metadata
end

#enable_key_terms_suggestions_by_document_typeObject

Returns the value of attribute enable_key_terms_suggestions_by_document_type.



231
232
233
# File 'lib/docusign_esign/models/user_settings_information.rb', line 231

def enable_key_terms_suggestions_by_document_type
  @enable_key_terms_suggestions_by_document_type
end

#enable_key_terms_suggestions_by_document_type_metadataObject

Returns the value of attribute enable_key_terms_suggestions_by_document_type_metadata.



234
235
236
# File 'lib/docusign_esign/models/user_settings_information.rb', line 234

def 
  @enable_key_terms_suggestions_by_document_type_metadata
end

#enable_sequential_signing_apiObject

Returns the value of attribute enable_sequential_signing_api.



237
238
239
# File 'lib/docusign_esign/models/user_settings_information.rb', line 237

def enable_sequential_signing_api
  @enable_sequential_signing_api
end

#enable_sequential_signing_api_metadataObject

Metadata that indicates whether the ‘enableSequentialSigningAPI` property is editable.



240
241
242
# File 'lib/docusign_esign/models/user_settings_information.rb', line 240

def 
  @enable_sequential_signing_api_metadata
end

#enable_sequential_signing_uiObject

Returns the value of attribute enable_sequential_signing_ui.



243
244
245
# File 'lib/docusign_esign/models/user_settings_information.rb', line 243

def enable_sequential_signing_ui
  @enable_sequential_signing_ui
end

#enable_sequential_signing_ui_metadataObject

Metadata that indicates whether the ‘enableSequentialSigningUI` property is editable.



246
247
248
# File 'lib/docusign_esign/models/user_settings_information.rb', line 246

def 
  @enable_sequential_signing_ui_metadata
end

#enable_sign_on_paper_overrideObject

Returns the value of attribute enable_sign_on_paper_override.



255
256
257
# File 'lib/docusign_esign/models/user_settings_information.rb', line 255

def enable_sign_on_paper_override
  @enable_sign_on_paper_override
end

#enable_sign_on_paper_override_metadataObject

Metadata that indicates whether the ‘enableSignOnPaperOverride` property is editable.



258
259
260
# File 'lib/docusign_esign/models/user_settings_information.rb', line 258

def 
  @enable_sign_on_paper_override_metadata
end

#enable_signer_attachmentsObject

Returns the value of attribute enable_signer_attachments.



249
250
251
# File 'lib/docusign_esign/models/user_settings_information.rb', line 249

def enable_signer_attachments
  @enable_signer_attachments
end

#enable_signer_attachments_metadataObject

Metadata that indicates whether the ‘enableSignerAttachments` property is editable.



252
253
254
# File 'lib/docusign_esign/models/user_settings_information.rb', line 252

def 
  @enable_signer_attachments_metadata
end

#enable_transaction_pointObject

Returns the value of attribute enable_transaction_point.



261
262
263
# File 'lib/docusign_esign/models/user_settings_information.rb', line 261

def enable_transaction_point
  @enable_transaction_point
end

#enable_transaction_point_metadataObject

Reserved for DocuSign.



264
265
266
# File 'lib/docusign_esign/models/user_settings_information.rb', line 264

def 
  @enable_transaction_point_metadata
end

#enable_vaultingObject

Returns the value of attribute enable_vaulting.



267
268
269
# File 'lib/docusign_esign/models/user_settings_information.rb', line 267

def enable_vaulting
  @enable_vaulting
end

#enable_vaulting_metadataObject

Metadata that indicates whether the ‘enableVaulting` property is editable.



270
271
272
# File 'lib/docusign_esign/models/user_settings_information.rb', line 270

def 
  @enable_vaulting_metadata
end

#express_send_onlyObject

Returns the value of attribute express_send_only.



273
274
275
# File 'lib/docusign_esign/models/user_settings_information.rb', line 273

def express_send_only
  @express_send_only
end

#localeObject

Returns the value of attribute locale.



276
277
278
# File 'lib/docusign_esign/models/user_settings_information.rb', line 276

def locale
  @locale
end

#locale_metadataObject

Metadata about the ‘locale` property.



279
280
281
# File 'lib/docusign_esign/models/user_settings_information.rb', line 279

def 
  @locale_metadata
end

#locale_policyObject

Reserved for DocuSign.



282
283
284
# File 'lib/docusign_esign/models/user_settings_information.rb', line 282

def locale_policy
  @locale_policy
end

#manage_clickwraps_modeObject

Returns the value of attribute manage_clickwraps_mode.



285
286
287
# File 'lib/docusign_esign/models/user_settings_information.rb', line 285

def manage_clickwraps_mode
  @manage_clickwraps_mode
end

#manage_clickwraps_mode_metadataObject

Metadata about the ‘manageClickwrapsMode` property.



288
289
290
# File 'lib/docusign_esign/models/user_settings_information.rb', line 288

def 
  @manage_clickwraps_mode_metadata
end

#modified_byObject

Returns the value of attribute modified_by.



291
292
293
# File 'lib/docusign_esign/models/user_settings_information.rb', line 291

def modified_by
  @modified_by
end

#modified_by_metadataObject

Metadata about the ‘modifiedBy` property.



294
295
296
# File 'lib/docusign_esign/models/user_settings_information.rb', line 294

def 
  @modified_by_metadata
end

#modified_dateObject

Returns the value of attribute modified_date.



297
298
299
# File 'lib/docusign_esign/models/user_settings_information.rb', line 297

def modified_date
  @modified_date
end

#modified_date_metadataObject

Metadata about the ‘modifiedDate` property.



300
301
302
# File 'lib/docusign_esign/models/user_settings_information.rb', line 300

def 
  @modified_date_metadata
end

#modified_pageObject

Returns the value of attribute modified_page.



303
304
305
# File 'lib/docusign_esign/models/user_settings_information.rb', line 303

def modified_page
  @modified_page
end

#modified_page_metadataObject

Metadata about the ‘modifiedPage` property.



306
307
308
# File 'lib/docusign_esign/models/user_settings_information.rb', line 306

def 
  @modified_page_metadata
end

#new_send_uiObject

Returns the value of attribute new_send_ui.



309
310
311
# File 'lib/docusign_esign/models/user_settings_information.rb', line 309

def new_send_ui
  @new_send_ui
end

#new_send_ui_metadataObject

Metadata about the ‘newSendUI` property.



312
313
314
# File 'lib/docusign_esign/models/user_settings_information.rb', line 312

def 
  @new_send_ui_metadata
end

#power_form_modeObject

Returns the value of attribute power_form_mode.



315
316
317
# File 'lib/docusign_esign/models/user_settings_information.rb', line 315

def power_form_mode
  @power_form_mode
end

#power_form_mode_metadataObject

Metadata about the ‘powerFormMode` property.



318
319
320
# File 'lib/docusign_esign/models/user_settings_information.rb', line 318

def 
  @power_form_mode_metadata
end

#recipient_viewed_notificationObject

Returns the value of attribute recipient_viewed_notification.



321
322
323
# File 'lib/docusign_esign/models/user_settings_information.rb', line 321

def recipient_viewed_notification
  @recipient_viewed_notification
end

#recipient_viewed_notification_metadataObject

Metadata about the ‘recipientViewedNotification` property.



324
325
326
# File 'lib/docusign_esign/models/user_settings_information.rb', line 324

def 
  @recipient_viewed_notification_metadata
end

#seal_identifiersObject

Returns the value of attribute seal_identifiers.



327
328
329
# File 'lib/docusign_esign/models/user_settings_information.rb', line 327

def seal_identifiers
  @seal_identifiers
end

#self_signed_recipient_email_documentObject

Returns the value of attribute self_signed_recipient_email_document.



330
331
332
# File 'lib/docusign_esign/models/user_settings_information.rb', line 330

def self_signed_recipient_email_document
  @self_signed_recipient_email_document
end

#self_signed_recipient_email_document_metadataObject

Metadata that indicates whether the ‘selfSignedRecipientEmailDocument` property is editable.



333
334
335
# File 'lib/docusign_esign/models/user_settings_information.rb', line 333

def 
  @self_signed_recipient_email_document_metadata
end

#sender_email_notificationsObject

An array of email notifications that sets the email the user receives when they are a sender. When the specific email notification is set to true, the user will receive those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created. The email notifications are: * envelopeComplete * changedSigner * senderEnvelopeDeclined * withdrawnConsent * recipientViewed * deliveryFailed



336
337
338
# File 'lib/docusign_esign/models/user_settings_information.rb', line 336

def sender_email_notifications
  @sender_email_notifications
end

#signer_email_notificationsObject

An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account email notification settings when the user is created.



339
340
341
# File 'lib/docusign_esign/models/user_settings_information.rb', line 339

def signer_email_notifications
  @signer_email_notifications
end

#supplemental_document_include_in_downloadObject

Returns the value of attribute supplemental_document_include_in_download.



342
343
344
# File 'lib/docusign_esign/models/user_settings_information.rb', line 342

def supplemental_document_include_in_download
  @supplemental_document_include_in_download
end

#supplemental_documents_must_acceptObject

Returns the value of attribute supplemental_documents_must_accept.



345
346
347
# File 'lib/docusign_esign/models/user_settings_information.rb', line 345

def supplemental_documents_must_accept
  @supplemental_documents_must_accept
end

#supplemental_documents_must_accept_metadataObject

Metadata that indicates whether the ‘supplementalDocumentsMustAccept` property is editable.



348
349
350
# File 'lib/docusign_esign/models/user_settings_information.rb', line 348

def 
  @supplemental_documents_must_accept_metadata
end

#supplemental_documents_must_readObject

Returns the value of attribute supplemental_documents_must_read.



351
352
353
# File 'lib/docusign_esign/models/user_settings_information.rb', line 351

def supplemental_documents_must_read
  @supplemental_documents_must_read
end

#supplemental_documents_must_read_metadataObject

Metadata that indicates whether the ‘supplementalDocumentsMustRead` property is editable.



354
355
356
# File 'lib/docusign_esign/models/user_settings_information.rb', line 354

def 
  @supplemental_documents_must_read_metadata
end

#supplemental_documents_must_viewObject

Returns the value of attribute supplemental_documents_must_view.



357
358
359
# File 'lib/docusign_esign/models/user_settings_information.rb', line 357

def supplemental_documents_must_view
  @supplemental_documents_must_view
end

#supplemental_documents_must_view_metadataObject

Metadata that indicates whether the ‘supplementalDocumentsMustView` property is editable.



360
361
362
# File 'lib/docusign_esign/models/user_settings_information.rb', line 360

def 
  @supplemental_documents_must_view_metadata
end

#template_active_creationObject

Returns the value of attribute template_active_creation.



363
364
365
# File 'lib/docusign_esign/models/user_settings_information.rb', line 363

def template_active_creation
  @template_active_creation
end

#template_active_creation_metadataObject

Metadata about the ‘templateActiveCreation` property.



366
367
368
# File 'lib/docusign_esign/models/user_settings_information.rb', line 366

def 
  @template_active_creation_metadata
end

#template_apply_notifyObject

Returns the value of attribute template_apply_notify.



369
370
371
# File 'lib/docusign_esign/models/user_settings_information.rb', line 369

def template_apply_notify
  @template_apply_notify
end

#template_apply_notify_metadataObject

Metadata about the ‘templateApplyNotify` property.



372
373
374
# File 'lib/docusign_esign/models/user_settings_information.rb', line 372

def 
  @template_apply_notify_metadata
end

#template_auto_matchingObject

Returns the value of attribute template_auto_matching.



375
376
377
# File 'lib/docusign_esign/models/user_settings_information.rb', line 375

def template_auto_matching
  @template_auto_matching
end

#template_auto_matching_metadataObject

Metadata about the ‘templateAutoMatching` property.



378
379
380
# File 'lib/docusign_esign/models/user_settings_information.rb', line 378

def 
  @template_auto_matching_metadata
end

#template_matching_sensitivityObject

Returns the value of attribute template_matching_sensitivity.



381
382
383
# File 'lib/docusign_esign/models/user_settings_information.rb', line 381

def template_matching_sensitivity
  @template_matching_sensitivity
end

#template_matching_sensitivity_metadataObject

Metadata about the ‘tempalteMatchingSensitivity` property.



384
385
386
# File 'lib/docusign_esign/models/user_settings_information.rb', line 384

def 
  @template_matching_sensitivity_metadata
end

#template_page_level_matchingObject

Returns the value of attribute template_page_level_matching.



387
388
389
# File 'lib/docusign_esign/models/user_settings_information.rb', line 387

def template_page_level_matching
  @template_page_level_matching
end

#template_page_level_matching_metadataObject

Metadata about the ‘templatePageLevelMatching` property.



390
391
392
# File 'lib/docusign_esign/models/user_settings_information.rb', line 390

def 
  @template_page_level_matching_metadata
end

#timezone_dstObject

Returns the value of attribute timezone_dst.



393
394
395
# File 'lib/docusign_esign/models/user_settings_information.rb', line 393

def timezone_dst
  @timezone_dst
end

#timezone_dst_metadataObject

Metadata about the ‘timezoneDST` property.



396
397
398
# File 'lib/docusign_esign/models/user_settings_information.rb', line 396

def 
  @timezone_dst_metadata
end

#timezone_maskObject

Returns the value of attribute timezone_mask.



399
400
401
# File 'lib/docusign_esign/models/user_settings_information.rb', line 399

def timezone_mask
  @timezone_mask
end

#timezone_mask_metadataObject

Metadata about the ‘timezoneMask` property.



402
403
404
# File 'lib/docusign_esign/models/user_settings_information.rb', line 402

def 
  @timezone_mask_metadata
end

#timezone_offsetObject

Returns the value of attribute timezone_offset.



405
406
407
# File 'lib/docusign_esign/models/user_settings_information.rb', line 405

def timezone_offset
  @timezone_offset
end

#timezone_offset_metadataObject

Metadata about the ‘timezoneOffset` property.



408
409
410
# File 'lib/docusign_esign/models/user_settings_information.rb', line 408

def 
  @timezone_offset_metadata
end

#timezone_sending_prefObject

Returns the value of attribute timezone_sending_pref.



411
412
413
# File 'lib/docusign_esign/models/user_settings_information.rb', line 411

def timezone_sending_pref
  @timezone_sending_pref
end

#timezone_sending_pref_metadataObject

Reserved for DocuSign.



414
415
416
# File 'lib/docusign_esign/models/user_settings_information.rb', line 414

def 
  @timezone_sending_pref_metadata
end

#timezone_signing_prefObject

Returns the value of attribute timezone_signing_pref.



417
418
419
# File 'lib/docusign_esign/models/user_settings_information.rb', line 417

def timezone_signing_pref
  @timezone_signing_pref
end

#timezone_signing_pref_metadataObject

Reserved for DocuSign.



420
421
422
# File 'lib/docusign_esign/models/user_settings_information.rb', line 420

def 
  @timezone_signing_pref_metadata
end

#transaction_point_site_name_urlObject

Returns the value of attribute transaction_point_site_name_url.



423
424
425
# File 'lib/docusign_esign/models/user_settings_information.rb', line 423

def transaction_point_site_name_url
  @transaction_point_site_name_url
end

#transaction_point_site_name_url_metadataObject

Reserved for DocuSign.



426
427
428
# File 'lib/docusign_esign/models/user_settings_information.rb', line 426

def 
  @transaction_point_site_name_url_metadata
end

#transaction_point_user_nameObject

Returns the value of attribute transaction_point_user_name.



429
430
431
# File 'lib/docusign_esign/models/user_settings_information.rb', line 429

def transaction_point_user_name
  @transaction_point_user_name
end

#transaction_point_user_name_metadataObject

Reserved for DocuSign.



432
433
434
# File 'lib/docusign_esign/models/user_settings_information.rb', line 432

def 
  @transaction_point_user_name_metadata
end

#vaulting_modeObject

Returns the value of attribute vaulting_mode.



435
436
437
# File 'lib/docusign_esign/models/user_settings_information.rb', line 435

def vaulting_mode
  @vaulting_mode
end

#vaulting_mode_metadataObject

Metadata about the ‘vaultingMode` property.



438
439
440
# File 'lib/docusign_esign/models/user_settings_information.rb', line 438

def 
  @vaulting_mode_metadata
end

#web_formsObject

Returns the value of attribute web_forms.



441
442
443
# File 'lib/docusign_esign/models/user_settings_information.rb', line 441

def web_forms
  @web_forms
end

#web_forms_metadataObject

Returns the value of attribute web_forms_metadata.



444
445
446
# File 'lib/docusign_esign/models/user_settings_information.rb', line 444

def 
  @web_forms_metadata
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
# File 'lib/docusign_esign/models/user_settings_information.rb', line 447

def self.attribute_map
  {
    :'account_agreements_access_type' => :'accountAgreementsAccessType',
    :'account_agreements_access_type_metadata' => :'accountAgreementsAccessTypeMetadata',
    :'account_management_granular' => :'accountManagementGranular',
    :'admin_only' => :'adminOnly',
    :'admin_only_metadata' => :'adminOnlyMetadata',
    :'allow_access_to_all_account_agreements' => :'allowAccessToAllAccountAgreements',
    :'allow_access_to_all_account_agreements_metadata' => :'allowAccessToAllAccountAgreementsMetadata',
    :'allow_auto_tagging' => :'allowAutoTagging',
    :'allowed_orchestration_access' => :'allowedOrchestrationAccess',
    :'allowed_orchestration_access_metadata' => :'allowedOrchestrationAccessMetadata',
    :'allow_envelope_transfer_to' => :'allowEnvelopeTransferTo',
    :'allow_envelope_transfer_to_metadata' => :'allowEnvelopeTransferToMetadata',
    :'allow_eseal_recipients' => :'allowEsealRecipients',
    :'allow_eseal_recipients_metadata' => :'allowEsealRecipientsMetadata',
    :'allow_power_forms_admin_to_access_all_power_form_envelope' => :'allowPowerFormsAdminToAccessAllPowerFormEnvelope',
    :'allow_power_forms_admin_to_access_all_power_form_envelope_metadata' => :'allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata',
    :'allow_recipient_language_selection' => :'allowRecipientLanguageSelection',
    :'allow_recipient_language_selection_metadata' => :'allowRecipientLanguageSelectionMetadata',
    :'allow_send_on_behalf_of' => :'allowSendOnBehalfOf',
    :'allow_send_on_behalf_of_metadata' => :'allowSendOnBehalfOfMetadata',
    :'allow_supplemental_documents' => :'allowSupplementalDocuments',
    :'allow_supplemental_documents_metadata' => :'allowSupplementalDocumentsMetadata',
    :'allow_transactions' => :'allowTransactions',
    :'allow_transactions_metadata' => :'allowTransactionsMetadata',
    :'anchor_tag_versioned_placement_enabled' => :'anchorTagVersionedPlacementEnabled',
    :'api_account_wide_access' => :'apiAccountWideAccess',
    :'api_account_wide_access_metadata' => :'apiAccountWideAccessMetadata',
    :'api_can_export_ac' => :'apiCanExportAC',
    :'api_can_export_ac_metadata' => :'apiCanExportACMetadata',
    :'bulk_send' => :'bulkSend',
    :'bulk_send_metadata' => :'bulkSendMetadata',
    :'can_bulk_upload_agreements' => :'canBulkUploadAgreements',
    :'can_bulk_upload_agreements_metadata' => :'canBulkUploadAgreementsMetadata',
    :'can_charge_account' => :'canChargeAccount',
    :'can_charge_account_metadata' => :'canChargeAccountMetadata',
    :'can_create_transaction' => :'canCreateTransaction',
    :'can_create_transaction_metadata' => :'canCreateTransactionMetadata',
    :'can_delete_documents_in_transaction' => :'canDeleteDocumentsInTransaction',
    :'can_delete_documents_in_transaction_metadata' => :'canDeleteDocumentsInTransactionMetadata',
    :'can_delete_transaction' => :'canDeleteTransaction',
    :'can_delete_transaction_metadata' => :'canDeleteTransactionMetadata',
    :'can_edit_shared_addressbook' => :'canEditSharedAddressbook',
    :'can_edit_shared_addressbook_metadata' => :'canEditSharedAddressbookMetadata',
    :'can_lock_envelopes' => :'canLockEnvelopes',
    :'can_lock_envelopes_metadata' => :'canLockEnvelopesMetadata',
    :'can_manage_account' => :'canManageAccount',
    :'can_manage_account_metadata' => :'canManageAccountMetadata',
    :'can_manage_agreement_parties' => :'canManageAgreementParties',
    :'can_manage_agreement_parties_metadata' => :'canManageAgreementPartiesMetadata',
    :'can_manage_distributor' => :'canManageDistributor',
    :'can_manage_distributor_metadata' => :'canManageDistributorMetadata',
    :'can_manage_templates' => :'canManageTemplates',
    :'can_manage_templates_metadata' => :'canManageTemplatesMetadata',
    :'can_send_api_requests' => :'canSendAPIRequests',
    :'can_send_api_requests_metadata' => :'canSendAPIRequestsMetadata',
    :'can_send_envelope' => :'canSendEnvelope',
    :'can_send_envelope_metadata' => :'canSendEnvelopeMetadata',
    :'can_send_envelopes_via_sms' => :'canSendEnvelopesViaSMS',
    :'can_send_envelopes_via_sms_metadata' => :'canSendEnvelopesViaSMSMetadata',
    :'can_sign_envelope' => :'canSignEnvelope',
    :'can_sign_envelope_metadata' => :'canSignEnvelopeMetadata',
    :'can_use_scratchpad' => :'canUseScratchpad',
    :'can_use_scratchpad_metadata' => :'canUseScratchpadMetadata',
    :'can_use_smart_contracts' => :'canUseSmartContracts',
    :'can_use_smart_contracts_metadata' => :'canUseSmartContractsMetadata',
    :'disable_document_upload' => :'disableDocumentUpload',
    :'disable_document_upload_metadata' => :'disableDocumentUploadMetadata',
    :'disable_other_actions' => :'disableOtherActions',
    :'disable_other_actions_metadata' => :'disableOtherActionsMetadata',
    :'enable_ds_pro' => :'enableDSPro',
    :'enable_ds_pro_metadata' => :'enableDSProMetadata',
    :'enable_key_terms_suggestions_by_document_type' => :'enableKeyTermsSuggestionsByDocumentType',
    :'enable_key_terms_suggestions_by_document_type_metadata' => :'enableKeyTermsSuggestionsByDocumentTypeMetadata',
    :'enable_sequential_signing_api' => :'enableSequentialSigningAPI',
    :'enable_sequential_signing_api_metadata' => :'enableSequentialSigningAPIMetadata',
    :'enable_sequential_signing_ui' => :'enableSequentialSigningUI',
    :'enable_sequential_signing_ui_metadata' => :'enableSequentialSigningUIMetadata',
    :'enable_signer_attachments' => :'enableSignerAttachments',
    :'enable_signer_attachments_metadata' => :'enableSignerAttachmentsMetadata',
    :'enable_sign_on_paper_override' => :'enableSignOnPaperOverride',
    :'enable_sign_on_paper_override_metadata' => :'enableSignOnPaperOverrideMetadata',
    :'enable_transaction_point' => :'enableTransactionPoint',
    :'enable_transaction_point_metadata' => :'enableTransactionPointMetadata',
    :'enable_vaulting' => :'enableVaulting',
    :'enable_vaulting_metadata' => :'enableVaultingMetadata',
    :'express_send_only' => :'expressSendOnly',
    :'locale' => :'locale',
    :'locale_metadata' => :'localeMetadata',
    :'locale_policy' => :'localePolicy',
    :'manage_clickwraps_mode' => :'manageClickwrapsMode',
    :'manage_clickwraps_mode_metadata' => :'manageClickwrapsModeMetadata',
    :'modified_by' => :'modifiedBy',
    :'modified_by_metadata' => :'modifiedByMetadata',
    :'modified_date' => :'modifiedDate',
    :'modified_date_metadata' => :'modifiedDateMetadata',
    :'modified_page' => :'modifiedPage',
    :'modified_page_metadata' => :'modifiedPageMetadata',
    :'new_send_ui' => :'newSendUI',
    :'new_send_ui_metadata' => :'newSendUIMetadata',
    :'power_form_mode' => :'powerFormMode',
    :'power_form_mode_metadata' => :'powerFormModeMetadata',
    :'recipient_viewed_notification' => :'recipientViewedNotification',
    :'recipient_viewed_notification_metadata' => :'recipientViewedNotificationMetadata',
    :'seal_identifiers' => :'sealIdentifiers',
    :'self_signed_recipient_email_document' => :'selfSignedRecipientEmailDocument',
    :'self_signed_recipient_email_document_metadata' => :'selfSignedRecipientEmailDocumentMetadata',
    :'sender_email_notifications' => :'senderEmailNotifications',
    :'signer_email_notifications' => :'signerEmailNotifications',
    :'supplemental_document_include_in_download' => :'supplementalDocumentIncludeInDownload',
    :'supplemental_documents_must_accept' => :'supplementalDocumentsMustAccept',
    :'supplemental_documents_must_accept_metadata' => :'supplementalDocumentsMustAcceptMetadata',
    :'supplemental_documents_must_read' => :'supplementalDocumentsMustRead',
    :'supplemental_documents_must_read_metadata' => :'supplementalDocumentsMustReadMetadata',
    :'supplemental_documents_must_view' => :'supplementalDocumentsMustView',
    :'supplemental_documents_must_view_metadata' => :'supplementalDocumentsMustViewMetadata',
    :'template_active_creation' => :'templateActiveCreation',
    :'template_active_creation_metadata' => :'templateActiveCreationMetadata',
    :'template_apply_notify' => :'templateApplyNotify',
    :'template_apply_notify_metadata' => :'templateApplyNotifyMetadata',
    :'template_auto_matching' => :'templateAutoMatching',
    :'template_auto_matching_metadata' => :'templateAutoMatchingMetadata',
    :'template_matching_sensitivity' => :'templateMatchingSensitivity',
    :'template_matching_sensitivity_metadata' => :'templateMatchingSensitivityMetadata',
    :'template_page_level_matching' => :'templatePageLevelMatching',
    :'template_page_level_matching_metadata' => :'templatePageLevelMatchingMetadata',
    :'timezone_dst' => :'timezoneDST',
    :'timezone_dst_metadata' => :'timezoneDSTMetadata',
    :'timezone_mask' => :'timezoneMask',
    :'timezone_mask_metadata' => :'timezoneMaskMetadata',
    :'timezone_offset' => :'timezoneOffset',
    :'timezone_offset_metadata' => :'timezoneOffsetMetadata',
    :'timezone_sending_pref' => :'timezoneSendingPref',
    :'timezone_sending_pref_metadata' => :'timezoneSendingPrefMetadata',
    :'timezone_signing_pref' => :'timezoneSigningPref',
    :'timezone_signing_pref_metadata' => :'timezoneSigningPrefMetadata',
    :'transaction_point_site_name_url' => :'transactionPointSiteNameURL',
    :'transaction_point_site_name_url_metadata' => :'transactionPointSiteNameURLMetadata',
    :'transaction_point_user_name' => :'transactionPointUserName',
    :'transaction_point_user_name_metadata' => :'transactionPointUserNameMetadata',
    :'vaulting_mode' => :'vaultingMode',
    :'vaulting_mode_metadata' => :'vaultingModeMetadata',
    :'web_forms' => :'webForms',
    :'web_forms_metadata' => :'webFormsMetadata'
  }
end

.swagger_typesObject

Attribute type mapping.



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
# File 'lib/docusign_esign/models/user_settings_information.rb', line 596

def self.swagger_types
  {
    :'account_agreements_access_type' => :'String',
    :'account_agreements_access_type_metadata' => :'SettingsMetadata',
    :'account_management_granular' => :'UserAccountManagementGranularInformation',
    :'admin_only' => :'String',
    :'admin_only_metadata' => :'SettingsMetadata',
    :'allow_access_to_all_account_agreements' => :'String',
    :'allow_access_to_all_account_agreements_metadata' => :'SettingsMetadata',
    :'allow_auto_tagging' => :'String',
    :'allowed_orchestration_access' => :'String',
    :'allowed_orchestration_access_metadata' => :'SettingsMetadata',
    :'allow_envelope_transfer_to' => :'String',
    :'allow_envelope_transfer_to_metadata' => :'SettingsMetadata',
    :'allow_eseal_recipients' => :'String',
    :'allow_eseal_recipients_metadata' => :'SettingsMetadata',
    :'allow_power_forms_admin_to_access_all_power_form_envelope' => :'String',
    :'allow_power_forms_admin_to_access_all_power_form_envelope_metadata' => :'SettingsMetadata',
    :'allow_recipient_language_selection' => :'String',
    :'allow_recipient_language_selection_metadata' => :'SettingsMetadata',
    :'allow_send_on_behalf_of' => :'String',
    :'allow_send_on_behalf_of_metadata' => :'SettingsMetadata',
    :'allow_supplemental_documents' => :'String',
    :'allow_supplemental_documents_metadata' => :'SettingsMetadata',
    :'allow_transactions' => :'String',
    :'allow_transactions_metadata' => :'SettingsMetadata',
    :'anchor_tag_versioned_placement_enabled' => :'String',
    :'api_account_wide_access' => :'String',
    :'api_account_wide_access_metadata' => :'SettingsMetadata',
    :'api_can_export_ac' => :'String',
    :'api_can_export_ac_metadata' => :'SettingsMetadata',
    :'bulk_send' => :'String',
    :'bulk_send_metadata' => :'SettingsMetadata',
    :'can_bulk_upload_agreements' => :'String',
    :'can_bulk_upload_agreements_metadata' => :'SettingsMetadata',
    :'can_charge_account' => :'String',
    :'can_charge_account_metadata' => :'SettingsMetadata',
    :'can_create_transaction' => :'String',
    :'can_create_transaction_metadata' => :'SettingsMetadata',
    :'can_delete_documents_in_transaction' => :'String',
    :'can_delete_documents_in_transaction_metadata' => :'SettingsMetadata',
    :'can_delete_transaction' => :'String',
    :'can_delete_transaction_metadata' => :'SettingsMetadata',
    :'can_edit_shared_addressbook' => :'String',
    :'can_edit_shared_addressbook_metadata' => :'SettingsMetadata',
    :'can_lock_envelopes' => :'String',
    :'can_lock_envelopes_metadata' => :'SettingsMetadata',
    :'can_manage_account' => :'String',
    :'can_manage_account_metadata' => :'SettingsMetadata',
    :'can_manage_agreement_parties' => :'String',
    :'can_manage_agreement_parties_metadata' => :'SettingsMetadata',
    :'can_manage_distributor' => :'String',
    :'can_manage_distributor_metadata' => :'SettingsMetadata',
    :'can_manage_templates' => :'String',
    :'can_manage_templates_metadata' => :'SettingsMetadata',
    :'can_send_api_requests' => :'String',
    :'can_send_api_requests_metadata' => :'SettingsMetadata',
    :'can_send_envelope' => :'String',
    :'can_send_envelope_metadata' => :'SettingsMetadata',
    :'can_send_envelopes_via_sms' => :'String',
    :'can_send_envelopes_via_sms_metadata' => :'SettingsMetadata',
    :'can_sign_envelope' => :'String',
    :'can_sign_envelope_metadata' => :'SettingsMetadata',
    :'can_use_scratchpad' => :'String',
    :'can_use_scratchpad_metadata' => :'SettingsMetadata',
    :'can_use_smart_contracts' => :'String',
    :'can_use_smart_contracts_metadata' => :'SettingsMetadata',
    :'disable_document_upload' => :'String',
    :'disable_document_upload_metadata' => :'SettingsMetadata',
    :'disable_other_actions' => :'String',
    :'disable_other_actions_metadata' => :'SettingsMetadata',
    :'enable_ds_pro' => :'String',
    :'enable_ds_pro_metadata' => :'SettingsMetadata',
    :'enable_key_terms_suggestions_by_document_type' => :'String',
    :'enable_key_terms_suggestions_by_document_type_metadata' => :'SettingsMetadata',
    :'enable_sequential_signing_api' => :'String',
    :'enable_sequential_signing_api_metadata' => :'SettingsMetadata',
    :'enable_sequential_signing_ui' => :'String',
    :'enable_sequential_signing_ui_metadata' => :'SettingsMetadata',
    :'enable_signer_attachments' => :'String',
    :'enable_signer_attachments_metadata' => :'SettingsMetadata',
    :'enable_sign_on_paper_override' => :'String',
    :'enable_sign_on_paper_override_metadata' => :'SettingsMetadata',
    :'enable_transaction_point' => :'String',
    :'enable_transaction_point_metadata' => :'SettingsMetadata',
    :'enable_vaulting' => :'String',
    :'enable_vaulting_metadata' => :'SettingsMetadata',
    :'express_send_only' => :'String',
    :'locale' => :'String',
    :'locale_metadata' => :'SettingsMetadata',
    :'locale_policy' => :'LocalePolicy',
    :'manage_clickwraps_mode' => :'String',
    :'manage_clickwraps_mode_metadata' => :'SettingsMetadata',
    :'modified_by' => :'String',
    :'modified_by_metadata' => :'SettingsMetadata',
    :'modified_date' => :'String',
    :'modified_date_metadata' => :'SettingsMetadata',
    :'modified_page' => :'String',
    :'modified_page_metadata' => :'SettingsMetadata',
    :'new_send_ui' => :'String',
    :'new_send_ui_metadata' => :'SettingsMetadata',
    :'power_form_mode' => :'String',
    :'power_form_mode_metadata' => :'SettingsMetadata',
    :'recipient_viewed_notification' => :'String',
    :'recipient_viewed_notification_metadata' => :'SettingsMetadata',
    :'seal_identifiers' => :'Array<SealIdentifier>',
    :'self_signed_recipient_email_document' => :'String',
    :'self_signed_recipient_email_document_metadata' => :'SettingsMetadata',
    :'sender_email_notifications' => :'SenderEmailNotifications',
    :'signer_email_notifications' => :'SignerEmailNotifications',
    :'supplemental_document_include_in_download' => :'String',
    :'supplemental_documents_must_accept' => :'String',
    :'supplemental_documents_must_accept_metadata' => :'SettingsMetadata',
    :'supplemental_documents_must_read' => :'String',
    :'supplemental_documents_must_read_metadata' => :'SettingsMetadata',
    :'supplemental_documents_must_view' => :'String',
    :'supplemental_documents_must_view_metadata' => :'SettingsMetadata',
    :'template_active_creation' => :'String',
    :'template_active_creation_metadata' => :'SettingsMetadata',
    :'template_apply_notify' => :'String',
    :'template_apply_notify_metadata' => :'SettingsMetadata',
    :'template_auto_matching' => :'String',
    :'template_auto_matching_metadata' => :'SettingsMetadata',
    :'template_matching_sensitivity' => :'String',
    :'template_matching_sensitivity_metadata' => :'SettingsMetadata',
    :'template_page_level_matching' => :'String',
    :'template_page_level_matching_metadata' => :'SettingsMetadata',
    :'timezone_dst' => :'String',
    :'timezone_dst_metadata' => :'SettingsMetadata',
    :'timezone_mask' => :'String',
    :'timezone_mask_metadata' => :'SettingsMetadata',
    :'timezone_offset' => :'String',
    :'timezone_offset_metadata' => :'SettingsMetadata',
    :'timezone_sending_pref' => :'String',
    :'timezone_sending_pref_metadata' => :'SettingsMetadata',
    :'timezone_signing_pref' => :'String',
    :'timezone_signing_pref_metadata' => :'SettingsMetadata',
    :'transaction_point_site_name_url' => :'String',
    :'transaction_point_site_name_url_metadata' => :'SettingsMetadata',
    :'transaction_point_user_name' => :'String',
    :'transaction_point_user_name_metadata' => :'SettingsMetadata',
    :'vaulting_mode' => :'String',
    :'vaulting_mode_metadata' => :'SettingsMetadata',
    :'web_forms' => :'String',
    :'web_forms_metadata' => :'SettingsMetadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
# File 'lib/docusign_esign/models/user_settings_information.rb', line 1342

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
       == o. &&
      admin_only == o.admin_only &&
       == o. &&
       == o. &&
       == o. &&
      allow_auto_tagging == o.allow_auto_tagging &&
      allowed_orchestration_access == o.allowed_orchestration_access &&
       == o. &&
      allow_envelope_transfer_to == o.allow_envelope_transfer_to &&
       == o. &&
      allow_eseal_recipients == o.allow_eseal_recipients &&
       == o. &&
      allow_power_forms_admin_to_access_all_power_form_envelope == o.allow_power_forms_admin_to_access_all_power_form_envelope &&
       == o. &&
      allow_recipient_language_selection == o.allow_recipient_language_selection &&
       == o. &&
      allow_send_on_behalf_of == o.allow_send_on_behalf_of &&
       == o. &&
      allow_supplemental_documents == o.allow_supplemental_documents &&
       == o. &&
      allow_transactions == o.allow_transactions &&
       == o. &&
      anchor_tag_versioned_placement_enabled == o.anchor_tag_versioned_placement_enabled &&
       == o. &&
       == o. &&
      api_can_export_ac == o.api_can_export_ac &&
       == o. &&
      bulk_send == o.bulk_send &&
       == o. &&
      can_bulk_upload_agreements == o.can_bulk_upload_agreements &&
       == o. &&
       == o. &&
       == o. &&
      can_create_transaction == o.can_create_transaction &&
       == o. &&
      can_delete_documents_in_transaction == o.can_delete_documents_in_transaction &&
       == o. &&
      can_delete_transaction == o.can_delete_transaction &&
       == o. &&
      can_edit_shared_addressbook == o.can_edit_shared_addressbook &&
       == o. &&
      can_lock_envelopes == o.can_lock_envelopes &&
       == o. &&
       == o. &&
       == o. &&
      can_manage_agreement_parties == o.can_manage_agreement_parties &&
       == o. &&
      can_manage_distributor == o.can_manage_distributor &&
       == o. &&
      can_manage_templates == o.can_manage_templates &&
       == o. &&
      can_send_api_requests == o.can_send_api_requests &&
       == o. &&
      can_send_envelope == o.can_send_envelope &&
       == o. &&
      can_send_envelopes_via_sms == o.can_send_envelopes_via_sms &&
       == o. &&
      can_sign_envelope == o.can_sign_envelope &&
       == o. &&
      can_use_scratchpad == o.can_use_scratchpad &&
       == o. &&
      can_use_smart_contracts == o.can_use_smart_contracts &&
       == o. &&
      disable_document_upload == o.disable_document_upload &&
       == o. &&
      disable_other_actions == o.disable_other_actions &&
       == o. &&
      enable_ds_pro == o.enable_ds_pro &&
       == o. &&
      enable_key_terms_suggestions_by_document_type == o.enable_key_terms_suggestions_by_document_type &&
       == o. &&
      enable_sequential_signing_api == o.enable_sequential_signing_api &&
       == o. &&
      enable_sequential_signing_ui == o.enable_sequential_signing_ui &&
       == o. &&
      enable_signer_attachments == o.enable_signer_attachments &&
       == o. &&
      enable_sign_on_paper_override == o.enable_sign_on_paper_override &&
       == o. &&
      enable_transaction_point == o.enable_transaction_point &&
       == o. &&
      enable_vaulting == o.enable_vaulting &&
       == o. &&
      express_send_only == o.express_send_only &&
      locale == o.locale &&
       == o. &&
      locale_policy == o.locale_policy &&
      manage_clickwraps_mode == o.manage_clickwraps_mode &&
       == o. &&
      modified_by == o.modified_by &&
       == o. &&
      modified_date == o.modified_date &&
       == o. &&
      modified_page == o.modified_page &&
       == o. &&
      new_send_ui == o.new_send_ui &&
       == o. &&
      power_form_mode == o.power_form_mode &&
       == o. &&
      recipient_viewed_notification == o.recipient_viewed_notification &&
       == o. &&
      seal_identifiers == o.seal_identifiers &&
      self_signed_recipient_email_document == o.self_signed_recipient_email_document &&
       == o. &&
      sender_email_notifications == o.sender_email_notifications &&
      signer_email_notifications == o.signer_email_notifications &&
      supplemental_document_include_in_download == o.supplemental_document_include_in_download &&
      supplemental_documents_must_accept == o.supplemental_documents_must_accept &&
       == o. &&
      supplemental_documents_must_read == o.supplemental_documents_must_read &&
       == o. &&
      supplemental_documents_must_view == o.supplemental_documents_must_view &&
       == o. &&
      template_active_creation == o.template_active_creation &&
       == o. &&
      template_apply_notify == o.template_apply_notify &&
       == o. &&
      template_auto_matching == o.template_auto_matching &&
       == o. &&
      template_matching_sensitivity == o.template_matching_sensitivity &&
       == o. &&
      template_page_level_matching == o.template_page_level_matching &&
       == o. &&
      timezone_dst == o.timezone_dst &&
       == o. &&
      timezone_mask == o.timezone_mask &&
       == o. &&
      timezone_offset == o.timezone_offset &&
       == o. &&
      timezone_sending_pref == o.timezone_sending_pref &&
       == o. &&
      timezone_signing_pref == o.timezone_signing_pref &&
       == o. &&
      transaction_point_site_name_url == o.transaction_point_site_name_url &&
       == o. &&
      transaction_point_user_name == o.transaction_point_user_name &&
       == o. &&
      vaulting_mode == o.vaulting_mode &&
       == o. &&
      web_forms == o.web_forms &&
       == o.
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
# File 'lib/docusign_esign/models/user_settings_information.rb', line 1526

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = DocuSign_eSign.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
# File 'lib/docusign_esign/models/user_settings_information.rb', line 1592

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
# File 'lib/docusign_esign/models/user_settings_information.rb', line 1505

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


1492
1493
1494
# File 'lib/docusign_esign/models/user_settings_information.rb', line 1492

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



1498
1499
1500
# File 'lib/docusign_esign/models/user_settings_information.rb', line 1498

def hash
  [, , , admin_only, , , , allow_auto_tagging, allowed_orchestration_access, , allow_envelope_transfer_to, , allow_eseal_recipients, , allow_power_forms_admin_to_access_all_power_form_envelope, , allow_recipient_language_selection, , allow_send_on_behalf_of, , allow_supplemental_documents, , allow_transactions, , anchor_tag_versioned_placement_enabled, , , api_can_export_ac, , bulk_send, , can_bulk_upload_agreements, , , , can_create_transaction, , can_delete_documents_in_transaction, , can_delete_transaction, , can_edit_shared_addressbook, , can_lock_envelopes, , , , can_manage_agreement_parties, , can_manage_distributor, , can_manage_templates, , can_send_api_requests, , can_send_envelope, , can_send_envelopes_via_sms, , can_sign_envelope, , can_use_scratchpad, , can_use_smart_contracts, , disable_document_upload, , disable_other_actions, , enable_ds_pro, , enable_key_terms_suggestions_by_document_type, , enable_sequential_signing_api, , enable_sequential_signing_ui, , enable_signer_attachments, , enable_sign_on_paper_override, , enable_transaction_point, , enable_vaulting, , express_send_only, locale, , locale_policy, manage_clickwraps_mode, , modified_by, , modified_date, , modified_page, , new_send_ui, , power_form_mode, , recipient_viewed_notification, , seal_identifiers, self_signed_recipient_email_document, , sender_email_notifications, signer_email_notifications, supplemental_document_include_in_download, supplemental_documents_must_accept, , supplemental_documents_must_read, , supplemental_documents_must_view, , template_active_creation, , template_apply_notify, , template_auto_matching, , template_matching_sensitivity, , template_page_level_matching, , timezone_dst, , timezone_mask, , timezone_offset, , timezone_sending_pref, , timezone_signing_pref, , transaction_point_site_name_url, , transaction_point_user_name, , vaulting_mode, , web_forms, ].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



1329
1330
1331
1332
# File 'lib/docusign_esign/models/user_settings_information.rb', line 1329

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



1572
1573
1574
# File 'lib/docusign_esign/models/user_settings_information.rb', line 1572

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



1578
1579
1580
1581
1582
1583
1584
1585
1586
# File 'lib/docusign_esign/models/user_settings_information.rb', line 1578

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



1566
1567
1568
# File 'lib/docusign_esign/models/user_settings_information.rb', line 1566

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



1336
1337
1338
# File 'lib/docusign_esign/models/user_settings_information.rb', line 1336

def valid?
  true
end