docusign_esign 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/README.md +18 -66
- data/docusign_esign-1.0.0.gem +0 -0
- data/docusign_esign.gemspec +2 -2
- data/lib/docusign_esign/version.rb +1 -1
- data/tests/Gemfile.lock +13 -9
- data/tests/keys/docusign_private_key.txt.enc +0 -0
- data/tests/rsa_keys/private.pem +25 -25
- data/tests/spec/unit_tests_spec.rb +8 -8
- data/tests/spec/unit_tests_using_jwt_spec.rb +9 -10
- metadata +11 -331
- data/docs/AccountAddress.md +0 -19
- data/docs/AccountBillingPlan.md +0 -27
- data/docs/AccountBillingPlanResponse.md +0 -13
- data/docs/AccountInformation.md +0 -38
- data/docs/AccountRoleSettings.md +0 -71
- data/docs/AccountSettingsInformation.md +0 -8
- data/docs/AccountSharedAccess.md +0 -16
- data/docs/AccountSignatureProvider.md +0 -14
- data/docs/AccountSignatureProviderOption.md +0 -10
- data/docs/AccountSignatureProviders.md +0 -8
- data/docs/AccountsApi.md +0 -1997
- data/docs/AddOn.md +0 -11
- data/docs/AddressInformation.md +0 -15
- data/docs/AddressInformationInput.md +0 -10
- data/docs/AddressInformationV2.md +0 -15
- data/docs/Agent.md +0 -49
- data/docs/ApiRequestLog.md +0 -11
- data/docs/ApiRequestLogsResult.md +0 -8
- data/docs/AppStoreProduct.md +0 -9
- data/docs/AppStoreReceipt.md +0 -9
- data/docs/Approve.md +0 -40
- data/docs/Attachment.md +0 -14
- data/docs/AuthenticationApi.md +0 -356
- data/docs/AuthenticationMethod.md +0 -11
- data/docs/AuthenticationStatus.md +0 -24
- data/docs/BccEmailAddress.md +0 -9
- data/docs/BillingApi.md +0 -569
- data/docs/BillingCharge.md +0 -20
- data/docs/BillingChargeResponse.md +0 -8
- data/docs/BillingDiscount.md +0 -10
- data/docs/BillingInvoice.md +0 -17
- data/docs/BillingInvoiceItem.md +0 -12
- data/docs/BillingInvoicesResponse.md +0 -10
- data/docs/BillingInvoicesSummary.md +0 -10
- data/docs/BillingPayment.md +0 -10
- data/docs/BillingPaymentItem.md +0 -12
- data/docs/BillingPaymentRequest.md +0 -8
- data/docs/BillingPaymentResponse.md +0 -8
- data/docs/BillingPaymentsResponse.md +0 -10
- data/docs/BillingPlan.md +0 -22
- data/docs/BillingPlanInformation.md +0 -22
- data/docs/BillingPlanPreview.md +0 -13
- data/docs/BillingPlanResponse.md +0 -9
- data/docs/BillingPlanUpdateResponse.md +0 -14
- data/docs/BillingPlansResponse.md +0 -8
- data/docs/BillingPrice.md +0 -10
- data/docs/Brand.md +0 -20
- data/docs/BrandEmailContent.md +0 -11
- data/docs/BrandLink.md +0 -11
- data/docs/BrandLogos.md +0 -10
- data/docs/BrandRequest.md +0 -8
- data/docs/BrandResourceUrls.md +0 -11
- data/docs/BrandResources.md +0 -14
- data/docs/BrandResourcesList.md +0 -8
- data/docs/BrandsRequest.md +0 -8
- data/docs/BrandsResponse.md +0 -10
- data/docs/BulkEnvelope.md +0 -16
- data/docs/BulkEnvelopeStatus.md +0 -21
- data/docs/BulkEnvelopesApi.md +0 -295
- data/docs/BulkEnvelopesResponse.md +0 -14
- data/docs/BulkRecipient.md +0 -17
- data/docs/BulkRecipientSignatureProvider.md +0 -9
- data/docs/BulkRecipientTabLabel.md +0 -9
- data/docs/BulkRecipientsRequest.md +0 -8
- data/docs/BulkRecipientsResponse.md +0 -14
- data/docs/BulkRecipientsSummaryResponse.md +0 -11
- data/docs/BulkRecipientsUpdateResponse.md +0 -8
- data/docs/CaptiveRecipient.md +0 -11
- data/docs/CaptiveRecipientInformation.md +0 -8
- data/docs/CarbonCopy.md +0 -49
- data/docs/CertifiedDelivery.md +0 -49
- data/docs/Checkbox.md +0 -37
- data/docs/ChunkedUploadPart.md +0 -9
- data/docs/ChunkedUploadRequest.md +0 -9
- data/docs/ChunkedUploadResponse.md +0 -14
- data/docs/CloudStorageApi.md +0 -424
- data/docs/CloudStorageProvider.md +0 -12
- data/docs/CloudStorageProviders.md +0 -8
- data/docs/Company.md +0 -46
- data/docs/CompositeTemplate.md +0 -12
- data/docs/ConnectApi.md +0 -891
- data/docs/ConnectConfigResults.md +0 -9
- data/docs/ConnectCustomConfiguration.md +0 -28
- data/docs/ConnectDebugLog.md +0 -12
- data/docs/ConnectFailureFilter.md +0 -9
- data/docs/ConnectFailureResult.md +0 -12
- data/docs/ConnectFailureResults.md +0 -8
- data/docs/ConnectLog.md +0 -25
- data/docs/ConnectLogs.md +0 -11
- data/docs/ConsoleViewRequest.md +0 -9
- data/docs/ConsumerDisclosure.md +0 -37
- data/docs/Contact.md +0 -16
- data/docs/ContactGetResponse.md +0 -14
- data/docs/ContactModRequest.md +0 -8
- data/docs/ContactUpdateResponse.md +0 -8
- data/docs/CorrectViewRequest.md +0 -9
- data/docs/Country.md +0 -11
- data/docs/CreditCardInformation.md +0 -13
- data/docs/CreditCardTypes.md +0 -8
- data/docs/CurrencyFeatureSetPrice.md +0 -12
- data/docs/CurrencyPlanPrice.md +0 -13
- data/docs/CustomFieldV2.md +0 -14
- data/docs/CustomFields.md +0 -9
- data/docs/CustomFieldsEnvelope.md +0 -9
- data/docs/CustomSettingsInformation.md +0 -8
- data/docs/CustomTabsApi.md +0 -268
- data/docs/Date.md +0 -52
- data/docs/DateSigned.md +0 -39
- data/docs/Decline.md +0 -41
- data/docs/DiagnosticsApi.md +0 -321
- data/docs/DiagnosticsSettingsInformation.md +0 -10
- data/docs/DobInformationInput.md +0 -10
- data/docs/Document.md +0 -27
- data/docs/DocumentFieldsInformation.md +0 -8
- data/docs/DocumentTemplate.md +0 -12
- data/docs/DocumentTemplateList.md +0 -8
- data/docs/DocumentVisibility.md +0 -12
- data/docs/DocumentVisibilityList.md +0 -8
- data/docs/ENoteConfiguration.md +0 -12
- data/docs/Editor.md +0 -48
- data/docs/Email.md +0 -52
- data/docs/EmailAddress.md +0 -38
- data/docs/EmailSettings.md +0 -10
- data/docs/Envelope.md +0 -54
- data/docs/EnvelopeAttachment.md +0 -13
- data/docs/EnvelopeAttachmentsRequest.md +0 -8
- data/docs/EnvelopeAttachmentsResult.md +0 -8
- data/docs/EnvelopeAuditEvent.md +0 -8
- data/docs/EnvelopeAuditEventResponse.md +0 -8
- data/docs/EnvelopeDefinition.md +0 -63
- data/docs/EnvelopeDocument.md +0 -24
- data/docs/EnvelopeDocumentsResult.md +0 -9
- data/docs/EnvelopeEvent.md +0 -9
- data/docs/EnvelopeFormData.md +0 -13
- data/docs/EnvelopeId.md +0 -38
- data/docs/EnvelopeIdsRequest.md +0 -9
- data/docs/EnvelopeNotificationRequest.md +0 -10
- data/docs/EnvelopeSummary.md +0 -11
- data/docs/EnvelopeTemplate.md +0 -56
- data/docs/EnvelopeTemplateDefinition.md +0 -22
- data/docs/EnvelopeTemplateResult.md +0 -68
- data/docs/EnvelopeTemplateResults.md +0 -15
- data/docs/EnvelopeTransactionStatus.md +0 -11
- data/docs/EnvelopeUpdateSummary.md +0 -15
- data/docs/EnvelopesApi.md +0 -4306
- data/docs/EnvelopesInformation.md +0 -15
- data/docs/ErrorDetails.md +0 -9
- data/docs/EventNotification.md +0 -22
- data/docs/EventResult.md +0 -11
- data/docs/Expirations.md +0 -10
- data/docs/ExternalDocServiceErrorDetails.md +0 -10
- data/docs/ExternalFile.md +0 -15
- data/docs/ExternalFolder.md +0 -17
- data/docs/FeatureSet.md +0 -16
- data/docs/FileType.md +0 -9
- data/docs/FileTypeList.md +0 -8
- data/docs/Filter.md +0 -18
- data/docs/FirstName.md +0 -38
- data/docs/Folder.md +0 -19
- data/docs/FolderItem.md +0 -28
- data/docs/FolderItemResponse.md +0 -14
- data/docs/FolderItemV2.md +0 -27
- data/docs/FolderItemsResponse.md +0 -14
- data/docs/FoldersApi.md +0 -261
- data/docs/FoldersRequest.md +0 -9
- data/docs/FoldersResponse.md +0 -8
- data/docs/ForgottenPasswordInformation.md +0 -15
- data/docs/FormulaTab.md +0 -56
- data/docs/FullName.md +0 -38
- data/docs/Group.md +0 -13
- data/docs/GroupInformation.md +0 -14
- data/docs/GroupsApi.md +0 -552
- data/docs/IdCheckInformationInput.md +0 -11
- data/docs/InPersonSigner.md +0 -62
- data/docs/InitialHere.md +0 -34
- data/docs/InlineTemplate.md +0 -12
- data/docs/IntegratedUserInfoList.md +0 -15
- data/docs/Intermediary.md +0 -49
- data/docs/LastName.md +0 -38
- data/docs/List.md +0 -46
- data/docs/ListCustomField.md +0 -15
- data/docs/ListItem.md +0 -10
- data/docs/LockInformation.md +0 -15
- data/docs/LockRequest.md +0 -12
- data/docs/LoginAccount.md +0 -18
- data/docs/LoginInformation.md +0 -9
- data/docs/MatchBox.md +0 -12
- data/docs/MemberGroupSharedItem.md +0 -10
- data/docs/MemberSharedItems.md +0 -11
- data/docs/MergeField.md +0 -12
- data/docs/MobileNotifierConfiguration.md +0 -10
- data/docs/MobileNotifierConfigurationInformation.md +0 -8
- data/docs/Money.md +0 -10
- data/docs/NameValue.md +0 -11
- data/docs/NewAccountDefinition.md +0 -17
- data/docs/NewAccountSummary.md +0 -14
- data/docs/NewUser.md +0 -17
- data/docs/NewUsersDefinition.md +0 -8
- data/docs/NewUsersSummary.md +0 -8
- data/docs/NotaryHost.md +0 -47
- data/docs/Note.md +0 -42
- data/docs/Notification.md +0 -10
- data/docs/Number.md +0 -54
- data/docs/OauthAccess.md +0 -13
- data/docs/OfflineAttributes.md +0 -13
- data/docs/Page.md +0 -15
- data/docs/PageImages.md +0 -14
- data/docs/PageRequest.md +0 -9
- data/docs/PaymentDetails.md +0 -12
- data/docs/PaymentLineItem.md +0 -11
- data/docs/PermissionProfile.md +0 -14
- data/docs/PermissionProfileInformation.md +0 -8
- data/docs/PlanInformation.md +0 -13
- data/docs/PostTransactionsRequest.md +0 -11
- data/docs/PostTransactionsResponse.md +0 -9
- data/docs/PowerForm.md +0 -31
- data/docs/PowerFormFormDataEnvelope.md +0 -9
- data/docs/PowerFormFormDataRecipient.md +0 -11
- data/docs/PowerFormRecipient.md +0 -20
- data/docs/PowerFormSendersResponse.md +0 -14
- data/docs/PowerFormsApi.md +0 -419
- data/docs/PowerFormsFormDataResponse.md +0 -8
- data/docs/PowerFormsRequest.md +0 -8
- data/docs/PowerFormsResponse.md +0 -14
- data/docs/PropertyMetadata.md +0 -9
- data/docs/Province.md +0 -9
- data/docs/ProvisioningInformation.md +0 -14
- data/docs/PurchasedEnvelopesInformation.md +0 -16
- data/docs/Radio.md +0 -25
- data/docs/RadioGroup.md +0 -16
- data/docs/RecipientAttachment.md +0 -13
- data/docs/RecipientDomain.md +0 -11
- data/docs/RecipientEmailNotification.md +0 -10
- data/docs/RecipientEvent.md +0 -9
- data/docs/RecipientFormData.md +0 -15
- data/docs/RecipientNamesResponse.md +0 -10
- data/docs/RecipientPhoneAuthentication.md +0 -11
- data/docs/RecipientSAMLAuthentication.md +0 -8
- data/docs/RecipientSMSAuthentication.md +0 -8
- data/docs/RecipientSignatureInformation.md +0 -10
- data/docs/RecipientSignatureProvider.md +0 -9
- data/docs/RecipientSignatureProviderOptions.md +0 -11
- data/docs/RecipientUpdateResponse.md +0 -10
- data/docs/RecipientViewRequest.md +0 -21
- data/docs/Recipients.md +0 -17
- data/docs/RecipientsUpdateSummary.md +0 -8
- data/docs/ReferralInformation.md +0 -25
- data/docs/Reminders.md +0 -10
- data/docs/ResourceInformation.md +0 -8
- data/docs/ReturnUrlRequest.md +0 -8
- data/docs/SamlAssertionAttribute.md +0 -11
- data/docs/SeatDiscount.md +0 -10
- data/docs/SenderEmailNotifications.md +0 -14
- data/docs/ServerTemplate.md +0 -9
- data/docs/ServiceInformation.md +0 -13
- data/docs/ServiceVersion.md +0 -9
- data/docs/SettingsMetadata.md +0 -13
- data/docs/SharedItem.md +0 -10
- data/docs/SignHere.md +0 -34
- data/docs/SignatureProviderRequiredOption.md +0 -9
- data/docs/SignatureType.md +0 -9
- data/docs/Signer.md +0 -63
- data/docs/SignerAttachment.md +0 -34
- data/docs/SignerEmailNotifications.md +0 -21
- data/docs/SigningGroup.md +0 -17
- data/docs/SigningGroupInformation.md +0 -8
- data/docs/SigningGroupUser.md +0 -10
- data/docs/SigningGroupUsers.md +0 -8
- data/docs/SigningGroupsApi.md +0 -485
- data/docs/SocialAccountInformation.md +0 -12
- data/docs/SocialAuthentication.md +0 -8
- data/docs/Ssn.md +0 -52
- data/docs/Ssn4InformationInput.md +0 -10
- data/docs/Ssn9InformationInput.md +0 -9
- data/docs/TabAccountSettings.md +0 -45
- data/docs/TabMetadata.md +0 -46
- data/docs/TabMetadataList.md +0 -8
- data/docs/Tabs.md +0 -32
- data/docs/TemplateCustomFields.md +0 -9
- data/docs/TemplateDocumentVisibilityList.md +0 -8
- data/docs/TemplateDocumentsResult.md +0 -9
- data/docs/TemplateInformation.md +0 -8
- data/docs/TemplateMatch.md +0 -10
- data/docs/TemplateNotificationRequest.md +0 -11
- data/docs/TemplateRecipients.md +0 -17
- data/docs/TemplateRole.md +0 -19
- data/docs/TemplateSharedItem.md +0 -14
- data/docs/TemplateSummary.md +0 -14
- data/docs/TemplateTabs.md +0 -32
- data/docs/TemplateUpdateSummary.md +0 -15
- data/docs/TemplatesApi.md +0 -2349
- data/docs/Text.md +0 -55
- data/docs/TextCustomField.md +0 -14
- data/docs/Title.md +0 -46
- data/docs/UsageHistory.md +0 -11
- data/docs/UserAccountManagementGranularInformation.md +0 -15
- data/docs/UserInfo.md +0 -17
- data/docs/UserInfoList.md +0 -8
- data/docs/UserInformation.md +0 -41
- data/docs/UserInformationList.md +0 -14
- data/docs/UserPasswordInformation.md +0 -11
- data/docs/UserProfile.md +0 -19
- data/docs/UserSettingsInformation.md +0 -11
- data/docs/UserSharedItem.md +0 -10
- data/docs/UserSignature.md +0 -20
- data/docs/UserSignatureDefinition.md +0 -11
- data/docs/UserSignaturesInformation.md +0 -8
- data/docs/UserSocialIdResult.md +0 -9
- data/docs/UsersApi.md +0 -1566
- data/docs/UsersResponse.md +0 -14
- data/docs/View.md +0 -42
- data/docs/ViewLinkRequest.md +0 -9
- data/docs/ViewUrl.md +0 -8
- data/docs/Workspace.md +0 -18
- data/docs/WorkspaceFolderContents.md +0 -15
- data/docs/WorkspaceItem.md +0 -26
- data/docs/WorkspaceItemList.md +0 -8
- data/docs/WorkspaceList.md +0 -12
- data/docs/WorkspaceUser.md +0 -23
- data/docs/WorkspaceUserAuthorization.md +0 -18
- data/docs/WorkspacesApi.md +0 -630
- data/docs/Zip.md +0 -53
- data/tests/rsa_keys/public.pem +0 -9
data/docs/ServiceInformation.md
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::ServiceInformation
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**build_branch** | **String** | Reserved: TBD | [optional]
|
|
7
|
-
**build_branch_deployed_date_time** | **String** | Reserved: TBD | [optional]
|
|
8
|
-
**build_sha** | **String** | Reserved: TBD | [optional]
|
|
9
|
-
**build_version** | **String** | Reserved: TBD | [optional]
|
|
10
|
-
**linked_sites** | **Array<String>** | | [optional]
|
|
11
|
-
**service_versions** | [**Array<ServiceVersion>**](ServiceVersion.md) | | [optional]
|
|
12
|
-
|
|
13
|
-
|
data/docs/ServiceVersion.md
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::ServiceVersion
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**version** | **String** | The version of the rest API. | [optional]
|
|
7
|
-
**version_url** | **String** | | [optional]
|
|
8
|
-
|
|
9
|
-
|
data/docs/SettingsMetadata.md
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::SettingsMetadata
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**is21_cfr_part11** | **String** | When set to **true**, indicates that this module is enabled on the account. | [optional]
|
|
7
|
-
**options** | **Array<String>** | | [optional]
|
|
8
|
-
**rights** | **String** | | [optional]
|
|
9
|
-
**ui_hint** | **String** | | [optional]
|
|
10
|
-
**ui_order** | **String** | | [optional]
|
|
11
|
-
**ui_type** | **String** | | [optional]
|
|
12
|
-
|
|
13
|
-
|
data/docs/SharedItem.md
DELETED
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::SharedItem
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
|
7
|
-
**shared** | **String** | When set to **true**, this custom tab is shared. | [optional]
|
|
8
|
-
**user** | [**UserInfo**](UserInfo.md) | | [optional]
|
|
9
|
-
|
|
10
|
-
|
data/docs/SignHere.md
DELETED
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::SignHere
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**anchor_case_sensitive** | **String** | When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. | [optional]
|
|
7
|
-
**anchor_horizontal_alignment** | **String** | Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. | [optional]
|
|
8
|
-
**anchor_ignore_if_not_present** | **String** | When set to **true**, this tab is ignored if anchorString is not found in the document. | [optional]
|
|
9
|
-
**anchor_match_whole_word** | **String** | When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. | [optional]
|
|
10
|
-
**anchor_string** | **String** | Anchor text information for a radio button. | [optional]
|
|
11
|
-
**anchor_units** | **String** | Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. | [optional]
|
|
12
|
-
**anchor_x_offset** | **String** | Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. | [optional]
|
|
13
|
-
**anchor_y_offset** | **String** | Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. | [optional]
|
|
14
|
-
**conditional_parent_label** | **String** | For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. | [optional]
|
|
15
|
-
**conditional_parent_value** | **String** | For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. | [optional]
|
|
16
|
-
**custom_tab_id** | **String** | The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. | [optional]
|
|
17
|
-
**document_id** | **String** | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. | [optional]
|
|
18
|
-
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
|
19
|
-
**merge_field** | [**MergeField**](MergeField.md) | | [optional]
|
|
20
|
-
**name** | **String** | Specifies the tool tip text for the tab. | [optional]
|
|
21
|
-
**optional** | **String** | | [optional]
|
|
22
|
-
**page_number** | **String** | Specifies the page number on which the tab is located. | [optional]
|
|
23
|
-
**recipient_id** | **String** | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | [optional]
|
|
24
|
-
**scale_value** | [**Number**](Number.md) | | [optional]
|
|
25
|
-
**status** | **String** | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. | [optional]
|
|
26
|
-
**tab_id** | **String** | The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. | [optional]
|
|
27
|
-
**tab_label** | **String** | The label string associated with the tab. | [optional]
|
|
28
|
-
**tab_order** | **String** | | [optional]
|
|
29
|
-
**template_locked** | **String** | When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. | [optional]
|
|
30
|
-
**template_required** | **String** | When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. | [optional]
|
|
31
|
-
**x_position** | **String** | This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
|
|
32
|
-
**y_position** | **String** | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
|
|
33
|
-
|
|
34
|
-
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::SignatureProviderRequiredOption
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**required_signature_provider_option_ids** | **Array<String>** | | [optional]
|
|
7
|
-
**signer_type** | **String** | | [optional]
|
|
8
|
-
|
|
9
|
-
|
data/docs/SignatureType.md
DELETED
data/docs/Signer.md
DELETED
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::Signer
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**access_code** | **String** | If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account’s access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. | [optional]
|
|
7
|
-
**add_access_code_to_email** | **String** | This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. | [optional]
|
|
8
|
-
**auto_navigation** | **String** | | [optional]
|
|
9
|
-
**bulk_recipients_uri** | **String** | Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. | [optional]
|
|
10
|
-
**can_sign_offline** | **String** | When set to **true**, specifies that the signer can perform the signing ceremony offline. | [optional]
|
|
11
|
-
**client_user_id** | **String** | Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. | [optional]
|
|
12
|
-
**creation_reason** | **String** | | [optional]
|
|
13
|
-
**custom_fields** | **Array<String>** | An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. | [optional]
|
|
14
|
-
**declined_date_time** | **String** | The date and time the recipient declined the document. | [optional]
|
|
15
|
-
**declined_reason** | **String** | The reason the recipient declined the document. | [optional]
|
|
16
|
-
**default_recipient** | **String** | | [optional]
|
|
17
|
-
**delivered_date_time** | **String** | Reserved: For DocuSign use only. | [optional]
|
|
18
|
-
**delivery_method** | **String** | Reserved: For DocuSign use only. | [optional]
|
|
19
|
-
**document_visibility** | [**Array<DocumentVisibility>**](DocumentVisibility.md) | | [optional]
|
|
20
|
-
**email** | **String** | Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters. | [optional]
|
|
21
|
-
**email_notification** | [**RecipientEmailNotification**](RecipientEmailNotification.md) | | [optional]
|
|
22
|
-
**email_recipient_post_signing_url** | **String** | | [optional]
|
|
23
|
-
**embedded_recipient_start_url** | **String** | Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender’s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient’s identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` | [optional]
|
|
24
|
-
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
|
25
|
-
**excluded_documents** | **Array<String>** | Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. | [optional]
|
|
26
|
-
**fax_number** | **String** | Reserved: | [optional]
|
|
27
|
-
**id_check_configuration_name** | **String** | Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. | [optional]
|
|
28
|
-
**id_check_information_input** | [**IdCheckInformationInput**](IdCheckInformationInput.md) | | [optional]
|
|
29
|
-
**inherit_email_notification_configuration** | **String** | When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. | [optional]
|
|
30
|
-
**is_bulk_recipient** | **String** | When set to **true**, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. Note that when this is true the email and name for the recipient becomes bulk@recipient.com and \"Bulk Recipient\". These fields can not be changed for the bulk recipient. | [optional]
|
|
31
|
-
**name** | **String** | | [optional]
|
|
32
|
-
**note** | **String** | Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. | [optional]
|
|
33
|
-
**offline_attributes** | [**OfflineAttributes**](OfflineAttributes.md) | | [optional]
|
|
34
|
-
**phone_authentication** | [**RecipientPhoneAuthentication**](RecipientPhoneAuthentication.md) | | [optional]
|
|
35
|
-
**recipient_attachments** | [**Array<RecipientAttachment>**](RecipientAttachment.md) | Reserved: | [optional]
|
|
36
|
-
**recipient_authentication_status** | [**AuthenticationStatus**](AuthenticationStatus.md) | | [optional]
|
|
37
|
-
**recipient_id** | **String** | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | [optional]
|
|
38
|
-
**recipient_id_guid** | **String** | | [optional]
|
|
39
|
-
**recipient_signature_providers** | [**Array<RecipientSignatureProvider>**](RecipientSignatureProvider.md) | | [optional]
|
|
40
|
-
**recipient_supplies_tabs** | **String** | | [optional]
|
|
41
|
-
**require_id_lookup** | **String** | When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. | [optional]
|
|
42
|
-
**require_signer_certificate** | **String** | Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. The possible values are: * docusign_express – Requires a DocuSign Express certificate. * safe – Requires a SAFE-BioPharma certificate. * open_trust – Requires an OpenTrust certificate. **Important**: There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information. | [optional]
|
|
43
|
-
**require_sign_on_paper** | **String** | When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign. | [optional]
|
|
44
|
-
**role_name** | **String** | Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. | [optional]
|
|
45
|
-
**routing_order** | **String** | Specifies the routing order of the recipient in the envelope. | [optional]
|
|
46
|
-
**saml_authentication** | [**RecipientSAMLAuthentication**](RecipientSAMLAuthentication.md) | | [optional]
|
|
47
|
-
**sent_date_time** | **String** | The date and time the envelope was sent. | [optional]
|
|
48
|
-
**signature_info** | [**RecipientSignatureInformation**](RecipientSignatureInformation.md) | | [optional]
|
|
49
|
-
**signed_date_time** | **String** | Reserved: For DocuSign use only. | [optional]
|
|
50
|
-
**sign_in_each_location** | **String** | When set to **true**, specifies that the signer must sign in all locations. | [optional]
|
|
51
|
-
**signing_group_id** | **String** | When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). | [optional]
|
|
52
|
-
**signing_group_name** | **String** | The display name for the signing group. Maximum Length: 100 characters. | [optional]
|
|
53
|
-
**signing_group_users** | [**Array<UserInfo>**](UserInfo.md) | A complex type that contains information about users in the signing group. | [optional]
|
|
54
|
-
**sms_authentication** | [**RecipientSMSAuthentication**](RecipientSMSAuthentication.md) | | [optional]
|
|
55
|
-
**social_authentications** | [**Array<SocialAuthentication>**](SocialAuthentication.md) | Lists the social ID type that can be used for recipient authentication. | [optional]
|
|
56
|
-
**status** | **String** | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. | [optional]
|
|
57
|
-
**tabs** | [**Tabs**](Tabs.md) | | [optional]
|
|
58
|
-
**template_locked** | **String** | When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. | [optional]
|
|
59
|
-
**template_required** | **String** | When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. | [optional]
|
|
60
|
-
**total_tab_count** | **String** | | [optional]
|
|
61
|
-
**user_id** | **String** | | [optional]
|
|
62
|
-
|
|
63
|
-
|
data/docs/SignerAttachment.md
DELETED
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::SignerAttachment
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**anchor_case_sensitive** | **String** | When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. | [optional]
|
|
7
|
-
**anchor_horizontal_alignment** | **String** | Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. | [optional]
|
|
8
|
-
**anchor_ignore_if_not_present** | **String** | When set to **true**, this tab is ignored if anchorString is not found in the document. | [optional]
|
|
9
|
-
**anchor_match_whole_word** | **String** | When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. | [optional]
|
|
10
|
-
**anchor_string** | **String** | Anchor text information for a radio button. | [optional]
|
|
11
|
-
**anchor_units** | **String** | Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. | [optional]
|
|
12
|
-
**anchor_x_offset** | **String** | Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. | [optional]
|
|
13
|
-
**anchor_y_offset** | **String** | Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. | [optional]
|
|
14
|
-
**conditional_parent_label** | **String** | For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. | [optional]
|
|
15
|
-
**conditional_parent_value** | **String** | For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. | [optional]
|
|
16
|
-
**custom_tab_id** | **String** | The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. | [optional]
|
|
17
|
-
**document_id** | **String** | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. | [optional]
|
|
18
|
-
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
|
19
|
-
**merge_field** | [**MergeField**](MergeField.md) | | [optional]
|
|
20
|
-
**name** | **String** | | [optional]
|
|
21
|
-
**optional** | **String** | | [optional]
|
|
22
|
-
**page_number** | **String** | Specifies the page number on which the tab is located. | [optional]
|
|
23
|
-
**recipient_id** | **String** | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | [optional]
|
|
24
|
-
**scale_value** | [**Number**](Number.md) | | [optional]
|
|
25
|
-
**status** | **String** | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. | [optional]
|
|
26
|
-
**tab_id** | **String** | The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. | [optional]
|
|
27
|
-
**tab_label** | **String** | The label string associated with the tab. | [optional]
|
|
28
|
-
**tab_order** | **String** | | [optional]
|
|
29
|
-
**template_locked** | **String** | When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. | [optional]
|
|
30
|
-
**template_required** | **String** | When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. | [optional]
|
|
31
|
-
**x_position** | **String** | This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
|
|
32
|
-
**y_position** | **String** | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
|
|
33
|
-
|
|
34
|
-
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::SignerEmailNotifications
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**agent_notification** | **String** | When set to **true**, the user receives agent notification emails. | [optional]
|
|
7
|
-
**carbon_copy_notification** | **String** | When set to **true**, the user receives notifications of carbon copy deliveries. | [optional]
|
|
8
|
-
**certified_delivery_notification** | **String** | When set to **true**, the user receives notifications of certified deliveries. | [optional]
|
|
9
|
-
**document_markup_activation** | **String** | When set to **true**, the user receives notification that document markup has been activated. | [optional]
|
|
10
|
-
**envelope_activation** | **String** | When set to **true**, the user receives notification that the envelope has been activated. | [optional]
|
|
11
|
-
**envelope_complete** | **String** | When set to **true**, the user receives notification that the envelope has been completed. | [optional]
|
|
12
|
-
**envelope_corrected** | **String** | When set to **true**, the user receives notification that the envelope has been corrected. | [optional]
|
|
13
|
-
**envelope_declined** | **String** | When set to **true**, the user receives notification that the envelope has been declined. | [optional]
|
|
14
|
-
**envelope_voided** | **String** | When set to **true**, the user receives notification that the envelope has been voided. | [optional]
|
|
15
|
-
**fax_received** | **String** | Reserved: | [optional]
|
|
16
|
-
**offline_signing_failed** | **String** | When set to **true**, the user receives notification if the offline signing failed. | [optional]
|
|
17
|
-
**purge_documents** | **String** | When set to **true**, the user receives notification of document purges. | [optional]
|
|
18
|
-
**reassigned_signer** | **String** | When set to **true**, the user receives notification that the envelope has been reassigned. | [optional]
|
|
19
|
-
**when_signing_group_member** | **String** | | [optional]
|
|
20
|
-
|
|
21
|
-
|
data/docs/SigningGroup.md
DELETED
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::SigningGroup
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**created** | **String** | | [optional]
|
|
7
|
-
**created_by** | **String** | | [optional]
|
|
8
|
-
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
|
9
|
-
**group_email** | **String** | | [optional]
|
|
10
|
-
**group_name** | **String** | The name of the group. | [optional]
|
|
11
|
-
**group_type** | **String** | | [optional]
|
|
12
|
-
**modified** | **String** | | [optional]
|
|
13
|
-
**modified_by** | **String** | | [optional]
|
|
14
|
-
**signing_group_id** | **String** | When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). | [optional]
|
|
15
|
-
**users** | [**Array<SigningGroupUser>**](SigningGroupUser.md) | | [optional]
|
|
16
|
-
|
|
17
|
-
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::SigningGroupInformation
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**groups** | [**Array<SigningGroup>**](SigningGroup.md) | A collection group objects containing information about the groups returned. | [optional]
|
|
7
|
-
|
|
8
|
-
|
data/docs/SigningGroupUser.md
DELETED
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::SigningGroupUser
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**email** | **String** | | [optional]
|
|
7
|
-
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
|
8
|
-
**user_name** | **String** | The name of the group member. Maximum Length: 100 characters. | [optional]
|
|
9
|
-
|
|
10
|
-
|
data/docs/SigningGroupUsers.md
DELETED
data/docs/SigningGroupsApi.md
DELETED
|
@@ -1,485 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::SigningGroupsApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *https://www.docusign.net/restapi*
|
|
4
|
-
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
------------- | ------------- | -------------
|
|
7
|
-
[**create_list**](SigningGroupsApi.md#create_list) | **POST** /v2/accounts/{accountId}/signing_groups | Creates a signing group.
|
|
8
|
-
[**delete_list**](SigningGroupsApi.md#delete_list) | **DELETE** /v2/accounts/{accountId}/signing_groups | Deletes one or more signing groups.
|
|
9
|
-
[**delete_users**](SigningGroupsApi.md#delete_users) | **DELETE** /v2/accounts/{accountId}/signing_groups/{signingGroupId}/users | Deletes one or more members from a signing group.
|
|
10
|
-
[**get**](SigningGroupsApi.md#get) | **GET** /v2/accounts/{accountId}/signing_groups/{signingGroupId} | Gets information about a signing group.
|
|
11
|
-
[**list**](SigningGroupsApi.md#list) | **GET** /v2/accounts/{accountId}/signing_groups | Gets a list of the Signing Groups in an account.
|
|
12
|
-
[**list_users**](SigningGroupsApi.md#list_users) | **GET** /v2/accounts/{accountId}/signing_groups/{signingGroupId}/users | Gets a list of members in a Signing Group.
|
|
13
|
-
[**update**](SigningGroupsApi.md#update) | **PUT** /v2/accounts/{accountId}/signing_groups/{signingGroupId} | Updates a signing group.
|
|
14
|
-
[**update_list**](SigningGroupsApi.md#update_list) | **PUT** /v2/accounts/{accountId}/signing_groups | Updates signing group names.
|
|
15
|
-
[**update_users**](SigningGroupsApi.md#update_users) | **PUT** /v2/accounts/{accountId}/signing_groups/{signingGroupId}/users | Adds members to a signing group.
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
# **create_list**
|
|
19
|
-
> SigningGroupInformation create_list(account_id, opts)
|
|
20
|
-
|
|
21
|
-
Creates a signing group.
|
|
22
|
-
|
|
23
|
-
Creates one or more signing groups. Multiple signing groups can be created in one call. Only users with account administrator privileges can create signing groups. An account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members. Signing groups can be used by any account user.
|
|
24
|
-
|
|
25
|
-
### Example
|
|
26
|
-
```ruby
|
|
27
|
-
# load the gem
|
|
28
|
-
require 'docusign_esign'
|
|
29
|
-
|
|
30
|
-
api_instance = DocuSign_eSign::SigningGroupsApi.new
|
|
31
|
-
|
|
32
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
33
|
-
|
|
34
|
-
opts = {
|
|
35
|
-
signing_group_information: DocuSign_eSign::SigningGroupInformation.new # SigningGroupInformation |
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
begin
|
|
39
|
-
#Creates a signing group.
|
|
40
|
-
result = api_instance.create_list(account_id, opts)
|
|
41
|
-
p result
|
|
42
|
-
rescue DocuSign_eSign::ApiError => e
|
|
43
|
-
puts "Exception when calling SigningGroupsApi->create_list: #{e}"
|
|
44
|
-
end
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
### Parameters
|
|
48
|
-
|
|
49
|
-
Name | Type | Description | Notes
|
|
50
|
-
------------- | ------------- | ------------- | -------------
|
|
51
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
52
|
-
**signing_group_information** | [**SigningGroupInformation**](SigningGroupInformation.md)| | [optional]
|
|
53
|
-
|
|
54
|
-
### Return type
|
|
55
|
-
|
|
56
|
-
[**SigningGroupInformation**](SigningGroupInformation.md)
|
|
57
|
-
|
|
58
|
-
### Authorization
|
|
59
|
-
|
|
60
|
-
No authorization required
|
|
61
|
-
|
|
62
|
-
### HTTP request headers
|
|
63
|
-
|
|
64
|
-
- **Content-Type**: Not defined
|
|
65
|
-
- **Accept**: application/json
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
# **delete_list**
|
|
70
|
-
> SigningGroupInformation delete_list(account_id, opts)
|
|
71
|
-
|
|
72
|
-
Deletes one or more signing groups.
|
|
73
|
-
|
|
74
|
-
Deletes one or more signing groups in the specified account.
|
|
75
|
-
|
|
76
|
-
### Example
|
|
77
|
-
```ruby
|
|
78
|
-
# load the gem
|
|
79
|
-
require 'docusign_esign'
|
|
80
|
-
|
|
81
|
-
api_instance = DocuSign_eSign::SigningGroupsApi.new
|
|
82
|
-
|
|
83
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
84
|
-
|
|
85
|
-
opts = {
|
|
86
|
-
signing_group_information: DocuSign_eSign::SigningGroupInformation.new # SigningGroupInformation |
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
begin
|
|
90
|
-
#Deletes one or more signing groups.
|
|
91
|
-
result = api_instance.delete_list(account_id, opts)
|
|
92
|
-
p result
|
|
93
|
-
rescue DocuSign_eSign::ApiError => e
|
|
94
|
-
puts "Exception when calling SigningGroupsApi->delete_list: #{e}"
|
|
95
|
-
end
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
### Parameters
|
|
99
|
-
|
|
100
|
-
Name | Type | Description | Notes
|
|
101
|
-
------------- | ------------- | ------------- | -------------
|
|
102
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
103
|
-
**signing_group_information** | [**SigningGroupInformation**](SigningGroupInformation.md)| | [optional]
|
|
104
|
-
|
|
105
|
-
### Return type
|
|
106
|
-
|
|
107
|
-
[**SigningGroupInformation**](SigningGroupInformation.md)
|
|
108
|
-
|
|
109
|
-
### Authorization
|
|
110
|
-
|
|
111
|
-
No authorization required
|
|
112
|
-
|
|
113
|
-
### HTTP request headers
|
|
114
|
-
|
|
115
|
-
- **Content-Type**: Not defined
|
|
116
|
-
- **Accept**: application/json
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
# **delete_users**
|
|
121
|
-
> SigningGroupUsers delete_users(account_id, signing_group_id, opts)
|
|
122
|
-
|
|
123
|
-
Deletes one or more members from a signing group.
|
|
124
|
-
|
|
125
|
-
Deletes one or more members from the specified signing group.
|
|
126
|
-
|
|
127
|
-
### Example
|
|
128
|
-
```ruby
|
|
129
|
-
# load the gem
|
|
130
|
-
require 'docusign_esign'
|
|
131
|
-
|
|
132
|
-
api_instance = DocuSign_eSign::SigningGroupsApi.new
|
|
133
|
-
|
|
134
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
135
|
-
|
|
136
|
-
signing_group_id = "signing_group_id_example" # String |
|
|
137
|
-
|
|
138
|
-
opts = {
|
|
139
|
-
signing_group_users: DocuSign_eSign::SigningGroupUsers.new # SigningGroupUsers |
|
|
140
|
-
}
|
|
141
|
-
|
|
142
|
-
begin
|
|
143
|
-
#Deletes one or more members from a signing group.
|
|
144
|
-
result = api_instance.delete_users(account_id, signing_group_id, opts)
|
|
145
|
-
p result
|
|
146
|
-
rescue DocuSign_eSign::ApiError => e
|
|
147
|
-
puts "Exception when calling SigningGroupsApi->delete_users: #{e}"
|
|
148
|
-
end
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
### Parameters
|
|
152
|
-
|
|
153
|
-
Name | Type | Description | Notes
|
|
154
|
-
------------- | ------------- | ------------- | -------------
|
|
155
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
156
|
-
**signing_group_id** | **String**| |
|
|
157
|
-
**signing_group_users** | [**SigningGroupUsers**](SigningGroupUsers.md)| | [optional]
|
|
158
|
-
|
|
159
|
-
### Return type
|
|
160
|
-
|
|
161
|
-
[**SigningGroupUsers**](SigningGroupUsers.md)
|
|
162
|
-
|
|
163
|
-
### Authorization
|
|
164
|
-
|
|
165
|
-
No authorization required
|
|
166
|
-
|
|
167
|
-
### HTTP request headers
|
|
168
|
-
|
|
169
|
-
- **Content-Type**: Not defined
|
|
170
|
-
- **Accept**: application/json
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
# **get**
|
|
175
|
-
> SigningGroup get(account_id, signing_group_id)
|
|
176
|
-
|
|
177
|
-
Gets information about a signing group.
|
|
178
|
-
|
|
179
|
-
Retrieves information, including group member information, for the specified signing group.
|
|
180
|
-
|
|
181
|
-
### Example
|
|
182
|
-
```ruby
|
|
183
|
-
# load the gem
|
|
184
|
-
require 'docusign_esign'
|
|
185
|
-
|
|
186
|
-
api_instance = DocuSign_eSign::SigningGroupsApi.new
|
|
187
|
-
|
|
188
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
189
|
-
|
|
190
|
-
signing_group_id = "signing_group_id_example" # String |
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
begin
|
|
194
|
-
#Gets information about a signing group.
|
|
195
|
-
result = api_instance.get(account_id, signing_group_id)
|
|
196
|
-
p result
|
|
197
|
-
rescue DocuSign_eSign::ApiError => e
|
|
198
|
-
puts "Exception when calling SigningGroupsApi->get: #{e}"
|
|
199
|
-
end
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
### Parameters
|
|
203
|
-
|
|
204
|
-
Name | Type | Description | Notes
|
|
205
|
-
------------- | ------------- | ------------- | -------------
|
|
206
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
207
|
-
**signing_group_id** | **String**| |
|
|
208
|
-
|
|
209
|
-
### Return type
|
|
210
|
-
|
|
211
|
-
[**SigningGroup**](SigningGroup.md)
|
|
212
|
-
|
|
213
|
-
### Authorization
|
|
214
|
-
|
|
215
|
-
No authorization required
|
|
216
|
-
|
|
217
|
-
### HTTP request headers
|
|
218
|
-
|
|
219
|
-
- **Content-Type**: Not defined
|
|
220
|
-
- **Accept**: application/json
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
# **list**
|
|
225
|
-
> SigningGroupInformation list(account_id, opts)
|
|
226
|
-
|
|
227
|
-
Gets a list of the Signing Groups in an account.
|
|
228
|
-
|
|
229
|
-
Retrieves a list of all signing groups in the specified account.
|
|
230
|
-
|
|
231
|
-
### Example
|
|
232
|
-
```ruby
|
|
233
|
-
# load the gem
|
|
234
|
-
require 'docusign_esign'
|
|
235
|
-
|
|
236
|
-
api_instance = DocuSign_eSign::SigningGroupsApi.new
|
|
237
|
-
|
|
238
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
239
|
-
|
|
240
|
-
opts = {
|
|
241
|
-
group_type: "group_type_example", # String |
|
|
242
|
-
include_users: "include_users_example" # String | When set to **true**, the response includes the signing group members.
|
|
243
|
-
}
|
|
244
|
-
|
|
245
|
-
begin
|
|
246
|
-
#Gets a list of the Signing Groups in an account.
|
|
247
|
-
result = api_instance.list(account_id, opts)
|
|
248
|
-
p result
|
|
249
|
-
rescue DocuSign_eSign::ApiError => e
|
|
250
|
-
puts "Exception when calling SigningGroupsApi->list: #{e}"
|
|
251
|
-
end
|
|
252
|
-
```
|
|
253
|
-
|
|
254
|
-
### Parameters
|
|
255
|
-
|
|
256
|
-
Name | Type | Description | Notes
|
|
257
|
-
------------- | ------------- | ------------- | -------------
|
|
258
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
259
|
-
**group_type** | **String**| | [optional]
|
|
260
|
-
**include_users** | **String**| When set to **true**, the response includes the signing group members. | [optional]
|
|
261
|
-
|
|
262
|
-
### Return type
|
|
263
|
-
|
|
264
|
-
[**SigningGroupInformation**](SigningGroupInformation.md)
|
|
265
|
-
|
|
266
|
-
### Authorization
|
|
267
|
-
|
|
268
|
-
No authorization required
|
|
269
|
-
|
|
270
|
-
### HTTP request headers
|
|
271
|
-
|
|
272
|
-
- **Content-Type**: Not defined
|
|
273
|
-
- **Accept**: application/json
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
# **list_users**
|
|
278
|
-
> SigningGroupUsers list_users(account_id, signing_group_id)
|
|
279
|
-
|
|
280
|
-
Gets a list of members in a Signing Group.
|
|
281
|
-
|
|
282
|
-
Retrieves the list of members in the specified Signing Group.
|
|
283
|
-
|
|
284
|
-
### Example
|
|
285
|
-
```ruby
|
|
286
|
-
# load the gem
|
|
287
|
-
require 'docusign_esign'
|
|
288
|
-
|
|
289
|
-
api_instance = DocuSign_eSign::SigningGroupsApi.new
|
|
290
|
-
|
|
291
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
292
|
-
|
|
293
|
-
signing_group_id = "signing_group_id_example" # String |
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
begin
|
|
297
|
-
#Gets a list of members in a Signing Group.
|
|
298
|
-
result = api_instance.list_users(account_id, signing_group_id)
|
|
299
|
-
p result
|
|
300
|
-
rescue DocuSign_eSign::ApiError => e
|
|
301
|
-
puts "Exception when calling SigningGroupsApi->list_users: #{e}"
|
|
302
|
-
end
|
|
303
|
-
```
|
|
304
|
-
|
|
305
|
-
### Parameters
|
|
306
|
-
|
|
307
|
-
Name | Type | Description | Notes
|
|
308
|
-
------------- | ------------- | ------------- | -------------
|
|
309
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
310
|
-
**signing_group_id** | **String**| |
|
|
311
|
-
|
|
312
|
-
### Return type
|
|
313
|
-
|
|
314
|
-
[**SigningGroupUsers**](SigningGroupUsers.md)
|
|
315
|
-
|
|
316
|
-
### Authorization
|
|
317
|
-
|
|
318
|
-
No authorization required
|
|
319
|
-
|
|
320
|
-
### HTTP request headers
|
|
321
|
-
|
|
322
|
-
- **Content-Type**: Not defined
|
|
323
|
-
- **Accept**: application/json
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
# **update**
|
|
328
|
-
> SigningGroup update(account_id, signing_group_id, opts)
|
|
329
|
-
|
|
330
|
-
Updates a signing group.
|
|
331
|
-
|
|
332
|
-
Updates signing group name and member information. You can also add new members to the signing group. A signing group can have a maximum of 50 members.
|
|
333
|
-
|
|
334
|
-
### Example
|
|
335
|
-
```ruby
|
|
336
|
-
# load the gem
|
|
337
|
-
require 'docusign_esign'
|
|
338
|
-
|
|
339
|
-
api_instance = DocuSign_eSign::SigningGroupsApi.new
|
|
340
|
-
|
|
341
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
342
|
-
|
|
343
|
-
signing_group_id = "signing_group_id_example" # String |
|
|
344
|
-
|
|
345
|
-
opts = {
|
|
346
|
-
signing_group: DocuSign_eSign::SigningGroup.new # SigningGroup |
|
|
347
|
-
}
|
|
348
|
-
|
|
349
|
-
begin
|
|
350
|
-
#Updates a signing group.
|
|
351
|
-
result = api_instance.update(account_id, signing_group_id, opts)
|
|
352
|
-
p result
|
|
353
|
-
rescue DocuSign_eSign::ApiError => e
|
|
354
|
-
puts "Exception when calling SigningGroupsApi->update: #{e}"
|
|
355
|
-
end
|
|
356
|
-
```
|
|
357
|
-
|
|
358
|
-
### Parameters
|
|
359
|
-
|
|
360
|
-
Name | Type | Description | Notes
|
|
361
|
-
------------- | ------------- | ------------- | -------------
|
|
362
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
363
|
-
**signing_group_id** | **String**| |
|
|
364
|
-
**signing_group** | [**SigningGroup**](SigningGroup.md)| | [optional]
|
|
365
|
-
|
|
366
|
-
### Return type
|
|
367
|
-
|
|
368
|
-
[**SigningGroup**](SigningGroup.md)
|
|
369
|
-
|
|
370
|
-
### Authorization
|
|
371
|
-
|
|
372
|
-
No authorization required
|
|
373
|
-
|
|
374
|
-
### HTTP request headers
|
|
375
|
-
|
|
376
|
-
- **Content-Type**: Not defined
|
|
377
|
-
- **Accept**: application/json
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
# **update_list**
|
|
382
|
-
> SigningGroupInformation update_list(account_id, opts)
|
|
383
|
-
|
|
384
|
-
Updates signing group names.
|
|
385
|
-
|
|
386
|
-
Updates the name of one or more existing signing groups.
|
|
387
|
-
|
|
388
|
-
### Example
|
|
389
|
-
```ruby
|
|
390
|
-
# load the gem
|
|
391
|
-
require 'docusign_esign'
|
|
392
|
-
|
|
393
|
-
api_instance = DocuSign_eSign::SigningGroupsApi.new
|
|
394
|
-
|
|
395
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
396
|
-
|
|
397
|
-
opts = {
|
|
398
|
-
signing_group_information: DocuSign_eSign::SigningGroupInformation.new # SigningGroupInformation |
|
|
399
|
-
}
|
|
400
|
-
|
|
401
|
-
begin
|
|
402
|
-
#Updates signing group names.
|
|
403
|
-
result = api_instance.update_list(account_id, opts)
|
|
404
|
-
p result
|
|
405
|
-
rescue DocuSign_eSign::ApiError => e
|
|
406
|
-
puts "Exception when calling SigningGroupsApi->update_list: #{e}"
|
|
407
|
-
end
|
|
408
|
-
```
|
|
409
|
-
|
|
410
|
-
### Parameters
|
|
411
|
-
|
|
412
|
-
Name | Type | Description | Notes
|
|
413
|
-
------------- | ------------- | ------------- | -------------
|
|
414
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
415
|
-
**signing_group_information** | [**SigningGroupInformation**](SigningGroupInformation.md)| | [optional]
|
|
416
|
-
|
|
417
|
-
### Return type
|
|
418
|
-
|
|
419
|
-
[**SigningGroupInformation**](SigningGroupInformation.md)
|
|
420
|
-
|
|
421
|
-
### Authorization
|
|
422
|
-
|
|
423
|
-
No authorization required
|
|
424
|
-
|
|
425
|
-
### HTTP request headers
|
|
426
|
-
|
|
427
|
-
- **Content-Type**: Not defined
|
|
428
|
-
- **Accept**: application/json
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
# **update_users**
|
|
433
|
-
> SigningGroupUsers update_users(account_id, signing_group_id, opts)
|
|
434
|
-
|
|
435
|
-
Adds members to a signing group.
|
|
436
|
-
|
|
437
|
-
Adds one or more new members to a signing group. A signing group can have a maximum of 50 members.
|
|
438
|
-
|
|
439
|
-
### Example
|
|
440
|
-
```ruby
|
|
441
|
-
# load the gem
|
|
442
|
-
require 'docusign_esign'
|
|
443
|
-
|
|
444
|
-
api_instance = DocuSign_eSign::SigningGroupsApi.new
|
|
445
|
-
|
|
446
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
447
|
-
|
|
448
|
-
signing_group_id = "signing_group_id_example" # String |
|
|
449
|
-
|
|
450
|
-
opts = {
|
|
451
|
-
signing_group_users: DocuSign_eSign::SigningGroupUsers.new # SigningGroupUsers |
|
|
452
|
-
}
|
|
453
|
-
|
|
454
|
-
begin
|
|
455
|
-
#Adds members to a signing group.
|
|
456
|
-
result = api_instance.update_users(account_id, signing_group_id, opts)
|
|
457
|
-
p result
|
|
458
|
-
rescue DocuSign_eSign::ApiError => e
|
|
459
|
-
puts "Exception when calling SigningGroupsApi->update_users: #{e}"
|
|
460
|
-
end
|
|
461
|
-
```
|
|
462
|
-
|
|
463
|
-
### Parameters
|
|
464
|
-
|
|
465
|
-
Name | Type | Description | Notes
|
|
466
|
-
------------- | ------------- | ------------- | -------------
|
|
467
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
468
|
-
**signing_group_id** | **String**| |
|
|
469
|
-
**signing_group_users** | [**SigningGroupUsers**](SigningGroupUsers.md)| | [optional]
|
|
470
|
-
|
|
471
|
-
### Return type
|
|
472
|
-
|
|
473
|
-
[**SigningGroupUsers**](SigningGroupUsers.md)
|
|
474
|
-
|
|
475
|
-
### Authorization
|
|
476
|
-
|
|
477
|
-
No authorization required
|
|
478
|
-
|
|
479
|
-
### HTTP request headers
|
|
480
|
-
|
|
481
|
-
- **Content-Type**: Not defined
|
|
482
|
-
- **Accept**: application/json
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|