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
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::PowerFormFormDataRecipient
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**email** | **String** | | [optional]
|
|
7
|
-
**form_data** | [**Array<NameValue>**](NameValue.md) | | [optional]
|
|
8
|
-
**name** | **String** | | [optional]
|
|
9
|
-
**recipient_id** | **String** | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | [optional]
|
|
10
|
-
|
|
11
|
-
|
data/docs/PowerFormRecipient.md
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::PowerFormRecipient
|
|
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
|
-
**access_code_locked** | **String** | | [optional]
|
|
8
|
-
**access_code_required** | **String** | | [optional]
|
|
9
|
-
**email** | **String** | | [optional]
|
|
10
|
-
**email_locked** | **String** | | [optional]
|
|
11
|
-
**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]
|
|
12
|
-
**id_check_required** | **String** | | [optional]
|
|
13
|
-
**name** | **String** | | [optional]
|
|
14
|
-
**recipient_type** | **String** | | [optional]
|
|
15
|
-
**role_name** | **String** | Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. | [optional]
|
|
16
|
-
**routing_order** | **String** | Specifies the routing order of the recipient in the envelope. | [optional]
|
|
17
|
-
**template_requires_id_lookup** | **String** | | [optional]
|
|
18
|
-
**user_name_locked** | **String** | | [optional]
|
|
19
|
-
|
|
20
|
-
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::PowerFormSendersResponse
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**end_position** | **String** | The last position in the result set. | [optional]
|
|
7
|
-
**next_uri** | **String** | The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. | [optional]
|
|
8
|
-
**power_form_senders** | [**Array<UserInfo>**](UserInfo.md) | | [optional]
|
|
9
|
-
**previous_uri** | **String** | The postal code for the billing address. | [optional]
|
|
10
|
-
**result_set_size** | **String** | The number of results returned in this response. | [optional]
|
|
11
|
-
**start_position** | **String** | Starting position of the current result set. | [optional]
|
|
12
|
-
**total_set_size** | **String** | The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response. | [optional]
|
|
13
|
-
|
|
14
|
-
|
data/docs/PowerFormsApi.md
DELETED
|
@@ -1,419 +0,0 @@
|
|
|
1
|
-
# DocuSign_eSign::PowerFormsApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *https://www.docusign.net/restapi*
|
|
4
|
-
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
------------- | ------------- | -------------
|
|
7
|
-
[**create_power_form**](PowerFormsApi.md#create_power_form) | **POST** /v2/accounts/{accountId}/powerforms | Creates a new PowerForm.
|
|
8
|
-
[**delete_power_form**](PowerFormsApi.md#delete_power_form) | **DELETE** /v2/accounts/{accountId}/powerforms/{powerFormId} | Delete a PowerForm.
|
|
9
|
-
[**delete_power_forms**](PowerFormsApi.md#delete_power_forms) | **DELETE** /v2/accounts/{accountId}/powerforms | Deletes one or more PowerForms
|
|
10
|
-
[**get_power_form**](PowerFormsApi.md#get_power_form) | **GET** /v2/accounts/{accountId}/powerforms/{powerFormId} | Returns a single PowerForm.
|
|
11
|
-
[**get_power_form_data**](PowerFormsApi.md#get_power_form_data) | **GET** /v2/accounts/{accountId}/powerforms/{powerFormId}/form_data | Returns the form data associated with the usage of a PowerForm.
|
|
12
|
-
[**list_power_form_senders**](PowerFormsApi.md#list_power_form_senders) | **GET** /v2/accounts/{accountId}/powerforms/senders | Returns the list of PowerForms available to the user.
|
|
13
|
-
[**list_power_forms**](PowerFormsApi.md#list_power_forms) | **GET** /v2/accounts/{accountId}/powerforms | Returns the list of PowerForms available to the user.
|
|
14
|
-
[**update_power_form**](PowerFormsApi.md#update_power_form) | **PUT** /v2/accounts/{accountId}/powerforms/{powerFormId} | Creates a new PowerForm.
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
# **create_power_form**
|
|
18
|
-
> PowerForm create_power_form(account_id, opts)
|
|
19
|
-
|
|
20
|
-
Creates a new PowerForm.
|
|
21
|
-
|
|
22
|
-
### Example
|
|
23
|
-
```ruby
|
|
24
|
-
# load the gem
|
|
25
|
-
require 'docusign_esign'
|
|
26
|
-
|
|
27
|
-
api_instance = DocuSign_eSign::PowerFormsApi.new
|
|
28
|
-
|
|
29
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
30
|
-
|
|
31
|
-
opts = {
|
|
32
|
-
power_form: DocuSign_eSign::PowerForm.new # PowerForm |
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
begin
|
|
36
|
-
#Creates a new PowerForm.
|
|
37
|
-
result = api_instance.create_power_form(account_id, opts)
|
|
38
|
-
p result
|
|
39
|
-
rescue DocuSign_eSign::ApiError => e
|
|
40
|
-
puts "Exception when calling PowerFormsApi->create_power_form: #{e}"
|
|
41
|
-
end
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
### Parameters
|
|
45
|
-
|
|
46
|
-
Name | Type | Description | Notes
|
|
47
|
-
------------- | ------------- | ------------- | -------------
|
|
48
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
49
|
-
**power_form** | [**PowerForm**](PowerForm.md)| | [optional]
|
|
50
|
-
|
|
51
|
-
### Return type
|
|
52
|
-
|
|
53
|
-
[**PowerForm**](PowerForm.md)
|
|
54
|
-
|
|
55
|
-
### Authorization
|
|
56
|
-
|
|
57
|
-
No authorization required
|
|
58
|
-
|
|
59
|
-
### HTTP request headers
|
|
60
|
-
|
|
61
|
-
- **Content-Type**: Not defined
|
|
62
|
-
- **Accept**: application/json
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
# **delete_power_form**
|
|
67
|
-
> delete_power_form(account_id, power_form_id)
|
|
68
|
-
|
|
69
|
-
Delete a PowerForm.
|
|
70
|
-
|
|
71
|
-
### Example
|
|
72
|
-
```ruby
|
|
73
|
-
# load the gem
|
|
74
|
-
require 'docusign_esign'
|
|
75
|
-
|
|
76
|
-
api_instance = DocuSign_eSign::PowerFormsApi.new
|
|
77
|
-
|
|
78
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
79
|
-
|
|
80
|
-
power_form_id = "power_form_id_example" # String |
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
begin
|
|
84
|
-
#Delete a PowerForm.
|
|
85
|
-
api_instance.delete_power_form(account_id, power_form_id)
|
|
86
|
-
rescue DocuSign_eSign::ApiError => e
|
|
87
|
-
puts "Exception when calling PowerFormsApi->delete_power_form: #{e}"
|
|
88
|
-
end
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
### Parameters
|
|
92
|
-
|
|
93
|
-
Name | Type | Description | Notes
|
|
94
|
-
------------- | ------------- | ------------- | -------------
|
|
95
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
96
|
-
**power_form_id** | **String**| |
|
|
97
|
-
|
|
98
|
-
### Return type
|
|
99
|
-
|
|
100
|
-
nil (empty response body)
|
|
101
|
-
|
|
102
|
-
### Authorization
|
|
103
|
-
|
|
104
|
-
No authorization required
|
|
105
|
-
|
|
106
|
-
### HTTP request headers
|
|
107
|
-
|
|
108
|
-
- **Content-Type**: Not defined
|
|
109
|
-
- **Accept**: application/json
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
# **delete_power_forms**
|
|
114
|
-
> PowerFormsResponse delete_power_forms(account_id, opts)
|
|
115
|
-
|
|
116
|
-
Deletes one or more PowerForms
|
|
117
|
-
|
|
118
|
-
### Example
|
|
119
|
-
```ruby
|
|
120
|
-
# load the gem
|
|
121
|
-
require 'docusign_esign'
|
|
122
|
-
|
|
123
|
-
api_instance = DocuSign_eSign::PowerFormsApi.new
|
|
124
|
-
|
|
125
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
126
|
-
|
|
127
|
-
opts = {
|
|
128
|
-
power_forms_request: DocuSign_eSign::PowerFormsRequest.new # PowerFormsRequest |
|
|
129
|
-
}
|
|
130
|
-
|
|
131
|
-
begin
|
|
132
|
-
#Deletes one or more PowerForms
|
|
133
|
-
result = api_instance.delete_power_forms(account_id, opts)
|
|
134
|
-
p result
|
|
135
|
-
rescue DocuSign_eSign::ApiError => e
|
|
136
|
-
puts "Exception when calling PowerFormsApi->delete_power_forms: #{e}"
|
|
137
|
-
end
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
### Parameters
|
|
141
|
-
|
|
142
|
-
Name | Type | Description | Notes
|
|
143
|
-
------------- | ------------- | ------------- | -------------
|
|
144
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
145
|
-
**power_forms_request** | [**PowerFormsRequest**](PowerFormsRequest.md)| | [optional]
|
|
146
|
-
|
|
147
|
-
### Return type
|
|
148
|
-
|
|
149
|
-
[**PowerFormsResponse**](PowerFormsResponse.md)
|
|
150
|
-
|
|
151
|
-
### Authorization
|
|
152
|
-
|
|
153
|
-
No authorization required
|
|
154
|
-
|
|
155
|
-
### HTTP request headers
|
|
156
|
-
|
|
157
|
-
- **Content-Type**: Not defined
|
|
158
|
-
- **Accept**: application/json
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
# **get_power_form**
|
|
163
|
-
> PowerForm get_power_form(account_id, power_form_id)
|
|
164
|
-
|
|
165
|
-
Returns a single PowerForm.
|
|
166
|
-
|
|
167
|
-
### Example
|
|
168
|
-
```ruby
|
|
169
|
-
# load the gem
|
|
170
|
-
require 'docusign_esign'
|
|
171
|
-
|
|
172
|
-
api_instance = DocuSign_eSign::PowerFormsApi.new
|
|
173
|
-
|
|
174
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
175
|
-
|
|
176
|
-
power_form_id = "power_form_id_example" # String |
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
begin
|
|
180
|
-
#Returns a single PowerForm.
|
|
181
|
-
result = api_instance.get_power_form(account_id, power_form_id)
|
|
182
|
-
p result
|
|
183
|
-
rescue DocuSign_eSign::ApiError => e
|
|
184
|
-
puts "Exception when calling PowerFormsApi->get_power_form: #{e}"
|
|
185
|
-
end
|
|
186
|
-
```
|
|
187
|
-
|
|
188
|
-
### Parameters
|
|
189
|
-
|
|
190
|
-
Name | Type | Description | Notes
|
|
191
|
-
------------- | ------------- | ------------- | -------------
|
|
192
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
193
|
-
**power_form_id** | **String**| |
|
|
194
|
-
|
|
195
|
-
### Return type
|
|
196
|
-
|
|
197
|
-
[**PowerForm**](PowerForm.md)
|
|
198
|
-
|
|
199
|
-
### Authorization
|
|
200
|
-
|
|
201
|
-
No authorization required
|
|
202
|
-
|
|
203
|
-
### HTTP request headers
|
|
204
|
-
|
|
205
|
-
- **Content-Type**: Not defined
|
|
206
|
-
- **Accept**: application/json
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
# **get_power_form_data**
|
|
211
|
-
> PowerFormsFormDataResponse get_power_form_data(account_id, power_form_id, opts)
|
|
212
|
-
|
|
213
|
-
Returns the form data associated with the usage of a PowerForm.
|
|
214
|
-
|
|
215
|
-
### Example
|
|
216
|
-
```ruby
|
|
217
|
-
# load the gem
|
|
218
|
-
require 'docusign_esign'
|
|
219
|
-
|
|
220
|
-
api_instance = DocuSign_eSign::PowerFormsApi.new
|
|
221
|
-
|
|
222
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
223
|
-
|
|
224
|
-
power_form_id = "power_form_id_example" # String |
|
|
225
|
-
|
|
226
|
-
opts = {
|
|
227
|
-
from_date: "from_date_example", # String |
|
|
228
|
-
to_date: "to_date_example" # String |
|
|
229
|
-
}
|
|
230
|
-
|
|
231
|
-
begin
|
|
232
|
-
#Returns the form data associated with the usage of a PowerForm.
|
|
233
|
-
result = api_instance.get_power_form_data(account_id, power_form_id, opts)
|
|
234
|
-
p result
|
|
235
|
-
rescue DocuSign_eSign::ApiError => e
|
|
236
|
-
puts "Exception when calling PowerFormsApi->get_power_form_data: #{e}"
|
|
237
|
-
end
|
|
238
|
-
```
|
|
239
|
-
|
|
240
|
-
### Parameters
|
|
241
|
-
|
|
242
|
-
Name | Type | Description | Notes
|
|
243
|
-
------------- | ------------- | ------------- | -------------
|
|
244
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
245
|
-
**power_form_id** | **String**| |
|
|
246
|
-
**from_date** | **String**| | [optional]
|
|
247
|
-
**to_date** | **String**| | [optional]
|
|
248
|
-
|
|
249
|
-
### Return type
|
|
250
|
-
|
|
251
|
-
[**PowerFormsFormDataResponse**](PowerFormsFormDataResponse.md)
|
|
252
|
-
|
|
253
|
-
### Authorization
|
|
254
|
-
|
|
255
|
-
No authorization required
|
|
256
|
-
|
|
257
|
-
### HTTP request headers
|
|
258
|
-
|
|
259
|
-
- **Content-Type**: Not defined
|
|
260
|
-
- **Accept**: application/json
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
# **list_power_form_senders**
|
|
265
|
-
> PowerFormSendersResponse list_power_form_senders(account_id, opts)
|
|
266
|
-
|
|
267
|
-
Returns the list of PowerForms available to the user.
|
|
268
|
-
|
|
269
|
-
### Example
|
|
270
|
-
```ruby
|
|
271
|
-
# load the gem
|
|
272
|
-
require 'docusign_esign'
|
|
273
|
-
|
|
274
|
-
api_instance = DocuSign_eSign::PowerFormsApi.new
|
|
275
|
-
|
|
276
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
277
|
-
|
|
278
|
-
opts = {
|
|
279
|
-
start_position: "start_position_example" # String |
|
|
280
|
-
}
|
|
281
|
-
|
|
282
|
-
begin
|
|
283
|
-
#Returns the list of PowerForms available to the user.
|
|
284
|
-
result = api_instance.list_power_form_senders(account_id, opts)
|
|
285
|
-
p result
|
|
286
|
-
rescue DocuSign_eSign::ApiError => e
|
|
287
|
-
puts "Exception when calling PowerFormsApi->list_power_form_senders: #{e}"
|
|
288
|
-
end
|
|
289
|
-
```
|
|
290
|
-
|
|
291
|
-
### Parameters
|
|
292
|
-
|
|
293
|
-
Name | Type | Description | Notes
|
|
294
|
-
------------- | ------------- | ------------- | -------------
|
|
295
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
296
|
-
**start_position** | **String**| | [optional]
|
|
297
|
-
|
|
298
|
-
### Return type
|
|
299
|
-
|
|
300
|
-
[**PowerFormSendersResponse**](PowerFormSendersResponse.md)
|
|
301
|
-
|
|
302
|
-
### Authorization
|
|
303
|
-
|
|
304
|
-
No authorization required
|
|
305
|
-
|
|
306
|
-
### HTTP request headers
|
|
307
|
-
|
|
308
|
-
- **Content-Type**: Not defined
|
|
309
|
-
- **Accept**: application/json
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
# **list_power_forms**
|
|
314
|
-
> PowerFormsResponse list_power_forms(account_id, opts)
|
|
315
|
-
|
|
316
|
-
Returns the list of PowerForms available to the user.
|
|
317
|
-
|
|
318
|
-
### Example
|
|
319
|
-
```ruby
|
|
320
|
-
# load the gem
|
|
321
|
-
require 'docusign_esign'
|
|
322
|
-
|
|
323
|
-
api_instance = DocuSign_eSign::PowerFormsApi.new
|
|
324
|
-
|
|
325
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
326
|
-
|
|
327
|
-
opts = {
|
|
328
|
-
from_date: "from_date_example", # String |
|
|
329
|
-
order: "order_example", # String |
|
|
330
|
-
order_by: "order_by_example", # String |
|
|
331
|
-
to_date: "to_date_example" # String |
|
|
332
|
-
}
|
|
333
|
-
|
|
334
|
-
begin
|
|
335
|
-
#Returns the list of PowerForms available to the user.
|
|
336
|
-
result = api_instance.list_power_forms(account_id, opts)
|
|
337
|
-
p result
|
|
338
|
-
rescue DocuSign_eSign::ApiError => e
|
|
339
|
-
puts "Exception when calling PowerFormsApi->list_power_forms: #{e}"
|
|
340
|
-
end
|
|
341
|
-
```
|
|
342
|
-
|
|
343
|
-
### Parameters
|
|
344
|
-
|
|
345
|
-
Name | Type | Description | Notes
|
|
346
|
-
------------- | ------------- | ------------- | -------------
|
|
347
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
348
|
-
**from_date** | **String**| | [optional]
|
|
349
|
-
**order** | **String**| | [optional]
|
|
350
|
-
**order_by** | **String**| | [optional]
|
|
351
|
-
**to_date** | **String**| | [optional]
|
|
352
|
-
|
|
353
|
-
### Return type
|
|
354
|
-
|
|
355
|
-
[**PowerFormsResponse**](PowerFormsResponse.md)
|
|
356
|
-
|
|
357
|
-
### Authorization
|
|
358
|
-
|
|
359
|
-
No authorization required
|
|
360
|
-
|
|
361
|
-
### HTTP request headers
|
|
362
|
-
|
|
363
|
-
- **Content-Type**: Not defined
|
|
364
|
-
- **Accept**: application/json
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
# **update_power_form**
|
|
369
|
-
> PowerForm update_power_form(account_id, power_form_id, opts)
|
|
370
|
-
|
|
371
|
-
Creates a new PowerForm.
|
|
372
|
-
|
|
373
|
-
### Example
|
|
374
|
-
```ruby
|
|
375
|
-
# load the gem
|
|
376
|
-
require 'docusign_esign'
|
|
377
|
-
|
|
378
|
-
api_instance = DocuSign_eSign::PowerFormsApi.new
|
|
379
|
-
|
|
380
|
-
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
381
|
-
|
|
382
|
-
power_form_id = "power_form_id_example" # String |
|
|
383
|
-
|
|
384
|
-
opts = {
|
|
385
|
-
power_form: DocuSign_eSign::PowerForm.new # PowerForm |
|
|
386
|
-
}
|
|
387
|
-
|
|
388
|
-
begin
|
|
389
|
-
#Creates a new PowerForm.
|
|
390
|
-
result = api_instance.update_power_form(account_id, power_form_id, opts)
|
|
391
|
-
p result
|
|
392
|
-
rescue DocuSign_eSign::ApiError => e
|
|
393
|
-
puts "Exception when calling PowerFormsApi->update_power_form: #{e}"
|
|
394
|
-
end
|
|
395
|
-
```
|
|
396
|
-
|
|
397
|
-
### Parameters
|
|
398
|
-
|
|
399
|
-
Name | Type | Description | Notes
|
|
400
|
-
------------- | ------------- | ------------- | -------------
|
|
401
|
-
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
402
|
-
**power_form_id** | **String**| |
|
|
403
|
-
**power_form** | [**PowerForm**](PowerForm.md)| | [optional]
|
|
404
|
-
|
|
405
|
-
### Return type
|
|
406
|
-
|
|
407
|
-
[**PowerForm**](PowerForm.md)
|
|
408
|
-
|
|
409
|
-
### Authorization
|
|
410
|
-
|
|
411
|
-
No authorization required
|
|
412
|
-
|
|
413
|
-
### HTTP request headers
|
|
414
|
-
|
|
415
|
-
- **Content-Type**: Not defined
|
|
416
|
-
- **Accept**: application/json
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|