diff --git a/docs/Account.md b/docs/Account.md new file mode 100644 index 0000000..b475ac1 --- /dev/null +++ b/docs/Account.md @@ -0,0 +1,39 @@ + +# Account + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | [**Date**](Date.md) | Date when the account was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**accountType** | [**AccountTypeEnum**](#AccountTypeEnum) | The provisioned type of the account. This is a server generated attributed and can not be provided in POST/PUT calls. | [optional] +**name** | **String** | The name which the account is known. This is a server generated attributed and can not be provided in POST/PUT calls. | [optional] +**modified** | [**Date**](Date.md) | The last date that the account information was updated. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**company** | **String** | The company associated with the account. This is a server generated attributed and can not be provided in POST/PUT calls. | [optional] +**id** | **String** | Identifier of the account. This is a server generated attributed and can not be provided in POST/PUT calls. | [optional] + + + +## Enum: AccountTypeEnum +Name | Value +---- | ----- +FREE | "FREE" +FREE_LEGACY | "FREE_LEGACY" +TEAM_TRIAL | "TEAM_TRIAL" +TEAM | "TEAM" +TEAM_LEGACY | "TEAM_LEGACY" +ENTERPRISE_TRIAL | "ENTERPRISE_TRIAL" +ENTERPRISE | "ENTERPRISE" +ENTERPRISE_LEGACY | "ENTERPRISE_LEGACY" +GLOBAL_TRIAL | "GLOBAL_TRIAL" +GLOBAL | "GLOBAL" +DEVELOPER | "DEVELOPER" +PRO_DOC_CLOUD | "PRO_DOC_CLOUD" +TEAM_DOC_CLOUD | "TEAM_DOC_CLOUD" +TRIAL_EXPIRED | "TRIAL_EXPIRED" +ANONYMOUS | "ANONYMOUS" +PRO_DOC_CLOUD_MULTI | "PRO_DOC_CLOUD_MULTI" +PRO_PLUS_DOC_CLOUD | "PRO_PLUS_DOC_CLOUD" +PRO_PLUS_DOC_CLOUD_MULTI | "PRO_PLUS_DOC_CLOUD_MULTI" + + + diff --git a/docs/AccountSharerInfo.md b/docs/AccountSharerInfo.md new file mode 100644 index 0000000..4aa2d6f --- /dev/null +++ b/docs/AccountSharerInfo.md @@ -0,0 +1,22 @@ + +# AccountSharerInfo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**permissions** | [**List<PermissionsEnum>**](#List<PermissionsEnum>) | A list of permissions given for this account sharing. | [optional] +**fullName** | **String** | Full name of this account sharer. | [optional] +**userId** | **String** | A unique identifier of the user resource for REST APIs as issued by Sign. | [optional] +**email** | **String** | The email address of the user | [optional] + + + +## Enum: List<PermissionsEnum> +Name | Value +---- | ----- +VIEW | "VIEW" +SEND | "SEND" +MODIFY | "MODIFY" + + + diff --git a/docs/AccountsApi.md b/docs/AccountsApi.md new file mode 100644 index 0000000..79bcc24 --- /dev/null +++ b/docs/AccountsApi.md @@ -0,0 +1,56 @@ +# AccountsApi + +All URIs are relative to *https://secure.au1.echosign.com/api/rest/v6* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAccount**](AccountsApi.md#getAccount) | **GET** /accounts/{accountId} | Retrieves the information for an account. + + + +# **getAccount** +> Account getAccount(authorization, accountId, xApiUser) + +Retrieves the information for an account. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.AccountsApi; + + +AccountsApi apiInstance = new AccountsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String accountId = "accountId_example"; // String | The account identifier. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +try { + Account result = apiInstance.getAccount(authorization, accountId, xApiUser); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling AccountsApi#getAccount"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_read')\" oncontextmenu=\"this.href=oauthDoc('user_read')\" target=\"oauthDoc\">user_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **accountId** | **String**| The account identifier. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + +### Return type + +[**Account**](Account.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + diff --git a/docs/AgreementCcInfo.md b/docs/AgreementCcInfo.md index 16af449..e282bbf 100755 --- a/docs/AgreementCcInfo.md +++ b/docs/AgreementCcInfo.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**email** | **String** | Email of the CC participant of the agreement | [optional] -**label** | **String** | Label of the CC list as returned in workflow description | [optional] **visiblePages** | **List<String>** | When you enable limited document visibility (documentVisibilityEnabled), you can specify which file (fileInfo) should be made visible to which specific participant set.<br>Specify one or more label values of a fileInfos element.<br>Each signer participant sets must contain at least one required signature field in at least one visible file included in this API call; if not a page with a signature field is automatically appended for any missing participant sets. If there is a possibility that one or more participant sets do not have a required signature field in the files included in the API call, all signer participant sets should include a special index value of '0' to make this automatically appended signature page visible to the signer. Not doing so may result in an error. For all other roles, you may omit this value to exclude this page. | [optional] +**label** | **String** | Label of the CC list as returned in workflow description | [optional] +**email** | **String** | Email of the CC participant of the agreement | [optional] diff --git a/docs/AgreementCreationInfo.md b/docs/AgreementCreationInfo.md index 0cca001..3a5f1b0 100755 --- a/docs/AgreementCreationInfo.md +++ b/docs/AgreementCreationInfo.md @@ -4,44 +4,56 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**groupId** | **String** | The unique identifier of the group to which the agreement belongs to. If not provided during agreement creation, primary group of the creator will be used | [optional] +**locale** | **String** | The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender | [optional] +**type** | [**TypeEnum**](#TypeEnum) | The kind of agreement | [optional] +**vaultingInfo** | [**VaultingInfo**](VaultingInfo.md) | Vaulting properties that allows Adobe Sign to securely store documents with a vault provider | [optional] +**securityOption** | [**SecurityOption**](SecurityOption.md) | Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation. | [optional] +**postSignOption** | [**PostSignOption**](PostSignOption.md) | URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation. | [optional] **ccs** | [**List<AgreementCcInfo>**](AgreementCcInfo.md) | A list of one or more CCs that will be copied in the agreement transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file. Should not be provided in offline agreement creation. | [optional] -**createdDate** | [**Date**](Date.md) | Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**deviceInfo** | [**OfflineDeviceInfo**](OfflineDeviceInfo.md) | Device info of the offline device. It should only be provided in case of offline agreement creation. | [optional] **documentVisibilityEnabled** | **Boolean** | If set to true, enable limited document visibility. Should not be provided in offline agreement creation. | [optional] -**emailOption** | [**EmailOption**](EmailOption.md) | Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement. | [optional] -**expirationTime** | [**Date**](Date.md) | Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. | [optional] -**externalId** | [**ExternalId**](ExternalId.md) | An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation. | [optional] -**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] -**firstReminderDelay** | **Integer** | Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation. | [optional] -**formFieldLayerTemplates** | [**List<FileInfo>**](FileInfo.md) | Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] +**isDocumentRetentionApplied** | **Boolean** | Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. | [optional] +**hasSignerIdentityReport** | **Boolean** | True if agreement has signer identity report available. If provided in POST or PUT, it will simply be ignored. | [optional] +**lastEventDate** | [**Date**](Date.md) | The date of the last event that occurred for this agreement. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**senderEmail** | **String** | Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored | [optional] **id** | **String** | The unique identifier of the agreement.If provided in POST, it will simply be ignored | [optional] -**locale** | **String** | The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender | [optional] +**state** | [**StateEnum**](#StateEnum) | The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID | [optional] **mergeFieldInfo** | [**List<MergefieldInfo>**](MergefieldInfo.md) | Optional default values for fields to merge into the document. The values will be presented to the signers for editable fields; for read-only fields the provided values will not be editable during the signing process. Merging data into fields is currently not supported when used with libraryDocumentId or libraryDocumentName. Only file and url are currently supported | [optional] +**firstReminderDelay** | **Integer** | Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation. | [optional] +**emailOption** | [**EmailOption**](EmailOption.md) | Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement. | [optional] +**signatureType** | [**SignatureTypeEnum**](#SignatureTypeEnum) | Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system | [optional] +**externalId** | [**ExternalId**](ExternalId.md) | An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation. | [optional] **message** | **String** | An optional message to the participants, describing what is being sent or why their signature is required | [optional] -**name** | **String** | The name of the agreement that will be used to identify it, in emails, website and other places | [optional] -**participantSetsInfo** | [**List<ParticipantSetInfo>**](ParticipantSetInfo.md) | A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc ), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document | [optional] -**postSignOption** | [**PostSignOption**](PostSignOption.md) | URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation. | [optional] +**deviceInfo** | [**OfflineDeviceInfo**](OfflineDeviceInfo.md) | Device info of the offline device. It should only be provided in case of offline agreement creation. | [optional] +**parentId** | **String** | The parent id of a megaSign child *OR* the originating id of a widget agreement instance | [optional] **reminderFrequency** | [**ReminderFrequencyEnum**](#ReminderFrequencyEnum) | Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used. Should not be provided in offline agreement creation. If provided in PUT as a different value than the current one, an error will be thrown. | [optional] -**securityOption** | [**SecurityOption**](SecurityOption.md) | Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation. | [optional] -**senderEmail** | **String** | Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored | [optional] -**signatureType** | [**SignatureTypeEnum**](#SignatureTypeEnum) | Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system | [optional] -**state** | [**StateEnum**](#StateEnum) | The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID | [optional] -**status** | [**StatusEnum**](#StatusEnum) | This is a server generated attribute which provides the detailed status of an agreement. | [optional] -**vaultingInfo** | [**VaultingInfo**](VaultingInfo.md) | Vaulting properties that allows Adobe Sign to securely store documents with a vault provider | [optional] +**createdDate** | [**Date**](Date.md) | Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**participantSetsInfo** | [**List<ParticipantSetInfo>**](ParticipantSetInfo.md) | A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document | [optional] +**hasFormFieldData** | **Boolean** | True if form field data is present. If provided in POST or PUT, it will simply be ignored. | [optional] +**expirationTime** | [**Date**](Date.md) | Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. | [optional] +**formFieldLayerTemplates** | [**List<FileInfo>**](FileInfo.md) | Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] +**name** | **String** | The name of the agreement that will be used to identify it, in emails, website and other places | [optional] +**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] **workflowId** | **String** | The identifier of custom workflow which defines the routing path of an agreement. Should not be provided in offline agreement creation. | [optional] +**status** | [**StatusEnum**](#StatusEnum) | This is a server generated attribute which provides the detailed status of an agreement. | [optional] - -## Enum: ReminderFrequencyEnum + +## Enum: TypeEnum Name | Value ---- | ----- -DAILY_UNTIL_SIGNED | "DAILY_UNTIL_SIGNED" -WEEKDAILY_UNTIL_SIGNED | "WEEKDAILY_UNTIL_SIGNED" -EVERY_OTHER_DAY_UNTIL_SIGNED | "EVERY_OTHER_DAY_UNTIL_SIGNED" -EVERY_THIRD_DAY_UNTIL_SIGNED | "EVERY_THIRD_DAY_UNTIL_SIGNED" -EVERY_FIFTH_DAY_UNTIL_SIGNED | "EVERY_FIFTH_DAY_UNTIL_SIGNED" -WEEKLY_UNTIL_SIGNED | "WEEKLY_UNTIL_SIGNED" -ONCE | "ONCE" +AGREEMENT | "AGREEMENT" +MEGASIGN_CHILD | "MEGASIGN_CHILD" +WIDGET_INSTANCE | "WIDGET_INSTANCE" + + + +## Enum: StateEnum +Name | Value +---- | ----- +AUTHORING | "AUTHORING" +DRAFT | "DRAFT" +IN_PROCESS | "IN_PROCESS" @@ -52,13 +64,17 @@ ESIGN | "ESIGN" WRITTEN | "WRITTEN" - -## Enum: StateEnum + +## Enum: ReminderFrequencyEnum Name | Value ---- | ----- -AUTHORING | "AUTHORING" -DRAFT | "DRAFT" -IN_PROCESS | "IN_PROCESS" +DAILY_UNTIL_SIGNED | "DAILY_UNTIL_SIGNED" +WEEKDAILY_UNTIL_SIGNED | "WEEKDAILY_UNTIL_SIGNED" +EVERY_OTHER_DAY_UNTIL_SIGNED | "EVERY_OTHER_DAY_UNTIL_SIGNED" +EVERY_THIRD_DAY_UNTIL_SIGNED | "EVERY_THIRD_DAY_UNTIL_SIGNED" +EVERY_FIFTH_DAY_UNTIL_SIGNED | "EVERY_FIFTH_DAY_UNTIL_SIGNED" +WEEKLY_UNTIL_SIGNED | "WEEKLY_UNTIL_SIGNED" +ONCE | "ONCE" diff --git a/docs/AgreementDocumentImageUrlsInfo.md b/docs/AgreementDocumentImageUrlsInfo.md index d40303a..31efba1 100755 --- a/docs/AgreementDocumentImageUrlsInfo.md +++ b/docs/AgreementDocumentImageUrlsInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**documentId** | **String** | Id of the document | [optional] **documentImageUrlsList** | [**List<DocumentImageUrls>**](DocumentImageUrls.md) | A list of documents image URLs. | [optional] +**documentId** | **String** | Id of the document | [optional] diff --git a/docs/AgreementDocuments.md b/docs/AgreementDocuments.md index b0a82d2..b66e108 100755 --- a/docs/AgreementDocuments.md +++ b/docs/AgreementDocuments.md @@ -5,7 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **documents** | [**List<Document>**](Document.md) | A list of documents | [optional] -**supportingDocuments** | [**List<SupportingDocument>**](SupportingDocument.md) | A list of supporting documents | [optional] diff --git a/docs/AgreementEvent.md b/docs/AgreementEvent.md index 8b2414f..2779d95 100755 --- a/docs/AgreementEvent.md +++ b/docs/AgreementEvent.md @@ -4,43 +4,26 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**actingUserEmail** | **String** | Email address of the user that created the event | [optional] -**actingUserIpAddress** | **String** | The IP address of the user that created the event | [optional] -**actingUserName** | **String** | The name of the acting user | [optional] -**comment** | **String** | The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant | [optional] **date** | [**Date**](Date.md) | The date of the audit event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**description** | **String** | A description of the audit event | [optional] -**deviceLocation** | [**DeviceLocation**](DeviceLocation.md) | Location of the device that generated the event (This value may be null due to limited privileges) | [optional] -**devicePhoneNumber** | **String** | Phone number from the device used when the participation is completed on a mobile phone | [optional] -**digitalSignatureInfo** | [**DigitalSignatureInfo**](DigitalSignatureInfo.md) | This is present for ESIGNED events when the participation is signed digitally | [optional] -**initiatingUserEmail** | **String** | Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect | [optional] **initiatingUserName** | **String** | Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect | [optional] +**description** | **String** | A description of the audit event | [optional] +**actingUserName** | **String** | The name of the acting user | [optional] +**actingUserIpAddress** | **String** | The IP address of the user that created the event | [optional] **participantEmail** | **String** | Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to | [optional] -**participantId** | **String** | The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to | [optional] -**participantRole** | [**ParticipantRoleEnum**](#ParticipantRoleEnum) | Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). | [optional] -**synchronizationId** | **String** | A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null) | [optional] **type** | [**TypeEnum**](#TypeEnum) | Type of agreement event | [optional] +**participantRole** | [**ParticipantRoleEnum**](#ParticipantRoleEnum) | Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). | [optional] **vaultEventId** | **String** | The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null) | [optional] -**vaultProviderName** | **String** | Name of the vault provider for the vault event (if vaulted, otherwise null) | [optional] +**participantId** | **String** | The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to | [optional] **versionId** | **String** | An ID which uniquely identifies the version of the document associated with this audit event | [optional] - - - -## Enum: ParticipantRoleEnum -Name | Value ----- | ----- -SIGNER | "SIGNER" -DELEGATE_TO_SIGNER | "DELEGATE_TO_SIGNER" -APPROVER | "APPROVER" -DELEGATE_TO_APPROVER | "DELEGATE_TO_APPROVER" -ACCEPTOR | "ACCEPTOR" -DELEGATE_TO_ACCEPTOR | "DELEGATE_TO_ACCEPTOR" -FORM_FILLER | "FORM_FILLER" -DELEGATE_TO_FORM_FILLER | "DELEGATE_TO_FORM_FILLER" -CERTIFIED_RECIPIENT | "CERTIFIED_RECIPIENT" -DELEGATE_TO_CERTIFIED_RECIPIENT | "DELEGATE_TO_CERTIFIED_RECIPIENT" -SHARE | "SHARE" -SENDER | "SENDER" +**actingUserEmail** | **String** | Email address of the user that created the event | [optional] +**devicePhoneNumber** | **String** | Phone number from the device used when the participation is completed on a mobile phone | [optional] +**initiatingUserEmail** | **String** | Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect | [optional] +**digitalSignatureInfo** | [**DigitalSignatureInfo**](DigitalSignatureInfo.md) | This is present for ESIGNED events when the participation is signed digitally | [optional] +**vaultProviderName** | **String** | Name of the vault provider for the vault event (if vaulted, otherwise null) | [optional] +**comment** | **String** | The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant | [optional] +**id** | **String** | The identifier for the event. | [optional] +**synchronizationId** | **String** | A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null) | [optional] +**deviceLocation** | [**DeviceLocation**](DeviceLocation.md) | Location of the device that generated the event (This value may be null due to limited privileges) | [optional] @@ -96,6 +79,7 @@ SIGNED | "SIGNED" SIGNING_URL_REQUESTED | "SIGNING_URL_REQUESTED" UPLOADED_BY_SENDER | "UPLOADED_BY_SENDER" USER_ACK_AGREEMENT_MODIFIED | "USER_ACK_AGREEMENT_MODIFIED" +READY_TO_VAULT | "READY_TO_VAULT" VAULTED | "VAULTED" WEB_IDENTITY_AUTHENTICATED | "WEB_IDENTITY_AUTHENTICATED" WEB_IDENTITY_SPECIFIED | "WEB_IDENTITY_SPECIFIED" @@ -103,4 +87,22 @@ WRITTEN_DOWNLOAD | "WRITTEN_DOWNLOAD" WRITTEN_SIGNED | "WRITTEN_SIGNED" + +## Enum: ParticipantRoleEnum +Name | Value +---- | ----- +SIGNER | "SIGNER" +DELEGATE_TO_SIGNER | "DELEGATE_TO_SIGNER" +APPROVER | "APPROVER" +DELEGATE_TO_APPROVER | "DELEGATE_TO_APPROVER" +ACCEPTOR | "ACCEPTOR" +DELEGATE_TO_ACCEPTOR | "DELEGATE_TO_ACCEPTOR" +FORM_FILLER | "FORM_FILLER" +DELEGATE_TO_FORM_FILLER | "DELEGATE_TO_FORM_FILLER" +CERTIFIED_RECIPIENT | "CERTIFIED_RECIPIENT" +DELEGATE_TO_CERTIFIED_RECIPIENT | "DELEGATE_TO_CERTIFIED_RECIPIENT" +SHARE | "SHARE" +SENDER | "SENDER" + + diff --git a/docs/AgreementInfo.md b/docs/AgreementInfo.md index 9f68857..d8906ff 100755 --- a/docs/AgreementInfo.md +++ b/docs/AgreementInfo.md @@ -4,44 +4,56 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**groupId** | **String** | The unique identifier of the group to which the agreement belongs to. If not provided during agreement creation, primary group of the creator will be used | [optional] +**locale** | **String** | The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender | [optional] +**type** | [**TypeEnum**](#TypeEnum) | The kind of agreement | [optional] +**vaultingInfo** | [**VaultingInfo**](VaultingInfo.md) | Vaulting properties that allows Adobe Sign to securely store documents with a vault provider | [optional] +**securityOption** | [**SecurityOption**](SecurityOption.md) | Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation. | [optional] +**postSignOption** | [**PostSignOption**](PostSignOption.md) | URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation. | [optional] **ccs** | [**List<AgreementCcInfo>**](AgreementCcInfo.md) | A list of one or more CCs that will be copied in the agreement transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file. Should not be provided in offline agreement creation. | [optional] -**createdDate** | [**Date**](Date.md) | Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**deviceInfo** | [**OfflineDeviceInfo**](OfflineDeviceInfo.md) | Device info of the offline device. It should only be provided in case of offline agreement creation. | [optional] **documentVisibilityEnabled** | **Boolean** | If set to true, enable limited document visibility. Should not be provided in offline agreement creation. | [optional] -**emailOption** | [**EmailOption**](EmailOption.md) | Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement. | [optional] -**expirationTime** | [**Date**](Date.md) | Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. | [optional] -**externalId** | [**ExternalId**](ExternalId.md) | An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation. | [optional] -**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] -**firstReminderDelay** | **Integer** | Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation. | [optional] -**formFieldLayerTemplates** | [**List<FileInfo>**](FileInfo.md) | Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] +**isDocumentRetentionApplied** | **Boolean** | Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. | [optional] +**hasSignerIdentityReport** | **Boolean** | True if agreement has signer identity report available. If provided in POST or PUT, it will simply be ignored. | [optional] +**lastEventDate** | [**Date**](Date.md) | The date of the last event that occurred for this agreement. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**senderEmail** | **String** | Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored | [optional] **id** | **String** | The unique identifier of the agreement.If provided in POST, it will simply be ignored | [optional] -**locale** | **String** | The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender | [optional] +**state** | [**StateEnum**](#StateEnum) | The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID | [optional] **mergeFieldInfo** | [**List<MergefieldInfo>**](MergefieldInfo.md) | Optional default values for fields to merge into the document. The values will be presented to the signers for editable fields; for read-only fields the provided values will not be editable during the signing process. Merging data into fields is currently not supported when used with libraryDocumentId or libraryDocumentName. Only file and url are currently supported | [optional] +**firstReminderDelay** | **Integer** | Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation. | [optional] +**emailOption** | [**EmailOption**](EmailOption.md) | Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement. | [optional] +**signatureType** | [**SignatureTypeEnum**](#SignatureTypeEnum) | Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system | [optional] +**externalId** | [**ExternalId**](ExternalId.md) | An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation. | [optional] **message** | **String** | An optional message to the participants, describing what is being sent or why their signature is required | [optional] -**name** | **String** | The name of the agreement that will be used to identify it, in emails, website and other places | [optional] -**participantSetsInfo** | [**List<ParticipantSetInfo>**](ParticipantSetInfo.md) | A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc ), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document | [optional] -**postSignOption** | [**PostSignOption**](PostSignOption.md) | URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation. | [optional] +**deviceInfo** | [**OfflineDeviceInfo**](OfflineDeviceInfo.md) | Device info of the offline device. It should only be provided in case of offline agreement creation. | [optional] +**parentId** | **String** | The parent id of a megaSign child *OR* the originating id of a widget agreement instance | [optional] **reminderFrequency** | [**ReminderFrequencyEnum**](#ReminderFrequencyEnum) | Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used. Should not be provided in offline agreement creation. If provided in PUT as a different value than the current one, an error will be thrown. | [optional] -**securityOption** | [**SecurityOption**](SecurityOption.md) | Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation. | [optional] -**senderEmail** | **String** | Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored | [optional] -**signatureType** | [**SignatureTypeEnum**](#SignatureTypeEnum) | Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system | [optional] -**state** | [**StateEnum**](#StateEnum) | The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID | [optional] -**status** | [**StatusEnum**](#StatusEnum) | This is a server generated attribute which provides the detailed status of an agreement. | [optional] -**vaultingInfo** | [**VaultingInfo**](VaultingInfo.md) | Vaulting properties that allows Adobe Sign to securely store documents with a vault provider | [optional] +**createdDate** | [**Date**](Date.md) | Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**participantSetsInfo** | [**List<ParticipantSetInfo>**](ParticipantSetInfo.md) | A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document | [optional] +**hasFormFieldData** | **Boolean** | True if form field data is present. If provided in POST or PUT, it will simply be ignored. | [optional] +**expirationTime** | [**Date**](Date.md) | Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. | [optional] +**formFieldLayerTemplates** | [**List<FileInfo>**](FileInfo.md) | Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] +**name** | **String** | The name of the agreement that will be used to identify it, in emails, website and other places | [optional] +**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] **workflowId** | **String** | The identifier of custom workflow which defines the routing path of an agreement. Should not be provided in offline agreement creation. | [optional] +**status** | [**StatusEnum**](#StatusEnum) | This is a server generated attribute which provides the detailed status of an agreement. | [optional] - -## Enum: ReminderFrequencyEnum + +## Enum: TypeEnum Name | Value ---- | ----- -DAILY_UNTIL_SIGNED | "DAILY_UNTIL_SIGNED" -WEEKDAILY_UNTIL_SIGNED | "WEEKDAILY_UNTIL_SIGNED" -EVERY_OTHER_DAY_UNTIL_SIGNED | "EVERY_OTHER_DAY_UNTIL_SIGNED" -EVERY_THIRD_DAY_UNTIL_SIGNED | "EVERY_THIRD_DAY_UNTIL_SIGNED" -EVERY_FIFTH_DAY_UNTIL_SIGNED | "EVERY_FIFTH_DAY_UNTIL_SIGNED" -WEEKLY_UNTIL_SIGNED | "WEEKLY_UNTIL_SIGNED" -ONCE | "ONCE" +AGREEMENT | "AGREEMENT" +MEGASIGN_CHILD | "MEGASIGN_CHILD" +WIDGET_INSTANCE | "WIDGET_INSTANCE" + + + +## Enum: StateEnum +Name | Value +---- | ----- +AUTHORING | "AUTHORING" +DRAFT | "DRAFT" +IN_PROCESS | "IN_PROCESS" @@ -52,13 +64,17 @@ ESIGN | "ESIGN" WRITTEN | "WRITTEN" - -## Enum: StateEnum + +## Enum: ReminderFrequencyEnum Name | Value ---- | ----- -AUTHORING | "AUTHORING" -DRAFT | "DRAFT" -IN_PROCESS | "IN_PROCESS" +DAILY_UNTIL_SIGNED | "DAILY_UNTIL_SIGNED" +WEEKDAILY_UNTIL_SIGNED | "WEEKDAILY_UNTIL_SIGNED" +EVERY_OTHER_DAY_UNTIL_SIGNED | "EVERY_OTHER_DAY_UNTIL_SIGNED" +EVERY_THIRD_DAY_UNTIL_SIGNED | "EVERY_THIRD_DAY_UNTIL_SIGNED" +EVERY_FIFTH_DAY_UNTIL_SIGNED | "EVERY_FIFTH_DAY_UNTIL_SIGNED" +WEEKLY_UNTIL_SIGNED | "WEEKLY_UNTIL_SIGNED" +ONCE | "ONCE" diff --git a/docs/AgreementView.md b/docs/AgreementView.md index 0016d68..c8ad4d8 100755 --- a/docs/AgreementView.md +++ b/docs/AgreementView.md @@ -4,10 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**embeddedCode** | **String** | Embedded code of url of resource | [optional] -**expiration** | [**Date**](Date.md) | Expiration of user url | [optional] **isCurrent** | **Boolean** | True if this view is the current view | [optional] +**embeddedCode** | **String** | Embedded code of url of resource | [optional] **name** | [**NameEnum**](#NameEnum) | Name of the requested agreement view | [optional] +**expiration** | [**Date**](Date.md) | Expiration of user url | [optional] **url** | **String** | Url of resource location | [optional] diff --git a/docs/AgreementViewInfo.md b/docs/AgreementViewInfo.md index d3f4ab5..e1e842d 100755 --- a/docs/AgreementViewInfo.md +++ b/docs/AgreementViewInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**commonViewConfiguration** | [**CommonViewConfiguration**](CommonViewConfiguration.md) | Common view configuration for all the available views | [optional] **composeViewConfiguration** | [**ComposeViewConfiguration**](ComposeViewConfiguration.md) | Compose page view configuration | [optional] +**commonViewConfiguration** | [**CommonViewConfiguration**](CommonViewConfiguration.md) | Common view configuration for all the available views | [optional] **name** | [**NameEnum**](#NameEnum) | Name of the requested agreement view | [optional] diff --git a/docs/AgreementsApi.md b/docs/AgreementsApi.md index cedc725..56a12b2 100755 --- a/docs/AgreementsApi.md +++ b/docs/AgreementsApi.md @@ -1,6 +1,6 @@ # AgreementsApi -All URIs are relative to *http://localhost/api/rest/v6* +All URIs are relative to *https://secure.au1.echosign.com/api/rest/v6* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -10,8 +10,10 @@ Method | HTTP request | Description [**createDelegatedParticipantSets**](AgreementsApi.md#createDelegatedParticipantSets) | **POST** /agreements/{agreementId}/members/participantSets/{participantSetId}/delegatedParticipantSets | Creates a participantSet to which the agreement is forwarded for taking appropriate action. [**createReminderOnParticipant**](AgreementsApi.md#createReminderOnParticipant) | **POST** /agreements/{agreementId}/reminders | Creates a reminder on the specified participants of an agreement identified by agreementId in the path. [**createShareOnAgreement**](AgreementsApi.md#createShareOnAgreement) | **POST** /agreements/{agreementId}/members/share | Share an agreement with someone. +[**createSignerIdentityReport**](AgreementsApi.md#createSignerIdentityReport) | **POST** /agreements/{agreementId}/signerIdentityReport | Retrieves the signer identity report of an agreement identified by agreementId. [**deleteDocuments**](AgreementsApi.md#deleteDocuments) | **DELETE** /agreements/{agreementId}/documents | Deletes all the documents of an agreement. [**getAgreementInfo**](AgreementsApi.md#getAgreementInfo) | **GET** /agreements/{agreementId} | Retrieves the current status of an agreement. +[**getAgreementInfoForUser**](AgreementsApi.md#getAgreementInfoForUser) | **GET** /agreements/{agreementId}/me | Retrieves the agreement information related to the api caller [**getAgreementNoteForApiUser**](AgreementsApi.md#getAgreementNoteForApiUser) | **GET** /agreements/{agreementId}/me/note | Retrieves the latest note associated with an agreement. [**getAgreementReminder**](AgreementsApi.md#getAgreementReminder) | **GET** /agreements/{agreementId}/reminders/{reminderId} | Retrieves a specific reminder associated with an agreement [**getAgreementReminders**](AgreementsApi.md#getAgreementReminders) | **GET** /agreements/{agreementId}/reminders | Retrieves the reminders of an agreement, identified by agreementId in the path. @@ -39,6 +41,7 @@ Method | HTTP request | Description [**updateAgreementReminder**](AgreementsApi.md#updateAgreementReminder) | **PUT** /agreements/{agreementId}/reminders/{reminderId} | Updates an existing reminder for an agreement [**updateAgreementSecurityOptionsForParticipation**](AgreementsApi.md#updateAgreementSecurityOptionsForParticipation) | **PUT** /agreements/{agreementId}/members/participantSets/{participantSetId}/participants/{participantId}/securityOptions | Updates the security options for a particular participant. [**updateAgreementState**](AgreementsApi.md#updateAgreementState) | **PUT** /agreements/{agreementId}/state | Updates the state of an agreement identified by agreementId in the path. +[**updateAgreementVaulted**](AgreementsApi.md#updateAgreementVaulted) | **PUT** /agreements/{agreementId}/vaulted | Complete the vaulting process and update the agreement as vaulted. [**updateAgreementVisibility**](AgreementsApi.md#updateAgreementVisibility) | **PUT** /agreements/{agreementId}/me/visibility | Updates the visibility of an agreement. [**updateFormFields**](AgreementsApi.md#updateFormFields) | **PUT** /agreements/{agreementId}/formFields | Updates form fields of an agreement. This will replace all fields in AUTHORING mode agreements, and will replace all fields except for text tag generated fields in DRAFT mode agreements. [**updateParticipantSet**](AgreementsApi.md#updateParticipantSet) | **PUT** /agreements/{agreementId}/members/participantSets/{participantSetId} | Updates the participant set of an agreement identified by agreementId in the path. @@ -46,7 +49,7 @@ Method | HTTP request | Description # **addTemplateFieldsToAgreement** -> AgreementFormFields addTemplateFieldsToAgreement(authorization, ifMatch, agreementId, formFieldPostInfo, xApiUser, xOnBehalfOfUser) +> AgreementFormFields addTemplateFieldsToAgreement(authorization, agreementId, formFieldPostInfo, xApiUser, xOnBehalfOfUser, ifMatch) Adds template fields to an agreement @@ -59,13 +62,13 @@ Adds template fields to an agreement AgreementsApi apiInstance = new AgreementsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. FormFieldPostInfo formFieldPostInfo = new FormFieldPostInfo(); // FormFieldPostInfo | List of form fields to add or replace String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. try { - AgreementFormFields result = apiInstance.addTemplateFieldsToAgreement(authorization, ifMatch, agreementId, formFieldPostInfo, xApiUser, xOnBehalfOfUser); + AgreementFormFields result = apiInstance.addTemplateFieldsToAgreement(authorization, agreementId, formFieldPostInfo, xApiUser, xOnBehalfOfUser, ifMatch); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AgreementsApi#addTemplateFieldsToAgreement"); @@ -78,11 +81,11 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | **agreementId** | **String**| The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | **formFieldPostInfo** | [**FormFieldPostInfo**](FormFieldPostInfo.md)| List of form fields to add or replace | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] ### Return type @@ -354,9 +357,60 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + +# **createSignerIdentityReport** +> byte[] createSignerIdentityReport(authorization, agreementId, xApiUser, signerIdentityReportInfo) + +Retrieves the signer identity report of an agreement identified by agreementId. + +PDF file stream containing signer identify information + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.AgreementsApi; + + +AgreementsApi apiInstance = new AgreementsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +SignerIdentityReportInfo signerIdentityReportInfo = new SignerIdentityReportInfo(); // SignerIdentityReportInfo | Information about the agreement for which you want to create signer identity report. +try { + byte[] result = apiInstance.createSignerIdentityReport(authorization, agreementId, xApiUser, signerIdentityReportInfo); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling AgreementsApi#createSignerIdentityReport"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **agreementId** | **String**| The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **signerIdentityReportInfo** | [**SignerIdentityReportInfo**](SignerIdentityReportInfo.md)| Information about the agreement for which you want to create signer identity report. | [optional] + +### Return type + +**byte[]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/pdf, application/pdf;encoding=base64 + # **deleteDocuments** -> deleteDocuments(authorization, ifMatch, agreementId, xApiUser, xOnBehalfOfUser) +> deleteDocuments(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifMatch) Deletes all the documents of an agreement. @@ -369,12 +423,12 @@ Deletes all the documents of an agreement. AgreementsApi apiInstance = new AgreementsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. try { - apiInstance.deleteDocuments(authorization, ifMatch, agreementId, xApiUser, xOnBehalfOfUser); + apiInstance.deleteDocuments(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifMatch); } catch (ApiException e) { System.err.println("Exception when calling AgreementsApi#deleteDocuments"); e.printStackTrace(); @@ -386,10 +440,10 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_retention')\" oncontextmenu=\"this.href=oauthDoc('agreement_retention')\" target=\"oauthDoc\">agreement_retention</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | **agreementId** | **String**| The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] ### Return type @@ -406,7 +460,7 @@ No authorization required # **getAgreementInfo** -> AgreementInfo getAgreementInfo(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch) +> FetchedAgreementInfo getAgreementInfo(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch) Retrieves the current status of an agreement. @@ -424,7 +478,7 @@ String xApiUser = "xApiUser_example"; // String | The userId or email of API cal String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. try { - AgreementInfo result = apiInstance.getAgreementInfo(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + FetchedAgreementInfo result = apiInstance.getAgreementInfo(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AgreementsApi#getAgreementInfo"); @@ -444,7 +498,54 @@ Name | Type | Description | Notes ### Return type -[**AgreementInfo**](AgreementInfo.md) +[**FetchedAgreementInfo**](FetchedAgreementInfo.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **getAgreementInfoForUser** +> MyAgreementInfo getAgreementInfoForUser(authorization, agreementId, xApiUser) + +Retrieves the agreement information related to the api caller + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.AgreementsApi; + + +AgreementsApi apiInstance = new AgreementsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +try { + MyAgreementInfo result = apiInstance.getAgreementInfoForUser(authorization, agreementId, xApiUser); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling AgreementsApi#getAgreementInfoForUser"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **agreementId** | **String**| The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + +### Return type + +[**MyAgreementInfo**](MyAgreementInfo.md) ### Authorization @@ -573,7 +674,7 @@ String authorization = "authorization_example"; // String | An userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account -String status = "status_example"; // String | A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELLED, COMPLETE +String status = "status_example"; // String | A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELED, COMPLETE try { RemindersResponse result = apiInstance.getAgreementReminders(authorization, agreementId, xApiUser, xOnBehalfOfUser, status); System.out.println(result); @@ -591,7 +692,7 @@ Name | Type | Description | Notes **agreementId** | **String**| The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] - **status** | **String**| A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELLED, COMPLETE | [optional] + **status** | **String**| A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELED, COMPLETE | [optional] ### Return type @@ -608,7 +709,7 @@ No authorization required # **getAgreementSecurityOptionsForParticipation** -> ParticipantSecurityOption getAgreementSecurityOptionsForParticipation(authorization, agreementId, participantSetId, participantId, ifNoneMatch, xApiUser) +> ParticipantSecurityOption getAgreementSecurityOptionsForParticipation(authorization, agreementId, participantSetId, participantId, ifNoneMatch, xApiUser, xOnBehalfOfUser) Retrieves the security options for a particular participant. @@ -626,8 +727,9 @@ String participantSetId = "participantSetId_example"; // String | The participan String participantId = "participantId_example"; // String | The participant identifier String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account try { - ParticipantSecurityOption result = apiInstance.getAgreementSecurityOptionsForParticipation(authorization, agreementId, participantSetId, participantId, ifNoneMatch, xApiUser); + ParticipantSecurityOption result = apiInstance.getAgreementSecurityOptionsForParticipation(authorization, agreementId, participantSetId, participantId, ifNoneMatch, xApiUser, xOnBehalfOfUser); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AgreementsApi#getAgreementSecurityOptionsForParticipation"); @@ -645,6 +747,7 @@ Name | Type | Description | Notes **participantId** | **String**| The participant identifier | **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] ### Return type @@ -661,7 +764,7 @@ No authorization required # **getAgreements** -> UserAgreements getAgreements(authorization, xApiUser, xOnBehalfOfUser, externalId, showHiddenAgreements, cursor, pageSize) +> UserAgreements getAgreements(authorization, xApiUser, xOnBehalfOfUser, externalId, groupId, showHiddenAgreements, cursor, pageSize) Retrieves agreements for the user. @@ -677,11 +780,12 @@ String authorization = "authorization_example"; // String | An userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account String externalId = "externalId_example"; // String | Case-sensitive ExternalID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API. +String groupId = "groupId_example"; // String | The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. Boolean showHiddenAgreements = true; // Boolean | A query parameter to fetch all the hidden agreements along with the visible agreements. Default value is false. String cursor = "cursor_example"; // String | Used to navigate through the pages. If not provided, returns the first page. Integer pageSize = 56; // Integer | Number of intended items in the response page. If not provided, it is decided by the application settings. try { - UserAgreements result = apiInstance.getAgreements(authorization, xApiUser, xOnBehalfOfUser, externalId, showHiddenAgreements, cursor, pageSize); + UserAgreements result = apiInstance.getAgreements(authorization, xApiUser, xOnBehalfOfUser, externalId, groupId, showHiddenAgreements, cursor, pageSize); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AgreementsApi#getAgreements"); @@ -697,6 +801,7 @@ Name | Type | Description | Notes **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] **externalId** | **String**| Case-sensitive ExternalID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API. | [optional] + **groupId** | **String**| The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. | [optional] **showHiddenAgreements** | **Boolean**| A query parameter to fetch all the hidden agreements along with the visible agreements. Default value is false. | [optional] **cursor** | **String**| Used to navigate through the pages. If not provided, returns the first page. | [optional] **pageSize** | **Integer**| Number of intended items in the response page. If not provided, it is decided by the application settings. | [optional] @@ -958,7 +1063,7 @@ String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e- String versionId = "versionId_example"; // String | The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used. String participantId = "participantId_example"; // String | The participant identifier to be used to retrieve documents. If not mentioned, the participation of api caller is used. Boolean attachSupportingDocuments = true; // Boolean | When set to true, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true. -Boolean attachAuditReport = true; // Boolean | When set to true, attach an audit report to the signed agreement PDF. Default value is false +Boolean attachAuditReport = true; // Boolean | When set to true, attach an audit report to the signed agreement PDF. The default value is false. try { byte[] result = apiInstance.getCombinedDocument(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch, versionId, participantId, attachSupportingDocuments, attachAuditReport); System.out.println(result); @@ -980,7 +1085,7 @@ Name | Type | Description | Notes **versionId** | **String**| The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used. | [optional] **participantId** | **String**| The participant identifier to be used to retrieve documents. If not mentioned, the participation of api caller is used. | [optional] **attachSupportingDocuments** | **Boolean**| When set to true, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true. | [optional] - **attachAuditReport** | **Boolean**| When set to true, attach an audit report to the signed agreement PDF. Default value is false | [optional] + **attachAuditReport** | **Boolean**| When set to true, attach an audit report to the signed agreement PDF. The default value is false. | [optional] ### Return type @@ -1069,7 +1174,7 @@ String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or em String versionId = "versionId_example"; // String | The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used. String participantId = "participantId_example"; // String | The participant identifier to be used to retrieve documents. If not mentioned, the participation of api caller is used. Boolean attachSupportingDocuments = true; // Boolean | When set to true, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true. -Boolean attachAuditReport = true; // Boolean | When set to true, attach an audit report to the signed agreement PDF. Default value is false +Boolean attachAuditReport = true; // Boolean | When set to true, attach an audit report to the signed agreement PDF. The default value is false. try { DocumentUrl result = apiInstance.getCombinedDocumentUrl(authorization, agreementId, xApiUser, xOnBehalfOfUser, versionId, participantId, attachSupportingDocuments, attachAuditReport); System.out.println(result); @@ -1090,7 +1195,7 @@ Name | Type | Description | Notes **versionId** | **String**| The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used. | [optional] **participantId** | **String**| The participant identifier to be used to retrieve documents. If not mentioned, the participation of api caller is used. | [optional] **attachSupportingDocuments** | **Boolean**| When set to true, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true. | [optional] - **attachAuditReport** | **Boolean**| When set to true, attach an audit report to the signed agreement PDF. Default value is false | [optional] + **attachAuditReport** | **Boolean**| When set to true, attach an audit report to the signed agreement PDF. The default value is false. | [optional] ### Return type @@ -1478,7 +1583,7 @@ No authorization required # **getSigningUrl** -> SigningUrlResponse getSigningUrl(authorization, agreementId, xApiUser, ifNoneMatch) +> SigningUrlResponse getSigningUrl(authorization, agreementId, xApiUser, ifNoneMatch, expiry) Retrieves the URL for the e-sign page for the current signer(s) of an agreement. @@ -1494,8 +1599,9 @@ String authorization = "authorization_example"; // String | An userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. +Integer expiry = 56; // Integer | Lifetime of the esignUrl, between 30 and 315360000 seconds. If not provided, it is decided by the application settings. try { - SigningUrlResponse result = apiInstance.getSigningUrl(authorization, agreementId, xApiUser, ifNoneMatch); + SigningUrlResponse result = apiInstance.getSigningUrl(authorization, agreementId, xApiUser, ifNoneMatch, expiry); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AgreementsApi#getSigningUrl"); @@ -1511,6 +1617,7 @@ Name | Type | Description | Notes **agreementId** | **String**| The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] + **expiry** | **Integer**| Lifetime of the esignUrl, between 30 and 315360000 seconds. If not provided, it is decided by the application settings. | [optional] ### Return type @@ -1527,7 +1634,7 @@ No authorization required # **rejectAgreementForParticipation** -> rejectAgreementForParticipation(authorization, ifMatch, agreementId, participantSetId, participantId, agreementRejectionInfo, xApiUser) +> rejectAgreementForParticipation(authorization, agreementId, participantSetId, participantId, agreementRejectionInfo, ifMatch, xApiUser) Rejects the agreement for a participant. @@ -1540,14 +1647,14 @@ Rejects the agreement for a participant. AgreementsApi apiInstance = new AgreementsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. String participantSetId = "participantSetId_example"; // String | The participant set identifier String participantId = "participantId_example"; // String | The participant identifier AgreementRejectionInfo agreementRejectionInfo = new AgreementRejectionInfo(); // AgreementRejectionInfo | Participant rejection information required for rejecting the agreement +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. try { - apiInstance.rejectAgreementForParticipation(authorization, ifMatch, agreementId, participantSetId, participantId, agreementRejectionInfo, xApiUser); + apiInstance.rejectAgreementForParticipation(authorization, agreementId, participantSetId, participantId, agreementRejectionInfo, ifMatch, xApiUser); } catch (ApiException e) { System.err.println("Exception when calling AgreementsApi#rejectAgreementForParticipation"); e.printStackTrace(); @@ -1559,11 +1666,11 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | **agreementId** | **String**| The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | **participantSetId** | **String**| The participant set identifier | **participantId** | **String**| The participant identifier | **agreementRejectionInfo** | [**AgreementRejectionInfo**](AgreementRejectionInfo.md)| Participant rejection information required for rejecting the agreement | + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] ### Return type @@ -1581,7 +1688,7 @@ No authorization required # **updateAgreement** -> updateAgreement(authorization, ifMatch, agreementId, agreementInfo, xApiUser, xOnBehalfOfUser) +> updateAgreement(authorization, agreementId, agreementInfo, xApiUser, xOnBehalfOfUser, ifMatch) Updates the agreement in draft state, or update the expirationTime on an existing agreement that is already out for signature. @@ -1594,13 +1701,13 @@ Updates the agreement in draft state, or update the expirationTime on an existin AgreementsApi apiInstance = new AgreementsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. AgreementInfo agreementInfo = new AgreementInfo(); // AgreementInfo | Information necessary to update a modifiable agreement that is presently out for signature. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. try { - apiInstance.updateAgreement(authorization, ifMatch, agreementId, agreementInfo, xApiUser, xOnBehalfOfUser); + apiInstance.updateAgreement(authorization, agreementId, agreementInfo, xApiUser, xOnBehalfOfUser, ifMatch); } catch (ApiException e) { System.err.println("Exception when calling AgreementsApi#updateAgreement"); e.printStackTrace(); @@ -1612,11 +1719,11 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | **agreementId** | **String**| The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | **agreementInfo** | [**AgreementInfo**](AgreementInfo.md)| Information necessary to update a modifiable agreement that is presently out for signature. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] ### Return type @@ -1633,7 +1740,7 @@ No authorization required # **updateAgreementMergeInfo** -> updateAgreementMergeInfo(authorization, ifMatch, agreementId, formFieldMergeInfo, xApiUser, xOnBehalfOfUser) +> updateAgreementMergeInfo(authorization, agreementId, formFieldMergeInfo, xApiUser, xOnBehalfOfUser, ifMatch) Set the merge info for an agreement. @@ -1646,13 +1753,13 @@ Set the merge info for an agreement. AgreementsApi apiInstance = new AgreementsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. FormFieldMergeInfo formFieldMergeInfo = new FormFieldMergeInfo(); // FormFieldMergeInfo | A mapping indicating the default values to set for form fields String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. try { - apiInstance.updateAgreementMergeInfo(authorization, ifMatch, agreementId, formFieldMergeInfo, xApiUser, xOnBehalfOfUser); + apiInstance.updateAgreementMergeInfo(authorization, agreementId, formFieldMergeInfo, xApiUser, xOnBehalfOfUser, ifMatch); } catch (ApiException e) { System.err.println("Exception when calling AgreementsApi#updateAgreementMergeInfo"); e.printStackTrace(); @@ -1664,11 +1771,11 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | **agreementId** | **String**| The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | **formFieldMergeInfo** | [**FormFieldMergeInfo**](FormFieldMergeInfo.md)| A mapping indicating the default values to set for form fields | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] ### Return type @@ -1789,7 +1896,7 @@ No authorization required # **updateAgreementSecurityOptionsForParticipation** -> updateAgreementSecurityOptionsForParticipation(authorization, ifMatch, agreementId, participantSetId, participantId, participantSecurityOption, xApiUser) +> updateAgreementSecurityOptionsForParticipation(authorization, agreementId, participantSetId, participantId, participantSecurityOption, ifMatch, xApiUser, xOnBehalfOfUser) Updates the security options for a particular participant. @@ -1802,14 +1909,15 @@ Updates the security options for a particular participant. AgreementsApi apiInstance = new AgreementsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. String participantSetId = "participantSetId_example"; // String | The participant set identifier String participantId = "participantId_example"; // String | The participant identifier ParticipantSecurityOption participantSecurityOption = new ParticipantSecurityOption(); // ParticipantSecurityOption | Security options that apply to the participant +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account try { - apiInstance.updateAgreementSecurityOptionsForParticipation(authorization, ifMatch, agreementId, participantSetId, participantId, participantSecurityOption, xApiUser); + apiInstance.updateAgreementSecurityOptionsForParticipation(authorization, agreementId, participantSetId, participantId, participantSecurityOption, ifMatch, xApiUser, xOnBehalfOfUser); } catch (ApiException e) { System.err.println("Exception when calling AgreementsApi#updateAgreementSecurityOptionsForParticipation"); e.printStackTrace(); @@ -1821,12 +1929,13 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | **agreementId** | **String**| The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | **participantSetId** | **String**| The participant set identifier | **participantId** | **String**| The participant identifier | **participantSecurityOption** | [**ParticipantSecurityOption**](ParticipantSecurityOption.md)| Security options that apply to the participant | + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] ### Return type @@ -1843,7 +1952,7 @@ No authorization required # **updateAgreementState** -> updateAgreementState(authorization, ifMatch, agreementId, agreementStateInfo, xApiUser, xOnBehalfOfUser) +> updateAgreementState(authorization, agreementId, agreementStateInfo, xApiUser, xOnBehalfOfUser, ifMatch) Updates the state of an agreement identified by agreementId in the path. @@ -1858,13 +1967,13 @@ This endpoint can be used by originator/sender of an agreement to transition bet AgreementsApi apiInstance = new AgreementsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. AgreementStateInfo agreementStateInfo = new AgreementStateInfo(); // AgreementStateInfo | String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. try { - apiInstance.updateAgreementState(authorization, ifMatch, agreementId, agreementStateInfo, xApiUser, xOnBehalfOfUser); + apiInstance.updateAgreementState(authorization, agreementId, agreementStateInfo, xApiUser, xOnBehalfOfUser, ifMatch); } catch (ApiException e) { System.err.println("Exception when calling AgreementsApi#updateAgreementState"); e.printStackTrace(); @@ -1876,11 +1985,61 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | **agreementId** | **String**| The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | **agreementStateInfo** | [**AgreementStateInfo**](AgreementStateInfo.md)| | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **updateAgreementVaulted** +> updateAgreementVaulted(authorization, agreementId, vaultEventInfo, xApiUser, xOnBehalfOfUser) + +Complete the vaulting process and update the agreement as vaulted. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.AgreementsApi; + + +AgreementsApi apiInstance = new AgreementsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. +VaultEventInfo vaultEventInfo = new VaultEventInfo(); // VaultEventInfo | Information to vault an agreement +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +try { + apiInstance.updateAgreementVaulted(authorization, agreementId, vaultEventInfo, xApiUser, xOnBehalfOfUser); +} catch (ApiException e) { + System.err.println("Exception when calling AgreementsApi#updateAgreementVaulted"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_vault')\" oncontextmenu=\"this.href=oauthDoc('agreement_vault')\" target=\"oauthDoc\">agreement_vault</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **agreementId** | **String**| The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | + **vaultEventInfo** | [**VaultEventInfo**](VaultEventInfo.md)| Information to vault an agreement | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] ### Return type @@ -1947,7 +2106,7 @@ No authorization required # **updateFormFields** -> AgreementFormFields updateFormFields(authorization, ifMatch, agreementId, formFieldPutInfo, xApiUser, xOnBehalfOfUser) +> AgreementFormFields updateFormFields(authorization, agreementId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, ifMatch) Updates form fields of an agreement. This will replace all fields in AUTHORING mode agreements, and will replace all fields except for text tag generated fields in DRAFT mode agreements. @@ -1960,13 +2119,13 @@ Updates form fields of an agreement. This will replace all fields in AUTHORING AgreementsApi apiInstance = new AgreementsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. -FormFieldPutInfo formFieldPutInfo = new FormFieldPutInfo(); // FormFieldPutInfo | List of form fields to add or replace +FormFieldPutInfo formFieldPutInfo = new FormFieldPutInfo(); // FormFieldPutInfo | List of form fields to set for agreement String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. try { - AgreementFormFields result = apiInstance.updateFormFields(authorization, ifMatch, agreementId, formFieldPutInfo, xApiUser, xOnBehalfOfUser); + AgreementFormFields result = apiInstance.updateFormFields(authorization, agreementId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, ifMatch); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AgreementsApi#updateFormFields"); @@ -1979,11 +2138,11 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | **agreementId** | **String**| The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | - **formFieldPutInfo** | [**FormFieldPutInfo**](FormFieldPutInfo.md)| List of form fields to add or replace | + **formFieldPutInfo** | [**FormFieldPutInfo**](FormFieldPutInfo.md)| List of form fields to set for agreement | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] ### Return type @@ -2000,7 +2159,7 @@ No authorization required # **updateParticipantSet** -> updateParticipantSet(authorization, ifMatch, agreementId, participantSetId, detailedParticipantSetInfo, xApiUser, xOnBehalfOfUser) +> updateParticipantSet(authorization, agreementId, participantSetId, detailedParticipantSetInfo, xApiUser, xOnBehalfOfUser, ifMatch) Updates the participant set of an agreement identified by agreementId in the path. @@ -2013,14 +2172,14 @@ Updates the participant set of an agreement identified by agreementId in the pat AgreementsApi apiInstance = new AgreementsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String agreementId = "agreementId_example"; // String | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. String participantSetId = "participantSetId_example"; // String | The participant set identifier DetailedParticipantSetInfo detailedParticipantSetInfo = new DetailedParticipantSetInfo(); // DetailedParticipantSetInfo | The new participant set info. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. try { - apiInstance.updateParticipantSet(authorization, ifMatch, agreementId, participantSetId, detailedParticipantSetInfo, xApiUser, xOnBehalfOfUser); + apiInstance.updateParticipantSet(authorization, agreementId, participantSetId, detailedParticipantSetInfo, xApiUser, xOnBehalfOfUser, ifMatch); } catch (ApiException e) { System.err.println("Exception when calling AgreementsApi#updateParticipantSet"); e.printStackTrace(); @@ -2032,12 +2191,12 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | **agreementId** | **String**| The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | **participantSetId** | **String**| The participant set identifier | **detailedParticipantSetInfo** | [**DetailedParticipantSetInfo**](DetailedParticipantSetInfo.md)| The new participant set info. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] ### Return type diff --git a/docs/BaseUrisApi.md b/docs/BaseUrisApi.md index 0aa769e..b18b078 100755 --- a/docs/BaseUrisApi.md +++ b/docs/BaseUrisApi.md @@ -1,6 +1,6 @@ # BaseUrisApi -All URIs are relative to *http://localhost/api/rest/v6* +All URIs are relative to *https://secure.au1.echosign.com/api/rest/v6* Method | HTTP request | Description ------------- | ------------- | ------------- diff --git a/docs/BasicDocumentsImageUrlsInfo.md b/docs/BasicDocumentsImageUrlsInfo.md new file mode 100644 index 0000000..1b49ad9 --- /dev/null +++ b/docs/BasicDocumentsImageUrlsInfo.md @@ -0,0 +1,10 @@ + +# BasicDocumentsImageUrlsInfo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**documentsImageUrlsInfo** | [**List<DocumentImageUrlsInfo>**](DocumentImageUrlsInfo.md) | A list of original document image URLs info. | [optional] + + + diff --git a/docs/BooleanSettingInfo.md b/docs/BooleanSettingInfo.md new file mode 100644 index 0000000..039aa4f --- /dev/null +++ b/docs/BooleanSettingInfo.md @@ -0,0 +1,11 @@ + +# BooleanSettingInfo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**inherited** | **Boolean** | True if setting is inherited from its group or account value. | [optional] +**value** | **Boolean** | Value of the setting. | [optional] + + + diff --git a/docs/CCParticipantInfo.md b/docs/CCParticipantInfo.md index 9ea61b5..29aa01f 100755 --- a/docs/CCParticipantInfo.md +++ b/docs/CCParticipantInfo.md @@ -4,10 +4,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**company** | **String** | Company of the CC participant, if available. | [optional] -**email** | **String** | Email of the CC participant of the widget | [optional] +**participantId** | **String** | The unique identifier of the CC participant of the web form. | [optional] +**hidden** | **Boolean** | True if the web form is hidden for the user that is calling the API. Only returned if self is true. | [optional] **name** | **String** | Name of the CC participant, if available. | [optional] -**participantId** | **String** | The unique identifier of the CC participant of the widget. | [optional] +**self** | **Boolean** | True if the CC participant of the web form is the same user that is calling the API. | [optional] +**company** | **String** | Company of the CC participant, if available. | [optional] +**email** | **String** | Email of the CC participant of the web form | [optional] diff --git a/docs/CCsListInfoDescription.md b/docs/CCsListInfoDescription.md new file mode 100644 index 0000000..cfeb62f --- /dev/null +++ b/docs/CCsListInfoDescription.md @@ -0,0 +1,17 @@ + +# CCsListInfoDescription + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**minListCount** | **Integer** | minimum number of entries allowed in the current CC list | [optional] +**visible** | **Boolean** | Whether current field is visible or not. If visible attribute for this field is false then this field should not be shown in the agreement creation page using this workflow | [optional] +**editable** | **Boolean** | Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation | [optional] +**name** | **String** | Name of the current CC list | [optional] +**defaultValues** | **List<String>** | An array of default emails that will be used if no input is provided for this list element. | [optional] +**maxListCount** | **Integer** | maximum number of entries allowed in the current CC list | [optional] +**label** | **String** | A display text for the workflow user that can be used for the current CC list | [optional] +**required** | **Boolean** | Whether this field is required or optional | [optional] + + + diff --git a/docs/CommonViewConfiguration.md b/docs/CommonViewConfiguration.md index d418249..b6b8c47 100755 --- a/docs/CommonViewConfiguration.md +++ b/docs/CommonViewConfiguration.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **autoLoginUser** | **Boolean** | Auto LogIn Flag. If true, the URL returned will automatically log the user in. If false, the URL returned will require the credentials. By default its value is false | [optional] -**locale** | **String** | Message template locale | [optional] **noChrome** | **Boolean** | No Chrome Flag. If true, the embedded page is shown without a navigation header or footer. If false, the standard page header and footer will be present. By default its value is false | [optional] +**locale** | **String** | Message template locale | [optional] diff --git a/docs/DelegatedParticipantSetInfo.md b/docs/DelegatedParticipantSetInfo.md index 3d66dbe..5c00194 100755 --- a/docs/DelegatedParticipantSetInfo.md +++ b/docs/DelegatedParticipantSetInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**memberInfos** | [**List<DelegatedParticipantInfo>**](DelegatedParticipantInfo.md) | Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set | [optional] **privateMessage** | **String** | Participant set's private message - all participants in the set will receive the same message. This cannot be changed as part of the PUT call. | [optional] +**memberInfos** | [**List<DelegatedParticipantInfo>**](DelegatedParticipantInfo.md) | Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set | [optional] diff --git a/docs/DetailedGroupInfo.md b/docs/DetailedGroupInfo.md index f4ede6d..b0ac48e 100755 --- a/docs/DetailedGroupInfo.md +++ b/docs/DetailedGroupInfo.md @@ -4,9 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | [**Date**](Date.md) | Date of creation of the group. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**id** | **String** | The unique identifier of the Group. This will be returned as part of GET call but is not mandatory to be passed as part of PUT/POST call for groups/{groupId} | [optional] +**isDefaultGroup** | **Boolean** | Is the default group for the account | [optional] +**created** | [**Date**](Date.md) | Date of creation of the group. This will be ignored as part of POST or PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] **name** | **String** | Name of the group | [optional] +**id** | **String** | The unique identifier of the Group. This will be returned as part of GET call but is not mandatory to be passed as part of PUT/POST call for groups/{groupId} | [optional] diff --git a/docs/DetailedParticipantInfo.md b/docs/DetailedParticipantInfo.md index f3009b3..13eda46 100755 --- a/docs/DetailedParticipantInfo.md +++ b/docs/DetailedParticipantInfo.md @@ -4,23 +4,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**createdDate** | [**Date**](Date.md) | The date when the participant was added. This will be returned as part of GET call but is ignored if passed as part of PUT call. | [optional] +**hidden** | **Boolean** | True if the agreement is hidden for the user that is calling the API. Only returned if self is true. Ignored (not required) if modifying a participant (PUT). | [optional] +**name** | **String** | The name of the participant, if available. This cannot be changed as part of the PUT call. | [optional] +**self** | **Boolean** | True if this participant is the same user that is calling the API. Returned as part of Get. Ignored (not required) if modifying a participant set (PUT). | [optional] **company** | **String** | The company of the participant, if available. This cannot be changed as part of the PUT call. | [optional] -**email** | **String** | Email of the participant. In case of modifying a participant set (PUT) this is a required field. In case of GET, this is the required field and will always be returned unless it is a fax workflow (legacy agreements) that were created using fax as input | [optional] -**fax** | **String** | Fax of the participant. New Agreements can not be created with fax option. This is only returned for legacy agreements created with fax as participants | [optional] **id** | **String** | The unique identifier of the participant. This will be returned as part of Get call but is not mandatory to be passed as part of PUT call for agreements/{id}/members/participantSets/{id}. | [optional] -**name** | **String** | The name of the participant, if available. This cannot be changed as part of the PUT call. | [optional] -**privateMessage** | **String** | The private message of the participant, if available. This cannot be changed as part of the PUT call. | [optional] +**userId** | **String** | The user ID of the participant. This will be returned as part of GET call but is ignored if passed as part of PUT call. | [optional] +**email** | **String** | Email of the participant. In case of modifying a participant set (PUT) this is a required field. In case of GET, this is the required field and will always be returned unless it is a fax workflow (legacy agreements) that were created using fax as input | [optional] **securityOption** | [**ParticipantSecurityOption**](ParticipantSecurityOption.md) | Security options that apply to the participant. | [optional] -**self** | **Boolean** | True if this participant is the same user that is calling the API. Returned as part of Get. Ignored (not required) if modifying a participant set (PUT). | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the participant. This cannot be changed as part of the PUT call. New participants will be ignored if added with a REPLACED status. | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -REPLACED | "REPLACED" -ACTIVE | "ACTIVE" diff --git a/docs/DetailedParticipantSetInfo.md b/docs/DetailedParticipantSetInfo.md index 40b109f..12921af 100755 --- a/docs/DetailedParticipantSetInfo.md +++ b/docs/DetailedParticipantSetInfo.md @@ -4,13 +4,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | The unique identifier of the participant set. This cannot be changed as part of the PUT call. | [optional] +**role** | [**RoleEnum**](#RoleEnum) | Role assumed by all participants in the set (signer, approver etc.). | [optional] +**name** | **String** | Name of ParticipantSet (it can be empty, but needs not to be unique in a single megaSign). Maximum no of characters in participant set name is restricted to 255. | [optional] +**id** | **String** | The unique identifier of the participant set. | [optional] +**privateMessage** | **String** | Participant set's private message - all participants in the set will receive the same message. | [optional] **memberInfos** | [**List<DetailedParticipantInfo>**](DetailedParticipantInfo.md) | Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set | [optional] -**name** | **String** | Name of ParticipantSet (it can be empty, but needs not to be unique in a single agreement). Maximum no of characters in participant set name is restricted to 255. This cannot be changed as part of the PUT call. | [optional] -**order** | **Integer** | Index indicating sequential signing group (specified for hybrid routing). This cannot be changed as part of the PUT call. | [optional] -**privateMessage** | **String** | Participant set's private message - all participants in the set will receive the same message. This cannot be changed as part of the PUT call. | [optional] -**role** | [**RoleEnum**](#RoleEnum) | Role assumed by all participants in the set (signer, approver etc.). This cannot be changed as part of the PUT call. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The agreement status with respect to the participant set. This cannot be changed as part of the PUT call. | [optional] +**order** | **Integer** | Index indicating sequential signing group (specified for hybrid routing). | [optional] +**status** | [**StatusEnum**](#StatusEnum) | The megaSign status with respect to the participant set. | [optional] diff --git a/docs/DetailedUserInfo.md b/docs/DetailedUserInfo.md index 1d61cea..1f075fd 100755 --- a/docs/DetailedUserInfo.md +++ b/docs/DetailedUserInfo.md @@ -4,18 +4,21 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**accountType** | [**AccountTypeEnum**](#AccountTypeEnum) | Type of account to which the user belongs (null if no account) | [optional] -**company** | **String** | The name of company of the user | [optional] -**email** | **String** | The email address of the user | [optional] -**firstName** | **String** | The first name of the user | [optional] -**id** | **String** | A unique identifier of the user resource for REST APIs as issued by Sign. | [optional] -**initials** | **String** | The initials of the user | [optional] -**isAccountAdmin** | **Boolean** | True if the user is account admin | [optional] **lastName** | **String** | The last name of the user | [optional] +**initials** | **String** | The initials of the user | [optional] +**accountType** | [**AccountTypeEnum**](#AccountTypeEnum) | Type of account to which the user belongs (null if no account). If provided in POST or PUT it will be ignored. | [optional] **locale** | **String** | The UI locale of the user | [optional] -**phone** | **String** | The phone number of the user | [optional] -**status** | [**StatusEnum**](#StatusEnum) | Status of the user | [optional] **title** | **String** | The job title of the user | [optional] +**accountId** | **String** | The account id of the user | [optional] +**firstName** | **String** | The first name of the user | [optional] +**isAccountAdmin** | **Boolean** | True if the user is account admin | [optional] +**createdDate** | [**Date**](Date.md) | The date the user was created. If provided in POST or PUT it will be ignored | [optional] +**phone** | **String** | The phone number of the user | [optional] +**primaryGroupId** | **String** | Primary group in which the new user should be added. Default is the default group for the account the user is being added to. This will be ignored as part of PUT calls | [optional] +**company** | **String** | The name of company of the user | [optional] +**id** | **String** | A unique identifier of the user resource for REST APIs as issued by Sign. | [optional] +**email** | **String** | The email address of the user | [optional] +**status** | [**StatusEnum**](#StatusEnum) | Status of the user. If provided in POST it will be ignored. | [optional] diff --git a/docs/DetailedWidgetParticipantSetInfo.md b/docs/DetailedWidgetParticipantSetInfo.md index c013e2b..77a0516 100755 --- a/docs/DetailedWidgetParticipantSetInfo.md +++ b/docs/DetailedWidgetParticipantSetInfo.md @@ -4,10 +4,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**providerParticipantSetInfo** | [**ProviderParticipantSetInfo**](ProviderParticipantSetInfo.md) | Represents the attributes related to a unknown participant's provider. | [optional] +**role** | [**RoleEnum**](#RoleEnum) | Role assumed by all participants in the set (signer, approver etc.). This cannot be changed as part of the PUT call. | [optional] **id** | **String** | The unique identifier of the participant set. This cannot be changed as part of the PUT call. | [optional] **memberInfos** | [**List<DetailedParticipantInfo>**](DetailedParticipantInfo.md) | Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set | [optional] **order** | **Integer** | Index indicating sequential signing group (specified for hybrid routing). This cannot be changed as part of the PUT call. | [optional] -**role** | [**RoleEnum**](#RoleEnum) | Role assumed by all participants in the set (signer, approver etc.). This cannot be changed as part of the PUT call. | [optional] diff --git a/docs/DigitalSignatureInfo.md b/docs/DigitalSignatureInfo.md index 6f1b970..c191d34 100755 --- a/docs/DigitalSignatureInfo.md +++ b/docs/DigitalSignatureInfo.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**name** | **String** | Name captured during digital signing | [optional] **company** | **String** | Company name captured during digital signing | [optional] **email** | **String** | Email captured during digital signing | [optional] -**name** | **String** | Name captured during digital signing | [optional] diff --git a/docs/DisplayParticipantInfo.md b/docs/DisplayParticipantInfo.md index 1db2afd..94d1ebf 100755 --- a/docs/DisplayParticipantInfo.md +++ b/docs/DisplayParticipantInfo.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**fullName** | **String** | Displays the full name of the user, if available. | [optional] **company** | **String** | Displays the name of the company of the user, if available | [optional] **email** | **String** | Displays the email of the user | [optional] -**fullName** | **String** | Displays the full name of the user, if available. | [optional] diff --git a/docs/Document.md b/docs/Document.md index c8073b2..a4fb08e 100755 --- a/docs/Document.md +++ b/docs/Document.md @@ -4,11 +4,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**numPages** | **Integer** | Number of pages in the document | [optional] +**createdDate** | [**Date**](Date.md) | The date the document was created | [optional] +**name** | **String** | Name of the original document uploaded. This is returned in GET but not accepted back in PUT | [optional] **id** | **String** | ID of the document. In case of PUT call, this is the only field that is accepted in Document structure. Name and mimeType are ignored in case of PUT call | [optional] **label** | **String** | Label of the document | [optional] **mimeType** | **String** | mimeType of the original file. This is returned in GET but not accepted back in PUT | [optional] -**name** | **String** | Name of the original document uploaded. This is returned in GET but not accepted back in PUT | [optional] -**numPages** | **Integer** | Number of pages in the document | [optional] diff --git a/docs/DocumentImageUrls.md b/docs/DocumentImageUrls.md index 2691193..4533206 100755 --- a/docs/DocumentImageUrls.md +++ b/docs/DocumentImageUrls.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**imageSize** | [**ImageSizeEnum**](#ImageSizeEnum) | ImageSize corresponding to the imageUrl returned | [optional] **imageURLs** | [**List<PageImageUrl>**](PageImageUrl.md) | A list of image url (one per page). | [optional] **imagesAvailable** | **Boolean** | true if images for the associated image size is available, else false. | [optional] +**imageSize** | [**ImageSizeEnum**](#ImageSizeEnum) | ImageSize corresponding to the imageUrl returned | [optional] diff --git a/docs/DocumentImageUrlsInfo.md b/docs/DocumentImageUrlsInfo.md index 722357d..a2d5e44 100755 --- a/docs/DocumentImageUrlsInfo.md +++ b/docs/DocumentImageUrlsInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**documentId** | **String** | Id of the document | [optional] **documentImageUrlsList** | [**List<DocumentImageUrls>**](DocumentImageUrls.md) | A list of documents image URLs. | [optional] +**documentId** | **String** | Id of the document | [optional] diff --git a/docs/DocumentPageInfo.md b/docs/DocumentPageInfo.md index e48d9e9..a9a000c 100755 --- a/docs/DocumentPageInfo.md +++ b/docs/DocumentPageInfo.md @@ -4,10 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**height** | **Double** | Height of the page | [optional] -**index** | **Integer** | Index of the page in combined document starting from 1 | [optional] **rotation** | **Double** | Rotation angle of the page in clockwise direction in degree | [optional] **width** | **Double** | Width of the page | [optional] +**index** | **Integer** | Index of the page in combined document starting from 1 | [optional] +**height** | **Double** | Height of the page | [optional] diff --git a/docs/DocumentsImageUrlsInfo.md b/docs/DocumentsImageUrlsInfo.md index 7d9c8dd..01f42f2 100755 --- a/docs/DocumentsImageUrlsInfo.md +++ b/docs/DocumentsImageUrlsInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**originalDocumentsImageUrlsInfo** | [**List<DocumentImageUrlsInfo>**](DocumentImageUrlsInfo.md) | A list of original document image URLs info. | [optional] **supportingDocumentsImageUrlsInfo** | [**List<DocumentImageUrlsInfo>**](DocumentImageUrlsInfo.md) | A list of supporting document image URLs info. | [optional] +**originalDocumentsImageUrlsInfo** | [**List<DocumentImageUrlsInfo>**](DocumentImageUrlsInfo.md) | A list of original document image URLs info. | [optional] diff --git a/docs/ExpirationFieldInfoDescription.md b/docs/ExpirationFieldInfoDescription.md new file mode 100644 index 0000000..d32918c --- /dev/null +++ b/docs/ExpirationFieldInfoDescription.md @@ -0,0 +1,14 @@ + +# ExpirationFieldInfoDescription + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**maxDays** | **Integer** | Maximum number of days for agreement expiration | [optional] +**visible** | **Boolean** | Whether current field is visible or not. If visible attribute for this field is false then this field should not be visible in the agreement creation UI using this workflow to user | [optional] +**defaultValue** | **String** | default value of the field if input for this field is not provided and this field is required | [optional] +**editable** | **Boolean** | Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation | [optional] +**required** | **Boolean** | Whether this field is required or optional | [optional] + + + diff --git a/docs/FetchedAgreementInfo.md b/docs/FetchedAgreementInfo.md new file mode 100644 index 0000000..447819d --- /dev/null +++ b/docs/FetchedAgreementInfo.md @@ -0,0 +1,106 @@ + +# FetchedAgreementInfo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**groupId** | **String** | The unique identifier of the group to which the agreement belongs to. If not provided during agreement creation, primary group of the creator will be used | [optional] +**locale** | **String** | The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender | [optional] +**type** | [**TypeEnum**](#TypeEnum) | The kind of agreement | [optional] +**vaultingInfo** | [**VaultingInfo**](VaultingInfo.md) | Vaulting properties that allows Adobe Sign to securely store documents with a vault provider | [optional] +**securityOption** | [**SecurityOption**](SecurityOption.md) | Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation. | [optional] +**postSignOption** | [**PostSignOption**](PostSignOption.md) | URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation. | [optional] +**ccs** | [**List<AgreementCcInfo>**](AgreementCcInfo.md) | A list of one or more CCs that will be copied in the agreement transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file. Should not be provided in offline agreement creation. | [optional] +**documentVisibilityEnabled** | **Boolean** | If set to true, enable limited document visibility. Should not be provided in offline agreement creation. | [optional] +**isDocumentRetentionApplied** | **Boolean** | Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. | [optional] +**hasSignerIdentityReport** | **Boolean** | True if agreement has signer identity report available. If provided in POST or PUT, it will simply be ignored. | [optional] +**lastEventDate** | [**Date**](Date.md) | The date of the last event that occurred for this agreement. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**senderEmail** | **String** | Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored | [optional] +**id** | **String** | The unique identifier of the agreement.If provided in POST, it will simply be ignored | [optional] +**state** | [**StateEnum**](#StateEnum) | The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID | [optional] +**mergeFieldInfo** | [**List<MergefieldInfo>**](MergefieldInfo.md) | Optional default values for fields to merge into the document. The values will be presented to the signers for editable fields; for read-only fields the provided values will not be editable during the signing process. Merging data into fields is currently not supported when used with libraryDocumentId or libraryDocumentName. Only file and url are currently supported | [optional] +**firstReminderDelay** | **Integer** | Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation. | [optional] +**emailOption** | [**EmailOption**](EmailOption.md) | Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement. | [optional] +**signatureType** | [**SignatureTypeEnum**](#SignatureTypeEnum) | Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system | [optional] +**externalId** | [**ExternalId**](ExternalId.md) | An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation. | [optional] +**message** | **String** | An optional message to the participants, describing what is being sent or why their signature is required | [optional] +**deviceInfo** | [**OfflineDeviceInfo**](OfflineDeviceInfo.md) | Device info of the offline device. It should only be provided in case of offline agreement creation. | [optional] +**parentId** | **String** | The parent id of a megaSign child *OR* the originating id of a widget agreement instance | [optional] +**reminderFrequency** | [**ReminderFrequencyEnum**](#ReminderFrequencyEnum) | Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used. Should not be provided in offline agreement creation. If provided in PUT as a different value than the current one, an error will be thrown. | [optional] +**createdDate** | [**Date**](Date.md) | Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**participantSetsInfo** | [**List<ParticipantSetInfo>**](ParticipantSetInfo.md) | A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document | [optional] +**hasFormFieldData** | **Boolean** | True if form field data is present. If provided in POST or PUT, it will simply be ignored. | [optional] +**expirationTime** | [**Date**](Date.md) | Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. | [optional] +**formFieldLayerTemplates** | [**List<FileInfo>**](FileInfo.md) | Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] +**name** | **String** | The name of the agreement that will be used to identify it, in emails, website and other places | [optional] +**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] +**workflowId** | **String** | The identifier of custom workflow which defines the routing path of an agreement. Should not be provided in offline agreement creation. | [optional] +**status** | [**StatusEnum**](#StatusEnum) | This is a server generated attribute which provides the detailed status of an agreement. | [optional] + + + +## Enum: TypeEnum +Name | Value +---- | ----- +AGREEMENT | "AGREEMENT" +MEGASIGN_CHILD | "MEGASIGN_CHILD" +WIDGET_INSTANCE | "WIDGET_INSTANCE" + + + +## Enum: StateEnum +Name | Value +---- | ----- +AUTHORING | "AUTHORING" +DRAFT | "DRAFT" +IN_PROCESS | "IN_PROCESS" + + + +## Enum: SignatureTypeEnum +Name | Value +---- | ----- +ESIGN | "ESIGN" +WRITTEN | "WRITTEN" + + + +## Enum: ReminderFrequencyEnum +Name | Value +---- | ----- +DAILY_UNTIL_SIGNED | "DAILY_UNTIL_SIGNED" +WEEKDAILY_UNTIL_SIGNED | "WEEKDAILY_UNTIL_SIGNED" +EVERY_OTHER_DAY_UNTIL_SIGNED | "EVERY_OTHER_DAY_UNTIL_SIGNED" +EVERY_THIRD_DAY_UNTIL_SIGNED | "EVERY_THIRD_DAY_UNTIL_SIGNED" +EVERY_FIFTH_DAY_UNTIL_SIGNED | "EVERY_FIFTH_DAY_UNTIL_SIGNED" +WEEKLY_UNTIL_SIGNED | "WEEKLY_UNTIL_SIGNED" +ONCE | "ONCE" + + + +## Enum: StatusEnum +Name | Value +---- | ----- +OUT_FOR_SIGNATURE | "OUT_FOR_SIGNATURE" +OUT_FOR_DELIVERY | "OUT_FOR_DELIVERY" +OUT_FOR_ACCEPTANCE | "OUT_FOR_ACCEPTANCE" +OUT_FOR_FORM_FILLING | "OUT_FOR_FORM_FILLING" +OUT_FOR_APPROVAL | "OUT_FOR_APPROVAL" +AUTHORING | "AUTHORING" +CANCELLED | "CANCELLED" +SIGNED | "SIGNED" +APPROVED | "APPROVED" +DELIVERED | "DELIVERED" +ACCEPTED | "ACCEPTED" +FORM_FILLED | "FORM_FILLED" +EXPIRED | "EXPIRED" +ARCHIVED | "ARCHIVED" +PREFILL | "PREFILL" +WIDGET_WAITING_FOR_VERIFICATION | "WIDGET_WAITING_FOR_VERIFICATION" +DRAFT | "DRAFT" +DOCUMENTS_NOT_YET_PROCESSED | "DOCUMENTS_NOT_YET_PROCESSED" +WAITING_FOR_FAXIN | "WAITING_FOR_FAXIN" +WAITING_FOR_VERIFICATION | "WAITING_FOR_VERIFICATION" + + + diff --git a/docs/FetchedMegaSignInfo.md b/docs/FetchedMegaSignInfo.md new file mode 100644 index 0000000..b312500 --- /dev/null +++ b/docs/FetchedMegaSignInfo.md @@ -0,0 +1,71 @@ + +# FetchedMegaSignInfo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**firstReminderDelay** | **Integer** | Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT | [optional] +**groupId** | **String** | The unique identifier of the group to which the megasign agreement will belong to when it is created. If it is not provided during agreement creation the primary group of the creator will be used | [optional] +**childAgreementsInfo** | [**ChildAgreementsInfo**](ChildAgreementsInfo.md) | Info corresponding to each child agreement of the megaSign | [optional] +**signatureType** | [**SignatureTypeEnum**](#SignatureTypeEnum) | Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system | [optional] +**externalId** | [**ExternalId**](ExternalId.md) | An arbitrary value from your system, which can be specified at sending time and then later returned or queried | [optional] +**locale** | **String** | The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender | [optional] +**message** | **String** | An optional message to the participants, describing what is being sent or why their signature is required | [optional] +**vaultingInfo** | [**VaultingInfo**](VaultingInfo.md) | Vaulting properties that allows Adobe Sign to securely store documents with a vault provider | [optional] +**securityOption** | [**MegaSignSecurityOption**](MegaSignSecurityOption.md) | Optional security parameters for the megasign | [optional] +**postSignOption** | [**PostSignOption**](PostSignOption.md) | URL and associated properties for the success page the user will be taken to after completing the signing process | [optional] +**reminderFrequency** | [**ReminderFrequencyEnum**](#ReminderFrequencyEnum) | Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used | [optional] +**ccs** | [**List<MegaSignCcInfo>**](MegaSignCcInfo.md) | A list of one or more CCs that will be copied in the megasign transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file | [optional] +**createdDate** | [**Date**](Date.md) | Date when megasign was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**isDocumentRetentionApplied** | **Boolean** | Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. | [optional] +**expirationTime** | [**Date**](Date.md) | Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. | [optional] +**lastEventDate** | [**Date**](Date.md) | The date of the last event that occurred for this megasign. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**senderEmail** | **String** | Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored | [optional] +**name** | **String** | The name of the agreement that will be used to identify it, in emails, website and other places | [optional] +**numChildren** | **Integer** | The total number of MegaSign children associated with the MegaSign parent. If provided in POST, it will be ignored. If modified in PUT, it will throw error MODIFYING_IMMUTABLE_FIELDS | [optional] +**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] +**id** | **String** | The unique identifier of megasign | [optional] +**state** | [**StateEnum**](#StateEnum) | State of the Megasign | [optional] +**status** | [**StatusEnum**](#StatusEnum) | Status of the Megasign | [optional] + + + +## Enum: SignatureTypeEnum +Name | Value +---- | ----- +ESIGN | "ESIGN" +WRITTEN | "WRITTEN" + + + +## Enum: ReminderFrequencyEnum +Name | Value +---- | ----- +DAILY_UNTIL_SIGNED | "DAILY_UNTIL_SIGNED" +WEEKDAILY_UNTIL_SIGNED | "WEEKDAILY_UNTIL_SIGNED" +EVERY_OTHER_DAY_UNTIL_SIGNED | "EVERY_OTHER_DAY_UNTIL_SIGNED" +EVERY_THIRD_DAY_UNTIL_SIGNED | "EVERY_THIRD_DAY_UNTIL_SIGNED" +EVERY_FIFTH_DAY_UNTIL_SIGNED | "EVERY_FIFTH_DAY_UNTIL_SIGNED" +WEEKLY_UNTIL_SIGNED | "WEEKLY_UNTIL_SIGNED" + + + +## Enum: StateEnum +Name | Value +---- | ----- +PROCESS | "IN_PROCESS" + + + +## Enum: StatusEnum +Name | Value +---- | ----- +AUTHORING | "AUTHORING" +IN_PROCESS | "IN_PROCESS" +CANCELLED | "CANCELLED" +COMPLETED | "COMPLETED" +EXPIRED | "EXPIRED" +PREFILL | "PREFILL" + + + diff --git a/docs/FetchedWidgetInfo.md b/docs/FetchedWidgetInfo.md new file mode 100644 index 0000000..5450cbf --- /dev/null +++ b/docs/FetchedWidgetInfo.md @@ -0,0 +1,49 @@ + +# FetchedWidgetInfo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**additionalParticipantSetsInfo** | [**List<WidgetAdditionalParticipationSetInfo>**](WidgetAdditionalParticipationSetInfo.md) | List of all the participants in the web form except web form signer | [optional] +**creatorEmail** | **String** | Email of web form creator. Only returned in GET response. Cannot be provided in POST/PUT request. If provided in POST, it will simply be ignored | [optional] +**groupId** | **String** | The ID of the group to which the widget belongs to. If not provided during creation, primary group of the creator will be used | [optional] +**locale** | **String** | The locale associated with this web form - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the web form creator | [optional] +**vaultingInfo** | [**VaultingInfo**](VaultingInfo.md) | Vaulting properties that allows Adobe Sign to securely store documents with a vault provider | [optional] +**securityOption** | [**SecurityOption**](SecurityOption.md) | Secondary security parameters for the web form | [optional] +**widgetParticipantSetInfo** | [**WidgetParticipantSetInfo**](WidgetParticipantSetInfo.md) | Represents web form participant for whom email should not be provided | [optional] +**widgetInActiveInfo** | [**WidgetInActiveInfo**](WidgetInActiveInfo.md) | The custom message which will be displayed to the user or the URL to which user will be redirected when the web form is accessed in a disabled state. This can only be specified in PUT request | [optional] +**ccs** | [**List<WidgetCcInfo>**](WidgetCcInfo.md) | A list of one or more email addresses that you want to copy on this transaction. The email addresses will each receive an email when the final agreement created through web form is signed. The email addresses will also receive a copy of the document, attached as a PDF file | [optional] +**createdDate** | [**Date**](Date.md) | Date when web form was created. If provided in POST, it will simply be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**isDocumentRetentionApplied** | **Boolean** | Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. | [optional] +**lastEventDate** | [**Date**](Date.md) | The date of the last event that occurred for this web form. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**name** | **String** | The name of the web form that will be used to identify it, in emails, website and other places | [optional] +**completionInfo** | [**WidgetRedirectionInfo**](WidgetRedirectionInfo.md) | URL and associated properties for the success page the web form signer will be taken to after performing desired action on the web form | [optional] +**authFailureInfo** | [**WidgetRedirectionInfo**](WidgetRedirectionInfo.md) | URL and associated properties for the error page the web form signer will be taken after failing to authenticate | [optional] +**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be used to create the web form. If more than one file is provided, they will be combined before the web form is created. Library documents are not permitted. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] +**id** | **String** | A resource identifier that can be used to uniquely identify the web form in other apis. If provided in POST, it will simply be ignored | [optional] +**state** | [**StateEnum**](#StateEnum) | The state in which the web form should land. For example in order to create a web form in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the web form can be obtained from GET /widgets/ID | [optional] +**status** | [**StatusEnum**](#StatusEnum) | Status of the Web Form. If provided in POST, it will simply be ignored | [optional] + + + +## Enum: StateEnum +Name | Value +---- | ----- +DRAFT | "DRAFT" +ACTIVE | "ACTIVE" +AUTHORING | "AUTHORING" + + + +## Enum: StatusEnum +Name | Value +---- | ----- +DRAFT | "DRAFT" +AUTHORING | "AUTHORING" +ACTIVE | "ACTIVE" +DOCUMENTS_NOT_YET_PROCESSED | "DOCUMENTS_NOT_YET_PROCESSED" +DISABLED | "DISABLED" +DISCARDED | "DISCARDED" + + + diff --git a/docs/FileInfo.md b/docs/FileInfo.md index cb0ce80..e4b0043 100755 --- a/docs/FileInfo.md +++ b/docs/FileInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**document** | [**Document**](Document.md) | A document that is associated with the widget. This field cannot be provided in POST call. In case of GET call, this is the only field returned in the response | [optional] -**transientDocumentId** | **String** | ID for a transient document that will be added to the widget | [optional] +**transientDocumentId** | **String** | ID for a transient document that will be added to the web form | [optional] +**document** | [**Document**](Document.md) | A document that is associated with the web form. This field cannot be provided in POST call. In case of GET call, this is the only field returned in the response | [optional] **urlFileInfo** | [**URLFileInfo**](URLFileInfo.md) | URL for an external document to add to the agreement | [optional] diff --git a/docs/FileInfosDescription.md b/docs/FileInfosDescription.md new file mode 100644 index 0000000..0e2148f --- /dev/null +++ b/docs/FileInfosDescription.md @@ -0,0 +1,13 @@ + +# FileInfosDescription + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Name of the fileInfo element | [optional] +**workflowLibraryDocumentSelectorList** | [**List<WorkflowLibraryDocument>**](WorkflowLibraryDocument.md) | A list of workflow library documents out of which one workflow library document can be selected with this fileInfo object | [optional] +**label** | **String** | Display label of this field for external users | [optional] +**required** | **Boolean** | Whether this field is required or optional | [optional] + + + diff --git a/docs/FileUploadOptions.md b/docs/FileUploadOptions.md index fa8c1be..8f2c66b 100755 --- a/docs/FileUploadOptions.md +++ b/docs/FileUploadOptions.md @@ -4,9 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**libraryDocument** | **Boolean** | Whether library documents link should appear or not. Default value is taken as true | [optional] +**canEditFiles** | **Boolean** | Whether the file upload section can be edited by adding or removing files. Default value is taken as true. Changing the default value will alter the compose page view configuration for this agreement, but is not an access control mechanism | [optional] **localFile** | **Boolean** | Whether local file upload button should appear or not. Default value is taken as true | [optional] **webConnectors** | **Boolean** | Whether link to attach documents from web sources like Dropbox should appear or not. Default value is taken as true | [optional] +**libraryDocument** | **Boolean** | Whether library documents link should appear or not. Default value is taken as true | [optional] diff --git a/docs/FormField.md b/docs/FormField.md index 34d34dd..3f707a9 100755 --- a/docs/FormField.md +++ b/docs/FormField.md @@ -4,54 +4,87 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**alignment** | [**AlignmentEnum**](#AlignmentEnum) | Alignment of the text. | [optional] -**assignee** | **String** | Who the field is assigned to. Either a participant set id, null, NOBODY or PREFILL. | [optional] -**backgroundColor** | **String** | Background color of the form field in RGB or HEX format | [optional] +**radioCheckType** | [**RadioCheckTypeEnum**](#RadioCheckTypeEnum) | The type of radio button (if field is radio button, identified by inputType). | [optional] **borderColor** | **String** | Color of the border of the field in RGB or HEX format | [optional] -**borderStyle** | [**BorderStyleEnum**](#BorderStyleEnum) | Style of the border of the field. | [optional] -**borderWidth** | **Double** | Width of the border of the field in pixels | [optional] -**calculated** | **Boolean** | true if this field's value is calculated from an expression, else false | [optional] -**conditionalAction** | [**FormFieldConditionalAction**](FormFieldConditionalAction.md) | A predicate (or set of predicates) that determines whether this field is visible and enabled. | [optional] -**contentType** | [**ContentTypeEnum**](#ContentTypeEnum) | Content Type of the form field. | [optional] +**valueExpression** | **String** | Expression to calculate value of the form field | [optional] +**maskingText** | **String** | Text to mask the masked form field | [optional] **defaultValue** | **String** | Default value of the form field | [optional] -**displayFormat** | **String** | Format of the value of the field to be displayed based on the displayFormatType property. | [optional] -**displayFormatType** | [**DisplayFormatTypeEnum**](#DisplayFormatTypeEnum) | Format type of the text field. | [optional] -**displayLabel** | **String** | Display label attached to the field | [optional] -**fontColor** | **String** | Font color of the form field in RGB or HEX format | [optional] -**fontName** | **String** | Font name of the form field | [optional] -**fontSize** | **Double** | Font size of the form field in points | [optional] -**hiddenOptions** | **List<String>** | Text values which are hidden in a drop down form field | [optional] -**hyperlink** | [**FormFieldHyperlink**](FormFieldHyperlink.md) | Hyperlink-specific data (e.g. as url, link type) | [optional] -**inputType** | [**InputTypeEnum**](#InputTypeEnum) | Input type of the form field | [optional] -**locations** | [**List<FormFieldLocation>**](FormFieldLocation.md) | All locations in a document where the form field is placed | [optional] **masked** | **Boolean** | true if the input entered by the signer has to be masked (like password), false if it shouldn't be | [optional] -**maskingText** | **String** | Text to mask the masked form field | [optional] -**maxLength** | **Integer** | Maximum length of the input text field in terms of no. of characters | [optional] -**maxValue** | **Double** | Upper bound of the number that can be entered by the signer | [optional] **minLength** | **Integer** | Minimum length of the input text field in terms of no. of characters | [optional] -**minValue** | **Double** | Lower bound of the number that can be entered by the signer | [optional] -**name** | **String** | The name of the form field | [optional] **origin** | [**OriginEnum**](#OriginEnum) | Origin of Form Field | [optional] -**radioCheckType** | [**RadioCheckTypeEnum**](#RadioCheckTypeEnum) | The type of radio button (if field is radio button, identified by inputType). | [optional] -**readOnly** | **Boolean** | true if it is a read-only field, else false | [optional] -**required** | **Boolean** | true if it is a mandatory field to be filled by the signer, else false | [optional] **tooltip** | **String** | Text that appears while hovering over the field | [optional] -**urlOverridable** | **Boolean** | For widget text fields only - true if the default value may come from the URL, else false | [optional] -**validation** | [**ValidationEnum**](#ValidationEnum) | Rule for validating the field value. | [optional] +**hiddenOptions** | **List<String>** | Text values which are hidden in a drop down form field | [optional] +**required** | **Boolean** | true if it is a mandatory field to be filled by the signer, else false | [optional] **validationData** | **String** | Further data for validating input with regards to the field's specified format. The contents and interpretation of formatData depends on the value of validation. | [optional] -**validationErrMsg** | **String** | Error message to be shown to the signer if filled value doesn't match the validations of the form field | [optional] -**valueExpression** | **String** | Expression to calculate value of the form field | [optional] +**minValue** | **Double** | Lower bound of the number that can be entered by the signer | [optional] +**borderWidth** | **Double** | Width of the border of the field in pixels | [optional] +**urlOverridable** | **Boolean** | For web form text fields only - true if the default value may come from the URL, else false | [optional] +**inputType** | [**InputTypeEnum**](#InputTypeEnum) | Input type of the form field | [optional] +**borderStyle** | [**BorderStyleEnum**](#BorderStyleEnum) | Style of the border of the field. | [optional] +**calculated** | **Boolean** | true if this field's value is calculated from an expression, else false | [optional] +**contentType** | [**ContentTypeEnum**](#ContentTypeEnum) | Content Type of the form field. | [optional] +**validation** | [**ValidationEnum**](#ValidationEnum) | Rule for validating the field value. | [optional] +**displayLabel** | **String** | Display label attached to the field | [optional] +**hyperlink** | [**FormFieldHyperlink**](FormFieldHyperlink.md) | Hyperlink-specific data (e.g. as url, link type) | [optional] +**backgroundColor** | **String** | Background color of the form field in RGB or HEX format | [optional] **visible** | **Boolean** | If set to false, then the form field is hidden. Otherwise, it is visible. | [optional] +**displayFormatType** | [**DisplayFormatTypeEnum**](#DisplayFormatTypeEnum) | Format type of the text field. | [optional] +**maxValue** | **Double** | Upper bound of the number that can be entered by the signer | [optional] +**validationErrMsg** | **String** | Error message to be shown to the signer if filled value doesn't match the validations of the form field | [optional] +**displayFormat** | **String** | Format of the value of the field to be displayed based on the displayFormatType property. | [optional] **visibleOptions** | **List<String>** | Text values which are visible in a drop down form field | [optional] +**readOnly** | **Boolean** | true if it is a read-only field, else false | [optional] +**fontName** | **String** | Font name of the form field | [optional] +**conditionalAction** | [**FormFieldConditionalAction**](FormFieldConditionalAction.md) | A predicate (or set of predicates) that determines whether this field is visible and enabled. | [optional] +**name** | **String** | The name of the form field | [optional] +**fontSize** | **Double** | Font size of the form field in points | [optional] +**locations** | [**List<FormFieldLocation>**](FormFieldLocation.md) | All locations in a document where the form field is placed | [optional] +**assignee** | **String** | Who the field is assigned to. Valid values are a participant set id, null, \"NOBODY\", \"PREFILL\" or \"EVERYONE\". If set to a participant set id, then any member of that participant set may fill out the field. \"NOBODY\" indicates that the field may not be filled by anybody (e.g. autopopulated fields like transaction number). \"PREFILL\" indicates that the field will be filled by the sender before the agreement is sent out for signing. \"EVERYONE\" exists only in hyperlink fields currently and indicates that it is assigned to all participants. null indicates that anybody may fill out the field. If the propeerty isn't specified, it is treated as null. | [optional] +**alignment** | [**AlignmentEnum**](#AlignmentEnum) | Alignment of the text. | [optional] +**fontColor** | **String** | Font color of the form field in RGB or HEX format | [optional] +**maxLength** | **Integer** | Maximum length of the input text field in terms of no. of characters | [optional] - -## Enum: AlignmentEnum + +## Enum: RadioCheckTypeEnum Name | Value ---- | ----- -LEFT | "LEFT" -RIGHT | "RIGHT" -CENTER | "CENTER" +CIRCLE | "CIRCLE" +CHECK | "CHECK" +CROSS | "CROSS" +DIAMOND | "DIAMOND" +SQUARE | "SQUARE" +STAR | "STAR" + + + +## Enum: OriginEnum +Name | Value +---- | ----- +AUTHORED | "AUTHORED" +GENERATED | "GENERATED" +IMPORTED | "IMPORTED" + + + +## Enum: InputTypeEnum +Name | Value +---- | ----- +TEXT_FIELD | "TEXT_FIELD" +MULTILINE | "MULTILINE" +PASSWORD | "PASSWORD" +RADIO | "RADIO" +CHECKBOX | "CHECKBOX" +DROP_DOWN | "DROP_DOWN" +LISTBOX | "LISTBOX" +SIGNATURE | "SIGNATURE" +PDF_SIGNATURE | "PDF_SIGNATURE" +BUTTON | "BUTTON" +BLOCK | "BLOCK" +FILE_CHOOSER | "FILE_CHOOSER" +COMB | "COMB" +INLINE_IMAGE | "INLINE_IMAGE" +UNSUPPORTED | "UNSUPPORTED" @@ -86,57 +119,7 @@ TRANSACTION_ID | "TRANSACTION_ID" SIGNATURE_STAMP | "SIGNATURE_STAMP" PAYMENT | "PAYMENT" DIGITAL_SIGNATURE | "DIGITAL_SIGNATURE" - - - -## Enum: DisplayFormatTypeEnum -Name | Value ----- | ----- -DEFAULT | "DEFAULT" -DATE | "DATE" -NUMBER | "NUMBER" - - - -## Enum: InputTypeEnum -Name | Value ----- | ----- -TEXT_FIELD | "TEXT_FIELD" -MULTILINE | "MULTILINE" -PASSWORD | "PASSWORD" -RADIO | "RADIO" -CHECKBOX | "CHECKBOX" -DROP_DOWN | "DROP_DOWN" -LISTBOX | "LISTBOX" -SIGNATURE | "SIGNATURE" -PDF_SIGNATURE | "PDF_SIGNATURE" -BUTTON | "BUTTON" -BLOCK | "BLOCK" -FILE_CHOOSER | "FILE_CHOOSER" -COMB | "COMB" -INLINE_IMAGE | "INLINE_IMAGE" -UNSUPPORTED | "UNSUPPORTED" - - - -## Enum: OriginEnum -Name | Value ----- | ----- -AUTHORED | "AUTHORED" -GENERATED | "GENERATED" -IMPORTED | "IMPORTED" - - - -## Enum: RadioCheckTypeEnum -Name | Value ----- | ----- -CIRCLE | "CIRCLE" -CHECK | "CHECK" -CROSS | "CROSS" -DIAMOND | "DIAMOND" -SQUARE | "SQUARE" -STAR | "STAR" +CALC | "CALC" @@ -160,4 +143,22 @@ CUSTOM | "CUSTOM" XFA_PICTURE | "XFA_PICTURE" + +## Enum: DisplayFormatTypeEnum +Name | Value +---- | ----- +DEFAULT | "DEFAULT" +DATE | "DATE" +NUMBER | "NUMBER" + + + +## Enum: AlignmentEnum +Name | Value +---- | ----- +LEFT | "LEFT" +RIGHT | "RIGHT" +CENTER | "CENTER" + + diff --git a/docs/FormFieldConditionPredicate.md b/docs/FormFieldConditionPredicate.md index 350225f..2823511 100755 --- a/docs/FormFieldConditionPredicate.md +++ b/docs/FormFieldConditionPredicate.md @@ -4,10 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**fieldLocationIndex** | **Integer** | Index of the location of the form field used in the predicate | [optional] **fieldName** | **String** | Name of the field whose value is the basis of predicate | [optional] -**operator** | [**OperatorEnum**](#OperatorEnum) | Operator to be applied on the value of the predicate field. | [optional] **value** | **String** | Value to compare against the value of the predicate's form field, using the specified operator | [optional] +**operator** | [**OperatorEnum**](#OperatorEnum) | Operator to be applied on the value of the predicate field. | [optional] +**fieldLocationIndex** | **Integer** | Index of the location of the form field used in the predicate | [optional] diff --git a/docs/FormFieldConditionalAction.md b/docs/FormFieldConditionalAction.md index 20ffb29..f4cc8ff 100755 --- a/docs/FormFieldConditionalAction.md +++ b/docs/FormFieldConditionalAction.md @@ -4,9 +4,17 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**action** | [**ActionEnum**](#ActionEnum) | Action to show/hide the form field is to be taken on the basis of evaluation of conditions. | [optional] -**anyOrAll** | [**AnyOrAllEnum**](#AnyOrAllEnum) | It indicates if any one of the conditions or all of them have to be true. | [optional] **predicates** | [**List<FormFieldConditionPredicate>**](FormFieldConditionPredicate.md) | The predicates to be evaluated in order to determine whether this condition is true | [optional] +**anyOrAll** | [**AnyOrAllEnum**](#AnyOrAllEnum) | It indicates if any one of the conditions or all of them have to be true. | [optional] +**action** | [**ActionEnum**](#ActionEnum) | Action to show/hide the form field is to be taken on the basis of evaluation of conditions. | [optional] + + + +## Enum: AnyOrAllEnum +Name | Value +---- | ----- +ALL | "ALL" +ANY | "ANY" @@ -19,12 +27,4 @@ DISABLE | "DISABLE" ENABLE | "ENABLE" - -## Enum: AnyOrAllEnum -Name | Value ----- | ----- -ALL | "ALL" -ANY | "ANY" - - diff --git a/docs/FormFieldHyperlink.md b/docs/FormFieldHyperlink.md index 43c07e9..3f616b8 100755 --- a/docs/FormFieldHyperlink.md +++ b/docs/FormFieldHyperlink.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**documentLocation** | [**FormFieldLocation**](FormFieldLocation.md) | Location on the document pointed by the link in case of INTERNAL type link | [optional] **linkType** | [**LinkTypeEnum**](#LinkTypeEnum) | Type of link in an agreement. | [optional] +**documentLocation** | [**FormFieldLocation**](FormFieldLocation.md) | Location on the document pointed by the link in case of INTERNAL type link | [optional] **url** | **String** | URL, in case of EXTERNAL type link | [optional] diff --git a/docs/FormFieldLocation.md b/docs/FormFieldLocation.md index f6a6070..a1f425b 100755 --- a/docs/FormFieldLocation.md +++ b/docs/FormFieldLocation.md @@ -4,11 +4,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**height** | **Double** | Height of the form field in pixels | [optional] -**left** | **Double** | No. of pixels from left of the page for form field placement | [optional] **pageNumber** | **Integer** | Number of the page where form field has to be placed, starting from 1. | [optional] **top** | **Double** | No. of pixels from bottom of the page for form field placement | [optional] +**left** | **Double** | No. of pixels from left of the page for form field placement | [optional] **width** | **Double** | Width of the form field in pixels | [optional] +**height** | **Double** | Height of the form field in pixels | [optional] diff --git a/docs/GroupCreationResponse.md b/docs/GroupCreationResponse.md new file mode 100644 index 0000000..31213d2 --- /dev/null +++ b/docs/GroupCreationResponse.md @@ -0,0 +1,10 @@ + +# GroupCreationResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Unique identifier of the group created. | [optional] + + + diff --git a/docs/GroupInfo.md b/docs/GroupInfo.md index dc02890..4a8ae55 100755 --- a/docs/GroupInfo.md +++ b/docs/GroupInfo.md @@ -4,8 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**groupId** | **String** | Unique identifier of the group | [optional] +**isDefaultGroup** | **Boolean** | Is the default group for the account | [optional] **groupName** | **String** | Name of the group | [optional] +**createdDate** | [**Date**](Date.md) | Date group was created | [optional] +**groupId** | **String** | Unique identifier of the group | [optional] diff --git a/docs/GroupUserInfo.md b/docs/GroupUserInfo.md index 8880b7b..8db745c 100755 --- a/docs/GroupUserInfo.md +++ b/docs/GroupUserInfo.md @@ -4,12 +4,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**company** | **String** | The name of company of the user | [optional] -**email** | **String** | The email address of the user | [optional] **firstName** | **String** | The first name of the user | [optional] -**id** | **String** | A unique identifier of the user resource for REST APIs. This identifier can not be used in SOAP APIs | [optional] -**isGroupAdmin** | **Boolean** | True if user is group admin | [optional] **lastName** | **String** | The last name of the user | [optional] +**isGroupAdmin** | **Boolean** | True if user is group admin | [optional] +**company** | **String** | The name of company of the user | [optional] +**id** | **String** | A unique identifier of the user resource for REST APIs. This identifier can not be used in SOAP APIs | [optional] +**email** | **String** | The email address of the user | [optional] diff --git a/docs/GroupUsersInfo.md b/docs/GroupUsersInfo.md index ac13d3a..33e2195 100755 --- a/docs/GroupUsersInfo.md +++ b/docs/GroupUsersInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**page** | [**PageInfo**](PageInfo.md) | Pagination information for navigating through the response | [optional] **userInfoList** | [**List<GroupUserInfo>**](GroupUserInfo.md) | The list of users in the account. | [optional] +**page** | [**PageInfo**](PageInfo.md) | Pagination information for navigating through the response | [optional] diff --git a/docs/GroupsApi.md b/docs/GroupsApi.md index dd1ec3c..a17ef11 100755 --- a/docs/GroupsApi.md +++ b/docs/GroupsApi.md @@ -1,14 +1,110 @@ # GroupsApi -All URIs are relative to *http://localhost/api/rest/v6* +All URIs are relative to *https://secure.au1.echosign.com/api/rest/v6* Method | HTTP request | Description ------------- | ------------- | ------------- +[**createGroup**](GroupsApi.md#createGroup) | **POST** /groups | Creates a new group in an account. +[**deleteGroup**](GroupsApi.md#deleteGroup) | **DELETE** /groups/{groupId} | Delete an existing group. [**getGroupDetails**](GroupsApi.md#getGroupDetails) | **GET** /groups/{groupId} | Retrieves detailed information about the group. [**getGroups**](GroupsApi.md#getGroups) | **GET** /groups | Retrieves all the groups in an account. [**getUsersInGroup**](GroupsApi.md#getUsersInGroup) | **GET** /groups/{groupId}/users | Retrieves all the users in a group. +[**modifyGroup**](GroupsApi.md#modifyGroup) | **PUT** /groups/{groupId} | Update an existing group. + +# **createGroup** +> GroupCreationResponse createGroup(authorization, detailedGroupInfo, xApiUser) + +Creates a new group in an account. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.GroupsApi; + + +GroupsApi apiInstance = new GroupsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +DetailedGroupInfo detailedGroupInfo = new DetailedGroupInfo(); // DetailedGroupInfo | Information necessary to create a group. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +try { + GroupCreationResponse result = apiInstance.createGroup(authorization, detailedGroupInfo, xApiUser); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling GroupsApi#createGroup"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_write')\" oncontextmenu=\"this.href=oauthDoc('user_write')\" target=\"oauthDoc\">user_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **detailedGroupInfo** | [**DetailedGroupInfo**](DetailedGroupInfo.md)| Information necessary to create a group. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + +### Return type + +[**GroupCreationResponse**](GroupCreationResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **deleteGroup** +> deleteGroup(authorization, groupId, xApiUser) + +Delete an existing group. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.GroupsApi; + + +GroupsApi apiInstance = new GroupsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String groupId = "groupId_example"; // String | The group identifier, as returned by the group creation API or retrieved from the API to fetch groups +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +try { + apiInstance.deleteGroup(authorization, groupId, xApiUser); +} catch (ApiException e) { + System.err.println("Exception when calling GroupsApi#deleteGroup"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_write')\" oncontextmenu=\"this.href=oauthDoc('user_write')\" target=\"oauthDoc\">user_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **groupId** | **String**| The group identifier, as returned by the group creation API or retrieved from the API to fetch groups | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + # **getGroupDetails** > DetailedGroupInfo getGroupDetails(authorization, groupId, xApiUser) @@ -156,3 +252,51 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + +# **modifyGroup** +> modifyGroup(authorization, groupId, detailedGroupInfo, xApiUser) + +Update an existing group. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.GroupsApi; + + +GroupsApi apiInstance = new GroupsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String groupId = "groupId_example"; // String | The group identifier, as returned by the group creation API or retrieved from the API to fetch groups +DetailedGroupInfo detailedGroupInfo = new DetailedGroupInfo(); // DetailedGroupInfo | Information necessary to update a group. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +try { + apiInstance.modifyGroup(authorization, groupId, detailedGroupInfo, xApiUser); +} catch (ApiException e) { + System.err.println("Exception when calling GroupsApi#modifyGroup"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_write')\" oncontextmenu=\"this.href=oauthDoc('user_write')\" target=\"oauthDoc\">user_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **groupId** | **String**| The group identifier, as returned by the group creation API or retrieved from the API to fetch groups | + **detailedGroupInfo** | [**DetailedGroupInfo**](DetailedGroupInfo.md)| Information necessary to update a group. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + diff --git a/docs/LibraryDocument.md b/docs/LibraryDocument.md index 969e206..0b3471b 100755 --- a/docs/LibraryDocument.md +++ b/docs/LibraryDocument.md @@ -4,14 +4,23 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**creatorEmail** | **String** | Email address of the library document creator. It will be ignored in POST/PUT requests | [optional] -**id** | **String** | The unique identifier that is used to refer to the library template | [optional] +**templateTypes** | [**List<TemplateTypesEnum>**](#List<TemplateTypesEnum>) | A list of one or more library template types | [optional] **hidden** | **Boolean** | True if Library Document is hidden | [optional] +**creatorEmail** | **String** | Email address of the library document creator. It will be ignored in POST/PUT requests | [optional] +**sharingMode** | [**SharingModeEnum**](#SharingModeEnum) | Specifies who should have access to this library document. GLOBAL sharing is a restricted operation. | [optional] +**groupId** | **String** | The unique identifier of the group to which the library template belongs to. If not provided during creation, primary group of the creator will be used | [optional] **modifiedDate** | [**Date**](Date.md) | The date on which the library document was last modified. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] **name** | **String** | The name of the library document | [optional] -**sharingMode** | [**SharingModeEnum**](#SharingModeEnum) | Specifies who should have access to this library document. GLOBAL sharing mode is not applicable in POST/PUT requests | [optional] +**id** | **String** | The unique identifier that is used to refer to the library template | [optional] **status** | [**StatusEnum**](#StatusEnum) | Status of the library document | [optional] -**templateTypes** | [**List<TemplateTypesEnum>**](#List<TemplateTypesEnum>) | A list of one or more library template types | [optional] + + + +## Enum: List<TemplateTypesEnum> +Name | Value +---- | ----- +DOCUMENT | "DOCUMENT" +FORM_FIELD_LAYER | "FORM_FIELD_LAYER" @@ -33,12 +42,4 @@ ACTIVE | "ACTIVE" REMOVED | "REMOVED" - -## Enum: List<TemplateTypesEnum> -Name | Value ----- | ----- -DOCUMENT | "DOCUMENT" -FORM_FIELD_LAYER | "FORM_FIELD_LAYER" - - diff --git a/docs/LibraryDocumentCreationInfoV6.md b/docs/LibraryDocumentCreationInfoV6.md index fbd32ce..d0f70a8 100755 --- a/docs/LibraryDocumentCreationInfoV6.md +++ b/docs/LibraryDocumentCreationInfoV6.md @@ -4,17 +4,20 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**createdDate** | [**Date**](Date.md) | Date when library document was created. It will be ignored in POST/PUT requests. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] **creatorEmail** | **String** | Email address of the library document creator. It will be ignored in POST/PUT requests | [optional] +**sharingMode** | [**SharingModeEnum**](#SharingModeEnum) | Specifies who should have access to this library document. GLOBAL sharing is a restricted operation. | [optional] +**groupId** | **String** | The unique identifier of the group to which the library template belongs to. If not provided during creation, primary group of the creator will be used | [optional] **creatorName** | **String** | Name of the library document creator. It will be ignored in POST/PUT requests | [optional] -**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be used to create the template. If more than one file is provided, they will be combined into one PDF. Note: Only a single parameter in every FileInfo object must be specified | [optional] -**id** | **String** | The unique identifier that is used to refer to the library template. It will be ignored in POST requests | [optional] +**createdDate** | [**Date**](Date.md) | Date when library document was created. It will be ignored in POST/PUT requests. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**isDocumentRetentionApplied** | **Boolean** | Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. | [optional] +**templateTypes** | [**List<TemplateTypesEnum>**](#List<TemplateTypesEnum>) | A list of one or more library template types | [optional] +**lastEventDate** | [**Date**](Date.md) | The date of the last event that occurred for this library document | [optional] **modifiedDate** | [**Date**](Date.md) | Date when library document was last modified. It will be ignored in POST/PUT requests. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] **name** | **String** | The name of the library template that will be used to identify it, in emails and on the website | [optional] -**sharingMode** | [**SharingModeEnum**](#SharingModeEnum) | Specifies who should have access to this library document. GLOBAL sharing mode is not applicable in POST/PUT requests | [optional] +**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be used to create the template. If more than one file is provided, they will be combined into one PDF. Note: Only a single parameter in every FileInfo object must be specified | [optional] +**id** | **String** | The unique identifier that is used to refer to the library template. It will be ignored in POST requests | [optional] **state** | [**StateEnum**](#StateEnum) | State of the library document. | [optional] **status** | [**StatusEnum**](#StatusEnum) | Status of the library document | [optional] -**templateTypes** | [**List<TemplateTypesEnum>**](#List<TemplateTypesEnum>) | A list of one or more library template types | [optional] @@ -27,6 +30,14 @@ ACCOUNT | "ACCOUNT" GLOBAL | "GLOBAL" + +## Enum: List<TemplateTypesEnum> +Name | Value +---- | ----- +DOCUMENT | "DOCUMENT" +FORM_FIELD_LAYER | "FORM_FIELD_LAYER" + + ## Enum: StateEnum Name | Value @@ -44,12 +55,4 @@ ACTIVE | "ACTIVE" REMOVED | "REMOVED" - -## Enum: List<TemplateTypesEnum> -Name | Value ----- | ----- -DOCUMENT | "DOCUMENT" -FORM_FIELD_LAYER | "FORM_FIELD_LAYER" - - diff --git a/docs/LibraryDocumentEvent.md b/docs/LibraryDocumentEvent.md index 44c367a..e8555a2 100755 --- a/docs/LibraryDocumentEvent.md +++ b/docs/LibraryDocumentEvent.md @@ -4,25 +4,36 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**actingUserEmail** | **String** | Email address of the user that created the event | [optional] -**actingUserIpAddress** | **String** | The IP address of the user that created the event | [optional] -**actingUserName** | **String** | The name of the acting user | [optional] -**comment** | **String** | The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant | [optional] **date** | [**Date**](Date.md) | The date of the audit event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**description** | **String** | A description of the audit event | [optional] -**deviceLocation** | [**LibDocEventDeviceLocation**](LibDocEventDeviceLocation.md) | Location of the device that generated the event (This value may be null due to limited privileges) | [optional] -**devicePhoneNumber** | **String** | Phone number from the device used when the participation is completed on a mobile phone | [optional] -**digitalSignatureInfo** | [**DigitalSignatureInfo**](DigitalSignatureInfo.md) | This is present for ESIGNED events when the participation is signed digitally | [optional] -**initiatingUserEmail** | **String** | Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect | [optional] **initiatingUserName** | **String** | Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect | [optional] +**description** | **String** | A description of the audit event | [optional] +**actingUserName** | **String** | The name of the acting user | [optional] +**actingUserIpAddress** | **String** | The IP address of the user that created the event | [optional] **participantEmail** | **String** | Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to | [optional] -**participantId** | **String** | The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to | [optional] -**participantRole** | [**ParticipantRoleEnum**](#ParticipantRoleEnum) | Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). | [optional] -**synchronizationId** | **String** | A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null) | [optional] **type** | [**TypeEnum**](#TypeEnum) | Type of library document event | [optional] +**participantRole** | [**ParticipantRoleEnum**](#ParticipantRoleEnum) | Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). | [optional] **vaultEventId** | **String** | The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null) | [optional] -**vaultProviderName** | **String** | Name of the vault provider for the vault event (if vaulted, otherwise null) | [optional] +**participantId** | **String** | The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to | [optional] **versionId** | **String** | An ID which uniquely identifies the version of the document associated with this audit event | [optional] +**actingUserEmail** | **String** | Email address of the user that created the event | [optional] +**devicePhoneNumber** | **String** | Phone number from the device used when the participation is completed on a mobile phone | [optional] +**initiatingUserEmail** | **String** | Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect | [optional] +**digitalSignatureInfo** | [**DigitalSignatureInfo**](DigitalSignatureInfo.md) | This is present for ESIGNED events when the participation is signed digitally | [optional] +**vaultProviderName** | **String** | Name of the vault provider for the vault event (if vaulted, otherwise null) | [optional] +**comment** | **String** | The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant | [optional] +**id** | **String** | The identifier for the event. | [optional] +**synchronizationId** | **String** | A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null) | [optional] +**deviceLocation** | [**LibDocEventDeviceLocation**](LibDocEventDeviceLocation.md) | Location of the device that generated the event (This value may be null due to limited privileges) | [optional] + + + +## Enum: TypeEnum +Name | Value +---- | ----- +AUTO_CANCELLED_CONVERSION_PROBLEM | "AUTO_CANCELLED_CONVERSION_PROBLEM" +CREATED | "CREATED" +MODIFIED | "MODIFIED" +DOCUMENTS_DELETED | "DOCUMENTS_DELETED" @@ -43,14 +54,4 @@ SHARE | "SHARE" SENDER | "SENDER" - -## Enum: TypeEnum -Name | Value ----- | ----- -AUTO_CANCELLED_CONVERSION_PROBLEM | "AUTO_CANCELLED_CONVERSION_PROBLEM" -CREATED | "CREATED" -MODIFIED | "MODIFIED" -DOCUMENTS_DELETED | "DOCUMENTS_DELETED" - - diff --git a/docs/LibraryDocumentFormFields.md b/docs/LibraryDocumentFormFields.md new file mode 100644 index 0000000..e67cd65 --- /dev/null +++ b/docs/LibraryDocumentFormFields.md @@ -0,0 +1,10 @@ + +# LibraryDocumentFormFields + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fields** | [**List<FormField>**](FormField.md) | List of the form fields in an agreement | [optional] + + + diff --git a/docs/LibraryDocumentInfo.md b/docs/LibraryDocumentInfo.md index 7f5ee6a..dc0463c 100755 --- a/docs/LibraryDocumentInfo.md +++ b/docs/LibraryDocumentInfo.md @@ -4,17 +4,20 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**createdDate** | [**Date**](Date.md) | Date when library document was created. It will be ignored in POST/PUT requests. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] **creatorEmail** | **String** | Email address of the library document creator. It will be ignored in POST/PUT requests | [optional] +**sharingMode** | [**SharingModeEnum**](#SharingModeEnum) | Specifies who should have access to this library document. GLOBAL sharing is a restricted operation. | [optional] +**groupId** | **String** | The unique identifier of the group to which the library template belongs to. If not provided during creation, primary group of the creator will be used | [optional] **creatorName** | **String** | Name of the library document creator. It will be ignored in POST/PUT requests | [optional] -**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be used to create the template. If more than one file is provided, they will be combined into one PDF. Note: Only a single parameter in every FileInfo object must be specified | [optional] -**id** | **String** | The unique identifier that is used to refer to the library template. It will be ignored in POST requests | [optional] +**createdDate** | [**Date**](Date.md) | Date when library document was created. It will be ignored in POST/PUT requests. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**isDocumentRetentionApplied** | **Boolean** | Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. | [optional] +**templateTypes** | [**List<TemplateTypesEnum>**](#List<TemplateTypesEnum>) | A list of one or more library template types | [optional] +**lastEventDate** | [**Date**](Date.md) | The date of the last event that occurred for this library document | [optional] **modifiedDate** | [**Date**](Date.md) | Date when library document was last modified. It will be ignored in POST/PUT requests. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] **name** | **String** | The name of the library template that will be used to identify it, in emails and on the website | [optional] -**sharingMode** | [**SharingModeEnum**](#SharingModeEnum) | Specifies who should have access to this library document. GLOBAL sharing mode is not applicable in POST/PUT requests | [optional] +**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be used to create the template. If more than one file is provided, they will be combined into one PDF. Note: Only a single parameter in every FileInfo object must be specified | [optional] +**id** | **String** | The unique identifier that is used to refer to the library template. It will be ignored in POST requests | [optional] **state** | [**StateEnum**](#StateEnum) | State of the library document. | [optional] **status** | [**StatusEnum**](#StatusEnum) | Status of the library document | [optional] -**templateTypes** | [**List<TemplateTypesEnum>**](#List<TemplateTypesEnum>) | A list of one or more library template types | [optional] @@ -27,6 +30,14 @@ ACCOUNT | "ACCOUNT" GLOBAL | "GLOBAL" + +## Enum: List<TemplateTypesEnum> +Name | Value +---- | ----- +DOCUMENT | "DOCUMENT" +FORM_FIELD_LAYER | "FORM_FIELD_LAYER" + + ## Enum: StateEnum Name | Value @@ -44,12 +55,4 @@ ACTIVE | "ACTIVE" REMOVED | "REMOVED" - -## Enum: List<TemplateTypesEnum> -Name | Value ----- | ----- -DOCUMENT | "DOCUMENT" -FORM_FIELD_LAYER | "FORM_FIELD_LAYER" - - diff --git a/docs/LibraryDocumentMembersInfo.md b/docs/LibraryDocumentMembersInfo.md new file mode 100644 index 0000000..8670dd3 --- /dev/null +++ b/docs/LibraryDocumentMembersInfo.md @@ -0,0 +1,10 @@ + +# LibraryDocumentMembersInfo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**creatorInfo** | [**SenderInfo**](SenderInfo.md) | Information about the creator of the library document. | [optional] + + + diff --git a/docs/LibraryDocumentStateInfo.md b/docs/LibraryDocumentStateInfo.md index 9f9d4e8..2aef4c0 100755 --- a/docs/LibraryDocumentStateInfo.md +++ b/docs/LibraryDocumentStateInfo.md @@ -13,6 +13,7 @@ Name | Value ---- | ----- AUTHORING | "AUTHORING" ACTIVE | "ACTIVE" +REMOVED | "REMOVED" diff --git a/docs/LibraryDocumentsApi.md b/docs/LibraryDocumentsApi.md index 6791e9c..f887123 100755 --- a/docs/LibraryDocumentsApi.md +++ b/docs/LibraryDocumentsApi.md @@ -1,21 +1,26 @@ # LibraryDocumentsApi -All URIs are relative to *http://localhost/api/rest/v6* +All URIs are relative to *https://secure.au1.echosign.com/api/rest/v6* Method | HTTP request | Description ------------- | ------------- | ------------- [**createLibraryDocument**](LibraryDocumentsApi.md#createLibraryDocument) | **POST** /libraryDocuments | Creates a template that is placed in the library of the user for reuse. [**createLibraryDocumentView**](LibraryDocumentsApi.md#createLibraryDocumentView) | **POST** /libraryDocuments/{libraryDocumentId}/views | Retrieves the latest state view url of a library document. +[**getAllLibraryDocumentMembers**](LibraryDocumentsApi.md#getAllLibraryDocumentMembers) | **GET** /libraryDocuments/{libraryDocumentId}/members | Retrieves information of members (creator) of the library document. [**getCombinedDocument**](LibraryDocumentsApi.md#getCombinedDocument) | **GET** /libraryDocuments/{libraryDocumentId}/combinedDocument | Retrieves the combined document associated with a library document. [**getDocuments**](LibraryDocumentsApi.md#getDocuments) | **GET** /libraryDocuments/{libraryDocumentId}/documents | Retrieves the IDs of the documents associated with library document. [**getEvents**](LibraryDocumentsApi.md#getEvents) | **GET** /libraryDocuments/{libraryDocumentId}/events | Retrieves the events information for a library document. [**getFormData**](LibraryDocumentsApi.md#getFormData) | **GET** /libraryDocuments/{libraryDocumentId}/formData | Retrieves data entered into the interactive form fields of the library document. +[**getFormFields**](LibraryDocumentsApi.md#getFormFields) | **GET** /libraryDocuments/{libraryDocumentId}/formFields | Retrieves details of form fields of a library document. +[**getLibraryCombinedDocumentUrl**](LibraryDocumentsApi.md#getLibraryCombinedDocumentUrl) | **GET** /libraryDocuments/{libraryDocumentId}/combinedDocument/url | Retrieves url of all visible pages of all the documents associated with a library document. [**getLibraryDocument**](LibraryDocumentsApi.md#getLibraryDocument) | **GET** /libraryDocuments/{libraryDocumentId}/documents/{documentId} | Retrieves the file stream of a document of library document. [**getLibraryDocumentAuditTrail**](LibraryDocumentsApi.md#getLibraryDocumentAuditTrail) | **GET** /libraryDocuments/{libraryDocumentId}/auditTrail | Retrieves the audit trail associated with a library document. [**getLibraryDocumentImageUrls**](LibraryDocumentsApi.md#getLibraryDocumentImageUrls) | **GET** /libraryDocuments/{libraryDocumentId}/documents/{documentId}/imageUrls | Retrieves image urls of all visible pages of a document associated with a library document. [**getLibraryDocumentInfo**](LibraryDocumentsApi.md#getLibraryDocumentInfo) | **GET** /libraryDocuments/{libraryDocumentId} | Retrieves the details of a library document. +[**getLibraryDocumentInfoForUser**](LibraryDocumentsApi.md#getLibraryDocumentInfoForUser) | **GET** /libraryDocuments/{libraryDocumentId}/me | Retrieves the library document information related to the api caller [**getLibraryDocumentNoteForApiUser**](LibraryDocumentsApi.md#getLibraryDocumentNoteForApiUser) | **GET** /libraryDocuments/{libraryDocumentId}/me/note | Retrieves the latest note of a library document for the API user. [**getLibraryDocuments**](LibraryDocumentsApi.md#getLibraryDocuments) | **GET** /libraryDocuments | Retrieves library documents for a user. +[**updateFormFields**](LibraryDocumentsApi.md#updateFormFields) | **PUT** /libraryDocuments/{libraryDocumentId}/formFields | Updates details of form fields of a library document. [**updateLibraryDocument**](LibraryDocumentsApi.md#updateLibraryDocument) | **PUT** /libraryDocuments/{libraryDocumentId} | Updates the library document. [**updateLibraryDocumentNoteForApiUser**](LibraryDocumentsApi.md#updateLibraryDocumentNoteForApiUser) | **PUT** /libraryDocuments/{libraryDocumentId}/me/note | Updates the latest note of a library document for the API user. [**updateLibraryDocumentState**](LibraryDocumentsApi.md#updateLibraryDocumentState) | **PUT** /libraryDocuments/{libraryDocumentId}/state | Updates the library document's state. @@ -119,6 +124,57 @@ Name | Type | Description | Notes No authorization required +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **getAllLibraryDocumentMembers** +> LibraryDocumentMembersInfo getAllLibraryDocumentMembers(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch) + +Retrieves information of members (creator) of the library document. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.LibraryDocumentsApi; + + +LibraryDocumentsApi apiInstance = new LibraryDocumentsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String libraryDocumentId = "libraryDocumentId_example"; // String | The document identifier, as retrieved from the API to fetch library documents. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. +try { + LibraryDocumentMembersInfo result = apiInstance.getAllLibraryDocumentMembers(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling LibraryDocumentsApi#getAllLibraryDocumentMembers"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **libraryDocumentId** | **String**| The document identifier, as retrieved from the API to fetch library documents. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] + +### Return type + +[**LibraryDocumentMembersInfo**](LibraryDocumentMembersInfo.md) + +### Authorization + +No authorization required + ### HTTP request headers - **Content-Type**: Not defined @@ -283,7 +339,7 @@ No authorization required # **getFormData** -> byte[] getFormData(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch) +> byte[] getFormData(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, cursor, pageSize) Retrieves data entered into the interactive form fields of the library document. @@ -302,8 +358,10 @@ String libraryDocumentId = "libraryDocumentId_example"; // String | The document String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. +String cursor = "cursor_example"; // String | Used to navigate through the pages. If not provided, returns the first page. +Integer pageSize = 56; // Integer | Number of intended items in the response page. If not provided, it is decided by the application settings. try { - byte[] result = apiInstance.getFormData(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + byte[] result = apiInstance.getFormData(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, cursor, pageSize); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling LibraryDocumentsApi#getFormData"); @@ -320,6 +378,8 @@ Name | Type | Description | Notes **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] + **cursor** | **String**| Used to navigate through the pages. If not provided, returns the first page. | [optional] + **pageSize** | **Integer**| Number of intended items in the response page. If not provided, it is decided by the application settings. | [optional] ### Return type @@ -332,7 +392,109 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/csv + - **Accept**: application/json, text/csv + + +# **getFormFields** +> LibraryDocumentFormFields getFormFields(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch) + +Retrieves details of form fields of a library document. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.LibraryDocumentsApi; + + +LibraryDocumentsApi apiInstance = new LibraryDocumentsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String libraryDocumentId = "libraryDocumentId_example"; // String | The document identifier, as retrieved from the API to fetch library documents. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. +try { + LibraryDocumentFormFields result = apiInstance.getFormFields(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling LibraryDocumentsApi#getFormFields"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **libraryDocumentId** | **String**| The document identifier, as retrieved from the API to fetch library documents. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] + +### Return type + +[**LibraryDocumentFormFields**](LibraryDocumentFormFields.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **getLibraryCombinedDocumentUrl** +> DocumentUrl getLibraryCombinedDocumentUrl(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, attachAuditReport) + +Retrieves url of all visible pages of all the documents associated with a library document. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.LibraryDocumentsApi; + + +LibraryDocumentsApi apiInstance = new LibraryDocumentsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String libraryDocumentId = "libraryDocumentId_example"; // String | The document identifier, as retrieved from the API to fetch library documents. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +Boolean attachAuditReport = true; // Boolean | When set to true, attach an audit report to the library document PDF. The default value is false. +try { + DocumentUrl result = apiInstance.getLibraryCombinedDocumentUrl(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, attachAuditReport); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling LibraryDocumentsApi#getLibraryCombinedDocumentUrl"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **libraryDocumentId** | **String**| The document identifier, as retrieved from the API to fetch library documents. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **attachAuditReport** | **Boolean**| When set to true, attach an audit report to the library document PDF. The default value is false. | [optional] + +### Return type + +[**DocumentUrl**](DocumentUrl.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json # **getLibraryDocument** @@ -440,7 +602,7 @@ No authorization required # **getLibraryDocumentImageUrls** -> DocumentImageUrlsInfo getLibraryDocumentImageUrls(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, imageSizes, startPage, endPage) +> DocumentImageUrlsInfo getLibraryDocumentImageUrls(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, imageSizes, startPage, endPage) Retrieves image urls of all visible pages of a document associated with a library document. @@ -457,12 +619,11 @@ String libraryDocumentId = "libraryDocumentId_example"; // String | The document String documentId = "documentId_example"; // String | The document identifier, as retrieved from the API which fetches the documents of a specified library document String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account -String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. String imageSizes = "imageSizes_example"; // String | A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. Integer startPage = 56; // Integer | Start of page number range for which imageUrls are requested. Starting page number should be greater than 0. Integer endPage = 56; // Integer | End of page number range for which imageUrls are requested. try { - DocumentImageUrlsInfo result = apiInstance.getLibraryDocumentImageUrls(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, imageSizes, startPage, endPage); + DocumentImageUrlsInfo result = apiInstance.getLibraryDocumentImageUrls(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, imageSizes, startPage, endPage); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling LibraryDocumentsApi#getLibraryDocumentImageUrls"); @@ -479,7 +640,6 @@ Name | Type | Description | Notes **documentId** | **String**| The document identifier, as retrieved from the API which fetches the documents of a specified library document | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] - **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] **imageSizes** | **String**| A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. | [optional] **startPage** | **Integer**| Start of page number range for which imageUrls are requested. Starting page number should be greater than 0. | [optional] **endPage** | **Integer**| End of page number range for which imageUrls are requested. | [optional] @@ -543,6 +703,53 @@ Name | Type | Description | Notes No authorization required +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **getLibraryDocumentInfoForUser** +> MyAgreementInfo getLibraryDocumentInfoForUser(authorization, libraryDocumentId, xApiUser) + +Retrieves the library document information related to the api caller + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.LibraryDocumentsApi; + + +LibraryDocumentsApi apiInstance = new LibraryDocumentsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String libraryDocumentId = "libraryDocumentId_example"; // String | The document identifier, as retrieved from the API to fetch library documents. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +try { + MyAgreementInfo result = apiInstance.getLibraryDocumentInfoForUser(authorization, libraryDocumentId, xApiUser); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling LibraryDocumentsApi#getLibraryDocumentInfoForUser"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **libraryDocumentId** | **String**| The document identifier, as retrieved from the API to fetch library documents. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + +### Return type + +[**MyAgreementInfo**](MyAgreementInfo.md) + +### Authorization + +No authorization required + ### HTTP request headers - **Content-Type**: Not defined @@ -599,7 +806,7 @@ No authorization required # **getLibraryDocuments** -> LibraryDocuments getLibraryDocuments(authorization, xApiUser, xOnBehalfOfUser, showHiddenLibraryDocuments, cursor, pageSize) +> LibraryDocuments getLibraryDocuments(authorization, xApiUser, xOnBehalfOfUser, groupId, showHiddenLibraryDocuments, cursor, pageSize) Retrieves library documents for a user. @@ -614,11 +821,12 @@ LibraryDocumentsApi apiInstance = new LibraryDocumentsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String groupId = "groupId_example"; // String | The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. Boolean showHiddenLibraryDocuments = true; // Boolean | A query parameter to fetch all the hidden library documents along with the visible library documents. Default value is false. String cursor = "cursor_example"; // String | Used to navigate through the pages. If not provided, returns the first page. Integer pageSize = 56; // Integer | Number of intended items in the response page. If not provided, it is decided by the application settings. try { - LibraryDocuments result = apiInstance.getLibraryDocuments(authorization, xApiUser, xOnBehalfOfUser, showHiddenLibraryDocuments, cursor, pageSize); + LibraryDocuments result = apiInstance.getLibraryDocuments(authorization, xApiUser, xOnBehalfOfUser, groupId, showHiddenLibraryDocuments, cursor, pageSize); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling LibraryDocumentsApi#getLibraryDocuments"); @@ -633,6 +841,7 @@ Name | Type | Description | Notes **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **groupId** | **String**| The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. | [optional] **showHiddenLibraryDocuments** | **Boolean**| A query parameter to fetch all the hidden library documents along with the visible library documents. Default value is false. | [optional] **cursor** | **String**| Used to navigate through the pages. If not provided, returns the first page. | [optional] **pageSize** | **Integer**| Number of intended items in the response page. If not provided, it is decided by the application settings. | [optional] @@ -645,6 +854,59 @@ Name | Type | Description | Notes No authorization required +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **updateFormFields** +> LibraryDocumentFormFields updateFormFields(authorization, libraryDocumentId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, ifNoneMatch) + +Updates details of form fields of a library document. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.LibraryDocumentsApi; + + +LibraryDocumentsApi apiInstance = new LibraryDocumentsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String libraryDocumentId = "libraryDocumentId_example"; // String | The document identifier, as retrieved from the API to fetch library documents. +FormFieldPutInfo formFieldPutInfo = new FormFieldPutInfo(); // FormFieldPutInfo | List of form fields to set for library document +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. +try { + LibraryDocumentFormFields result = apiInstance.updateFormFields(authorization, libraryDocumentId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, ifNoneMatch); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling LibraryDocumentsApi#updateFormFields"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_write')\" oncontextmenu=\"this.href=oauthDoc('library_write')\" target=\"oauthDoc\">library_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **libraryDocumentId** | **String**| The document identifier, as retrieved from the API to fetch library documents. | + **formFieldPutInfo** | [**FormFieldPutInfo**](FormFieldPutInfo.md)| List of form fields to set for library document | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] + +### Return type + +[**LibraryDocumentFormFields**](LibraryDocumentFormFields.md) + +### Authorization + +No authorization required + ### HTTP request headers - **Content-Type**: Not defined @@ -652,7 +914,7 @@ No authorization required # **updateLibraryDocument** -> updateLibraryDocument(authorization, ifMatch, libraryDocumentId, libraryDocumentInfo, xApiUser, xOnBehalfOfUser) +> updateLibraryDocument(authorization, libraryDocumentId, libraryDocumentInfo, xApiUser, xOnBehalfOfUser, ifMatch) Updates the library document. @@ -667,13 +929,13 @@ Currently status, name, sharingMode and templateTypes of the library document ca LibraryDocumentsApi apiInstance = new LibraryDocumentsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String libraryDocumentId = "libraryDocumentId_example"; // String | The document identifier, as retrieved from the API to fetch library documents. LibraryDocumentInfo libraryDocumentInfo = new LibraryDocumentInfo(); // LibraryDocumentInfo | Information about the library document that you want to create. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. try { - apiInstance.updateLibraryDocument(authorization, ifMatch, libraryDocumentId, libraryDocumentInfo, xApiUser, xOnBehalfOfUser); + apiInstance.updateLibraryDocument(authorization, libraryDocumentId, libraryDocumentInfo, xApiUser, xOnBehalfOfUser, ifMatch); } catch (ApiException e) { System.err.println("Exception when calling LibraryDocumentsApi#updateLibraryDocument"); e.printStackTrace(); @@ -685,11 +947,11 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_write')\" oncontextmenu=\"this.href=oauthDoc('library_write')\" target=\"oauthDoc\">library_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | **libraryDocumentId** | **String**| The document identifier, as retrieved from the API to fetch library documents. | **libraryDocumentInfo** | [**LibraryDocumentInfo**](LibraryDocumentInfo.md)| Information about the library document that you want to create. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] ### Return type @@ -756,11 +1018,11 @@ No authorization required # **updateLibraryDocumentState** -> updateLibraryDocumentState(authorization, ifMatch, libraryDocumentId, libraryDocumentStateInfo, xApiUser, xOnBehalfOfUser) +> updateLibraryDocumentState(authorization, libraryDocumentId, libraryDocumentStateInfo, xApiUser, xOnBehalfOfUser, ifMatch) Updates the library document's state. -Currently state can be changed from AUTHORING to ACTIVE. +Currently state can be changed from AUTHORING to ACTIVE, AUTHORING to REMOVED or ACTIVE to REMOVED ### Example ```java @@ -771,13 +1033,13 @@ Currently state can be changed from AUTHORING to ACTIVE. LibraryDocumentsApi apiInstance = new LibraryDocumentsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String libraryDocumentId = "libraryDocumentId_example"; // String | The document identifier, as retrieved from the API to fetch library documents. LibraryDocumentStateInfo libraryDocumentStateInfo = new LibraryDocumentStateInfo(); // LibraryDocumentStateInfo | Information about the state of library document to which you want to update String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. try { - apiInstance.updateLibraryDocumentState(authorization, ifMatch, libraryDocumentId, libraryDocumentStateInfo, xApiUser, xOnBehalfOfUser); + apiInstance.updateLibraryDocumentState(authorization, libraryDocumentId, libraryDocumentStateInfo, xApiUser, xOnBehalfOfUser, ifMatch); } catch (ApiException e) { System.err.println("Exception when calling LibraryDocumentsApi#updateLibraryDocumentState"); e.printStackTrace(); @@ -789,11 +1051,11 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_write')\" oncontextmenu=\"this.href=oauthDoc('library_write')\" target=\"oauthDoc\">library_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | **libraryDocumentId** | **String**| The document identifier, as retrieved from the API to fetch library documents. | **libraryDocumentStateInfo** | [**LibraryDocumentStateInfo**](LibraryDocumentStateInfo.md)| Information about the state of library document to which you want to update | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] ### Return type diff --git a/docs/LibraryView.md b/docs/LibraryView.md index d928194..c874ed2 100755 --- a/docs/LibraryView.md +++ b/docs/LibraryView.md @@ -4,10 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**embeddedCode** | **String** | Embedded code of url of resource | [optional] -**expiration** | [**Date**](Date.md) | Expiration of user url | [optional] **isCurrent** | **Boolean** | True if this view is the current view | [optional] +**embeddedCode** | **String** | Embedded code of url of resource | [optional] **name** | [**NameEnum**](#NameEnum) | Name of the requested libraryDocument view | [optional] +**expiration** | [**Date**](Date.md) | Expiration of user url | [optional] **url** | **String** | Url of resource location | [optional] diff --git a/docs/LocaleFieldInfoDescription.md b/docs/LocaleFieldInfoDescription.md new file mode 100644 index 0000000..d755646 --- /dev/null +++ b/docs/LocaleFieldInfoDescription.md @@ -0,0 +1,14 @@ + +# LocaleFieldInfoDescription + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**visible** | **Boolean** | Whether current field is visible or not. If visible attribute for this field is false then this field should not be visible in the agreement creation UI using this workflow to user | [optional] +**defaultValue** | **String** | default value of the field if input for this field is not provided and this field is required | [optional] +**editable** | **Boolean** | Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation | [optional] +**required** | **Boolean** | Whether this field is required or optional | [optional] +**availableLocales** | **List<String>** | Which locales can be chosen for this workflow | [optional] + + + diff --git a/docs/MegaSign.md b/docs/MegaSign.md index fba62b4..14ca74e 100755 --- a/docs/MegaSign.md +++ b/docs/MegaSign.md @@ -4,10 +4,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**hidden** | **Boolean** | True, if megaSign is hidden for the user | [optional] **displayDate** | [**Date**](Date.md) | The display date for the MegaSign parent agreement. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**id** | **String** | The unique identifier of the MegaSign parent agreement | [optional] +**groupId** | **String** | Unique identifier of the group | [optional] **esign** | **Boolean** | True, if the signature type of the MegaSign parent agreement is ESIGN. False, if the signature type of the MegaSign parent agreement is WRITTEN | [optional] **name** | **String** | Name of the MegaSign parent agreement | [optional] +**id** | **String** | The unique identifier of the MegaSign parent agreement | [optional] **status** | [**StatusEnum**](#StatusEnum) | Current status of the MegaSign parent agreement from the perspective of the user | [optional] diff --git a/docs/MegaSignChildAgreement.md b/docs/MegaSignChildAgreement.md index 12ade15..38737e3 100755 --- a/docs/MegaSignChildAgreement.md +++ b/docs/MegaSignChildAgreement.md @@ -5,12 +5,23 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **displayDate** | [**Date**](Date.md) | The display date for the agreement. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**id** | **String** | The unique identifier of the agreement.If provided in POST, it will simply be ignored | [optional] **esign** | **Boolean** | True if this is an e-sign document | [optional] **name** | **String** | Name of the Agreement | [optional] +**id** | **String** | The unique identifier of the agreement.If provided in POST, it will simply be ignored | [optional] +**type** | [**TypeEnum**](#TypeEnum) | The kind of agreement | [optional] +**parentId** | **String** | The parent id of a megaSign child *OR* the originating id of a widget agreement instance | [optional] **status** | [**StatusEnum**](#StatusEnum) | This is a server generated attribute which provides the detailed status of an agreement with respect to the apiCaller | [optional] + +## Enum: TypeEnum +Name | Value +---- | ----- +AGREEMENT | "AGREEMENT" +MEGASIGN_CHILD | "MEGASIGN_CHILD" +WIDGET_INSTANCE | "WIDGET_INSTANCE" + + ## Enum: StatusEnum Name | Value diff --git a/docs/MegaSignChildAgreements.md b/docs/MegaSignChildAgreements.md index 6a570ff..88983cd 100755 --- a/docs/MegaSignChildAgreements.md +++ b/docs/MegaSignChildAgreements.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**megaSignChildAgreementList** | [**List<MegaSignChildAgreement>**](MegaSignChildAgreement.md) | A array of MegaSign child agreements | [optional] **page** | [**PageInfo**](PageInfo.md) | Pagination information for navigating through the response | [optional] +**megaSignChildAgreementList** | [**List<MegaSignChildAgreement>**](MegaSignChildAgreement.md) | A array of MegaSign child agreements | [optional] diff --git a/docs/MegaSignChildAgreementsFileInfo.md b/docs/MegaSignChildAgreementsFileInfo.md index a5c729b..3ee72d8 100755 --- a/docs/MegaSignChildAgreementsFileInfo.md +++ b/docs/MegaSignChildAgreementsFileInfo.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**childAgreementsInfoFileId** | **String** | id of the file containg information about the existing childAgreementsInfo associated with the megaSign. Will be ignored in POST call and in case of GET call, this is the only thing that will be returned. The content of the file can be fetched through GET /megaSigns/{megaSignId}/childAgreementsInfo/{childAgreementsInfoFileId} endpoint. | [optional] -**fileType** | [**FileTypeEnum**](#FileTypeEnum) | Input type through which participantSetsInfos will be provided. Whichever input type is provided, the values should be provided in its corresponding value object. Currently we are supporting CSV file format for providing megaSIgn child recipients. | [optional] **transientDocumentId** | **String** | Transient id of the input file which contains participantSetsInfos. Currently only csv format is suppported. More details about CSV format <a href='https://www.adobe.com/go/documentcloud_megasigncsv'>here</a> | [optional] +**fileType** | [**FileTypeEnum**](#FileTypeEnum) | Input type through which participantSetsInfos will be provided. Whichever input type is provided, the values should be provided in its corresponding value object. Currently we are supporting CSV file format for providing megaSIgn child recipients. | [optional] +**childAgreementsInfoFileId** | **String** | id of the file containg information about the existing childAgreementsInfo associated with the megaSign. Will be ignored in POST and PUT calls and in the case of GET call, this is the only thing that will be returned. The content of the file can be fetched through GET /megaSigns/{megaSignId}/childAgreementsInfo/{childAgreementsInfoFileId} endpoint. | [optional] diff --git a/docs/MegaSignCreationInfo.md b/docs/MegaSignCreationInfo.md index 2b78352..7a05fd2 100755 --- a/docs/MegaSignCreationInfo.md +++ b/docs/MegaSignCreationInfo.md @@ -4,25 +4,37 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ccs** | [**List<MegaSignCcInfo>**](MegaSignCcInfo.md) | A list of one or more CCs that will be copied in the megasign transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file | [optional] +**firstReminderDelay** | **Integer** | Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT | [optional] +**groupId** | **String** | The unique identifier of the group to which the megasign agreement will belong to when it is created. If it is not provided during agreement creation the primary group of the creator will be used | [optional] **childAgreementsInfo** | [**ChildAgreementsInfo**](ChildAgreementsInfo.md) | Info corresponding to each child agreement of the megaSign | [optional] -**createdDate** | [**Date**](Date.md) | Date when megasign was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**expirationTime** | [**Date**](Date.md) | Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. | [optional] +**signatureType** | [**SignatureTypeEnum**](#SignatureTypeEnum) | Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system | [optional] **externalId** | [**ExternalId**](ExternalId.md) | An arbitrary value from your system, which can be specified at sending time and then later returned or queried | [optional] -**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] -**firstReminderDelay** | **Integer** | Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT | [optional] -**id** | **String** | The unique identifier of megasign | [optional] **locale** | **String** | The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender | [optional] **message** | **String** | An optional message to the participants, describing what is being sent or why their signature is required | [optional] -**name** | **String** | The name of the agreement that will be used to identify it, in emails, website and other places | [optional] +**vaultingInfo** | [**VaultingInfo**](VaultingInfo.md) | Vaulting properties that allows Adobe Sign to securely store documents with a vault provider | [optional] +**securityOption** | [**MegaSignSecurityOption**](MegaSignSecurityOption.md) | Optional security parameters for the megasign | [optional] **postSignOption** | [**PostSignOption**](PostSignOption.md) | URL and associated properties for the success page the user will be taken to after completing the signing process | [optional] **reminderFrequency** | [**ReminderFrequencyEnum**](#ReminderFrequencyEnum) | Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used | [optional] -**securityOption** | [**MegaSignSecurityOption**](MegaSignSecurityOption.md) | Optional security parameters for the megasign | [optional] +**ccs** | [**List<MegaSignCcInfo>**](MegaSignCcInfo.md) | A list of one or more CCs that will be copied in the megasign transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file | [optional] +**createdDate** | [**Date**](Date.md) | Date when megasign was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**isDocumentRetentionApplied** | **Boolean** | Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. | [optional] +**expirationTime** | [**Date**](Date.md) | Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. | [optional] +**lastEventDate** | [**Date**](Date.md) | The date of the last event that occurred for this megasign. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] **senderEmail** | **String** | Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored | [optional] -**signatureType** | [**SignatureTypeEnum**](#SignatureTypeEnum) | Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system | [optional] +**name** | **String** | The name of the agreement that will be used to identify it, in emails, website and other places | [optional] +**numChildren** | **Integer** | The total number of MegaSign children associated with the MegaSign parent. If provided in POST, it will be ignored. If modified in PUT, it will throw error MODIFYING_IMMUTABLE_FIELDS | [optional] +**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] +**id** | **String** | The unique identifier of megasign | [optional] **state** | [**StateEnum**](#StateEnum) | State of the Megasign | [optional] **status** | [**StatusEnum**](#StatusEnum) | Status of the Megasign | [optional] -**vaultingInfo** | [**VaultingInfo**](VaultingInfo.md) | Vaulting properties that allows Adobe Sign to securely store documents with a vault provider | [optional] + + + +## Enum: SignatureTypeEnum +Name | Value +---- | ----- +ESIGN | "ESIGN" +WRITTEN | "WRITTEN" @@ -37,14 +49,6 @@ EVERY_FIFTH_DAY_UNTIL_SIGNED | "EVERY_FIFTH_DAY_UNTIL_SIGNED" WEEKLY_UNTIL_SIGNED | "WEEKLY_UNTIL_SIGNED" - -## Enum: SignatureTypeEnum -Name | Value ----- | ----- -ESIGN | "ESIGN" -WRITTEN | "WRITTEN" - - ## Enum: StateEnum Name | Value diff --git a/docs/MegaSignInfo.md b/docs/MegaSignInfo.md new file mode 100644 index 0000000..eb92c4c --- /dev/null +++ b/docs/MegaSignInfo.md @@ -0,0 +1,71 @@ + +# MegaSignInfo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**firstReminderDelay** | **Integer** | Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT | [optional] +**groupId** | **String** | The unique identifier of the group to which the megasign agreement will belong to when it is created. If it is not provided during agreement creation the primary group of the creator will be used | [optional] +**childAgreementsInfo** | [**ChildAgreementsInfo**](ChildAgreementsInfo.md) | Info corresponding to each child agreement of the megaSign | [optional] +**signatureType** | [**SignatureTypeEnum**](#SignatureTypeEnum) | Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system | [optional] +**externalId** | [**ExternalId**](ExternalId.md) | An arbitrary value from your system, which can be specified at sending time and then later returned or queried | [optional] +**locale** | **String** | The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender | [optional] +**message** | **String** | An optional message to the participants, describing what is being sent or why their signature is required | [optional] +**vaultingInfo** | [**VaultingInfo**](VaultingInfo.md) | Vaulting properties that allows Adobe Sign to securely store documents with a vault provider | [optional] +**securityOption** | [**MegaSignSecurityOption**](MegaSignSecurityOption.md) | Optional security parameters for the megasign | [optional] +**postSignOption** | [**PostSignOption**](PostSignOption.md) | URL and associated properties for the success page the user will be taken to after completing the signing process | [optional] +**reminderFrequency** | [**ReminderFrequencyEnum**](#ReminderFrequencyEnum) | Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used | [optional] +**ccs** | [**List<MegaSignCcInfo>**](MegaSignCcInfo.md) | A list of one or more CCs that will be copied in the megasign transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file | [optional] +**createdDate** | [**Date**](Date.md) | Date when megasign was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**isDocumentRetentionApplied** | **Boolean** | Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. | [optional] +**expirationTime** | [**Date**](Date.md) | Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. | [optional] +**lastEventDate** | [**Date**](Date.md) | The date of the last event that occurred for this megasign. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**senderEmail** | **String** | Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored | [optional] +**name** | **String** | The name of the agreement that will be used to identify it, in emails, website and other places | [optional] +**numChildren** | **Integer** | The total number of MegaSign children associated with the MegaSign parent. If provided in POST, it will be ignored. If modified in PUT, it will throw error MODIFYING_IMMUTABLE_FIELDS | [optional] +**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] +**id** | **String** | The unique identifier of megasign | [optional] +**state** | [**StateEnum**](#StateEnum) | State of the Megasign | [optional] +**status** | [**StatusEnum**](#StatusEnum) | Status of the Megasign | [optional] + + + +## Enum: SignatureTypeEnum +Name | Value +---- | ----- +ESIGN | "ESIGN" +WRITTEN | "WRITTEN" + + + +## Enum: ReminderFrequencyEnum +Name | Value +---- | ----- +DAILY_UNTIL_SIGNED | "DAILY_UNTIL_SIGNED" +WEEKDAILY_UNTIL_SIGNED | "WEEKDAILY_UNTIL_SIGNED" +EVERY_OTHER_DAY_UNTIL_SIGNED | "EVERY_OTHER_DAY_UNTIL_SIGNED" +EVERY_THIRD_DAY_UNTIL_SIGNED | "EVERY_THIRD_DAY_UNTIL_SIGNED" +EVERY_FIFTH_DAY_UNTIL_SIGNED | "EVERY_FIFTH_DAY_UNTIL_SIGNED" +WEEKLY_UNTIL_SIGNED | "WEEKLY_UNTIL_SIGNED" + + + +## Enum: StateEnum +Name | Value +---- | ----- +PROCESS | "IN_PROCESS" + + + +## Enum: StatusEnum +Name | Value +---- | ----- +AUTHORING | "AUTHORING" +IN_PROCESS | "IN_PROCESS" +CANCELLED | "CANCELLED" +COMPLETED | "COMPLETED" +EXPIRED | "EXPIRED" +PREFILL | "PREFILL" + + + diff --git a/docs/MegaSignMembersInfo.md b/docs/MegaSignMembersInfo.md new file mode 100644 index 0000000..92b480b --- /dev/null +++ b/docs/MegaSignMembersInfo.md @@ -0,0 +1,13 @@ + +# MegaSignMembersInfo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**participantSets** | [**List<DetailedParticipantSetInfo>**](DetailedParticipantSetInfo.md) | Information about the participant Sets. | [optional] +**ccsInfo** | [**List<CCParticipantInfo>**](CCParticipantInfo.md) | Information of CC participants of the megaSign. | [optional] +**senderInfo** | [**SenderInfo**](SenderInfo.md) | Information of the sender of the megaSign. | [optional] +**sharesInfo** | [**List<ShareParticipantInfo>**](ShareParticipantInfo.md) | Information of the participants with whom the megaSign has been shared. | [optional] + + + diff --git a/docs/MegaSignRemindersResponse.md b/docs/MegaSignRemindersResponse.md new file mode 100644 index 0000000..7df0f0a --- /dev/null +++ b/docs/MegaSignRemindersResponse.md @@ -0,0 +1,10 @@ + +# MegaSignRemindersResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reminderInfoList** | [**List<ReminderInfo>**](ReminderInfo.md) | A list of one or more reminders created on the MegaSign parent specified by the unique identifier megasignId by the user invoking the API. | [optional] + + + diff --git a/docs/MegaSignSecurityOption.md b/docs/MegaSignSecurityOption.md index 07695ba..4aaf9b1 100755 --- a/docs/MegaSignSecurityOption.md +++ b/docs/MegaSignSecurityOption.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **externalAuthenticationMethod** | [**ExternalAuthenticationMethodEnum**](#ExternalAuthenticationMethodEnum) | The authentication method for the participants to have access to view and sign the document. | [optional] -**externalPassword** | **String** | The secondary password that will be used to protect signing the document for internal signers. Note that Adobe Sign will never show this password to anyone, so you will need to separately communicate it to any relevant parties. This password is applied only if password protection is specified for internal signers or all signers | [optional] **internalAuthenticationMethod** | [**InternalAuthenticationMethodEnum**](#InternalAuthenticationMethodEnum) | The authentication method for the participants to have access to view and sign the document. | [optional] +**externalPassword** | **String** | The secondary password that will be used to protect signing the document for internal signers. Note that Adobe Sign will never show this password to anyone, so you will need to separately communicate it to any relevant parties. This password is applied only if password protection is specified for internal signers or all signers | [optional] **internalPassword** | **String** | The secondary password that will be used to protect signing the document for external signers. Note that Adobe Sign will never show this password to anyone, so you will need to separately communicate it to any relevant parties. This password is applied only if password protection is specified for external signers or all signers | [optional] **openPassword** | **String** | The secondary password that will be used to secure the PDF document. Note that AdobeSign will never show this password to anyone, so you will need to separately communicate it to any relevant parties | [optional] diff --git a/docs/MegaSignStateInfo.md b/docs/MegaSignStateInfo.md index d4b14df..480aaf6 100755 --- a/docs/MegaSignStateInfo.md +++ b/docs/MegaSignStateInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**megaSignCancellationInfo** | [**AgreementCancellationInfo**](AgreementCancellationInfo.md) | Cancellation information for the agreement. Mandatory while cancelling a megaSign | [optional] **state** | [**StateEnum**](#StateEnum) | The state to which the megaSign is to be updated. The only valid state for this variable is currently, CANCELLED | [optional] +**megaSignCancellationInfo** | [**AgreementCancellationInfo**](AgreementCancellationInfo.md) | Cancellation information for the agreement. Mandatory while cancelling a megaSign | [optional] diff --git a/docs/MegaSignView.md b/docs/MegaSignView.md index a9b82a0..15e9e17 100755 --- a/docs/MegaSignView.md +++ b/docs/MegaSignView.md @@ -4,10 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**embeddedCode** | **String** | Embedded code of url of resource | [optional] -**expiration** | [**Date**](Date.md) | Expiration of user url | [optional] **isCurrent** | **Boolean** | True if this view is the current view | [optional] +**embeddedCode** | **String** | Embedded code of url of resource | [optional] **name** | [**NameEnum**](#NameEnum) | Name of the requested mega sign view | [optional] +**expiration** | [**Date**](Date.md) | Expiration of user url | [optional] **url** | **String** | Url of resource location | [optional] @@ -15,11 +15,13 @@ Name | Type | Description | Notes ## Enum: NameEnum Name | Value ---- | ----- +ACTIVITY_REPORT | "ACTIVITY_REPORT" AUTHORING | "AUTHORING" DOCUMENT | "DOCUMENT" MANAGE | "MANAGE" POST_CREATE | "POST_CREATE" PREFILL | "PREFILL" +SIGNING | "SIGNING" ALL | "ALL" diff --git a/docs/MegaSignViewInfo.md b/docs/MegaSignViewInfo.md index 8374d15..5f69089 100755 --- a/docs/MegaSignViewInfo.md +++ b/docs/MegaSignViewInfo.md @@ -12,11 +12,13 @@ Name | Type | Description | Notes ## Enum: NameEnum Name | Value ---- | ----- +ACTIVITY_REPORT | "ACTIVITY_REPORT" AUTHORING | "AUTHORING" DOCUMENT | "DOCUMENT" MANAGE | "MANAGE" POST_CREATE | "POST_CREATE" PREFILL | "PREFILL" +SIGNING | "SIGNING" ALL | "ALL" diff --git a/docs/MegaSignsApi.md b/docs/MegaSignsApi.md index 0b91524..dffa34c 100755 --- a/docs/MegaSignsApi.md +++ b/docs/MegaSignsApi.md @@ -1,19 +1,34 @@ # MegaSignsApi -All URIs are relative to *http://localhost/api/rest/v6* +All URIs are relative to *https://secure.au1.echosign.com/api/rest/v6* Method | HTTP request | Description ------------- | ------------- | ------------- [**createMegaSign**](MegaSignsApi.md#createMegaSign) | **POST** /megaSigns | Send an agreement out for signature to multiple recipients. Each recipient will receive and sign their own copy of the agreement. +[**createReminderOnMegaSign**](MegaSignsApi.md#createReminderOnMegaSign) | **POST** /megaSigns/{megaSignId}/reminders | Creates a reminder on the specified participants of the MegaSign parent. +[**createShareOnMegaSign**](MegaSignsApi.md#createShareOnMegaSign) | **POST** /megaSigns/{megaSignId}/members/share | Share a MegaSign parent and all the child agreements with someone. +[**getAllMegaSignMembers**](MegaSignsApi.md#getAllMegaSignMembers) | **GET** /megaSigns/{megaSignId}/members | Retrieves detailed member info along with IDs for different types of participants associated with the MegaSign parent agreement. [**getChildAgreementsInfoFile**](MegaSignsApi.md#getChildAgreementsInfoFile) | **GET** /megaSigns/{megaSignId}/childAgreementsInfo/{childAgreementsInfoFileId} | Retrieves the file stream of the original childAgreementsInfoFile that was uploaded by sender while creating the MegaSign. [**getEvents**](MegaSignsApi.md#getEvents) | **GET** /megaSigns/{megaSignId}/events | Retrieves the events information for the MegaSign parent agreement. +[**getMegaSignAllDocuments**](MegaSignsApi.md#getMegaSignAllDocuments) | **GET** /megaSigns/{megaSignId}/documents | Retrieves the IDs of the documents associated with a MegaSign parent agreement. +[**getMegaSignAllDocumentsImageUrls**](MegaSignsApi.md#getMegaSignAllDocumentsImageUrls) | **GET** /megaSigns/{megaSignId}/documents/imageUrls | Retrieves image urls of all visible pages of a document associated with a MegaSign parent agreement. [**getMegaSignChildAgreements**](MegaSignsApi.md#getMegaSignChildAgreements) | **GET** /megaSigns/{megaSignId}/agreements | Get all the child agreements of the specified MegaSign parent agreement. [**getMegaSignCombinedDocument**](MegaSignsApi.md#getMegaSignCombinedDocument) | **GET** /megaSigns/{megaSignId}/combinedDocument | Retrieves a single combined PDF document for the documents associated with the MegaSign parent agreement. +[**getMegaSignCombinedDocumentUrl**](MegaSignsApi.md#getMegaSignCombinedDocumentUrl) | **GET** /megaSigns/{megaSignId}/combinedDocument/url | Retrieves url of all visible pages of all the documents associated with the MegaSign parent agreement. +[**getMegaSignDocumentInfo**](MegaSignsApi.md#getMegaSignDocumentInfo) | **GET** /megaSigns/{megaSignId}/documents/{documentId} | Retrieves the file stream of a document of a MegaSign parent agreement. [**getMegaSignFormData**](MegaSignsApi.md#getMegaSignFormData) | **GET** /megaSigns/{megaSignId}/formData | Retrieves data entered by recipients into interactive form fields at the time they signed the child agreements of the specified MegaSign agreement [**getMegaSignInfo**](MegaSignsApi.md#getMegaSignInfo) | **GET** /megaSigns/{megaSignId} | Get detailed information of the specified MegaSign parent agreement. +[**getMegaSignInfoForUser**](MegaSignsApi.md#getMegaSignInfoForUser) | **GET** /megaSigns/{megaSignId}/me | Retrieves the MegaSign parent agreement information related to the api caller +[**getMegaSignNoteForUser**](MegaSignsApi.md#getMegaSignNoteForUser) | **GET** /megaSigns/{megaSignId}/me/note | Retrieves the latest note of a MegaSign parent agreement for the user. +[**getMegaSignReminder**](MegaSignsApi.md#getMegaSignReminder) | **GET** /megaSigns/{megaSignId}/reminders/{reminderId} | Retrieves a specific reminder given the reminder id for the specified MegaSign parent agreement. +[**getMegaSignReminders**](MegaSignsApi.md#getMegaSignReminders) | **GET** /megaSigns/{megaSignId}/reminders | Retrieves the reminders of the specified MegaSign parent agreement. [**getMegaSignView**](MegaSignsApi.md#getMegaSignView) | **POST** /megaSigns/{megaSignId}/views | Retrieves the requested views of mega sign agreement. [**getMegaSigns**](MegaSignsApi.md#getMegaSigns) | **GET** /megaSigns | Retrieves MegaSign parent agreements for a user. +[**updateMegaSign**](MegaSignsApi.md#updateMegaSign) | **PUT** /megaSigns/{megaSignId} | Update the expirationTime on an existing megaSign parent and all the child agreements that are already out for signature. +[**updateMegaSignNoteForUser**](MegaSignsApi.md#updateMegaSignNoteForUser) | **PUT** /megaSigns/{megaSignId}/me/note | Updates the latest note of a MegaSign parent agreement for the user. +[**updateMegaSignReminder**](MegaSignsApi.md#updateMegaSignReminder) | **PUT** /megaSigns/{megaSignId}/reminders/{reminderId} | Updates an existing reminder for a MegaSign parent agreement. [**updateMegaSignState**](MegaSignsApi.md#updateMegaSignState) | **PUT** /megaSigns/{megaSignId}/state | Updates the state of a MegaSign identified by MegaSignId in the path. +[**updateMegaSignVisibility**](MegaSignsApi.md#updateMegaSignVisibility) | **PUT** /megaSigns/{megaSignId}/me/visibility | Updates the visibility of a MegaSign. @@ -62,6 +77,159 @@ Name | Type | Description | Notes No authorization required +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **createReminderOnMegaSign** +> ReminderCreationResult createReminderOnMegaSign(authorization, megaSignId, reminderInfo, xApiUser, xOnBehalfOfUser) + +Creates a reminder on the specified participants of the MegaSign parent. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.MegaSignsApi; + + +MegaSignsApi apiInstance = new MegaSignsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements +ReminderInfo reminderInfo = new ReminderInfo(); // ReminderInfo | The information about a reminder associated with a recipient of an agreement. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +try { + ReminderCreationResult result = apiInstance.createReminderOnMegaSign(authorization, megaSignId, reminderInfo, xApiUser, xOnBehalfOfUser); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling MegaSignsApi#createReminderOnMegaSign"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | + **reminderInfo** | [**ReminderInfo**](ReminderInfo.md)| The information about a reminder associated with a recipient of an agreement. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + +### Return type + +[**ReminderCreationResult**](ReminderCreationResult.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **createShareOnMegaSign** +> ShareCreationResponseList createShareOnMegaSign(authorization, megaSignId, shareCreationInfoList, xApiUser, xOnBehalfOfUser) + +Share a MegaSign parent and all the child agreements with someone. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.MegaSignsApi; + + +MegaSignsApi apiInstance = new MegaSignsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements +ShareCreationInfoList shareCreationInfoList = new ShareCreationInfoList(); // ShareCreationInfoList | List of agreement share creation information objects. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +try { + ShareCreationResponseList result = apiInstance.createShareOnMegaSign(authorization, megaSignId, shareCreationInfoList, xApiUser, xOnBehalfOfUser); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling MegaSignsApi#createShareOnMegaSign"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | + **shareCreationInfoList** | [**ShareCreationInfoList**](ShareCreationInfoList.md)| List of agreement share creation information objects. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + +### Return type + +[**ShareCreationResponseList**](ShareCreationResponseList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **getAllMegaSignMembers** +> MegaSignMembersInfo getAllMegaSignMembers(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch) + +Retrieves detailed member info along with IDs for different types of participants associated with the MegaSign parent agreement. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.MegaSignsApi; + + +MegaSignsApi apiInstance = new MegaSignsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. +try { + MegaSignMembersInfo result = apiInstance.getAllMegaSignMembers(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling MegaSignsApi#getAllMegaSignMembers"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] + +### Return type + +[**MegaSignMembersInfo**](MegaSignMembersInfo.md) + +### Authorization + +No authorization required + ### HTTP request headers - **Content-Type**: Not defined @@ -71,7 +239,429 @@ No authorization required # **getChildAgreementsInfoFile** > byte[] getChildAgreementsInfoFile(authorization, megaSignId, childAgreementsInfoFileId, xApiUser, xOnBehalfOfUser, ifNoneMatch) -Retrieves the file stream of the original childAgreementsInfoFile that was uploaded by sender while creating the MegaSign. +Retrieves the file stream of the original childAgreementsInfoFile that was uploaded by sender while creating the MegaSign. + +CSV file stream containing form data information + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.MegaSignsApi; + + +MegaSignsApi apiInstance = new MegaSignsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements +String childAgreementsInfoFileId = "childAgreementsInfoFileId_example"; // String | The identifier of the childAgreementsInfoFile that has been uploaded by sender while creating the megaSign or retrieved from the API to fetch megaSignInfo +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. +try { + byte[] result = apiInstance.getChildAgreementsInfoFile(authorization, megaSignId, childAgreementsInfoFileId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling MegaSignsApi#getChildAgreementsInfoFile"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | + **childAgreementsInfoFileId** | **String**| The identifier of the childAgreementsInfoFile that has been uploaded by sender while creating the megaSign or retrieved from the API to fetch megaSignInfo | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] + +### Return type + +**byte[]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/csv + + +# **getEvents** +> MegasignEventList getEvents(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch) + +Retrieves the events information for the MegaSign parent agreement. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.MegaSignsApi; + + +MegaSignsApi apiInstance = new MegaSignsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. +try { + MegasignEventList result = apiInstance.getEvents(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling MegaSignsApi#getEvents"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] + +### Return type + +[**MegasignEventList**](MegasignEventList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **getMegaSignAllDocuments** +> AgreementDocuments getMegaSignAllDocuments(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch) + +Retrieves the IDs of the documents associated with a MegaSign parent agreement. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.MegaSignsApi; + + +MegaSignsApi apiInstance = new MegaSignsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. +try { + AgreementDocuments result = apiInstance.getMegaSignAllDocuments(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling MegaSignsApi#getMegaSignAllDocuments"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] + +### Return type + +[**AgreementDocuments**](AgreementDocuments.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **getMegaSignAllDocumentsImageUrls** +> BasicDocumentsImageUrlsInfo getMegaSignAllDocumentsImageUrls(authorization, megaSignId, xApiUser, xOnBehalfOfUser, imageSizes, showImageAvailabilityOnly) + +Retrieves image urls of all visible pages of a document associated with a MegaSign parent agreement. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.MegaSignsApi; + + +MegaSignsApi apiInstance = new MegaSignsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String imageSizes = "imageSizes_example"; // String | A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. +Boolean showImageAvailabilityOnly = true; // Boolean | When set to true, returns only image availability. Else, returns both image urls and its availability. +try { + BasicDocumentsImageUrlsInfo result = apiInstance.getMegaSignAllDocumentsImageUrls(authorization, megaSignId, xApiUser, xOnBehalfOfUser, imageSizes, showImageAvailabilityOnly); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling MegaSignsApi#getMegaSignAllDocumentsImageUrls"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **imageSizes** | **String**| A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. | [optional] + **showImageAvailabilityOnly** | **Boolean**| When set to true, returns only image availability. Else, returns both image urls and its availability. | [optional] + +### Return type + +[**BasicDocumentsImageUrlsInfo**](BasicDocumentsImageUrlsInfo.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **getMegaSignChildAgreements** +> MegaSignChildAgreements getMegaSignChildAgreements(authorization, megaSignId, xApiUser, xOnBehalfOfUser, cursor, pageSize) + +Get all the child agreements of the specified MegaSign parent agreement. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.MegaSignsApi; + + +MegaSignsApi apiInstance = new MegaSignsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String cursor = "cursor_example"; // String | Used to navigate through the pages. If not provided, returns the first page. +Integer pageSize = 56; // Integer | Number of intended items in the response page. If not provided, it is decided by the application settings. +try { + MegaSignChildAgreements result = apiInstance.getMegaSignChildAgreements(authorization, megaSignId, xApiUser, xOnBehalfOfUser, cursor, pageSize); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling MegaSignsApi#getMegaSignChildAgreements"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **cursor** | **String**| Used to navigate through the pages. If not provided, returns the first page. | [optional] + **pageSize** | **Integer**| Number of intended items in the response page. If not provided, it is decided by the application settings. | [optional] + +### Return type + +[**MegaSignChildAgreements**](MegaSignChildAgreements.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **getMegaSignCombinedDocument** +> byte[] getMegaSignCombinedDocument(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, attachAuditReport) + +Retrieves a single combined PDF document for the documents associated with the MegaSign parent agreement. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.MegaSignsApi; + + +MegaSignsApi apiInstance = new MegaSignsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. +Boolean attachAuditReport = true; // Boolean | When set to true attach an audit report to the MegaSign document PDF. Default value will be false. +try { + byte[] result = apiInstance.getMegaSignCombinedDocument(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, attachAuditReport); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling MegaSignsApi#getMegaSignCombinedDocument"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] + **attachAuditReport** | **Boolean**| When set to true attach an audit report to the MegaSign document PDF. Default value will be false. | [optional] + +### Return type + +**byte[]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/pdf, application/pdf;encoding=base64 + + +# **getMegaSignCombinedDocumentUrl** +> DocumentUrl getMegaSignCombinedDocumentUrl(authorization, megaSignId, xApiUser, xOnBehalfOfUser, attachAuditReport) + +Retrieves url of all visible pages of all the documents associated with the MegaSign parent agreement. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.MegaSignsApi; + + +MegaSignsApi apiInstance = new MegaSignsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +Boolean attachAuditReport = true; // Boolean | When set to true, attach an audit report to the MegaSign PDF. The default value is false. +try { + DocumentUrl result = apiInstance.getMegaSignCombinedDocumentUrl(authorization, megaSignId, xApiUser, xOnBehalfOfUser, attachAuditReport); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling MegaSignsApi#getMegaSignCombinedDocumentUrl"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **attachAuditReport** | **Boolean**| When set to true, attach an audit report to the MegaSign PDF. The default value is false. | [optional] + +### Return type + +[**DocumentUrl**](DocumentUrl.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **getMegaSignDocumentInfo** +> byte[] getMegaSignDocumentInfo(authorization, megaSignId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch) + +Retrieves the file stream of a document of a MegaSign parent agreement. + +Raw stream of the file + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.MegaSignsApi; + + +MegaSignsApi apiInstance = new MegaSignsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements +String documentId = "documentId_example"; // String | The document identifier, as retrieved from the API which fetches the documents of a specified MegaSign parent +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. +try { + byte[] result = apiInstance.getMegaSignDocumentInfo(authorization, megaSignId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling MegaSignsApi#getMegaSignDocumentInfo"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | + **documentId** | **String**| The document identifier, as retrieved from the API which fetches the documents of a specified MegaSign parent | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] + +### Return type + +**byte[]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/pdf, application/pdf;encoding=base64 + + +# **getMegaSignFormData** +> byte[] getMegaSignFormData(authorization, megaSignId, xApiUser, xOnBehalfOfUser) + +Retrieves data entered by recipients into interactive form fields at the time they signed the child agreements of the specified MegaSign agreement CSV file stream containing form data information @@ -85,15 +675,13 @@ CSV file stream containing form data information MegaSignsApi apiInstance = new MegaSignsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements -String childAgreementsInfoFileId = "childAgreementsInfoFileId_example"; // String | The identifier of the childAgreementsInfoFile that has been uploaded by sender while creating the megaSign or retrieved from the API to fetch megaSignInfo String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account -String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. try { - byte[] result = apiInstance.getChildAgreementsInfoFile(authorization, megaSignId, childAgreementsInfoFileId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + byte[] result = apiInstance.getMegaSignFormData(authorization, megaSignId, xApiUser, xOnBehalfOfUser); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling MegaSignsApi#getChildAgreementsInfoFile"); + System.err.println("Exception when calling MegaSignsApi#getMegaSignFormData"); e.printStackTrace(); } ``` @@ -104,10 +692,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | - **childAgreementsInfoFileId** | **String**| The identifier of the childAgreementsInfoFile that has been uploaded by sender while creating the megaSign or retrieved from the API to fetch megaSignInfo | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] - **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] ### Return type @@ -122,11 +708,11 @@ No authorization required - **Content-Type**: Not defined - **Accept**: text/csv - -# **getEvents** -> MegasignEventList getEvents(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch) + +# **getMegaSignInfo** +> FetchedMegaSignInfo getMegaSignInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch) -Retrieves the events information for the MegaSign parent agreement. +Get detailed information of the specified MegaSign parent agreement. ### Example ```java @@ -142,10 +728,10 @@ String xApiUser = "xApiUser_example"; // String | The userId or email of API cal String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. try { - MegasignEventList result = apiInstance.getEvents(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + FetchedMegaSignInfo result = apiInstance.getMegaSignInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling MegaSignsApi#getEvents"); + System.err.println("Exception when calling MegaSignsApi#getMegaSignInfo"); e.printStackTrace(); } ``` @@ -162,7 +748,7 @@ Name | Type | Description | Notes ### Return type -[**MegasignEventList**](MegasignEventList.md) +[**FetchedMegaSignInfo**](FetchedMegaSignInfo.md) ### Authorization @@ -173,11 +759,11 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - -# **getMegaSignChildAgreements** -> MegaSignChildAgreements getMegaSignChildAgreements(authorization, megaSignId, xApiUser, xOnBehalfOfUser, cursor, pageSize) + +# **getMegaSignInfoForUser** +> MyAgreementInfo getMegaSignInfoForUser(authorization, megaSignId, xApiUser) -Get all the child agreements of the specified MegaSign parent agreement. +Retrieves the MegaSign parent agreement information related to the api caller ### Example ```java @@ -190,14 +776,11 @@ MegaSignsApi apiInstance = new MegaSignsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. -String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account -String cursor = "cursor_example"; // String | Used to navigate through the pages. If not provided, returns the first page. -Integer pageSize = 56; // Integer | Number of intended items in the response page. If not provided, it is decided by the application settings. try { - MegaSignChildAgreements result = apiInstance.getMegaSignChildAgreements(authorization, megaSignId, xApiUser, xOnBehalfOfUser, cursor, pageSize); + MyAgreementInfo result = apiInstance.getMegaSignInfoForUser(authorization, megaSignId, xApiUser); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling MegaSignsApi#getMegaSignChildAgreements"); + System.err.println("Exception when calling MegaSignsApi#getMegaSignInfoForUser"); e.printStackTrace(); } ``` @@ -209,13 +792,10 @@ Name | Type | Description | Notes **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] - **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] - **cursor** | **String**| Used to navigate through the pages. If not provided, returns the first page. | [optional] - **pageSize** | **Integer**| Number of intended items in the response page. If not provided, it is decided by the application settings. | [optional] ### Return type -[**MegaSignChildAgreements**](MegaSignChildAgreements.md) +[**MyAgreementInfo**](MyAgreementInfo.md) ### Authorization @@ -226,11 +806,11 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - -# **getMegaSignCombinedDocument** -> byte[] getMegaSignCombinedDocument(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, attachAuditReport) + +# **getMegaSignNoteForUser** +> Note getMegaSignNoteForUser(authorization, megaSignId, xApiUser, xOnBehalfOfUser) -Retrieves a single combined PDF document for the documents associated with the MegaSign parent agreement. +Retrieves the latest note of a MegaSign parent agreement for the user. ### Example ```java @@ -244,13 +824,11 @@ String authorization = "authorization_example"; // String | An userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account -String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. -Boolean attachAuditReport = true; // Boolean | When set to true attach an audit report to the MegaSign document PDF. Default value will be false. try { - byte[] result = apiInstance.getMegaSignCombinedDocument(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, attachAuditReport); + Note result = apiInstance.getMegaSignNoteForUser(authorization, megaSignId, xApiUser, xOnBehalfOfUser); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling MegaSignsApi#getMegaSignCombinedDocument"); + System.err.println("Exception when calling MegaSignsApi#getMegaSignNoteForUser"); e.printStackTrace(); } ``` @@ -263,12 +841,10 @@ Name | Type | Description | Notes **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] - **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] - **attachAuditReport** | **Boolean**| When set to true attach an audit report to the MegaSign document PDF. Default value will be false. | [optional] ### Return type -**byte[]** +[**Note**](Note.md) ### Authorization @@ -277,15 +853,13 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/pdf, application/pdf;encoding=base64 - - -# **getMegaSignFormData** -> byte[] getMegaSignFormData(authorization, megaSignId, xApiUser, xOnBehalfOfUser) + - **Accept**: application/json -Retrieves data entered by recipients into interactive form fields at the time they signed the child agreements of the specified MegaSign agreement + +# **getMegaSignReminder** +> ReminderInfo getMegaSignReminder(authorization, megaSignId, reminderId, xApiUser, xOnBehalfOfUser) -CSV file stream containing form data information +Retrieves a specific reminder given the reminder id for the specified MegaSign parent agreement. ### Example ```java @@ -297,13 +871,14 @@ CSV file stream containing form data information MegaSignsApi apiInstance = new MegaSignsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements +String reminderId = "reminderId_example"; // String | The reminder identifier String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account try { - byte[] result = apiInstance.getMegaSignFormData(authorization, megaSignId, xApiUser, xOnBehalfOfUser); + ReminderInfo result = apiInstance.getMegaSignReminder(authorization, megaSignId, reminderId, xApiUser, xOnBehalfOfUser); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling MegaSignsApi#getMegaSignFormData"); + System.err.println("Exception when calling MegaSignsApi#getMegaSignReminder"); e.printStackTrace(); } ``` @@ -314,12 +889,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | + **reminderId** | **String**| The reminder identifier | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] ### Return type -**byte[]** +[**ReminderInfo**](ReminderInfo.md) ### Authorization @@ -328,13 +904,13 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/csv + - **Accept**: application/json - -# **getMegaSignInfo** -> MegaSignCreationInfo getMegaSignInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch) + +# **getMegaSignReminders** +> MegaSignRemindersResponse getMegaSignReminders(authorization, megaSignId, xApiUser, xOnBehalfOfUser, status) -Get detailed information of the specified MegaSign parent agreement. +Retrieves the reminders of the specified MegaSign parent agreement. ### Example ```java @@ -348,12 +924,12 @@ String authorization = "authorization_example"; // String | An userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account -String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. +String status = "status_example"; // String | A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELED, COMPLETE try { - MegaSignCreationInfo result = apiInstance.getMegaSignInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + MegaSignRemindersResponse result = apiInstance.getMegaSignReminders(authorization, megaSignId, xApiUser, xOnBehalfOfUser, status); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling MegaSignsApi#getMegaSignInfo"); + System.err.println("Exception when calling MegaSignsApi#getMegaSignReminders"); e.printStackTrace(); } ``` @@ -366,11 +942,11 @@ Name | Type | Description | Notes **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] - **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] + **status** | **String**| A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELED, COMPLETE | [optional] ### Return type -[**MegaSignCreationInfo**](MegaSignCreationInfo.md) +[**MegaSignRemindersResponse**](MegaSignRemindersResponse.md) ### Authorization @@ -434,7 +1010,7 @@ No authorization required # **getMegaSigns** -> MegaSigns getMegaSigns(authorization, xApiUser, xOnBehalfOfUser, cursor, pageSize) +> MegaSigns getMegaSigns(authorization, xApiUser, xOnBehalfOfUser, showHiddenMegaSigns, cursor, pageSize, groupId) Retrieves MegaSign parent agreements for a user. @@ -449,10 +1025,12 @@ MegaSignsApi apiInstance = new MegaSignsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +Boolean showHiddenMegaSigns = true; // Boolean | A query parameter to fetch all the hidden MegaSigns along with the visible MegaSigns. Default value is false. String cursor = "cursor_example"; // String | Used to navigate through the pages. If not provided, returns the first page. Integer pageSize = 56; // Integer | Number of intended items in the response page. If not provided, it is decided by the application settings. +String groupId = "groupId_example"; // String | The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. try { - MegaSigns result = apiInstance.getMegaSigns(authorization, xApiUser, xOnBehalfOfUser, cursor, pageSize); + MegaSigns result = apiInstance.getMegaSigns(authorization, xApiUser, xOnBehalfOfUser, showHiddenMegaSigns, cursor, pageSize, groupId); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MegaSignsApi#getMegaSigns"); @@ -467,8 +1045,10 @@ Name | Type | Description | Notes **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **showHiddenMegaSigns** | **Boolean**| A query parameter to fetch all the hidden MegaSigns along with the visible MegaSigns. Default value is false. | [optional] **cursor** | **String**| Used to navigate through the pages. If not provided, returns the first page. | [optional] **pageSize** | **Integer**| Number of intended items in the response page. If not provided, it is decided by the application settings. | [optional] + **groupId** | **String**| The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. | [optional] ### Return type @@ -478,6 +1058,162 @@ Name | Type | Description | Notes No authorization required +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **updateMegaSign** +> updateMegaSign(authorization, megaSignId, megaSignInfo, xApiUser, xOnBehalfOfUser, ifMatch) + +Update the expirationTime on an existing megaSign parent and all the child agreements that are already out for signature. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.MegaSignsApi; + + +MegaSignsApi apiInstance = new MegaSignsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements +MegaSignInfo megaSignInfo = new MegaSignInfo(); // MegaSignInfo | Information necessary to update a modifiable megaSign parent that is presently out for signature. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. +try { + apiInstance.updateMegaSign(authorization, megaSignId, megaSignInfo, xApiUser, xOnBehalfOfUser, ifMatch); +} catch (ApiException e) { + System.err.println("Exception when calling MegaSignsApi#updateMegaSign"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | + **megaSignInfo** | [**MegaSignInfo**](MegaSignInfo.md)| Information necessary to update a modifiable megaSign parent that is presently out for signature. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **updateMegaSignNoteForUser** +> updateMegaSignNoteForUser(authorization, megaSignId, note, xApiUser, xOnBehalfOfUser) + +Updates the latest note of a MegaSign parent agreement for the user. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.MegaSignsApi; + + +MegaSignsApi apiInstance = new MegaSignsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements +Note note = new Note(); // Note | The note to be associated with the MegaSign parent agreement. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +try { + apiInstance.updateMegaSignNoteForUser(authorization, megaSignId, note, xApiUser, xOnBehalfOfUser); +} catch (ApiException e) { + System.err.println("Exception when calling MegaSignsApi#updateMegaSignNoteForUser"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | + **note** | [**Note**](Note.md)| The note to be associated with the MegaSign parent agreement. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **updateMegaSignReminder** +> updateMegaSignReminder(authorization, megaSignId, reminderId, reminderInfo, xApiUser, xOnBehalfOfUser) + +Updates an existing reminder for a MegaSign parent agreement. + +You can only update an ACTIVE reminder, and can only update the status to 'CANCELED', update reminderParticipantIds, update allUnsigned or update note. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.MegaSignsApi; + + +MegaSignsApi apiInstance = new MegaSignsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements +String reminderId = "reminderId_example"; // String | The reminder identifier +ReminderInfo reminderInfo = new ReminderInfo(); // ReminderInfo | The information about a reminder associated with a recipient of an agreement. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +try { + apiInstance.updateMegaSignReminder(authorization, megaSignId, reminderId, reminderInfo, xApiUser, xOnBehalfOfUser); +} catch (ApiException e) { + System.err.println("Exception when calling MegaSignsApi#updateMegaSignReminder"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | + **reminderId** | **String**| The reminder identifier | + **reminderInfo** | [**ReminderInfo**](ReminderInfo.md)| The information about a reminder associated with a recipient of an agreement. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + ### HTTP request headers - **Content-Type**: Not defined @@ -485,7 +1221,7 @@ No authorization required # **updateMegaSignState** -> updateMegaSignState(authorization, ifMatch, megaSignId, megaSignStateInfo, xApiUser, xOnBehalfOfUser) +> updateMegaSignState(authorization, megaSignId, megaSignStateInfo, xApiUser, xOnBehalfOfUser, ifMatch) Updates the state of a MegaSign identified by MegaSignId in the path. @@ -500,13 +1236,13 @@ This endpoint can be used by creator of the MegaSign to transition between the s MegaSignsApi apiInstance = new MegaSignsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements MegaSignStateInfo megaSignStateInfo = new MegaSignStateInfo(); // MegaSignStateInfo | MegaSign state update information object. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. try { - apiInstance.updateMegaSignState(authorization, ifMatch, megaSignId, megaSignStateInfo, xApiUser, xOnBehalfOfUser); + apiInstance.updateMegaSignState(authorization, megaSignId, megaSignStateInfo, xApiUser, xOnBehalfOfUser, ifMatch); } catch (ApiException e) { System.err.println("Exception when calling MegaSignsApi#updateMegaSignState"); e.printStackTrace(); @@ -518,11 +1254,61 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | **megaSignStateInfo** | [**MegaSignStateInfo**](MegaSignStateInfo.md)| MegaSign state update information object. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **updateMegaSignVisibility** +> updateMegaSignVisibility(authorization, megaSignId, visibilityInfo, xApiUser, xOnBehalfOfUser) + +Updates the visibility of a MegaSign. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.MegaSignsApi; + + +MegaSignsApi apiInstance = new MegaSignsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String megaSignId = "megaSignId_example"; // String | The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements +VisibilityInfo visibilityInfo = new VisibilityInfo(); // VisibilityInfo | Information to update visibility of agreement +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +try { + apiInstance.updateMegaSignVisibility(authorization, megaSignId, visibilityInfo, xApiUser, xOnBehalfOfUser); +} catch (ApiException e) { + System.err.println("Exception when calling MegaSignsApi#updateMegaSignVisibility"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **megaSignId** | **String**| The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements | + **visibilityInfo** | [**VisibilityInfo**](VisibilityInfo.md)| Information to update visibility of agreement | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] ### Return type diff --git a/docs/MegasignEvent.md b/docs/MegasignEvent.md index 7cb0cd9..36c0e99 100755 --- a/docs/MegasignEvent.md +++ b/docs/MegasignEvent.md @@ -4,25 +4,40 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**actingUserEmail** | **String** | Email address of the user that created the event | [optional] -**actingUserIpAddress** | **String** | The IP address of the user that created the event | [optional] -**actingUserName** | **String** | The name of the acting user | [optional] -**comment** | **String** | The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant | [optional] **date** | [**Date**](Date.md) | The date of the audit event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**description** | **String** | A description of the audit event | [optional] -**deviceLocation** | [**DeviceLocation**](DeviceLocation.md) | Location of the device that generated the event (This value may be null due to limited privileges) | [optional] -**devicePhoneNumber** | **String** | Phone number from the device used when the participation is completed on a mobile phone | [optional] -**digitalSignatureInfo** | [**DigitalSignatureInfo**](DigitalSignatureInfo.md) | This is present for ESIGNED events when the participation is signed digitally | [optional] -**initiatingUserEmail** | **String** | Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect | [optional] **initiatingUserName** | **String** | Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect | [optional] +**description** | **String** | A description of the audit event | [optional] +**actingUserName** | **String** | The name of the acting user | [optional] +**actingUserIpAddress** | **String** | The IP address of the user that created the event | [optional] **participantEmail** | **String** | Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to | [optional] -**participantId** | **String** | The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to | [optional] -**participantRole** | [**ParticipantRoleEnum**](#ParticipantRoleEnum) | Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). | [optional] -**synchronizationId** | **String** | A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null) | [optional] **type** | [**TypeEnum**](#TypeEnum) | Type of MegaSign event | [optional] +**participantRole** | [**ParticipantRoleEnum**](#ParticipantRoleEnum) | Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). | [optional] **vaultEventId** | **String** | The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null) | [optional] -**vaultProviderName** | **String** | Name of the vault provider for the vault event (if vaulted, otherwise null) | [optional] +**participantId** | **String** | The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to | [optional] **versionId** | **String** | An ID which uniquely identifies the version of the document associated with this audit event | [optional] +**actingUserEmail** | **String** | Email address of the user that created the event | [optional] +**devicePhoneNumber** | **String** | Phone number from the device used when the participation is completed on a mobile phone | [optional] +**initiatingUserEmail** | **String** | Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect | [optional] +**digitalSignatureInfo** | [**DigitalSignatureInfo**](DigitalSignatureInfo.md) | This is present for ESIGNED events when the participation is signed digitally | [optional] +**vaultProviderName** | **String** | Name of the vault provider for the vault event (if vaulted, otherwise null) | [optional] +**comment** | **String** | The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant | [optional] +**id** | **String** | The identifier for the event. | [optional] +**synchronizationId** | **String** | A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null) | [optional] +**deviceLocation** | [**DeviceLocation**](DeviceLocation.md) | Location of the device that generated the event (This value may be null due to limited privileges) | [optional] + + + +## Enum: TypeEnum +Name | Value +---- | ----- +AUTO_CANCELLED_CONVERSION_PROBLEM | "AUTO_CANCELLED_CONVERSION_PROBLEM" +CREATED | "CREATED" +EXPIRED | "EXPIRED" +EMAIL_BOUNCED | "EMAIL_BOUNCED" +RECALLED | "RECALLED" +SHARED | "SHARED" +READY_TO_VAULT | "READY_TO_VAULT" +VAULTED | "VAULTED" @@ -43,17 +58,4 @@ SHARE | "SHARE" SENDER | "SENDER" - -## Enum: TypeEnum -Name | Value ----- | ----- -AUTO_CANCELLED_CONVERSION_PROBLEM | "AUTO_CANCELLED_CONVERSION_PROBLEM" -CREATED | "CREATED" -EXPIRED | "EXPIRED" -EMAIL_BOUNCED | "EMAIL_BOUNCED" -RECALLED | "RECALLED" -SHARED | "SHARED" -VAULTED | "VAULTED" - - diff --git a/docs/MembersInfo.md b/docs/MembersInfo.md index dddb081..27a587f 100755 --- a/docs/MembersInfo.md +++ b/docs/MembersInfo.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**participantSets** | [**List<DetailedParticipantSetInfo>**](DetailedParticipantSetInfo.md) | Information about the participant Sets. | [optional] **ccsInfo** | [**List<CCParticipantInfo>**](CCParticipantInfo.md) | Information of CC participants of the agreement. | [optional] **nextParticipantSets** | [**List<DetailedParticipantSetInfo>**](DetailedParticipantSetInfo.md) | Information of next participant sets. | [optional] -**participantSets** | [**List<DetailedParticipantSetInfo>**](DetailedParticipantSetInfo.md) | Information about the participant Sets. | [optional] **senderInfo** | [**SenderInfo**](SenderInfo.md) | Information of the sender of the agreement. | [optional] **sharesInfo** | [**List<ShareParticipantInfo>**](ShareParticipantInfo.md) | Information of the participants with whom the agreement has been shared. | [optional] diff --git a/docs/MergeFieldInfoDescription.md b/docs/MergeFieldInfoDescription.md new file mode 100644 index 0000000..7812d29 --- /dev/null +++ b/docs/MergeFieldInfoDescription.md @@ -0,0 +1,15 @@ + +# MergeFieldInfoDescription + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fieldName** | **String** | Name of the custom field in this workflow | [optional] +**visible** | **Boolean** | Whether current field should be visible on agreement creation page. If visible attribute for this field is false then this field should not be shown on the agreement creation page using this workflow | [optional] +**defaultValue** | **String** | default value of the field if input for this field is not provided and this field is required | [optional] +**displayName** | **String** | The display text that can be shown for this custom field | [optional] +**editable** | **Boolean** | Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation | [optional] +**required** | **Boolean** | Whether this field is required or optional | [optional] + + + diff --git a/docs/MergefieldInfo.md b/docs/MergefieldInfo.md index 4734589..c3a11c5 100755 --- a/docs/MergefieldInfo.md +++ b/docs/MergefieldInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**defaultValue** | **String** | The default value of the field | [optional] **fieldName** | **String** | The name of the field | [optional] +**defaultValue** | **String** | The default value of the field | [optional] diff --git a/docs/MessageTemplate.md b/docs/MessageTemplate.md new file mode 100644 index 0000000..5b1cb54 --- /dev/null +++ b/docs/MessageTemplate.md @@ -0,0 +1,13 @@ + +# MessageTemplate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Message template name | [optional] +**messageTemplateId** | **String** | Unique identifier of the message template | [optional] +**text** | **String** | Message template text | [optional] +**locale** | **String** | Message template locale | [optional] + + + diff --git a/docs/MessageTemplates.md b/docs/MessageTemplates.md new file mode 100644 index 0000000..334d119 --- /dev/null +++ b/docs/MessageTemplates.md @@ -0,0 +1,11 @@ + +# MessageTemplates + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**messageTemplateList** | [**List<MessageTemplate>**](MessageTemplate.md) | An array of message template items | [optional] +**page** | [**PageInfo**](PageInfo.md) | Pagination information for navigating through the response | [optional] + + + diff --git a/docs/MessageTemplatesApi.md b/docs/MessageTemplatesApi.md new file mode 100644 index 0000000..7efd5f5 --- /dev/null +++ b/docs/MessageTemplatesApi.md @@ -0,0 +1,64 @@ +# MessageTemplatesApi + +All URIs are relative to *https://secure.au1.echosign.com/api/rest/v6* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getMessageTemplates**](MessageTemplatesApi.md#getMessageTemplates) | **GET** /messageTemplates | Retrieves a list of message templates applicable to the current user. + + + +# **getMessageTemplates** +> MessageTemplates getMessageTemplates(authorization, locale, xApiUser, xOnBehalfOfUser, groupId, cursor, pageSize) + +Retrieves a list of message templates applicable to the current user. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.MessageTemplatesApi; + + +MessageTemplatesApi apiInstance = new MessageTemplatesApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String locale = "locale_example"; // String | Message template locale +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String groupId = "groupId_example"; // String | The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. +String cursor = "cursor_example"; // String | Used to navigate through the pages. If not provided, returns the first page. +Integer pageSize = 56; // Integer | Number of intended items in the response page. If not provided, it is decided by the application settings. +try { + MessageTemplates result = apiInstance.getMessageTemplates(authorization, locale, xApiUser, xOnBehalfOfUser, groupId, cursor, pageSize); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling MessageTemplatesApi#getMessageTemplates"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_read')\" oncontextmenu=\"this.href=oauthDoc('user_read')\" target=\"oauthDoc\">user_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **locale** | **String**| Message template locale | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **groupId** | **String**| The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. | [optional] + **cursor** | **String**| Used to navigate through the pages. If not provided, returns the first page. | [optional] + **pageSize** | **Integer**| Number of intended items in the response page. If not provided, it is decided by the application settings. | [optional] + +### Return type + +[**MessageTemplates**](MessageTemplates.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + diff --git a/docs/MyAgreementInfo.md b/docs/MyAgreementInfo.md new file mode 100644 index 0000000..56ef000 --- /dev/null +++ b/docs/MyAgreementInfo.md @@ -0,0 +1,10 @@ + +# MyAgreementInfo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountSharers** | [**List<AccountSharerInfo>**](AccountSharerInfo.md) | A list of account sharer in relation to the api caller and this resource. | [optional] + + + diff --git a/docs/OfflineDeviceInfo.md b/docs/OfflineDeviceInfo.md index 0c78ac7..4bb9b29 100755 --- a/docs/OfflineDeviceInfo.md +++ b/docs/OfflineDeviceInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**applicationDescription** | **String** | Application Description | [optional] **deviceDescription** | **String** | Device Description | [optional] +**applicationDescription** | **String** | Application Description | [optional] **deviceTime** | [**Date**](Date.md) | The device local time. The device time provided should not be before 30 days of current date.Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] diff --git a/docs/ParticipantSecurityOption.md b/docs/ParticipantSecurityOption.md index 2475e11..24229db 100755 --- a/docs/ParticipantSecurityOption.md +++ b/docs/ParticipantSecurityOption.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**authenticationMethod** | [**AuthenticationMethodEnum**](#AuthenticationMethodEnum) | The authentication method for the participants to have access to view and sign the document. When replacing a participant that has PASSWORD or PHONE authentication specified, you must supply a password or phone number for the new participant, and you cannot change the authentication method | [optional] **password** | **String** | The password required for the participant to view and sign the document. Note that AdobeSign will never show this password to anyone, so you will need to separately communicate it to any relevant parties. The password will not be returned in GET call. When replacing a participant that has PASSWORD authentication specified, you must supply a password for the new participant. | [optional] +**authenticationMethod** | [**AuthenticationMethodEnum**](#AuthenticationMethodEnum) | The authentication method for the participants to have access to view and sign the document. When replacing a participant that has PASSWORD or PHONE authentication specified, you must supply a password or phone number for the new participant, and you cannot change the authentication method. For unknown participants, only email based authentication is allowed. Hence, only ‘NONE’ authenticaiton method is permitted | [optional] **phoneInfo** | [**PhoneInfo**](PhoneInfo.md) | The phoneInfo required for the participant to view and sign the document | [optional] diff --git a/docs/ParticipantSetInfo.md b/docs/ParticipantSetInfo.md index 85d9d6f..5fad6b5 100755 --- a/docs/ParticipantSetInfo.md +++ b/docs/ParticipantSetInfo.md @@ -4,13 +4,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**role** | [**RoleEnum**](#RoleEnum) | Role assumed by all participants in the set (signer, approver etc.) | [optional] +**visiblePages** | **List<String>** | When you enable limited document visibility (documentVisibilityEnabled), you can specify which file (fileInfo) should be made visible to which specific participant set.<br>Specify one or more label values of a fileInfos element.<br>Each signer participant sets must contain at least one required signature field in at least one visible file included in this API call; if not a page with a signature field is automatically appended for any missing participant sets. If there is a possibility that one or more participant sets do not have a required signature field in the files included in the API call, all signer participant sets should include a special index value of '0' to make this automatically appended signature page visible to the signer. Not doing so may result in an error. For all other roles, you may omit this value to exclude this page. | [optional] +**name** | **String** | Name of the participant set (it can be empty, but if present it must be unique within a single agreement). Maximum no of characters in participant set name is restricted to 255 | [optional] +**id** | **String** | The unique identifier of the participant. This will be ignored as part of POST or PUT calls. The Id might be null in draft state | [optional] **label** | **String** | The unique label of a participant set.<br>For custom workflows, label specified in the participation set should map it to the participation step in the custom workflow. | [optional] +**privateMessage** | **String** | Participant set's private message - all participants in the set will receive the same message | [optional] **memberInfos** | [**List<ParticipantSetMemberInfo>**](ParticipantSetMemberInfo.md) | Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set | [optional] -**name** | **String** | Name of the participant set (it can be empty, but needs not to be unique in a single agreement). Maximum no of characters in participant set name is restricted to 255 | [optional] **order** | **Integer** | Index indicating position at which signing group needs to sign. Signing group to sign at first place is assigned a 1 index. Different signingOrder specified in input should form a valid consecutive increasing sequence of integers. Otherwise signingOrder will be considered invalid. No signingOrder should be specified for SHARE role | [optional] -**privateMessage** | **String** | Participant set's private message - all participants in the set will receive the same message | [optional] -**role** | [**RoleEnum**](#RoleEnum) | Role assumed by all participants in the set (signer, approver etc.) | [optional] -**visiblePages** | **List<String>** | When you enable limited document visibility (documentVisibilityEnabled), you can specify which file (fileInfo) should be made visible to which specific participant set.<br>Specify one or more label values of a fileInfos element.<br>Each signer participant sets must contain at least one required signature field in at least one visible file included in this API call; if not a page with a signature field is automatically appended for any missing participant sets. If there is a possibility that one or more participant sets do not have a required signature field in the files included in the API call, all signer participant sets should include a special index value of '0' to make this automatically appended signature page visible to the signer. Not doing so may result in an error. For all other roles, you may omit this value to exclude this page. | [optional] diff --git a/docs/ParticipantSetMemberInfo.md b/docs/ParticipantSetMemberInfo.md index 9767e83..c63d063 100755 --- a/docs/ParticipantSetMemberInfo.md +++ b/docs/ParticipantSetMemberInfo.md @@ -4,7 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**email** | **String** | Email of the participant | [optional] +**id** | **String** | The unique identifier of the participant. This will be ignored as part of POST or PUT calls. The Id might be null in draft state | [optional] +**email** | **String** | Email of the participant. It should be blank for the unknown participants. | [optional] **securityOption** | [**ParticipantSecurityOption**](ParticipantSecurityOption.md) | Security options that apply to the participant | [optional] diff --git a/docs/PasswordFieldInfoDescription.md b/docs/PasswordFieldInfoDescription.md new file mode 100644 index 0000000..03c5ffe --- /dev/null +++ b/docs/PasswordFieldInfoDescription.md @@ -0,0 +1,15 @@ + +# PasswordFieldInfoDescription + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**visible** | **Boolean** | Whether password info field is visible on agreement creation page | [optional] +**defaultValue** | **String** | Default value of the password info field | [optional] +**editable** | **Boolean** | Default value of the password info field | [optional] +**name** | **String** | Name of password field | [optional] +**label** | **String** | Label of password field | [optional] +**required** | **Boolean** | Whether this field is required or optional | [optional] + + + diff --git a/docs/PersonalizedSigningViewConfiguration.md b/docs/PersonalizedSigningViewConfiguration.md new file mode 100644 index 0000000..15f9694 --- /dev/null +++ b/docs/PersonalizedSigningViewConfiguration.md @@ -0,0 +1,13 @@ + +# PersonalizedSigningViewConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **String** | Comment describing how the API caller established the signer's identity - will appear in the audit trail | [optional] +**expiration** | [**Date**](Date.md) | Expiration date for the personalization of this web form. After this date, the identity of the signer will not be assumed by Adobe Sign. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2022-02-25T18:46:19Z represents UTC time | [optional] +**email** | **String** | The email address of the person who will be receiving this web form | [optional] +**reusable** | **Boolean** | Should the intended signer be allowed to sign this web form more than once | [optional] + + + diff --git a/docs/PhoneInfo.md b/docs/PhoneInfo.md index 33ba91b..5387a7d 100755 --- a/docs/PhoneInfo.md +++ b/docs/PhoneInfo.md @@ -4,8 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**countryCode** | **String** | The numeric country calling code (ISD code) required for the participant to view and sign the document if authentication type is PHONE | [optional] +**countryIsoCode** | **String** | The country ISO Alpha-2 code required for the participant to view and sign the document if authentication method is PHONE | [optional] **phone** | **String** | The phone number required for the participant to view and sign the document if authentication method is PHONE. When replacing a participant that has PHONE authentication specified, you must supply a phone number for the new participant. | [optional] +**countryCode** | **String** | The numeric country calling code (ISD code) required for the participant to view and sign the document if authentication type is PHONE | [optional] diff --git a/docs/PostSignOption.md b/docs/PostSignOption.md index 368b311..5889df4 100755 --- a/docs/PostSignOption.md +++ b/docs/PostSignOption.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**redirectDelay** | **Integer** | The delay (in seconds) before the user is taken to the success page. If this value is greater than 0, the user will first see the standard Adobe Sign success message, and then after a delay will be redirected to your success page | [optional] **redirectUrl** | **String** | A publicly accessible url to which the user will be sent after successfully completing the signing process | [optional] +**redirectDelay** | **Integer** | The delay (in seconds) before the user is taken to the success page. If this value is greater than 0, the user will first see the standard Adobe Sign success message, and then after a delay will be redirected to your success page | [optional] diff --git a/docs/ProviderParticipantSetInfo.md b/docs/ProviderParticipantSetInfo.md new file mode 100644 index 0000000..3d31f04 --- /dev/null +++ b/docs/ProviderParticipantSetInfo.md @@ -0,0 +1,11 @@ + +# ProviderParticipantSetInfo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**actionRequired** | **Boolean** | It indicates whether it is mandatory or not for the provider participant to provide the details for the unknown participant | [optional] +**actionDescription** | **String** | The description for the provider participant who is responsible to provide details like name, email for the unknown participant. | [optional] + + + diff --git a/docs/RecipientsListInfoDescription.md b/docs/RecipientsListInfoDescription.md new file mode 100644 index 0000000..44d3195 --- /dev/null +++ b/docs/RecipientsListInfoDescription.md @@ -0,0 +1,29 @@ + +# RecipientsListInfoDescription + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**allowSender** | **Boolean** | whether sender is allowed as a recipient | [optional] +**minListCount** | **Integer** | minimum number of entries allowed in the current recipient list | [optional] +**visible** | **Boolean** | Whether current field is visible. If visible attribute for this field is false then this field should not be shown in the agreement creation UI using this workflow to user | [optional] +**authenticationMethod** | [**AuthenticationMethodEnum**](#AuthenticationMethodEnum) | authentication method for the current recipient list to have access to view and sign the document | [optional] +**allowfax** | **Boolean** | whether fax is allowed or not | [optional] +**defaultValue** | **String** | A default email or fax number | [optional] +**editable** | **Boolean** | Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation | [optional] +**name** | **String** | Name of the current RecipientInfo list | [optional] +**maxListCount** | **Integer** | maximum number of entries allowed in the current recipient list | [optional] +**label** | **String** | A display text for the workflow user that can be used for the current recipients list | [optional] + + + +## Enum: AuthenticationMethodEnum +Name | Value +---- | ----- +NONE | "NONE" +KBA | "KBA" +PASSWORD | "PASSWORD" +WEB_IDENTITY | "WEB_IDENTITY" + + + diff --git a/docs/ReminderInfo.md b/docs/ReminderInfo.md index 3e4fae2..3feee28 100755 --- a/docs/ReminderInfo.md +++ b/docs/ReminderInfo.md @@ -4,17 +4,26 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**firstReminderDelay** | **Integer** | Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT | [optional] -**frequency** | [**FrequencyEnum**](#FrequencyEnum) | The frequency at which reminder will be sent until the agreement is completed.<br>If frequency is not provided, the reminder will be sent once (if the agreement is available at the specified time) with the delay based on the firstReminderDelay field and will never repeat again. If the agreement is not available at that time, reminder will not be sent. Cannot be updated in a PUT | [optional] +**note** | **String** | An optional message sent to the recipients, describing why their participation is required | [optional] **lastSentDate** | [**Date**](Date.md) | The date when the reminder was last sent. Only provided in GET. Cannot be provided in POST request. If provided in POST, it will be ignored. Cannot be updated in a PUT. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] **nextSentDate** | [**Date**](Date.md) | The date when the reminder is scheduled to be sent next. When provided in POST request, frequency needs to be ONCE (or not specified), startReminderCounterFrom needs to be REMINDER_CREATION (or not specified) and firstReminderDelay needs to be 0 (or not specified). Cannot be updated in a PUT. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**note** | **String** | An optional message sent to the recipients, describing why their participation is required | [optional] -**recipientParticipantIds** | **List<String>** | A list of one or more participant IDs that the reminder should be sent to. These must be recipients of the agreement and not sharees or cc's. | [optional] **reminderId** | **String** | An identifier of the reminder resource created on the server. If provided in POST or PUT, it will be ignored | [optional] +**firstReminderDelay** | **Integer** | Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT | [optional] +**recipientParticipantIds** | **List<String>** | A list of one or more participant IDs that the reminder should be sent to. These must be sharees or cc's on the MegaSign. In order to remind any other participant who has not signed, use the allUnsigned boolean parameter. | [optional] **startReminderCounterFrom** | [**StartReminderCounterFromEnum**](#StartReminderCounterFromEnum) | Reminder can be sent based on when the agreement becomes available or when the reminder is created<br>AGREEMENT_AVAILABILITY: If the agreement is not available to the participant at the time of reminder creation, the reminder will be sent for the first time, only when the agreement becomes available to the participant taking the firstReminderDelay into account. Subsequent reminders will be sent based on the frequency specified. If the agreement is already available to the participant at the time of reminder creation, the first reminder will be sent after the delay specified by firstReminderDelay from the reminder creation time.<br>REMINDER_CREATION: The first reminder will be sent after the delay specified by firstReminderDelay from the reminder creation time only if the agreement is available at that time. Subsequent reminders will be triggered based on the frequency specified and will be sent only if the agreement is available at that time. For agreements in authoring state, creating reminder with startReminderCounterFrom as REMINDER_CREATION is not allowed.<br>Note : If firstReminderDelay, frequency and startReminderCounterFrom fields are not specified in POST, reminder will be sent right now if the agreement is available. If agreement is not available, an error will be thrown. Cannot be updated in a PUT | [optional] +**allUnsigned** | **Boolean** | If true, set a reminder on all participants (non-CCs and non-sharees) that still need to sign the MegaSign agreement | [optional] +**frequency** | [**FrequencyEnum**](#FrequencyEnum) | The frequency at which reminder will be sent until the agreement is completed.<br>If frequency is not provided, the reminder will be sent once (if the agreement is available at the specified time) with the delay based on the firstReminderDelay field and will never repeat again. If the agreement is not available at that time, reminder will not be sent. Cannot be updated in a PUT | [optional] **status** | [**StatusEnum**](#StatusEnum) | Current status of the reminder. The only valid update in a PUT is from ACTIVE to CANCELED. Must be provided as ACTIVE in a POST. | [optional] + +## Enum: StartReminderCounterFromEnum +Name | Value +---- | ----- +AGREEMENT_AVAILABILITY | "AGREEMENT_AVAILABILITY" +REMINDER_CREATION | "REMINDER_CREATION" + + ## Enum: FrequencyEnum Name | Value @@ -28,14 +37,6 @@ WEEKLY_UNTIL_SIGNED | "WEEKLY_UNTIL_SIGNED" ONCE | "ONCE" - -## Enum: StartReminderCounterFromEnum -Name | Value ----- | ----- -AGREEMENT_AVAILABILITY | "AGREEMENT_AVAILABILITY" -REMINDER_CREATION | "REMINDER_CREATION" - - ## Enum: StatusEnum Name | Value diff --git a/docs/SendOptions.md b/docs/SendOptions.md index 2089dae..6222965 100755 --- a/docs/SendOptions.md +++ b/docs/SendOptions.md @@ -4,13 +4,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**completionEmails** | [**CompletionEmailsEnum**](#CompletionEmailsEnum) | Control notification mails for agreement completion events - COMPLETED, CANCELLED, EXPIRED and REJECTED | [optional] -**inFlightEmails** | [**InFlightEmailsEnum**](#InFlightEmailsEnum) | Control notification mails for agreement-in-process events - DELEGATED, REPLACED | [optional] **initEmails** | [**InitEmailsEnum**](#InitEmailsEnum) | Control notification mails for Agreement initiation events - ACTION_REQUESTED and CREATED | [optional] +**inFlightEmails** | [**InFlightEmailsEnum**](#InFlightEmailsEnum) | Control notification mails for agreement-in-process events - DELEGATED, REPLACED | [optional] +**completionEmails** | [**CompletionEmailsEnum**](#CompletionEmailsEnum) | Control notification mails for agreement completion events - COMPLETED, CANCELLED, EXPIRED and REJECTED | [optional] - -## Enum: CompletionEmailsEnum + +## Enum: InitEmailsEnum Name | Value ---- | ----- ALL | "ALL" @@ -25,8 +25,8 @@ ALL | "ALL" NONE | "NONE" - -## Enum: InitEmailsEnum + +## Enum: CompletionEmailsEnum Name | Value ---- | ----- ALL | "ALL" diff --git a/docs/SendViewConfiguration.md b/docs/SendViewConfiguration.md index 9810c0c..f241ec1 100755 --- a/docs/SendViewConfiguration.md +++ b/docs/SendViewConfiguration.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**agrName** | **String** | The agreement name for the library document on the compose page | [optional] **fileUploadOptions** | [**FileUploadOptions**](FileUploadOptions.md) | Controls various file upload options available on the compose page | [optional] **isPreviewSelected** | **Boolean** | Should the compose page be provided with authoring mode selected? | [optional] +**agrName** | **String** | The agreement name for the library document on the compose page | [optional] diff --git a/docs/SenderInfo.md b/docs/SenderInfo.md index a044ba0..404b497 100755 --- a/docs/SenderInfo.md +++ b/docs/SenderInfo.md @@ -4,11 +4,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**company** | **String** | Company of the creator, if available. | [optional] -**email** | **String** | Email of the creator of the widget. | [optional] +**participantId** | **String** | The unique identifier of the creator of the web form. | [optional] +**createdDate** | [**Date**](Date.md) | The date when the sender was added. This will be returned as part of GET call but is ignored if passed as part of PUT call. | [optional] +**hidden** | **Boolean** | True if the web form is hidden for the user that is calling the API. Only returned if self is true. | [optional] **name** | **String** | Name of the creator, if available. | [optional] -**participantId** | **String** | The unique identifier of the creator of the widget. | [optional] -**self** | **Boolean** | True if the creator of the widget is the same user that is calling the API. | [optional] +**self** | **Boolean** | True if the creator of the web form is the same user that is calling the API. | [optional] +**company** | **String** | Company of the creator, if available. | [optional] +**userId** | **String** | The user ID of the sender. This will be returned as part of GET call but is ignored if passed as part of PUT call. | [optional] +**email** | **String** | Email of the creator of the web form. | [optional] diff --git a/docs/SettingsInfo.md b/docs/SettingsInfo.md new file mode 100644 index 0000000..883f693 --- /dev/null +++ b/docs/SettingsInfo.md @@ -0,0 +1,11 @@ + +# SettingsInfo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**libaryDocumentCreationVisible** | [**BooleanSettingInfo**](BooleanSettingInfo.md) | Can user create library documents? | [optional] +**userCanSend** | [**BooleanSettingInfo**](BooleanSettingInfo.md) | Can user send agreements for signature to others? | [optional] + + + diff --git a/docs/ShareCreationInfo.md b/docs/ShareCreationInfo.md index 83c6714..57fc959 100755 --- a/docs/ShareCreationInfo.md +++ b/docs/ShareCreationInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**email** | **String** | The email address of the member with whom the agreement will be shared | [optional] **message** | **String** | Optional message to the sharee | [optional] +**email** | **String** | The email address of the member with whom the agreement will be shared | [optional] diff --git a/docs/ShareCreationResponse.md b/docs/ShareCreationResponse.md index f4014a0..73d5d5a 100755 --- a/docs/ShareCreationResponse.md +++ b/docs/ShareCreationResponse.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**email** | **String** | The email address that was requested | [optional] **participantId** | **String** | The unique identifier of the participant | [optional] +**email** | **String** | The email address that was requested | [optional] diff --git a/docs/ShareParticipantInfo.md b/docs/ShareParticipantInfo.md index 3f5c605..089b421 100755 --- a/docs/ShareParticipantInfo.md +++ b/docs/ShareParticipantInfo.md @@ -4,11 +4,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**company** | **String** | Company of the sharee participant of the widget, if available. | [optional] -**email** | **String** | Email of the sharee participant of the widget. | [optional] -**name** | **String** | Name of the sharee participant of the widget, if available. | [optional] -**participantId** | **String** | The unique identifier of the sharee participant of the widget. | [optional] -**sharerParticipantId** | **String** | The unique identifier of the participant who shared the widget. | [optional] +**participantId** | **String** | The unique identifier of the sharee participant of the web form. | [optional] +**hidden** | **Boolean** | True if the web form is hidden for the user that is calling the API. Only returned if self is true. | [optional] +**name** | **String** | Name of the sharee participant of the web form, if available. | [optional] +**self** | **Boolean** | True if the Share participant of the web form is the same user that is calling the API. | [optional] +**sharerParticipantId** | **String** | The unique identifier of the participant who shared the web form. | [optional] +**company** | **String** | Company of the sharee participant of the web form, if available. | [optional] +**email** | **String** | Email of the sharee participant of the web form. | [optional] diff --git a/docs/SignerIdentityReportInfo.md b/docs/SignerIdentityReportInfo.md new file mode 100644 index 0000000..fcede8f --- /dev/null +++ b/docs/SignerIdentityReportInfo.md @@ -0,0 +1,10 @@ + +# SignerIdentityReportInfo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**securityOption** | [**SecurityOption**](SecurityOption.md) | Optional secondary security parameters for the signer identity report. | [optional] + + + diff --git a/docs/SigningUrl.md b/docs/SigningUrl.md index c9100ce..1524dd1 100755 --- a/docs/SigningUrl.md +++ b/docs/SigningUrl.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**email** | **String** | The email address of the signer associated with this signing url | [optional] **esignUrl** | **String** | The email address of the signer associated with this signing url | [optional] +**email** | **String** | The email address of the signer associated with this signing url | [optional] diff --git a/docs/SigningUrlSetInfo.md b/docs/SigningUrlSetInfo.md index 03bb95b..1677d8e 100755 --- a/docs/SigningUrlSetInfo.md +++ b/docs/SigningUrlSetInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**signingUrlSetName** | **String** | The name of the current signer set. Returned only, if the API caller is the sender of agreement | [optional] **signingUrls** | [**List<SigningUrl>**](SigningUrl.md) | An array of urls for current signer set. | [optional] +**signingUrlSetName** | **String** | The name of the current signer set. Returned only, if the API caller is the sender of agreement | [optional] diff --git a/docs/SupportingDocument.md b/docs/SupportingDocument.md index 882acd6..edc1c91 100755 --- a/docs/SupportingDocument.md +++ b/docs/SupportingDocument.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **displayLabel** | **String** | Display name of the document | [optional] +**participantId** | **String** | The unique identifier of the participant that uploaded the supporting document | [optional] +**numPages** | **Integer** | Number of pages in the document | [optional] **fieldName** | **String** | The name of the supporting document field | [optional] **id** | **String** | Id representing the document | [optional] **mimeType** | **String** | Mime-type of the document | [optional] -**numPages** | **Integer** | Number of pages in the document | [optional] -**participantId** | **String** | The unique identifier of the participant that uploaded the supporting document | [optional] diff --git a/docs/TransientDocumentResponse.md b/docs/TransientDocumentResponse.md index f45705a..1802169 100755 --- a/docs/TransientDocumentResponse.md +++ b/docs/TransientDocumentResponse.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transientDocumentId** | **String** | The unique identifier of the uploaded document that can be used in an agreement or a megaSign or widget creation call | [optional] +**transientDocumentId** | **String** | The unique identifier of the uploaded document that can be used in an agreement or a megaSign or web form creation call | [optional] diff --git a/docs/TransientDocumentsApi.md b/docs/TransientDocumentsApi.md index bb1ec6b..0f995bf 100755 --- a/docs/TransientDocumentsApi.md +++ b/docs/TransientDocumentsApi.md @@ -1,6 +1,6 @@ # TransientDocumentsApi -All URIs are relative to *http://localhost/api/rest/v6* +All URIs are relative to *https://secure.au1.echosign.com/api/rest/v6* Method | HTTP request | Description ------------- | ------------- | ------------- diff --git a/docs/URLFileInfo.md b/docs/URLFileInfo.md index fcf4f05..8b53f0d 100755 --- a/docs/URLFileInfo.md +++ b/docs/URLFileInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mimeType** | **String** | The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed | [optional] **name** | **String** | The original system file name of the document being sent | [optional] +**mimeType** | **String** | The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed | [optional] **url** | **String** | A publicly accessible URL for retrieving the raw file content | [optional] diff --git a/docs/UserAgreement.md b/docs/UserAgreement.md index 392f27e..9789bd7 100755 --- a/docs/UserAgreement.md +++ b/docs/UserAgreement.md @@ -4,16 +4,28 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**hidden** | **Boolean** | True if agreement is hidden for the user | [optional] **displayDate** | [**Date**](Date.md) | The display date for the agreement. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**displayParticipantSetInfos** | [**List<DisplayParticipantSetInfo>**](DisplayParticipantSetInfo.md) | The most relevant current user set for the agreement. It is typically the next signer if the agreement is from the current user, or the sender if received from another user | [optional] -**id** | **String** | The unique identifier of the agreement.If provided in POST, it will simply be ignored | [optional] +**groupId** | **String** | Unique identifier of the group | [optional] **esign** | **Boolean** | True if this is an e-sign document | [optional] -**hidden** | **Boolean** | True if agreement is hidden for the user | [optional] -**latestVersionId** | **String** | A version ID which uniquely identifies the current version of the agreement | [optional] **name** | **String** | Name of the Agreement | [optional] +**displayParticipantSetInfos** | [**List<DisplayParticipantSetInfo>**](DisplayParticipantSetInfo.md) | The most relevant current user set for the agreement. It is typically the next signer if the agreement is from the current user, or the sender if received from another user | [optional] +**latestVersionId** | **String** | A version ID which uniquely identifies the current version of the agreement | [optional] +**id** | **String** | The unique identifier of the agreement.If provided in POST, it will simply be ignored | [optional] +**type** | [**TypeEnum**](#TypeEnum) | The kind of agreement | [optional] +**parentId** | **String** | The parent id of a megaSign child *OR* the originating id of a widget agreement instance | [optional] **status** | [**StatusEnum**](#StatusEnum) | This is a server generated attribute which provides the detailed status of an agreement with respect to the apiCaller | [optional] + +## Enum: TypeEnum +Name | Value +---- | ----- +AGREEMENT | "AGREEMENT" +MEGASIGN_CHILD | "MEGASIGN_CHILD" +WIDGET_INSTANCE | "WIDGET_INSTANCE" + + ## Enum: StatusEnum Name | Value diff --git a/docs/UserAgreements.md b/docs/UserAgreements.md index b8e1ac6..c386886 100755 --- a/docs/UserAgreements.md +++ b/docs/UserAgreements.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**page** | [**PageInfo**](PageInfo.md) | Pagination information for navigating through the response | [optional] **userAgreementList** | [**List<UserAgreement>**](UserAgreement.md) | An array of UserAgreement items | [optional] +**page** | [**PageInfo**](PageInfo.md) | Pagination information for navigating through the response | [optional] diff --git a/docs/UserGroupInfo.md b/docs/UserGroupInfo.md index aa9cad8..33ef324 100755 --- a/docs/UserGroupInfo.md +++ b/docs/UserGroupInfo.md @@ -4,9 +4,21 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Unique identifier of the group | [optional] +**settings** | [**SettingsInfo**](SettingsInfo.md) | List of some group membership settings. | [optional] +**createdDate** | [**Date**](Date.md) | Date group was created | [optional] **isGroupAdmin** | **Boolean** | True if user is group admin. | [optional] +**isPrimaryGroup** | **Boolean** | True if the group is the user's primary group. | [optional] **name** | **String** | Name of the group. This will be ignored as part of PUT call. | [optional] +**id** | **String** | Unique identifier of the group | [optional] +**status** | [**StatusEnum**](#StatusEnum) | Status of the group membership | [optional] + + + +## Enum: StatusEnum +Name | Value +---- | ----- +ACTIVE | "ACTIVE" +DELETED | "DELETED" diff --git a/docs/UserInfo.md b/docs/UserInfo.md index 5c179b1..c6c80f6 100755 --- a/docs/UserInfo.md +++ b/docs/UserInfo.md @@ -4,12 +4,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**company** | **String** | The name of company of the user | [optional] -**email** | **String** | The email address of the user | [optional] +**accountId** | **String** | The account id of the user | [optional] **firstName** | **String** | The first name of the user | [optional] -**id** | **String** | A unique identifier of the user resource for REST APIs as issued by Sign. | [optional] -**isAccountAdmin** | **Boolean** | True if user is account admin | [optional] **lastName** | **String** | The last name of the user | [optional] +**isAccountAdmin** | **Boolean** | True if user is account admin | [optional] +**company** | **String** | The name of company of the user | [optional] +**id** | **String** | A unique identifier of the user resource for REST APIs as issued by Sign. | [optional] +**email** | **String** | The email address of the user | [optional] diff --git a/docs/UserStatusUpdateResponse.md b/docs/UserStatusUpdateResponse.md index 87efeae..d274aab 100755 --- a/docs/UserStatusUpdateResponse.md +++ b/docs/UserStatusUpdateResponse.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | [**CodeEnum**](#CodeEnum) | The result of the attempt to activate or deactivate the user | [optional] -**message** | **String** | String result message if there was no error | [optional] **state** | [**StateEnum**](#StateEnum) | A status value showing the result of this operation | [optional] +**message** | **String** | String result message if there was no error | [optional] diff --git a/docs/UserView.md b/docs/UserView.md index 4b3c8bf..9cc7f98 100755 --- a/docs/UserView.md +++ b/docs/UserView.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **embeddedCode** | **String** | Embedded code of url of resource | [optional] -**expiration** | [**Date**](Date.md) | Expiration of user url | [optional] **name** | [**NameEnum**](#NameEnum) | Name of the requested user view | [optional] +**expiration** | [**Date**](Date.md) | Expiration of user url | [optional] **url** | **String** | Url of resource location | [optional] diff --git a/docs/UserWebhook.md b/docs/UserWebhook.md index ffdd680..713cdd0 100755 --- a/docs/UserWebhook.md +++ b/docs/UserWebhook.md @@ -4,45 +4,17 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**applicationDisplayName** | **String** | The display name of the application through which webhook is created | [optional] -**applicationName** | **String** | The name of the application through which webhook is created | [optional] +**resourceId** | **String** | Id of the resource type for which you want to create webhook. Provide agreementId if webhook needs to be created for an agreement. Similarly, widgetId if webhook needs to be created for a web form, megaSignId if webhook needs to be created for a megaSign and libraryDocumentId if webhook needs to be created for a library document. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request | [optional] +**webhookUrlInfo** | [**WebhookUrlInfo**](WebhookUrlInfo.md) | Info of webhook url | [optional] +**webhookSubscriptionEvents** | [**List<WebhookSubscriptionEventsEnum>**](#List<WebhookSubscriptionEventsEnum>) | Determines events for which the webhook is triggered. The possible values are <br> AGREEMENT_CREATED : When an agreement is created <br>, AGREEMENT_ACTION_DELEGATED : When an agreement is delegated <br>, AGREEMENT_RECALLED : When an agreement is recalled <br>, AGREEMENT_REJECTED : When an agreement is rejected <br>, AGREEMENT_EXPIRED : When an agreement expires <br>, AGREEMENT_ACTION_COMPLETED : When an agreement action is completed <br>, AGREEMENT_WORKFLOW_COMPLETED : When an agreement workflow is completed <br>, AGREEMENT_EMAIL_VIEWED : When an agreement's email is viewed <br>, AGREEMENT_MODIFIED : When an agreement is modified <br>, AGREEMENT_SHARED : When an agreement is shared <br>, AGREEMENT_READY_TO_VAULT : When an agreement is ready to vault <br>, AGREEMENT_VAULTED : When an agreement is vaulted <br>, AGREEMENT_ACTION_REQUESTED : When an agreement action is requested <br>, AGREEMENT_ACTION_REPLACED_SIGNER : When signer is replaced for an agreement <br>, AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When an agreement is auto-cancelled due to conversion problem <br>, AGREEMENT_DOCUMENTS_DELETED : When an agreement documents are deleted <br>, AGREEMENT_EMAIL_BOUNCED : When an agreement email gets bounced <br>, AGREEMENT_KBA_AUTHENTICATED : When an agreement KBA is authenticated <br>, AGREEMENT_OFFLINE_SYNC : When an agreement is synced offline <br>, AGREEMENT_USER_ACK_AGREEMENT_MODIFIED : User Acknowledgement when an agreement is modified <br>, AGREEMENT_UPLOADED_BY_SENDER : When an agreement is uploaded by sender <br>, AGREEMENT_WEB_IDENTITY_AUTHENTICATED : When an agreement web identity is authenticated <br>, AGREEMENT_ALL : All the supported agreement events for Webhooks <br>, MEGASIGN_CREATED : When a megaSign is created <br>, MEGASIGN_RECALLED : When a megaSign is recalled <br>, MEGASIGN_SHARED : When a megaSign is shared <br>, MEGASIGN_ALL : All the supported megaSign events for Webhooks <br>, WIDGET_CREATED : When a web form is created <br>, WIDGET_MODIFIED : When a web form is modified <br>, WIDGET_SHARED : When a web form is shared <br>, WIDGET_ENABLED : When a web form is enabled <br>, WIDGET_DISABLED : When a web form is disabled <br>, WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM : When a web form is auto-cancelled due to conversion problem <br>, WIDGET_ALL : All the supported web form events for Webhooks <br>, LIBRARY_DOCUMENT_CREATED : When a library document is created <br>, LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When a library document is auto-cancelled due to conversion problem <br>, LIBRARY_DOCUMENT_MODIFIED : When a library document is modified <br>, LIBRARY_DOCUMENT_ALL : All the supported library document events for Webhooks | [optional] +**scope** | [**ScopeEnum**](#ScopeEnum) | Scope of webhook. Can't be modified in PUT request. The possible values are ACCOUNT, GROUP, USER or RESOURCE | [optional] +**name** | **String** | The name of the webhook | [optional] **id** | **String** | The unique identifier of the webhook. Will only be returned in GET request. Can't be modified in PUT request | [optional] **lastModified** | [**Date**](Date.md) | Timestamp when the webhook was last updated. Will only be returned in GET request. Can't be modified in PUT request | [optional] -**name** | **String** | The name of the webhook | [optional] -**resourceId** | **String** | Id of the resource type for which you want to create webhook. Provide agreementId if webhook needs to be created for an agreement. Similarly, widgetId if webhook needs to be created for a widget, megaSignId if webhook needs to be created for a megaSign and libraryDocumentId if webhook needs to be created for a library document. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request | [optional] +**applicationDisplayName** | **String** | The display name of the application through which webhook is created | [optional] +**applicationName** | **String** | The name of the application through which webhook is created | [optional] **resourceType** | [**ResourceTypeEnum**](#ResourceTypeEnum) | The resource for which you want to create webhook. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request. The possible values are AGREEMENT, WIDGET, MEGASIGN AND LIBRARY_DOCUMENT | [optional] -**scope** | [**ScopeEnum**](#ScopeEnum) | Scope of webhook. Can't be modified in PUT request. The possible values are ACCOUNT, GROUP, USER or RESOURCE | [optional] **status** | [**StatusEnum**](#StatusEnum) | Status of the webhook. Determines whether the webhook will be actually triggered. Default: ACTIVE, if ACTIVE, this webhook will receive event requests. If INACTIVE, this webhook will not receive event requests. Can't provide status in POST/PUT requests. | [optional] -**webhookSubscriptionEvents** | [**List<WebhookSubscriptionEventsEnum>**](#List<WebhookSubscriptionEventsEnum>) | Determines events for which the webhook is triggered. The possible values are <br> AGREEMENT_CREATED : When an agreement is created <br>, AGREEMENT_ACTION_DELEGATED : When an agreement is delegated <br>, AGREEMENT_RECALLED : When an agreement is recalled <br>, AGREEMENT_REJECTED : When an agreement is rejected <br>, AGREEMENT_EXPIRED : When an agreement expires <br>, AGREEMENT_ACTION_COMPLETED : When an agreement action is completed <br>, AGREEMENT_WORKFLOW_COMPLETED : When an agreement workflow is completed <br>, AGREEMENT_EMAIL_VIEWED : When an agreement's email is viewed <br>, AGREEMENT_MODIFIED : When an agreement is modified <br>, AGREEMENT_SHARED : When an agreement is shared <br>, AGREEMENT_VAULTED : When an agreement is vaulted <br>, AGREEMENT_ACTION_REQUESTED : When an agreement action is requested <br>, AGREEMENT_ACTION_REPLACED_SIGNER : When signer is replaced for an agreement <br>, AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When an agreement is auto-cancelled due to conversion problem <br>, AGREEMENT_DOCUMENTS_DELETED : When an agreement documents are deleted <br>, AGREEMENT_EMAIL_BOUNCED : When an agreement email gets bounced <br>, AGREEMENT_KBA_AUTHENTICATED : When an agreement KBA is authenticated <br>, AGREEMENT_OFFLINE_SYNC : When an agreement is synced offline <br>, AGREEMENT_USER_ACK_AGREEMENT_MODIFIED : User Acknowledgement when an agreement is modified <br>, AGREEMENT_UPLOADED_BY_SENDER : When an agreement is uploaded by sender <br>, AGREEMENT_WEB_IDENTITY_AUTHENTICATED : When an agreement web identity is authenticated <br>, AGREEMENT_ALL : All the supported agreement events for Webhooks <br>, MEGASIGN_CREATED : When a megaSign is created <br>, MEGASIGN_RECALLED : When a megaSign is recalled <br>, MEGASIGN_SHARED : When a megaSign is shared <br>, MEGASIGN_ALL : All the supported megaSign events for Webhooks <br>, WIDGET_CREATED : When a widget is created <br>, WIDGET_MODIFIED : When a widget is modified <br>, WIDGET_SHARED : When a widget is shared <br>, WIDGET_ENABLED : When a widget is enabled <br>, WIDGET_DISABLED : When a widget is disabled <br>, WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM : When a widget is auto-cancelled due to conversion problem <br>, WIDGET_ALL : All the supported widget events for Webhooks <br>, LIBRARY_DOCUMENT_CREATED : When a library document is created <br>, LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When a library document is auto-cancelled due to conversion problem <br>, LIBRARY_DOCUMENT_MODIFIED : When a library document is modified <br>, LIBRARY_DOCUMENT_ALL : All the supported library document events for Webhooks | [optional] -**webhookUrlInfo** | [**WebhookUrlInfo**](WebhookUrlInfo.md) | Info of webhook url | [optional] - - - -## Enum: ResourceTypeEnum -Name | Value ----- | ----- -AGREEMENT | "AGREEMENT" -WIDGET | "WIDGET" -MEGASIGN | "MEGASIGN" -LIBRARY_DOCUMENT | "LIBRARY_DOCUMENT" - - - -## Enum: ScopeEnum -Name | Value ----- | ----- -ACCOUNT | "ACCOUNT" -GROUP | "GROUP" -USER | "USER" -RESOURCE | "RESOURCE" - - - -## Enum: StatusEnum -Name | Value ----- | ----- -ACTIVE | "ACTIVE" -INACTIVE | "INACTIVE" @@ -59,6 +31,7 @@ AGREEMENT_WORKFLOW_COMPLETED | "AGREEMENT_WORKFLOW_COMPLETED" AGREEMENT_EMAIL_VIEWED | "AGREEMENT_EMAIL_VIEWED" AGREEMENT_MODIFIED | "AGREEMENT_MODIFIED" AGREEMENT_SHARED | "AGREEMENT_SHARED" +AGREEMENT_READY_TO_VAULT | "AGREEMENT_READY_TO_VAULT" AGREEMENT_VAULTED | "AGREEMENT_VAULTED" AGREEMENT_ACTION_REQUESTED | "AGREEMENT_ACTION_REQUESTED" AGREEMENT_ACTION_REPLACED_SIGNER | "AGREEMENT_ACTION_REPLACED_SIGNER" @@ -88,4 +61,32 @@ LIBRARY_DOCUMENT_MODIFIED | "LIBRARY_DOCUMENT_MODIFIED" LIBRARY_DOCUMENT_ALL | "LIBRARY_DOCUMENT_ALL" + +## Enum: ScopeEnum +Name | Value +---- | ----- +ACCOUNT | "ACCOUNT" +GROUP | "GROUP" +USER | "USER" +RESOURCE | "RESOURCE" + + + +## Enum: ResourceTypeEnum +Name | Value +---- | ----- +AGREEMENT | "AGREEMENT" +WIDGET | "WIDGET" +MEGASIGN | "MEGASIGN" +LIBRARY_DOCUMENT | "LIBRARY_DOCUMENT" + + + +## Enum: StatusEnum +Name | Value +---- | ----- +ACTIVE | "ACTIVE" +INACTIVE | "INACTIVE" + + diff --git a/docs/UserWebhooks.md b/docs/UserWebhooks.md index fa12074..40829eb 100755 --- a/docs/UserWebhooks.md +++ b/docs/UserWebhooks.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**userWebhookList** | [**List<UserWebhook>**](UserWebhook.md) | An array of web form items | [optional] **page** | [**PageInfo**](PageInfo.md) | Pagination information for navigating through the response | [optional] -**userWebhookList** | [**List<UserWebhook>**](UserWebhook.md) | An array of widget items | [optional] diff --git a/docs/UserWidget.md b/docs/UserWidget.md index 2fd8051..ea44912 100755 --- a/docs/UserWidget.md +++ b/docs/UserWidget.md @@ -4,13 +4,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | The unique identifier of a widget | [optional] **hidden** | **Boolean** | True if agreement is hidden for the user | [optional] -**javascript** | **String** | The embedded javascript code of the widget | [optional] -**modifiedDate** | [**Date**](Date.md) | The date on which the widget was last modified. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**name** | **String** | The name of the widget. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The widget status (AUTHORING, ACTIVE, DRAFT, DISABLED) | [optional] -**url** | **String** | The hosted url of the widget | [optional] +**groupId** | **String** | Unique identifier of the group | [optional] +**modifiedDate** | [**Date**](Date.md) | The date on which the web form was last modified. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**name** | **String** | The name of the web form. | [optional] +**id** | **String** | The unique identifier of a web form | [optional] +**javascript** | **String** | The embedded javascript code of the web form | [optional] +**url** | **String** | The hosted url of the web form | [optional] +**status** | [**StatusEnum**](#StatusEnum) | The web form status (AUTHORING, ACTIVE, DRAFT, DISABLED) | [optional] diff --git a/docs/UserWidgets.md b/docs/UserWidgets.md index 8a22fea..40c140b 100755 --- a/docs/UserWidgets.md +++ b/docs/UserWidgets.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**userWidgetList** | [**List<UserWidget>**](UserWidget.md) | An array of web form items | [optional] **page** | [**PageInfo**](PageInfo.md) | Pagination information for navigating through the response | [optional] -**userWidgetList** | [**List<UserWidget>**](UserWidget.md) | An array of widget items | [optional] diff --git a/docs/UserWorkflow.md b/docs/UserWorkflow.md index 36a473a..60916cf 100755 --- a/docs/UserWorkflow.md +++ b/docs/UserWorkflow.md @@ -4,13 +4,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**scopeId** | **String** | Identifier of scope. Currently it is applicable for scope GROUP only and the value will be groupId. | [optional] **created** | [**Date**](Date.md) | The date on which the workflow was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**description** | **String** | Description provided for this workflow at the time of its creation | [optional] **displayName** | **String** | The display name of the workflow. | [optional] -**id** | **String** | The unique identifier of a workflow | [optional] -**name** | **String** | The name of the workflow. | [optional] **scope** | [**ScopeEnum**](#ScopeEnum) | The workflow scope (ACCOUNT or GROUP or OTHER) | [optional] -**scopeId** | **String** | Identifier of scope. Currently it is applicable for scope GROUP only and the value will be groupId. | [optional] +**name** | **String** | The name of the workflow. | [optional] +**description** | **String** | Description provided for this workflow at the time of its creation | [optional] +**id** | **String** | The unique identifier of a workflow | [optional] **status** | [**StatusEnum**](#StatusEnum) | The workflow status (ACTIVE or DRAFT or INACTIVE or OTHER) | [optional] diff --git a/docs/UsersApi.md b/docs/UsersApi.md index c77ce1a..c1dd610 100755 --- a/docs/UsersApi.md +++ b/docs/UsersApi.md @@ -1,6 +1,6 @@ # UsersApi -All URIs are relative to *http://localhost/api/rest/v6* +All URIs are relative to *https://secure.au1.echosign.com/api/rest/v6* Method | HTTP request | Description ------------- | ------------- | ------------- diff --git a/docs/UsersInfo.md b/docs/UsersInfo.md index cebeb4d..8bc46c7 100755 --- a/docs/UsersInfo.md +++ b/docs/UsersInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**page** | [**PageInfo**](PageInfo.md) | Pagination information for navigating through the response | [optional] **userInfoList** | [**List<UserInfo>**](UserInfo.md) | The list of users in the account. | [optional] +**page** | [**PageInfo**](PageInfo.md) | Pagination information for navigating through the response | [optional] diff --git a/docs/VaultEventInfo.md b/docs/VaultEventInfo.md new file mode 100644 index 0000000..49a7560 --- /dev/null +++ b/docs/VaultEventInfo.md @@ -0,0 +1,11 @@ + +# VaultEventInfo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**vaultEventComment** | **String** | The description provided by the vault provider for the vault event | [optional] +**vaultEventId** | **String** | The identifier assigned by the vault provider for the vault event | [optional] + + + diff --git a/docs/WebhookAgreementEvents.md b/docs/WebhookAgreementEvents.md index 90e8be2..b8d2a08 100755 --- a/docs/WebhookAgreementEvents.md +++ b/docs/WebhookAgreementEvents.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **includeDetailedInfo** | **Boolean** | Determines whether agreement detailed info will be returned in the response payload | [optional] -**includeDocumentsInfo** | **Boolean** | Determines whether document info will be returned in the response payload | [optional] **includeParticipantsInfo** | **Boolean** | Determines whether participants info will be returned in the response payload | [optional] **includeSignedDocuments** | **Boolean** | Determines whether documents will be returned in webhook response payload. If set to true, signed document will be returned in base 64 encoded format in JSON when signing is complete | [optional] +**includeDocumentsInfo** | **Boolean** | Determines whether document info will be returned in the response payload | [optional] diff --git a/docs/WebhookConditionalParams.md b/docs/WebhookConditionalParams.md index 0976031..531a436 100755 --- a/docs/WebhookConditionalParams.md +++ b/docs/WebhookConditionalParams.md @@ -4,10 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**webhookAgreementEvents** | [**WebhookAgreementEvents**](WebhookAgreementEvents.md) | Conditional parameters for webhook agreement events | [optional] -**webhookLibraryDocumentEvents** | [**WebhookLibraryDocumentEvents**](WebhookLibraryDocumentEvents.md) | Conditional parameters for webhook library document events | [optional] +**webhookWidgetEvents** | [**WebhookWidgetEvents**](WebhookWidgetEvents.md) | Conditional parameters for webhook web form events | [optional] **webhookMegaSignEvents** | [**WebhookMegaSignEvents**](WebhookMegaSignEvents.md) | Conditional parameters for webhook megasign events | [optional] -**webhookWidgetEvents** | [**WebhookWidgetEvents**](WebhookWidgetEvents.md) | Conditional parameters for webhook widget events | [optional] +**webhookLibraryDocumentEvents** | [**WebhookLibraryDocumentEvents**](WebhookLibraryDocumentEvents.md) | Conditional parameters for webhook library document events | [optional] +**webhookAgreementEvents** | [**WebhookAgreementEvents**](WebhookAgreementEvents.md) | Conditional parameters for webhook agreement events | [optional] diff --git a/docs/WebhookInfo.md b/docs/WebhookInfo.md index 813be50..58616bb 100755 --- a/docs/WebhookInfo.md +++ b/docs/WebhookInfo.md @@ -4,55 +4,20 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**applicationDisplayName** | **String** | The display name of the application through which webhook is created | [optional] -**applicationName** | **String** | The name of the application through which webhook is created | [optional] +**resourceId** | **String** | Id of the resource type for which you want to create webhook. Provide agreementId if webhook needs to be created for an agreement. Similarly, widgetId if webhook needs to be created for a web form, megaSignId if webhook needs to be created for a megaSign and libraryDocumentId if webhook needs to be created for a library document. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request | [optional] +**webhookUrlInfo** | [**WebhookUrlInfo**](WebhookUrlInfo.md) | Info of webhook url | [optional] +**webhookConditionalParams** | [**WebhookConditionalParams**](WebhookConditionalParams.md) | Conditions which webhook creator can specify for the payload while creating or updating a webhook | [optional] **created** | [**Date**](Date.md) | Timestamp when the webhook was created. Will only be returned in GET request. Can't be modified in PUT request | [optional] +**webhookSubscriptionEvents** | [**List<WebhookSubscriptionEventsEnum>**](#List<WebhookSubscriptionEventsEnum>) | Determines events for which the webhook is triggered. The possible values are <br> AGREEMENT_CREATED : When an agreement is created <br>, AGREEMENT_ACTION_DELEGATED : When an agreement is delegated <br>, AGREEMENT_RECALLED : When an agreement is recalled <br>, AGREEMENT_REJECTED : When an agreement is rejected <br>, AGREEMENT_EXPIRED : When an agreement expires <br>, AGREEMENT_ACTION_COMPLETED : When an agreement action is completed <br>, AGREEMENT_WORKFLOW_COMPLETED : When an agreement workflow is completed <br>, AGREEMENT_EMAIL_VIEWED : When an agreement's email is viewed <br>, AGREEMENT_MODIFIED : When an agreement is modified <br>, AGREEMENT_SHARED : When an agreement is shared <br>, AGREEMENT_READY_TO_VAULT : When an agreement is ready to vault <br>, AGREEMENT_VAULTED : When an agreement is vaulted <br>, AGREEMENT_ACTION_REQUESTED : When an agreement action is requested <br>, AGREEMENT_ACTION_REPLACED_SIGNER : When signer is replaced for an agreement <br>, AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When an agreement is auto-cancelled due to conversion problem <br>, AGREEMENT_DOCUMENTS_DELETED : When an agreement documents are deleted <br>, AGREEMENT_EMAIL_BOUNCED : When an agreement email gets bounced <br>, AGREEMENT_KBA_AUTHENTICATED : When an agreement KBA is authenticated <br>, AGREEMENT_OFFLINE_SYNC : When an agreement is synced offline <br>, AGREEMENT_USER_ACK_AGREEMENT_MODIFIED : User Acknowledgement when an agreement is modified <br>, AGREEMENT_UPLOADED_BY_SENDER : When an agreement is uploaded by sender <br>, AGREEMENT_WEB_IDENTITY_AUTHENTICATED : When an agreement web identity is authenticated <br>, AGREEMENT_ALL : All the supported agreement events for Webhooks <br>, MEGASIGN_CREATED : When a megaSign is created <br>, MEGASIGN_RECALLED : When a megaSign is recalled <br>, MEGASIGN_SHARED : When a megaSign is shared <br>, MEGASIGN_ALL : All the supported megaSign events for Webhooks <br>, WIDGET_CREATED : When a web form is created <br>, WIDGET_MODIFIED : When a web form is modified <br>, WIDGET_SHARED : When a web form is shared <br>, WIDGET_ENABLED : When a web form is enabled <br>, WIDGET_DISABLED : When a web form is disabled <br>, WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM : When a web form is auto-cancelled due to conversion problem <br>, WIDGET_ALL : All the supported web form events for Webhooks <br>, LIBRARY_DOCUMENT_CREATED : When a library document is created <br>, LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When a library document is auto-cancelled due to conversion problem <br>, LIBRARY_DOCUMENT_MODIFIED : When a library document is modified <br>, LIBRARY_DOCUMENT_ALL : All the supported library document events for Webhooks | [optional] +**applicationDisplayName** | **String** | The display name of the application through which webhook is created | [optional] +**scope** | [**ScopeEnum**](#ScopeEnum) | Scope of webhook. Can't be modified in PUT request. The possible values are ACCOUNT, GROUP, USER or RESOURCE | [optional] +**name** | **String** | The name of the webhook | [optional] **id** | **String** | The unique identifier of the webhook. Will only be returned in GET request. Can't be modified in PUT request | [optional] **lastModified** | [**Date**](Date.md) | Timestamp when the webhook was last updated. Will only be returned in GET request. Can't be modified in PUT request | [optional] -**name** | **String** | The name of the webhook | [optional] -**resourceId** | **String** | Id of the resource type for which you want to create webhook. Provide agreementId if webhook needs to be created for an agreement. Similarly, widgetId if webhook needs to be created for a widget, megaSignId if webhook needs to be created for a megaSign and libraryDocumentId if webhook needs to be created for a library document. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request | [optional] -**resourceType** | [**ResourceTypeEnum**](#ResourceTypeEnum) | The resource for which you want to create webhook. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request. The possible values are AGREEMENT, WIDGET, MEGASIGN AND LIBRARY_DOCUMENT | [optional] -**scope** | [**ScopeEnum**](#ScopeEnum) | Scope of webhook. Can't be modified in PUT request. The possible values are ACCOUNT, GROUP, USER or RESOURCE | [optional] **state** | [**StateEnum**](#StateEnum) | The state in which the webhook should be created | [optional] +**applicationName** | **String** | The name of the application through which webhook is created | [optional] +**resourceType** | [**ResourceTypeEnum**](#ResourceTypeEnum) | The resource for which you want to create webhook. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request. The possible values are AGREEMENT, WIDGET, MEGASIGN AND LIBRARY_DOCUMENT | [optional] **status** | [**StatusEnum**](#StatusEnum) | Status of the webhook. Determines whether the webhook will be actually triggered. Default: ACTIVE, if ACTIVE, this webhook will receive event requests. If INACTIVE, this webhook will not receive event requests. Can't provide status in POST/PUT requests. | [optional] -**webhookConditionalParams** | [**WebhookConditionalParams**](WebhookConditionalParams.md) | Conditions which webhook creator can specify for the payload while creating or updating a webhook | [optional] -**webhookSubscriptionEvents** | [**List<WebhookSubscriptionEventsEnum>**](#List<WebhookSubscriptionEventsEnum>) | Determines events for which the webhook is triggered. The possible values are <br> AGREEMENT_CREATED : When an agreement is created <br>, AGREEMENT_ACTION_DELEGATED : When an agreement is delegated <br>, AGREEMENT_RECALLED : When an agreement is recalled <br>, AGREEMENT_REJECTED : When an agreement is rejected <br>, AGREEMENT_EXPIRED : When an agreement expires <br>, AGREEMENT_ACTION_COMPLETED : When an agreement action is completed <br>, AGREEMENT_WORKFLOW_COMPLETED : When an agreement workflow is completed <br>, AGREEMENT_EMAIL_VIEWED : When an agreement's email is viewed <br>, AGREEMENT_MODIFIED : When an agreement is modified <br>, AGREEMENT_SHARED : When an agreement is shared <br>, AGREEMENT_VAULTED : When an agreement is vaulted <br>, AGREEMENT_ACTION_REQUESTED : When an agreement action is requested <br>, AGREEMENT_ACTION_REPLACED_SIGNER : When signer is replaced for an agreement <br>, AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When an agreement is auto-cancelled due to conversion problem <br>, AGREEMENT_DOCUMENTS_DELETED : When an agreement documents are deleted <br>, AGREEMENT_EMAIL_BOUNCED : When an agreement email gets bounced <br>, AGREEMENT_KBA_AUTHENTICATED : When an agreement KBA is authenticated <br>, AGREEMENT_OFFLINE_SYNC : When an agreement is synced offline <br>, AGREEMENT_USER_ACK_AGREEMENT_MODIFIED : User Acknowledgement when an agreement is modified <br>, AGREEMENT_UPLOADED_BY_SENDER : When an agreement is uploaded by sender <br>, AGREEMENT_WEB_IDENTITY_AUTHENTICATED : When an agreement web identity is authenticated <br>, AGREEMENT_ALL : All the supported agreement events for Webhooks <br>, MEGASIGN_CREATED : When a megaSign is created <br>, MEGASIGN_RECALLED : When a megaSign is recalled <br>, MEGASIGN_SHARED : When a megaSign is shared <br>, MEGASIGN_ALL : All the supported megaSign events for Webhooks <br>, WIDGET_CREATED : When a widget is created <br>, WIDGET_MODIFIED : When a widget is modified <br>, WIDGET_SHARED : When a widget is shared <br>, WIDGET_ENABLED : When a widget is enabled <br>, WIDGET_DISABLED : When a widget is disabled <br>, WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM : When a widget is auto-cancelled due to conversion problem <br>, WIDGET_ALL : All the supported widget events for Webhooks <br>, LIBRARY_DOCUMENT_CREATED : When a library document is created <br>, LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When a library document is auto-cancelled due to conversion problem <br>, LIBRARY_DOCUMENT_MODIFIED : When a library document is modified <br>, LIBRARY_DOCUMENT_ALL : All the supported library document events for Webhooks | [optional] -**webhookUrlInfo** | [**WebhookUrlInfo**](WebhookUrlInfo.md) | Info of webhook url | [optional] - - - -## Enum: ResourceTypeEnum -Name | Value ----- | ----- -AGREEMENT | "AGREEMENT" -WIDGET | "WIDGET" -MEGASIGN | "MEGASIGN" -LIBRARY_DOCUMENT | "LIBRARY_DOCUMENT" - - - -## Enum: ScopeEnum -Name | Value ----- | ----- -ACCOUNT | "ACCOUNT" -GROUP | "GROUP" -USER | "USER" -RESOURCE | "RESOURCE" - - - -## Enum: StateEnum -Name | Value ----- | ----- -ACTIVE | "ACTIVE" - - - -## Enum: StatusEnum -Name | Value ----- | ----- -ACTIVE | "ACTIVE" -INACTIVE | "INACTIVE" @@ -69,6 +34,7 @@ AGREEMENT_WORKFLOW_COMPLETED | "AGREEMENT_WORKFLOW_COMPLETED" AGREEMENT_EMAIL_VIEWED | "AGREEMENT_EMAIL_VIEWED" AGREEMENT_MODIFIED | "AGREEMENT_MODIFIED" AGREEMENT_SHARED | "AGREEMENT_SHARED" +AGREEMENT_READY_TO_VAULT | "AGREEMENT_READY_TO_VAULT" AGREEMENT_VAULTED | "AGREEMENT_VAULTED" AGREEMENT_ACTION_REQUESTED | "AGREEMENT_ACTION_REQUESTED" AGREEMENT_ACTION_REPLACED_SIGNER | "AGREEMENT_ACTION_REPLACED_SIGNER" @@ -98,4 +64,39 @@ LIBRARY_DOCUMENT_MODIFIED | "LIBRARY_DOCUMENT_MODIFIED" LIBRARY_DOCUMENT_ALL | "LIBRARY_DOCUMENT_ALL" + +## Enum: ScopeEnum +Name | Value +---- | ----- +ACCOUNT | "ACCOUNT" +GROUP | "GROUP" +USER | "USER" +RESOURCE | "RESOURCE" + + + +## Enum: StateEnum +Name | Value +---- | ----- +ACTIVE | "ACTIVE" + + + +## Enum: ResourceTypeEnum +Name | Value +---- | ----- +AGREEMENT | "AGREEMENT" +WIDGET | "WIDGET" +MEGASIGN | "MEGASIGN" +LIBRARY_DOCUMENT | "LIBRARY_DOCUMENT" + + + +## Enum: StatusEnum +Name | Value +---- | ----- +ACTIVE | "ACTIVE" +INACTIVE | "INACTIVE" + + diff --git a/docs/WebhookWidgetEvents.md b/docs/WebhookWidgetEvents.md index ea3ec6c..978d4e9 100755 --- a/docs/WebhookWidgetEvents.md +++ b/docs/WebhookWidgetEvents.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **includeDetailedInfo** | **Boolean** | Determines whether agreement detailed info will be returned in the response payload | [optional] -**includeDocumentsInfo** | **Boolean** | Determines whether document info will be returned in the response payload | [optional] **includeParticipantsInfo** | **Boolean** | Determines whether participants info will be returned in the response payload | [optional] +**includeDocumentsInfo** | **Boolean** | Determines whether document info will be returned in the response payload | [optional] diff --git a/docs/WebhooksApi.md b/docs/WebhooksApi.md index 4ee7d96..e7fd26f 100755 --- a/docs/WebhooksApi.md +++ b/docs/WebhooksApi.md @@ -1,6 +1,6 @@ # WebhooksApi -All URIs are relative to *http://localhost/api/rest/v6* +All URIs are relative to *https://secure.au1.echosign.com/api/rest/v6* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -18,7 +18,7 @@ Method | HTTP request | Description Creates a webhook. -This is a primary endpoint which is used to create a new webhook. A webhook can only be created in ACTIVE state. Currently, webhooks are supported at four scopes - Account, Group, User and Resource. <br/> <br/> Before creating a webhook successfully at any of these scopes, Adobe Sign <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobeio/adobeio-documentation/master/sign/webhooks.md#verificationofintentofthewebhookurl'>verifies</a> that the webhook URL that is provided in the registration request really intends to receive notifications and is a valid URL. <br/>There is a defined mechanism for this validation where Adobe Sign makes an HTTPS GET request to the webhook URL. This request has a custom HTTP header X-AdobeSign-ClientId. The value of this header is the client ID of the application that is requesting to create the webhook. To register a webhook successfully, the webhook URL must respond to this verification request with an HTTPS 2XX response code, and also it must send back the same client ID value in one of the following two ways:<ol><li>In a custom response header, X-AdobeSign-ClientId. This is the same header which was passed in the request, and can be echoed back in the response.</li><li> In the JSON response body of the response with the key of xAdobeSignClientId and its value being the same client ID that was sent in the request. </li></ol><p>On successful registration, Adobe Sign sends a success response (any HTTPS 2XX code) to your client app with the unique webhook identifier and a Location header, which contains the URL of the webhook resource created in Adobe Sign.<br/> To learn more, please refer <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobeio/adobeio-documentation/master/sign/webhooks.md'>Webhooks in Adobe Sign Guide</a>.</p> +This is a primary endpoint which is used to create a new webhook. A webhook can only be created in ACTIVE state. Currently, webhooks are supported at four scopes - Account, Group, User and Resource. <br/> <br/> Before creating a webhook successfully at any of these scopes, Adobe Sign <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks.md#verificationofintentofthewebhookurl'>verifies</a> that the webhook URL that is provided in the registration request really intends to receive notifications and is a valid URL. <br/>There is a defined mechanism for this validation where Adobe Sign makes an HTTPS GET request to the webhook URL. This request has a custom HTTP header X-AdobeSign-ClientId. The value of this header is the client ID of the application that is requesting to create the webhook. To register a webhook successfully, the webhook URL must respond to this verification request with an HTTPS 2XX response code, and also it must send back the same client ID value in one of the following two ways:<ol><li>In a custom response header, X-AdobeSign-ClientId. This is the same header which was passed in the request, and can be echoed back in the response.</li><li> In the JSON response body of the response with the key of xAdobeSignClientId and its value being the same client ID that was sent in the request. </li></ol><p>On successful registration, Adobe Sign sends a success response (any HTTPS 2XX code) to your client app with the unique webhook identifier and a Location header, which contains the URL of the webhook resource created in Adobe Sign.<br/> To learn more, please refer <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks.md'>Webhooks in Adobe Sign Guide</a>.</p> ### Example ```java @@ -65,7 +65,7 @@ No authorization required # **deleteWebhook** -> deleteWebhook(authorization, ifMatch, webhookId, xApiUser, xOnBehalfOfUser) +> deleteWebhook(authorization, webhookId, xApiUser, xOnBehalfOfUser, ifMatch) Deletes a webhook. @@ -78,12 +78,12 @@ Deletes a webhook. WebhooksApi apiInstance = new WebhooksApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String webhookId = "webhookId_example"; // String | The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. try { - apiInstance.deleteWebhook(authorization, ifMatch, webhookId, xApiUser, xOnBehalfOfUser); + apiInstance.deleteWebhook(authorization, webhookId, xApiUser, xOnBehalfOfUser, ifMatch); } catch (ApiException e) { System.err.println("Exception when calling WebhooksApi#deleteWebhook"); e.printStackTrace(); @@ -95,10 +95,10 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_retention')\" oncontextmenu=\"this.href=oauthDoc('webhook_retention')\" target=\"oauthDoc\">webhook_retention</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | **webhookId** | **String**| The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] ### Return type @@ -223,7 +223,7 @@ No authorization required # **updateWebhook** -> updateWebhook(authorization, ifMatch, webhookId, webhookInfo, xApiUser, xOnBehalfOfUser) +> updateWebhook(authorization, webhookId, webhookInfo, xApiUser, xOnBehalfOfUser, ifMatch) Updates a webhook. @@ -236,13 +236,13 @@ Updates a webhook. WebhooksApi apiInstance = new WebhooksApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String webhookId = "webhookId_example"; // String | The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. WebhookInfo webhookInfo = new WebhookInfo(); // WebhookInfo | Information necessary to update a webhook String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. try { - apiInstance.updateWebhook(authorization, ifMatch, webhookId, webhookInfo, xApiUser, xOnBehalfOfUser); + apiInstance.updateWebhook(authorization, webhookId, webhookInfo, xApiUser, xOnBehalfOfUser, ifMatch); } catch (ApiException e) { System.err.println("Exception when calling WebhooksApi#updateWebhook"); e.printStackTrace(); @@ -254,11 +254,11 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_write')\" oncontextmenu=\"this.href=oauthDoc('webhook_write')\" target=\"oauthDoc\">webhook_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | **webhookId** | **String**| The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. | **webhookInfo** | [**WebhookInfo**](WebhookInfo.md)| Information necessary to update a webhook | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] ### Return type @@ -275,7 +275,7 @@ No authorization required # **updateWebhookState** -> updateWebhookState(authorization, ifMatch, webhookId, webhookStateInfo, xApiUser, xOnBehalfOfUser) +> updateWebhookState(authorization, webhookId, webhookStateInfo, xApiUser, xOnBehalfOfUser, ifMatch) Updates the state of a webhook identified by webhookId in the path. @@ -288,13 +288,13 @@ Updates the state of a webhook identified by webhookId in the path. WebhooksApi apiInstance = new WebhooksApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String webhookId = "webhookId_example"; // String | The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. WebhookStateInfo webhookStateInfo = new WebhookStateInfo(); // WebhookStateInfo | String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. try { - apiInstance.updateWebhookState(authorization, ifMatch, webhookId, webhookStateInfo, xApiUser, xOnBehalfOfUser); + apiInstance.updateWebhookState(authorization, webhookId, webhookStateInfo, xApiUser, xOnBehalfOfUser, ifMatch); } catch (ApiException e) { System.err.println("Exception when calling WebhooksApi#updateWebhookState"); e.printStackTrace(); @@ -306,11 +306,11 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_write')\" oncontextmenu=\"this.href=oauthDoc('webhook_write')\" target=\"oauthDoc\">webhook_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | **webhookId** | **String**| The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. | **webhookStateInfo** | [**WebhookStateInfo**](WebhookStateInfo.md)| | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] ### Return type diff --git a/docs/WidgetAdditionalParticipationSetInfo.md b/docs/WidgetAdditionalParticipationSetInfo.md index 3a1d2e3..4ec3fb3 100755 --- a/docs/WidgetAdditionalParticipationSetInfo.md +++ b/docs/WidgetAdditionalParticipationSetInfo.md @@ -4,9 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**memberInfos** | [**List<ParticipantSetMemberInfo>**](ParticipantSetMemberInfo.md) | Array of ParticipantInfo objects, containing participant-specific data (email, e.g.) for all the additional participants in the widget | [optional] -**order** | **Integer** | Index indicating position at which signing group needs to sign. Additional participant to sign at first place is assigned a index of 1. Widget participant should not have any order specified. Widget participant should not have any email address and and can not have phone authentication applied. Different signingOrder specified in input should form a valid consecutive increasing sequence of integers. Otherwise signingOrder will be considered invalid | [optional] -**role** | [**RoleEnum**](#RoleEnum) | Role assumed by all participants in the set (signer, approver, etc.) Widget First Participant will only have roles - Signer, Approver, Acceptor and Form Filler | [optional] +**providerParticipantSetInfo** | [**ProviderParticipantSetInfo**](ProviderParticipantSetInfo.md) | Represents all the attributes related to the unknown participant and its provider. If it is defined then the participant will be treated as an unknown participant. | [optional] +**role** | [**RoleEnum**](#RoleEnum) | Role assumed by all participants in the set (signer, approver, etc.) Web Form First Participant will only have roles - Signer, Approver, Acceptor and Form Filler | [optional] +**memberInfos** | [**List<ParticipantSetMemberInfo>**](ParticipantSetMemberInfo.md) | Array of ParticipantInfo objects, containing participant-specific data (email, e.g.) for all the additional participants in the web form. If the email of the participant is unknown at the time of web form creation, the email should be left empty, | [optional] +**order** | **Integer** | Index indicating position at which signing group needs to sign. Additional participant to sign at first place is assigned a index of 1. Web Form participant should not have any order specified. Web Form participant should not have any email address and and can not have phone authentication applied. Different signingOrder specified in input should form a valid consecutive increasing sequence of integers. Otherwise signingOrder will be considered invalid, | [optional] diff --git a/docs/WidgetAgreement.md b/docs/WidgetAgreement.md index a108b23..1671ad3 100755 --- a/docs/WidgetAgreement.md +++ b/docs/WidgetAgreement.md @@ -4,16 +4,28 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**hidden** | **Boolean** | True if agreement is hidden for the user | [optional] **displayDate** | [**Date**](Date.md) | The display date for the agreement. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**displayParticipantSetInfos** | [**List<DisplayWidgetParticipantSetInfo>**](DisplayWidgetParticipantSetInfo.md) | The most relevant current user set for the agreement. It is typically the next signer if the agreement is from the current user, or the sender if received from another user | [optional] -**id** | **String** | The unique identifier of the agreement.If provided in POST, it will simply be ignored | [optional] +**groupId** | **String** | Unique identifier of the group | [optional] **esign** | **Boolean** | True if this is an e-sign document | [optional] -**hidden** | **Boolean** | True if agreement is hidden for the user | [optional] -**latestVersionId** | **String** | A version ID which uniquely identifies the current version of the agreement | [optional] **name** | **String** | Name of the Agreement | [optional] +**displayParticipantSetInfos** | [**List<DisplayWidgetParticipantSetInfo>**](DisplayWidgetParticipantSetInfo.md) | The most relevant current user set for the agreement. It is typically the next signer if the agreement is from the current user, or the sender if received from another user | [optional] +**latestVersionId** | **String** | A version ID which uniquely identifies the current version of the agreement | [optional] +**id** | **String** | The unique identifier of the agreement.If provided in POST, it will simply be ignored | [optional] +**type** | [**TypeEnum**](#TypeEnum) | The kind of agreement | [optional] +**parentId** | **String** | The parent id of a megaSign child *OR* the originating id of a widget agreement instance | [optional] **status** | [**StatusEnum**](#StatusEnum) | The current status of the document from the perspective of the originator | [optional] + +## Enum: TypeEnum +Name | Value +---- | ----- +AGREEMENT | "AGREEMENT" +MEGASIGN_CHILD | "MEGASIGN_CHILD" +WIDGET_INSTANCE | "WIDGET_INSTANCE" + + ## Enum: StatusEnum Name | Value diff --git a/docs/WidgetAgreements.md b/docs/WidgetAgreements.md index f26996f..79e8c35 100755 --- a/docs/WidgetAgreements.md +++ b/docs/WidgetAgreements.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**page** | [**PageInfo**](PageInfo.md) | Pagination information for navigating through the response | [optional] **userAgreementList** | [**List<WidgetAgreement>**](WidgetAgreement.md) | An array of UserAgreement items | [optional] +**page** | [**PageInfo**](PageInfo.md) | Pagination information for navigating through the response | [optional] diff --git a/docs/WidgetCcInfo.md b/docs/WidgetCcInfo.md index 75127c1..e83eb03 100755 --- a/docs/WidgetCcInfo.md +++ b/docs/WidgetCcInfo.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**email** | **String** | Email of the CC participant of the widget | [optional] +**email** | **String** | Email of the CC participant of the web form | [optional] diff --git a/docs/WidgetCreationInfoV6.md b/docs/WidgetCreationInfoV6.md index b26e683..9d24b4e 100755 --- a/docs/WidgetCreationInfoV6.md +++ b/docs/WidgetCreationInfoV6.md @@ -4,22 +4,25 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**additionalParticipantSetsInfo** | [**List<WidgetAdditionalParticipationSetInfo>**](WidgetAdditionalParticipationSetInfo.md) | List of all the participants in the widget except widget signer | [optional] -**authFailureInfo** | [**WidgetRedirectionInfo**](WidgetRedirectionInfo.md) | URL and associated properties for the error page the widget signer will be taken after failing to authenticate | [optional] -**ccs** | [**List<WidgetCcInfo>**](WidgetCcInfo.md) | A list of one or more email addresses that you want to copy on this transaction. The email addresses will each receive an email when the final agreement created through widget is signed. The email addresses will also receive a copy of the document, attached as a PDF file | [optional] -**completionInfo** | [**WidgetRedirectionInfo**](WidgetRedirectionInfo.md) | URL and associated properties for the success page the widget signer will be taken to after performing desired action on the widget | [optional] -**createdDate** | [**Date**](Date.md) | Date when widget was created. If provided in POST, it will simply be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**creatorEmail** | **String** | Email of widget creator. Only returned in GET response. Cannot be provided in POST/PUT request. If provided in POST, it will simply be ignored | [optional] -**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be used to create the widget. If more than one file is provided, they will be combined before the widget is created. Library documents are not permitted. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] -**id** | **String** | A resource identifier that can be used to uniquely identify the widget in other apis. If provided in POST, it will simply be ignored | [optional] -**locale** | **String** | The locale associated with this widget - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the widget creator | [optional] -**name** | **String** | The name of the widget that will be used to identify it, in emails, website and other places | [optional] -**securityOption** | [**SecurityOption**](SecurityOption.md) | Secondary security parameters for the widget | [optional] -**state** | [**StateEnum**](#StateEnum) | The state in which the widget should land. For example in order to create a widget in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the widget can be obtained from GET /widgets/ID | [optional] -**status** | [**StatusEnum**](#StatusEnum) | Status of the Widget. If provided in POST, it will simply be ignored | [optional] +**additionalParticipantSetsInfo** | [**List<WidgetAdditionalParticipationSetInfo>**](WidgetAdditionalParticipationSetInfo.md) | List of all the participants in the web form except web form signer | [optional] +**creatorEmail** | **String** | Email of web form creator. Only returned in GET response. Cannot be provided in POST/PUT request. If provided in POST, it will simply be ignored | [optional] +**groupId** | **String** | The ID of the group to which the widget belongs to. If not provided during creation, primary group of the creator will be used | [optional] +**locale** | **String** | The locale associated with this web form - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the web form creator | [optional] **vaultingInfo** | [**VaultingInfo**](VaultingInfo.md) | Vaulting properties that allows Adobe Sign to securely store documents with a vault provider | [optional] -**widgetInActiveInfo** | [**WidgetInActiveInfo**](WidgetInActiveInfo.md) | The custom message which will be displayed to the user or the URL to which user will be redirected when the widget is accessed in a disabled state. This can only be specified in PUT request | [optional] -**widgetParticipantSetInfo** | [**WidgetParticipantSetInfo**](WidgetParticipantSetInfo.md) | Represents widget participant for whom email should not be provided | [optional] +**securityOption** | [**SecurityOption**](SecurityOption.md) | Secondary security parameters for the web form | [optional] +**widgetParticipantSetInfo** | [**WidgetParticipantSetInfo**](WidgetParticipantSetInfo.md) | Represents web form participant for whom email should not be provided | [optional] +**widgetInActiveInfo** | [**WidgetInActiveInfo**](WidgetInActiveInfo.md) | The custom message which will be displayed to the user or the URL to which user will be redirected when the web form is accessed in a disabled state. This can only be specified in PUT request | [optional] +**ccs** | [**List<WidgetCcInfo>**](WidgetCcInfo.md) | A list of one or more email addresses that you want to copy on this transaction. The email addresses will each receive an email when the final agreement created through web form is signed. The email addresses will also receive a copy of the document, attached as a PDF file | [optional] +**createdDate** | [**Date**](Date.md) | Date when web form was created. If provided in POST, it will simply be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**isDocumentRetentionApplied** | **Boolean** | Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. | [optional] +**lastEventDate** | [**Date**](Date.md) | The date of the last event that occurred for this web form. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**name** | **String** | The name of the web form that will be used to identify it, in emails, website and other places | [optional] +**completionInfo** | [**WidgetRedirectionInfo**](WidgetRedirectionInfo.md) | URL and associated properties for the success page the web form signer will be taken to after performing desired action on the web form | [optional] +**authFailureInfo** | [**WidgetRedirectionInfo**](WidgetRedirectionInfo.md) | URL and associated properties for the error page the web form signer will be taken after failing to authenticate | [optional] +**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be used to create the web form. If more than one file is provided, they will be combined before the web form is created. Library documents are not permitted. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] +**id** | **String** | A resource identifier that can be used to uniquely identify the web form in other apis. If provided in POST, it will simply be ignored | [optional] +**state** | [**StateEnum**](#StateEnum) | The state in which the web form should land. For example in order to create a web form in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the web form can be obtained from GET /widgets/ID | [optional] +**status** | [**StatusEnum**](#StatusEnum) | Status of the Web Form. If provided in POST, it will simply be ignored | [optional] diff --git a/docs/WidgetCreationResponse.md b/docs/WidgetCreationResponse.md index 3638df3..16a9cdf 100755 --- a/docs/WidgetCreationResponse.md +++ b/docs/WidgetCreationResponse.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | The unique identifier of widget which can be used to retrieve the data entered by the signers. | [optional] +**id** | **String** | The unique identifier of web form which can be used to retrieve the data entered by the signers. | [optional] diff --git a/docs/WidgetEvent.md b/docs/WidgetEvent.md index e4e6be4..5833ae3 100755 --- a/docs/WidgetEvent.md +++ b/docs/WidgetEvent.md @@ -4,25 +4,37 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**actingUserEmail** | **String** | Email address of the user that created the event | [optional] -**actingUserIpAddress** | **String** | The IP address of the user that created the event | [optional] -**actingUserName** | **String** | The name of the acting user | [optional] -**comment** | **String** | The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant | [optional] **date** | [**Date**](Date.md) | The date of the audit event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**description** | **String** | A description of the audit event | [optional] -**deviceLocation** | [**WidgetEventDeviceLocation**](WidgetEventDeviceLocation.md) | Location of the device that generated the event (This value may be null due to limited privileges) | [optional] -**devicePhoneNumber** | **String** | Phone number from the device used when the participation is completed on a mobile phone | [optional] -**digitalSignatureInfo** | [**DigitalSignatureInfo**](DigitalSignatureInfo.md) | This is present for ESIGNED events when the participation is signed digitally | [optional] -**initiatingUserEmail** | **String** | Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect | [optional] **initiatingUserName** | **String** | Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect | [optional] +**description** | **String** | A description of the audit event | [optional] +**actingUserName** | **String** | The name of the acting user | [optional] +**actingUserIpAddress** | **String** | The IP address of the user that created the event | [optional] **participantEmail** | **String** | Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to | [optional] -**participantId** | **String** | The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to | [optional] +**type** | [**TypeEnum**](#TypeEnum) | Type of web form event | [optional] **participantRole** | [**ParticipantRoleEnum**](#ParticipantRoleEnum) | Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). | [optional] -**synchronizationId** | **String** | A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null) | [optional] -**type** | [**TypeEnum**](#TypeEnum) | Type of widget event | [optional] **vaultEventId** | **String** | The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null) | [optional] -**vaultProviderName** | **String** | Name of the vault provider for the vault event (if vaulted, otherwise null) | [optional] +**participantId** | **String** | The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to | [optional] **versionId** | **String** | An ID which uniquely identifies the version of the document associated with this audit event | [optional] +**actingUserEmail** | **String** | Email address of the user that created the event | [optional] +**devicePhoneNumber** | **String** | Phone number from the device used when the participation is completed on a mobile phone | [optional] +**initiatingUserEmail** | **String** | Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect | [optional] +**digitalSignatureInfo** | [**DigitalSignatureInfo**](DigitalSignatureInfo.md) | This is present for ESIGNED events when the participation is signed digitally | [optional] +**vaultProviderName** | **String** | Name of the vault provider for the vault event (if vaulted, otherwise null) | [optional] +**comment** | **String** | The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant | [optional] +**id** | **String** | The identifier for the event. | [optional] +**synchronizationId** | **String** | A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null) | [optional] +**deviceLocation** | [**WidgetEventDeviceLocation**](WidgetEventDeviceLocation.md) | Location of the device that generated the event (This value may be null due to limited privileges) | [optional] + + + +## Enum: TypeEnum +Name | Value +---- | ----- +AUTO_CANCELLED_CONVERSION_PROBLEM | "AUTO_CANCELLED_CONVERSION_PROBLEM" +ACTIVATED | "ACTIVATED" +CREATED | "CREATED" +DEACTIVATED | "DEACTIVATED" +MODIFIED | "MODIFIED" @@ -43,15 +55,4 @@ SHARE | "SHARE" SENDER | "SENDER" - -## Enum: TypeEnum -Name | Value ----- | ----- -AUTO_CANCELLED_CONVERSION_PROBLEM | "AUTO_CANCELLED_CONVERSION_PROBLEM" -ACTIVATED | "ACTIVATED" -CREATED | "CREATED" -DEACTIVATED | "DEACTIVATED" -MODIFIED | "MODIFIED" - - diff --git a/docs/WidgetInActiveInfo.md b/docs/WidgetInActiveInfo.md index ce09892..7cd9195 100755 --- a/docs/WidgetInActiveInfo.md +++ b/docs/WidgetInActiveInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**message** | **String** | Display this custom message to the user when the widget is accessed. Note that this can contain wiki markup to include clickable links in the message. This is required if redirectUrl is not provided. Both message and redirectUrl cannot be specified. | [optional] -**redirectUrl** | **String** | Redirect the user to this URL when the widget is accessed. This is required if message is not provided. Both message and redirectUrl cannot be specified. | [optional] +**redirectUrl** | **String** | Redirect the user to this URL when the web form is accessed. This is required if message is not provided. Both message and redirectUrl cannot be specified. | [optional] +**message** | **String** | Display this custom message to the user when the web form is accessed. Note that this can contain wiki markup to include clickable links in the message. This is required if redirectUrl is not provided. Both message and redirectUrl cannot be specified. | [optional] diff --git a/docs/WidgetInfo.md b/docs/WidgetInfo.md index 1f30da5..60516eb 100755 --- a/docs/WidgetInfo.md +++ b/docs/WidgetInfo.md @@ -4,22 +4,25 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**additionalParticipantSetsInfo** | [**List<WidgetAdditionalParticipationSetInfo>**](WidgetAdditionalParticipationSetInfo.md) | List of all the participants in the widget except widget signer | [optional] -**authFailureInfo** | [**WidgetRedirectionInfo**](WidgetRedirectionInfo.md) | URL and associated properties for the error page the widget signer will be taken after failing to authenticate | [optional] -**ccs** | [**List<WidgetCcInfo>**](WidgetCcInfo.md) | A list of one or more email addresses that you want to copy on this transaction. The email addresses will each receive an email when the final agreement created through widget is signed. The email addresses will also receive a copy of the document, attached as a PDF file | [optional] -**completionInfo** | [**WidgetRedirectionInfo**](WidgetRedirectionInfo.md) | URL and associated properties for the success page the widget signer will be taken to after performing desired action on the widget | [optional] -**createdDate** | [**Date**](Date.md) | Date when widget was created. If provided in POST, it will simply be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] -**creatorEmail** | **String** | Email of widget creator. Only returned in GET response. Cannot be provided in POST/PUT request. If provided in POST, it will simply be ignored | [optional] -**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be used to create the widget. If more than one file is provided, they will be combined before the widget is created. Library documents are not permitted. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] -**id** | **String** | A resource identifier that can be used to uniquely identify the widget in other apis. If provided in POST, it will simply be ignored | [optional] -**locale** | **String** | The locale associated with this widget - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the widget creator | [optional] -**name** | **String** | The name of the widget that will be used to identify it, in emails, website and other places | [optional] -**securityOption** | [**SecurityOption**](SecurityOption.md) | Secondary security parameters for the widget | [optional] -**state** | [**StateEnum**](#StateEnum) | The state in which the widget should land. For example in order to create a widget in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the widget can be obtained from GET /widgets/ID | [optional] -**status** | [**StatusEnum**](#StatusEnum) | Status of the Widget. If provided in POST, it will simply be ignored | [optional] +**additionalParticipantSetsInfo** | [**List<WidgetAdditionalParticipationSetInfo>**](WidgetAdditionalParticipationSetInfo.md) | List of all the participants in the web form except web form signer | [optional] +**creatorEmail** | **String** | Email of web form creator. Only returned in GET response. Cannot be provided in POST/PUT request. If provided in POST, it will simply be ignored | [optional] +**groupId** | **String** | The ID of the group to which the widget belongs to. If not provided during creation, primary group of the creator will be used | [optional] +**locale** | **String** | The locale associated with this web form - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the web form creator | [optional] **vaultingInfo** | [**VaultingInfo**](VaultingInfo.md) | Vaulting properties that allows Adobe Sign to securely store documents with a vault provider | [optional] -**widgetInActiveInfo** | [**WidgetInActiveInfo**](WidgetInActiveInfo.md) | The custom message which will be displayed to the user or the URL to which user will be redirected when the widget is accessed in a disabled state. This can only be specified in PUT request | [optional] -**widgetParticipantSetInfo** | [**WidgetParticipantSetInfo**](WidgetParticipantSetInfo.md) | Represents widget participant for whom email should not be provided | [optional] +**securityOption** | [**SecurityOption**](SecurityOption.md) | Secondary security parameters for the web form | [optional] +**widgetParticipantSetInfo** | [**WidgetParticipantSetInfo**](WidgetParticipantSetInfo.md) | Represents web form participant for whom email should not be provided | [optional] +**widgetInActiveInfo** | [**WidgetInActiveInfo**](WidgetInActiveInfo.md) | The custom message which will be displayed to the user or the URL to which user will be redirected when the web form is accessed in a disabled state. This can only be specified in PUT request | [optional] +**ccs** | [**List<WidgetCcInfo>**](WidgetCcInfo.md) | A list of one or more email addresses that you want to copy on this transaction. The email addresses will each receive an email when the final agreement created through web form is signed. The email addresses will also receive a copy of the document, attached as a PDF file | [optional] +**createdDate** | [**Date**](Date.md) | Date when web form was created. If provided in POST, it will simply be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**isDocumentRetentionApplied** | **Boolean** | Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. | [optional] +**lastEventDate** | [**Date**](Date.md) | The date of the last event that occurred for this web form. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**name** | **String** | The name of the web form that will be used to identify it, in emails, website and other places | [optional] +**completionInfo** | [**WidgetRedirectionInfo**](WidgetRedirectionInfo.md) | URL and associated properties for the success page the web form signer will be taken to after performing desired action on the web form | [optional] +**authFailureInfo** | [**WidgetRedirectionInfo**](WidgetRedirectionInfo.md) | URL and associated properties for the error page the web form signer will be taken after failing to authenticate | [optional] +**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be used to create the web form. If more than one file is provided, they will be combined before the web form is created. Library documents are not permitted. Note: Only one of the four parameters in every FileInfo object must be specified | [optional] +**id** | **String** | A resource identifier that can be used to uniquely identify the web form in other apis. If provided in POST, it will simply be ignored | [optional] +**state** | [**StateEnum**](#StateEnum) | The state in which the web form should land. For example in order to create a web form in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the web form can be obtained from GET /widgets/ID | [optional] +**status** | [**StatusEnum**](#StatusEnum) | Status of the Web Form. If provided in POST, it will simply be ignored | [optional] diff --git a/docs/WidgetMembersInfo.md b/docs/WidgetMembersInfo.md index abb0421..98bba22 100755 --- a/docs/WidgetMembersInfo.md +++ b/docs/WidgetMembersInfo.md @@ -4,11 +4,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**additionalParticipantSets** | [**List<DetailedWidgetParticipantSetInfo>**](DetailedWidgetParticipantSetInfo.md) | Information about the widget additional participant Sets | [optional] -**ccsInfo** | [**List<CCParticipantInfo>**](CCParticipantInfo.md) | Information of CC participants of the widget. | [optional] -**creatorInfo** | [**SenderInfo**](SenderInfo.md) | Information of the creator of the widget. | [optional] -**sharesInfo** | [**List<ShareParticipantInfo>**](ShareParticipantInfo.md) | Information of the participants with whom the widget has been shared. | [optional] -**widgetParticipantSet** | [**DetailedWidgetParticipantSetInfo**](DetailedWidgetParticipantSetInfo.md) | Information about the widget participant Set | [optional] +**ccsInfo** | [**List<CCParticipantInfo>**](CCParticipantInfo.md) | Information of CC participants of the web form. | [optional] +**additionalParticipantSets** | [**List<DetailedWidgetParticipantSetInfo>**](DetailedWidgetParticipantSetInfo.md) | Information about the web form additional participant Sets | [optional] +**widgetParticipantSet** | [**DetailedWidgetParticipantSetInfo**](DetailedWidgetParticipantSetInfo.md) | Information about the web form participant Set | [optional] +**sharesInfo** | [**List<ShareParticipantInfo>**](ShareParticipantInfo.md) | Information of the participants with whom the web form has been shared. | [optional] +**creatorInfo** | [**SenderInfo**](SenderInfo.md) | Information of the creator of the web form. | [optional] diff --git a/docs/WidgetParticipantSetInfo.md b/docs/WidgetParticipantSetInfo.md index 8dd80c2..333b35a 100755 --- a/docs/WidgetParticipantSetInfo.md +++ b/docs/WidgetParticipantSetInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**memberInfos** | [**List<ParticipantSetMemberInfo>**](ParticipantSetMemberInfo.md) | Array of ParticipantInfo objects, containing participant - specific data (email, e.g.). All participants in the array belong to the same set. Currently we are supporting only one member in the set. Since the email of the widget signer is unknown at the time of widget creation, the email should be left empty and its optional security options should be provided. | [optional] -**role** | [**RoleEnum**](#RoleEnum) | Role assumed by all participants in the set (signer, approver, etc.) Widget First Participant will only have roles - Signer, Approver, Acceptor and Form Filler | [optional] +**role** | [**RoleEnum**](#RoleEnum) | Role assumed by all participants in the set (signer, approver, etc.) Web Form First Participant will only have roles - Signer, Approver, Acceptor and Form Filler | [optional] +**memberInfos** | [**List<ParticipantSetMemberInfo>**](ParticipantSetMemberInfo.md) | Array of ParticipantInfo objects, containing participant - specific data (email, e.g.). All participants in the array belong to the same set. Currently we are supporting only one member in the set. Since the email of the web form signer is unknown at the time of web form creation, the email should be left empty and its optional security options should be provided. | [optional] diff --git a/docs/WidgetRedirectionInfo.md b/docs/WidgetRedirectionInfo.md index 6e55c91..6049570 100755 --- a/docs/WidgetRedirectionInfo.md +++ b/docs/WidgetRedirectionInfo.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**deframe** | **Boolean** | If deframe is false, the resultant page will be shown inside the widget frame. If deframe is true, the resultant page will be shown in the full browser window. Note that in the case of embedded widgets, browser security restrictions do not permit automatic redirection in the full browser window, so if deframe is true the user will instead just see a link to the success page. We recommend this scenario be avoided - in other words, setting deframe to false is recommended for embedded widgets | [optional] -**delay** | **Integer** | The delay (in seconds) before the user is taken to the resultant page. If this value is greater than 0, the user will first see the standard Adobe Sign result message, and then after a delay will be redirected to your resultant page. Note that this parameter has no effect for embedded widgets when deframe is true | [optional] -**url** | **String** | A publicly accessible url to which the user will be sent after successfully completing the widget. If the URL you provide includes information that allows you to identify the specific transaction, such as your own unique identifier, you can use the browser request to this URL as a callback to notify you that this transaction is completed. In addition, Adobe Sign will append a documentKey parameter to the URL which will contain the Adobe Sign DocumentKey for this signed widget, but only if the sender is the same as the API key user. Your application can use this value to get the form data for this widget | [optional] +**delay** | **Integer** | The delay (in seconds) before the user is taken to the resultant page. If this value is greater than 0, the user will first see the standard Adobe Sign result message, and then after a delay will be redirected to your resultant page. Note that this parameter has no effect for embedded web forms when deframe is true | [optional] +**deframe** | **Boolean** | If deframe is false, the resultant page will be shown inside the web form frame. If deframe is true, the resultant page will be shown in the full browser window. Note that in the case of embedded web forms, browser security restrictions do not permit automatic redirection in the full browser window, so if deframe is true the user will instead just see a link to the success page. We recommend this scenario be avoided - in other words, setting deframe to false is recommended for embedded web forms | [optional] +**url** | **String** | A publicly accessible url to which the user will be sent after successfully completing the web form. If the URL you provide includes information that allows you to identify the specific transaction, such as your own unique identifier, you can use the browser request to this URL as a callback to notify you that this transaction is completed. In addition, Adobe Sign will append a documentKey parameter to the URL which will contain the Adobe Sign DocumentKey for this signed web form, but only if the sender is the same as the API key user. Your application can use this value to get the form data for this web form | [optional] diff --git a/docs/WidgetStateInfo.md b/docs/WidgetStateInfo.md index 20ec940..c5c1cad 100755 --- a/docs/WidgetStateInfo.md +++ b/docs/WidgetStateInfo.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**state** | [**StateEnum**](#StateEnum) | State of the Widget | [optional] -**widgetInActiveInfo** | [**WidgetInActiveInfo**](WidgetInActiveInfo.md) | The custom message which will be displayed to the user or the URL to which user will be redirected when the widget is accessed in a disabled state. This can only be specified in PUT request | [optional] +**widgetInActiveInfo** | [**WidgetInActiveInfo**](WidgetInActiveInfo.md) | The custom message which will be displayed to the user or the URL to which user will be redirected when the web form is accessed in a disabled state. This can only be specified in PUT request | [optional] +**state** | [**StateEnum**](#StateEnum) | State of the Web Form | [optional] diff --git a/docs/WidgetView.md b/docs/WidgetView.md index 7f9c2ce..26ced9b 100755 --- a/docs/WidgetView.md +++ b/docs/WidgetView.md @@ -4,10 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**isCurrent** | **Boolean** | True if this view is the current view | [optional] **embeddedCode** | **String** | Embedded code of url of resource | [optional] +**name** | [**NameEnum**](#NameEnum) | Name of the requested web form view | [optional] **expiration** | [**Date**](Date.md) | Expiration of user url | [optional] -**isCurrent** | **Boolean** | True if this view is the current view | [optional] -**name** | [**NameEnum**](#NameEnum) | Name of the requested widget view | [optional] **url** | **String** | Url of resource location | [optional] diff --git a/docs/WidgetViewInfo.md b/docs/WidgetViewInfo.md index 312a20f..61a9282 100755 --- a/docs/WidgetViewInfo.md +++ b/docs/WidgetViewInfo.md @@ -5,7 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **commonViewConfiguration** | [**CommonViewConfiguration**](CommonViewConfiguration.md) | Common view configuration for all the available views | [optional] -**name** | [**NameEnum**](#NameEnum) | Name of the requested widget view | [optional] +**name** | [**NameEnum**](#NameEnum) | Name of the requested web form view | [optional] +**personalizedSigningViewConfiguration** | [**PersonalizedSigningViewConfiguration**](PersonalizedSigningViewConfiguration.md) | Personalized SIGNING view configuration | [optional] diff --git a/docs/WidgetViews.md b/docs/WidgetViews.md index c722e9f..46d3b59 100755 --- a/docs/WidgetViews.md +++ b/docs/WidgetViews.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**widgetViewList** | [**List<WidgetView>**](WidgetView.md) | List of widget views | [optional] +**widgetViewList** | [**List<WidgetView>**](WidgetView.md) | List of web form views | [optional] diff --git a/docs/WidgetsApi.md b/docs/WidgetsApi.md index 01d7a4e..56e5394 100755 --- a/docs/WidgetsApi.md +++ b/docs/WidgetsApi.md @@ -1,38 +1,40 @@ # WidgetsApi -All URIs are relative to *http://localhost/api/rest/v6* +All URIs are relative to *https://secure.au1.echosign.com/api/rest/v6* Method | HTTP request | Description ------------- | ------------- | ------------- -[**createShareOnWidget**](WidgetsApi.md#createShareOnWidget) | **POST** /widgets/{widgetId}/members/share | Share a widget with someone. -[**createWidget**](WidgetsApi.md#createWidget) | **POST** /widgets | Creates a widget and and returns the widgetId in the response to the client. +[**createShareOnWidget**](WidgetsApi.md#createShareOnWidget) | **POST** /widgets/{widgetId}/members/share | Share a web form with someone. +[**createWidget**](WidgetsApi.md#createWidget) | **POST** /widgets | Creates a web form and and returns the widgetId in the response to the client. [**getAllWidgetMembers**](WidgetsApi.md#getAllWidgetMembers) | **GET** /widgets/{widgetId}/members | Retrieves detailed member info along with IDs for different types of participants. -[**getEvents**](WidgetsApi.md#getEvents) | **GET** /widgets/{widgetId}/events | Retrieves the events information for a widget. -[**getParticipantSet**](WidgetsApi.md#getParticipantSet) | **GET** /widgets/{widgetId}/members/participantSets/{participantSetId} | Retrieves the participant set of a widget identified by widgetId in the path. -[**getWidgetAgreements**](WidgetsApi.md#getWidgetAgreements) | **GET** /widgets/{widgetId}/agreements | Retrieves agreements for the widget. -[**getWidgetAllDocumentsImageUrls**](WidgetsApi.md#getWidgetAllDocumentsImageUrls) | **GET** /widgets/{widgetId}/documents/imageUrls | Retrieves image urls of all visible pages of a document associated with a widget. -[**getWidgetAuditTrail**](WidgetsApi.md#getWidgetAuditTrail) | **GET** /widgets/{widgetId}/auditTrail | Retrieves the audit trail of a widget identified by widgetId. -[**getWidgetCombinedDocument**](WidgetsApi.md#getWidgetCombinedDocument) | **GET** /widgets/{widgetId}/combinedDocument | Retrieves a single combined PDF document for the documents associated with a widget. -[**getWidgetDocumentInfo**](WidgetsApi.md#getWidgetDocumentInfo) | **GET** /widgets/{widgetId}/documents/{documentId} | Retrieves the file stream of a document of a widget. -[**getWidgetDocuments**](WidgetsApi.md#getWidgetDocuments) | **GET** /widgets/{widgetId}/documents | Retrieves the IDs of the documents associated with widget. -[**getWidgetFormData**](WidgetsApi.md#getWidgetFormData) | **GET** /widgets/{widgetId}/formData | Retrieves data entered by the user into interactive form fields at the time they signed the widget -[**getWidgetInfo**](WidgetsApi.md#getWidgetInfo) | **GET** /widgets/{widgetId} | Retrieves the details of a widget. -[**getWidgetNoteForApiUser**](WidgetsApi.md#getWidgetNoteForApiUser) | **GET** /widgets/{widgetId}/me/note | Retrieves the latest note of a widget for the API user. +[**getEvents**](WidgetsApi.md#getEvents) | **GET** /widgets/{widgetId}/events | Retrieves the events information for a web form. +[**getParticipantSet**](WidgetsApi.md#getParticipantSet) | **GET** /widgets/{widgetId}/members/participantSets/{participantSetId} | Retrieves the participant set of a web form identified by widgetId in the path. +[**getWidgetAgreements**](WidgetsApi.md#getWidgetAgreements) | **GET** /widgets/{widgetId}/agreements | Retrieves agreements for the web form. +[**getWidgetAllDocumentsImageUrls**](WidgetsApi.md#getWidgetAllDocumentsImageUrls) | **GET** /widgets/{widgetId}/documents/imageUrls | Retrieves image urls of all visible pages of a document associated with a web form. +[**getWidgetAuditTrail**](WidgetsApi.md#getWidgetAuditTrail) | **GET** /widgets/{widgetId}/auditTrail | Retrieves the audit trail of a web form identified by widgetId. +[**getWidgetCombinedDocument**](WidgetsApi.md#getWidgetCombinedDocument) | **GET** /widgets/{widgetId}/combinedDocument | Retrieves a single combined PDF document for the documents associated with a web form. +[**getWidgetCombinedDocumentUrl**](WidgetsApi.md#getWidgetCombinedDocumentUrl) | **GET** /widgets/{widgetId}/combinedDocument/url | Retrieves url of all visible pages of all the documents associated with a web form. +[**getWidgetDocumentInfo**](WidgetsApi.md#getWidgetDocumentInfo) | **GET** /widgets/{widgetId}/documents/{documentId} | Retrieves the file stream of a document of a web form. +[**getWidgetDocuments**](WidgetsApi.md#getWidgetDocuments) | **GET** /widgets/{widgetId}/documents | Retrieves the IDs of the documents associated with web form. +[**getWidgetFormData**](WidgetsApi.md#getWidgetFormData) | **GET** /widgets/{widgetId}/formData | Retrieves data entered by the user into interactive form fields at the time they signed the web form +[**getWidgetInfo**](WidgetsApi.md#getWidgetInfo) | **GET** /widgets/{widgetId} | Retrieves the details of a web form. +[**getWidgetInfoForUser**](WidgetsApi.md#getWidgetInfoForUser) | **GET** /widgets/{widgetId}/me | Retrieves the web form information related to the api caller +[**getWidgetNoteForApiUser**](WidgetsApi.md#getWidgetNoteForApiUser) | **GET** /widgets/{widgetId}/me/note | Retrieves the latest note of a web form for the API user. [**getWidgetSecurityOptionsForParticipation**](WidgetsApi.md#getWidgetSecurityOptionsForParticipation) | **GET** /widgets/{widgetId}/members/participantSets/{participantSetId}/participants/{participantId}/securityOptions | Retrieves the security options for a particular participant. -[**getWidgetView**](WidgetsApi.md#getWidgetView) | **POST** /widgets/{widgetId}/views | Retrieves the requested views for a widget. -[**getWidgets**](WidgetsApi.md#getWidgets) | **GET** /widgets | Retrieves widgets for a user. -[**updateWidget**](WidgetsApi.md#updateWidget) | **PUT** /widgets/{widgetId} | Updates a widget. -[**updateWidgetNoteForApiUser**](WidgetsApi.md#updateWidgetNoteForApiUser) | **PUT** /widgets/{widgetId}/me/note | Updates the latest note of a widget for the API user. +[**getWidgetView**](WidgetsApi.md#getWidgetView) | **POST** /widgets/{widgetId}/views | Retrieves the requested views for a web form. +[**getWidgets**](WidgetsApi.md#getWidgets) | **GET** /widgets | Retrieves web forms for a user. +[**updateWidget**](WidgetsApi.md#updateWidget) | **PUT** /widgets/{widgetId} | Updates a web form. +[**updateWidgetNoteForApiUser**](WidgetsApi.md#updateWidgetNoteForApiUser) | **PUT** /widgets/{widgetId}/me/note | Updates the latest note of a web form for the API user. [**updateWidgetSecurityOptionsForParticipation**](WidgetsApi.md#updateWidgetSecurityOptionsForParticipation) | **PUT** /widgets/{widgetId}/members/participantSets/{participantSetId}/participants/{participantId}/securityOptions | Updates the security options for a particular participant. -[**updateWidgetState**](WidgetsApi.md#updateWidgetState) | **PUT** /widgets/{widgetId}/state | Updates the state of a widget identified by widgetId in the path. -[**updateWidgetVisibility**](WidgetsApi.md#updateWidgetVisibility) | **PUT** /widgets/{widgetId}/me/visibility | Updates the visibility of widget. +[**updateWidgetState**](WidgetsApi.md#updateWidgetState) | **PUT** /widgets/{widgetId}/state | Updates the state of a web form identified by widgetId in the path. +[**updateWidgetVisibility**](WidgetsApi.md#updateWidgetVisibility) | **PUT** /widgets/{widgetId}/me/visibility | Updates the visibility of web form. # **createShareOnWidget** > ShareCreationResponseList createShareOnWidget(authorization, widgetId, shareCreationInfoList, xApiUser, xOnBehalfOfUser) -Share a widget with someone. +Share a web form with someone. ### Example ```java @@ -43,7 +45,7 @@ Share a widget with someone. WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. ShareCreationInfoList shareCreationInfoList = new ShareCreationInfoList(); // ShareCreationInfoList | List of agreement share creation information objects. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account @@ -61,7 +63,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | **shareCreationInfoList** | [**ShareCreationInfoList**](ShareCreationInfoList.md)| List of agreement share creation information objects. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] @@ -83,9 +85,9 @@ No authorization required # **createWidget** > WidgetCreationResponse createWidget(authorization, widgetInfo, xApiUser, xOnBehalfOfUser) -Creates a widget and and returns the widgetId in the response to the client. +Creates a web form and and returns the widgetId in the response to the client. -This is a primary endpoint which is used to create a new widget. You can create a widget in one of the 3 mentioned states: a) <b>DRAFT</b> - to incrementally build the widget, b) <b>AUTHORING</b> - to add/edit form fields in the widget, c) <b>ACTIVE</b> - to immediately host the widget. You can use the PUT /widgets/{widgetId}/state endpoint to transition a widget between the above mentioned states. An allowed transition would follow the any of the following sequences: DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. +This is a primary endpoint which is used to create a new web form. You can create a web form in one of the 3 mentioned states: a) <b>DRAFT</b> - to incrementally build the web form, b) <b>AUTHORING</b> - to add/edit form fields in the web form, c) <b>ACTIVE</b> - to immediately host the web form. You can use the PUT /widgets/{widgetId}/state endpoint to transition a web form between the above mentioned states. An allowed transition would follow the any of the following sequences: DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. ### Example ```java @@ -96,7 +98,7 @@ This is a primary endpoint which is used to create a new widget. You can create WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -WidgetCreationInfoV6 widgetInfo = new WidgetCreationInfoV6(); // WidgetCreationInfoV6 | Information about the widget that you want to create. +WidgetCreationInfoV6 widgetInfo = new WidgetCreationInfoV6(); // WidgetCreationInfoV6 | Information about the web form that you want to create. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account try { @@ -113,7 +115,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetInfo** | [**WidgetCreationInfoV6**](WidgetCreationInfoV6.md)| Information about the widget that you want to create. | + **widgetInfo** | [**WidgetCreationInfoV6**](WidgetCreationInfoV6.md)| Information about the web form that you want to create. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] @@ -145,7 +147,7 @@ Retrieves detailed member info along with IDs for different types of participant WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. @@ -163,7 +165,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] @@ -185,7 +187,7 @@ No authorization required # **getEvents** > WidgetEventList getEvents(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch) -Retrieves the events information for a widget. +Retrieves the events information for a web form. ### Example ```java @@ -196,7 +198,7 @@ Retrieves the events information for a widget. WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. @@ -214,7 +216,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] @@ -236,7 +238,7 @@ No authorization required # **getParticipantSet** > DetailedWidgetParticipantSetInfo getParticipantSet(authorization, widgetId, participantSetId, xApiUser, xOnBehalfOfUser, ifNoneMatch) -Retrieves the participant set of a widget identified by widgetId in the path. +Retrieves the participant set of a web form identified by widgetId in the path. ### Example ```java @@ -247,7 +249,7 @@ Retrieves the participant set of a widget identified by widgetId in the path. WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. String participantSetId = "participantSetId_example"; // String | The participant set identifier String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account @@ -266,7 +268,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | **participantSetId** | **String**| The participant set identifier | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] @@ -289,7 +291,7 @@ No authorization required # **getWidgetAgreements** > WidgetAgreements getWidgetAgreements(authorization, widgetId, xApiUser, xOnBehalfOfUser, showHiddenAgreements, cursor, pageSize) -Retrieves agreements for the widget. +Retrieves agreements for the web form. ### Example ```java @@ -300,7 +302,7 @@ Retrieves agreements for the widget. WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account Boolean showHiddenAgreements = true; // Boolean | A query parameter to fetch all the hidden agreements along with the visible agreements. Default value is false. @@ -320,7 +322,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] **showHiddenAgreements** | **Boolean**| A query parameter to fetch all the hidden agreements along with the visible agreements. Default value is false. | [optional] @@ -342,9 +344,9 @@ No authorization required # **getWidgetAllDocumentsImageUrls** -> WidgetDocumentsImageUrlsInfo getWidgetAllDocumentsImageUrls(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch, imageSizes, showImageAvailabilityOnly) +> BasicDocumentsImageUrlsInfo getWidgetAllDocumentsImageUrls(authorization, widgetId, xApiUser, xOnBehalfOfUser, imageSizes, showImageAvailabilityOnly) -Retrieves image urls of all visible pages of a document associated with a widget. +Retrieves image urls of all visible pages of a document associated with a web form. ### Example ```java @@ -355,14 +357,13 @@ Retrieves image urls of all visible pages of a document associated with a widget WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account -String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. String imageSizes = "imageSizes_example"; // String | A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. Boolean showImageAvailabilityOnly = true; // Boolean | When set to true, returns only image availability. Else, returns both image urls and its availability. try { - WidgetDocumentsImageUrlsInfo result = apiInstance.getWidgetAllDocumentsImageUrls(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch, imageSizes, showImageAvailabilityOnly); + BasicDocumentsImageUrlsInfo result = apiInstance.getWidgetAllDocumentsImageUrls(authorization, widgetId, xApiUser, xOnBehalfOfUser, imageSizes, showImageAvailabilityOnly); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling WidgetsApi#getWidgetAllDocumentsImageUrls"); @@ -375,16 +376,15 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] - **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] **imageSizes** | **String**| A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. | [optional] **showImageAvailabilityOnly** | **Boolean**| When set to true, returns only image availability. Else, returns both image urls and its availability. | [optional] ### Return type -[**WidgetDocumentsImageUrlsInfo**](WidgetDocumentsImageUrlsInfo.md) +[**BasicDocumentsImageUrlsInfo**](BasicDocumentsImageUrlsInfo.md) ### Authorization @@ -399,7 +399,7 @@ No authorization required # **getWidgetAuditTrail** > byte[] getWidgetAuditTrail(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch) -Retrieves the audit trail of a widget identified by widgetId. +Retrieves the audit trail of a web form identified by widgetId. ### Example ```java @@ -410,7 +410,7 @@ Retrieves the audit trail of a widget identified by widgetId. WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. @@ -428,7 +428,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] @@ -450,7 +450,7 @@ No authorization required # **getWidgetCombinedDocument** > byte[] getWidgetCombinedDocument(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch, versionId, participantId, attachAuditReport) -Retrieves a single combined PDF document for the documents associated with a widget. +Retrieves a single combined PDF document for the documents associated with a web form. ### Example ```java @@ -461,13 +461,13 @@ Retrieves a single combined PDF document for the documents associated with a wid WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. -String versionId = "versionId_example"; // String | The version identifier of widget as provided by the API which retrieves information of a specific widget. If not provided then latest version will be used. +String versionId = "versionId_example"; // String | The version identifier of web form as provided by the API which retrieves information of a specific web form. If not provided then latest version will be used. String participantId = "participantId_example"; // String | The ID of the participant to be used to retrieve documents. If not mentioned, the participation of api caller is used. -Boolean attachAuditReport = true; // Boolean | When set to YES, attach an audit report to the signed Widget PDF. Default value is false +Boolean attachAuditReport = true; // Boolean | When set to YES, attach an audit report to the signed Web Form PDF. Default value is false try { byte[] result = apiInstance.getWidgetCombinedDocument(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch, versionId, participantId, attachAuditReport); System.out.println(result); @@ -482,13 +482,13 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] - **versionId** | **String**| The version identifier of widget as provided by the API which retrieves information of a specific widget. If not provided then latest version will be used. | [optional] + **versionId** | **String**| The version identifier of web form as provided by the API which retrieves information of a specific web form. If not provided then latest version will be used. | [optional] **participantId** | **String**| The ID of the participant to be used to retrieve documents. If not mentioned, the participation of api caller is used. | [optional] - **attachAuditReport** | **Boolean**| When set to YES, attach an audit report to the signed Widget PDF. Default value is false | [optional] + **attachAuditReport** | **Boolean**| When set to YES, attach an audit report to the signed Web Form PDF. Default value is false | [optional] ### Return type @@ -503,11 +503,62 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/pdf, application/pdf;encoding=base64 + +# **getWidgetCombinedDocumentUrl** +> DocumentUrl getWidgetCombinedDocumentUrl(authorization, widgetId, xApiUser, xOnBehalfOfUser, attachAuditReport) + +Retrieves url of all visible pages of all the documents associated with a web form. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.WidgetsApi; + + +WidgetsApi apiInstance = new WidgetsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +Boolean attachAuditReport = true; // Boolean | When set to true, attach an audit report to the web form PDF. The default value is false. +try { + DocumentUrl result = apiInstance.getWidgetCombinedDocumentUrl(authorization, widgetId, xApiUser, xOnBehalfOfUser, attachAuditReport); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling WidgetsApi#getWidgetCombinedDocumentUrl"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **attachAuditReport** | **Boolean**| When set to true, attach an audit report to the web form PDF. The default value is false. | [optional] + +### Return type + +[**DocumentUrl**](DocumentUrl.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + # **getWidgetDocumentInfo** > byte[] getWidgetDocumentInfo(authorization, widgetId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch) -Retrieves the file stream of a document of a widget. +Retrieves the file stream of a document of a web form. ### Example ```java @@ -518,8 +569,8 @@ Retrieves the file stream of a document of a widget. WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. -String documentId = "documentId_example"; // String | The document identifier, as retrieved from the API which fetches the documents of a specified widget +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. +String documentId = "documentId_example"; // String | The document identifier, as retrieved from the API which fetches the documents of a specified web form String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. @@ -537,8 +588,8 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | - **documentId** | **String**| The document identifier, as retrieved from the API which fetches the documents of a specified widget | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | + **documentId** | **String**| The document identifier, as retrieved from the API which fetches the documents of a specified web form | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] @@ -560,7 +611,7 @@ No authorization required # **getWidgetDocuments** > WidgetDocuments getWidgetDocuments(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch, versionId, participantId) -Retrieves the IDs of the documents associated with widget. +Retrieves the IDs of the documents associated with web form. ### Example ```java @@ -571,11 +622,11 @@ Retrieves the IDs of the documents associated with widget. WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. -String versionId = "versionId_example"; // String | The version identifier of widget as provided by the API which retrieves information of a specific widget. If not provided then latest version will be used. +String versionId = "versionId_example"; // String | The version identifier of web form as provided by the API which retrieves information of a specific web form. If not provided then latest version will be used. String participantId = "participantId_example"; // String | The ID of the participant to be used to retrieve documents. If not mentioned, the participation of api caller is used. try { WidgetDocuments result = apiInstance.getWidgetDocuments(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch, versionId, participantId); @@ -591,11 +642,11 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] - **versionId** | **String**| The version identifier of widget as provided by the API which retrieves information of a specific widget. If not provided then latest version will be used. | [optional] + **versionId** | **String**| The version identifier of web form as provided by the API which retrieves information of a specific web form. If not provided then latest version will be used. | [optional] **participantId** | **String**| The ID of the participant to be used to retrieve documents. If not mentioned, the participation of api caller is used. | [optional] ### Return type @@ -615,7 +666,7 @@ No authorization required # **getWidgetFormData** > byte[] getWidgetFormData(authorization, widgetId, xApiUser, xOnBehalfOfUser) -Retrieves data entered by the user into interactive form fields at the time they signed the widget +Retrieves data entered by the user into interactive form fields at the time they signed the web form CSV file stream containing form data information @@ -628,7 +679,7 @@ CSV file stream containing form data information WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account try { @@ -645,7 +696,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] @@ -664,9 +715,9 @@ No authorization required # **getWidgetInfo** -> WidgetCreationInfoV6 getWidgetInfo(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch) +> FetchedWidgetInfo getWidgetInfo(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch) -Retrieves the details of a widget. +Retrieves the details of a web form. ### Example ```java @@ -677,12 +728,12 @@ Retrieves the details of a widget. WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. try { - WidgetCreationInfoV6 result = apiInstance.getWidgetInfo(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + FetchedWidgetInfo result = apiInstance.getWidgetInfo(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling WidgetsApi#getWidgetInfo"); @@ -695,14 +746,61 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] ### Return type -[**WidgetCreationInfoV6**](WidgetCreationInfoV6.md) +[**FetchedWidgetInfo**](FetchedWidgetInfo.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +# **getWidgetInfoForUser** +> MyAgreementInfo getWidgetInfoForUser(authorization, widgetId, xApiUser) + +Retrieves the web form information related to the api caller + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.WidgetsApi; + + +WidgetsApi apiInstance = new WidgetsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +try { + MyAgreementInfo result = apiInstance.getWidgetInfoForUser(authorization, widgetId, xApiUser); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling WidgetsApi#getWidgetInfoForUser"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + +### Return type + +[**MyAgreementInfo**](MyAgreementInfo.md) ### Authorization @@ -717,7 +815,7 @@ No authorization required # **getWidgetNoteForApiUser** > Note getWidgetNoteForApiUser(authorization, widgetId, xApiUser, xOnBehalfOfUser) -Retrieves the latest note of a widget for the API user. +Retrieves the latest note of a web form for the API user. ### Example ```java @@ -728,7 +826,7 @@ Retrieves the latest note of a widget for the API user. WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account try { @@ -745,7 +843,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] @@ -764,7 +862,7 @@ No authorization required # **getWidgetSecurityOptionsForParticipation** -> ParticipantSecurityOption getWidgetSecurityOptionsForParticipation(authorization, widgetId, participantSetId, participantId, ifNoneMatch, xApiUser) +> ParticipantSecurityOption getWidgetSecurityOptionsForParticipation(authorization, widgetId, participantSetId, participantId, ifNoneMatch, xApiUser, xOnBehalfOfUser) Retrieves the security options for a particular participant. @@ -777,13 +875,14 @@ Retrieves the security options for a particular participant. WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. String participantSetId = "participantSetId_example"; // String | The participant set identifier String participantId = "participantId_example"; // String | The participant identifier String ifNoneMatch = "ifNoneMatch_example"; // String | Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account try { - ParticipantSecurityOption result = apiInstance.getWidgetSecurityOptionsForParticipation(authorization, widgetId, participantSetId, participantId, ifNoneMatch, xApiUser); + ParticipantSecurityOption result = apiInstance.getWidgetSecurityOptionsForParticipation(authorization, widgetId, participantSetId, participantId, ifNoneMatch, xApiUser, xOnBehalfOfUser); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling WidgetsApi#getWidgetSecurityOptionsForParticipation"); @@ -796,11 +895,12 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | **participantSetId** | **String**| The participant set identifier | **participantId** | **String**| The participant identifier | **ifNoneMatch** | **String**| Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. | [optional] **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] ### Return type @@ -819,7 +919,7 @@ No authorization required # **getWidgetView** > WidgetViews getWidgetView(authorization, widgetId, widgetViewInfo, xApiUser, xOnBehalfOfUser) -Retrieves the requested views for a widget. +Retrieves the requested views for a web form. ### Example ```java @@ -829,8 +929,8 @@ Retrieves the requested views for a widget. WidgetsApi apiInstance = new WidgetsApi(); -String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:
  • widget_read - widget read is always required
  • user_login - Required additionally if the autoLoginUser parameter is set to true
in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:
  • widget_read - web form read is always required
  • user_login - Required additionally if the autoLoginUser parameter is set to true
in the format 'Bearer {accessToken}'. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. WidgetViewInfo widgetViewInfo = new WidgetViewInfo(); // WidgetViewInfo | Name of the required view and its desired configuration. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account @@ -847,8 +947,8 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a> - widget read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a> - web form read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | **widgetViewInfo** | [**WidgetViewInfo**](WidgetViewInfo.md)| Name of the required view and its desired configuration. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] @@ -868,9 +968,9 @@ No authorization required # **getWidgets** -> UserWidgets getWidgets(authorization, xApiUser, xOnBehalfOfUser, showHiddenWidgets, cursor, pageSize) +> UserWidgets getWidgets(authorization, xApiUser, xOnBehalfOfUser, groupId, showHiddenWidgets, cursor, pageSize) -Retrieves widgets for a user. +Retrieves web forms for a user. ### Example ```java @@ -883,11 +983,12 @@ WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account -Boolean showHiddenWidgets = true; // Boolean | A query parameter to fetch all the hidden widgets along with the visible widgets. Default value is false. +String groupId = "groupId_example"; // String | The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. +Boolean showHiddenWidgets = true; // Boolean | A query parameter to fetch all the hidden web forms along with the visible web forms. Default value is false. String cursor = "cursor_example"; // String | Used to navigate through the pages. If not provided, returns the first page. Integer pageSize = 56; // Integer | Number of intended items in the response page. If not provided, it is decided by the application settings. try { - UserWidgets result = apiInstance.getWidgets(authorization, xApiUser, xOnBehalfOfUser, showHiddenWidgets, cursor, pageSize); + UserWidgets result = apiInstance.getWidgets(authorization, xApiUser, xOnBehalfOfUser, groupId, showHiddenWidgets, cursor, pageSize); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling WidgetsApi#getWidgets"); @@ -902,7 +1003,8 @@ Name | Type | Description | Notes **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] - **showHiddenWidgets** | **Boolean**| A query parameter to fetch all the hidden widgets along with the visible widgets. Default value is false. | [optional] + **groupId** | **String**| The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. | [optional] + **showHiddenWidgets** | **Boolean**| A query parameter to fetch all the hidden web forms along with the visible web forms. Default value is false. | [optional] **cursor** | **String**| Used to navigate through the pages. If not provided, returns the first page. | [optional] **pageSize** | **Integer**| Number of intended items in the response page. If not provided, it is decided by the application settings. | [optional] @@ -921,9 +1023,9 @@ No authorization required # **updateWidget** -> updateWidget(authorization, ifMatch, widgetId, widgetInfo, xApiUser, xOnBehalfOfUser) +> updateWidget(authorization, widgetId, widgetInfo, xApiUser, xOnBehalfOfUser, ifMatch) -Updates a widget. +Updates a web form. ### Example ```java @@ -934,13 +1036,13 @@ Updates a widget. WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. -WidgetInfo widgetInfo = new WidgetInfo(); // WidgetInfo | Widget update information object. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. +WidgetInfo widgetInfo = new WidgetInfo(); // WidgetInfo | Web Form update information object. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. try { - apiInstance.updateWidget(authorization, ifMatch, widgetId, widgetInfo, xApiUser, xOnBehalfOfUser); + apiInstance.updateWidget(authorization, widgetId, widgetInfo, xApiUser, xOnBehalfOfUser, ifMatch); } catch (ApiException e) { System.err.println("Exception when calling WidgetsApi#updateWidget"); e.printStackTrace(); @@ -952,11 +1054,11 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | - **widgetInfo** | [**WidgetInfo**](WidgetInfo.md)| Widget update information object. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | + **widgetInfo** | [**WidgetInfo**](WidgetInfo.md)| Web Form update information object. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] ### Return type @@ -975,7 +1077,7 @@ No authorization required # **updateWidgetNoteForApiUser** > updateWidgetNoteForApiUser(authorization, widgetId, note, xApiUser, xOnBehalfOfUser) -Updates the latest note of a widget for the API user. +Updates the latest note of a web form for the API user. ### Example ```java @@ -986,8 +1088,8 @@ Updates the latest note of a widget for the API user. WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. -Note note = new Note(); // Note | The note to be associated with the widget. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. +Note note = new Note(); // Note | The note to be associated with the web form. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account try { @@ -1003,8 +1105,8 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | - **note** | [**Note**](Note.md)| The note to be associated with the widget. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | + **note** | [**Note**](Note.md)| The note to be associated with the web form. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] @@ -1023,7 +1125,7 @@ No authorization required # **updateWidgetSecurityOptionsForParticipation** -> updateWidgetSecurityOptionsForParticipation(authorization, ifMatch, widgetId, participantSetId, participantId, participantSecurityOption, xApiUser) +> updateWidgetSecurityOptionsForParticipation(authorization, widgetId, participantSetId, participantId, participantSecurityOption, ifMatch, xApiUser, xOnBehalfOfUser) Updates the security options for a particular participant. @@ -1036,14 +1138,15 @@ Updates the security options for a particular participant. WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. String participantSetId = "participantSetId_example"; // String | The participant set identifier String participantId = "participantId_example"; // String | The participant identifier ParticipantSecurityOption participantSecurityOption = new ParticipantSecurityOption(); // ParticipantSecurityOption | Security options that apply to the participant +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account try { - apiInstance.updateWidgetSecurityOptionsForParticipation(authorization, ifMatch, widgetId, participantSetId, participantId, participantSecurityOption, xApiUser); + apiInstance.updateWidgetSecurityOptionsForParticipation(authorization, widgetId, participantSetId, participantId, participantSecurityOption, ifMatch, xApiUser, xOnBehalfOfUser); } catch (ApiException e) { System.err.println("Exception when calling WidgetsApi#updateWidgetSecurityOptionsForParticipation"); e.printStackTrace(); @@ -1055,12 +1158,13 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | **participantSetId** | **String**| The participant set identifier | **participantId** | **String**| The participant identifier | **participantSecurityOption** | [**ParticipantSecurityOption**](ParticipantSecurityOption.md)| Security options that apply to the participant | + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] ### Return type @@ -1077,11 +1181,11 @@ No authorization required # **updateWidgetState** -> updateWidgetState(authorization, ifMatch, widgetId, widgetStateInfo, xApiUser, xOnBehalfOfUser) +> updateWidgetState(authorization, widgetId, widgetStateInfo, xApiUser, xOnBehalfOfUser, ifMatch) -Updates the state of a widget identified by widgetId in the path. +Updates the state of a web form identified by widgetId in the path. -This endpoint can be used by creator of the widget to transition between the states of widget. An allowed transition would follow any of the following sequence : DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. +This endpoint can be used by creator of the web form to transition between the states of web form. An allowed transition would follow any of the following sequence : DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. ### Example ```java @@ -1092,13 +1196,13 @@ This endpoint can be used by creator of the widget to transition between the sta WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. WidgetStateInfo widgetStateInfo = new WidgetStateInfo(); // WidgetStateInfo | String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String ifMatch = "ifMatch_example"; // String | The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. try { - apiInstance.updateWidgetState(authorization, ifMatch, widgetId, widgetStateInfo, xApiUser, xOnBehalfOfUser); + apiInstance.updateWidgetState(authorization, widgetId, widgetStateInfo, xApiUser, xOnBehalfOfUser, ifMatch); } catch (ApiException e) { System.err.println("Exception when calling WidgetsApi#updateWidgetState"); e.printStackTrace(); @@ -1110,11 +1214,11 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | **widgetStateInfo** | [**WidgetStateInfo**](WidgetStateInfo.md)| | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **ifMatch** | **String**| The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. | [optional] ### Return type @@ -1133,7 +1237,7 @@ No authorization required # **updateWidgetVisibility** > updateWidgetVisibility(authorization, widgetId, visibilityInfo, xApiUser, xOnBehalfOfUser) -Updates the visibility of widget. +Updates the visibility of web form. ### Example ```java @@ -1144,8 +1248,8 @@ Updates the visibility of widget. WidgetsApi apiInstance = new WidgetsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. -String widgetId = "widgetId_example"; // String | The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. -VisibilityInfo visibilityInfo = new VisibilityInfo(); // VisibilityInfo | Information to update visibility of widget +String widgetId = "widgetId_example"; // String | The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. +VisibilityInfo visibilityInfo = new VisibilityInfo(); // VisibilityInfo | Information to update visibility of web form String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account try { @@ -1161,8 +1265,8 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. | - **widgetId** | **String**| The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. | - **visibilityInfo** | [**VisibilityInfo**](VisibilityInfo.md)| Information to update visibility of widget | + **widgetId** | **String**| The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. | + **visibilityInfo** | [**VisibilityInfo**](VisibilityInfo.md)| Information to update visibility of web form | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] diff --git a/docs/WorkflowDefaultParams.md b/docs/WorkflowDefaultParams.md new file mode 100644 index 0000000..37f6947 --- /dev/null +++ b/docs/WorkflowDefaultParams.md @@ -0,0 +1,13 @@ + +# WorkflowDefaultParams + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**visible** | **Boolean** | Whether current field is visible or not. If visible attribute for this field is false then this field should not be visible in the agreement creation UI using this workflow to user | [optional] +**defaultValue** | **String** | default value of the field if input for this field is not provided and this field is required | [optional] +**editable** | **Boolean** | Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation | [optional] +**required** | **Boolean** | Whether this field is required or optional | [optional] + + + diff --git a/docs/WorkflowDescription.md b/docs/WorkflowDescription.md new file mode 100644 index 0000000..3221e8a --- /dev/null +++ b/docs/WorkflowDescription.md @@ -0,0 +1,44 @@ + +# WorkflowDescription + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scopeId** | **String** | Identifier of scope. Currently it is applicable for scope GROUP only and the value will be groupId. | [optional] +**messageInfo** | [**WorkflowDefaultParams**](WorkflowDefaultParams.md) | Information about message field in DocumentCreationInfo input field in the agreement creation request when using the API which creates an agreement in a workflow | [optional] +**created** | [**Date**](Date.md) | The day on which the workflow was created | [optional] +**displayName** | **String** | The display name of the workflow. | [optional] +**description** | **String** | Description provided for this workflow at the time of its creation | [optional] +**mergeFieldsInfo** | [**List<MergeFieldInfoDescription>**](MergeFieldInfoDescription.md) | Information about customFieldInfos in DocumentCreationInfo input field in the agreement creation request when using the API which creates an agreement in a workflow | [optional] +**agreementNameInfo** | [**WorkflowDefaultParams**](WorkflowDefaultParams.md) | Information about name field in DocumentCreationInfo input field in the agreement creation request when using the API which creates an agreement in a workflow | [optional] +**passwordInfo** | [**PasswordFieldInfoDescription**](PasswordFieldInfoDescription.md) | Information about openPassword field in SecurityOptions input field in the agreement creation request when using the API which creates an agreement in a workflow | [optional] +**authoringInfo** | [**WorkflowDefaultParams**](WorkflowDefaultParams.md) | Information about authoringRequested field in SendDocumentInteractiveOptions input field in the agreement creation request when using the API which creates an agreement in a workflow | [optional] +**recipientsListInfo** | [**List<RecipientsListInfoDescription>**](RecipientsListInfoDescription.md) | Information about RecepientsInfo input field in the agreement creation request when using the API which creates an agreement in a workflow | [optional] +**scope** | [**ScopeEnum**](#ScopeEnum) | The workflow scope (ACCOUNT or GROUP or OTHER) | [optional] +**expirationInfo** | [**ExpirationFieldInfoDescription**](ExpirationFieldInfoDescription.md) | Information about daysUntilSigningDeadline field in DocumentCreationInfo input field in the agreement creation request when using the API which creates an agreement in a workflow | [optional] +**name** | **String** | The name of the workflow. | [optional] +**modified** | [**Date**](Date.md) | The day on which the workflow was last modified | [optional] +**fileInfos** | [**List<FileInfosDescription>**](FileInfosDescription.md) | Information about FileInfo input field in the agreement creation request when using the API which creates an agreement in a workflow | [optional] +**localeInfo** | [**LocaleFieldInfoDescription**](LocaleFieldInfoDescription.md) | Information about locale field in DocumentCreationInfo input field in the agreement creation request when using the API which creates an agreement in a workflow | [optional] +**ccsListInfo** | [**List<CCsListInfoDescription>**](CCsListInfoDescription.md) | Information about CCList input field in the agreement creation request when using the API which creates an agreement in a workflow | [optional] +**status** | [**StatusEnum**](#StatusEnum) | The workflow status (ACTIVE or DRAFT or INACTIVE or OTHER) | [optional] + + + +## Enum: ScopeEnum +Name | Value +---- | ----- +ACCOUNT | "ACCOUNT" +GROUP | "GROUP" + + + +## Enum: StatusEnum +Name | Value +---- | ----- +ACTIVE | "ACTIVE" +DRAFT | "DRAFT" +HIDDEN | "HIDDEN" + + + diff --git a/docs/WorkflowLibraryDocument.md b/docs/WorkflowLibraryDocument.md new file mode 100644 index 0000000..c47ecdb --- /dev/null +++ b/docs/WorkflowLibraryDocument.md @@ -0,0 +1,32 @@ + +# WorkflowLibraryDocument + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**templateTypes** | [**List<TemplateTypesEnum>**](#List<TemplateTypesEnum>) | A list of one or more library template types | [optional] +**sharingMode** | [**SharingModeEnum**](#SharingModeEnum) | Specifies who should have access to this library document. GLOBAL sharing is a restricted operation. | [optional] +**modifiedDate** | [**Date**](Date.md) | The date on which the library document was last modified. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional] +**workflowLibDoc** | **String** | An id of the workflow library document that can be provided as an input file in the custom workflow agreement creation request | [optional] +**label** | **String** | A display text for this form for workflow users | [optional] + + + +## Enum: List<TemplateTypesEnum> +Name | Value +---- | ----- +DOCUMENT | "DOCUMENT" +FORM_FIELD_LAYER | "FORM_FIELD_LAYER" + + + +## Enum: SharingModeEnum +Name | Value +---- | ----- +USER | "USER" +GROUP | "GROUP" +ACCOUNT | "ACCOUNT" +GLOBAL | "GLOBAL" + + + diff --git a/docs/WorkflowsApi.md b/docs/WorkflowsApi.md index a7300c7..26d87ff 100755 --- a/docs/WorkflowsApi.md +++ b/docs/WorkflowsApi.md @@ -1,15 +1,67 @@ # WorkflowsApi -All URIs are relative to *http://localhost/api/rest/v6* +All URIs are relative to *https://secure.au1.echosign.com/api/rest/v6* Method | HTTP request | Description ------------- | ------------- | ------------- +[**getWorkflowInfo**](WorkflowsApi.md#getWorkflowInfo) | **GET** /workflows/{workflowId} | Retrieves the details of a workflow. [**getWorkflows**](WorkflowsApi.md#getWorkflows) | **GET** /workflows | Retrieves workflows for a user. + +# **getWorkflowInfo** +> WorkflowDescription getWorkflowInfo(authorization, workflowId, xApiUser, xOnBehalfOfUser, groupId) + +Retrieves the details of a workflow. + +### Example +```java +// Import classes: +//import io.swagger.client.model.ApiException; +//import io.swagger.client.api.WorkflowsApi; + + +WorkflowsApi apiInstance = new WorkflowsApi(); +String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. +String workflowId = "workflowId_example"; // String | The workflow identifier, as retrieved from the API to fetch workflows. +String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String groupId = "groupId_example"; // String | The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. +try { + WorkflowDescription result = apiInstance.getWorkflowInfo(authorization, workflowId, xApiUser, xOnBehalfOfUser, groupId); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling WorkflowsApi#getWorkflowInfo"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('workflow_read')\" oncontextmenu=\"this.href=oauthDoc('workflow_read')\" target=\"oauthDoc\">workflow_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | + **workflowId** | **String**| The workflow identifier, as retrieved from the API to fetch workflows. | + **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **groupId** | **String**| The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. | [optional] + +### Return type + +[**WorkflowDescription**](WorkflowDescription.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + # **getWorkflows** -> UserWorkflows getWorkflows(authorization, xApiUser, includeDraftWorkflows, includeInactiveWorkflows, groupId) +> UserWorkflows getWorkflows(authorization, xApiUser, xOnBehalfOfUser, groupId, includeDraftWorkflows, includeInactiveWorkflows) Retrieves workflows for a user. @@ -23,11 +75,12 @@ Retrieves workflows for a user. WorkflowsApi apiInstance = new WorkflowsApi(); String authorization = "authorization_example"; // String | An OAuth Access Token with scopes:in the format 'Bearer {accessToken}'. String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format userid:{userId} OR email:{email}. If it is not specified, then the caller is inferred from the token. +String xOnBehalfOfUser = "xOnBehalfOfUser_example"; // String | The userId or email in the format userid:{userId} OR email:{email}. of the user that has shared his/her account +String groupId = "groupId_example"; // String | The group identifier for which the workflows will be fetched Boolean includeDraftWorkflows = true; // Boolean | Include draft workflows Boolean includeInactiveWorkflows = true; // Boolean | Include inactive workflows -String groupId = "groupId_example"; // String | The group identifier for which the workflows will be fetched try { - UserWorkflows result = apiInstance.getWorkflows(authorization, xApiUser, includeDraftWorkflows, includeInactiveWorkflows, groupId); + UserWorkflows result = apiInstance.getWorkflows(authorization, xApiUser, xOnBehalfOfUser, groupId, includeDraftWorkflows, includeInactiveWorkflows); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling WorkflowsApi#getWorkflows"); @@ -41,9 +94,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **authorization** | **String**| An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('workflow_read')\" oncontextmenu=\"this.href=oauthDoc('workflow_read')\" target=\"oauthDoc\">workflow_read</a></li></ul>in the format <b>'Bearer {accessToken}'. | **xApiUser** | **String**| The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. | [optional] + **xOnBehalfOfUser** | **String**| The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account | [optional] + **groupId** | **String**| The group identifier for which the workflows will be fetched | [optional] **includeDraftWorkflows** | **Boolean**| Include draft workflows | [optional] **includeInactiveWorkflows** | **Boolean**| Include inactive workflows | [optional] - **groupId** | **String**| The group identifier for which the workflows will be fetched | [optional] ### Return type diff --git a/src/main/AndroidManifest.xml b/src/main/AndroidManifest.xml index 067c874..8b93072 100755 --- a/src/main/AndroidManifest.xml +++ b/src/main/AndroidManifest.xml @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - diff --git a/src/main/java/io/swagger/client/api/AccountsApi.java b/src/main/java/io/swagger/client/api/AccountsApi.java new file mode 100644 index 0000000..9022e9d --- /dev/null +++ b/src/main/java/io/swagger/client/api/AccountsApi.java @@ -0,0 +1,197 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.api; + +import io.swagger.client.model.ApiCallback; +import io.swagger.client.model.ApiClient; +import io.swagger.client.model.ApiException; +import io.swagger.client.model.ApiResponse; +import io.swagger.client.model.Configuration; +import io.swagger.client.model.Pair; +import io.swagger.client.model.ProgressRequestBody; +import io.swagger.client.model.ProgressResponseBody; + +import com.google.gson.reflect.TypeToken; + +import java.io.IOException; + + +import io.swagger.client.model.accounts.Account; + +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class AccountsApi { + private ApiClient apiClient; + + public AccountsApi() { + this(Configuration.getDefaultApiClient()); + } + + public AccountsApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + public ApiClient getApiClient() { + return apiClient; + } + + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Build call for getAccount + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_read')\" oncontextmenu=\"this.href=oauthDoc('user_read')\" target=\"oauthDoc\">user_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param accountId The account identifier. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getAccountCall(String authorization, String accountId, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/accounts/{accountId}" + .replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getAccountValidateBeforeCall(String authorization, String accountId, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getAccount(Async)"); + } + + // verify the required parameter 'accountId' is set + if (accountId == null) { + throw new ApiException("Missing the required parameter 'accountId' when calling getAccount(Async)"); + } + + + com.squareup.okhttp.Call call = getAccountCall(authorization, accountId, xApiUser, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves the information for an account. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_read')\" oncontextmenu=\"this.href=oauthDoc('user_read')\" target=\"oauthDoc\">user_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param accountId The account identifier. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @return Account + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public Account getAccount(String authorization, String accountId, String xApiUser) throws ApiException { + ApiResponse resp = getAccountWithHttpInfo(authorization, accountId, xApiUser); + return resp.getData(); + } + + /** + * Retrieves the information for an account. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_read')\" oncontextmenu=\"this.href=oauthDoc('user_read')\" target=\"oauthDoc\">user_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param accountId The account identifier. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @return ApiResponse<Account> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getAccountWithHttpInfo(String authorization, String accountId, String xApiUser) throws ApiException { + com.squareup.okhttp.Call call = getAccountValidateBeforeCall(authorization, accountId, xApiUser, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves the information for an account. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_read')\" oncontextmenu=\"this.href=oauthDoc('user_read')\" target=\"oauthDoc\">user_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param accountId The account identifier. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getAccountAsync(String authorization, String accountId, String xApiUser, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getAccountValidateBeforeCall(authorization, accountId, xApiUser, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } +} diff --git a/src/main/java/io/swagger/client/api/AgreementsApi.java b/src/main/java/io/swagger/client/api/AgreementsApi.java index 9b78c39..f50ce30 100755 --- a/src/main/java/io/swagger/client/api/AgreementsApi.java +++ b/src/main/java/io/swagger/client/api/AgreementsApi.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -59,10 +44,12 @@ import io.swagger.client.model.agreements.DetailedParticipantSetInfo; import io.swagger.client.model.agreements.DocumentUrl; import io.swagger.client.model.agreements.DocumentsImageUrlsInfo; +import io.swagger.client.model.agreements.FetchedAgreementInfo; import io.swagger.client.model.agreements.FormFieldMergeInfo; import io.swagger.client.model.agreements.FormFieldPostInfo; import io.swagger.client.model.agreements.FormFieldPutInfo; import io.swagger.client.model.agreements.MembersInfo; +import io.swagger.client.model.agreements.MyAgreementInfo; import io.swagger.client.model.agreements.Note; import io.swagger.client.model.agreements.ParticipantSecurityOption; import io.swagger.client.model.agreements.ReminderCreationResult; @@ -70,8 +57,10 @@ import io.swagger.client.model.agreements.RemindersResponse; import io.swagger.client.model.agreements.ShareCreationInfoList; import io.swagger.client.model.agreements.ShareCreationResponseList; +import io.swagger.client.model.agreements.SignerIdentityReportInfo; import io.swagger.client.model.agreements.SigningUrlResponse; import io.swagger.client.model.agreements.UserAgreements; +import io.swagger.client.model.agreements.VaultEventInfo; import io.swagger.client.model.agreements.VisibilityInfo; import java.lang.reflect.Type; @@ -102,17 +91,17 @@ public void setApiClient(ApiClient apiClient) { /** * Build call for addTemplateFieldsToAgreement * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param formFieldPostInfo List of form fields to add or replace (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call addTemplateFieldsToAgreementCall(String authorization, String ifMatch, String agreementId, FormFieldPostInfo formFieldPostInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call addTemplateFieldsToAgreementCall(String authorization, String agreementId, FormFieldPostInfo formFieldPostInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = formFieldPostInfo; // create path and map variables @@ -163,18 +152,13 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call addTemplateFieldsToAgreementValidateBeforeCall(String authorization, String ifMatch, String agreementId, FormFieldPostInfo formFieldPostInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call addTemplateFieldsToAgreementValidateBeforeCall(String authorization, String agreementId, FormFieldPostInfo formFieldPostInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling addTemplateFieldsToAgreement(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling addTemplateFieldsToAgreement(Async)"); - } - // verify the required parameter 'agreementId' is set if (agreementId == null) { throw new ApiException("Missing the required parameter 'agreementId' when calling addTemplateFieldsToAgreement(Async)"); @@ -186,7 +170,7 @@ private com.squareup.okhttp.Call addTemplateFieldsToAgreementValidateBeforeCall( } - com.squareup.okhttp.Call call = addTemplateFieldsToAgreementCall(authorization, ifMatch, agreementId, formFieldPostInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = addTemplateFieldsToAgreementCall(authorization, agreementId, formFieldPostInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); return call; } @@ -195,16 +179,16 @@ private com.squareup.okhttp.Call addTemplateFieldsToAgreementValidateBeforeCall( * Adds template fields to an agreement * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param formFieldPostInfo List of form fields to add or replace (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return AgreementFormFields * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public AgreementFormFields addTemplateFieldsToAgreement(String authorization, String ifMatch, String agreementId, FormFieldPostInfo formFieldPostInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - ApiResponse resp = addTemplateFieldsToAgreementWithHttpInfo(authorization, ifMatch, agreementId, formFieldPostInfo, xApiUser, xOnBehalfOfUser); + public AgreementFormFields addTemplateFieldsToAgreement(String authorization, String agreementId, FormFieldPostInfo formFieldPostInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + ApiResponse resp = addTemplateFieldsToAgreementWithHttpInfo(authorization, agreementId, formFieldPostInfo, xApiUser, xOnBehalfOfUser, ifMatch); return resp.getData(); } @@ -212,16 +196,16 @@ public AgreementFormFields addTemplateFieldsToAgreement(String authorization, St * Adds template fields to an agreement * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param formFieldPostInfo List of form fields to add or replace (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return ApiResponse<AgreementFormFields> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse addTemplateFieldsToAgreementWithHttpInfo(String authorization, String ifMatch, String agreementId, FormFieldPostInfo formFieldPostInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = addTemplateFieldsToAgreementValidateBeforeCall(authorization, ifMatch, agreementId, formFieldPostInfo, xApiUser, xOnBehalfOfUser, null, null); + public ApiResponse addTemplateFieldsToAgreementWithHttpInfo(String authorization, String agreementId, FormFieldPostInfo formFieldPostInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + com.squareup.okhttp.Call call = addTemplateFieldsToAgreementValidateBeforeCall(authorization, agreementId, formFieldPostInfo, xApiUser, xOnBehalfOfUser, ifMatch, null, null); Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -230,16 +214,16 @@ public ApiResponse addTemplateFieldsToAgreementWithHttpInfo * Adds template fields to an agreement (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param formFieldPostInfo List of form fields to add or replace (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call addTemplateFieldsToAgreementAsync(String authorization, String ifMatch, String agreementId, FormFieldPostInfo formFieldPostInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call addTemplateFieldsToAgreementAsync(String authorization, String agreementId, FormFieldPostInfo formFieldPostInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -260,7 +244,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = addTemplateFieldsToAgreementValidateBeforeCall(authorization, ifMatch, agreementId, formFieldPostInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = addTemplateFieldsToAgreementValidateBeforeCall(authorization, agreementId, formFieldPostInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; @@ -1034,19 +1018,163 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don apiClient.executeAsync(call, localVarReturnType, callback); return call; } + /** + * Build call for createSignerIdentityReport + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param signerIdentityReportInfo Information about the agreement for which you want to create signer identity report. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call createSignerIdentityReportCall(String authorization, String agreementId, String xApiUser, SignerIdentityReportInfo signerIdentityReportInfo, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = signerIdentityReportInfo; + + // create path and map variables + String localVarPath = "/agreements/{agreementId}/signerIdentityReport" + .replaceAll("\\{" + "agreementId" + "\\}", apiClient.escapeString(agreementId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/pdf", "application/pdf;encoding=base64" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call createSignerIdentityReportValidateBeforeCall(String authorization, String agreementId, String xApiUser, SignerIdentityReportInfo signerIdentityReportInfo, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling createSignerIdentityReport(Async)"); + } + + // verify the required parameter 'agreementId' is set + if (agreementId == null) { + throw new ApiException("Missing the required parameter 'agreementId' when calling createSignerIdentityReport(Async)"); + } + + + com.squareup.okhttp.Call call = createSignerIdentityReportCall(authorization, agreementId, xApiUser, signerIdentityReportInfo, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves the signer identity report of an agreement identified by agreementId. + * PDF file stream containing signer identify information + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param signerIdentityReportInfo Information about the agreement for which you want to create signer identity report. (optional) + * @return byte[] + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public byte[] createSignerIdentityReport(String authorization, String agreementId, String xApiUser, SignerIdentityReportInfo signerIdentityReportInfo) throws ApiException { + ApiResponse resp = createSignerIdentityReportWithHttpInfo(authorization, agreementId, xApiUser, signerIdentityReportInfo); + return resp.getData(); + } + + /** + * Retrieves the signer identity report of an agreement identified by agreementId. + * PDF file stream containing signer identify information + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param signerIdentityReportInfo Information about the agreement for which you want to create signer identity report. (optional) + * @return ApiResponse<byte[]> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse createSignerIdentityReportWithHttpInfo(String authorization, String agreementId, String xApiUser, SignerIdentityReportInfo signerIdentityReportInfo) throws ApiException { + com.squareup.okhttp.Call call = createSignerIdentityReportValidateBeforeCall(authorization, agreementId, xApiUser, signerIdentityReportInfo, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves the signer identity report of an agreement identified by agreementId. (asynchronously) + * PDF file stream containing signer identify information + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param signerIdentityReportInfo Information about the agreement for which you want to create signer identity report. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call createSignerIdentityReportAsync(String authorization, String agreementId, String xApiUser, SignerIdentityReportInfo signerIdentityReportInfo, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = createSignerIdentityReportValidateBeforeCall(authorization, agreementId, xApiUser, signerIdentityReportInfo, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } /** * Build call for deleteDocuments * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_retention')\" oncontextmenu=\"this.href=oauthDoc('agreement_retention')\" target=\"oauthDoc\">agreement_retention</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call deleteDocumentsCall(String authorization, String ifMatch, String agreementId, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call deleteDocumentsCall(String authorization, String agreementId, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -1097,25 +1225,20 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call deleteDocumentsValidateBeforeCall(String authorization, String ifMatch, String agreementId, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call deleteDocumentsValidateBeforeCall(String authorization, String agreementId, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling deleteDocuments(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling deleteDocuments(Async)"); - } - // verify the required parameter 'agreementId' is set if (agreementId == null) { throw new ApiException("Missing the required parameter 'agreementId' when calling deleteDocuments(Async)"); } - com.squareup.okhttp.Call call = deleteDocumentsCall(authorization, ifMatch, agreementId, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = deleteDocumentsCall(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); return call; } @@ -1124,29 +1247,29 @@ private com.squareup.okhttp.Call deleteDocumentsValidateBeforeCall(String author * Deletes all the documents of an agreement. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_retention')\" oncontextmenu=\"this.href=oauthDoc('agreement_retention')\" target=\"oauthDoc\">agreement_retention</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void deleteDocuments(String authorization, String ifMatch, String agreementId, String xApiUser, String xOnBehalfOfUser) throws ApiException { - deleteDocumentsWithHttpInfo(authorization, ifMatch, agreementId, xApiUser, xOnBehalfOfUser); + public void deleteDocuments(String authorization, String agreementId, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + deleteDocumentsWithHttpInfo(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifMatch); } /** * Deletes all the documents of an agreement. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_retention')\" oncontextmenu=\"this.href=oauthDoc('agreement_retention')\" target=\"oauthDoc\">agreement_retention</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse deleteDocumentsWithHttpInfo(String authorization, String ifMatch, String agreementId, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = deleteDocumentsValidateBeforeCall(authorization, ifMatch, agreementId, xApiUser, xOnBehalfOfUser, null, null); + public ApiResponse deleteDocumentsWithHttpInfo(String authorization, String agreementId, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + com.squareup.okhttp.Call call = deleteDocumentsValidateBeforeCall(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifMatch, null, null); return apiClient.execute(call); } @@ -1154,15 +1277,15 @@ public ApiResponse deleteDocumentsWithHttpInfo(String authorization, Strin * Deletes all the documents of an agreement. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_retention')\" oncontextmenu=\"this.href=oauthDoc('agreement_retention')\" target=\"oauthDoc\">agreement_retention</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call deleteDocumentsAsync(String authorization, String ifMatch, String agreementId, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call deleteDocumentsAsync(String authorization, String agreementId, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -1183,7 +1306,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = deleteDocumentsValidateBeforeCall(authorization, ifMatch, agreementId, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = deleteDocumentsValidateBeforeCall(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } @@ -1276,11 +1399,11 @@ private com.squareup.okhttp.Call getAgreementInfoValidateBeforeCall(String autho * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @return AgreementInfo + * @return FetchedAgreementInfo * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public AgreementInfo getAgreementInfo(String authorization, String agreementId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { - ApiResponse resp = getAgreementInfoWithHttpInfo(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + public FetchedAgreementInfo getAgreementInfo(String authorization, String agreementId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + ApiResponse resp = getAgreementInfoWithHttpInfo(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch); return resp.getData(); } @@ -1292,12 +1415,12 @@ public AgreementInfo getAgreementInfo(String authorization, String agreementId, * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @return ApiResponse<AgreementInfo> + * @return ApiResponse<FetchedAgreementInfo> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getAgreementInfoWithHttpInfo(String authorization, String agreementId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + public ApiResponse getAgreementInfoWithHttpInfo(String authorization, String agreementId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { com.squareup.okhttp.Call call = getAgreementInfoValidateBeforeCall(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -1313,7 +1436,7 @@ public ApiResponse getAgreementInfoWithHttpInfo(String authorizat * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getAgreementInfoAsync(String authorization, String agreementId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getAgreementInfoAsync(String authorization, String agreementId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -1335,7 +1458,147 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don } com.squareup.okhttp.Call call = getAgreementInfoValidateBeforeCall(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getAgreementInfoForUser + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getAgreementInfoForUserCall(String authorization, String agreementId, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/agreements/{agreementId}/me" + .replaceAll("\\{" + "agreementId" + "\\}", apiClient.escapeString(agreementId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getAgreementInfoForUserValidateBeforeCall(String authorization, String agreementId, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getAgreementInfoForUser(Async)"); + } + + // verify the required parameter 'agreementId' is set + if (agreementId == null) { + throw new ApiException("Missing the required parameter 'agreementId' when calling getAgreementInfoForUser(Async)"); + } + + + com.squareup.okhttp.Call call = getAgreementInfoForUserCall(authorization, agreementId, xApiUser, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves the agreement information related to the api caller + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @return MyAgreementInfo + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public MyAgreementInfo getAgreementInfoForUser(String authorization, String agreementId, String xApiUser) throws ApiException { + ApiResponse resp = getAgreementInfoForUserWithHttpInfo(authorization, agreementId, xApiUser); + return resp.getData(); + } + + /** + * Retrieves the agreement information related to the api caller + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @return ApiResponse<MyAgreementInfo> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getAgreementInfoForUserWithHttpInfo(String authorization, String agreementId, String xApiUser) throws ApiException { + com.squareup.okhttp.Call call = getAgreementInfoForUserValidateBeforeCall(authorization, agreementId, xApiUser, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves the agreement information related to the api caller (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getAgreementInfoForUserAsync(String authorization, String agreementId, String xApiUser, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getAgreementInfoForUserValidateBeforeCall(authorization, agreementId, xApiUser, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } @@ -1647,7 +1910,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param status A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELLED, COMPLETE (optional) + * @param status A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELED, COMPLETE (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute @@ -1729,7 +1992,7 @@ private com.squareup.okhttp.Call getAgreementRemindersValidateBeforeCall(String * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param status A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELLED, COMPLETE (optional) + * @param status A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELED, COMPLETE (optional) * @return RemindersResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ @@ -1745,7 +2008,7 @@ public RemindersResponse getAgreementReminders(String authorization, String agre * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param status A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELLED, COMPLETE (optional) + * @param status A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELED, COMPLETE (optional) * @return ApiResponse<RemindersResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ @@ -1762,7 +2025,7 @@ public ApiResponse getAgreementRemindersWithHttpInfo(String a * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param status A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELLED, COMPLETE (optional) + * @param status A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELED, COMPLETE (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -1801,12 +2064,13 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @param participantId The participant identifier (required) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getAgreementSecurityOptionsForParticipationCall(String authorization, String agreementId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getAgreementSecurityOptionsForParticipationCall(String authorization, String agreementId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -1825,6 +2089,8 @@ public com.squareup.okhttp.Call getAgreementSecurityOptionsForParticipationCall( localVarHeaderParams.put("If-None-Match", apiClient.parameterToString(ifNoneMatch)); if (xApiUser != null) localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); Map localVarFormParams = new HashMap(); @@ -1857,7 +2123,7 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getAgreementSecurityOptionsForParticipationValidateBeforeCall(String authorization, String agreementId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getAgreementSecurityOptionsForParticipationValidateBeforeCall(String authorization, String agreementId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { @@ -1880,7 +2146,7 @@ private com.squareup.okhttp.Call getAgreementSecurityOptionsForParticipationVali } - com.squareup.okhttp.Call call = getAgreementSecurityOptionsForParticipationCall(authorization, agreementId, participantSetId, participantId, ifNoneMatch, xApiUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getAgreementSecurityOptionsForParticipationCall(authorization, agreementId, participantSetId, participantId, ifNoneMatch, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); return call; } @@ -1894,11 +2160,12 @@ private com.squareup.okhttp.Call getAgreementSecurityOptionsForParticipationVali * @param participantId The participant identifier (required) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @return ParticipantSecurityOption * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ParticipantSecurityOption getAgreementSecurityOptionsForParticipation(String authorization, String agreementId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser) throws ApiException { - ApiResponse resp = getAgreementSecurityOptionsForParticipationWithHttpInfo(authorization, agreementId, participantSetId, participantId, ifNoneMatch, xApiUser); + public ParticipantSecurityOption getAgreementSecurityOptionsForParticipation(String authorization, String agreementId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser, String xOnBehalfOfUser) throws ApiException { + ApiResponse resp = getAgreementSecurityOptionsForParticipationWithHttpInfo(authorization, agreementId, participantSetId, participantId, ifNoneMatch, xApiUser, xOnBehalfOfUser); return resp.getData(); } @@ -1911,11 +2178,12 @@ public ParticipantSecurityOption getAgreementSecurityOptionsForParticipation(Str * @param participantId The participant identifier (required) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @return ApiResponse<ParticipantSecurityOption> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getAgreementSecurityOptionsForParticipationWithHttpInfo(String authorization, String agreementId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser) throws ApiException { - com.squareup.okhttp.Call call = getAgreementSecurityOptionsForParticipationValidateBeforeCall(authorization, agreementId, participantSetId, participantId, ifNoneMatch, xApiUser, null, null); + public ApiResponse getAgreementSecurityOptionsForParticipationWithHttpInfo(String authorization, String agreementId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser, String xOnBehalfOfUser) throws ApiException { + com.squareup.okhttp.Call call = getAgreementSecurityOptionsForParticipationValidateBeforeCall(authorization, agreementId, participantSetId, participantId, ifNoneMatch, xApiUser, xOnBehalfOfUser, null, null); Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -1929,11 +2197,12 @@ public ApiResponse getAgreementSecurityOptionsForPart * @param participantId The participant identifier (required) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getAgreementSecurityOptionsForParticipationAsync(String authorization, String agreementId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getAgreementSecurityOptionsForParticipationAsync(String authorization, String agreementId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -1954,7 +2223,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getAgreementSecurityOptionsForParticipationValidateBeforeCall(authorization, agreementId, participantSetId, participantId, ifNoneMatch, xApiUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getAgreementSecurityOptionsForParticipationValidateBeforeCall(authorization, agreementId, participantSetId, participantId, ifNoneMatch, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; @@ -1965,6 +2234,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param externalId Case-sensitive ExternalID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API. (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) * @param showHiddenAgreements A query parameter to fetch all the hidden agreements along with the visible agreements. Default value is false. (optional) * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) @@ -1973,7 +2243,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getAgreementsCall(String authorization, String xApiUser, String xOnBehalfOfUser, String externalId, Boolean showHiddenAgreements, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getAgreementsCall(String authorization, String xApiUser, String xOnBehalfOfUser, String externalId, String groupId, Boolean showHiddenAgreements, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -1983,6 +2253,8 @@ public com.squareup.okhttp.Call getAgreementsCall(String authorization, String x List localVarCollectionQueryParams = new ArrayList(); if (externalId != null) localVarQueryParams.addAll(apiClient.parameterToPair("externalId", externalId)); + if (groupId != null) + localVarQueryParams.addAll(apiClient.parameterToPair("groupId", groupId)); if (showHiddenAgreements != null) localVarQueryParams.addAll(apiClient.parameterToPair("showHiddenAgreements", showHiddenAgreements)); if (cursor != null) @@ -2029,7 +2301,7 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getAgreementsValidateBeforeCall(String authorization, String xApiUser, String xOnBehalfOfUser, String externalId, Boolean showHiddenAgreements, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getAgreementsValidateBeforeCall(String authorization, String xApiUser, String xOnBehalfOfUser, String externalId, String groupId, Boolean showHiddenAgreements, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { @@ -2037,7 +2309,7 @@ private com.squareup.okhttp.Call getAgreementsValidateBeforeCall(String authoriz } - com.squareup.okhttp.Call call = getAgreementsCall(authorization, xApiUser, xOnBehalfOfUser, externalId, showHiddenAgreements, cursor, pageSize, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getAgreementsCall(authorization, xApiUser, xOnBehalfOfUser, externalId, groupId, showHiddenAgreements, cursor, pageSize, progressListener, progressRequestListener); return call; } @@ -2049,14 +2321,15 @@ private com.squareup.okhttp.Call getAgreementsValidateBeforeCall(String authoriz * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param externalId Case-sensitive ExternalID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API. (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) * @param showHiddenAgreements A query parameter to fetch all the hidden agreements along with the visible agreements. Default value is false. (optional) * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) * @return UserAgreements * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public UserAgreements getAgreements(String authorization, String xApiUser, String xOnBehalfOfUser, String externalId, Boolean showHiddenAgreements, String cursor, Integer pageSize) throws ApiException { - ApiResponse resp = getAgreementsWithHttpInfo(authorization, xApiUser, xOnBehalfOfUser, externalId, showHiddenAgreements, cursor, pageSize); + public UserAgreements getAgreements(String authorization, String xApiUser, String xOnBehalfOfUser, String externalId, String groupId, Boolean showHiddenAgreements, String cursor, Integer pageSize) throws ApiException { + ApiResponse resp = getAgreementsWithHttpInfo(authorization, xApiUser, xOnBehalfOfUser, externalId, groupId, showHiddenAgreements, cursor, pageSize); return resp.getData(); } @@ -2067,14 +2340,15 @@ public UserAgreements getAgreements(String authorization, String xApiUser, Strin * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param externalId Case-sensitive ExternalID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API. (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) * @param showHiddenAgreements A query parameter to fetch all the hidden agreements along with the visible agreements. Default value is false. (optional) * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) * @return ApiResponse<UserAgreements> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getAgreementsWithHttpInfo(String authorization, String xApiUser, String xOnBehalfOfUser, String externalId, Boolean showHiddenAgreements, String cursor, Integer pageSize) throws ApiException { - com.squareup.okhttp.Call call = getAgreementsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, externalId, showHiddenAgreements, cursor, pageSize, null, null); + public ApiResponse getAgreementsWithHttpInfo(String authorization, String xApiUser, String xOnBehalfOfUser, String externalId, String groupId, Boolean showHiddenAgreements, String cursor, Integer pageSize) throws ApiException { + com.squareup.okhttp.Call call = getAgreementsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, externalId, groupId, showHiddenAgreements, cursor, pageSize, null, null); Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -2086,6 +2360,7 @@ public ApiResponse getAgreementsWithHttpInfo(String authorizatio * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param externalId Case-sensitive ExternalID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API. (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) * @param showHiddenAgreements A query parameter to fetch all the hidden agreements along with the visible agreements. Default value is false. (optional) * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) @@ -2093,7 +2368,7 @@ public ApiResponse getAgreementsWithHttpInfo(String authorizatio * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getAgreementsAsync(String authorization, String xApiUser, String xOnBehalfOfUser, String externalId, Boolean showHiddenAgreements, String cursor, Integer pageSize, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getAgreementsAsync(String authorization, String xApiUser, String xOnBehalfOfUser, String externalId, String groupId, Boolean showHiddenAgreements, String cursor, Integer pageSize, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -2114,7 +2389,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getAgreementsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, externalId, showHiddenAgreements, cursor, pageSize, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getAgreementsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, externalId, groupId, showHiddenAgreements, cursor, pageSize, progressListener, progressRequestListener); Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; @@ -2785,7 +3060,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @param versionId The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used. (optional) * @param participantId The participant identifier to be used to retrieve documents. If not mentioned, the participation of api caller is used. (optional) * @param attachSupportingDocuments When set to true, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true. (optional) - * @param attachAuditReport When set to true, attach an audit report to the signed agreement PDF. Default value is false (optional) + * @param attachAuditReport When set to true, attach an audit report to the signed agreement PDF. The default value is false. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute @@ -2879,7 +3154,7 @@ private com.squareup.okhttp.Call getCombinedDocumentValidateBeforeCall(String au * @param versionId The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used. (optional) * @param participantId The participant identifier to be used to retrieve documents. If not mentioned, the participation of api caller is used. (optional) * @param attachSupportingDocuments When set to true, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true. (optional) - * @param attachAuditReport When set to true, attach an audit report to the signed agreement PDF. Default value is false (optional) + * @param attachAuditReport When set to true, attach an audit report to the signed agreement PDF. The default value is false. (optional) * @return byte[] * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ @@ -2899,7 +3174,7 @@ public byte[] getCombinedDocument(String authorization, String agreementId, Stri * @param versionId The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used. (optional) * @param participantId The participant identifier to be used to retrieve documents. If not mentioned, the participation of api caller is used. (optional) * @param attachSupportingDocuments When set to true, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true. (optional) - * @param attachAuditReport When set to true, attach an audit report to the signed agreement PDF. Default value is false (optional) + * @param attachAuditReport When set to true, attach an audit report to the signed agreement PDF. The default value is false. (optional) * @return ApiResponse<byte[]> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ @@ -2920,7 +3195,7 @@ public ApiResponse getCombinedDocumentWithHttpInfo(String authorization, * @param versionId The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used. (optional) * @param participantId The participant identifier to be used to retrieve documents. If not mentioned, the participation of api caller is used. (optional) * @param attachSupportingDocuments When set to true, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true. (optional) - * @param attachAuditReport When set to true, attach an audit report to the signed agreement PDF. Default value is false (optional) + * @param attachAuditReport When set to true, attach an audit report to the signed agreement PDF. The default value is false. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -3118,7 +3393,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @param versionId The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used. (optional) * @param participantId The participant identifier to be used to retrieve documents. If not mentioned, the participation of api caller is used. (optional) * @param attachSupportingDocuments When set to true, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true. (optional) - * @param attachAuditReport When set to true, attach an audit report to the signed agreement PDF. Default value is false (optional) + * @param attachAuditReport When set to true, attach an audit report to the signed agreement PDF. The default value is false. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute @@ -3209,7 +3484,7 @@ private com.squareup.okhttp.Call getCombinedDocumentUrlValidateBeforeCall(String * @param versionId The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used. (optional) * @param participantId The participant identifier to be used to retrieve documents. If not mentioned, the participation of api caller is used. (optional) * @param attachSupportingDocuments When set to true, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true. (optional) - * @param attachAuditReport When set to true, attach an audit report to the signed agreement PDF. Default value is false (optional) + * @param attachAuditReport When set to true, attach an audit report to the signed agreement PDF. The default value is false. (optional) * @return DocumentUrl * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ @@ -3228,7 +3503,7 @@ public DocumentUrl getCombinedDocumentUrl(String authorization, String agreement * @param versionId The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used. (optional) * @param participantId The participant identifier to be used to retrieve documents. If not mentioned, the participation of api caller is used. (optional) * @param attachSupportingDocuments When set to true, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true. (optional) - * @param attachAuditReport When set to true, attach an audit report to the signed agreement PDF. Default value is false (optional) + * @param attachAuditReport When set to true, attach an audit report to the signed agreement PDF. The default value is false. (optional) * @return ApiResponse<DocumentUrl> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ @@ -3248,7 +3523,7 @@ public ApiResponse getCombinedDocumentUrlWithHttpInfo(String author * @param versionId The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used. (optional) * @param participantId The participant identifier to be used to retrieve documents. If not mentioned, the participation of api caller is used. (optional) * @param attachSupportingDocuments When set to true, attach corresponding supporting documents to the signed agreement PDF. Default value of this parameter is true. (optional) - * @param attachAuditReport When set to true, attach an audit report to the signed agreement PDF. Default value is false (optional) + * @param attachAuditReport When set to true, attach an audit report to the signed agreement PDF. The default value is false. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -4397,12 +4672,13 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param expiry Lifetime of the esignUrl, between 30 and 315360000 seconds. If not provided, it is decided by the application settings. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getSigningUrlCall(String authorization, String agreementId, String xApiUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getSigningUrlCall(String authorization, String agreementId, String xApiUser, String ifNoneMatch, Integer expiry, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -4411,6 +4687,8 @@ public com.squareup.okhttp.Call getSigningUrlCall(String authorization, String a List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); + if (expiry != null) + localVarQueryParams.addAll(apiClient.parameterToPair("expiry", expiry)); Map localVarHeaderParams = new HashMap(); if (authorization != null) @@ -4451,7 +4729,7 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getSigningUrlValidateBeforeCall(String authorization, String agreementId, String xApiUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getSigningUrlValidateBeforeCall(String authorization, String agreementId, String xApiUser, String ifNoneMatch, Integer expiry, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { @@ -4464,7 +4742,7 @@ private com.squareup.okhttp.Call getSigningUrlValidateBeforeCall(String authoriz } - com.squareup.okhttp.Call call = getSigningUrlCall(authorization, agreementId, xApiUser, ifNoneMatch, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getSigningUrlCall(authorization, agreementId, xApiUser, ifNoneMatch, expiry, progressListener, progressRequestListener); return call; } @@ -4476,11 +4754,12 @@ private com.squareup.okhttp.Call getSigningUrlValidateBeforeCall(String authoriz * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param expiry Lifetime of the esignUrl, between 30 and 315360000 seconds. If not provided, it is decided by the application settings. (optional) * @return SigningUrlResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public SigningUrlResponse getSigningUrl(String authorization, String agreementId, String xApiUser, String ifNoneMatch) throws ApiException { - ApiResponse resp = getSigningUrlWithHttpInfo(authorization, agreementId, xApiUser, ifNoneMatch); + public SigningUrlResponse getSigningUrl(String authorization, String agreementId, String xApiUser, String ifNoneMatch, Integer expiry) throws ApiException { + ApiResponse resp = getSigningUrlWithHttpInfo(authorization, agreementId, xApiUser, ifNoneMatch, expiry); return resp.getData(); } @@ -4491,11 +4770,12 @@ public SigningUrlResponse getSigningUrl(String authorization, String agreementId * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param expiry Lifetime of the esignUrl, between 30 and 315360000 seconds. If not provided, it is decided by the application settings. (optional) * @return ApiResponse<SigningUrlResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getSigningUrlWithHttpInfo(String authorization, String agreementId, String xApiUser, String ifNoneMatch) throws ApiException { - com.squareup.okhttp.Call call = getSigningUrlValidateBeforeCall(authorization, agreementId, xApiUser, ifNoneMatch, null, null); + public ApiResponse getSigningUrlWithHttpInfo(String authorization, String agreementId, String xApiUser, String ifNoneMatch, Integer expiry) throws ApiException { + com.squareup.okhttp.Call call = getSigningUrlValidateBeforeCall(authorization, agreementId, xApiUser, ifNoneMatch, expiry, null, null); Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -4507,11 +4787,12 @@ public ApiResponse getSigningUrlWithHttpInfo(String authoriz * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param expiry Lifetime of the esignUrl, between 30 and 315360000 seconds. If not provided, it is decided by the application settings. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getSigningUrlAsync(String authorization, String agreementId, String xApiUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getSigningUrlAsync(String authorization, String agreementId, String xApiUser, String ifNoneMatch, Integer expiry, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -4532,7 +4813,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getSigningUrlValidateBeforeCall(authorization, agreementId, xApiUser, ifNoneMatch, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getSigningUrlValidateBeforeCall(authorization, agreementId, xApiUser, ifNoneMatch, expiry, progressListener, progressRequestListener); Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; @@ -4540,18 +4821,18 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for rejectAgreementForParticipation * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param participantSetId The participant set identifier (required) * @param participantId The participant identifier (required) * @param agreementRejectionInfo Participant rejection information required for rejecting the agreement (required) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call rejectAgreementForParticipationCall(String authorization, String ifMatch, String agreementId, String participantSetId, String participantId, AgreementRejectionInfo agreementRejectionInfo, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call rejectAgreementForParticipationCall(String authorization, String agreementId, String participantSetId, String participantId, AgreementRejectionInfo agreementRejectionInfo, String ifMatch, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = agreementRejectionInfo; // create path and map variables @@ -4602,18 +4883,13 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call rejectAgreementForParticipationValidateBeforeCall(String authorization, String ifMatch, String agreementId, String participantSetId, String participantId, AgreementRejectionInfo agreementRejectionInfo, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call rejectAgreementForParticipationValidateBeforeCall(String authorization, String agreementId, String participantSetId, String participantId, AgreementRejectionInfo agreementRejectionInfo, String ifMatch, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling rejectAgreementForParticipation(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling rejectAgreementForParticipation(Async)"); - } - // verify the required parameter 'agreementId' is set if (agreementId == null) { throw new ApiException("Missing the required parameter 'agreementId' when calling rejectAgreementForParticipation(Async)"); @@ -4635,7 +4911,7 @@ private com.squareup.okhttp.Call rejectAgreementForParticipationValidateBeforeCa } - com.squareup.okhttp.Call call = rejectAgreementForParticipationCall(authorization, ifMatch, agreementId, participantSetId, participantId, agreementRejectionInfo, xApiUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = rejectAgreementForParticipationCall(authorization, agreementId, participantSetId, participantId, agreementRejectionInfo, ifMatch, xApiUser, progressListener, progressRequestListener); return call; } @@ -4644,33 +4920,33 @@ private com.squareup.okhttp.Call rejectAgreementForParticipationValidateBeforeCa * Rejects the agreement for a participant. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param participantSetId The participant set identifier (required) * @param participantId The participant identifier (required) * @param agreementRejectionInfo Participant rejection information required for rejecting the agreement (required) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void rejectAgreementForParticipation(String authorization, String ifMatch, String agreementId, String participantSetId, String participantId, AgreementRejectionInfo agreementRejectionInfo, String xApiUser) throws ApiException { - rejectAgreementForParticipationWithHttpInfo(authorization, ifMatch, agreementId, participantSetId, participantId, agreementRejectionInfo, xApiUser); + public void rejectAgreementForParticipation(String authorization, String agreementId, String participantSetId, String participantId, AgreementRejectionInfo agreementRejectionInfo, String ifMatch, String xApiUser) throws ApiException { + rejectAgreementForParticipationWithHttpInfo(authorization, agreementId, participantSetId, participantId, agreementRejectionInfo, ifMatch, xApiUser); } /** * Rejects the agreement for a participant. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param participantSetId The participant set identifier (required) * @param participantId The participant identifier (required) * @param agreementRejectionInfo Participant rejection information required for rejecting the agreement (required) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse rejectAgreementForParticipationWithHttpInfo(String authorization, String ifMatch, String agreementId, String participantSetId, String participantId, AgreementRejectionInfo agreementRejectionInfo, String xApiUser) throws ApiException { - com.squareup.okhttp.Call call = rejectAgreementForParticipationValidateBeforeCall(authorization, ifMatch, agreementId, participantSetId, participantId, agreementRejectionInfo, xApiUser, null, null); + public ApiResponse rejectAgreementForParticipationWithHttpInfo(String authorization, String agreementId, String participantSetId, String participantId, AgreementRejectionInfo agreementRejectionInfo, String ifMatch, String xApiUser) throws ApiException { + com.squareup.okhttp.Call call = rejectAgreementForParticipationValidateBeforeCall(authorization, agreementId, participantSetId, participantId, agreementRejectionInfo, ifMatch, xApiUser, null, null); return apiClient.execute(call); } @@ -4678,17 +4954,17 @@ public ApiResponse rejectAgreementForParticipationWithHttpInfo(String auth * Rejects the agreement for a participant. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param participantSetId The participant set identifier (required) * @param participantId The participant identifier (required) * @param agreementRejectionInfo Participant rejection information required for rejecting the agreement (required) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call rejectAgreementForParticipationAsync(String authorization, String ifMatch, String agreementId, String participantSetId, String participantId, AgreementRejectionInfo agreementRejectionInfo, String xApiUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call rejectAgreementForParticipationAsync(String authorization, String agreementId, String participantSetId, String participantId, AgreementRejectionInfo agreementRejectionInfo, String ifMatch, String xApiUser, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -4709,24 +4985,24 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = rejectAgreementForParticipationValidateBeforeCall(authorization, ifMatch, agreementId, participantSetId, participantId, agreementRejectionInfo, xApiUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = rejectAgreementForParticipationValidateBeforeCall(authorization, agreementId, participantSetId, participantId, agreementRejectionInfo, ifMatch, xApiUser, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } /** * Build call for updateAgreement * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param agreementInfo Information necessary to update a modifiable agreement that is presently out for signature. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call updateAgreementCall(String authorization, String ifMatch, String agreementId, AgreementInfo agreementInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call updateAgreementCall(String authorization, String agreementId, AgreementInfo agreementInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = agreementInfo; // create path and map variables @@ -4777,18 +5053,13 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call updateAgreementValidateBeforeCall(String authorization, String ifMatch, String agreementId, AgreementInfo agreementInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateAgreementValidateBeforeCall(String authorization, String agreementId, AgreementInfo agreementInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling updateAgreement(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling updateAgreement(Async)"); - } - // verify the required parameter 'agreementId' is set if (agreementId == null) { throw new ApiException("Missing the required parameter 'agreementId' when calling updateAgreement(Async)"); @@ -4800,7 +5071,7 @@ private com.squareup.okhttp.Call updateAgreementValidateBeforeCall(String author } - com.squareup.okhttp.Call call = updateAgreementCall(authorization, ifMatch, agreementId, agreementInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateAgreementCall(authorization, agreementId, agreementInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); return call; } @@ -4809,31 +5080,31 @@ private com.squareup.okhttp.Call updateAgreementValidateBeforeCall(String author * Updates the agreement in draft state, or update the expirationTime on an existing agreement that is already out for signature. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param agreementInfo Information necessary to update a modifiable agreement that is presently out for signature. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void updateAgreement(String authorization, String ifMatch, String agreementId, AgreementInfo agreementInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - updateAgreementWithHttpInfo(authorization, ifMatch, agreementId, agreementInfo, xApiUser, xOnBehalfOfUser); + public void updateAgreement(String authorization, String agreementId, AgreementInfo agreementInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + updateAgreementWithHttpInfo(authorization, agreementId, agreementInfo, xApiUser, xOnBehalfOfUser, ifMatch); } /** * Updates the agreement in draft state, or update the expirationTime on an existing agreement that is already out for signature. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param agreementInfo Information necessary to update a modifiable agreement that is presently out for signature. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse updateAgreementWithHttpInfo(String authorization, String ifMatch, String agreementId, AgreementInfo agreementInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = updateAgreementValidateBeforeCall(authorization, ifMatch, agreementId, agreementInfo, xApiUser, xOnBehalfOfUser, null, null); + public ApiResponse updateAgreementWithHttpInfo(String authorization, String agreementId, AgreementInfo agreementInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + com.squareup.okhttp.Call call = updateAgreementValidateBeforeCall(authorization, agreementId, agreementInfo, xApiUser, xOnBehalfOfUser, ifMatch, null, null); return apiClient.execute(call); } @@ -4841,16 +5112,16 @@ public ApiResponse updateAgreementWithHttpInfo(String authorization, Strin * Updates the agreement in draft state, or update the expirationTime on an existing agreement that is already out for signature. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param agreementInfo Information necessary to update a modifiable agreement that is presently out for signature. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call updateAgreementAsync(String authorization, String ifMatch, String agreementId, AgreementInfo agreementInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateAgreementAsync(String authorization, String agreementId, AgreementInfo agreementInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -4871,24 +5142,24 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = updateAgreementValidateBeforeCall(authorization, ifMatch, agreementId, agreementInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateAgreementValidateBeforeCall(authorization, agreementId, agreementInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } /** * Build call for updateAgreementMergeInfo * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param formFieldMergeInfo A mapping indicating the default values to set for form fields (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call updateAgreementMergeInfoCall(String authorization, String ifMatch, String agreementId, FormFieldMergeInfo formFieldMergeInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call updateAgreementMergeInfoCall(String authorization, String agreementId, FormFieldMergeInfo formFieldMergeInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = formFieldMergeInfo; // create path and map variables @@ -4939,18 +5210,13 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call updateAgreementMergeInfoValidateBeforeCall(String authorization, String ifMatch, String agreementId, FormFieldMergeInfo formFieldMergeInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateAgreementMergeInfoValidateBeforeCall(String authorization, String agreementId, FormFieldMergeInfo formFieldMergeInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling updateAgreementMergeInfo(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling updateAgreementMergeInfo(Async)"); - } - // verify the required parameter 'agreementId' is set if (agreementId == null) { throw new ApiException("Missing the required parameter 'agreementId' when calling updateAgreementMergeInfo(Async)"); @@ -4962,7 +5228,7 @@ private com.squareup.okhttp.Call updateAgreementMergeInfoValidateBeforeCall(Stri } - com.squareup.okhttp.Call call = updateAgreementMergeInfoCall(authorization, ifMatch, agreementId, formFieldMergeInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateAgreementMergeInfoCall(authorization, agreementId, formFieldMergeInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); return call; } @@ -4971,31 +5237,31 @@ private com.squareup.okhttp.Call updateAgreementMergeInfoValidateBeforeCall(Stri * Set the merge info for an agreement. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param formFieldMergeInfo A mapping indicating the default values to set for form fields (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void updateAgreementMergeInfo(String authorization, String ifMatch, String agreementId, FormFieldMergeInfo formFieldMergeInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - updateAgreementMergeInfoWithHttpInfo(authorization, ifMatch, agreementId, formFieldMergeInfo, xApiUser, xOnBehalfOfUser); + public void updateAgreementMergeInfo(String authorization, String agreementId, FormFieldMergeInfo formFieldMergeInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + updateAgreementMergeInfoWithHttpInfo(authorization, agreementId, formFieldMergeInfo, xApiUser, xOnBehalfOfUser, ifMatch); } /** * Set the merge info for an agreement. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param formFieldMergeInfo A mapping indicating the default values to set for form fields (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse updateAgreementMergeInfoWithHttpInfo(String authorization, String ifMatch, String agreementId, FormFieldMergeInfo formFieldMergeInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = updateAgreementMergeInfoValidateBeforeCall(authorization, ifMatch, agreementId, formFieldMergeInfo, xApiUser, xOnBehalfOfUser, null, null); + public ApiResponse updateAgreementMergeInfoWithHttpInfo(String authorization, String agreementId, FormFieldMergeInfo formFieldMergeInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + com.squareup.okhttp.Call call = updateAgreementMergeInfoValidateBeforeCall(authorization, agreementId, formFieldMergeInfo, xApiUser, xOnBehalfOfUser, ifMatch, null, null); return apiClient.execute(call); } @@ -5003,16 +5269,16 @@ public ApiResponse updateAgreementMergeInfoWithHttpInfo(String authorizati * Set the merge info for an agreement. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param formFieldMergeInfo A mapping indicating the default values to set for form fields (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call updateAgreementMergeInfoAsync(String authorization, String ifMatch, String agreementId, FormFieldMergeInfo formFieldMergeInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateAgreementMergeInfoAsync(String authorization, String agreementId, FormFieldMergeInfo formFieldMergeInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -5033,7 +5299,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = updateAgreementMergeInfoValidateBeforeCall(authorization, ifMatch, agreementId, formFieldMergeInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateAgreementMergeInfoValidateBeforeCall(authorization, agreementId, formFieldMergeInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } @@ -5352,18 +5618,19 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for updateAgreementSecurityOptionsForParticipation * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param participantSetId The participant set identifier (required) * @param participantId The participant identifier (required) * @param participantSecurityOption Security options that apply to the participant (required) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call updateAgreementSecurityOptionsForParticipationCall(String authorization, String ifMatch, String agreementId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call updateAgreementSecurityOptionsForParticipationCall(String authorization, String agreementId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String ifMatch, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = participantSecurityOption; // create path and map variables @@ -5382,6 +5649,8 @@ public com.squareup.okhttp.Call updateAgreementSecurityOptionsForParticipationCa localVarHeaderParams.put("If-Match", apiClient.parameterToString(ifMatch)); if (xApiUser != null) localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); Map localVarFormParams = new HashMap(); @@ -5414,18 +5683,13 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call updateAgreementSecurityOptionsForParticipationValidateBeforeCall(String authorization, String ifMatch, String agreementId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateAgreementSecurityOptionsForParticipationValidateBeforeCall(String authorization, String agreementId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String ifMatch, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling updateAgreementSecurityOptionsForParticipation(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling updateAgreementSecurityOptionsForParticipation(Async)"); - } - // verify the required parameter 'agreementId' is set if (agreementId == null) { throw new ApiException("Missing the required parameter 'agreementId' when calling updateAgreementSecurityOptionsForParticipation(Async)"); @@ -5447,7 +5711,7 @@ private com.squareup.okhttp.Call updateAgreementSecurityOptionsForParticipationV } - com.squareup.okhttp.Call call = updateAgreementSecurityOptionsForParticipationCall(authorization, ifMatch, agreementId, participantSetId, participantId, participantSecurityOption, xApiUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateAgreementSecurityOptionsForParticipationCall(authorization, agreementId, participantSetId, participantId, participantSecurityOption, ifMatch, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); return call; } @@ -5456,33 +5720,35 @@ private com.squareup.okhttp.Call updateAgreementSecurityOptionsForParticipationV * Updates the security options for a particular participant. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param participantSetId The participant set identifier (required) * @param participantId The participant identifier (required) * @param participantSecurityOption Security options that apply to the participant (required) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void updateAgreementSecurityOptionsForParticipation(String authorization, String ifMatch, String agreementId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String xApiUser) throws ApiException { - updateAgreementSecurityOptionsForParticipationWithHttpInfo(authorization, ifMatch, agreementId, participantSetId, participantId, participantSecurityOption, xApiUser); + public void updateAgreementSecurityOptionsForParticipation(String authorization, String agreementId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String ifMatch, String xApiUser, String xOnBehalfOfUser) throws ApiException { + updateAgreementSecurityOptionsForParticipationWithHttpInfo(authorization, agreementId, participantSetId, participantId, participantSecurityOption, ifMatch, xApiUser, xOnBehalfOfUser); } /** * Updates the security options for a particular participant. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param participantSetId The participant set identifier (required) * @param participantId The participant identifier (required) * @param participantSecurityOption Security options that apply to the participant (required) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse updateAgreementSecurityOptionsForParticipationWithHttpInfo(String authorization, String ifMatch, String agreementId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String xApiUser) throws ApiException { - com.squareup.okhttp.Call call = updateAgreementSecurityOptionsForParticipationValidateBeforeCall(authorization, ifMatch, agreementId, participantSetId, participantId, participantSecurityOption, xApiUser, null, null); + public ApiResponse updateAgreementSecurityOptionsForParticipationWithHttpInfo(String authorization, String agreementId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String ifMatch, String xApiUser, String xOnBehalfOfUser) throws ApiException { + com.squareup.okhttp.Call call = updateAgreementSecurityOptionsForParticipationValidateBeforeCall(authorization, agreementId, participantSetId, participantId, participantSecurityOption, ifMatch, xApiUser, xOnBehalfOfUser, null, null); return apiClient.execute(call); } @@ -5490,17 +5756,18 @@ public ApiResponse updateAgreementSecurityOptionsForParticipationWithHttpI * Updates the security options for a particular participant. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param participantSetId The participant set identifier (required) * @param participantId The participant identifier (required) * @param participantSecurityOption Security options that apply to the participant (required) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call updateAgreementSecurityOptionsForParticipationAsync(String authorization, String ifMatch, String agreementId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String xApiUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateAgreementSecurityOptionsForParticipationAsync(String authorization, String agreementId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String ifMatch, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -5521,24 +5788,24 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = updateAgreementSecurityOptionsForParticipationValidateBeforeCall(authorization, ifMatch, agreementId, participantSetId, participantId, participantSecurityOption, xApiUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateAgreementSecurityOptionsForParticipationValidateBeforeCall(authorization, agreementId, participantSetId, participantId, participantSecurityOption, ifMatch, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } /** * Build call for updateAgreementState * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param agreementStateInfo (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call updateAgreementStateCall(String authorization, String ifMatch, String agreementId, AgreementStateInfo agreementStateInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call updateAgreementStateCall(String authorization, String agreementId, AgreementStateInfo agreementStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = agreementStateInfo; // create path and map variables @@ -5589,18 +5856,13 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call updateAgreementStateValidateBeforeCall(String authorization, String ifMatch, String agreementId, AgreementStateInfo agreementStateInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateAgreementStateValidateBeforeCall(String authorization, String agreementId, AgreementStateInfo agreementStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling updateAgreementState(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling updateAgreementState(Async)"); - } - // verify the required parameter 'agreementId' is set if (agreementId == null) { throw new ApiException("Missing the required parameter 'agreementId' when calling updateAgreementState(Async)"); @@ -5612,7 +5874,7 @@ private com.squareup.okhttp.Call updateAgreementStateValidateBeforeCall(String a } - com.squareup.okhttp.Call call = updateAgreementStateCall(authorization, ifMatch, agreementId, agreementStateInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateAgreementStateCall(authorization, agreementId, agreementStateInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); return call; } @@ -5621,31 +5883,31 @@ private com.squareup.okhttp.Call updateAgreementStateValidateBeforeCall(String a * Updates the state of an agreement identified by agreementId in the path. * This endpoint can be used by originator/sender of an agreement to transition between the states of agreement. An allowed transition would follow the following sequence: DRAFT -> AUTHORING -> IN_PROCESS -> CANCELLED. * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param agreementStateInfo (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void updateAgreementState(String authorization, String ifMatch, String agreementId, AgreementStateInfo agreementStateInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - updateAgreementStateWithHttpInfo(authorization, ifMatch, agreementId, agreementStateInfo, xApiUser, xOnBehalfOfUser); + public void updateAgreementState(String authorization, String agreementId, AgreementStateInfo agreementStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + updateAgreementStateWithHttpInfo(authorization, agreementId, agreementStateInfo, xApiUser, xOnBehalfOfUser, ifMatch); } /** * Updates the state of an agreement identified by agreementId in the path. * This endpoint can be used by originator/sender of an agreement to transition between the states of agreement. An allowed transition would follow the following sequence: DRAFT -> AUTHORING -> IN_PROCESS -> CANCELLED. * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param agreementStateInfo (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse updateAgreementStateWithHttpInfo(String authorization, String ifMatch, String agreementId, AgreementStateInfo agreementStateInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = updateAgreementStateValidateBeforeCall(authorization, ifMatch, agreementId, agreementStateInfo, xApiUser, xOnBehalfOfUser, null, null); + public ApiResponse updateAgreementStateWithHttpInfo(String authorization, String agreementId, AgreementStateInfo agreementStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + com.squareup.okhttp.Call call = updateAgreementStateValidateBeforeCall(authorization, agreementId, agreementStateInfo, xApiUser, xOnBehalfOfUser, ifMatch, null, null); return apiClient.execute(call); } @@ -5653,16 +5915,16 @@ public ApiResponse updateAgreementStateWithHttpInfo(String authorization, * Updates the state of an agreement identified by agreementId in the path. (asynchronously) * This endpoint can be used by originator/sender of an agreement to transition between the states of agreement. An allowed transition would follow the following sequence: DRAFT -> AUTHORING -> IN_PROCESS -> CANCELLED. * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param agreementStateInfo (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call updateAgreementStateAsync(String authorization, String ifMatch, String agreementId, AgreementStateInfo agreementStateInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateAgreementStateAsync(String authorization, String agreementId, AgreementStateInfo agreementStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -5683,7 +5945,158 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = updateAgreementStateValidateBeforeCall(authorization, ifMatch, agreementId, agreementStateInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateAgreementStateValidateBeforeCall(authorization, agreementId, agreementStateInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); + apiClient.executeAsync(call, callback); + return call; + } + /** + * Build call for updateAgreementVaulted + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_vault')\" oncontextmenu=\"this.href=oauthDoc('agreement_vault')\" target=\"oauthDoc\">agreement_vault</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) + * @param vaultEventInfo Information to vault an agreement (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call updateAgreementVaultedCall(String authorization, String agreementId, VaultEventInfo vaultEventInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = vaultEventInfo; + + // create path and map variables + String localVarPath = "/agreements/{agreementId}/vaulted" + .replaceAll("\\{" + "agreementId" + "\\}", apiClient.escapeString(agreementId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call updateAgreementVaultedValidateBeforeCall(String authorization, String agreementId, VaultEventInfo vaultEventInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling updateAgreementVaulted(Async)"); + } + + // verify the required parameter 'agreementId' is set + if (agreementId == null) { + throw new ApiException("Missing the required parameter 'agreementId' when calling updateAgreementVaulted(Async)"); + } + + // verify the required parameter 'vaultEventInfo' is set + if (vaultEventInfo == null) { + throw new ApiException("Missing the required parameter 'vaultEventInfo' when calling updateAgreementVaulted(Async)"); + } + + + com.squareup.okhttp.Call call = updateAgreementVaultedCall(authorization, agreementId, vaultEventInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + return call; + + } + + /** + * Complete the vaulting process and update the agreement as vaulted. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_vault')\" oncontextmenu=\"this.href=oauthDoc('agreement_vault')\" target=\"oauthDoc\">agreement_vault</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) + * @param vaultEventInfo Information to vault an agreement (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public void updateAgreementVaulted(String authorization, String agreementId, VaultEventInfo vaultEventInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { + updateAgreementVaultedWithHttpInfo(authorization, agreementId, vaultEventInfo, xApiUser, xOnBehalfOfUser); + } + + /** + * Complete the vaulting process and update the agreement as vaulted. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_vault')\" oncontextmenu=\"this.href=oauthDoc('agreement_vault')\" target=\"oauthDoc\">agreement_vault</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) + * @param vaultEventInfo Information to vault an agreement (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse updateAgreementVaultedWithHttpInfo(String authorization, String agreementId, VaultEventInfo vaultEventInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { + com.squareup.okhttp.Call call = updateAgreementVaultedValidateBeforeCall(authorization, agreementId, vaultEventInfo, xApiUser, xOnBehalfOfUser, null, null); + return apiClient.execute(call); + } + + /** + * Complete the vaulting process and update the agreement as vaulted. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_vault')\" oncontextmenu=\"this.href=oauthDoc('agreement_vault')\" target=\"oauthDoc\">agreement_vault</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) + * @param vaultEventInfo Information to vault an agreement (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call updateAgreementVaultedAsync(String authorization, String agreementId, VaultEventInfo vaultEventInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = updateAgreementVaultedValidateBeforeCall(authorization, agreementId, vaultEventInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } @@ -5841,17 +6254,17 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for updateFormFields * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) - * @param formFieldPutInfo List of form fields to add or replace (required) + * @param formFieldPutInfo List of form fields to set for agreement (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call updateFormFieldsCall(String authorization, String ifMatch, String agreementId, FormFieldPutInfo formFieldPutInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call updateFormFieldsCall(String authorization, String agreementId, FormFieldPutInfo formFieldPutInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = formFieldPutInfo; // create path and map variables @@ -5902,18 +6315,13 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call updateFormFieldsValidateBeforeCall(String authorization, String ifMatch, String agreementId, FormFieldPutInfo formFieldPutInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateFormFieldsValidateBeforeCall(String authorization, String agreementId, FormFieldPutInfo formFieldPutInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling updateFormFields(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling updateFormFields(Async)"); - } - // verify the required parameter 'agreementId' is set if (agreementId == null) { throw new ApiException("Missing the required parameter 'agreementId' when calling updateFormFields(Async)"); @@ -5925,7 +6333,7 @@ private com.squareup.okhttp.Call updateFormFieldsValidateBeforeCall(String autho } - com.squareup.okhttp.Call call = updateFormFieldsCall(authorization, ifMatch, agreementId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateFormFieldsCall(authorization, agreementId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); return call; } @@ -5934,16 +6342,16 @@ private com.squareup.okhttp.Call updateFormFieldsValidateBeforeCall(String autho * Updates form fields of an agreement. This will replace all fields in AUTHORING mode agreements, and will replace all fields except for text tag generated fields in DRAFT mode agreements. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) - * @param formFieldPutInfo List of form fields to add or replace (required) + * @param formFieldPutInfo List of form fields to set for agreement (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return AgreementFormFields * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public AgreementFormFields updateFormFields(String authorization, String ifMatch, String agreementId, FormFieldPutInfo formFieldPutInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - ApiResponse resp = updateFormFieldsWithHttpInfo(authorization, ifMatch, agreementId, formFieldPutInfo, xApiUser, xOnBehalfOfUser); + public AgreementFormFields updateFormFields(String authorization, String agreementId, FormFieldPutInfo formFieldPutInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + ApiResponse resp = updateFormFieldsWithHttpInfo(authorization, agreementId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, ifMatch); return resp.getData(); } @@ -5951,16 +6359,16 @@ public AgreementFormFields updateFormFields(String authorization, String ifMatch * Updates form fields of an agreement. This will replace all fields in AUTHORING mode agreements, and will replace all fields except for text tag generated fields in DRAFT mode agreements. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) - * @param formFieldPutInfo List of form fields to add or replace (required) + * @param formFieldPutInfo List of form fields to set for agreement (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return ApiResponse<AgreementFormFields> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse updateFormFieldsWithHttpInfo(String authorization, String ifMatch, String agreementId, FormFieldPutInfo formFieldPutInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = updateFormFieldsValidateBeforeCall(authorization, ifMatch, agreementId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, null, null); + public ApiResponse updateFormFieldsWithHttpInfo(String authorization, String agreementId, FormFieldPutInfo formFieldPutInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + com.squareup.okhttp.Call call = updateFormFieldsValidateBeforeCall(authorization, agreementId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, ifMatch, null, null); Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -5969,16 +6377,16 @@ public ApiResponse updateFormFieldsWithHttpInfo(String auth * Updates form fields of an agreement. This will replace all fields in AUTHORING mode agreements, and will replace all fields except for text tag generated fields in DRAFT mode agreements. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) - * @param formFieldPutInfo List of form fields to add or replace (required) + * @param formFieldPutInfo List of form fields to set for agreement (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call updateFormFieldsAsync(String authorization, String ifMatch, String agreementId, FormFieldPutInfo formFieldPutInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateFormFieldsAsync(String authorization, String agreementId, FormFieldPutInfo formFieldPutInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -5999,7 +6407,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = updateFormFieldsValidateBeforeCall(authorization, ifMatch, agreementId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateFormFieldsValidateBeforeCall(authorization, agreementId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; @@ -6007,18 +6415,18 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for updateParticipantSet * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param participantSetId The participant set identifier (required) * @param detailedParticipantSetInfo The new participant set info. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call updateParticipantSetCall(String authorization, String ifMatch, String agreementId, String participantSetId, DetailedParticipantSetInfo detailedParticipantSetInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call updateParticipantSetCall(String authorization, String agreementId, String participantSetId, DetailedParticipantSetInfo detailedParticipantSetInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = detailedParticipantSetInfo; // create path and map variables @@ -6070,18 +6478,13 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call updateParticipantSetValidateBeforeCall(String authorization, String ifMatch, String agreementId, String participantSetId, DetailedParticipantSetInfo detailedParticipantSetInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateParticipantSetValidateBeforeCall(String authorization, String agreementId, String participantSetId, DetailedParticipantSetInfo detailedParticipantSetInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling updateParticipantSet(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling updateParticipantSet(Async)"); - } - // verify the required parameter 'agreementId' is set if (agreementId == null) { throw new ApiException("Missing the required parameter 'agreementId' when calling updateParticipantSet(Async)"); @@ -6098,7 +6501,7 @@ private com.squareup.okhttp.Call updateParticipantSetValidateBeforeCall(String a } - com.squareup.okhttp.Call call = updateParticipantSetCall(authorization, ifMatch, agreementId, participantSetId, detailedParticipantSetInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateParticipantSetCall(authorization, agreementId, participantSetId, detailedParticipantSetInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); return call; } @@ -6107,33 +6510,33 @@ private com.squareup.okhttp.Call updateParticipantSetValidateBeforeCall(String a * Updates the participant set of an agreement identified by agreementId in the path. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param participantSetId The participant set identifier (required) * @param detailedParticipantSetInfo The new participant set info. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void updateParticipantSet(String authorization, String ifMatch, String agreementId, String participantSetId, DetailedParticipantSetInfo detailedParticipantSetInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - updateParticipantSetWithHttpInfo(authorization, ifMatch, agreementId, participantSetId, detailedParticipantSetInfo, xApiUser, xOnBehalfOfUser); + public void updateParticipantSet(String authorization, String agreementId, String participantSetId, DetailedParticipantSetInfo detailedParticipantSetInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + updateParticipantSetWithHttpInfo(authorization, agreementId, participantSetId, detailedParticipantSetInfo, xApiUser, xOnBehalfOfUser, ifMatch); } /** * Updates the participant set of an agreement identified by agreementId in the path. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param participantSetId The participant set identifier (required) * @param detailedParticipantSetInfo The new participant set info. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse updateParticipantSetWithHttpInfo(String authorization, String ifMatch, String agreementId, String participantSetId, DetailedParticipantSetInfo detailedParticipantSetInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = updateParticipantSetValidateBeforeCall(authorization, ifMatch, agreementId, participantSetId, detailedParticipantSetInfo, xApiUser, xOnBehalfOfUser, null, null); + public ApiResponse updateParticipantSetWithHttpInfo(String authorization, String agreementId, String participantSetId, DetailedParticipantSetInfo detailedParticipantSetInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + com.squareup.okhttp.Call call = updateParticipantSetValidateBeforeCall(authorization, agreementId, participantSetId, detailedParticipantSetInfo, xApiUser, xOnBehalfOfUser, ifMatch, null, null); return apiClient.execute(call); } @@ -6141,17 +6544,17 @@ public ApiResponse updateParticipantSetWithHttpInfo(String authorization, * Updates the participant set of an agreement identified by agreementId in the path. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param agreementId The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. (required) * @param participantSetId The participant set identifier (required) * @param detailedParticipantSetInfo The new participant set info. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call updateParticipantSetAsync(String authorization, String ifMatch, String agreementId, String participantSetId, DetailedParticipantSetInfo detailedParticipantSetInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateParticipantSetAsync(String authorization, String agreementId, String participantSetId, DetailedParticipantSetInfo detailedParticipantSetInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -6172,7 +6575,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = updateParticipantSetValidateBeforeCall(authorization, ifMatch, agreementId, participantSetId, detailedParticipantSetInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateParticipantSetValidateBeforeCall(authorization, agreementId, participantSetId, detailedParticipantSetInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } diff --git a/src/main/java/io/swagger/client/api/BaseUrisApi.java b/src/main/java/io/swagger/client/api/BaseUrisApi.java index 0f7848d..8548b31 100755 --- a/src/main/java/io/swagger/client/api/BaseUrisApi.java +++ b/src/main/java/io/swagger/client/api/BaseUrisApi.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) diff --git a/src/main/java/io/swagger/client/api/GroupsApi.java b/src/main/java/io/swagger/client/api/GroupsApi.java index f758509..38ebaf4 100755 --- a/src/main/java/io/swagger/client/api/GroupsApi.java +++ b/src/main/java/io/swagger/client/api/GroupsApi.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -43,6 +28,7 @@ import io.swagger.client.model.groups.DetailedGroupInfo; +import io.swagger.client.model.groups.GroupCreationResponse; import io.swagger.client.model.groups.GroupUsersInfo; import io.swagger.client.model.groups.GroupsInfo; @@ -71,6 +57,281 @@ public void setApiClient(ApiClient apiClient) { this.apiClient = apiClient; } + /** + * Build call for createGroup + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_write')\" oncontextmenu=\"this.href=oauthDoc('user_write')\" target=\"oauthDoc\">user_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param detailedGroupInfo Information necessary to create a group. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call createGroupCall(String authorization, DetailedGroupInfo detailedGroupInfo, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = detailedGroupInfo; + + // create path and map variables + String localVarPath = "/groups"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call createGroupValidateBeforeCall(String authorization, DetailedGroupInfo detailedGroupInfo, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling createGroup(Async)"); + } + + // verify the required parameter 'detailedGroupInfo' is set + if (detailedGroupInfo == null) { + throw new ApiException("Missing the required parameter 'detailedGroupInfo' when calling createGroup(Async)"); + } + + + com.squareup.okhttp.Call call = createGroupCall(authorization, detailedGroupInfo, xApiUser, progressListener, progressRequestListener); + return call; + + } + + /** + * Creates a new group in an account. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_write')\" oncontextmenu=\"this.href=oauthDoc('user_write')\" target=\"oauthDoc\">user_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param detailedGroupInfo Information necessary to create a group. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @return GroupCreationResponse + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public GroupCreationResponse createGroup(String authorization, DetailedGroupInfo detailedGroupInfo, String xApiUser) throws ApiException { + ApiResponse resp = createGroupWithHttpInfo(authorization, detailedGroupInfo, xApiUser); + return resp.getData(); + } + + /** + * Creates a new group in an account. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_write')\" oncontextmenu=\"this.href=oauthDoc('user_write')\" target=\"oauthDoc\">user_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param detailedGroupInfo Information necessary to create a group. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @return ApiResponse<GroupCreationResponse> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse createGroupWithHttpInfo(String authorization, DetailedGroupInfo detailedGroupInfo, String xApiUser) throws ApiException { + com.squareup.okhttp.Call call = createGroupValidateBeforeCall(authorization, detailedGroupInfo, xApiUser, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Creates a new group in an account. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_write')\" oncontextmenu=\"this.href=oauthDoc('user_write')\" target=\"oauthDoc\">user_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param detailedGroupInfo Information necessary to create a group. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call createGroupAsync(String authorization, DetailedGroupInfo detailedGroupInfo, String xApiUser, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = createGroupValidateBeforeCall(authorization, detailedGroupInfo, xApiUser, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for deleteGroup + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_write')\" oncontextmenu=\"this.href=oauthDoc('user_write')\" target=\"oauthDoc\">user_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call deleteGroupCall(String authorization, String groupId, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/groups/{groupId}" + .replaceAll("\\{" + "groupId" + "\\}", apiClient.escapeString(groupId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call deleteGroupValidateBeforeCall(String authorization, String groupId, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling deleteGroup(Async)"); + } + + // verify the required parameter 'groupId' is set + if (groupId == null) { + throw new ApiException("Missing the required parameter 'groupId' when calling deleteGroup(Async)"); + } + + + com.squareup.okhttp.Call call = deleteGroupCall(authorization, groupId, xApiUser, progressListener, progressRequestListener); + return call; + + } + + /** + * Delete an existing group. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_write')\" oncontextmenu=\"this.href=oauthDoc('user_write')\" target=\"oauthDoc\">user_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public void deleteGroup(String authorization, String groupId, String xApiUser) throws ApiException { + deleteGroupWithHttpInfo(authorization, groupId, xApiUser); + } + + /** + * Delete an existing group. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_write')\" oncontextmenu=\"this.href=oauthDoc('user_write')\" target=\"oauthDoc\">user_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse deleteGroupWithHttpInfo(String authorization, String groupId, String xApiUser) throws ApiException { + com.squareup.okhttp.Call call = deleteGroupValidateBeforeCall(authorization, groupId, xApiUser, null, null); + return apiClient.execute(call); + } + + /** + * Delete an existing group. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_write')\" oncontextmenu=\"this.href=oauthDoc('user_write')\" target=\"oauthDoc\">user_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call deleteGroupAsync(String authorization, String groupId, String xApiUser, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = deleteGroupValidateBeforeCall(authorization, groupId, xApiUser, progressListener, progressRequestListener); + apiClient.executeAsync(call, callback); + return call; + } /** * Build call for getGroupDetails * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_read')\" oncontextmenu=\"this.href=oauthDoc('user_read')\" target=\"oauthDoc\">user_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) @@ -505,4 +766,149 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don apiClient.executeAsync(call, localVarReturnType, callback); return call; } + /** + * Build call for modifyGroup + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_write')\" oncontextmenu=\"this.href=oauthDoc('user_write')\" target=\"oauthDoc\">user_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups (required) + * @param detailedGroupInfo Information necessary to update a group. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call modifyGroupCall(String authorization, String groupId, DetailedGroupInfo detailedGroupInfo, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = detailedGroupInfo; + + // create path and map variables + String localVarPath = "/groups/{groupId}" + .replaceAll("\\{" + "groupId" + "\\}", apiClient.escapeString(groupId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call modifyGroupValidateBeforeCall(String authorization, String groupId, DetailedGroupInfo detailedGroupInfo, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling modifyGroup(Async)"); + } + + // verify the required parameter 'groupId' is set + if (groupId == null) { + throw new ApiException("Missing the required parameter 'groupId' when calling modifyGroup(Async)"); + } + + // verify the required parameter 'detailedGroupInfo' is set + if (detailedGroupInfo == null) { + throw new ApiException("Missing the required parameter 'detailedGroupInfo' when calling modifyGroup(Async)"); + } + + + com.squareup.okhttp.Call call = modifyGroupCall(authorization, groupId, detailedGroupInfo, xApiUser, progressListener, progressRequestListener); + return call; + + } + + /** + * Update an existing group. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_write')\" oncontextmenu=\"this.href=oauthDoc('user_write')\" target=\"oauthDoc\">user_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups (required) + * @param detailedGroupInfo Information necessary to update a group. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public void modifyGroup(String authorization, String groupId, DetailedGroupInfo detailedGroupInfo, String xApiUser) throws ApiException { + modifyGroupWithHttpInfo(authorization, groupId, detailedGroupInfo, xApiUser); + } + + /** + * Update an existing group. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_write')\" oncontextmenu=\"this.href=oauthDoc('user_write')\" target=\"oauthDoc\">user_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups (required) + * @param detailedGroupInfo Information necessary to update a group. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse modifyGroupWithHttpInfo(String authorization, String groupId, DetailedGroupInfo detailedGroupInfo, String xApiUser) throws ApiException { + com.squareup.okhttp.Call call = modifyGroupValidateBeforeCall(authorization, groupId, detailedGroupInfo, xApiUser, null, null); + return apiClient.execute(call); + } + + /** + * Update an existing group. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_write')\" oncontextmenu=\"this.href=oauthDoc('user_write')\" target=\"oauthDoc\">user_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups (required) + * @param detailedGroupInfo Information necessary to update a group. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call modifyGroupAsync(String authorization, String groupId, DetailedGroupInfo detailedGroupInfo, String xApiUser, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = modifyGroupValidateBeforeCall(authorization, groupId, detailedGroupInfo, xApiUser, progressListener, progressRequestListener); + apiClient.executeAsync(call, callback); + return call; + } } diff --git a/src/main/java/io/swagger/client/api/LibraryDocumentsApi.java b/src/main/java/io/swagger/client/api/LibraryDocumentsApi.java index e4e7287..830f19a 100755 --- a/src/main/java/io/swagger/client/api/LibraryDocumentsApi.java +++ b/src/main/java/io/swagger/client/api/LibraryDocumentsApi.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -43,15 +28,20 @@ import io.swagger.client.model.libraryDocuments.DocumentImageUrlsInfo; +import io.swagger.client.model.libraryDocuments.DocumentUrl; import io.swagger.client.model.libraryDocuments.Documents; +import io.swagger.client.model.libraryDocuments.FormFieldPutInfo; import io.swagger.client.model.libraryDocuments.LibraryDocumentCreationInfoV6; import io.swagger.client.model.libraryDocuments.LibraryDocumentCreationResponse; import io.swagger.client.model.libraryDocuments.LibraryDocumentEventList; +import io.swagger.client.model.libraryDocuments.LibraryDocumentFormFields; import io.swagger.client.model.libraryDocuments.LibraryDocumentInfo; +import io.swagger.client.model.libraryDocuments.LibraryDocumentMembersInfo; import io.swagger.client.model.libraryDocuments.LibraryDocumentStateInfo; import io.swagger.client.model.libraryDocuments.LibraryDocumentViewResponse; import io.swagger.client.model.libraryDocuments.LibraryDocuments; import io.swagger.client.model.libraryDocuments.LibraryViewInfo; +import io.swagger.client.model.libraryDocuments.MyAgreementInfo; import io.swagger.client.model.libraryDocuments.Note; import io.swagger.client.model.libraryDocuments.VisibilityInfo; @@ -386,6 +376,158 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don apiClient.executeAsync(call, localVarReturnType, callback); return call; } + /** + * Build call for getAllLibraryDocumentMembers + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getAllLibraryDocumentMembersCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/libraryDocuments/{libraryDocumentId}/members" + .replaceAll("\\{" + "libraryDocumentId" + "\\}", apiClient.escapeString(libraryDocumentId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + if (ifNoneMatch != null) + localVarHeaderParams.put("If-None-Match", apiClient.parameterToString(ifNoneMatch)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getAllLibraryDocumentMembersValidateBeforeCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getAllLibraryDocumentMembers(Async)"); + } + + // verify the required parameter 'libraryDocumentId' is set + if (libraryDocumentId == null) { + throw new ApiException("Missing the required parameter 'libraryDocumentId' when calling getAllLibraryDocumentMembers(Async)"); + } + + + com.squareup.okhttp.Call call = getAllLibraryDocumentMembersCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves information of members (creator) of the library document. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @return LibraryDocumentMembersInfo + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public LibraryDocumentMembersInfo getAllLibraryDocumentMembers(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + ApiResponse resp = getAllLibraryDocumentMembersWithHttpInfo(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + return resp.getData(); + } + + /** + * Retrieves information of members (creator) of the library document. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @return ApiResponse<LibraryDocumentMembersInfo> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getAllLibraryDocumentMembersWithHttpInfo(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + com.squareup.okhttp.Call call = getAllLibraryDocumentMembersValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves information of members (creator) of the library document. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getAllLibraryDocumentMembersAsync(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getAllLibraryDocumentMembersValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } /** * Build call for getCombinedDocument * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) @@ -861,12 +1003,14 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) + * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getFormDataCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getFormDataCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -875,6 +1019,10 @@ public com.squareup.okhttp.Call getFormDataCall(String authorization, String lib List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); + if (cursor != null) + localVarQueryParams.addAll(apiClient.parameterToPair("cursor", cursor)); + if (pageSize != null) + localVarQueryParams.addAll(apiClient.parameterToPair("pageSize", pageSize)); Map localVarHeaderParams = new HashMap(); if (authorization != null) @@ -889,7 +1037,7 @@ public com.squareup.okhttp.Call getFormDataCall(String authorization, String lib Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "text/csv" + "application/json", "text/csv" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); @@ -917,7 +1065,7 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getFormDataValidateBeforeCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getFormDataValidateBeforeCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { @@ -930,7 +1078,7 @@ private com.squareup.okhttp.Call getFormDataValidateBeforeCall(String authorizat } - com.squareup.okhttp.Call call = getFormDataCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getFormDataCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, cursor, pageSize, progressListener, progressRequestListener); return call; } @@ -943,11 +1091,13 @@ private com.squareup.okhttp.Call getFormDataValidateBeforeCall(String authorizat * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) + * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) * @return byte[] * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public byte[] getFormData(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { - ApiResponse resp = getFormDataWithHttpInfo(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + public byte[] getFormData(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, String cursor, Integer pageSize) throws ApiException { + ApiResponse resp = getFormDataWithHttpInfo(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, cursor, pageSize); return resp.getData(); } @@ -959,11 +1109,13 @@ public byte[] getFormData(String authorization, String libraryDocumentId, String * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) + * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) * @return ApiResponse<byte[]> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getFormDataWithHttpInfo(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { - com.squareup.okhttp.Call call = getFormDataValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); + public ApiResponse getFormDataWithHttpInfo(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, String cursor, Integer pageSize) throws ApiException { + com.squareup.okhttp.Call call = getFormDataValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, cursor, pageSize, null, null); Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -976,11 +1128,13 @@ public ApiResponse getFormDataWithHttpInfo(String authorization, String * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) + * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getFormDataAsync(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getFormDataAsync(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, String cursor, Integer pageSize, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -1001,16 +1155,15 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getFormDataValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getFormDataValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, cursor, pageSize, progressListener, progressRequestListener); Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } /** - * Build call for getLibraryDocument + * Build call for getFormFields * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) - * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified library document (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -1019,13 +1172,12 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getLibraryDocumentCall(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getFormFieldsCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/libraryDocuments/{libraryDocumentId}/documents/{documentId}" - .replaceAll("\\{" + "libraryDocumentId" + "\\}", apiClient.escapeString(libraryDocumentId.toString())) - .replaceAll("\\{" + "documentId" + "\\}", apiClient.escapeString(documentId.toString())); + String localVarPath = "/libraryDocuments/{libraryDocumentId}/formFields" + .replaceAll("\\{" + "libraryDocumentId" + "\\}", apiClient.escapeString(libraryDocumentId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -1043,7 +1195,7 @@ public com.squareup.okhttp.Call getLibraryDocumentCall(String authorization, Str Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/pdf", "application/pdf;encoding=base64" + "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); @@ -1071,70 +1223,62 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getLibraryDocumentValidateBeforeCall(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getFormFieldsValidateBeforeCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { - throw new ApiException("Missing the required parameter 'authorization' when calling getLibraryDocument(Async)"); + throw new ApiException("Missing the required parameter 'authorization' when calling getFormFields(Async)"); } // verify the required parameter 'libraryDocumentId' is set if (libraryDocumentId == null) { - throw new ApiException("Missing the required parameter 'libraryDocumentId' when calling getLibraryDocument(Async)"); - } - - // verify the required parameter 'documentId' is set - if (documentId == null) { - throw new ApiException("Missing the required parameter 'documentId' when calling getLibraryDocument(Async)"); + throw new ApiException("Missing the required parameter 'libraryDocumentId' when calling getFormFields(Async)"); } - com.squareup.okhttp.Call call = getLibraryDocumentCall(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getFormFieldsCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); return call; } /** - * Retrieves the file stream of a document of library document. + * Retrieves details of form fields of a library document. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) - * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified library document (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @return byte[] + * @return LibraryDocumentFormFields * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public byte[] getLibraryDocument(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { - ApiResponse resp = getLibraryDocumentWithHttpInfo(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + public LibraryDocumentFormFields getFormFields(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + ApiResponse resp = getFormFieldsWithHttpInfo(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); return resp.getData(); } /** - * Retrieves the file stream of a document of library document. + * Retrieves details of form fields of a library document. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) - * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified library document (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @return ApiResponse<byte[]> + * @return ApiResponse<LibraryDocumentFormFields> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getLibraryDocumentWithHttpInfo(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { - com.squareup.okhttp.Call call = getLibraryDocumentValidateBeforeCall(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse getFormFieldsWithHttpInfo(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + com.squareup.okhttp.Call call = getFormFieldsValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } /** - * Retrieves the file stream of a document of library document. (asynchronously) + * Retrieves details of form fields of a library document. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) - * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified library document (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -1142,7 +1286,7 @@ public ApiResponse getLibraryDocumentWithHttpInfo(String authorization, * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getLibraryDocumentAsync(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getFormFieldsAsync(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -1163,32 +1307,34 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getLibraryDocumentValidateBeforeCall(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + com.squareup.okhttp.Call call = getFormFieldsValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } /** - * Build call for getLibraryDocumentAuditTrail + * Build call for getLibraryCombinedDocumentUrl * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param attachAuditReport When set to true, attach an audit report to the library document PDF. The default value is false. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getLibraryDocumentAuditTrailCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getLibraryCombinedDocumentUrlCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, Boolean attachAuditReport, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/libraryDocuments/{libraryDocumentId}/auditTrail" + String localVarPath = "/libraryDocuments/{libraryDocumentId}/combinedDocument/url" .replaceAll("\\{" + "libraryDocumentId" + "\\}", apiClient.escapeString(libraryDocumentId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); + if (attachAuditReport != null) + localVarQueryParams.addAll(apiClient.parameterToPair("attachAuditReport", attachAuditReport)); Map localVarHeaderParams = new HashMap(); if (authorization != null) @@ -1197,13 +1343,11 @@ public com.squareup.okhttp.Call getLibraryDocumentAuditTrailCall(String authoriz localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); if (xOnBehalfOfUser != null) localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); - if (ifNoneMatch != null) - localVarHeaderParams.put("If-None-Match", apiClient.parameterToString(ifNoneMatch)); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/pdf", "application/pdf;encoding=base64" + "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); @@ -1231,70 +1375,70 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getLibraryDocumentAuditTrailValidateBeforeCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getLibraryCombinedDocumentUrlValidateBeforeCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, Boolean attachAuditReport, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { - throw new ApiException("Missing the required parameter 'authorization' when calling getLibraryDocumentAuditTrail(Async)"); + throw new ApiException("Missing the required parameter 'authorization' when calling getLibraryCombinedDocumentUrl(Async)"); } // verify the required parameter 'libraryDocumentId' is set if (libraryDocumentId == null) { - throw new ApiException("Missing the required parameter 'libraryDocumentId' when calling getLibraryDocumentAuditTrail(Async)"); + throw new ApiException("Missing the required parameter 'libraryDocumentId' when calling getLibraryCombinedDocumentUrl(Async)"); } - com.squareup.okhttp.Call call = getLibraryDocumentAuditTrailCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getLibraryCombinedDocumentUrlCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, attachAuditReport, progressListener, progressRequestListener); return call; } /** - * Retrieves the audit trail associated with a library document. + * Retrieves url of all visible pages of all the documents associated with a library document. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @return byte[] + * @param attachAuditReport When set to true, attach an audit report to the library document PDF. The default value is false. (optional) + * @return DocumentUrl * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public byte[] getLibraryDocumentAuditTrail(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { - ApiResponse resp = getLibraryDocumentAuditTrailWithHttpInfo(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + public DocumentUrl getLibraryCombinedDocumentUrl(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, Boolean attachAuditReport) throws ApiException { + ApiResponse resp = getLibraryCombinedDocumentUrlWithHttpInfo(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, attachAuditReport); return resp.getData(); } /** - * Retrieves the audit trail associated with a library document. + * Retrieves url of all visible pages of all the documents associated with a library document. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @return ApiResponse<byte[]> + * @param attachAuditReport When set to true, attach an audit report to the library document PDF. The default value is false. (optional) + * @return ApiResponse<DocumentUrl> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getLibraryDocumentAuditTrailWithHttpInfo(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { - com.squareup.okhttp.Call call = getLibraryDocumentAuditTrailValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse getLibraryCombinedDocumentUrlWithHttpInfo(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, Boolean attachAuditReport) throws ApiException { + com.squareup.okhttp.Call call = getLibraryCombinedDocumentUrlValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, attachAuditReport, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } /** - * Retrieves the audit trail associated with a library document. (asynchronously) + * Retrieves url of all visible pages of all the documents associated with a library document. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param attachAuditReport When set to true, attach an audit report to the library document PDF. The default value is false. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getLibraryDocumentAuditTrailAsync(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getLibraryCombinedDocumentUrlAsync(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, Boolean attachAuditReport, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -1315,43 +1459,34 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getLibraryDocumentAuditTrailValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + com.squareup.okhttp.Call call = getLibraryCombinedDocumentUrlValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, attachAuditReport, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } /** - * Build call for getLibraryDocumentImageUrls + * Build call for getLibraryDocument * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified library document (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @param imageSizes A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. (optional) - * @param startPage Start of page number range for which imageUrls are requested. Starting page number should be greater than 0. (optional) - * @param endPage End of page number range for which imageUrls are requested. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getLibraryDocumentImageUrlsCall(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, String imageSizes, Integer startPage, Integer endPage, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getLibraryDocumentCall(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/libraryDocuments/{libraryDocumentId}/documents/{documentId}/imageUrls" + String localVarPath = "/libraryDocuments/{libraryDocumentId}/documents/{documentId}" .replaceAll("\\{" + "libraryDocumentId" + "\\}", apiClient.escapeString(libraryDocumentId.toString())) .replaceAll("\\{" + "documentId" + "\\}", apiClient.escapeString(documentId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); - if (imageSizes != null) - localVarQueryParams.addAll(apiClient.parameterToPair("imageSizes", imageSizes)); - if (startPage != null) - localVarQueryParams.addAll(apiClient.parameterToPair("startPage", startPage)); - if (endPage != null) - localVarQueryParams.addAll(apiClient.parameterToPair("endPage", endPage)); Map localVarHeaderParams = new HashMap(); if (authorization != null) @@ -1366,7 +1501,7 @@ public com.squareup.okhttp.Call getLibraryDocumentImageUrlsCall(String authoriza Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/json" + "application/pdf", "application/pdf;encoding=base64" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); @@ -1394,31 +1529,31 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getLibraryDocumentImageUrlsValidateBeforeCall(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, String imageSizes, Integer startPage, Integer endPage, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getLibraryDocumentValidateBeforeCall(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { - throw new ApiException("Missing the required parameter 'authorization' when calling getLibraryDocumentImageUrls(Async)"); + throw new ApiException("Missing the required parameter 'authorization' when calling getLibraryDocument(Async)"); } // verify the required parameter 'libraryDocumentId' is set if (libraryDocumentId == null) { - throw new ApiException("Missing the required parameter 'libraryDocumentId' when calling getLibraryDocumentImageUrls(Async)"); + throw new ApiException("Missing the required parameter 'libraryDocumentId' when calling getLibraryDocument(Async)"); } // verify the required parameter 'documentId' is set if (documentId == null) { - throw new ApiException("Missing the required parameter 'documentId' when calling getLibraryDocumentImageUrls(Async)"); + throw new ApiException("Missing the required parameter 'documentId' when calling getLibraryDocument(Async)"); } - com.squareup.okhttp.Call call = getLibraryDocumentImageUrlsCall(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, imageSizes, startPage, endPage, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getLibraryDocumentCall(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); return call; } /** - * Retrieves image urls of all visible pages of a document associated with a library document. + * Retrieves the file stream of a document of library document. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) @@ -1426,19 +1561,16 @@ private com.squareup.okhttp.Call getLibraryDocumentImageUrlsValidateBeforeCall(S * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @param imageSizes A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. (optional) - * @param startPage Start of page number range for which imageUrls are requested. Starting page number should be greater than 0. (optional) - * @param endPage End of page number range for which imageUrls are requested. (optional) - * @return DocumentImageUrlsInfo + * @return byte[] * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public DocumentImageUrlsInfo getLibraryDocumentImageUrls(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, String imageSizes, Integer startPage, Integer endPage) throws ApiException { - ApiResponse resp = getLibraryDocumentImageUrlsWithHttpInfo(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, imageSizes, startPage, endPage); + public byte[] getLibraryDocument(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + ApiResponse resp = getLibraryDocumentWithHttpInfo(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); return resp.getData(); } /** - * Retrieves image urls of all visible pages of a document associated with a library document. + * Retrieves the file stream of a document of library document. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) @@ -1446,35 +1578,507 @@ public DocumentImageUrlsInfo getLibraryDocumentImageUrls(String authorization, S * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @param imageSizes A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. (optional) - * @param startPage Start of page number range for which imageUrls are requested. Starting page number should be greater than 0. (optional) - * @param endPage End of page number range for which imageUrls are requested. (optional) - * @return ApiResponse<DocumentImageUrlsInfo> + * @return ApiResponse<byte[]> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getLibraryDocumentImageUrlsWithHttpInfo(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, String imageSizes, Integer startPage, Integer endPage) throws ApiException { - com.squareup.okhttp.Call call = getLibraryDocumentImageUrlsValidateBeforeCall(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, imageSizes, startPage, endPage, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse getLibraryDocumentWithHttpInfo(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + com.squareup.okhttp.Call call = getLibraryDocumentValidateBeforeCall(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } /** - * Retrieves image urls of all visible pages of a document associated with a library document. (asynchronously) + * Retrieves the file stream of a document of library document. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified library document (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getLibraryDocumentAsync(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getLibraryDocumentValidateBeforeCall(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getLibraryDocumentAuditTrail + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getLibraryDocumentAuditTrailCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/libraryDocuments/{libraryDocumentId}/auditTrail" + .replaceAll("\\{" + "libraryDocumentId" + "\\}", apiClient.escapeString(libraryDocumentId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + if (ifNoneMatch != null) + localVarHeaderParams.put("If-None-Match", apiClient.parameterToString(ifNoneMatch)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/pdf", "application/pdf;encoding=base64" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getLibraryDocumentAuditTrailValidateBeforeCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getLibraryDocumentAuditTrail(Async)"); + } + + // verify the required parameter 'libraryDocumentId' is set + if (libraryDocumentId == null) { + throw new ApiException("Missing the required parameter 'libraryDocumentId' when calling getLibraryDocumentAuditTrail(Async)"); + } + + + com.squareup.okhttp.Call call = getLibraryDocumentAuditTrailCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves the audit trail associated with a library document. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @return byte[] + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public byte[] getLibraryDocumentAuditTrail(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + ApiResponse resp = getLibraryDocumentAuditTrailWithHttpInfo(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + return resp.getData(); + } + + /** + * Retrieves the audit trail associated with a library document. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @return ApiResponse<byte[]> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getLibraryDocumentAuditTrailWithHttpInfo(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + com.squareup.okhttp.Call call = getLibraryDocumentAuditTrailValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves the audit trail associated with a library document. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getLibraryDocumentAuditTrailAsync(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getLibraryDocumentAuditTrailValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getLibraryDocumentImageUrls + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified library document (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param imageSizes A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. (optional) + * @param startPage Start of page number range for which imageUrls are requested. Starting page number should be greater than 0. (optional) + * @param endPage End of page number range for which imageUrls are requested. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getLibraryDocumentImageUrlsCall(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String imageSizes, Integer startPage, Integer endPage, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/libraryDocuments/{libraryDocumentId}/documents/{documentId}/imageUrls" + .replaceAll("\\{" + "libraryDocumentId" + "\\}", apiClient.escapeString(libraryDocumentId.toString())) + .replaceAll("\\{" + "documentId" + "\\}", apiClient.escapeString(documentId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (imageSizes != null) + localVarQueryParams.addAll(apiClient.parameterToPair("imageSizes", imageSizes)); + if (startPage != null) + localVarQueryParams.addAll(apiClient.parameterToPair("startPage", startPage)); + if (endPage != null) + localVarQueryParams.addAll(apiClient.parameterToPair("endPage", endPage)); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getLibraryDocumentImageUrlsValidateBeforeCall(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String imageSizes, Integer startPage, Integer endPage, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getLibraryDocumentImageUrls(Async)"); + } + + // verify the required parameter 'libraryDocumentId' is set + if (libraryDocumentId == null) { + throw new ApiException("Missing the required parameter 'libraryDocumentId' when calling getLibraryDocumentImageUrls(Async)"); + } + + // verify the required parameter 'documentId' is set + if (documentId == null) { + throw new ApiException("Missing the required parameter 'documentId' when calling getLibraryDocumentImageUrls(Async)"); + } + + + com.squareup.okhttp.Call call = getLibraryDocumentImageUrlsCall(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, imageSizes, startPage, endPage, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves image urls of all visible pages of a document associated with a library document. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified library document (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param imageSizes A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. (optional) + * @param startPage Start of page number range for which imageUrls are requested. Starting page number should be greater than 0. (optional) + * @param endPage End of page number range for which imageUrls are requested. (optional) + * @return DocumentImageUrlsInfo + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public DocumentImageUrlsInfo getLibraryDocumentImageUrls(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String imageSizes, Integer startPage, Integer endPage) throws ApiException { + ApiResponse resp = getLibraryDocumentImageUrlsWithHttpInfo(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, imageSizes, startPage, endPage); + return resp.getData(); + } + + /** + * Retrieves image urls of all visible pages of a document associated with a library document. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified library document (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param imageSizes A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. (optional) + * @param startPage Start of page number range for which imageUrls are requested. Starting page number should be greater than 0. (optional) + * @param endPage End of page number range for which imageUrls are requested. (optional) + * @return ApiResponse<DocumentImageUrlsInfo> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getLibraryDocumentImageUrlsWithHttpInfo(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String imageSizes, Integer startPage, Integer endPage) throws ApiException { + com.squareup.okhttp.Call call = getLibraryDocumentImageUrlsValidateBeforeCall(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, imageSizes, startPage, endPage, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves image urls of all visible pages of a document associated with a library document. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified library document (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param imageSizes A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. (optional) + * @param startPage Start of page number range for which imageUrls are requested. Starting page number should be greater than 0. (optional) + * @param endPage End of page number range for which imageUrls are requested. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getLibraryDocumentImageUrlsAsync(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String imageSizes, Integer startPage, Integer endPage, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getLibraryDocumentImageUrlsValidateBeforeCall(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, imageSizes, startPage, endPage, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getLibraryDocumentInfo + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getLibraryDocumentInfoCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/libraryDocuments/{libraryDocumentId}" + .replaceAll("\\{" + "libraryDocumentId" + "\\}", apiClient.escapeString(libraryDocumentId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + if (ifNoneMatch != null) + localVarHeaderParams.put("If-None-Match", apiClient.parameterToString(ifNoneMatch)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getLibraryDocumentInfoValidateBeforeCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getLibraryDocumentInfo(Async)"); + } + + // verify the required parameter 'libraryDocumentId' is set + if (libraryDocumentId == null) { + throw new ApiException("Missing the required parameter 'libraryDocumentId' when calling getLibraryDocumentInfo(Async)"); + } + + + com.squareup.okhttp.Call call = getLibraryDocumentInfoCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves the details of a library document. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @return LibraryDocumentCreationInfoV6 + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public LibraryDocumentCreationInfoV6 getLibraryDocumentInfo(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + ApiResponse resp = getLibraryDocumentInfoWithHttpInfo(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + return resp.getData(); + } + + /** + * Retrieves the details of a library document. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @return ApiResponse<LibraryDocumentCreationInfoV6> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getLibraryDocumentInfoWithHttpInfo(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + com.squareup.okhttp.Call call = getLibraryDocumentInfoValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves the details of a library document. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) - * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified library document (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @param imageSizes A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. (optional) - * @param startPage Start of page number range for which imageUrls are requested. Starting page number should be greater than 0. (optional) - * @param endPage End of page number range for which imageUrls are requested. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getLibraryDocumentImageUrlsAsync(String authorization, String libraryDocumentId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, String imageSizes, Integer startPage, Integer endPage, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getLibraryDocumentInfoAsync(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -1495,28 +2099,26 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getLibraryDocumentImageUrlsValidateBeforeCall(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, imageSizes, startPage, endPage, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + com.squareup.okhttp.Call call = getLibraryDocumentInfoValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } /** - * Build call for getLibraryDocumentInfo + * Build call for getLibraryDocumentInfoForUser * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) - * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getLibraryDocumentInfoCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getLibraryDocumentInfoForUserCall(String authorization, String libraryDocumentId, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/libraryDocuments/{libraryDocumentId}" + String localVarPath = "/libraryDocuments/{libraryDocumentId}/me" .replaceAll("\\{" + "libraryDocumentId" + "\\}", apiClient.escapeString(libraryDocumentId.toString())); List localVarQueryParams = new ArrayList(); @@ -1527,10 +2129,6 @@ public com.squareup.okhttp.Call getLibraryDocumentInfoCall(String authorization, localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); if (xApiUser != null) localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); - if (xOnBehalfOfUser != null) - localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); - if (ifNoneMatch != null) - localVarHeaderParams.put("If-None-Match", apiClient.parameterToString(ifNoneMatch)); Map localVarFormParams = new HashMap(); @@ -1563,70 +2161,64 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getLibraryDocumentInfoValidateBeforeCall(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getLibraryDocumentInfoForUserValidateBeforeCall(String authorization, String libraryDocumentId, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { - throw new ApiException("Missing the required parameter 'authorization' when calling getLibraryDocumentInfo(Async)"); + throw new ApiException("Missing the required parameter 'authorization' when calling getLibraryDocumentInfoForUser(Async)"); } // verify the required parameter 'libraryDocumentId' is set if (libraryDocumentId == null) { - throw new ApiException("Missing the required parameter 'libraryDocumentId' when calling getLibraryDocumentInfo(Async)"); + throw new ApiException("Missing the required parameter 'libraryDocumentId' when calling getLibraryDocumentInfoForUser(Async)"); } - com.squareup.okhttp.Call call = getLibraryDocumentInfoCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getLibraryDocumentInfoForUserCall(authorization, libraryDocumentId, xApiUser, progressListener, progressRequestListener); return call; } /** - * Retrieves the details of a library document. + * Retrieves the library document information related to the api caller * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) - * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @return LibraryDocumentCreationInfoV6 + * @return MyAgreementInfo * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public LibraryDocumentCreationInfoV6 getLibraryDocumentInfo(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { - ApiResponse resp = getLibraryDocumentInfoWithHttpInfo(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + public MyAgreementInfo getLibraryDocumentInfoForUser(String authorization, String libraryDocumentId, String xApiUser) throws ApiException { + ApiResponse resp = getLibraryDocumentInfoForUserWithHttpInfo(authorization, libraryDocumentId, xApiUser); return resp.getData(); } /** - * Retrieves the details of a library document. + * Retrieves the library document information related to the api caller * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) - * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @return ApiResponse<LibraryDocumentCreationInfoV6> + * @return ApiResponse<MyAgreementInfo> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getLibraryDocumentInfoWithHttpInfo(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { - com.squareup.okhttp.Call call = getLibraryDocumentInfoValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse getLibraryDocumentInfoForUserWithHttpInfo(String authorization, String libraryDocumentId, String xApiUser) throws ApiException { + com.squareup.okhttp.Call call = getLibraryDocumentInfoForUserValidateBeforeCall(authorization, libraryDocumentId, xApiUser, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } /** - * Retrieves the details of a library document. (asynchronously) + * Retrieves the library document information related to the api caller (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) - * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getLibraryDocumentInfoAsync(String authorization, String libraryDocumentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getLibraryDocumentInfoForUserAsync(String authorization, String libraryDocumentId, String xApiUser, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -1647,8 +2239,8 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getLibraryDocumentInfoValidateBeforeCall(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + com.squareup.okhttp.Call call = getLibraryDocumentInfoForUserValidateBeforeCall(authorization, libraryDocumentId, xApiUser, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } @@ -1803,6 +2395,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) * @param showHiddenLibraryDocuments A query parameter to fetch all the hidden library documents along with the visible library documents. Default value is false. (optional) * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) @@ -1811,7 +2404,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getLibraryDocumentsCall(String authorization, String xApiUser, String xOnBehalfOfUser, Boolean showHiddenLibraryDocuments, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getLibraryDocumentsCall(String authorization, String xApiUser, String xOnBehalfOfUser, String groupId, Boolean showHiddenLibraryDocuments, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -1819,6 +2412,8 @@ public com.squareup.okhttp.Call getLibraryDocumentsCall(String authorization, St List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); + if (groupId != null) + localVarQueryParams.addAll(apiClient.parameterToPair("groupId", groupId)); if (showHiddenLibraryDocuments != null) localVarQueryParams.addAll(apiClient.parameterToPair("showHiddenLibraryDocuments", showHiddenLibraryDocuments)); if (cursor != null) @@ -1865,7 +2460,7 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getLibraryDocumentsValidateBeforeCall(String authorization, String xApiUser, String xOnBehalfOfUser, Boolean showHiddenLibraryDocuments, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getLibraryDocumentsValidateBeforeCall(String authorization, String xApiUser, String xOnBehalfOfUser, String groupId, Boolean showHiddenLibraryDocuments, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { @@ -1873,7 +2468,7 @@ private com.squareup.okhttp.Call getLibraryDocumentsValidateBeforeCall(String au } - com.squareup.okhttp.Call call = getLibraryDocumentsCall(authorization, xApiUser, xOnBehalfOfUser, showHiddenLibraryDocuments, cursor, pageSize, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getLibraryDocumentsCall(authorization, xApiUser, xOnBehalfOfUser, groupId, showHiddenLibraryDocuments, cursor, pageSize, progressListener, progressRequestListener); return call; } @@ -1884,14 +2479,15 @@ private com.squareup.okhttp.Call getLibraryDocumentsValidateBeforeCall(String au * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) * @param showHiddenLibraryDocuments A query parameter to fetch all the hidden library documents along with the visible library documents. Default value is false. (optional) * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) * @return LibraryDocuments * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public LibraryDocuments getLibraryDocuments(String authorization, String xApiUser, String xOnBehalfOfUser, Boolean showHiddenLibraryDocuments, String cursor, Integer pageSize) throws ApiException { - ApiResponse resp = getLibraryDocumentsWithHttpInfo(authorization, xApiUser, xOnBehalfOfUser, showHiddenLibraryDocuments, cursor, pageSize); + public LibraryDocuments getLibraryDocuments(String authorization, String xApiUser, String xOnBehalfOfUser, String groupId, Boolean showHiddenLibraryDocuments, String cursor, Integer pageSize) throws ApiException { + ApiResponse resp = getLibraryDocumentsWithHttpInfo(authorization, xApiUser, xOnBehalfOfUser, groupId, showHiddenLibraryDocuments, cursor, pageSize); return resp.getData(); } @@ -1901,14 +2497,15 @@ public LibraryDocuments getLibraryDocuments(String authorization, String xApiUse * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) * @param showHiddenLibraryDocuments A query parameter to fetch all the hidden library documents along with the visible library documents. Default value is false. (optional) * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) * @return ApiResponse<LibraryDocuments> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getLibraryDocumentsWithHttpInfo(String authorization, String xApiUser, String xOnBehalfOfUser, Boolean showHiddenLibraryDocuments, String cursor, Integer pageSize) throws ApiException { - com.squareup.okhttp.Call call = getLibraryDocumentsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, showHiddenLibraryDocuments, cursor, pageSize, null, null); + public ApiResponse getLibraryDocumentsWithHttpInfo(String authorization, String xApiUser, String xOnBehalfOfUser, String groupId, Boolean showHiddenLibraryDocuments, String cursor, Integer pageSize) throws ApiException { + com.squareup.okhttp.Call call = getLibraryDocumentsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, groupId, showHiddenLibraryDocuments, cursor, pageSize, null, null); Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -1919,6 +2516,7 @@ public ApiResponse getLibraryDocumentsWithHttpInfo(String auth * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_read')\" oncontextmenu=\"this.href=oauthDoc('library_read')\" target=\"oauthDoc\">library_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) * @param showHiddenLibraryDocuments A query parameter to fetch all the hidden library documents along with the visible library documents. Default value is false. (optional) * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) @@ -1926,7 +2524,7 @@ public ApiResponse getLibraryDocumentsWithHttpInfo(String auth * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getLibraryDocumentsAsync(String authorization, String xApiUser, String xOnBehalfOfUser, Boolean showHiddenLibraryDocuments, String cursor, Integer pageSize, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getLibraryDocumentsAsync(String authorization, String xApiUser, String xOnBehalfOfUser, String groupId, Boolean showHiddenLibraryDocuments, String cursor, Integer pageSize, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -1947,25 +2545,186 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getLibraryDocumentsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, showHiddenLibraryDocuments, cursor, pageSize, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getLibraryDocumentsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, groupId, showHiddenLibraryDocuments, cursor, pageSize, progressListener, progressRequestListener); Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } + /** + * Build call for updateFormFields + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_write')\" oncontextmenu=\"this.href=oauthDoc('library_write')\" target=\"oauthDoc\">library_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param formFieldPutInfo List of form fields to set for library document (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call updateFormFieldsCall(String authorization, String libraryDocumentId, FormFieldPutInfo formFieldPutInfo, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = formFieldPutInfo; + + // create path and map variables + String localVarPath = "/libraryDocuments/{libraryDocumentId}/formFields" + .replaceAll("\\{" + "libraryDocumentId" + "\\}", apiClient.escapeString(libraryDocumentId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + if (ifNoneMatch != null) + localVarHeaderParams.put("If-None-Match", apiClient.parameterToString(ifNoneMatch)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call updateFormFieldsValidateBeforeCall(String authorization, String libraryDocumentId, FormFieldPutInfo formFieldPutInfo, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling updateFormFields(Async)"); + } + + // verify the required parameter 'libraryDocumentId' is set + if (libraryDocumentId == null) { + throw new ApiException("Missing the required parameter 'libraryDocumentId' when calling updateFormFields(Async)"); + } + + // verify the required parameter 'formFieldPutInfo' is set + if (formFieldPutInfo == null) { + throw new ApiException("Missing the required parameter 'formFieldPutInfo' when calling updateFormFields(Async)"); + } + + + com.squareup.okhttp.Call call = updateFormFieldsCall(authorization, libraryDocumentId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + return call; + + } + + /** + * Updates details of form fields of a library document. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_write')\" oncontextmenu=\"this.href=oauthDoc('library_write')\" target=\"oauthDoc\">library_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param formFieldPutInfo List of form fields to set for library document (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @return LibraryDocumentFormFields + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public LibraryDocumentFormFields updateFormFields(String authorization, String libraryDocumentId, FormFieldPutInfo formFieldPutInfo, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + ApiResponse resp = updateFormFieldsWithHttpInfo(authorization, libraryDocumentId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, ifNoneMatch); + return resp.getData(); + } + + /** + * Updates details of form fields of a library document. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_write')\" oncontextmenu=\"this.href=oauthDoc('library_write')\" target=\"oauthDoc\">library_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param formFieldPutInfo List of form fields to set for library document (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @return ApiResponse<LibraryDocumentFormFields> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse updateFormFieldsWithHttpInfo(String authorization, String libraryDocumentId, FormFieldPutInfo formFieldPutInfo, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + com.squareup.okhttp.Call call = updateFormFieldsValidateBeforeCall(authorization, libraryDocumentId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Updates details of form fields of a library document. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_write')\" oncontextmenu=\"this.href=oauthDoc('library_write')\" target=\"oauthDoc\">library_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) + * @param formFieldPutInfo List of form fields to set for library document (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call updateFormFieldsAsync(String authorization, String libraryDocumentId, FormFieldPutInfo formFieldPutInfo, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = updateFormFieldsValidateBeforeCall(authorization, libraryDocumentId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } /** * Build call for updateLibraryDocument * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_write')\" oncontextmenu=\"this.href=oauthDoc('library_write')\" target=\"oauthDoc\">library_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param libraryDocumentInfo Information about the library document that you want to create. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call updateLibraryDocumentCall(String authorization, String ifMatch, String libraryDocumentId, LibraryDocumentInfo libraryDocumentInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call updateLibraryDocumentCall(String authorization, String libraryDocumentId, LibraryDocumentInfo libraryDocumentInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = libraryDocumentInfo; // create path and map variables @@ -2016,18 +2775,13 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call updateLibraryDocumentValidateBeforeCall(String authorization, String ifMatch, String libraryDocumentId, LibraryDocumentInfo libraryDocumentInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateLibraryDocumentValidateBeforeCall(String authorization, String libraryDocumentId, LibraryDocumentInfo libraryDocumentInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling updateLibraryDocument(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling updateLibraryDocument(Async)"); - } - // verify the required parameter 'libraryDocumentId' is set if (libraryDocumentId == null) { throw new ApiException("Missing the required parameter 'libraryDocumentId' when calling updateLibraryDocument(Async)"); @@ -2039,7 +2793,7 @@ private com.squareup.okhttp.Call updateLibraryDocumentValidateBeforeCall(String } - com.squareup.okhttp.Call call = updateLibraryDocumentCall(authorization, ifMatch, libraryDocumentId, libraryDocumentInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateLibraryDocumentCall(authorization, libraryDocumentId, libraryDocumentInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); return call; } @@ -2048,31 +2802,31 @@ private com.squareup.okhttp.Call updateLibraryDocumentValidateBeforeCall(String * Updates the library document. * Currently status, name, sharingMode and templateTypes of the library document can only be updated. * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_write')\" oncontextmenu=\"this.href=oauthDoc('library_write')\" target=\"oauthDoc\">library_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param libraryDocumentInfo Information about the library document that you want to create. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void updateLibraryDocument(String authorization, String ifMatch, String libraryDocumentId, LibraryDocumentInfo libraryDocumentInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - updateLibraryDocumentWithHttpInfo(authorization, ifMatch, libraryDocumentId, libraryDocumentInfo, xApiUser, xOnBehalfOfUser); + public void updateLibraryDocument(String authorization, String libraryDocumentId, LibraryDocumentInfo libraryDocumentInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + updateLibraryDocumentWithHttpInfo(authorization, libraryDocumentId, libraryDocumentInfo, xApiUser, xOnBehalfOfUser, ifMatch); } /** * Updates the library document. * Currently status, name, sharingMode and templateTypes of the library document can only be updated. * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_write')\" oncontextmenu=\"this.href=oauthDoc('library_write')\" target=\"oauthDoc\">library_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param libraryDocumentInfo Information about the library document that you want to create. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse updateLibraryDocumentWithHttpInfo(String authorization, String ifMatch, String libraryDocumentId, LibraryDocumentInfo libraryDocumentInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = updateLibraryDocumentValidateBeforeCall(authorization, ifMatch, libraryDocumentId, libraryDocumentInfo, xApiUser, xOnBehalfOfUser, null, null); + public ApiResponse updateLibraryDocumentWithHttpInfo(String authorization, String libraryDocumentId, LibraryDocumentInfo libraryDocumentInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + com.squareup.okhttp.Call call = updateLibraryDocumentValidateBeforeCall(authorization, libraryDocumentId, libraryDocumentInfo, xApiUser, xOnBehalfOfUser, ifMatch, null, null); return apiClient.execute(call); } @@ -2080,16 +2834,16 @@ public ApiResponse updateLibraryDocumentWithHttpInfo(String authorization, * Updates the library document. (asynchronously) * Currently status, name, sharingMode and templateTypes of the library document can only be updated. * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_write')\" oncontextmenu=\"this.href=oauthDoc('library_write')\" target=\"oauthDoc\">library_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param libraryDocumentInfo Information about the library document that you want to create. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call updateLibraryDocumentAsync(String authorization, String ifMatch, String libraryDocumentId, LibraryDocumentInfo libraryDocumentInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateLibraryDocumentAsync(String authorization, String libraryDocumentId, LibraryDocumentInfo libraryDocumentInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -2110,7 +2864,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = updateLibraryDocumentValidateBeforeCall(authorization, ifMatch, libraryDocumentId, libraryDocumentInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateLibraryDocumentValidateBeforeCall(authorization, libraryDocumentId, libraryDocumentInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } @@ -2268,17 +3022,17 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for updateLibraryDocumentState * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_write')\" oncontextmenu=\"this.href=oauthDoc('library_write')\" target=\"oauthDoc\">library_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param libraryDocumentStateInfo Information about the state of library document to which you want to update (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call updateLibraryDocumentStateCall(String authorization, String ifMatch, String libraryDocumentId, LibraryDocumentStateInfo libraryDocumentStateInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call updateLibraryDocumentStateCall(String authorization, String libraryDocumentId, LibraryDocumentStateInfo libraryDocumentStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = libraryDocumentStateInfo; // create path and map variables @@ -2329,18 +3083,13 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call updateLibraryDocumentStateValidateBeforeCall(String authorization, String ifMatch, String libraryDocumentId, LibraryDocumentStateInfo libraryDocumentStateInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateLibraryDocumentStateValidateBeforeCall(String authorization, String libraryDocumentId, LibraryDocumentStateInfo libraryDocumentStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling updateLibraryDocumentState(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling updateLibraryDocumentState(Async)"); - } - // verify the required parameter 'libraryDocumentId' is set if (libraryDocumentId == null) { throw new ApiException("Missing the required parameter 'libraryDocumentId' when calling updateLibraryDocumentState(Async)"); @@ -2352,57 +3101,57 @@ private com.squareup.okhttp.Call updateLibraryDocumentStateValidateBeforeCall(St } - com.squareup.okhttp.Call call = updateLibraryDocumentStateCall(authorization, ifMatch, libraryDocumentId, libraryDocumentStateInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateLibraryDocumentStateCall(authorization, libraryDocumentId, libraryDocumentStateInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); return call; } /** * Updates the library document's state. - * Currently state can be changed from AUTHORING to ACTIVE. + * Currently state can be changed from AUTHORING to ACTIVE, AUTHORING to REMOVED or ACTIVE to REMOVED * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_write')\" oncontextmenu=\"this.href=oauthDoc('library_write')\" target=\"oauthDoc\">library_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param libraryDocumentStateInfo Information about the state of library document to which you want to update (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void updateLibraryDocumentState(String authorization, String ifMatch, String libraryDocumentId, LibraryDocumentStateInfo libraryDocumentStateInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - updateLibraryDocumentStateWithHttpInfo(authorization, ifMatch, libraryDocumentId, libraryDocumentStateInfo, xApiUser, xOnBehalfOfUser); + public void updateLibraryDocumentState(String authorization, String libraryDocumentId, LibraryDocumentStateInfo libraryDocumentStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + updateLibraryDocumentStateWithHttpInfo(authorization, libraryDocumentId, libraryDocumentStateInfo, xApiUser, xOnBehalfOfUser, ifMatch); } /** * Updates the library document's state. - * Currently state can be changed from AUTHORING to ACTIVE. + * Currently state can be changed from AUTHORING to ACTIVE, AUTHORING to REMOVED or ACTIVE to REMOVED * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_write')\" oncontextmenu=\"this.href=oauthDoc('library_write')\" target=\"oauthDoc\">library_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param libraryDocumentStateInfo Information about the state of library document to which you want to update (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse updateLibraryDocumentStateWithHttpInfo(String authorization, String ifMatch, String libraryDocumentId, LibraryDocumentStateInfo libraryDocumentStateInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = updateLibraryDocumentStateValidateBeforeCall(authorization, ifMatch, libraryDocumentId, libraryDocumentStateInfo, xApiUser, xOnBehalfOfUser, null, null); + public ApiResponse updateLibraryDocumentStateWithHttpInfo(String authorization, String libraryDocumentId, LibraryDocumentStateInfo libraryDocumentStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + com.squareup.okhttp.Call call = updateLibraryDocumentStateValidateBeforeCall(authorization, libraryDocumentId, libraryDocumentStateInfo, xApiUser, xOnBehalfOfUser, ifMatch, null, null); return apiClient.execute(call); } /** * Updates the library document's state. (asynchronously) - * Currently state can be changed from AUTHORING to ACTIVE. + * Currently state can be changed from AUTHORING to ACTIVE, AUTHORING to REMOVED or ACTIVE to REMOVED * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('library_write')\" oncontextmenu=\"this.href=oauthDoc('library_write')\" target=\"oauthDoc\">library_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param libraryDocumentId The document identifier, as retrieved from the API to fetch library documents. (required) * @param libraryDocumentStateInfo Information about the state of library document to which you want to update (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call updateLibraryDocumentStateAsync(String authorization, String ifMatch, String libraryDocumentId, LibraryDocumentStateInfo libraryDocumentStateInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateLibraryDocumentStateAsync(String authorization, String libraryDocumentId, LibraryDocumentStateInfo libraryDocumentStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -2423,7 +3172,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = updateLibraryDocumentStateValidateBeforeCall(authorization, ifMatch, libraryDocumentId, libraryDocumentStateInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateLibraryDocumentStateValidateBeforeCall(authorization, libraryDocumentId, libraryDocumentStateInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } diff --git a/src/main/java/io/swagger/client/api/MegaSignsApi.java b/src/main/java/io/swagger/client/api/MegaSignsApi.java index f364793..21834c8 100755 --- a/src/main/java/io/swagger/client/api/MegaSignsApi.java +++ b/src/main/java/io/swagger/client/api/MegaSignsApi.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,14 +27,28 @@ import java.io.IOException; +import io.swagger.client.model.megaSigns.AgreementDocuments; +import io.swagger.client.model.megaSigns.BasicDocumentsImageUrlsInfo; +import io.swagger.client.model.megaSigns.DocumentUrl; +import io.swagger.client.model.megaSigns.FetchedMegaSignInfo; import io.swagger.client.model.megaSigns.MegaSignChildAgreements; import io.swagger.client.model.megaSigns.MegaSignCreationInfo; import io.swagger.client.model.megaSigns.MegaSignCreationResponse; +import io.swagger.client.model.megaSigns.MegaSignInfo; +import io.swagger.client.model.megaSigns.MegaSignMembersInfo; +import io.swagger.client.model.megaSigns.MegaSignRemindersResponse; import io.swagger.client.model.megaSigns.MegaSignStateInfo; import io.swagger.client.model.megaSigns.MegaSignViewInfo; import io.swagger.client.model.megaSigns.MegaSignViewResponse; import io.swagger.client.model.megaSigns.MegaSigns; import io.swagger.client.model.megaSigns.MegasignEventList; +import io.swagger.client.model.megaSigns.MyAgreementInfo; +import io.swagger.client.model.megaSigns.Note; +import io.swagger.client.model.megaSigns.ReminderCreationResult; +import io.swagger.client.model.megaSigns.ReminderInfo; +import io.swagger.client.model.megaSigns.ShareCreationInfoList; +import io.swagger.client.model.megaSigns.ShareCreationResponseList; +import io.swagger.client.model.megaSigns.VisibilityInfo; import java.lang.reflect.Type; import java.util.ArrayList; @@ -222,25 +221,23 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don return call; } /** - * Build call for getChildAgreementsInfoFile - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * Build call for createReminderOnMegaSign + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) - * @param childAgreementsInfoFileId The identifier of the childAgreementsInfoFile that has been uploaded by sender while creating the megaSign or retrieved from the API to fetch megaSignInfo (required) + * @param reminderInfo The information about a reminder associated with a recipient of an agreement. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getChildAgreementsInfoFileCall(String authorization, String megaSignId, String childAgreementsInfoFileId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { - Object localVarPostBody = null; + public com.squareup.okhttp.Call createReminderOnMegaSignCall(String authorization, String megaSignId, ReminderInfo reminderInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = reminderInfo; // create path and map variables - String localVarPath = "/megaSigns/{megaSignId}/childAgreementsInfo/{childAgreementsInfoFileId}" - .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())) - .replaceAll("\\{" + "childAgreementsInfoFileId" + "\\}", apiClient.escapeString(childAgreementsInfoFileId.toString())); + String localVarPath = "/megaSigns/{megaSignId}/reminders" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -252,13 +249,11 @@ public com.squareup.okhttp.Call getChildAgreementsInfoFileCall(String authorizat localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); if (xOnBehalfOfUser != null) localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); - if (ifNoneMatch != null) - localVarHeaderParams.put("If-None-Match", apiClient.parameterToString(ifNoneMatch)); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "text/csv" + "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); @@ -282,82 +277,79 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } String[] localVarAuthNames = new String[] { }; - return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + return apiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getChildAgreementsInfoFileValidateBeforeCall(String authorization, String megaSignId, String childAgreementsInfoFileId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call createReminderOnMegaSignValidateBeforeCall(String authorization, String megaSignId, ReminderInfo reminderInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { - throw new ApiException("Missing the required parameter 'authorization' when calling getChildAgreementsInfoFile(Async)"); + throw new ApiException("Missing the required parameter 'authorization' when calling createReminderOnMegaSign(Async)"); } // verify the required parameter 'megaSignId' is set if (megaSignId == null) { - throw new ApiException("Missing the required parameter 'megaSignId' when calling getChildAgreementsInfoFile(Async)"); + throw new ApiException("Missing the required parameter 'megaSignId' when calling createReminderOnMegaSign(Async)"); } - // verify the required parameter 'childAgreementsInfoFileId' is set - if (childAgreementsInfoFileId == null) { - throw new ApiException("Missing the required parameter 'childAgreementsInfoFileId' when calling getChildAgreementsInfoFile(Async)"); + // verify the required parameter 'reminderInfo' is set + if (reminderInfo == null) { + throw new ApiException("Missing the required parameter 'reminderInfo' when calling createReminderOnMegaSign(Async)"); } - com.squareup.okhttp.Call call = getChildAgreementsInfoFileCall(authorization, megaSignId, childAgreementsInfoFileId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = createReminderOnMegaSignCall(authorization, megaSignId, reminderInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); return call; } /** - * Retrieves the file stream of the original childAgreementsInfoFile that was uploaded by sender while creating the MegaSign. - * CSV file stream containing form data information - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * Creates a reminder on the specified participants of the MegaSign parent. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) - * @param childAgreementsInfoFileId The identifier of the childAgreementsInfoFile that has been uploaded by sender while creating the megaSign or retrieved from the API to fetch megaSignInfo (required) + * @param reminderInfo The information about a reminder associated with a recipient of an agreement. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @return byte[] + * @return ReminderCreationResult * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public byte[] getChildAgreementsInfoFile(String authorization, String megaSignId, String childAgreementsInfoFileId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { - ApiResponse resp = getChildAgreementsInfoFileWithHttpInfo(authorization, megaSignId, childAgreementsInfoFileId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + public ReminderCreationResult createReminderOnMegaSign(String authorization, String megaSignId, ReminderInfo reminderInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { + ApiResponse resp = createReminderOnMegaSignWithHttpInfo(authorization, megaSignId, reminderInfo, xApiUser, xOnBehalfOfUser); return resp.getData(); } /** - * Retrieves the file stream of the original childAgreementsInfoFile that was uploaded by sender while creating the MegaSign. - * CSV file stream containing form data information - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * Creates a reminder on the specified participants of the MegaSign parent. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) - * @param childAgreementsInfoFileId The identifier of the childAgreementsInfoFile that has been uploaded by sender while creating the megaSign or retrieved from the API to fetch megaSignInfo (required) + * @param reminderInfo The information about a reminder associated with a recipient of an agreement. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @return ApiResponse<byte[]> + * @return ApiResponse<ReminderCreationResult> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getChildAgreementsInfoFileWithHttpInfo(String authorization, String megaSignId, String childAgreementsInfoFileId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { - com.squareup.okhttp.Call call = getChildAgreementsInfoFileValidateBeforeCall(authorization, megaSignId, childAgreementsInfoFileId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse createReminderOnMegaSignWithHttpInfo(String authorization, String megaSignId, ReminderInfo reminderInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { + com.squareup.okhttp.Call call = createReminderOnMegaSignValidateBeforeCall(authorization, megaSignId, reminderInfo, xApiUser, xOnBehalfOfUser, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } /** - * Retrieves the file stream of the original childAgreementsInfoFile that was uploaded by sender while creating the MegaSign. (asynchronously) - * CSV file stream containing form data information - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * Creates a reminder on the specified participants of the MegaSign parent. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) - * @param childAgreementsInfoFileId The identifier of the childAgreementsInfoFile that has been uploaded by sender while creating the megaSign or retrieved from the API to fetch megaSignInfo (required) + * @param reminderInfo The information about a reminder associated with a recipient of an agreement. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getChildAgreementsInfoFileAsync(String authorization, String megaSignId, String childAgreementsInfoFileId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call createReminderOnMegaSignAsync(String authorization, String megaSignId, ReminderInfo reminderInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -378,28 +370,28 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getChildAgreementsInfoFileValidateBeforeCall(authorization, megaSignId, childAgreementsInfoFileId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + com.squareup.okhttp.Call call = createReminderOnMegaSignValidateBeforeCall(authorization, megaSignId, reminderInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } /** - * Build call for getEvents - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * Build call for createShareOnMegaSign + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param shareCreationInfoList List of agreement share creation information objects. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getEventsCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { - Object localVarPostBody = null; + public com.squareup.okhttp.Call createShareOnMegaSignCall(String authorization, String megaSignId, ShareCreationInfoList shareCreationInfoList, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = shareCreationInfoList; // create path and map variables - String localVarPath = "/megaSigns/{megaSignId}/events" + String localVarPath = "/megaSigns/{megaSignId}/members/share" .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); List localVarQueryParams = new ArrayList(); @@ -412,8 +404,6 @@ public com.squareup.okhttp.Call getEventsCall(String authorization, String megaS localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); if (xOnBehalfOfUser != null) localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); - if (ifNoneMatch != null) - localVarHeaderParams.put("If-None-Match", apiClient.parameterToString(ifNoneMatch)); Map localVarFormParams = new HashMap(); @@ -442,74 +432,79 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } String[] localVarAuthNames = new String[] { }; - return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + return apiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getEventsValidateBeforeCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call createShareOnMegaSignValidateBeforeCall(String authorization, String megaSignId, ShareCreationInfoList shareCreationInfoList, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { - throw new ApiException("Missing the required parameter 'authorization' when calling getEvents(Async)"); + throw new ApiException("Missing the required parameter 'authorization' when calling createShareOnMegaSign(Async)"); } // verify the required parameter 'megaSignId' is set if (megaSignId == null) { - throw new ApiException("Missing the required parameter 'megaSignId' when calling getEvents(Async)"); + throw new ApiException("Missing the required parameter 'megaSignId' when calling createShareOnMegaSign(Async)"); + } + + // verify the required parameter 'shareCreationInfoList' is set + if (shareCreationInfoList == null) { + throw new ApiException("Missing the required parameter 'shareCreationInfoList' when calling createShareOnMegaSign(Async)"); } - com.squareup.okhttp.Call call = getEventsCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = createShareOnMegaSignCall(authorization, megaSignId, shareCreationInfoList, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); return call; } /** - * Retrieves the events information for the MegaSign parent agreement. + * Share a MegaSign parent and all the child agreements with someone. * - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param shareCreationInfoList List of agreement share creation information objects. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @return MegasignEventList + * @return ShareCreationResponseList * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public MegasignEventList getEvents(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { - ApiResponse resp = getEventsWithHttpInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + public ShareCreationResponseList createShareOnMegaSign(String authorization, String megaSignId, ShareCreationInfoList shareCreationInfoList, String xApiUser, String xOnBehalfOfUser) throws ApiException { + ApiResponse resp = createShareOnMegaSignWithHttpInfo(authorization, megaSignId, shareCreationInfoList, xApiUser, xOnBehalfOfUser); return resp.getData(); } /** - * Retrieves the events information for the MegaSign parent agreement. + * Share a MegaSign parent and all the child agreements with someone. * - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param shareCreationInfoList List of agreement share creation information objects. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @return ApiResponse<MegasignEventList> + * @return ApiResponse<ShareCreationResponseList> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getEventsWithHttpInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { - com.squareup.okhttp.Call call = getEventsValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse createShareOnMegaSignWithHttpInfo(String authorization, String megaSignId, ShareCreationInfoList shareCreationInfoList, String xApiUser, String xOnBehalfOfUser) throws ApiException { + com.squareup.okhttp.Call call = createShareOnMegaSignValidateBeforeCall(authorization, megaSignId, shareCreationInfoList, xApiUser, xOnBehalfOfUser, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } /** - * Retrieves the events information for the MegaSign parent agreement. (asynchronously) + * Share a MegaSign parent and all the child agreements with someone. (asynchronously) * - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param shareCreationInfoList List of agreement share creation information objects. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getEventsAsync(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call createShareOnMegaSignAsync(String authorization, String megaSignId, ShareCreationInfoList shareCreationInfoList, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -530,37 +525,32 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getEventsValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + com.squareup.okhttp.Call call = createShareOnMegaSignValidateBeforeCall(authorization, megaSignId, shareCreationInfoList, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } /** - * Build call for getMegaSignChildAgreements + * Build call for getAllMegaSignMembers * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) - * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getMegaSignChildAgreementsCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getAllMegaSignMembersCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/megaSigns/{megaSignId}/agreements" + String localVarPath = "/megaSigns/{megaSignId}/members" .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); - if (cursor != null) - localVarQueryParams.addAll(apiClient.parameterToPair("cursor", cursor)); - if (pageSize != null) - localVarQueryParams.addAll(apiClient.parameterToPair("pageSize", pageSize)); Map localVarHeaderParams = new HashMap(); if (authorization != null) @@ -569,6 +559,8 @@ public com.squareup.okhttp.Call getMegaSignChildAgreementsCall(String authorizat localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); if (xOnBehalfOfUser != null) localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + if (ifNoneMatch != null) + localVarHeaderParams.put("If-None-Match", apiClient.parameterToString(ifNoneMatch)); Map localVarFormParams = new HashMap(); @@ -601,73 +593,70 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getMegaSignChildAgreementsValidateBeforeCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getAllMegaSignMembersValidateBeforeCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { - throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignChildAgreements(Async)"); + throw new ApiException("Missing the required parameter 'authorization' when calling getAllMegaSignMembers(Async)"); } // verify the required parameter 'megaSignId' is set if (megaSignId == null) { - throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignChildAgreements(Async)"); + throw new ApiException("Missing the required parameter 'megaSignId' when calling getAllMegaSignMembers(Async)"); } - com.squareup.okhttp.Call call = getMegaSignChildAgreementsCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, cursor, pageSize, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getAllMegaSignMembersCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); return call; } /** - * Get all the child agreements of the specified MegaSign parent agreement. + * Retrieves detailed member info along with IDs for different types of participants associated with the MegaSign parent agreement. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) - * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) - * @return MegaSignChildAgreements + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @return MegaSignMembersInfo * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public MegaSignChildAgreements getMegaSignChildAgreements(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String cursor, Integer pageSize) throws ApiException { - ApiResponse resp = getMegaSignChildAgreementsWithHttpInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, cursor, pageSize); + public MegaSignMembersInfo getAllMegaSignMembers(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + ApiResponse resp = getAllMegaSignMembersWithHttpInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch); return resp.getData(); } /** - * Get all the child agreements of the specified MegaSign parent agreement. + * Retrieves detailed member info along with IDs for different types of participants associated with the MegaSign parent agreement. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) - * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) - * @return ApiResponse<MegaSignChildAgreements> + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @return ApiResponse<MegaSignMembersInfo> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getMegaSignChildAgreementsWithHttpInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String cursor, Integer pageSize) throws ApiException { - com.squareup.okhttp.Call call = getMegaSignChildAgreementsValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, cursor, pageSize, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse getAllMegaSignMembersWithHttpInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + com.squareup.okhttp.Call call = getAllMegaSignMembersValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } /** - * Get all the child agreements of the specified MegaSign parent agreement. (asynchronously) + * Retrieves detailed member info along with IDs for different types of participants associated with the MegaSign parent agreement. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) - * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getMegaSignChildAgreementsAsync(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String cursor, Integer pageSize, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getAllMegaSignMembersAsync(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -688,35 +677,34 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getMegaSignChildAgreementsValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, cursor, pageSize, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + com.squareup.okhttp.Call call = getAllMegaSignMembersValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } /** - * Build call for getMegaSignCombinedDocument + * Build call for getChildAgreementsInfoFile * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param childAgreementsInfoFileId The identifier of the childAgreementsInfoFile that has been uploaded by sender while creating the megaSign or retrieved from the API to fetch megaSignInfo (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @param attachAuditReport When set to true attach an audit report to the MegaSign document PDF. Default value will be false. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getMegaSignCombinedDocumentCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, Boolean attachAuditReport, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getChildAgreementsInfoFileCall(String authorization, String megaSignId, String childAgreementsInfoFileId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/megaSigns/{megaSignId}/combinedDocument" - .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); + String localVarPath = "/megaSigns/{megaSignId}/childAgreementsInfo/{childAgreementsInfoFileId}" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())) + .replaceAll("\\{" + "childAgreementsInfoFileId" + "\\}", apiClient.escapeString(childAgreementsInfoFileId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); - if (attachAuditReport != null) - localVarQueryParams.addAll(apiClient.parameterToPair("attachAuditReport", attachAuditReport)); Map localVarHeaderParams = new HashMap(); if (authorization != null) @@ -731,7 +719,7 @@ public com.squareup.okhttp.Call getMegaSignCombinedDocumentCall(String authoriza Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/pdf", "application/pdf;encoding=base64" + "text/csv" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); @@ -759,73 +747,78 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getMegaSignCombinedDocumentValidateBeforeCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, Boolean attachAuditReport, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getChildAgreementsInfoFileValidateBeforeCall(String authorization, String megaSignId, String childAgreementsInfoFileId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { - throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignCombinedDocument(Async)"); + throw new ApiException("Missing the required parameter 'authorization' when calling getChildAgreementsInfoFile(Async)"); } // verify the required parameter 'megaSignId' is set if (megaSignId == null) { - throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignCombinedDocument(Async)"); + throw new ApiException("Missing the required parameter 'megaSignId' when calling getChildAgreementsInfoFile(Async)"); + } + + // verify the required parameter 'childAgreementsInfoFileId' is set + if (childAgreementsInfoFileId == null) { + throw new ApiException("Missing the required parameter 'childAgreementsInfoFileId' when calling getChildAgreementsInfoFile(Async)"); } - com.squareup.okhttp.Call call = getMegaSignCombinedDocumentCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, attachAuditReport, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getChildAgreementsInfoFileCall(authorization, megaSignId, childAgreementsInfoFileId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); return call; } /** - * Retrieves a single combined PDF document for the documents associated with the MegaSign parent agreement. - * + * Retrieves the file stream of the original childAgreementsInfoFile that was uploaded by sender while creating the MegaSign. + * CSV file stream containing form data information * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param childAgreementsInfoFileId The identifier of the childAgreementsInfoFile that has been uploaded by sender while creating the megaSign or retrieved from the API to fetch megaSignInfo (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @param attachAuditReport When set to true attach an audit report to the MegaSign document PDF. Default value will be false. (optional) * @return byte[] * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public byte[] getMegaSignCombinedDocument(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, Boolean attachAuditReport) throws ApiException { - ApiResponse resp = getMegaSignCombinedDocumentWithHttpInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, attachAuditReport); + public byte[] getChildAgreementsInfoFile(String authorization, String megaSignId, String childAgreementsInfoFileId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + ApiResponse resp = getChildAgreementsInfoFileWithHttpInfo(authorization, megaSignId, childAgreementsInfoFileId, xApiUser, xOnBehalfOfUser, ifNoneMatch); return resp.getData(); } /** - * Retrieves a single combined PDF document for the documents associated with the MegaSign parent agreement. - * + * Retrieves the file stream of the original childAgreementsInfoFile that was uploaded by sender while creating the MegaSign. + * CSV file stream containing form data information * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param childAgreementsInfoFileId The identifier of the childAgreementsInfoFile that has been uploaded by sender while creating the megaSign or retrieved from the API to fetch megaSignInfo (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @param attachAuditReport When set to true attach an audit report to the MegaSign document PDF. Default value will be false. (optional) * @return ApiResponse<byte[]> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getMegaSignCombinedDocumentWithHttpInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, Boolean attachAuditReport) throws ApiException { - com.squareup.okhttp.Call call = getMegaSignCombinedDocumentValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, attachAuditReport, null, null); + public ApiResponse getChildAgreementsInfoFileWithHttpInfo(String authorization, String megaSignId, String childAgreementsInfoFileId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + com.squareup.okhttp.Call call = getChildAgreementsInfoFileValidateBeforeCall(authorization, megaSignId, childAgreementsInfoFileId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } /** - * Retrieves a single combined PDF document for the documents associated with the MegaSign parent agreement. (asynchronously) - * + * Retrieves the file stream of the original childAgreementsInfoFile that was uploaded by sender while creating the MegaSign. (asynchronously) + * CSV file stream containing form data information * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param childAgreementsInfoFileId The identifier of the childAgreementsInfoFile that has been uploaded by sender while creating the megaSign or retrieved from the API to fetch megaSignInfo (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @param attachAuditReport When set to true attach an audit report to the MegaSign document PDF. Default value will be false. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getMegaSignCombinedDocumentAsync(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, Boolean attachAuditReport, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getChildAgreementsInfoFileAsync(String authorization, String megaSignId, String childAgreementsInfoFileId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -846,27 +839,28 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getMegaSignCombinedDocumentValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, attachAuditReport, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getChildAgreementsInfoFileValidateBeforeCall(authorization, megaSignId, childAgreementsInfoFileId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } /** - * Build call for getMegaSignFormData + * Build call for getEvents * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getMegaSignFormDataCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getEventsCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/megaSigns/{megaSignId}/formData" + String localVarPath = "/megaSigns/{megaSignId}/events" .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); List localVarQueryParams = new ArrayList(); @@ -879,11 +873,13 @@ public com.squareup.okhttp.Call getMegaSignFormDataCall(String authorization, St localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); if (xOnBehalfOfUser != null) localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + if (ifNoneMatch != null) + localVarHeaderParams.put("If-None-Match", apiClient.parameterToString(ifNoneMatch)); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "text/csv" + "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); @@ -911,67 +907,70 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getMegaSignFormDataValidateBeforeCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getEventsValidateBeforeCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { - throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignFormData(Async)"); + throw new ApiException("Missing the required parameter 'authorization' when calling getEvents(Async)"); } // verify the required parameter 'megaSignId' is set if (megaSignId == null) { - throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignFormData(Async)"); + throw new ApiException("Missing the required parameter 'megaSignId' when calling getEvents(Async)"); } - com.squareup.okhttp.Call call = getMegaSignFormDataCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getEventsCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); return call; } /** - * Retrieves data entered by recipients into interactive form fields at the time they signed the child agreements of the specified MegaSign agreement - * CSV file stream containing form data information + * Retrieves the events information for the MegaSign parent agreement. + * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @return byte[] + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @return MegasignEventList * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public byte[] getMegaSignFormData(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser) throws ApiException { - ApiResponse resp = getMegaSignFormDataWithHttpInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser); + public MegasignEventList getEvents(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + ApiResponse resp = getEventsWithHttpInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch); return resp.getData(); } /** - * Retrieves data entered by recipients into interactive form fields at the time they signed the child agreements of the specified MegaSign agreement - * CSV file stream containing form data information + * Retrieves the events information for the MegaSign parent agreement. + * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @return ApiResponse<byte[]> + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @return ApiResponse<MegasignEventList> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getMegaSignFormDataWithHttpInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = getMegaSignFormDataValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse getEventsWithHttpInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + com.squareup.okhttp.Call call = getEventsValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } /** - * Retrieves data entered by recipients into interactive form fields at the time they signed the child agreements of the specified MegaSign agreement (asynchronously) - * CSV file stream containing form data information + * Retrieves the events information for the MegaSign parent agreement. (asynchronously) + * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getMegaSignFormDataAsync(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getEventsAsync(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -992,13 +991,13 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getMegaSignFormDataValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + com.squareup.okhttp.Call call = getEventsValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } /** - * Build call for getMegaSignInfo + * Build call for getMegaSignAllDocuments * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) @@ -1009,11 +1008,11 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getMegaSignInfoCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getMegaSignAllDocumentsCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/megaSigns/{megaSignId}" + String localVarPath = "/megaSigns/{megaSignId}/documents" .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); List localVarQueryParams = new ArrayList(); @@ -1060,70 +1059,2223 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getMegaSignInfoValidateBeforeCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getMegaSignAllDocumentsValidateBeforeCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { - throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignInfo(Async)"); + throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignAllDocuments(Async)"); } // verify the required parameter 'megaSignId' is set if (megaSignId == null) { - throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignInfo(Async)"); + throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignAllDocuments(Async)"); } - com.squareup.okhttp.Call call = getMegaSignInfoCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getMegaSignAllDocumentsCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); return call; } /** - * Get detailed information of the specified MegaSign parent agreement. + * Retrieves the IDs of the documents associated with a MegaSign parent agreement. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @return MegaSignCreationInfo + * @return AgreementDocuments * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public MegaSignCreationInfo getMegaSignInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { - ApiResponse resp = getMegaSignInfoWithHttpInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + public AgreementDocuments getMegaSignAllDocuments(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + ApiResponse resp = getMegaSignAllDocumentsWithHttpInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch); return resp.getData(); } /** - * Get detailed information of the specified MegaSign parent agreement. + * Retrieves the IDs of the documents associated with a MegaSign parent agreement. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @return ApiResponse<MegaSignCreationInfo> + * @return ApiResponse<AgreementDocuments> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getMegaSignInfoWithHttpInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { - com.squareup.okhttp.Call call = getMegaSignInfoValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse getMegaSignAllDocumentsWithHttpInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + com.squareup.okhttp.Call call = getMegaSignAllDocumentsValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves the IDs of the documents associated with a MegaSign parent agreement. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getMegaSignAllDocumentsAsync(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getMegaSignAllDocumentsValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getMegaSignAllDocumentsImageUrls + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param imageSizes A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. (optional) + * @param showImageAvailabilityOnly When set to true, returns only image availability. Else, returns both image urls and its availability. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getMegaSignAllDocumentsImageUrlsCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String imageSizes, Boolean showImageAvailabilityOnly, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/megaSigns/{megaSignId}/documents/imageUrls" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (imageSizes != null) + localVarQueryParams.addAll(apiClient.parameterToPair("imageSizes", imageSizes)); + if (showImageAvailabilityOnly != null) + localVarQueryParams.addAll(apiClient.parameterToPair("showImageAvailabilityOnly", showImageAvailabilityOnly)); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getMegaSignAllDocumentsImageUrlsValidateBeforeCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String imageSizes, Boolean showImageAvailabilityOnly, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignAllDocumentsImageUrls(Async)"); + } + + // verify the required parameter 'megaSignId' is set + if (megaSignId == null) { + throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignAllDocumentsImageUrls(Async)"); + } + + + com.squareup.okhttp.Call call = getMegaSignAllDocumentsImageUrlsCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, imageSizes, showImageAvailabilityOnly, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves image urls of all visible pages of a document associated with a MegaSign parent agreement. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param imageSizes A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. (optional) + * @param showImageAvailabilityOnly When set to true, returns only image availability. Else, returns both image urls and its availability. (optional) + * @return BasicDocumentsImageUrlsInfo + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public BasicDocumentsImageUrlsInfo getMegaSignAllDocumentsImageUrls(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String imageSizes, Boolean showImageAvailabilityOnly) throws ApiException { + ApiResponse resp = getMegaSignAllDocumentsImageUrlsWithHttpInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, imageSizes, showImageAvailabilityOnly); + return resp.getData(); + } + + /** + * Retrieves image urls of all visible pages of a document associated with a MegaSign parent agreement. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param imageSizes A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. (optional) + * @param showImageAvailabilityOnly When set to true, returns only image availability. Else, returns both image urls and its availability. (optional) + * @return ApiResponse<BasicDocumentsImageUrlsInfo> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getMegaSignAllDocumentsImageUrlsWithHttpInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String imageSizes, Boolean showImageAvailabilityOnly) throws ApiException { + com.squareup.okhttp.Call call = getMegaSignAllDocumentsImageUrlsValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, imageSizes, showImageAvailabilityOnly, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves image urls of all visible pages of a document associated with a MegaSign parent agreement. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param imageSizes A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. (optional) + * @param showImageAvailabilityOnly When set to true, returns only image availability. Else, returns both image urls and its availability. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getMegaSignAllDocumentsImageUrlsAsync(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String imageSizes, Boolean showImageAvailabilityOnly, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getMegaSignAllDocumentsImageUrlsValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, imageSizes, showImageAvailabilityOnly, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getMegaSignChildAgreements + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) + * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getMegaSignChildAgreementsCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/megaSigns/{megaSignId}/agreements" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (cursor != null) + localVarQueryParams.addAll(apiClient.parameterToPair("cursor", cursor)); + if (pageSize != null) + localVarQueryParams.addAll(apiClient.parameterToPair("pageSize", pageSize)); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getMegaSignChildAgreementsValidateBeforeCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignChildAgreements(Async)"); + } + + // verify the required parameter 'megaSignId' is set + if (megaSignId == null) { + throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignChildAgreements(Async)"); + } + + + com.squareup.okhttp.Call call = getMegaSignChildAgreementsCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, cursor, pageSize, progressListener, progressRequestListener); + return call; + + } + + /** + * Get all the child agreements of the specified MegaSign parent agreement. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) + * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) + * @return MegaSignChildAgreements + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public MegaSignChildAgreements getMegaSignChildAgreements(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String cursor, Integer pageSize) throws ApiException { + ApiResponse resp = getMegaSignChildAgreementsWithHttpInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, cursor, pageSize); + return resp.getData(); + } + + /** + * Get all the child agreements of the specified MegaSign parent agreement. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) + * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) + * @return ApiResponse<MegaSignChildAgreements> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getMegaSignChildAgreementsWithHttpInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String cursor, Integer pageSize) throws ApiException { + com.squareup.okhttp.Call call = getMegaSignChildAgreementsValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, cursor, pageSize, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Get all the child agreements of the specified MegaSign parent agreement. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) + * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getMegaSignChildAgreementsAsync(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String cursor, Integer pageSize, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getMegaSignChildAgreementsValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, cursor, pageSize, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getMegaSignCombinedDocument + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param attachAuditReport When set to true attach an audit report to the MegaSign document PDF. Default value will be false. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getMegaSignCombinedDocumentCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, Boolean attachAuditReport, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/megaSigns/{megaSignId}/combinedDocument" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (attachAuditReport != null) + localVarQueryParams.addAll(apiClient.parameterToPair("attachAuditReport", attachAuditReport)); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + if (ifNoneMatch != null) + localVarHeaderParams.put("If-None-Match", apiClient.parameterToString(ifNoneMatch)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/pdf", "application/pdf;encoding=base64" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getMegaSignCombinedDocumentValidateBeforeCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, Boolean attachAuditReport, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignCombinedDocument(Async)"); + } + + // verify the required parameter 'megaSignId' is set + if (megaSignId == null) { + throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignCombinedDocument(Async)"); + } + + + com.squareup.okhttp.Call call = getMegaSignCombinedDocumentCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, attachAuditReport, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves a single combined PDF document for the documents associated with the MegaSign parent agreement. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param attachAuditReport When set to true attach an audit report to the MegaSign document PDF. Default value will be false. (optional) + * @return byte[] + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public byte[] getMegaSignCombinedDocument(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, Boolean attachAuditReport) throws ApiException { + ApiResponse resp = getMegaSignCombinedDocumentWithHttpInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, attachAuditReport); + return resp.getData(); + } + + /** + * Retrieves a single combined PDF document for the documents associated with the MegaSign parent agreement. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param attachAuditReport When set to true attach an audit report to the MegaSign document PDF. Default value will be false. (optional) + * @return ApiResponse<byte[]> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getMegaSignCombinedDocumentWithHttpInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, Boolean attachAuditReport) throws ApiException { + com.squareup.okhttp.Call call = getMegaSignCombinedDocumentValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, attachAuditReport, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves a single combined PDF document for the documents associated with the MegaSign parent agreement. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param attachAuditReport When set to true attach an audit report to the MegaSign document PDF. Default value will be false. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getMegaSignCombinedDocumentAsync(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, Boolean attachAuditReport, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getMegaSignCombinedDocumentValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, attachAuditReport, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getMegaSignCombinedDocumentUrl + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param attachAuditReport When set to true, attach an audit report to the MegaSign PDF. The default value is false. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getMegaSignCombinedDocumentUrlCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, Boolean attachAuditReport, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/megaSigns/{megaSignId}/combinedDocument/url" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (attachAuditReport != null) + localVarQueryParams.addAll(apiClient.parameterToPair("attachAuditReport", attachAuditReport)); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getMegaSignCombinedDocumentUrlValidateBeforeCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, Boolean attachAuditReport, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignCombinedDocumentUrl(Async)"); + } + + // verify the required parameter 'megaSignId' is set + if (megaSignId == null) { + throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignCombinedDocumentUrl(Async)"); + } + + + com.squareup.okhttp.Call call = getMegaSignCombinedDocumentUrlCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, attachAuditReport, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves url of all visible pages of all the documents associated with the MegaSign parent agreement. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param attachAuditReport When set to true, attach an audit report to the MegaSign PDF. The default value is false. (optional) + * @return DocumentUrl + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public DocumentUrl getMegaSignCombinedDocumentUrl(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, Boolean attachAuditReport) throws ApiException { + ApiResponse resp = getMegaSignCombinedDocumentUrlWithHttpInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, attachAuditReport); + return resp.getData(); + } + + /** + * Retrieves url of all visible pages of all the documents associated with the MegaSign parent agreement. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param attachAuditReport When set to true, attach an audit report to the MegaSign PDF. The default value is false. (optional) + * @return ApiResponse<DocumentUrl> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getMegaSignCombinedDocumentUrlWithHttpInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, Boolean attachAuditReport) throws ApiException { + com.squareup.okhttp.Call call = getMegaSignCombinedDocumentUrlValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, attachAuditReport, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves url of all visible pages of all the documents associated with the MegaSign parent agreement. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param attachAuditReport When set to true, attach an audit report to the MegaSign PDF. The default value is false. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getMegaSignCombinedDocumentUrlAsync(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, Boolean attachAuditReport, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getMegaSignCombinedDocumentUrlValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, attachAuditReport, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getMegaSignDocumentInfo + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified MegaSign parent (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getMegaSignDocumentInfoCall(String authorization, String megaSignId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/megaSigns/{megaSignId}/documents/{documentId}" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())) + .replaceAll("\\{" + "documentId" + "\\}", apiClient.escapeString(documentId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + if (ifNoneMatch != null) + localVarHeaderParams.put("If-None-Match", apiClient.parameterToString(ifNoneMatch)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/pdf", "application/pdf;encoding=base64" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getMegaSignDocumentInfoValidateBeforeCall(String authorization, String megaSignId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignDocumentInfo(Async)"); + } + + // verify the required parameter 'megaSignId' is set + if (megaSignId == null) { + throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignDocumentInfo(Async)"); + } + + // verify the required parameter 'documentId' is set + if (documentId == null) { + throw new ApiException("Missing the required parameter 'documentId' when calling getMegaSignDocumentInfo(Async)"); + } + + + com.squareup.okhttp.Call call = getMegaSignDocumentInfoCall(authorization, megaSignId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves the file stream of a document of a MegaSign parent agreement. + * Raw stream of the file + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified MegaSign parent (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @return byte[] + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public byte[] getMegaSignDocumentInfo(String authorization, String megaSignId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + ApiResponse resp = getMegaSignDocumentInfoWithHttpInfo(authorization, megaSignId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + return resp.getData(); + } + + /** + * Retrieves the file stream of a document of a MegaSign parent agreement. + * Raw stream of the file + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified MegaSign parent (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @return ApiResponse<byte[]> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getMegaSignDocumentInfoWithHttpInfo(String authorization, String megaSignId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + com.squareup.okhttp.Call call = getMegaSignDocumentInfoValidateBeforeCall(authorization, megaSignId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves the file stream of a document of a MegaSign parent agreement. (asynchronously) + * Raw stream of the file + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified MegaSign parent (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getMegaSignDocumentInfoAsync(String authorization, String megaSignId, String documentId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getMegaSignDocumentInfoValidateBeforeCall(authorization, megaSignId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getMegaSignFormData + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getMegaSignFormDataCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/megaSigns/{megaSignId}/formData" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "text/csv" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getMegaSignFormDataValidateBeforeCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignFormData(Async)"); + } + + // verify the required parameter 'megaSignId' is set + if (megaSignId == null) { + throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignFormData(Async)"); + } + + + com.squareup.okhttp.Call call = getMegaSignFormDataCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves data entered by recipients into interactive form fields at the time they signed the child agreements of the specified MegaSign agreement + * CSV file stream containing form data information + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @return byte[] + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public byte[] getMegaSignFormData(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser) throws ApiException { + ApiResponse resp = getMegaSignFormDataWithHttpInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser); + return resp.getData(); + } + + /** + * Retrieves data entered by recipients into interactive form fields at the time they signed the child agreements of the specified MegaSign agreement + * CSV file stream containing form data information + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @return ApiResponse<byte[]> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getMegaSignFormDataWithHttpInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser) throws ApiException { + com.squareup.okhttp.Call call = getMegaSignFormDataValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves data entered by recipients into interactive form fields at the time they signed the child agreements of the specified MegaSign agreement (asynchronously) + * CSV file stream containing form data information + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getMegaSignFormDataAsync(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getMegaSignFormDataValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getMegaSignInfo + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getMegaSignInfoCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/megaSigns/{megaSignId}" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + if (ifNoneMatch != null) + localVarHeaderParams.put("If-None-Match", apiClient.parameterToString(ifNoneMatch)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getMegaSignInfoValidateBeforeCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignInfo(Async)"); + } + + // verify the required parameter 'megaSignId' is set + if (megaSignId == null) { + throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignInfo(Async)"); + } + + + com.squareup.okhttp.Call call = getMegaSignInfoCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + return call; + + } + + /** + * Get detailed information of the specified MegaSign parent agreement. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @return FetchedMegaSignInfo + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public FetchedMegaSignInfo getMegaSignInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + ApiResponse resp = getMegaSignInfoWithHttpInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + return resp.getData(); + } + + /** + * Get detailed information of the specified MegaSign parent agreement. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @return ApiResponse<FetchedMegaSignInfo> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getMegaSignInfoWithHttpInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + com.squareup.okhttp.Call call = getMegaSignInfoValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } /** * Get detailed information of the specified MegaSign parent agreement. (asynchronously) * - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getMegaSignInfoAsync(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getMegaSignInfoValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getMegaSignInfoForUser + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getMegaSignInfoForUserCall(String authorization, String megaSignId, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/megaSigns/{megaSignId}/me" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getMegaSignInfoForUserValidateBeforeCall(String authorization, String megaSignId, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignInfoForUser(Async)"); + } + + // verify the required parameter 'megaSignId' is set + if (megaSignId == null) { + throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignInfoForUser(Async)"); + } + + + com.squareup.okhttp.Call call = getMegaSignInfoForUserCall(authorization, megaSignId, xApiUser, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves the MegaSign parent agreement information related to the api caller + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @return MyAgreementInfo + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public MyAgreementInfo getMegaSignInfoForUser(String authorization, String megaSignId, String xApiUser) throws ApiException { + ApiResponse resp = getMegaSignInfoForUserWithHttpInfo(authorization, megaSignId, xApiUser); + return resp.getData(); + } + + /** + * Retrieves the MegaSign parent agreement information related to the api caller + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @return ApiResponse<MyAgreementInfo> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getMegaSignInfoForUserWithHttpInfo(String authorization, String megaSignId, String xApiUser) throws ApiException { + com.squareup.okhttp.Call call = getMegaSignInfoForUserValidateBeforeCall(authorization, megaSignId, xApiUser, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves the MegaSign parent agreement information related to the api caller (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getMegaSignInfoForUserAsync(String authorization, String megaSignId, String xApiUser, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getMegaSignInfoForUserValidateBeforeCall(authorization, megaSignId, xApiUser, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getMegaSignNoteForUser + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getMegaSignNoteForUserCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/megaSigns/{megaSignId}/me/note" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getMegaSignNoteForUserValidateBeforeCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignNoteForUser(Async)"); + } + + // verify the required parameter 'megaSignId' is set + if (megaSignId == null) { + throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignNoteForUser(Async)"); + } + + + com.squareup.okhttp.Call call = getMegaSignNoteForUserCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves the latest note of a MegaSign parent agreement for the user. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @return Note + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public Note getMegaSignNoteForUser(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser) throws ApiException { + ApiResponse resp = getMegaSignNoteForUserWithHttpInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser); + return resp.getData(); + } + + /** + * Retrieves the latest note of a MegaSign parent agreement for the user. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @return ApiResponse<Note> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getMegaSignNoteForUserWithHttpInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser) throws ApiException { + com.squareup.okhttp.Call call = getMegaSignNoteForUserValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves the latest note of a MegaSign parent agreement for the user. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getMegaSignNoteForUserAsync(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getMegaSignNoteForUserValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getMegaSignReminder + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param reminderId The reminder identifier (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getMegaSignReminderCall(String authorization, String megaSignId, String reminderId, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/megaSigns/{megaSignId}/reminders/{reminderId}" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())) + .replaceAll("\\{" + "reminderId" + "\\}", apiClient.escapeString(reminderId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getMegaSignReminderValidateBeforeCall(String authorization, String megaSignId, String reminderId, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignReminder(Async)"); + } + + // verify the required parameter 'megaSignId' is set + if (megaSignId == null) { + throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignReminder(Async)"); + } + + // verify the required parameter 'reminderId' is set + if (reminderId == null) { + throw new ApiException("Missing the required parameter 'reminderId' when calling getMegaSignReminder(Async)"); + } + + + com.squareup.okhttp.Call call = getMegaSignReminderCall(authorization, megaSignId, reminderId, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves a specific reminder given the reminder id for the specified MegaSign parent agreement. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param reminderId The reminder identifier (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @return ReminderInfo + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ReminderInfo getMegaSignReminder(String authorization, String megaSignId, String reminderId, String xApiUser, String xOnBehalfOfUser) throws ApiException { + ApiResponse resp = getMegaSignReminderWithHttpInfo(authorization, megaSignId, reminderId, xApiUser, xOnBehalfOfUser); + return resp.getData(); + } + + /** + * Retrieves a specific reminder given the reminder id for the specified MegaSign parent agreement. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param reminderId The reminder identifier (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @return ApiResponse<ReminderInfo> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getMegaSignReminderWithHttpInfo(String authorization, String megaSignId, String reminderId, String xApiUser, String xOnBehalfOfUser) throws ApiException { + com.squareup.okhttp.Call call = getMegaSignReminderValidateBeforeCall(authorization, megaSignId, reminderId, xApiUser, xOnBehalfOfUser, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves a specific reminder given the reminder id for the specified MegaSign parent agreement. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param reminderId The reminder identifier (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getMegaSignReminderAsync(String authorization, String megaSignId, String reminderId, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getMegaSignReminderValidateBeforeCall(authorization, megaSignId, reminderId, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getMegaSignReminders + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param status A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELED, COMPLETE (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getMegaSignRemindersCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String status, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/megaSigns/{megaSignId}/reminders" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (status != null) + localVarQueryParams.addAll(apiClient.parameterToPair("status", status)); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getMegaSignRemindersValidateBeforeCall(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String status, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignReminders(Async)"); + } + + // verify the required parameter 'megaSignId' is set + if (megaSignId == null) { + throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignReminders(Async)"); + } + + + com.squareup.okhttp.Call call = getMegaSignRemindersCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, status, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves the reminders of the specified MegaSign parent agreement. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param status A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELED, COMPLETE (optional) + * @return MegaSignRemindersResponse + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public MegaSignRemindersResponse getMegaSignReminders(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String status) throws ApiException { + ApiResponse resp = getMegaSignRemindersWithHttpInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, status); + return resp.getData(); + } + + /** + * Retrieves the reminders of the specified MegaSign parent agreement. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param status A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELED, COMPLETE (optional) + * @return ApiResponse<MegaSignRemindersResponse> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getMegaSignRemindersWithHttpInfo(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String status) throws ApiException { + com.squareup.okhttp.Call call = getMegaSignRemindersValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, status, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves the reminders of the specified MegaSign parent agreement. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param status A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELED, COMPLETE (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getMegaSignRemindersAsync(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String status, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getMegaSignRemindersValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, status, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getMegaSignView + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a> - agreement read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param megaSignViewInfo Name of the required view and its desired configuration. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getMegaSignViewCall(String authorization, String megaSignId, MegaSignViewInfo megaSignViewInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = megaSignViewInfo; + + // create path and map variables + String localVarPath = "/megaSigns/{megaSignId}/views" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getMegaSignViewValidateBeforeCall(String authorization, String megaSignId, MegaSignViewInfo megaSignViewInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignView(Async)"); + } + + // verify the required parameter 'megaSignId' is set + if (megaSignId == null) { + throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignView(Async)"); + } + + // verify the required parameter 'megaSignViewInfo' is set + if (megaSignViewInfo == null) { + throw new ApiException("Missing the required parameter 'megaSignViewInfo' when calling getMegaSignView(Async)"); + } + + + com.squareup.okhttp.Call call = getMegaSignViewCall(authorization, megaSignId, megaSignViewInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves the requested views of mega sign agreement. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a> - agreement read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param megaSignViewInfo Name of the required view and its desired configuration. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @return MegaSignViewResponse + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public MegaSignViewResponse getMegaSignView(String authorization, String megaSignId, MegaSignViewInfo megaSignViewInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { + ApiResponse resp = getMegaSignViewWithHttpInfo(authorization, megaSignId, megaSignViewInfo, xApiUser, xOnBehalfOfUser); + return resp.getData(); + } + + /** + * Retrieves the requested views of mega sign agreement. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a> - agreement read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param megaSignViewInfo Name of the required view and its desired configuration. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @return ApiResponse<MegaSignViewResponse> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getMegaSignViewWithHttpInfo(String authorization, String megaSignId, MegaSignViewInfo megaSignViewInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { + com.squareup.okhttp.Call call = getMegaSignViewValidateBeforeCall(authorization, megaSignId, megaSignViewInfo, xApiUser, xOnBehalfOfUser, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves the requested views of mega sign agreement. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a> - agreement read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param megaSignViewInfo Name of the required view and its desired configuration. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getMegaSignViewAsync(String authorization, String megaSignId, MegaSignViewInfo megaSignViewInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getMegaSignViewValidateBeforeCall(authorization, megaSignId, megaSignViewInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getMegaSigns + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param showHiddenMegaSigns A query parameter to fetch all the hidden MegaSigns along with the visible MegaSigns. Default value is false. (optional) + * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) + * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getMegaSignsCall(String authorization, String xApiUser, String xOnBehalfOfUser, Boolean showHiddenMegaSigns, String cursor, Integer pageSize, String groupId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/megaSigns"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (showHiddenMegaSigns != null) + localVarQueryParams.addAll(apiClient.parameterToPair("showHiddenMegaSigns", showHiddenMegaSigns)); + if (cursor != null) + localVarQueryParams.addAll(apiClient.parameterToPair("cursor", cursor)); + if (pageSize != null) + localVarQueryParams.addAll(apiClient.parameterToPair("pageSize", pageSize)); + if (groupId != null) + localVarQueryParams.addAll(apiClient.parameterToPair("groupId", groupId)); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getMegaSignsValidateBeforeCall(String authorization, String xApiUser, String xOnBehalfOfUser, Boolean showHiddenMegaSigns, String cursor, Integer pageSize, String groupId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSigns(Async)"); + } + + + com.squareup.okhttp.Call call = getMegaSignsCall(authorization, xApiUser, xOnBehalfOfUser, showHiddenMegaSigns, cursor, pageSize, groupId, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves MegaSign parent agreements for a user. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param showHiddenMegaSigns A query parameter to fetch all the hidden MegaSigns along with the visible MegaSigns. Default value is false. (optional) + * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) + * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) + * @return MegaSigns + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public MegaSigns getMegaSigns(String authorization, String xApiUser, String xOnBehalfOfUser, Boolean showHiddenMegaSigns, String cursor, Integer pageSize, String groupId) throws ApiException { + ApiResponse resp = getMegaSignsWithHttpInfo(authorization, xApiUser, xOnBehalfOfUser, showHiddenMegaSigns, cursor, pageSize, groupId); + return resp.getData(); + } + + /** + * Retrieves MegaSign parent agreements for a user. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param showHiddenMegaSigns A query parameter to fetch all the hidden MegaSigns along with the visible MegaSigns. Default value is false. (optional) + * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) + * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) + * @return ApiResponse<MegaSigns> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getMegaSignsWithHttpInfo(String authorization, String xApiUser, String xOnBehalfOfUser, Boolean showHiddenMegaSigns, String cursor, Integer pageSize, String groupId) throws ApiException { + com.squareup.okhttp.Call call = getMegaSignsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, showHiddenMegaSigns, cursor, pageSize, groupId, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves MegaSign parent agreements for a user. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param showHiddenMegaSigns A query parameter to fetch all the hidden MegaSigns along with the visible MegaSigns. Default value is false. (optional) + * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) + * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getMegaSignsAsync(String authorization, String xApiUser, String xOnBehalfOfUser, Boolean showHiddenMegaSigns, String cursor, Integer pageSize, String groupId, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getMegaSignsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, showHiddenMegaSigns, cursor, pageSize, groupId, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for updateMegaSign + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param megaSignInfo Information necessary to update a modifiable megaSign parent that is presently out for signature. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call updateMegaSignCall(String authorization, String megaSignId, MegaSignInfo megaSignInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = megaSignInfo; + + // create path and map variables + String localVarPath = "/megaSigns/{megaSignId}" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + if (ifMatch != null) + localVarHeaderParams.put("If-Match", apiClient.parameterToString(ifMatch)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call updateMegaSignValidateBeforeCall(String authorization, String megaSignId, MegaSignInfo megaSignInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling updateMegaSign(Async)"); + } + + // verify the required parameter 'megaSignId' is set + if (megaSignId == null) { + throw new ApiException("Missing the required parameter 'megaSignId' when calling updateMegaSign(Async)"); + } + + // verify the required parameter 'megaSignInfo' is set + if (megaSignInfo == null) { + throw new ApiException("Missing the required parameter 'megaSignInfo' when calling updateMegaSign(Async)"); + } + + + com.squareup.okhttp.Call call = updateMegaSignCall(authorization, megaSignId, megaSignInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); + return call; + + } + + /** + * Update the expirationTime on an existing megaSign parent and all the child agreements that are already out for signature. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param megaSignInfo Information necessary to update a modifiable megaSign parent that is presently out for signature. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public void updateMegaSign(String authorization, String megaSignId, MegaSignInfo megaSignInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + updateMegaSignWithHttpInfo(authorization, megaSignId, megaSignInfo, xApiUser, xOnBehalfOfUser, ifMatch); + } + + /** + * Update the expirationTime on an existing megaSign parent and all the child agreements that are already out for signature. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param megaSignInfo Information necessary to update a modifiable megaSign parent that is presently out for signature. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse updateMegaSignWithHttpInfo(String authorization, String megaSignId, MegaSignInfo megaSignInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + com.squareup.okhttp.Call call = updateMegaSignValidateBeforeCall(authorization, megaSignId, megaSignInfo, xApiUser, xOnBehalfOfUser, ifMatch, null, null); + return apiClient.execute(call); + } + + /** + * Update the expirationTime on an existing megaSign parent and all the child agreements that are already out for signature. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param megaSignInfo Information necessary to update a modifiable megaSign parent that is presently out for signature. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getMegaSignInfoAsync(String authorization, String megaSignId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateMegaSignAsync(String authorization, String megaSignId, MegaSignInfo megaSignInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -1144,16 +3296,15 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getMegaSignInfoValidateBeforeCall(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); - apiClient.executeAsync(call, localVarReturnType, callback); + com.squareup.okhttp.Call call = updateMegaSignValidateBeforeCall(authorization, megaSignId, megaSignInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); + apiClient.executeAsync(call, callback); return call; } /** - * Build call for getMegaSignView - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a> - agreement read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. (required) + * Build call for updateMegaSignNoteForUser + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) - * @param megaSignViewInfo Name of the required view and its desired configuration. (required) + * @param note The note to be associated with the MegaSign parent agreement. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param progressListener Progress listener @@ -1161,11 +3312,11 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getMegaSignViewCall(String authorization, String megaSignId, MegaSignViewInfo megaSignViewInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { - Object localVarPostBody = megaSignViewInfo; + public com.squareup.okhttp.Call updateMegaSignNoteForUserCall(String authorization, String megaSignId, Note note, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = note; // create path and map variables - String localVarPath = "/megaSigns/{megaSignId}/views" + String localVarPath = "/megaSigns/{megaSignId}/me/note" .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); List localVarQueryParams = new ArrayList(); @@ -1206,79 +3357,76 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } String[] localVarAuthNames = new String[] { }; - return apiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + return apiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getMegaSignViewValidateBeforeCall(String authorization, String megaSignId, MegaSignViewInfo megaSignViewInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateMegaSignNoteForUserValidateBeforeCall(String authorization, String megaSignId, Note note, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { - throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSignView(Async)"); + throw new ApiException("Missing the required parameter 'authorization' when calling updateMegaSignNoteForUser(Async)"); } // verify the required parameter 'megaSignId' is set if (megaSignId == null) { - throw new ApiException("Missing the required parameter 'megaSignId' when calling getMegaSignView(Async)"); + throw new ApiException("Missing the required parameter 'megaSignId' when calling updateMegaSignNoteForUser(Async)"); } - // verify the required parameter 'megaSignViewInfo' is set - if (megaSignViewInfo == null) { - throw new ApiException("Missing the required parameter 'megaSignViewInfo' when calling getMegaSignView(Async)"); + // verify the required parameter 'note' is set + if (note == null) { + throw new ApiException("Missing the required parameter 'note' when calling updateMegaSignNoteForUser(Async)"); } - com.squareup.okhttp.Call call = getMegaSignViewCall(authorization, megaSignId, megaSignViewInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateMegaSignNoteForUserCall(authorization, megaSignId, note, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); return call; } /** - * Retrieves the requested views of mega sign agreement. + * Updates the latest note of a MegaSign parent agreement for the user. * - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a> - agreement read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) - * @param megaSignViewInfo Name of the required view and its desired configuration. (required) + * @param note The note to be associated with the MegaSign parent agreement. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @return MegaSignViewResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public MegaSignViewResponse getMegaSignView(String authorization, String megaSignId, MegaSignViewInfo megaSignViewInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - ApiResponse resp = getMegaSignViewWithHttpInfo(authorization, megaSignId, megaSignViewInfo, xApiUser, xOnBehalfOfUser); - return resp.getData(); + public void updateMegaSignNoteForUser(String authorization, String megaSignId, Note note, String xApiUser, String xOnBehalfOfUser) throws ApiException { + updateMegaSignNoteForUserWithHttpInfo(authorization, megaSignId, note, xApiUser, xOnBehalfOfUser); } /** - * Retrieves the requested views of mega sign agreement. + * Updates the latest note of a MegaSign parent agreement for the user. * - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a> - agreement read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) - * @param megaSignViewInfo Name of the required view and its desired configuration. (required) + * @param note The note to be associated with the MegaSign parent agreement. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @return ApiResponse<MegaSignViewResponse> + * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getMegaSignViewWithHttpInfo(String authorization, String megaSignId, MegaSignViewInfo megaSignViewInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = getMegaSignViewValidateBeforeCall(authorization, megaSignId, megaSignViewInfo, xApiUser, xOnBehalfOfUser, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return apiClient.execute(call, localVarReturnType); + public ApiResponse updateMegaSignNoteForUserWithHttpInfo(String authorization, String megaSignId, Note note, String xApiUser, String xOnBehalfOfUser) throws ApiException { + com.squareup.okhttp.Call call = updateMegaSignNoteForUserValidateBeforeCall(authorization, megaSignId, note, xApiUser, xOnBehalfOfUser, null, null); + return apiClient.execute(call); } /** - * Retrieves the requested views of mega sign agreement. (asynchronously) + * Updates the latest note of a MegaSign parent agreement for the user. (asynchronously) * - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a> - agreement read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) - * @param megaSignViewInfo Name of the required view and its desired configuration. (required) + * @param note The note to be associated with the MegaSign parent agreement. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getMegaSignViewAsync(String authorization, String megaSignId, MegaSignViewInfo megaSignViewInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateMegaSignNoteForUserAsync(String authorization, String megaSignId, Note note, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -1299,35 +3447,33 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getMegaSignViewValidateBeforeCall(authorization, megaSignId, megaSignViewInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); - apiClient.executeAsync(call, localVarReturnType, callback); + com.squareup.okhttp.Call call = updateMegaSignNoteForUserValidateBeforeCall(authorization, megaSignId, note, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + apiClient.executeAsync(call, callback); return call; } /** - * Build call for getMegaSigns - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * Build call for updateMegaSignReminder + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param reminderId The reminder identifier (required) + * @param reminderInfo The information about a reminder associated with a recipient of an agreement. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) - * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getMegaSignsCall(String authorization, String xApiUser, String xOnBehalfOfUser, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { - Object localVarPostBody = null; + public com.squareup.okhttp.Call updateMegaSignReminderCall(String authorization, String megaSignId, String reminderId, ReminderInfo reminderInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = reminderInfo; // create path and map variables - String localVarPath = "/megaSigns"; + String localVarPath = "/megaSigns/{megaSignId}/reminders/{reminderId}" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())) + .replaceAll("\\{" + "reminderId" + "\\}", apiClient.escapeString(reminderId.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); - if (cursor != null) - localVarQueryParams.addAll(apiClient.parameterToPair("cursor", cursor)); - if (pageSize != null) - localVarQueryParams.addAll(apiClient.parameterToPair("pageSize", pageSize)); Map localVarHeaderParams = new HashMap(); if (authorization != null) @@ -1364,69 +3510,84 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } String[] localVarAuthNames = new String[] { }; - return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + return apiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getMegaSignsValidateBeforeCall(String authorization, String xApiUser, String xOnBehalfOfUser, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateMegaSignReminderValidateBeforeCall(String authorization, String megaSignId, String reminderId, ReminderInfo reminderInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { - throw new ApiException("Missing the required parameter 'authorization' when calling getMegaSigns(Async)"); + throw new ApiException("Missing the required parameter 'authorization' when calling updateMegaSignReminder(Async)"); + } + + // verify the required parameter 'megaSignId' is set + if (megaSignId == null) { + throw new ApiException("Missing the required parameter 'megaSignId' when calling updateMegaSignReminder(Async)"); + } + + // verify the required parameter 'reminderId' is set + if (reminderId == null) { + throw new ApiException("Missing the required parameter 'reminderId' when calling updateMegaSignReminder(Async)"); + } + + // verify the required parameter 'reminderInfo' is set + if (reminderInfo == null) { + throw new ApiException("Missing the required parameter 'reminderInfo' when calling updateMegaSignReminder(Async)"); } - com.squareup.okhttp.Call call = getMegaSignsCall(authorization, xApiUser, xOnBehalfOfUser, cursor, pageSize, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateMegaSignReminderCall(authorization, megaSignId, reminderId, reminderInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); return call; } /** - * Retrieves MegaSign parent agreements for a user. - * - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * Updates an existing reminder for a MegaSign parent agreement. + * You can only update an ACTIVE reminder, and can only update the status to 'CANCELED', update reminderParticipantIds, update allUnsigned or update note. + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param reminderId The reminder identifier (required) + * @param reminderInfo The information about a reminder associated with a recipient of an agreement. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) - * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) - * @return MegaSigns * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public MegaSigns getMegaSigns(String authorization, String xApiUser, String xOnBehalfOfUser, String cursor, Integer pageSize) throws ApiException { - ApiResponse resp = getMegaSignsWithHttpInfo(authorization, xApiUser, xOnBehalfOfUser, cursor, pageSize); - return resp.getData(); + public void updateMegaSignReminder(String authorization, String megaSignId, String reminderId, ReminderInfo reminderInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { + updateMegaSignReminderWithHttpInfo(authorization, megaSignId, reminderId, reminderInfo, xApiUser, xOnBehalfOfUser); } /** - * Retrieves MegaSign parent agreements for a user. - * - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * Updates an existing reminder for a MegaSign parent agreement. + * You can only update an ACTIVE reminder, and can only update the status to 'CANCELED', update reminderParticipantIds, update allUnsigned or update note. + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param reminderId The reminder identifier (required) + * @param reminderInfo The information about a reminder associated with a recipient of an agreement. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) - * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) - * @return ApiResponse<MegaSigns> + * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getMegaSignsWithHttpInfo(String authorization, String xApiUser, String xOnBehalfOfUser, String cursor, Integer pageSize) throws ApiException { - com.squareup.okhttp.Call call = getMegaSignsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, cursor, pageSize, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return apiClient.execute(call, localVarReturnType); + public ApiResponse updateMegaSignReminderWithHttpInfo(String authorization, String megaSignId, String reminderId, ReminderInfo reminderInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { + com.squareup.okhttp.Call call = updateMegaSignReminderValidateBeforeCall(authorization, megaSignId, reminderId, reminderInfo, xApiUser, xOnBehalfOfUser, null, null); + return apiClient.execute(call); } /** - * Retrieves MegaSign parent agreements for a user. (asynchronously) - * - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_read')\" oncontextmenu=\"this.href=oauthDoc('agreement_read')\" target=\"oauthDoc\">agreement_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * Updates an existing reminder for a MegaSign parent agreement. (asynchronously) + * You can only update an ACTIVE reminder, and can only update the status to 'CANCELED', update reminderParticipantIds, update allUnsigned or update note. + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param reminderId The reminder identifier (required) + * @param reminderInfo The information about a reminder associated with a recipient of an agreement. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) - * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getMegaSignsAsync(String authorization, String xApiUser, String xOnBehalfOfUser, String cursor, Integer pageSize, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateMegaSignReminderAsync(String authorization, String megaSignId, String reminderId, ReminderInfo reminderInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -1447,25 +3608,24 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getMegaSignsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, cursor, pageSize, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); - apiClient.executeAsync(call, localVarReturnType, callback); + com.squareup.okhttp.Call call = updateMegaSignReminderValidateBeforeCall(authorization, megaSignId, reminderId, reminderInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + apiClient.executeAsync(call, callback); return call; } /** * Build call for updateMegaSignState * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) * @param megaSignStateInfo MegaSign state update information object. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call updateMegaSignStateCall(String authorization, String ifMatch, String megaSignId, MegaSignStateInfo megaSignStateInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call updateMegaSignStateCall(String authorization, String megaSignId, MegaSignStateInfo megaSignStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = megaSignStateInfo; // create path and map variables @@ -1516,18 +3676,13 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call updateMegaSignStateValidateBeforeCall(String authorization, String ifMatch, String megaSignId, MegaSignStateInfo megaSignStateInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateMegaSignStateValidateBeforeCall(String authorization, String megaSignId, MegaSignStateInfo megaSignStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling updateMegaSignState(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling updateMegaSignState(Async)"); - } - // verify the required parameter 'megaSignId' is set if (megaSignId == null) { throw new ApiException("Missing the required parameter 'megaSignId' when calling updateMegaSignState(Async)"); @@ -1539,7 +3694,7 @@ private com.squareup.okhttp.Call updateMegaSignStateValidateBeforeCall(String au } - com.squareup.okhttp.Call call = updateMegaSignStateCall(authorization, ifMatch, megaSignId, megaSignStateInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateMegaSignStateCall(authorization, megaSignId, megaSignStateInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); return call; } @@ -1548,31 +3703,31 @@ private com.squareup.okhttp.Call updateMegaSignStateValidateBeforeCall(String au * Updates the state of a MegaSign identified by MegaSignId in the path. * This endpoint can be used by creator of the MegaSign to transition between the states of megaSign. An allowed transition would follow the following sequence : IN_PROCESS->CANCELLED. * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) * @param megaSignStateInfo MegaSign state update information object. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void updateMegaSignState(String authorization, String ifMatch, String megaSignId, MegaSignStateInfo megaSignStateInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - updateMegaSignStateWithHttpInfo(authorization, ifMatch, megaSignId, megaSignStateInfo, xApiUser, xOnBehalfOfUser); + public void updateMegaSignState(String authorization, String megaSignId, MegaSignStateInfo megaSignStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + updateMegaSignStateWithHttpInfo(authorization, megaSignId, megaSignStateInfo, xApiUser, xOnBehalfOfUser, ifMatch); } /** * Updates the state of a MegaSign identified by MegaSignId in the path. * This endpoint can be used by creator of the MegaSign to transition between the states of megaSign. An allowed transition would follow the following sequence : IN_PROCESS->CANCELLED. * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) * @param megaSignStateInfo MegaSign state update information object. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse updateMegaSignStateWithHttpInfo(String authorization, String ifMatch, String megaSignId, MegaSignStateInfo megaSignStateInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = updateMegaSignStateValidateBeforeCall(authorization, ifMatch, megaSignId, megaSignStateInfo, xApiUser, xOnBehalfOfUser, null, null); + public ApiResponse updateMegaSignStateWithHttpInfo(String authorization, String megaSignId, MegaSignStateInfo megaSignStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + com.squareup.okhttp.Call call = updateMegaSignStateValidateBeforeCall(authorization, megaSignId, megaSignStateInfo, xApiUser, xOnBehalfOfUser, ifMatch, null, null); return apiClient.execute(call); } @@ -1580,16 +3735,167 @@ public ApiResponse updateMegaSignStateWithHttpInfo(String authorization, S * Updates the state of a MegaSign identified by MegaSignId in the path. (asynchronously) * This endpoint can be used by creator of the MegaSign to transition between the states of megaSign. An allowed transition would follow the following sequence : IN_PROCESS->CANCELLED. * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) * @param megaSignStateInfo MegaSign state update information object. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call updateMegaSignStateAsync(String authorization, String megaSignId, MegaSignStateInfo megaSignStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = updateMegaSignStateValidateBeforeCall(authorization, megaSignId, megaSignStateInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); + apiClient.executeAsync(call, callback); + return call; + } + /** + * Build call for updateMegaSignVisibility + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param visibilityInfo Information to update visibility of agreement (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call updateMegaSignVisibilityCall(String authorization, String megaSignId, VisibilityInfo visibilityInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = visibilityInfo; + + // create path and map variables + String localVarPath = "/megaSigns/{megaSignId}/me/visibility" + .replaceAll("\\{" + "megaSignId" + "\\}", apiClient.escapeString(megaSignId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call updateMegaSignVisibilityValidateBeforeCall(String authorization, String megaSignId, VisibilityInfo visibilityInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling updateMegaSignVisibility(Async)"); + } + + // verify the required parameter 'megaSignId' is set + if (megaSignId == null) { + throw new ApiException("Missing the required parameter 'megaSignId' when calling updateMegaSignVisibility(Async)"); + } + + // verify the required parameter 'visibilityInfo' is set + if (visibilityInfo == null) { + throw new ApiException("Missing the required parameter 'visibilityInfo' when calling updateMegaSignVisibility(Async)"); + } + + + com.squareup.okhttp.Call call = updateMegaSignVisibilityCall(authorization, megaSignId, visibilityInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + return call; + + } + + /** + * Updates the visibility of a MegaSign. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param visibilityInfo Information to update visibility of agreement (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public void updateMegaSignVisibility(String authorization, String megaSignId, VisibilityInfo visibilityInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { + updateMegaSignVisibilityWithHttpInfo(authorization, megaSignId, visibilityInfo, xApiUser, xOnBehalfOfUser); + } + + /** + * Updates the visibility of a MegaSign. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param visibilityInfo Information to update visibility of agreement (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse updateMegaSignVisibilityWithHttpInfo(String authorization, String megaSignId, VisibilityInfo visibilityInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { + com.squareup.okhttp.Call call = updateMegaSignVisibilityValidateBeforeCall(authorization, megaSignId, visibilityInfo, xApiUser, xOnBehalfOfUser, null, null); + return apiClient.execute(call); + } + + /** + * Updates the visibility of a MegaSign. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('agreement_write')\" oncontextmenu=\"this.href=oauthDoc('agreement_write')\" target=\"oauthDoc\">agreement_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param megaSignId The identifier of the MegaSign parent agreement, as returned by the megaSign creation API or retrieved from the API to fetch megaSign agreements (required) + * @param visibilityInfo Information to update visibility of agreement (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call updateMegaSignStateAsync(String authorization, String ifMatch, String megaSignId, MegaSignStateInfo megaSignStateInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateMegaSignVisibilityAsync(String authorization, String megaSignId, VisibilityInfo visibilityInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -1610,7 +3916,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = updateMegaSignStateValidateBeforeCall(authorization, ifMatch, megaSignId, megaSignStateInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateMegaSignVisibilityValidateBeforeCall(authorization, megaSignId, visibilityInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } diff --git a/src/main/java/io/swagger/client/api/MessageTemplatesApi.java b/src/main/java/io/swagger/client/api/MessageTemplatesApi.java new file mode 100644 index 0000000..78afeaa --- /dev/null +++ b/src/main/java/io/swagger/client/api/MessageTemplatesApi.java @@ -0,0 +1,222 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.api; + +import io.swagger.client.model.ApiCallback; +import io.swagger.client.model.ApiClient; +import io.swagger.client.model.ApiException; +import io.swagger.client.model.ApiResponse; +import io.swagger.client.model.Configuration; +import io.swagger.client.model.Pair; +import io.swagger.client.model.ProgressRequestBody; +import io.swagger.client.model.ProgressResponseBody; + +import com.google.gson.reflect.TypeToken; + +import java.io.IOException; + + +import io.swagger.client.model.messageTemplates.MessageTemplates; + +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class MessageTemplatesApi { + private ApiClient apiClient; + + public MessageTemplatesApi() { + this(Configuration.getDefaultApiClient()); + } + + public MessageTemplatesApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + public ApiClient getApiClient() { + return apiClient; + } + + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Build call for getMessageTemplates + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_read')\" oncontextmenu=\"this.href=oauthDoc('user_read')\" target=\"oauthDoc\">user_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param locale Message template locale (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) + * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) + * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getMessageTemplatesCall(String authorization, String locale, String xApiUser, String xOnBehalfOfUser, String groupId, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/messageTemplates"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (locale != null) + localVarQueryParams.addAll(apiClient.parameterToPair("locale", locale)); + if (groupId != null) + localVarQueryParams.addAll(apiClient.parameterToPair("groupId", groupId)); + if (cursor != null) + localVarQueryParams.addAll(apiClient.parameterToPair("cursor", cursor)); + if (pageSize != null) + localVarQueryParams.addAll(apiClient.parameterToPair("pageSize", pageSize)); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getMessageTemplatesValidateBeforeCall(String authorization, String locale, String xApiUser, String xOnBehalfOfUser, String groupId, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getMessageTemplates(Async)"); + } + + // verify the required parameter 'locale' is set + if (locale == null) { + throw new ApiException("Missing the required parameter 'locale' when calling getMessageTemplates(Async)"); + } + + + com.squareup.okhttp.Call call = getMessageTemplatesCall(authorization, locale, xApiUser, xOnBehalfOfUser, groupId, cursor, pageSize, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves a list of message templates applicable to the current user. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_read')\" oncontextmenu=\"this.href=oauthDoc('user_read')\" target=\"oauthDoc\">user_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param locale Message template locale (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) + * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) + * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) + * @return MessageTemplates + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public MessageTemplates getMessageTemplates(String authorization, String locale, String xApiUser, String xOnBehalfOfUser, String groupId, String cursor, Integer pageSize) throws ApiException { + ApiResponse resp = getMessageTemplatesWithHttpInfo(authorization, locale, xApiUser, xOnBehalfOfUser, groupId, cursor, pageSize); + return resp.getData(); + } + + /** + * Retrieves a list of message templates applicable to the current user. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_read')\" oncontextmenu=\"this.href=oauthDoc('user_read')\" target=\"oauthDoc\">user_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param locale Message template locale (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) + * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) + * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) + * @return ApiResponse<MessageTemplates> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getMessageTemplatesWithHttpInfo(String authorization, String locale, String xApiUser, String xOnBehalfOfUser, String groupId, String cursor, Integer pageSize) throws ApiException { + com.squareup.okhttp.Call call = getMessageTemplatesValidateBeforeCall(authorization, locale, xApiUser, xOnBehalfOfUser, groupId, cursor, pageSize, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves a list of message templates applicable to the current user. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_read')\" oncontextmenu=\"this.href=oauthDoc('user_read')\" target=\"oauthDoc\">user_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param locale Message template locale (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) + * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) + * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getMessageTemplatesAsync(String authorization, String locale, String xApiUser, String xOnBehalfOfUser, String groupId, String cursor, Integer pageSize, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getMessageTemplatesValidateBeforeCall(authorization, locale, xApiUser, xOnBehalfOfUser, groupId, cursor, pageSize, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } +} diff --git a/src/main/java/io/swagger/client/api/TransientDocumentsApi.java b/src/main/java/io/swagger/client/api/TransientDocumentsApi.java index 660763c..8de2fd1 100755 --- a/src/main/java/io/swagger/client/api/TransientDocumentsApi.java +++ b/src/main/java/io/swagger/client/api/TransientDocumentsApi.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) diff --git a/src/main/java/io/swagger/client/api/UsersApi.java b/src/main/java/io/swagger/client/api/UsersApi.java index 2d79b76..b1bcc10 100755 --- a/src/main/java/io/swagger/client/api/UsersApi.java +++ b/src/main/java/io/swagger/client/api/UsersApi.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) diff --git a/src/main/java/io/swagger/client/api/WebhooksApi.java b/src/main/java/io/swagger/client/api/WebhooksApi.java index 737d65d..f730b30 100755 --- a/src/main/java/io/swagger/client/api/WebhooksApi.java +++ b/src/main/java/io/swagger/client/api/WebhooksApi.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -151,7 +136,7 @@ private com.squareup.okhttp.Call createWebhookValidateBeforeCall(String authoriz /** * Creates a webhook. - * This is a primary endpoint which is used to create a new webhook. A webhook can only be created in ACTIVE state. Currently, webhooks are supported at four scopes - Account, Group, User and Resource. <br/> <br/> Before creating a webhook successfully at any of these scopes, Adobe Sign <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobeio/adobeio-documentation/master/sign/webhooks.md#verificationofintentofthewebhookurl'>verifies</a> that the webhook URL that is provided in the registration request really intends to receive notifications and is a valid URL. <br/>There is a defined mechanism for this validation where Adobe Sign makes an HTTPS GET request to the webhook URL. This request has a custom HTTP header X-AdobeSign-ClientId. The value of this header is the client ID of the application that is requesting to create the webhook. To register a webhook successfully, the webhook URL must respond to this verification request with an HTTPS 2XX response code, and also it must send back the same client ID value in one of the following two ways:<ol><li>In a custom response header, X-AdobeSign-ClientId. This is the same header which was passed in the request, and can be echoed back in the response.</li><li> In the JSON response body of the response with the key of xAdobeSignClientId and its value being the same client ID that was sent in the request. </li></ol><p>On successful registration, Adobe Sign sends a success response (any HTTPS 2XX code) to your client app with the unique webhook identifier and a Location header, which contains the URL of the webhook resource created in Adobe Sign.<br/> To learn more, please refer <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobeio/adobeio-documentation/master/sign/webhooks.md'>Webhooks in Adobe Sign Guide</a>.</p> + * This is a primary endpoint which is used to create a new webhook. A webhook can only be created in ACTIVE state. Currently, webhooks are supported at four scopes - Account, Group, User and Resource. <br/> <br/> Before creating a webhook successfully at any of these scopes, Adobe Sign <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks.md#verificationofintentofthewebhookurl'>verifies</a> that the webhook URL that is provided in the registration request really intends to receive notifications and is a valid URL. <br/>There is a defined mechanism for this validation where Adobe Sign makes an HTTPS GET request to the webhook URL. This request has a custom HTTP header X-AdobeSign-ClientId. The value of this header is the client ID of the application that is requesting to create the webhook. To register a webhook successfully, the webhook URL must respond to this verification request with an HTTPS 2XX response code, and also it must send back the same client ID value in one of the following two ways:<ol><li>In a custom response header, X-AdobeSign-ClientId. This is the same header which was passed in the request, and can be echoed back in the response.</li><li> In the JSON response body of the response with the key of xAdobeSignClientId and its value being the same client ID that was sent in the request. </li></ol><p>On successful registration, Adobe Sign sends a success response (any HTTPS 2XX code) to your client app with the unique webhook identifier and a Location header, which contains the URL of the webhook resource created in Adobe Sign.<br/> To learn more, please refer <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks.md'>Webhooks in Adobe Sign Guide</a>.</p> * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_write')\" oncontextmenu=\"this.href=oauthDoc('webhook_write')\" target=\"oauthDoc\">webhook_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param webhookInfo Information about the webhook that you want to create (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) @@ -166,7 +151,7 @@ public WebhookCreationResponse createWebhook(String authorization, WebhookInfo w /** * Creates a webhook. - * This is a primary endpoint which is used to create a new webhook. A webhook can only be created in ACTIVE state. Currently, webhooks are supported at four scopes - Account, Group, User and Resource. <br/> <br/> Before creating a webhook successfully at any of these scopes, Adobe Sign <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobeio/adobeio-documentation/master/sign/webhooks.md#verificationofintentofthewebhookurl'>verifies</a> that the webhook URL that is provided in the registration request really intends to receive notifications and is a valid URL. <br/>There is a defined mechanism for this validation where Adobe Sign makes an HTTPS GET request to the webhook URL. This request has a custom HTTP header X-AdobeSign-ClientId. The value of this header is the client ID of the application that is requesting to create the webhook. To register a webhook successfully, the webhook URL must respond to this verification request with an HTTPS 2XX response code, and also it must send back the same client ID value in one of the following two ways:<ol><li>In a custom response header, X-AdobeSign-ClientId. This is the same header which was passed in the request, and can be echoed back in the response.</li><li> In the JSON response body of the response with the key of xAdobeSignClientId and its value being the same client ID that was sent in the request. </li></ol><p>On successful registration, Adobe Sign sends a success response (any HTTPS 2XX code) to your client app with the unique webhook identifier and a Location header, which contains the URL of the webhook resource created in Adobe Sign.<br/> To learn more, please refer <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobeio/adobeio-documentation/master/sign/webhooks.md'>Webhooks in Adobe Sign Guide</a>.</p> + * This is a primary endpoint which is used to create a new webhook. A webhook can only be created in ACTIVE state. Currently, webhooks are supported at four scopes - Account, Group, User and Resource. <br/> <br/> Before creating a webhook successfully at any of these scopes, Adobe Sign <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks.md#verificationofintentofthewebhookurl'>verifies</a> that the webhook URL that is provided in the registration request really intends to receive notifications and is a valid URL. <br/>There is a defined mechanism for this validation where Adobe Sign makes an HTTPS GET request to the webhook URL. This request has a custom HTTP header X-AdobeSign-ClientId. The value of this header is the client ID of the application that is requesting to create the webhook. To register a webhook successfully, the webhook URL must respond to this verification request with an HTTPS 2XX response code, and also it must send back the same client ID value in one of the following two ways:<ol><li>In a custom response header, X-AdobeSign-ClientId. This is the same header which was passed in the request, and can be echoed back in the response.</li><li> In the JSON response body of the response with the key of xAdobeSignClientId and its value being the same client ID that was sent in the request. </li></ol><p>On successful registration, Adobe Sign sends a success response (any HTTPS 2XX code) to your client app with the unique webhook identifier and a Location header, which contains the URL of the webhook resource created in Adobe Sign.<br/> To learn more, please refer <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks.md'>Webhooks in Adobe Sign Guide</a>.</p> * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_write')\" oncontextmenu=\"this.href=oauthDoc('webhook_write')\" target=\"oauthDoc\">webhook_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param webhookInfo Information about the webhook that you want to create (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) @@ -182,7 +167,7 @@ public ApiResponse createWebhookWithHttpInfo(String aut /** * Creates a webhook. (asynchronously) - * This is a primary endpoint which is used to create a new webhook. A webhook can only be created in ACTIVE state. Currently, webhooks are supported at four scopes - Account, Group, User and Resource. <br/> <br/> Before creating a webhook successfully at any of these scopes, Adobe Sign <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobeio/adobeio-documentation/master/sign/webhooks.md#verificationofintentofthewebhookurl'>verifies</a> that the webhook URL that is provided in the registration request really intends to receive notifications and is a valid URL. <br/>There is a defined mechanism for this validation where Adobe Sign makes an HTTPS GET request to the webhook URL. This request has a custom HTTP header X-AdobeSign-ClientId. The value of this header is the client ID of the application that is requesting to create the webhook. To register a webhook successfully, the webhook URL must respond to this verification request with an HTTPS 2XX response code, and also it must send back the same client ID value in one of the following two ways:<ol><li>In a custom response header, X-AdobeSign-ClientId. This is the same header which was passed in the request, and can be echoed back in the response.</li><li> In the JSON response body of the response with the key of xAdobeSignClientId and its value being the same client ID that was sent in the request. </li></ol><p>On successful registration, Adobe Sign sends a success response (any HTTPS 2XX code) to your client app with the unique webhook identifier and a Location header, which contains the URL of the webhook resource created in Adobe Sign.<br/> To learn more, please refer <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobeio/adobeio-documentation/master/sign/webhooks.md'>Webhooks in Adobe Sign Guide</a>.</p> + * This is a primary endpoint which is used to create a new webhook. A webhook can only be created in ACTIVE state. Currently, webhooks are supported at four scopes - Account, Group, User and Resource. <br/> <br/> Before creating a webhook successfully at any of these scopes, Adobe Sign <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks.md#verificationofintentofthewebhookurl'>verifies</a> that the webhook URL that is provided in the registration request really intends to receive notifications and is a valid URL. <br/>There is a defined mechanism for this validation where Adobe Sign makes an HTTPS GET request to the webhook URL. This request has a custom HTTP header X-AdobeSign-ClientId. The value of this header is the client ID of the application that is requesting to create the webhook. To register a webhook successfully, the webhook URL must respond to this verification request with an HTTPS 2XX response code, and also it must send back the same client ID value in one of the following two ways:<ol><li>In a custom response header, X-AdobeSign-ClientId. This is the same header which was passed in the request, and can be echoed back in the response.</li><li> In the JSON response body of the response with the key of xAdobeSignClientId and its value being the same client ID that was sent in the request. </li></ol><p>On successful registration, Adobe Sign sends a success response (any HTTPS 2XX code) to your client app with the unique webhook identifier and a Location header, which contains the URL of the webhook resource created in Adobe Sign.<br/> To learn more, please refer <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks.md'>Webhooks in Adobe Sign Guide</a>.</p> * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_write')\" oncontextmenu=\"this.href=oauthDoc('webhook_write')\" target=\"oauthDoc\">webhook_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param webhookInfo Information about the webhook that you want to create (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) @@ -220,16 +205,16 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for deleteWebhook * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_retention')\" oncontextmenu=\"this.href=oauthDoc('webhook_retention')\" target=\"oauthDoc\">webhook_retention</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param webhookId The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call deleteWebhookCall(String authorization, String ifMatch, String webhookId, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call deleteWebhookCall(String authorization, String webhookId, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -280,25 +265,20 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call deleteWebhookValidateBeforeCall(String authorization, String ifMatch, String webhookId, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call deleteWebhookValidateBeforeCall(String authorization, String webhookId, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling deleteWebhook(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling deleteWebhook(Async)"); - } - // verify the required parameter 'webhookId' is set if (webhookId == null) { throw new ApiException("Missing the required parameter 'webhookId' when calling deleteWebhook(Async)"); } - com.squareup.okhttp.Call call = deleteWebhookCall(authorization, ifMatch, webhookId, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = deleteWebhookCall(authorization, webhookId, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); return call; } @@ -307,29 +287,29 @@ private com.squareup.okhttp.Call deleteWebhookValidateBeforeCall(String authoriz * Deletes a webhook. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_retention')\" oncontextmenu=\"this.href=oauthDoc('webhook_retention')\" target=\"oauthDoc\">webhook_retention</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param webhookId The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void deleteWebhook(String authorization, String ifMatch, String webhookId, String xApiUser, String xOnBehalfOfUser) throws ApiException { - deleteWebhookWithHttpInfo(authorization, ifMatch, webhookId, xApiUser, xOnBehalfOfUser); + public void deleteWebhook(String authorization, String webhookId, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + deleteWebhookWithHttpInfo(authorization, webhookId, xApiUser, xOnBehalfOfUser, ifMatch); } /** * Deletes a webhook. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_retention')\" oncontextmenu=\"this.href=oauthDoc('webhook_retention')\" target=\"oauthDoc\">webhook_retention</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param webhookId The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse deleteWebhookWithHttpInfo(String authorization, String ifMatch, String webhookId, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = deleteWebhookValidateBeforeCall(authorization, ifMatch, webhookId, xApiUser, xOnBehalfOfUser, null, null); + public ApiResponse deleteWebhookWithHttpInfo(String authorization, String webhookId, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + com.squareup.okhttp.Call call = deleteWebhookValidateBeforeCall(authorization, webhookId, xApiUser, xOnBehalfOfUser, ifMatch, null, null); return apiClient.execute(call); } @@ -337,15 +317,15 @@ public ApiResponse deleteWebhookWithHttpInfo(String authorization, String * Deletes a webhook. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_retention')\" oncontextmenu=\"this.href=oauthDoc('webhook_retention')\" target=\"oauthDoc\">webhook_retention</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param webhookId The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call deleteWebhookAsync(String authorization, String ifMatch, String webhookId, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call deleteWebhookAsync(String authorization, String webhookId, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -366,7 +346,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = deleteWebhookValidateBeforeCall(authorization, ifMatch, webhookId, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = deleteWebhookValidateBeforeCall(authorization, webhookId, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } @@ -691,17 +671,17 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for updateWebhook * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_write')\" oncontextmenu=\"this.href=oauthDoc('webhook_write')\" target=\"oauthDoc\">webhook_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param webhookId The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. (required) * @param webhookInfo Information necessary to update a webhook (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call updateWebhookCall(String authorization, String ifMatch, String webhookId, WebhookInfo webhookInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call updateWebhookCall(String authorization, String webhookId, WebhookInfo webhookInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = webhookInfo; // create path and map variables @@ -752,18 +732,13 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call updateWebhookValidateBeforeCall(String authorization, String ifMatch, String webhookId, WebhookInfo webhookInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateWebhookValidateBeforeCall(String authorization, String webhookId, WebhookInfo webhookInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling updateWebhook(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling updateWebhook(Async)"); - } - // verify the required parameter 'webhookId' is set if (webhookId == null) { throw new ApiException("Missing the required parameter 'webhookId' when calling updateWebhook(Async)"); @@ -775,7 +750,7 @@ private com.squareup.okhttp.Call updateWebhookValidateBeforeCall(String authoriz } - com.squareup.okhttp.Call call = updateWebhookCall(authorization, ifMatch, webhookId, webhookInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateWebhookCall(authorization, webhookId, webhookInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); return call; } @@ -784,31 +759,31 @@ private com.squareup.okhttp.Call updateWebhookValidateBeforeCall(String authoriz * Updates a webhook. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_write')\" oncontextmenu=\"this.href=oauthDoc('webhook_write')\" target=\"oauthDoc\">webhook_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param webhookId The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. (required) * @param webhookInfo Information necessary to update a webhook (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void updateWebhook(String authorization, String ifMatch, String webhookId, WebhookInfo webhookInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - updateWebhookWithHttpInfo(authorization, ifMatch, webhookId, webhookInfo, xApiUser, xOnBehalfOfUser); + public void updateWebhook(String authorization, String webhookId, WebhookInfo webhookInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + updateWebhookWithHttpInfo(authorization, webhookId, webhookInfo, xApiUser, xOnBehalfOfUser, ifMatch); } /** * Updates a webhook. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_write')\" oncontextmenu=\"this.href=oauthDoc('webhook_write')\" target=\"oauthDoc\">webhook_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param webhookId The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. (required) * @param webhookInfo Information necessary to update a webhook (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse updateWebhookWithHttpInfo(String authorization, String ifMatch, String webhookId, WebhookInfo webhookInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = updateWebhookValidateBeforeCall(authorization, ifMatch, webhookId, webhookInfo, xApiUser, xOnBehalfOfUser, null, null); + public ApiResponse updateWebhookWithHttpInfo(String authorization, String webhookId, WebhookInfo webhookInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + com.squareup.okhttp.Call call = updateWebhookValidateBeforeCall(authorization, webhookId, webhookInfo, xApiUser, xOnBehalfOfUser, ifMatch, null, null); return apiClient.execute(call); } @@ -816,16 +791,16 @@ public ApiResponse updateWebhookWithHttpInfo(String authorization, String * Updates a webhook. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_write')\" oncontextmenu=\"this.href=oauthDoc('webhook_write')\" target=\"oauthDoc\">webhook_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param webhookId The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. (required) * @param webhookInfo Information necessary to update a webhook (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call updateWebhookAsync(String authorization, String ifMatch, String webhookId, WebhookInfo webhookInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateWebhookAsync(String authorization, String webhookId, WebhookInfo webhookInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -846,24 +821,24 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = updateWebhookValidateBeforeCall(authorization, ifMatch, webhookId, webhookInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateWebhookValidateBeforeCall(authorization, webhookId, webhookInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } /** * Build call for updateWebhookState * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_write')\" oncontextmenu=\"this.href=oauthDoc('webhook_write')\" target=\"oauthDoc\">webhook_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param webhookId The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. (required) * @param webhookStateInfo (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call updateWebhookStateCall(String authorization, String ifMatch, String webhookId, WebhookStateInfo webhookStateInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call updateWebhookStateCall(String authorization, String webhookId, WebhookStateInfo webhookStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = webhookStateInfo; // create path and map variables @@ -914,18 +889,13 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call updateWebhookStateValidateBeforeCall(String authorization, String ifMatch, String webhookId, WebhookStateInfo webhookStateInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateWebhookStateValidateBeforeCall(String authorization, String webhookId, WebhookStateInfo webhookStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling updateWebhookState(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling updateWebhookState(Async)"); - } - // verify the required parameter 'webhookId' is set if (webhookId == null) { throw new ApiException("Missing the required parameter 'webhookId' when calling updateWebhookState(Async)"); @@ -937,7 +907,7 @@ private com.squareup.okhttp.Call updateWebhookStateValidateBeforeCall(String aut } - com.squareup.okhttp.Call call = updateWebhookStateCall(authorization, ifMatch, webhookId, webhookStateInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateWebhookStateCall(authorization, webhookId, webhookStateInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); return call; } @@ -946,31 +916,31 @@ private com.squareup.okhttp.Call updateWebhookStateValidateBeforeCall(String aut * Updates the state of a webhook identified by webhookId in the path. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_write')\" oncontextmenu=\"this.href=oauthDoc('webhook_write')\" target=\"oauthDoc\">webhook_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param webhookId The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. (required) * @param webhookStateInfo (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void updateWebhookState(String authorization, String ifMatch, String webhookId, WebhookStateInfo webhookStateInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - updateWebhookStateWithHttpInfo(authorization, ifMatch, webhookId, webhookStateInfo, xApiUser, xOnBehalfOfUser); + public void updateWebhookState(String authorization, String webhookId, WebhookStateInfo webhookStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + updateWebhookStateWithHttpInfo(authorization, webhookId, webhookStateInfo, xApiUser, xOnBehalfOfUser, ifMatch); } /** * Updates the state of a webhook identified by webhookId in the path. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_write')\" oncontextmenu=\"this.href=oauthDoc('webhook_write')\" target=\"oauthDoc\">webhook_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param webhookId The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. (required) * @param webhookStateInfo (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse updateWebhookStateWithHttpInfo(String authorization, String ifMatch, String webhookId, WebhookStateInfo webhookStateInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = updateWebhookStateValidateBeforeCall(authorization, ifMatch, webhookId, webhookStateInfo, xApiUser, xOnBehalfOfUser, null, null); + public ApiResponse updateWebhookStateWithHttpInfo(String authorization, String webhookId, WebhookStateInfo webhookStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + com.squareup.okhttp.Call call = updateWebhookStateValidateBeforeCall(authorization, webhookId, webhookStateInfo, xApiUser, xOnBehalfOfUser, ifMatch, null, null); return apiClient.execute(call); } @@ -978,16 +948,16 @@ public ApiResponse updateWebhookStateWithHttpInfo(String authorization, St * Updates the state of a webhook identified by webhookId in the path. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('webhook_write')\" oncontextmenu=\"this.href=oauthDoc('webhook_write')\" target=\"oauthDoc\">webhook_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) * @param webhookId The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. (required) * @param webhookStateInfo (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call updateWebhookStateAsync(String authorization, String ifMatch, String webhookId, WebhookStateInfo webhookStateInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateWebhookStateAsync(String authorization, String webhookId, WebhookStateInfo webhookStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -1008,7 +978,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = updateWebhookStateValidateBeforeCall(authorization, ifMatch, webhookId, webhookStateInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateWebhookStateValidateBeforeCall(authorization, webhookId, webhookStateInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } diff --git a/src/main/java/io/swagger/client/api/WidgetsApi.java b/src/main/java/io/swagger/client/api/WidgetsApi.java index 53bd8b6..a35777d 100755 --- a/src/main/java/io/swagger/client/api/WidgetsApi.java +++ b/src/main/java/io/swagger/client/api/WidgetsApi.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,11 @@ import java.io.IOException; +import io.swagger.client.model.widgets.BasicDocumentsImageUrlsInfo; import io.swagger.client.model.widgets.DetailedWidgetParticipantSetInfo; +import io.swagger.client.model.widgets.DocumentUrl; +import io.swagger.client.model.widgets.FetchedWidgetInfo; +import io.swagger.client.model.widgets.MyAgreementInfo; import io.swagger.client.model.widgets.Note; import io.swagger.client.model.widgets.ParticipantSecurityOption; import io.swagger.client.model.widgets.ShareCreationInfoList; @@ -53,7 +42,6 @@ import io.swagger.client.model.widgets.WidgetCreationInfoV6; import io.swagger.client.model.widgets.WidgetCreationResponse; import io.swagger.client.model.widgets.WidgetDocuments; -import io.swagger.client.model.widgets.WidgetDocumentsImageUrlsInfo; import io.swagger.client.model.widgets.WidgetEventList; import io.swagger.client.model.widgets.WidgetInfo; import io.swagger.client.model.widgets.WidgetMembersInfo; @@ -89,7 +77,7 @@ public void setApiClient(ApiClient apiClient) { /** * Build call for createShareOnWidget * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param shareCreationInfoList List of agreement share creation information objects. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) @@ -171,10 +159,10 @@ private com.squareup.okhttp.Call createShareOnWidgetValidateBeforeCall(String au } /** - * Share a widget with someone. + * Share a web form with someone. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param shareCreationInfoList List of agreement share creation information objects. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) @@ -187,10 +175,10 @@ public ShareCreationResponseList createShareOnWidget(String authorization, Strin } /** - * Share a widget with someone. + * Share a web form with someone. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param shareCreationInfoList List of agreement share creation information objects. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) @@ -204,10 +192,10 @@ public ApiResponse createShareOnWidgetWithHttpInfo(St } /** - * Share a widget with someone. (asynchronously) + * Share a web form with someone. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param shareCreationInfoList List of agreement share creation information objects. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) @@ -244,7 +232,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for createWidget * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetInfo Information about the widget that you want to create. (required) + * @param widgetInfo Information about the web form that you want to create. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param progressListener Progress listener @@ -319,10 +307,10 @@ private com.squareup.okhttp.Call createWidgetValidateBeforeCall(String authoriza } /** - * Creates a widget and and returns the widgetId in the response to the client. - * This is a primary endpoint which is used to create a new widget. You can create a widget in one of the 3 mentioned states: a) <b>DRAFT</b> - to incrementally build the widget, b) <b>AUTHORING</b> - to add/edit form fields in the widget, c) <b>ACTIVE</b> - to immediately host the widget. You can use the PUT /widgets/{widgetId}/state endpoint to transition a widget between the above mentioned states. An allowed transition would follow the any of the following sequences: DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. + * Creates a web form and and returns the widgetId in the response to the client. + * This is a primary endpoint which is used to create a new web form. You can create a web form in one of the 3 mentioned states: a) <b>DRAFT</b> - to incrementally build the web form, b) <b>AUTHORING</b> - to add/edit form fields in the web form, c) <b>ACTIVE</b> - to immediately host the web form. You can use the PUT /widgets/{widgetId}/state endpoint to transition a web form between the above mentioned states. An allowed transition would follow the any of the following sequences: DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetInfo Information about the widget that you want to create. (required) + * @param widgetInfo Information about the web form that you want to create. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @return WidgetCreationResponse @@ -334,10 +322,10 @@ public WidgetCreationResponse createWidget(String authorization, WidgetCreationI } /** - * Creates a widget and and returns the widgetId in the response to the client. - * This is a primary endpoint which is used to create a new widget. You can create a widget in one of the 3 mentioned states: a) <b>DRAFT</b> - to incrementally build the widget, b) <b>AUTHORING</b> - to add/edit form fields in the widget, c) <b>ACTIVE</b> - to immediately host the widget. You can use the PUT /widgets/{widgetId}/state endpoint to transition a widget between the above mentioned states. An allowed transition would follow the any of the following sequences: DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. + * Creates a web form and and returns the widgetId in the response to the client. + * This is a primary endpoint which is used to create a new web form. You can create a web form in one of the 3 mentioned states: a) <b>DRAFT</b> - to incrementally build the web form, b) <b>AUTHORING</b> - to add/edit form fields in the web form, c) <b>ACTIVE</b> - to immediately host the web form. You can use the PUT /widgets/{widgetId}/state endpoint to transition a web form between the above mentioned states. An allowed transition would follow the any of the following sequences: DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetInfo Information about the widget that you want to create. (required) + * @param widgetInfo Information about the web form that you want to create. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @return ApiResponse<WidgetCreationResponse> @@ -350,10 +338,10 @@ public ApiResponse createWidgetWithHttpInfo(String autho } /** - * Creates a widget and and returns the widgetId in the response to the client. (asynchronously) - * This is a primary endpoint which is used to create a new widget. You can create a widget in one of the 3 mentioned states: a) <b>DRAFT</b> - to incrementally build the widget, b) <b>AUTHORING</b> - to add/edit form fields in the widget, c) <b>ACTIVE</b> - to immediately host the widget. You can use the PUT /widgets/{widgetId}/state endpoint to transition a widget between the above mentioned states. An allowed transition would follow the any of the following sequences: DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. + * Creates a web form and and returns the widgetId in the response to the client. (asynchronously) + * This is a primary endpoint which is used to create a new web form. You can create a web form in one of the 3 mentioned states: a) <b>DRAFT</b> - to incrementally build the web form, b) <b>AUTHORING</b> - to add/edit form fields in the web form, c) <b>ACTIVE</b> - to immediately host the web form. You can use the PUT /widgets/{widgetId}/state endpoint to transition a web form between the above mentioned states. An allowed transition would follow the any of the following sequences: DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetInfo Information about the widget that you want to create. (required) + * @param widgetInfo Information about the web form that you want to create. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param callback The callback to be executed when the API call finishes @@ -389,7 +377,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for getAllWidgetMembers * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -471,7 +459,7 @@ private com.squareup.okhttp.Call getAllWidgetMembersValidateBeforeCall(String au * Retrieves detailed member info along with IDs for different types of participants. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -487,7 +475,7 @@ public WidgetMembersInfo getAllWidgetMembers(String authorization, String widget * Retrieves detailed member info along with IDs for different types of participants. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -504,7 +492,7 @@ public ApiResponse getAllWidgetMembersWithHttpInfo(String aut * Retrieves detailed member info along with IDs for different types of participants. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -541,7 +529,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for getEvents * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -620,10 +608,10 @@ private com.squareup.okhttp.Call getEventsValidateBeforeCall(String authorizatio } /** - * Retrieves the events information for a widget. + * Retrieves the events information for a web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -636,10 +624,10 @@ public WidgetEventList getEvents(String authorization, String widgetId, String x } /** - * Retrieves the events information for a widget. + * Retrieves the events information for a web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -653,10 +641,10 @@ public ApiResponse getEventsWithHttpInfo(String authorization, } /** - * Retrieves the events information for a widget. (asynchronously) + * Retrieves the events information for a web form. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -693,7 +681,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for getParticipantSet * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param participantSetId The participant set identifier (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) @@ -779,10 +767,10 @@ private com.squareup.okhttp.Call getParticipantSetValidateBeforeCall(String auth } /** - * Retrieves the participant set of a widget identified by widgetId in the path. + * Retrieves the participant set of a web form identified by widgetId in the path. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param participantSetId The participant set identifier (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) @@ -796,10 +784,10 @@ public DetailedWidgetParticipantSetInfo getParticipantSet(String authorization, } /** - * Retrieves the participant set of a widget identified by widgetId in the path. + * Retrieves the participant set of a web form identified by widgetId in the path. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param participantSetId The participant set identifier (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) @@ -814,10 +802,10 @@ public ApiResponse getParticipantSetWithHttpIn } /** - * Retrieves the participant set of a widget identified by widgetId in the path. (asynchronously) + * Retrieves the participant set of a web form identified by widgetId in the path. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param participantSetId The participant set identifier (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) @@ -855,7 +843,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for getWidgetAgreements * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param showHiddenAgreements A query parameter to fetch all the hidden agreements along with the visible agreements. Default value is false. (optional) @@ -940,10 +928,10 @@ private com.squareup.okhttp.Call getWidgetAgreementsValidateBeforeCall(String au } /** - * Retrieves agreements for the widget. + * Retrieves agreements for the web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param showHiddenAgreements A query parameter to fetch all the hidden agreements along with the visible agreements. Default value is false. (optional) @@ -958,10 +946,10 @@ public WidgetAgreements getWidgetAgreements(String authorization, String widgetI } /** - * Retrieves agreements for the widget. + * Retrieves agreements for the web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param showHiddenAgreements A query parameter to fetch all the hidden agreements along with the visible agreements. Default value is false. (optional) @@ -977,10 +965,10 @@ public ApiResponse getWidgetAgreementsWithHttpInfo(String auth } /** - * Retrieves agreements for the widget. (asynchronously) + * Retrieves agreements for the web form. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param showHiddenAgreements A query parameter to fetch all the hidden agreements along with the visible agreements. Default value is false. (optional) @@ -1019,10 +1007,9 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for getWidgetAllDocumentsImageUrls * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param imageSizes A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. (optional) * @param showImageAvailabilityOnly When set to true, returns only image availability. Else, returns both image urls and its availability. (optional) * @param progressListener Progress listener @@ -1030,7 +1017,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getWidgetAllDocumentsImageUrlsCall(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, String imageSizes, Boolean showImageAvailabilityOnly, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getWidgetAllDocumentsImageUrlsCall(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, String imageSizes, Boolean showImageAvailabilityOnly, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -1051,8 +1038,6 @@ public com.squareup.okhttp.Call getWidgetAllDocumentsImageUrlsCall(String author localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); if (xOnBehalfOfUser != null) localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); - if (ifNoneMatch != null) - localVarHeaderParams.put("If-None-Match", apiClient.parameterToString(ifNoneMatch)); Map localVarFormParams = new HashMap(); @@ -1085,7 +1070,7 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getWidgetAllDocumentsImageUrlsValidateBeforeCall(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, String imageSizes, Boolean showImageAvailabilityOnly, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getWidgetAllDocumentsImageUrlsValidateBeforeCall(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, String imageSizes, Boolean showImageAvailabilityOnly, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { @@ -1098,63 +1083,60 @@ private com.squareup.okhttp.Call getWidgetAllDocumentsImageUrlsValidateBeforeCal } - com.squareup.okhttp.Call call = getWidgetAllDocumentsImageUrlsCall(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch, imageSizes, showImageAvailabilityOnly, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getWidgetAllDocumentsImageUrlsCall(authorization, widgetId, xApiUser, xOnBehalfOfUser, imageSizes, showImageAvailabilityOnly, progressListener, progressRequestListener); return call; } /** - * Retrieves image urls of all visible pages of a document associated with a widget. + * Retrieves image urls of all visible pages of a document associated with a web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param imageSizes A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. (optional) * @param showImageAvailabilityOnly When set to true, returns only image availability. Else, returns both image urls and its availability. (optional) - * @return WidgetDocumentsImageUrlsInfo + * @return BasicDocumentsImageUrlsInfo * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public WidgetDocumentsImageUrlsInfo getWidgetAllDocumentsImageUrls(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, String imageSizes, Boolean showImageAvailabilityOnly) throws ApiException { - ApiResponse resp = getWidgetAllDocumentsImageUrlsWithHttpInfo(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch, imageSizes, showImageAvailabilityOnly); + public BasicDocumentsImageUrlsInfo getWidgetAllDocumentsImageUrls(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, String imageSizes, Boolean showImageAvailabilityOnly) throws ApiException { + ApiResponse resp = getWidgetAllDocumentsImageUrlsWithHttpInfo(authorization, widgetId, xApiUser, xOnBehalfOfUser, imageSizes, showImageAvailabilityOnly); return resp.getData(); } /** - * Retrieves image urls of all visible pages of a document associated with a widget. + * Retrieves image urls of all visible pages of a document associated with a web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param imageSizes A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. (optional) * @param showImageAvailabilityOnly When set to true, returns only image availability. Else, returns both image urls and its availability. (optional) - * @return ApiResponse<WidgetDocumentsImageUrlsInfo> + * @return ApiResponse<BasicDocumentsImageUrlsInfo> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getWidgetAllDocumentsImageUrlsWithHttpInfo(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, String imageSizes, Boolean showImageAvailabilityOnly) throws ApiException { - com.squareup.okhttp.Call call = getWidgetAllDocumentsImageUrlsValidateBeforeCall(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch, imageSizes, showImageAvailabilityOnly, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse getWidgetAllDocumentsImageUrlsWithHttpInfo(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, String imageSizes, Boolean showImageAvailabilityOnly) throws ApiException { + com.squareup.okhttp.Call call = getWidgetAllDocumentsImageUrlsValidateBeforeCall(authorization, widgetId, xApiUser, xOnBehalfOfUser, imageSizes, showImageAvailabilityOnly, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } /** - * Retrieves image urls of all visible pages of a document associated with a widget. (asynchronously) + * Retrieves image urls of all visible pages of a document associated with a web form. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param imageSizes A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}. (optional) * @param showImageAvailabilityOnly When set to true, returns only image availability. Else, returns both image urls and its availability. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getWidgetAllDocumentsImageUrlsAsync(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, String imageSizes, Boolean showImageAvailabilityOnly, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getWidgetAllDocumentsImageUrlsAsync(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, String imageSizes, Boolean showImageAvailabilityOnly, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -1175,15 +1157,15 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getWidgetAllDocumentsImageUrlsValidateBeforeCall(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch, imageSizes, showImageAvailabilityOnly, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + com.squareup.okhttp.Call call = getWidgetAllDocumentsImageUrlsValidateBeforeCall(authorization, widgetId, xApiUser, xOnBehalfOfUser, imageSizes, showImageAvailabilityOnly, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } /** * Build call for getWidgetAuditTrail * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -1262,10 +1244,10 @@ private com.squareup.okhttp.Call getWidgetAuditTrailValidateBeforeCall(String au } /** - * Retrieves the audit trail of a widget identified by widgetId. + * Retrieves the audit trail of a web form identified by widgetId. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -1278,10 +1260,10 @@ public byte[] getWidgetAuditTrail(String authorization, String widgetId, String } /** - * Retrieves the audit trail of a widget identified by widgetId. + * Retrieves the audit trail of a web form identified by widgetId. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -1295,10 +1277,10 @@ public ApiResponse getWidgetAuditTrailWithHttpInfo(String authorization, } /** - * Retrieves the audit trail of a widget identified by widgetId. (asynchronously) + * Retrieves the audit trail of a web form identified by widgetId. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -1335,13 +1317,13 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for getWidgetCombinedDocument * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @param versionId The version identifier of widget as provided by the API which retrieves information of a specific widget. If not provided then latest version will be used. (optional) + * @param versionId The version identifier of web form as provided by the API which retrieves information of a specific web form. If not provided then latest version will be used. (optional) * @param participantId The ID of the participant to be used to retrieve documents. If not mentioned, the participation of api caller is used. (optional) - * @param attachAuditReport When set to YES, attach an audit report to the signed Widget PDF. Default value is false (optional) + * @param attachAuditReport When set to YES, attach an audit report to the signed Web Form PDF. Default value is false (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute @@ -1423,16 +1405,16 @@ private com.squareup.okhttp.Call getWidgetCombinedDocumentValidateBeforeCall(Str } /** - * Retrieves a single combined PDF document for the documents associated with a widget. + * Retrieves a single combined PDF document for the documents associated with a web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @param versionId The version identifier of widget as provided by the API which retrieves information of a specific widget. If not provided then latest version will be used. (optional) + * @param versionId The version identifier of web form as provided by the API which retrieves information of a specific web form. If not provided then latest version will be used. (optional) * @param participantId The ID of the participant to be used to retrieve documents. If not mentioned, the participation of api caller is used. (optional) - * @param attachAuditReport When set to YES, attach an audit report to the signed Widget PDF. Default value is false (optional) + * @param attachAuditReport When set to YES, attach an audit report to the signed Web Form PDF. Default value is false (optional) * @return byte[] * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ @@ -1442,16 +1424,16 @@ public byte[] getWidgetCombinedDocument(String authorization, String widgetId, S } /** - * Retrieves a single combined PDF document for the documents associated with a widget. + * Retrieves a single combined PDF document for the documents associated with a web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @param versionId The version identifier of widget as provided by the API which retrieves information of a specific widget. If not provided then latest version will be used. (optional) + * @param versionId The version identifier of web form as provided by the API which retrieves information of a specific web form. If not provided then latest version will be used. (optional) * @param participantId The ID of the participant to be used to retrieve documents. If not mentioned, the participation of api caller is used. (optional) - * @param attachAuditReport When set to YES, attach an audit report to the signed Widget PDF. Default value is false (optional) + * @param attachAuditReport When set to YES, attach an audit report to the signed Web Form PDF. Default value is false (optional) * @return ApiResponse<byte[]> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ @@ -1462,16 +1444,16 @@ public ApiResponse getWidgetCombinedDocumentWithHttpInfo(String authoriz } /** - * Retrieves a single combined PDF document for the documents associated with a widget. (asynchronously) + * Retrieves a single combined PDF document for the documents associated with a web form. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @param versionId The version identifier of widget as provided by the API which retrieves information of a specific widget. If not provided then latest version will be used. (optional) + * @param versionId The version identifier of web form as provided by the API which retrieves information of a specific web form. If not provided then latest version will be used. (optional) * @param participantId The ID of the participant to be used to retrieve documents. If not mentioned, the participation of api caller is used. (optional) - * @param attachAuditReport When set to YES, attach an audit report to the signed Widget PDF. Default value is false (optional) + * @param attachAuditReport When set to YES, attach an audit report to the signed Web Form PDF. Default value is false (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -1502,11 +1484,163 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don apiClient.executeAsync(call, localVarReturnType, callback); return call; } + /** + * Build call for getWidgetCombinedDocumentUrl + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param attachAuditReport When set to true, attach an audit report to the web form PDF. The default value is false. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getWidgetCombinedDocumentUrlCall(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, Boolean attachAuditReport, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/widgets/{widgetId}/combinedDocument/url" + .replaceAll("\\{" + "widgetId" + "\\}", apiClient.escapeString(widgetId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (attachAuditReport != null) + localVarQueryParams.addAll(apiClient.parameterToPair("attachAuditReport", attachAuditReport)); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getWidgetCombinedDocumentUrlValidateBeforeCall(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, Boolean attachAuditReport, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getWidgetCombinedDocumentUrl(Async)"); + } + + // verify the required parameter 'widgetId' is set + if (widgetId == null) { + throw new ApiException("Missing the required parameter 'widgetId' when calling getWidgetCombinedDocumentUrl(Async)"); + } + + + com.squareup.okhttp.Call call = getWidgetCombinedDocumentUrlCall(authorization, widgetId, xApiUser, xOnBehalfOfUser, attachAuditReport, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves url of all visible pages of all the documents associated with a web form. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param attachAuditReport When set to true, attach an audit report to the web form PDF. The default value is false. (optional) + * @return DocumentUrl + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public DocumentUrl getWidgetCombinedDocumentUrl(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, Boolean attachAuditReport) throws ApiException { + ApiResponse resp = getWidgetCombinedDocumentUrlWithHttpInfo(authorization, widgetId, xApiUser, xOnBehalfOfUser, attachAuditReport); + return resp.getData(); + } + + /** + * Retrieves url of all visible pages of all the documents associated with a web form. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param attachAuditReport When set to true, attach an audit report to the web form PDF. The default value is false. (optional) + * @return ApiResponse<DocumentUrl> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getWidgetCombinedDocumentUrlWithHttpInfo(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, Boolean attachAuditReport) throws ApiException { + com.squareup.okhttp.Call call = getWidgetCombinedDocumentUrlValidateBeforeCall(authorization, widgetId, xApiUser, xOnBehalfOfUser, attachAuditReport, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves url of all visible pages of all the documents associated with a web form. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param attachAuditReport When set to true, attach an audit report to the web form PDF. The default value is false. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getWidgetCombinedDocumentUrlAsync(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, Boolean attachAuditReport, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getWidgetCombinedDocumentUrlValidateBeforeCall(authorization, widgetId, xApiUser, xOnBehalfOfUser, attachAuditReport, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } /** * Build call for getWidgetDocumentInfo * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) - * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified widget (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified web form (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -1591,11 +1725,11 @@ private com.squareup.okhttp.Call getWidgetDocumentInfoValidateBeforeCall(String } /** - * Retrieves the file stream of a document of a widget. + * Retrieves the file stream of a document of a web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) - * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified widget (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified web form (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -1608,11 +1742,11 @@ public byte[] getWidgetDocumentInfo(String authorization, String widgetId, Strin } /** - * Retrieves the file stream of a document of a widget. + * Retrieves the file stream of a document of a web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) - * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified widget (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified web form (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -1626,11 +1760,11 @@ public ApiResponse getWidgetDocumentInfoWithHttpInfo(String authorizatio } /** - * Retrieves the file stream of a document of a widget. (asynchronously) + * Retrieves the file stream of a document of a web form. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) - * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified widget (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param documentId The document identifier, as retrieved from the API which fetches the documents of a specified web form (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -1667,11 +1801,11 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for getWidgetDocuments * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @param versionId The version identifier of widget as provided by the API which retrieves information of a specific widget. If not provided then latest version will be used. (optional) + * @param versionId The version identifier of web form as provided by the API which retrieves information of a specific web form. If not provided then latest version will be used. (optional) * @param participantId The ID of the participant to be used to retrieve documents. If not mentioned, the participation of api caller is used. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener @@ -1752,14 +1886,14 @@ private com.squareup.okhttp.Call getWidgetDocumentsValidateBeforeCall(String aut } /** - * Retrieves the IDs of the documents associated with widget. + * Retrieves the IDs of the documents associated with web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @param versionId The version identifier of widget as provided by the API which retrieves information of a specific widget. If not provided then latest version will be used. (optional) + * @param versionId The version identifier of web form as provided by the API which retrieves information of a specific web form. If not provided then latest version will be used. (optional) * @param participantId The ID of the participant to be used to retrieve documents. If not mentioned, the participation of api caller is used. (optional) * @return WidgetDocuments * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -1770,14 +1904,14 @@ public WidgetDocuments getWidgetDocuments(String authorization, String widgetId, } /** - * Retrieves the IDs of the documents associated with widget. + * Retrieves the IDs of the documents associated with web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @param versionId The version identifier of widget as provided by the API which retrieves information of a specific widget. If not provided then latest version will be used. (optional) + * @param versionId The version identifier of web form as provided by the API which retrieves information of a specific web form. If not provided then latest version will be used. (optional) * @param participantId The ID of the participant to be used to retrieve documents. If not mentioned, the participation of api caller is used. (optional) * @return ApiResponse<WidgetDocuments> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -1789,14 +1923,14 @@ public ApiResponse getWidgetDocumentsWithHttpInfo(String author } /** - * Retrieves the IDs of the documents associated with widget. (asynchronously) + * Retrieves the IDs of the documents associated with web form. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @param versionId The version identifier of widget as provided by the API which retrieves information of a specific widget. If not provided then latest version will be used. (optional) + * @param versionId The version identifier of web form as provided by the API which retrieves information of a specific web form. If not provided then latest version will be used. (optional) * @param participantId The ID of the participant to be used to retrieve documents. If not mentioned, the participation of api caller is used. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call @@ -1831,7 +1965,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for getWidgetFormData * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param progressListener Progress listener @@ -1907,10 +2041,10 @@ private com.squareup.okhttp.Call getWidgetFormDataValidateBeforeCall(String auth } /** - * Retrieves data entered by the user into interactive form fields at the time they signed the widget + * Retrieves data entered by the user into interactive form fields at the time they signed the web form * CSV file stream containing form data information * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @return byte[] @@ -1922,10 +2056,10 @@ public byte[] getWidgetFormData(String authorization, String widgetId, String xA } /** - * Retrieves data entered by the user into interactive form fields at the time they signed the widget + * Retrieves data entered by the user into interactive form fields at the time they signed the web form * CSV file stream containing form data information * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @return ApiResponse<byte[]> @@ -1938,10 +2072,10 @@ public ApiResponse getWidgetFormDataWithHttpInfo(String authorization, S } /** - * Retrieves data entered by the user into interactive form fields at the time they signed the widget (asynchronously) + * Retrieves data entered by the user into interactive form fields at the time they signed the web form (asynchronously) * CSV file stream containing form data information * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param callback The callback to be executed when the API call finishes @@ -1977,7 +2111,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for getWidgetInfo * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -2056,43 +2190,43 @@ private com.squareup.okhttp.Call getWidgetInfoValidateBeforeCall(String authoriz } /** - * Retrieves the details of a widget. + * Retrieves the details of a web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @return WidgetCreationInfoV6 + * @return FetchedWidgetInfo * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public WidgetCreationInfoV6 getWidgetInfo(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { - ApiResponse resp = getWidgetInfoWithHttpInfo(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + public FetchedWidgetInfo getWidgetInfo(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + ApiResponse resp = getWidgetInfoWithHttpInfo(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch); return resp.getData(); } /** - * Retrieves the details of a widget. + * Retrieves the details of a web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) - * @return ApiResponse<WidgetCreationInfoV6> + * @return ApiResponse<FetchedWidgetInfo> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getWidgetInfoWithHttpInfo(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { + public ApiResponse getWidgetInfoWithHttpInfo(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch) throws ApiException { com.squareup.okhttp.Call call = getWidgetInfoValidateBeforeCall(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } /** - * Retrieves the details of a widget. (asynchronously) + * Retrieves the details of a web form. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) @@ -2100,7 +2234,7 @@ public ApiResponse getWidgetInfoWithHttpInfo(String author * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getWidgetInfoAsync(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getWidgetInfoAsync(String authorization, String widgetId, String xApiUser, String xOnBehalfOfUser, String ifNoneMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -2122,14 +2256,154 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don } com.squareup.okhttp.Call call = getWidgetInfoValidateBeforeCall(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getWidgetInfoForUser + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getWidgetInfoForUserCall(String authorization, String widgetId, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/widgets/{widgetId}/me" + .replaceAll("\\{" + "widgetId" + "\\}", apiClient.escapeString(widgetId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getWidgetInfoForUserValidateBeforeCall(String authorization, String widgetId, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getWidgetInfoForUser(Async)"); + } + + // verify the required parameter 'widgetId' is set + if (widgetId == null) { + throw new ApiException("Missing the required parameter 'widgetId' when calling getWidgetInfoForUser(Async)"); + } + + + com.squareup.okhttp.Call call = getWidgetInfoForUserCall(authorization, widgetId, xApiUser, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves the web form information related to the api caller + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @return MyAgreementInfo + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public MyAgreementInfo getWidgetInfoForUser(String authorization, String widgetId, String xApiUser) throws ApiException { + ApiResponse resp = getWidgetInfoForUserWithHttpInfo(authorization, widgetId, xApiUser); + return resp.getData(); + } + + /** + * Retrieves the web form information related to the api caller + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @return ApiResponse<MyAgreementInfo> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getWidgetInfoForUserWithHttpInfo(String authorization, String widgetId, String xApiUser) throws ApiException { + com.squareup.okhttp.Call call = getWidgetInfoForUserValidateBeforeCall(authorization, widgetId, xApiUser, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves the web form information related to the api caller (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getWidgetInfoForUserAsync(String authorization, String widgetId, String xApiUser, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getWidgetInfoForUserValidateBeforeCall(authorization, widgetId, xApiUser, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } /** * Build call for getWidgetNoteForApiUser * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param progressListener Progress listener @@ -2205,10 +2479,10 @@ private com.squareup.okhttp.Call getWidgetNoteForApiUserValidateBeforeCall(Strin } /** - * Retrieves the latest note of a widget for the API user. + * Retrieves the latest note of a web form for the API user. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @return Note @@ -2220,10 +2494,10 @@ public Note getWidgetNoteForApiUser(String authorization, String widgetId, Strin } /** - * Retrieves the latest note of a widget for the API user. + * Retrieves the latest note of a web form for the API user. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @return ApiResponse<Note> @@ -2236,10 +2510,10 @@ public ApiResponse getWidgetNoteForApiUserWithHttpInfo(String authorizatio } /** - * Retrieves the latest note of a widget for the API user. (asynchronously) + * Retrieves the latest note of a web form for the API user. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param callback The callback to be executed when the API call finishes @@ -2275,17 +2549,18 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for getWidgetSecurityOptionsForParticipation * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param participantSetId The participant set identifier (required) * @param participantId The participant identifier (required) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getWidgetSecurityOptionsForParticipationCall(String authorization, String widgetId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getWidgetSecurityOptionsForParticipationCall(String authorization, String widgetId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -2304,6 +2579,8 @@ public com.squareup.okhttp.Call getWidgetSecurityOptionsForParticipationCall(Str localVarHeaderParams.put("If-None-Match", apiClient.parameterToString(ifNoneMatch)); if (xApiUser != null) localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); Map localVarFormParams = new HashMap(); @@ -2336,7 +2613,7 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getWidgetSecurityOptionsForParticipationValidateBeforeCall(String authorization, String widgetId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getWidgetSecurityOptionsForParticipationValidateBeforeCall(String authorization, String widgetId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { @@ -2359,7 +2636,7 @@ private com.squareup.okhttp.Call getWidgetSecurityOptionsForParticipationValidat } - com.squareup.okhttp.Call call = getWidgetSecurityOptionsForParticipationCall(authorization, widgetId, participantSetId, participantId, ifNoneMatch, xApiUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getWidgetSecurityOptionsForParticipationCall(authorization, widgetId, participantSetId, participantId, ifNoneMatch, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); return call; } @@ -2368,16 +2645,17 @@ private com.squareup.okhttp.Call getWidgetSecurityOptionsForParticipationValidat * Retrieves the security options for a particular participant. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param participantSetId The participant set identifier (required) * @param participantId The participant identifier (required) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @return ParticipantSecurityOption * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ParticipantSecurityOption getWidgetSecurityOptionsForParticipation(String authorization, String widgetId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser) throws ApiException { - ApiResponse resp = getWidgetSecurityOptionsForParticipationWithHttpInfo(authorization, widgetId, participantSetId, participantId, ifNoneMatch, xApiUser); + public ParticipantSecurityOption getWidgetSecurityOptionsForParticipation(String authorization, String widgetId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser, String xOnBehalfOfUser) throws ApiException { + ApiResponse resp = getWidgetSecurityOptionsForParticipationWithHttpInfo(authorization, widgetId, participantSetId, participantId, ifNoneMatch, xApiUser, xOnBehalfOfUser); return resp.getData(); } @@ -2385,16 +2663,17 @@ public ParticipantSecurityOption getWidgetSecurityOptionsForParticipation(String * Retrieves the security options for a particular participant. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param participantSetId The participant set identifier (required) * @param participantId The participant identifier (required) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @return ApiResponse<ParticipantSecurityOption> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getWidgetSecurityOptionsForParticipationWithHttpInfo(String authorization, String widgetId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser) throws ApiException { - com.squareup.okhttp.Call call = getWidgetSecurityOptionsForParticipationValidateBeforeCall(authorization, widgetId, participantSetId, participantId, ifNoneMatch, xApiUser, null, null); + public ApiResponse getWidgetSecurityOptionsForParticipationWithHttpInfo(String authorization, String widgetId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser, String xOnBehalfOfUser) throws ApiException { + com.squareup.okhttp.Call call = getWidgetSecurityOptionsForParticipationValidateBeforeCall(authorization, widgetId, participantSetId, participantId, ifNoneMatch, xApiUser, xOnBehalfOfUser, null, null); Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -2403,16 +2682,17 @@ public ApiResponse getWidgetSecurityOptionsForPartici * Retrieves the security options for a particular participant. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param participantSetId The participant set identifier (required) * @param participantId The participant identifier (required) * @param ifNoneMatch Pass the value of the e-tag header obtained from the previous response to the same request to get a RESOURCE_NOT_MODIFIED(304) if the resource hasn't changed. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getWidgetSecurityOptionsForParticipationAsync(String authorization, String widgetId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getWidgetSecurityOptionsForParticipationAsync(String authorization, String widgetId, String participantSetId, String participantId, String ifNoneMatch, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -2433,15 +2713,15 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getWidgetSecurityOptionsForParticipationValidateBeforeCall(authorization, widgetId, participantSetId, participantId, ifNoneMatch, xApiUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getWidgetSecurityOptionsForParticipationValidateBeforeCall(authorization, widgetId, participantSetId, participantId, ifNoneMatch, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } /** * Build call for getWidgetView - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a> - widget read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a> - web form read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param widgetViewInfo Name of the required view and its desired configuration. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) @@ -2523,10 +2803,10 @@ private com.squareup.okhttp.Call getWidgetViewValidateBeforeCall(String authoriz } /** - * Retrieves the requested views for a widget. + * Retrieves the requested views for a web form. * - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a> - widget read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a> - web form read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param widgetViewInfo Name of the required view and its desired configuration. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) @@ -2539,10 +2819,10 @@ public WidgetViews getWidgetView(String authorization, String widgetId, WidgetVi } /** - * Retrieves the requested views for a widget. + * Retrieves the requested views for a web form. * - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a> - widget read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a> - web form read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param widgetViewInfo Name of the required view and its desired configuration. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) @@ -2556,10 +2836,10 @@ public ApiResponse getWidgetViewWithHttpInfo(String authorization, } /** - * Retrieves the requested views for a widget. (asynchronously) + * Retrieves the requested views for a web form. (asynchronously) * - * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a> - widget read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a> - web form read is always required</li><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_login')\" oncontextmenu=\"this.href=oauthDoc('user_login')\" target=\"oauthDoc\">user_login</a> - Required additionally if the autoLoginUser parameter is set to true</li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param widgetViewInfo Name of the required view and its desired configuration. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) @@ -2598,7 +2878,8 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param showHiddenWidgets A query parameter to fetch all the hidden widgets along with the visible widgets. Default value is false. (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) + * @param showHiddenWidgets A query parameter to fetch all the hidden web forms along with the visible web forms. Default value is false. (optional) * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) * @param progressListener Progress listener @@ -2606,7 +2887,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getWidgetsCall(String authorization, String xApiUser, String xOnBehalfOfUser, Boolean showHiddenWidgets, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getWidgetsCall(String authorization, String xApiUser, String xOnBehalfOfUser, String groupId, Boolean showHiddenWidgets, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -2614,6 +2895,8 @@ public com.squareup.okhttp.Call getWidgetsCall(String authorization, String xApi List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); + if (groupId != null) + localVarQueryParams.addAll(apiClient.parameterToPair("groupId", groupId)); if (showHiddenWidgets != null) localVarQueryParams.addAll(apiClient.parameterToPair("showHiddenWidgets", showHiddenWidgets)); if (cursor != null) @@ -2660,7 +2943,7 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getWidgetsValidateBeforeCall(String authorization, String xApiUser, String xOnBehalfOfUser, Boolean showHiddenWidgets, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getWidgetsValidateBeforeCall(String authorization, String xApiUser, String xOnBehalfOfUser, String groupId, Boolean showHiddenWidgets, String cursor, Integer pageSize, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { @@ -2668,60 +2951,63 @@ private com.squareup.okhttp.Call getWidgetsValidateBeforeCall(String authorizati } - com.squareup.okhttp.Call call = getWidgetsCall(authorization, xApiUser, xOnBehalfOfUser, showHiddenWidgets, cursor, pageSize, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getWidgetsCall(authorization, xApiUser, xOnBehalfOfUser, groupId, showHiddenWidgets, cursor, pageSize, progressListener, progressRequestListener); return call; } /** - * Retrieves widgets for a user. + * Retrieves web forms for a user. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param showHiddenWidgets A query parameter to fetch all the hidden widgets along with the visible widgets. Default value is false. (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) + * @param showHiddenWidgets A query parameter to fetch all the hidden web forms along with the visible web forms. Default value is false. (optional) * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) * @return UserWidgets * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public UserWidgets getWidgets(String authorization, String xApiUser, String xOnBehalfOfUser, Boolean showHiddenWidgets, String cursor, Integer pageSize) throws ApiException { - ApiResponse resp = getWidgetsWithHttpInfo(authorization, xApiUser, xOnBehalfOfUser, showHiddenWidgets, cursor, pageSize); + public UserWidgets getWidgets(String authorization, String xApiUser, String xOnBehalfOfUser, String groupId, Boolean showHiddenWidgets, String cursor, Integer pageSize) throws ApiException { + ApiResponse resp = getWidgetsWithHttpInfo(authorization, xApiUser, xOnBehalfOfUser, groupId, showHiddenWidgets, cursor, pageSize); return resp.getData(); } /** - * Retrieves widgets for a user. + * Retrieves web forms for a user. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param showHiddenWidgets A query parameter to fetch all the hidden widgets along with the visible widgets. Default value is false. (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) + * @param showHiddenWidgets A query parameter to fetch all the hidden web forms along with the visible web forms. Default value is false. (optional) * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) * @return ApiResponse<UserWidgets> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getWidgetsWithHttpInfo(String authorization, String xApiUser, String xOnBehalfOfUser, Boolean showHiddenWidgets, String cursor, Integer pageSize) throws ApiException { - com.squareup.okhttp.Call call = getWidgetsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, showHiddenWidgets, cursor, pageSize, null, null); + public ApiResponse getWidgetsWithHttpInfo(String authorization, String xApiUser, String xOnBehalfOfUser, String groupId, Boolean showHiddenWidgets, String cursor, Integer pageSize) throws ApiException { + com.squareup.okhttp.Call call = getWidgetsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, groupId, showHiddenWidgets, cursor, pageSize, null, null); Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } /** - * Retrieves widgets for a user. (asynchronously) + * Retrieves web forms for a user. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_read')\" oncontextmenu=\"this.href=oauthDoc('widget_read')\" target=\"oauthDoc\">widget_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) - * @param showHiddenWidgets A query parameter to fetch all the hidden widgets along with the visible widgets. Default value is false. (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) + * @param showHiddenWidgets A query parameter to fetch all the hidden web forms along with the visible web forms. Default value is false. (optional) * @param cursor Used to navigate through the pages. If not provided, returns the first page. (optional) * @param pageSize Number of intended items in the response page. If not provided, it is decided by the application settings. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getWidgetsAsync(String authorization, String xApiUser, String xOnBehalfOfUser, Boolean showHiddenWidgets, String cursor, Integer pageSize, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getWidgetsAsync(String authorization, String xApiUser, String xOnBehalfOfUser, String groupId, Boolean showHiddenWidgets, String cursor, Integer pageSize, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -2742,7 +3028,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getWidgetsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, showHiddenWidgets, cursor, pageSize, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getWidgetsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, groupId, showHiddenWidgets, cursor, pageSize, progressListener, progressRequestListener); Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; @@ -2750,17 +3036,17 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for updateWidget * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) - * @param widgetInfo Widget update information object. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param widgetInfo Web Form update information object. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call updateWidgetCall(String authorization, String ifMatch, String widgetId, WidgetInfo widgetInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call updateWidgetCall(String authorization, String widgetId, WidgetInfo widgetInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = widgetInfo; // create path and map variables @@ -2811,18 +3097,13 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call updateWidgetValidateBeforeCall(String authorization, String ifMatch, String widgetId, WidgetInfo widgetInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateWidgetValidateBeforeCall(String authorization, String widgetId, WidgetInfo widgetInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling updateWidget(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling updateWidget(Async)"); - } - // verify the required parameter 'widgetId' is set if (widgetId == null) { throw new ApiException("Missing the required parameter 'widgetId' when calling updateWidget(Async)"); @@ -2834,57 +3115,57 @@ private com.squareup.okhttp.Call updateWidgetValidateBeforeCall(String authoriza } - com.squareup.okhttp.Call call = updateWidgetCall(authorization, ifMatch, widgetId, widgetInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateWidgetCall(authorization, widgetId, widgetInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); return call; } /** - * Updates a widget. + * Updates a web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) - * @param widgetInfo Widget update information object. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param widgetInfo Web Form update information object. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void updateWidget(String authorization, String ifMatch, String widgetId, WidgetInfo widgetInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - updateWidgetWithHttpInfo(authorization, ifMatch, widgetId, widgetInfo, xApiUser, xOnBehalfOfUser); + public void updateWidget(String authorization, String widgetId, WidgetInfo widgetInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + updateWidgetWithHttpInfo(authorization, widgetId, widgetInfo, xApiUser, xOnBehalfOfUser, ifMatch); } /** - * Updates a widget. + * Updates a web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) - * @param widgetInfo Widget update information object. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param widgetInfo Web Form update information object. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse updateWidgetWithHttpInfo(String authorization, String ifMatch, String widgetId, WidgetInfo widgetInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = updateWidgetValidateBeforeCall(authorization, ifMatch, widgetId, widgetInfo, xApiUser, xOnBehalfOfUser, null, null); + public ApiResponse updateWidgetWithHttpInfo(String authorization, String widgetId, WidgetInfo widgetInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + com.squareup.okhttp.Call call = updateWidgetValidateBeforeCall(authorization, widgetId, widgetInfo, xApiUser, xOnBehalfOfUser, ifMatch, null, null); return apiClient.execute(call); } /** - * Updates a widget. (asynchronously) + * Updates a web form. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) - * @param widgetInfo Widget update information object. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param widgetInfo Web Form update information object. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call updateWidgetAsync(String authorization, String ifMatch, String widgetId, WidgetInfo widgetInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateWidgetAsync(String authorization, String widgetId, WidgetInfo widgetInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -2905,15 +3186,15 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = updateWidgetValidateBeforeCall(authorization, ifMatch, widgetId, widgetInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateWidgetValidateBeforeCall(authorization, widgetId, widgetInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } /** * Build call for updateWidgetNoteForApiUser * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) - * @param note The note to be associated with the widget. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param note The note to be associated with the web form. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param progressListener Progress listener @@ -2994,11 +3275,11 @@ private com.squareup.okhttp.Call updateWidgetNoteForApiUserValidateBeforeCall(St } /** - * Updates the latest note of a widget for the API user. + * Updates the latest note of a web form for the API user. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) - * @param note The note to be associated with the widget. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param note The note to be associated with the web form. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -3008,11 +3289,11 @@ public void updateWidgetNoteForApiUser(String authorization, String widgetId, No } /** - * Updates the latest note of a widget for the API user. + * Updates the latest note of a web form for the API user. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) - * @param note The note to be associated with the widget. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param note The note to be associated with the web form. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @return ApiResponse<Void> @@ -3024,11 +3305,11 @@ public ApiResponse updateWidgetNoteForApiUserWithHttpInfo(String authoriza } /** - * Updates the latest note of a widget for the API user. (asynchronously) + * Updates the latest note of a web form for the API user. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) - * @param note The note to be associated with the widget. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param note The note to be associated with the web form. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param callback The callback to be executed when the API call finishes @@ -3063,18 +3344,19 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don /** * Build call for updateWidgetSecurityOptionsForParticipation * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param participantSetId The participant set identifier (required) * @param participantId The participant identifier (required) * @param participantSecurityOption Security options that apply to the participant (required) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call updateWidgetSecurityOptionsForParticipationCall(String authorization, String ifMatch, String widgetId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call updateWidgetSecurityOptionsForParticipationCall(String authorization, String widgetId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String ifMatch, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = participantSecurityOption; // create path and map variables @@ -3093,6 +3375,8 @@ public com.squareup.okhttp.Call updateWidgetSecurityOptionsForParticipationCall( localVarHeaderParams.put("If-Match", apiClient.parameterToString(ifMatch)); if (xApiUser != null) localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); Map localVarFormParams = new HashMap(); @@ -3125,18 +3409,13 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call updateWidgetSecurityOptionsForParticipationValidateBeforeCall(String authorization, String ifMatch, String widgetId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String xApiUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateWidgetSecurityOptionsForParticipationValidateBeforeCall(String authorization, String widgetId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String ifMatch, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling updateWidgetSecurityOptionsForParticipation(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling updateWidgetSecurityOptionsForParticipation(Async)"); - } - // verify the required parameter 'widgetId' is set if (widgetId == null) { throw new ApiException("Missing the required parameter 'widgetId' when calling updateWidgetSecurityOptionsForParticipation(Async)"); @@ -3158,7 +3437,7 @@ private com.squareup.okhttp.Call updateWidgetSecurityOptionsForParticipationVali } - com.squareup.okhttp.Call call = updateWidgetSecurityOptionsForParticipationCall(authorization, ifMatch, widgetId, participantSetId, participantId, participantSecurityOption, xApiUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateWidgetSecurityOptionsForParticipationCall(authorization, widgetId, participantSetId, participantId, participantSecurityOption, ifMatch, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); return call; } @@ -3167,33 +3446,35 @@ private com.squareup.okhttp.Call updateWidgetSecurityOptionsForParticipationVali * Updates the security options for a particular participant. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param participantSetId The participant set identifier (required) * @param participantId The participant identifier (required) * @param participantSecurityOption Security options that apply to the participant (required) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void updateWidgetSecurityOptionsForParticipation(String authorization, String ifMatch, String widgetId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String xApiUser) throws ApiException { - updateWidgetSecurityOptionsForParticipationWithHttpInfo(authorization, ifMatch, widgetId, participantSetId, participantId, participantSecurityOption, xApiUser); + public void updateWidgetSecurityOptionsForParticipation(String authorization, String widgetId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String ifMatch, String xApiUser, String xOnBehalfOfUser) throws ApiException { + updateWidgetSecurityOptionsForParticipationWithHttpInfo(authorization, widgetId, participantSetId, participantId, participantSecurityOption, ifMatch, xApiUser, xOnBehalfOfUser); } /** * Updates the security options for a particular participant. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param participantSetId The participant set identifier (required) * @param participantId The participant identifier (required) * @param participantSecurityOption Security options that apply to the participant (required) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse updateWidgetSecurityOptionsForParticipationWithHttpInfo(String authorization, String ifMatch, String widgetId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String xApiUser) throws ApiException { - com.squareup.okhttp.Call call = updateWidgetSecurityOptionsForParticipationValidateBeforeCall(authorization, ifMatch, widgetId, participantSetId, participantId, participantSecurityOption, xApiUser, null, null); + public ApiResponse updateWidgetSecurityOptionsForParticipationWithHttpInfo(String authorization, String widgetId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String ifMatch, String xApiUser, String xOnBehalfOfUser) throws ApiException { + com.squareup.okhttp.Call call = updateWidgetSecurityOptionsForParticipationValidateBeforeCall(authorization, widgetId, participantSetId, participantId, participantSecurityOption, ifMatch, xApiUser, xOnBehalfOfUser, null, null); return apiClient.execute(call); } @@ -3201,17 +3482,18 @@ public ApiResponse updateWidgetSecurityOptionsForParticipationWithHttpInfo * Updates the security options for a particular participant. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param participantSetId The participant set identifier (required) * @param participantId The participant identifier (required) * @param participantSecurityOption Security options that apply to the participant (required) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call updateWidgetSecurityOptionsForParticipationAsync(String authorization, String ifMatch, String widgetId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String xApiUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateWidgetSecurityOptionsForParticipationAsync(String authorization, String widgetId, String participantSetId, String participantId, ParticipantSecurityOption participantSecurityOption, String ifMatch, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -3232,24 +3514,24 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = updateWidgetSecurityOptionsForParticipationValidateBeforeCall(authorization, ifMatch, widgetId, participantSetId, participantId, participantSecurityOption, xApiUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateWidgetSecurityOptionsForParticipationValidateBeforeCall(authorization, widgetId, participantSetId, participantId, participantSecurityOption, ifMatch, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } /** * Build call for updateWidgetState * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param widgetStateInfo (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call updateWidgetStateCall(String authorization, String ifMatch, String widgetId, WidgetStateInfo widgetStateInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call updateWidgetStateCall(String authorization, String widgetId, WidgetStateInfo widgetStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = widgetStateInfo; // create path and map variables @@ -3300,18 +3582,13 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call updateWidgetStateValidateBeforeCall(String authorization, String ifMatch, String widgetId, WidgetStateInfo widgetStateInfo, String xApiUser, String xOnBehalfOfUser, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateWidgetStateValidateBeforeCall(String authorization, String widgetId, WidgetStateInfo widgetStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { throw new ApiException("Missing the required parameter 'authorization' when calling updateWidgetState(Async)"); } - // verify the required parameter 'ifMatch' is set - if (ifMatch == null) { - throw new ApiException("Missing the required parameter 'ifMatch' when calling updateWidgetState(Async)"); - } - // verify the required parameter 'widgetId' is set if (widgetId == null) { throw new ApiException("Missing the required parameter 'widgetId' when calling updateWidgetState(Async)"); @@ -3323,57 +3600,57 @@ private com.squareup.okhttp.Call updateWidgetStateValidateBeforeCall(String auth } - com.squareup.okhttp.Call call = updateWidgetStateCall(authorization, ifMatch, widgetId, widgetStateInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateWidgetStateCall(authorization, widgetId, widgetStateInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); return call; } /** - * Updates the state of a widget identified by widgetId in the path. - * This endpoint can be used by creator of the widget to transition between the states of widget. An allowed transition would follow any of the following sequence : DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. + * Updates the state of a web form identified by widgetId in the path. + * This endpoint can be used by creator of the web form to transition between the states of web form. An allowed transition would follow any of the following sequence : DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param widgetStateInfo (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void updateWidgetState(String authorization, String ifMatch, String widgetId, WidgetStateInfo widgetStateInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - updateWidgetStateWithHttpInfo(authorization, ifMatch, widgetId, widgetStateInfo, xApiUser, xOnBehalfOfUser); + public void updateWidgetState(String authorization, String widgetId, WidgetStateInfo widgetStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + updateWidgetStateWithHttpInfo(authorization, widgetId, widgetStateInfo, xApiUser, xOnBehalfOfUser, ifMatch); } /** - * Updates the state of a widget identified by widgetId in the path. - * This endpoint can be used by creator of the widget to transition between the states of widget. An allowed transition would follow any of the following sequence : DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. + * Updates the state of a web form identified by widgetId in the path. + * This endpoint can be used by creator of the web form to transition between the states of web form. An allowed transition would follow any of the following sequence : DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param widgetStateInfo (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse updateWidgetStateWithHttpInfo(String authorization, String ifMatch, String widgetId, WidgetStateInfo widgetStateInfo, String xApiUser, String xOnBehalfOfUser) throws ApiException { - com.squareup.okhttp.Call call = updateWidgetStateValidateBeforeCall(authorization, ifMatch, widgetId, widgetStateInfo, xApiUser, xOnBehalfOfUser, null, null); + public ApiResponse updateWidgetStateWithHttpInfo(String authorization, String widgetId, WidgetStateInfo widgetStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch) throws ApiException { + com.squareup.okhttp.Call call = updateWidgetStateValidateBeforeCall(authorization, widgetId, widgetStateInfo, xApiUser, xOnBehalfOfUser, ifMatch, null, null); return apiClient.execute(call); } /** - * Updates the state of a widget identified by widgetId in the path. (asynchronously) - * This endpoint can be used by creator of the widget to transition between the states of widget. An allowed transition would follow any of the following sequence : DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. + * Updates the state of a web form identified by widgetId in the path. (asynchronously) + * This endpoint can be used by creator of the web form to transition between the states of web form. An allowed transition would follow any of the following sequence : DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) * @param widgetStateInfo (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param ifMatch The server will only update the resource if it matches the listed ETag otherwise error RESOURCE_MODIFIED(412) is returned. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call updateWidgetStateAsync(String authorization, String ifMatch, String widgetId, WidgetStateInfo widgetStateInfo, String xApiUser, String xOnBehalfOfUser, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateWidgetStateAsync(String authorization, String widgetId, WidgetStateInfo widgetStateInfo, String xApiUser, String xOnBehalfOfUser, String ifMatch, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -3394,15 +3671,15 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = updateWidgetStateValidateBeforeCall(authorization, ifMatch, widgetId, widgetStateInfo, xApiUser, xOnBehalfOfUser, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateWidgetStateValidateBeforeCall(authorization, widgetId, widgetStateInfo, xApiUser, xOnBehalfOfUser, ifMatch, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } /** * Build call for updateWidgetVisibility * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) - * @param visibilityInfo Information to update visibility of widget (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param visibilityInfo Information to update visibility of web form (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param progressListener Progress listener @@ -3483,11 +3760,11 @@ private com.squareup.okhttp.Call updateWidgetVisibilityValidateBeforeCall(String } /** - * Updates the visibility of widget. + * Updates the visibility of web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) - * @param visibilityInfo Information to update visibility of widget (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param visibilityInfo Information to update visibility of web form (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -3497,11 +3774,11 @@ public void updateWidgetVisibility(String authorization, String widgetId, Visibi } /** - * Updates the visibility of widget. + * Updates the visibility of web form. * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) - * @param visibilityInfo Information to update visibility of widget (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param visibilityInfo Information to update visibility of web form (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @return ApiResponse<Void> @@ -3513,11 +3790,11 @@ public ApiResponse updateWidgetVisibilityWithHttpInfo(String authorization } /** - * Updates the visibility of widget. (asynchronously) + * Updates the visibility of web form. (asynchronously) * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('widget_write')\" oncontextmenu=\"this.href=oauthDoc('widget_write')\" target=\"oauthDoc\">widget_write</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) - * @param widgetId The widget identifier, as returned by the widget creation API or retrieved from the API to fetch widgets. (required) - * @param visibilityInfo Information to update visibility of widget (required) + * @param widgetId The web form identifier, as returned by the web form creation API or retrieved from the API to fetch web forms. (required) + * @param visibilityInfo Information to update visibility of web form (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) * @param callback The callback to be executed when the API call finishes diff --git a/src/main/java/io/swagger/client/api/WorkflowsApi.java b/src/main/java/io/swagger/client/api/WorkflowsApi.java index 68a6b7b..09a0d52 100755 --- a/src/main/java/io/swagger/client/api/WorkflowsApi.java +++ b/src/main/java/io/swagger/client/api/WorkflowsApi.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -43,6 +28,7 @@ import io.swagger.client.model.workflows.UserWorkflows; +import io.swagger.client.model.workflows.WorkflowDescription; import java.lang.reflect.Type; import java.util.ArrayList; @@ -69,19 +55,172 @@ public void setApiClient(ApiClient apiClient) { this.apiClient = apiClient; } + /** + * Build call for getWorkflowInfo + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('workflow_read')\" oncontextmenu=\"this.href=oauthDoc('workflow_read')\" target=\"oauthDoc\">workflow_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param workflowId The workflow identifier, as retrieved from the API to fetch workflows. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getWorkflowInfoCall(String authorization, String workflowId, String xApiUser, String xOnBehalfOfUser, String groupId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/workflows/{workflowId}" + .replaceAll("\\{" + "workflowId" + "\\}", apiClient.escapeString(workflowId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (groupId != null) + localVarQueryParams.addAll(apiClient.parameterToPair("groupId", groupId)); + + Map localVarHeaderParams = new HashMap(); + if (authorization != null) + localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); + if (xApiUser != null) + localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getWorkflowInfoValidateBeforeCall(String authorization, String workflowId, String xApiUser, String xOnBehalfOfUser, String groupId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'authorization' is set + if (authorization == null) { + throw new ApiException("Missing the required parameter 'authorization' when calling getWorkflowInfo(Async)"); + } + + // verify the required parameter 'workflowId' is set + if (workflowId == null) { + throw new ApiException("Missing the required parameter 'workflowId' when calling getWorkflowInfo(Async)"); + } + + + com.squareup.okhttp.Call call = getWorkflowInfoCall(authorization, workflowId, xApiUser, xOnBehalfOfUser, groupId, progressListener, progressRequestListener); + return call; + + } + + /** + * Retrieves the details of a workflow. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('workflow_read')\" oncontextmenu=\"this.href=oauthDoc('workflow_read')\" target=\"oauthDoc\">workflow_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param workflowId The workflow identifier, as retrieved from the API to fetch workflows. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) + * @return WorkflowDescription + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public WorkflowDescription getWorkflowInfo(String authorization, String workflowId, String xApiUser, String xOnBehalfOfUser, String groupId) throws ApiException { + ApiResponse resp = getWorkflowInfoWithHttpInfo(authorization, workflowId, xApiUser, xOnBehalfOfUser, groupId); + return resp.getData(); + } + + /** + * Retrieves the details of a workflow. + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('workflow_read')\" oncontextmenu=\"this.href=oauthDoc('workflow_read')\" target=\"oauthDoc\">workflow_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param workflowId The workflow identifier, as retrieved from the API to fetch workflows. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) + * @return ApiResponse<WorkflowDescription> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getWorkflowInfoWithHttpInfo(String authorization, String workflowId, String xApiUser, String xOnBehalfOfUser, String groupId) throws ApiException { + com.squareup.okhttp.Call call = getWorkflowInfoValidateBeforeCall(authorization, workflowId, xApiUser, xOnBehalfOfUser, groupId, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieves the details of a workflow. (asynchronously) + * + * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('workflow_read')\" oncontextmenu=\"this.href=oauthDoc('workflow_read')\" target=\"oauthDoc\">workflow_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) + * @param workflowId The workflow identifier, as retrieved from the API to fetch workflows. (required) + * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param groupId The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getWorkflowInfoAsync(String authorization, String workflowId, String xApiUser, String xOnBehalfOfUser, String groupId, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getWorkflowInfoValidateBeforeCall(authorization, workflowId, xApiUser, xOnBehalfOfUser, groupId, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } /** * Build call for getWorkflows * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('workflow_read')\" oncontextmenu=\"this.href=oauthDoc('workflow_read')\" target=\"oauthDoc\">workflow_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param groupId The group identifier for which the workflows will be fetched (optional) * @param includeDraftWorkflows Include draft workflows (optional) * @param includeInactiveWorkflows Include inactive workflows (optional) - * @param groupId The group identifier for which the workflows will be fetched (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getWorkflowsCall(String authorization, String xApiUser, Boolean includeDraftWorkflows, Boolean includeInactiveWorkflows, String groupId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getWorkflowsCall(String authorization, String xApiUser, String xOnBehalfOfUser, String groupId, Boolean includeDraftWorkflows, Boolean includeInactiveWorkflows, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -89,18 +228,20 @@ public com.squareup.okhttp.Call getWorkflowsCall(String authorization, String xA List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); + if (groupId != null) + localVarQueryParams.addAll(apiClient.parameterToPair("groupId", groupId)); if (includeDraftWorkflows != null) localVarQueryParams.addAll(apiClient.parameterToPair("includeDraftWorkflows", includeDraftWorkflows)); if (includeInactiveWorkflows != null) localVarQueryParams.addAll(apiClient.parameterToPair("includeInactiveWorkflows", includeInactiveWorkflows)); - if (groupId != null) - localVarQueryParams.addAll(apiClient.parameterToPair("groupId", groupId)); Map localVarHeaderParams = new HashMap(); if (authorization != null) localVarHeaderParams.put("Authorization", apiClient.parameterToString(authorization)); if (xApiUser != null) localVarHeaderParams.put("x-api-user", apiClient.parameterToString(xApiUser)); + if (xOnBehalfOfUser != null) + localVarHeaderParams.put("x-on-behalf-of-user", apiClient.parameterToString(xOnBehalfOfUser)); Map localVarFormParams = new HashMap(); @@ -133,7 +274,7 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getWorkflowsValidateBeforeCall(String authorization, String xApiUser, Boolean includeDraftWorkflows, Boolean includeInactiveWorkflows, String groupId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getWorkflowsValidateBeforeCall(String authorization, String xApiUser, String xOnBehalfOfUser, String groupId, Boolean includeDraftWorkflows, Boolean includeInactiveWorkflows, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'authorization' is set if (authorization == null) { @@ -141,7 +282,7 @@ private com.squareup.okhttp.Call getWorkflowsValidateBeforeCall(String authoriza } - com.squareup.okhttp.Call call = getWorkflowsCall(authorization, xApiUser, includeDraftWorkflows, includeInactiveWorkflows, groupId, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getWorkflowsCall(authorization, xApiUser, xOnBehalfOfUser, groupId, includeDraftWorkflows, includeInactiveWorkflows, progressListener, progressRequestListener); return call; } @@ -151,14 +292,15 @@ private com.squareup.okhttp.Call getWorkflowsValidateBeforeCall(String authoriza * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('workflow_read')\" oncontextmenu=\"this.href=oauthDoc('workflow_read')\" target=\"oauthDoc\">workflow_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param groupId The group identifier for which the workflows will be fetched (optional) * @param includeDraftWorkflows Include draft workflows (optional) * @param includeInactiveWorkflows Include inactive workflows (optional) - * @param groupId The group identifier for which the workflows will be fetched (optional) * @return UserWorkflows * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public UserWorkflows getWorkflows(String authorization, String xApiUser, Boolean includeDraftWorkflows, Boolean includeInactiveWorkflows, String groupId) throws ApiException { - ApiResponse resp = getWorkflowsWithHttpInfo(authorization, xApiUser, includeDraftWorkflows, includeInactiveWorkflows, groupId); + public UserWorkflows getWorkflows(String authorization, String xApiUser, String xOnBehalfOfUser, String groupId, Boolean includeDraftWorkflows, Boolean includeInactiveWorkflows) throws ApiException { + ApiResponse resp = getWorkflowsWithHttpInfo(authorization, xApiUser, xOnBehalfOfUser, groupId, includeDraftWorkflows, includeInactiveWorkflows); return resp.getData(); } @@ -167,14 +309,15 @@ public UserWorkflows getWorkflows(String authorization, String xApiUser, Boolean * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('workflow_read')\" oncontextmenu=\"this.href=oauthDoc('workflow_read')\" target=\"oauthDoc\">workflow_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param groupId The group identifier for which the workflows will be fetched (optional) * @param includeDraftWorkflows Include draft workflows (optional) * @param includeInactiveWorkflows Include inactive workflows (optional) - * @param groupId The group identifier for which the workflows will be fetched (optional) * @return ApiResponse<UserWorkflows> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getWorkflowsWithHttpInfo(String authorization, String xApiUser, Boolean includeDraftWorkflows, Boolean includeInactiveWorkflows, String groupId) throws ApiException { - com.squareup.okhttp.Call call = getWorkflowsValidateBeforeCall(authorization, xApiUser, includeDraftWorkflows, includeInactiveWorkflows, groupId, null, null); + public ApiResponse getWorkflowsWithHttpInfo(String authorization, String xApiUser, String xOnBehalfOfUser, String groupId, Boolean includeDraftWorkflows, Boolean includeInactiveWorkflows) throws ApiException { + com.squareup.okhttp.Call call = getWorkflowsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, groupId, includeDraftWorkflows, includeInactiveWorkflows, null, null); Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -184,14 +327,15 @@ public ApiResponse getWorkflowsWithHttpInfo(String authorization, * * @param authorization An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('workflow_read')\" oncontextmenu=\"this.href=oauthDoc('workflow_read')\" target=\"oauthDoc\">workflow_read</a></li></ul>in the format <b>'Bearer {accessToken}'. (required) * @param xApiUser The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token. (optional) + * @param xOnBehalfOfUser The userId or email in the format <b>userid:{userId} OR email:{email}.</b> of the user that has shared his/her account (optional) + * @param groupId The group identifier for which the workflows will be fetched (optional) * @param includeDraftWorkflows Include draft workflows (optional) * @param includeInactiveWorkflows Include inactive workflows (optional) - * @param groupId The group identifier for which the workflows will be fetched (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getWorkflowsAsync(String authorization, String xApiUser, Boolean includeDraftWorkflows, Boolean includeInactiveWorkflows, String groupId, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getWorkflowsAsync(String authorization, String xApiUser, String xOnBehalfOfUser, String groupId, Boolean includeDraftWorkflows, Boolean includeInactiveWorkflows, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -212,7 +356,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getWorkflowsValidateBeforeCall(authorization, xApiUser, includeDraftWorkflows, includeInactiveWorkflows, groupId, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getWorkflowsValidateBeforeCall(authorization, xApiUser, xOnBehalfOfUser, groupId, includeDraftWorkflows, includeInactiveWorkflows, progressListener, progressRequestListener); Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; diff --git a/src/main/java/io/swagger/client/model/ApiCallback.java b/src/main/java/io/swagger/client/model/ApiCallback.java index 6e9af2c..c21b69c 100755 --- a/src/main/java/io/swagger/client/model/ApiCallback.java +++ b/src/main/java/io/swagger/client/model/ApiCallback.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) diff --git a/src/main/java/io/swagger/client/model/ApiClient.java b/src/main/java/io/swagger/client/model/ApiClient.java index 95ca1a9..b754c3e 100755 --- a/src/main/java/io/swagger/client/model/ApiClient.java +++ b/src/main/java/io/swagger/client/model/ApiClient.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -64,7 +49,7 @@ public class ApiClient { - private String basePath = "http://localhost/api/rest/v6"; + private String basePath = "https://secure.au1.echosign.com/api/rest/v6"; private boolean debugging = false; private Map defaultHeaderMap = new HashMap(); private String tempFolderPath = null; @@ -97,7 +82,7 @@ public ApiClient() { json = new JSON(); // Set default User-Agent. - setUserAgent("AdobeSign_JavaSdk_3_0"); + setUserAgent("AdobeSign_JavaSdk_1_0"); // Setup authentications (key: authentication name, value: authentication). authentications = new HashMap(); @@ -117,7 +102,7 @@ public String getBasePath() { /** * Set base path * - * @param basePath Base path of the URL (e.g http://localhost/api/rest/v6 + * @param basePath Base path of the URL (e.g https://secure.au1.echosign.com/api/rest/v6 * @return An instance of OkHttpClient */ public ApiClient setBasePath(String basePath) { diff --git a/src/main/java/io/swagger/client/model/ApiException.java b/src/main/java/io/swagger/client/model/ApiException.java index 3d852f2..895f25e 100755 --- a/src/main/java/io/swagger/client/model/ApiException.java +++ b/src/main/java/io/swagger/client/model/ApiException.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -31,7 +16,7 @@ import java.util.Map; import java.util.List; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:09.914+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") public class ApiException extends Exception { private int code = 0; private Map> responseHeaders = null; diff --git a/src/main/java/io/swagger/client/model/ApiResponse.java b/src/main/java/io/swagger/client/model/ApiResponse.java index 8bbada2..9d12dbc 100755 --- a/src/main/java/io/swagger/client/model/ApiResponse.java +++ b/src/main/java/io/swagger/client/model/ApiResponse.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) diff --git a/src/main/java/io/swagger/client/model/Configuration.java b/src/main/java/io/swagger/client/model/Configuration.java index d6e13ae..f9f26f8 100755 --- a/src/main/java/io/swagger/client/model/Configuration.java +++ b/src/main/java/io/swagger/client/model/Configuration.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -28,7 +13,7 @@ package io.swagger.client.model; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:09.914+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") public class Configuration { private static ApiClient defaultApiClient = new ApiClient(); diff --git a/src/main/java/io/swagger/client/model/GzipRequestInterceptor.java b/src/main/java/io/swagger/client/model/GzipRequestInterceptor.java index 0c2df14..08a07b6 100755 --- a/src/main/java/io/swagger/client/model/GzipRequestInterceptor.java +++ b/src/main/java/io/swagger/client/model/GzipRequestInterceptor.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) diff --git a/src/main/java/io/swagger/client/model/JSON.java b/src/main/java/io/swagger/client/model/JSON.java index 8d7d683..36dcef2 100755 --- a/src/main/java/io/swagger/client/model/JSON.java +++ b/src/main/java/io/swagger/client/model/JSON.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) diff --git a/src/main/java/io/swagger/client/model/Pair.java b/src/main/java/io/swagger/client/model/Pair.java index edb425f..8ea97ec 100755 --- a/src/main/java/io/swagger/client/model/Pair.java +++ b/src/main/java/io/swagger/client/model/Pair.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -28,7 +13,7 @@ package io.swagger.client.model; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:09.914+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") public class Pair { private String name = ""; private String value = ""; diff --git a/src/main/java/io/swagger/client/model/ProgressRequestBody.java b/src/main/java/io/swagger/client/model/ProgressRequestBody.java index f8cbdd9..d02525b 100755 --- a/src/main/java/io/swagger/client/model/ProgressRequestBody.java +++ b/src/main/java/io/swagger/client/model/ProgressRequestBody.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) diff --git a/src/main/java/io/swagger/client/model/ProgressResponseBody.java b/src/main/java/io/swagger/client/model/ProgressResponseBody.java index 979c46c..888284d 100755 --- a/src/main/java/io/swagger/client/model/ProgressResponseBody.java +++ b/src/main/java/io/swagger/client/model/ProgressResponseBody.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) diff --git a/src/main/java/io/swagger/client/model/StringUtil.java b/src/main/java/io/swagger/client/model/StringUtil.java index 1fcedb5..887e069 100755 --- a/src/main/java/io/swagger/client/model/StringUtil.java +++ b/src/main/java/io/swagger/client/model/StringUtil.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -28,7 +13,7 @@ package io.swagger.client.model; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:09.914+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") public class StringUtil { /** * Check if the given array contains the given value (with case-insensitive comparison). diff --git a/src/main/java/io/swagger/client/model/accounts/Account.java b/src/main/java/io/swagger/client/model/accounts/Account.java new file mode 100644 index 0000000..1cdd187 --- /dev/null +++ b/src/main/java/io/swagger/client/model/accounts/Account.java @@ -0,0 +1,289 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.accounts; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.Date; + +/** + * Account resource for the User + */ +@ApiModel(description = "Account resource for the User") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:33.105+11:00") +public class Account { + @SerializedName("created") + private Date created = null; + + /** + * The provisioned type of the account. This is a server generated attributed and can not be provided in POST/PUT calls. + */ + @JsonAdapter(AccountTypeEnum.Adapter.class) + public enum AccountTypeEnum { + FREE("FREE"), + + FREE_LEGACY("FREE_LEGACY"), + + TEAM_TRIAL("TEAM_TRIAL"), + + TEAM("TEAM"), + + TEAM_LEGACY("TEAM_LEGACY"), + + ENTERPRISE_TRIAL("ENTERPRISE_TRIAL"), + + ENTERPRISE("ENTERPRISE"), + + ENTERPRISE_LEGACY("ENTERPRISE_LEGACY"), + + GLOBAL_TRIAL("GLOBAL_TRIAL"), + + GLOBAL("GLOBAL"), + + DEVELOPER("DEVELOPER"), + + PRO_DOC_CLOUD("PRO_DOC_CLOUD"), + + TEAM_DOC_CLOUD("TEAM_DOC_CLOUD"), + + TRIAL_EXPIRED("TRIAL_EXPIRED"), + + ANONYMOUS("ANONYMOUS"), + + PRO_DOC_CLOUD_MULTI("PRO_DOC_CLOUD_MULTI"), + + PRO_PLUS_DOC_CLOUD("PRO_PLUS_DOC_CLOUD"), + + PRO_PLUS_DOC_CLOUD_MULTI("PRO_PLUS_DOC_CLOUD_MULTI"); + + private String value; + + AccountTypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static AccountTypeEnum fromValue(String text) { + for (AccountTypeEnum b : AccountTypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final AccountTypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public AccountTypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return AccountTypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("accountType") + private AccountTypeEnum accountType = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("modified") + private Date modified = null; + + @SerializedName("company") + private String company = null; + + @SerializedName("id") + private String id = null; + + public Account created(Date created) { + this.created = created; + return this; + } + + /** + * Date when the account was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return created + **/ + @ApiModelProperty(value = "Date when the account was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getCreated() { + return created; + } + + public void setCreated(Date created) { + this.created = created; + } + + public Account accountType(AccountTypeEnum accountType) { + this.accountType = accountType; + return this; + } + + /** + * The provisioned type of the account. This is a server generated attributed and can not be provided in POST/PUT calls. + * @return accountType + **/ + @ApiModelProperty(value = "The provisioned type of the account. This is a server generated attributed and can not be provided in POST/PUT calls.") + public AccountTypeEnum getAccountType() { + return accountType; + } + + public void setAccountType(AccountTypeEnum accountType) { + this.accountType = accountType; + } + + public Account name(String name) { + this.name = name; + return this; + } + + /** + * The name which the account is known. This is a server generated attributed and can not be provided in POST/PUT calls. + * @return name + **/ + @ApiModelProperty(value = "The name which the account is known. This is a server generated attributed and can not be provided in POST/PUT calls. ") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public Account modified(Date modified) { + this.modified = modified; + return this; + } + + /** + * The last date that the account information was updated. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return modified + **/ + @ApiModelProperty(value = "The last date that the account information was updated. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getModified() { + return modified; + } + + public void setModified(Date modified) { + this.modified = modified; + } + + public Account company(String company) { + this.company = company; + return this; + } + + /** + * The company associated with the account. This is a server generated attributed and can not be provided in POST/PUT calls. + * @return company + **/ + @ApiModelProperty(value = "The company associated with the account. This is a server generated attributed and can not be provided in POST/PUT calls. ") + public String getCompany() { + return company; + } + + public void setCompany(String company) { + this.company = company; + } + + public Account id(String id) { + this.id = id; + return this; + } + + /** + * Identifier of the account. This is a server generated attributed and can not be provided in POST/PUT calls. + * @return id + **/ + @ApiModelProperty(value = "Identifier of the account. This is a server generated attributed and can not be provided in POST/PUT calls. ") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Account account = (Account) o; + return Objects.equals(this.created, account.created) && + Objects.equals(this.accountType, account.accountType) && + Objects.equals(this.name, account.name) && + Objects.equals(this.modified, account.modified) && + Objects.equals(this.company, account.company) && + Objects.equals(this.id, account.id); + } + + @Override + public int hashCode() { + return Objects.hash(created, accountType, name, modified, company, id); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Account {\n"); + + sb.append(" created: ").append(toIndentedString(created)).append("\n"); + sb.append(" accountType: ").append(toIndentedString(accountType)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" modified: ").append(toIndentedString(modified)).append("\n"); + sb.append(" company: ").append(toIndentedString(company)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/agreements/AccountSharerInfo.java b/src/main/java/io/swagger/client/model/agreements/AccountSharerInfo.java new file mode 100644 index 0000000..6fb07d3 --- /dev/null +++ b/src/main/java/io/swagger/client/model/agreements/AccountSharerInfo.java @@ -0,0 +1,221 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.agreements; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * AccountSharerInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") +public class AccountSharerInfo { + /** + * Gets or Sets permissions + */ + @JsonAdapter(PermissionsEnum.Adapter.class) + public enum PermissionsEnum { + VIEW("VIEW"), + + SEND("SEND"), + + MODIFY("MODIFY"); + + private String value; + + PermissionsEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static PermissionsEnum fromValue(String text) { + for (PermissionsEnum b : PermissionsEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final PermissionsEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public PermissionsEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return PermissionsEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("permissions") + private List permissions = null; + + @SerializedName("fullName") + private String fullName = null; + + @SerializedName("userId") + private String userId = null; + + @SerializedName("email") + private String email = null; + + public AccountSharerInfo permissions(List permissions) { + this.permissions = permissions; + return this; + } + + public AccountSharerInfo addPermissionsItem(PermissionsEnum permissionsItem) { + if (this.permissions == null) { + this.permissions = new ArrayList(); + } + this.permissions.add(permissionsItem); + return this; + } + + /** + * A list of permissions given for this account sharing. + * @return permissions + **/ + @ApiModelProperty(value = "A list of permissions given for this account sharing.") + public List getPermissions() { + return permissions; + } + + public void setPermissions(List permissions) { + this.permissions = permissions; + } + + public AccountSharerInfo fullName(String fullName) { + this.fullName = fullName; + return this; + } + + /** + * Full name of this account sharer. + * @return fullName + **/ + @ApiModelProperty(value = "Full name of this account sharer.") + public String getFullName() { + return fullName; + } + + public void setFullName(String fullName) { + this.fullName = fullName; + } + + public AccountSharerInfo userId(String userId) { + this.userId = userId; + return this; + } + + /** + * A unique identifier of the user resource for REST APIs as issued by Sign. + * @return userId + **/ + @ApiModelProperty(value = "A unique identifier of the user resource for REST APIs as issued by Sign.") + public String getUserId() { + return userId; + } + + public void setUserId(String userId) { + this.userId = userId; + } + + public AccountSharerInfo email(String email) { + this.email = email; + return this; + } + + /** + * The email address of the user + * @return email + **/ + @ApiModelProperty(value = "The email address of the user") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + AccountSharerInfo accountSharerInfo = (AccountSharerInfo) o; + return Objects.equals(this.permissions, accountSharerInfo.permissions) && + Objects.equals(this.fullName, accountSharerInfo.fullName) && + Objects.equals(this.userId, accountSharerInfo.userId) && + Objects.equals(this.email, accountSharerInfo.email); + } + + @Override + public int hashCode() { + return Objects.hash(permissions, fullName, userId, email); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class AccountSharerInfo {\n"); + + sb.append(" permissions: ").append(toIndentedString(permissions)).append("\n"); + sb.append(" fullName: ").append(toIndentedString(fullName)).append("\n"); + sb.append(" userId: ").append(toIndentedString(userId)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/agreements/AgreementCancellationInfo.java b/src/main/java/io/swagger/client/model/agreements/AgreementCancellationInfo.java index 1dd89bd..772716e 100755 --- a/src/main/java/io/swagger/client/model/agreements/AgreementCancellationInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/AgreementCancellationInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * AgreementCancellationInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class AgreementCancellationInfo { @SerializedName("comment") private String comment = null; diff --git a/src/main/java/io/swagger/client/model/agreements/AgreementCcInfo.java b/src/main/java/io/swagger/client/model/agreements/AgreementCcInfo.java index 7e9677f..7c5b3b9 100755 --- a/src/main/java/io/swagger/client/model/agreements/AgreementCcInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/AgreementCcInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -43,33 +28,41 @@ /** * AgreementCcInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class AgreementCcInfo { - @SerializedName("email") - private String email = null; + @SerializedName("visiblePages") + private List visiblePages = null; @SerializedName("label") private String label = null; - @SerializedName("visiblePages") - private List visiblePages = null; + @SerializedName("email") + private String email = null; - public AgreementCcInfo email(String email) { - this.email = email; + public AgreementCcInfo visiblePages(List visiblePages) { + this.visiblePages = visiblePages; + return this; + } + + public AgreementCcInfo addVisiblePagesItem(String visiblePagesItem) { + if (this.visiblePages == null) { + this.visiblePages = new ArrayList(); + } + this.visiblePages.add(visiblePagesItem); return this; } /** - * Email of the CC participant of the agreement - * @return email + * When you enable limited document visibility (documentVisibilityEnabled), you can specify which file (fileInfo) should be made visible to which specific participant set.<br>Specify one or more label values of a fileInfos element.<br>Each signer participant sets must contain at least one required signature field in at least one visible file included in this API call; if not a page with a signature field is automatically appended for any missing participant sets. If there is a possibility that one or more participant sets do not have a required signature field in the files included in the API call, all signer participant sets should include a special index value of '0' to make this automatically appended signature page visible to the signer. Not doing so may result in an error. For all other roles, you may omit this value to exclude this page. + * @return visiblePages **/ - @ApiModelProperty(value = "Email of the CC participant of the agreement") - public String getEmail() { - return email; + @ApiModelProperty(value = "When you enable limited document visibility (documentVisibilityEnabled), you can specify which file (fileInfo) should be made visible to which specific participant set.
Specify one or more label values of a fileInfos element.
Each signer participant sets must contain at least one required signature field in at least one visible file included in this API call; if not a page with a signature field is automatically appended for any missing participant sets. If there is a possibility that one or more participant sets do not have a required signature field in the files included in the API call, all signer participant sets should include a special index value of '0' to make this automatically appended signature page visible to the signer. Not doing so may result in an error. For all other roles, you may omit this value to exclude this page.") + public List getVisiblePages() { + return visiblePages; } - public void setEmail(String email) { - this.email = email; + public void setVisiblePages(List visiblePages) { + this.visiblePages = visiblePages; } public AgreementCcInfo label(String label) { @@ -90,30 +83,22 @@ public void setLabel(String label) { this.label = label; } - public AgreementCcInfo visiblePages(List visiblePages) { - this.visiblePages = visiblePages; - return this; - } - - public AgreementCcInfo addVisiblePagesItem(String visiblePagesItem) { - if (this.visiblePages == null) { - this.visiblePages = new ArrayList(); - } - this.visiblePages.add(visiblePagesItem); + public AgreementCcInfo email(String email) { + this.email = email; return this; } /** - * When you enable limited document visibility (documentVisibilityEnabled), you can specify which file (fileInfo) should be made visible to which specific participant set.<br>Specify one or more label values of a fileInfos element.<br>Each signer participant sets must contain at least one required signature field in at least one visible file included in this API call; if not a page with a signature field is automatically appended for any missing participant sets. If there is a possibility that one or more participant sets do not have a required signature field in the files included in the API call, all signer participant sets should include a special index value of '0' to make this automatically appended signature page visible to the signer. Not doing so may result in an error. For all other roles, you may omit this value to exclude this page. - * @return visiblePages + * Email of the CC participant of the agreement + * @return email **/ - @ApiModelProperty(value = "When you enable limited document visibility (documentVisibilityEnabled), you can specify which file (fileInfo) should be made visible to which specific participant set.
Specify one or more label values of a fileInfos element.
Each signer participant sets must contain at least one required signature field in at least one visible file included in this API call; if not a page with a signature field is automatically appended for any missing participant sets. If there is a possibility that one or more participant sets do not have a required signature field in the files included in the API call, all signer participant sets should include a special index value of '0' to make this automatically appended signature page visible to the signer. Not doing so may result in an error. For all other roles, you may omit this value to exclude this page.") - public List getVisiblePages() { - return visiblePages; + @ApiModelProperty(value = "Email of the CC participant of the agreement") + public String getEmail() { + return email; } - public void setVisiblePages(List visiblePages) { - this.visiblePages = visiblePages; + public void setEmail(String email) { + this.email = email; } @@ -126,14 +111,14 @@ public boolean equals(java.lang.Object o) { return false; } AgreementCcInfo agreementCcInfo = (AgreementCcInfo) o; - return Objects.equals(this.email, agreementCcInfo.email) && + return Objects.equals(this.visiblePages, agreementCcInfo.visiblePages) && Objects.equals(this.label, agreementCcInfo.label) && - Objects.equals(this.visiblePages, agreementCcInfo.visiblePages); + Objects.equals(this.email, agreementCcInfo.email); } @Override public int hashCode() { - return Objects.hash(email, label, visiblePages); + return Objects.hash(visiblePages, label, email); } @@ -142,9 +127,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class AgreementCcInfo {\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" label: ").append(toIndentedString(label)).append("\n"); sb.append(" visiblePages: ").append(toIndentedString(visiblePages)).append("\n"); + sb.append(" label: ").append(toIndentedString(label)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/AgreementCreationInfo.java b/src/main/java/io/swagger/client/model/agreements/AgreementCreationInfo.java index 65afdc4..a4d460a 100755 --- a/src/main/java/io/swagger/client/model/agreements/AgreementCreationInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/AgreementCreationInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -54,81 +39,110 @@ /** * AgreementCreationInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class AgreementCreationInfo { - @SerializedName("ccs") - private List ccs = null; + @SerializedName("groupId") + private String groupId = null; - @SerializedName("createdDate") - private Date createdDate = null; + @SerializedName("locale") + private String locale = null; - @SerializedName("deviceInfo") - private OfflineDeviceInfo deviceInfo = null; + /** + * The kind of agreement + */ + @JsonAdapter(TypeEnum.Adapter.class) + public enum TypeEnum { + AGREEMENT("AGREEMENT"), + + MEGASIGN_CHILD("MEGASIGN_CHILD"), + + WIDGET_INSTANCE("WIDGET_INSTANCE"); - @SerializedName("documentVisibilityEnabled") - private Boolean documentVisibilityEnabled = null; + private String value; - @SerializedName("emailOption") - private EmailOption emailOption = null; + TypeEnum(String value) { + this.value = value; + } - @SerializedName("expirationTime") - private Date expirationTime = null; + public String getValue() { + return value; + } - @SerializedName("externalId") - private ExternalId externalId = null; + @Override + public String toString() { + return String.valueOf(value); + } - @SerializedName("fileInfos") - private List fileInfos = null; + public static TypeEnum fromValue(String text) { + for (TypeEnum b : TypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } - @SerializedName("firstReminderDelay") - private Integer firstReminderDelay = null; + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } - @SerializedName("formFieldLayerTemplates") - private List formFieldLayerTemplates = null; + @Override + public TypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return TypeEnum.fromValue(String.valueOf(value)); + } + } + } - @SerializedName("id") - private String id = null; + @SerializedName("type") + private TypeEnum type = null; - @SerializedName("locale") - private String locale = null; + @SerializedName("vaultingInfo") + private VaultingInfo vaultingInfo = null; - @SerializedName("mergeFieldInfo") - private List mergeFieldInfo = null; + @SerializedName("securityOption") + private SecurityOption securityOption = null; - @SerializedName("message") - private String message = null; + @SerializedName("postSignOption") + private PostSignOption postSignOption = null; - @SerializedName("name") - private String name = null; + @SerializedName("ccs") + private List ccs = null; - @SerializedName("participantSetsInfo") - private List participantSetsInfo = null; + @SerializedName("documentVisibilityEnabled") + private Boolean documentVisibilityEnabled = null; - @SerializedName("postSignOption") - private PostSignOption postSignOption = null; + @SerializedName("isDocumentRetentionApplied") + private Boolean isDocumentRetentionApplied = null; + + @SerializedName("hasSignerIdentityReport") + private Boolean hasSignerIdentityReport = null; + + @SerializedName("lastEventDate") + private Date lastEventDate = null; + + @SerializedName("senderEmail") + private String senderEmail = null; + + @SerializedName("id") + private String id = null; /** - * Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used. Should not be provided in offline agreement creation. If provided in PUT as a different value than the current one, an error will be thrown. + * The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID */ - @JsonAdapter(ReminderFrequencyEnum.Adapter.class) - public enum ReminderFrequencyEnum { - DAILY_UNTIL_SIGNED("DAILY_UNTIL_SIGNED"), - - WEEKDAILY_UNTIL_SIGNED("WEEKDAILY_UNTIL_SIGNED"), - - EVERY_OTHER_DAY_UNTIL_SIGNED("EVERY_OTHER_DAY_UNTIL_SIGNED"), - - EVERY_THIRD_DAY_UNTIL_SIGNED("EVERY_THIRD_DAY_UNTIL_SIGNED"), - - EVERY_FIFTH_DAY_UNTIL_SIGNED("EVERY_FIFTH_DAY_UNTIL_SIGNED"), + @JsonAdapter(StateEnum.Adapter.class) + public enum StateEnum { + AUTHORING("AUTHORING"), - WEEKLY_UNTIL_SIGNED("WEEKLY_UNTIL_SIGNED"), + DRAFT("DRAFT"), - ONCE("ONCE"); + IN_PROCESS("IN_PROCESS"); private String value; - ReminderFrequencyEnum(String value) { + StateEnum(String value) { this.value = value; } @@ -141,8 +155,8 @@ public String toString() { return String.valueOf(value); } - public static ReminderFrequencyEnum fromValue(String text) { - for (ReminderFrequencyEnum b : ReminderFrequencyEnum.values()) { + public static StateEnum fromValue(String text) { + for (StateEnum b : StateEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -150,28 +164,31 @@ public static ReminderFrequencyEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final ReminderFrequencyEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public ReminderFrequencyEnum read(final JsonReader jsonReader) throws IOException { + public StateEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return ReminderFrequencyEnum.fromValue(String.valueOf(value)); + return StateEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("reminderFrequency") - private ReminderFrequencyEnum reminderFrequency = null; + @SerializedName("state") + private StateEnum state = null; - @SerializedName("securityOption") - private SecurityOption securityOption = null; + @SerializedName("mergeFieldInfo") + private List mergeFieldInfo = null; - @SerializedName("senderEmail") - private String senderEmail = null; + @SerializedName("firstReminderDelay") + private Integer firstReminderDelay = null; + + @SerializedName("emailOption") + private EmailOption emailOption = null; /** * Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system @@ -223,20 +240,40 @@ public SignatureTypeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("signatureType") private SignatureTypeEnum signatureType = null; + @SerializedName("externalId") + private ExternalId externalId = null; + + @SerializedName("message") + private String message = null; + + @SerializedName("deviceInfo") + private OfflineDeviceInfo deviceInfo = null; + + @SerializedName("parentId") + private String parentId = null; + /** - * The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID + * Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used. Should not be provided in offline agreement creation. If provided in PUT as a different value than the current one, an error will be thrown. */ - @JsonAdapter(StateEnum.Adapter.class) - public enum StateEnum { - AUTHORING("AUTHORING"), + @JsonAdapter(ReminderFrequencyEnum.Adapter.class) + public enum ReminderFrequencyEnum { + DAILY_UNTIL_SIGNED("DAILY_UNTIL_SIGNED"), - DRAFT("DRAFT"), + WEEKDAILY_UNTIL_SIGNED("WEEKDAILY_UNTIL_SIGNED"), - IN_PROCESS("IN_PROCESS"); + EVERY_OTHER_DAY_UNTIL_SIGNED("EVERY_OTHER_DAY_UNTIL_SIGNED"), + + EVERY_THIRD_DAY_UNTIL_SIGNED("EVERY_THIRD_DAY_UNTIL_SIGNED"), + + EVERY_FIFTH_DAY_UNTIL_SIGNED("EVERY_FIFTH_DAY_UNTIL_SIGNED"), + + WEEKLY_UNTIL_SIGNED("WEEKLY_UNTIL_SIGNED"), + + ONCE("ONCE"); private String value; - StateEnum(String value) { + ReminderFrequencyEnum(String value) { this.value = value; } @@ -249,8 +286,8 @@ public String toString() { return String.valueOf(value); } - public static StateEnum fromValue(String text) { - for (StateEnum b : StateEnum.values()) { + public static ReminderFrequencyEnum fromValue(String text) { + for (ReminderFrequencyEnum b : ReminderFrequencyEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -258,22 +295,46 @@ public static StateEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final ReminderFrequencyEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public StateEnum read(final JsonReader jsonReader) throws IOException { + public ReminderFrequencyEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return StateEnum.fromValue(String.valueOf(value)); + return ReminderFrequencyEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("state") - private StateEnum state = null; + @SerializedName("reminderFrequency") + private ReminderFrequencyEnum reminderFrequency = null; + + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("participantSetsInfo") + private List participantSetsInfo = null; + + @SerializedName("hasFormFieldData") + private Boolean hasFormFieldData = null; + + @SerializedName("expirationTime") + private Date expirationTime = null; + + @SerializedName("formFieldLayerTemplates") + private List formFieldLayerTemplates = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("fileInfos") + private List fileInfos = null; + + @SerializedName("workflowId") + private String workflowId = null; /** * This is a server generated attribute which provides the detailed status of an agreement. @@ -361,214 +422,228 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; - @SerializedName("vaultingInfo") - private VaultingInfo vaultingInfo = null; - - @SerializedName("workflowId") - private String workflowId = null; - - public AgreementCreationInfo ccs(List ccs) { - this.ccs = ccs; - return this; - } - - public AgreementCreationInfo addCcsItem(AgreementCcInfo ccsItem) { - if (this.ccs == null) { - this.ccs = new ArrayList(); - } - this.ccs.add(ccsItem); + public AgreementCreationInfo groupId(String groupId) { + this.groupId = groupId; return this; } /** - * A list of one or more CCs that will be copied in the agreement transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file. Should not be provided in offline agreement creation. - * @return ccs + * The unique identifier of the group to which the agreement belongs to. If not provided during agreement creation, primary group of the creator will be used + * @return groupId **/ - @ApiModelProperty(value = "A list of one or more CCs that will be copied in the agreement transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file. Should not be provided in offline agreement creation.") - public List getCcs() { - return ccs; + @ApiModelProperty(value = "The unique identifier of the group to which the agreement belongs to. If not provided during agreement creation, primary group of the creator will be used") + public String getGroupId() { + return groupId; } - public void setCcs(List ccs) { - this.ccs = ccs; + public void setGroupId(String groupId) { + this.groupId = groupId; } - public AgreementCreationInfo createdDate(Date createdDate) { - this.createdDate = createdDate; + public AgreementCreationInfo locale(String locale) { + this.locale = locale; return this; } /** - * Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time - * @return createdDate + * The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender + * @return locale **/ - @ApiModelProperty(value = "Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") - public Date getCreatedDate() { - return createdDate; + @ApiModelProperty(value = "The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender") + public String getLocale() { + return locale; } - public void setCreatedDate(Date createdDate) { - this.createdDate = createdDate; + public void setLocale(String locale) { + this.locale = locale; } - public AgreementCreationInfo deviceInfo(OfflineDeviceInfo deviceInfo) { - this.deviceInfo = deviceInfo; + public AgreementCreationInfo type(TypeEnum type) { + this.type = type; return this; } /** - * Device info of the offline device. It should only be provided in case of offline agreement creation. - * @return deviceInfo + * The kind of agreement + * @return type **/ - @ApiModelProperty(value = "Device info of the offline device. It should only be provided in case of offline agreement creation.") - public OfflineDeviceInfo getDeviceInfo() { - return deviceInfo; + @ApiModelProperty(value = "The kind of agreement") + public TypeEnum getType() { + return type; } - public void setDeviceInfo(OfflineDeviceInfo deviceInfo) { - this.deviceInfo = deviceInfo; + public void setType(TypeEnum type) { + this.type = type; } - public AgreementCreationInfo documentVisibilityEnabled(Boolean documentVisibilityEnabled) { - this.documentVisibilityEnabled = documentVisibilityEnabled; + public AgreementCreationInfo vaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; return this; } /** - * If set to true, enable limited document visibility. Should not be provided in offline agreement creation. - * @return documentVisibilityEnabled + * Vaulting properties that allows Adobe Sign to securely store documents with a vault provider + * @return vaultingInfo **/ - @ApiModelProperty(value = "If set to true, enable limited document visibility. Should not be provided in offline agreement creation.") - public Boolean isDocumentVisibilityEnabled() { - return documentVisibilityEnabled; + @ApiModelProperty(value = "Vaulting properties that allows Adobe Sign to securely store documents with a vault provider") + public VaultingInfo getVaultingInfo() { + return vaultingInfo; } - public void setDocumentVisibilityEnabled(Boolean documentVisibilityEnabled) { - this.documentVisibilityEnabled = documentVisibilityEnabled; + public void setVaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; } - public AgreementCreationInfo emailOption(EmailOption emailOption) { - this.emailOption = emailOption; + public AgreementCreationInfo securityOption(SecurityOption securityOption) { + this.securityOption = securityOption; return this; } /** - * Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement. - * @return emailOption + * Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation. + * @return securityOption **/ - @ApiModelProperty(value = "Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement.") - public EmailOption getEmailOption() { - return emailOption; + @ApiModelProperty(value = "Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation.") + public SecurityOption getSecurityOption() { + return securityOption; } - public void setEmailOption(EmailOption emailOption) { - this.emailOption = emailOption; + public void setSecurityOption(SecurityOption securityOption) { + this.securityOption = securityOption; } - public AgreementCreationInfo expirationTime(Date expirationTime) { - this.expirationTime = expirationTime; + public AgreementCreationInfo postSignOption(PostSignOption postSignOption) { + this.postSignOption = postSignOption; return this; } /** - * Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. - * @return expirationTime + * URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation. + * @return postSignOption **/ - @ApiModelProperty(value = "Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation.") - public Date getExpirationTime() { - return expirationTime; + @ApiModelProperty(value = "URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation.") + public PostSignOption getPostSignOption() { + return postSignOption; } - public void setExpirationTime(Date expirationTime) { - this.expirationTime = expirationTime; + public void setPostSignOption(PostSignOption postSignOption) { + this.postSignOption = postSignOption; } - public AgreementCreationInfo externalId(ExternalId externalId) { - this.externalId = externalId; + public AgreementCreationInfo ccs(List ccs) { + this.ccs = ccs; + return this; + } + + public AgreementCreationInfo addCcsItem(AgreementCcInfo ccsItem) { + if (this.ccs == null) { + this.ccs = new ArrayList(); + } + this.ccs.add(ccsItem); return this; } /** - * An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation. - * @return externalId + * A list of one or more CCs that will be copied in the agreement transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file. Should not be provided in offline agreement creation. + * @return ccs **/ - @ApiModelProperty(value = "An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation.") - public ExternalId getExternalId() { - return externalId; + @ApiModelProperty(value = "A list of one or more CCs that will be copied in the agreement transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file. Should not be provided in offline agreement creation.") + public List getCcs() { + return ccs; } - public void setExternalId(ExternalId externalId) { - this.externalId = externalId; + public void setCcs(List ccs) { + this.ccs = ccs; } - public AgreementCreationInfo fileInfos(List fileInfos) { - this.fileInfos = fileInfos; + public AgreementCreationInfo documentVisibilityEnabled(Boolean documentVisibilityEnabled) { + this.documentVisibilityEnabled = documentVisibilityEnabled; return this; } - public AgreementCreationInfo addFileInfosItem(FileInfo fileInfosItem) { - if (this.fileInfos == null) { - this.fileInfos = new ArrayList(); - } - this.fileInfos.add(fileInfosItem); + /** + * If set to true, enable limited document visibility. Should not be provided in offline agreement creation. + * @return documentVisibilityEnabled + **/ + @ApiModelProperty(value = "If set to true, enable limited document visibility. Should not be provided in offline agreement creation.") + public Boolean isDocumentVisibilityEnabled() { + return documentVisibilityEnabled; + } + + public void setDocumentVisibilityEnabled(Boolean documentVisibilityEnabled) { + this.documentVisibilityEnabled = documentVisibilityEnabled; + } + + public AgreementCreationInfo isDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; return this; } /** - * A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified - * @return fileInfos + * Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. + * @return isDocumentRetentionApplied **/ - @ApiModelProperty(value = "A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified") - public List getFileInfos() { - return fileInfos; + @ApiModelProperty(value = "Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored.") + public Boolean isIsDocumentRetentionApplied() { + return isDocumentRetentionApplied; } - public void setFileInfos(List fileInfos) { - this.fileInfos = fileInfos; + public void setIsDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; } - public AgreementCreationInfo firstReminderDelay(Integer firstReminderDelay) { - this.firstReminderDelay = firstReminderDelay; + public AgreementCreationInfo hasSignerIdentityReport(Boolean hasSignerIdentityReport) { + this.hasSignerIdentityReport = hasSignerIdentityReport; return this; } /** - * Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation. - * @return firstReminderDelay + * True if agreement has signer identity report available. If provided in POST or PUT, it will simply be ignored. + * @return hasSignerIdentityReport **/ - @ApiModelProperty(value = "Integer which specifies the delay in hours before sending the first reminder.
This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.
If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.
i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation.") - public Integer getFirstReminderDelay() { - return firstReminderDelay; + @ApiModelProperty(value = "True if agreement has signer identity report available. If provided in POST or PUT, it will simply be ignored.") + public Boolean isHasSignerIdentityReport() { + return hasSignerIdentityReport; } - public void setFirstReminderDelay(Integer firstReminderDelay) { - this.firstReminderDelay = firstReminderDelay; + public void setHasSignerIdentityReport(Boolean hasSignerIdentityReport) { + this.hasSignerIdentityReport = hasSignerIdentityReport; } - public AgreementCreationInfo formFieldLayerTemplates(List formFieldLayerTemplates) { - this.formFieldLayerTemplates = formFieldLayerTemplates; + public AgreementCreationInfo lastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; return this; } - public AgreementCreationInfo addFormFieldLayerTemplatesItem(FileInfo formFieldLayerTemplatesItem) { - if (this.formFieldLayerTemplates == null) { - this.formFieldLayerTemplates = new ArrayList(); - } - this.formFieldLayerTemplates.add(formFieldLayerTemplatesItem); + /** + * The date of the last event that occurred for this agreement. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return lastEventDate + **/ + @ApiModelProperty(value = "The date of the last event that occurred for this agreement. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getLastEventDate() { + return lastEventDate; + } + + public void setLastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; + } + + public AgreementCreationInfo senderEmail(String senderEmail) { + this.senderEmail = senderEmail; return this; } /** - * Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified - * @return formFieldLayerTemplates + * Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored + * @return senderEmail **/ - @ApiModelProperty(value = "Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified") - public List getFormFieldLayerTemplates() { - return formFieldLayerTemplates; + @ApiModelProperty(value = "Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored") + public String getSenderEmail() { + return senderEmail; } - public void setFormFieldLayerTemplates(List formFieldLayerTemplates) { - this.formFieldLayerTemplates = formFieldLayerTemplates; + public void setSenderEmail(String senderEmail) { + this.senderEmail = senderEmail; } public AgreementCreationInfo id(String id) { @@ -589,22 +664,22 @@ public void setId(String id) { this.id = id; } - public AgreementCreationInfo locale(String locale) { - this.locale = locale; + public AgreementCreationInfo state(StateEnum state) { + this.state = state; return this; } /** - * The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender - * @return locale + * The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID + * @return state **/ - @ApiModelProperty(value = "The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender") - public String getLocale() { - return locale; + @ApiModelProperty(value = "The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID") + public StateEnum getState() { + return state; } - public void setLocale(String locale) { - this.locale = locale; + public void setState(StateEnum state) { + this.state = state; } public AgreementCreationInfo mergeFieldInfo(List mergeFieldInfo) { @@ -633,84 +708,130 @@ public void setMergeFieldInfo(List mergeFieldInfo) { this.mergeFieldInfo = mergeFieldInfo; } - public AgreementCreationInfo message(String message) { - this.message = message; + public AgreementCreationInfo firstReminderDelay(Integer firstReminderDelay) { + this.firstReminderDelay = firstReminderDelay; return this; } /** - * An optional message to the participants, describing what is being sent or why their signature is required - * @return message + * Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation. + * @return firstReminderDelay **/ - @ApiModelProperty(value = "An optional message to the participants, describing what is being sent or why their signature is required") - public String getMessage() { - return message; + @ApiModelProperty(value = "Integer which specifies the delay in hours before sending the first reminder.
This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.
If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.
i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation.") + public Integer getFirstReminderDelay() { + return firstReminderDelay; } - public void setMessage(String message) { - this.message = message; + public void setFirstReminderDelay(Integer firstReminderDelay) { + this.firstReminderDelay = firstReminderDelay; } - public AgreementCreationInfo name(String name) { - this.name = name; + public AgreementCreationInfo emailOption(EmailOption emailOption) { + this.emailOption = emailOption; return this; } /** - * The name of the agreement that will be used to identify it, in emails, website and other places - * @return name + * Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement. + * @return emailOption **/ - @ApiModelProperty(value = "The name of the agreement that will be used to identify it, in emails, website and other places") - public String getName() { - return name; + @ApiModelProperty(value = "Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement.") + public EmailOption getEmailOption() { + return emailOption; } - public void setName(String name) { - this.name = name; + public void setEmailOption(EmailOption emailOption) { + this.emailOption = emailOption; } - public AgreementCreationInfo participantSetsInfo(List participantSetsInfo) { - this.participantSetsInfo = participantSetsInfo; + public AgreementCreationInfo signatureType(SignatureTypeEnum signatureType) { + this.signatureType = signatureType; return this; } - public AgreementCreationInfo addParticipantSetsInfoItem(ParticipantSetInfo participantSetsInfoItem) { - if (this.participantSetsInfo == null) { - this.participantSetsInfo = new ArrayList(); - } - this.participantSetsInfo.add(participantSetsInfoItem); + /** + * Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system + * @return signatureType + **/ + @ApiModelProperty(value = "Specifies the type of signature you would like to request - written or e-signature. The possible values are
ESIGN : Agreement needs to be signed electronically
, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system") + public SignatureTypeEnum getSignatureType() { + return signatureType; + } + + public void setSignatureType(SignatureTypeEnum signatureType) { + this.signatureType = signatureType; + } + + public AgreementCreationInfo externalId(ExternalId externalId) { + this.externalId = externalId; return this; } /** - * A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc ), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document - * @return participantSetsInfo + * An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation. + * @return externalId **/ - @ApiModelProperty(value = "A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc ), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document") - public List getParticipantSetsInfo() { - return participantSetsInfo; + @ApiModelProperty(value = "An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation.") + public ExternalId getExternalId() { + return externalId; } - public void setParticipantSetsInfo(List participantSetsInfo) { - this.participantSetsInfo = participantSetsInfo; + public void setExternalId(ExternalId externalId) { + this.externalId = externalId; } - public AgreementCreationInfo postSignOption(PostSignOption postSignOption) { - this.postSignOption = postSignOption; + public AgreementCreationInfo message(String message) { + this.message = message; return this; } /** - * URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation. - * @return postSignOption + * An optional message to the participants, describing what is being sent or why their signature is required + * @return message **/ - @ApiModelProperty(value = "URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation.") - public PostSignOption getPostSignOption() { - return postSignOption; + @ApiModelProperty(value = "An optional message to the participants, describing what is being sent or why their signature is required") + public String getMessage() { + return message; } - public void setPostSignOption(PostSignOption postSignOption) { - this.postSignOption = postSignOption; + public void setMessage(String message) { + this.message = message; + } + + public AgreementCreationInfo deviceInfo(OfflineDeviceInfo deviceInfo) { + this.deviceInfo = deviceInfo; + return this; + } + + /** + * Device info of the offline device. It should only be provided in case of offline agreement creation. + * @return deviceInfo + **/ + @ApiModelProperty(value = "Device info of the offline device. It should only be provided in case of offline agreement creation.") + public OfflineDeviceInfo getDeviceInfo() { + return deviceInfo; + } + + public void setDeviceInfo(OfflineDeviceInfo deviceInfo) { + this.deviceInfo = deviceInfo; + } + + public AgreementCreationInfo parentId(String parentId) { + this.parentId = parentId; + return this; + } + + /** + * The parent id of a megaSign child *OR* the originating id of a widget agreement instance + * @return parentId + **/ + @ApiModelProperty(value = "The parent id of a megaSign child *OR* the originating id of a widget agreement instance") + public String getParentId() { + return parentId; + } + + public void setParentId(String parentId) { + this.parentId = parentId; } public AgreementCreationInfo reminderFrequency(ReminderFrequencyEnum reminderFrequency) { @@ -731,112 +852,154 @@ public void setReminderFrequency(ReminderFrequencyEnum reminderFrequency) { this.reminderFrequency = reminderFrequency; } - public AgreementCreationInfo securityOption(SecurityOption securityOption) { - this.securityOption = securityOption; + public AgreementCreationInfo createdDate(Date createdDate) { + this.createdDate = createdDate; return this; } /** - * Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation. - * @return securityOption + * Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return createdDate **/ - @ApiModelProperty(value = "Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation.") - public SecurityOption getSecurityOption() { - return securityOption; + @ApiModelProperty(value = "Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getCreatedDate() { + return createdDate; } - public void setSecurityOption(SecurityOption securityOption) { - this.securityOption = securityOption; + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; } - public AgreementCreationInfo senderEmail(String senderEmail) { - this.senderEmail = senderEmail; + public AgreementCreationInfo participantSetsInfo(List participantSetsInfo) { + this.participantSetsInfo = participantSetsInfo; + return this; + } + + public AgreementCreationInfo addParticipantSetsInfoItem(ParticipantSetInfo participantSetsInfoItem) { + if (this.participantSetsInfo == null) { + this.participantSetsInfo = new ArrayList(); + } + this.participantSetsInfo.add(participantSetsInfoItem); return this; } /** - * Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored - * @return senderEmail + * A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document + * @return participantSetsInfo **/ - @ApiModelProperty(value = "Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored") - public String getSenderEmail() { - return senderEmail; + @ApiModelProperty(value = "A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document") + public List getParticipantSetsInfo() { + return participantSetsInfo; } - public void setSenderEmail(String senderEmail) { - this.senderEmail = senderEmail; + public void setParticipantSetsInfo(List participantSetsInfo) { + this.participantSetsInfo = participantSetsInfo; } - public AgreementCreationInfo signatureType(SignatureTypeEnum signatureType) { - this.signatureType = signatureType; + public AgreementCreationInfo hasFormFieldData(Boolean hasFormFieldData) { + this.hasFormFieldData = hasFormFieldData; return this; } /** - * Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system - * @return signatureType + * True if form field data is present. If provided in POST or PUT, it will simply be ignored. + * @return hasFormFieldData **/ - @ApiModelProperty(value = "Specifies the type of signature you would like to request - written or e-signature. The possible values are
ESIGN : Agreement needs to be signed electronically
, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system") - public SignatureTypeEnum getSignatureType() { - return signatureType; + @ApiModelProperty(value = "True if form field data is present. If provided in POST or PUT, it will simply be ignored.") + public Boolean isHasFormFieldData() { + return hasFormFieldData; } - public void setSignatureType(SignatureTypeEnum signatureType) { - this.signatureType = signatureType; + public void setHasFormFieldData(Boolean hasFormFieldData) { + this.hasFormFieldData = hasFormFieldData; } - public AgreementCreationInfo state(StateEnum state) { - this.state = state; + public AgreementCreationInfo expirationTime(Date expirationTime) { + this.expirationTime = expirationTime; return this; } /** - * The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID - * @return state + * Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. + * @return expirationTime **/ - @ApiModelProperty(value = "The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID") - public StateEnum getState() { - return state; + @ApiModelProperty(value = "Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation.") + public Date getExpirationTime() { + return expirationTime; } - public void setState(StateEnum state) { - this.state = state; + public void setExpirationTime(Date expirationTime) { + this.expirationTime = expirationTime; } - public AgreementCreationInfo status(StatusEnum status) { - this.status = status; + public AgreementCreationInfo formFieldLayerTemplates(List formFieldLayerTemplates) { + this.formFieldLayerTemplates = formFieldLayerTemplates; + return this; + } + + public AgreementCreationInfo addFormFieldLayerTemplatesItem(FileInfo formFieldLayerTemplatesItem) { + if (this.formFieldLayerTemplates == null) { + this.formFieldLayerTemplates = new ArrayList(); + } + this.formFieldLayerTemplates.add(formFieldLayerTemplatesItem); return this; } /** - * This is a server generated attribute which provides the detailed status of an agreement. - * @return status + * Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified + * @return formFieldLayerTemplates **/ - @ApiModelProperty(value = "This is a server generated attribute which provides the detailed status of an agreement.") - public StatusEnum getStatus() { - return status; + @ApiModelProperty(value = "Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified") + public List getFormFieldLayerTemplates() { + return formFieldLayerTemplates; } - public void setStatus(StatusEnum status) { - this.status = status; + public void setFormFieldLayerTemplates(List formFieldLayerTemplates) { + this.formFieldLayerTemplates = formFieldLayerTemplates; } - public AgreementCreationInfo vaultingInfo(VaultingInfo vaultingInfo) { - this.vaultingInfo = vaultingInfo; + public AgreementCreationInfo name(String name) { + this.name = name; return this; } /** - * Vaulting properties that allows Adobe Sign to securely store documents with a vault provider - * @return vaultingInfo + * The name of the agreement that will be used to identify it, in emails, website and other places + * @return name **/ - @ApiModelProperty(value = "Vaulting properties that allows Adobe Sign to securely store documents with a vault provider") - public VaultingInfo getVaultingInfo() { - return vaultingInfo; + @ApiModelProperty(value = "The name of the agreement that will be used to identify it, in emails, website and other places") + public String getName() { + return name; } - public void setVaultingInfo(VaultingInfo vaultingInfo) { - this.vaultingInfo = vaultingInfo; + public void setName(String name) { + this.name = name; + } + + public AgreementCreationInfo fileInfos(List fileInfos) { + this.fileInfos = fileInfos; + return this; + } + + public AgreementCreationInfo addFileInfosItem(FileInfo fileInfosItem) { + if (this.fileInfos == null) { + this.fileInfos = new ArrayList(); + } + this.fileInfos.add(fileInfosItem); + return this; + } + + /** + * A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified + * @return fileInfos + **/ + @ApiModelProperty(value = "A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified") + public List getFileInfos() { + return fileInfos; + } + + public void setFileInfos(List fileInfos) { + this.fileInfos = fileInfos; } public AgreementCreationInfo workflowId(String workflowId) { @@ -857,6 +1020,24 @@ public void setWorkflowId(String workflowId) { this.workflowId = workflowId; } + public AgreementCreationInfo status(StatusEnum status) { + this.status = status; + return this; + } + + /** + * This is a server generated attribute which provides the detailed status of an agreement. + * @return status + **/ + @ApiModelProperty(value = "This is a server generated attribute which provides the detailed status of an agreement.") + public StatusEnum getStatus() { + return status; + } + + public void setStatus(StatusEnum status) { + this.status = status; + } + @Override public boolean equals(java.lang.Object o) { @@ -867,36 +1048,43 @@ public boolean equals(java.lang.Object o) { return false; } AgreementCreationInfo agreementCreationInfo = (AgreementCreationInfo) o; - return Objects.equals(this.ccs, agreementCreationInfo.ccs) && - Objects.equals(this.createdDate, agreementCreationInfo.createdDate) && - Objects.equals(this.deviceInfo, agreementCreationInfo.deviceInfo) && + return Objects.equals(this.groupId, agreementCreationInfo.groupId) && + Objects.equals(this.locale, agreementCreationInfo.locale) && + Objects.equals(this.type, agreementCreationInfo.type) && + Objects.equals(this.vaultingInfo, agreementCreationInfo.vaultingInfo) && + Objects.equals(this.securityOption, agreementCreationInfo.securityOption) && + Objects.equals(this.postSignOption, agreementCreationInfo.postSignOption) && + Objects.equals(this.ccs, agreementCreationInfo.ccs) && Objects.equals(this.documentVisibilityEnabled, agreementCreationInfo.documentVisibilityEnabled) && - Objects.equals(this.emailOption, agreementCreationInfo.emailOption) && - Objects.equals(this.expirationTime, agreementCreationInfo.expirationTime) && - Objects.equals(this.externalId, agreementCreationInfo.externalId) && - Objects.equals(this.fileInfos, agreementCreationInfo.fileInfos) && - Objects.equals(this.firstReminderDelay, agreementCreationInfo.firstReminderDelay) && - Objects.equals(this.formFieldLayerTemplates, agreementCreationInfo.formFieldLayerTemplates) && + Objects.equals(this.isDocumentRetentionApplied, agreementCreationInfo.isDocumentRetentionApplied) && + Objects.equals(this.hasSignerIdentityReport, agreementCreationInfo.hasSignerIdentityReport) && + Objects.equals(this.lastEventDate, agreementCreationInfo.lastEventDate) && + Objects.equals(this.senderEmail, agreementCreationInfo.senderEmail) && Objects.equals(this.id, agreementCreationInfo.id) && - Objects.equals(this.locale, agreementCreationInfo.locale) && + Objects.equals(this.state, agreementCreationInfo.state) && Objects.equals(this.mergeFieldInfo, agreementCreationInfo.mergeFieldInfo) && + Objects.equals(this.firstReminderDelay, agreementCreationInfo.firstReminderDelay) && + Objects.equals(this.emailOption, agreementCreationInfo.emailOption) && + Objects.equals(this.signatureType, agreementCreationInfo.signatureType) && + Objects.equals(this.externalId, agreementCreationInfo.externalId) && Objects.equals(this.message, agreementCreationInfo.message) && - Objects.equals(this.name, agreementCreationInfo.name) && - Objects.equals(this.participantSetsInfo, agreementCreationInfo.participantSetsInfo) && - Objects.equals(this.postSignOption, agreementCreationInfo.postSignOption) && + Objects.equals(this.deviceInfo, agreementCreationInfo.deviceInfo) && + Objects.equals(this.parentId, agreementCreationInfo.parentId) && Objects.equals(this.reminderFrequency, agreementCreationInfo.reminderFrequency) && - Objects.equals(this.securityOption, agreementCreationInfo.securityOption) && - Objects.equals(this.senderEmail, agreementCreationInfo.senderEmail) && - Objects.equals(this.signatureType, agreementCreationInfo.signatureType) && - Objects.equals(this.state, agreementCreationInfo.state) && - Objects.equals(this.status, agreementCreationInfo.status) && - Objects.equals(this.vaultingInfo, agreementCreationInfo.vaultingInfo) && - Objects.equals(this.workflowId, agreementCreationInfo.workflowId); + Objects.equals(this.createdDate, agreementCreationInfo.createdDate) && + Objects.equals(this.participantSetsInfo, agreementCreationInfo.participantSetsInfo) && + Objects.equals(this.hasFormFieldData, agreementCreationInfo.hasFormFieldData) && + Objects.equals(this.expirationTime, agreementCreationInfo.expirationTime) && + Objects.equals(this.formFieldLayerTemplates, agreementCreationInfo.formFieldLayerTemplates) && + Objects.equals(this.name, agreementCreationInfo.name) && + Objects.equals(this.fileInfos, agreementCreationInfo.fileInfos) && + Objects.equals(this.workflowId, agreementCreationInfo.workflowId) && + Objects.equals(this.status, agreementCreationInfo.status); } @Override public int hashCode() { - return Objects.hash(ccs, createdDate, deviceInfo, documentVisibilityEnabled, emailOption, expirationTime, externalId, fileInfos, firstReminderDelay, formFieldLayerTemplates, id, locale, mergeFieldInfo, message, name, participantSetsInfo, postSignOption, reminderFrequency, securityOption, senderEmail, signatureType, state, status, vaultingInfo, workflowId); + return Objects.hash(groupId, locale, type, vaultingInfo, securityOption, postSignOption, ccs, documentVisibilityEnabled, isDocumentRetentionApplied, hasSignerIdentityReport, lastEventDate, senderEmail, id, state, mergeFieldInfo, firstReminderDelay, emailOption, signatureType, externalId, message, deviceInfo, parentId, reminderFrequency, createdDate, participantSetsInfo, hasFormFieldData, expirationTime, formFieldLayerTemplates, name, fileInfos, workflowId, status); } @@ -905,31 +1093,38 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class AgreementCreationInfo {\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); + sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" vaultingInfo: ").append(toIndentedString(vaultingInfo)).append("\n"); + sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); + sb.append(" postSignOption: ").append(toIndentedString(postSignOption)).append("\n"); sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n"); - sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); - sb.append(" deviceInfo: ").append(toIndentedString(deviceInfo)).append("\n"); sb.append(" documentVisibilityEnabled: ").append(toIndentedString(documentVisibilityEnabled)).append("\n"); - sb.append(" emailOption: ").append(toIndentedString(emailOption)).append("\n"); - sb.append(" expirationTime: ").append(toIndentedString(expirationTime)).append("\n"); - sb.append(" externalId: ").append(toIndentedString(externalId)).append("\n"); - sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); - sb.append(" firstReminderDelay: ").append(toIndentedString(firstReminderDelay)).append("\n"); - sb.append(" formFieldLayerTemplates: ").append(toIndentedString(formFieldLayerTemplates)).append("\n"); + sb.append(" isDocumentRetentionApplied: ").append(toIndentedString(isDocumentRetentionApplied)).append("\n"); + sb.append(" hasSignerIdentityReport: ").append(toIndentedString(hasSignerIdentityReport)).append("\n"); + sb.append(" lastEventDate: ").append(toIndentedString(lastEventDate)).append("\n"); + sb.append(" senderEmail: ").append(toIndentedString(senderEmail)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); + sb.append(" state: ").append(toIndentedString(state)).append("\n"); sb.append(" mergeFieldInfo: ").append(toIndentedString(mergeFieldInfo)).append("\n"); + sb.append(" firstReminderDelay: ").append(toIndentedString(firstReminderDelay)).append("\n"); + sb.append(" emailOption: ").append(toIndentedString(emailOption)).append("\n"); + sb.append(" signatureType: ").append(toIndentedString(signatureType)).append("\n"); + sb.append(" externalId: ").append(toIndentedString(externalId)).append("\n"); sb.append(" message: ").append(toIndentedString(message)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" participantSetsInfo: ").append(toIndentedString(participantSetsInfo)).append("\n"); - sb.append(" postSignOption: ").append(toIndentedString(postSignOption)).append("\n"); + sb.append(" deviceInfo: ").append(toIndentedString(deviceInfo)).append("\n"); + sb.append(" parentId: ").append(toIndentedString(parentId)).append("\n"); sb.append(" reminderFrequency: ").append(toIndentedString(reminderFrequency)).append("\n"); - sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); - sb.append(" senderEmail: ").append(toIndentedString(senderEmail)).append("\n"); - sb.append(" signatureType: ").append(toIndentedString(signatureType)).append("\n"); - sb.append(" state: ").append(toIndentedString(state)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" vaultingInfo: ").append(toIndentedString(vaultingInfo)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" participantSetsInfo: ").append(toIndentedString(participantSetsInfo)).append("\n"); + sb.append(" hasFormFieldData: ").append(toIndentedString(hasFormFieldData)).append("\n"); + sb.append(" expirationTime: ").append(toIndentedString(expirationTime)).append("\n"); + sb.append(" formFieldLayerTemplates: ").append(toIndentedString(formFieldLayerTemplates)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); sb.append(" workflowId: ").append(toIndentedString(workflowId)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/AgreementCreationResponse.java b/src/main/java/io/swagger/client/model/agreements/AgreementCreationResponse.java index 7f344cb..082c362 100755 --- a/src/main/java/io/swagger/client/model/agreements/AgreementCreationResponse.java +++ b/src/main/java/io/swagger/client/model/agreements/AgreementCreationResponse.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,7 @@ * A JSON that contains both the id of the newly created agreement and URL / embedded code to direct the user to tne next step in the creation process. */ @ApiModel(description = "A JSON that contains both the id of the newly created agreement and URL / embedded code to direct the user to tne next step in the creation process.") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class AgreementCreationResponse { @SerializedName("id") private String id = null; diff --git a/src/main/java/io/swagger/client/model/agreements/AgreementDocumentImageUrlsInfo.java b/src/main/java/io/swagger/client/model/agreements/AgreementDocumentImageUrlsInfo.java index fe234bb..bc12e2e 100755 --- a/src/main/java/io/swagger/client/model/agreements/AgreementDocumentImageUrlsInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/AgreementDocumentImageUrlsInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,31 +29,13 @@ /** * AgreementDocumentImageUrlsInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class AgreementDocumentImageUrlsInfo { - @SerializedName("documentId") - private String documentId = null; - @SerializedName("documentImageUrlsList") private List documentImageUrlsList = null; - public AgreementDocumentImageUrlsInfo documentId(String documentId) { - this.documentId = documentId; - return this; - } - - /** - * Id of the document - * @return documentId - **/ - @ApiModelProperty(value = "Id of the document") - public String getDocumentId() { - return documentId; - } - - public void setDocumentId(String documentId) { - this.documentId = documentId; - } + @SerializedName("documentId") + private String documentId = null; public AgreementDocumentImageUrlsInfo documentImageUrlsList(List documentImageUrlsList) { this.documentImageUrlsList = documentImageUrlsList; @@ -96,6 +63,24 @@ public void setDocumentImageUrlsList(List documentImageUrlsLi this.documentImageUrlsList = documentImageUrlsList; } + public AgreementDocumentImageUrlsInfo documentId(String documentId) { + this.documentId = documentId; + return this; + } + + /** + * Id of the document + * @return documentId + **/ + @ApiModelProperty(value = "Id of the document") + public String getDocumentId() { + return documentId; + } + + public void setDocumentId(String documentId) { + this.documentId = documentId; + } + @Override public boolean equals(java.lang.Object o) { @@ -106,13 +91,13 @@ public boolean equals(java.lang.Object o) { return false; } AgreementDocumentImageUrlsInfo agreementDocumentImageUrlsInfo = (AgreementDocumentImageUrlsInfo) o; - return Objects.equals(this.documentId, agreementDocumentImageUrlsInfo.documentId) && - Objects.equals(this.documentImageUrlsList, agreementDocumentImageUrlsInfo.documentImageUrlsList); + return Objects.equals(this.documentImageUrlsList, agreementDocumentImageUrlsInfo.documentImageUrlsList) && + Objects.equals(this.documentId, agreementDocumentImageUrlsInfo.documentId); } @Override public int hashCode() { - return Objects.hash(documentId, documentImageUrlsList); + return Objects.hash(documentImageUrlsList, documentId); } @@ -121,8 +106,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class AgreementDocumentImageUrlsInfo {\n"); - sb.append(" documentId: ").append(toIndentedString(documentId)).append("\n"); sb.append(" documentImageUrlsList: ").append(toIndentedString(documentImageUrlsList)).append("\n"); + sb.append(" documentId: ").append(toIndentedString(documentId)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/AgreementDocuments.java b/src/main/java/io/swagger/client/model/agreements/AgreementDocuments.java index a1f9670..357934d 100755 --- a/src/main/java/io/swagger/client/model/agreements/AgreementDocuments.java +++ b/src/main/java/io/swagger/client/model/agreements/AgreementDocuments.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,7 +30,7 @@ /** * AgreementDocuments */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class AgreementDocuments { @SerializedName("documents") private List documents = null; diff --git a/src/main/java/io/swagger/client/model/agreements/AgreementEvent.java b/src/main/java/io/swagger/client/model/agreements/AgreementEvent.java index 8003287..7b8812e 100755 --- a/src/main/java/io/swagger/client/model/agreements/AgreementEvent.java +++ b/src/main/java/io/swagger/client/model/agreements/AgreementEvent.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,120 +29,26 @@ /** * AgreementEvent */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class AgreementEvent { - @SerializedName("actingUserEmail") - private String actingUserEmail = null; - - @SerializedName("actingUserIpAddress") - private String actingUserIpAddress = null; - - @SerializedName("actingUserName") - private String actingUserName = null; - - @SerializedName("comment") - private String comment = null; - @SerializedName("date") private Date date = null; + @SerializedName("initiatingUserName") + private String initiatingUserName = null; + @SerializedName("description") private String description = null; - @SerializedName("deviceLocation") - private DeviceLocation deviceLocation = null; - - @SerializedName("devicePhoneNumber") - private String devicePhoneNumber = null; - - @SerializedName("digitalSignatureInfo") - private DigitalSignatureInfo digitalSignatureInfo = null; - - @SerializedName("initiatingUserEmail") - private String initiatingUserEmail = null; + @SerializedName("actingUserName") + private String actingUserName = null; - @SerializedName("initiatingUserName") - private String initiatingUserName = null; + @SerializedName("actingUserIpAddress") + private String actingUserIpAddress = null; @SerializedName("participantEmail") private String participantEmail = null; - @SerializedName("participantId") - private String participantId = null; - - /** - * Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). - */ - @JsonAdapter(ParticipantRoleEnum.Adapter.class) - public enum ParticipantRoleEnum { - SIGNER("SIGNER"), - - DELEGATE_TO_SIGNER("DELEGATE_TO_SIGNER"), - - APPROVER("APPROVER"), - - DELEGATE_TO_APPROVER("DELEGATE_TO_APPROVER"), - - ACCEPTOR("ACCEPTOR"), - - DELEGATE_TO_ACCEPTOR("DELEGATE_TO_ACCEPTOR"), - - FORM_FILLER("FORM_FILLER"), - - DELEGATE_TO_FORM_FILLER("DELEGATE_TO_FORM_FILLER"), - - CERTIFIED_RECIPIENT("CERTIFIED_RECIPIENT"), - - DELEGATE_TO_CERTIFIED_RECIPIENT("DELEGATE_TO_CERTIFIED_RECIPIENT"), - - SHARE("SHARE"), - - SENDER("SENDER"); - - private String value; - - ParticipantRoleEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static ParticipantRoleEnum fromValue(String text) { - for (ParticipantRoleEnum b : ParticipantRoleEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final ParticipantRoleEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public ParticipantRoleEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return ParticipantRoleEnum.fromValue(String.valueOf(value)); - } - } - } - - @SerializedName("participantRole") - private ParticipantRoleEnum participantRole = null; - - @SerializedName("synchronizationId") - private String synchronizationId = null; - /** * Type of agreement event */ @@ -261,6 +152,8 @@ public enum TypeEnum { USER_ACK_AGREEMENT_MODIFIED("USER_ACK_AGREEMENT_MODIFIED"), + READY_TO_VAULT("READY_TO_VAULT"), + VAULTED("VAULTED"), WEB_IDENTITY_AUTHENTICATED("WEB_IDENTITY_AUTHENTICATED"), @@ -312,61 +205,176 @@ public TypeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("type") private TypeEnum type = null; + /** + * Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). + */ + @JsonAdapter(ParticipantRoleEnum.Adapter.class) + public enum ParticipantRoleEnum { + SIGNER("SIGNER"), + + DELEGATE_TO_SIGNER("DELEGATE_TO_SIGNER"), + + APPROVER("APPROVER"), + + DELEGATE_TO_APPROVER("DELEGATE_TO_APPROVER"), + + ACCEPTOR("ACCEPTOR"), + + DELEGATE_TO_ACCEPTOR("DELEGATE_TO_ACCEPTOR"), + + FORM_FILLER("FORM_FILLER"), + + DELEGATE_TO_FORM_FILLER("DELEGATE_TO_FORM_FILLER"), + + CERTIFIED_RECIPIENT("CERTIFIED_RECIPIENT"), + + DELEGATE_TO_CERTIFIED_RECIPIENT("DELEGATE_TO_CERTIFIED_RECIPIENT"), + + SHARE("SHARE"), + + SENDER("SENDER"); + + private String value; + + ParticipantRoleEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ParticipantRoleEnum fromValue(String text) { + for (ParticipantRoleEnum b : ParticipantRoleEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ParticipantRoleEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ParticipantRoleEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ParticipantRoleEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("participantRole") + private ParticipantRoleEnum participantRole = null; + @SerializedName("vaultEventId") private String vaultEventId = null; - @SerializedName("vaultProviderName") - private String vaultProviderName = null; + @SerializedName("participantId") + private String participantId = null; @SerializedName("versionId") private String versionId = null; - public AgreementEvent actingUserEmail(String actingUserEmail) { - this.actingUserEmail = actingUserEmail; + @SerializedName("actingUserEmail") + private String actingUserEmail = null; + + @SerializedName("devicePhoneNumber") + private String devicePhoneNumber = null; + + @SerializedName("initiatingUserEmail") + private String initiatingUserEmail = null; + + @SerializedName("digitalSignatureInfo") + private DigitalSignatureInfo digitalSignatureInfo = null; + + @SerializedName("vaultProviderName") + private String vaultProviderName = null; + + @SerializedName("comment") + private String comment = null; + + @SerializedName("id") + private String id = null; + + @SerializedName("synchronizationId") + private String synchronizationId = null; + + @SerializedName("deviceLocation") + private DeviceLocation deviceLocation = null; + + public AgreementEvent date(Date date) { + this.date = date; return this; } /** - * Email address of the user that created the event - * @return actingUserEmail + * The date of the audit event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return date **/ - @ApiModelProperty(value = "Email address of the user that created the event") - public String getActingUserEmail() { - return actingUserEmail; + @ApiModelProperty(value = "The date of the audit event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getDate() { + return date; } - public void setActingUserEmail(String actingUserEmail) { - this.actingUserEmail = actingUserEmail; + public void setDate(Date date) { + this.date = date; } - public AgreementEvent actingUserIpAddress(String actingUserIpAddress) { - this.actingUserIpAddress = actingUserIpAddress; + public AgreementEvent initiatingUserName(String initiatingUserName) { + this.initiatingUserName = initiatingUserName; return this; } /** - * The IP address of the user that created the event - * @return actingUserIpAddress + * Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect + * @return initiatingUserName **/ - @ApiModelProperty(value = "The IP address of the user that created the event") - public String getActingUserIpAddress() { - return actingUserIpAddress; + @ApiModelProperty(value = "Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect") + public String getInitiatingUserName() { + return initiatingUserName; } - public void setActingUserIpAddress(String actingUserIpAddress) { - this.actingUserIpAddress = actingUserIpAddress; + public void setInitiatingUserName(String initiatingUserName) { + this.initiatingUserName = initiatingUserName; } - public AgreementEvent actingUserName(String actingUserName) { - this.actingUserName = actingUserName; + public AgreementEvent description(String description) { + this.description = description; return this; } /** - * The name of the acting user - * @return actingUserName + * A description of the audit event + * @return description **/ - @ApiModelProperty(value = "The name of the acting user") + @ApiModelProperty(value = "A description of the audit event") + public String getDescription() { + return description; + } + + public void setDescription(String description) { + this.description = description; + } + + public AgreementEvent actingUserName(String actingUserName) { + this.actingUserName = actingUserName; + return this; + } + + /** + * The name of the acting user + * @return actingUserName + **/ + @ApiModelProperty(value = "The name of the acting user") public String getActingUserName() { return actingUserName; } @@ -375,292 +383,292 @@ public void setActingUserName(String actingUserName) { this.actingUserName = actingUserName; } - public AgreementEvent comment(String comment) { - this.comment = comment; + public AgreementEvent actingUserIpAddress(String actingUserIpAddress) { + this.actingUserIpAddress = actingUserIpAddress; return this; } /** - * The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant - * @return comment + * The IP address of the user that created the event + * @return actingUserIpAddress **/ - @ApiModelProperty(value = "The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant") - public String getComment() { - return comment; + @ApiModelProperty(value = "The IP address of the user that created the event") + public String getActingUserIpAddress() { + return actingUserIpAddress; } - public void setComment(String comment) { - this.comment = comment; + public void setActingUserIpAddress(String actingUserIpAddress) { + this.actingUserIpAddress = actingUserIpAddress; } - public AgreementEvent date(Date date) { - this.date = date; + public AgreementEvent participantEmail(String participantEmail) { + this.participantEmail = participantEmail; return this; } /** - * The date of the audit event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time - * @return date + * Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to + * @return participantEmail **/ - @ApiModelProperty(value = "The date of the audit event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") - public Date getDate() { - return date; + @ApiModelProperty(value = "Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to") + public String getParticipantEmail() { + return participantEmail; } - public void setDate(Date date) { - this.date = date; + public void setParticipantEmail(String participantEmail) { + this.participantEmail = participantEmail; } - public AgreementEvent description(String description) { - this.description = description; + public AgreementEvent type(TypeEnum type) { + this.type = type; return this; } /** - * A description of the audit event - * @return description + * Type of agreement event + * @return type **/ - @ApiModelProperty(value = "A description of the audit event") - public String getDescription() { - return description; + @ApiModelProperty(value = "Type of agreement event") + public TypeEnum getType() { + return type; } - public void setDescription(String description) { - this.description = description; + public void setType(TypeEnum type) { + this.type = type; } - public AgreementEvent deviceLocation(DeviceLocation deviceLocation) { - this.deviceLocation = deviceLocation; + public AgreementEvent participantRole(ParticipantRoleEnum participantRole) { + this.participantRole = participantRole; return this; } /** - * Location of the device that generated the event (This value may be null due to limited privileges) - * @return deviceLocation + * Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). + * @return participantRole **/ - @ApiModelProperty(value = "Location of the device that generated the event (This value may be null due to limited privileges)") - public DeviceLocation getDeviceLocation() { - return deviceLocation; + @ApiModelProperty(value = "Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.).") + public ParticipantRoleEnum getParticipantRole() { + return participantRole; } - public void setDeviceLocation(DeviceLocation deviceLocation) { - this.deviceLocation = deviceLocation; + public void setParticipantRole(ParticipantRoleEnum participantRole) { + this.participantRole = participantRole; } - public AgreementEvent devicePhoneNumber(String devicePhoneNumber) { - this.devicePhoneNumber = devicePhoneNumber; + public AgreementEvent vaultEventId(String vaultEventId) { + this.vaultEventId = vaultEventId; return this; } /** - * Phone number from the device used when the participation is completed on a mobile phone - * @return devicePhoneNumber + * The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null) + * @return vaultEventId **/ - @ApiModelProperty(value = "Phone number from the device used when the participation is completed on a mobile phone") - public String getDevicePhoneNumber() { - return devicePhoneNumber; + @ApiModelProperty(value = "The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null)") + public String getVaultEventId() { + return vaultEventId; } - public void setDevicePhoneNumber(String devicePhoneNumber) { - this.devicePhoneNumber = devicePhoneNumber; + public void setVaultEventId(String vaultEventId) { + this.vaultEventId = vaultEventId; } - public AgreementEvent digitalSignatureInfo(DigitalSignatureInfo digitalSignatureInfo) { - this.digitalSignatureInfo = digitalSignatureInfo; + public AgreementEvent participantId(String participantId) { + this.participantId = participantId; return this; } /** - * This is present for ESIGNED events when the participation is signed digitally - * @return digitalSignatureInfo + * The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to + * @return participantId **/ - @ApiModelProperty(value = "This is present for ESIGNED events when the participation is signed digitally") - public DigitalSignatureInfo getDigitalSignatureInfo() { - return digitalSignatureInfo; + @ApiModelProperty(value = "The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to") + public String getParticipantId() { + return participantId; } - public void setDigitalSignatureInfo(DigitalSignatureInfo digitalSignatureInfo) { - this.digitalSignatureInfo = digitalSignatureInfo; + public void setParticipantId(String participantId) { + this.participantId = participantId; } - public AgreementEvent initiatingUserEmail(String initiatingUserEmail) { - this.initiatingUserEmail = initiatingUserEmail; + public AgreementEvent versionId(String versionId) { + this.versionId = versionId; return this; } /** - * Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect - * @return initiatingUserEmail + * An ID which uniquely identifies the version of the document associated with this audit event + * @return versionId **/ - @ApiModelProperty(value = "Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect") - public String getInitiatingUserEmail() { - return initiatingUserEmail; + @ApiModelProperty(value = "An ID which uniquely identifies the version of the document associated with this audit event") + public String getVersionId() { + return versionId; } - public void setInitiatingUserEmail(String initiatingUserEmail) { - this.initiatingUserEmail = initiatingUserEmail; + public void setVersionId(String versionId) { + this.versionId = versionId; } - public AgreementEvent initiatingUserName(String initiatingUserName) { - this.initiatingUserName = initiatingUserName; + public AgreementEvent actingUserEmail(String actingUserEmail) { + this.actingUserEmail = actingUserEmail; return this; } /** - * Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect - * @return initiatingUserName + * Email address of the user that created the event + * @return actingUserEmail **/ - @ApiModelProperty(value = "Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect") - public String getInitiatingUserName() { - return initiatingUserName; + @ApiModelProperty(value = "Email address of the user that created the event") + public String getActingUserEmail() { + return actingUserEmail; } - public void setInitiatingUserName(String initiatingUserName) { - this.initiatingUserName = initiatingUserName; + public void setActingUserEmail(String actingUserEmail) { + this.actingUserEmail = actingUserEmail; } - public AgreementEvent participantEmail(String participantEmail) { - this.participantEmail = participantEmail; + public AgreementEvent devicePhoneNumber(String devicePhoneNumber) { + this.devicePhoneNumber = devicePhoneNumber; return this; } /** - * Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to - * @return participantEmail + * Phone number from the device used when the participation is completed on a mobile phone + * @return devicePhoneNumber **/ - @ApiModelProperty(value = "Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to") - public String getParticipantEmail() { - return participantEmail; + @ApiModelProperty(value = "Phone number from the device used when the participation is completed on a mobile phone") + public String getDevicePhoneNumber() { + return devicePhoneNumber; } - public void setParticipantEmail(String participantEmail) { - this.participantEmail = participantEmail; + public void setDevicePhoneNumber(String devicePhoneNumber) { + this.devicePhoneNumber = devicePhoneNumber; } - public AgreementEvent participantId(String participantId) { - this.participantId = participantId; + public AgreementEvent initiatingUserEmail(String initiatingUserEmail) { + this.initiatingUserEmail = initiatingUserEmail; return this; } /** - * The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to - * @return participantId + * Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect + * @return initiatingUserEmail **/ - @ApiModelProperty(value = "The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to") - public String getParticipantId() { - return participantId; + @ApiModelProperty(value = "Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect") + public String getInitiatingUserEmail() { + return initiatingUserEmail; } - public void setParticipantId(String participantId) { - this.participantId = participantId; + public void setInitiatingUserEmail(String initiatingUserEmail) { + this.initiatingUserEmail = initiatingUserEmail; } - public AgreementEvent participantRole(ParticipantRoleEnum participantRole) { - this.participantRole = participantRole; + public AgreementEvent digitalSignatureInfo(DigitalSignatureInfo digitalSignatureInfo) { + this.digitalSignatureInfo = digitalSignatureInfo; return this; } /** - * Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). - * @return participantRole + * This is present for ESIGNED events when the participation is signed digitally + * @return digitalSignatureInfo **/ - @ApiModelProperty(value = "Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.).") - public ParticipantRoleEnum getParticipantRole() { - return participantRole; + @ApiModelProperty(value = "This is present for ESIGNED events when the participation is signed digitally") + public DigitalSignatureInfo getDigitalSignatureInfo() { + return digitalSignatureInfo; } - public void setParticipantRole(ParticipantRoleEnum participantRole) { - this.participantRole = participantRole; + public void setDigitalSignatureInfo(DigitalSignatureInfo digitalSignatureInfo) { + this.digitalSignatureInfo = digitalSignatureInfo; } - public AgreementEvent synchronizationId(String synchronizationId) { - this.synchronizationId = synchronizationId; + public AgreementEvent vaultProviderName(String vaultProviderName) { + this.vaultProviderName = vaultProviderName; return this; } /** - * A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null) - * @return synchronizationId + * Name of the vault provider for the vault event (if vaulted, otherwise null) + * @return vaultProviderName **/ - @ApiModelProperty(value = "A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null)") - public String getSynchronizationId() { - return synchronizationId; + @ApiModelProperty(value = "Name of the vault provider for the vault event (if vaulted, otherwise null)") + public String getVaultProviderName() { + return vaultProviderName; } - public void setSynchronizationId(String synchronizationId) { - this.synchronizationId = synchronizationId; + public void setVaultProviderName(String vaultProviderName) { + this.vaultProviderName = vaultProviderName; } - public AgreementEvent type(TypeEnum type) { - this.type = type; + public AgreementEvent comment(String comment) { + this.comment = comment; return this; } /** - * Type of agreement event - * @return type + * The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant + * @return comment **/ - @ApiModelProperty(value = "Type of agreement event") - public TypeEnum getType() { - return type; + @ApiModelProperty(value = "The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant") + public String getComment() { + return comment; } - public void setType(TypeEnum type) { - this.type = type; + public void setComment(String comment) { + this.comment = comment; } - public AgreementEvent vaultEventId(String vaultEventId) { - this.vaultEventId = vaultEventId; + public AgreementEvent id(String id) { + this.id = id; return this; } /** - * The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null) - * @return vaultEventId + * The identifier for the event. + * @return id **/ - @ApiModelProperty(value = "The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null)") - public String getVaultEventId() { - return vaultEventId; + @ApiModelProperty(value = "The identifier for the event.") + public String getId() { + return id; } - public void setVaultEventId(String vaultEventId) { - this.vaultEventId = vaultEventId; + public void setId(String id) { + this.id = id; } - public AgreementEvent vaultProviderName(String vaultProviderName) { - this.vaultProviderName = vaultProviderName; + public AgreementEvent synchronizationId(String synchronizationId) { + this.synchronizationId = synchronizationId; return this; } /** - * Name of the vault provider for the vault event (if vaulted, otherwise null) - * @return vaultProviderName + * A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null) + * @return synchronizationId **/ - @ApiModelProperty(value = "Name of the vault provider for the vault event (if vaulted, otherwise null)") - public String getVaultProviderName() { - return vaultProviderName; + @ApiModelProperty(value = "A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null)") + public String getSynchronizationId() { + return synchronizationId; } - public void setVaultProviderName(String vaultProviderName) { - this.vaultProviderName = vaultProviderName; + public void setSynchronizationId(String synchronizationId) { + this.synchronizationId = synchronizationId; } - public AgreementEvent versionId(String versionId) { - this.versionId = versionId; + public AgreementEvent deviceLocation(DeviceLocation deviceLocation) { + this.deviceLocation = deviceLocation; return this; } /** - * An ID which uniquely identifies the version of the document associated with this audit event - * @return versionId + * Location of the device that generated the event (This value may be null due to limited privileges) + * @return deviceLocation **/ - @ApiModelProperty(value = "An ID which uniquely identifies the version of the document associated with this audit event") - public String getVersionId() { - return versionId; + @ApiModelProperty(value = "Location of the device that generated the event (This value may be null due to limited privileges)") + public DeviceLocation getDeviceLocation() { + return deviceLocation; } - public void setVersionId(String versionId) { - this.versionId = versionId; + public void setDeviceLocation(DeviceLocation deviceLocation) { + this.deviceLocation = deviceLocation; } @@ -673,30 +681,31 @@ public boolean equals(java.lang.Object o) { return false; } AgreementEvent agreementEvent = (AgreementEvent) o; - return Objects.equals(this.actingUserEmail, agreementEvent.actingUserEmail) && - Objects.equals(this.actingUserIpAddress, agreementEvent.actingUserIpAddress) && - Objects.equals(this.actingUserName, agreementEvent.actingUserName) && - Objects.equals(this.comment, agreementEvent.comment) && - Objects.equals(this.date, agreementEvent.date) && - Objects.equals(this.description, agreementEvent.description) && - Objects.equals(this.deviceLocation, agreementEvent.deviceLocation) && - Objects.equals(this.devicePhoneNumber, agreementEvent.devicePhoneNumber) && - Objects.equals(this.digitalSignatureInfo, agreementEvent.digitalSignatureInfo) && - Objects.equals(this.initiatingUserEmail, agreementEvent.initiatingUserEmail) && + return Objects.equals(this.date, agreementEvent.date) && Objects.equals(this.initiatingUserName, agreementEvent.initiatingUserName) && + Objects.equals(this.description, agreementEvent.description) && + Objects.equals(this.actingUserName, agreementEvent.actingUserName) && + Objects.equals(this.actingUserIpAddress, agreementEvent.actingUserIpAddress) && Objects.equals(this.participantEmail, agreementEvent.participantEmail) && - Objects.equals(this.participantId, agreementEvent.participantId) && - Objects.equals(this.participantRole, agreementEvent.participantRole) && - Objects.equals(this.synchronizationId, agreementEvent.synchronizationId) && Objects.equals(this.type, agreementEvent.type) && + Objects.equals(this.participantRole, agreementEvent.participantRole) && Objects.equals(this.vaultEventId, agreementEvent.vaultEventId) && + Objects.equals(this.participantId, agreementEvent.participantId) && + Objects.equals(this.versionId, agreementEvent.versionId) && + Objects.equals(this.actingUserEmail, agreementEvent.actingUserEmail) && + Objects.equals(this.devicePhoneNumber, agreementEvent.devicePhoneNumber) && + Objects.equals(this.initiatingUserEmail, agreementEvent.initiatingUserEmail) && + Objects.equals(this.digitalSignatureInfo, agreementEvent.digitalSignatureInfo) && Objects.equals(this.vaultProviderName, agreementEvent.vaultProviderName) && - Objects.equals(this.versionId, agreementEvent.versionId); + Objects.equals(this.comment, agreementEvent.comment) && + Objects.equals(this.id, agreementEvent.id) && + Objects.equals(this.synchronizationId, agreementEvent.synchronizationId) && + Objects.equals(this.deviceLocation, agreementEvent.deviceLocation); } @Override public int hashCode() { - return Objects.hash(actingUserEmail, actingUserIpAddress, actingUserName, comment, date, description, deviceLocation, devicePhoneNumber, digitalSignatureInfo, initiatingUserEmail, initiatingUserName, participantEmail, participantId, participantRole, synchronizationId, type, vaultEventId, vaultProviderName, versionId); + return Objects.hash(date, initiatingUserName, description, actingUserName, actingUserIpAddress, participantEmail, type, participantRole, vaultEventId, participantId, versionId, actingUserEmail, devicePhoneNumber, initiatingUserEmail, digitalSignatureInfo, vaultProviderName, comment, id, synchronizationId, deviceLocation); } @@ -705,25 +714,26 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class AgreementEvent {\n"); - sb.append(" actingUserEmail: ").append(toIndentedString(actingUserEmail)).append("\n"); - sb.append(" actingUserIpAddress: ").append(toIndentedString(actingUserIpAddress)).append("\n"); - sb.append(" actingUserName: ").append(toIndentedString(actingUserName)).append("\n"); - sb.append(" comment: ").append(toIndentedString(comment)).append("\n"); sb.append(" date: ").append(toIndentedString(date)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" deviceLocation: ").append(toIndentedString(deviceLocation)).append("\n"); - sb.append(" devicePhoneNumber: ").append(toIndentedString(devicePhoneNumber)).append("\n"); - sb.append(" digitalSignatureInfo: ").append(toIndentedString(digitalSignatureInfo)).append("\n"); - sb.append(" initiatingUserEmail: ").append(toIndentedString(initiatingUserEmail)).append("\n"); sb.append(" initiatingUserName: ").append(toIndentedString(initiatingUserName)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" actingUserName: ").append(toIndentedString(actingUserName)).append("\n"); + sb.append(" actingUserIpAddress: ").append(toIndentedString(actingUserIpAddress)).append("\n"); sb.append(" participantEmail: ").append(toIndentedString(participantEmail)).append("\n"); - sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); - sb.append(" participantRole: ").append(toIndentedString(participantRole)).append("\n"); - sb.append(" synchronizationId: ").append(toIndentedString(synchronizationId)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" participantRole: ").append(toIndentedString(participantRole)).append("\n"); sb.append(" vaultEventId: ").append(toIndentedString(vaultEventId)).append("\n"); - sb.append(" vaultProviderName: ").append(toIndentedString(vaultProviderName)).append("\n"); + sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); sb.append(" versionId: ").append(toIndentedString(versionId)).append("\n"); + sb.append(" actingUserEmail: ").append(toIndentedString(actingUserEmail)).append("\n"); + sb.append(" devicePhoneNumber: ").append(toIndentedString(devicePhoneNumber)).append("\n"); + sb.append(" initiatingUserEmail: ").append(toIndentedString(initiatingUserEmail)).append("\n"); + sb.append(" digitalSignatureInfo: ").append(toIndentedString(digitalSignatureInfo)).append("\n"); + sb.append(" vaultProviderName: ").append(toIndentedString(vaultProviderName)).append("\n"); + sb.append(" comment: ").append(toIndentedString(comment)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" synchronizationId: ").append(toIndentedString(synchronizationId)).append("\n"); + sb.append(" deviceLocation: ").append(toIndentedString(deviceLocation)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/AgreementEventList.java b/src/main/java/io/swagger/client/model/agreements/AgreementEventList.java index 0efca04..3ff6ee6 100755 --- a/src/main/java/io/swagger/client/model/agreements/AgreementEventList.java +++ b/src/main/java/io/swagger/client/model/agreements/AgreementEventList.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * AgreementEventList */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class AgreementEventList { @SerializedName("events") private List events = null; diff --git a/src/main/java/io/swagger/client/model/agreements/AgreementFormFields.java b/src/main/java/io/swagger/client/model/agreements/AgreementFormFields.java index 5e4b585..377d9fd 100755 --- a/src/main/java/io/swagger/client/model/agreements/AgreementFormFields.java +++ b/src/main/java/io/swagger/client/model/agreements/AgreementFormFields.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,7 +30,7 @@ * A JSON list of all of the fields for a form */ @ApiModel(description = "A JSON list of all of the fields for a form") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class AgreementFormFields { @SerializedName("fields") private List fields = null; diff --git a/src/main/java/io/swagger/client/model/agreements/AgreementInfo.java b/src/main/java/io/swagger/client/model/agreements/AgreementInfo.java index 3252da6..27b82d9 100755 --- a/src/main/java/io/swagger/client/model/agreements/AgreementInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/AgreementInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -54,81 +39,110 @@ /** * AgreementInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class AgreementInfo { - @SerializedName("ccs") - private List ccs = null; + @SerializedName("groupId") + private String groupId = null; - @SerializedName("createdDate") - private Date createdDate = null; + @SerializedName("locale") + private String locale = null; - @SerializedName("deviceInfo") - private OfflineDeviceInfo deviceInfo = null; + /** + * The kind of agreement + */ + @JsonAdapter(TypeEnum.Adapter.class) + public enum TypeEnum { + AGREEMENT("AGREEMENT"), + + MEGASIGN_CHILD("MEGASIGN_CHILD"), + + WIDGET_INSTANCE("WIDGET_INSTANCE"); - @SerializedName("documentVisibilityEnabled") - private Boolean documentVisibilityEnabled = null; + private String value; - @SerializedName("emailOption") - private EmailOption emailOption = null; + TypeEnum(String value) { + this.value = value; + } - @SerializedName("expirationTime") - private Date expirationTime = null; + public String getValue() { + return value; + } - @SerializedName("externalId") - private ExternalId externalId = null; + @Override + public String toString() { + return String.valueOf(value); + } - @SerializedName("fileInfos") - private List fileInfos = null; + public static TypeEnum fromValue(String text) { + for (TypeEnum b : TypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } - @SerializedName("firstReminderDelay") - private Integer firstReminderDelay = null; + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } - @SerializedName("formFieldLayerTemplates") - private List formFieldLayerTemplates = null; + @Override + public TypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return TypeEnum.fromValue(String.valueOf(value)); + } + } + } - @SerializedName("id") - private String id = null; + @SerializedName("type") + private TypeEnum type = null; - @SerializedName("locale") - private String locale = null; + @SerializedName("vaultingInfo") + private VaultingInfo vaultingInfo = null; - @SerializedName("mergeFieldInfo") - private List mergeFieldInfo = null; + @SerializedName("securityOption") + private SecurityOption securityOption = null; - @SerializedName("message") - private String message = null; + @SerializedName("postSignOption") + private PostSignOption postSignOption = null; - @SerializedName("name") - private String name = null; + @SerializedName("ccs") + private List ccs = null; - @SerializedName("participantSetsInfo") - private List participantSetsInfo = null; + @SerializedName("documentVisibilityEnabled") + private Boolean documentVisibilityEnabled = null; - @SerializedName("postSignOption") - private PostSignOption postSignOption = null; + @SerializedName("isDocumentRetentionApplied") + private Boolean isDocumentRetentionApplied = null; + + @SerializedName("hasSignerIdentityReport") + private Boolean hasSignerIdentityReport = null; + + @SerializedName("lastEventDate") + private Date lastEventDate = null; + + @SerializedName("senderEmail") + private String senderEmail = null; + + @SerializedName("id") + private String id = null; /** - * Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used. Should not be provided in offline agreement creation. If provided in PUT as a different value than the current one, an error will be thrown. + * The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID */ - @JsonAdapter(ReminderFrequencyEnum.Adapter.class) - public enum ReminderFrequencyEnum { - DAILY_UNTIL_SIGNED("DAILY_UNTIL_SIGNED"), - - WEEKDAILY_UNTIL_SIGNED("WEEKDAILY_UNTIL_SIGNED"), - - EVERY_OTHER_DAY_UNTIL_SIGNED("EVERY_OTHER_DAY_UNTIL_SIGNED"), - - EVERY_THIRD_DAY_UNTIL_SIGNED("EVERY_THIRD_DAY_UNTIL_SIGNED"), - - EVERY_FIFTH_DAY_UNTIL_SIGNED("EVERY_FIFTH_DAY_UNTIL_SIGNED"), + @JsonAdapter(StateEnum.Adapter.class) + public enum StateEnum { + AUTHORING("AUTHORING"), - WEEKLY_UNTIL_SIGNED("WEEKLY_UNTIL_SIGNED"), + DRAFT("DRAFT"), - ONCE("ONCE"); + IN_PROCESS("IN_PROCESS"); private String value; - ReminderFrequencyEnum(String value) { + StateEnum(String value) { this.value = value; } @@ -141,8 +155,8 @@ public String toString() { return String.valueOf(value); } - public static ReminderFrequencyEnum fromValue(String text) { - for (ReminderFrequencyEnum b : ReminderFrequencyEnum.values()) { + public static StateEnum fromValue(String text) { + for (StateEnum b : StateEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -150,28 +164,31 @@ public static ReminderFrequencyEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final ReminderFrequencyEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public ReminderFrequencyEnum read(final JsonReader jsonReader) throws IOException { + public StateEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return ReminderFrequencyEnum.fromValue(String.valueOf(value)); + return StateEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("reminderFrequency") - private ReminderFrequencyEnum reminderFrequency = null; + @SerializedName("state") + private StateEnum state = null; - @SerializedName("securityOption") - private SecurityOption securityOption = null; + @SerializedName("mergeFieldInfo") + private List mergeFieldInfo = null; - @SerializedName("senderEmail") - private String senderEmail = null; + @SerializedName("firstReminderDelay") + private Integer firstReminderDelay = null; + + @SerializedName("emailOption") + private EmailOption emailOption = null; /** * Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system @@ -223,20 +240,40 @@ public SignatureTypeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("signatureType") private SignatureTypeEnum signatureType = null; + @SerializedName("externalId") + private ExternalId externalId = null; + + @SerializedName("message") + private String message = null; + + @SerializedName("deviceInfo") + private OfflineDeviceInfo deviceInfo = null; + + @SerializedName("parentId") + private String parentId = null; + /** - * The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID + * Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used. Should not be provided in offline agreement creation. If provided in PUT as a different value than the current one, an error will be thrown. */ - @JsonAdapter(StateEnum.Adapter.class) - public enum StateEnum { - AUTHORING("AUTHORING"), + @JsonAdapter(ReminderFrequencyEnum.Adapter.class) + public enum ReminderFrequencyEnum { + DAILY_UNTIL_SIGNED("DAILY_UNTIL_SIGNED"), - DRAFT("DRAFT"), + WEEKDAILY_UNTIL_SIGNED("WEEKDAILY_UNTIL_SIGNED"), - IN_PROCESS("IN_PROCESS"); + EVERY_OTHER_DAY_UNTIL_SIGNED("EVERY_OTHER_DAY_UNTIL_SIGNED"), + + EVERY_THIRD_DAY_UNTIL_SIGNED("EVERY_THIRD_DAY_UNTIL_SIGNED"), + + EVERY_FIFTH_DAY_UNTIL_SIGNED("EVERY_FIFTH_DAY_UNTIL_SIGNED"), + + WEEKLY_UNTIL_SIGNED("WEEKLY_UNTIL_SIGNED"), + + ONCE("ONCE"); private String value; - StateEnum(String value) { + ReminderFrequencyEnum(String value) { this.value = value; } @@ -249,8 +286,8 @@ public String toString() { return String.valueOf(value); } - public static StateEnum fromValue(String text) { - for (StateEnum b : StateEnum.values()) { + public static ReminderFrequencyEnum fromValue(String text) { + for (ReminderFrequencyEnum b : ReminderFrequencyEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -258,22 +295,46 @@ public static StateEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final ReminderFrequencyEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public StateEnum read(final JsonReader jsonReader) throws IOException { + public ReminderFrequencyEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return StateEnum.fromValue(String.valueOf(value)); + return ReminderFrequencyEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("state") - private StateEnum state = null; + @SerializedName("reminderFrequency") + private ReminderFrequencyEnum reminderFrequency = null; + + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("participantSetsInfo") + private List participantSetsInfo = null; + + @SerializedName("hasFormFieldData") + private Boolean hasFormFieldData = null; + + @SerializedName("expirationTime") + private Date expirationTime = null; + + @SerializedName("formFieldLayerTemplates") + private List formFieldLayerTemplates = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("fileInfos") + private List fileInfos = null; + + @SerializedName("workflowId") + private String workflowId = null; /** * This is a server generated attribute which provides the detailed status of an agreement. @@ -361,214 +422,228 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; - @SerializedName("vaultingInfo") - private VaultingInfo vaultingInfo = null; - - @SerializedName("workflowId") - private String workflowId = null; - - public AgreementInfo ccs(List ccs) { - this.ccs = ccs; - return this; - } - - public AgreementInfo addCcsItem(AgreementCcInfo ccsItem) { - if (this.ccs == null) { - this.ccs = new ArrayList(); - } - this.ccs.add(ccsItem); + public AgreementInfo groupId(String groupId) { + this.groupId = groupId; return this; } /** - * A list of one or more CCs that will be copied in the agreement transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file. Should not be provided in offline agreement creation. - * @return ccs + * The unique identifier of the group to which the agreement belongs to. If not provided during agreement creation, primary group of the creator will be used + * @return groupId **/ - @ApiModelProperty(value = "A list of one or more CCs that will be copied in the agreement transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file. Should not be provided in offline agreement creation.") - public List getCcs() { - return ccs; + @ApiModelProperty(value = "The unique identifier of the group to which the agreement belongs to. If not provided during agreement creation, primary group of the creator will be used") + public String getGroupId() { + return groupId; } - public void setCcs(List ccs) { - this.ccs = ccs; + public void setGroupId(String groupId) { + this.groupId = groupId; } - public AgreementInfo createdDate(Date createdDate) { - this.createdDate = createdDate; + public AgreementInfo locale(String locale) { + this.locale = locale; return this; } /** - * Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time - * @return createdDate + * The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender + * @return locale **/ - @ApiModelProperty(value = "Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") - public Date getCreatedDate() { - return createdDate; + @ApiModelProperty(value = "The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender") + public String getLocale() { + return locale; } - public void setCreatedDate(Date createdDate) { - this.createdDate = createdDate; + public void setLocale(String locale) { + this.locale = locale; } - public AgreementInfo deviceInfo(OfflineDeviceInfo deviceInfo) { - this.deviceInfo = deviceInfo; + public AgreementInfo type(TypeEnum type) { + this.type = type; return this; } /** - * Device info of the offline device. It should only be provided in case of offline agreement creation. - * @return deviceInfo + * The kind of agreement + * @return type **/ - @ApiModelProperty(value = "Device info of the offline device. It should only be provided in case of offline agreement creation.") - public OfflineDeviceInfo getDeviceInfo() { - return deviceInfo; + @ApiModelProperty(value = "The kind of agreement") + public TypeEnum getType() { + return type; } - public void setDeviceInfo(OfflineDeviceInfo deviceInfo) { - this.deviceInfo = deviceInfo; + public void setType(TypeEnum type) { + this.type = type; } - public AgreementInfo documentVisibilityEnabled(Boolean documentVisibilityEnabled) { - this.documentVisibilityEnabled = documentVisibilityEnabled; + public AgreementInfo vaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; return this; } /** - * If set to true, enable limited document visibility. Should not be provided in offline agreement creation. - * @return documentVisibilityEnabled + * Vaulting properties that allows Adobe Sign to securely store documents with a vault provider + * @return vaultingInfo **/ - @ApiModelProperty(value = "If set to true, enable limited document visibility. Should not be provided in offline agreement creation.") - public Boolean isDocumentVisibilityEnabled() { - return documentVisibilityEnabled; + @ApiModelProperty(value = "Vaulting properties that allows Adobe Sign to securely store documents with a vault provider") + public VaultingInfo getVaultingInfo() { + return vaultingInfo; } - public void setDocumentVisibilityEnabled(Boolean documentVisibilityEnabled) { - this.documentVisibilityEnabled = documentVisibilityEnabled; + public void setVaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; } - public AgreementInfo emailOption(EmailOption emailOption) { - this.emailOption = emailOption; + public AgreementInfo securityOption(SecurityOption securityOption) { + this.securityOption = securityOption; return this; } /** - * Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement. - * @return emailOption + * Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation. + * @return securityOption **/ - @ApiModelProperty(value = "Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement.") - public EmailOption getEmailOption() { - return emailOption; + @ApiModelProperty(value = "Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation.") + public SecurityOption getSecurityOption() { + return securityOption; } - public void setEmailOption(EmailOption emailOption) { - this.emailOption = emailOption; + public void setSecurityOption(SecurityOption securityOption) { + this.securityOption = securityOption; } - public AgreementInfo expirationTime(Date expirationTime) { - this.expirationTime = expirationTime; + public AgreementInfo postSignOption(PostSignOption postSignOption) { + this.postSignOption = postSignOption; return this; } /** - * Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. - * @return expirationTime + * URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation. + * @return postSignOption **/ - @ApiModelProperty(value = "Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation.") - public Date getExpirationTime() { - return expirationTime; + @ApiModelProperty(value = "URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation.") + public PostSignOption getPostSignOption() { + return postSignOption; } - public void setExpirationTime(Date expirationTime) { - this.expirationTime = expirationTime; + public void setPostSignOption(PostSignOption postSignOption) { + this.postSignOption = postSignOption; } - public AgreementInfo externalId(ExternalId externalId) { - this.externalId = externalId; + public AgreementInfo ccs(List ccs) { + this.ccs = ccs; + return this; + } + + public AgreementInfo addCcsItem(AgreementCcInfo ccsItem) { + if (this.ccs == null) { + this.ccs = new ArrayList(); + } + this.ccs.add(ccsItem); return this; } /** - * An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation. - * @return externalId + * A list of one or more CCs that will be copied in the agreement transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file. Should not be provided in offline agreement creation. + * @return ccs **/ - @ApiModelProperty(value = "An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation.") - public ExternalId getExternalId() { - return externalId; + @ApiModelProperty(value = "A list of one or more CCs that will be copied in the agreement transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file. Should not be provided in offline agreement creation.") + public List getCcs() { + return ccs; } - public void setExternalId(ExternalId externalId) { - this.externalId = externalId; + public void setCcs(List ccs) { + this.ccs = ccs; } - public AgreementInfo fileInfos(List fileInfos) { - this.fileInfos = fileInfos; + public AgreementInfo documentVisibilityEnabled(Boolean documentVisibilityEnabled) { + this.documentVisibilityEnabled = documentVisibilityEnabled; return this; } - public AgreementInfo addFileInfosItem(FileInfo fileInfosItem) { - if (this.fileInfos == null) { - this.fileInfos = new ArrayList(); - } - this.fileInfos.add(fileInfosItem); + /** + * If set to true, enable limited document visibility. Should not be provided in offline agreement creation. + * @return documentVisibilityEnabled + **/ + @ApiModelProperty(value = "If set to true, enable limited document visibility. Should not be provided in offline agreement creation.") + public Boolean isDocumentVisibilityEnabled() { + return documentVisibilityEnabled; + } + + public void setDocumentVisibilityEnabled(Boolean documentVisibilityEnabled) { + this.documentVisibilityEnabled = documentVisibilityEnabled; + } + + public AgreementInfo isDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; return this; } /** - * A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified - * @return fileInfos + * Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. + * @return isDocumentRetentionApplied **/ - @ApiModelProperty(value = "A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified") - public List getFileInfos() { - return fileInfos; + @ApiModelProperty(value = "Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored.") + public Boolean isIsDocumentRetentionApplied() { + return isDocumentRetentionApplied; } - public void setFileInfos(List fileInfos) { - this.fileInfos = fileInfos; + public void setIsDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; } - public AgreementInfo firstReminderDelay(Integer firstReminderDelay) { - this.firstReminderDelay = firstReminderDelay; + public AgreementInfo hasSignerIdentityReport(Boolean hasSignerIdentityReport) { + this.hasSignerIdentityReport = hasSignerIdentityReport; return this; } /** - * Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation. - * @return firstReminderDelay + * True if agreement has signer identity report available. If provided in POST or PUT, it will simply be ignored. + * @return hasSignerIdentityReport **/ - @ApiModelProperty(value = "Integer which specifies the delay in hours before sending the first reminder.
This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.
If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.
i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation.") - public Integer getFirstReminderDelay() { - return firstReminderDelay; + @ApiModelProperty(value = "True if agreement has signer identity report available. If provided in POST or PUT, it will simply be ignored.") + public Boolean isHasSignerIdentityReport() { + return hasSignerIdentityReport; } - public void setFirstReminderDelay(Integer firstReminderDelay) { - this.firstReminderDelay = firstReminderDelay; + public void setHasSignerIdentityReport(Boolean hasSignerIdentityReport) { + this.hasSignerIdentityReport = hasSignerIdentityReport; } - public AgreementInfo formFieldLayerTemplates(List formFieldLayerTemplates) { - this.formFieldLayerTemplates = formFieldLayerTemplates; + public AgreementInfo lastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; return this; } - public AgreementInfo addFormFieldLayerTemplatesItem(FileInfo formFieldLayerTemplatesItem) { - if (this.formFieldLayerTemplates == null) { - this.formFieldLayerTemplates = new ArrayList(); - } - this.formFieldLayerTemplates.add(formFieldLayerTemplatesItem); + /** + * The date of the last event that occurred for this agreement. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return lastEventDate + **/ + @ApiModelProperty(value = "The date of the last event that occurred for this agreement. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getLastEventDate() { + return lastEventDate; + } + + public void setLastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; + } + + public AgreementInfo senderEmail(String senderEmail) { + this.senderEmail = senderEmail; return this; } /** - * Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified - * @return formFieldLayerTemplates + * Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored + * @return senderEmail **/ - @ApiModelProperty(value = "Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified") - public List getFormFieldLayerTemplates() { - return formFieldLayerTemplates; + @ApiModelProperty(value = "Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored") + public String getSenderEmail() { + return senderEmail; } - public void setFormFieldLayerTemplates(List formFieldLayerTemplates) { - this.formFieldLayerTemplates = formFieldLayerTemplates; + public void setSenderEmail(String senderEmail) { + this.senderEmail = senderEmail; } public AgreementInfo id(String id) { @@ -589,22 +664,22 @@ public void setId(String id) { this.id = id; } - public AgreementInfo locale(String locale) { - this.locale = locale; + public AgreementInfo state(StateEnum state) { + this.state = state; return this; } /** - * The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender - * @return locale + * The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID + * @return state **/ - @ApiModelProperty(value = "The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender") - public String getLocale() { - return locale; + @ApiModelProperty(value = "The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID") + public StateEnum getState() { + return state; } - public void setLocale(String locale) { - this.locale = locale; + public void setState(StateEnum state) { + this.state = state; } public AgreementInfo mergeFieldInfo(List mergeFieldInfo) { @@ -633,84 +708,130 @@ public void setMergeFieldInfo(List mergeFieldInfo) { this.mergeFieldInfo = mergeFieldInfo; } - public AgreementInfo message(String message) { - this.message = message; + public AgreementInfo firstReminderDelay(Integer firstReminderDelay) { + this.firstReminderDelay = firstReminderDelay; return this; } /** - * An optional message to the participants, describing what is being sent or why their signature is required - * @return message + * Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation. + * @return firstReminderDelay **/ - @ApiModelProperty(value = "An optional message to the participants, describing what is being sent or why their signature is required") - public String getMessage() { - return message; + @ApiModelProperty(value = "Integer which specifies the delay in hours before sending the first reminder.
This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.
If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.
i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation.") + public Integer getFirstReminderDelay() { + return firstReminderDelay; } - public void setMessage(String message) { - this.message = message; + public void setFirstReminderDelay(Integer firstReminderDelay) { + this.firstReminderDelay = firstReminderDelay; } - public AgreementInfo name(String name) { - this.name = name; + public AgreementInfo emailOption(EmailOption emailOption) { + this.emailOption = emailOption; return this; } /** - * The name of the agreement that will be used to identify it, in emails, website and other places - * @return name + * Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement. + * @return emailOption **/ - @ApiModelProperty(value = "The name of the agreement that will be used to identify it, in emails, website and other places") - public String getName() { - return name; + @ApiModelProperty(value = "Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement.") + public EmailOption getEmailOption() { + return emailOption; } - public void setName(String name) { - this.name = name; + public void setEmailOption(EmailOption emailOption) { + this.emailOption = emailOption; } - public AgreementInfo participantSetsInfo(List participantSetsInfo) { - this.participantSetsInfo = participantSetsInfo; + public AgreementInfo signatureType(SignatureTypeEnum signatureType) { + this.signatureType = signatureType; return this; } - public AgreementInfo addParticipantSetsInfoItem(ParticipantSetInfo participantSetsInfoItem) { - if (this.participantSetsInfo == null) { - this.participantSetsInfo = new ArrayList(); - } - this.participantSetsInfo.add(participantSetsInfoItem); + /** + * Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system + * @return signatureType + **/ + @ApiModelProperty(value = "Specifies the type of signature you would like to request - written or e-signature. The possible values are
ESIGN : Agreement needs to be signed electronically
, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system") + public SignatureTypeEnum getSignatureType() { + return signatureType; + } + + public void setSignatureType(SignatureTypeEnum signatureType) { + this.signatureType = signatureType; + } + + public AgreementInfo externalId(ExternalId externalId) { + this.externalId = externalId; return this; } /** - * A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc ), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document - * @return participantSetsInfo + * An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation. + * @return externalId **/ - @ApiModelProperty(value = "A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc ), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document") - public List getParticipantSetsInfo() { - return participantSetsInfo; + @ApiModelProperty(value = "An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation.") + public ExternalId getExternalId() { + return externalId; } - public void setParticipantSetsInfo(List participantSetsInfo) { - this.participantSetsInfo = participantSetsInfo; + public void setExternalId(ExternalId externalId) { + this.externalId = externalId; } - public AgreementInfo postSignOption(PostSignOption postSignOption) { - this.postSignOption = postSignOption; + public AgreementInfo message(String message) { + this.message = message; return this; } /** - * URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation. - * @return postSignOption + * An optional message to the participants, describing what is being sent or why their signature is required + * @return message **/ - @ApiModelProperty(value = "URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation.") - public PostSignOption getPostSignOption() { - return postSignOption; + @ApiModelProperty(value = "An optional message to the participants, describing what is being sent or why their signature is required") + public String getMessage() { + return message; } - public void setPostSignOption(PostSignOption postSignOption) { - this.postSignOption = postSignOption; + public void setMessage(String message) { + this.message = message; + } + + public AgreementInfo deviceInfo(OfflineDeviceInfo deviceInfo) { + this.deviceInfo = deviceInfo; + return this; + } + + /** + * Device info of the offline device. It should only be provided in case of offline agreement creation. + * @return deviceInfo + **/ + @ApiModelProperty(value = "Device info of the offline device. It should only be provided in case of offline agreement creation.") + public OfflineDeviceInfo getDeviceInfo() { + return deviceInfo; + } + + public void setDeviceInfo(OfflineDeviceInfo deviceInfo) { + this.deviceInfo = deviceInfo; + } + + public AgreementInfo parentId(String parentId) { + this.parentId = parentId; + return this; + } + + /** + * The parent id of a megaSign child *OR* the originating id of a widget agreement instance + * @return parentId + **/ + @ApiModelProperty(value = "The parent id of a megaSign child *OR* the originating id of a widget agreement instance") + public String getParentId() { + return parentId; + } + + public void setParentId(String parentId) { + this.parentId = parentId; } public AgreementInfo reminderFrequency(ReminderFrequencyEnum reminderFrequency) { @@ -731,112 +852,154 @@ public void setReminderFrequency(ReminderFrequencyEnum reminderFrequency) { this.reminderFrequency = reminderFrequency; } - public AgreementInfo securityOption(SecurityOption securityOption) { - this.securityOption = securityOption; + public AgreementInfo createdDate(Date createdDate) { + this.createdDate = createdDate; return this; } /** - * Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation. - * @return securityOption + * Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return createdDate **/ - @ApiModelProperty(value = "Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation.") - public SecurityOption getSecurityOption() { - return securityOption; + @ApiModelProperty(value = "Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getCreatedDate() { + return createdDate; } - public void setSecurityOption(SecurityOption securityOption) { - this.securityOption = securityOption; + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; } - public AgreementInfo senderEmail(String senderEmail) { - this.senderEmail = senderEmail; + public AgreementInfo participantSetsInfo(List participantSetsInfo) { + this.participantSetsInfo = participantSetsInfo; + return this; + } + + public AgreementInfo addParticipantSetsInfoItem(ParticipantSetInfo participantSetsInfoItem) { + if (this.participantSetsInfo == null) { + this.participantSetsInfo = new ArrayList(); + } + this.participantSetsInfo.add(participantSetsInfoItem); return this; } /** - * Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored - * @return senderEmail + * A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document + * @return participantSetsInfo **/ - @ApiModelProperty(value = "Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored") - public String getSenderEmail() { - return senderEmail; + @ApiModelProperty(value = "A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document") + public List getParticipantSetsInfo() { + return participantSetsInfo; } - public void setSenderEmail(String senderEmail) { - this.senderEmail = senderEmail; + public void setParticipantSetsInfo(List participantSetsInfo) { + this.participantSetsInfo = participantSetsInfo; } - public AgreementInfo signatureType(SignatureTypeEnum signatureType) { - this.signatureType = signatureType; + public AgreementInfo hasFormFieldData(Boolean hasFormFieldData) { + this.hasFormFieldData = hasFormFieldData; return this; } /** - * Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system - * @return signatureType + * True if form field data is present. If provided in POST or PUT, it will simply be ignored. + * @return hasFormFieldData **/ - @ApiModelProperty(value = "Specifies the type of signature you would like to request - written or e-signature. The possible values are
ESIGN : Agreement needs to be signed electronically
, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system") - public SignatureTypeEnum getSignatureType() { - return signatureType; + @ApiModelProperty(value = "True if form field data is present. If provided in POST or PUT, it will simply be ignored.") + public Boolean isHasFormFieldData() { + return hasFormFieldData; } - public void setSignatureType(SignatureTypeEnum signatureType) { - this.signatureType = signatureType; + public void setHasFormFieldData(Boolean hasFormFieldData) { + this.hasFormFieldData = hasFormFieldData; } - public AgreementInfo state(StateEnum state) { - this.state = state; + public AgreementInfo expirationTime(Date expirationTime) { + this.expirationTime = expirationTime; return this; } /** - * The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID - * @return state + * Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. + * @return expirationTime **/ - @ApiModelProperty(value = "The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID") - public StateEnum getState() { - return state; + @ApiModelProperty(value = "Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation.") + public Date getExpirationTime() { + return expirationTime; } - public void setState(StateEnum state) { - this.state = state; + public void setExpirationTime(Date expirationTime) { + this.expirationTime = expirationTime; } - public AgreementInfo status(StatusEnum status) { - this.status = status; + public AgreementInfo formFieldLayerTemplates(List formFieldLayerTemplates) { + this.formFieldLayerTemplates = formFieldLayerTemplates; + return this; + } + + public AgreementInfo addFormFieldLayerTemplatesItem(FileInfo formFieldLayerTemplatesItem) { + if (this.formFieldLayerTemplates == null) { + this.formFieldLayerTemplates = new ArrayList(); + } + this.formFieldLayerTemplates.add(formFieldLayerTemplatesItem); return this; } /** - * This is a server generated attribute which provides the detailed status of an agreement. - * @return status + * Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified + * @return formFieldLayerTemplates **/ - @ApiModelProperty(value = "This is a server generated attribute which provides the detailed status of an agreement.") - public StatusEnum getStatus() { - return status; + @ApiModelProperty(value = "Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified") + public List getFormFieldLayerTemplates() { + return formFieldLayerTemplates; } - public void setStatus(StatusEnum status) { - this.status = status; + public void setFormFieldLayerTemplates(List formFieldLayerTemplates) { + this.formFieldLayerTemplates = formFieldLayerTemplates; } - public AgreementInfo vaultingInfo(VaultingInfo vaultingInfo) { - this.vaultingInfo = vaultingInfo; + public AgreementInfo name(String name) { + this.name = name; return this; } /** - * Vaulting properties that allows Adobe Sign to securely store documents with a vault provider - * @return vaultingInfo + * The name of the agreement that will be used to identify it, in emails, website and other places + * @return name **/ - @ApiModelProperty(value = "Vaulting properties that allows Adobe Sign to securely store documents with a vault provider") - public VaultingInfo getVaultingInfo() { - return vaultingInfo; + @ApiModelProperty(value = "The name of the agreement that will be used to identify it, in emails, website and other places") + public String getName() { + return name; } - public void setVaultingInfo(VaultingInfo vaultingInfo) { - this.vaultingInfo = vaultingInfo; + public void setName(String name) { + this.name = name; + } + + public AgreementInfo fileInfos(List fileInfos) { + this.fileInfos = fileInfos; + return this; + } + + public AgreementInfo addFileInfosItem(FileInfo fileInfosItem) { + if (this.fileInfos == null) { + this.fileInfos = new ArrayList(); + } + this.fileInfos.add(fileInfosItem); + return this; + } + + /** + * A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified + * @return fileInfos + **/ + @ApiModelProperty(value = "A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified") + public List getFileInfos() { + return fileInfos; + } + + public void setFileInfos(List fileInfos) { + this.fileInfos = fileInfos; } public AgreementInfo workflowId(String workflowId) { @@ -857,6 +1020,24 @@ public void setWorkflowId(String workflowId) { this.workflowId = workflowId; } + public AgreementInfo status(StatusEnum status) { + this.status = status; + return this; + } + + /** + * This is a server generated attribute which provides the detailed status of an agreement. + * @return status + **/ + @ApiModelProperty(value = "This is a server generated attribute which provides the detailed status of an agreement.") + public StatusEnum getStatus() { + return status; + } + + public void setStatus(StatusEnum status) { + this.status = status; + } + @Override public boolean equals(java.lang.Object o) { @@ -867,36 +1048,43 @@ public boolean equals(java.lang.Object o) { return false; } AgreementInfo agreementInfo = (AgreementInfo) o; - return Objects.equals(this.ccs, agreementInfo.ccs) && - Objects.equals(this.createdDate, agreementInfo.createdDate) && - Objects.equals(this.deviceInfo, agreementInfo.deviceInfo) && + return Objects.equals(this.groupId, agreementInfo.groupId) && + Objects.equals(this.locale, agreementInfo.locale) && + Objects.equals(this.type, agreementInfo.type) && + Objects.equals(this.vaultingInfo, agreementInfo.vaultingInfo) && + Objects.equals(this.securityOption, agreementInfo.securityOption) && + Objects.equals(this.postSignOption, agreementInfo.postSignOption) && + Objects.equals(this.ccs, agreementInfo.ccs) && Objects.equals(this.documentVisibilityEnabled, agreementInfo.documentVisibilityEnabled) && - Objects.equals(this.emailOption, agreementInfo.emailOption) && - Objects.equals(this.expirationTime, agreementInfo.expirationTime) && - Objects.equals(this.externalId, agreementInfo.externalId) && - Objects.equals(this.fileInfos, agreementInfo.fileInfos) && - Objects.equals(this.firstReminderDelay, agreementInfo.firstReminderDelay) && - Objects.equals(this.formFieldLayerTemplates, agreementInfo.formFieldLayerTemplates) && + Objects.equals(this.isDocumentRetentionApplied, agreementInfo.isDocumentRetentionApplied) && + Objects.equals(this.hasSignerIdentityReport, agreementInfo.hasSignerIdentityReport) && + Objects.equals(this.lastEventDate, agreementInfo.lastEventDate) && + Objects.equals(this.senderEmail, agreementInfo.senderEmail) && Objects.equals(this.id, agreementInfo.id) && - Objects.equals(this.locale, agreementInfo.locale) && + Objects.equals(this.state, agreementInfo.state) && Objects.equals(this.mergeFieldInfo, agreementInfo.mergeFieldInfo) && + Objects.equals(this.firstReminderDelay, agreementInfo.firstReminderDelay) && + Objects.equals(this.emailOption, agreementInfo.emailOption) && + Objects.equals(this.signatureType, agreementInfo.signatureType) && + Objects.equals(this.externalId, agreementInfo.externalId) && Objects.equals(this.message, agreementInfo.message) && - Objects.equals(this.name, agreementInfo.name) && - Objects.equals(this.participantSetsInfo, agreementInfo.participantSetsInfo) && - Objects.equals(this.postSignOption, agreementInfo.postSignOption) && + Objects.equals(this.deviceInfo, agreementInfo.deviceInfo) && + Objects.equals(this.parentId, agreementInfo.parentId) && Objects.equals(this.reminderFrequency, agreementInfo.reminderFrequency) && - Objects.equals(this.securityOption, agreementInfo.securityOption) && - Objects.equals(this.senderEmail, agreementInfo.senderEmail) && - Objects.equals(this.signatureType, agreementInfo.signatureType) && - Objects.equals(this.state, agreementInfo.state) && - Objects.equals(this.status, agreementInfo.status) && - Objects.equals(this.vaultingInfo, agreementInfo.vaultingInfo) && - Objects.equals(this.workflowId, agreementInfo.workflowId); + Objects.equals(this.createdDate, agreementInfo.createdDate) && + Objects.equals(this.participantSetsInfo, agreementInfo.participantSetsInfo) && + Objects.equals(this.hasFormFieldData, agreementInfo.hasFormFieldData) && + Objects.equals(this.expirationTime, agreementInfo.expirationTime) && + Objects.equals(this.formFieldLayerTemplates, agreementInfo.formFieldLayerTemplates) && + Objects.equals(this.name, agreementInfo.name) && + Objects.equals(this.fileInfos, agreementInfo.fileInfos) && + Objects.equals(this.workflowId, agreementInfo.workflowId) && + Objects.equals(this.status, agreementInfo.status); } @Override public int hashCode() { - return Objects.hash(ccs, createdDate, deviceInfo, documentVisibilityEnabled, emailOption, expirationTime, externalId, fileInfos, firstReminderDelay, formFieldLayerTemplates, id, locale, mergeFieldInfo, message, name, participantSetsInfo, postSignOption, reminderFrequency, securityOption, senderEmail, signatureType, state, status, vaultingInfo, workflowId); + return Objects.hash(groupId, locale, type, vaultingInfo, securityOption, postSignOption, ccs, documentVisibilityEnabled, isDocumentRetentionApplied, hasSignerIdentityReport, lastEventDate, senderEmail, id, state, mergeFieldInfo, firstReminderDelay, emailOption, signatureType, externalId, message, deviceInfo, parentId, reminderFrequency, createdDate, participantSetsInfo, hasFormFieldData, expirationTime, formFieldLayerTemplates, name, fileInfos, workflowId, status); } @@ -905,31 +1093,38 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class AgreementInfo {\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); + sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" vaultingInfo: ").append(toIndentedString(vaultingInfo)).append("\n"); + sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); + sb.append(" postSignOption: ").append(toIndentedString(postSignOption)).append("\n"); sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n"); - sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); - sb.append(" deviceInfo: ").append(toIndentedString(deviceInfo)).append("\n"); sb.append(" documentVisibilityEnabled: ").append(toIndentedString(documentVisibilityEnabled)).append("\n"); - sb.append(" emailOption: ").append(toIndentedString(emailOption)).append("\n"); - sb.append(" expirationTime: ").append(toIndentedString(expirationTime)).append("\n"); - sb.append(" externalId: ").append(toIndentedString(externalId)).append("\n"); - sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); - sb.append(" firstReminderDelay: ").append(toIndentedString(firstReminderDelay)).append("\n"); - sb.append(" formFieldLayerTemplates: ").append(toIndentedString(formFieldLayerTemplates)).append("\n"); + sb.append(" isDocumentRetentionApplied: ").append(toIndentedString(isDocumentRetentionApplied)).append("\n"); + sb.append(" hasSignerIdentityReport: ").append(toIndentedString(hasSignerIdentityReport)).append("\n"); + sb.append(" lastEventDate: ").append(toIndentedString(lastEventDate)).append("\n"); + sb.append(" senderEmail: ").append(toIndentedString(senderEmail)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); + sb.append(" state: ").append(toIndentedString(state)).append("\n"); sb.append(" mergeFieldInfo: ").append(toIndentedString(mergeFieldInfo)).append("\n"); + sb.append(" firstReminderDelay: ").append(toIndentedString(firstReminderDelay)).append("\n"); + sb.append(" emailOption: ").append(toIndentedString(emailOption)).append("\n"); + sb.append(" signatureType: ").append(toIndentedString(signatureType)).append("\n"); + sb.append(" externalId: ").append(toIndentedString(externalId)).append("\n"); sb.append(" message: ").append(toIndentedString(message)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" participantSetsInfo: ").append(toIndentedString(participantSetsInfo)).append("\n"); - sb.append(" postSignOption: ").append(toIndentedString(postSignOption)).append("\n"); + sb.append(" deviceInfo: ").append(toIndentedString(deviceInfo)).append("\n"); + sb.append(" parentId: ").append(toIndentedString(parentId)).append("\n"); sb.append(" reminderFrequency: ").append(toIndentedString(reminderFrequency)).append("\n"); - sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); - sb.append(" senderEmail: ").append(toIndentedString(senderEmail)).append("\n"); - sb.append(" signatureType: ").append(toIndentedString(signatureType)).append("\n"); - sb.append(" state: ").append(toIndentedString(state)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" vaultingInfo: ").append(toIndentedString(vaultingInfo)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" participantSetsInfo: ").append(toIndentedString(participantSetsInfo)).append("\n"); + sb.append(" hasFormFieldData: ").append(toIndentedString(hasFormFieldData)).append("\n"); + sb.append(" expirationTime: ").append(toIndentedString(expirationTime)).append("\n"); + sb.append(" formFieldLayerTemplates: ").append(toIndentedString(formFieldLayerTemplates)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); sb.append(" workflowId: ").append(toIndentedString(workflowId)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/AgreementRejectionInfo.java b/src/main/java/io/swagger/client/model/agreements/AgreementRejectionInfo.java index 41f008b..0e6dc15 100755 --- a/src/main/java/io/swagger/client/model/agreements/AgreementRejectionInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/AgreementRejectionInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * AgreementRejectionInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class AgreementRejectionInfo { @SerializedName("comment") private String comment = null; diff --git a/src/main/java/io/swagger/client/model/agreements/AgreementStateInfo.java b/src/main/java/io/swagger/client/model/agreements/AgreementStateInfo.java index b28fe67..d18fcdc 100755 --- a/src/main/java/io/swagger/client/model/agreements/AgreementStateInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/AgreementStateInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,7 @@ /** * AgreementStateInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class AgreementStateInfo { @SerializedName("agreementCancellationInfo") private AgreementCancellationInfo agreementCancellationInfo = null; diff --git a/src/main/java/io/swagger/client/model/agreements/AgreementView.java b/src/main/java/io/swagger/client/model/agreements/AgreementView.java index 8261d82..de8f828 100755 --- a/src/main/java/io/swagger/client/model/agreements/AgreementView.java +++ b/src/main/java/io/swagger/client/model/agreements/AgreementView.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,17 +27,14 @@ /** * AgreementView */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class AgreementView { - @SerializedName("embeddedCode") - private String embeddedCode = null; - - @SerializedName("expiration") - private Date expiration = null; - @SerializedName("isCurrent") private Boolean isCurrent = null; + @SerializedName("embeddedCode") + private String embeddedCode = null; + /** * Name of the requested agreement view */ @@ -119,45 +101,12 @@ public NameEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("name") private NameEnum name = null; + @SerializedName("expiration") + private Date expiration = null; + @SerializedName("url") private String url = null; - public AgreementView embeddedCode(String embeddedCode) { - this.embeddedCode = embeddedCode; - return this; - } - - /** - * Embedded code of url of resource - * @return embeddedCode - **/ - @ApiModelProperty(value = "Embedded code of url of resource ") - public String getEmbeddedCode() { - return embeddedCode; - } - - public void setEmbeddedCode(String embeddedCode) { - this.embeddedCode = embeddedCode; - } - - public AgreementView expiration(Date expiration) { - this.expiration = expiration; - return this; - } - - /** - * Expiration of user url - * @return expiration - **/ - @ApiModelProperty(value = "Expiration of user url ") - public Date getExpiration() { - return expiration; - } - - public void setExpiration(Date expiration) { - this.expiration = expiration; - } - public AgreementView isCurrent(Boolean isCurrent) { this.isCurrent = isCurrent; return this; @@ -176,6 +125,24 @@ public void setIsCurrent(Boolean isCurrent) { this.isCurrent = isCurrent; } + public AgreementView embeddedCode(String embeddedCode) { + this.embeddedCode = embeddedCode; + return this; + } + + /** + * Embedded code of url of resource + * @return embeddedCode + **/ + @ApiModelProperty(value = "Embedded code of url of resource ") + public String getEmbeddedCode() { + return embeddedCode; + } + + public void setEmbeddedCode(String embeddedCode) { + this.embeddedCode = embeddedCode; + } + public AgreementView name(NameEnum name) { this.name = name; return this; @@ -194,6 +161,24 @@ public void setName(NameEnum name) { this.name = name; } + public AgreementView expiration(Date expiration) { + this.expiration = expiration; + return this; + } + + /** + * Expiration of user url + * @return expiration + **/ + @ApiModelProperty(value = "Expiration of user url ") + public Date getExpiration() { + return expiration; + } + + public void setExpiration(Date expiration) { + this.expiration = expiration; + } + public AgreementView url(String url) { this.url = url; return this; @@ -222,16 +207,16 @@ public boolean equals(java.lang.Object o) { return false; } AgreementView agreementView = (AgreementView) o; - return Objects.equals(this.embeddedCode, agreementView.embeddedCode) && - Objects.equals(this.expiration, agreementView.expiration) && - Objects.equals(this.isCurrent, agreementView.isCurrent) && + return Objects.equals(this.isCurrent, agreementView.isCurrent) && + Objects.equals(this.embeddedCode, agreementView.embeddedCode) && Objects.equals(this.name, agreementView.name) && + Objects.equals(this.expiration, agreementView.expiration) && Objects.equals(this.url, agreementView.url); } @Override public int hashCode() { - return Objects.hash(embeddedCode, expiration, isCurrent, name, url); + return Objects.hash(isCurrent, embeddedCode, name, expiration, url); } @@ -240,10 +225,10 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class AgreementView {\n"); - sb.append(" embeddedCode: ").append(toIndentedString(embeddedCode)).append("\n"); - sb.append(" expiration: ").append(toIndentedString(expiration)).append("\n"); sb.append(" isCurrent: ").append(toIndentedString(isCurrent)).append("\n"); + sb.append(" embeddedCode: ").append(toIndentedString(embeddedCode)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" expiration: ").append(toIndentedString(expiration)).append("\n"); sb.append(" url: ").append(toIndentedString(url)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/agreements/AgreementViewInfo.java b/src/main/java/io/swagger/client/model/agreements/AgreementViewInfo.java index cba932c..d428d3e 100755 --- a/src/main/java/io/swagger/client/model/agreements/AgreementViewInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/AgreementViewInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -43,14 +28,14 @@ /** * AgreementViewInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class AgreementViewInfo { - @SerializedName("commonViewConfiguration") - private CommonViewConfiguration commonViewConfiguration = null; - @SerializedName("composeViewConfiguration") private ComposeViewConfiguration composeViewConfiguration = null; + @SerializedName("commonViewConfiguration") + private CommonViewConfiguration commonViewConfiguration = null; + /** * Name of the requested agreement view */ @@ -117,24 +102,6 @@ public NameEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("name") private NameEnum name = null; - public AgreementViewInfo commonViewConfiguration(CommonViewConfiguration commonViewConfiguration) { - this.commonViewConfiguration = commonViewConfiguration; - return this; - } - - /** - * Common view configuration for all the available views - * @return commonViewConfiguration - **/ - @ApiModelProperty(value = "Common view configuration for all the available views") - public CommonViewConfiguration getCommonViewConfiguration() { - return commonViewConfiguration; - } - - public void setCommonViewConfiguration(CommonViewConfiguration commonViewConfiguration) { - this.commonViewConfiguration = commonViewConfiguration; - } - public AgreementViewInfo composeViewConfiguration(ComposeViewConfiguration composeViewConfiguration) { this.composeViewConfiguration = composeViewConfiguration; return this; @@ -153,6 +120,24 @@ public void setComposeViewConfiguration(ComposeViewConfiguration composeViewConf this.composeViewConfiguration = composeViewConfiguration; } + public AgreementViewInfo commonViewConfiguration(CommonViewConfiguration commonViewConfiguration) { + this.commonViewConfiguration = commonViewConfiguration; + return this; + } + + /** + * Common view configuration for all the available views + * @return commonViewConfiguration + **/ + @ApiModelProperty(value = "Common view configuration for all the available views") + public CommonViewConfiguration getCommonViewConfiguration() { + return commonViewConfiguration; + } + + public void setCommonViewConfiguration(CommonViewConfiguration commonViewConfiguration) { + this.commonViewConfiguration = commonViewConfiguration; + } + public AgreementViewInfo name(NameEnum name) { this.name = name; return this; @@ -181,14 +166,14 @@ public boolean equals(java.lang.Object o) { return false; } AgreementViewInfo agreementViewInfo = (AgreementViewInfo) o; - return Objects.equals(this.commonViewConfiguration, agreementViewInfo.commonViewConfiguration) && - Objects.equals(this.composeViewConfiguration, agreementViewInfo.composeViewConfiguration) && + return Objects.equals(this.composeViewConfiguration, agreementViewInfo.composeViewConfiguration) && + Objects.equals(this.commonViewConfiguration, agreementViewInfo.commonViewConfiguration) && Objects.equals(this.name, agreementViewInfo.name); } @Override public int hashCode() { - return Objects.hash(commonViewConfiguration, composeViewConfiguration, name); + return Objects.hash(composeViewConfiguration, commonViewConfiguration, name); } @@ -197,8 +182,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class AgreementViewInfo {\n"); - sb.append(" commonViewConfiguration: ").append(toIndentedString(commonViewConfiguration)).append("\n"); sb.append(" composeViewConfiguration: ").append(toIndentedString(composeViewConfiguration)).append("\n"); + sb.append(" commonViewConfiguration: ").append(toIndentedString(commonViewConfiguration)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/agreements/AgreementViews.java b/src/main/java/io/swagger/client/model/agreements/AgreementViews.java index 2109e0b..04f5db6 100755 --- a/src/main/java/io/swagger/client/model/agreements/AgreementViews.java +++ b/src/main/java/io/swagger/client/model/agreements/AgreementViews.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * AgreementViews */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class AgreementViews { @SerializedName("agreementViewList") private List agreementViewList = null; diff --git a/src/main/java/io/swagger/client/model/agreements/CCParticipantInfo.java b/src/main/java/io/swagger/client/model/agreements/CCParticipantInfo.java index f9a455a..5aaac7c 100755 --- a/src/main/java/io/swagger/client/model/agreements/CCParticipantInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/CCParticipantInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,54 +26,60 @@ /** * CCParticipantInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class CCParticipantInfo { - @SerializedName("company") - private String company = null; + @SerializedName("participantId") + private String participantId = null; - @SerializedName("email") - private String email = null; + @SerializedName("hidden") + private Boolean hidden = null; @SerializedName("name") private String name = null; - @SerializedName("participantId") - private String participantId = null; + @SerializedName("self") + private Boolean self = null; - public CCParticipantInfo company(String company) { - this.company = company; + @SerializedName("company") + private String company = null; + + @SerializedName("email") + private String email = null; + + public CCParticipantInfo participantId(String participantId) { + this.participantId = participantId; return this; } /** - * Company of the CC participant, if available. - * @return company + * The unique identifier of the CC participant of the agreement. + * @return participantId **/ - @ApiModelProperty(value = "Company of the CC participant, if available.") - public String getCompany() { - return company; + @ApiModelProperty(value = " The unique identifier of the CC participant of the agreement.") + public String getParticipantId() { + return participantId; } - public void setCompany(String company) { - this.company = company; + public void setParticipantId(String participantId) { + this.participantId = participantId; } - public CCParticipantInfo email(String email) { - this.email = email; + public CCParticipantInfo hidden(Boolean hidden) { + this.hidden = hidden; return this; } /** - * Email of the CC participant of the agreement - * @return email + * True if the agreement is hidden for the user that is calling the API. Only returned if self is true. + * @return hidden **/ - @ApiModelProperty(value = "Email of the CC participant of the agreement") - public String getEmail() { - return email; + @ApiModelProperty(value = "True if the agreement is hidden for the user that is calling the API. Only returned if self is true.") + public Boolean isHidden() { + return hidden; } - public void setEmail(String email) { - this.email = email; + public void setHidden(Boolean hidden) { + this.hidden = hidden; } public CCParticipantInfo name(String name) { @@ -109,22 +100,58 @@ public void setName(String name) { this.name = name; } - public CCParticipantInfo participantId(String participantId) { - this.participantId = participantId; + public CCParticipantInfo self(Boolean self) { + this.self = self; return this; } /** - * The unique identifier of the CC participant of the agreement. - * @return participantId + * True if the CC participant is the same user that is calling the API. + * @return self **/ - @ApiModelProperty(value = " The unique identifier of the CC participant of the agreement.") - public String getParticipantId() { - return participantId; + @ApiModelProperty(value = "True if the CC participant is the same user that is calling the API.") + public Boolean isSelf() { + return self; } - public void setParticipantId(String participantId) { - this.participantId = participantId; + public void setSelf(Boolean self) { + this.self = self; + } + + public CCParticipantInfo company(String company) { + this.company = company; + return this; + } + + /** + * Company of the CC participant, if available. + * @return company + **/ + @ApiModelProperty(value = "Company of the CC participant, if available.") + public String getCompany() { + return company; + } + + public void setCompany(String company) { + this.company = company; + } + + public CCParticipantInfo email(String email) { + this.email = email; + return this; + } + + /** + * Email of the CC participant of the agreement + * @return email + **/ + @ApiModelProperty(value = "Email of the CC participant of the agreement") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; } @@ -137,15 +164,17 @@ public boolean equals(java.lang.Object o) { return false; } CCParticipantInfo ccParticipantInfo = (CCParticipantInfo) o; - return Objects.equals(this.company, ccParticipantInfo.company) && - Objects.equals(this.email, ccParticipantInfo.email) && + return Objects.equals(this.participantId, ccParticipantInfo.participantId) && + Objects.equals(this.hidden, ccParticipantInfo.hidden) && Objects.equals(this.name, ccParticipantInfo.name) && - Objects.equals(this.participantId, ccParticipantInfo.participantId); + Objects.equals(this.self, ccParticipantInfo.self) && + Objects.equals(this.company, ccParticipantInfo.company) && + Objects.equals(this.email, ccParticipantInfo.email); } @Override public int hashCode() { - return Objects.hash(company, email, name, participantId); + return Objects.hash(participantId, hidden, name, self, company, email); } @@ -154,10 +183,12 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class CCParticipantInfo {\n"); + sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); + sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" self: ").append(toIndentedString(self)).append("\n"); sb.append(" company: ").append(toIndentedString(company)).append("\n"); sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/CombinedDocumentPagesInfo.java b/src/main/java/io/swagger/client/model/agreements/CombinedDocumentPagesInfo.java index 49257dd..c8b265f 100755 --- a/src/main/java/io/swagger/client/model/agreements/CombinedDocumentPagesInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/CombinedDocumentPagesInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * CombinedDocumentPagesInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class CombinedDocumentPagesInfo { @SerializedName("documentPagesInfo") private List documentPagesInfo = null; diff --git a/src/main/java/io/swagger/client/model/agreements/CommonViewConfiguration.java b/src/main/java/io/swagger/client/model/agreements/CommonViewConfiguration.java index 6a3ea2b..55df0cb 100755 --- a/src/main/java/io/swagger/client/model/agreements/CommonViewConfiguration.java +++ b/src/main/java/io/swagger/client/model/agreements/CommonViewConfiguration.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,17 +26,17 @@ /** * CommonViewConfiguration */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class CommonViewConfiguration { @SerializedName("autoLoginUser") private Boolean autoLoginUser = null; - @SerializedName("locale") - private String locale = null; - @SerializedName("noChrome") private Boolean noChrome = null; + @SerializedName("locale") + private String locale = null; + public CommonViewConfiguration autoLoginUser(Boolean autoLoginUser) { this.autoLoginUser = autoLoginUser; return this; @@ -70,24 +55,6 @@ public void setAutoLoginUser(Boolean autoLoginUser) { this.autoLoginUser = autoLoginUser; } - public CommonViewConfiguration locale(String locale) { - this.locale = locale; - return this; - } - - /** - * Message template locale - * @return locale - **/ - @ApiModelProperty(value = "Message template locale") - public String getLocale() { - return locale; - } - - public void setLocale(String locale) { - this.locale = locale; - } - public CommonViewConfiguration noChrome(Boolean noChrome) { this.noChrome = noChrome; return this; @@ -106,6 +73,24 @@ public void setNoChrome(Boolean noChrome) { this.noChrome = noChrome; } + public CommonViewConfiguration locale(String locale) { + this.locale = locale; + return this; + } + + /** + * Message template locale + * @return locale + **/ + @ApiModelProperty(value = "Message template locale") + public String getLocale() { + return locale; + } + + public void setLocale(String locale) { + this.locale = locale; + } + @Override public boolean equals(java.lang.Object o) { @@ -117,13 +102,13 @@ public boolean equals(java.lang.Object o) { } CommonViewConfiguration commonViewConfiguration = (CommonViewConfiguration) o; return Objects.equals(this.autoLoginUser, commonViewConfiguration.autoLoginUser) && - Objects.equals(this.locale, commonViewConfiguration.locale) && - Objects.equals(this.noChrome, commonViewConfiguration.noChrome); + Objects.equals(this.noChrome, commonViewConfiguration.noChrome) && + Objects.equals(this.locale, commonViewConfiguration.locale); } @Override public int hashCode() { - return Objects.hash(autoLoginUser, locale, noChrome); + return Objects.hash(autoLoginUser, noChrome, locale); } @@ -133,8 +118,8 @@ public String toString() { sb.append("class CommonViewConfiguration {\n"); sb.append(" autoLoginUser: ").append(toIndentedString(autoLoginUser)).append("\n"); - sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); sb.append(" noChrome: ").append(toIndentedString(noChrome)).append("\n"); + sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/ComposeViewConfiguration.java b/src/main/java/io/swagger/client/model/agreements/ComposeViewConfiguration.java index d593f23..763184a 100755 --- a/src/main/java/io/swagger/client/model/agreements/ComposeViewConfiguration.java +++ b/src/main/java/io/swagger/client/model/agreements/ComposeViewConfiguration.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,7 @@ /** * ComposeViewConfiguration */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class ComposeViewConfiguration { @SerializedName("fileUploadOptions") private FileUploadOptions fileUploadOptions = null; diff --git a/src/main/java/io/swagger/client/model/agreements/DelegatedParticipantInfo.java b/src/main/java/io/swagger/client/model/agreements/DelegatedParticipantInfo.java index 940f77a..6b94040 100755 --- a/src/main/java/io/swagger/client/model/agreements/DelegatedParticipantInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/DelegatedParticipantInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,7 @@ /** * DelegatedParticipantInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class DelegatedParticipantInfo { @SerializedName("email") private String email = null; diff --git a/src/main/java/io/swagger/client/model/agreements/DelegatedParticipantSecurityOption.java b/src/main/java/io/swagger/client/model/agreements/DelegatedParticipantSecurityOption.java index 3935aef..8673d9c 100755 --- a/src/main/java/io/swagger/client/model/agreements/DelegatedParticipantSecurityOption.java +++ b/src/main/java/io/swagger/client/model/agreements/DelegatedParticipantSecurityOption.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,7 @@ /** * DelegatedParticipantSecurityOption */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class DelegatedParticipantSecurityOption { @SerializedName("phoneInfo") private PhoneInfo phoneInfo = null; diff --git a/src/main/java/io/swagger/client/model/agreements/DelegatedParticipantSetInfo.java b/src/main/java/io/swagger/client/model/agreements/DelegatedParticipantSetInfo.java index 097c5a1..293a46d 100755 --- a/src/main/java/io/swagger/client/model/agreements/DelegatedParticipantSetInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/DelegatedParticipantSetInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,13 +29,31 @@ /** * DelegatedParticipantSetInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class DelegatedParticipantSetInfo { + @SerializedName("privateMessage") + private String privateMessage = null; + @SerializedName("memberInfos") private List memberInfos = null; - @SerializedName("privateMessage") - private String privateMessage = null; + public DelegatedParticipantSetInfo privateMessage(String privateMessage) { + this.privateMessage = privateMessage; + return this; + } + + /** + * Participant set's private message - all participants in the set will receive the same message. This cannot be changed as part of the PUT call. + * @return privateMessage + **/ + @ApiModelProperty(value = "Participant set's private message - all participants in the set will receive the same message. This cannot be changed as part of the PUT call.") + public String getPrivateMessage() { + return privateMessage; + } + + public void setPrivateMessage(String privateMessage) { + this.privateMessage = privateMessage; + } public DelegatedParticipantSetInfo memberInfos(List memberInfos) { this.memberInfos = memberInfos; @@ -78,24 +81,6 @@ public void setMemberInfos(List memberInfos) { this.memberInfos = memberInfos; } - public DelegatedParticipantSetInfo privateMessage(String privateMessage) { - this.privateMessage = privateMessage; - return this; - } - - /** - * Participant set's private message - all participants in the set will receive the same message. This cannot be changed as part of the PUT call. - * @return privateMessage - **/ - @ApiModelProperty(value = "Participant set's private message - all participants in the set will receive the same message. This cannot be changed as part of the PUT call.") - public String getPrivateMessage() { - return privateMessage; - } - - public void setPrivateMessage(String privateMessage) { - this.privateMessage = privateMessage; - } - @Override public boolean equals(java.lang.Object o) { @@ -106,13 +91,13 @@ public boolean equals(java.lang.Object o) { return false; } DelegatedParticipantSetInfo delegatedParticipantSetInfo = (DelegatedParticipantSetInfo) o; - return Objects.equals(this.memberInfos, delegatedParticipantSetInfo.memberInfos) && - Objects.equals(this.privateMessage, delegatedParticipantSetInfo.privateMessage); + return Objects.equals(this.privateMessage, delegatedParticipantSetInfo.privateMessage) && + Objects.equals(this.memberInfos, delegatedParticipantSetInfo.memberInfos); } @Override public int hashCode() { - return Objects.hash(memberInfos, privateMessage); + return Objects.hash(privateMessage, memberInfos); } @@ -121,8 +106,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DelegatedParticipantSetInfo {\n"); - sb.append(" memberInfos: ").append(toIndentedString(memberInfos)).append("\n"); sb.append(" privateMessage: ").append(toIndentedString(privateMessage)).append("\n"); + sb.append(" memberInfos: ").append(toIndentedString(memberInfos)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/DelegationResponse.java b/src/main/java/io/swagger/client/model/agreements/DelegationResponse.java index d4e25d2..2e73bf8 100755 --- a/src/main/java/io/swagger/client/model/agreements/DelegationResponse.java +++ b/src/main/java/io/swagger/client/model/agreements/DelegationResponse.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,7 @@ * A JSON that contains the id of newly created delegated participant set */ @ApiModel(description = "A JSON that contains the id of newly created delegated participant set") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class DelegationResponse { @SerializedName("id") private String id = null; diff --git a/src/main/java/io/swagger/client/model/agreements/DetailedParticipantInfo.java b/src/main/java/io/swagger/client/model/agreements/DetailedParticipantInfo.java index 23cbd22..63d0c69 100755 --- a/src/main/java/io/swagger/client/model/agreements/DetailedParticipantInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/DetailedParticipantInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -38,36 +23,43 @@ import io.swagger.annotations.ApiModelProperty; import io.swagger.client.model.agreements.ParticipantSecurityOption; import java.io.IOException; +import java.util.Date; /** * DetailedParticipantInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class DetailedParticipantInfo { - @SerializedName("company") - private String company = null; + @SerializedName("createdDate") + private Date createdDate = null; - @SerializedName("email") - private String email = null; + @SerializedName("hidden") + private Boolean hidden = null; - @SerializedName("fax") - private String fax = null; + @SerializedName("name") + private String name = null; + + @SerializedName("self") + private Boolean self = null; + + @SerializedName("company") + private String company = null; @SerializedName("id") private String id = null; - @SerializedName("name") - private String name = null; - @SerializedName("privateMessage") private String privateMessage = null; + @SerializedName("userId") + private String userId = null; + + @SerializedName("email") + private String email = null; + @SerializedName("securityOption") private ParticipantSecurityOption securityOption = null; - @SerializedName("self") - private Boolean self = null; - /** * The status of the participant. This cannot be changed as part of the PUT call. New participants will be ignored if added with a REPLACED status. */ @@ -118,94 +110,112 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; - public DetailedParticipantInfo company(String company) { - this.company = company; + public DetailedParticipantInfo createdDate(Date createdDate) { + this.createdDate = createdDate; return this; } /** - * The company of the participant, if available. This cannot be changed as part of the PUT call. - * @return company + * The date when the participant was added. This will be returned as part of GET call but is ignored if passed as part of PUT call. + * @return createdDate **/ - @ApiModelProperty(value = "The company of the participant, if available. This cannot be changed as part of the PUT call.") - public String getCompany() { - return company; + @ApiModelProperty(value = "The date when the participant was added. This will be returned as part of GET call but is ignored if passed as part of PUT call.") + public Date getCreatedDate() { + return createdDate; } - public void setCompany(String company) { - this.company = company; + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; } - public DetailedParticipantInfo email(String email) { - this.email = email; + public DetailedParticipantInfo hidden(Boolean hidden) { + this.hidden = hidden; return this; } /** - * Email of the participant. In case of modifying a participant set (PUT) this is a required field. In case of GET, this is the required field and will always be returned unless it is a fax workflow (legacy agreements) that were created using fax as input - * @return email + * True if the agreement is hidden for the user that is calling the API. Only returned if self is true. Ignored (not required) if modifying a participant (PUT). + * @return hidden **/ - @ApiModelProperty(value = "Email of the participant. In case of modifying a participant set (PUT) this is a required field. In case of GET, this is the required field and will always be returned unless it is a fax workflow (legacy agreements) that were created using fax as input") - public String getEmail() { - return email; + @ApiModelProperty(value = "True if the agreement is hidden for the user that is calling the API. Only returned if self is true. Ignored (not required) if modifying a participant (PUT).") + public Boolean isHidden() { + return hidden; } - public void setEmail(String email) { - this.email = email; + public void setHidden(Boolean hidden) { + this.hidden = hidden; } - public DetailedParticipantInfo fax(String fax) { - this.fax = fax; + public DetailedParticipantInfo name(String name) { + this.name = name; return this; } /** - * Fax of the participant. New Agreements can not be created with fax option. This is only returned for legacy agreements created with fax as participants - * @return fax + * The name of the participant, if available. This cannot be changed as part of the PUT call. + * @return name **/ - @ApiModelProperty(value = "Fax of the participant. New Agreements can not be created with fax option. This is only returned for legacy agreements created with fax as participants") - public String getFax() { - return fax; + @ApiModelProperty(value = "The name of the participant, if available. This cannot be changed as part of the PUT call.") + public String getName() { + return name; } - public void setFax(String fax) { - this.fax = fax; + public void setName(String name) { + this.name = name; } - public DetailedParticipantInfo id(String id) { - this.id = id; + public DetailedParticipantInfo self(Boolean self) { + this.self = self; return this; } /** - * The unique identifier of the participant. This will be returned as part of Get call but is not mandatory to be passed as part of PUT call for agreements/{id}/members/participantSets/{id}. - * @return id + * True if this participant is the same user that is calling the API. Returned as part of Get. Ignored (not required) if modifying a participant set (PUT). + * @return self **/ - @ApiModelProperty(value = "The unique identifier of the participant. This will be returned as part of Get call but is not mandatory to be passed as part of PUT call for agreements/{id}/members/participantSets/{id}.") - public String getId() { - return id; + @ApiModelProperty(value = "True if this participant is the same user that is calling the API. Returned as part of Get. Ignored (not required) if modifying a participant set (PUT).") + public Boolean isSelf() { + return self; } - public void setId(String id) { - this.id = id; + public void setSelf(Boolean self) { + this.self = self; } - public DetailedParticipantInfo name(String name) { - this.name = name; + public DetailedParticipantInfo company(String company) { + this.company = company; return this; } /** - * The name of the participant, if available. This cannot be changed as part of the PUT call. - * @return name + * The company of the participant, if available. This cannot be changed as part of the PUT call. + * @return company **/ - @ApiModelProperty(value = "The name of the participant, if available. This cannot be changed as part of the PUT call.") - public String getName() { - return name; + @ApiModelProperty(value = "The company of the participant, if available. This cannot be changed as part of the PUT call.") + public String getCompany() { + return company; } - public void setName(String name) { - this.name = name; + public void setCompany(String company) { + this.company = company; + } + + public DetailedParticipantInfo id(String id) { + this.id = id; + return this; + } + + /** + * The unique identifier of the participant. This will be returned as part of Get call but is not mandatory to be passed as part of PUT call for agreements/{id}/members/participantSets/{id}. + * @return id + **/ + @ApiModelProperty(value = "The unique identifier of the participant. This will be returned as part of Get call but is not mandatory to be passed as part of PUT call for agreements/{id}/members/participantSets/{id}.") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; } public DetailedParticipantInfo privateMessage(String privateMessage) { @@ -226,40 +236,58 @@ public void setPrivateMessage(String privateMessage) { this.privateMessage = privateMessage; } - public DetailedParticipantInfo securityOption(ParticipantSecurityOption securityOption) { - this.securityOption = securityOption; + public DetailedParticipantInfo userId(String userId) { + this.userId = userId; return this; } /** - * Security options that apply to the participant. - * @return securityOption + * The user ID of the participant. This will be returned as part of GET call but is ignored if passed as part of PUT call. + * @return userId **/ - @ApiModelProperty(value = "Security options that apply to the participant.") - public ParticipantSecurityOption getSecurityOption() { - return securityOption; + @ApiModelProperty(value = "The user ID of the participant. This will be returned as part of GET call but is ignored if passed as part of PUT call.") + public String getUserId() { + return userId; } - public void setSecurityOption(ParticipantSecurityOption securityOption) { - this.securityOption = securityOption; + public void setUserId(String userId) { + this.userId = userId; } - public DetailedParticipantInfo self(Boolean self) { - this.self = self; + public DetailedParticipantInfo email(String email) { + this.email = email; return this; } /** - * True if this participant is the same user that is calling the API. Returned as part of Get. Ignored (not required) if modifying a participant set (PUT). - * @return self + * Email of the participant. In case of modifying a participant set (PUT) this is a required field. In case of GET, this is the required field and will always be returned unless it is a fax workflow (legacy agreements) that were created using fax as input + * @return email **/ - @ApiModelProperty(value = "True if this participant is the same user that is calling the API. Returned as part of Get. Ignored (not required) if modifying a participant set (PUT).") - public Boolean isSelf() { - return self; + @ApiModelProperty(value = "Email of the participant. In case of modifying a participant set (PUT) this is a required field. In case of GET, this is the required field and will always be returned unless it is a fax workflow (legacy agreements) that were created using fax as input") + public String getEmail() { + return email; } - public void setSelf(Boolean self) { - this.self = self; + public void setEmail(String email) { + this.email = email; + } + + public DetailedParticipantInfo securityOption(ParticipantSecurityOption securityOption) { + this.securityOption = securityOption; + return this; + } + + /** + * Security options that apply to the participant. + * @return securityOption + **/ + @ApiModelProperty(value = "Security options that apply to the participant.") + public ParticipantSecurityOption getSecurityOption() { + return securityOption; + } + + public void setSecurityOption(ParticipantSecurityOption securityOption) { + this.securityOption = securityOption; } public DetailedParticipantInfo status(StatusEnum status) { @@ -290,20 +318,22 @@ public boolean equals(java.lang.Object o) { return false; } DetailedParticipantInfo detailedParticipantInfo = (DetailedParticipantInfo) o; - return Objects.equals(this.company, detailedParticipantInfo.company) && - Objects.equals(this.email, detailedParticipantInfo.email) && - Objects.equals(this.fax, detailedParticipantInfo.fax) && - Objects.equals(this.id, detailedParticipantInfo.id) && + return Objects.equals(this.createdDate, detailedParticipantInfo.createdDate) && + Objects.equals(this.hidden, detailedParticipantInfo.hidden) && Objects.equals(this.name, detailedParticipantInfo.name) && + Objects.equals(this.self, detailedParticipantInfo.self) && + Objects.equals(this.company, detailedParticipantInfo.company) && + Objects.equals(this.id, detailedParticipantInfo.id) && Objects.equals(this.privateMessage, detailedParticipantInfo.privateMessage) && + Objects.equals(this.userId, detailedParticipantInfo.userId) && + Objects.equals(this.email, detailedParticipantInfo.email) && Objects.equals(this.securityOption, detailedParticipantInfo.securityOption) && - Objects.equals(this.self, detailedParticipantInfo.self) && Objects.equals(this.status, detailedParticipantInfo.status); } @Override public int hashCode() { - return Objects.hash(company, email, fax, id, name, privateMessage, securityOption, self, status); + return Objects.hash(createdDate, hidden, name, self, company, id, privateMessage, userId, email, securityOption, status); } @@ -312,14 +342,16 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DetailedParticipantInfo {\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" self: ").append(toIndentedString(self)).append("\n"); sb.append(" company: ").append(toIndentedString(company)).append("\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" fax: ").append(toIndentedString(fax)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" privateMessage: ").append(toIndentedString(privateMessage)).append("\n"); + sb.append(" userId: ").append(toIndentedString(userId)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); - sb.append(" self: ").append(toIndentedString(self)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/agreements/DetailedParticipantSetInfo.java b/src/main/java/io/swagger/client/model/agreements/DetailedParticipantSetInfo.java index 3668c44..e5e4e83 100755 --- a/src/main/java/io/swagger/client/model/agreements/DetailedParticipantSetInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/DetailedParticipantSetInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,23 +29,8 @@ /** * DetailedParticipantSetInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class DetailedParticipantSetInfo { - @SerializedName("id") - private String id = null; - - @SerializedName("memberInfos") - private List memberInfos = null; - - @SerializedName("name") - private String name = null; - - @SerializedName("order") - private Integer order = null; - - @SerializedName("privateMessage") - private String privateMessage = null; - /** * Role assumed by all participants in the set (signer, approver etc.). This cannot be changed as part of the PUT call. */ @@ -131,6 +101,21 @@ public RoleEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("role") private RoleEnum role = null; + @SerializedName("name") + private String name = null; + + @SerializedName("id") + private String id = null; + + @SerializedName("privateMessage") + private String privateMessage = null; + + @SerializedName("memberInfos") + private List memberInfos = null; + + @SerializedName("order") + private Integer order = null; + /** * The agreement status with respect to the participant set. This cannot be changed as part of the PUT call. */ @@ -205,48 +190,22 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; - public DetailedParticipantSetInfo id(String id) { - this.id = id; - return this; - } - - /** - * The unique identifier of the participant set. This cannot be changed as part of the PUT call. - * @return id - **/ - @ApiModelProperty(value = "The unique identifier of the participant set. This cannot be changed as part of the PUT call.") - public String getId() { - return id; - } - - public void setId(String id) { - this.id = id; - } - - public DetailedParticipantSetInfo memberInfos(List memberInfos) { - this.memberInfos = memberInfos; - return this; - } - - public DetailedParticipantSetInfo addMemberInfosItem(DetailedParticipantInfo memberInfosItem) { - if (this.memberInfos == null) { - this.memberInfos = new ArrayList(); - } - this.memberInfos.add(memberInfosItem); + public DetailedParticipantSetInfo role(RoleEnum role) { + this.role = role; return this; } /** - * Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set - * @return memberInfos + * Role assumed by all participants in the set (signer, approver etc.). This cannot be changed as part of the PUT call. + * @return role **/ - @ApiModelProperty(value = "Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set") - public List getMemberInfos() { - return memberInfos; + @ApiModelProperty(value = "Role assumed by all participants in the set (signer, approver etc.). This cannot be changed as part of the PUT call.") + public RoleEnum getRole() { + return role; } - public void setMemberInfos(List memberInfos) { - this.memberInfos = memberInfos; + public void setRole(RoleEnum role) { + this.role = role; } public DetailedParticipantSetInfo name(String name) { @@ -267,22 +226,22 @@ public void setName(String name) { this.name = name; } - public DetailedParticipantSetInfo order(Integer order) { - this.order = order; + public DetailedParticipantSetInfo id(String id) { + this.id = id; return this; } /** - * Index indicating sequential signing group (specified for hybrid routing). This cannot be changed as part of the PUT call. - * @return order + * The unique identifier of the participant set. This cannot be changed as part of the PUT call. + * @return id **/ - @ApiModelProperty(value = "Index indicating sequential signing group (specified for hybrid routing). This cannot be changed as part of the PUT call.") - public Integer getOrder() { - return order; + @ApiModelProperty(value = "The unique identifier of the participant set. This cannot be changed as part of the PUT call.") + public String getId() { + return id; } - public void setOrder(Integer order) { - this.order = order; + public void setId(String id) { + this.id = id; } public DetailedParticipantSetInfo privateMessage(String privateMessage) { @@ -303,22 +262,48 @@ public void setPrivateMessage(String privateMessage) { this.privateMessage = privateMessage; } - public DetailedParticipantSetInfo role(RoleEnum role) { - this.role = role; + public DetailedParticipantSetInfo memberInfos(List memberInfos) { + this.memberInfos = memberInfos; + return this; + } + + public DetailedParticipantSetInfo addMemberInfosItem(DetailedParticipantInfo memberInfosItem) { + if (this.memberInfos == null) { + this.memberInfos = new ArrayList(); + } + this.memberInfos.add(memberInfosItem); return this; } /** - * Role assumed by all participants in the set (signer, approver etc.). This cannot be changed as part of the PUT call. - * @return role + * Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set + * @return memberInfos **/ - @ApiModelProperty(value = "Role assumed by all participants in the set (signer, approver etc.). This cannot be changed as part of the PUT call.") - public RoleEnum getRole() { - return role; + @ApiModelProperty(value = "Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set") + public List getMemberInfos() { + return memberInfos; } - public void setRole(RoleEnum role) { - this.role = role; + public void setMemberInfos(List memberInfos) { + this.memberInfos = memberInfos; + } + + public DetailedParticipantSetInfo order(Integer order) { + this.order = order; + return this; + } + + /** + * Index indicating sequential signing group (specified for hybrid routing). This cannot be changed as part of the PUT call. + * @return order + **/ + @ApiModelProperty(value = "Index indicating sequential signing group (specified for hybrid routing). This cannot be changed as part of the PUT call.") + public Integer getOrder() { + return order; + } + + public void setOrder(Integer order) { + this.order = order; } public DetailedParticipantSetInfo status(StatusEnum status) { @@ -349,18 +334,18 @@ public boolean equals(java.lang.Object o) { return false; } DetailedParticipantSetInfo detailedParticipantSetInfo = (DetailedParticipantSetInfo) o; - return Objects.equals(this.id, detailedParticipantSetInfo.id) && - Objects.equals(this.memberInfos, detailedParticipantSetInfo.memberInfos) && + return Objects.equals(this.role, detailedParticipantSetInfo.role) && Objects.equals(this.name, detailedParticipantSetInfo.name) && - Objects.equals(this.order, detailedParticipantSetInfo.order) && + Objects.equals(this.id, detailedParticipantSetInfo.id) && Objects.equals(this.privateMessage, detailedParticipantSetInfo.privateMessage) && - Objects.equals(this.role, detailedParticipantSetInfo.role) && + Objects.equals(this.memberInfos, detailedParticipantSetInfo.memberInfos) && + Objects.equals(this.order, detailedParticipantSetInfo.order) && Objects.equals(this.status, detailedParticipantSetInfo.status); } @Override public int hashCode() { - return Objects.hash(id, memberInfos, name, order, privateMessage, role, status); + return Objects.hash(role, name, id, privateMessage, memberInfos, order, status); } @@ -369,12 +354,12 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DetailedParticipantSetInfo {\n"); + sb.append(" role: ").append(toIndentedString(role)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" privateMessage: ").append(toIndentedString(privateMessage)).append("\n"); sb.append(" memberInfos: ").append(toIndentedString(memberInfos)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" order: ").append(toIndentedString(order)).append("\n"); - sb.append(" privateMessage: ").append(toIndentedString(privateMessage)).append("\n"); - sb.append(" role: ").append(toIndentedString(role)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/agreements/DeviceLocation.java b/src/main/java/io/swagger/client/model/agreements/DeviceLocation.java index 61f11ad..96decaf 100755 --- a/src/main/java/io/swagger/client/model/agreements/DeviceLocation.java +++ b/src/main/java/io/swagger/client/model/agreements/DeviceLocation.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * DeviceLocation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class DeviceLocation { @SerializedName("latitude") private Float latitude = null; diff --git a/src/main/java/io/swagger/client/model/agreements/DigitalSignatureInfo.java b/src/main/java/io/swagger/client/model/agreements/DigitalSignatureInfo.java index 2e51aa8..8b4f6b8 100755 --- a/src/main/java/io/swagger/client/model/agreements/DigitalSignatureInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/DigitalSignatureInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,16 +26,34 @@ /** * DigitalSignatureInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class DigitalSignatureInfo { + @SerializedName("name") + private String name = null; + @SerializedName("company") private String company = null; @SerializedName("email") private String email = null; - @SerializedName("name") - private String name = null; + public DigitalSignatureInfo name(String name) { + this.name = name; + return this; + } + + /** + * Name captured during digital signing + * @return name + **/ + @ApiModelProperty(value = "Name captured during digital signing") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } public DigitalSignatureInfo company(String company) { this.company = company; @@ -88,24 +91,6 @@ public void setEmail(String email) { this.email = email; } - public DigitalSignatureInfo name(String name) { - this.name = name; - return this; - } - - /** - * Name captured during digital signing - * @return name - **/ - @ApiModelProperty(value = "Name captured during digital signing") - public String getName() { - return name; - } - - public void setName(String name) { - this.name = name; - } - @Override public boolean equals(java.lang.Object o) { @@ -116,14 +101,14 @@ public boolean equals(java.lang.Object o) { return false; } DigitalSignatureInfo digitalSignatureInfo = (DigitalSignatureInfo) o; - return Objects.equals(this.company, digitalSignatureInfo.company) && - Objects.equals(this.email, digitalSignatureInfo.email) && - Objects.equals(this.name, digitalSignatureInfo.name); + return Objects.equals(this.name, digitalSignatureInfo.name) && + Objects.equals(this.company, digitalSignatureInfo.company) && + Objects.equals(this.email, digitalSignatureInfo.email); } @Override public int hashCode() { - return Objects.hash(company, email, name); + return Objects.hash(name, company, email); } @@ -132,9 +117,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DigitalSignatureInfo {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" company: ").append(toIndentedString(company)).append("\n"); sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/DisplayParticipantInfo.java b/src/main/java/io/swagger/client/model/agreements/DisplayParticipantInfo.java index 8557277..4303515 100755 --- a/src/main/java/io/swagger/client/model/agreements/DisplayParticipantInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/DisplayParticipantInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,16 +26,34 @@ /** * DisplayParticipantInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class DisplayParticipantInfo { + @SerializedName("fullName") + private String fullName = null; + @SerializedName("company") private String company = null; @SerializedName("email") private String email = null; - @SerializedName("fullName") - private String fullName = null; + public DisplayParticipantInfo fullName(String fullName) { + this.fullName = fullName; + return this; + } + + /** + * Displays the full name of the user, if available. + * @return fullName + **/ + @ApiModelProperty(value = "Displays the full name of the user, if available. ") + public String getFullName() { + return fullName; + } + + public void setFullName(String fullName) { + this.fullName = fullName; + } public DisplayParticipantInfo company(String company) { this.company = company; @@ -88,24 +91,6 @@ public void setEmail(String email) { this.email = email; } - public DisplayParticipantInfo fullName(String fullName) { - this.fullName = fullName; - return this; - } - - /** - * Displays the full name of the user, if available. - * @return fullName - **/ - @ApiModelProperty(value = "Displays the full name of the user, if available. ") - public String getFullName() { - return fullName; - } - - public void setFullName(String fullName) { - this.fullName = fullName; - } - @Override public boolean equals(java.lang.Object o) { @@ -116,14 +101,14 @@ public boolean equals(java.lang.Object o) { return false; } DisplayParticipantInfo displayParticipantInfo = (DisplayParticipantInfo) o; - return Objects.equals(this.company, displayParticipantInfo.company) && - Objects.equals(this.email, displayParticipantInfo.email) && - Objects.equals(this.fullName, displayParticipantInfo.fullName); + return Objects.equals(this.fullName, displayParticipantInfo.fullName) && + Objects.equals(this.company, displayParticipantInfo.company) && + Objects.equals(this.email, displayParticipantInfo.email); } @Override public int hashCode() { - return Objects.hash(company, email, fullName); + return Objects.hash(fullName, company, email); } @@ -132,9 +117,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DisplayParticipantInfo {\n"); + sb.append(" fullName: ").append(toIndentedString(fullName)).append("\n"); sb.append(" company: ").append(toIndentedString(company)).append("\n"); sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" fullName: ").append(toIndentedString(fullName)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/DisplayParticipantSetInfo.java b/src/main/java/io/swagger/client/model/agreements/DisplayParticipantSetInfo.java index 330c91c..c4900f2 100755 --- a/src/main/java/io/swagger/client/model/agreements/DisplayParticipantSetInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/DisplayParticipantSetInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * DisplayParticipantSetInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class DisplayParticipantSetInfo { @SerializedName("displayUserSetMemberInfos") private List displayUserSetMemberInfos = null; diff --git a/src/main/java/io/swagger/client/model/agreements/Document.java b/src/main/java/io/swagger/client/model/agreements/Document.java index b802536..b6a06ce 100755 --- a/src/main/java/io/swagger/client/model/agreements/Document.java +++ b/src/main/java/io/swagger/client/model/agreements/Document.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -37,12 +22,22 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; +import java.util.Date; /** * Document */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class Document { + @SerializedName("numPages") + private Integer numPages = null; + + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("name") + private String name = null; + @SerializedName("id") private String id = null; @@ -52,11 +47,59 @@ public class Document { @SerializedName("mimeType") private String mimeType = null; - @SerializedName("name") - private String name = null; + public Document numPages(Integer numPages) { + this.numPages = numPages; + return this; + } - @SerializedName("numPages") - private Integer numPages = null; + /** + * Number of pages in the document + * @return numPages + **/ + @ApiModelProperty(value = "Number of pages in the document") + public Integer getNumPages() { + return numPages; + } + + public void setNumPages(Integer numPages) { + this.numPages = numPages; + } + + public Document createdDate(Date createdDate) { + this.createdDate = createdDate; + return this; + } + + /** + * The date the document was created + * @return createdDate + **/ + @ApiModelProperty(value = "The date the document was created") + public Date getCreatedDate() { + return createdDate; + } + + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } + + public Document name(String name) { + this.name = name; + return this; + } + + /** + * Name of the original document uploaded. This is returned in GET but not accepted back in PUT + * @return name + **/ + @ApiModelProperty(value = "Name of the original document uploaded. This is returned in GET but not accepted back in PUT") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } public Document id(String id) { this.id = id; @@ -112,42 +155,6 @@ public void setMimeType(String mimeType) { this.mimeType = mimeType; } - public Document name(String name) { - this.name = name; - return this; - } - - /** - * Name of the original document uploaded. This is returned in GET but not accepted back in PUT - * @return name - **/ - @ApiModelProperty(value = "Name of the original document uploaded. This is returned in GET but not accepted back in PUT") - public String getName() { - return name; - } - - public void setName(String name) { - this.name = name; - } - - public Document numPages(Integer numPages) { - this.numPages = numPages; - return this; - } - - /** - * Number of pages in the document - * @return numPages - **/ - @ApiModelProperty(value = "Number of pages in the document") - public Integer getNumPages() { - return numPages; - } - - public void setNumPages(Integer numPages) { - this.numPages = numPages; - } - @Override public boolean equals(java.lang.Object o) { @@ -158,16 +165,17 @@ public boolean equals(java.lang.Object o) { return false; } Document document = (Document) o; - return Objects.equals(this.id, document.id) && - Objects.equals(this.label, document.label) && - Objects.equals(this.mimeType, document.mimeType) && + return Objects.equals(this.numPages, document.numPages) && + Objects.equals(this.createdDate, document.createdDate) && Objects.equals(this.name, document.name) && - Objects.equals(this.numPages, document.numPages); + Objects.equals(this.id, document.id) && + Objects.equals(this.label, document.label) && + Objects.equals(this.mimeType, document.mimeType); } @Override public int hashCode() { - return Objects.hash(id, label, mimeType, name, numPages); + return Objects.hash(numPages, createdDate, name, id, label, mimeType); } @@ -176,11 +184,12 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class Document {\n"); + sb.append(" numPages: ").append(toIndentedString(numPages)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" label: ").append(toIndentedString(label)).append("\n"); sb.append(" mimeType: ").append(toIndentedString(mimeType)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" numPages: ").append(toIndentedString(numPages)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/DocumentImageUrls.java b/src/main/java/io/swagger/client/model/agreements/DocumentImageUrls.java index eef18c2..3f16472 100755 --- a/src/main/java/io/swagger/client/model/agreements/DocumentImageUrls.java +++ b/src/main/java/io/swagger/client/model/agreements/DocumentImageUrls.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,8 +29,14 @@ /** * DocumentImageUrls */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class DocumentImageUrls { + @SerializedName("imageURLs") + private List imageURLs = null; + + @SerializedName("imagesAvailable") + private Boolean imagesAvailable = null; + /** * ImageSize corresponding to the imageUrl returned */ @@ -110,30 +101,6 @@ public ImageSizeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("imageSize") private ImageSizeEnum imageSize = null; - @SerializedName("imageURLs") - private List imageURLs = null; - - @SerializedName("imagesAvailable") - private Boolean imagesAvailable = null; - - public DocumentImageUrls imageSize(ImageSizeEnum imageSize) { - this.imageSize = imageSize; - return this; - } - - /** - * ImageSize corresponding to the imageUrl returned - * @return imageSize - **/ - @ApiModelProperty(value = "ImageSize corresponding to the imageUrl returned ") - public ImageSizeEnum getImageSize() { - return imageSize; - } - - public void setImageSize(ImageSizeEnum imageSize) { - this.imageSize = imageSize; - } - public DocumentImageUrls imageURLs(List imageURLs) { this.imageURLs = imageURLs; return this; @@ -178,6 +145,24 @@ public void setImagesAvailable(Boolean imagesAvailable) { this.imagesAvailable = imagesAvailable; } + public DocumentImageUrls imageSize(ImageSizeEnum imageSize) { + this.imageSize = imageSize; + return this; + } + + /** + * ImageSize corresponding to the imageUrl returned + * @return imageSize + **/ + @ApiModelProperty(value = "ImageSize corresponding to the imageUrl returned ") + public ImageSizeEnum getImageSize() { + return imageSize; + } + + public void setImageSize(ImageSizeEnum imageSize) { + this.imageSize = imageSize; + } + @Override public boolean equals(java.lang.Object o) { @@ -188,14 +173,14 @@ public boolean equals(java.lang.Object o) { return false; } DocumentImageUrls documentImageUrls = (DocumentImageUrls) o; - return Objects.equals(this.imageSize, documentImageUrls.imageSize) && - Objects.equals(this.imageURLs, documentImageUrls.imageURLs) && - Objects.equals(this.imagesAvailable, documentImageUrls.imagesAvailable); + return Objects.equals(this.imageURLs, documentImageUrls.imageURLs) && + Objects.equals(this.imagesAvailable, documentImageUrls.imagesAvailable) && + Objects.equals(this.imageSize, documentImageUrls.imageSize); } @Override public int hashCode() { - return Objects.hash(imageSize, imageURLs, imagesAvailable); + return Objects.hash(imageURLs, imagesAvailable, imageSize); } @@ -204,9 +189,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DocumentImageUrls {\n"); - sb.append(" imageSize: ").append(toIndentedString(imageSize)).append("\n"); sb.append(" imageURLs: ").append(toIndentedString(imageURLs)).append("\n"); sb.append(" imagesAvailable: ").append(toIndentedString(imagesAvailable)).append("\n"); + sb.append(" imageSize: ").append(toIndentedString(imageSize)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/DocumentImageUrlsInfo.java b/src/main/java/io/swagger/client/model/agreements/DocumentImageUrlsInfo.java index 1c5a57a..c6360b1 100755 --- a/src/main/java/io/swagger/client/model/agreements/DocumentImageUrlsInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/DocumentImageUrlsInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,31 +29,13 @@ /** * DocumentImageUrlsInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class DocumentImageUrlsInfo { - @SerializedName("documentId") - private String documentId = null; - @SerializedName("documentImageUrlsList") private List documentImageUrlsList = null; - public DocumentImageUrlsInfo documentId(String documentId) { - this.documentId = documentId; - return this; - } - - /** - * Id of the document - * @return documentId - **/ - @ApiModelProperty(value = "Id of the document") - public String getDocumentId() { - return documentId; - } - - public void setDocumentId(String documentId) { - this.documentId = documentId; - } + @SerializedName("documentId") + private String documentId = null; public DocumentImageUrlsInfo documentImageUrlsList(List documentImageUrlsList) { this.documentImageUrlsList = documentImageUrlsList; @@ -96,6 +63,24 @@ public void setDocumentImageUrlsList(List documentImageUrlsLi this.documentImageUrlsList = documentImageUrlsList; } + public DocumentImageUrlsInfo documentId(String documentId) { + this.documentId = documentId; + return this; + } + + /** + * Id of the document + * @return documentId + **/ + @ApiModelProperty(value = "Id of the document") + public String getDocumentId() { + return documentId; + } + + public void setDocumentId(String documentId) { + this.documentId = documentId; + } + @Override public boolean equals(java.lang.Object o) { @@ -106,13 +91,13 @@ public boolean equals(java.lang.Object o) { return false; } DocumentImageUrlsInfo documentImageUrlsInfo = (DocumentImageUrlsInfo) o; - return Objects.equals(this.documentId, documentImageUrlsInfo.documentId) && - Objects.equals(this.documentImageUrlsList, documentImageUrlsInfo.documentImageUrlsList); + return Objects.equals(this.documentImageUrlsList, documentImageUrlsInfo.documentImageUrlsList) && + Objects.equals(this.documentId, documentImageUrlsInfo.documentId); } @Override public int hashCode() { - return Objects.hash(documentId, documentImageUrlsList); + return Objects.hash(documentImageUrlsList, documentId); } @@ -121,8 +106,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DocumentImageUrlsInfo {\n"); - sb.append(" documentId: ").append(toIndentedString(documentId)).append("\n"); sb.append(" documentImageUrlsList: ").append(toIndentedString(documentImageUrlsList)).append("\n"); + sb.append(" documentId: ").append(toIndentedString(documentId)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/DocumentPageInfo.java b/src/main/java/io/swagger/client/model/agreements/DocumentPageInfo.java index 01966f3..c4d63fb 100755 --- a/src/main/java/io/swagger/client/model/agreements/DocumentPageInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/DocumentPageInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,55 +26,19 @@ /** * DocumentPageInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class DocumentPageInfo { - @SerializedName("height") - private Double height = null; - - @SerializedName("index") - private Integer index = null; - @SerializedName("rotation") private Double rotation = null; @SerializedName("width") private Double width = null; - public DocumentPageInfo height(Double height) { - this.height = height; - return this; - } - - /** - * Height of the page - * @return height - **/ - @ApiModelProperty(value = "Height of the page") - public Double getHeight() { - return height; - } - - public void setHeight(Double height) { - this.height = height; - } - - public DocumentPageInfo index(Integer index) { - this.index = index; - return this; - } - - /** - * Index of the page in combined document starting from 1 - * @return index - **/ - @ApiModelProperty(value = "Index of the page in combined document starting from 1") - public Integer getIndex() { - return index; - } + @SerializedName("index") + private Integer index = null; - public void setIndex(Integer index) { - this.index = index; - } + @SerializedName("height") + private Double height = null; public DocumentPageInfo rotation(Double rotation) { this.rotation = rotation; @@ -127,6 +76,42 @@ public void setWidth(Double width) { this.width = width; } + public DocumentPageInfo index(Integer index) { + this.index = index; + return this; + } + + /** + * Index of the page in combined document starting from 1 + * @return index + **/ + @ApiModelProperty(value = "Index of the page in combined document starting from 1") + public Integer getIndex() { + return index; + } + + public void setIndex(Integer index) { + this.index = index; + } + + public DocumentPageInfo height(Double height) { + this.height = height; + return this; + } + + /** + * Height of the page + * @return height + **/ + @ApiModelProperty(value = "Height of the page") + public Double getHeight() { + return height; + } + + public void setHeight(Double height) { + this.height = height; + } + @Override public boolean equals(java.lang.Object o) { @@ -137,15 +122,15 @@ public boolean equals(java.lang.Object o) { return false; } DocumentPageInfo documentPageInfo = (DocumentPageInfo) o; - return Objects.equals(this.height, documentPageInfo.height) && + return Objects.equals(this.rotation, documentPageInfo.rotation) && + Objects.equals(this.width, documentPageInfo.width) && Objects.equals(this.index, documentPageInfo.index) && - Objects.equals(this.rotation, documentPageInfo.rotation) && - Objects.equals(this.width, documentPageInfo.width); + Objects.equals(this.height, documentPageInfo.height); } @Override public int hashCode() { - return Objects.hash(height, index, rotation, width); + return Objects.hash(rotation, width, index, height); } @@ -154,10 +139,10 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DocumentPageInfo {\n"); - sb.append(" height: ").append(toIndentedString(height)).append("\n"); - sb.append(" index: ").append(toIndentedString(index)).append("\n"); sb.append(" rotation: ").append(toIndentedString(rotation)).append("\n"); sb.append(" width: ").append(toIndentedString(width)).append("\n"); + sb.append(" index: ").append(toIndentedString(index)).append("\n"); + sb.append(" height: ").append(toIndentedString(height)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/DocumentUrl.java b/src/main/java/io/swagger/client/model/agreements/DocumentUrl.java index 218cf27..fb5733f 100755 --- a/src/main/java/io/swagger/client/model/agreements/DocumentUrl.java +++ b/src/main/java/io/swagger/client/model/agreements/DocumentUrl.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * DocumentUrl */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class DocumentUrl { @SerializedName("url") private String url = null; diff --git a/src/main/java/io/swagger/client/model/agreements/DocumentsImageUrlsInfo.java b/src/main/java/io/swagger/client/model/agreements/DocumentsImageUrlsInfo.java index 58ab0c4..7516e13 100755 --- a/src/main/java/io/swagger/client/model/agreements/DocumentsImageUrlsInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/DocumentsImageUrlsInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,39 +29,13 @@ /** * DocumentsImageUrlsInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class DocumentsImageUrlsInfo { - @SerializedName("originalDocumentsImageUrlsInfo") - private List originalDocumentsImageUrlsInfo = null; - @SerializedName("supportingDocumentsImageUrlsInfo") private List supportingDocumentsImageUrlsInfo = null; - public DocumentsImageUrlsInfo originalDocumentsImageUrlsInfo(List originalDocumentsImageUrlsInfo) { - this.originalDocumentsImageUrlsInfo = originalDocumentsImageUrlsInfo; - return this; - } - - public DocumentsImageUrlsInfo addOriginalDocumentsImageUrlsInfoItem(DocumentImageUrlsInfo originalDocumentsImageUrlsInfoItem) { - if (this.originalDocumentsImageUrlsInfo == null) { - this.originalDocumentsImageUrlsInfo = new ArrayList(); - } - this.originalDocumentsImageUrlsInfo.add(originalDocumentsImageUrlsInfoItem); - return this; - } - - /** - * A list of original document image URLs info. - * @return originalDocumentsImageUrlsInfo - **/ - @ApiModelProperty(value = "A list of original document image URLs info.") - public List getOriginalDocumentsImageUrlsInfo() { - return originalDocumentsImageUrlsInfo; - } - - public void setOriginalDocumentsImageUrlsInfo(List originalDocumentsImageUrlsInfo) { - this.originalDocumentsImageUrlsInfo = originalDocumentsImageUrlsInfo; - } + @SerializedName("originalDocumentsImageUrlsInfo") + private List originalDocumentsImageUrlsInfo = null; public DocumentsImageUrlsInfo supportingDocumentsImageUrlsInfo(List supportingDocumentsImageUrlsInfo) { this.supportingDocumentsImageUrlsInfo = supportingDocumentsImageUrlsInfo; @@ -104,6 +63,32 @@ public void setSupportingDocumentsImageUrlsInfo(List supp this.supportingDocumentsImageUrlsInfo = supportingDocumentsImageUrlsInfo; } + public DocumentsImageUrlsInfo originalDocumentsImageUrlsInfo(List originalDocumentsImageUrlsInfo) { + this.originalDocumentsImageUrlsInfo = originalDocumentsImageUrlsInfo; + return this; + } + + public DocumentsImageUrlsInfo addOriginalDocumentsImageUrlsInfoItem(DocumentImageUrlsInfo originalDocumentsImageUrlsInfoItem) { + if (this.originalDocumentsImageUrlsInfo == null) { + this.originalDocumentsImageUrlsInfo = new ArrayList(); + } + this.originalDocumentsImageUrlsInfo.add(originalDocumentsImageUrlsInfoItem); + return this; + } + + /** + * A list of original document image URLs info. + * @return originalDocumentsImageUrlsInfo + **/ + @ApiModelProperty(value = "A list of original document image URLs info.") + public List getOriginalDocumentsImageUrlsInfo() { + return originalDocumentsImageUrlsInfo; + } + + public void setOriginalDocumentsImageUrlsInfo(List originalDocumentsImageUrlsInfo) { + this.originalDocumentsImageUrlsInfo = originalDocumentsImageUrlsInfo; + } + @Override public boolean equals(java.lang.Object o) { @@ -114,13 +99,13 @@ public boolean equals(java.lang.Object o) { return false; } DocumentsImageUrlsInfo documentsImageUrlsInfo = (DocumentsImageUrlsInfo) o; - return Objects.equals(this.originalDocumentsImageUrlsInfo, documentsImageUrlsInfo.originalDocumentsImageUrlsInfo) && - Objects.equals(this.supportingDocumentsImageUrlsInfo, documentsImageUrlsInfo.supportingDocumentsImageUrlsInfo); + return Objects.equals(this.supportingDocumentsImageUrlsInfo, documentsImageUrlsInfo.supportingDocumentsImageUrlsInfo) && + Objects.equals(this.originalDocumentsImageUrlsInfo, documentsImageUrlsInfo.originalDocumentsImageUrlsInfo); } @Override public int hashCode() { - return Objects.hash(originalDocumentsImageUrlsInfo, supportingDocumentsImageUrlsInfo); + return Objects.hash(supportingDocumentsImageUrlsInfo, originalDocumentsImageUrlsInfo); } @@ -129,8 +114,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DocumentsImageUrlsInfo {\n"); - sb.append(" originalDocumentsImageUrlsInfo: ").append(toIndentedString(originalDocumentsImageUrlsInfo)).append("\n"); sb.append(" supportingDocumentsImageUrlsInfo: ").append(toIndentedString(supportingDocumentsImageUrlsInfo)).append("\n"); + sb.append(" originalDocumentsImageUrlsInfo: ").append(toIndentedString(originalDocumentsImageUrlsInfo)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/EmailOption.java b/src/main/java/io/swagger/client/model/agreements/EmailOption.java index 6b73fda..6743e23 100755 --- a/src/main/java/io/swagger/client/model/agreements/EmailOption.java +++ b/src/main/java/io/swagger/client/model/agreements/EmailOption.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,7 @@ /** * EmailOption */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class EmailOption { @SerializedName("sendOptions") private SendOptions sendOptions = null; diff --git a/src/main/java/io/swagger/client/model/agreements/ExternalId.java b/src/main/java/io/swagger/client/model/agreements/ExternalId.java index 4f19525..19acece 100755 --- a/src/main/java/io/swagger/client/model/agreements/ExternalId.java +++ b/src/main/java/io/swagger/client/model/agreements/ExternalId.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * ExternalId */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class ExternalId { @SerializedName("id") private String id = null; diff --git a/src/main/java/io/swagger/client/model/agreements/FetchedAgreementInfo.java b/src/main/java/io/swagger/client/model/agreements/FetchedAgreementInfo.java new file mode 100644 index 0000000..5d0f7a5 --- /dev/null +++ b/src/main/java/io/swagger/client/model/agreements/FetchedAgreementInfo.java @@ -0,0 +1,1144 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.agreements; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.agreements.AgreementCcInfo; +import io.swagger.client.model.agreements.EmailOption; +import io.swagger.client.model.agreements.ExternalId; +import io.swagger.client.model.agreements.FileInfo; +import io.swagger.client.model.agreements.MergefieldInfo; +import io.swagger.client.model.agreements.OfflineDeviceInfo; +import io.swagger.client.model.agreements.ParticipantSetInfo; +import io.swagger.client.model.agreements.PostSignOption; +import io.swagger.client.model.agreements.SecurityOption; +import io.swagger.client.model.agreements.VaultingInfo; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +/** + * FetchedAgreementInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") +public class FetchedAgreementInfo { + @SerializedName("groupId") + private String groupId = null; + + @SerializedName("locale") + private String locale = null; + + /** + * The kind of agreement + */ + @JsonAdapter(TypeEnum.Adapter.class) + public enum TypeEnum { + AGREEMENT("AGREEMENT"), + + MEGASIGN_CHILD("MEGASIGN_CHILD"), + + WIDGET_INSTANCE("WIDGET_INSTANCE"); + + private String value; + + TypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static TypeEnum fromValue(String text) { + for (TypeEnum b : TypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public TypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return TypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("type") + private TypeEnum type = null; + + @SerializedName("vaultingInfo") + private VaultingInfo vaultingInfo = null; + + @SerializedName("securityOption") + private SecurityOption securityOption = null; + + @SerializedName("postSignOption") + private PostSignOption postSignOption = null; + + @SerializedName("ccs") + private List ccs = null; + + @SerializedName("documentVisibilityEnabled") + private Boolean documentVisibilityEnabled = null; + + @SerializedName("isDocumentRetentionApplied") + private Boolean isDocumentRetentionApplied = null; + + @SerializedName("hasSignerIdentityReport") + private Boolean hasSignerIdentityReport = null; + + @SerializedName("lastEventDate") + private Date lastEventDate = null; + + @SerializedName("senderEmail") + private String senderEmail = null; + + @SerializedName("id") + private String id = null; + + /** + * The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID + */ + @JsonAdapter(StateEnum.Adapter.class) + public enum StateEnum { + AUTHORING("AUTHORING"), + + DRAFT("DRAFT"), + + IN_PROCESS("IN_PROCESS"); + + private String value; + + StateEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static StateEnum fromValue(String text) { + for (StateEnum b : StateEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public StateEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return StateEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("state") + private StateEnum state = null; + + @SerializedName("mergeFieldInfo") + private List mergeFieldInfo = null; + + @SerializedName("firstReminderDelay") + private Integer firstReminderDelay = null; + + @SerializedName("emailOption") + private EmailOption emailOption = null; + + /** + * Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system + */ + @JsonAdapter(SignatureTypeEnum.Adapter.class) + public enum SignatureTypeEnum { + ESIGN("ESIGN"), + + WRITTEN("WRITTEN"); + + private String value; + + SignatureTypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static SignatureTypeEnum fromValue(String text) { + for (SignatureTypeEnum b : SignatureTypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final SignatureTypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public SignatureTypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return SignatureTypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("signatureType") + private SignatureTypeEnum signatureType = null; + + @SerializedName("externalId") + private ExternalId externalId = null; + + @SerializedName("message") + private String message = null; + + @SerializedName("deviceInfo") + private OfflineDeviceInfo deviceInfo = null; + + @SerializedName("parentId") + private String parentId = null; + + /** + * Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used. Should not be provided in offline agreement creation. If provided in PUT as a different value than the current one, an error will be thrown. + */ + @JsonAdapter(ReminderFrequencyEnum.Adapter.class) + public enum ReminderFrequencyEnum { + DAILY_UNTIL_SIGNED("DAILY_UNTIL_SIGNED"), + + WEEKDAILY_UNTIL_SIGNED("WEEKDAILY_UNTIL_SIGNED"), + + EVERY_OTHER_DAY_UNTIL_SIGNED("EVERY_OTHER_DAY_UNTIL_SIGNED"), + + EVERY_THIRD_DAY_UNTIL_SIGNED("EVERY_THIRD_DAY_UNTIL_SIGNED"), + + EVERY_FIFTH_DAY_UNTIL_SIGNED("EVERY_FIFTH_DAY_UNTIL_SIGNED"), + + WEEKLY_UNTIL_SIGNED("WEEKLY_UNTIL_SIGNED"), + + ONCE("ONCE"); + + private String value; + + ReminderFrequencyEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ReminderFrequencyEnum fromValue(String text) { + for (ReminderFrequencyEnum b : ReminderFrequencyEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ReminderFrequencyEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ReminderFrequencyEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ReminderFrequencyEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("reminderFrequency") + private ReminderFrequencyEnum reminderFrequency = null; + + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("participantSetsInfo") + private List participantSetsInfo = null; + + @SerializedName("hasFormFieldData") + private Boolean hasFormFieldData = null; + + @SerializedName("expirationTime") + private Date expirationTime = null; + + @SerializedName("formFieldLayerTemplates") + private List formFieldLayerTemplates = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("fileInfos") + private List fileInfos = null; + + @SerializedName("workflowId") + private String workflowId = null; + + /** + * This is a server generated attribute which provides the detailed status of an agreement. + */ + @JsonAdapter(StatusEnum.Adapter.class) + public enum StatusEnum { + OUT_FOR_SIGNATURE("OUT_FOR_SIGNATURE"), + + OUT_FOR_DELIVERY("OUT_FOR_DELIVERY"), + + OUT_FOR_ACCEPTANCE("OUT_FOR_ACCEPTANCE"), + + OUT_FOR_FORM_FILLING("OUT_FOR_FORM_FILLING"), + + OUT_FOR_APPROVAL("OUT_FOR_APPROVAL"), + + AUTHORING("AUTHORING"), + + CANCELLED("CANCELLED"), + + SIGNED("SIGNED"), + + APPROVED("APPROVED"), + + DELIVERED("DELIVERED"), + + ACCEPTED("ACCEPTED"), + + FORM_FILLED("FORM_FILLED"), + + EXPIRED("EXPIRED"), + + ARCHIVED("ARCHIVED"), + + PREFILL("PREFILL"), + + WIDGET_WAITING_FOR_VERIFICATION("WIDGET_WAITING_FOR_VERIFICATION"), + + DRAFT("DRAFT"), + + DOCUMENTS_NOT_YET_PROCESSED("DOCUMENTS_NOT_YET_PROCESSED"), + + WAITING_FOR_FAXIN("WAITING_FOR_FAXIN"), + + WAITING_FOR_VERIFICATION("WAITING_FOR_VERIFICATION"); + + private String value; + + StatusEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static StatusEnum fromValue(String text) { + for (StatusEnum b : StatusEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public StatusEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return StatusEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("status") + private StatusEnum status = null; + + public FetchedAgreementInfo groupId(String groupId) { + this.groupId = groupId; + return this; + } + + /** + * The unique identifier of the group to which the agreement belongs to. If not provided during agreement creation, primary group of the creator will be used + * @return groupId + **/ + @ApiModelProperty(value = "The unique identifier of the group to which the agreement belongs to. If not provided during agreement creation, primary group of the creator will be used") + public String getGroupId() { + return groupId; + } + + public void setGroupId(String groupId) { + this.groupId = groupId; + } + + public FetchedAgreementInfo locale(String locale) { + this.locale = locale; + return this; + } + + /** + * The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender + * @return locale + **/ + @ApiModelProperty(value = "The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender") + public String getLocale() { + return locale; + } + + public void setLocale(String locale) { + this.locale = locale; + } + + public FetchedAgreementInfo type(TypeEnum type) { + this.type = type; + return this; + } + + /** + * The kind of agreement + * @return type + **/ + @ApiModelProperty(value = "The kind of agreement") + public TypeEnum getType() { + return type; + } + + public void setType(TypeEnum type) { + this.type = type; + } + + public FetchedAgreementInfo vaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; + return this; + } + + /** + * Vaulting properties that allows Adobe Sign to securely store documents with a vault provider + * @return vaultingInfo + **/ + @ApiModelProperty(value = "Vaulting properties that allows Adobe Sign to securely store documents with a vault provider") + public VaultingInfo getVaultingInfo() { + return vaultingInfo; + } + + public void setVaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; + } + + public FetchedAgreementInfo securityOption(SecurityOption securityOption) { + this.securityOption = securityOption; + return this; + } + + /** + * Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation. + * @return securityOption + **/ + @ApiModelProperty(value = "Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation.") + public SecurityOption getSecurityOption() { + return securityOption; + } + + public void setSecurityOption(SecurityOption securityOption) { + this.securityOption = securityOption; + } + + public FetchedAgreementInfo postSignOption(PostSignOption postSignOption) { + this.postSignOption = postSignOption; + return this; + } + + /** + * URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation. + * @return postSignOption + **/ + @ApiModelProperty(value = "URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation.") + public PostSignOption getPostSignOption() { + return postSignOption; + } + + public void setPostSignOption(PostSignOption postSignOption) { + this.postSignOption = postSignOption; + } + + public FetchedAgreementInfo ccs(List ccs) { + this.ccs = ccs; + return this; + } + + public FetchedAgreementInfo addCcsItem(AgreementCcInfo ccsItem) { + if (this.ccs == null) { + this.ccs = new ArrayList(); + } + this.ccs.add(ccsItem); + return this; + } + + /** + * A list of one or more CCs that will be copied in the agreement transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file. Should not be provided in offline agreement creation. + * @return ccs + **/ + @ApiModelProperty(value = "A list of one or more CCs that will be copied in the agreement transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file. Should not be provided in offline agreement creation.") + public List getCcs() { + return ccs; + } + + public void setCcs(List ccs) { + this.ccs = ccs; + } + + public FetchedAgreementInfo documentVisibilityEnabled(Boolean documentVisibilityEnabled) { + this.documentVisibilityEnabled = documentVisibilityEnabled; + return this; + } + + /** + * If set to true, enable limited document visibility. Should not be provided in offline agreement creation. + * @return documentVisibilityEnabled + **/ + @ApiModelProperty(value = "If set to true, enable limited document visibility. Should not be provided in offline agreement creation.") + public Boolean isDocumentVisibilityEnabled() { + return documentVisibilityEnabled; + } + + public void setDocumentVisibilityEnabled(Boolean documentVisibilityEnabled) { + this.documentVisibilityEnabled = documentVisibilityEnabled; + } + + public FetchedAgreementInfo isDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; + return this; + } + + /** + * Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. + * @return isDocumentRetentionApplied + **/ + @ApiModelProperty(value = "Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored.") + public Boolean isIsDocumentRetentionApplied() { + return isDocumentRetentionApplied; + } + + public void setIsDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; + } + + public FetchedAgreementInfo hasSignerIdentityReport(Boolean hasSignerIdentityReport) { + this.hasSignerIdentityReport = hasSignerIdentityReport; + return this; + } + + /** + * True if agreement has signer identity report available. If provided in POST or PUT, it will simply be ignored. + * @return hasSignerIdentityReport + **/ + @ApiModelProperty(value = "True if agreement has signer identity report available. If provided in POST or PUT, it will simply be ignored.") + public Boolean isHasSignerIdentityReport() { + return hasSignerIdentityReport; + } + + public void setHasSignerIdentityReport(Boolean hasSignerIdentityReport) { + this.hasSignerIdentityReport = hasSignerIdentityReport; + } + + public FetchedAgreementInfo lastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; + return this; + } + + /** + * The date of the last event that occurred for this agreement. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return lastEventDate + **/ + @ApiModelProperty(value = "The date of the last event that occurred for this agreement. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getLastEventDate() { + return lastEventDate; + } + + public void setLastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; + } + + public FetchedAgreementInfo senderEmail(String senderEmail) { + this.senderEmail = senderEmail; + return this; + } + + /** + * Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored + * @return senderEmail + **/ + @ApiModelProperty(value = "Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored") + public String getSenderEmail() { + return senderEmail; + } + + public void setSenderEmail(String senderEmail) { + this.senderEmail = senderEmail; + } + + public FetchedAgreementInfo id(String id) { + this.id = id; + return this; + } + + /** + * The unique identifier of the agreement.If provided in POST, it will simply be ignored + * @return id + **/ + @ApiModelProperty(value = "The unique identifier of the agreement.If provided in POST, it will simply be ignored") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public FetchedAgreementInfo state(StateEnum state) { + this.state = state; + return this; + } + + /** + * The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID + * @return state + **/ + @ApiModelProperty(value = "The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID") + public StateEnum getState() { + return state; + } + + public void setState(StateEnum state) { + this.state = state; + } + + public FetchedAgreementInfo mergeFieldInfo(List mergeFieldInfo) { + this.mergeFieldInfo = mergeFieldInfo; + return this; + } + + public FetchedAgreementInfo addMergeFieldInfoItem(MergefieldInfo mergeFieldInfoItem) { + if (this.mergeFieldInfo == null) { + this.mergeFieldInfo = new ArrayList(); + } + this.mergeFieldInfo.add(mergeFieldInfoItem); + return this; + } + + /** + * Optional default values for fields to merge into the document. The values will be presented to the signers for editable fields; for read-only fields the provided values will not be editable during the signing process. Merging data into fields is currently not supported when used with libraryDocumentId or libraryDocumentName. Only file and url are currently supported + * @return mergeFieldInfo + **/ + @ApiModelProperty(value = "Optional default values for fields to merge into the document. The values will be presented to the signers for editable fields; for read-only fields the provided values will not be editable during the signing process. Merging data into fields is currently not supported when used with libraryDocumentId or libraryDocumentName. Only file and url are currently supported") + public List getMergeFieldInfo() { + return mergeFieldInfo; + } + + public void setMergeFieldInfo(List mergeFieldInfo) { + this.mergeFieldInfo = mergeFieldInfo; + } + + public FetchedAgreementInfo firstReminderDelay(Integer firstReminderDelay) { + this.firstReminderDelay = firstReminderDelay; + return this; + } + + /** + * Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation. + * @return firstReminderDelay + **/ + @ApiModelProperty(value = "Integer which specifies the delay in hours before sending the first reminder.
This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.
If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.
i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation.") + public Integer getFirstReminderDelay() { + return firstReminderDelay; + } + + public void setFirstReminderDelay(Integer firstReminderDelay) { + this.firstReminderDelay = firstReminderDelay; + } + + public FetchedAgreementInfo emailOption(EmailOption emailOption) { + this.emailOption = emailOption; + return this; + } + + /** + * Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement. + * @return emailOption + **/ + @ApiModelProperty(value = "Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement.") + public EmailOption getEmailOption() { + return emailOption; + } + + public void setEmailOption(EmailOption emailOption) { + this.emailOption = emailOption; + } + + public FetchedAgreementInfo signatureType(SignatureTypeEnum signatureType) { + this.signatureType = signatureType; + return this; + } + + /** + * Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system + * @return signatureType + **/ + @ApiModelProperty(value = "Specifies the type of signature you would like to request - written or e-signature. The possible values are
ESIGN : Agreement needs to be signed electronically
, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system") + public SignatureTypeEnum getSignatureType() { + return signatureType; + } + + public void setSignatureType(SignatureTypeEnum signatureType) { + this.signatureType = signatureType; + } + + public FetchedAgreementInfo externalId(ExternalId externalId) { + this.externalId = externalId; + return this; + } + + /** + * An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation. + * @return externalId + **/ + @ApiModelProperty(value = "An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation.") + public ExternalId getExternalId() { + return externalId; + } + + public void setExternalId(ExternalId externalId) { + this.externalId = externalId; + } + + public FetchedAgreementInfo message(String message) { + this.message = message; + return this; + } + + /** + * An optional message to the participants, describing what is being sent or why their signature is required + * @return message + **/ + @ApiModelProperty(value = "An optional message to the participants, describing what is being sent or why their signature is required") + public String getMessage() { + return message; + } + + public void setMessage(String message) { + this.message = message; + } + + public FetchedAgreementInfo deviceInfo(OfflineDeviceInfo deviceInfo) { + this.deviceInfo = deviceInfo; + return this; + } + + /** + * Device info of the offline device. It should only be provided in case of offline agreement creation. + * @return deviceInfo + **/ + @ApiModelProperty(value = "Device info of the offline device. It should only be provided in case of offline agreement creation.") + public OfflineDeviceInfo getDeviceInfo() { + return deviceInfo; + } + + public void setDeviceInfo(OfflineDeviceInfo deviceInfo) { + this.deviceInfo = deviceInfo; + } + + public FetchedAgreementInfo parentId(String parentId) { + this.parentId = parentId; + return this; + } + + /** + * The parent id of a megaSign child *OR* the originating id of a widget agreement instance + * @return parentId + **/ + @ApiModelProperty(value = "The parent id of a megaSign child *OR* the originating id of a widget agreement instance") + public String getParentId() { + return parentId; + } + + public void setParentId(String parentId) { + this.parentId = parentId; + } + + public FetchedAgreementInfo reminderFrequency(ReminderFrequencyEnum reminderFrequency) { + this.reminderFrequency = reminderFrequency; + return this; + } + + /** + * Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used. Should not be provided in offline agreement creation. If provided in PUT as a different value than the current one, an error will be thrown. + * @return reminderFrequency + **/ + @ApiModelProperty(value = "Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used. Should not be provided in offline agreement creation. If provided in PUT as a different value than the current one, an error will be thrown.") + public ReminderFrequencyEnum getReminderFrequency() { + return reminderFrequency; + } + + public void setReminderFrequency(ReminderFrequencyEnum reminderFrequency) { + this.reminderFrequency = reminderFrequency; + } + + public FetchedAgreementInfo createdDate(Date createdDate) { + this.createdDate = createdDate; + return this; + } + + /** + * Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return createdDate + **/ + @ApiModelProperty(value = "Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getCreatedDate() { + return createdDate; + } + + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } + + public FetchedAgreementInfo participantSetsInfo(List participantSetsInfo) { + this.participantSetsInfo = participantSetsInfo; + return this; + } + + public FetchedAgreementInfo addParticipantSetsInfoItem(ParticipantSetInfo participantSetsInfoItem) { + if (this.participantSetsInfo == null) { + this.participantSetsInfo = new ArrayList(); + } + this.participantSetsInfo.add(participantSetsInfoItem); + return this; + } + + /** + * A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document + * @return participantSetsInfo + **/ + @ApiModelProperty(value = "A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document") + public List getParticipantSetsInfo() { + return participantSetsInfo; + } + + public void setParticipantSetsInfo(List participantSetsInfo) { + this.participantSetsInfo = participantSetsInfo; + } + + public FetchedAgreementInfo hasFormFieldData(Boolean hasFormFieldData) { + this.hasFormFieldData = hasFormFieldData; + return this; + } + + /** + * True if form field data is present. If provided in POST or PUT, it will simply be ignored. + * @return hasFormFieldData + **/ + @ApiModelProperty(value = "True if form field data is present. If provided in POST or PUT, it will simply be ignored.") + public Boolean isHasFormFieldData() { + return hasFormFieldData; + } + + public void setHasFormFieldData(Boolean hasFormFieldData) { + this.hasFormFieldData = hasFormFieldData; + } + + public FetchedAgreementInfo expirationTime(Date expirationTime) { + this.expirationTime = expirationTime; + return this; + } + + /** + * Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. + * @return expirationTime + **/ + @ApiModelProperty(value = "Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation.") + public Date getExpirationTime() { + return expirationTime; + } + + public void setExpirationTime(Date expirationTime) { + this.expirationTime = expirationTime; + } + + public FetchedAgreementInfo formFieldLayerTemplates(List formFieldLayerTemplates) { + this.formFieldLayerTemplates = formFieldLayerTemplates; + return this; + } + + public FetchedAgreementInfo addFormFieldLayerTemplatesItem(FileInfo formFieldLayerTemplatesItem) { + if (this.formFieldLayerTemplates == null) { + this.formFieldLayerTemplates = new ArrayList(); + } + this.formFieldLayerTemplates.add(formFieldLayerTemplatesItem); + return this; + } + + /** + * Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified + * @return formFieldLayerTemplates + **/ + @ApiModelProperty(value = "Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified") + public List getFormFieldLayerTemplates() { + return formFieldLayerTemplates; + } + + public void setFormFieldLayerTemplates(List formFieldLayerTemplates) { + this.formFieldLayerTemplates = formFieldLayerTemplates; + } + + public FetchedAgreementInfo name(String name) { + this.name = name; + return this; + } + + /** + * The name of the agreement that will be used to identify it, in emails, website and other places + * @return name + **/ + @ApiModelProperty(value = "The name of the agreement that will be used to identify it, in emails, website and other places") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public FetchedAgreementInfo fileInfos(List fileInfos) { + this.fileInfos = fileInfos; + return this; + } + + public FetchedAgreementInfo addFileInfosItem(FileInfo fileInfosItem) { + if (this.fileInfos == null) { + this.fileInfos = new ArrayList(); + } + this.fileInfos.add(fileInfosItem); + return this; + } + + /** + * A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified + * @return fileInfos + **/ + @ApiModelProperty(value = "A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified") + public List getFileInfos() { + return fileInfos; + } + + public void setFileInfos(List fileInfos) { + this.fileInfos = fileInfos; + } + + public FetchedAgreementInfo workflowId(String workflowId) { + this.workflowId = workflowId; + return this; + } + + /** + * The identifier of custom workflow which defines the routing path of an agreement. Should not be provided in offline agreement creation. + * @return workflowId + **/ + @ApiModelProperty(value = "The identifier of custom workflow which defines the routing path of an agreement. Should not be provided in offline agreement creation.") + public String getWorkflowId() { + return workflowId; + } + + public void setWorkflowId(String workflowId) { + this.workflowId = workflowId; + } + + public FetchedAgreementInfo status(StatusEnum status) { + this.status = status; + return this; + } + + /** + * This is a server generated attribute which provides the detailed status of an agreement. + * @return status + **/ + @ApiModelProperty(value = "This is a server generated attribute which provides the detailed status of an agreement.") + public StatusEnum getStatus() { + return status; + } + + public void setStatus(StatusEnum status) { + this.status = status; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FetchedAgreementInfo fetchedAgreementInfo = (FetchedAgreementInfo) o; + return Objects.equals(this.groupId, fetchedAgreementInfo.groupId) && + Objects.equals(this.locale, fetchedAgreementInfo.locale) && + Objects.equals(this.type, fetchedAgreementInfo.type) && + Objects.equals(this.vaultingInfo, fetchedAgreementInfo.vaultingInfo) && + Objects.equals(this.securityOption, fetchedAgreementInfo.securityOption) && + Objects.equals(this.postSignOption, fetchedAgreementInfo.postSignOption) && + Objects.equals(this.ccs, fetchedAgreementInfo.ccs) && + Objects.equals(this.documentVisibilityEnabled, fetchedAgreementInfo.documentVisibilityEnabled) && + Objects.equals(this.isDocumentRetentionApplied, fetchedAgreementInfo.isDocumentRetentionApplied) && + Objects.equals(this.hasSignerIdentityReport, fetchedAgreementInfo.hasSignerIdentityReport) && + Objects.equals(this.lastEventDate, fetchedAgreementInfo.lastEventDate) && + Objects.equals(this.senderEmail, fetchedAgreementInfo.senderEmail) && + Objects.equals(this.id, fetchedAgreementInfo.id) && + Objects.equals(this.state, fetchedAgreementInfo.state) && + Objects.equals(this.mergeFieldInfo, fetchedAgreementInfo.mergeFieldInfo) && + Objects.equals(this.firstReminderDelay, fetchedAgreementInfo.firstReminderDelay) && + Objects.equals(this.emailOption, fetchedAgreementInfo.emailOption) && + Objects.equals(this.signatureType, fetchedAgreementInfo.signatureType) && + Objects.equals(this.externalId, fetchedAgreementInfo.externalId) && + Objects.equals(this.message, fetchedAgreementInfo.message) && + Objects.equals(this.deviceInfo, fetchedAgreementInfo.deviceInfo) && + Objects.equals(this.parentId, fetchedAgreementInfo.parentId) && + Objects.equals(this.reminderFrequency, fetchedAgreementInfo.reminderFrequency) && + Objects.equals(this.createdDate, fetchedAgreementInfo.createdDate) && + Objects.equals(this.participantSetsInfo, fetchedAgreementInfo.participantSetsInfo) && + Objects.equals(this.hasFormFieldData, fetchedAgreementInfo.hasFormFieldData) && + Objects.equals(this.expirationTime, fetchedAgreementInfo.expirationTime) && + Objects.equals(this.formFieldLayerTemplates, fetchedAgreementInfo.formFieldLayerTemplates) && + Objects.equals(this.name, fetchedAgreementInfo.name) && + Objects.equals(this.fileInfos, fetchedAgreementInfo.fileInfos) && + Objects.equals(this.workflowId, fetchedAgreementInfo.workflowId) && + Objects.equals(this.status, fetchedAgreementInfo.status); + } + + @Override + public int hashCode() { + return Objects.hash(groupId, locale, type, vaultingInfo, securityOption, postSignOption, ccs, documentVisibilityEnabled, isDocumentRetentionApplied, hasSignerIdentityReport, lastEventDate, senderEmail, id, state, mergeFieldInfo, firstReminderDelay, emailOption, signatureType, externalId, message, deviceInfo, parentId, reminderFrequency, createdDate, participantSetsInfo, hasFormFieldData, expirationTime, formFieldLayerTemplates, name, fileInfos, workflowId, status); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FetchedAgreementInfo {\n"); + + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); + sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" vaultingInfo: ").append(toIndentedString(vaultingInfo)).append("\n"); + sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); + sb.append(" postSignOption: ").append(toIndentedString(postSignOption)).append("\n"); + sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n"); + sb.append(" documentVisibilityEnabled: ").append(toIndentedString(documentVisibilityEnabled)).append("\n"); + sb.append(" isDocumentRetentionApplied: ").append(toIndentedString(isDocumentRetentionApplied)).append("\n"); + sb.append(" hasSignerIdentityReport: ").append(toIndentedString(hasSignerIdentityReport)).append("\n"); + sb.append(" lastEventDate: ").append(toIndentedString(lastEventDate)).append("\n"); + sb.append(" senderEmail: ").append(toIndentedString(senderEmail)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" state: ").append(toIndentedString(state)).append("\n"); + sb.append(" mergeFieldInfo: ").append(toIndentedString(mergeFieldInfo)).append("\n"); + sb.append(" firstReminderDelay: ").append(toIndentedString(firstReminderDelay)).append("\n"); + sb.append(" emailOption: ").append(toIndentedString(emailOption)).append("\n"); + sb.append(" signatureType: ").append(toIndentedString(signatureType)).append("\n"); + sb.append(" externalId: ").append(toIndentedString(externalId)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" deviceInfo: ").append(toIndentedString(deviceInfo)).append("\n"); + sb.append(" parentId: ").append(toIndentedString(parentId)).append("\n"); + sb.append(" reminderFrequency: ").append(toIndentedString(reminderFrequency)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" participantSetsInfo: ").append(toIndentedString(participantSetsInfo)).append("\n"); + sb.append(" hasFormFieldData: ").append(toIndentedString(hasFormFieldData)).append("\n"); + sb.append(" expirationTime: ").append(toIndentedString(expirationTime)).append("\n"); + sb.append(" formFieldLayerTemplates: ").append(toIndentedString(formFieldLayerTemplates)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); + sb.append(" workflowId: ").append(toIndentedString(workflowId)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/agreements/FileInfo.java b/src/main/java/io/swagger/client/model/agreements/FileInfo.java index ec633b3..d4cf915 100755 --- a/src/main/java/io/swagger/client/model/agreements/FileInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/FileInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -43,57 +28,57 @@ /** * FileInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class FileInfo { + @SerializedName("transientDocumentId") + private String transientDocumentId = null; + @SerializedName("document") private Document document = null; - @SerializedName("label") - private String label = null; - @SerializedName("libraryDocumentId") private String libraryDocumentId = null; - @SerializedName("transientDocumentId") - private String transientDocumentId = null; + @SerializedName("label") + private String label = null; @SerializedName("urlFileInfo") private URLFileInfo urlFileInfo = null; - public FileInfo document(Document document) { - this.document = document; + public FileInfo transientDocumentId(String transientDocumentId) { + this.transientDocumentId = transientDocumentId; return this; } /** - * A document that is associated with the agreement. This field cannot be provided in POST call. In case of GET call, this is the only field returned in the response - * @return document + * ID for a transient document that will be added to the agreement + * @return transientDocumentId **/ - @ApiModelProperty(value = "A document that is associated with the agreement. This field cannot be provided in POST call. In case of GET call, this is the only field returned in the response") - public Document getDocument() { - return document; + @ApiModelProperty(value = "ID for a transient document that will be added to the agreement") + public String getTransientDocumentId() { + return transientDocumentId; } - public void setDocument(Document document) { - this.document = document; + public void setTransientDocumentId(String transientDocumentId) { + this.transientDocumentId = transientDocumentId; } - public FileInfo label(String label) { - this.label = label; + public FileInfo document(Document document) { + this.document = document; return this; } /** - * The unique label value of a file info element. In case of custom workflow this will map a file to corresponding file element in workflow definition. This must be specified in case of custom workflow agreement creation request - * @return label + * A document that is associated with the agreement. This field cannot be provided in POST call. In case of GET call, this is the only field returned in the response + * @return document **/ - @ApiModelProperty(value = "The unique label value of a file info element. In case of custom workflow this will map a file to corresponding file element in workflow definition. This must be specified in case of custom workflow agreement creation request ") - public String getLabel() { - return label; + @ApiModelProperty(value = "A document that is associated with the agreement. This field cannot be provided in POST call. In case of GET call, this is the only field returned in the response") + public Document getDocument() { + return document; } - public void setLabel(String label) { - this.label = label; + public void setDocument(Document document) { + this.document = document; } public FileInfo libraryDocumentId(String libraryDocumentId) { @@ -114,22 +99,22 @@ public void setLibraryDocumentId(String libraryDocumentId) { this.libraryDocumentId = libraryDocumentId; } - public FileInfo transientDocumentId(String transientDocumentId) { - this.transientDocumentId = transientDocumentId; + public FileInfo label(String label) { + this.label = label; return this; } /** - * ID for a transient document that will be added to the agreement - * @return transientDocumentId + * The unique label value of a file info element. In case of custom workflow this will map a file to corresponding file element in workflow definition. This must be specified in case of custom workflow agreement creation request + * @return label **/ - @ApiModelProperty(value = "ID for a transient document that will be added to the agreement") - public String getTransientDocumentId() { - return transientDocumentId; + @ApiModelProperty(value = "The unique label value of a file info element. In case of custom workflow this will map a file to corresponding file element in workflow definition. This must be specified in case of custom workflow agreement creation request ") + public String getLabel() { + return label; } - public void setTransientDocumentId(String transientDocumentId) { - this.transientDocumentId = transientDocumentId; + public void setLabel(String label) { + this.label = label; } public FileInfo urlFileInfo(URLFileInfo urlFileInfo) { @@ -160,16 +145,16 @@ public boolean equals(java.lang.Object o) { return false; } FileInfo fileInfo = (FileInfo) o; - return Objects.equals(this.document, fileInfo.document) && - Objects.equals(this.label, fileInfo.label) && + return Objects.equals(this.transientDocumentId, fileInfo.transientDocumentId) && + Objects.equals(this.document, fileInfo.document) && Objects.equals(this.libraryDocumentId, fileInfo.libraryDocumentId) && - Objects.equals(this.transientDocumentId, fileInfo.transientDocumentId) && + Objects.equals(this.label, fileInfo.label) && Objects.equals(this.urlFileInfo, fileInfo.urlFileInfo); } @Override public int hashCode() { - return Objects.hash(document, label, libraryDocumentId, transientDocumentId, urlFileInfo); + return Objects.hash(transientDocumentId, document, libraryDocumentId, label, urlFileInfo); } @@ -178,10 +163,10 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class FileInfo {\n"); + sb.append(" transientDocumentId: ").append(toIndentedString(transientDocumentId)).append("\n"); sb.append(" document: ").append(toIndentedString(document)).append("\n"); - sb.append(" label: ").append(toIndentedString(label)).append("\n"); sb.append(" libraryDocumentId: ").append(toIndentedString(libraryDocumentId)).append("\n"); - sb.append(" transientDocumentId: ").append(toIndentedString(transientDocumentId)).append("\n"); + sb.append(" label: ").append(toIndentedString(label)).append("\n"); sb.append(" urlFileInfo: ").append(toIndentedString(urlFileInfo)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/agreements/FileUploadOptions.java b/src/main/java/io/swagger/client/model/agreements/FileUploadOptions.java index 7e9ea3f..0e4ae2f 100755 --- a/src/main/java/io/swagger/client/model/agreements/FileUploadOptions.java +++ b/src/main/java/io/swagger/client/model/agreements/FileUploadOptions.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,10 +26,10 @@ /** * FileUploadOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class FileUploadOptions { - @SerializedName("libraryDocument") - private Boolean libraryDocument = null; + @SerializedName("canEditFiles") + private Boolean canEditFiles = null; @SerializedName("localFile") private Boolean localFile = null; @@ -52,22 +37,25 @@ public class FileUploadOptions { @SerializedName("webConnectors") private Boolean webConnectors = null; - public FileUploadOptions libraryDocument(Boolean libraryDocument) { - this.libraryDocument = libraryDocument; + @SerializedName("libraryDocument") + private Boolean libraryDocument = null; + + public FileUploadOptions canEditFiles(Boolean canEditFiles) { + this.canEditFiles = canEditFiles; return this; } /** - * Whether library documents link should appear or not. Default value is taken as true - * @return libraryDocument + * Whether the file upload section can be edited by adding or removing files. Default value is taken as true. Changing the default value will alter the compose page view configuration for this agreement, but is not an access control mechanism + * @return canEditFiles **/ - @ApiModelProperty(value = "Whether library documents link should appear or not. Default value is taken as true") - public Boolean isLibraryDocument() { - return libraryDocument; + @ApiModelProperty(value = "Whether the file upload section can be edited by adding or removing files. Default value is taken as true. Changing the default value will alter the compose page view configuration for this agreement, but is not an access control mechanism") + public Boolean isCanEditFiles() { + return canEditFiles; } - public void setLibraryDocument(Boolean libraryDocument) { - this.libraryDocument = libraryDocument; + public void setCanEditFiles(Boolean canEditFiles) { + this.canEditFiles = canEditFiles; } public FileUploadOptions localFile(Boolean localFile) { @@ -106,6 +94,24 @@ public void setWebConnectors(Boolean webConnectors) { this.webConnectors = webConnectors; } + public FileUploadOptions libraryDocument(Boolean libraryDocument) { + this.libraryDocument = libraryDocument; + return this; + } + + /** + * Whether library documents link should appear or not. Default value is taken as true + * @return libraryDocument + **/ + @ApiModelProperty(value = "Whether library documents link should appear or not. Default value is taken as true") + public Boolean isLibraryDocument() { + return libraryDocument; + } + + public void setLibraryDocument(Boolean libraryDocument) { + this.libraryDocument = libraryDocument; + } + @Override public boolean equals(java.lang.Object o) { @@ -116,14 +122,15 @@ public boolean equals(java.lang.Object o) { return false; } FileUploadOptions fileUploadOptions = (FileUploadOptions) o; - return Objects.equals(this.libraryDocument, fileUploadOptions.libraryDocument) && + return Objects.equals(this.canEditFiles, fileUploadOptions.canEditFiles) && Objects.equals(this.localFile, fileUploadOptions.localFile) && - Objects.equals(this.webConnectors, fileUploadOptions.webConnectors); + Objects.equals(this.webConnectors, fileUploadOptions.webConnectors) && + Objects.equals(this.libraryDocument, fileUploadOptions.libraryDocument); } @Override public int hashCode() { - return Objects.hash(libraryDocument, localFile, webConnectors); + return Objects.hash(canEditFiles, localFile, webConnectors, libraryDocument); } @@ -132,9 +139,10 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class FileUploadOptions {\n"); - sb.append(" libraryDocument: ").append(toIndentedString(libraryDocument)).append("\n"); + sb.append(" canEditFiles: ").append(toIndentedString(canEditFiles)).append("\n"); sb.append(" localFile: ").append(toIndentedString(localFile)).append("\n"); sb.append(" webConnectors: ").append(toIndentedString(webConnectors)).append("\n"); + sb.append(" libraryDocument: ").append(toIndentedString(libraryDocument)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/FormField.java b/src/main/java/io/swagger/client/model/agreements/FormField.java index 7b1a7d1..4d237c8 100755 --- a/src/main/java/io/swagger/client/model/agreements/FormField.java +++ b/src/main/java/io/swagger/client/model/agreements/FormField.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -47,22 +32,28 @@ * A form field for an agreement. */ @ApiModel(description = "A form field for an agreement.") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class FormField { /** - * Alignment of the text. + * The type of radio button (if field is radio button, identified by inputType). */ - @JsonAdapter(AlignmentEnum.Adapter.class) - public enum AlignmentEnum { - LEFT("LEFT"), + @JsonAdapter(RadioCheckTypeEnum.Adapter.class) + public enum RadioCheckTypeEnum { + CIRCLE("CIRCLE"), - RIGHT("RIGHT"), + CHECK("CHECK"), - CENTER("CENTER"); + CROSS("CROSS"), + + DIAMOND("DIAMOND"), + + SQUARE("SQUARE"), + + STAR("STAR"); private String value; - AlignmentEnum(String value) { + RadioCheckTypeEnum(String value) { this.value = value; } @@ -75,8 +66,8 @@ public String toString() { return String.valueOf(value); } - public static AlignmentEnum fromValue(String text) { - for (AlignmentEnum b : AlignmentEnum.values()) { + public static RadioCheckTypeEnum fromValue(String text) { + for (RadioCheckTypeEnum b : RadioCheckTypeEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -84,32 +75,190 @@ public static AlignmentEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final AlignmentEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final RadioCheckTypeEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public AlignmentEnum read(final JsonReader jsonReader) throws IOException { + public RadioCheckTypeEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return AlignmentEnum.fromValue(String.valueOf(value)); + return RadioCheckTypeEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("alignment") - private AlignmentEnum alignment = null; - - @SerializedName("assignee") - private String assignee = null; - - @SerializedName("backgroundColor") - private String backgroundColor = null; + @SerializedName("radioCheckType") + private RadioCheckTypeEnum radioCheckType = null; @SerializedName("borderColor") private String borderColor = null; + @SerializedName("valueExpression") + private String valueExpression = null; + + @SerializedName("maskingText") + private String maskingText = null; + + @SerializedName("defaultValue") + private String defaultValue = null; + + @SerializedName("masked") + private Boolean masked = null; + + @SerializedName("minLength") + private Integer minLength = null; + + /** + * Origin of Form Field + */ + @JsonAdapter(OriginEnum.Adapter.class) + public enum OriginEnum { + AUTHORED("AUTHORED"), + + GENERATED("GENERATED"), + + IMPORTED("IMPORTED"); + + private String value; + + OriginEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static OriginEnum fromValue(String text) { + for (OriginEnum b : OriginEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final OriginEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public OriginEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return OriginEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("origin") + private OriginEnum origin = null; + + @SerializedName("tooltip") + private String tooltip = null; + + @SerializedName("hiddenOptions") + private List hiddenOptions = null; + + @SerializedName("required") + private Boolean required = null; + + @SerializedName("validationData") + private String validationData = null; + + @SerializedName("minValue") + private Double minValue = null; + + @SerializedName("borderWidth") + private Double borderWidth = null; + + @SerializedName("urlOverridable") + private Boolean urlOverridable = null; + + /** + * Input type of the form field + */ + @JsonAdapter(InputTypeEnum.Adapter.class) + public enum InputTypeEnum { + TEXT_FIELD("TEXT_FIELD"), + + MULTILINE("MULTILINE"), + + PASSWORD("PASSWORD"), + + RADIO("RADIO"), + + CHECKBOX("CHECKBOX"), + + DROP_DOWN("DROP_DOWN"), + + LISTBOX("LISTBOX"), + + SIGNATURE("SIGNATURE"), + + PDF_SIGNATURE("PDF_SIGNATURE"), + + BUTTON("BUTTON"), + + BLOCK("BLOCK"), + + FILE_CHOOSER("FILE_CHOOSER"), + + COMB("COMB"), + + INLINE_IMAGE("INLINE_IMAGE"), + + UNSUPPORTED("UNSUPPORTED"); + + private String value; + + InputTypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static InputTypeEnum fromValue(String text) { + for (InputTypeEnum b : InputTypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final InputTypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public InputTypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return InputTypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("inputType") + private InputTypeEnum inputType = null; + /** * Style of the border of the field. */ @@ -166,15 +315,9 @@ public BorderStyleEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("borderStyle") private BorderStyleEnum borderStyle = null; - @SerializedName("borderWidth") - private Double borderWidth = null; - @SerializedName("calculated") private Boolean calculated = null; - @SerializedName("conditionalAction") - private FormFieldConditionalAction conditionalAction = null; - /** * Content Type of the form field. */ @@ -212,7 +355,9 @@ public enum ContentTypeEnum { PAYMENT("PAYMENT"), - DIGITAL_SIGNATURE("DIGITAL_SIGNATURE"); + DIGITAL_SIGNATURE("DIGITAL_SIGNATURE"), + + CALC("CALC"); private String value; @@ -255,26 +400,44 @@ public ContentTypeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("contentType") private ContentTypeEnum contentType = null; - @SerializedName("defaultValue") - private String defaultValue = null; - - @SerializedName("displayFormat") - private String displayFormat = null; - /** - * Format type of the text field. + * Rule for validating the field value. */ - @JsonAdapter(DisplayFormatTypeEnum.Adapter.class) - public enum DisplayFormatTypeEnum { - DEFAULT("DEFAULT"), + @JsonAdapter(ValidationEnum.Adapter.class) + public enum ValidationEnum { + NONE("NONE"), + + STRING("STRING"), + + NUMBER("NUMBER"), DATE("DATE"), - NUMBER("NUMBER"); + DATE_CUSTOM("DATE_CUSTOM"), + + TIME("TIME"), + + ZIP("ZIP"), + + PHONE("PHONE"), + + SOCIAL_SEC("SOCIAL_SEC"), + + EMAIL("EMAIL"), + + CURRENCY("CURRENCY"), + + PERCENT("PERCENT"), + + FORMULA("FORMULA"), + + CUSTOM("CUSTOM"), + + XFA_PICTURE("XFA_PICTURE"); private String value; - DisplayFormatTypeEnum(String value) { + ValidationEnum(String value) { this.value = value; } @@ -287,8 +450,8 @@ public String toString() { return String.valueOf(value); } - public static DisplayFormatTypeEnum fromValue(String text) { - for (DisplayFormatTypeEnum b : DisplayFormatTypeEnum.values()) { + public static ValidationEnum fromValue(String text) { + for (ValidationEnum b : ValidationEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -296,79 +459,49 @@ public static DisplayFormatTypeEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final DisplayFormatTypeEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final ValidationEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public DisplayFormatTypeEnum read(final JsonReader jsonReader) throws IOException { + public ValidationEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return DisplayFormatTypeEnum.fromValue(String.valueOf(value)); + return ValidationEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("displayFormatType") - private DisplayFormatTypeEnum displayFormatType = null; + @SerializedName("validation") + private ValidationEnum validation = null; @SerializedName("displayLabel") private String displayLabel = null; - @SerializedName("fontColor") - private String fontColor = null; - - @SerializedName("fontName") - private String fontName = null; - - @SerializedName("fontSize") - private Double fontSize = null; - - @SerializedName("hiddenOptions") - private List hiddenOptions = null; - @SerializedName("hyperlink") private FormFieldHyperlink hyperlink = null; + @SerializedName("backgroundColor") + private String backgroundColor = null; + + @SerializedName("visible") + private Boolean visible = null; + /** - * Input type of the form field + * Format type of the text field. */ - @JsonAdapter(InputTypeEnum.Adapter.class) - public enum InputTypeEnum { - TEXT_FIELD("TEXT_FIELD"), - - MULTILINE("MULTILINE"), - - PASSWORD("PASSWORD"), - - RADIO("RADIO"), - - CHECKBOX("CHECKBOX"), - - DROP_DOWN("DROP_DOWN"), - - LISTBOX("LISTBOX"), - - SIGNATURE("SIGNATURE"), - - PDF_SIGNATURE("PDF_SIGNATURE"), - - BUTTON("BUTTON"), - - BLOCK("BLOCK"), - - FILE_CHOOSER("FILE_CHOOSER"), - - COMB("COMB"), + @JsonAdapter(DisplayFormatTypeEnum.Adapter.class) + public enum DisplayFormatTypeEnum { + DEFAULT("DEFAULT"), - INLINE_IMAGE("INLINE_IMAGE"), + DATE("DATE"), - UNSUPPORTED("UNSUPPORTED"); + NUMBER("NUMBER"); private String value; - InputTypeEnum(String value) { + DisplayFormatTypeEnum(String value) { this.value = value; } @@ -381,8 +514,8 @@ public String toString() { return String.valueOf(value); } - public static InputTypeEnum fromValue(String text) { - for (InputTypeEnum b : InputTypeEnum.values()) { + public static DisplayFormatTypeEnum fromValue(String text) { + for (DisplayFormatTypeEnum b : DisplayFormatTypeEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -390,61 +523,70 @@ public static InputTypeEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final InputTypeEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final DisplayFormatTypeEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public InputTypeEnum read(final JsonReader jsonReader) throws IOException { + public DisplayFormatTypeEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return InputTypeEnum.fromValue(String.valueOf(value)); + return DisplayFormatTypeEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("inputType") - private InputTypeEnum inputType = null; + @SerializedName("displayFormatType") + private DisplayFormatTypeEnum displayFormatType = null; - @SerializedName("locations") - private List locations = null; + @SerializedName("maxValue") + private Double maxValue = null; - @SerializedName("masked") - private Boolean masked = null; + @SerializedName("validationErrMsg") + private String validationErrMsg = null; - @SerializedName("maskingText") - private String maskingText = null; + @SerializedName("displayFormat") + private String displayFormat = null; - @SerializedName("maxLength") - private Integer maxLength = null; + @SerializedName("visibleOptions") + private List visibleOptions = null; - @SerializedName("maxValue") - private Double maxValue = null; + @SerializedName("readOnly") + private Boolean readOnly = null; - @SerializedName("minLength") - private Integer minLength = null; + @SerializedName("fontName") + private String fontName = null; - @SerializedName("minValue") - private Double minValue = null; + @SerializedName("conditionalAction") + private FormFieldConditionalAction conditionalAction = null; @SerializedName("name") private String name = null; + @SerializedName("fontSize") + private Double fontSize = null; + + @SerializedName("locations") + private List locations = null; + + @SerializedName("assignee") + private String assignee = null; + /** - * Origin of Form Field + * Alignment of the text. */ - @JsonAdapter(OriginEnum.Adapter.class) - public enum OriginEnum { - AUTHORED("AUTHORED"), + @JsonAdapter(AlignmentEnum.Adapter.class) + public enum AlignmentEnum { + LEFT("LEFT"), - GENERATED("GENERATED"), + RIGHT("RIGHT"), - IMPORTED("IMPORTED"); + CENTER("CENTER"); private String value; - OriginEnum(String value) { + AlignmentEnum(String value) { this.value = value; } @@ -457,8 +599,8 @@ public String toString() { return String.valueOf(value); } - public static OriginEnum fromValue(String text) { - for (OriginEnum b : OriginEnum.values()) { + public static AlignmentEnum fromValue(String text) { + for (AlignmentEnum b : AlignmentEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -466,612 +608,485 @@ public static OriginEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final OriginEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final AlignmentEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public OriginEnum read(final JsonReader jsonReader) throws IOException { + public AlignmentEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return OriginEnum.fromValue(String.valueOf(value)); + return AlignmentEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("origin") - private OriginEnum origin = null; - - /** - * The type of radio button (if field is radio button, identified by inputType). - */ - @JsonAdapter(RadioCheckTypeEnum.Adapter.class) - public enum RadioCheckTypeEnum { - CIRCLE("CIRCLE"), - - CHECK("CHECK"), - - CROSS("CROSS"), - - DIAMOND("DIAMOND"), - - SQUARE("SQUARE"), - - STAR("STAR"); + @SerializedName("alignment") + private AlignmentEnum alignment = null; - private String value; + @SerializedName("fontColor") + private String fontColor = null; - RadioCheckTypeEnum(String value) { - this.value = value; - } + @SerializedName("maxLength") + private Integer maxLength = null; - public String getValue() { - return value; - } + public FormField radioCheckType(RadioCheckTypeEnum radioCheckType) { + this.radioCheckType = radioCheckType; + return this; + } - @Override - public String toString() { - return String.valueOf(value); - } + /** + * The type of radio button (if field is radio button, identified by inputType). + * @return radioCheckType + **/ + @ApiModelProperty(value = "The type of radio button (if field is radio button, identified by inputType).") + public RadioCheckTypeEnum getRadioCheckType() { + return radioCheckType; + } - public static RadioCheckTypeEnum fromValue(String text) { - for (RadioCheckTypeEnum b : RadioCheckTypeEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } + public void setRadioCheckType(RadioCheckTypeEnum radioCheckType) { + this.radioCheckType = radioCheckType; + } - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final RadioCheckTypeEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } + public FormField borderColor(String borderColor) { + this.borderColor = borderColor; + return this; + } - @Override - public RadioCheckTypeEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return RadioCheckTypeEnum.fromValue(String.valueOf(value)); - } - } + /** + * Color of the border of the field in RGB or HEX format + * @return borderColor + **/ + @ApiModelProperty(value = "Color of the border of the field in RGB or HEX format") + public String getBorderColor() { + return borderColor; } - @SerializedName("radioCheckType") - private RadioCheckTypeEnum radioCheckType = null; + public void setBorderColor(String borderColor) { + this.borderColor = borderColor; + } - @SerializedName("readOnly") - private Boolean readOnly = null; + public FormField valueExpression(String valueExpression) { + this.valueExpression = valueExpression; + return this; + } - @SerializedName("required") - private Boolean required = null; + /** + * Expression to calculate value of the form field + * @return valueExpression + **/ + @ApiModelProperty(value = "Expression to calculate value of the form field") + public String getValueExpression() { + return valueExpression; + } - @SerializedName("tooltip") - private String tooltip = null; - - @SerializedName("urlOverridable") - private Boolean urlOverridable = null; - - /** - * Rule for validating the field value. - */ - @JsonAdapter(ValidationEnum.Adapter.class) - public enum ValidationEnum { - NONE("NONE"), - - STRING("STRING"), - - NUMBER("NUMBER"), - - DATE("DATE"), - - DATE_CUSTOM("DATE_CUSTOM"), - - TIME("TIME"), - - ZIP("ZIP"), - - PHONE("PHONE"), - - SOCIAL_SEC("SOCIAL_SEC"), - - EMAIL("EMAIL"), - - CURRENCY("CURRENCY"), - - PERCENT("PERCENT"), - - FORMULA("FORMULA"), - - CUSTOM("CUSTOM"), - - XFA_PICTURE("XFA_PICTURE"); - - private String value; - - ValidationEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static ValidationEnum fromValue(String text) { - for (ValidationEnum b : ValidationEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final ValidationEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public ValidationEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return ValidationEnum.fromValue(String.valueOf(value)); - } - } + public void setValueExpression(String valueExpression) { + this.valueExpression = valueExpression; } - @SerializedName("validation") - private ValidationEnum validation = null; - - @SerializedName("validationData") - private String validationData = null; - - @SerializedName("validationErrMsg") - private String validationErrMsg = null; - - @SerializedName("valueExpression") - private String valueExpression = null; - - @SerializedName("visible") - private Boolean visible = null; - - @SerializedName("visibleOptions") - private List visibleOptions = null; - - public FormField alignment(AlignmentEnum alignment) { - this.alignment = alignment; + public FormField maskingText(String maskingText) { + this.maskingText = maskingText; return this; } /** - * Alignment of the text. - * @return alignment + * Text to mask the masked form field + * @return maskingText **/ - @ApiModelProperty(value = "Alignment of the text.") - public AlignmentEnum getAlignment() { - return alignment; + @ApiModelProperty(value = "Text to mask the masked form field") + public String getMaskingText() { + return maskingText; } - public void setAlignment(AlignmentEnum alignment) { - this.alignment = alignment; + public void setMaskingText(String maskingText) { + this.maskingText = maskingText; } - public FormField assignee(String assignee) { - this.assignee = assignee; + public FormField defaultValue(String defaultValue) { + this.defaultValue = defaultValue; return this; } /** - * Who the field is assigned to. Either a participant set id, null, NOBODY or PREFILL. - * @return assignee + * Default value of the form field + * @return defaultValue **/ - @ApiModelProperty(value = "Who the field is assigned to. Either a participant set id, null, NOBODY or PREFILL.") - public String getAssignee() { - return assignee; + @ApiModelProperty(value = "Default value of the form field") + public String getDefaultValue() { + return defaultValue; } - public void setAssignee(String assignee) { - this.assignee = assignee; + public void setDefaultValue(String defaultValue) { + this.defaultValue = defaultValue; } - public FormField backgroundColor(String backgroundColor) { - this.backgroundColor = backgroundColor; + public FormField masked(Boolean masked) { + this.masked = masked; return this; } /** - * Background color of the form field in RGB or HEX format - * @return backgroundColor + * true if the input entered by the signer has to be masked (like password), false if it shouldn't be + * @return masked **/ - @ApiModelProperty(value = "Background color of the form field in RGB or HEX format") - public String getBackgroundColor() { - return backgroundColor; + @ApiModelProperty(value = "true if the input entered by the signer has to be masked (like password), false if it shouldn't be") + public Boolean isMasked() { + return masked; } - public void setBackgroundColor(String backgroundColor) { - this.backgroundColor = backgroundColor; + public void setMasked(Boolean masked) { + this.masked = masked; } - public FormField borderColor(String borderColor) { - this.borderColor = borderColor; + public FormField minLength(Integer minLength) { + this.minLength = minLength; return this; } /** - * Color of the border of the field in RGB or HEX format - * @return borderColor + * Minimum length of the input text field in terms of no. of characters + * @return minLength **/ - @ApiModelProperty(value = "Color of the border of the field in RGB or HEX format") - public String getBorderColor() { - return borderColor; + @ApiModelProperty(value = "Minimum length of the input text field in terms of no. of characters") + public Integer getMinLength() { + return minLength; } - public void setBorderColor(String borderColor) { - this.borderColor = borderColor; + public void setMinLength(Integer minLength) { + this.minLength = minLength; } - public FormField borderStyle(BorderStyleEnum borderStyle) { - this.borderStyle = borderStyle; + public FormField origin(OriginEnum origin) { + this.origin = origin; return this; } /** - * Style of the border of the field. - * @return borderStyle + * Origin of Form Field + * @return origin **/ - @ApiModelProperty(value = "Style of the border of the field.") - public BorderStyleEnum getBorderStyle() { - return borderStyle; + @ApiModelProperty(value = "Origin of Form Field") + public OriginEnum getOrigin() { + return origin; } - public void setBorderStyle(BorderStyleEnum borderStyle) { - this.borderStyle = borderStyle; + public void setOrigin(OriginEnum origin) { + this.origin = origin; } - public FormField borderWidth(Double borderWidth) { - this.borderWidth = borderWidth; + public FormField tooltip(String tooltip) { + this.tooltip = tooltip; return this; } /** - * Width of the border of the field in pixels - * @return borderWidth + * Text that appears while hovering over the field + * @return tooltip **/ - @ApiModelProperty(value = "Width of the border of the field in pixels") - public Double getBorderWidth() { - return borderWidth; + @ApiModelProperty(value = "Text that appears while hovering over the field") + public String getTooltip() { + return tooltip; } - public void setBorderWidth(Double borderWidth) { - this.borderWidth = borderWidth; + public void setTooltip(String tooltip) { + this.tooltip = tooltip; } - public FormField calculated(Boolean calculated) { - this.calculated = calculated; + public FormField hiddenOptions(List hiddenOptions) { + this.hiddenOptions = hiddenOptions; return this; } - /** - * true if this field's value is calculated from an expression, else false - * @return calculated - **/ - @ApiModelProperty(value = "true if this field's value is calculated from an expression, else false") - public Boolean isCalculated() { - return calculated; - } - - public void setCalculated(Boolean calculated) { - this.calculated = calculated; - } - - public FormField conditionalAction(FormFieldConditionalAction conditionalAction) { - this.conditionalAction = conditionalAction; + public FormField addHiddenOptionsItem(String hiddenOptionsItem) { + if (this.hiddenOptions == null) { + this.hiddenOptions = new ArrayList(); + } + this.hiddenOptions.add(hiddenOptionsItem); return this; } /** - * A predicate (or set of predicates) that determines whether this field is visible and enabled. - * @return conditionalAction + * Text values which are hidden in a drop down form field + * @return hiddenOptions **/ - @ApiModelProperty(value = "A predicate (or set of predicates) that determines whether this field is visible and enabled.") - public FormFieldConditionalAction getConditionalAction() { - return conditionalAction; + @ApiModelProperty(value = "Text values which are hidden in a drop down form field") + public List getHiddenOptions() { + return hiddenOptions; } - public void setConditionalAction(FormFieldConditionalAction conditionalAction) { - this.conditionalAction = conditionalAction; + public void setHiddenOptions(List hiddenOptions) { + this.hiddenOptions = hiddenOptions; } - public FormField contentType(ContentTypeEnum contentType) { - this.contentType = contentType; + public FormField required(Boolean required) { + this.required = required; return this; } /** - * Content Type of the form field. - * @return contentType + * true if it is a mandatory field to be filled by the signer, else false + * @return required **/ - @ApiModelProperty(value = "Content Type of the form field.") - public ContentTypeEnum getContentType() { - return contentType; + @ApiModelProperty(value = "true if it is a mandatory field to be filled by the signer, else false") + public Boolean isRequired() { + return required; } - public void setContentType(ContentTypeEnum contentType) { - this.contentType = contentType; + public void setRequired(Boolean required) { + this.required = required; } - public FormField defaultValue(String defaultValue) { - this.defaultValue = defaultValue; + public FormField validationData(String validationData) { + this.validationData = validationData; return this; } /** - * Default value of the form field - * @return defaultValue + * Further data for validating input with regards to the field's specified format. The contents and interpretation of formatData depends on the value of validation. + * @return validationData **/ - @ApiModelProperty(value = "Default value of the form field") - public String getDefaultValue() { - return defaultValue; + @ApiModelProperty(value = "Further data for validating input with regards to the field's specified format. The contents and interpretation of formatData depends on the value of validation.") + public String getValidationData() { + return validationData; } - public void setDefaultValue(String defaultValue) { - this.defaultValue = defaultValue; + public void setValidationData(String validationData) { + this.validationData = validationData; } - public FormField displayFormat(String displayFormat) { - this.displayFormat = displayFormat; + public FormField minValue(Double minValue) { + this.minValue = minValue; return this; } /** - * Format of the value of the field to be displayed based on the displayFormatType property. - * @return displayFormat + * Lower bound of the number that can be entered by the signer + * @return minValue **/ - @ApiModelProperty(value = "Format of the value of the field to be displayed based on the displayFormatType property.") - public String getDisplayFormat() { - return displayFormat; + @ApiModelProperty(value = "Lower bound of the number that can be entered by the signer") + public Double getMinValue() { + return minValue; } - public void setDisplayFormat(String displayFormat) { - this.displayFormat = displayFormat; + public void setMinValue(Double minValue) { + this.minValue = minValue; } - public FormField displayFormatType(DisplayFormatTypeEnum displayFormatType) { - this.displayFormatType = displayFormatType; + public FormField borderWidth(Double borderWidth) { + this.borderWidth = borderWidth; return this; } /** - * Format type of the text field. - * @return displayFormatType + * Width of the border of the field in pixels + * @return borderWidth **/ - @ApiModelProperty(value = "Format type of the text field.") - public DisplayFormatTypeEnum getDisplayFormatType() { - return displayFormatType; + @ApiModelProperty(value = "Width of the border of the field in pixels") + public Double getBorderWidth() { + return borderWidth; } - public void setDisplayFormatType(DisplayFormatTypeEnum displayFormatType) { - this.displayFormatType = displayFormatType; + public void setBorderWidth(Double borderWidth) { + this.borderWidth = borderWidth; } - public FormField displayLabel(String displayLabel) { - this.displayLabel = displayLabel; + public FormField urlOverridable(Boolean urlOverridable) { + this.urlOverridable = urlOverridable; return this; } /** - * Display label attached to the field - * @return displayLabel + * For web form text fields only - true if the default value may come from the URL, else false + * @return urlOverridable **/ - @ApiModelProperty(value = "Display label attached to the field") - public String getDisplayLabel() { - return displayLabel; + @ApiModelProperty(value = "For web form text fields only - true if the default value may come from the URL, else false") + public Boolean isUrlOverridable() { + return urlOverridable; } - public void setDisplayLabel(String displayLabel) { - this.displayLabel = displayLabel; + public void setUrlOverridable(Boolean urlOverridable) { + this.urlOverridable = urlOverridable; } - public FormField fontColor(String fontColor) { - this.fontColor = fontColor; + public FormField inputType(InputTypeEnum inputType) { + this.inputType = inputType; return this; } /** - * Font color of the form field in RGB or HEX format - * @return fontColor + * Input type of the form field + * @return inputType **/ - @ApiModelProperty(value = "Font color of the form field in RGB or HEX format") - public String getFontColor() { - return fontColor; + @ApiModelProperty(value = "Input type of the form field") + public InputTypeEnum getInputType() { + return inputType; } - public void setFontColor(String fontColor) { - this.fontColor = fontColor; + public void setInputType(InputTypeEnum inputType) { + this.inputType = inputType; } - public FormField fontName(String fontName) { - this.fontName = fontName; + public FormField borderStyle(BorderStyleEnum borderStyle) { + this.borderStyle = borderStyle; return this; } /** - * Font name of the form field - * @return fontName + * Style of the border of the field. + * @return borderStyle **/ - @ApiModelProperty(value = "Font name of the form field") - public String getFontName() { - return fontName; + @ApiModelProperty(value = "Style of the border of the field.") + public BorderStyleEnum getBorderStyle() { + return borderStyle; } - public void setFontName(String fontName) { - this.fontName = fontName; + public void setBorderStyle(BorderStyleEnum borderStyle) { + this.borderStyle = borderStyle; } - public FormField fontSize(Double fontSize) { - this.fontSize = fontSize; + public FormField calculated(Boolean calculated) { + this.calculated = calculated; return this; } /** - * Font size of the form field in points - * @return fontSize + * true if this field's value is calculated from an expression, else false + * @return calculated **/ - @ApiModelProperty(value = "Font size of the form field in points") - public Double getFontSize() { - return fontSize; - } - - public void setFontSize(Double fontSize) { - this.fontSize = fontSize; - } - - public FormField hiddenOptions(List hiddenOptions) { - this.hiddenOptions = hiddenOptions; - return this; + @ApiModelProperty(value = "true if this field's value is calculated from an expression, else false") + public Boolean isCalculated() { + return calculated; } - public FormField addHiddenOptionsItem(String hiddenOptionsItem) { - if (this.hiddenOptions == null) { - this.hiddenOptions = new ArrayList(); - } - this.hiddenOptions.add(hiddenOptionsItem); + public void setCalculated(Boolean calculated) { + this.calculated = calculated; + } + + public FormField contentType(ContentTypeEnum contentType) { + this.contentType = contentType; return this; } /** - * Text values which are hidden in a drop down form field - * @return hiddenOptions + * Content Type of the form field. + * @return contentType **/ - @ApiModelProperty(value = "Text values which are hidden in a drop down form field") - public List getHiddenOptions() { - return hiddenOptions; + @ApiModelProperty(value = "Content Type of the form field.") + public ContentTypeEnum getContentType() { + return contentType; } - public void setHiddenOptions(List hiddenOptions) { - this.hiddenOptions = hiddenOptions; + public void setContentType(ContentTypeEnum contentType) { + this.contentType = contentType; } - public FormField hyperlink(FormFieldHyperlink hyperlink) { - this.hyperlink = hyperlink; + public FormField validation(ValidationEnum validation) { + this.validation = validation; return this; } /** - * Hyperlink-specific data (e.g. as url, link type) - * @return hyperlink + * Rule for validating the field value. + * @return validation **/ - @ApiModelProperty(value = "Hyperlink-specific data (e.g. as url, link type)") - public FormFieldHyperlink getHyperlink() { - return hyperlink; + @ApiModelProperty(value = "Rule for validating the field value.") + public ValidationEnum getValidation() { + return validation; } - public void setHyperlink(FormFieldHyperlink hyperlink) { - this.hyperlink = hyperlink; + public void setValidation(ValidationEnum validation) { + this.validation = validation; } - public FormField inputType(InputTypeEnum inputType) { - this.inputType = inputType; + public FormField displayLabel(String displayLabel) { + this.displayLabel = displayLabel; return this; } /** - * Input type of the form field - * @return inputType + * Display label attached to the field + * @return displayLabel **/ - @ApiModelProperty(value = "Input type of the form field") - public InputTypeEnum getInputType() { - return inputType; - } - - public void setInputType(InputTypeEnum inputType) { - this.inputType = inputType; + @ApiModelProperty(value = "Display label attached to the field") + public String getDisplayLabel() { + return displayLabel; } - public FormField locations(List locations) { - this.locations = locations; - return this; + public void setDisplayLabel(String displayLabel) { + this.displayLabel = displayLabel; } - public FormField addLocationsItem(FormFieldLocation locationsItem) { - if (this.locations == null) { - this.locations = new ArrayList(); - } - this.locations.add(locationsItem); + public FormField hyperlink(FormFieldHyperlink hyperlink) { + this.hyperlink = hyperlink; return this; } /** - * All locations in a document where the form field is placed - * @return locations + * Hyperlink-specific data (e.g. as url, link type) + * @return hyperlink **/ - @ApiModelProperty(value = "All locations in a document where the form field is placed") - public List getLocations() { - return locations; + @ApiModelProperty(value = "Hyperlink-specific data (e.g. as url, link type)") + public FormFieldHyperlink getHyperlink() { + return hyperlink; } - public void setLocations(List locations) { - this.locations = locations; + public void setHyperlink(FormFieldHyperlink hyperlink) { + this.hyperlink = hyperlink; } - public FormField masked(Boolean masked) { - this.masked = masked; + public FormField backgroundColor(String backgroundColor) { + this.backgroundColor = backgroundColor; return this; } /** - * true if the input entered by the signer has to be masked (like password), false if it shouldn't be - * @return masked + * Background color of the form field in RGB or HEX format + * @return backgroundColor **/ - @ApiModelProperty(value = "true if the input entered by the signer has to be masked (like password), false if it shouldn't be") - public Boolean isMasked() { - return masked; + @ApiModelProperty(value = "Background color of the form field in RGB or HEX format") + public String getBackgroundColor() { + return backgroundColor; } - public void setMasked(Boolean masked) { - this.masked = masked; + public void setBackgroundColor(String backgroundColor) { + this.backgroundColor = backgroundColor; } - public FormField maskingText(String maskingText) { - this.maskingText = maskingText; + public FormField visible(Boolean visible) { + this.visible = visible; return this; } /** - * Text to mask the masked form field - * @return maskingText + * If set to false, then the form field is hidden. Otherwise, it is visible. + * @return visible **/ - @ApiModelProperty(value = "Text to mask the masked form field") - public String getMaskingText() { - return maskingText; + @ApiModelProperty(value = "If set to false, then the form field is hidden. Otherwise, it is visible.") + public Boolean isVisible() { + return visible; } - public void setMaskingText(String maskingText) { - this.maskingText = maskingText; + public void setVisible(Boolean visible) { + this.visible = visible; } - public FormField maxLength(Integer maxLength) { - this.maxLength = maxLength; + public FormField displayFormatType(DisplayFormatTypeEnum displayFormatType) { + this.displayFormatType = displayFormatType; return this; } /** - * Maximum length of the input text field in terms of no. of characters - * @return maxLength + * Format type of the text field. + * @return displayFormatType **/ - @ApiModelProperty(value = "Maximum length of the input text field in terms of no. of characters") - public Integer getMaxLength() { - return maxLength; + @ApiModelProperty(value = "Format type of the text field.") + public DisplayFormatTypeEnum getDisplayFormatType() { + return displayFormatType; } - public void setMaxLength(Integer maxLength) { - this.maxLength = maxLength; + public void setDisplayFormatType(DisplayFormatTypeEnum displayFormatType) { + this.displayFormatType = displayFormatType; } public FormField maxValue(Double maxValue) { @@ -1092,94 +1107,66 @@ public void setMaxValue(Double maxValue) { this.maxValue = maxValue; } - public FormField minLength(Integer minLength) { - this.minLength = minLength; - return this; - } - - /** - * Minimum length of the input text field in terms of no. of characters - * @return minLength - **/ - @ApiModelProperty(value = "Minimum length of the input text field in terms of no. of characters") - public Integer getMinLength() { - return minLength; - } - - public void setMinLength(Integer minLength) { - this.minLength = minLength; - } - - public FormField minValue(Double minValue) { - this.minValue = minValue; + public FormField validationErrMsg(String validationErrMsg) { + this.validationErrMsg = validationErrMsg; return this; } /** - * Lower bound of the number that can be entered by the signer - * @return minValue + * Error message to be shown to the signer if filled value doesn't match the validations of the form field + * @return validationErrMsg **/ - @ApiModelProperty(value = "Lower bound of the number that can be entered by the signer") - public Double getMinValue() { - return minValue; + @ApiModelProperty(value = "Error message to be shown to the signer if filled value doesn't match the validations of the form field") + public String getValidationErrMsg() { + return validationErrMsg; } - public void setMinValue(Double minValue) { - this.minValue = minValue; + public void setValidationErrMsg(String validationErrMsg) { + this.validationErrMsg = validationErrMsg; } - public FormField name(String name) { - this.name = name; + public FormField displayFormat(String displayFormat) { + this.displayFormat = displayFormat; return this; } /** - * The name of the form field - * @return name + * Format of the value of the field to be displayed based on the displayFormatType property. + * @return displayFormat **/ - @ApiModelProperty(value = "The name of the form field") - public String getName() { - return name; + @ApiModelProperty(value = "Format of the value of the field to be displayed based on the displayFormatType property.") + public String getDisplayFormat() { + return displayFormat; } - public void setName(String name) { - this.name = name; + public void setDisplayFormat(String displayFormat) { + this.displayFormat = displayFormat; } - public FormField origin(OriginEnum origin) { - this.origin = origin; + public FormField visibleOptions(List visibleOptions) { + this.visibleOptions = visibleOptions; return this; } - /** - * Origin of Form Field - * @return origin - **/ - @ApiModelProperty(value = "Origin of Form Field") - public OriginEnum getOrigin() { - return origin; - } - - public void setOrigin(OriginEnum origin) { - this.origin = origin; - } - - public FormField radioCheckType(RadioCheckTypeEnum radioCheckType) { - this.radioCheckType = radioCheckType; + public FormField addVisibleOptionsItem(String visibleOptionsItem) { + if (this.visibleOptions == null) { + this.visibleOptions = new ArrayList(); + } + this.visibleOptions.add(visibleOptionsItem); return this; } /** - * The type of radio button (if field is radio button, identified by inputType). - * @return radioCheckType + * Text values which are visible in a drop down form field + * @return visibleOptions **/ - @ApiModelProperty(value = "The type of radio button (if field is radio button, identified by inputType).") - public RadioCheckTypeEnum getRadioCheckType() { - return radioCheckType; + @ApiModelProperty(value = "Text values which are visible in a drop down form field") + public List getVisibleOptions() { + return visibleOptions; } - public void setRadioCheckType(RadioCheckTypeEnum radioCheckType) { - this.radioCheckType = radioCheckType; + public void setVisibleOptions(List visibleOptions) { + this.visibleOptions = visibleOptions; } public FormField readOnly(Boolean readOnly) { @@ -1200,174 +1187,174 @@ public void setReadOnly(Boolean readOnly) { this.readOnly = readOnly; } - public FormField required(Boolean required) { - this.required = required; + public FormField fontName(String fontName) { + this.fontName = fontName; return this; } /** - * true if it is a mandatory field to be filled by the signer, else false - * @return required + * Font name of the form field + * @return fontName **/ - @ApiModelProperty(value = "true if it is a mandatory field to be filled by the signer, else false") - public Boolean isRequired() { - return required; + @ApiModelProperty(value = "Font name of the form field") + public String getFontName() { + return fontName; } - public void setRequired(Boolean required) { - this.required = required; + public void setFontName(String fontName) { + this.fontName = fontName; } - public FormField tooltip(String tooltip) { - this.tooltip = tooltip; + public FormField conditionalAction(FormFieldConditionalAction conditionalAction) { + this.conditionalAction = conditionalAction; return this; } /** - * Text that appears while hovering over the field - * @return tooltip - **/ - @ApiModelProperty(value = "Text that appears while hovering over the field") - public String getTooltip() { - return tooltip; + * A predicate (or set of predicates) that determines whether this field is visible and enabled. + * @return conditionalAction + **/ + @ApiModelProperty(value = "A predicate (or set of predicates) that determines whether this field is visible and enabled.") + public FormFieldConditionalAction getConditionalAction() { + return conditionalAction; } - public void setTooltip(String tooltip) { - this.tooltip = tooltip; + public void setConditionalAction(FormFieldConditionalAction conditionalAction) { + this.conditionalAction = conditionalAction; } - public FormField urlOverridable(Boolean urlOverridable) { - this.urlOverridable = urlOverridable; + public FormField name(String name) { + this.name = name; return this; } /** - * For widget text fields only - true if the default value may come from the URL, else false - * @return urlOverridable + * The name of the form field + * @return name **/ - @ApiModelProperty(value = "For widget text fields only - true if the default value may come from the URL, else false") - public Boolean isUrlOverridable() { - return urlOverridable; + @ApiModelProperty(value = "The name of the form field") + public String getName() { + return name; } - public void setUrlOverridable(Boolean urlOverridable) { - this.urlOverridable = urlOverridable; + public void setName(String name) { + this.name = name; } - public FormField validation(ValidationEnum validation) { - this.validation = validation; + public FormField fontSize(Double fontSize) { + this.fontSize = fontSize; return this; } /** - * Rule for validating the field value. - * @return validation + * Font size of the form field in points + * @return fontSize **/ - @ApiModelProperty(value = "Rule for validating the field value.") - public ValidationEnum getValidation() { - return validation; + @ApiModelProperty(value = "Font size of the form field in points") + public Double getFontSize() { + return fontSize; } - public void setValidation(ValidationEnum validation) { - this.validation = validation; + public void setFontSize(Double fontSize) { + this.fontSize = fontSize; } - public FormField validationData(String validationData) { - this.validationData = validationData; + public FormField locations(List locations) { + this.locations = locations; + return this; + } + + public FormField addLocationsItem(FormFieldLocation locationsItem) { + if (this.locations == null) { + this.locations = new ArrayList(); + } + this.locations.add(locationsItem); return this; } /** - * Further data for validating input with regards to the field's specified format. The contents and interpretation of formatData depends on the value of validation. - * @return validationData + * All locations in a document where the form field is placed + * @return locations **/ - @ApiModelProperty(value = "Further data for validating input with regards to the field's specified format. The contents and interpretation of formatData depends on the value of validation.") - public String getValidationData() { - return validationData; + @ApiModelProperty(value = "All locations in a document where the form field is placed") + public List getLocations() { + return locations; } - public void setValidationData(String validationData) { - this.validationData = validationData; + public void setLocations(List locations) { + this.locations = locations; } - public FormField validationErrMsg(String validationErrMsg) { - this.validationErrMsg = validationErrMsg; + public FormField assignee(String assignee) { + this.assignee = assignee; return this; } /** - * Error message to be shown to the signer if filled value doesn't match the validations of the form field - * @return validationErrMsg + * Who the field is assigned to. Valid values are a participant set id, null, \"NOBODY\", \"PREFILL\" or \"EVERYONE\". If set to a participant set id, then any member of that participant set may fill out the field. \"NOBODY\" indicates that the field may not be filled by anybody (e.g. autopopulated fields like transaction number). \"PREFILL\" indicates that the field will be filled by the sender before the agreement is sent out for signing. \"EVERYONE\" exists only in hyperlink fields currently and indicates that it is assigned to all participants. null indicates that anybody may fill out the field. If the propeerty isn't specified, it is treated as null. + * @return assignee **/ - @ApiModelProperty(value = "Error message to be shown to the signer if filled value doesn't match the validations of the form field") - public String getValidationErrMsg() { - return validationErrMsg; + @ApiModelProperty(value = "Who the field is assigned to. Valid values are a participant set id, null, \"NOBODY\", \"PREFILL\" or \"EVERYONE\". If set to a participant set id, then any member of that participant set may fill out the field. \"NOBODY\" indicates that the field may not be filled by anybody (e.g. autopopulated fields like transaction number). \"PREFILL\" indicates that the field will be filled by the sender before the agreement is sent out for signing. \"EVERYONE\" exists only in hyperlink fields currently and indicates that it is assigned to all participants. null indicates that anybody may fill out the field. If the propeerty isn't specified, it is treated as null.") + public String getAssignee() { + return assignee; } - public void setValidationErrMsg(String validationErrMsg) { - this.validationErrMsg = validationErrMsg; + public void setAssignee(String assignee) { + this.assignee = assignee; } - public FormField valueExpression(String valueExpression) { - this.valueExpression = valueExpression; + public FormField alignment(AlignmentEnum alignment) { + this.alignment = alignment; return this; } /** - * Expression to calculate value of the form field - * @return valueExpression + * Alignment of the text. + * @return alignment **/ - @ApiModelProperty(value = "Expression to calculate value of the form field") - public String getValueExpression() { - return valueExpression; + @ApiModelProperty(value = "Alignment of the text.") + public AlignmentEnum getAlignment() { + return alignment; } - public void setValueExpression(String valueExpression) { - this.valueExpression = valueExpression; + public void setAlignment(AlignmentEnum alignment) { + this.alignment = alignment; } - public FormField visible(Boolean visible) { - this.visible = visible; + public FormField fontColor(String fontColor) { + this.fontColor = fontColor; return this; } /** - * If set to false, then the form field is hidden. Otherwise, it is visible. - * @return visible + * Font color of the form field in RGB or HEX format + * @return fontColor **/ - @ApiModelProperty(value = "If set to false, then the form field is hidden. Otherwise, it is visible.") - public Boolean isVisible() { - return visible; - } - - public void setVisible(Boolean visible) { - this.visible = visible; + @ApiModelProperty(value = "Font color of the form field in RGB or HEX format") + public String getFontColor() { + return fontColor; } - public FormField visibleOptions(List visibleOptions) { - this.visibleOptions = visibleOptions; - return this; + public void setFontColor(String fontColor) { + this.fontColor = fontColor; } - public FormField addVisibleOptionsItem(String visibleOptionsItem) { - if (this.visibleOptions == null) { - this.visibleOptions = new ArrayList(); - } - this.visibleOptions.add(visibleOptionsItem); + public FormField maxLength(Integer maxLength) { + this.maxLength = maxLength; return this; } /** - * Text values which are visible in a drop down form field - * @return visibleOptions + * Maximum length of the input text field in terms of no. of characters + * @return maxLength **/ - @ApiModelProperty(value = "Text values which are visible in a drop down form field") - public List getVisibleOptions() { - return visibleOptions; + @ApiModelProperty(value = "Maximum length of the input text field in terms of no. of characters") + public Integer getMaxLength() { + return maxLength; } - public void setVisibleOptions(List visibleOptions) { - this.visibleOptions = visibleOptions; + public void setMaxLength(Integer maxLength) { + this.maxLength = maxLength; } @@ -1380,50 +1367,50 @@ public boolean equals(java.lang.Object o) { return false; } FormField formField = (FormField) o; - return Objects.equals(this.alignment, formField.alignment) && - Objects.equals(this.assignee, formField.assignee) && - Objects.equals(this.backgroundColor, formField.backgroundColor) && + return Objects.equals(this.radioCheckType, formField.radioCheckType) && Objects.equals(this.borderColor, formField.borderColor) && - Objects.equals(this.borderStyle, formField.borderStyle) && - Objects.equals(this.borderWidth, formField.borderWidth) && - Objects.equals(this.calculated, formField.calculated) && - Objects.equals(this.conditionalAction, formField.conditionalAction) && - Objects.equals(this.contentType, formField.contentType) && + Objects.equals(this.valueExpression, formField.valueExpression) && + Objects.equals(this.maskingText, formField.maskingText) && Objects.equals(this.defaultValue, formField.defaultValue) && - Objects.equals(this.displayFormat, formField.displayFormat) && - Objects.equals(this.displayFormatType, formField.displayFormatType) && - Objects.equals(this.displayLabel, formField.displayLabel) && - Objects.equals(this.fontColor, formField.fontColor) && - Objects.equals(this.fontName, formField.fontName) && - Objects.equals(this.fontSize, formField.fontSize) && - Objects.equals(this.hiddenOptions, formField.hiddenOptions) && - Objects.equals(this.hyperlink, formField.hyperlink) && - Objects.equals(this.inputType, formField.inputType) && - Objects.equals(this.locations, formField.locations) && Objects.equals(this.masked, formField.masked) && - Objects.equals(this.maskingText, formField.maskingText) && - Objects.equals(this.maxLength, formField.maxLength) && - Objects.equals(this.maxValue, formField.maxValue) && Objects.equals(this.minLength, formField.minLength) && - Objects.equals(this.minValue, formField.minValue) && - Objects.equals(this.name, formField.name) && Objects.equals(this.origin, formField.origin) && - Objects.equals(this.radioCheckType, formField.radioCheckType) && - Objects.equals(this.readOnly, formField.readOnly) && - Objects.equals(this.required, formField.required) && Objects.equals(this.tooltip, formField.tooltip) && + Objects.equals(this.hiddenOptions, formField.hiddenOptions) && + Objects.equals(this.required, formField.required) && + Objects.equals(this.validationData, formField.validationData) && + Objects.equals(this.minValue, formField.minValue) && + Objects.equals(this.borderWidth, formField.borderWidth) && Objects.equals(this.urlOverridable, formField.urlOverridable) && + Objects.equals(this.inputType, formField.inputType) && + Objects.equals(this.borderStyle, formField.borderStyle) && + Objects.equals(this.calculated, formField.calculated) && + Objects.equals(this.contentType, formField.contentType) && Objects.equals(this.validation, formField.validation) && - Objects.equals(this.validationData, formField.validationData) && - Objects.equals(this.validationErrMsg, formField.validationErrMsg) && - Objects.equals(this.valueExpression, formField.valueExpression) && + Objects.equals(this.displayLabel, formField.displayLabel) && + Objects.equals(this.hyperlink, formField.hyperlink) && + Objects.equals(this.backgroundColor, formField.backgroundColor) && Objects.equals(this.visible, formField.visible) && - Objects.equals(this.visibleOptions, formField.visibleOptions); + Objects.equals(this.displayFormatType, formField.displayFormatType) && + Objects.equals(this.maxValue, formField.maxValue) && + Objects.equals(this.validationErrMsg, formField.validationErrMsg) && + Objects.equals(this.displayFormat, formField.displayFormat) && + Objects.equals(this.visibleOptions, formField.visibleOptions) && + Objects.equals(this.readOnly, formField.readOnly) && + Objects.equals(this.fontName, formField.fontName) && + Objects.equals(this.conditionalAction, formField.conditionalAction) && + Objects.equals(this.name, formField.name) && + Objects.equals(this.fontSize, formField.fontSize) && + Objects.equals(this.locations, formField.locations) && + Objects.equals(this.assignee, formField.assignee) && + Objects.equals(this.alignment, formField.alignment) && + Objects.equals(this.fontColor, formField.fontColor) && + Objects.equals(this.maxLength, formField.maxLength); } @Override public int hashCode() { - return Objects.hash(alignment, assignee, backgroundColor, borderColor, borderStyle, borderWidth, calculated, conditionalAction, contentType, defaultValue, displayFormat, displayFormatType, displayLabel, fontColor, fontName, fontSize, hiddenOptions, hyperlink, inputType, locations, masked, maskingText, maxLength, maxValue, minLength, minValue, name, origin, radioCheckType, readOnly, required, tooltip, urlOverridable, validation, validationData, validationErrMsg, valueExpression, visible, visibleOptions); + return Objects.hash(radioCheckType, borderColor, valueExpression, maskingText, defaultValue, masked, minLength, origin, tooltip, hiddenOptions, required, validationData, minValue, borderWidth, urlOverridable, inputType, borderStyle, calculated, contentType, validation, displayLabel, hyperlink, backgroundColor, visible, displayFormatType, maxValue, validationErrMsg, displayFormat, visibleOptions, readOnly, fontName, conditionalAction, name, fontSize, locations, assignee, alignment, fontColor, maxLength); } @@ -1432,45 +1419,45 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class FormField {\n"); - sb.append(" alignment: ").append(toIndentedString(alignment)).append("\n"); - sb.append(" assignee: ").append(toIndentedString(assignee)).append("\n"); - sb.append(" backgroundColor: ").append(toIndentedString(backgroundColor)).append("\n"); + sb.append(" radioCheckType: ").append(toIndentedString(radioCheckType)).append("\n"); sb.append(" borderColor: ").append(toIndentedString(borderColor)).append("\n"); - sb.append(" borderStyle: ").append(toIndentedString(borderStyle)).append("\n"); - sb.append(" borderWidth: ").append(toIndentedString(borderWidth)).append("\n"); - sb.append(" calculated: ").append(toIndentedString(calculated)).append("\n"); - sb.append(" conditionalAction: ").append(toIndentedString(conditionalAction)).append("\n"); - sb.append(" contentType: ").append(toIndentedString(contentType)).append("\n"); + sb.append(" valueExpression: ").append(toIndentedString(valueExpression)).append("\n"); + sb.append(" maskingText: ").append(toIndentedString(maskingText)).append("\n"); sb.append(" defaultValue: ").append(toIndentedString(defaultValue)).append("\n"); - sb.append(" displayFormat: ").append(toIndentedString(displayFormat)).append("\n"); - sb.append(" displayFormatType: ").append(toIndentedString(displayFormatType)).append("\n"); - sb.append(" displayLabel: ").append(toIndentedString(displayLabel)).append("\n"); - sb.append(" fontColor: ").append(toIndentedString(fontColor)).append("\n"); - sb.append(" fontName: ").append(toIndentedString(fontName)).append("\n"); - sb.append(" fontSize: ").append(toIndentedString(fontSize)).append("\n"); - sb.append(" hiddenOptions: ").append(toIndentedString(hiddenOptions)).append("\n"); - sb.append(" hyperlink: ").append(toIndentedString(hyperlink)).append("\n"); - sb.append(" inputType: ").append(toIndentedString(inputType)).append("\n"); - sb.append(" locations: ").append(toIndentedString(locations)).append("\n"); sb.append(" masked: ").append(toIndentedString(masked)).append("\n"); - sb.append(" maskingText: ").append(toIndentedString(maskingText)).append("\n"); - sb.append(" maxLength: ").append(toIndentedString(maxLength)).append("\n"); - sb.append(" maxValue: ").append(toIndentedString(maxValue)).append("\n"); sb.append(" minLength: ").append(toIndentedString(minLength)).append("\n"); - sb.append(" minValue: ").append(toIndentedString(minValue)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" origin: ").append(toIndentedString(origin)).append("\n"); - sb.append(" radioCheckType: ").append(toIndentedString(radioCheckType)).append("\n"); - sb.append(" readOnly: ").append(toIndentedString(readOnly)).append("\n"); - sb.append(" required: ").append(toIndentedString(required)).append("\n"); sb.append(" tooltip: ").append(toIndentedString(tooltip)).append("\n"); + sb.append(" hiddenOptions: ").append(toIndentedString(hiddenOptions)).append("\n"); + sb.append(" required: ").append(toIndentedString(required)).append("\n"); + sb.append(" validationData: ").append(toIndentedString(validationData)).append("\n"); + sb.append(" minValue: ").append(toIndentedString(minValue)).append("\n"); + sb.append(" borderWidth: ").append(toIndentedString(borderWidth)).append("\n"); sb.append(" urlOverridable: ").append(toIndentedString(urlOverridable)).append("\n"); + sb.append(" inputType: ").append(toIndentedString(inputType)).append("\n"); + sb.append(" borderStyle: ").append(toIndentedString(borderStyle)).append("\n"); + sb.append(" calculated: ").append(toIndentedString(calculated)).append("\n"); + sb.append(" contentType: ").append(toIndentedString(contentType)).append("\n"); sb.append(" validation: ").append(toIndentedString(validation)).append("\n"); - sb.append(" validationData: ").append(toIndentedString(validationData)).append("\n"); - sb.append(" validationErrMsg: ").append(toIndentedString(validationErrMsg)).append("\n"); - sb.append(" valueExpression: ").append(toIndentedString(valueExpression)).append("\n"); + sb.append(" displayLabel: ").append(toIndentedString(displayLabel)).append("\n"); + sb.append(" hyperlink: ").append(toIndentedString(hyperlink)).append("\n"); + sb.append(" backgroundColor: ").append(toIndentedString(backgroundColor)).append("\n"); sb.append(" visible: ").append(toIndentedString(visible)).append("\n"); + sb.append(" displayFormatType: ").append(toIndentedString(displayFormatType)).append("\n"); + sb.append(" maxValue: ").append(toIndentedString(maxValue)).append("\n"); + sb.append(" validationErrMsg: ").append(toIndentedString(validationErrMsg)).append("\n"); + sb.append(" displayFormat: ").append(toIndentedString(displayFormat)).append("\n"); sb.append(" visibleOptions: ").append(toIndentedString(visibleOptions)).append("\n"); + sb.append(" readOnly: ").append(toIndentedString(readOnly)).append("\n"); + sb.append(" fontName: ").append(toIndentedString(fontName)).append("\n"); + sb.append(" conditionalAction: ").append(toIndentedString(conditionalAction)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" fontSize: ").append(toIndentedString(fontSize)).append("\n"); + sb.append(" locations: ").append(toIndentedString(locations)).append("\n"); + sb.append(" assignee: ").append(toIndentedString(assignee)).append("\n"); + sb.append(" alignment: ").append(toIndentedString(alignment)).append("\n"); + sb.append(" fontColor: ").append(toIndentedString(fontColor)).append("\n"); + sb.append(" maxLength: ").append(toIndentedString(maxLength)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/FormFieldConditionPredicate.java b/src/main/java/io/swagger/client/model/agreements/FormFieldConditionPredicate.java index 1238b7a..182f8e8 100755 --- a/src/main/java/io/swagger/client/model/agreements/FormFieldConditionPredicate.java +++ b/src/main/java/io/swagger/client/model/agreements/FormFieldConditionPredicate.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,14 +27,14 @@ * A predicate used to determine whether the condtion succeeds */ @ApiModel(description = "A predicate used to determine whether the condtion succeeds") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class FormFieldConditionPredicate { - @SerializedName("fieldLocationIndex") - private Integer fieldLocationIndex = null; - @SerializedName("fieldName") private String fieldName = null; + @SerializedName("value") + private String value = null; + /** * Operator to be applied on the value of the predicate field. */ @@ -116,26 +101,8 @@ public OperatorEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("operator") private OperatorEnum operator = null; - @SerializedName("value") - private String value = null; - - public FormFieldConditionPredicate fieldLocationIndex(Integer fieldLocationIndex) { - this.fieldLocationIndex = fieldLocationIndex; - return this; - } - - /** - * Index of the location of the form field used in the predicate - * @return fieldLocationIndex - **/ - @ApiModelProperty(value = "Index of the location of the form field used in the predicate") - public Integer getFieldLocationIndex() { - return fieldLocationIndex; - } - - public void setFieldLocationIndex(Integer fieldLocationIndex) { - this.fieldLocationIndex = fieldLocationIndex; - } + @SerializedName("fieldLocationIndex") + private Integer fieldLocationIndex = null; public FormFieldConditionPredicate fieldName(String fieldName) { this.fieldName = fieldName; @@ -155,6 +122,24 @@ public void setFieldName(String fieldName) { this.fieldName = fieldName; } + public FormFieldConditionPredicate value(String value) { + this.value = value; + return this; + } + + /** + * Value to compare against the value of the predicate's form field, using the specified operator + * @return value + **/ + @ApiModelProperty(value = "Value to compare against the value of the predicate's form field, using the specified operator") + public String getValue() { + return value; + } + + public void setValue(String value) { + this.value = value; + } + public FormFieldConditionPredicate operator(OperatorEnum operator) { this.operator = operator; return this; @@ -173,22 +158,22 @@ public void setOperator(OperatorEnum operator) { this.operator = operator; } - public FormFieldConditionPredicate value(String value) { - this.value = value; + public FormFieldConditionPredicate fieldLocationIndex(Integer fieldLocationIndex) { + this.fieldLocationIndex = fieldLocationIndex; return this; } /** - * Value to compare against the value of the predicate's form field, using the specified operator - * @return value + * Index of the location of the form field used in the predicate + * @return fieldLocationIndex **/ - @ApiModelProperty(value = "Value to compare against the value of the predicate's form field, using the specified operator") - public String getValue() { - return value; + @ApiModelProperty(value = "Index of the location of the form field used in the predicate") + public Integer getFieldLocationIndex() { + return fieldLocationIndex; } - public void setValue(String value) { - this.value = value; + public void setFieldLocationIndex(Integer fieldLocationIndex) { + this.fieldLocationIndex = fieldLocationIndex; } @@ -201,15 +186,15 @@ public boolean equals(java.lang.Object o) { return false; } FormFieldConditionPredicate formFieldConditionPredicate = (FormFieldConditionPredicate) o; - return Objects.equals(this.fieldLocationIndex, formFieldConditionPredicate.fieldLocationIndex) && - Objects.equals(this.fieldName, formFieldConditionPredicate.fieldName) && + return Objects.equals(this.fieldName, formFieldConditionPredicate.fieldName) && + Objects.equals(this.value, formFieldConditionPredicate.value) && Objects.equals(this.operator, formFieldConditionPredicate.operator) && - Objects.equals(this.value, formFieldConditionPredicate.value); + Objects.equals(this.fieldLocationIndex, formFieldConditionPredicate.fieldLocationIndex); } @Override public int hashCode() { - return Objects.hash(fieldLocationIndex, fieldName, operator, value); + return Objects.hash(fieldName, value, operator, fieldLocationIndex); } @@ -218,10 +203,10 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class FormFieldConditionPredicate {\n"); - sb.append(" fieldLocationIndex: ").append(toIndentedString(fieldLocationIndex)).append("\n"); sb.append(" fieldName: ").append(toIndentedString(fieldName)).append("\n"); - sb.append(" operator: ").append(toIndentedString(operator)).append("\n"); sb.append(" value: ").append(toIndentedString(value)).append("\n"); + sb.append(" operator: ").append(toIndentedString(operator)).append("\n"); + sb.append(" fieldLocationIndex: ").append(toIndentedString(fieldLocationIndex)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/FormFieldConditionalAction.java b/src/main/java/io/swagger/client/model/agreements/FormFieldConditionalAction.java index eb714b4..3ce5ec6 100755 --- a/src/main/java/io/swagger/client/model/agreements/FormFieldConditionalAction.java +++ b/src/main/java/io/swagger/client/model/agreements/FormFieldConditionalAction.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,24 +30,23 @@ * Conditional actions to perfom on this form field. */ @ApiModel(description = "Conditional actions to perfom on this form field.") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class FormFieldConditionalAction { + @SerializedName("predicates") + private List predicates = null; + /** - * Action to show/hide the form field is to be taken on the basis of evaluation of conditions. + * It indicates if any one of the conditions or all of them have to be true. */ - @JsonAdapter(ActionEnum.Adapter.class) - public enum ActionEnum { - SHOW("SHOW"), - - HIDE("HIDE"), - - DISABLE("DISABLE"), + @JsonAdapter(AnyOrAllEnum.Adapter.class) + public enum AnyOrAllEnum { + ALL("ALL"), - ENABLE("ENABLE"); + ANY("ANY"); private String value; - ActionEnum(String value) { + AnyOrAllEnum(String value) { this.value = value; } @@ -75,8 +59,8 @@ public String toString() { return String.valueOf(value); } - public static ActionEnum fromValue(String text) { - for (ActionEnum b : ActionEnum.values()) { + public static AnyOrAllEnum fromValue(String text) { + for (AnyOrAllEnum b : AnyOrAllEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -84,35 +68,39 @@ public static ActionEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final ActionEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final AnyOrAllEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public ActionEnum read(final JsonReader jsonReader) throws IOException { + public AnyOrAllEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return ActionEnum.fromValue(String.valueOf(value)); + return AnyOrAllEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("action") - private ActionEnum action = null; + @SerializedName("anyOrAll") + private AnyOrAllEnum anyOrAll = null; /** - * It indicates if any one of the conditions or all of them have to be true. + * Action to show/hide the form field is to be taken on the basis of evaluation of conditions. */ - @JsonAdapter(AnyOrAllEnum.Adapter.class) - public enum AnyOrAllEnum { - ALL("ALL"), + @JsonAdapter(ActionEnum.Adapter.class) + public enum ActionEnum { + SHOW("SHOW"), - ANY("ANY"); + HIDE("HIDE"), + + DISABLE("DISABLE"), + + ENABLE("ENABLE"); private String value; - AnyOrAllEnum(String value) { + ActionEnum(String value) { this.value = value; } @@ -125,8 +113,8 @@ public String toString() { return String.valueOf(value); } - public static AnyOrAllEnum fromValue(String text) { - for (AnyOrAllEnum b : AnyOrAllEnum.values()) { + public static ActionEnum fromValue(String text) { + for (ActionEnum b : ActionEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -134,42 +122,47 @@ public static AnyOrAllEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final AnyOrAllEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final ActionEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public AnyOrAllEnum read(final JsonReader jsonReader) throws IOException { + public ActionEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return AnyOrAllEnum.fromValue(String.valueOf(value)); + return ActionEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("anyOrAll") - private AnyOrAllEnum anyOrAll = null; + @SerializedName("action") + private ActionEnum action = null; - @SerializedName("predicates") - private List predicates = null; + public FormFieldConditionalAction predicates(List predicates) { + this.predicates = predicates; + return this; + } - public FormFieldConditionalAction action(ActionEnum action) { - this.action = action; + public FormFieldConditionalAction addPredicatesItem(FormFieldConditionPredicate predicatesItem) { + if (this.predicates == null) { + this.predicates = new ArrayList(); + } + this.predicates.add(predicatesItem); return this; } /** - * Action to show/hide the form field is to be taken on the basis of evaluation of conditions. - * @return action + * The predicates to be evaluated in order to determine whether this condition is true + * @return predicates **/ - @ApiModelProperty(value = "Action to show/hide the form field is to be taken on the basis of evaluation of conditions.") - public ActionEnum getAction() { - return action; + @ApiModelProperty(value = "The predicates to be evaluated in order to determine whether this condition is true") + public List getPredicates() { + return predicates; } - public void setAction(ActionEnum action) { - this.action = action; + public void setPredicates(List predicates) { + this.predicates = predicates; } public FormFieldConditionalAction anyOrAll(AnyOrAllEnum anyOrAll) { @@ -190,30 +183,22 @@ public void setAnyOrAll(AnyOrAllEnum anyOrAll) { this.anyOrAll = anyOrAll; } - public FormFieldConditionalAction predicates(List predicates) { - this.predicates = predicates; - return this; - } - - public FormFieldConditionalAction addPredicatesItem(FormFieldConditionPredicate predicatesItem) { - if (this.predicates == null) { - this.predicates = new ArrayList(); - } - this.predicates.add(predicatesItem); + public FormFieldConditionalAction action(ActionEnum action) { + this.action = action; return this; } /** - * The predicates to be evaluated in order to determine whether this condition is true - * @return predicates + * Action to show/hide the form field is to be taken on the basis of evaluation of conditions. + * @return action **/ - @ApiModelProperty(value = "The predicates to be evaluated in order to determine whether this condition is true") - public List getPredicates() { - return predicates; + @ApiModelProperty(value = "Action to show/hide the form field is to be taken on the basis of evaluation of conditions.") + public ActionEnum getAction() { + return action; } - public void setPredicates(List predicates) { - this.predicates = predicates; + public void setAction(ActionEnum action) { + this.action = action; } @@ -226,14 +211,14 @@ public boolean equals(java.lang.Object o) { return false; } FormFieldConditionalAction formFieldConditionalAction = (FormFieldConditionalAction) o; - return Objects.equals(this.action, formFieldConditionalAction.action) && + return Objects.equals(this.predicates, formFieldConditionalAction.predicates) && Objects.equals(this.anyOrAll, formFieldConditionalAction.anyOrAll) && - Objects.equals(this.predicates, formFieldConditionalAction.predicates); + Objects.equals(this.action, formFieldConditionalAction.action); } @Override public int hashCode() { - return Objects.hash(action, anyOrAll, predicates); + return Objects.hash(predicates, anyOrAll, action); } @@ -242,9 +227,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class FormFieldConditionalAction {\n"); - sb.append(" action: ").append(toIndentedString(action)).append("\n"); - sb.append(" anyOrAll: ").append(toIndentedString(anyOrAll)).append("\n"); sb.append(" predicates: ").append(toIndentedString(predicates)).append("\n"); + sb.append(" anyOrAll: ").append(toIndentedString(anyOrAll)).append("\n"); + sb.append(" action: ").append(toIndentedString(action)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/FormFieldHyperlink.java b/src/main/java/io/swagger/client/model/agreements/FormFieldHyperlink.java index ba8af93..1ced0f1 100755 --- a/src/main/java/io/swagger/client/model/agreements/FormFieldHyperlink.java +++ b/src/main/java/io/swagger/client/model/agreements/FormFieldHyperlink.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -43,11 +28,8 @@ * Hyperlink-specific data for hyperlink form fields */ @ApiModel(description = "Hyperlink-specific data for hyperlink form fields") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class FormFieldHyperlink { - @SerializedName("documentLocation") - private FormFieldLocation documentLocation = null; - /** * Type of link in an agreement. */ @@ -100,27 +82,12 @@ public LinkTypeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("linkType") private LinkTypeEnum linkType = null; + @SerializedName("documentLocation") + private FormFieldLocation documentLocation = null; + @SerializedName("url") private String url = null; - public FormFieldHyperlink documentLocation(FormFieldLocation documentLocation) { - this.documentLocation = documentLocation; - return this; - } - - /** - * Location on the document pointed by the link in case of INTERNAL type link - * @return documentLocation - **/ - @ApiModelProperty(value = "Location on the document pointed by the link in case of INTERNAL type link") - public FormFieldLocation getDocumentLocation() { - return documentLocation; - } - - public void setDocumentLocation(FormFieldLocation documentLocation) { - this.documentLocation = documentLocation; - } - public FormFieldHyperlink linkType(LinkTypeEnum linkType) { this.linkType = linkType; return this; @@ -139,6 +106,24 @@ public void setLinkType(LinkTypeEnum linkType) { this.linkType = linkType; } + public FormFieldHyperlink documentLocation(FormFieldLocation documentLocation) { + this.documentLocation = documentLocation; + return this; + } + + /** + * Location on the document pointed by the link in case of INTERNAL type link + * @return documentLocation + **/ + @ApiModelProperty(value = "Location on the document pointed by the link in case of INTERNAL type link") + public FormFieldLocation getDocumentLocation() { + return documentLocation; + } + + public void setDocumentLocation(FormFieldLocation documentLocation) { + this.documentLocation = documentLocation; + } + public FormFieldHyperlink url(String url) { this.url = url; return this; @@ -167,14 +152,14 @@ public boolean equals(java.lang.Object o) { return false; } FormFieldHyperlink formFieldHyperlink = (FormFieldHyperlink) o; - return Objects.equals(this.documentLocation, formFieldHyperlink.documentLocation) && - Objects.equals(this.linkType, formFieldHyperlink.linkType) && + return Objects.equals(this.linkType, formFieldHyperlink.linkType) && + Objects.equals(this.documentLocation, formFieldHyperlink.documentLocation) && Objects.equals(this.url, formFieldHyperlink.url); } @Override public int hashCode() { - return Objects.hash(documentLocation, linkType, url); + return Objects.hash(linkType, documentLocation, url); } @@ -183,8 +168,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class FormFieldHyperlink {\n"); - sb.append(" documentLocation: ").append(toIndentedString(documentLocation)).append("\n"); sb.append(" linkType: ").append(toIndentedString(linkType)).append("\n"); + sb.append(" documentLocation: ").append(toIndentedString(documentLocation)).append("\n"); sb.append(" url: ").append(toIndentedString(url)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/agreements/FormFieldLocation.java b/src/main/java/io/swagger/client/model/agreements/FormFieldLocation.java index f5acced..4ed9be9 100755 --- a/src/main/java/io/swagger/client/model/agreements/FormFieldLocation.java +++ b/src/main/java/io/swagger/client/model/agreements/FormFieldLocation.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,58 +27,22 @@ * Location information for form fields */ @ApiModel(description = "Location information for form fields") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class FormFieldLocation { - @SerializedName("height") - private Double height = null; - - @SerializedName("left") - private Double left = null; - @SerializedName("pageNumber") private Integer pageNumber = null; @SerializedName("top") private Double top = null; + @SerializedName("left") + private Double left = null; + @SerializedName("width") private Double width = null; - public FormFieldLocation height(Double height) { - this.height = height; - return this; - } - - /** - * Height of the form field in pixels - * @return height - **/ - @ApiModelProperty(value = "Height of the form field in pixels") - public Double getHeight() { - return height; - } - - public void setHeight(Double height) { - this.height = height; - } - - public FormFieldLocation left(Double left) { - this.left = left; - return this; - } - - /** - * No. of pixels from left of the page for form field placement - * @return left - **/ - @ApiModelProperty(value = "No. of pixels from left of the page for form field placement") - public Double getLeft() { - return left; - } - - public void setLeft(Double left) { - this.left = left; - } + @SerializedName("height") + private Double height = null; public FormFieldLocation pageNumber(Integer pageNumber) { this.pageNumber = pageNumber; @@ -131,6 +80,24 @@ public void setTop(Double top) { this.top = top; } + public FormFieldLocation left(Double left) { + this.left = left; + return this; + } + + /** + * No. of pixels from left of the page for form field placement + * @return left + **/ + @ApiModelProperty(value = "No. of pixels from left of the page for form field placement") + public Double getLeft() { + return left; + } + + public void setLeft(Double left) { + this.left = left; + } + public FormFieldLocation width(Double width) { this.width = width; return this; @@ -149,6 +116,24 @@ public void setWidth(Double width) { this.width = width; } + public FormFieldLocation height(Double height) { + this.height = height; + return this; + } + + /** + * Height of the form field in pixels + * @return height + **/ + @ApiModelProperty(value = "Height of the form field in pixels") + public Double getHeight() { + return height; + } + + public void setHeight(Double height) { + this.height = height; + } + @Override public boolean equals(java.lang.Object o) { @@ -159,16 +144,16 @@ public boolean equals(java.lang.Object o) { return false; } FormFieldLocation formFieldLocation = (FormFieldLocation) o; - return Objects.equals(this.height, formFieldLocation.height) && - Objects.equals(this.left, formFieldLocation.left) && - Objects.equals(this.pageNumber, formFieldLocation.pageNumber) && + return Objects.equals(this.pageNumber, formFieldLocation.pageNumber) && Objects.equals(this.top, formFieldLocation.top) && - Objects.equals(this.width, formFieldLocation.width); + Objects.equals(this.left, formFieldLocation.left) && + Objects.equals(this.width, formFieldLocation.width) && + Objects.equals(this.height, formFieldLocation.height); } @Override public int hashCode() { - return Objects.hash(height, left, pageNumber, top, width); + return Objects.hash(pageNumber, top, left, width, height); } @@ -177,11 +162,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class FormFieldLocation {\n"); - sb.append(" height: ").append(toIndentedString(height)).append("\n"); - sb.append(" left: ").append(toIndentedString(left)).append("\n"); sb.append(" pageNumber: ").append(toIndentedString(pageNumber)).append("\n"); sb.append(" top: ").append(toIndentedString(top)).append("\n"); + sb.append(" left: ").append(toIndentedString(left)).append("\n"); sb.append(" width: ").append(toIndentedString(width)).append("\n"); + sb.append(" height: ").append(toIndentedString(height)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/FormFieldMergeInfo.java b/src/main/java/io/swagger/client/model/agreements/FormFieldMergeInfo.java index 6c235bc..a10c382 100755 --- a/src/main/java/io/swagger/client/model/agreements/FormFieldMergeInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/FormFieldMergeInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,7 +30,7 @@ * Data for updating the default values of existing form fields */ @ApiModel(description = "Data for updating the default values of existing form fields") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class FormFieldMergeInfo { @SerializedName("fieldMergeInfos") private List fieldMergeInfos = null; diff --git a/src/main/java/io/swagger/client/model/agreements/FormFieldPostInfo.java b/src/main/java/io/swagger/client/model/agreements/FormFieldPostInfo.java index 66e4528..e1e7054 100755 --- a/src/main/java/io/swagger/client/model/agreements/FormFieldPostInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/FormFieldPostInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,7 @@ * Information required to add or update agreement form fields */ @ApiModel(description = "Information required to add or update agreement form fields") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class FormFieldPostInfo { @SerializedName("templateId") private String templateId = null; diff --git a/src/main/java/io/swagger/client/model/agreements/FormFieldPutInfo.java b/src/main/java/io/swagger/client/model/agreements/FormFieldPutInfo.java index c81e099..7b50470 100755 --- a/src/main/java/io/swagger/client/model/agreements/FormFieldPutInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/FormFieldPutInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,7 +30,7 @@ * Information required to add or replace agreement form fields */ @ApiModel(description = "Information required to add or replace agreement form fields") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class FormFieldPutInfo { @SerializedName("fields") private List fields = null; diff --git a/src/main/java/io/swagger/client/model/agreements/MembersInfo.java b/src/main/java/io/swagger/client/model/agreements/MembersInfo.java index 1fd8418..946a269 100755 --- a/src/main/java/io/swagger/client/model/agreements/MembersInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/MembersInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -47,23 +32,49 @@ /** * MembersInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class MembersInfo { + @SerializedName("participantSets") + private List participantSets = null; + @SerializedName("ccsInfo") private List ccsInfo = null; @SerializedName("nextParticipantSets") private List nextParticipantSets = null; - @SerializedName("participantSets") - private List participantSets = null; - @SerializedName("senderInfo") private SenderInfo senderInfo = null; @SerializedName("sharesInfo") private List sharesInfo = null; + public MembersInfo participantSets(List participantSets) { + this.participantSets = participantSets; + return this; + } + + public MembersInfo addParticipantSetsItem(DetailedParticipantSetInfo participantSetsItem) { + if (this.participantSets == null) { + this.participantSets = new ArrayList(); + } + this.participantSets.add(participantSetsItem); + return this; + } + + /** + * Information about the participant Sets. + * @return participantSets + **/ + @ApiModelProperty(value = "Information about the participant Sets.") + public List getParticipantSets() { + return participantSets; + } + + public void setParticipantSets(List participantSets) { + this.participantSets = participantSets; + } + public MembersInfo ccsInfo(List ccsInfo) { this.ccsInfo = ccsInfo; return this; @@ -116,32 +127,6 @@ public void setNextParticipantSets(List nextParticip this.nextParticipantSets = nextParticipantSets; } - public MembersInfo participantSets(List participantSets) { - this.participantSets = participantSets; - return this; - } - - public MembersInfo addParticipantSetsItem(DetailedParticipantSetInfo participantSetsItem) { - if (this.participantSets == null) { - this.participantSets = new ArrayList(); - } - this.participantSets.add(participantSetsItem); - return this; - } - - /** - * Information about the participant Sets. - * @return participantSets - **/ - @ApiModelProperty(value = "Information about the participant Sets.") - public List getParticipantSets() { - return participantSets; - } - - public void setParticipantSets(List participantSets) { - this.participantSets = participantSets; - } - public MembersInfo senderInfo(SenderInfo senderInfo) { this.senderInfo = senderInfo; return this; @@ -196,16 +181,16 @@ public boolean equals(java.lang.Object o) { return false; } MembersInfo membersInfo = (MembersInfo) o; - return Objects.equals(this.ccsInfo, membersInfo.ccsInfo) && + return Objects.equals(this.participantSets, membersInfo.participantSets) && + Objects.equals(this.ccsInfo, membersInfo.ccsInfo) && Objects.equals(this.nextParticipantSets, membersInfo.nextParticipantSets) && - Objects.equals(this.participantSets, membersInfo.participantSets) && Objects.equals(this.senderInfo, membersInfo.senderInfo) && Objects.equals(this.sharesInfo, membersInfo.sharesInfo); } @Override public int hashCode() { - return Objects.hash(ccsInfo, nextParticipantSets, participantSets, senderInfo, sharesInfo); + return Objects.hash(participantSets, ccsInfo, nextParticipantSets, senderInfo, sharesInfo); } @@ -214,9 +199,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class MembersInfo {\n"); + sb.append(" participantSets: ").append(toIndentedString(participantSets)).append("\n"); sb.append(" ccsInfo: ").append(toIndentedString(ccsInfo)).append("\n"); sb.append(" nextParticipantSets: ").append(toIndentedString(nextParticipantSets)).append("\n"); - sb.append(" participantSets: ").append(toIndentedString(participantSets)).append("\n"); sb.append(" senderInfo: ").append(toIndentedString(senderInfo)).append("\n"); sb.append(" sharesInfo: ").append(toIndentedString(sharesInfo)).append("\n"); sb.append("}"); diff --git a/src/main/java/io/swagger/client/model/agreements/MergefieldInfo.java b/src/main/java/io/swagger/client/model/agreements/MergefieldInfo.java index 82a8f75..891244a 100755 --- a/src/main/java/io/swagger/client/model/agreements/MergefieldInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/MergefieldInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,31 +26,13 @@ /** * MergefieldInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class MergefieldInfo { - @SerializedName("defaultValue") - private String defaultValue = null; - @SerializedName("fieldName") private String fieldName = null; - public MergefieldInfo defaultValue(String defaultValue) { - this.defaultValue = defaultValue; - return this; - } - - /** - * The default value of the field - * @return defaultValue - **/ - @ApiModelProperty(value = "The default value of the field") - public String getDefaultValue() { - return defaultValue; - } - - public void setDefaultValue(String defaultValue) { - this.defaultValue = defaultValue; - } + @SerializedName("defaultValue") + private String defaultValue = null; public MergefieldInfo fieldName(String fieldName) { this.fieldName = fieldName; @@ -85,6 +52,24 @@ public void setFieldName(String fieldName) { this.fieldName = fieldName; } + public MergefieldInfo defaultValue(String defaultValue) { + this.defaultValue = defaultValue; + return this; + } + + /** + * The default value of the field + * @return defaultValue + **/ + @ApiModelProperty(value = "The default value of the field") + public String getDefaultValue() { + return defaultValue; + } + + public void setDefaultValue(String defaultValue) { + this.defaultValue = defaultValue; + } + @Override public boolean equals(java.lang.Object o) { @@ -95,13 +80,13 @@ public boolean equals(java.lang.Object o) { return false; } MergefieldInfo mergefieldInfo = (MergefieldInfo) o; - return Objects.equals(this.defaultValue, mergefieldInfo.defaultValue) && - Objects.equals(this.fieldName, mergefieldInfo.fieldName); + return Objects.equals(this.fieldName, mergefieldInfo.fieldName) && + Objects.equals(this.defaultValue, mergefieldInfo.defaultValue); } @Override public int hashCode() { - return Objects.hash(defaultValue, fieldName); + return Objects.hash(fieldName, defaultValue); } @@ -110,8 +95,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class MergefieldInfo {\n"); - sb.append(" defaultValue: ").append(toIndentedString(defaultValue)).append("\n"); sb.append(" fieldName: ").append(toIndentedString(fieldName)).append("\n"); + sb.append(" defaultValue: ").append(toIndentedString(defaultValue)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/MyAgreementInfo.java b/src/main/java/io/swagger/client/model/agreements/MyAgreementInfo.java new file mode 100644 index 0000000..5e50a76 --- /dev/null +++ b/src/main/java/io/swagger/client/model/agreements/MyAgreementInfo.java @@ -0,0 +1,104 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.agreements; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.agreements.AccountSharerInfo; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * MyAgreementInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") +public class MyAgreementInfo { + @SerializedName("accountSharers") + private List accountSharers = null; + + public MyAgreementInfo accountSharers(List accountSharers) { + this.accountSharers = accountSharers; + return this; + } + + public MyAgreementInfo addAccountSharersItem(AccountSharerInfo accountSharersItem) { + if (this.accountSharers == null) { + this.accountSharers = new ArrayList(); + } + this.accountSharers.add(accountSharersItem); + return this; + } + + /** + * A list of account sharer in relation to the api caller and this resource. + * @return accountSharers + **/ + @ApiModelProperty(value = "A list of account sharer in relation to the api caller and this resource.") + public List getAccountSharers() { + return accountSharers; + } + + public void setAccountSharers(List accountSharers) { + this.accountSharers = accountSharers; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + MyAgreementInfo myAgreementInfo = (MyAgreementInfo) o; + return Objects.equals(this.accountSharers, myAgreementInfo.accountSharers); + } + + @Override + public int hashCode() { + return Objects.hash(accountSharers); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class MyAgreementInfo {\n"); + + sb.append(" accountSharers: ").append(toIndentedString(accountSharers)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/agreements/Note.java b/src/main/java/io/swagger/client/model/agreements/Note.java index de75e86..9e219da 100755 --- a/src/main/java/io/swagger/client/model/agreements/Note.java +++ b/src/main/java/io/swagger/client/model/agreements/Note.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * Note */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class Note { @SerializedName("note") private String note = null; diff --git a/src/main/java/io/swagger/client/model/agreements/OfflineDeviceInfo.java b/src/main/java/io/swagger/client/model/agreements/OfflineDeviceInfo.java index 3ccffdb..a0a980e 100755 --- a/src/main/java/io/swagger/client/model/agreements/OfflineDeviceInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/OfflineDeviceInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,35 +27,17 @@ /** * OfflineDeviceInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class OfflineDeviceInfo { - @SerializedName("applicationDescription") - private String applicationDescription = null; - @SerializedName("deviceDescription") private String deviceDescription = null; + @SerializedName("applicationDescription") + private String applicationDescription = null; + @SerializedName("deviceTime") private Date deviceTime = null; - public OfflineDeviceInfo applicationDescription(String applicationDescription) { - this.applicationDescription = applicationDescription; - return this; - } - - /** - * Application Description - * @return applicationDescription - **/ - @ApiModelProperty(value = "Application Description") - public String getApplicationDescription() { - return applicationDescription; - } - - public void setApplicationDescription(String applicationDescription) { - this.applicationDescription = applicationDescription; - } - public OfflineDeviceInfo deviceDescription(String deviceDescription) { this.deviceDescription = deviceDescription; return this; @@ -89,6 +56,24 @@ public void setDeviceDescription(String deviceDescription) { this.deviceDescription = deviceDescription; } + public OfflineDeviceInfo applicationDescription(String applicationDescription) { + this.applicationDescription = applicationDescription; + return this; + } + + /** + * Application Description + * @return applicationDescription + **/ + @ApiModelProperty(value = "Application Description") + public String getApplicationDescription() { + return applicationDescription; + } + + public void setApplicationDescription(String applicationDescription) { + this.applicationDescription = applicationDescription; + } + public OfflineDeviceInfo deviceTime(Date deviceTime) { this.deviceTime = deviceTime; return this; @@ -117,14 +102,14 @@ public boolean equals(java.lang.Object o) { return false; } OfflineDeviceInfo offlineDeviceInfo = (OfflineDeviceInfo) o; - return Objects.equals(this.applicationDescription, offlineDeviceInfo.applicationDescription) && - Objects.equals(this.deviceDescription, offlineDeviceInfo.deviceDescription) && + return Objects.equals(this.deviceDescription, offlineDeviceInfo.deviceDescription) && + Objects.equals(this.applicationDescription, offlineDeviceInfo.applicationDescription) && Objects.equals(this.deviceTime, offlineDeviceInfo.deviceTime); } @Override public int hashCode() { - return Objects.hash(applicationDescription, deviceDescription, deviceTime); + return Objects.hash(deviceDescription, applicationDescription, deviceTime); } @@ -133,8 +118,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class OfflineDeviceInfo {\n"); - sb.append(" applicationDescription: ").append(toIndentedString(applicationDescription)).append("\n"); sb.append(" deviceDescription: ").append(toIndentedString(deviceDescription)).append("\n"); + sb.append(" applicationDescription: ").append(toIndentedString(applicationDescription)).append("\n"); sb.append(" deviceTime: ").append(toIndentedString(deviceTime)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/agreements/PageImageUrl.java b/src/main/java/io/swagger/client/model/agreements/PageImageUrl.java index f9246b3..deef6f2 100755 --- a/src/main/java/io/swagger/client/model/agreements/PageImageUrl.java +++ b/src/main/java/io/swagger/client/model/agreements/PageImageUrl.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * PageImageUrl */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class PageImageUrl { @SerializedName("pageNumber") private Integer pageNumber = null; diff --git a/src/main/java/io/swagger/client/model/agreements/PageInfo.java b/src/main/java/io/swagger/client/model/agreements/PageInfo.java index 19c5d77..1f72e0f 100755 --- a/src/main/java/io/swagger/client/model/agreements/PageInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/PageInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * PageInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class PageInfo { @SerializedName("nextCursor") private String nextCursor = null; diff --git a/src/main/java/io/swagger/client/model/agreements/ParticipantSecurityOption.java b/src/main/java/io/swagger/client/model/agreements/ParticipantSecurityOption.java index 4bb58ff..05b0bbb 100755 --- a/src/main/java/io/swagger/client/model/agreements/ParticipantSecurityOption.java +++ b/src/main/java/io/swagger/client/model/agreements/ParticipantSecurityOption.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,8 +27,11 @@ /** * ParticipantSecurityOption */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class ParticipantSecurityOption { + @SerializedName("password") + private String password = null; + /** * The authentication method for the participants to have access to view and sign the document. When replacing a participant that has PASSWORD or PHONE authentication specified, you must supply a password or phone number for the new participant, and you cannot change the authentication method */ @@ -104,30 +92,9 @@ public AuthenticationMethodEnum read(final JsonReader jsonReader) throws IOExcep @SerializedName("authenticationMethod") private AuthenticationMethodEnum authenticationMethod = null; - @SerializedName("password") - private String password = null; - @SerializedName("phoneInfo") private PhoneInfo phoneInfo = null; - public ParticipantSecurityOption authenticationMethod(AuthenticationMethodEnum authenticationMethod) { - this.authenticationMethod = authenticationMethod; - return this; - } - - /** - * The authentication method for the participants to have access to view and sign the document. When replacing a participant that has PASSWORD or PHONE authentication specified, you must supply a password or phone number for the new participant, and you cannot change the authentication method - * @return authenticationMethod - **/ - @ApiModelProperty(value = "The authentication method for the participants to have access to view and sign the document. When replacing a participant that has PASSWORD or PHONE authentication specified, you must supply a password or phone number for the new participant, and you cannot change the authentication method") - public AuthenticationMethodEnum getAuthenticationMethod() { - return authenticationMethod; - } - - public void setAuthenticationMethod(AuthenticationMethodEnum authenticationMethod) { - this.authenticationMethod = authenticationMethod; - } - public ParticipantSecurityOption password(String password) { this.password = password; return this; @@ -146,6 +113,24 @@ public void setPassword(String password) { this.password = password; } + public ParticipantSecurityOption authenticationMethod(AuthenticationMethodEnum authenticationMethod) { + this.authenticationMethod = authenticationMethod; + return this; + } + + /** + * The authentication method for the participants to have access to view and sign the document. When replacing a participant that has PASSWORD or PHONE authentication specified, you must supply a password or phone number for the new participant, and you cannot change the authentication method + * @return authenticationMethod + **/ + @ApiModelProperty(value = "The authentication method for the participants to have access to view and sign the document. When replacing a participant that has PASSWORD or PHONE authentication specified, you must supply a password or phone number for the new participant, and you cannot change the authentication method") + public AuthenticationMethodEnum getAuthenticationMethod() { + return authenticationMethod; + } + + public void setAuthenticationMethod(AuthenticationMethodEnum authenticationMethod) { + this.authenticationMethod = authenticationMethod; + } + public ParticipantSecurityOption phoneInfo(PhoneInfo phoneInfo) { this.phoneInfo = phoneInfo; return this; @@ -174,14 +159,14 @@ public boolean equals(java.lang.Object o) { return false; } ParticipantSecurityOption participantSecurityOption = (ParticipantSecurityOption) o; - return Objects.equals(this.authenticationMethod, participantSecurityOption.authenticationMethod) && - Objects.equals(this.password, participantSecurityOption.password) && + return Objects.equals(this.password, participantSecurityOption.password) && + Objects.equals(this.authenticationMethod, participantSecurityOption.authenticationMethod) && Objects.equals(this.phoneInfo, participantSecurityOption.phoneInfo); } @Override public int hashCode() { - return Objects.hash(authenticationMethod, password, phoneInfo); + return Objects.hash(password, authenticationMethod, phoneInfo); } @@ -190,8 +175,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ParticipantSecurityOption {\n"); - sb.append(" authenticationMethod: ").append(toIndentedString(authenticationMethod)).append("\n"); sb.append(" password: ").append(toIndentedString(password)).append("\n"); + sb.append(" authenticationMethod: ").append(toIndentedString(authenticationMethod)).append("\n"); sb.append(" phoneInfo: ").append(toIndentedString(phoneInfo)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/agreements/ParticipantSetInfo.java b/src/main/java/io/swagger/client/model/agreements/ParticipantSetInfo.java index bd88617..a9c6ccc 100755 --- a/src/main/java/io/swagger/client/model/agreements/ParticipantSetInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/ParticipantSetInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,23 +29,8 @@ /** * ParticipantSetInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class ParticipantSetInfo { - @SerializedName("label") - private String label = null; - - @SerializedName("memberInfos") - private List memberInfos = null; - - @SerializedName("name") - private String name = null; - - @SerializedName("order") - private Integer order = null; - - @SerializedName("privateMessage") - private String privateMessage = null; - /** * Role assumed by all participants in the set (signer, approver etc.) */ @@ -132,48 +102,66 @@ public RoleEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("visiblePages") private List visiblePages = null; - public ParticipantSetInfo label(String label) { - this.label = label; + @SerializedName("name") + private String name = null; + + @SerializedName("id") + private String id = null; + + @SerializedName("label") + private String label = null; + + @SerializedName("privateMessage") + private String privateMessage = null; + + @SerializedName("memberInfos") + private List memberInfos = null; + + @SerializedName("order") + private Integer order = null; + + public ParticipantSetInfo role(RoleEnum role) { + this.role = role; return this; } /** - * The unique label of a participant set.<br>For custom workflows, label specified in the participation set should map it to the participation step in the custom workflow. - * @return label + * Role assumed by all participants in the set (signer, approver etc.) + * @return role **/ - @ApiModelProperty(value = "The unique label of a participant set.
For custom workflows, label specified in the participation set should map it to the participation step in the custom workflow.") - public String getLabel() { - return label; + @ApiModelProperty(value = "Role assumed by all participants in the set (signer, approver etc.)") + public RoleEnum getRole() { + return role; } - public void setLabel(String label) { - this.label = label; + public void setRole(RoleEnum role) { + this.role = role; } - public ParticipantSetInfo memberInfos(List memberInfos) { - this.memberInfos = memberInfos; + public ParticipantSetInfo visiblePages(List visiblePages) { + this.visiblePages = visiblePages; return this; } - public ParticipantSetInfo addMemberInfosItem(ParticipantSetMemberInfo memberInfosItem) { - if (this.memberInfos == null) { - this.memberInfos = new ArrayList(); + public ParticipantSetInfo addVisiblePagesItem(String visiblePagesItem) { + if (this.visiblePages == null) { + this.visiblePages = new ArrayList(); } - this.memberInfos.add(memberInfosItem); + this.visiblePages.add(visiblePagesItem); return this; } /** - * Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set - * @return memberInfos + * When you enable limited document visibility (documentVisibilityEnabled), you can specify which file (fileInfo) should be made visible to which specific participant set.<br>Specify one or more label values of a fileInfos element.<br>Each signer participant sets must contain at least one required signature field in at least one visible file included in this API call; if not a page with a signature field is automatically appended for any missing participant sets. If there is a possibility that one or more participant sets do not have a required signature field in the files included in the API call, all signer participant sets should include a special index value of '0' to make this automatically appended signature page visible to the signer. Not doing so may result in an error. For all other roles, you may omit this value to exclude this page. + * @return visiblePages **/ - @ApiModelProperty(value = "Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set") - public List getMemberInfos() { - return memberInfos; + @ApiModelProperty(value = "When you enable limited document visibility (documentVisibilityEnabled), you can specify which file (fileInfo) should be made visible to which specific participant set.
Specify one or more label values of a fileInfos element.
Each signer participant sets must contain at least one required signature field in at least one visible file included in this API call; if not a page with a signature field is automatically appended for any missing participant sets. If there is a possibility that one or more participant sets do not have a required signature field in the files included in the API call, all signer participant sets should include a special index value of '0' to make this automatically appended signature page visible to the signer. Not doing so may result in an error. For all other roles, you may omit this value to exclude this page.") + public List getVisiblePages() { + return visiblePages; } - public void setMemberInfos(List memberInfos) { - this.memberInfos = memberInfos; + public void setVisiblePages(List visiblePages) { + this.visiblePages = visiblePages; } public ParticipantSetInfo name(String name) { @@ -182,10 +170,10 @@ public ParticipantSetInfo name(String name) { } /** - * Name of the participant set (it can be empty, but needs not to be unique in a single agreement). Maximum no of characters in participant set name is restricted to 255 + * Name of the participant set (it can be empty, but if present it must be unique within a single agreement). Maximum no of characters in participant set name is restricted to 255 * @return name **/ - @ApiModelProperty(value = "Name of the participant set (it can be empty, but needs not to be unique in a single agreement). Maximum no of characters in participant set name is restricted to 255") + @ApiModelProperty(value = "Name of the participant set (it can be empty, but if present it must be unique within a single agreement). Maximum no of characters in participant set name is restricted to 255") public String getName() { return name; } @@ -194,22 +182,40 @@ public void setName(String name) { this.name = name; } - public ParticipantSetInfo order(Integer order) { - this.order = order; + public ParticipantSetInfo id(String id) { + this.id = id; return this; } /** - * Index indicating position at which signing group needs to sign. Signing group to sign at first place is assigned a 1 index. Different signingOrder specified in input should form a valid consecutive increasing sequence of integers. Otherwise signingOrder will be considered invalid. No signingOrder should be specified for SHARE role - * @return order + * The unique identifier of the participant. This will be ignored as part of POST or PUT calls. The Id might be null in draft state + * @return id **/ - @ApiModelProperty(value = "Index indicating position at which signing group needs to sign. Signing group to sign at first place is assigned a 1 index. Different signingOrder specified in input should form a valid consecutive increasing sequence of integers. Otherwise signingOrder will be considered invalid. No signingOrder should be specified for SHARE role") - public Integer getOrder() { - return order; + @ApiModelProperty(value = "The unique identifier of the participant. This will be ignored as part of POST or PUT calls. The Id might be null in draft state") + public String getId() { + return id; } - public void setOrder(Integer order) { - this.order = order; + public void setId(String id) { + this.id = id; + } + + public ParticipantSetInfo label(String label) { + this.label = label; + return this; + } + + /** + * The unique label of a participant set.<br>For custom workflows, label specified in the participation set should map it to the participation step in the custom workflow. + * @return label + **/ + @ApiModelProperty(value = "The unique label of a participant set.
For custom workflows, label specified in the participation set should map it to the participation step in the custom workflow.") + public String getLabel() { + return label; + } + + public void setLabel(String label) { + this.label = label; } public ParticipantSetInfo privateMessage(String privateMessage) { @@ -230,48 +236,48 @@ public void setPrivateMessage(String privateMessage) { this.privateMessage = privateMessage; } - public ParticipantSetInfo role(RoleEnum role) { - this.role = role; + public ParticipantSetInfo memberInfos(List memberInfos) { + this.memberInfos = memberInfos; return this; } - /** - * Role assumed by all participants in the set (signer, approver etc.) - * @return role - **/ - @ApiModelProperty(value = "Role assumed by all participants in the set (signer, approver etc.)") - public RoleEnum getRole() { - return role; + public ParticipantSetInfo addMemberInfosItem(ParticipantSetMemberInfo memberInfosItem) { + if (this.memberInfos == null) { + this.memberInfos = new ArrayList(); + } + this.memberInfos.add(memberInfosItem); + return this; } - public void setRole(RoleEnum role) { - this.role = role; + /** + * Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set + * @return memberInfos + **/ + @ApiModelProperty(value = "Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set") + public List getMemberInfos() { + return memberInfos; } - public ParticipantSetInfo visiblePages(List visiblePages) { - this.visiblePages = visiblePages; - return this; + public void setMemberInfos(List memberInfos) { + this.memberInfos = memberInfos; } - public ParticipantSetInfo addVisiblePagesItem(String visiblePagesItem) { - if (this.visiblePages == null) { - this.visiblePages = new ArrayList(); - } - this.visiblePages.add(visiblePagesItem); + public ParticipantSetInfo order(Integer order) { + this.order = order; return this; } /** - * When you enable limited document visibility (documentVisibilityEnabled), you can specify which file (fileInfo) should be made visible to which specific participant set.<br>Specify one or more label values of a fileInfos element.<br>Each signer participant sets must contain at least one required signature field in at least one visible file included in this API call; if not a page with a signature field is automatically appended for any missing participant sets. If there is a possibility that one or more participant sets do not have a required signature field in the files included in the API call, all signer participant sets should include a special index value of '0' to make this automatically appended signature page visible to the signer. Not doing so may result in an error. For all other roles, you may omit this value to exclude this page. - * @return visiblePages + * Index indicating position at which signing group needs to sign. Signing group to sign at first place is assigned a 1 index. Different signingOrder specified in input should form a valid consecutive increasing sequence of integers. Otherwise signingOrder will be considered invalid. No signingOrder should be specified for SHARE role + * @return order **/ - @ApiModelProperty(value = "When you enable limited document visibility (documentVisibilityEnabled), you can specify which file (fileInfo) should be made visible to which specific participant set.
Specify one or more label values of a fileInfos element.
Each signer participant sets must contain at least one required signature field in at least one visible file included in this API call; if not a page with a signature field is automatically appended for any missing participant sets. If there is a possibility that one or more participant sets do not have a required signature field in the files included in the API call, all signer participant sets should include a special index value of '0' to make this automatically appended signature page visible to the signer. Not doing so may result in an error. For all other roles, you may omit this value to exclude this page.") - public List getVisiblePages() { - return visiblePages; + @ApiModelProperty(value = "Index indicating position at which signing group needs to sign. Signing group to sign at first place is assigned a 1 index. Different signingOrder specified in input should form a valid consecutive increasing sequence of integers. Otherwise signingOrder will be considered invalid. No signingOrder should be specified for SHARE role") + public Integer getOrder() { + return order; } - public void setVisiblePages(List visiblePages) { - this.visiblePages = visiblePages; + public void setOrder(Integer order) { + this.order = order; } @@ -284,18 +290,19 @@ public boolean equals(java.lang.Object o) { return false; } ParticipantSetInfo participantSetInfo = (ParticipantSetInfo) o; - return Objects.equals(this.label, participantSetInfo.label) && - Objects.equals(this.memberInfos, participantSetInfo.memberInfos) && + return Objects.equals(this.role, participantSetInfo.role) && + Objects.equals(this.visiblePages, participantSetInfo.visiblePages) && Objects.equals(this.name, participantSetInfo.name) && - Objects.equals(this.order, participantSetInfo.order) && + Objects.equals(this.id, participantSetInfo.id) && + Objects.equals(this.label, participantSetInfo.label) && Objects.equals(this.privateMessage, participantSetInfo.privateMessage) && - Objects.equals(this.role, participantSetInfo.role) && - Objects.equals(this.visiblePages, participantSetInfo.visiblePages); + Objects.equals(this.memberInfos, participantSetInfo.memberInfos) && + Objects.equals(this.order, participantSetInfo.order); } @Override public int hashCode() { - return Objects.hash(label, memberInfos, name, order, privateMessage, role, visiblePages); + return Objects.hash(role, visiblePages, name, id, label, privateMessage, memberInfos, order); } @@ -304,13 +311,14 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ParticipantSetInfo {\n"); + sb.append(" role: ").append(toIndentedString(role)).append("\n"); + sb.append(" visiblePages: ").append(toIndentedString(visiblePages)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" label: ").append(toIndentedString(label)).append("\n"); + sb.append(" privateMessage: ").append(toIndentedString(privateMessage)).append("\n"); sb.append(" memberInfos: ").append(toIndentedString(memberInfos)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" order: ").append(toIndentedString(order)).append("\n"); - sb.append(" privateMessage: ").append(toIndentedString(privateMessage)).append("\n"); - sb.append(" role: ").append(toIndentedString(role)).append("\n"); - sb.append(" visiblePages: ").append(toIndentedString(visiblePages)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/ParticipantSetMemberInfo.java b/src/main/java/io/swagger/client/model/agreements/ParticipantSetMemberInfo.java index 4c5440b..08f025b 100755 --- a/src/main/java/io/swagger/client/model/agreements/ParticipantSetMemberInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/ParticipantSetMemberInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,24 +27,45 @@ /** * ParticipantSetMemberInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class ParticipantSetMemberInfo { + @SerializedName("id") + private String id = null; + @SerializedName("email") private String email = null; @SerializedName("securityOption") private ParticipantSecurityOption securityOption = null; + public ParticipantSetMemberInfo id(String id) { + this.id = id; + return this; + } + + /** + * The unique identifier of the participant. This will be ignored as part of POST or PUT calls. The Id might be null in draft state + * @return id + **/ + @ApiModelProperty(value = "The unique identifier of the participant. This will be ignored as part of POST or PUT calls. The Id might be null in draft state") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + public ParticipantSetMemberInfo email(String email) { this.email = email; return this; } /** - * Email of the participant. In case of creating new Agreements(POST/PUT), this is a required field. In case of GET, this is the required field and will always be returned unless it is a fax workflow( legacy agreements) that were created using fax as input + * Email of the participant. In case of creating new Agreements(POST/PUT), this is a required field. * @return email **/ - @ApiModelProperty(value = "Email of the participant. In case of creating new Agreements(POST/PUT), this is a required field. In case of GET, this is the required field and will always be returned unless it is a fax workflow( legacy agreements) that were created using fax as input") + @ApiModelProperty(value = "Email of the participant. In case of creating new Agreements(POST/PUT), this is a required field.") public String getEmail() { return email; } @@ -96,13 +102,14 @@ public boolean equals(java.lang.Object o) { return false; } ParticipantSetMemberInfo participantSetMemberInfo = (ParticipantSetMemberInfo) o; - return Objects.equals(this.email, participantSetMemberInfo.email) && + return Objects.equals(this.id, participantSetMemberInfo.id) && + Objects.equals(this.email, participantSetMemberInfo.email) && Objects.equals(this.securityOption, participantSetMemberInfo.securityOption); } @Override public int hashCode() { - return Objects.hash(email, securityOption); + return Objects.hash(id, email, securityOption); } @@ -111,6 +118,7 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ParticipantSetMemberInfo {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); sb.append("}"); diff --git a/src/main/java/io/swagger/client/model/agreements/PhoneInfo.java b/src/main/java/io/swagger/client/model/agreements/PhoneInfo.java index dfd0173..ad1bfa2 100755 --- a/src/main/java/io/swagger/client/model/agreements/PhoneInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/PhoneInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,30 +26,33 @@ /** * PhoneInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class PhoneInfo { - @SerializedName("countryCode") - private String countryCode = null; + @SerializedName("countryIsoCode") + private String countryIsoCode = null; @SerializedName("phone") private String phone = null; - public PhoneInfo countryCode(String countryCode) { - this.countryCode = countryCode; + @SerializedName("countryCode") + private String countryCode = null; + + public PhoneInfo countryIsoCode(String countryIsoCode) { + this.countryIsoCode = countryIsoCode; return this; } /** - * The numeric country calling code (ISD code) required for the participant to view and sign the document if authentication type is PHONE - * @return countryCode + * The country ISO Alpha-2 code required for the participant to view and sign the document if authentication method is PHONE + * @return countryIsoCode **/ - @ApiModelProperty(value = "The numeric country calling code (ISD code) required for the participant to view and sign the document if authentication type is PHONE") - public String getCountryCode() { - return countryCode; + @ApiModelProperty(value = "The country ISO Alpha-2 code required for the participant to view and sign the document if authentication method is PHONE") + public String getCountryIsoCode() { + return countryIsoCode; } - public void setCountryCode(String countryCode) { - this.countryCode = countryCode; + public void setCountryIsoCode(String countryIsoCode) { + this.countryIsoCode = countryIsoCode; } public PhoneInfo phone(String phone) { @@ -85,6 +73,24 @@ public void setPhone(String phone) { this.phone = phone; } + public PhoneInfo countryCode(String countryCode) { + this.countryCode = countryCode; + return this; + } + + /** + * The numeric country calling code (ISD code) required for the participant to view and sign the document if authentication type is PHONE + * @return countryCode + **/ + @ApiModelProperty(value = "The numeric country calling code (ISD code) required for the participant to view and sign the document if authentication type is PHONE") + public String getCountryCode() { + return countryCode; + } + + public void setCountryCode(String countryCode) { + this.countryCode = countryCode; + } + @Override public boolean equals(java.lang.Object o) { @@ -95,13 +101,14 @@ public boolean equals(java.lang.Object o) { return false; } PhoneInfo phoneInfo = (PhoneInfo) o; - return Objects.equals(this.countryCode, phoneInfo.countryCode) && - Objects.equals(this.phone, phoneInfo.phone); + return Objects.equals(this.countryIsoCode, phoneInfo.countryIsoCode) && + Objects.equals(this.phone, phoneInfo.phone) && + Objects.equals(this.countryCode, phoneInfo.countryCode); } @Override public int hashCode() { - return Objects.hash(countryCode, phone); + return Objects.hash(countryIsoCode, phone, countryCode); } @@ -110,8 +117,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class PhoneInfo {\n"); - sb.append(" countryCode: ").append(toIndentedString(countryCode)).append("\n"); + sb.append(" countryIsoCode: ").append(toIndentedString(countryIsoCode)).append("\n"); sb.append(" phone: ").append(toIndentedString(phone)).append("\n"); + sb.append(" countryCode: ").append(toIndentedString(countryCode)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/PostSignOption.java b/src/main/java/io/swagger/client/model/agreements/PostSignOption.java index 174bd64..40262d0 100755 --- a/src/main/java/io/swagger/client/model/agreements/PostSignOption.java +++ b/src/main/java/io/swagger/client/model/agreements/PostSignOption.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,31 +26,13 @@ /** * PostSignOption */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class PostSignOption { - @SerializedName("redirectDelay") - private Integer redirectDelay = null; - @SerializedName("redirectUrl") private String redirectUrl = null; - public PostSignOption redirectDelay(Integer redirectDelay) { - this.redirectDelay = redirectDelay; - return this; - } - - /** - * The delay (in seconds) before the user is taken to the success page. If this value is greater than 0, the user will first see the standard Adobe Sign success message, and then after a delay will be redirected to your success page - * @return redirectDelay - **/ - @ApiModelProperty(value = "The delay (in seconds) before the user is taken to the success page. If this value is greater than 0, the user will first see the standard Adobe Sign success message, and then after a delay will be redirected to your success page") - public Integer getRedirectDelay() { - return redirectDelay; - } - - public void setRedirectDelay(Integer redirectDelay) { - this.redirectDelay = redirectDelay; - } + @SerializedName("redirectDelay") + private Integer redirectDelay = null; public PostSignOption redirectUrl(String redirectUrl) { this.redirectUrl = redirectUrl; @@ -85,6 +52,24 @@ public void setRedirectUrl(String redirectUrl) { this.redirectUrl = redirectUrl; } + public PostSignOption redirectDelay(Integer redirectDelay) { + this.redirectDelay = redirectDelay; + return this; + } + + /** + * The delay (in seconds) before the user is taken to the success page. If this value is greater than 0, the user will first see the standard Adobe Sign success message, and then after a delay will be redirected to your success page + * @return redirectDelay + **/ + @ApiModelProperty(value = "The delay (in seconds) before the user is taken to the success page. If this value is greater than 0, the user will first see the standard Adobe Sign success message, and then after a delay will be redirected to your success page") + public Integer getRedirectDelay() { + return redirectDelay; + } + + public void setRedirectDelay(Integer redirectDelay) { + this.redirectDelay = redirectDelay; + } + @Override public boolean equals(java.lang.Object o) { @@ -95,13 +80,13 @@ public boolean equals(java.lang.Object o) { return false; } PostSignOption postSignOption = (PostSignOption) o; - return Objects.equals(this.redirectDelay, postSignOption.redirectDelay) && - Objects.equals(this.redirectUrl, postSignOption.redirectUrl); + return Objects.equals(this.redirectUrl, postSignOption.redirectUrl) && + Objects.equals(this.redirectDelay, postSignOption.redirectDelay); } @Override public int hashCode() { - return Objects.hash(redirectDelay, redirectUrl); + return Objects.hash(redirectUrl, redirectDelay); } @@ -110,8 +95,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class PostSignOption {\n"); - sb.append(" redirectDelay: ").append(toIndentedString(redirectDelay)).append("\n"); sb.append(" redirectUrl: ").append(toIndentedString(redirectUrl)).append("\n"); + sb.append(" redirectDelay: ").append(toIndentedString(redirectDelay)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/ReminderCreationResult.java b/src/main/java/io/swagger/client/model/agreements/ReminderCreationResult.java index 38f2c0a..359eb7d 100755 --- a/src/main/java/io/swagger/client/model/agreements/ReminderCreationResult.java +++ b/src/main/java/io/swagger/client/model/agreements/ReminderCreationResult.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * ReminderCreationResult */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class ReminderCreationResult { @SerializedName("id") private String id = null; diff --git a/src/main/java/io/swagger/client/model/agreements/ReminderInfo.java b/src/main/java/io/swagger/client/model/agreements/ReminderInfo.java index 46022c4..7e11712 100755 --- a/src/main/java/io/swagger/client/model/agreements/ReminderInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/ReminderInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,33 +29,38 @@ /** * ReminderInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class ReminderInfo { + @SerializedName("note") + private String note = null; + + @SerializedName("lastSentDate") + private Date lastSentDate = null; + + @SerializedName("nextSentDate") + private Date nextSentDate = null; + + @SerializedName("reminderId") + private String reminderId = null; + @SerializedName("firstReminderDelay") private Integer firstReminderDelay = null; + @SerializedName("recipientParticipantIds") + private List recipientParticipantIds = null; + /** - * The frequency at which reminder will be sent until the agreement is completed.<br>If frequency is not provided, the reminder will be sent once (if the agreement is available at the specified time) with the delay based on the firstReminderDelay field and will never repeat again. If the agreement is not available at that time, reminder will not be sent. Cannot be updated in a PUT + * Reminder can be sent based on when the agreement becomes available or when the reminder is created<br>AGREEMENT_AVAILABILITY: If the agreement is not available to the participant at the time of reminder creation, the reminder will be sent for the first time, only when the agreement becomes available to the participant taking the firstReminderDelay into account. Subsequent reminders will be sent based on the frequency specified. If the agreement is already available to the participant at the time of reminder creation, the first reminder will be sent after the delay specified by firstReminderDelay from the reminder creation time.<br>REMINDER_CREATION: The first reminder will be sent after the delay specified by firstReminderDelay from the reminder creation time only if the agreement is available at that time. Subsequent reminders will be triggered based on the frequency specified and will be sent only if the agreement is available at that time. For agreements in authoring state, creating reminder with startReminderCounterFrom as REMINDER_CREATION is not allowed.<br>Note : If firstReminderDelay, frequency and startReminderCounterFrom fields are not specified in POST, reminder will be sent right now if the agreement is available. If agreement is not available, an error will be thrown. Cannot be updated in a PUT */ - @JsonAdapter(FrequencyEnum.Adapter.class) - public enum FrequencyEnum { - DAILY_UNTIL_SIGNED("DAILY_UNTIL_SIGNED"), - - WEEKDAILY_UNTIL_SIGNED("WEEKDAILY_UNTIL_SIGNED"), - - EVERY_OTHER_DAY_UNTIL_SIGNED("EVERY_OTHER_DAY_UNTIL_SIGNED"), - - EVERY_THIRD_DAY_UNTIL_SIGNED("EVERY_THIRD_DAY_UNTIL_SIGNED"), - - EVERY_FIFTH_DAY_UNTIL_SIGNED("EVERY_FIFTH_DAY_UNTIL_SIGNED"), - - WEEKLY_UNTIL_SIGNED("WEEKLY_UNTIL_SIGNED"), + @JsonAdapter(StartReminderCounterFromEnum.Adapter.class) + public enum StartReminderCounterFromEnum { + AGREEMENT_AVAILABILITY("AGREEMENT_AVAILABILITY"), - ONCE("ONCE"); + REMINDER_CREATION("REMINDER_CREATION"); private String value; - FrequencyEnum(String value) { + StartReminderCounterFromEnum(String value) { this.value = value; } @@ -83,8 +73,8 @@ public String toString() { return String.valueOf(value); } - public static FrequencyEnum fromValue(String text) { - for (FrequencyEnum b : FrequencyEnum.values()) { + public static StartReminderCounterFromEnum fromValue(String text) { + for (StartReminderCounterFromEnum b : StartReminderCounterFromEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -92,50 +82,45 @@ public static FrequencyEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final FrequencyEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final StartReminderCounterFromEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public FrequencyEnum read(final JsonReader jsonReader) throws IOException { + public StartReminderCounterFromEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return FrequencyEnum.fromValue(String.valueOf(value)); + return StartReminderCounterFromEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("frequency") - private FrequencyEnum frequency = null; - - @SerializedName("lastSentDate") - private Date lastSentDate = null; - - @SerializedName("nextSentDate") - private Date nextSentDate = null; - - @SerializedName("note") - private String note = null; - - @SerializedName("recipientParticipantIds") - private List recipientParticipantIds = null; - - @SerializedName("reminderId") - private String reminderId = null; + @SerializedName("startReminderCounterFrom") + private StartReminderCounterFromEnum startReminderCounterFrom = null; /** - * Reminder can be sent based on when the agreement becomes available or when the reminder is created<br>AGREEMENT_AVAILABILITY: If the agreement is not available to the participant at the time of reminder creation, the reminder will be sent for the first time, only when the agreement becomes available to the participant taking the firstReminderDelay into account. Subsequent reminders will be sent based on the frequency specified. If the agreement is already available to the participant at the time of reminder creation, the first reminder will be sent after the delay specified by firstReminderDelay from the reminder creation time.<br>REMINDER_CREATION: The first reminder will be sent after the delay specified by firstReminderDelay from the reminder creation time only if the agreement is available at that time. Subsequent reminders will be triggered based on the frequency specified and will be sent only if the agreement is available at that time. For agreements in authoring state, creating reminder with startReminderCounterFrom as REMINDER_CREATION is not allowed.<br>Note : If firstReminderDelay, frequency and startReminderCounterFrom fields are not specified in POST, reminder will be sent right now if the agreement is available. If agreement is not available, an error will be thrown. Cannot be updated in a PUT + * The frequency at which reminder will be sent until the agreement is completed.<br>If frequency is not provided, the reminder will be sent once (if the agreement is available at the specified time) with the delay based on the firstReminderDelay field and will never repeat again. If the agreement is not available at that time, reminder will not be sent. Cannot be updated in a PUT */ - @JsonAdapter(StartReminderCounterFromEnum.Adapter.class) - public enum StartReminderCounterFromEnum { - AGREEMENT_AVAILABILITY("AGREEMENT_AVAILABILITY"), + @JsonAdapter(FrequencyEnum.Adapter.class) + public enum FrequencyEnum { + DAILY_UNTIL_SIGNED("DAILY_UNTIL_SIGNED"), - REMINDER_CREATION("REMINDER_CREATION"); + WEEKDAILY_UNTIL_SIGNED("WEEKDAILY_UNTIL_SIGNED"), + + EVERY_OTHER_DAY_UNTIL_SIGNED("EVERY_OTHER_DAY_UNTIL_SIGNED"), + + EVERY_THIRD_DAY_UNTIL_SIGNED("EVERY_THIRD_DAY_UNTIL_SIGNED"), + + EVERY_FIFTH_DAY_UNTIL_SIGNED("EVERY_FIFTH_DAY_UNTIL_SIGNED"), + + WEEKLY_UNTIL_SIGNED("WEEKLY_UNTIL_SIGNED"), + + ONCE("ONCE"); private String value; - StartReminderCounterFromEnum(String value) { + FrequencyEnum(String value) { this.value = value; } @@ -148,8 +133,8 @@ public String toString() { return String.valueOf(value); } - public static StartReminderCounterFromEnum fromValue(String text) { - for (StartReminderCounterFromEnum b : StartReminderCounterFromEnum.values()) { + public static FrequencyEnum fromValue(String text) { + for (FrequencyEnum b : FrequencyEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -157,22 +142,22 @@ public static StartReminderCounterFromEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final StartReminderCounterFromEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final FrequencyEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public StartReminderCounterFromEnum read(final JsonReader jsonReader) throws IOException { + public FrequencyEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return StartReminderCounterFromEnum.fromValue(String.valueOf(value)); + return FrequencyEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("startReminderCounterFrom") - private StartReminderCounterFromEnum startReminderCounterFrom = null; + @SerializedName("frequency") + private FrequencyEnum frequency = null; /** * Current status of the reminder. The only valid update in a PUT is from ACTIVE to CANCELED. Must be provided as ACTIVE in a POST. @@ -226,40 +211,22 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; - public ReminderInfo firstReminderDelay(Integer firstReminderDelay) { - this.firstReminderDelay = firstReminderDelay; - return this; - } - - /** - * Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT - * @return firstReminderDelay - **/ - @ApiModelProperty(value = "Integer which specifies the delay in hours before sending the first reminder.
This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.
If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.
i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT") - public Integer getFirstReminderDelay() { - return firstReminderDelay; - } - - public void setFirstReminderDelay(Integer firstReminderDelay) { - this.firstReminderDelay = firstReminderDelay; - } - - public ReminderInfo frequency(FrequencyEnum frequency) { - this.frequency = frequency; + public ReminderInfo note(String note) { + this.note = note; return this; } /** - * The frequency at which reminder will be sent until the agreement is completed.<br>If frequency is not provided, the reminder will be sent once (if the agreement is available at the specified time) with the delay based on the firstReminderDelay field and will never repeat again. If the agreement is not available at that time, reminder will not be sent. Cannot be updated in a PUT - * @return frequency + * An optional message sent to the recipients, describing why their participation is required + * @return note **/ - @ApiModelProperty(value = "The frequency at which reminder will be sent until the agreement is completed.
If frequency is not provided, the reminder will be sent once (if the agreement is available at the specified time) with the delay based on the firstReminderDelay field and will never repeat again. If the agreement is not available at that time, reminder will not be sent. Cannot be updated in a PUT") - public FrequencyEnum getFrequency() { - return frequency; + @ApiModelProperty(value = "An optional message sent to the recipients, describing why their participation is required") + public String getNote() { + return note; } - public void setFrequency(FrequencyEnum frequency) { - this.frequency = frequency; + public void setNote(String note) { + this.note = note; } public ReminderInfo lastSentDate(Date lastSentDate) { @@ -298,22 +265,40 @@ public void setNextSentDate(Date nextSentDate) { this.nextSentDate = nextSentDate; } - public ReminderInfo note(String note) { - this.note = note; + public ReminderInfo reminderId(String reminderId) { + this.reminderId = reminderId; return this; } /** - * An optional message sent to the recipients, describing why their participation is required - * @return note + * An identifier of the reminder resource created on the server. If provided in POST or PUT, it will be ignored + * @return reminderId **/ - @ApiModelProperty(value = "An optional message sent to the recipients, describing why their participation is required") - public String getNote() { - return note; + @ApiModelProperty(value = "An identifier of the reminder resource created on the server. If provided in POST or PUT, it will be ignored") + public String getReminderId() { + return reminderId; } - public void setNote(String note) { - this.note = note; + public void setReminderId(String reminderId) { + this.reminderId = reminderId; + } + + public ReminderInfo firstReminderDelay(Integer firstReminderDelay) { + this.firstReminderDelay = firstReminderDelay; + return this; + } + + /** + * Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT + * @return firstReminderDelay + **/ + @ApiModelProperty(value = "Integer which specifies the delay in hours before sending the first reminder.
This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.
If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.
i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT") + public Integer getFirstReminderDelay() { + return firstReminderDelay; + } + + public void setFirstReminderDelay(Integer firstReminderDelay) { + this.firstReminderDelay = firstReminderDelay; } public ReminderInfo recipientParticipantIds(List recipientParticipantIds) { @@ -342,24 +327,6 @@ public void setRecipientParticipantIds(List recipientParticipantIds) { this.recipientParticipantIds = recipientParticipantIds; } - public ReminderInfo reminderId(String reminderId) { - this.reminderId = reminderId; - return this; - } - - /** - * An identifier of the reminder resource created on the server. If provided in POST or PUT, it will be ignored - * @return reminderId - **/ - @ApiModelProperty(value = "An identifier of the reminder resource created on the server. If provided in POST or PUT, it will be ignored") - public String getReminderId() { - return reminderId; - } - - public void setReminderId(String reminderId) { - this.reminderId = reminderId; - } - public ReminderInfo startReminderCounterFrom(StartReminderCounterFromEnum startReminderCounterFrom) { this.startReminderCounterFrom = startReminderCounterFrom; return this; @@ -378,6 +345,24 @@ public void setStartReminderCounterFrom(StartReminderCounterFromEnum startRemind this.startReminderCounterFrom = startReminderCounterFrom; } + public ReminderInfo frequency(FrequencyEnum frequency) { + this.frequency = frequency; + return this; + } + + /** + * The frequency at which reminder will be sent until the agreement is completed.<br>If frequency is not provided, the reminder will be sent once (if the agreement is available at the specified time) with the delay based on the firstReminderDelay field and will never repeat again. If the agreement is not available at that time, reminder will not be sent. Cannot be updated in a PUT + * @return frequency + **/ + @ApiModelProperty(value = "The frequency at which reminder will be sent until the agreement is completed.
If frequency is not provided, the reminder will be sent once (if the agreement is available at the specified time) with the delay based on the firstReminderDelay field and will never repeat again. If the agreement is not available at that time, reminder will not be sent. Cannot be updated in a PUT") + public FrequencyEnum getFrequency() { + return frequency; + } + + public void setFrequency(FrequencyEnum frequency) { + this.frequency = frequency; + } + public ReminderInfo status(StatusEnum status) { this.status = status; return this; @@ -406,20 +391,20 @@ public boolean equals(java.lang.Object o) { return false; } ReminderInfo reminderInfo = (ReminderInfo) o; - return Objects.equals(this.firstReminderDelay, reminderInfo.firstReminderDelay) && - Objects.equals(this.frequency, reminderInfo.frequency) && + return Objects.equals(this.note, reminderInfo.note) && Objects.equals(this.lastSentDate, reminderInfo.lastSentDate) && Objects.equals(this.nextSentDate, reminderInfo.nextSentDate) && - Objects.equals(this.note, reminderInfo.note) && - Objects.equals(this.recipientParticipantIds, reminderInfo.recipientParticipantIds) && Objects.equals(this.reminderId, reminderInfo.reminderId) && + Objects.equals(this.firstReminderDelay, reminderInfo.firstReminderDelay) && + Objects.equals(this.recipientParticipantIds, reminderInfo.recipientParticipantIds) && Objects.equals(this.startReminderCounterFrom, reminderInfo.startReminderCounterFrom) && + Objects.equals(this.frequency, reminderInfo.frequency) && Objects.equals(this.status, reminderInfo.status); } @Override public int hashCode() { - return Objects.hash(firstReminderDelay, frequency, lastSentDate, nextSentDate, note, recipientParticipantIds, reminderId, startReminderCounterFrom, status); + return Objects.hash(note, lastSentDate, nextSentDate, reminderId, firstReminderDelay, recipientParticipantIds, startReminderCounterFrom, frequency, status); } @@ -428,14 +413,14 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ReminderInfo {\n"); - sb.append(" firstReminderDelay: ").append(toIndentedString(firstReminderDelay)).append("\n"); - sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); + sb.append(" note: ").append(toIndentedString(note)).append("\n"); sb.append(" lastSentDate: ").append(toIndentedString(lastSentDate)).append("\n"); sb.append(" nextSentDate: ").append(toIndentedString(nextSentDate)).append("\n"); - sb.append(" note: ").append(toIndentedString(note)).append("\n"); - sb.append(" recipientParticipantIds: ").append(toIndentedString(recipientParticipantIds)).append("\n"); sb.append(" reminderId: ").append(toIndentedString(reminderId)).append("\n"); + sb.append(" firstReminderDelay: ").append(toIndentedString(firstReminderDelay)).append("\n"); + sb.append(" recipientParticipantIds: ").append(toIndentedString(recipientParticipantIds)).append("\n"); sb.append(" startReminderCounterFrom: ").append(toIndentedString(startReminderCounterFrom)).append("\n"); + sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/agreements/RemindersResponse.java b/src/main/java/io/swagger/client/model/agreements/RemindersResponse.java index c40082b..0d383fc 100755 --- a/src/main/java/io/swagger/client/model/agreements/RemindersResponse.java +++ b/src/main/java/io/swagger/client/model/agreements/RemindersResponse.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * RemindersResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class RemindersResponse { @SerializedName("reminderInfoList") private List reminderInfoList = null; diff --git a/src/main/java/io/swagger/client/model/agreements/SecurityOption.java b/src/main/java/io/swagger/client/model/agreements/SecurityOption.java index 513193b..53a55dc 100755 --- a/src/main/java/io/swagger/client/model/agreements/SecurityOption.java +++ b/src/main/java/io/swagger/client/model/agreements/SecurityOption.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * SecurityOption */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class SecurityOption { @SerializedName("openPassword") private String openPassword = null; diff --git a/src/main/java/io/swagger/client/model/agreements/SendOptions.java b/src/main/java/io/swagger/client/model/agreements/SendOptions.java index 026a7c0..077ca2d 100755 --- a/src/main/java/io/swagger/client/model/agreements/SendOptions.java +++ b/src/main/java/io/swagger/client/model/agreements/SendOptions.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,20 +26,20 @@ /** * SendOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class SendOptions { /** - * Control notification mails for agreement completion events - COMPLETED, CANCELLED, EXPIRED and REJECTED + * Control notification mails for Agreement initiation events - ACTION_REQUESTED and CREATED */ - @JsonAdapter(CompletionEmailsEnum.Adapter.class) - public enum CompletionEmailsEnum { + @JsonAdapter(InitEmailsEnum.Adapter.class) + public enum InitEmailsEnum { ALL("ALL"), NONE("NONE"); private String value; - CompletionEmailsEnum(String value) { + InitEmailsEnum(String value) { this.value = value; } @@ -67,8 +52,8 @@ public String toString() { return String.valueOf(value); } - public static CompletionEmailsEnum fromValue(String text) { - for (CompletionEmailsEnum b : CompletionEmailsEnum.values()) { + public static InitEmailsEnum fromValue(String text) { + for (InitEmailsEnum b : InitEmailsEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -76,22 +61,22 @@ public static CompletionEmailsEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final CompletionEmailsEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final InitEmailsEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public CompletionEmailsEnum read(final JsonReader jsonReader) throws IOException { + public InitEmailsEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return CompletionEmailsEnum.fromValue(String.valueOf(value)); + return InitEmailsEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("completionEmails") - private CompletionEmailsEnum completionEmails = null; + @SerializedName("initEmails") + private InitEmailsEnum initEmails = null; /** * Control notification mails for agreement-in-process events - DELEGATED, REPLACED @@ -144,17 +129,17 @@ public InFlightEmailsEnum read(final JsonReader jsonReader) throws IOException { private InFlightEmailsEnum inFlightEmails = null; /** - * Control notification mails for Agreement initiation events - ACTION_REQUESTED and CREATED + * Control notification mails for agreement completion events - COMPLETED, CANCELLED, EXPIRED and REJECTED */ - @JsonAdapter(InitEmailsEnum.Adapter.class) - public enum InitEmailsEnum { + @JsonAdapter(CompletionEmailsEnum.Adapter.class) + public enum CompletionEmailsEnum { ALL("ALL"), NONE("NONE"); private String value; - InitEmailsEnum(String value) { + CompletionEmailsEnum(String value) { this.value = value; } @@ -167,8 +152,8 @@ public String toString() { return String.valueOf(value); } - public static InitEmailsEnum fromValue(String text) { - for (InitEmailsEnum b : InitEmailsEnum.values()) { + public static CompletionEmailsEnum fromValue(String text) { + for (CompletionEmailsEnum b : CompletionEmailsEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -176,39 +161,39 @@ public static InitEmailsEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final InitEmailsEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final CompletionEmailsEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public InitEmailsEnum read(final JsonReader jsonReader) throws IOException { + public CompletionEmailsEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return InitEmailsEnum.fromValue(String.valueOf(value)); + return CompletionEmailsEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("initEmails") - private InitEmailsEnum initEmails = null; + @SerializedName("completionEmails") + private CompletionEmailsEnum completionEmails = null; - public SendOptions completionEmails(CompletionEmailsEnum completionEmails) { - this.completionEmails = completionEmails; + public SendOptions initEmails(InitEmailsEnum initEmails) { + this.initEmails = initEmails; return this; } /** - * Control notification mails for agreement completion events - COMPLETED, CANCELLED, EXPIRED and REJECTED - * @return completionEmails + * Control notification mails for Agreement initiation events - ACTION_REQUESTED and CREATED + * @return initEmails **/ - @ApiModelProperty(value = "Control notification mails for agreement completion events - COMPLETED, CANCELLED, EXPIRED and REJECTED") - public CompletionEmailsEnum getCompletionEmails() { - return completionEmails; + @ApiModelProperty(value = "Control notification mails for Agreement initiation events - ACTION_REQUESTED and CREATED") + public InitEmailsEnum getInitEmails() { + return initEmails; } - public void setCompletionEmails(CompletionEmailsEnum completionEmails) { - this.completionEmails = completionEmails; + public void setInitEmails(InitEmailsEnum initEmails) { + this.initEmails = initEmails; } public SendOptions inFlightEmails(InFlightEmailsEnum inFlightEmails) { @@ -229,22 +214,22 @@ public void setInFlightEmails(InFlightEmailsEnum inFlightEmails) { this.inFlightEmails = inFlightEmails; } - public SendOptions initEmails(InitEmailsEnum initEmails) { - this.initEmails = initEmails; + public SendOptions completionEmails(CompletionEmailsEnum completionEmails) { + this.completionEmails = completionEmails; return this; } /** - * Control notification mails for Agreement initiation events - ACTION_REQUESTED and CREATED - * @return initEmails + * Control notification mails for agreement completion events - COMPLETED, CANCELLED, EXPIRED and REJECTED + * @return completionEmails **/ - @ApiModelProperty(value = "Control notification mails for Agreement initiation events - ACTION_REQUESTED and CREATED") - public InitEmailsEnum getInitEmails() { - return initEmails; + @ApiModelProperty(value = "Control notification mails for agreement completion events - COMPLETED, CANCELLED, EXPIRED and REJECTED") + public CompletionEmailsEnum getCompletionEmails() { + return completionEmails; } - public void setInitEmails(InitEmailsEnum initEmails) { - this.initEmails = initEmails; + public void setCompletionEmails(CompletionEmailsEnum completionEmails) { + this.completionEmails = completionEmails; } @@ -257,14 +242,14 @@ public boolean equals(java.lang.Object o) { return false; } SendOptions sendOptions = (SendOptions) o; - return Objects.equals(this.completionEmails, sendOptions.completionEmails) && + return Objects.equals(this.initEmails, sendOptions.initEmails) && Objects.equals(this.inFlightEmails, sendOptions.inFlightEmails) && - Objects.equals(this.initEmails, sendOptions.initEmails); + Objects.equals(this.completionEmails, sendOptions.completionEmails); } @Override public int hashCode() { - return Objects.hash(completionEmails, inFlightEmails, initEmails); + return Objects.hash(initEmails, inFlightEmails, completionEmails); } @@ -273,9 +258,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class SendOptions {\n"); - sb.append(" completionEmails: ").append(toIndentedString(completionEmails)).append("\n"); - sb.append(" inFlightEmails: ").append(toIndentedString(inFlightEmails)).append("\n"); sb.append(" initEmails: ").append(toIndentedString(initEmails)).append("\n"); + sb.append(" inFlightEmails: ").append(toIndentedString(inFlightEmails)).append("\n"); + sb.append(" completionEmails: ").append(toIndentedString(completionEmails)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/SenderInfo.java b/src/main/java/io/swagger/client/model/agreements/SenderInfo.java index b495833..ff11bb2 100755 --- a/src/main/java/io/swagger/client/model/agreements/SenderInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/SenderInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -37,27 +22,37 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; +import java.util.Date; /** * SenderInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class SenderInfo { - @SerializedName("company") - private String company = null; + @SerializedName("participantId") + private String participantId = null; - @SerializedName("email") - private String email = null; + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("hidden") + private Boolean hidden = null; @SerializedName("name") private String name = null; - @SerializedName("participantId") - private String participantId = null; - @SerializedName("self") private Boolean self = null; + @SerializedName("company") + private String company = null; + + @SerializedName("userId") + private String userId = null; + + @SerializedName("email") + private String email = null; + /** * The agreement status with respect to the participant set. This cannot be changed as part of the PUT call. */ @@ -128,76 +123,76 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; - public SenderInfo company(String company) { - this.company = company; + public SenderInfo participantId(String participantId) { + this.participantId = participantId; return this; } /** - * Company of the sender, if available. - * @return company + * The unique identifier of the sender of the agreement. + * @return participantId **/ - @ApiModelProperty(value = "Company of the sender, if available.") - public String getCompany() { - return company; + @ApiModelProperty(value = " The unique identifier of the sender of the agreement.") + public String getParticipantId() { + return participantId; } - public void setCompany(String company) { - this.company = company; + public void setParticipantId(String participantId) { + this.participantId = participantId; } - public SenderInfo email(String email) { - this.email = email; + public SenderInfo createdDate(Date createdDate) { + this.createdDate = createdDate; return this; } /** - * Email of the sender of the agreement. - * @return email + * The date when the sender was added. This will be returned as part of GET call but is ignored if passed as part of PUT call. + * @return createdDate **/ - @ApiModelProperty(value = "Email of the sender of the agreement.") - public String getEmail() { - return email; + @ApiModelProperty(value = "The date when the sender was added. This will be returned as part of GET call but is ignored if passed as part of PUT call.") + public Date getCreatedDate() { + return createdDate; } - public void setEmail(String email) { - this.email = email; + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; } - public SenderInfo name(String name) { - this.name = name; + public SenderInfo hidden(Boolean hidden) { + this.hidden = hidden; return this; } /** - * Name of the sender, if available. - * @return name + * True if the agreement is hidden for the user that is calling the API. Only returned if self is true. + * @return hidden **/ - @ApiModelProperty(value = "Name of the sender, if available.") - public String getName() { - return name; + @ApiModelProperty(value = "True if the agreement is hidden for the user that is calling the API. Only returned if self is true.") + public Boolean isHidden() { + return hidden; } - public void setName(String name) { - this.name = name; + public void setHidden(Boolean hidden) { + this.hidden = hidden; } - public SenderInfo participantId(String participantId) { - this.participantId = participantId; + public SenderInfo name(String name) { + this.name = name; return this; } /** - * The unique identifier of the sender of the agreement. - * @return participantId + * Name of the sender, if available. + * @return name **/ - @ApiModelProperty(value = " The unique identifier of the sender of the agreement.") - public String getParticipantId() { - return participantId; + @ApiModelProperty(value = "Name of the sender, if available.") + public String getName() { + return name; } - public void setParticipantId(String participantId) { - this.participantId = participantId; + public void setName(String name) { + this.name = name; } public SenderInfo self(Boolean self) { @@ -218,6 +213,60 @@ public void setSelf(Boolean self) { this.self = self; } + public SenderInfo company(String company) { + this.company = company; + return this; + } + + /** + * Company of the sender, if available. + * @return company + **/ + @ApiModelProperty(value = "Company of the sender, if available.") + public String getCompany() { + return company; + } + + public void setCompany(String company) { + this.company = company; + } + + public SenderInfo userId(String userId) { + this.userId = userId; + return this; + } + + /** + * The user ID of the sender. This will be returned as part of GET call but is ignored if passed as part of PUT call. + * @return userId + **/ + @ApiModelProperty(value = "The user ID of the sender. This will be returned as part of GET call but is ignored if passed as part of PUT call.") + public String getUserId() { + return userId; + } + + public void setUserId(String userId) { + this.userId = userId; + } + + public SenderInfo email(String email) { + this.email = email; + return this; + } + + /** + * Email of the sender of the agreement. + * @return email + **/ + @ApiModelProperty(value = "Email of the sender of the agreement.") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + public SenderInfo status(StatusEnum status) { this.status = status; return this; @@ -246,17 +295,20 @@ public boolean equals(java.lang.Object o) { return false; } SenderInfo senderInfo = (SenderInfo) o; - return Objects.equals(this.company, senderInfo.company) && - Objects.equals(this.email, senderInfo.email) && + return Objects.equals(this.participantId, senderInfo.participantId) && + Objects.equals(this.createdDate, senderInfo.createdDate) && + Objects.equals(this.hidden, senderInfo.hidden) && Objects.equals(this.name, senderInfo.name) && - Objects.equals(this.participantId, senderInfo.participantId) && Objects.equals(this.self, senderInfo.self) && + Objects.equals(this.company, senderInfo.company) && + Objects.equals(this.userId, senderInfo.userId) && + Objects.equals(this.email, senderInfo.email) && Objects.equals(this.status, senderInfo.status); } @Override public int hashCode() { - return Objects.hash(company, email, name, participantId, self, status); + return Objects.hash(participantId, createdDate, hidden, name, self, company, userId, email, status); } @@ -265,11 +317,14 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class SenderInfo {\n"); - sb.append(" company: ").append(toIndentedString(company)).append("\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" self: ").append(toIndentedString(self)).append("\n"); + sb.append(" company: ").append(toIndentedString(company)).append("\n"); + sb.append(" userId: ").append(toIndentedString(userId)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/agreements/ShareCreationInfo.java b/src/main/java/io/swagger/client/model/agreements/ShareCreationInfo.java index ff84201..002de39 100755 --- a/src/main/java/io/swagger/client/model/agreements/ShareCreationInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/ShareCreationInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,31 +26,13 @@ /** * ShareCreationInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class ShareCreationInfo { - @SerializedName("email") - private String email = null; - @SerializedName("message") private String message = null; - public ShareCreationInfo email(String email) { - this.email = email; - return this; - } - - /** - * The email address of the member with whom the agreement will be shared - * @return email - **/ - @ApiModelProperty(value = "The email address of the member with whom the agreement will be shared") - public String getEmail() { - return email; - } - - public void setEmail(String email) { - this.email = email; - } + @SerializedName("email") + private String email = null; public ShareCreationInfo message(String message) { this.message = message; @@ -85,6 +52,24 @@ public void setMessage(String message) { this.message = message; } + public ShareCreationInfo email(String email) { + this.email = email; + return this; + } + + /** + * The email address of the member with whom the agreement will be shared + * @return email + **/ + @ApiModelProperty(value = "The email address of the member with whom the agreement will be shared") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + @Override public boolean equals(java.lang.Object o) { @@ -95,13 +80,13 @@ public boolean equals(java.lang.Object o) { return false; } ShareCreationInfo shareCreationInfo = (ShareCreationInfo) o; - return Objects.equals(this.email, shareCreationInfo.email) && - Objects.equals(this.message, shareCreationInfo.message); + return Objects.equals(this.message, shareCreationInfo.message) && + Objects.equals(this.email, shareCreationInfo.email); } @Override public int hashCode() { - return Objects.hash(email, message); + return Objects.hash(message, email); } @@ -110,8 +95,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ShareCreationInfo {\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/ShareCreationInfoList.java b/src/main/java/io/swagger/client/model/agreements/ShareCreationInfoList.java index 19b4d07..d0969fe 100755 --- a/src/main/java/io/swagger/client/model/agreements/ShareCreationInfoList.java +++ b/src/main/java/io/swagger/client/model/agreements/ShareCreationInfoList.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * ShareCreationInfoList */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class ShareCreationInfoList { @SerializedName("shareCreationInfo") private List shareCreationInfo = null; diff --git a/src/main/java/io/swagger/client/model/agreements/ShareCreationResponse.java b/src/main/java/io/swagger/client/model/agreements/ShareCreationResponse.java index ce69d16..93d6cf3 100755 --- a/src/main/java/io/swagger/client/model/agreements/ShareCreationResponse.java +++ b/src/main/java/io/swagger/client/model/agreements/ShareCreationResponse.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,31 +26,13 @@ /** * ShareCreationResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class ShareCreationResponse { - @SerializedName("email") - private String email = null; - @SerializedName("participantId") private String participantId = null; - public ShareCreationResponse email(String email) { - this.email = email; - return this; - } - - /** - * The email address that was requested - * @return email - **/ - @ApiModelProperty(value = "The email address that was requested") - public String getEmail() { - return email; - } - - public void setEmail(String email) { - this.email = email; - } + @SerializedName("email") + private String email = null; public ShareCreationResponse participantId(String participantId) { this.participantId = participantId; @@ -85,6 +52,24 @@ public void setParticipantId(String participantId) { this.participantId = participantId; } + public ShareCreationResponse email(String email) { + this.email = email; + return this; + } + + /** + * The email address that was requested + * @return email + **/ + @ApiModelProperty(value = "The email address that was requested") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + @Override public boolean equals(java.lang.Object o) { @@ -95,13 +80,13 @@ public boolean equals(java.lang.Object o) { return false; } ShareCreationResponse shareCreationResponse = (ShareCreationResponse) o; - return Objects.equals(this.email, shareCreationResponse.email) && - Objects.equals(this.participantId, shareCreationResponse.participantId); + return Objects.equals(this.participantId, shareCreationResponse.participantId) && + Objects.equals(this.email, shareCreationResponse.email); } @Override public int hashCode() { - return Objects.hash(email, participantId); + return Objects.hash(participantId, email); } @@ -110,8 +95,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ShareCreationResponse {\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/ShareCreationResponseList.java b/src/main/java/io/swagger/client/model/agreements/ShareCreationResponseList.java index 393b079..8808faf 100755 --- a/src/main/java/io/swagger/client/model/agreements/ShareCreationResponseList.java +++ b/src/main/java/io/swagger/client/model/agreements/ShareCreationResponseList.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * ShareCreationResponseList */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class ShareCreationResponseList { @SerializedName("shareCreationResponseList") private List shareCreationResponseList = null; diff --git a/src/main/java/io/swagger/client/model/agreements/ShareParticipantInfo.java b/src/main/java/io/swagger/client/model/agreements/ShareParticipantInfo.java index d8119de..84fa1db 100755 --- a/src/main/java/io/swagger/client/model/agreements/ShareParticipantInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/ShareParticipantInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,57 +26,63 @@ /** * ShareParticipantInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class ShareParticipantInfo { - @SerializedName("company") - private String company = null; + @SerializedName("participantId") + private String participantId = null; - @SerializedName("email") - private String email = null; + @SerializedName("hidden") + private Boolean hidden = null; @SerializedName("name") private String name = null; - @SerializedName("participantId") - private String participantId = null; + @SerializedName("self") + private Boolean self = null; @SerializedName("sharerParticipantId") private String sharerParticipantId = null; - public ShareParticipantInfo company(String company) { - this.company = company; + @SerializedName("company") + private String company = null; + + @SerializedName("email") + private String email = null; + + public ShareParticipantInfo participantId(String participantId) { + this.participantId = participantId; return this; } /** - * Company of the sharee participant, if available. - * @return company + * The unique identifier of the sharee participant of the agreement. + * @return participantId **/ - @ApiModelProperty(value = "Company of the sharee participant, if available.") - public String getCompany() { - return company; + @ApiModelProperty(value = "The unique identifier of the sharee participant of the agreement.") + public String getParticipantId() { + return participantId; } - public void setCompany(String company) { - this.company = company; + public void setParticipantId(String participantId) { + this.participantId = participantId; } - public ShareParticipantInfo email(String email) { - this.email = email; + public ShareParticipantInfo hidden(Boolean hidden) { + this.hidden = hidden; return this; } /** - * Email of the sharee participant of the agreement. - * @return email + * True if the agreement is hidden for the user that is calling the API. Only returned if self is true. + * @return hidden **/ - @ApiModelProperty(value = "Email of the sharee participant of the agreement.") - public String getEmail() { - return email; + @ApiModelProperty(value = "True if the agreement is hidden for the user that is calling the API. Only returned if self is true.") + public Boolean isHidden() { + return hidden; } - public void setEmail(String email) { - this.email = email; + public void setHidden(Boolean hidden) { + this.hidden = hidden; } public ShareParticipantInfo name(String name) { @@ -112,22 +103,22 @@ public void setName(String name) { this.name = name; } - public ShareParticipantInfo participantId(String participantId) { - this.participantId = participantId; + public ShareParticipantInfo self(Boolean self) { + this.self = self; return this; } /** - * The unique identifier of the sharee participant of the agreement. - * @return participantId + * True if the Share participant is the same user that is calling the API. + * @return self **/ - @ApiModelProperty(value = "The unique identifier of the sharee participant of the agreement.") - public String getParticipantId() { - return participantId; + @ApiModelProperty(value = "True if the Share participant is the same user that is calling the API.") + public Boolean isSelf() { + return self; } - public void setParticipantId(String participantId) { - this.participantId = participantId; + public void setSelf(Boolean self) { + this.self = self; } public ShareParticipantInfo sharerParticipantId(String sharerParticipantId) { @@ -148,6 +139,42 @@ public void setSharerParticipantId(String sharerParticipantId) { this.sharerParticipantId = sharerParticipantId; } + public ShareParticipantInfo company(String company) { + this.company = company; + return this; + } + + /** + * Company of the sharee participant, if available. + * @return company + **/ + @ApiModelProperty(value = "Company of the sharee participant, if available.") + public String getCompany() { + return company; + } + + public void setCompany(String company) { + this.company = company; + } + + public ShareParticipantInfo email(String email) { + this.email = email; + return this; + } + + /** + * Email of the sharee participant of the agreement. + * @return email + **/ + @ApiModelProperty(value = "Email of the sharee participant of the agreement.") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + @Override public boolean equals(java.lang.Object o) { @@ -158,16 +185,18 @@ public boolean equals(java.lang.Object o) { return false; } ShareParticipantInfo shareParticipantInfo = (ShareParticipantInfo) o; - return Objects.equals(this.company, shareParticipantInfo.company) && - Objects.equals(this.email, shareParticipantInfo.email) && + return Objects.equals(this.participantId, shareParticipantInfo.participantId) && + Objects.equals(this.hidden, shareParticipantInfo.hidden) && Objects.equals(this.name, shareParticipantInfo.name) && - Objects.equals(this.participantId, shareParticipantInfo.participantId) && - Objects.equals(this.sharerParticipantId, shareParticipantInfo.sharerParticipantId); + Objects.equals(this.self, shareParticipantInfo.self) && + Objects.equals(this.sharerParticipantId, shareParticipantInfo.sharerParticipantId) && + Objects.equals(this.company, shareParticipantInfo.company) && + Objects.equals(this.email, shareParticipantInfo.email); } @Override public int hashCode() { - return Objects.hash(company, email, name, participantId, sharerParticipantId); + return Objects.hash(participantId, hidden, name, self, sharerParticipantId, company, email); } @@ -176,11 +205,13 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ShareParticipantInfo {\n"); - sb.append(" company: ").append(toIndentedString(company)).append("\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); + sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" self: ").append(toIndentedString(self)).append("\n"); sb.append(" sharerParticipantId: ").append(toIndentedString(sharerParticipantId)).append("\n"); + sb.append(" company: ").append(toIndentedString(company)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/SignerIdentityReportInfo.java b/src/main/java/io/swagger/client/model/agreements/SignerIdentityReportInfo.java new file mode 100644 index 0000000..86cd9e5 --- /dev/null +++ b/src/main/java/io/swagger/client/model/agreements/SignerIdentityReportInfo.java @@ -0,0 +1,94 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.agreements; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.agreements.SecurityOption; +import java.io.IOException; + +/** + * SignerIdentityReportInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") +public class SignerIdentityReportInfo { + @SerializedName("securityOption") + private SecurityOption securityOption = null; + + public SignerIdentityReportInfo securityOption(SecurityOption securityOption) { + this.securityOption = securityOption; + return this; + } + + /** + * Optional secondary security parameters for the signer identity report. + * @return securityOption + **/ + @ApiModelProperty(value = "Optional secondary security parameters for the signer identity report.") + public SecurityOption getSecurityOption() { + return securityOption; + } + + public void setSecurityOption(SecurityOption securityOption) { + this.securityOption = securityOption; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SignerIdentityReportInfo signerIdentityReportInfo = (SignerIdentityReportInfo) o; + return Objects.equals(this.securityOption, signerIdentityReportInfo.securityOption); + } + + @Override + public int hashCode() { + return Objects.hash(securityOption); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SignerIdentityReportInfo {\n"); + + sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/agreements/SigningUrl.java b/src/main/java/io/swagger/client/model/agreements/SigningUrl.java index 6b3e66a..5436978 100755 --- a/src/main/java/io/swagger/client/model/agreements/SigningUrl.java +++ b/src/main/java/io/swagger/client/model/agreements/SigningUrl.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,48 +26,48 @@ /** * SigningUrl */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class SigningUrl { - @SerializedName("email") - private String email = null; - @SerializedName("esignUrl") private String esignUrl = null; - public SigningUrl email(String email) { - this.email = email; + @SerializedName("email") + private String email = null; + + public SigningUrl esignUrl(String esignUrl) { + this.esignUrl = esignUrl; return this; } /** * The email address of the signer associated with this signing url - * @return email + * @return esignUrl **/ @ApiModelProperty(value = "The email address of the signer associated with this signing url") - public String getEmail() { - return email; + public String getEsignUrl() { + return esignUrl; } - public void setEmail(String email) { - this.email = email; + public void setEsignUrl(String esignUrl) { + this.esignUrl = esignUrl; } - public SigningUrl esignUrl(String esignUrl) { - this.esignUrl = esignUrl; + public SigningUrl email(String email) { + this.email = email; return this; } /** * The email address of the signer associated with this signing url - * @return esignUrl + * @return email **/ @ApiModelProperty(value = "The email address of the signer associated with this signing url") - public String getEsignUrl() { - return esignUrl; + public String getEmail() { + return email; } - public void setEsignUrl(String esignUrl) { - this.esignUrl = esignUrl; + public void setEmail(String email) { + this.email = email; } @@ -95,13 +80,13 @@ public boolean equals(java.lang.Object o) { return false; } SigningUrl signingUrl = (SigningUrl) o; - return Objects.equals(this.email, signingUrl.email) && - Objects.equals(this.esignUrl, signingUrl.esignUrl); + return Objects.equals(this.esignUrl, signingUrl.esignUrl) && + Objects.equals(this.email, signingUrl.email); } @Override public int hashCode() { - return Objects.hash(email, esignUrl); + return Objects.hash(esignUrl, email); } @@ -110,8 +95,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class SigningUrl {\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append(" esignUrl: ").append(toIndentedString(esignUrl)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/SigningUrlResponse.java b/src/main/java/io/swagger/client/model/agreements/SigningUrlResponse.java index ae3547b..4573967 100755 --- a/src/main/java/io/swagger/client/model/agreements/SigningUrlResponse.java +++ b/src/main/java/io/swagger/client/model/agreements/SigningUrlResponse.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * SigningUrlResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class SigningUrlResponse { @SerializedName("signingUrlSetInfos") private List signingUrlSetInfos = null; diff --git a/src/main/java/io/swagger/client/model/agreements/SigningUrlSetInfo.java b/src/main/java/io/swagger/client/model/agreements/SigningUrlSetInfo.java index 9a7c663..d2aba61 100755 --- a/src/main/java/io/swagger/client/model/agreements/SigningUrlSetInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/SigningUrlSetInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,31 +29,13 @@ /** * SigningUrlSetInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class SigningUrlSetInfo { - @SerializedName("signingUrlSetName") - private String signingUrlSetName = null; - @SerializedName("signingUrls") private List signingUrls = null; - public SigningUrlSetInfo signingUrlSetName(String signingUrlSetName) { - this.signingUrlSetName = signingUrlSetName; - return this; - } - - /** - * The name of the current signer set. Returned only, if the API caller is the sender of agreement - * @return signingUrlSetName - **/ - @ApiModelProperty(value = "The name of the current signer set. Returned only, if the API caller is the sender of agreement") - public String getSigningUrlSetName() { - return signingUrlSetName; - } - - public void setSigningUrlSetName(String signingUrlSetName) { - this.signingUrlSetName = signingUrlSetName; - } + @SerializedName("signingUrlSetName") + private String signingUrlSetName = null; public SigningUrlSetInfo signingUrls(List signingUrls) { this.signingUrls = signingUrls; @@ -96,6 +63,24 @@ public void setSigningUrls(List signingUrls) { this.signingUrls = signingUrls; } + public SigningUrlSetInfo signingUrlSetName(String signingUrlSetName) { + this.signingUrlSetName = signingUrlSetName; + return this; + } + + /** + * The name of the current signer set. Returned only, if the API caller is the sender of agreement + * @return signingUrlSetName + **/ + @ApiModelProperty(value = "The name of the current signer set. Returned only, if the API caller is the sender of agreement") + public String getSigningUrlSetName() { + return signingUrlSetName; + } + + public void setSigningUrlSetName(String signingUrlSetName) { + this.signingUrlSetName = signingUrlSetName; + } + @Override public boolean equals(java.lang.Object o) { @@ -106,13 +91,13 @@ public boolean equals(java.lang.Object o) { return false; } SigningUrlSetInfo signingUrlSetInfo = (SigningUrlSetInfo) o; - return Objects.equals(this.signingUrlSetName, signingUrlSetInfo.signingUrlSetName) && - Objects.equals(this.signingUrls, signingUrlSetInfo.signingUrls); + return Objects.equals(this.signingUrls, signingUrlSetInfo.signingUrls) && + Objects.equals(this.signingUrlSetName, signingUrlSetInfo.signingUrlSetName); } @Override public int hashCode() { - return Objects.hash(signingUrlSetName, signingUrls); + return Objects.hash(signingUrls, signingUrlSetName); } @@ -121,8 +106,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class SigningUrlSetInfo {\n"); - sb.append(" signingUrlSetName: ").append(toIndentedString(signingUrlSetName)).append("\n"); sb.append(" signingUrls: ").append(toIndentedString(signingUrls)).append("\n"); + sb.append(" signingUrlSetName: ").append(toIndentedString(signingUrlSetName)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/SupportingDocument.java b/src/main/java/io/swagger/client/model/agreements/SupportingDocument.java index 01ab1f7..b8b8234 100755 --- a/src/main/java/io/swagger/client/model/agreements/SupportingDocument.java +++ b/src/main/java/io/swagger/client/model/agreements/SupportingDocument.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,11 +26,17 @@ /** * SupportingDocument */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class SupportingDocument { @SerializedName("displayLabel") private String displayLabel = null; + @SerializedName("participantId") + private String participantId = null; + + @SerializedName("numPages") + private Integer numPages = null; + @SerializedName("fieldName") private String fieldName = null; @@ -55,12 +46,6 @@ public class SupportingDocument { @SerializedName("mimeType") private String mimeType = null; - @SerializedName("numPages") - private Integer numPages = null; - - @SerializedName("participantId") - private String participantId = null; - public SupportingDocument displayLabel(String displayLabel) { this.displayLabel = displayLabel; return this; @@ -79,6 +64,42 @@ public void setDisplayLabel(String displayLabel) { this.displayLabel = displayLabel; } + public SupportingDocument participantId(String participantId) { + this.participantId = participantId; + return this; + } + + /** + * The unique identifier of the participant that uploaded the supporting document + * @return participantId + **/ + @ApiModelProperty(value = "The unique identifier of the participant that uploaded the supporting document") + public String getParticipantId() { + return participantId; + } + + public void setParticipantId(String participantId) { + this.participantId = participantId; + } + + public SupportingDocument numPages(Integer numPages) { + this.numPages = numPages; + return this; + } + + /** + * Number of pages in the document + * @return numPages + **/ + @ApiModelProperty(value = "Number of pages in the document") + public Integer getNumPages() { + return numPages; + } + + public void setNumPages(Integer numPages) { + this.numPages = numPages; + } + public SupportingDocument fieldName(String fieldName) { this.fieldName = fieldName; return this; @@ -133,42 +154,6 @@ public void setMimeType(String mimeType) { this.mimeType = mimeType; } - public SupportingDocument numPages(Integer numPages) { - this.numPages = numPages; - return this; - } - - /** - * Number of pages in the document - * @return numPages - **/ - @ApiModelProperty(value = "Number of pages in the document") - public Integer getNumPages() { - return numPages; - } - - public void setNumPages(Integer numPages) { - this.numPages = numPages; - } - - public SupportingDocument participantId(String participantId) { - this.participantId = participantId; - return this; - } - - /** - * The unique identifier of the participant that uploaded the supporting document - * @return participantId - **/ - @ApiModelProperty(value = "The unique identifier of the participant that uploaded the supporting document") - public String getParticipantId() { - return participantId; - } - - public void setParticipantId(String participantId) { - this.participantId = participantId; - } - @Override public boolean equals(java.lang.Object o) { @@ -180,16 +165,16 @@ public boolean equals(java.lang.Object o) { } SupportingDocument supportingDocument = (SupportingDocument) o; return Objects.equals(this.displayLabel, supportingDocument.displayLabel) && + Objects.equals(this.participantId, supportingDocument.participantId) && + Objects.equals(this.numPages, supportingDocument.numPages) && Objects.equals(this.fieldName, supportingDocument.fieldName) && Objects.equals(this.id, supportingDocument.id) && - Objects.equals(this.mimeType, supportingDocument.mimeType) && - Objects.equals(this.numPages, supportingDocument.numPages) && - Objects.equals(this.participantId, supportingDocument.participantId); + Objects.equals(this.mimeType, supportingDocument.mimeType); } @Override public int hashCode() { - return Objects.hash(displayLabel, fieldName, id, mimeType, numPages, participantId); + return Objects.hash(displayLabel, participantId, numPages, fieldName, id, mimeType); } @@ -199,11 +184,11 @@ public String toString() { sb.append("class SupportingDocument {\n"); sb.append(" displayLabel: ").append(toIndentedString(displayLabel)).append("\n"); + sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); + sb.append(" numPages: ").append(toIndentedString(numPages)).append("\n"); sb.append(" fieldName: ").append(toIndentedString(fieldName)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" mimeType: ").append(toIndentedString(mimeType)).append("\n"); - sb.append(" numPages: ").append(toIndentedString(numPages)).append("\n"); - sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/URLFileInfo.java b/src/main/java/io/swagger/client/model/agreements/URLFileInfo.java index 0f5dc39..b435149 100755 --- a/src/main/java/io/swagger/client/model/agreements/URLFileInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/URLFileInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,35 +26,17 @@ /** * URLFileInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class URLFileInfo { - @SerializedName("mimeType") - private String mimeType = null; - @SerializedName("name") private String name = null; + @SerializedName("mimeType") + private String mimeType = null; + @SerializedName("url") private String url = null; - public URLFileInfo mimeType(String mimeType) { - this.mimeType = mimeType; - return this; - } - - /** - * The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed - * @return mimeType - **/ - @ApiModelProperty(value = "The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed") - public String getMimeType() { - return mimeType; - } - - public void setMimeType(String mimeType) { - this.mimeType = mimeType; - } - public URLFileInfo name(String name) { this.name = name; return this; @@ -88,6 +55,24 @@ public void setName(String name) { this.name = name; } + public URLFileInfo mimeType(String mimeType) { + this.mimeType = mimeType; + return this; + } + + /** + * The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed + * @return mimeType + **/ + @ApiModelProperty(value = "The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed") + public String getMimeType() { + return mimeType; + } + + public void setMimeType(String mimeType) { + this.mimeType = mimeType; + } + public URLFileInfo url(String url) { this.url = url; return this; @@ -116,14 +101,14 @@ public boolean equals(java.lang.Object o) { return false; } URLFileInfo urLFileInfo = (URLFileInfo) o; - return Objects.equals(this.mimeType, urLFileInfo.mimeType) && - Objects.equals(this.name, urLFileInfo.name) && + return Objects.equals(this.name, urLFileInfo.name) && + Objects.equals(this.mimeType, urLFileInfo.mimeType) && Objects.equals(this.url, urLFileInfo.url); } @Override public int hashCode() { - return Objects.hash(mimeType, name, url); + return Objects.hash(name, mimeType, url); } @@ -132,8 +117,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class URLFileInfo {\n"); - sb.append(" mimeType: ").append(toIndentedString(mimeType)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" mimeType: ").append(toIndentedString(mimeType)).append("\n"); sb.append(" url: ").append(toIndentedString(url)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/agreements/UserAgreement.java b/src/main/java/io/swagger/client/model/agreements/UserAgreement.java index fb39013..be64aa4 100755 --- a/src/main/java/io/swagger/client/model/agreements/UserAgreement.java +++ b/src/main/java/io/swagger/client/model/agreements/UserAgreement.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,28 +30,86 @@ /** * UserAgreement */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class UserAgreement { + @SerializedName("hidden") + private Boolean hidden = null; + @SerializedName("displayDate") private Date displayDate = null; + @SerializedName("groupId") + private String groupId = null; + + @SerializedName("esign") + private Boolean esign = null; + + @SerializedName("name") + private String name = null; + @SerializedName("displayParticipantSetInfos") private List displayParticipantSetInfos = null; + @SerializedName("latestVersionId") + private String latestVersionId = null; + @SerializedName("id") private String id = null; - @SerializedName("esign") - private Boolean esign = null; + /** + * The kind of agreement + */ + @JsonAdapter(TypeEnum.Adapter.class) + public enum TypeEnum { + AGREEMENT("AGREEMENT"), + + MEGASIGN_CHILD("MEGASIGN_CHILD"), + + WIDGET_INSTANCE("WIDGET_INSTANCE"); - @SerializedName("hidden") - private Boolean hidden = null; + private String value; - @SerializedName("latestVersionId") - private String latestVersionId = null; + TypeEnum(String value) { + this.value = value; + } - @SerializedName("name") - private String name = null; + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static TypeEnum fromValue(String text) { + for (TypeEnum b : TypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public TypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return TypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("type") + private TypeEnum type = null; + + @SerializedName("parentId") + private String parentId = null; /** * This is a server generated attribute which provides the detailed status of an agreement with respect to the apiCaller @@ -164,6 +207,24 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; + public UserAgreement hidden(Boolean hidden) { + this.hidden = hidden; + return this; + } + + /** + * True if agreement is hidden for the user + * @return hidden + **/ + @ApiModelProperty(value = "True if agreement is hidden for the user") + public Boolean isHidden() { + return hidden; + } + + public void setHidden(Boolean hidden) { + this.hidden = hidden; + } + public UserAgreement displayDate(Date displayDate) { this.displayDate = displayDate; return this; @@ -182,48 +243,22 @@ public void setDisplayDate(Date displayDate) { this.displayDate = displayDate; } - public UserAgreement displayParticipantSetInfos(List displayParticipantSetInfos) { - this.displayParticipantSetInfos = displayParticipantSetInfos; - return this; - } - - public UserAgreement addDisplayParticipantSetInfosItem(DisplayParticipantSetInfo displayParticipantSetInfosItem) { - if (this.displayParticipantSetInfos == null) { - this.displayParticipantSetInfos = new ArrayList(); - } - this.displayParticipantSetInfos.add(displayParticipantSetInfosItem); + public UserAgreement groupId(String groupId) { + this.groupId = groupId; return this; } /** - * The most relevant current user set for the agreement. It is typically the next signer if the agreement is from the current user, or the sender if received from another user - * @return displayParticipantSetInfos + * Unique identifier of the group + * @return groupId **/ - @ApiModelProperty(value = "The most relevant current user set for the agreement. It is typically the next signer if the agreement is from the current user, or the sender if received from another user") - public List getDisplayParticipantSetInfos() { - return displayParticipantSetInfos; + @ApiModelProperty(value = "Unique identifier of the group") + public String getGroupId() { + return groupId; } - public void setDisplayParticipantSetInfos(List displayParticipantSetInfos) { - this.displayParticipantSetInfos = displayParticipantSetInfos; - } - - public UserAgreement id(String id) { - this.id = id; - return this; - } - - /** - * The unique identifier of the agreement.If provided in POST, it will simply be ignored - * @return id - **/ - @ApiModelProperty(value = "The unique identifier of the agreement.If provided in POST, it will simply be ignored") - public String getId() { - return id; - } - - public void setId(String id) { - this.id = id; + public void setGroupId(String groupId) { + this.groupId = groupId; } public UserAgreement esign(Boolean esign) { @@ -244,22 +279,48 @@ public void setEsign(Boolean esign) { this.esign = esign; } - public UserAgreement hidden(Boolean hidden) { - this.hidden = hidden; + public UserAgreement name(String name) { + this.name = name; return this; } /** - * True if agreement is hidden for the user - * @return hidden + * Name of the Agreement + * @return name **/ - @ApiModelProperty(value = "True if agreement is hidden for the user") - public Boolean isHidden() { - return hidden; + @ApiModelProperty(value = "Name of the Agreement") + public String getName() { + return name; } - public void setHidden(Boolean hidden) { - this.hidden = hidden; + public void setName(String name) { + this.name = name; + } + + public UserAgreement displayParticipantSetInfos(List displayParticipantSetInfos) { + this.displayParticipantSetInfos = displayParticipantSetInfos; + return this; + } + + public UserAgreement addDisplayParticipantSetInfosItem(DisplayParticipantSetInfo displayParticipantSetInfosItem) { + if (this.displayParticipantSetInfos == null) { + this.displayParticipantSetInfos = new ArrayList(); + } + this.displayParticipantSetInfos.add(displayParticipantSetInfosItem); + return this; + } + + /** + * The most relevant current user set for the agreement. It is typically the next signer if the agreement is from the current user, or the sender if received from another user + * @return displayParticipantSetInfos + **/ + @ApiModelProperty(value = "The most relevant current user set for the agreement. It is typically the next signer if the agreement is from the current user, or the sender if received from another user") + public List getDisplayParticipantSetInfos() { + return displayParticipantSetInfos; + } + + public void setDisplayParticipantSetInfos(List displayParticipantSetInfos) { + this.displayParticipantSetInfos = displayParticipantSetInfos; } public UserAgreement latestVersionId(String latestVersionId) { @@ -280,22 +341,58 @@ public void setLatestVersionId(String latestVersionId) { this.latestVersionId = latestVersionId; } - public UserAgreement name(String name) { - this.name = name; + public UserAgreement id(String id) { + this.id = id; return this; } /** - * Name of the Agreement - * @return name + * The unique identifier of the agreement.If provided in POST, it will simply be ignored + * @return id **/ - @ApiModelProperty(value = "Name of the Agreement") - public String getName() { - return name; + @ApiModelProperty(value = "The unique identifier of the agreement.If provided in POST, it will simply be ignored") + public String getId() { + return id; } - public void setName(String name) { - this.name = name; + public void setId(String id) { + this.id = id; + } + + public UserAgreement type(TypeEnum type) { + this.type = type; + return this; + } + + /** + * The kind of agreement + * @return type + **/ + @ApiModelProperty(value = "The kind of agreement") + public TypeEnum getType() { + return type; + } + + public void setType(TypeEnum type) { + this.type = type; + } + + public UserAgreement parentId(String parentId) { + this.parentId = parentId; + return this; + } + + /** + * The parent id of a megaSign child *OR* the originating id of a widget agreement instance + * @return parentId + **/ + @ApiModelProperty(value = "The parent id of a megaSign child *OR* the originating id of a widget agreement instance") + public String getParentId() { + return parentId; + } + + public void setParentId(String parentId) { + this.parentId = parentId; } public UserAgreement status(StatusEnum status) { @@ -326,19 +423,22 @@ public boolean equals(java.lang.Object o) { return false; } UserAgreement userAgreement = (UserAgreement) o; - return Objects.equals(this.displayDate, userAgreement.displayDate) && - Objects.equals(this.displayParticipantSetInfos, userAgreement.displayParticipantSetInfos) && - Objects.equals(this.id, userAgreement.id) && + return Objects.equals(this.hidden, userAgreement.hidden) && + Objects.equals(this.displayDate, userAgreement.displayDate) && + Objects.equals(this.groupId, userAgreement.groupId) && Objects.equals(this.esign, userAgreement.esign) && - Objects.equals(this.hidden, userAgreement.hidden) && - Objects.equals(this.latestVersionId, userAgreement.latestVersionId) && Objects.equals(this.name, userAgreement.name) && + Objects.equals(this.displayParticipantSetInfos, userAgreement.displayParticipantSetInfos) && + Objects.equals(this.latestVersionId, userAgreement.latestVersionId) && + Objects.equals(this.id, userAgreement.id) && + Objects.equals(this.type, userAgreement.type) && + Objects.equals(this.parentId, userAgreement.parentId) && Objects.equals(this.status, userAgreement.status); } @Override public int hashCode() { - return Objects.hash(displayDate, displayParticipantSetInfos, id, esign, hidden, latestVersionId, name, status); + return Objects.hash(hidden, displayDate, groupId, esign, name, displayParticipantSetInfos, latestVersionId, id, type, parentId, status); } @@ -347,13 +447,16 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class UserAgreement {\n"); + sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); sb.append(" displayDate: ").append(toIndentedString(displayDate)).append("\n"); - sb.append(" displayParticipantSetInfos: ").append(toIndentedString(displayParticipantSetInfos)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); sb.append(" esign: ").append(toIndentedString(esign)).append("\n"); - sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); - sb.append(" latestVersionId: ").append(toIndentedString(latestVersionId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" displayParticipantSetInfos: ").append(toIndentedString(displayParticipantSetInfos)).append("\n"); + sb.append(" latestVersionId: ").append(toIndentedString(latestVersionId)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" parentId: ").append(toIndentedString(parentId)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/agreements/UserAgreements.java b/src/main/java/io/swagger/client/model/agreements/UserAgreements.java index 56d40f3..db30c29 100755 --- a/src/main/java/io/swagger/client/model/agreements/UserAgreements.java +++ b/src/main/java/io/swagger/client/model/agreements/UserAgreements.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,31 +30,13 @@ /** * UserAgreements */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class UserAgreements { - @SerializedName("page") - private PageInfo page = null; - @SerializedName("userAgreementList") private List userAgreementList = null; - public UserAgreements page(PageInfo page) { - this.page = page; - return this; - } - - /** - * Pagination information for navigating through the response - * @return page - **/ - @ApiModelProperty(value = "Pagination information for navigating through the response") - public PageInfo getPage() { - return page; - } - - public void setPage(PageInfo page) { - this.page = page; - } + @SerializedName("page") + private PageInfo page = null; public UserAgreements userAgreementList(List userAgreementList) { this.userAgreementList = userAgreementList; @@ -97,6 +64,24 @@ public void setUserAgreementList(List userAgreementList) { this.userAgreementList = userAgreementList; } + public UserAgreements page(PageInfo page) { + this.page = page; + return this; + } + + /** + * Pagination information for navigating through the response + * @return page + **/ + @ApiModelProperty(value = "Pagination information for navigating through the response") + public PageInfo getPage() { + return page; + } + + public void setPage(PageInfo page) { + this.page = page; + } + @Override public boolean equals(java.lang.Object o) { @@ -107,13 +92,13 @@ public boolean equals(java.lang.Object o) { return false; } UserAgreements userAgreements = (UserAgreements) o; - return Objects.equals(this.page, userAgreements.page) && - Objects.equals(this.userAgreementList, userAgreements.userAgreementList); + return Objects.equals(this.userAgreementList, userAgreements.userAgreementList) && + Objects.equals(this.page, userAgreements.page); } @Override public int hashCode() { - return Objects.hash(page, userAgreementList); + return Objects.hash(userAgreementList, page); } @@ -122,8 +107,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class UserAgreements {\n"); - sb.append(" page: ").append(toIndentedString(page)).append("\n"); sb.append(" userAgreementList: ").append(toIndentedString(userAgreementList)).append("\n"); + sb.append(" page: ").append(toIndentedString(page)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/agreements/VaultEventInfo.java b/src/main/java/io/swagger/client/model/agreements/VaultEventInfo.java new file mode 100644 index 0000000..c403a66 --- /dev/null +++ b/src/main/java/io/swagger/client/model/agreements/VaultEventInfo.java @@ -0,0 +1,116 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.agreements; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * VaultEventInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") +public class VaultEventInfo { + @SerializedName("vaultEventComment") + private String vaultEventComment = null; + + @SerializedName("vaultEventId") + private String vaultEventId = null; + + public VaultEventInfo vaultEventComment(String vaultEventComment) { + this.vaultEventComment = vaultEventComment; + return this; + } + + /** + * The description provided by the vault provider for the vault event + * @return vaultEventComment + **/ + @ApiModelProperty(value = "The description provided by the vault provider for the vault event") + public String getVaultEventComment() { + return vaultEventComment; + } + + public void setVaultEventComment(String vaultEventComment) { + this.vaultEventComment = vaultEventComment; + } + + public VaultEventInfo vaultEventId(String vaultEventId) { + this.vaultEventId = vaultEventId; + return this; + } + + /** + * The identifier assigned by the vault provider for the vault event + * @return vaultEventId + **/ + @ApiModelProperty(value = "The identifier assigned by the vault provider for the vault event") + public String getVaultEventId() { + return vaultEventId; + } + + public void setVaultEventId(String vaultEventId) { + this.vaultEventId = vaultEventId; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + VaultEventInfo vaultEventInfo = (VaultEventInfo) o; + return Objects.equals(this.vaultEventComment, vaultEventInfo.vaultEventComment) && + Objects.equals(this.vaultEventId, vaultEventInfo.vaultEventId); + } + + @Override + public int hashCode() { + return Objects.hash(vaultEventComment, vaultEventId); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class VaultEventInfo {\n"); + + sb.append(" vaultEventComment: ").append(toIndentedString(vaultEventComment)).append("\n"); + sb.append(" vaultEventId: ").append(toIndentedString(vaultEventId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/agreements/VaultingInfo.java b/src/main/java/io/swagger/client/model/agreements/VaultingInfo.java index 311e34f..28a79e4 100755 --- a/src/main/java/io/swagger/client/model/agreements/VaultingInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/VaultingInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * VaultingInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class VaultingInfo { @SerializedName("enabled") private Boolean enabled = null; diff --git a/src/main/java/io/swagger/client/model/agreements/VisibilityInfo.java b/src/main/java/io/swagger/client/model/agreements/VisibilityInfo.java index 3a43059..31c3e4d 100755 --- a/src/main/java/io/swagger/client/model/agreements/VisibilityInfo.java +++ b/src/main/java/io/swagger/client/model/agreements/VisibilityInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * VisibilityInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:52.659+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:34.872+11:00") public class VisibilityInfo { /** * Specifies the visibility. The possible values are HIDE or SHOW diff --git a/src/main/java/io/swagger/client/model/auth/ApiKeyAuth.java b/src/main/java/io/swagger/client/model/auth/ApiKeyAuth.java index 62f86fc..c208deb 100755 --- a/src/main/java/io/swagger/client/model/auth/ApiKeyAuth.java +++ b/src/main/java/io/swagger/client/model/auth/ApiKeyAuth.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -33,7 +18,7 @@ import java.util.Map; import java.util.List; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:09.914+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") public class ApiKeyAuth implements Authentication { private final String location; private final String paramName; diff --git a/src/main/java/io/swagger/client/model/auth/Authentication.java b/src/main/java/io/swagger/client/model/auth/Authentication.java index 4195b67..7d2a0e6 100755 --- a/src/main/java/io/swagger/client/model/auth/Authentication.java +++ b/src/main/java/io/swagger/client/model/auth/Authentication.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) diff --git a/src/main/java/io/swagger/client/model/auth/HttpBasicAuth.java b/src/main/java/io/swagger/client/model/auth/HttpBasicAuth.java index c1b6bf0..e9ffe27 100755 --- a/src/main/java/io/swagger/client/model/auth/HttpBasicAuth.java +++ b/src/main/java/io/swagger/client/model/auth/HttpBasicAuth.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) diff --git a/src/main/java/io/swagger/client/model/auth/OAuth.java b/src/main/java/io/swagger/client/model/auth/OAuth.java index a69729f..291beeb 100755 --- a/src/main/java/io/swagger/client/model/auth/OAuth.java +++ b/src/main/java/io/swagger/client/model/auth/OAuth.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -33,7 +18,7 @@ import java.util.Map; import java.util.List; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:09.914+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") public class OAuth implements Authentication { private String accessToken; diff --git a/src/main/java/io/swagger/client/model/auth/OAuthFlow.java b/src/main/java/io/swagger/client/model/auth/OAuthFlow.java index fdea216..8efcac2 100755 --- a/src/main/java/io/swagger/client/model/auth/OAuthFlow.java +++ b/src/main/java/io/swagger/client/model/auth/OAuthFlow.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) diff --git a/src/main/java/io/swagger/client/model/baseUris/BaseUriInfo.java b/src/main/java/io/swagger/client/model/baseUris/BaseUriInfo.java index 89c57c5..94957f1 100755 --- a/src/main/java/io/swagger/client/model/baseUris/BaseUriInfo.java +++ b/src/main/java/io/swagger/client/model/baseUris/BaseUriInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * BaseUriInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:48:58.840+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:38.733+11:00") public class BaseUriInfo { @SerializedName("apiAccessPoint") private String apiAccessPoint = null; diff --git a/src/main/java/io/swagger/client/model/groups/DetailedGroupInfo.java b/src/main/java/io/swagger/client/model/groups/DetailedGroupInfo.java index 43099f6..63044ab 100755 --- a/src/main/java/io/swagger/client/model/groups/DetailedGroupInfo.java +++ b/src/main/java/io/swagger/client/model/groups/DetailedGroupInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,51 +27,54 @@ /** * DetailedGroupInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:04.402+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:40.217+11:00") public class DetailedGroupInfo { + @SerializedName("isDefaultGroup") + private Boolean isDefaultGroup = null; + @SerializedName("created") private Date created = null; - @SerializedName("id") - private String id = null; - @SerializedName("name") private String name = null; - public DetailedGroupInfo created(Date created) { - this.created = created; + @SerializedName("id") + private String id = null; + + public DetailedGroupInfo isDefaultGroup(Boolean isDefaultGroup) { + this.isDefaultGroup = isDefaultGroup; return this; } /** - * Date of creation of the group. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time - * @return created + * Is the default group for the account + * @return isDefaultGroup **/ - @ApiModelProperty(value = "Date of creation of the group. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") - public Date getCreated() { - return created; + @ApiModelProperty(value = "Is the default group for the account") + public Boolean isIsDefaultGroup() { + return isDefaultGroup; } - public void setCreated(Date created) { - this.created = created; + public void setIsDefaultGroup(Boolean isDefaultGroup) { + this.isDefaultGroup = isDefaultGroup; } - public DetailedGroupInfo id(String id) { - this.id = id; + public DetailedGroupInfo created(Date created) { + this.created = created; return this; } /** - * The unique identifier of the Group. This will be returned as part of GET call but is not mandatory to be passed as part of PUT/POST call for groups/{groupId} - * @return id + * Date of creation of the group. This will be ignored as part of POST or PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return created **/ - @ApiModelProperty(value = "The unique identifier of the Group. This will be returned as part of GET call but is not mandatory to be passed as part of PUT/POST call for groups/{groupId}") - public String getId() { - return id; + @ApiModelProperty(value = "Date of creation of the group. This will be ignored as part of POST or PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getCreated() { + return created; } - public void setId(String id) { - this.id = id; + public void setCreated(Date created) { + this.created = created; } public DetailedGroupInfo name(String name) { @@ -107,6 +95,24 @@ public void setName(String name) { this.name = name; } + public DetailedGroupInfo id(String id) { + this.id = id; + return this; + } + + /** + * The unique identifier of the Group. This will be returned as part of GET call but is not mandatory to be passed as part of PUT/POST call for groups/{groupId} + * @return id + **/ + @ApiModelProperty(value = "The unique identifier of the Group. This will be returned as part of GET call but is not mandatory to be passed as part of PUT/POST call for groups/{groupId}") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + @Override public boolean equals(java.lang.Object o) { @@ -117,14 +123,15 @@ public boolean equals(java.lang.Object o) { return false; } DetailedGroupInfo detailedGroupInfo = (DetailedGroupInfo) o; - return Objects.equals(this.created, detailedGroupInfo.created) && - Objects.equals(this.id, detailedGroupInfo.id) && - Objects.equals(this.name, detailedGroupInfo.name); + return Objects.equals(this.isDefaultGroup, detailedGroupInfo.isDefaultGroup) && + Objects.equals(this.created, detailedGroupInfo.created) && + Objects.equals(this.name, detailedGroupInfo.name) && + Objects.equals(this.id, detailedGroupInfo.id); } @Override public int hashCode() { - return Objects.hash(created, id, name); + return Objects.hash(isDefaultGroup, created, name, id); } @@ -133,9 +140,10 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DetailedGroupInfo {\n"); + sb.append(" isDefaultGroup: ").append(toIndentedString(isDefaultGroup)).append("\n"); sb.append(" created: ").append(toIndentedString(created)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/groups/GroupCreationResponse.java b/src/main/java/io/swagger/client/model/groups/GroupCreationResponse.java new file mode 100644 index 0000000..ec943ba --- /dev/null +++ b/src/main/java/io/swagger/client/model/groups/GroupCreationResponse.java @@ -0,0 +1,94 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.groups; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * A JSON that contains id of the newly created group. + */ +@ApiModel(description = "A JSON that contains id of the newly created group.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:40.217+11:00") +public class GroupCreationResponse { + @SerializedName("id") + private String id = null; + + public GroupCreationResponse id(String id) { + this.id = id; + return this; + } + + /** + * Unique identifier of the group created. + * @return id + **/ + @ApiModelProperty(value = "Unique identifier of the group created.") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + GroupCreationResponse groupCreationResponse = (GroupCreationResponse) o; + return Objects.equals(this.id, groupCreationResponse.id); + } + + @Override + public int hashCode() { + return Objects.hash(id); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class GroupCreationResponse {\n"); + + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/groups/GroupInfo.java b/src/main/java/io/swagger/client/model/groups/GroupInfo.java index 168e6e2..ab56e5b 100755 --- a/src/main/java/io/swagger/client/model/groups/GroupInfo.java +++ b/src/main/java/io/swagger/client/model/groups/GroupInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -37,34 +22,41 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; +import java.util.Date; /** * GroupInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:04.402+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:40.217+11:00") public class GroupInfo { - @SerializedName("groupId") - private String groupId = null; + @SerializedName("isDefaultGroup") + private Boolean isDefaultGroup = null; @SerializedName("groupName") private String groupName = null; - public GroupInfo groupId(String groupId) { - this.groupId = groupId; + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("groupId") + private String groupId = null; + + public GroupInfo isDefaultGroup(Boolean isDefaultGroup) { + this.isDefaultGroup = isDefaultGroup; return this; } /** - * Unique identifier of the group - * @return groupId + * Is the default group for the account + * @return isDefaultGroup **/ - @ApiModelProperty(value = "Unique identifier of the group") - public String getGroupId() { - return groupId; + @ApiModelProperty(value = "Is the default group for the account") + public Boolean isIsDefaultGroup() { + return isDefaultGroup; } - public void setGroupId(String groupId) { - this.groupId = groupId; + public void setIsDefaultGroup(Boolean isDefaultGroup) { + this.isDefaultGroup = isDefaultGroup; } public GroupInfo groupName(String groupName) { @@ -85,6 +77,42 @@ public void setGroupName(String groupName) { this.groupName = groupName; } + public GroupInfo createdDate(Date createdDate) { + this.createdDate = createdDate; + return this; + } + + /** + * Date group was created + * @return createdDate + **/ + @ApiModelProperty(value = "Date group was created") + public Date getCreatedDate() { + return createdDate; + } + + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } + + public GroupInfo groupId(String groupId) { + this.groupId = groupId; + return this; + } + + /** + * Unique identifier of the group + * @return groupId + **/ + @ApiModelProperty(value = "Unique identifier of the group") + public String getGroupId() { + return groupId; + } + + public void setGroupId(String groupId) { + this.groupId = groupId; + } + @Override public boolean equals(java.lang.Object o) { @@ -95,13 +123,15 @@ public boolean equals(java.lang.Object o) { return false; } GroupInfo groupInfo = (GroupInfo) o; - return Objects.equals(this.groupId, groupInfo.groupId) && - Objects.equals(this.groupName, groupInfo.groupName); + return Objects.equals(this.isDefaultGroup, groupInfo.isDefaultGroup) && + Objects.equals(this.groupName, groupInfo.groupName) && + Objects.equals(this.createdDate, groupInfo.createdDate) && + Objects.equals(this.groupId, groupInfo.groupId); } @Override public int hashCode() { - return Objects.hash(groupId, groupName); + return Objects.hash(isDefaultGroup, groupName, createdDate, groupId); } @@ -110,8 +140,10 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class GroupInfo {\n"); - sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); + sb.append(" isDefaultGroup: ").append(toIndentedString(isDefaultGroup)).append("\n"); sb.append(" groupName: ").append(toIndentedString(groupName)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/groups/GroupUserInfo.java b/src/main/java/io/swagger/client/model/groups/GroupUserInfo.java index 1718f9a..9c94acf 100755 --- a/src/main/java/io/swagger/client/model/groups/GroupUserInfo.java +++ b/src/main/java/io/swagger/client/model/groups/GroupUserInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,61 +26,25 @@ /** * GroupUserInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:04.402+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:40.217+11:00") public class GroupUserInfo { - @SerializedName("company") - private String company = null; - - @SerializedName("email") - private String email = null; - @SerializedName("firstName") private String firstName = null; - @SerializedName("id") - private String id = null; - - @SerializedName("isGroupAdmin") - private Boolean isGroupAdmin = null; - @SerializedName("lastName") private String lastName = null; - public GroupUserInfo company(String company) { - this.company = company; - return this; - } - - /** - * The name of company of the user - * @return company - **/ - @ApiModelProperty(value = "The name of company of the user") - public String getCompany() { - return company; - } - - public void setCompany(String company) { - this.company = company; - } + @SerializedName("isGroupAdmin") + private Boolean isGroupAdmin = null; - public GroupUserInfo email(String email) { - this.email = email; - return this; - } + @SerializedName("company") + private String company = null; - /** - * The email address of the user - * @return email - **/ - @ApiModelProperty(value = "The email address of the user") - public String getEmail() { - return email; - } + @SerializedName("id") + private String id = null; - public void setEmail(String email) { - this.email = email; - } + @SerializedName("email") + private String email = null; public GroupUserInfo firstName(String firstName) { this.firstName = firstName; @@ -115,22 +64,22 @@ public void setFirstName(String firstName) { this.firstName = firstName; } - public GroupUserInfo id(String id) { - this.id = id; + public GroupUserInfo lastName(String lastName) { + this.lastName = lastName; return this; } /** - * A unique identifier of the user resource for REST APIs. This identifier can not be used in SOAP APIs - * @return id + * The last name of the user + * @return lastName **/ - @ApiModelProperty(value = "A unique identifier of the user resource for REST APIs. This identifier can not be used in SOAP APIs") - public String getId() { - return id; + @ApiModelProperty(value = "The last name of the user") + public String getLastName() { + return lastName; } - public void setId(String id) { - this.id = id; + public void setLastName(String lastName) { + this.lastName = lastName; } public GroupUserInfo isGroupAdmin(Boolean isGroupAdmin) { @@ -151,22 +100,58 @@ public void setIsGroupAdmin(Boolean isGroupAdmin) { this.isGroupAdmin = isGroupAdmin; } - public GroupUserInfo lastName(String lastName) { - this.lastName = lastName; + public GroupUserInfo company(String company) { + this.company = company; return this; } /** - * The last name of the user - * @return lastName + * The name of company of the user + * @return company **/ - @ApiModelProperty(value = "The last name of the user") - public String getLastName() { - return lastName; + @ApiModelProperty(value = "The name of company of the user") + public String getCompany() { + return company; } - public void setLastName(String lastName) { - this.lastName = lastName; + public void setCompany(String company) { + this.company = company; + } + + public GroupUserInfo id(String id) { + this.id = id; + return this; + } + + /** + * A unique identifier of the user resource for REST APIs. This identifier can not be used in SOAP APIs + * @return id + **/ + @ApiModelProperty(value = "A unique identifier of the user resource for REST APIs. This identifier can not be used in SOAP APIs") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public GroupUserInfo email(String email) { + this.email = email; + return this; + } + + /** + * The email address of the user + * @return email + **/ + @ApiModelProperty(value = "The email address of the user") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; } @@ -179,17 +164,17 @@ public boolean equals(java.lang.Object o) { return false; } GroupUserInfo groupUserInfo = (GroupUserInfo) o; - return Objects.equals(this.company, groupUserInfo.company) && - Objects.equals(this.email, groupUserInfo.email) && - Objects.equals(this.firstName, groupUserInfo.firstName) && - Objects.equals(this.id, groupUserInfo.id) && + return Objects.equals(this.firstName, groupUserInfo.firstName) && + Objects.equals(this.lastName, groupUserInfo.lastName) && Objects.equals(this.isGroupAdmin, groupUserInfo.isGroupAdmin) && - Objects.equals(this.lastName, groupUserInfo.lastName); + Objects.equals(this.company, groupUserInfo.company) && + Objects.equals(this.id, groupUserInfo.id) && + Objects.equals(this.email, groupUserInfo.email); } @Override public int hashCode() { - return Objects.hash(company, email, firstName, id, isGroupAdmin, lastName); + return Objects.hash(firstName, lastName, isGroupAdmin, company, id, email); } @@ -198,12 +183,12 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class GroupUserInfo {\n"); - sb.append(" company: ").append(toIndentedString(company)).append("\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append(" firstName: ").append(toIndentedString(firstName)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" isGroupAdmin: ").append(toIndentedString(isGroupAdmin)).append("\n"); sb.append(" lastName: ").append(toIndentedString(lastName)).append("\n"); + sb.append(" isGroupAdmin: ").append(toIndentedString(isGroupAdmin)).append("\n"); + sb.append(" company: ").append(toIndentedString(company)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/groups/GroupUsersInfo.java b/src/main/java/io/swagger/client/model/groups/GroupUsersInfo.java index 9db0b02..5ad1e4d 100755 --- a/src/main/java/io/swagger/client/model/groups/GroupUsersInfo.java +++ b/src/main/java/io/swagger/client/model/groups/GroupUsersInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,31 +30,13 @@ /** * GroupUsersInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:04.402+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:40.217+11:00") public class GroupUsersInfo { - @SerializedName("page") - private PageInfo page = null; - @SerializedName("userInfoList") private List userInfoList = null; - public GroupUsersInfo page(PageInfo page) { - this.page = page; - return this; - } - - /** - * Pagination information for navigating through the response - * @return page - **/ - @ApiModelProperty(value = "Pagination information for navigating through the response") - public PageInfo getPage() { - return page; - } - - public void setPage(PageInfo page) { - this.page = page; - } + @SerializedName("page") + private PageInfo page = null; public GroupUsersInfo userInfoList(List userInfoList) { this.userInfoList = userInfoList; @@ -97,6 +64,24 @@ public void setUserInfoList(List userInfoList) { this.userInfoList = userInfoList; } + public GroupUsersInfo page(PageInfo page) { + this.page = page; + return this; + } + + /** + * Pagination information for navigating through the response + * @return page + **/ + @ApiModelProperty(value = "Pagination information for navigating through the response") + public PageInfo getPage() { + return page; + } + + public void setPage(PageInfo page) { + this.page = page; + } + @Override public boolean equals(java.lang.Object o) { @@ -107,13 +92,13 @@ public boolean equals(java.lang.Object o) { return false; } GroupUsersInfo groupUsersInfo = (GroupUsersInfo) o; - return Objects.equals(this.page, groupUsersInfo.page) && - Objects.equals(this.userInfoList, groupUsersInfo.userInfoList); + return Objects.equals(this.userInfoList, groupUsersInfo.userInfoList) && + Objects.equals(this.page, groupUsersInfo.page); } @Override public int hashCode() { - return Objects.hash(page, userInfoList); + return Objects.hash(userInfoList, page); } @@ -122,8 +107,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class GroupUsersInfo {\n"); - sb.append(" page: ").append(toIndentedString(page)).append("\n"); sb.append(" userInfoList: ").append(toIndentedString(userInfoList)).append("\n"); + sb.append(" page: ").append(toIndentedString(page)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/groups/GroupsInfo.java b/src/main/java/io/swagger/client/model/groups/GroupsInfo.java index c7108ed..cc1df32 100755 --- a/src/main/java/io/swagger/client/model/groups/GroupsInfo.java +++ b/src/main/java/io/swagger/client/model/groups/GroupsInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,7 +30,7 @@ /** * GroupsInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:04.402+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:40.217+11:00") public class GroupsInfo { @SerializedName("groupInfoList") private List groupInfoList = null; diff --git a/src/main/java/io/swagger/client/model/groups/PageInfo.java b/src/main/java/io/swagger/client/model/groups/PageInfo.java index aabb680..74a6a7b 100755 --- a/src/main/java/io/swagger/client/model/groups/PageInfo.java +++ b/src/main/java/io/swagger/client/model/groups/PageInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * PageInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:04.402+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:40.217+11:00") public class PageInfo { @SerializedName("nextCursor") private String nextCursor = null; diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/AccountSharerInfo.java b/src/main/java/io/swagger/client/model/libraryDocuments/AccountSharerInfo.java new file mode 100644 index 0000000..6544bdd --- /dev/null +++ b/src/main/java/io/swagger/client/model/libraryDocuments/AccountSharerInfo.java @@ -0,0 +1,221 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.libraryDocuments; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * AccountSharerInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") +public class AccountSharerInfo { + /** + * Gets or Sets permissions + */ + @JsonAdapter(PermissionsEnum.Adapter.class) + public enum PermissionsEnum { + VIEW("VIEW"), + + SEND("SEND"), + + MODIFY("MODIFY"); + + private String value; + + PermissionsEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static PermissionsEnum fromValue(String text) { + for (PermissionsEnum b : PermissionsEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final PermissionsEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public PermissionsEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return PermissionsEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("permissions") + private List permissions = null; + + @SerializedName("fullName") + private String fullName = null; + + @SerializedName("userId") + private String userId = null; + + @SerializedName("email") + private String email = null; + + public AccountSharerInfo permissions(List permissions) { + this.permissions = permissions; + return this; + } + + public AccountSharerInfo addPermissionsItem(PermissionsEnum permissionsItem) { + if (this.permissions == null) { + this.permissions = new ArrayList(); + } + this.permissions.add(permissionsItem); + return this; + } + + /** + * A list of permissions given for this account sharing. + * @return permissions + **/ + @ApiModelProperty(value = "A list of permissions given for this account sharing.") + public List getPermissions() { + return permissions; + } + + public void setPermissions(List permissions) { + this.permissions = permissions; + } + + public AccountSharerInfo fullName(String fullName) { + this.fullName = fullName; + return this; + } + + /** + * Full name of this account sharer. + * @return fullName + **/ + @ApiModelProperty(value = "Full name of this account sharer.") + public String getFullName() { + return fullName; + } + + public void setFullName(String fullName) { + this.fullName = fullName; + } + + public AccountSharerInfo userId(String userId) { + this.userId = userId; + return this; + } + + /** + * A unique identifier of the user resource for REST APIs as issued by Sign. + * @return userId + **/ + @ApiModelProperty(value = "A unique identifier of the user resource for REST APIs as issued by Sign.") + public String getUserId() { + return userId; + } + + public void setUserId(String userId) { + this.userId = userId; + } + + public AccountSharerInfo email(String email) { + this.email = email; + return this; + } + + /** + * The email address of the user + * @return email + **/ + @ApiModelProperty(value = "The email address of the user") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + AccountSharerInfo accountSharerInfo = (AccountSharerInfo) o; + return Objects.equals(this.permissions, accountSharerInfo.permissions) && + Objects.equals(this.fullName, accountSharerInfo.fullName) && + Objects.equals(this.userId, accountSharerInfo.userId) && + Objects.equals(this.email, accountSharerInfo.email); + } + + @Override + public int hashCode() { + return Objects.hash(permissions, fullName, userId, email); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class AccountSharerInfo {\n"); + + sb.append(" permissions: ").append(toIndentedString(permissions)).append("\n"); + sb.append(" fullName: ").append(toIndentedString(fullName)).append("\n"); + sb.append(" userId: ").append(toIndentedString(userId)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/CommonViewConfiguration.java b/src/main/java/io/swagger/client/model/libraryDocuments/CommonViewConfiguration.java index 0a253fe..ae919cd 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/CommonViewConfiguration.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/CommonViewConfiguration.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,17 +26,17 @@ /** * CommonViewConfiguration */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class CommonViewConfiguration { @SerializedName("autoLoginUser") private Boolean autoLoginUser = null; - @SerializedName("locale") - private String locale = null; - @SerializedName("noChrome") private Boolean noChrome = null; + @SerializedName("locale") + private String locale = null; + public CommonViewConfiguration autoLoginUser(Boolean autoLoginUser) { this.autoLoginUser = autoLoginUser; return this; @@ -70,24 +55,6 @@ public void setAutoLoginUser(Boolean autoLoginUser) { this.autoLoginUser = autoLoginUser; } - public CommonViewConfiguration locale(String locale) { - this.locale = locale; - return this; - } - - /** - * Message template locale - * @return locale - **/ - @ApiModelProperty(value = "Message template locale") - public String getLocale() { - return locale; - } - - public void setLocale(String locale) { - this.locale = locale; - } - public CommonViewConfiguration noChrome(Boolean noChrome) { this.noChrome = noChrome; return this; @@ -106,6 +73,24 @@ public void setNoChrome(Boolean noChrome) { this.noChrome = noChrome; } + public CommonViewConfiguration locale(String locale) { + this.locale = locale; + return this; + } + + /** + * Message template locale + * @return locale + **/ + @ApiModelProperty(value = "Message template locale") + public String getLocale() { + return locale; + } + + public void setLocale(String locale) { + this.locale = locale; + } + @Override public boolean equals(java.lang.Object o) { @@ -117,13 +102,13 @@ public boolean equals(java.lang.Object o) { } CommonViewConfiguration commonViewConfiguration = (CommonViewConfiguration) o; return Objects.equals(this.autoLoginUser, commonViewConfiguration.autoLoginUser) && - Objects.equals(this.locale, commonViewConfiguration.locale) && - Objects.equals(this.noChrome, commonViewConfiguration.noChrome); + Objects.equals(this.noChrome, commonViewConfiguration.noChrome) && + Objects.equals(this.locale, commonViewConfiguration.locale); } @Override public int hashCode() { - return Objects.hash(autoLoginUser, locale, noChrome); + return Objects.hash(autoLoginUser, noChrome, locale); } @@ -133,8 +118,8 @@ public String toString() { sb.append("class CommonViewConfiguration {\n"); sb.append(" autoLoginUser: ").append(toIndentedString(autoLoginUser)).append("\n"); - sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); sb.append(" noChrome: ").append(toIndentedString(noChrome)).append("\n"); + sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/DigitalSignatureInfo.java b/src/main/java/io/swagger/client/model/libraryDocuments/DigitalSignatureInfo.java index 8b05e1e..0c24e00 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/DigitalSignatureInfo.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/DigitalSignatureInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,16 +26,34 @@ /** * DigitalSignatureInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class DigitalSignatureInfo { + @SerializedName("name") + private String name = null; + @SerializedName("company") private String company = null; @SerializedName("email") private String email = null; - @SerializedName("name") - private String name = null; + public DigitalSignatureInfo name(String name) { + this.name = name; + return this; + } + + /** + * Name captured during digital signing + * @return name + **/ + @ApiModelProperty(value = "Name captured during digital signing") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } public DigitalSignatureInfo company(String company) { this.company = company; @@ -88,24 +91,6 @@ public void setEmail(String email) { this.email = email; } - public DigitalSignatureInfo name(String name) { - this.name = name; - return this; - } - - /** - * Name captured during digital signing - * @return name - **/ - @ApiModelProperty(value = "Name captured during digital signing") - public String getName() { - return name; - } - - public void setName(String name) { - this.name = name; - } - @Override public boolean equals(java.lang.Object o) { @@ -116,14 +101,14 @@ public boolean equals(java.lang.Object o) { return false; } DigitalSignatureInfo digitalSignatureInfo = (DigitalSignatureInfo) o; - return Objects.equals(this.company, digitalSignatureInfo.company) && - Objects.equals(this.email, digitalSignatureInfo.email) && - Objects.equals(this.name, digitalSignatureInfo.name); + return Objects.equals(this.name, digitalSignatureInfo.name) && + Objects.equals(this.company, digitalSignatureInfo.company) && + Objects.equals(this.email, digitalSignatureInfo.email); } @Override public int hashCode() { - return Objects.hash(company, email, name); + return Objects.hash(name, company, email); } @@ -132,9 +117,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DigitalSignatureInfo {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" company: ").append(toIndentedString(company)).append("\n"); sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/Document.java b/src/main/java/io/swagger/client/model/libraryDocuments/Document.java index cc72e50..ce0b7cf 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/Document.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/Document.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -37,12 +22,22 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; +import java.util.Date; /** * Document */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class Document { + @SerializedName("numPages") + private Integer numPages = null; + + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("name") + private String name = null; + @SerializedName("id") private String id = null; @@ -52,11 +47,59 @@ public class Document { @SerializedName("mimeType") private String mimeType = null; - @SerializedName("name") - private String name = null; + public Document numPages(Integer numPages) { + this.numPages = numPages; + return this; + } - @SerializedName("numPages") - private Integer numPages = null; + /** + * Number of pages in the document + * @return numPages + **/ + @ApiModelProperty(value = "Number of pages in the document") + public Integer getNumPages() { + return numPages; + } + + public void setNumPages(Integer numPages) { + this.numPages = numPages; + } + + public Document createdDate(Date createdDate) { + this.createdDate = createdDate; + return this; + } + + /** + * The date the document was created + * @return createdDate + **/ + @ApiModelProperty(value = "The date the document was created") + public Date getCreatedDate() { + return createdDate; + } + + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } + + public Document name(String name) { + this.name = name; + return this; + } + + /** + * Name of the original document uploaded. This is returned in GET but not accepted back in PUT + * @return name + **/ + @ApiModelProperty(value = "Name of the original document uploaded. This is returned in GET but not accepted back in PUT") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } public Document id(String id) { this.id = id; @@ -112,42 +155,6 @@ public void setMimeType(String mimeType) { this.mimeType = mimeType; } - public Document name(String name) { - this.name = name; - return this; - } - - /** - * Name of the original document uploaded. This is returned in GET but not accepted back in PUT - * @return name - **/ - @ApiModelProperty(value = "Name of the original document uploaded. This is returned in GET but not accepted back in PUT") - public String getName() { - return name; - } - - public void setName(String name) { - this.name = name; - } - - public Document numPages(Integer numPages) { - this.numPages = numPages; - return this; - } - - /** - * Number of pages in the document - * @return numPages - **/ - @ApiModelProperty(value = "Number of pages in the document") - public Integer getNumPages() { - return numPages; - } - - public void setNumPages(Integer numPages) { - this.numPages = numPages; - } - @Override public boolean equals(java.lang.Object o) { @@ -158,16 +165,17 @@ public boolean equals(java.lang.Object o) { return false; } Document document = (Document) o; - return Objects.equals(this.id, document.id) && - Objects.equals(this.label, document.label) && - Objects.equals(this.mimeType, document.mimeType) && + return Objects.equals(this.numPages, document.numPages) && + Objects.equals(this.createdDate, document.createdDate) && Objects.equals(this.name, document.name) && - Objects.equals(this.numPages, document.numPages); + Objects.equals(this.id, document.id) && + Objects.equals(this.label, document.label) && + Objects.equals(this.mimeType, document.mimeType); } @Override public int hashCode() { - return Objects.hash(id, label, mimeType, name, numPages); + return Objects.hash(numPages, createdDate, name, id, label, mimeType); } @@ -176,11 +184,12 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class Document {\n"); + sb.append(" numPages: ").append(toIndentedString(numPages)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" label: ").append(toIndentedString(label)).append("\n"); sb.append(" mimeType: ").append(toIndentedString(mimeType)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" numPages: ").append(toIndentedString(numPages)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/DocumentImageUrls.java b/src/main/java/io/swagger/client/model/libraryDocuments/DocumentImageUrls.java index 3789549..95a3761 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/DocumentImageUrls.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/DocumentImageUrls.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,8 +29,14 @@ /** * DocumentImageUrls */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class DocumentImageUrls { + @SerializedName("imageURLs") + private List imageURLs = null; + + @SerializedName("imagesAvailable") + private Boolean imagesAvailable = null; + /** * ImageSize corresponding to the imageUrl returned */ @@ -110,30 +101,6 @@ public ImageSizeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("imageSize") private ImageSizeEnum imageSize = null; - @SerializedName("imageURLs") - private List imageURLs = null; - - @SerializedName("imagesAvailable") - private Boolean imagesAvailable = null; - - public DocumentImageUrls imageSize(ImageSizeEnum imageSize) { - this.imageSize = imageSize; - return this; - } - - /** - * ImageSize corresponding to the imageUrl returned - * @return imageSize - **/ - @ApiModelProperty(value = "ImageSize corresponding to the imageUrl returned ") - public ImageSizeEnum getImageSize() { - return imageSize; - } - - public void setImageSize(ImageSizeEnum imageSize) { - this.imageSize = imageSize; - } - public DocumentImageUrls imageURLs(List imageURLs) { this.imageURLs = imageURLs; return this; @@ -178,6 +145,24 @@ public void setImagesAvailable(Boolean imagesAvailable) { this.imagesAvailable = imagesAvailable; } + public DocumentImageUrls imageSize(ImageSizeEnum imageSize) { + this.imageSize = imageSize; + return this; + } + + /** + * ImageSize corresponding to the imageUrl returned + * @return imageSize + **/ + @ApiModelProperty(value = "ImageSize corresponding to the imageUrl returned ") + public ImageSizeEnum getImageSize() { + return imageSize; + } + + public void setImageSize(ImageSizeEnum imageSize) { + this.imageSize = imageSize; + } + @Override public boolean equals(java.lang.Object o) { @@ -188,14 +173,14 @@ public boolean equals(java.lang.Object o) { return false; } DocumentImageUrls documentImageUrls = (DocumentImageUrls) o; - return Objects.equals(this.imageSize, documentImageUrls.imageSize) && - Objects.equals(this.imageURLs, documentImageUrls.imageURLs) && - Objects.equals(this.imagesAvailable, documentImageUrls.imagesAvailable); + return Objects.equals(this.imageURLs, documentImageUrls.imageURLs) && + Objects.equals(this.imagesAvailable, documentImageUrls.imagesAvailable) && + Objects.equals(this.imageSize, documentImageUrls.imageSize); } @Override public int hashCode() { - return Objects.hash(imageSize, imageURLs, imagesAvailable); + return Objects.hash(imageURLs, imagesAvailable, imageSize); } @@ -204,9 +189,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DocumentImageUrls {\n"); - sb.append(" imageSize: ").append(toIndentedString(imageSize)).append("\n"); sb.append(" imageURLs: ").append(toIndentedString(imageURLs)).append("\n"); sb.append(" imagesAvailable: ").append(toIndentedString(imagesAvailable)).append("\n"); + sb.append(" imageSize: ").append(toIndentedString(imageSize)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/DocumentImageUrlsInfo.java b/src/main/java/io/swagger/client/model/libraryDocuments/DocumentImageUrlsInfo.java index c42bde0..f597a63 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/DocumentImageUrlsInfo.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/DocumentImageUrlsInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,31 +29,13 @@ /** * DocumentImageUrlsInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class DocumentImageUrlsInfo { - @SerializedName("documentId") - private String documentId = null; - @SerializedName("documentImageUrlsList") private List documentImageUrlsList = null; - public DocumentImageUrlsInfo documentId(String documentId) { - this.documentId = documentId; - return this; - } - - /** - * Id of the document - * @return documentId - **/ - @ApiModelProperty(value = "Id of the document") - public String getDocumentId() { - return documentId; - } - - public void setDocumentId(String documentId) { - this.documentId = documentId; - } + @SerializedName("documentId") + private String documentId = null; public DocumentImageUrlsInfo documentImageUrlsList(List documentImageUrlsList) { this.documentImageUrlsList = documentImageUrlsList; @@ -96,6 +63,24 @@ public void setDocumentImageUrlsList(List documentImageUrlsLi this.documentImageUrlsList = documentImageUrlsList; } + public DocumentImageUrlsInfo documentId(String documentId) { + this.documentId = documentId; + return this; + } + + /** + * Id of the document + * @return documentId + **/ + @ApiModelProperty(value = "Id of the document") + public String getDocumentId() { + return documentId; + } + + public void setDocumentId(String documentId) { + this.documentId = documentId; + } + @Override public boolean equals(java.lang.Object o) { @@ -106,13 +91,13 @@ public boolean equals(java.lang.Object o) { return false; } DocumentImageUrlsInfo documentImageUrlsInfo = (DocumentImageUrlsInfo) o; - return Objects.equals(this.documentId, documentImageUrlsInfo.documentId) && - Objects.equals(this.documentImageUrlsList, documentImageUrlsInfo.documentImageUrlsList); + return Objects.equals(this.documentImageUrlsList, documentImageUrlsInfo.documentImageUrlsList) && + Objects.equals(this.documentId, documentImageUrlsInfo.documentId); } @Override public int hashCode() { - return Objects.hash(documentId, documentImageUrlsList); + return Objects.hash(documentImageUrlsList, documentId); } @@ -121,8 +106,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DocumentImageUrlsInfo {\n"); - sb.append(" documentId: ").append(toIndentedString(documentId)).append("\n"); sb.append(" documentImageUrlsList: ").append(toIndentedString(documentImageUrlsList)).append("\n"); + sb.append(" documentId: ").append(toIndentedString(documentId)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/DocumentUrl.java b/src/main/java/io/swagger/client/model/libraryDocuments/DocumentUrl.java new file mode 100644 index 0000000..6f56216 --- /dev/null +++ b/src/main/java/io/swagger/client/model/libraryDocuments/DocumentUrl.java @@ -0,0 +1,93 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.libraryDocuments; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * DocumentUrl + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") +public class DocumentUrl { + @SerializedName("url") + private String url = null; + + public DocumentUrl url(String url) { + this.url = url; + return this; + } + + /** + * Secure URL of the document + * @return url + **/ + @ApiModelProperty(value = "Secure URL of the document") + public String getUrl() { + return url; + } + + public void setUrl(String url) { + this.url = url; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + DocumentUrl documentUrl = (DocumentUrl) o; + return Objects.equals(this.url, documentUrl.url); + } + + @Override + public int hashCode() { + return Objects.hash(url); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class DocumentUrl {\n"); + + sb.append(" url: ").append(toIndentedString(url)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/Documents.java b/src/main/java/io/swagger/client/model/libraryDocuments/Documents.java index 0901707..f405696 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/Documents.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/Documents.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * Documents */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class Documents { @SerializedName("documents") private List documents = null; diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/FileInfo.java b/src/main/java/io/swagger/client/model/libraryDocuments/FileInfo.java index a8af244..a007001 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/FileInfo.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/FileInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,7 @@ /** * FileInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class FileInfo { @SerializedName("transientDocumentId") private String transientDocumentId = null; diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/FileUploadOptions.java b/src/main/java/io/swagger/client/model/libraryDocuments/FileUploadOptions.java index f08133f..d04c736 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/FileUploadOptions.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/FileUploadOptions.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,10 +26,10 @@ /** * FileUploadOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class FileUploadOptions { - @SerializedName("libraryDocument") - private Boolean libraryDocument = null; + @SerializedName("canEditFiles") + private Boolean canEditFiles = null; @SerializedName("localFile") private Boolean localFile = null; @@ -52,22 +37,25 @@ public class FileUploadOptions { @SerializedName("webConnectors") private Boolean webConnectors = null; - public FileUploadOptions libraryDocument(Boolean libraryDocument) { - this.libraryDocument = libraryDocument; + @SerializedName("libraryDocument") + private Boolean libraryDocument = null; + + public FileUploadOptions canEditFiles(Boolean canEditFiles) { + this.canEditFiles = canEditFiles; return this; } /** - * Whether library documents link should appear or not. Default value is taken as true - * @return libraryDocument + * Whether the file upload section can be edited by adding or removing files. Default value is taken as true. Changing the default value will alter the compose page view configuration for this agreement, but is not an access control mechanism + * @return canEditFiles **/ - @ApiModelProperty(value = "Whether library documents link should appear or not. Default value is taken as true") - public Boolean isLibraryDocument() { - return libraryDocument; + @ApiModelProperty(value = "Whether the file upload section can be edited by adding or removing files. Default value is taken as true. Changing the default value will alter the compose page view configuration for this agreement, but is not an access control mechanism") + public Boolean isCanEditFiles() { + return canEditFiles; } - public void setLibraryDocument(Boolean libraryDocument) { - this.libraryDocument = libraryDocument; + public void setCanEditFiles(Boolean canEditFiles) { + this.canEditFiles = canEditFiles; } public FileUploadOptions localFile(Boolean localFile) { @@ -106,6 +94,24 @@ public void setWebConnectors(Boolean webConnectors) { this.webConnectors = webConnectors; } + public FileUploadOptions libraryDocument(Boolean libraryDocument) { + this.libraryDocument = libraryDocument; + return this; + } + + /** + * Whether library documents link should appear or not. Default value is taken as true + * @return libraryDocument + **/ + @ApiModelProperty(value = "Whether library documents link should appear or not. Default value is taken as true") + public Boolean isLibraryDocument() { + return libraryDocument; + } + + public void setLibraryDocument(Boolean libraryDocument) { + this.libraryDocument = libraryDocument; + } + @Override public boolean equals(java.lang.Object o) { @@ -116,14 +122,15 @@ public boolean equals(java.lang.Object o) { return false; } FileUploadOptions fileUploadOptions = (FileUploadOptions) o; - return Objects.equals(this.libraryDocument, fileUploadOptions.libraryDocument) && + return Objects.equals(this.canEditFiles, fileUploadOptions.canEditFiles) && Objects.equals(this.localFile, fileUploadOptions.localFile) && - Objects.equals(this.webConnectors, fileUploadOptions.webConnectors); + Objects.equals(this.webConnectors, fileUploadOptions.webConnectors) && + Objects.equals(this.libraryDocument, fileUploadOptions.libraryDocument); } @Override public int hashCode() { - return Objects.hash(libraryDocument, localFile, webConnectors); + return Objects.hash(canEditFiles, localFile, webConnectors, libraryDocument); } @@ -132,9 +139,10 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class FileUploadOptions {\n"); - sb.append(" libraryDocument: ").append(toIndentedString(libraryDocument)).append("\n"); + sb.append(" canEditFiles: ").append(toIndentedString(canEditFiles)).append("\n"); sb.append(" localFile: ").append(toIndentedString(localFile)).append("\n"); sb.append(" webConnectors: ").append(toIndentedString(webConnectors)).append("\n"); + sb.append(" libraryDocument: ").append(toIndentedString(libraryDocument)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/FormField.java b/src/main/java/io/swagger/client/model/libraryDocuments/FormField.java new file mode 100644 index 0000000..70b5033 --- /dev/null +++ b/src/main/java/io/swagger/client/model/libraryDocuments/FormField.java @@ -0,0 +1,1477 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.libraryDocuments; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.libraryDocuments.FormFieldConditionalAction; +import io.swagger.client.model.libraryDocuments.FormFieldHyperlink; +import io.swagger.client.model.libraryDocuments.FormFieldLocation; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * A form field for an agreement. + */ +@ApiModel(description = "A form field for an agreement.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") +public class FormField { + /** + * The type of radio button (if field is radio button, identified by inputType). + */ + @JsonAdapter(RadioCheckTypeEnum.Adapter.class) + public enum RadioCheckTypeEnum { + CIRCLE("CIRCLE"), + + CHECK("CHECK"), + + CROSS("CROSS"), + + DIAMOND("DIAMOND"), + + SQUARE("SQUARE"), + + STAR("STAR"); + + private String value; + + RadioCheckTypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static RadioCheckTypeEnum fromValue(String text) { + for (RadioCheckTypeEnum b : RadioCheckTypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final RadioCheckTypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public RadioCheckTypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return RadioCheckTypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("radioCheckType") + private RadioCheckTypeEnum radioCheckType = null; + + @SerializedName("borderColor") + private String borderColor = null; + + @SerializedName("valueExpression") + private String valueExpression = null; + + @SerializedName("maskingText") + private String maskingText = null; + + @SerializedName("defaultValue") + private String defaultValue = null; + + @SerializedName("masked") + private Boolean masked = null; + + @SerializedName("minLength") + private Integer minLength = null; + + /** + * Origin of Form Field + */ + @JsonAdapter(OriginEnum.Adapter.class) + public enum OriginEnum { + AUTHORED("AUTHORED"), + + GENERATED("GENERATED"), + + IMPORTED("IMPORTED"); + + private String value; + + OriginEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static OriginEnum fromValue(String text) { + for (OriginEnum b : OriginEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final OriginEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public OriginEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return OriginEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("origin") + private OriginEnum origin = null; + + @SerializedName("tooltip") + private String tooltip = null; + + @SerializedName("hiddenOptions") + private List hiddenOptions = null; + + @SerializedName("required") + private Boolean required = null; + + @SerializedName("validationData") + private String validationData = null; + + @SerializedName("minValue") + private Double minValue = null; + + @SerializedName("borderWidth") + private Double borderWidth = null; + + @SerializedName("urlOverridable") + private Boolean urlOverridable = null; + + /** + * Input type of the form field + */ + @JsonAdapter(InputTypeEnum.Adapter.class) + public enum InputTypeEnum { + TEXT_FIELD("TEXT_FIELD"), + + MULTILINE("MULTILINE"), + + PASSWORD("PASSWORD"), + + RADIO("RADIO"), + + CHECKBOX("CHECKBOX"), + + DROP_DOWN("DROP_DOWN"), + + LISTBOX("LISTBOX"), + + SIGNATURE("SIGNATURE"), + + PDF_SIGNATURE("PDF_SIGNATURE"), + + BUTTON("BUTTON"), + + BLOCK("BLOCK"), + + FILE_CHOOSER("FILE_CHOOSER"), + + COMB("COMB"), + + INLINE_IMAGE("INLINE_IMAGE"), + + UNSUPPORTED("UNSUPPORTED"); + + private String value; + + InputTypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static InputTypeEnum fromValue(String text) { + for (InputTypeEnum b : InputTypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final InputTypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public InputTypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return InputTypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("inputType") + private InputTypeEnum inputType = null; + + /** + * Style of the border of the field. + */ + @JsonAdapter(BorderStyleEnum.Adapter.class) + public enum BorderStyleEnum { + SOLID("SOLID"), + + DASHED("DASHED"), + + BEVELED("BEVELED"), + + INSET("INSET"), + + UNDERLINE("UNDERLINE"); + + private String value; + + BorderStyleEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static BorderStyleEnum fromValue(String text) { + for (BorderStyleEnum b : BorderStyleEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final BorderStyleEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public BorderStyleEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return BorderStyleEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("borderStyle") + private BorderStyleEnum borderStyle = null; + + @SerializedName("calculated") + private Boolean calculated = null; + + /** + * Content Type of the form field. + */ + @JsonAdapter(ContentTypeEnum.Adapter.class) + public enum ContentTypeEnum { + DATA("DATA"), + + SIGNATURE_BLOCK("SIGNATURE_BLOCK"), + + SIGNATURE("SIGNATURE"), + + SIGNER_NAME("SIGNER_NAME"), + + SIGNER_FIRST_NAME("SIGNER_FIRST_NAME"), + + SIGNER_LAST_NAME("SIGNER_LAST_NAME"), + + SIGNER_INITIALS("SIGNER_INITIALS"), + + SIGNER_EMAIL("SIGNER_EMAIL"), + + SIGNER_TITLE("SIGNER_TITLE"), + + SIGNER_COMPANY("SIGNER_COMPANY"), + + SIGNATURE_DATE("SIGNATURE_DATE"), + + AGREEMENT_NAME("AGREEMENT_NAME"), + + AGREEMENT_MESSAGE("AGREEMENT_MESSAGE"), + + TRANSACTION_ID("TRANSACTION_ID"), + + SIGNATURE_STAMP("SIGNATURE_STAMP"), + + PAYMENT("PAYMENT"), + + DIGITAL_SIGNATURE("DIGITAL_SIGNATURE"), + + CALC("CALC"); + + private String value; + + ContentTypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ContentTypeEnum fromValue(String text) { + for (ContentTypeEnum b : ContentTypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ContentTypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ContentTypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ContentTypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("contentType") + private ContentTypeEnum contentType = null; + + /** + * Rule for validating the field value. + */ + @JsonAdapter(ValidationEnum.Adapter.class) + public enum ValidationEnum { + NONE("NONE"), + + STRING("STRING"), + + NUMBER("NUMBER"), + + DATE("DATE"), + + DATE_CUSTOM("DATE_CUSTOM"), + + TIME("TIME"), + + ZIP("ZIP"), + + PHONE("PHONE"), + + SOCIAL_SEC("SOCIAL_SEC"), + + EMAIL("EMAIL"), + + CURRENCY("CURRENCY"), + + PERCENT("PERCENT"), + + FORMULA("FORMULA"), + + CUSTOM("CUSTOM"), + + XFA_PICTURE("XFA_PICTURE"); + + private String value; + + ValidationEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ValidationEnum fromValue(String text) { + for (ValidationEnum b : ValidationEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ValidationEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ValidationEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ValidationEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("validation") + private ValidationEnum validation = null; + + @SerializedName("displayLabel") + private String displayLabel = null; + + @SerializedName("hyperlink") + private FormFieldHyperlink hyperlink = null; + + @SerializedName("backgroundColor") + private String backgroundColor = null; + + @SerializedName("visible") + private Boolean visible = null; + + /** + * Format type of the text field. + */ + @JsonAdapter(DisplayFormatTypeEnum.Adapter.class) + public enum DisplayFormatTypeEnum { + DEFAULT("DEFAULT"), + + DATE("DATE"), + + NUMBER("NUMBER"); + + private String value; + + DisplayFormatTypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static DisplayFormatTypeEnum fromValue(String text) { + for (DisplayFormatTypeEnum b : DisplayFormatTypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final DisplayFormatTypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public DisplayFormatTypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return DisplayFormatTypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("displayFormatType") + private DisplayFormatTypeEnum displayFormatType = null; + + @SerializedName("maxValue") + private Double maxValue = null; + + @SerializedName("validationErrMsg") + private String validationErrMsg = null; + + @SerializedName("displayFormat") + private String displayFormat = null; + + @SerializedName("visibleOptions") + private List visibleOptions = null; + + @SerializedName("readOnly") + private Boolean readOnly = null; + + @SerializedName("fontName") + private String fontName = null; + + @SerializedName("conditionalAction") + private FormFieldConditionalAction conditionalAction = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("fontSize") + private Double fontSize = null; + + @SerializedName("locations") + private List locations = null; + + @SerializedName("assignee") + private String assignee = null; + + /** + * Alignment of the text. + */ + @JsonAdapter(AlignmentEnum.Adapter.class) + public enum AlignmentEnum { + LEFT("LEFT"), + + RIGHT("RIGHT"), + + CENTER("CENTER"); + + private String value; + + AlignmentEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static AlignmentEnum fromValue(String text) { + for (AlignmentEnum b : AlignmentEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final AlignmentEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public AlignmentEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return AlignmentEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("alignment") + private AlignmentEnum alignment = null; + + @SerializedName("fontColor") + private String fontColor = null; + + @SerializedName("maxLength") + private Integer maxLength = null; + + public FormField radioCheckType(RadioCheckTypeEnum radioCheckType) { + this.radioCheckType = radioCheckType; + return this; + } + + /** + * The type of radio button (if field is radio button, identified by inputType). + * @return radioCheckType + **/ + @ApiModelProperty(value = "The type of radio button (if field is radio button, identified by inputType).") + public RadioCheckTypeEnum getRadioCheckType() { + return radioCheckType; + } + + public void setRadioCheckType(RadioCheckTypeEnum radioCheckType) { + this.radioCheckType = radioCheckType; + } + + public FormField borderColor(String borderColor) { + this.borderColor = borderColor; + return this; + } + + /** + * Color of the border of the field in RGB or HEX format + * @return borderColor + **/ + @ApiModelProperty(value = "Color of the border of the field in RGB or HEX format") + public String getBorderColor() { + return borderColor; + } + + public void setBorderColor(String borderColor) { + this.borderColor = borderColor; + } + + public FormField valueExpression(String valueExpression) { + this.valueExpression = valueExpression; + return this; + } + + /** + * Expression to calculate value of the form field + * @return valueExpression + **/ + @ApiModelProperty(value = "Expression to calculate value of the form field") + public String getValueExpression() { + return valueExpression; + } + + public void setValueExpression(String valueExpression) { + this.valueExpression = valueExpression; + } + + public FormField maskingText(String maskingText) { + this.maskingText = maskingText; + return this; + } + + /** + * Text to mask the masked form field + * @return maskingText + **/ + @ApiModelProperty(value = "Text to mask the masked form field") + public String getMaskingText() { + return maskingText; + } + + public void setMaskingText(String maskingText) { + this.maskingText = maskingText; + } + + public FormField defaultValue(String defaultValue) { + this.defaultValue = defaultValue; + return this; + } + + /** + * Default value of the form field + * @return defaultValue + **/ + @ApiModelProperty(value = "Default value of the form field") + public String getDefaultValue() { + return defaultValue; + } + + public void setDefaultValue(String defaultValue) { + this.defaultValue = defaultValue; + } + + public FormField masked(Boolean masked) { + this.masked = masked; + return this; + } + + /** + * true if the input entered by the signer has to be masked (like password), false if it shouldn't be + * @return masked + **/ + @ApiModelProperty(value = "true if the input entered by the signer has to be masked (like password), false if it shouldn't be") + public Boolean isMasked() { + return masked; + } + + public void setMasked(Boolean masked) { + this.masked = masked; + } + + public FormField minLength(Integer minLength) { + this.minLength = minLength; + return this; + } + + /** + * Minimum length of the input text field in terms of no. of characters + * @return minLength + **/ + @ApiModelProperty(value = "Minimum length of the input text field in terms of no. of characters") + public Integer getMinLength() { + return minLength; + } + + public void setMinLength(Integer minLength) { + this.minLength = minLength; + } + + public FormField origin(OriginEnum origin) { + this.origin = origin; + return this; + } + + /** + * Origin of Form Field + * @return origin + **/ + @ApiModelProperty(value = "Origin of Form Field") + public OriginEnum getOrigin() { + return origin; + } + + public void setOrigin(OriginEnum origin) { + this.origin = origin; + } + + public FormField tooltip(String tooltip) { + this.tooltip = tooltip; + return this; + } + + /** + * Text that appears while hovering over the field + * @return tooltip + **/ + @ApiModelProperty(value = "Text that appears while hovering over the field") + public String getTooltip() { + return tooltip; + } + + public void setTooltip(String tooltip) { + this.tooltip = tooltip; + } + + public FormField hiddenOptions(List hiddenOptions) { + this.hiddenOptions = hiddenOptions; + return this; + } + + public FormField addHiddenOptionsItem(String hiddenOptionsItem) { + if (this.hiddenOptions == null) { + this.hiddenOptions = new ArrayList(); + } + this.hiddenOptions.add(hiddenOptionsItem); + return this; + } + + /** + * Text values which are hidden in a drop down form field + * @return hiddenOptions + **/ + @ApiModelProperty(value = "Text values which are hidden in a drop down form field") + public List getHiddenOptions() { + return hiddenOptions; + } + + public void setHiddenOptions(List hiddenOptions) { + this.hiddenOptions = hiddenOptions; + } + + public FormField required(Boolean required) { + this.required = required; + return this; + } + + /** + * true if it is a mandatory field to be filled by the signer, else false + * @return required + **/ + @ApiModelProperty(value = "true if it is a mandatory field to be filled by the signer, else false") + public Boolean isRequired() { + return required; + } + + public void setRequired(Boolean required) { + this.required = required; + } + + public FormField validationData(String validationData) { + this.validationData = validationData; + return this; + } + + /** + * Further data for validating input with regards to the field's specified format. The contents and interpretation of formatData depends on the value of validation. + * @return validationData + **/ + @ApiModelProperty(value = "Further data for validating input with regards to the field's specified format. The contents and interpretation of formatData depends on the value of validation.") + public String getValidationData() { + return validationData; + } + + public void setValidationData(String validationData) { + this.validationData = validationData; + } + + public FormField minValue(Double minValue) { + this.minValue = minValue; + return this; + } + + /** + * Lower bound of the number that can be entered by the signer + * @return minValue + **/ + @ApiModelProperty(value = "Lower bound of the number that can be entered by the signer") + public Double getMinValue() { + return minValue; + } + + public void setMinValue(Double minValue) { + this.minValue = minValue; + } + + public FormField borderWidth(Double borderWidth) { + this.borderWidth = borderWidth; + return this; + } + + /** + * Width of the border of the field in pixels + * @return borderWidth + **/ + @ApiModelProperty(value = "Width of the border of the field in pixels") + public Double getBorderWidth() { + return borderWidth; + } + + public void setBorderWidth(Double borderWidth) { + this.borderWidth = borderWidth; + } + + public FormField urlOverridable(Boolean urlOverridable) { + this.urlOverridable = urlOverridable; + return this; + } + + /** + * For web form text fields only - true if the default value may come from the URL, else false + * @return urlOverridable + **/ + @ApiModelProperty(value = "For web form text fields only - true if the default value may come from the URL, else false") + public Boolean isUrlOverridable() { + return urlOverridable; + } + + public void setUrlOverridable(Boolean urlOverridable) { + this.urlOverridable = urlOverridable; + } + + public FormField inputType(InputTypeEnum inputType) { + this.inputType = inputType; + return this; + } + + /** + * Input type of the form field + * @return inputType + **/ + @ApiModelProperty(value = "Input type of the form field") + public InputTypeEnum getInputType() { + return inputType; + } + + public void setInputType(InputTypeEnum inputType) { + this.inputType = inputType; + } + + public FormField borderStyle(BorderStyleEnum borderStyle) { + this.borderStyle = borderStyle; + return this; + } + + /** + * Style of the border of the field. + * @return borderStyle + **/ + @ApiModelProperty(value = "Style of the border of the field.") + public BorderStyleEnum getBorderStyle() { + return borderStyle; + } + + public void setBorderStyle(BorderStyleEnum borderStyle) { + this.borderStyle = borderStyle; + } + + public FormField calculated(Boolean calculated) { + this.calculated = calculated; + return this; + } + + /** + * true if this field's value is calculated from an expression, else false + * @return calculated + **/ + @ApiModelProperty(value = "true if this field's value is calculated from an expression, else false") + public Boolean isCalculated() { + return calculated; + } + + public void setCalculated(Boolean calculated) { + this.calculated = calculated; + } + + public FormField contentType(ContentTypeEnum contentType) { + this.contentType = contentType; + return this; + } + + /** + * Content Type of the form field. + * @return contentType + **/ + @ApiModelProperty(value = "Content Type of the form field.") + public ContentTypeEnum getContentType() { + return contentType; + } + + public void setContentType(ContentTypeEnum contentType) { + this.contentType = contentType; + } + + public FormField validation(ValidationEnum validation) { + this.validation = validation; + return this; + } + + /** + * Rule for validating the field value. + * @return validation + **/ + @ApiModelProperty(value = "Rule for validating the field value.") + public ValidationEnum getValidation() { + return validation; + } + + public void setValidation(ValidationEnum validation) { + this.validation = validation; + } + + public FormField displayLabel(String displayLabel) { + this.displayLabel = displayLabel; + return this; + } + + /** + * Display label attached to the field + * @return displayLabel + **/ + @ApiModelProperty(value = "Display label attached to the field") + public String getDisplayLabel() { + return displayLabel; + } + + public void setDisplayLabel(String displayLabel) { + this.displayLabel = displayLabel; + } + + public FormField hyperlink(FormFieldHyperlink hyperlink) { + this.hyperlink = hyperlink; + return this; + } + + /** + * Hyperlink-specific data (e.g. as url, link type) + * @return hyperlink + **/ + @ApiModelProperty(value = "Hyperlink-specific data (e.g. as url, link type)") + public FormFieldHyperlink getHyperlink() { + return hyperlink; + } + + public void setHyperlink(FormFieldHyperlink hyperlink) { + this.hyperlink = hyperlink; + } + + public FormField backgroundColor(String backgroundColor) { + this.backgroundColor = backgroundColor; + return this; + } + + /** + * Background color of the form field in RGB or HEX format + * @return backgroundColor + **/ + @ApiModelProperty(value = "Background color of the form field in RGB or HEX format") + public String getBackgroundColor() { + return backgroundColor; + } + + public void setBackgroundColor(String backgroundColor) { + this.backgroundColor = backgroundColor; + } + + public FormField visible(Boolean visible) { + this.visible = visible; + return this; + } + + /** + * If set to false, then the form field is hidden. Otherwise, it is visible. + * @return visible + **/ + @ApiModelProperty(value = "If set to false, then the form field is hidden. Otherwise, it is visible.") + public Boolean isVisible() { + return visible; + } + + public void setVisible(Boolean visible) { + this.visible = visible; + } + + public FormField displayFormatType(DisplayFormatTypeEnum displayFormatType) { + this.displayFormatType = displayFormatType; + return this; + } + + /** + * Format type of the text field. + * @return displayFormatType + **/ + @ApiModelProperty(value = "Format type of the text field.") + public DisplayFormatTypeEnum getDisplayFormatType() { + return displayFormatType; + } + + public void setDisplayFormatType(DisplayFormatTypeEnum displayFormatType) { + this.displayFormatType = displayFormatType; + } + + public FormField maxValue(Double maxValue) { + this.maxValue = maxValue; + return this; + } + + /** + * Upper bound of the number that can be entered by the signer + * @return maxValue + **/ + @ApiModelProperty(value = "Upper bound of the number that can be entered by the signer") + public Double getMaxValue() { + return maxValue; + } + + public void setMaxValue(Double maxValue) { + this.maxValue = maxValue; + } + + public FormField validationErrMsg(String validationErrMsg) { + this.validationErrMsg = validationErrMsg; + return this; + } + + /** + * Error message to be shown to the signer if filled value doesn't match the validations of the form field + * @return validationErrMsg + **/ + @ApiModelProperty(value = "Error message to be shown to the signer if filled value doesn't match the validations of the form field") + public String getValidationErrMsg() { + return validationErrMsg; + } + + public void setValidationErrMsg(String validationErrMsg) { + this.validationErrMsg = validationErrMsg; + } + + public FormField displayFormat(String displayFormat) { + this.displayFormat = displayFormat; + return this; + } + + /** + * Format of the value of the field to be displayed based on the displayFormatType property. + * @return displayFormat + **/ + @ApiModelProperty(value = "Format of the value of the field to be displayed based on the displayFormatType property.") + public String getDisplayFormat() { + return displayFormat; + } + + public void setDisplayFormat(String displayFormat) { + this.displayFormat = displayFormat; + } + + public FormField visibleOptions(List visibleOptions) { + this.visibleOptions = visibleOptions; + return this; + } + + public FormField addVisibleOptionsItem(String visibleOptionsItem) { + if (this.visibleOptions == null) { + this.visibleOptions = new ArrayList(); + } + this.visibleOptions.add(visibleOptionsItem); + return this; + } + + /** + * Text values which are visible in a drop down form field + * @return visibleOptions + **/ + @ApiModelProperty(value = "Text values which are visible in a drop down form field") + public List getVisibleOptions() { + return visibleOptions; + } + + public void setVisibleOptions(List visibleOptions) { + this.visibleOptions = visibleOptions; + } + + public FormField readOnly(Boolean readOnly) { + this.readOnly = readOnly; + return this; + } + + /** + * true if it is a read-only field, else false + * @return readOnly + **/ + @ApiModelProperty(value = "true if it is a read-only field, else false") + public Boolean isReadOnly() { + return readOnly; + } + + public void setReadOnly(Boolean readOnly) { + this.readOnly = readOnly; + } + + public FormField fontName(String fontName) { + this.fontName = fontName; + return this; + } + + /** + * Font name of the form field + * @return fontName + **/ + @ApiModelProperty(value = "Font name of the form field") + public String getFontName() { + return fontName; + } + + public void setFontName(String fontName) { + this.fontName = fontName; + } + + public FormField conditionalAction(FormFieldConditionalAction conditionalAction) { + this.conditionalAction = conditionalAction; + return this; + } + + /** + * A predicate (or set of predicates) that determines whether this field is visible and enabled. + * @return conditionalAction + **/ + @ApiModelProperty(value = "A predicate (or set of predicates) that determines whether this field is visible and enabled.") + public FormFieldConditionalAction getConditionalAction() { + return conditionalAction; + } + + public void setConditionalAction(FormFieldConditionalAction conditionalAction) { + this.conditionalAction = conditionalAction; + } + + public FormField name(String name) { + this.name = name; + return this; + } + + /** + * The name of the form field + * @return name + **/ + @ApiModelProperty(value = "The name of the form field") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public FormField fontSize(Double fontSize) { + this.fontSize = fontSize; + return this; + } + + /** + * Font size of the form field in points + * @return fontSize + **/ + @ApiModelProperty(value = "Font size of the form field in points") + public Double getFontSize() { + return fontSize; + } + + public void setFontSize(Double fontSize) { + this.fontSize = fontSize; + } + + public FormField locations(List locations) { + this.locations = locations; + return this; + } + + public FormField addLocationsItem(FormFieldLocation locationsItem) { + if (this.locations == null) { + this.locations = new ArrayList(); + } + this.locations.add(locationsItem); + return this; + } + + /** + * All locations in a document where the form field is placed + * @return locations + **/ + @ApiModelProperty(value = "All locations in a document where the form field is placed") + public List getLocations() { + return locations; + } + + public void setLocations(List locations) { + this.locations = locations; + } + + public FormField assignee(String assignee) { + this.assignee = assignee; + return this; + } + + /** + * Who the field is assigned to. Valid values are a participant set id, null, \"NOBODY\", \"PREFILL\" or \"EVERYONE\". If set to a participant set id, then any member of that participant set may fill out the field. \"NOBODY\" indicates that the field may not be filled by anybody (e.g. autopopulated fields like transaction number). \"PREFILL\" indicates that the field will be filled by the sender before the agreement is sent out for signing. \"EVERYONE\" exists only in hyperlink fields currently and indicates that it is assigned to all participants. null indicates that anybody may fill out the field. If the propeerty isn't specified, it is treated as null. + * @return assignee + **/ + @ApiModelProperty(value = "Who the field is assigned to. Valid values are a participant set id, null, \"NOBODY\", \"PREFILL\" or \"EVERYONE\". If set to a participant set id, then any member of that participant set may fill out the field. \"NOBODY\" indicates that the field may not be filled by anybody (e.g. autopopulated fields like transaction number). \"PREFILL\" indicates that the field will be filled by the sender before the agreement is sent out for signing. \"EVERYONE\" exists only in hyperlink fields currently and indicates that it is assigned to all participants. null indicates that anybody may fill out the field. If the propeerty isn't specified, it is treated as null.") + public String getAssignee() { + return assignee; + } + + public void setAssignee(String assignee) { + this.assignee = assignee; + } + + public FormField alignment(AlignmentEnum alignment) { + this.alignment = alignment; + return this; + } + + /** + * Alignment of the text. + * @return alignment + **/ + @ApiModelProperty(value = "Alignment of the text.") + public AlignmentEnum getAlignment() { + return alignment; + } + + public void setAlignment(AlignmentEnum alignment) { + this.alignment = alignment; + } + + public FormField fontColor(String fontColor) { + this.fontColor = fontColor; + return this; + } + + /** + * Font color of the form field in RGB or HEX format + * @return fontColor + **/ + @ApiModelProperty(value = "Font color of the form field in RGB or HEX format") + public String getFontColor() { + return fontColor; + } + + public void setFontColor(String fontColor) { + this.fontColor = fontColor; + } + + public FormField maxLength(Integer maxLength) { + this.maxLength = maxLength; + return this; + } + + /** + * Maximum length of the input text field in terms of no. of characters + * @return maxLength + **/ + @ApiModelProperty(value = "Maximum length of the input text field in terms of no. of characters") + public Integer getMaxLength() { + return maxLength; + } + + public void setMaxLength(Integer maxLength) { + this.maxLength = maxLength; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FormField formField = (FormField) o; + return Objects.equals(this.radioCheckType, formField.radioCheckType) && + Objects.equals(this.borderColor, formField.borderColor) && + Objects.equals(this.valueExpression, formField.valueExpression) && + Objects.equals(this.maskingText, formField.maskingText) && + Objects.equals(this.defaultValue, formField.defaultValue) && + Objects.equals(this.masked, formField.masked) && + Objects.equals(this.minLength, formField.minLength) && + Objects.equals(this.origin, formField.origin) && + Objects.equals(this.tooltip, formField.tooltip) && + Objects.equals(this.hiddenOptions, formField.hiddenOptions) && + Objects.equals(this.required, formField.required) && + Objects.equals(this.validationData, formField.validationData) && + Objects.equals(this.minValue, formField.minValue) && + Objects.equals(this.borderWidth, formField.borderWidth) && + Objects.equals(this.urlOverridable, formField.urlOverridable) && + Objects.equals(this.inputType, formField.inputType) && + Objects.equals(this.borderStyle, formField.borderStyle) && + Objects.equals(this.calculated, formField.calculated) && + Objects.equals(this.contentType, formField.contentType) && + Objects.equals(this.validation, formField.validation) && + Objects.equals(this.displayLabel, formField.displayLabel) && + Objects.equals(this.hyperlink, formField.hyperlink) && + Objects.equals(this.backgroundColor, formField.backgroundColor) && + Objects.equals(this.visible, formField.visible) && + Objects.equals(this.displayFormatType, formField.displayFormatType) && + Objects.equals(this.maxValue, formField.maxValue) && + Objects.equals(this.validationErrMsg, formField.validationErrMsg) && + Objects.equals(this.displayFormat, formField.displayFormat) && + Objects.equals(this.visibleOptions, formField.visibleOptions) && + Objects.equals(this.readOnly, formField.readOnly) && + Objects.equals(this.fontName, formField.fontName) && + Objects.equals(this.conditionalAction, formField.conditionalAction) && + Objects.equals(this.name, formField.name) && + Objects.equals(this.fontSize, formField.fontSize) && + Objects.equals(this.locations, formField.locations) && + Objects.equals(this.assignee, formField.assignee) && + Objects.equals(this.alignment, formField.alignment) && + Objects.equals(this.fontColor, formField.fontColor) && + Objects.equals(this.maxLength, formField.maxLength); + } + + @Override + public int hashCode() { + return Objects.hash(radioCheckType, borderColor, valueExpression, maskingText, defaultValue, masked, minLength, origin, tooltip, hiddenOptions, required, validationData, minValue, borderWidth, urlOverridable, inputType, borderStyle, calculated, contentType, validation, displayLabel, hyperlink, backgroundColor, visible, displayFormatType, maxValue, validationErrMsg, displayFormat, visibleOptions, readOnly, fontName, conditionalAction, name, fontSize, locations, assignee, alignment, fontColor, maxLength); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FormField {\n"); + + sb.append(" radioCheckType: ").append(toIndentedString(radioCheckType)).append("\n"); + sb.append(" borderColor: ").append(toIndentedString(borderColor)).append("\n"); + sb.append(" valueExpression: ").append(toIndentedString(valueExpression)).append("\n"); + sb.append(" maskingText: ").append(toIndentedString(maskingText)).append("\n"); + sb.append(" defaultValue: ").append(toIndentedString(defaultValue)).append("\n"); + sb.append(" masked: ").append(toIndentedString(masked)).append("\n"); + sb.append(" minLength: ").append(toIndentedString(minLength)).append("\n"); + sb.append(" origin: ").append(toIndentedString(origin)).append("\n"); + sb.append(" tooltip: ").append(toIndentedString(tooltip)).append("\n"); + sb.append(" hiddenOptions: ").append(toIndentedString(hiddenOptions)).append("\n"); + sb.append(" required: ").append(toIndentedString(required)).append("\n"); + sb.append(" validationData: ").append(toIndentedString(validationData)).append("\n"); + sb.append(" minValue: ").append(toIndentedString(minValue)).append("\n"); + sb.append(" borderWidth: ").append(toIndentedString(borderWidth)).append("\n"); + sb.append(" urlOverridable: ").append(toIndentedString(urlOverridable)).append("\n"); + sb.append(" inputType: ").append(toIndentedString(inputType)).append("\n"); + sb.append(" borderStyle: ").append(toIndentedString(borderStyle)).append("\n"); + sb.append(" calculated: ").append(toIndentedString(calculated)).append("\n"); + sb.append(" contentType: ").append(toIndentedString(contentType)).append("\n"); + sb.append(" validation: ").append(toIndentedString(validation)).append("\n"); + sb.append(" displayLabel: ").append(toIndentedString(displayLabel)).append("\n"); + sb.append(" hyperlink: ").append(toIndentedString(hyperlink)).append("\n"); + sb.append(" backgroundColor: ").append(toIndentedString(backgroundColor)).append("\n"); + sb.append(" visible: ").append(toIndentedString(visible)).append("\n"); + sb.append(" displayFormatType: ").append(toIndentedString(displayFormatType)).append("\n"); + sb.append(" maxValue: ").append(toIndentedString(maxValue)).append("\n"); + sb.append(" validationErrMsg: ").append(toIndentedString(validationErrMsg)).append("\n"); + sb.append(" displayFormat: ").append(toIndentedString(displayFormat)).append("\n"); + sb.append(" visibleOptions: ").append(toIndentedString(visibleOptions)).append("\n"); + sb.append(" readOnly: ").append(toIndentedString(readOnly)).append("\n"); + sb.append(" fontName: ").append(toIndentedString(fontName)).append("\n"); + sb.append(" conditionalAction: ").append(toIndentedString(conditionalAction)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" fontSize: ").append(toIndentedString(fontSize)).append("\n"); + sb.append(" locations: ").append(toIndentedString(locations)).append("\n"); + sb.append(" assignee: ").append(toIndentedString(assignee)).append("\n"); + sb.append(" alignment: ").append(toIndentedString(alignment)).append("\n"); + sb.append(" fontColor: ").append(toIndentedString(fontColor)).append("\n"); + sb.append(" maxLength: ").append(toIndentedString(maxLength)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/FormFieldConditionPredicate.java b/src/main/java/io/swagger/client/model/libraryDocuments/FormFieldConditionPredicate.java new file mode 100644 index 0000000..712d66f --- /dev/null +++ b/src/main/java/io/swagger/client/model/libraryDocuments/FormFieldConditionPredicate.java @@ -0,0 +1,226 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.libraryDocuments; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * A predicate used to determine whether the condtion succeeds + */ +@ApiModel(description = "A predicate used to determine whether the condtion succeeds") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") +public class FormFieldConditionPredicate { + @SerializedName("fieldName") + private String fieldName = null; + + @SerializedName("value") + private String value = null; + + /** + * Operator to be applied on the value of the predicate field. + */ + @JsonAdapter(OperatorEnum.Adapter.class) + public enum OperatorEnum { + EQUALS("EQUALS"), + + NOT_EQUALS("NOT_EQUALS"), + + LESS_THAN("LESS_THAN"), + + LESS_THAN_EQUALS("LESS_THAN_EQUALS"), + + GREATER_THAN("GREATER_THAN"), + + GREATER_THAN_EQUALS("GREATER_THAN_EQUALS"), + + IN("IN"), + + NOT_IN("NOT_IN"), + + CONTAINS("CONTAINS"), + + NOT_CONTAINS("NOT_CONTAINS"); + + private String value; + + OperatorEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static OperatorEnum fromValue(String text) { + for (OperatorEnum b : OperatorEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final OperatorEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public OperatorEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return OperatorEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("operator") + private OperatorEnum operator = null; + + @SerializedName("fieldLocationIndex") + private Integer fieldLocationIndex = null; + + public FormFieldConditionPredicate fieldName(String fieldName) { + this.fieldName = fieldName; + return this; + } + + /** + * Name of the field whose value is the basis of predicate + * @return fieldName + **/ + @ApiModelProperty(value = "Name of the field whose value is the basis of predicate") + public String getFieldName() { + return fieldName; + } + + public void setFieldName(String fieldName) { + this.fieldName = fieldName; + } + + public FormFieldConditionPredicate value(String value) { + this.value = value; + return this; + } + + /** + * Value to compare against the value of the predicate's form field, using the specified operator + * @return value + **/ + @ApiModelProperty(value = "Value to compare against the value of the predicate's form field, using the specified operator") + public String getValue() { + return value; + } + + public void setValue(String value) { + this.value = value; + } + + public FormFieldConditionPredicate operator(OperatorEnum operator) { + this.operator = operator; + return this; + } + + /** + * Operator to be applied on the value of the predicate field. + * @return operator + **/ + @ApiModelProperty(value = "Operator to be applied on the value of the predicate field.") + public OperatorEnum getOperator() { + return operator; + } + + public void setOperator(OperatorEnum operator) { + this.operator = operator; + } + + public FormFieldConditionPredicate fieldLocationIndex(Integer fieldLocationIndex) { + this.fieldLocationIndex = fieldLocationIndex; + return this; + } + + /** + * Index of the location of the form field used in the predicate + * @return fieldLocationIndex + **/ + @ApiModelProperty(value = "Index of the location of the form field used in the predicate") + public Integer getFieldLocationIndex() { + return fieldLocationIndex; + } + + public void setFieldLocationIndex(Integer fieldLocationIndex) { + this.fieldLocationIndex = fieldLocationIndex; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FormFieldConditionPredicate formFieldConditionPredicate = (FormFieldConditionPredicate) o; + return Objects.equals(this.fieldName, formFieldConditionPredicate.fieldName) && + Objects.equals(this.value, formFieldConditionPredicate.value) && + Objects.equals(this.operator, formFieldConditionPredicate.operator) && + Objects.equals(this.fieldLocationIndex, formFieldConditionPredicate.fieldLocationIndex); + } + + @Override + public int hashCode() { + return Objects.hash(fieldName, value, operator, fieldLocationIndex); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FormFieldConditionPredicate {\n"); + + sb.append(" fieldName: ").append(toIndentedString(fieldName)).append("\n"); + sb.append(" value: ").append(toIndentedString(value)).append("\n"); + sb.append(" operator: ").append(toIndentedString(operator)).append("\n"); + sb.append(" fieldLocationIndex: ").append(toIndentedString(fieldLocationIndex)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/FormFieldConditionalAction.java b/src/main/java/io/swagger/client/model/libraryDocuments/FormFieldConditionalAction.java new file mode 100644 index 0000000..0a557a6 --- /dev/null +++ b/src/main/java/io/swagger/client/model/libraryDocuments/FormFieldConditionalAction.java @@ -0,0 +1,249 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.libraryDocuments; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.libraryDocuments.FormFieldConditionPredicate; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * Conditional actions to perfom on this form field. + */ +@ApiModel(description = "Conditional actions to perfom on this form field.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") +public class FormFieldConditionalAction { + @SerializedName("predicates") + private List predicates = null; + + /** + * It indicates if any one of the conditions or all of them have to be true. + */ + @JsonAdapter(AnyOrAllEnum.Adapter.class) + public enum AnyOrAllEnum { + ALL("ALL"), + + ANY("ANY"); + + private String value; + + AnyOrAllEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static AnyOrAllEnum fromValue(String text) { + for (AnyOrAllEnum b : AnyOrAllEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final AnyOrAllEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public AnyOrAllEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return AnyOrAllEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("anyOrAll") + private AnyOrAllEnum anyOrAll = null; + + /** + * Action to show/hide the form field is to be taken on the basis of evaluation of conditions. + */ + @JsonAdapter(ActionEnum.Adapter.class) + public enum ActionEnum { + SHOW("SHOW"), + + HIDE("HIDE"), + + DISABLE("DISABLE"), + + ENABLE("ENABLE"); + + private String value; + + ActionEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ActionEnum fromValue(String text) { + for (ActionEnum b : ActionEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ActionEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ActionEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ActionEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("action") + private ActionEnum action = null; + + public FormFieldConditionalAction predicates(List predicates) { + this.predicates = predicates; + return this; + } + + public FormFieldConditionalAction addPredicatesItem(FormFieldConditionPredicate predicatesItem) { + if (this.predicates == null) { + this.predicates = new ArrayList(); + } + this.predicates.add(predicatesItem); + return this; + } + + /** + * The predicates to be evaluated in order to determine whether this condition is true + * @return predicates + **/ + @ApiModelProperty(value = "The predicates to be evaluated in order to determine whether this condition is true") + public List getPredicates() { + return predicates; + } + + public void setPredicates(List predicates) { + this.predicates = predicates; + } + + public FormFieldConditionalAction anyOrAll(AnyOrAllEnum anyOrAll) { + this.anyOrAll = anyOrAll; + return this; + } + + /** + * It indicates if any one of the conditions or all of them have to be true. + * @return anyOrAll + **/ + @ApiModelProperty(value = "It indicates if any one of the conditions or all of them have to be true.") + public AnyOrAllEnum getAnyOrAll() { + return anyOrAll; + } + + public void setAnyOrAll(AnyOrAllEnum anyOrAll) { + this.anyOrAll = anyOrAll; + } + + public FormFieldConditionalAction action(ActionEnum action) { + this.action = action; + return this; + } + + /** + * Action to show/hide the form field is to be taken on the basis of evaluation of conditions. + * @return action + **/ + @ApiModelProperty(value = "Action to show/hide the form field is to be taken on the basis of evaluation of conditions.") + public ActionEnum getAction() { + return action; + } + + public void setAction(ActionEnum action) { + this.action = action; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FormFieldConditionalAction formFieldConditionalAction = (FormFieldConditionalAction) o; + return Objects.equals(this.predicates, formFieldConditionalAction.predicates) && + Objects.equals(this.anyOrAll, formFieldConditionalAction.anyOrAll) && + Objects.equals(this.action, formFieldConditionalAction.action); + } + + @Override + public int hashCode() { + return Objects.hash(predicates, anyOrAll, action); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FormFieldConditionalAction {\n"); + + sb.append(" predicates: ").append(toIndentedString(predicates)).append("\n"); + sb.append(" anyOrAll: ").append(toIndentedString(anyOrAll)).append("\n"); + sb.append(" action: ").append(toIndentedString(action)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/FormFieldHyperlink.java b/src/main/java/io/swagger/client/model/libraryDocuments/FormFieldHyperlink.java new file mode 100644 index 0000000..382c9eb --- /dev/null +++ b/src/main/java/io/swagger/client/model/libraryDocuments/FormFieldHyperlink.java @@ -0,0 +1,190 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.libraryDocuments; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.libraryDocuments.FormFieldLocation; +import java.io.IOException; + +/** + * Hyperlink-specific data for hyperlink form fields + */ +@ApiModel(description = "Hyperlink-specific data for hyperlink form fields") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") +public class FormFieldHyperlink { + /** + * Type of link in an agreement. + */ + @JsonAdapter(LinkTypeEnum.Adapter.class) + public enum LinkTypeEnum { + INTERNAL("INTERNAL"), + + EXTERNAL("EXTERNAL"), + + FROM_TEXT("FROM_TEXT"); + + private String value; + + LinkTypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static LinkTypeEnum fromValue(String text) { + for (LinkTypeEnum b : LinkTypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final LinkTypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public LinkTypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return LinkTypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("linkType") + private LinkTypeEnum linkType = null; + + @SerializedName("documentLocation") + private FormFieldLocation documentLocation = null; + + @SerializedName("url") + private String url = null; + + public FormFieldHyperlink linkType(LinkTypeEnum linkType) { + this.linkType = linkType; + return this; + } + + /** + * Type of link in an agreement. + * @return linkType + **/ + @ApiModelProperty(value = "Type of link in an agreement.") + public LinkTypeEnum getLinkType() { + return linkType; + } + + public void setLinkType(LinkTypeEnum linkType) { + this.linkType = linkType; + } + + public FormFieldHyperlink documentLocation(FormFieldLocation documentLocation) { + this.documentLocation = documentLocation; + return this; + } + + /** + * Location on the document pointed by the link in case of INTERNAL type link + * @return documentLocation + **/ + @ApiModelProperty(value = "Location on the document pointed by the link in case of INTERNAL type link") + public FormFieldLocation getDocumentLocation() { + return documentLocation; + } + + public void setDocumentLocation(FormFieldLocation documentLocation) { + this.documentLocation = documentLocation; + } + + public FormFieldHyperlink url(String url) { + this.url = url; + return this; + } + + /** + * URL, in case of EXTERNAL type link + * @return url + **/ + @ApiModelProperty(value = "URL, in case of EXTERNAL type link") + public String getUrl() { + return url; + } + + public void setUrl(String url) { + this.url = url; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FormFieldHyperlink formFieldHyperlink = (FormFieldHyperlink) o; + return Objects.equals(this.linkType, formFieldHyperlink.linkType) && + Objects.equals(this.documentLocation, formFieldHyperlink.documentLocation) && + Objects.equals(this.url, formFieldHyperlink.url); + } + + @Override + public int hashCode() { + return Objects.hash(linkType, documentLocation, url); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FormFieldHyperlink {\n"); + + sb.append(" linkType: ").append(toIndentedString(linkType)).append("\n"); + sb.append(" documentLocation: ").append(toIndentedString(documentLocation)).append("\n"); + sb.append(" url: ").append(toIndentedString(url)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/FormFieldLocation.java b/src/main/java/io/swagger/client/model/libraryDocuments/FormFieldLocation.java new file mode 100644 index 0000000..bd928bc --- /dev/null +++ b/src/main/java/io/swagger/client/model/libraryDocuments/FormFieldLocation.java @@ -0,0 +1,186 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.libraryDocuments; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Location information for form fields + */ +@ApiModel(description = "Location information for form fields") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") +public class FormFieldLocation { + @SerializedName("pageNumber") + private Integer pageNumber = null; + + @SerializedName("top") + private Double top = null; + + @SerializedName("left") + private Double left = null; + + @SerializedName("width") + private Double width = null; + + @SerializedName("height") + private Double height = null; + + public FormFieldLocation pageNumber(Integer pageNumber) { + this.pageNumber = pageNumber; + return this; + } + + /** + * Number of the page where form field has to be placed, starting from 1. + * @return pageNumber + **/ + @ApiModelProperty(value = "Number of the page where form field has to be placed, starting from 1.") + public Integer getPageNumber() { + return pageNumber; + } + + public void setPageNumber(Integer pageNumber) { + this.pageNumber = pageNumber; + } + + public FormFieldLocation top(Double top) { + this.top = top; + return this; + } + + /** + * No. of pixels from bottom of the page for form field placement + * @return top + **/ + @ApiModelProperty(value = "No. of pixels from bottom of the page for form field placement") + public Double getTop() { + return top; + } + + public void setTop(Double top) { + this.top = top; + } + + public FormFieldLocation left(Double left) { + this.left = left; + return this; + } + + /** + * No. of pixels from left of the page for form field placement + * @return left + **/ + @ApiModelProperty(value = "No. of pixels from left of the page for form field placement") + public Double getLeft() { + return left; + } + + public void setLeft(Double left) { + this.left = left; + } + + public FormFieldLocation width(Double width) { + this.width = width; + return this; + } + + /** + * Width of the form field in pixels + * @return width + **/ + @ApiModelProperty(value = "Width of the form field in pixels") + public Double getWidth() { + return width; + } + + public void setWidth(Double width) { + this.width = width; + } + + public FormFieldLocation height(Double height) { + this.height = height; + return this; + } + + /** + * Height of the form field in pixels + * @return height + **/ + @ApiModelProperty(value = "Height of the form field in pixels") + public Double getHeight() { + return height; + } + + public void setHeight(Double height) { + this.height = height; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FormFieldLocation formFieldLocation = (FormFieldLocation) o; + return Objects.equals(this.pageNumber, formFieldLocation.pageNumber) && + Objects.equals(this.top, formFieldLocation.top) && + Objects.equals(this.left, formFieldLocation.left) && + Objects.equals(this.width, formFieldLocation.width) && + Objects.equals(this.height, formFieldLocation.height); + } + + @Override + public int hashCode() { + return Objects.hash(pageNumber, top, left, width, height); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FormFieldLocation {\n"); + + sb.append(" pageNumber: ").append(toIndentedString(pageNumber)).append("\n"); + sb.append(" top: ").append(toIndentedString(top)).append("\n"); + sb.append(" left: ").append(toIndentedString(left)).append("\n"); + sb.append(" width: ").append(toIndentedString(width)).append("\n"); + sb.append(" height: ").append(toIndentedString(height)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/FormFieldPutInfo.java b/src/main/java/io/swagger/client/model/libraryDocuments/FormFieldPutInfo.java new file mode 100644 index 0000000..ce2e2d3 --- /dev/null +++ b/src/main/java/io/swagger/client/model/libraryDocuments/FormFieldPutInfo.java @@ -0,0 +1,105 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.libraryDocuments; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.libraryDocuments.FormField; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * Information required to add or replace agreement form fields + */ +@ApiModel(description = "Information required to add or replace agreement form fields") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") +public class FormFieldPutInfo { + @SerializedName("fields") + private List fields = null; + + public FormFieldPutInfo fields(List fields) { + this.fields = fields; + return this; + } + + public FormFieldPutInfo addFieldsItem(FormField fieldsItem) { + if (this.fields == null) { + this.fields = new ArrayList(); + } + this.fields.add(fieldsItem); + return this; + } + + /** + * The list of fields to update or replace. PDF_SIGNATURE inputType field is currently not supported. + * @return fields + **/ + @ApiModelProperty(value = "The list of fields to update or replace. PDF_SIGNATURE inputType field is currently not supported.") + public List getFields() { + return fields; + } + + public void setFields(List fields) { + this.fields = fields; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FormFieldPutInfo formFieldPutInfo = (FormFieldPutInfo) o; + return Objects.equals(this.fields, formFieldPutInfo.fields); + } + + @Override + public int hashCode() { + return Objects.hash(fields); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FormFieldPutInfo {\n"); + + sb.append(" fields: ").append(toIndentedString(fields)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/LibDocEventDeviceLocation.java b/src/main/java/io/swagger/client/model/libraryDocuments/LibDocEventDeviceLocation.java index 283de5d..1f4776a 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/LibDocEventDeviceLocation.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/LibDocEventDeviceLocation.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * LibDocEventDeviceLocation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class LibDocEventDeviceLocation { @SerializedName("latitude") private Float latitude = null; diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocument.java b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocument.java index 17e144f..2d00f38 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocument.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocument.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,25 +29,66 @@ /** * LibraryDocument */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class LibraryDocument { - @SerializedName("creatorEmail") - private String creatorEmail = null; + /** + * Gets or Sets templateTypes + */ + @JsonAdapter(TemplateTypesEnum.Adapter.class) + public enum TemplateTypesEnum { + DOCUMENT("DOCUMENT"), + + FORM_FIELD_LAYER("FORM_FIELD_LAYER"); - @SerializedName("id") - private String id = null; + private String value; + + TemplateTypesEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static TemplateTypesEnum fromValue(String text) { + for (TemplateTypesEnum b : TemplateTypesEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final TemplateTypesEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public TemplateTypesEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return TemplateTypesEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("templateTypes") + private List templateTypes = null; @SerializedName("hidden") private Boolean hidden = null; - @SerializedName("modifiedDate") - private Date modifiedDate = null; - - @SerializedName("name") - private String name = null; + @SerializedName("creatorEmail") + private String creatorEmail = null; /** - * Specifies who should have access to this library document. GLOBAL sharing mode is not applicable in POST/PUT requests + * Specifies who should have access to this library document. GLOBAL sharing is a restricted operation. */ @JsonAdapter(SharingModeEnum.Adapter.class) public enum SharingModeEnum { @@ -115,6 +141,18 @@ public SharingModeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("sharingMode") private SharingModeEnum sharingMode = null; + @SerializedName("groupId") + private String groupId = null; + + @SerializedName("modifiedDate") + private Date modifiedDate = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("id") + private String id = null; + /** * Status of the library document */ @@ -167,55 +205,49 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; - /** - * Gets or Sets templateTypes - */ - @JsonAdapter(TemplateTypesEnum.Adapter.class) - public enum TemplateTypesEnum { - DOCUMENT("DOCUMENT"), - - FORM_FIELD_LAYER("FORM_FIELD_LAYER"); - - private String value; - - TemplateTypesEnum(String value) { - this.value = value; - } + public LibraryDocument templateTypes(List templateTypes) { + this.templateTypes = templateTypes; + return this; + } - public String getValue() { - return value; + public LibraryDocument addTemplateTypesItem(TemplateTypesEnum templateTypesItem) { + if (this.templateTypes == null) { + this.templateTypes = new ArrayList(); } + this.templateTypes.add(templateTypesItem); + return this; + } - @Override - public String toString() { - return String.valueOf(value); - } + /** + * A list of one or more library template types + * @return templateTypes + **/ + @ApiModelProperty(value = "A list of one or more library template types") + public List getTemplateTypes() { + return templateTypes; + } - public static TemplateTypesEnum fromValue(String text) { - for (TemplateTypesEnum b : TemplateTypesEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } + public void setTemplateTypes(List templateTypes) { + this.templateTypes = templateTypes; + } - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final TemplateTypesEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } + public LibraryDocument hidden(Boolean hidden) { + this.hidden = hidden; + return this; + } - @Override - public TemplateTypesEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return TemplateTypesEnum.fromValue(String.valueOf(value)); - } - } + /** + * True if Library Document is hidden + * @return hidden + **/ + @ApiModelProperty(value = "True if Library Document is hidden") + public Boolean isHidden() { + return hidden; } - @SerializedName("templateTypes") - private List templateTypes = null; + public void setHidden(Boolean hidden) { + this.hidden = hidden; + } public LibraryDocument creatorEmail(String creatorEmail) { this.creatorEmail = creatorEmail; @@ -235,40 +267,40 @@ public void setCreatorEmail(String creatorEmail) { this.creatorEmail = creatorEmail; } - public LibraryDocument id(String id) { - this.id = id; + public LibraryDocument sharingMode(SharingModeEnum sharingMode) { + this.sharingMode = sharingMode; return this; } /** - * The unique identifier that is used to refer to the library template - * @return id + * Specifies who should have access to this library document. GLOBAL sharing is a restricted operation. + * @return sharingMode **/ - @ApiModelProperty(value = "The unique identifier that is used to refer to the library template") - public String getId() { - return id; + @ApiModelProperty(value = "Specifies who should have access to this library document. GLOBAL sharing is a restricted operation.") + public SharingModeEnum getSharingMode() { + return sharingMode; } - public void setId(String id) { - this.id = id; + public void setSharingMode(SharingModeEnum sharingMode) { + this.sharingMode = sharingMode; } - public LibraryDocument hidden(Boolean hidden) { - this.hidden = hidden; + public LibraryDocument groupId(String groupId) { + this.groupId = groupId; return this; } /** - * True if Library Document is hidden - * @return hidden + * The unique identifier of the group to which the library template belongs to. If not provided during creation, primary group of the creator will be used + * @return groupId **/ - @ApiModelProperty(value = "True if Library Document is hidden") - public Boolean isHidden() { - return hidden; + @ApiModelProperty(value = "The unique identifier of the group to which the library template belongs to. If not provided during creation, primary group of the creator will be used") + public String getGroupId() { + return groupId; } - public void setHidden(Boolean hidden) { - this.hidden = hidden; + public void setGroupId(String groupId) { + this.groupId = groupId; } public LibraryDocument modifiedDate(Date modifiedDate) { @@ -307,22 +339,22 @@ public void setName(String name) { this.name = name; } - public LibraryDocument sharingMode(SharingModeEnum sharingMode) { - this.sharingMode = sharingMode; + public LibraryDocument id(String id) { + this.id = id; return this; } /** - * Specifies who should have access to this library document. GLOBAL sharing mode is not applicable in POST/PUT requests - * @return sharingMode + * The unique identifier that is used to refer to the library template + * @return id **/ - @ApiModelProperty(value = "Specifies who should have access to this library document. GLOBAL sharing mode is not applicable in POST/PUT requests") - public SharingModeEnum getSharingMode() { - return sharingMode; + @ApiModelProperty(value = "The unique identifier that is used to refer to the library template") + public String getId() { + return id; } - public void setSharingMode(SharingModeEnum sharingMode) { - this.sharingMode = sharingMode; + public void setId(String id) { + this.id = id; } public LibraryDocument status(StatusEnum status) { @@ -343,32 +375,6 @@ public void setStatus(StatusEnum status) { this.status = status; } - public LibraryDocument templateTypes(List templateTypes) { - this.templateTypes = templateTypes; - return this; - } - - public LibraryDocument addTemplateTypesItem(TemplateTypesEnum templateTypesItem) { - if (this.templateTypes == null) { - this.templateTypes = new ArrayList(); - } - this.templateTypes.add(templateTypesItem); - return this; - } - - /** - * A list of one or more library template types - * @return templateTypes - **/ - @ApiModelProperty(value = "A list of one or more library template types") - public List getTemplateTypes() { - return templateTypes; - } - - public void setTemplateTypes(List templateTypes) { - this.templateTypes = templateTypes; - } - @Override public boolean equals(java.lang.Object o) { @@ -379,19 +385,20 @@ public boolean equals(java.lang.Object o) { return false; } LibraryDocument libraryDocument = (LibraryDocument) o; - return Objects.equals(this.creatorEmail, libraryDocument.creatorEmail) && - Objects.equals(this.id, libraryDocument.id) && + return Objects.equals(this.templateTypes, libraryDocument.templateTypes) && Objects.equals(this.hidden, libraryDocument.hidden) && + Objects.equals(this.creatorEmail, libraryDocument.creatorEmail) && + Objects.equals(this.sharingMode, libraryDocument.sharingMode) && + Objects.equals(this.groupId, libraryDocument.groupId) && Objects.equals(this.modifiedDate, libraryDocument.modifiedDate) && Objects.equals(this.name, libraryDocument.name) && - Objects.equals(this.sharingMode, libraryDocument.sharingMode) && - Objects.equals(this.status, libraryDocument.status) && - Objects.equals(this.templateTypes, libraryDocument.templateTypes); + Objects.equals(this.id, libraryDocument.id) && + Objects.equals(this.status, libraryDocument.status); } @Override public int hashCode() { - return Objects.hash(creatorEmail, id, hidden, modifiedDate, name, sharingMode, status, templateTypes); + return Objects.hash(templateTypes, hidden, creatorEmail, sharingMode, groupId, modifiedDate, name, id, status); } @@ -400,14 +407,15 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class LibraryDocument {\n"); - sb.append(" creatorEmail: ").append(toIndentedString(creatorEmail)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" templateTypes: ").append(toIndentedString(templateTypes)).append("\n"); sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); + sb.append(" creatorEmail: ").append(toIndentedString(creatorEmail)).append("\n"); + sb.append(" sharingMode: ").append(toIndentedString(sharingMode)).append("\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); sb.append(" modifiedDate: ").append(toIndentedString(modifiedDate)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" sharingMode: ").append(toIndentedString(sharingMode)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" templateTypes: ").append(toIndentedString(templateTypes)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentCreationInfoV6.java b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentCreationInfoV6.java index 7f56050..3714cc2 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentCreationInfoV6.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentCreationInfoV6.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,31 +30,13 @@ /** * LibraryDocumentCreationInfoV6 */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class LibraryDocumentCreationInfoV6 { - @SerializedName("createdDate") - private Date createdDate = null; - @SerializedName("creatorEmail") private String creatorEmail = null; - @SerializedName("creatorName") - private String creatorName = null; - - @SerializedName("fileInfos") - private List fileInfos = null; - - @SerializedName("id") - private String id = null; - - @SerializedName("modifiedDate") - private Date modifiedDate = null; - - @SerializedName("name") - private String name = null; - /** - * Specifies who should have access to this library document. GLOBAL sharing mode is not applicable in POST/PUT requests + * Specifies who should have access to this library document. GLOBAL sharing is a restricted operation. */ @JsonAdapter(SharingModeEnum.Adapter.class) public enum SharingModeEnum { @@ -122,18 +89,30 @@ public SharingModeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("sharingMode") private SharingModeEnum sharingMode = null; + @SerializedName("groupId") + private String groupId = null; + + @SerializedName("creatorName") + private String creatorName = null; + + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("isDocumentRetentionApplied") + private Boolean isDocumentRetentionApplied = null; + /** - * State of the library document. + * Gets or Sets templateTypes */ - @JsonAdapter(StateEnum.Adapter.class) - public enum StateEnum { - AUTHORING("AUTHORING"), + @JsonAdapter(TemplateTypesEnum.Adapter.class) + public enum TemplateTypesEnum { + DOCUMENT("DOCUMENT"), - ACTIVE("ACTIVE"); + FORM_FIELD_LAYER("FORM_FIELD_LAYER"); private String value; - StateEnum(String value) { + TemplateTypesEnum(String value) { this.value = value; } @@ -146,8 +125,8 @@ public String toString() { return String.valueOf(value); } - public static StateEnum fromValue(String text) { - for (StateEnum b : StateEnum.values()) { + public static TemplateTypesEnum fromValue(String text) { + for (TemplateTypesEnum b : TemplateTypesEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -155,37 +134,50 @@ public static StateEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final TemplateTypesEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public StateEnum read(final JsonReader jsonReader) throws IOException { + public TemplateTypesEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return StateEnum.fromValue(String.valueOf(value)); + return TemplateTypesEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("state") - private StateEnum state = null; + @SerializedName("templateTypes") + private List templateTypes = null; + + @SerializedName("lastEventDate") + private Date lastEventDate = null; + + @SerializedName("modifiedDate") + private Date modifiedDate = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("fileInfos") + private List fileInfos = null; + + @SerializedName("id") + private String id = null; /** - * Status of the library document + * State of the library document. */ - @JsonAdapter(StatusEnum.Adapter.class) - public enum StatusEnum { + @JsonAdapter(StateEnum.Adapter.class) + public enum StateEnum { AUTHORING("AUTHORING"), - ACTIVE("ACTIVE"), - - REMOVED("REMOVED"); + ACTIVE("ACTIVE"); private String value; - StatusEnum(String value) { + StateEnum(String value) { this.value = value; } @@ -198,8 +190,8 @@ public String toString() { return String.valueOf(value); } - public static StatusEnum fromValue(String text) { - for (StatusEnum b : StatusEnum.values()) { + public static StateEnum fromValue(String text) { + for (StateEnum b : StateEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -207,35 +199,37 @@ public static StatusEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public StatusEnum read(final JsonReader jsonReader) throws IOException { + public StateEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return StatusEnum.fromValue(String.valueOf(value)); + return StateEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("status") - private StatusEnum status = null; + @SerializedName("state") + private StateEnum state = null; /** - * Gets or Sets templateTypes + * Status of the library document */ - @JsonAdapter(TemplateTypesEnum.Adapter.class) - public enum TemplateTypesEnum { - DOCUMENT("DOCUMENT"), + @JsonAdapter(StatusEnum.Adapter.class) + public enum StatusEnum { + AUTHORING("AUTHORING"), - FORM_FIELD_LAYER("FORM_FIELD_LAYER"); + ACTIVE("ACTIVE"), + + REMOVED("REMOVED"); private String value; - TemplateTypesEnum(String value) { + StatusEnum(String value) { this.value = value; } @@ -248,8 +242,8 @@ public String toString() { return String.valueOf(value); } - public static TemplateTypesEnum fromValue(String text) { - for (TemplateTypesEnum b : TemplateTypesEnum.values()) { + public static StatusEnum fromValue(String text) { + for (StatusEnum b : StatusEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -257,40 +251,22 @@ public static TemplateTypesEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final TemplateTypesEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public TemplateTypesEnum read(final JsonReader jsonReader) throws IOException { + public StatusEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return TemplateTypesEnum.fromValue(String.valueOf(value)); + return StatusEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("templateTypes") - private List templateTypes = null; - - public LibraryDocumentCreationInfoV6 createdDate(Date createdDate) { - this.createdDate = createdDate; - return this; - } - - /** - * Date when library document was created. It will be ignored in POST/PUT requests. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time - * @return createdDate - **/ - @ApiModelProperty(value = "Date when library document was created. It will be ignored in POST/PUT requests. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") - public Date getCreatedDate() { - return createdDate; - } - - public void setCreatedDate(Date createdDate) { - this.createdDate = createdDate; - } + @SerializedName("status") + private StatusEnum status = null; public LibraryDocumentCreationInfoV6 creatorEmail(String creatorEmail) { this.creatorEmail = creatorEmail; @@ -310,6 +286,42 @@ public void setCreatorEmail(String creatorEmail) { this.creatorEmail = creatorEmail; } + public LibraryDocumentCreationInfoV6 sharingMode(SharingModeEnum sharingMode) { + this.sharingMode = sharingMode; + return this; + } + + /** + * Specifies who should have access to this library document. GLOBAL sharing is a restricted operation. + * @return sharingMode + **/ + @ApiModelProperty(value = "Specifies who should have access to this library document. GLOBAL sharing is a restricted operation.") + public SharingModeEnum getSharingMode() { + return sharingMode; + } + + public void setSharingMode(SharingModeEnum sharingMode) { + this.sharingMode = sharingMode; + } + + public LibraryDocumentCreationInfoV6 groupId(String groupId) { + this.groupId = groupId; + return this; + } + + /** + * The unique identifier of the group to which the library template belongs to. If not provided during creation, primary group of the creator will be used + * @return groupId + **/ + @ApiModelProperty(value = "The unique identifier of the group to which the library template belongs to. If not provided during creation, primary group of the creator will be used") + public String getGroupId() { + return groupId; + } + + public void setGroupId(String groupId) { + this.groupId = groupId; + } + public LibraryDocumentCreationInfoV6 creatorName(String creatorName) { this.creatorName = creatorName; return this; @@ -328,48 +340,84 @@ public void setCreatorName(String creatorName) { this.creatorName = creatorName; } - public LibraryDocumentCreationInfoV6 fileInfos(List fileInfos) { - this.fileInfos = fileInfos; + public LibraryDocumentCreationInfoV6 createdDate(Date createdDate) { + this.createdDate = createdDate; return this; } - public LibraryDocumentCreationInfoV6 addFileInfosItem(FileInfo fileInfosItem) { - if (this.fileInfos == null) { - this.fileInfos = new ArrayList(); + /** + * Date when library document was created. It will be ignored in POST/PUT requests. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return createdDate + **/ + @ApiModelProperty(value = "Date when library document was created. It will be ignored in POST/PUT requests. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getCreatedDate() { + return createdDate; + } + + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } + + public LibraryDocumentCreationInfoV6 isDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; + return this; + } + + /** + * Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. + * @return isDocumentRetentionApplied + **/ + @ApiModelProperty(value = "Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored.") + public Boolean isIsDocumentRetentionApplied() { + return isDocumentRetentionApplied; + } + + public void setIsDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; + } + + public LibraryDocumentCreationInfoV6 templateTypes(List templateTypes) { + this.templateTypes = templateTypes; + return this; + } + + public LibraryDocumentCreationInfoV6 addTemplateTypesItem(TemplateTypesEnum templateTypesItem) { + if (this.templateTypes == null) { + this.templateTypes = new ArrayList(); } - this.fileInfos.add(fileInfosItem); + this.templateTypes.add(templateTypesItem); return this; } /** - * A list of one or more files (or references to files) that will be used to create the template. If more than one file is provided, they will be combined into one PDF. Note: Only a single parameter in every FileInfo object must be specified - * @return fileInfos + * A list of one or more library template types + * @return templateTypes **/ - @ApiModelProperty(value = "A list of one or more files (or references to files) that will be used to create the template. If more than one file is provided, they will be combined into one PDF. Note: Only a single parameter in every FileInfo object must be specified") - public List getFileInfos() { - return fileInfos; + @ApiModelProperty(value = "A list of one or more library template types") + public List getTemplateTypes() { + return templateTypes; } - public void setFileInfos(List fileInfos) { - this.fileInfos = fileInfos; + public void setTemplateTypes(List templateTypes) { + this.templateTypes = templateTypes; } - public LibraryDocumentCreationInfoV6 id(String id) { - this.id = id; + public LibraryDocumentCreationInfoV6 lastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; return this; } /** - * The unique identifier that is used to refer to the library template. It will be ignored in POST requests - * @return id + * The date of the last event that occurred for this library document + * @return lastEventDate **/ - @ApiModelProperty(value = "The unique identifier that is used to refer to the library template. It will be ignored in POST requests") - public String getId() { - return id; + @ApiModelProperty(value = "The date of the last event that occurred for this library document") + public Date getLastEventDate() { + return lastEventDate; } - public void setId(String id) { - this.id = id; + public void setLastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; } public LibraryDocumentCreationInfoV6 modifiedDate(Date modifiedDate) { @@ -408,22 +456,48 @@ public void setName(String name) { this.name = name; } - public LibraryDocumentCreationInfoV6 sharingMode(SharingModeEnum sharingMode) { - this.sharingMode = sharingMode; + public LibraryDocumentCreationInfoV6 fileInfos(List fileInfos) { + this.fileInfos = fileInfos; + return this; + } + + public LibraryDocumentCreationInfoV6 addFileInfosItem(FileInfo fileInfosItem) { + if (this.fileInfos == null) { + this.fileInfos = new ArrayList(); + } + this.fileInfos.add(fileInfosItem); return this; } /** - * Specifies who should have access to this library document. GLOBAL sharing mode is not applicable in POST/PUT requests - * @return sharingMode + * A list of one or more files (or references to files) that will be used to create the template. If more than one file is provided, they will be combined into one PDF. Note: Only a single parameter in every FileInfo object must be specified + * @return fileInfos **/ - @ApiModelProperty(value = "Specifies who should have access to this library document. GLOBAL sharing mode is not applicable in POST/PUT requests") - public SharingModeEnum getSharingMode() { - return sharingMode; + @ApiModelProperty(value = "A list of one or more files (or references to files) that will be used to create the template. If more than one file is provided, they will be combined into one PDF. Note: Only a single parameter in every FileInfo object must be specified") + public List getFileInfos() { + return fileInfos; } - public void setSharingMode(SharingModeEnum sharingMode) { - this.sharingMode = sharingMode; + public void setFileInfos(List fileInfos) { + this.fileInfos = fileInfos; + } + + public LibraryDocumentCreationInfoV6 id(String id) { + this.id = id; + return this; + } + + /** + * The unique identifier that is used to refer to the library template. It will be ignored in POST requests + * @return id + **/ + @ApiModelProperty(value = "The unique identifier that is used to refer to the library template. It will be ignored in POST requests") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; } public LibraryDocumentCreationInfoV6 state(StateEnum state) { @@ -462,32 +536,6 @@ public void setStatus(StatusEnum status) { this.status = status; } - public LibraryDocumentCreationInfoV6 templateTypes(List templateTypes) { - this.templateTypes = templateTypes; - return this; - } - - public LibraryDocumentCreationInfoV6 addTemplateTypesItem(TemplateTypesEnum templateTypesItem) { - if (this.templateTypes == null) { - this.templateTypes = new ArrayList(); - } - this.templateTypes.add(templateTypesItem); - return this; - } - - /** - * A list of one or more library template types - * @return templateTypes - **/ - @ApiModelProperty(value = "A list of one or more library template types") - public List getTemplateTypes() { - return templateTypes; - } - - public void setTemplateTypes(List templateTypes) { - this.templateTypes = templateTypes; - } - @Override public boolean equals(java.lang.Object o) { @@ -498,22 +546,25 @@ public boolean equals(java.lang.Object o) { return false; } LibraryDocumentCreationInfoV6 libraryDocumentCreationInfoV6 = (LibraryDocumentCreationInfoV6) o; - return Objects.equals(this.createdDate, libraryDocumentCreationInfoV6.createdDate) && - Objects.equals(this.creatorEmail, libraryDocumentCreationInfoV6.creatorEmail) && + return Objects.equals(this.creatorEmail, libraryDocumentCreationInfoV6.creatorEmail) && + Objects.equals(this.sharingMode, libraryDocumentCreationInfoV6.sharingMode) && + Objects.equals(this.groupId, libraryDocumentCreationInfoV6.groupId) && Objects.equals(this.creatorName, libraryDocumentCreationInfoV6.creatorName) && - Objects.equals(this.fileInfos, libraryDocumentCreationInfoV6.fileInfos) && - Objects.equals(this.id, libraryDocumentCreationInfoV6.id) && + Objects.equals(this.createdDate, libraryDocumentCreationInfoV6.createdDate) && + Objects.equals(this.isDocumentRetentionApplied, libraryDocumentCreationInfoV6.isDocumentRetentionApplied) && + Objects.equals(this.templateTypes, libraryDocumentCreationInfoV6.templateTypes) && + Objects.equals(this.lastEventDate, libraryDocumentCreationInfoV6.lastEventDate) && Objects.equals(this.modifiedDate, libraryDocumentCreationInfoV6.modifiedDate) && Objects.equals(this.name, libraryDocumentCreationInfoV6.name) && - Objects.equals(this.sharingMode, libraryDocumentCreationInfoV6.sharingMode) && + Objects.equals(this.fileInfos, libraryDocumentCreationInfoV6.fileInfos) && + Objects.equals(this.id, libraryDocumentCreationInfoV6.id) && Objects.equals(this.state, libraryDocumentCreationInfoV6.state) && - Objects.equals(this.status, libraryDocumentCreationInfoV6.status) && - Objects.equals(this.templateTypes, libraryDocumentCreationInfoV6.templateTypes); + Objects.equals(this.status, libraryDocumentCreationInfoV6.status); } @Override public int hashCode() { - return Objects.hash(createdDate, creatorEmail, creatorName, fileInfos, id, modifiedDate, name, sharingMode, state, status, templateTypes); + return Objects.hash(creatorEmail, sharingMode, groupId, creatorName, createdDate, isDocumentRetentionApplied, templateTypes, lastEventDate, modifiedDate, name, fileInfos, id, state, status); } @@ -522,17 +573,20 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class LibraryDocumentCreationInfoV6 {\n"); - sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); sb.append(" creatorEmail: ").append(toIndentedString(creatorEmail)).append("\n"); + sb.append(" sharingMode: ").append(toIndentedString(sharingMode)).append("\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); sb.append(" creatorName: ").append(toIndentedString(creatorName)).append("\n"); - sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" isDocumentRetentionApplied: ").append(toIndentedString(isDocumentRetentionApplied)).append("\n"); + sb.append(" templateTypes: ").append(toIndentedString(templateTypes)).append("\n"); + sb.append(" lastEventDate: ").append(toIndentedString(lastEventDate)).append("\n"); sb.append(" modifiedDate: ").append(toIndentedString(modifiedDate)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" sharingMode: ").append(toIndentedString(sharingMode)).append("\n"); + sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" state: ").append(toIndentedString(state)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" templateTypes: ").append(toIndentedString(templateTypes)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentCreationResponse.java b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentCreationResponse.java index d23508a..074a573 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentCreationResponse.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentCreationResponse.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,7 @@ * A JSON object describing the library template */ @ApiModel(description = "A JSON object describing the library template") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class LibraryDocumentCreationResponse { @SerializedName("id") private String id = null; diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentEvent.java b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentEvent.java index f9376aa..d0559ff 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentEvent.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentEvent.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,46 +29,79 @@ /** * LibraryDocumentEvent */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class LibraryDocumentEvent { - @SerializedName("actingUserEmail") - private String actingUserEmail = null; + @SerializedName("date") + private Date date = null; - @SerializedName("actingUserIpAddress") - private String actingUserIpAddress = null; + @SerializedName("initiatingUserName") + private String initiatingUserName = null; + + @SerializedName("description") + private String description = null; @SerializedName("actingUserName") private String actingUserName = null; - @SerializedName("comment") - private String comment = null; + @SerializedName("actingUserIpAddress") + private String actingUserIpAddress = null; - @SerializedName("date") - private Date date = null; + @SerializedName("participantEmail") + private String participantEmail = null; - @SerializedName("description") - private String description = null; + /** + * Type of library document event + */ + @JsonAdapter(TypeEnum.Adapter.class) + public enum TypeEnum { + AUTO_CANCELLED_CONVERSION_PROBLEM("AUTO_CANCELLED_CONVERSION_PROBLEM"), + + CREATED("CREATED"), + + MODIFIED("MODIFIED"), + + DOCUMENTS_DELETED("DOCUMENTS_DELETED"); - @SerializedName("deviceLocation") - private LibDocEventDeviceLocation deviceLocation = null; + private String value; - @SerializedName("devicePhoneNumber") - private String devicePhoneNumber = null; + TypeEnum(String value) { + this.value = value; + } - @SerializedName("digitalSignatureInfo") - private DigitalSignatureInfo digitalSignatureInfo = null; + public String getValue() { + return value; + } - @SerializedName("initiatingUserEmail") - private String initiatingUserEmail = null; + @Override + public String toString() { + return String.valueOf(value); + } - @SerializedName("initiatingUserName") - private String initiatingUserName = null; + public static TypeEnum fromValue(String text) { + for (TypeEnum b : TypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } - @SerializedName("participantEmail") - private String participantEmail = null; + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } - @SerializedName("participantId") - private String participantId = null; + @Override + public TypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return TypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("type") + private TypeEnum type = null; /** * Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). @@ -155,106 +173,94 @@ public ParticipantRoleEnum read(final JsonReader jsonReader) throws IOException @SerializedName("participantRole") private ParticipantRoleEnum participantRole = null; - @SerializedName("synchronizationId") - private String synchronizationId = null; + @SerializedName("vaultEventId") + private String vaultEventId = null; - /** - * Type of library document event - */ - @JsonAdapter(TypeEnum.Adapter.class) - public enum TypeEnum { - AUTO_CANCELLED_CONVERSION_PROBLEM("AUTO_CANCELLED_CONVERSION_PROBLEM"), - - CREATED("CREATED"), - - MODIFIED("MODIFIED"), - - DOCUMENTS_DELETED("DOCUMENTS_DELETED"); + @SerializedName("participantId") + private String participantId = null; - private String value; + @SerializedName("versionId") + private String versionId = null; - TypeEnum(String value) { - this.value = value; - } + @SerializedName("actingUserEmail") + private String actingUserEmail = null; - public String getValue() { - return value; - } + @SerializedName("devicePhoneNumber") + private String devicePhoneNumber = null; - @Override - public String toString() { - return String.valueOf(value); - } + @SerializedName("initiatingUserEmail") + private String initiatingUserEmail = null; - public static TypeEnum fromValue(String text) { - for (TypeEnum b : TypeEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } + @SerializedName("digitalSignatureInfo") + private DigitalSignatureInfo digitalSignatureInfo = null; - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } + @SerializedName("vaultProviderName") + private String vaultProviderName = null; - @Override - public TypeEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return TypeEnum.fromValue(String.valueOf(value)); - } - } - } + @SerializedName("comment") + private String comment = null; - @SerializedName("type") - private TypeEnum type = null; + @SerializedName("id") + private String id = null; - @SerializedName("vaultEventId") - private String vaultEventId = null; + @SerializedName("synchronizationId") + private String synchronizationId = null; - @SerializedName("vaultProviderName") - private String vaultProviderName = null; + @SerializedName("deviceLocation") + private LibDocEventDeviceLocation deviceLocation = null; - @SerializedName("versionId") - private String versionId = null; + public LibraryDocumentEvent date(Date date) { + this.date = date; + return this; + } - public LibraryDocumentEvent actingUserEmail(String actingUserEmail) { - this.actingUserEmail = actingUserEmail; + /** + * The date of the audit event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return date + **/ + @ApiModelProperty(value = "The date of the audit event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getDate() { + return date; + } + + public void setDate(Date date) { + this.date = date; + } + + public LibraryDocumentEvent initiatingUserName(String initiatingUserName) { + this.initiatingUserName = initiatingUserName; return this; } /** - * Email address of the user that created the event - * @return actingUserEmail + * Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect + * @return initiatingUserName **/ - @ApiModelProperty(value = "Email address of the user that created the event") - public String getActingUserEmail() { - return actingUserEmail; + @ApiModelProperty(value = "Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect") + public String getInitiatingUserName() { + return initiatingUserName; } - public void setActingUserEmail(String actingUserEmail) { - this.actingUserEmail = actingUserEmail; + public void setInitiatingUserName(String initiatingUserName) { + this.initiatingUserName = initiatingUserName; } - public LibraryDocumentEvent actingUserIpAddress(String actingUserIpAddress) { - this.actingUserIpAddress = actingUserIpAddress; + public LibraryDocumentEvent description(String description) { + this.description = description; return this; } /** - * The IP address of the user that created the event - * @return actingUserIpAddress + * A description of the audit event + * @return description **/ - @ApiModelProperty(value = "The IP address of the user that created the event") - public String getActingUserIpAddress() { - return actingUserIpAddress; + @ApiModelProperty(value = "A description of the audit event") + public String getDescription() { + return description; } - public void setActingUserIpAddress(String actingUserIpAddress) { - this.actingUserIpAddress = actingUserIpAddress; + public void setDescription(String description) { + this.description = description; } public LibraryDocumentEvent actingUserName(String actingUserName) { @@ -275,292 +281,292 @@ public void setActingUserName(String actingUserName) { this.actingUserName = actingUserName; } - public LibraryDocumentEvent comment(String comment) { - this.comment = comment; + public LibraryDocumentEvent actingUserIpAddress(String actingUserIpAddress) { + this.actingUserIpAddress = actingUserIpAddress; return this; } /** - * The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant - * @return comment + * The IP address of the user that created the event + * @return actingUserIpAddress **/ - @ApiModelProperty(value = "The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant") - public String getComment() { - return comment; + @ApiModelProperty(value = "The IP address of the user that created the event") + public String getActingUserIpAddress() { + return actingUserIpAddress; } - public void setComment(String comment) { - this.comment = comment; + public void setActingUserIpAddress(String actingUserIpAddress) { + this.actingUserIpAddress = actingUserIpAddress; } - public LibraryDocumentEvent date(Date date) { - this.date = date; + public LibraryDocumentEvent participantEmail(String participantEmail) { + this.participantEmail = participantEmail; return this; } /** - * The date of the audit event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time - * @return date + * Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to + * @return participantEmail **/ - @ApiModelProperty(value = "The date of the audit event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") - public Date getDate() { - return date; + @ApiModelProperty(value = "Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to") + public String getParticipantEmail() { + return participantEmail; } - public void setDate(Date date) { - this.date = date; + public void setParticipantEmail(String participantEmail) { + this.participantEmail = participantEmail; } - public LibraryDocumentEvent description(String description) { - this.description = description; + public LibraryDocumentEvent type(TypeEnum type) { + this.type = type; return this; } /** - * A description of the audit event - * @return description + * Type of library document event + * @return type **/ - @ApiModelProperty(value = "A description of the audit event") - public String getDescription() { - return description; + @ApiModelProperty(value = "Type of library document event") + public TypeEnum getType() { + return type; } - public void setDescription(String description) { - this.description = description; + public void setType(TypeEnum type) { + this.type = type; } - public LibraryDocumentEvent deviceLocation(LibDocEventDeviceLocation deviceLocation) { - this.deviceLocation = deviceLocation; + public LibraryDocumentEvent participantRole(ParticipantRoleEnum participantRole) { + this.participantRole = participantRole; return this; } /** - * Location of the device that generated the event (This value may be null due to limited privileges) - * @return deviceLocation + * Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). + * @return participantRole **/ - @ApiModelProperty(value = "Location of the device that generated the event (This value may be null due to limited privileges)") - public LibDocEventDeviceLocation getDeviceLocation() { - return deviceLocation; + @ApiModelProperty(value = "Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.).") + public ParticipantRoleEnum getParticipantRole() { + return participantRole; } - public void setDeviceLocation(LibDocEventDeviceLocation deviceLocation) { - this.deviceLocation = deviceLocation; + public void setParticipantRole(ParticipantRoleEnum participantRole) { + this.participantRole = participantRole; } - public LibraryDocumentEvent devicePhoneNumber(String devicePhoneNumber) { - this.devicePhoneNumber = devicePhoneNumber; + public LibraryDocumentEvent vaultEventId(String vaultEventId) { + this.vaultEventId = vaultEventId; return this; } /** - * Phone number from the device used when the participation is completed on a mobile phone - * @return devicePhoneNumber + * The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null) + * @return vaultEventId **/ - @ApiModelProperty(value = "Phone number from the device used when the participation is completed on a mobile phone") - public String getDevicePhoneNumber() { - return devicePhoneNumber; + @ApiModelProperty(value = "The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null)") + public String getVaultEventId() { + return vaultEventId; } - public void setDevicePhoneNumber(String devicePhoneNumber) { - this.devicePhoneNumber = devicePhoneNumber; + public void setVaultEventId(String vaultEventId) { + this.vaultEventId = vaultEventId; } - public LibraryDocumentEvent digitalSignatureInfo(DigitalSignatureInfo digitalSignatureInfo) { - this.digitalSignatureInfo = digitalSignatureInfo; + public LibraryDocumentEvent participantId(String participantId) { + this.participantId = participantId; return this; } /** - * This is present for ESIGNED events when the participation is signed digitally - * @return digitalSignatureInfo + * The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to + * @return participantId **/ - @ApiModelProperty(value = "This is present for ESIGNED events when the participation is signed digitally") - public DigitalSignatureInfo getDigitalSignatureInfo() { - return digitalSignatureInfo; + @ApiModelProperty(value = "The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to") + public String getParticipantId() { + return participantId; } - public void setDigitalSignatureInfo(DigitalSignatureInfo digitalSignatureInfo) { - this.digitalSignatureInfo = digitalSignatureInfo; + public void setParticipantId(String participantId) { + this.participantId = participantId; } - public LibraryDocumentEvent initiatingUserEmail(String initiatingUserEmail) { - this.initiatingUserEmail = initiatingUserEmail; + public LibraryDocumentEvent versionId(String versionId) { + this.versionId = versionId; return this; } /** - * Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect - * @return initiatingUserEmail + * An ID which uniquely identifies the version of the document associated with this audit event + * @return versionId **/ - @ApiModelProperty(value = "Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect") - public String getInitiatingUserEmail() { - return initiatingUserEmail; + @ApiModelProperty(value = "An ID which uniquely identifies the version of the document associated with this audit event") + public String getVersionId() { + return versionId; } - public void setInitiatingUserEmail(String initiatingUserEmail) { - this.initiatingUserEmail = initiatingUserEmail; + public void setVersionId(String versionId) { + this.versionId = versionId; } - public LibraryDocumentEvent initiatingUserName(String initiatingUserName) { - this.initiatingUserName = initiatingUserName; + public LibraryDocumentEvent actingUserEmail(String actingUserEmail) { + this.actingUserEmail = actingUserEmail; return this; } /** - * Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect - * @return initiatingUserName + * Email address of the user that created the event + * @return actingUserEmail **/ - @ApiModelProperty(value = "Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect") - public String getInitiatingUserName() { - return initiatingUserName; + @ApiModelProperty(value = "Email address of the user that created the event") + public String getActingUserEmail() { + return actingUserEmail; } - public void setInitiatingUserName(String initiatingUserName) { - this.initiatingUserName = initiatingUserName; + public void setActingUserEmail(String actingUserEmail) { + this.actingUserEmail = actingUserEmail; } - public LibraryDocumentEvent participantEmail(String participantEmail) { - this.participantEmail = participantEmail; + public LibraryDocumentEvent devicePhoneNumber(String devicePhoneNumber) { + this.devicePhoneNumber = devicePhoneNumber; return this; } /** - * Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to - * @return participantEmail + * Phone number from the device used when the participation is completed on a mobile phone + * @return devicePhoneNumber **/ - @ApiModelProperty(value = "Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to") - public String getParticipantEmail() { - return participantEmail; + @ApiModelProperty(value = "Phone number from the device used when the participation is completed on a mobile phone") + public String getDevicePhoneNumber() { + return devicePhoneNumber; } - public void setParticipantEmail(String participantEmail) { - this.participantEmail = participantEmail; + public void setDevicePhoneNumber(String devicePhoneNumber) { + this.devicePhoneNumber = devicePhoneNumber; } - public LibraryDocumentEvent participantId(String participantId) { - this.participantId = participantId; + public LibraryDocumentEvent initiatingUserEmail(String initiatingUserEmail) { + this.initiatingUserEmail = initiatingUserEmail; return this; } /** - * The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to - * @return participantId + * Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect + * @return initiatingUserEmail **/ - @ApiModelProperty(value = "The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to") - public String getParticipantId() { - return participantId; + @ApiModelProperty(value = "Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect") + public String getInitiatingUserEmail() { + return initiatingUserEmail; } - public void setParticipantId(String participantId) { - this.participantId = participantId; + public void setInitiatingUserEmail(String initiatingUserEmail) { + this.initiatingUserEmail = initiatingUserEmail; } - public LibraryDocumentEvent participantRole(ParticipantRoleEnum participantRole) { - this.participantRole = participantRole; + public LibraryDocumentEvent digitalSignatureInfo(DigitalSignatureInfo digitalSignatureInfo) { + this.digitalSignatureInfo = digitalSignatureInfo; return this; } /** - * Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). - * @return participantRole + * This is present for ESIGNED events when the participation is signed digitally + * @return digitalSignatureInfo **/ - @ApiModelProperty(value = "Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.).") - public ParticipantRoleEnum getParticipantRole() { - return participantRole; + @ApiModelProperty(value = "This is present for ESIGNED events when the participation is signed digitally") + public DigitalSignatureInfo getDigitalSignatureInfo() { + return digitalSignatureInfo; } - public void setParticipantRole(ParticipantRoleEnum participantRole) { - this.participantRole = participantRole; + public void setDigitalSignatureInfo(DigitalSignatureInfo digitalSignatureInfo) { + this.digitalSignatureInfo = digitalSignatureInfo; } - public LibraryDocumentEvent synchronizationId(String synchronizationId) { - this.synchronizationId = synchronizationId; + public LibraryDocumentEvent vaultProviderName(String vaultProviderName) { + this.vaultProviderName = vaultProviderName; return this; } /** - * A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null) - * @return synchronizationId + * Name of the vault provider for the vault event (if vaulted, otherwise null) + * @return vaultProviderName **/ - @ApiModelProperty(value = "A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null)") - public String getSynchronizationId() { - return synchronizationId; + @ApiModelProperty(value = "Name of the vault provider for the vault event (if vaulted, otherwise null)") + public String getVaultProviderName() { + return vaultProviderName; } - public void setSynchronizationId(String synchronizationId) { - this.synchronizationId = synchronizationId; + public void setVaultProviderName(String vaultProviderName) { + this.vaultProviderName = vaultProviderName; } - public LibraryDocumentEvent type(TypeEnum type) { - this.type = type; + public LibraryDocumentEvent comment(String comment) { + this.comment = comment; return this; } /** - * Type of library document event - * @return type + * The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant + * @return comment **/ - @ApiModelProperty(value = "Type of library document event") - public TypeEnum getType() { - return type; + @ApiModelProperty(value = "The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant") + public String getComment() { + return comment; } - public void setType(TypeEnum type) { - this.type = type; + public void setComment(String comment) { + this.comment = comment; } - public LibraryDocumentEvent vaultEventId(String vaultEventId) { - this.vaultEventId = vaultEventId; + public LibraryDocumentEvent id(String id) { + this.id = id; return this; } /** - * The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null) - * @return vaultEventId + * The identifier for the event. + * @return id **/ - @ApiModelProperty(value = "The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null)") - public String getVaultEventId() { - return vaultEventId; + @ApiModelProperty(value = "The identifier for the event.") + public String getId() { + return id; } - public void setVaultEventId(String vaultEventId) { - this.vaultEventId = vaultEventId; + public void setId(String id) { + this.id = id; } - public LibraryDocumentEvent vaultProviderName(String vaultProviderName) { - this.vaultProviderName = vaultProviderName; + public LibraryDocumentEvent synchronizationId(String synchronizationId) { + this.synchronizationId = synchronizationId; return this; } /** - * Name of the vault provider for the vault event (if vaulted, otherwise null) - * @return vaultProviderName + * A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null) + * @return synchronizationId **/ - @ApiModelProperty(value = "Name of the vault provider for the vault event (if vaulted, otherwise null)") - public String getVaultProviderName() { - return vaultProviderName; + @ApiModelProperty(value = "A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null)") + public String getSynchronizationId() { + return synchronizationId; } - public void setVaultProviderName(String vaultProviderName) { - this.vaultProviderName = vaultProviderName; + public void setSynchronizationId(String synchronizationId) { + this.synchronizationId = synchronizationId; } - public LibraryDocumentEvent versionId(String versionId) { - this.versionId = versionId; + public LibraryDocumentEvent deviceLocation(LibDocEventDeviceLocation deviceLocation) { + this.deviceLocation = deviceLocation; return this; } /** - * An ID which uniquely identifies the version of the document associated with this audit event - * @return versionId + * Location of the device that generated the event (This value may be null due to limited privileges) + * @return deviceLocation **/ - @ApiModelProperty(value = "An ID which uniquely identifies the version of the document associated with this audit event") - public String getVersionId() { - return versionId; + @ApiModelProperty(value = "Location of the device that generated the event (This value may be null due to limited privileges)") + public LibDocEventDeviceLocation getDeviceLocation() { + return deviceLocation; } - public void setVersionId(String versionId) { - this.versionId = versionId; + public void setDeviceLocation(LibDocEventDeviceLocation deviceLocation) { + this.deviceLocation = deviceLocation; } @@ -573,30 +579,31 @@ public boolean equals(java.lang.Object o) { return false; } LibraryDocumentEvent libraryDocumentEvent = (LibraryDocumentEvent) o; - return Objects.equals(this.actingUserEmail, libraryDocumentEvent.actingUserEmail) && - Objects.equals(this.actingUserIpAddress, libraryDocumentEvent.actingUserIpAddress) && - Objects.equals(this.actingUserName, libraryDocumentEvent.actingUserName) && - Objects.equals(this.comment, libraryDocumentEvent.comment) && - Objects.equals(this.date, libraryDocumentEvent.date) && - Objects.equals(this.description, libraryDocumentEvent.description) && - Objects.equals(this.deviceLocation, libraryDocumentEvent.deviceLocation) && - Objects.equals(this.devicePhoneNumber, libraryDocumentEvent.devicePhoneNumber) && - Objects.equals(this.digitalSignatureInfo, libraryDocumentEvent.digitalSignatureInfo) && - Objects.equals(this.initiatingUserEmail, libraryDocumentEvent.initiatingUserEmail) && + return Objects.equals(this.date, libraryDocumentEvent.date) && Objects.equals(this.initiatingUserName, libraryDocumentEvent.initiatingUserName) && + Objects.equals(this.description, libraryDocumentEvent.description) && + Objects.equals(this.actingUserName, libraryDocumentEvent.actingUserName) && + Objects.equals(this.actingUserIpAddress, libraryDocumentEvent.actingUserIpAddress) && Objects.equals(this.participantEmail, libraryDocumentEvent.participantEmail) && - Objects.equals(this.participantId, libraryDocumentEvent.participantId) && - Objects.equals(this.participantRole, libraryDocumentEvent.participantRole) && - Objects.equals(this.synchronizationId, libraryDocumentEvent.synchronizationId) && Objects.equals(this.type, libraryDocumentEvent.type) && + Objects.equals(this.participantRole, libraryDocumentEvent.participantRole) && Objects.equals(this.vaultEventId, libraryDocumentEvent.vaultEventId) && + Objects.equals(this.participantId, libraryDocumentEvent.participantId) && + Objects.equals(this.versionId, libraryDocumentEvent.versionId) && + Objects.equals(this.actingUserEmail, libraryDocumentEvent.actingUserEmail) && + Objects.equals(this.devicePhoneNumber, libraryDocumentEvent.devicePhoneNumber) && + Objects.equals(this.initiatingUserEmail, libraryDocumentEvent.initiatingUserEmail) && + Objects.equals(this.digitalSignatureInfo, libraryDocumentEvent.digitalSignatureInfo) && Objects.equals(this.vaultProviderName, libraryDocumentEvent.vaultProviderName) && - Objects.equals(this.versionId, libraryDocumentEvent.versionId); + Objects.equals(this.comment, libraryDocumentEvent.comment) && + Objects.equals(this.id, libraryDocumentEvent.id) && + Objects.equals(this.synchronizationId, libraryDocumentEvent.synchronizationId) && + Objects.equals(this.deviceLocation, libraryDocumentEvent.deviceLocation); } @Override public int hashCode() { - return Objects.hash(actingUserEmail, actingUserIpAddress, actingUserName, comment, date, description, deviceLocation, devicePhoneNumber, digitalSignatureInfo, initiatingUserEmail, initiatingUserName, participantEmail, participantId, participantRole, synchronizationId, type, vaultEventId, vaultProviderName, versionId); + return Objects.hash(date, initiatingUserName, description, actingUserName, actingUserIpAddress, participantEmail, type, participantRole, vaultEventId, participantId, versionId, actingUserEmail, devicePhoneNumber, initiatingUserEmail, digitalSignatureInfo, vaultProviderName, comment, id, synchronizationId, deviceLocation); } @@ -605,25 +612,26 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class LibraryDocumentEvent {\n"); - sb.append(" actingUserEmail: ").append(toIndentedString(actingUserEmail)).append("\n"); - sb.append(" actingUserIpAddress: ").append(toIndentedString(actingUserIpAddress)).append("\n"); - sb.append(" actingUserName: ").append(toIndentedString(actingUserName)).append("\n"); - sb.append(" comment: ").append(toIndentedString(comment)).append("\n"); sb.append(" date: ").append(toIndentedString(date)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" deviceLocation: ").append(toIndentedString(deviceLocation)).append("\n"); - sb.append(" devicePhoneNumber: ").append(toIndentedString(devicePhoneNumber)).append("\n"); - sb.append(" digitalSignatureInfo: ").append(toIndentedString(digitalSignatureInfo)).append("\n"); - sb.append(" initiatingUserEmail: ").append(toIndentedString(initiatingUserEmail)).append("\n"); sb.append(" initiatingUserName: ").append(toIndentedString(initiatingUserName)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" actingUserName: ").append(toIndentedString(actingUserName)).append("\n"); + sb.append(" actingUserIpAddress: ").append(toIndentedString(actingUserIpAddress)).append("\n"); sb.append(" participantEmail: ").append(toIndentedString(participantEmail)).append("\n"); - sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); - sb.append(" participantRole: ").append(toIndentedString(participantRole)).append("\n"); - sb.append(" synchronizationId: ").append(toIndentedString(synchronizationId)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" participantRole: ").append(toIndentedString(participantRole)).append("\n"); sb.append(" vaultEventId: ").append(toIndentedString(vaultEventId)).append("\n"); - sb.append(" vaultProviderName: ").append(toIndentedString(vaultProviderName)).append("\n"); + sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); sb.append(" versionId: ").append(toIndentedString(versionId)).append("\n"); + sb.append(" actingUserEmail: ").append(toIndentedString(actingUserEmail)).append("\n"); + sb.append(" devicePhoneNumber: ").append(toIndentedString(devicePhoneNumber)).append("\n"); + sb.append(" initiatingUserEmail: ").append(toIndentedString(initiatingUserEmail)).append("\n"); + sb.append(" digitalSignatureInfo: ").append(toIndentedString(digitalSignatureInfo)).append("\n"); + sb.append(" vaultProviderName: ").append(toIndentedString(vaultProviderName)).append("\n"); + sb.append(" comment: ").append(toIndentedString(comment)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" synchronizationId: ").append(toIndentedString(synchronizationId)).append("\n"); + sb.append(" deviceLocation: ").append(toIndentedString(deviceLocation)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentEventList.java b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentEventList.java index 832f614..f683978 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentEventList.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentEventList.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * LibraryDocumentEventList */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class LibraryDocumentEventList { @SerializedName("events") private List events = null; diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentFormFields.java b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentFormFields.java new file mode 100644 index 0000000..effc42a --- /dev/null +++ b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentFormFields.java @@ -0,0 +1,105 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.libraryDocuments; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.libraryDocuments.FormField; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * A JSON list of all of the fields for a form + */ +@ApiModel(description = "A JSON list of all of the fields for a form") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") +public class LibraryDocumentFormFields { + @SerializedName("fields") + private List fields = null; + + public LibraryDocumentFormFields fields(List fields) { + this.fields = fields; + return this; + } + + public LibraryDocumentFormFields addFieldsItem(FormField fieldsItem) { + if (this.fields == null) { + this.fields = new ArrayList(); + } + this.fields.add(fieldsItem); + return this; + } + + /** + * List of the form fields in an agreement + * @return fields + **/ + @ApiModelProperty(value = "List of the form fields in an agreement") + public List getFields() { + return fields; + } + + public void setFields(List fields) { + this.fields = fields; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LibraryDocumentFormFields libraryDocumentFormFields = (LibraryDocumentFormFields) o; + return Objects.equals(this.fields, libraryDocumentFormFields.fields); + } + + @Override + public int hashCode() { + return Objects.hash(fields); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LibraryDocumentFormFields {\n"); + + sb.append(" fields: ").append(toIndentedString(fields)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentInfo.java b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentInfo.java index 1673977..74ca119 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentInfo.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,31 +30,13 @@ /** * LibraryDocumentInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class LibraryDocumentInfo { - @SerializedName("createdDate") - private Date createdDate = null; - @SerializedName("creatorEmail") private String creatorEmail = null; - @SerializedName("creatorName") - private String creatorName = null; - - @SerializedName("fileInfos") - private List fileInfos = null; - - @SerializedName("id") - private String id = null; - - @SerializedName("modifiedDate") - private Date modifiedDate = null; - - @SerializedName("name") - private String name = null; - /** - * Specifies who should have access to this library document. GLOBAL sharing mode is not applicable in POST/PUT requests + * Specifies who should have access to this library document. GLOBAL sharing is a restricted operation. */ @JsonAdapter(SharingModeEnum.Adapter.class) public enum SharingModeEnum { @@ -122,18 +89,30 @@ public SharingModeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("sharingMode") private SharingModeEnum sharingMode = null; + @SerializedName("groupId") + private String groupId = null; + + @SerializedName("creatorName") + private String creatorName = null; + + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("isDocumentRetentionApplied") + private Boolean isDocumentRetentionApplied = null; + /** - * State of the library document. + * Gets or Sets templateTypes */ - @JsonAdapter(StateEnum.Adapter.class) - public enum StateEnum { - AUTHORING("AUTHORING"), + @JsonAdapter(TemplateTypesEnum.Adapter.class) + public enum TemplateTypesEnum { + DOCUMENT("DOCUMENT"), - ACTIVE("ACTIVE"); + FORM_FIELD_LAYER("FORM_FIELD_LAYER"); private String value; - StateEnum(String value) { + TemplateTypesEnum(String value) { this.value = value; } @@ -146,8 +125,8 @@ public String toString() { return String.valueOf(value); } - public static StateEnum fromValue(String text) { - for (StateEnum b : StateEnum.values()) { + public static TemplateTypesEnum fromValue(String text) { + for (TemplateTypesEnum b : TemplateTypesEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -155,37 +134,50 @@ public static StateEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final TemplateTypesEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public StateEnum read(final JsonReader jsonReader) throws IOException { + public TemplateTypesEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return StateEnum.fromValue(String.valueOf(value)); + return TemplateTypesEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("state") - private StateEnum state = null; + @SerializedName("templateTypes") + private List templateTypes = null; + + @SerializedName("lastEventDate") + private Date lastEventDate = null; + + @SerializedName("modifiedDate") + private Date modifiedDate = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("fileInfos") + private List fileInfos = null; + + @SerializedName("id") + private String id = null; /** - * Status of the library document + * State of the library document. */ - @JsonAdapter(StatusEnum.Adapter.class) - public enum StatusEnum { + @JsonAdapter(StateEnum.Adapter.class) + public enum StateEnum { AUTHORING("AUTHORING"), - ACTIVE("ACTIVE"), - - REMOVED("REMOVED"); + ACTIVE("ACTIVE"); private String value; - StatusEnum(String value) { + StateEnum(String value) { this.value = value; } @@ -198,8 +190,8 @@ public String toString() { return String.valueOf(value); } - public static StatusEnum fromValue(String text) { - for (StatusEnum b : StatusEnum.values()) { + public static StateEnum fromValue(String text) { + for (StateEnum b : StateEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -207,35 +199,37 @@ public static StatusEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public StatusEnum read(final JsonReader jsonReader) throws IOException { + public StateEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return StatusEnum.fromValue(String.valueOf(value)); + return StateEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("status") - private StatusEnum status = null; + @SerializedName("state") + private StateEnum state = null; /** - * Gets or Sets templateTypes + * Status of the library document */ - @JsonAdapter(TemplateTypesEnum.Adapter.class) - public enum TemplateTypesEnum { - DOCUMENT("DOCUMENT"), + @JsonAdapter(StatusEnum.Adapter.class) + public enum StatusEnum { + AUTHORING("AUTHORING"), - FORM_FIELD_LAYER("FORM_FIELD_LAYER"); + ACTIVE("ACTIVE"), + + REMOVED("REMOVED"); private String value; - TemplateTypesEnum(String value) { + StatusEnum(String value) { this.value = value; } @@ -248,8 +242,8 @@ public String toString() { return String.valueOf(value); } - public static TemplateTypesEnum fromValue(String text) { - for (TemplateTypesEnum b : TemplateTypesEnum.values()) { + public static StatusEnum fromValue(String text) { + for (StatusEnum b : StatusEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -257,40 +251,22 @@ public static TemplateTypesEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final TemplateTypesEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public TemplateTypesEnum read(final JsonReader jsonReader) throws IOException { + public StatusEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return TemplateTypesEnum.fromValue(String.valueOf(value)); + return StatusEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("templateTypes") - private List templateTypes = null; - - public LibraryDocumentInfo createdDate(Date createdDate) { - this.createdDate = createdDate; - return this; - } - - /** - * Date when library document was created. It will be ignored in POST/PUT requests. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time - * @return createdDate - **/ - @ApiModelProperty(value = "Date when library document was created. It will be ignored in POST/PUT requests. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") - public Date getCreatedDate() { - return createdDate; - } - - public void setCreatedDate(Date createdDate) { - this.createdDate = createdDate; - } + @SerializedName("status") + private StatusEnum status = null; public LibraryDocumentInfo creatorEmail(String creatorEmail) { this.creatorEmail = creatorEmail; @@ -310,6 +286,42 @@ public void setCreatorEmail(String creatorEmail) { this.creatorEmail = creatorEmail; } + public LibraryDocumentInfo sharingMode(SharingModeEnum sharingMode) { + this.sharingMode = sharingMode; + return this; + } + + /** + * Specifies who should have access to this library document. GLOBAL sharing is a restricted operation. + * @return sharingMode + **/ + @ApiModelProperty(value = "Specifies who should have access to this library document. GLOBAL sharing is a restricted operation.") + public SharingModeEnum getSharingMode() { + return sharingMode; + } + + public void setSharingMode(SharingModeEnum sharingMode) { + this.sharingMode = sharingMode; + } + + public LibraryDocumentInfo groupId(String groupId) { + this.groupId = groupId; + return this; + } + + /** + * The unique identifier of the group to which the library template belongs to. If not provided during creation, primary group of the creator will be used + * @return groupId + **/ + @ApiModelProperty(value = "The unique identifier of the group to which the library template belongs to. If not provided during creation, primary group of the creator will be used") + public String getGroupId() { + return groupId; + } + + public void setGroupId(String groupId) { + this.groupId = groupId; + } + public LibraryDocumentInfo creatorName(String creatorName) { this.creatorName = creatorName; return this; @@ -328,48 +340,84 @@ public void setCreatorName(String creatorName) { this.creatorName = creatorName; } - public LibraryDocumentInfo fileInfos(List fileInfos) { - this.fileInfos = fileInfos; + public LibraryDocumentInfo createdDate(Date createdDate) { + this.createdDate = createdDate; return this; } - public LibraryDocumentInfo addFileInfosItem(FileInfo fileInfosItem) { - if (this.fileInfos == null) { - this.fileInfos = new ArrayList(); + /** + * Date when library document was created. It will be ignored in POST/PUT requests. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return createdDate + **/ + @ApiModelProperty(value = "Date when library document was created. It will be ignored in POST/PUT requests. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getCreatedDate() { + return createdDate; + } + + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } + + public LibraryDocumentInfo isDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; + return this; + } + + /** + * Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. + * @return isDocumentRetentionApplied + **/ + @ApiModelProperty(value = "Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored.") + public Boolean isIsDocumentRetentionApplied() { + return isDocumentRetentionApplied; + } + + public void setIsDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; + } + + public LibraryDocumentInfo templateTypes(List templateTypes) { + this.templateTypes = templateTypes; + return this; + } + + public LibraryDocumentInfo addTemplateTypesItem(TemplateTypesEnum templateTypesItem) { + if (this.templateTypes == null) { + this.templateTypes = new ArrayList(); } - this.fileInfos.add(fileInfosItem); + this.templateTypes.add(templateTypesItem); return this; } /** - * A list of one or more files (or references to files) that will be used to create the template. If more than one file is provided, they will be combined into one PDF. Note: Only a single parameter in every FileInfo object must be specified - * @return fileInfos + * A list of one or more library template types + * @return templateTypes **/ - @ApiModelProperty(value = "A list of one or more files (or references to files) that will be used to create the template. If more than one file is provided, they will be combined into one PDF. Note: Only a single parameter in every FileInfo object must be specified") - public List getFileInfos() { - return fileInfos; + @ApiModelProperty(value = "A list of one or more library template types") + public List getTemplateTypes() { + return templateTypes; } - public void setFileInfos(List fileInfos) { - this.fileInfos = fileInfos; + public void setTemplateTypes(List templateTypes) { + this.templateTypes = templateTypes; } - public LibraryDocumentInfo id(String id) { - this.id = id; + public LibraryDocumentInfo lastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; return this; } /** - * The unique identifier that is used to refer to the library template. It will be ignored in POST requests - * @return id + * The date of the last event that occurred for this library document + * @return lastEventDate **/ - @ApiModelProperty(value = "The unique identifier that is used to refer to the library template. It will be ignored in POST requests") - public String getId() { - return id; + @ApiModelProperty(value = "The date of the last event that occurred for this library document") + public Date getLastEventDate() { + return lastEventDate; } - public void setId(String id) { - this.id = id; + public void setLastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; } public LibraryDocumentInfo modifiedDate(Date modifiedDate) { @@ -408,22 +456,48 @@ public void setName(String name) { this.name = name; } - public LibraryDocumentInfo sharingMode(SharingModeEnum sharingMode) { - this.sharingMode = sharingMode; + public LibraryDocumentInfo fileInfos(List fileInfos) { + this.fileInfos = fileInfos; + return this; + } + + public LibraryDocumentInfo addFileInfosItem(FileInfo fileInfosItem) { + if (this.fileInfos == null) { + this.fileInfos = new ArrayList(); + } + this.fileInfos.add(fileInfosItem); return this; } /** - * Specifies who should have access to this library document. GLOBAL sharing mode is not applicable in POST/PUT requests - * @return sharingMode + * A list of one or more files (or references to files) that will be used to create the template. If more than one file is provided, they will be combined into one PDF. Note: Only a single parameter in every FileInfo object must be specified + * @return fileInfos **/ - @ApiModelProperty(value = "Specifies who should have access to this library document. GLOBAL sharing mode is not applicable in POST/PUT requests") - public SharingModeEnum getSharingMode() { - return sharingMode; + @ApiModelProperty(value = "A list of one or more files (or references to files) that will be used to create the template. If more than one file is provided, they will be combined into one PDF. Note: Only a single parameter in every FileInfo object must be specified") + public List getFileInfos() { + return fileInfos; } - public void setSharingMode(SharingModeEnum sharingMode) { - this.sharingMode = sharingMode; + public void setFileInfos(List fileInfos) { + this.fileInfos = fileInfos; + } + + public LibraryDocumentInfo id(String id) { + this.id = id; + return this; + } + + /** + * The unique identifier that is used to refer to the library template. It will be ignored in POST requests + * @return id + **/ + @ApiModelProperty(value = "The unique identifier that is used to refer to the library template. It will be ignored in POST requests") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; } public LibraryDocumentInfo state(StateEnum state) { @@ -462,32 +536,6 @@ public void setStatus(StatusEnum status) { this.status = status; } - public LibraryDocumentInfo templateTypes(List templateTypes) { - this.templateTypes = templateTypes; - return this; - } - - public LibraryDocumentInfo addTemplateTypesItem(TemplateTypesEnum templateTypesItem) { - if (this.templateTypes == null) { - this.templateTypes = new ArrayList(); - } - this.templateTypes.add(templateTypesItem); - return this; - } - - /** - * A list of one or more library template types - * @return templateTypes - **/ - @ApiModelProperty(value = "A list of one or more library template types") - public List getTemplateTypes() { - return templateTypes; - } - - public void setTemplateTypes(List templateTypes) { - this.templateTypes = templateTypes; - } - @Override public boolean equals(java.lang.Object o) { @@ -498,22 +546,25 @@ public boolean equals(java.lang.Object o) { return false; } LibraryDocumentInfo libraryDocumentInfo = (LibraryDocumentInfo) o; - return Objects.equals(this.createdDate, libraryDocumentInfo.createdDate) && - Objects.equals(this.creatorEmail, libraryDocumentInfo.creatorEmail) && + return Objects.equals(this.creatorEmail, libraryDocumentInfo.creatorEmail) && + Objects.equals(this.sharingMode, libraryDocumentInfo.sharingMode) && + Objects.equals(this.groupId, libraryDocumentInfo.groupId) && Objects.equals(this.creatorName, libraryDocumentInfo.creatorName) && - Objects.equals(this.fileInfos, libraryDocumentInfo.fileInfos) && - Objects.equals(this.id, libraryDocumentInfo.id) && + Objects.equals(this.createdDate, libraryDocumentInfo.createdDate) && + Objects.equals(this.isDocumentRetentionApplied, libraryDocumentInfo.isDocumentRetentionApplied) && + Objects.equals(this.templateTypes, libraryDocumentInfo.templateTypes) && + Objects.equals(this.lastEventDate, libraryDocumentInfo.lastEventDate) && Objects.equals(this.modifiedDate, libraryDocumentInfo.modifiedDate) && Objects.equals(this.name, libraryDocumentInfo.name) && - Objects.equals(this.sharingMode, libraryDocumentInfo.sharingMode) && + Objects.equals(this.fileInfos, libraryDocumentInfo.fileInfos) && + Objects.equals(this.id, libraryDocumentInfo.id) && Objects.equals(this.state, libraryDocumentInfo.state) && - Objects.equals(this.status, libraryDocumentInfo.status) && - Objects.equals(this.templateTypes, libraryDocumentInfo.templateTypes); + Objects.equals(this.status, libraryDocumentInfo.status); } @Override public int hashCode() { - return Objects.hash(createdDate, creatorEmail, creatorName, fileInfos, id, modifiedDate, name, sharingMode, state, status, templateTypes); + return Objects.hash(creatorEmail, sharingMode, groupId, creatorName, createdDate, isDocumentRetentionApplied, templateTypes, lastEventDate, modifiedDate, name, fileInfos, id, state, status); } @@ -522,17 +573,20 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class LibraryDocumentInfo {\n"); - sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); sb.append(" creatorEmail: ").append(toIndentedString(creatorEmail)).append("\n"); + sb.append(" sharingMode: ").append(toIndentedString(sharingMode)).append("\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); sb.append(" creatorName: ").append(toIndentedString(creatorName)).append("\n"); - sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" isDocumentRetentionApplied: ").append(toIndentedString(isDocumentRetentionApplied)).append("\n"); + sb.append(" templateTypes: ").append(toIndentedString(templateTypes)).append("\n"); + sb.append(" lastEventDate: ").append(toIndentedString(lastEventDate)).append("\n"); sb.append(" modifiedDate: ").append(toIndentedString(modifiedDate)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" sharingMode: ").append(toIndentedString(sharingMode)).append("\n"); + sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" state: ").append(toIndentedString(state)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" templateTypes: ").append(toIndentedString(templateTypes)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentMembersInfo.java b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentMembersInfo.java new file mode 100644 index 0000000..f81b2fd --- /dev/null +++ b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentMembersInfo.java @@ -0,0 +1,94 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.libraryDocuments; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.libraryDocuments.SenderInfo; +import java.io.IOException; + +/** + * LibraryDocumentMembersInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") +public class LibraryDocumentMembersInfo { + @SerializedName("creatorInfo") + private SenderInfo creatorInfo = null; + + public LibraryDocumentMembersInfo creatorInfo(SenderInfo creatorInfo) { + this.creatorInfo = creatorInfo; + return this; + } + + /** + * Information about the creator of the library document. + * @return creatorInfo + **/ + @ApiModelProperty(value = "Information about the creator of the library document.") + public SenderInfo getCreatorInfo() { + return creatorInfo; + } + + public void setCreatorInfo(SenderInfo creatorInfo) { + this.creatorInfo = creatorInfo; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LibraryDocumentMembersInfo libraryDocumentMembersInfo = (LibraryDocumentMembersInfo) o; + return Objects.equals(this.creatorInfo, libraryDocumentMembersInfo.creatorInfo); + } + + @Override + public int hashCode() { + return Objects.hash(creatorInfo); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LibraryDocumentMembersInfo {\n"); + + sb.append(" creatorInfo: ").append(toIndentedString(creatorInfo)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentStateInfo.java b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentStateInfo.java index 9dd0240..9886584 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentStateInfo.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentStateInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * LibraryDocumentStateInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class LibraryDocumentStateInfo { /** * State of the library document. @@ -50,7 +35,9 @@ public class LibraryDocumentStateInfo { public enum StateEnum { AUTHORING("AUTHORING"), - ACTIVE("ACTIVE"); + ACTIVE("ACTIVE"), + + REMOVED("REMOVED"); private String value; diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentViewResponse.java b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentViewResponse.java index e6ed4c8..f94a79c 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentViewResponse.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocumentViewResponse.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * LibraryDocumentViewResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class LibraryDocumentViewResponse { @SerializedName("libraryViewList") private List libraryViewList = null; diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocuments.java b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocuments.java index 33951c9..2ec9baa 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocuments.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryDocuments.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,7 +30,7 @@ /** * LibraryDocuments */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class LibraryDocuments { @SerializedName("libraryDocumentList") private List libraryDocumentList = null; diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryView.java b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryView.java index 797876a..2ee2de7 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryView.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryView.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,17 +27,14 @@ /** * LibraryView */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class LibraryView { - @SerializedName("embeddedCode") - private String embeddedCode = null; - - @SerializedName("expiration") - private Date expiration = null; - @SerializedName("isCurrent") private Boolean isCurrent = null; + @SerializedName("embeddedCode") + private String embeddedCode = null; + /** * Name of the requested libraryDocument view */ @@ -109,45 +91,12 @@ public NameEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("name") private NameEnum name = null; + @SerializedName("expiration") + private Date expiration = null; + @SerializedName("url") private String url = null; - public LibraryView embeddedCode(String embeddedCode) { - this.embeddedCode = embeddedCode; - return this; - } - - /** - * Embedded code of url of resource - * @return embeddedCode - **/ - @ApiModelProperty(value = "Embedded code of url of resource ") - public String getEmbeddedCode() { - return embeddedCode; - } - - public void setEmbeddedCode(String embeddedCode) { - this.embeddedCode = embeddedCode; - } - - public LibraryView expiration(Date expiration) { - this.expiration = expiration; - return this; - } - - /** - * Expiration of user url - * @return expiration - **/ - @ApiModelProperty(value = "Expiration of user url ") - public Date getExpiration() { - return expiration; - } - - public void setExpiration(Date expiration) { - this.expiration = expiration; - } - public LibraryView isCurrent(Boolean isCurrent) { this.isCurrent = isCurrent; return this; @@ -166,6 +115,24 @@ public void setIsCurrent(Boolean isCurrent) { this.isCurrent = isCurrent; } + public LibraryView embeddedCode(String embeddedCode) { + this.embeddedCode = embeddedCode; + return this; + } + + /** + * Embedded code of url of resource + * @return embeddedCode + **/ + @ApiModelProperty(value = "Embedded code of url of resource ") + public String getEmbeddedCode() { + return embeddedCode; + } + + public void setEmbeddedCode(String embeddedCode) { + this.embeddedCode = embeddedCode; + } + public LibraryView name(NameEnum name) { this.name = name; return this; @@ -184,6 +151,24 @@ public void setName(NameEnum name) { this.name = name; } + public LibraryView expiration(Date expiration) { + this.expiration = expiration; + return this; + } + + /** + * Expiration of user url + * @return expiration + **/ + @ApiModelProperty(value = "Expiration of user url ") + public Date getExpiration() { + return expiration; + } + + public void setExpiration(Date expiration) { + this.expiration = expiration; + } + public LibraryView url(String url) { this.url = url; return this; @@ -212,16 +197,16 @@ public boolean equals(java.lang.Object o) { return false; } LibraryView libraryView = (LibraryView) o; - return Objects.equals(this.embeddedCode, libraryView.embeddedCode) && - Objects.equals(this.expiration, libraryView.expiration) && - Objects.equals(this.isCurrent, libraryView.isCurrent) && + return Objects.equals(this.isCurrent, libraryView.isCurrent) && + Objects.equals(this.embeddedCode, libraryView.embeddedCode) && Objects.equals(this.name, libraryView.name) && + Objects.equals(this.expiration, libraryView.expiration) && Objects.equals(this.url, libraryView.url); } @Override public int hashCode() { - return Objects.hash(embeddedCode, expiration, isCurrent, name, url); + return Objects.hash(isCurrent, embeddedCode, name, expiration, url); } @@ -230,10 +215,10 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class LibraryView {\n"); - sb.append(" embeddedCode: ").append(toIndentedString(embeddedCode)).append("\n"); - sb.append(" expiration: ").append(toIndentedString(expiration)).append("\n"); sb.append(" isCurrent: ").append(toIndentedString(isCurrent)).append("\n"); + sb.append(" embeddedCode: ").append(toIndentedString(embeddedCode)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" expiration: ").append(toIndentedString(expiration)).append("\n"); sb.append(" url: ").append(toIndentedString(url)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryViewInfo.java b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryViewInfo.java index 50fc447..2980f87 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/LibraryViewInfo.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/LibraryViewInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -43,7 +28,7 @@ /** * LibraryViewInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class LibraryViewInfo { @SerializedName("commonViewConfiguration") private CommonViewConfiguration commonViewConfiguration = null; diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/MyAgreementInfo.java b/src/main/java/io/swagger/client/model/libraryDocuments/MyAgreementInfo.java new file mode 100644 index 0000000..779e54d --- /dev/null +++ b/src/main/java/io/swagger/client/model/libraryDocuments/MyAgreementInfo.java @@ -0,0 +1,104 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.libraryDocuments; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.libraryDocuments.AccountSharerInfo; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * MyAgreementInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") +public class MyAgreementInfo { + @SerializedName("accountSharers") + private List accountSharers = null; + + public MyAgreementInfo accountSharers(List accountSharers) { + this.accountSharers = accountSharers; + return this; + } + + public MyAgreementInfo addAccountSharersItem(AccountSharerInfo accountSharersItem) { + if (this.accountSharers == null) { + this.accountSharers = new ArrayList(); + } + this.accountSharers.add(accountSharersItem); + return this; + } + + /** + * A list of account sharer in relation to the api caller and this resource. + * @return accountSharers + **/ + @ApiModelProperty(value = "A list of account sharer in relation to the api caller and this resource.") + public List getAccountSharers() { + return accountSharers; + } + + public void setAccountSharers(List accountSharers) { + this.accountSharers = accountSharers; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + MyAgreementInfo myAgreementInfo = (MyAgreementInfo) o; + return Objects.equals(this.accountSharers, myAgreementInfo.accountSharers); + } + + @Override + public int hashCode() { + return Objects.hash(accountSharers); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class MyAgreementInfo {\n"); + + sb.append(" accountSharers: ").append(toIndentedString(accountSharers)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/Note.java b/src/main/java/io/swagger/client/model/libraryDocuments/Note.java index abbf8d1..23f1107 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/Note.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/Note.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * Note */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class Note { @SerializedName("note") private String note = null; diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/PageImageUrl.java b/src/main/java/io/swagger/client/model/libraryDocuments/PageImageUrl.java index 519a44a..5c4066f 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/PageImageUrl.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/PageImageUrl.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * PageImageUrl */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class PageImageUrl { @SerializedName("pageNumber") private Integer pageNumber = null; diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/PageInfo.java b/src/main/java/io/swagger/client/model/libraryDocuments/PageInfo.java index c77cfe4..12840df 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/PageInfo.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/PageInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * PageInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class PageInfo { @SerializedName("nextCursor") private String nextCursor = null; diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/SendViewConfiguration.java b/src/main/java/io/swagger/client/model/libraryDocuments/SendViewConfiguration.java index e7ad5df..3d96f12 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/SendViewConfiguration.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/SendViewConfiguration.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,34 +27,16 @@ /** * SendViewConfiguration */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class SendViewConfiguration { - @SerializedName("agrName") - private String agrName = null; - @SerializedName("fileUploadOptions") private FileUploadOptions fileUploadOptions = null; @SerializedName("isPreviewSelected") private Boolean isPreviewSelected = null; - public SendViewConfiguration agrName(String agrName) { - this.agrName = agrName; - return this; - } - - /** - * The agreement name for the library document on the compose page - * @return agrName - **/ - @ApiModelProperty(value = "The agreement name for the library document on the compose page") - public String getAgrName() { - return agrName; - } - - public void setAgrName(String agrName) { - this.agrName = agrName; - } + @SerializedName("agrName") + private String agrName = null; public SendViewConfiguration fileUploadOptions(FileUploadOptions fileUploadOptions) { this.fileUploadOptions = fileUploadOptions; @@ -107,6 +74,24 @@ public void setIsPreviewSelected(Boolean isPreviewSelected) { this.isPreviewSelected = isPreviewSelected; } + public SendViewConfiguration agrName(String agrName) { + this.agrName = agrName; + return this; + } + + /** + * The agreement name for the library document on the compose page + * @return agrName + **/ + @ApiModelProperty(value = "The agreement name for the library document on the compose page") + public String getAgrName() { + return agrName; + } + + public void setAgrName(String agrName) { + this.agrName = agrName; + } + @Override public boolean equals(java.lang.Object o) { @@ -117,14 +102,14 @@ public boolean equals(java.lang.Object o) { return false; } SendViewConfiguration sendViewConfiguration = (SendViewConfiguration) o; - return Objects.equals(this.agrName, sendViewConfiguration.agrName) && - Objects.equals(this.fileUploadOptions, sendViewConfiguration.fileUploadOptions) && - Objects.equals(this.isPreviewSelected, sendViewConfiguration.isPreviewSelected); + return Objects.equals(this.fileUploadOptions, sendViewConfiguration.fileUploadOptions) && + Objects.equals(this.isPreviewSelected, sendViewConfiguration.isPreviewSelected) && + Objects.equals(this.agrName, sendViewConfiguration.agrName); } @Override public int hashCode() { - return Objects.hash(agrName, fileUploadOptions, isPreviewSelected); + return Objects.hash(fileUploadOptions, isPreviewSelected, agrName); } @@ -133,9 +118,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class SendViewConfiguration {\n"); - sb.append(" agrName: ").append(toIndentedString(agrName)).append("\n"); sb.append(" fileUploadOptions: ").append(toIndentedString(fileUploadOptions)).append("\n"); sb.append(" isPreviewSelected: ").append(toIndentedString(isPreviewSelected)).append("\n"); + sb.append(" agrName: ").append(toIndentedString(agrName)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/SenderInfo.java b/src/main/java/io/swagger/client/model/libraryDocuments/SenderInfo.java new file mode 100644 index 0000000..e5a12ca --- /dev/null +++ b/src/main/java/io/swagger/client/model/libraryDocuments/SenderInfo.java @@ -0,0 +1,255 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.libraryDocuments; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.Date; + +/** + * SenderInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") +public class SenderInfo { + @SerializedName("participantId") + private String participantId = null; + + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("hidden") + private Boolean hidden = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("self") + private Boolean self = null; + + @SerializedName("company") + private String company = null; + + @SerializedName("userId") + private String userId = null; + + @SerializedName("email") + private String email = null; + + public SenderInfo participantId(String participantId) { + this.participantId = participantId; + return this; + } + + /** + * The unique identifier of the creator of the library document. + * @return participantId + **/ + @ApiModelProperty(value = " The unique identifier of the creator of the library document.") + public String getParticipantId() { + return participantId; + } + + public void setParticipantId(String participantId) { + this.participantId = participantId; + } + + public SenderInfo createdDate(Date createdDate) { + this.createdDate = createdDate; + return this; + } + + /** + * The date when the sender was added. This will be returned as part of GET call but is ignored if passed as part of PUT call. + * @return createdDate + **/ + @ApiModelProperty(value = "The date when the sender was added. This will be returned as part of GET call but is ignored if passed as part of PUT call.") + public Date getCreatedDate() { + return createdDate; + } + + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } + + public SenderInfo hidden(Boolean hidden) { + this.hidden = hidden; + return this; + } + + /** + * True if the library document is hidden for the user that is calling the API. Only returned if self is true. + * @return hidden + **/ + @ApiModelProperty(value = "True if the library document is hidden for the user that is calling the API. Only returned if self is true.") + public Boolean isHidden() { + return hidden; + } + + public void setHidden(Boolean hidden) { + this.hidden = hidden; + } + + public SenderInfo name(String name) { + this.name = name; + return this; + } + + /** + * Name of the creator of the library document, if available. + * @return name + **/ + @ApiModelProperty(value = "Name of the creator of the library document, if available.") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public SenderInfo self(Boolean self) { + this.self = self; + return this; + } + + /** + * True if the creator of the library document is the same user that is calling the API. + * @return self + **/ + @ApiModelProperty(value = "True if the creator of the library document is the same user that is calling the API.") + public Boolean isSelf() { + return self; + } + + public void setSelf(Boolean self) { + this.self = self; + } + + public SenderInfo company(String company) { + this.company = company; + return this; + } + + /** + * Company of the creator of the library document, if available. + * @return company + **/ + @ApiModelProperty(value = "Company of the creator of the library document, if available.") + public String getCompany() { + return company; + } + + public void setCompany(String company) { + this.company = company; + } + + public SenderInfo userId(String userId) { + this.userId = userId; + return this; + } + + /** + * The user ID of the sender. This will be returned as part of GET call but is ignored if passed as part of PUT call. + * @return userId + **/ + @ApiModelProperty(value = "The user ID of the sender. This will be returned as part of GET call but is ignored if passed as part of PUT call.") + public String getUserId() { + return userId; + } + + public void setUserId(String userId) { + this.userId = userId; + } + + public SenderInfo email(String email) { + this.email = email; + return this; + } + + /** + * Email of the creator of the library document. + * @return email + **/ + @ApiModelProperty(value = "Email of the creator of the library document.") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SenderInfo senderInfo = (SenderInfo) o; + return Objects.equals(this.participantId, senderInfo.participantId) && + Objects.equals(this.createdDate, senderInfo.createdDate) && + Objects.equals(this.hidden, senderInfo.hidden) && + Objects.equals(this.name, senderInfo.name) && + Objects.equals(this.self, senderInfo.self) && + Objects.equals(this.company, senderInfo.company) && + Objects.equals(this.userId, senderInfo.userId) && + Objects.equals(this.email, senderInfo.email); + } + + @Override + public int hashCode() { + return Objects.hash(participantId, createdDate, hidden, name, self, company, userId, email); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SenderInfo {\n"); + + sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" self: ").append(toIndentedString(self)).append("\n"); + sb.append(" company: ").append(toIndentedString(company)).append("\n"); + sb.append(" userId: ").append(toIndentedString(userId)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/URLFileInfo.java b/src/main/java/io/swagger/client/model/libraryDocuments/URLFileInfo.java index 0e7008c..174bc67 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/URLFileInfo.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/URLFileInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,35 +26,17 @@ /** * URLFileInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class URLFileInfo { - @SerializedName("mimeType") - private String mimeType = null; - @SerializedName("name") private String name = null; + @SerializedName("mimeType") + private String mimeType = null; + @SerializedName("url") private String url = null; - public URLFileInfo mimeType(String mimeType) { - this.mimeType = mimeType; - return this; - } - - /** - * The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed - * @return mimeType - **/ - @ApiModelProperty(value = "The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed") - public String getMimeType() { - return mimeType; - } - - public void setMimeType(String mimeType) { - this.mimeType = mimeType; - } - public URLFileInfo name(String name) { this.name = name; return this; @@ -88,6 +55,24 @@ public void setName(String name) { this.name = name; } + public URLFileInfo mimeType(String mimeType) { + this.mimeType = mimeType; + return this; + } + + /** + * The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed + * @return mimeType + **/ + @ApiModelProperty(value = "The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed") + public String getMimeType() { + return mimeType; + } + + public void setMimeType(String mimeType) { + this.mimeType = mimeType; + } + public URLFileInfo url(String url) { this.url = url; return this; @@ -116,14 +101,14 @@ public boolean equals(java.lang.Object o) { return false; } URLFileInfo urLFileInfo = (URLFileInfo) o; - return Objects.equals(this.mimeType, urLFileInfo.mimeType) && - Objects.equals(this.name, urLFileInfo.name) && + return Objects.equals(this.name, urLFileInfo.name) && + Objects.equals(this.mimeType, urLFileInfo.mimeType) && Objects.equals(this.url, urLFileInfo.url); } @Override public int hashCode() { - return Objects.hash(mimeType, name, url); + return Objects.hash(name, mimeType, url); } @@ -132,8 +117,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class URLFileInfo {\n"); - sb.append(" mimeType: ").append(toIndentedString(mimeType)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" mimeType: ").append(toIndentedString(mimeType)).append("\n"); sb.append(" url: ").append(toIndentedString(url)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/libraryDocuments/VisibilityInfo.java b/src/main/java/io/swagger/client/model/libraryDocuments/VisibilityInfo.java index 6b80d64..f112fc4 100755 --- a/src/main/java/io/swagger/client/model/libraryDocuments/VisibilityInfo.java +++ b/src/main/java/io/swagger/client/model/libraryDocuments/VisibilityInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * VisibilityInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:09.941+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:41.998+11:00") public class VisibilityInfo { /** * Specifies the visibility. The possible values are HIDE or SHOW diff --git a/src/main/java/io/swagger/client/model/megaSigns/AccountSharerInfo.java b/src/main/java/io/swagger/client/model/megaSigns/AccountSharerInfo.java new file mode 100644 index 0000000..d82bcf3 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/AccountSharerInfo.java @@ -0,0 +1,221 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * AccountSharerInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class AccountSharerInfo { + /** + * Gets or Sets permissions + */ + @JsonAdapter(PermissionsEnum.Adapter.class) + public enum PermissionsEnum { + VIEW("VIEW"), + + SEND("SEND"), + + MODIFY("MODIFY"); + + private String value; + + PermissionsEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static PermissionsEnum fromValue(String text) { + for (PermissionsEnum b : PermissionsEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final PermissionsEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public PermissionsEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return PermissionsEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("permissions") + private List permissions = null; + + @SerializedName("fullName") + private String fullName = null; + + @SerializedName("userId") + private String userId = null; + + @SerializedName("email") + private String email = null; + + public AccountSharerInfo permissions(List permissions) { + this.permissions = permissions; + return this; + } + + public AccountSharerInfo addPermissionsItem(PermissionsEnum permissionsItem) { + if (this.permissions == null) { + this.permissions = new ArrayList(); + } + this.permissions.add(permissionsItem); + return this; + } + + /** + * A list of permissions given for this account sharing. + * @return permissions + **/ + @ApiModelProperty(value = "A list of permissions given for this account sharing.") + public List getPermissions() { + return permissions; + } + + public void setPermissions(List permissions) { + this.permissions = permissions; + } + + public AccountSharerInfo fullName(String fullName) { + this.fullName = fullName; + return this; + } + + /** + * Full name of this account sharer. + * @return fullName + **/ + @ApiModelProperty(value = "Full name of this account sharer.") + public String getFullName() { + return fullName; + } + + public void setFullName(String fullName) { + this.fullName = fullName; + } + + public AccountSharerInfo userId(String userId) { + this.userId = userId; + return this; + } + + /** + * A unique identifier of the user resource for REST APIs as issued by Sign. + * @return userId + **/ + @ApiModelProperty(value = "A unique identifier of the user resource for REST APIs as issued by Sign.") + public String getUserId() { + return userId; + } + + public void setUserId(String userId) { + this.userId = userId; + } + + public AccountSharerInfo email(String email) { + this.email = email; + return this; + } + + /** + * The email address of the user + * @return email + **/ + @ApiModelProperty(value = "The email address of the user") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + AccountSharerInfo accountSharerInfo = (AccountSharerInfo) o; + return Objects.equals(this.permissions, accountSharerInfo.permissions) && + Objects.equals(this.fullName, accountSharerInfo.fullName) && + Objects.equals(this.userId, accountSharerInfo.userId) && + Objects.equals(this.email, accountSharerInfo.email); + } + + @Override + public int hashCode() { + return Objects.hash(permissions, fullName, userId, email); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class AccountSharerInfo {\n"); + + sb.append(" permissions: ").append(toIndentedString(permissions)).append("\n"); + sb.append(" fullName: ").append(toIndentedString(fullName)).append("\n"); + sb.append(" userId: ").append(toIndentedString(userId)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/AgreementCancellationInfo.java b/src/main/java/io/swagger/client/model/megaSigns/AgreementCancellationInfo.java index 6ca560b..3745116 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/AgreementCancellationInfo.java +++ b/src/main/java/io/swagger/client/model/megaSigns/AgreementCancellationInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * AgreementCancellationInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class AgreementCancellationInfo { @SerializedName("comment") private String comment = null; diff --git a/src/main/java/io/swagger/client/model/megaSigns/AgreementDocuments.java b/src/main/java/io/swagger/client/model/megaSigns/AgreementDocuments.java new file mode 100644 index 0000000..847b4c5 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/AgreementDocuments.java @@ -0,0 +1,104 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.megaSigns.Document; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * AgreementDocuments + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class AgreementDocuments { + @SerializedName("documents") + private List documents = null; + + public AgreementDocuments documents(List documents) { + this.documents = documents; + return this; + } + + public AgreementDocuments addDocumentsItem(Document documentsItem) { + if (this.documents == null) { + this.documents = new ArrayList(); + } + this.documents.add(documentsItem); + return this; + } + + /** + * A list of documents + * @return documents + **/ + @ApiModelProperty(value = "A list of documents") + public List getDocuments() { + return documents; + } + + public void setDocuments(List documents) { + this.documents = documents; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + AgreementDocuments agreementDocuments = (AgreementDocuments) o; + return Objects.equals(this.documents, agreementDocuments.documents); + } + + @Override + public int hashCode() { + return Objects.hash(documents); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class AgreementDocuments {\n"); + + sb.append(" documents: ").append(toIndentedString(documents)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/BasicDocumentsImageUrlsInfo.java b/src/main/java/io/swagger/client/model/megaSigns/BasicDocumentsImageUrlsInfo.java new file mode 100644 index 0000000..3b95e58 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/BasicDocumentsImageUrlsInfo.java @@ -0,0 +1,104 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.megaSigns.DocumentImageUrlsInfo; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * BasicDocumentsImageUrlsInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class BasicDocumentsImageUrlsInfo { + @SerializedName("documentsImageUrlsInfo") + private List documentsImageUrlsInfo = null; + + public BasicDocumentsImageUrlsInfo documentsImageUrlsInfo(List documentsImageUrlsInfo) { + this.documentsImageUrlsInfo = documentsImageUrlsInfo; + return this; + } + + public BasicDocumentsImageUrlsInfo addDocumentsImageUrlsInfoItem(DocumentImageUrlsInfo documentsImageUrlsInfoItem) { + if (this.documentsImageUrlsInfo == null) { + this.documentsImageUrlsInfo = new ArrayList(); + } + this.documentsImageUrlsInfo.add(documentsImageUrlsInfoItem); + return this; + } + + /** + * A list of original document image URLs info. + * @return documentsImageUrlsInfo + **/ + @ApiModelProperty(value = "A list of original document image URLs info.") + public List getDocumentsImageUrlsInfo() { + return documentsImageUrlsInfo; + } + + public void setDocumentsImageUrlsInfo(List documentsImageUrlsInfo) { + this.documentsImageUrlsInfo = documentsImageUrlsInfo; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + BasicDocumentsImageUrlsInfo basicDocumentsImageUrlsInfo = (BasicDocumentsImageUrlsInfo) o; + return Objects.equals(this.documentsImageUrlsInfo, basicDocumentsImageUrlsInfo.documentsImageUrlsInfo); + } + + @Override + public int hashCode() { + return Objects.hash(documentsImageUrlsInfo); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class BasicDocumentsImageUrlsInfo {\n"); + + sb.append(" documentsImageUrlsInfo: ").append(toIndentedString(documentsImageUrlsInfo)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/CCParticipantInfo.java b/src/main/java/io/swagger/client/model/megaSigns/CCParticipantInfo.java new file mode 100644 index 0000000..9997cf9 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/CCParticipantInfo.java @@ -0,0 +1,208 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * CCParticipantInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class CCParticipantInfo { + @SerializedName("participantId") + private String participantId = null; + + @SerializedName("hidden") + private Boolean hidden = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("self") + private Boolean self = null; + + @SerializedName("company") + private String company = null; + + @SerializedName("email") + private String email = null; + + public CCParticipantInfo participantId(String participantId) { + this.participantId = participantId; + return this; + } + + /** + * The unique identifier of the CC participant of the megaSign. + * @return participantId + **/ + @ApiModelProperty(value = " The unique identifier of the CC participant of the megaSign.") + public String getParticipantId() { + return participantId; + } + + public void setParticipantId(String participantId) { + this.participantId = participantId; + } + + public CCParticipantInfo hidden(Boolean hidden) { + this.hidden = hidden; + return this; + } + + /** + * True if the megaSign parent is hidden for the user that is calling the API. Only returned if self is true. + * @return hidden + **/ + @ApiModelProperty(value = "True if the megaSign parent is hidden for the user that is calling the API. Only returned if self is true.") + public Boolean isHidden() { + return hidden; + } + + public void setHidden(Boolean hidden) { + this.hidden = hidden; + } + + public CCParticipantInfo name(String name) { + this.name = name; + return this; + } + + /** + * Name of the CC participant, if available. + * @return name + **/ + @ApiModelProperty(value = "Name of the CC participant, if available.") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public CCParticipantInfo self(Boolean self) { + this.self = self; + return this; + } + + /** + * True if the CC participant of the megaSign is the same user that is calling the API. + * @return self + **/ + @ApiModelProperty(value = "True if the CC participant of the megaSign is the same user that is calling the API.") + public Boolean isSelf() { + return self; + } + + public void setSelf(Boolean self) { + this.self = self; + } + + public CCParticipantInfo company(String company) { + this.company = company; + return this; + } + + /** + * Company of the CC participant, if available. + * @return company + **/ + @ApiModelProperty(value = "Company of the CC participant, if available.") + public String getCompany() { + return company; + } + + public void setCompany(String company) { + this.company = company; + } + + public CCParticipantInfo email(String email) { + this.email = email; + return this; + } + + /** + * Email of the CC participant of the megaSign + * @return email + **/ + @ApiModelProperty(value = "Email of the CC participant of the megaSign") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CCParticipantInfo ccParticipantInfo = (CCParticipantInfo) o; + return Objects.equals(this.participantId, ccParticipantInfo.participantId) && + Objects.equals(this.hidden, ccParticipantInfo.hidden) && + Objects.equals(this.name, ccParticipantInfo.name) && + Objects.equals(this.self, ccParticipantInfo.self) && + Objects.equals(this.company, ccParticipantInfo.company) && + Objects.equals(this.email, ccParticipantInfo.email); + } + + @Override + public int hashCode() { + return Objects.hash(participantId, hidden, name, self, company, email); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CCParticipantInfo {\n"); + + sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); + sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" self: ").append(toIndentedString(self)).append("\n"); + sb.append(" company: ").append(toIndentedString(company)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/ChildAgreementsInfo.java b/src/main/java/io/swagger/client/model/megaSigns/ChildAgreementsInfo.java index e758d13..115e499 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/ChildAgreementsInfo.java +++ b/src/main/java/io/swagger/client/model/megaSigns/ChildAgreementsInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,7 @@ /** * ChildAgreementsInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class ChildAgreementsInfo { @SerializedName("fileInfo") private MegaSignChildAgreementsFileInfo fileInfo = null; diff --git a/src/main/java/io/swagger/client/model/megaSigns/CommonViewConfiguration.java b/src/main/java/io/swagger/client/model/megaSigns/CommonViewConfiguration.java index 6b79bfb..db6a0aa 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/CommonViewConfiguration.java +++ b/src/main/java/io/swagger/client/model/megaSigns/CommonViewConfiguration.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,17 +26,17 @@ /** * CommonViewConfiguration */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class CommonViewConfiguration { @SerializedName("autoLoginUser") private Boolean autoLoginUser = null; - @SerializedName("locale") - private String locale = null; - @SerializedName("noChrome") private Boolean noChrome = null; + @SerializedName("locale") + private String locale = null; + public CommonViewConfiguration autoLoginUser(Boolean autoLoginUser) { this.autoLoginUser = autoLoginUser; return this; @@ -70,24 +55,6 @@ public void setAutoLoginUser(Boolean autoLoginUser) { this.autoLoginUser = autoLoginUser; } - public CommonViewConfiguration locale(String locale) { - this.locale = locale; - return this; - } - - /** - * Message template locale - * @return locale - **/ - @ApiModelProperty(value = "Message template locale") - public String getLocale() { - return locale; - } - - public void setLocale(String locale) { - this.locale = locale; - } - public CommonViewConfiguration noChrome(Boolean noChrome) { this.noChrome = noChrome; return this; @@ -106,6 +73,24 @@ public void setNoChrome(Boolean noChrome) { this.noChrome = noChrome; } + public CommonViewConfiguration locale(String locale) { + this.locale = locale; + return this; + } + + /** + * Message template locale + * @return locale + **/ + @ApiModelProperty(value = "Message template locale") + public String getLocale() { + return locale; + } + + public void setLocale(String locale) { + this.locale = locale; + } + @Override public boolean equals(java.lang.Object o) { @@ -117,13 +102,13 @@ public boolean equals(java.lang.Object o) { } CommonViewConfiguration commonViewConfiguration = (CommonViewConfiguration) o; return Objects.equals(this.autoLoginUser, commonViewConfiguration.autoLoginUser) && - Objects.equals(this.locale, commonViewConfiguration.locale) && - Objects.equals(this.noChrome, commonViewConfiguration.noChrome); + Objects.equals(this.noChrome, commonViewConfiguration.noChrome) && + Objects.equals(this.locale, commonViewConfiguration.locale); } @Override public int hashCode() { - return Objects.hash(autoLoginUser, locale, noChrome); + return Objects.hash(autoLoginUser, noChrome, locale); } @@ -133,8 +118,8 @@ public String toString() { sb.append("class CommonViewConfiguration {\n"); sb.append(" autoLoginUser: ").append(toIndentedString(autoLoginUser)).append("\n"); - sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); sb.append(" noChrome: ").append(toIndentedString(noChrome)).append("\n"); + sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/megaSigns/DetailedParticipantInfo.java b/src/main/java/io/swagger/client/model/megaSigns/DetailedParticipantInfo.java new file mode 100644 index 0000000..71bc315 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/DetailedParticipantInfo.java @@ -0,0 +1,372 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.megaSigns.ParticipantSecurityOption; +import java.io.IOException; +import java.util.Date; + +/** + * DetailedParticipantInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class DetailedParticipantInfo { + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("hidden") + private Boolean hidden = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("self") + private Boolean self = null; + + @SerializedName("company") + private String company = null; + + @SerializedName("id") + private String id = null; + + @SerializedName("privateMessage") + private String privateMessage = null; + + @SerializedName("userId") + private String userId = null; + + @SerializedName("email") + private String email = null; + + @SerializedName("securityOption") + private ParticipantSecurityOption securityOption = null; + + /** + * The status of the participant. + */ + @JsonAdapter(StatusEnum.Adapter.class) + public enum StatusEnum { + REPLACED("REPLACED"), + + ACTIVE("ACTIVE"); + + private String value; + + StatusEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static StatusEnum fromValue(String text) { + for (StatusEnum b : StatusEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public StatusEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return StatusEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("status") + private StatusEnum status = null; + + public DetailedParticipantInfo createdDate(Date createdDate) { + this.createdDate = createdDate; + return this; + } + + /** + * The date when the participant was added. This will be returned as part of GET call but is ignored if passed as part of PUT call. + * @return createdDate + **/ + @ApiModelProperty(value = "The date when the participant was added. This will be returned as part of GET call but is ignored if passed as part of PUT call.") + public Date getCreatedDate() { + return createdDate; + } + + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } + + public DetailedParticipantInfo hidden(Boolean hidden) { + this.hidden = hidden; + return this; + } + + /** + * True if the megaSign is hidden for the user that is calling the API. Only returned if self is true. + * @return hidden + **/ + @ApiModelProperty(value = "True if the megaSign is hidden for the user that is calling the API. Only returned if self is true.") + public Boolean isHidden() { + return hidden; + } + + public void setHidden(Boolean hidden) { + this.hidden = hidden; + } + + public DetailedParticipantInfo name(String name) { + this.name = name; + return this; + } + + /** + * The name of the participant, if available. + * @return name + **/ + @ApiModelProperty(value = "The name of the participant, if available.") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public DetailedParticipantInfo self(Boolean self) { + this.self = self; + return this; + } + + /** + * True if this participant is the same user that is calling the API. + * @return self + **/ + @ApiModelProperty(value = "True if this participant is the same user that is calling the API.") + public Boolean isSelf() { + return self; + } + + public void setSelf(Boolean self) { + this.self = self; + } + + public DetailedParticipantInfo company(String company) { + this.company = company; + return this; + } + + /** + * The company of the participant, if available. + * @return company + **/ + @ApiModelProperty(value = "The company of the participant, if available.") + public String getCompany() { + return company; + } + + public void setCompany(String company) { + this.company = company; + } + + public DetailedParticipantInfo id(String id) { + this.id = id; + return this; + } + + /** + * The unique identifier of the participant. + * @return id + **/ + @ApiModelProperty(value = "The unique identifier of the participant.") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public DetailedParticipantInfo privateMessage(String privateMessage) { + this.privateMessage = privateMessage; + return this; + } + + /** + * The private message of the participant, if available. This cannot be changed as part of the PUT call. + * @return privateMessage + **/ + @ApiModelProperty(value = "The private message of the participant, if available. This cannot be changed as part of the PUT call.") + public String getPrivateMessage() { + return privateMessage; + } + + public void setPrivateMessage(String privateMessage) { + this.privateMessage = privateMessage; + } + + public DetailedParticipantInfo userId(String userId) { + this.userId = userId; + return this; + } + + /** + * The user ID of the participant. This will be returned as part of GET call but is ignored if passed as part of PUT call. + * @return userId + **/ + @ApiModelProperty(value = "The user ID of the participant. This will be returned as part of GET call but is ignored if passed as part of PUT call.") + public String getUserId() { + return userId; + } + + public void setUserId(String userId) { + this.userId = userId; + } + + public DetailedParticipantInfo email(String email) { + this.email = email; + return this; + } + + /** + * Email of the participant. This is the required field and will always be returned unless it is a fax workflow (legacy megaSigns) that were created using fax as input + * @return email + **/ + @ApiModelProperty(value = "Email of the participant. This is the required field and will always be returned unless it is a fax workflow (legacy megaSigns) that were created using fax as input") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + public DetailedParticipantInfo securityOption(ParticipantSecurityOption securityOption) { + this.securityOption = securityOption; + return this; + } + + /** + * Security options that apply to the participant. + * @return securityOption + **/ + @ApiModelProperty(value = "Security options that apply to the participant.") + public ParticipantSecurityOption getSecurityOption() { + return securityOption; + } + + public void setSecurityOption(ParticipantSecurityOption securityOption) { + this.securityOption = securityOption; + } + + public DetailedParticipantInfo status(StatusEnum status) { + this.status = status; + return this; + } + + /** + * The status of the participant. + * @return status + **/ + @ApiModelProperty(value = "The status of the participant.") + public StatusEnum getStatus() { + return status; + } + + public void setStatus(StatusEnum status) { + this.status = status; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + DetailedParticipantInfo detailedParticipantInfo = (DetailedParticipantInfo) o; + return Objects.equals(this.createdDate, detailedParticipantInfo.createdDate) && + Objects.equals(this.hidden, detailedParticipantInfo.hidden) && + Objects.equals(this.name, detailedParticipantInfo.name) && + Objects.equals(this.self, detailedParticipantInfo.self) && + Objects.equals(this.company, detailedParticipantInfo.company) && + Objects.equals(this.id, detailedParticipantInfo.id) && + Objects.equals(this.privateMessage, detailedParticipantInfo.privateMessage) && + Objects.equals(this.userId, detailedParticipantInfo.userId) && + Objects.equals(this.email, detailedParticipantInfo.email) && + Objects.equals(this.securityOption, detailedParticipantInfo.securityOption) && + Objects.equals(this.status, detailedParticipantInfo.status); + } + + @Override + public int hashCode() { + return Objects.hash(createdDate, hidden, name, self, company, id, privateMessage, userId, email, securityOption, status); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class DetailedParticipantInfo {\n"); + + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" self: ").append(toIndentedString(self)).append("\n"); + sb.append(" company: ").append(toIndentedString(company)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" privateMessage: ").append(toIndentedString(privateMessage)).append("\n"); + sb.append(" userId: ").append(toIndentedString(userId)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/DetailedParticipantSetInfo.java b/src/main/java/io/swagger/client/model/megaSigns/DetailedParticipantSetInfo.java new file mode 100644 index 0000000..cb999ab --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/DetailedParticipantSetInfo.java @@ -0,0 +1,380 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.megaSigns.DetailedParticipantInfo; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * DetailedParticipantSetInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class DetailedParticipantSetInfo { + /** + * Role assumed by all participants in the set (signer, approver etc.). + */ + @JsonAdapter(RoleEnum.Adapter.class) + public enum RoleEnum { + SIGNER("SIGNER"), + + SENDER("SENDER"), + + APPROVER("APPROVER"), + + ACCEPTOR("ACCEPTOR"), + + CERTIFIED_RECIPIENT("CERTIFIED_RECIPIENT"), + + FORM_FILLER("FORM_FILLER"), + + DELEGATE_TO_SIGNER("DELEGATE_TO_SIGNER"), + + DELEGATE_TO_APPROVER("DELEGATE_TO_APPROVER"), + + DELEGATE_TO_ACCEPTOR("DELEGATE_TO_ACCEPTOR"), + + DELEGATE_TO_CERTIFIED_RECIPIENT("DELEGATE_TO_CERTIFIED_RECIPIENT"), + + DELEGATE_TO_FORM_FILLER("DELEGATE_TO_FORM_FILLER"), + + SHARE("SHARE"); + + private String value; + + RoleEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static RoleEnum fromValue(String text) { + for (RoleEnum b : RoleEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final RoleEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public RoleEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return RoleEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("role") + private RoleEnum role = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("id") + private String id = null; + + @SerializedName("privateMessage") + private String privateMessage = null; + + @SerializedName("memberInfos") + private List memberInfos = null; + + @SerializedName("order") + private Integer order = null; + + /** + * The megaSign status with respect to the participant set. + */ + @JsonAdapter(StatusEnum.Adapter.class) + public enum StatusEnum { + CANCELLED("CANCELLED"), + + COMPLETED("COMPLETED"), + + EXPIRED("EXPIRED"), + + NOT_YET_VISIBLE("NOT_YET_VISIBLE"), + + WAITING_FOR_OTHERS("WAITING_FOR_OTHERS"), + + WAITING_FOR_MY_APPROVAL("WAITING_FOR_MY_APPROVAL"), + + WAITING_FOR_AUTHORING("WAITING_FOR_AUTHORING"), + + WAITING_FOR_MY_ACKNOWLEDGEMENT("WAITING_FOR_MY_ACKNOWLEDGEMENT"), + + WAITING_FOR_MY_ACCEPTANCE("WAITING_FOR_MY_ACCEPTANCE"), + + WAITING_FOR_MY_FORM_FILLING("WAITING_FOR_MY_FORM_FILLING"), + + WAITING_FOR_MY_DELEGATION("WAITING_FOR_MY_DELEGATION"), + + WAITING_FOR_MY_SIGNATURE("WAITING_FOR_MY_SIGNATURE"), + + WAITING_FOR_MY_VERIFICATION("WAITING_FOR_MY_VERIFICATION"), + + WAITING_FOR_PREFILL("WAITING_FOR_PREFILL"); + + private String value; + + StatusEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static StatusEnum fromValue(String text) { + for (StatusEnum b : StatusEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public StatusEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return StatusEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("status") + private StatusEnum status = null; + + public DetailedParticipantSetInfo role(RoleEnum role) { + this.role = role; + return this; + } + + /** + * Role assumed by all participants in the set (signer, approver etc.). + * @return role + **/ + @ApiModelProperty(value = "Role assumed by all participants in the set (signer, approver etc.).") + public RoleEnum getRole() { + return role; + } + + public void setRole(RoleEnum role) { + this.role = role; + } + + public DetailedParticipantSetInfo name(String name) { + this.name = name; + return this; + } + + /** + * Name of ParticipantSet (it can be empty, but needs not to be unique in a single megaSign). Maximum no of characters in participant set name is restricted to 255. + * @return name + **/ + @ApiModelProperty(value = "Name of ParticipantSet (it can be empty, but needs not to be unique in a single megaSign). Maximum no of characters in participant set name is restricted to 255.") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public DetailedParticipantSetInfo id(String id) { + this.id = id; + return this; + } + + /** + * The unique identifier of the participant set. + * @return id + **/ + @ApiModelProperty(value = "The unique identifier of the participant set.") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public DetailedParticipantSetInfo privateMessage(String privateMessage) { + this.privateMessage = privateMessage; + return this; + } + + /** + * Participant set's private message - all participants in the set will receive the same message. + * @return privateMessage + **/ + @ApiModelProperty(value = "Participant set's private message - all participants in the set will receive the same message.") + public String getPrivateMessage() { + return privateMessage; + } + + public void setPrivateMessage(String privateMessage) { + this.privateMessage = privateMessage; + } + + public DetailedParticipantSetInfo memberInfos(List memberInfos) { + this.memberInfos = memberInfos; + return this; + } + + public DetailedParticipantSetInfo addMemberInfosItem(DetailedParticipantInfo memberInfosItem) { + if (this.memberInfos == null) { + this.memberInfos = new ArrayList(); + } + this.memberInfos.add(memberInfosItem); + return this; + } + + /** + * Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set + * @return memberInfos + **/ + @ApiModelProperty(value = "Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set") + public List getMemberInfos() { + return memberInfos; + } + + public void setMemberInfos(List memberInfos) { + this.memberInfos = memberInfos; + } + + public DetailedParticipantSetInfo order(Integer order) { + this.order = order; + return this; + } + + /** + * Index indicating sequential signing group (specified for hybrid routing). + * @return order + **/ + @ApiModelProperty(value = "Index indicating sequential signing group (specified for hybrid routing).") + public Integer getOrder() { + return order; + } + + public void setOrder(Integer order) { + this.order = order; + } + + public DetailedParticipantSetInfo status(StatusEnum status) { + this.status = status; + return this; + } + + /** + * The megaSign status with respect to the participant set. + * @return status + **/ + @ApiModelProperty(value = "The megaSign status with respect to the participant set.") + public StatusEnum getStatus() { + return status; + } + + public void setStatus(StatusEnum status) { + this.status = status; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + DetailedParticipantSetInfo detailedParticipantSetInfo = (DetailedParticipantSetInfo) o; + return Objects.equals(this.role, detailedParticipantSetInfo.role) && + Objects.equals(this.name, detailedParticipantSetInfo.name) && + Objects.equals(this.id, detailedParticipantSetInfo.id) && + Objects.equals(this.privateMessage, detailedParticipantSetInfo.privateMessage) && + Objects.equals(this.memberInfos, detailedParticipantSetInfo.memberInfos) && + Objects.equals(this.order, detailedParticipantSetInfo.order) && + Objects.equals(this.status, detailedParticipantSetInfo.status); + } + + @Override + public int hashCode() { + return Objects.hash(role, name, id, privateMessage, memberInfos, order, status); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class DetailedParticipantSetInfo {\n"); + + sb.append(" role: ").append(toIndentedString(role)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" privateMessage: ").append(toIndentedString(privateMessage)).append("\n"); + sb.append(" memberInfos: ").append(toIndentedString(memberInfos)).append("\n"); + sb.append(" order: ").append(toIndentedString(order)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/DeviceLocation.java b/src/main/java/io/swagger/client/model/megaSigns/DeviceLocation.java index 180917e..43f5131 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/DeviceLocation.java +++ b/src/main/java/io/swagger/client/model/megaSigns/DeviceLocation.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * DeviceLocation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class DeviceLocation { @SerializedName("latitude") private Float latitude = null; diff --git a/src/main/java/io/swagger/client/model/megaSigns/DigitalSignatureInfo.java b/src/main/java/io/swagger/client/model/megaSigns/DigitalSignatureInfo.java index 27ea99c..a2688e7 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/DigitalSignatureInfo.java +++ b/src/main/java/io/swagger/client/model/megaSigns/DigitalSignatureInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,16 +26,34 @@ /** * DigitalSignatureInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class DigitalSignatureInfo { + @SerializedName("name") + private String name = null; + @SerializedName("company") private String company = null; @SerializedName("email") private String email = null; - @SerializedName("name") - private String name = null; + public DigitalSignatureInfo name(String name) { + this.name = name; + return this; + } + + /** + * Name captured during digital signing + * @return name + **/ + @ApiModelProperty(value = "Name captured during digital signing") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } public DigitalSignatureInfo company(String company) { this.company = company; @@ -88,24 +91,6 @@ public void setEmail(String email) { this.email = email; } - public DigitalSignatureInfo name(String name) { - this.name = name; - return this; - } - - /** - * Name captured during digital signing - * @return name - **/ - @ApiModelProperty(value = "Name captured during digital signing") - public String getName() { - return name; - } - - public void setName(String name) { - this.name = name; - } - @Override public boolean equals(java.lang.Object o) { @@ -116,14 +101,14 @@ public boolean equals(java.lang.Object o) { return false; } DigitalSignatureInfo digitalSignatureInfo = (DigitalSignatureInfo) o; - return Objects.equals(this.company, digitalSignatureInfo.company) && - Objects.equals(this.email, digitalSignatureInfo.email) && - Objects.equals(this.name, digitalSignatureInfo.name); + return Objects.equals(this.name, digitalSignatureInfo.name) && + Objects.equals(this.company, digitalSignatureInfo.company) && + Objects.equals(this.email, digitalSignatureInfo.email); } @Override public int hashCode() { - return Objects.hash(company, email, name); + return Objects.hash(name, company, email); } @@ -132,9 +117,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DigitalSignatureInfo {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" company: ").append(toIndentedString(company)).append("\n"); sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/megaSigns/Document.java b/src/main/java/io/swagger/client/model/megaSigns/Document.java new file mode 100644 index 0000000..ade10eb --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/Document.java @@ -0,0 +1,209 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.Date; + +/** + * Document + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class Document { + @SerializedName("numPages") + private Integer numPages = null; + + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("id") + private String id = null; + + @SerializedName("label") + private String label = null; + + @SerializedName("mimeType") + private String mimeType = null; + + public Document numPages(Integer numPages) { + this.numPages = numPages; + return this; + } + + /** + * Number of pages in the document + * @return numPages + **/ + @ApiModelProperty(value = "Number of pages in the document") + public Integer getNumPages() { + return numPages; + } + + public void setNumPages(Integer numPages) { + this.numPages = numPages; + } + + public Document createdDate(Date createdDate) { + this.createdDate = createdDate; + return this; + } + + /** + * The date the document was created + * @return createdDate + **/ + @ApiModelProperty(value = "The date the document was created") + public Date getCreatedDate() { + return createdDate; + } + + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } + + public Document name(String name) { + this.name = name; + return this; + } + + /** + * Name of the original document uploaded. This is returned in GET but not accepted back in PUT + * @return name + **/ + @ApiModelProperty(value = "Name of the original document uploaded. This is returned in GET but not accepted back in PUT") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public Document id(String id) { + this.id = id; + return this; + } + + /** + * ID of the document. In case of PUT call, this is the only field that is accepted in Document structure. Name and mimeType are ignored in case of PUT call + * @return id + **/ + @ApiModelProperty(value = "ID of the document. In case of PUT call, this is the only field that is accepted in Document structure. Name and mimeType are ignored in case of PUT call") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public Document label(String label) { + this.label = label; + return this; + } + + /** + * Label of the document + * @return label + **/ + @ApiModelProperty(value = "Label of the document") + public String getLabel() { + return label; + } + + public void setLabel(String label) { + this.label = label; + } + + public Document mimeType(String mimeType) { + this.mimeType = mimeType; + return this; + } + + /** + * mimeType of the original file. This is returned in GET but not accepted back in PUT + * @return mimeType + **/ + @ApiModelProperty(value = "mimeType of the original file. This is returned in GET but not accepted back in PUT") + public String getMimeType() { + return mimeType; + } + + public void setMimeType(String mimeType) { + this.mimeType = mimeType; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Document document = (Document) o; + return Objects.equals(this.numPages, document.numPages) && + Objects.equals(this.createdDate, document.createdDate) && + Objects.equals(this.name, document.name) && + Objects.equals(this.id, document.id) && + Objects.equals(this.label, document.label) && + Objects.equals(this.mimeType, document.mimeType); + } + + @Override + public int hashCode() { + return Objects.hash(numPages, createdDate, name, id, label, mimeType); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Document {\n"); + + sb.append(" numPages: ").append(toIndentedString(numPages)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" label: ").append(toIndentedString(label)).append("\n"); + sb.append(" mimeType: ").append(toIndentedString(mimeType)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/DocumentImageUrls.java b/src/main/java/io/swagger/client/model/megaSigns/DocumentImageUrls.java new file mode 100644 index 0000000..aad9cd3 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/DocumentImageUrls.java @@ -0,0 +1,211 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.megaSigns.PageImageUrl; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * DocumentImageUrls + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class DocumentImageUrls { + @SerializedName("imageURLs") + private List imageURLs = null; + + @SerializedName("imagesAvailable") + private Boolean imagesAvailable = null; + + /** + * ImageSize corresponding to the imageUrl returned + */ + @JsonAdapter(ImageSizeEnum.Adapter.class) + public enum ImageSizeEnum { + FIXED_WIDTH_50PX("FIXED_WIDTH_50px"), + + FIXED_WIDTH_250PX("FIXED_WIDTH_250px"), + + FIXED_WIDTH_675PX("FIXED_WIDTH_675px"), + + ZOOM_50_PERCENT("ZOOM_50_PERCENT"), + + ZOOM_75_PERCENT("ZOOM_75_PERCENT"), + + ZOOM_100_PERCENT("ZOOM_100_PERCENT"), + + ZOOM_125_PERCENT("ZOOM_125_PERCENT"), + + ZOOM_150_PERCENT("ZOOM_150_PERCENT"), + + ZOOM_200_PERCENT("ZOOM_200_PERCENT"); + + private String value; + + ImageSizeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ImageSizeEnum fromValue(String text) { + for (ImageSizeEnum b : ImageSizeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ImageSizeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ImageSizeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ImageSizeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("imageSize") + private ImageSizeEnum imageSize = null; + + public DocumentImageUrls imageURLs(List imageURLs) { + this.imageURLs = imageURLs; + return this; + } + + public DocumentImageUrls addImageURLsItem(PageImageUrl imageURLsItem) { + if (this.imageURLs == null) { + this.imageURLs = new ArrayList(); + } + this.imageURLs.add(imageURLsItem); + return this; + } + + /** + * A list of image url (one per page). + * @return imageURLs + **/ + @ApiModelProperty(value = "A list of image url (one per page).") + public List getImageURLs() { + return imageURLs; + } + + public void setImageURLs(List imageURLs) { + this.imageURLs = imageURLs; + } + + public DocumentImageUrls imagesAvailable(Boolean imagesAvailable) { + this.imagesAvailable = imagesAvailable; + return this; + } + + /** + * true if images for the associated image size is available, else false. + * @return imagesAvailable + **/ + @ApiModelProperty(value = "true if images for the associated image size is available, else false.") + public Boolean isImagesAvailable() { + return imagesAvailable; + } + + public void setImagesAvailable(Boolean imagesAvailable) { + this.imagesAvailable = imagesAvailable; + } + + public DocumentImageUrls imageSize(ImageSizeEnum imageSize) { + this.imageSize = imageSize; + return this; + } + + /** + * ImageSize corresponding to the imageUrl returned + * @return imageSize + **/ + @ApiModelProperty(value = "ImageSize corresponding to the imageUrl returned ") + public ImageSizeEnum getImageSize() { + return imageSize; + } + + public void setImageSize(ImageSizeEnum imageSize) { + this.imageSize = imageSize; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + DocumentImageUrls documentImageUrls = (DocumentImageUrls) o; + return Objects.equals(this.imageURLs, documentImageUrls.imageURLs) && + Objects.equals(this.imagesAvailable, documentImageUrls.imagesAvailable) && + Objects.equals(this.imageSize, documentImageUrls.imageSize); + } + + @Override + public int hashCode() { + return Objects.hash(imageURLs, imagesAvailable, imageSize); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class DocumentImageUrls {\n"); + + sb.append(" imageURLs: ").append(toIndentedString(imageURLs)).append("\n"); + sb.append(" imagesAvailable: ").append(toIndentedString(imagesAvailable)).append("\n"); + sb.append(" imageSize: ").append(toIndentedString(imageSize)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/DocumentImageUrlsInfo.java b/src/main/java/io/swagger/client/model/megaSigns/DocumentImageUrlsInfo.java new file mode 100644 index 0000000..c57cbf7 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/DocumentImageUrlsInfo.java @@ -0,0 +1,127 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.megaSigns.DocumentImageUrls; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * DocumentImageUrlsInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class DocumentImageUrlsInfo { + @SerializedName("documentImageUrlsList") + private List documentImageUrlsList = null; + + @SerializedName("documentId") + private String documentId = null; + + public DocumentImageUrlsInfo documentImageUrlsList(List documentImageUrlsList) { + this.documentImageUrlsList = documentImageUrlsList; + return this; + } + + public DocumentImageUrlsInfo addDocumentImageUrlsListItem(DocumentImageUrls documentImageUrlsListItem) { + if (this.documentImageUrlsList == null) { + this.documentImageUrlsList = new ArrayList(); + } + this.documentImageUrlsList.add(documentImageUrlsListItem); + return this; + } + + /** + * A list of documents image URLs. + * @return documentImageUrlsList + **/ + @ApiModelProperty(value = "A list of documents image URLs.") + public List getDocumentImageUrlsList() { + return documentImageUrlsList; + } + + public void setDocumentImageUrlsList(List documentImageUrlsList) { + this.documentImageUrlsList = documentImageUrlsList; + } + + public DocumentImageUrlsInfo documentId(String documentId) { + this.documentId = documentId; + return this; + } + + /** + * Id of the document + * @return documentId + **/ + @ApiModelProperty(value = "Id of the document") + public String getDocumentId() { + return documentId; + } + + public void setDocumentId(String documentId) { + this.documentId = documentId; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + DocumentImageUrlsInfo documentImageUrlsInfo = (DocumentImageUrlsInfo) o; + return Objects.equals(this.documentImageUrlsList, documentImageUrlsInfo.documentImageUrlsList) && + Objects.equals(this.documentId, documentImageUrlsInfo.documentId); + } + + @Override + public int hashCode() { + return Objects.hash(documentImageUrlsList, documentId); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class DocumentImageUrlsInfo {\n"); + + sb.append(" documentImageUrlsList: ").append(toIndentedString(documentImageUrlsList)).append("\n"); + sb.append(" documentId: ").append(toIndentedString(documentId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/DocumentUrl.java b/src/main/java/io/swagger/client/model/megaSigns/DocumentUrl.java new file mode 100644 index 0000000..3fd8da4 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/DocumentUrl.java @@ -0,0 +1,93 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * DocumentUrl + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class DocumentUrl { + @SerializedName("url") + private String url = null; + + public DocumentUrl url(String url) { + this.url = url; + return this; + } + + /** + * Secure URL of the document + * @return url + **/ + @ApiModelProperty(value = "Secure URL of the document") + public String getUrl() { + return url; + } + + public void setUrl(String url) { + this.url = url; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + DocumentUrl documentUrl = (DocumentUrl) o; + return Objects.equals(this.url, documentUrl.url); + } + + @Override + public int hashCode() { + return Objects.hash(url); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class DocumentUrl {\n"); + + sb.append(" url: ").append(toIndentedString(url)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/ExternalId.java b/src/main/java/io/swagger/client/model/megaSigns/ExternalId.java index 925b1ae..1ac4523 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/ExternalId.java +++ b/src/main/java/io/swagger/client/model/megaSigns/ExternalId.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * ExternalId */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class ExternalId { @SerializedName("id") private String id = null; diff --git a/src/main/java/io/swagger/client/model/megaSigns/FetchedMegaSignInfo.java b/src/main/java/io/swagger/client/model/megaSigns/FetchedMegaSignInfo.java new file mode 100644 index 0000000..680c330 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/FetchedMegaSignInfo.java @@ -0,0 +1,827 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.megaSigns.ChildAgreementsInfo; +import io.swagger.client.model.megaSigns.ExternalId; +import io.swagger.client.model.megaSigns.FileInfo; +import io.swagger.client.model.megaSigns.MegaSignCcInfo; +import io.swagger.client.model.megaSigns.MegaSignSecurityOption; +import io.swagger.client.model.megaSigns.PostSignOption; +import io.swagger.client.model.megaSigns.VaultingInfo; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +/** + * FetchedMegaSignInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class FetchedMegaSignInfo { + @SerializedName("firstReminderDelay") + private Integer firstReminderDelay = null; + + @SerializedName("groupId") + private String groupId = null; + + @SerializedName("childAgreementsInfo") + private ChildAgreementsInfo childAgreementsInfo = null; + + /** + * Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system + */ + @JsonAdapter(SignatureTypeEnum.Adapter.class) + public enum SignatureTypeEnum { + ESIGN("ESIGN"), + + WRITTEN("WRITTEN"); + + private String value; + + SignatureTypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static SignatureTypeEnum fromValue(String text) { + for (SignatureTypeEnum b : SignatureTypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final SignatureTypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public SignatureTypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return SignatureTypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("signatureType") + private SignatureTypeEnum signatureType = null; + + @SerializedName("externalId") + private ExternalId externalId = null; + + @SerializedName("locale") + private String locale = null; + + @SerializedName("message") + private String message = null; + + @SerializedName("vaultingInfo") + private VaultingInfo vaultingInfo = null; + + @SerializedName("securityOption") + private MegaSignSecurityOption securityOption = null; + + @SerializedName("postSignOption") + private PostSignOption postSignOption = null; + + /** + * Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used + */ + @JsonAdapter(ReminderFrequencyEnum.Adapter.class) + public enum ReminderFrequencyEnum { + DAILY_UNTIL_SIGNED("DAILY_UNTIL_SIGNED"), + + WEEKDAILY_UNTIL_SIGNED("WEEKDAILY_UNTIL_SIGNED"), + + EVERY_OTHER_DAY_UNTIL_SIGNED("EVERY_OTHER_DAY_UNTIL_SIGNED"), + + EVERY_THIRD_DAY_UNTIL_SIGNED("EVERY_THIRD_DAY_UNTIL_SIGNED"), + + EVERY_FIFTH_DAY_UNTIL_SIGNED("EVERY_FIFTH_DAY_UNTIL_SIGNED"), + + WEEKLY_UNTIL_SIGNED("WEEKLY_UNTIL_SIGNED"); + + private String value; + + ReminderFrequencyEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ReminderFrequencyEnum fromValue(String text) { + for (ReminderFrequencyEnum b : ReminderFrequencyEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ReminderFrequencyEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ReminderFrequencyEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ReminderFrequencyEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("reminderFrequency") + private ReminderFrequencyEnum reminderFrequency = null; + + @SerializedName("ccs") + private List ccs = null; + + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("isDocumentRetentionApplied") + private Boolean isDocumentRetentionApplied = null; + + @SerializedName("expirationTime") + private Date expirationTime = null; + + @SerializedName("lastEventDate") + private Date lastEventDate = null; + + @SerializedName("senderEmail") + private String senderEmail = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("numChildren") + private Integer numChildren = null; + + @SerializedName("fileInfos") + private List fileInfos = null; + + @SerializedName("id") + private String id = null; + + /** + * State of the Megasign + */ + @JsonAdapter(StateEnum.Adapter.class) + public enum StateEnum { + PROCESS("IN_PROCESS"); + + private String value; + + StateEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static StateEnum fromValue(String text) { + for (StateEnum b : StateEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public StateEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return StateEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("state") + private StateEnum state = null; + + /** + * Status of the Megasign + */ + @JsonAdapter(StatusEnum.Adapter.class) + public enum StatusEnum { + AUTHORING("AUTHORING"), + + IN_PROCESS("IN_PROCESS"), + + CANCELLED("CANCELLED"), + + COMPLETED("COMPLETED"), + + EXPIRED("EXPIRED"), + + PREFILL("PREFILL"); + + private String value; + + StatusEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static StatusEnum fromValue(String text) { + for (StatusEnum b : StatusEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public StatusEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return StatusEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("status") + private StatusEnum status = null; + + public FetchedMegaSignInfo firstReminderDelay(Integer firstReminderDelay) { + this.firstReminderDelay = firstReminderDelay; + return this; + } + + /** + * Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT + * @return firstReminderDelay + **/ + @ApiModelProperty(value = "Integer which specifies the delay in hours before sending the first reminder.
This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.
If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.
i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT") + public Integer getFirstReminderDelay() { + return firstReminderDelay; + } + + public void setFirstReminderDelay(Integer firstReminderDelay) { + this.firstReminderDelay = firstReminderDelay; + } + + public FetchedMegaSignInfo groupId(String groupId) { + this.groupId = groupId; + return this; + } + + /** + * The unique identifier of the group to which the megasign agreement will belong to when it is created. If it is not provided during agreement creation the primary group of the creator will be used + * @return groupId + **/ + @ApiModelProperty(value = "The unique identifier of the group to which the megasign agreement will belong to when it is created. If it is not provided during agreement creation the primary group of the creator will be used") + public String getGroupId() { + return groupId; + } + + public void setGroupId(String groupId) { + this.groupId = groupId; + } + + public FetchedMegaSignInfo childAgreementsInfo(ChildAgreementsInfo childAgreementsInfo) { + this.childAgreementsInfo = childAgreementsInfo; + return this; + } + + /** + * Info corresponding to each child agreement of the megaSign + * @return childAgreementsInfo + **/ + @ApiModelProperty(value = "Info corresponding to each child agreement of the megaSign ") + public ChildAgreementsInfo getChildAgreementsInfo() { + return childAgreementsInfo; + } + + public void setChildAgreementsInfo(ChildAgreementsInfo childAgreementsInfo) { + this.childAgreementsInfo = childAgreementsInfo; + } + + public FetchedMegaSignInfo signatureType(SignatureTypeEnum signatureType) { + this.signatureType = signatureType; + return this; + } + + /** + * Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system + * @return signatureType + **/ + @ApiModelProperty(value = "Specifies the type of signature you would like to request - written or e-signature. The possible values are
ESIGN : Agreement needs to be signed electronically
, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system") + public SignatureTypeEnum getSignatureType() { + return signatureType; + } + + public void setSignatureType(SignatureTypeEnum signatureType) { + this.signatureType = signatureType; + } + + public FetchedMegaSignInfo externalId(ExternalId externalId) { + this.externalId = externalId; + return this; + } + + /** + * An arbitrary value from your system, which can be specified at sending time and then later returned or queried + * @return externalId + **/ + @ApiModelProperty(value = "An arbitrary value from your system, which can be specified at sending time and then later returned or queried") + public ExternalId getExternalId() { + return externalId; + } + + public void setExternalId(ExternalId externalId) { + this.externalId = externalId; + } + + public FetchedMegaSignInfo locale(String locale) { + this.locale = locale; + return this; + } + + /** + * The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender + * @return locale + **/ + @ApiModelProperty(value = "The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender") + public String getLocale() { + return locale; + } + + public void setLocale(String locale) { + this.locale = locale; + } + + public FetchedMegaSignInfo message(String message) { + this.message = message; + return this; + } + + /** + * An optional message to the participants, describing what is being sent or why their signature is required + * @return message + **/ + @ApiModelProperty(value = "An optional message to the participants, describing what is being sent or why their signature is required") + public String getMessage() { + return message; + } + + public void setMessage(String message) { + this.message = message; + } + + public FetchedMegaSignInfo vaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; + return this; + } + + /** + * Vaulting properties that allows Adobe Sign to securely store documents with a vault provider + * @return vaultingInfo + **/ + @ApiModelProperty(value = "Vaulting properties that allows Adobe Sign to securely store documents with a vault provider") + public VaultingInfo getVaultingInfo() { + return vaultingInfo; + } + + public void setVaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; + } + + public FetchedMegaSignInfo securityOption(MegaSignSecurityOption securityOption) { + this.securityOption = securityOption; + return this; + } + + /** + * Optional security parameters for the megasign + * @return securityOption + **/ + @ApiModelProperty(value = "Optional security parameters for the megasign") + public MegaSignSecurityOption getSecurityOption() { + return securityOption; + } + + public void setSecurityOption(MegaSignSecurityOption securityOption) { + this.securityOption = securityOption; + } + + public FetchedMegaSignInfo postSignOption(PostSignOption postSignOption) { + this.postSignOption = postSignOption; + return this; + } + + /** + * URL and associated properties for the success page the user will be taken to after completing the signing process + * @return postSignOption + **/ + @ApiModelProperty(value = "URL and associated properties for the success page the user will be taken to after completing the signing process") + public PostSignOption getPostSignOption() { + return postSignOption; + } + + public void setPostSignOption(PostSignOption postSignOption) { + this.postSignOption = postSignOption; + } + + public FetchedMegaSignInfo reminderFrequency(ReminderFrequencyEnum reminderFrequency) { + this.reminderFrequency = reminderFrequency; + return this; + } + + /** + * Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used + * @return reminderFrequency + **/ + @ApiModelProperty(value = "Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used") + public ReminderFrequencyEnum getReminderFrequency() { + return reminderFrequency; + } + + public void setReminderFrequency(ReminderFrequencyEnum reminderFrequency) { + this.reminderFrequency = reminderFrequency; + } + + public FetchedMegaSignInfo ccs(List ccs) { + this.ccs = ccs; + return this; + } + + public FetchedMegaSignInfo addCcsItem(MegaSignCcInfo ccsItem) { + if (this.ccs == null) { + this.ccs = new ArrayList(); + } + this.ccs.add(ccsItem); + return this; + } + + /** + * A list of one or more CCs that will be copied in the megasign transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file + * @return ccs + **/ + @ApiModelProperty(value = "A list of one or more CCs that will be copied in the megasign transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file ") + public List getCcs() { + return ccs; + } + + public void setCcs(List ccs) { + this.ccs = ccs; + } + + public FetchedMegaSignInfo createdDate(Date createdDate) { + this.createdDate = createdDate; + return this; + } + + /** + * Date when megasign was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return createdDate + **/ + @ApiModelProperty(value = "Date when megasign was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getCreatedDate() { + return createdDate; + } + + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } + + public FetchedMegaSignInfo isDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; + return this; + } + + /** + * Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. + * @return isDocumentRetentionApplied + **/ + @ApiModelProperty(value = "Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored.") + public Boolean isIsDocumentRetentionApplied() { + return isDocumentRetentionApplied; + } + + public void setIsDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; + } + + public FetchedMegaSignInfo expirationTime(Date expirationTime) { + this.expirationTime = expirationTime; + return this; + } + + /** + * Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. + * @return expirationTime + **/ + @ApiModelProperty(value = "Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation.") + public Date getExpirationTime() { + return expirationTime; + } + + public void setExpirationTime(Date expirationTime) { + this.expirationTime = expirationTime; + } + + public FetchedMegaSignInfo lastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; + return this; + } + + /** + * The date of the last event that occurred for this megasign. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return lastEventDate + **/ + @ApiModelProperty(value = "The date of the last event that occurred for this megasign. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getLastEventDate() { + return lastEventDate; + } + + public void setLastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; + } + + public FetchedMegaSignInfo senderEmail(String senderEmail) { + this.senderEmail = senderEmail; + return this; + } + + /** + * Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored + * @return senderEmail + **/ + @ApiModelProperty(value = "Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored") + public String getSenderEmail() { + return senderEmail; + } + + public void setSenderEmail(String senderEmail) { + this.senderEmail = senderEmail; + } + + public FetchedMegaSignInfo name(String name) { + this.name = name; + return this; + } + + /** + * The name of the agreement that will be used to identify it, in emails, website and other places + * @return name + **/ + @ApiModelProperty(value = "The name of the agreement that will be used to identify it, in emails, website and other places") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public FetchedMegaSignInfo numChildren(Integer numChildren) { + this.numChildren = numChildren; + return this; + } + + /** + * The total number of MegaSign children associated with the MegaSign parent. If provided in POST, it will be ignored. If modified in PUT, it will throw error MODIFYING_IMMUTABLE_FIELDS + * @return numChildren + **/ + @ApiModelProperty(value = "The total number of MegaSign children associated with the MegaSign parent. If provided in POST, it will be ignored. If modified in PUT, it will throw error MODIFYING_IMMUTABLE_FIELDS") + public Integer getNumChildren() { + return numChildren; + } + + public void setNumChildren(Integer numChildren) { + this.numChildren = numChildren; + } + + public FetchedMegaSignInfo fileInfos(List fileInfos) { + this.fileInfos = fileInfos; + return this; + } + + public FetchedMegaSignInfo addFileInfosItem(FileInfo fileInfosItem) { + if (this.fileInfos == null) { + this.fileInfos = new ArrayList(); + } + this.fileInfos.add(fileInfosItem); + return this; + } + + /** + * A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified + * @return fileInfos + **/ + @ApiModelProperty(value = "A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified") + public List getFileInfos() { + return fileInfos; + } + + public void setFileInfos(List fileInfos) { + this.fileInfos = fileInfos; + } + + public FetchedMegaSignInfo id(String id) { + this.id = id; + return this; + } + + /** + * The unique identifier of megasign + * @return id + **/ + @ApiModelProperty(value = "The unique identifier of megasign ") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public FetchedMegaSignInfo state(StateEnum state) { + this.state = state; + return this; + } + + /** + * State of the Megasign + * @return state + **/ + @ApiModelProperty(value = "State of the Megasign") + public StateEnum getState() { + return state; + } + + public void setState(StateEnum state) { + this.state = state; + } + + public FetchedMegaSignInfo status(StatusEnum status) { + this.status = status; + return this; + } + + /** + * Status of the Megasign + * @return status + **/ + @ApiModelProperty(value = "Status of the Megasign") + public StatusEnum getStatus() { + return status; + } + + public void setStatus(StatusEnum status) { + this.status = status; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FetchedMegaSignInfo fetchedMegaSignInfo = (FetchedMegaSignInfo) o; + return Objects.equals(this.firstReminderDelay, fetchedMegaSignInfo.firstReminderDelay) && + Objects.equals(this.groupId, fetchedMegaSignInfo.groupId) && + Objects.equals(this.childAgreementsInfo, fetchedMegaSignInfo.childAgreementsInfo) && + Objects.equals(this.signatureType, fetchedMegaSignInfo.signatureType) && + Objects.equals(this.externalId, fetchedMegaSignInfo.externalId) && + Objects.equals(this.locale, fetchedMegaSignInfo.locale) && + Objects.equals(this.message, fetchedMegaSignInfo.message) && + Objects.equals(this.vaultingInfo, fetchedMegaSignInfo.vaultingInfo) && + Objects.equals(this.securityOption, fetchedMegaSignInfo.securityOption) && + Objects.equals(this.postSignOption, fetchedMegaSignInfo.postSignOption) && + Objects.equals(this.reminderFrequency, fetchedMegaSignInfo.reminderFrequency) && + Objects.equals(this.ccs, fetchedMegaSignInfo.ccs) && + Objects.equals(this.createdDate, fetchedMegaSignInfo.createdDate) && + Objects.equals(this.isDocumentRetentionApplied, fetchedMegaSignInfo.isDocumentRetentionApplied) && + Objects.equals(this.expirationTime, fetchedMegaSignInfo.expirationTime) && + Objects.equals(this.lastEventDate, fetchedMegaSignInfo.lastEventDate) && + Objects.equals(this.senderEmail, fetchedMegaSignInfo.senderEmail) && + Objects.equals(this.name, fetchedMegaSignInfo.name) && + Objects.equals(this.numChildren, fetchedMegaSignInfo.numChildren) && + Objects.equals(this.fileInfos, fetchedMegaSignInfo.fileInfos) && + Objects.equals(this.id, fetchedMegaSignInfo.id) && + Objects.equals(this.state, fetchedMegaSignInfo.state) && + Objects.equals(this.status, fetchedMegaSignInfo.status); + } + + @Override + public int hashCode() { + return Objects.hash(firstReminderDelay, groupId, childAgreementsInfo, signatureType, externalId, locale, message, vaultingInfo, securityOption, postSignOption, reminderFrequency, ccs, createdDate, isDocumentRetentionApplied, expirationTime, lastEventDate, senderEmail, name, numChildren, fileInfos, id, state, status); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FetchedMegaSignInfo {\n"); + + sb.append(" firstReminderDelay: ").append(toIndentedString(firstReminderDelay)).append("\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); + sb.append(" childAgreementsInfo: ").append(toIndentedString(childAgreementsInfo)).append("\n"); + sb.append(" signatureType: ").append(toIndentedString(signatureType)).append("\n"); + sb.append(" externalId: ").append(toIndentedString(externalId)).append("\n"); + sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" vaultingInfo: ").append(toIndentedString(vaultingInfo)).append("\n"); + sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); + sb.append(" postSignOption: ").append(toIndentedString(postSignOption)).append("\n"); + sb.append(" reminderFrequency: ").append(toIndentedString(reminderFrequency)).append("\n"); + sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" isDocumentRetentionApplied: ").append(toIndentedString(isDocumentRetentionApplied)).append("\n"); + sb.append(" expirationTime: ").append(toIndentedString(expirationTime)).append("\n"); + sb.append(" lastEventDate: ").append(toIndentedString(lastEventDate)).append("\n"); + sb.append(" senderEmail: ").append(toIndentedString(senderEmail)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" numChildren: ").append(toIndentedString(numChildren)).append("\n"); + sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" state: ").append(toIndentedString(state)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/FileInfo.java b/src/main/java/io/swagger/client/model/megaSigns/FileInfo.java index 0f4d673..24ebbd3 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/FileInfo.java +++ b/src/main/java/io/swagger/client/model/megaSigns/FileInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,35 +27,17 @@ /** * FileInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class FileInfo { - @SerializedName("libraryDocumentId") - private String libraryDocumentId = null; - @SerializedName("transientDocumentId") private String transientDocumentId = null; + @SerializedName("libraryDocumentId") + private String libraryDocumentId = null; + @SerializedName("urlFileInfo") private URLFileInfo urlFileInfo = null; - public FileInfo libraryDocumentId(String libraryDocumentId) { - this.libraryDocumentId = libraryDocumentId; - return this; - } - - /** - * ID for an existing Library document that will be added to the agreement - * @return libraryDocumentId - **/ - @ApiModelProperty(value = "ID for an existing Library document that will be added to the agreement") - public String getLibraryDocumentId() { - return libraryDocumentId; - } - - public void setLibraryDocumentId(String libraryDocumentId) { - this.libraryDocumentId = libraryDocumentId; - } - public FileInfo transientDocumentId(String transientDocumentId) { this.transientDocumentId = transientDocumentId; return this; @@ -89,6 +56,24 @@ public void setTransientDocumentId(String transientDocumentId) { this.transientDocumentId = transientDocumentId; } + public FileInfo libraryDocumentId(String libraryDocumentId) { + this.libraryDocumentId = libraryDocumentId; + return this; + } + + /** + * ID for an existing Library document that will be added to the agreement + * @return libraryDocumentId + **/ + @ApiModelProperty(value = "ID for an existing Library document that will be added to the agreement") + public String getLibraryDocumentId() { + return libraryDocumentId; + } + + public void setLibraryDocumentId(String libraryDocumentId) { + this.libraryDocumentId = libraryDocumentId; + } + public FileInfo urlFileInfo(URLFileInfo urlFileInfo) { this.urlFileInfo = urlFileInfo; return this; @@ -117,14 +102,14 @@ public boolean equals(java.lang.Object o) { return false; } FileInfo fileInfo = (FileInfo) o; - return Objects.equals(this.libraryDocumentId, fileInfo.libraryDocumentId) && - Objects.equals(this.transientDocumentId, fileInfo.transientDocumentId) && + return Objects.equals(this.transientDocumentId, fileInfo.transientDocumentId) && + Objects.equals(this.libraryDocumentId, fileInfo.libraryDocumentId) && Objects.equals(this.urlFileInfo, fileInfo.urlFileInfo); } @Override public int hashCode() { - return Objects.hash(libraryDocumentId, transientDocumentId, urlFileInfo); + return Objects.hash(transientDocumentId, libraryDocumentId, urlFileInfo); } @@ -133,8 +118,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class FileInfo {\n"); - sb.append(" libraryDocumentId: ").append(toIndentedString(libraryDocumentId)).append("\n"); sb.append(" transientDocumentId: ").append(toIndentedString(transientDocumentId)).append("\n"); + sb.append(" libraryDocumentId: ").append(toIndentedString(libraryDocumentId)).append("\n"); sb.append(" urlFileInfo: ").append(toIndentedString(urlFileInfo)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegaSign.java b/src/main/java/io/swagger/client/model/megaSigns/MegaSign.java index d7052e5..c9bf29a 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/MegaSign.java +++ b/src/main/java/io/swagger/client/model/megaSigns/MegaSign.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,13 +27,16 @@ /** * MegaSign */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class MegaSign { + @SerializedName("hidden") + private Boolean hidden = null; + @SerializedName("displayDate") private Date displayDate = null; - @SerializedName("id") - private String id = null; + @SerializedName("groupId") + private String groupId = null; @SerializedName("esign") private Boolean esign = null; @@ -56,6 +44,9 @@ public class MegaSign { @SerializedName("name") private String name = null; + @SerializedName("id") + private String id = null; + /** * Current status of the MegaSign parent agreement from the perspective of the user */ @@ -116,6 +107,24 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; + public MegaSign hidden(Boolean hidden) { + this.hidden = hidden; + return this; + } + + /** + * True, if megaSign is hidden for the user + * @return hidden + **/ + @ApiModelProperty(value = "True, if megaSign is hidden for the user") + public Boolean isHidden() { + return hidden; + } + + public void setHidden(Boolean hidden) { + this.hidden = hidden; + } + public MegaSign displayDate(Date displayDate) { this.displayDate = displayDate; return this; @@ -134,22 +143,22 @@ public void setDisplayDate(Date displayDate) { this.displayDate = displayDate; } - public MegaSign id(String id) { - this.id = id; + public MegaSign groupId(String groupId) { + this.groupId = groupId; return this; } /** - * The unique identifier of the MegaSign parent agreement - * @return id + * Unique identifier of the group + * @return groupId **/ - @ApiModelProperty(value = "The unique identifier of the MegaSign parent agreement") - public String getId() { - return id; + @ApiModelProperty(value = "Unique identifier of the group") + public String getGroupId() { + return groupId; } - public void setId(String id) { - this.id = id; + public void setGroupId(String groupId) { + this.groupId = groupId; } public MegaSign esign(Boolean esign) { @@ -188,6 +197,24 @@ public void setName(String name) { this.name = name; } + public MegaSign id(String id) { + this.id = id; + return this; + } + + /** + * The unique identifier of the MegaSign parent agreement + * @return id + **/ + @ApiModelProperty(value = "The unique identifier of the MegaSign parent agreement") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + public MegaSign status(StatusEnum status) { this.status = status; return this; @@ -216,16 +243,18 @@ public boolean equals(java.lang.Object o) { return false; } MegaSign megaSign = (MegaSign) o; - return Objects.equals(this.displayDate, megaSign.displayDate) && - Objects.equals(this.id, megaSign.id) && + return Objects.equals(this.hidden, megaSign.hidden) && + Objects.equals(this.displayDate, megaSign.displayDate) && + Objects.equals(this.groupId, megaSign.groupId) && Objects.equals(this.esign, megaSign.esign) && Objects.equals(this.name, megaSign.name) && + Objects.equals(this.id, megaSign.id) && Objects.equals(this.status, megaSign.status); } @Override public int hashCode() { - return Objects.hash(displayDate, id, esign, name, status); + return Objects.hash(hidden, displayDate, groupId, esign, name, id, status); } @@ -234,10 +263,12 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class MegaSign {\n"); + sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); sb.append(" displayDate: ").append(toIndentedString(displayDate)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); sb.append(" esign: ").append(toIndentedString(esign)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegaSignCcInfo.java b/src/main/java/io/swagger/client/model/megaSigns/MegaSignCcInfo.java index 984596e..1bdf92a 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/MegaSignCcInfo.java +++ b/src/main/java/io/swagger/client/model/megaSigns/MegaSignCcInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * MegaSignCcInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class MegaSignCcInfo { @SerializedName("email") private String email = null; diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegaSignChildAgreement.java b/src/main/java/io/swagger/client/model/megaSigns/MegaSignChildAgreement.java index c52e26e..549ab58 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/MegaSignChildAgreement.java +++ b/src/main/java/io/swagger/client/model/megaSigns/MegaSignChildAgreement.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,20 +27,75 @@ /** * MegaSignChildAgreement */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class MegaSignChildAgreement { @SerializedName("displayDate") private Date displayDate = null; - @SerializedName("id") - private String id = null; - @SerializedName("esign") private Boolean esign = null; @SerializedName("name") private String name = null; + @SerializedName("id") + private String id = null; + + /** + * The kind of agreement + */ + @JsonAdapter(TypeEnum.Adapter.class) + public enum TypeEnum { + AGREEMENT("AGREEMENT"), + + MEGASIGN_CHILD("MEGASIGN_CHILD"), + + WIDGET_INSTANCE("WIDGET_INSTANCE"); + + private String value; + + TypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static TypeEnum fromValue(String text) { + for (TypeEnum b : TypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public TypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return TypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("type") + private TypeEnum type = null; + + @SerializedName("parentId") + private String parentId = null; + /** * This is a server generated attribute which provides the detailed status of an agreement with respect to the apiCaller */ @@ -170,24 +210,6 @@ public void setDisplayDate(Date displayDate) { this.displayDate = displayDate; } - public MegaSignChildAgreement id(String id) { - this.id = id; - return this; - } - - /** - * The unique identifier of the agreement.If provided in POST, it will simply be ignored - * @return id - **/ - @ApiModelProperty(value = "The unique identifier of the agreement.If provided in POST, it will simply be ignored") - public String getId() { - return id; - } - - public void setId(String id) { - this.id = id; - } - public MegaSignChildAgreement esign(Boolean esign) { this.esign = esign; return this; @@ -224,6 +246,60 @@ public void setName(String name) { this.name = name; } + public MegaSignChildAgreement id(String id) { + this.id = id; + return this; + } + + /** + * The unique identifier of the agreement.If provided in POST, it will simply be ignored + * @return id + **/ + @ApiModelProperty(value = "The unique identifier of the agreement.If provided in POST, it will simply be ignored") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public MegaSignChildAgreement type(TypeEnum type) { + this.type = type; + return this; + } + + /** + * The kind of agreement + * @return type + **/ + @ApiModelProperty(value = "The kind of agreement") + public TypeEnum getType() { + return type; + } + + public void setType(TypeEnum type) { + this.type = type; + } + + public MegaSignChildAgreement parentId(String parentId) { + this.parentId = parentId; + return this; + } + + /** + * The parent id of a megaSign child *OR* the originating id of a widget agreement instance + * @return parentId + **/ + @ApiModelProperty(value = "The parent id of a megaSign child *OR* the originating id of a widget agreement instance") + public String getParentId() { + return parentId; + } + + public void setParentId(String parentId) { + this.parentId = parentId; + } + public MegaSignChildAgreement status(StatusEnum status) { this.status = status; return this; @@ -253,15 +329,17 @@ public boolean equals(java.lang.Object o) { } MegaSignChildAgreement megaSignChildAgreement = (MegaSignChildAgreement) o; return Objects.equals(this.displayDate, megaSignChildAgreement.displayDate) && - Objects.equals(this.id, megaSignChildAgreement.id) && Objects.equals(this.esign, megaSignChildAgreement.esign) && Objects.equals(this.name, megaSignChildAgreement.name) && + Objects.equals(this.id, megaSignChildAgreement.id) && + Objects.equals(this.type, megaSignChildAgreement.type) && + Objects.equals(this.parentId, megaSignChildAgreement.parentId) && Objects.equals(this.status, megaSignChildAgreement.status); } @Override public int hashCode() { - return Objects.hash(displayDate, id, esign, name, status); + return Objects.hash(displayDate, esign, name, id, type, parentId, status); } @@ -271,9 +349,11 @@ public String toString() { sb.append("class MegaSignChildAgreement {\n"); sb.append(" displayDate: ").append(toIndentedString(displayDate)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" esign: ").append(toIndentedString(esign)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" parentId: ").append(toIndentedString(parentId)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegaSignChildAgreements.java b/src/main/java/io/swagger/client/model/megaSigns/MegaSignChildAgreements.java index 22407f0..2a6571f 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/MegaSignChildAgreements.java +++ b/src/main/java/io/swagger/client/model/megaSigns/MegaSignChildAgreements.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,13 +30,31 @@ /** * MegaSignChildAgreements */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class MegaSignChildAgreements { + @SerializedName("page") + private PageInfo page = null; + @SerializedName("megaSignChildAgreementList") private List megaSignChildAgreementList = null; - @SerializedName("page") - private PageInfo page = null; + public MegaSignChildAgreements page(PageInfo page) { + this.page = page; + return this; + } + + /** + * Pagination information for navigating through the response + * @return page + **/ + @ApiModelProperty(value = "Pagination information for navigating through the response") + public PageInfo getPage() { + return page; + } + + public void setPage(PageInfo page) { + this.page = page; + } public MegaSignChildAgreements megaSignChildAgreementList(List megaSignChildAgreementList) { this.megaSignChildAgreementList = megaSignChildAgreementList; @@ -79,24 +82,6 @@ public void setMegaSignChildAgreementList(List megaSignC this.megaSignChildAgreementList = megaSignChildAgreementList; } - public MegaSignChildAgreements page(PageInfo page) { - this.page = page; - return this; - } - - /** - * Pagination information for navigating through the response - * @return page - **/ - @ApiModelProperty(value = "Pagination information for navigating through the response") - public PageInfo getPage() { - return page; - } - - public void setPage(PageInfo page) { - this.page = page; - } - @Override public boolean equals(java.lang.Object o) { @@ -107,13 +92,13 @@ public boolean equals(java.lang.Object o) { return false; } MegaSignChildAgreements megaSignChildAgreements = (MegaSignChildAgreements) o; - return Objects.equals(this.megaSignChildAgreementList, megaSignChildAgreements.megaSignChildAgreementList) && - Objects.equals(this.page, megaSignChildAgreements.page); + return Objects.equals(this.page, megaSignChildAgreements.page) && + Objects.equals(this.megaSignChildAgreementList, megaSignChildAgreements.megaSignChildAgreementList); } @Override public int hashCode() { - return Objects.hash(megaSignChildAgreementList, page); + return Objects.hash(page, megaSignChildAgreementList); } @@ -122,8 +107,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class MegaSignChildAgreements {\n"); - sb.append(" megaSignChildAgreementList: ").append(toIndentedString(megaSignChildAgreementList)).append("\n"); sb.append(" page: ").append(toIndentedString(page)).append("\n"); + sb.append(" megaSignChildAgreementList: ").append(toIndentedString(megaSignChildAgreementList)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegaSignChildAgreementsFileInfo.java b/src/main/java/io/swagger/client/model/megaSigns/MegaSignChildAgreementsFileInfo.java index c8c6e8d..8337010 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/MegaSignChildAgreementsFileInfo.java +++ b/src/main/java/io/swagger/client/model/megaSigns/MegaSignChildAgreementsFileInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,10 +26,10 @@ /** * MegaSignChildAgreementsFileInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class MegaSignChildAgreementsFileInfo { - @SerializedName("childAgreementsInfoFileId") - private String childAgreementsInfoFileId = null; + @SerializedName("transientDocumentId") + private String transientDocumentId = null; /** * Input type through which participantSetsInfos will be provided. Whichever input type is provided, the values should be provided in its corresponding value object. Currently we are supporting CSV file format for providing megaSIgn child recipients. @@ -94,25 +79,25 @@ public FileTypeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("fileType") private FileTypeEnum fileType = null; - @SerializedName("transientDocumentId") - private String transientDocumentId = null; + @SerializedName("childAgreementsInfoFileId") + private String childAgreementsInfoFileId = null; - public MegaSignChildAgreementsFileInfo childAgreementsInfoFileId(String childAgreementsInfoFileId) { - this.childAgreementsInfoFileId = childAgreementsInfoFileId; + public MegaSignChildAgreementsFileInfo transientDocumentId(String transientDocumentId) { + this.transientDocumentId = transientDocumentId; return this; } /** - * id of the file containg information about the existing childAgreementsInfo associated with the megaSign. Will be ignored in POST call and in case of GET call, this is the only thing that will be returned. The content of the file can be fetched through GET /megaSigns/{megaSignId}/childAgreementsInfo/{childAgreementsInfoFileId} endpoint. - * @return childAgreementsInfoFileId + * Transient id of the input file which contains participantSetsInfos. Currently only csv format is suppported. More details about CSV format <a href='https://www.adobe.com/go/documentcloud_megasigncsv'>here</a> + * @return transientDocumentId **/ - @ApiModelProperty(value = "id of the file containg information about the existing childAgreementsInfo associated with the megaSign. Will be ignored in POST call and in case of GET call, this is the only thing that will be returned. The content of the file can be fetched through GET /megaSigns/{megaSignId}/childAgreementsInfo/{childAgreementsInfoFileId} endpoint.") - public String getChildAgreementsInfoFileId() { - return childAgreementsInfoFileId; + @ApiModelProperty(value = "Transient id of the input file which contains participantSetsInfos. Currently only csv format is suppported. More details about CSV format here ") + public String getTransientDocumentId() { + return transientDocumentId; } - public void setChildAgreementsInfoFileId(String childAgreementsInfoFileId) { - this.childAgreementsInfoFileId = childAgreementsInfoFileId; + public void setTransientDocumentId(String transientDocumentId) { + this.transientDocumentId = transientDocumentId; } public MegaSignChildAgreementsFileInfo fileType(FileTypeEnum fileType) { @@ -133,22 +118,22 @@ public void setFileType(FileTypeEnum fileType) { this.fileType = fileType; } - public MegaSignChildAgreementsFileInfo transientDocumentId(String transientDocumentId) { - this.transientDocumentId = transientDocumentId; + public MegaSignChildAgreementsFileInfo childAgreementsInfoFileId(String childAgreementsInfoFileId) { + this.childAgreementsInfoFileId = childAgreementsInfoFileId; return this; } /** - * Transient id of the input file which contains participantSetsInfos. Currently only csv format is suppported. More details about CSV format <a href='https://www.adobe.com/go/documentcloud_megasigncsv'>here</a> - * @return transientDocumentId + * id of the file containg information about the existing childAgreementsInfo associated with the megaSign. Will be ignored in POST and PUT calls and in the case of GET call, this is the only thing that will be returned. The content of the file can be fetched through GET /megaSigns/{megaSignId}/childAgreementsInfo/{childAgreementsInfoFileId} endpoint. + * @return childAgreementsInfoFileId **/ - @ApiModelProperty(value = "Transient id of the input file which contains participantSetsInfos. Currently only csv format is suppported. More details about CSV format here ") - public String getTransientDocumentId() { - return transientDocumentId; + @ApiModelProperty(value = "id of the file containg information about the existing childAgreementsInfo associated with the megaSign. Will be ignored in POST and PUT calls and in the case of GET call, this is the only thing that will be returned. The content of the file can be fetched through GET /megaSigns/{megaSignId}/childAgreementsInfo/{childAgreementsInfoFileId} endpoint.") + public String getChildAgreementsInfoFileId() { + return childAgreementsInfoFileId; } - public void setTransientDocumentId(String transientDocumentId) { - this.transientDocumentId = transientDocumentId; + public void setChildAgreementsInfoFileId(String childAgreementsInfoFileId) { + this.childAgreementsInfoFileId = childAgreementsInfoFileId; } @@ -161,14 +146,14 @@ public boolean equals(java.lang.Object o) { return false; } MegaSignChildAgreementsFileInfo megaSignChildAgreementsFileInfo = (MegaSignChildAgreementsFileInfo) o; - return Objects.equals(this.childAgreementsInfoFileId, megaSignChildAgreementsFileInfo.childAgreementsInfoFileId) && + return Objects.equals(this.transientDocumentId, megaSignChildAgreementsFileInfo.transientDocumentId) && Objects.equals(this.fileType, megaSignChildAgreementsFileInfo.fileType) && - Objects.equals(this.transientDocumentId, megaSignChildAgreementsFileInfo.transientDocumentId); + Objects.equals(this.childAgreementsInfoFileId, megaSignChildAgreementsFileInfo.childAgreementsInfoFileId); } @Override public int hashCode() { - return Objects.hash(childAgreementsInfoFileId, fileType, transientDocumentId); + return Objects.hash(transientDocumentId, fileType, childAgreementsInfoFileId); } @@ -177,9 +162,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class MegaSignChildAgreementsFileInfo {\n"); - sb.append(" childAgreementsInfoFileId: ").append(toIndentedString(childAgreementsInfoFileId)).append("\n"); - sb.append(" fileType: ").append(toIndentedString(fileType)).append("\n"); sb.append(" transientDocumentId: ").append(toIndentedString(transientDocumentId)).append("\n"); + sb.append(" fileType: ").append(toIndentedString(fileType)).append("\n"); + sb.append(" childAgreementsInfoFileId: ").append(toIndentedString(childAgreementsInfoFileId)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegaSignCreationInfo.java b/src/main/java/io/swagger/client/model/megaSigns/MegaSignCreationInfo.java index 0f93eea..f60eddf 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/MegaSignCreationInfo.java +++ b/src/main/java/io/swagger/client/model/megaSigns/MegaSignCreationInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -51,31 +36,69 @@ /** * MegaSignCreationInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class MegaSignCreationInfo { - @SerializedName("ccs") - private List ccs = null; + @SerializedName("firstReminderDelay") + private Integer firstReminderDelay = null; + + @SerializedName("groupId") + private String groupId = null; @SerializedName("childAgreementsInfo") private ChildAgreementsInfo childAgreementsInfo = null; - @SerializedName("createdDate") - private Date createdDate = null; + /** + * Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system + */ + @JsonAdapter(SignatureTypeEnum.Adapter.class) + public enum SignatureTypeEnum { + ESIGN("ESIGN"), + + WRITTEN("WRITTEN"); - @SerializedName("expirationTime") - private Date expirationTime = null; + private String value; - @SerializedName("externalId") - private ExternalId externalId = null; + SignatureTypeEnum(String value) { + this.value = value; + } - @SerializedName("fileInfos") - private List fileInfos = null; + public String getValue() { + return value; + } - @SerializedName("firstReminderDelay") - private Integer firstReminderDelay = null; + @Override + public String toString() { + return String.valueOf(value); + } - @SerializedName("id") - private String id = null; + public static SignatureTypeEnum fromValue(String text) { + for (SignatureTypeEnum b : SignatureTypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final SignatureTypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public SignatureTypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return SignatureTypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("signatureType") + private SignatureTypeEnum signatureType = null; + + @SerializedName("externalId") + private ExternalId externalId = null; @SerializedName("locale") private String locale = null; @@ -83,8 +106,11 @@ public class MegaSignCreationInfo { @SerializedName("message") private String message = null; - @SerializedName("name") - private String name = null; + @SerializedName("vaultingInfo") + private VaultingInfo vaultingInfo = null; + + @SerializedName("securityOption") + private MegaSignSecurityOption securityOption = null; @SerializedName("postSignOption") private PostSignOption postSignOption = null; @@ -147,61 +173,35 @@ public ReminderFrequencyEnum read(final JsonReader jsonReader) throws IOExceptio @SerializedName("reminderFrequency") private ReminderFrequencyEnum reminderFrequency = null; - @SerializedName("securityOption") - private MegaSignSecurityOption securityOption = null; - - @SerializedName("senderEmail") - private String senderEmail = null; + @SerializedName("ccs") + private List ccs = null; - /** - * Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system - */ - @JsonAdapter(SignatureTypeEnum.Adapter.class) - public enum SignatureTypeEnum { - ESIGN("ESIGN"), - - WRITTEN("WRITTEN"); + @SerializedName("createdDate") + private Date createdDate = null; - private String value; + @SerializedName("isDocumentRetentionApplied") + private Boolean isDocumentRetentionApplied = null; - SignatureTypeEnum(String value) { - this.value = value; - } + @SerializedName("expirationTime") + private Date expirationTime = null; - public String getValue() { - return value; - } + @SerializedName("lastEventDate") + private Date lastEventDate = null; - @Override - public String toString() { - return String.valueOf(value); - } + @SerializedName("senderEmail") + private String senderEmail = null; - public static SignatureTypeEnum fromValue(String text) { - for (SignatureTypeEnum b : SignatureTypeEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } + @SerializedName("name") + private String name = null; - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final SignatureTypeEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } + @SerializedName("numChildren") + private Integer numChildren = null; - @Override - public SignatureTypeEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return SignatureTypeEnum.fromValue(String.valueOf(value)); - } - } - } + @SerializedName("fileInfos") + private List fileInfos = null; - @SerializedName("signatureType") - private SignatureTypeEnum signatureType = null; + @SerializedName("id") + private String id = null; /** * State of the Megasign @@ -309,33 +309,40 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; - @SerializedName("vaultingInfo") - private VaultingInfo vaultingInfo = null; - - public MegaSignCreationInfo ccs(List ccs) { - this.ccs = ccs; + public MegaSignCreationInfo firstReminderDelay(Integer firstReminderDelay) { + this.firstReminderDelay = firstReminderDelay; return this; } - public MegaSignCreationInfo addCcsItem(MegaSignCcInfo ccsItem) { - if (this.ccs == null) { - this.ccs = new ArrayList(); - } - this.ccs.add(ccsItem); + /** + * Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT + * @return firstReminderDelay + **/ + @ApiModelProperty(value = "Integer which specifies the delay in hours before sending the first reminder.
This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.
If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.
i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT") + public Integer getFirstReminderDelay() { + return firstReminderDelay; + } + + public void setFirstReminderDelay(Integer firstReminderDelay) { + this.firstReminderDelay = firstReminderDelay; + } + + public MegaSignCreationInfo groupId(String groupId) { + this.groupId = groupId; return this; } /** - * A list of one or more CCs that will be copied in the megasign transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file - * @return ccs + * The unique identifier of the group to which the megasign agreement will belong to when it is created. If it is not provided during agreement creation the primary group of the creator will be used + * @return groupId **/ - @ApiModelProperty(value = "A list of one or more CCs that will be copied in the megasign transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file ") - public List getCcs() { - return ccs; + @ApiModelProperty(value = "The unique identifier of the group to which the megasign agreement will belong to when it is created. If it is not provided during agreement creation the primary group of the creator will be used") + public String getGroupId() { + return groupId; } - public void setCcs(List ccs) { - this.ccs = ccs; + public void setGroupId(String groupId) { + this.groupId = groupId; } public MegaSignCreationInfo childAgreementsInfo(ChildAgreementsInfo childAgreementsInfo) { @@ -356,40 +363,22 @@ public void setChildAgreementsInfo(ChildAgreementsInfo childAgreementsInfo) { this.childAgreementsInfo = childAgreementsInfo; } - public MegaSignCreationInfo createdDate(Date createdDate) { - this.createdDate = createdDate; - return this; - } - - /** - * Date when megasign was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time - * @return createdDate - **/ - @ApiModelProperty(value = "Date when megasign was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") - public Date getCreatedDate() { - return createdDate; - } - - public void setCreatedDate(Date createdDate) { - this.createdDate = createdDate; - } - - public MegaSignCreationInfo expirationTime(Date expirationTime) { - this.expirationTime = expirationTime; + public MegaSignCreationInfo signatureType(SignatureTypeEnum signatureType) { + this.signatureType = signatureType; return this; } /** - * Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. - * @return expirationTime + * Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system + * @return signatureType **/ - @ApiModelProperty(value = "Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation.") - public Date getExpirationTime() { - return expirationTime; + @ApiModelProperty(value = "Specifies the type of signature you would like to request - written or e-signature. The possible values are
ESIGN : Agreement needs to be signed electronically
, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system") + public SignatureTypeEnum getSignatureType() { + return signatureType; } - public void setExpirationTime(Date expirationTime) { - this.expirationTime = expirationTime; + public void setSignatureType(SignatureTypeEnum signatureType) { + this.signatureType = signatureType; } public MegaSignCreationInfo externalId(ExternalId externalId) { @@ -410,68 +399,6 @@ public void setExternalId(ExternalId externalId) { this.externalId = externalId; } - public MegaSignCreationInfo fileInfos(List fileInfos) { - this.fileInfos = fileInfos; - return this; - } - - public MegaSignCreationInfo addFileInfosItem(FileInfo fileInfosItem) { - if (this.fileInfos == null) { - this.fileInfos = new ArrayList(); - } - this.fileInfos.add(fileInfosItem); - return this; - } - - /** - * A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified - * @return fileInfos - **/ - @ApiModelProperty(value = "A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified") - public List getFileInfos() { - return fileInfos; - } - - public void setFileInfos(List fileInfos) { - this.fileInfos = fileInfos; - } - - public MegaSignCreationInfo firstReminderDelay(Integer firstReminderDelay) { - this.firstReminderDelay = firstReminderDelay; - return this; - } - - /** - * Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT - * @return firstReminderDelay - **/ - @ApiModelProperty(value = "Integer which specifies the delay in hours before sending the first reminder.
This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.
If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.
i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT") - public Integer getFirstReminderDelay() { - return firstReminderDelay; - } - - public void setFirstReminderDelay(Integer firstReminderDelay) { - this.firstReminderDelay = firstReminderDelay; - } - - public MegaSignCreationInfo id(String id) { - this.id = id; - return this; - } - - /** - * The unique identifier of megasign - * @return id - **/ - @ApiModelProperty(value = "The unique identifier of megasign ") - public String getId() { - return id; - } - - public void setId(String id) { - this.id = id; - } - public MegaSignCreationInfo locale(String locale) { this.locale = locale; return this; @@ -508,22 +435,40 @@ public void setMessage(String message) { this.message = message; } - public MegaSignCreationInfo name(String name) { - this.name = name; + public MegaSignCreationInfo vaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; return this; } /** - * The name of the agreement that will be used to identify it, in emails, website and other places - * @return name + * Vaulting properties that allows Adobe Sign to securely store documents with a vault provider + * @return vaultingInfo **/ - @ApiModelProperty(value = "The name of the agreement that will be used to identify it, in emails, website and other places") - public String getName() { - return name; + @ApiModelProperty(value = "Vaulting properties that allows Adobe Sign to securely store documents with a vault provider") + public VaultingInfo getVaultingInfo() { + return vaultingInfo; } - public void setName(String name) { - this.name = name; + public void setVaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; + } + + public MegaSignCreationInfo securityOption(MegaSignSecurityOption securityOption) { + this.securityOption = securityOption; + return this; + } + + /** + * Optional security parameters for the megasign + * @return securityOption + **/ + @ApiModelProperty(value = "Optional security parameters for the megasign") + public MegaSignSecurityOption getSecurityOption() { + return securityOption; + } + + public void setSecurityOption(MegaSignSecurityOption securityOption) { + this.securityOption = securityOption; } public MegaSignCreationInfo postSignOption(PostSignOption postSignOption) { @@ -562,22 +507,102 @@ public void setReminderFrequency(ReminderFrequencyEnum reminderFrequency) { this.reminderFrequency = reminderFrequency; } - public MegaSignCreationInfo securityOption(MegaSignSecurityOption securityOption) { - this.securityOption = securityOption; + public MegaSignCreationInfo ccs(List ccs) { + this.ccs = ccs; + return this; + } + + public MegaSignCreationInfo addCcsItem(MegaSignCcInfo ccsItem) { + if (this.ccs == null) { + this.ccs = new ArrayList(); + } + this.ccs.add(ccsItem); return this; } /** - * Optional security parameters for the megasign - * @return securityOption + * A list of one or more CCs that will be copied in the megasign transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file + * @return ccs **/ - @ApiModelProperty(value = "Optional security parameters for the megasign") - public MegaSignSecurityOption getSecurityOption() { - return securityOption; + @ApiModelProperty(value = "A list of one or more CCs that will be copied in the megasign transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file ") + public List getCcs() { + return ccs; } - public void setSecurityOption(MegaSignSecurityOption securityOption) { - this.securityOption = securityOption; + public void setCcs(List ccs) { + this.ccs = ccs; + } + + public MegaSignCreationInfo createdDate(Date createdDate) { + this.createdDate = createdDate; + return this; + } + + /** + * Date when megasign was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return createdDate + **/ + @ApiModelProperty(value = "Date when megasign was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getCreatedDate() { + return createdDate; + } + + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } + + public MegaSignCreationInfo isDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; + return this; + } + + /** + * Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. + * @return isDocumentRetentionApplied + **/ + @ApiModelProperty(value = "Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored.") + public Boolean isIsDocumentRetentionApplied() { + return isDocumentRetentionApplied; + } + + public void setIsDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; + } + + public MegaSignCreationInfo expirationTime(Date expirationTime) { + this.expirationTime = expirationTime; + return this; + } + + /** + * Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. + * @return expirationTime + **/ + @ApiModelProperty(value = "Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation.") + public Date getExpirationTime() { + return expirationTime; + } + + public void setExpirationTime(Date expirationTime) { + this.expirationTime = expirationTime; + } + + public MegaSignCreationInfo lastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; + return this; + } + + /** + * The date of the last event that occurred for this megasign. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return lastEventDate + **/ + @ApiModelProperty(value = "The date of the last event that occurred for this megasign. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getLastEventDate() { + return lastEventDate; + } + + public void setLastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; } public MegaSignCreationInfo senderEmail(String senderEmail) { @@ -598,22 +623,84 @@ public void setSenderEmail(String senderEmail) { this.senderEmail = senderEmail; } - public MegaSignCreationInfo signatureType(SignatureTypeEnum signatureType) { - this.signatureType = signatureType; + public MegaSignCreationInfo name(String name) { + this.name = name; return this; } /** - * Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system - * @return signatureType + * The name of the agreement that will be used to identify it, in emails, website and other places + * @return name **/ - @ApiModelProperty(value = "Specifies the type of signature you would like to request - written or e-signature. The possible values are
ESIGN : Agreement needs to be signed electronically
, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system") - public SignatureTypeEnum getSignatureType() { - return signatureType; + @ApiModelProperty(value = "The name of the agreement that will be used to identify it, in emails, website and other places") + public String getName() { + return name; } - public void setSignatureType(SignatureTypeEnum signatureType) { - this.signatureType = signatureType; + public void setName(String name) { + this.name = name; + } + + public MegaSignCreationInfo numChildren(Integer numChildren) { + this.numChildren = numChildren; + return this; + } + + /** + * The total number of MegaSign children associated with the MegaSign parent. If provided in POST, it will be ignored. If modified in PUT, it will throw error MODIFYING_IMMUTABLE_FIELDS + * @return numChildren + **/ + @ApiModelProperty(value = "The total number of MegaSign children associated with the MegaSign parent. If provided in POST, it will be ignored. If modified in PUT, it will throw error MODIFYING_IMMUTABLE_FIELDS") + public Integer getNumChildren() { + return numChildren; + } + + public void setNumChildren(Integer numChildren) { + this.numChildren = numChildren; + } + + public MegaSignCreationInfo fileInfos(List fileInfos) { + this.fileInfos = fileInfos; + return this; + } + + public MegaSignCreationInfo addFileInfosItem(FileInfo fileInfosItem) { + if (this.fileInfos == null) { + this.fileInfos = new ArrayList(); + } + this.fileInfos.add(fileInfosItem); + return this; + } + + /** + * A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified + * @return fileInfos + **/ + @ApiModelProperty(value = "A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified") + public List getFileInfos() { + return fileInfos; + } + + public void setFileInfos(List fileInfos) { + this.fileInfos = fileInfos; + } + + public MegaSignCreationInfo id(String id) { + this.id = id; + return this; + } + + /** + * The unique identifier of megasign + * @return id + **/ + @ApiModelProperty(value = "The unique identifier of megasign ") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; } public MegaSignCreationInfo state(StateEnum state) { @@ -652,24 +739,6 @@ public void setStatus(StatusEnum status) { this.status = status; } - public MegaSignCreationInfo vaultingInfo(VaultingInfo vaultingInfo) { - this.vaultingInfo = vaultingInfo; - return this; - } - - /** - * Vaulting properties that allows Adobe Sign to securely store documents with a vault provider - * @return vaultingInfo - **/ - @ApiModelProperty(value = "Vaulting properties that allows Adobe Sign to securely store documents with a vault provider") - public VaultingInfo getVaultingInfo() { - return vaultingInfo; - } - - public void setVaultingInfo(VaultingInfo vaultingInfo) { - this.vaultingInfo = vaultingInfo; - } - @Override public boolean equals(java.lang.Object o) { @@ -680,30 +749,34 @@ public boolean equals(java.lang.Object o) { return false; } MegaSignCreationInfo megaSignCreationInfo = (MegaSignCreationInfo) o; - return Objects.equals(this.ccs, megaSignCreationInfo.ccs) && + return Objects.equals(this.firstReminderDelay, megaSignCreationInfo.firstReminderDelay) && + Objects.equals(this.groupId, megaSignCreationInfo.groupId) && Objects.equals(this.childAgreementsInfo, megaSignCreationInfo.childAgreementsInfo) && - Objects.equals(this.createdDate, megaSignCreationInfo.createdDate) && - Objects.equals(this.expirationTime, megaSignCreationInfo.expirationTime) && + Objects.equals(this.signatureType, megaSignCreationInfo.signatureType) && Objects.equals(this.externalId, megaSignCreationInfo.externalId) && - Objects.equals(this.fileInfos, megaSignCreationInfo.fileInfos) && - Objects.equals(this.firstReminderDelay, megaSignCreationInfo.firstReminderDelay) && - Objects.equals(this.id, megaSignCreationInfo.id) && Objects.equals(this.locale, megaSignCreationInfo.locale) && Objects.equals(this.message, megaSignCreationInfo.message) && - Objects.equals(this.name, megaSignCreationInfo.name) && + Objects.equals(this.vaultingInfo, megaSignCreationInfo.vaultingInfo) && + Objects.equals(this.securityOption, megaSignCreationInfo.securityOption) && Objects.equals(this.postSignOption, megaSignCreationInfo.postSignOption) && Objects.equals(this.reminderFrequency, megaSignCreationInfo.reminderFrequency) && - Objects.equals(this.securityOption, megaSignCreationInfo.securityOption) && + Objects.equals(this.ccs, megaSignCreationInfo.ccs) && + Objects.equals(this.createdDate, megaSignCreationInfo.createdDate) && + Objects.equals(this.isDocumentRetentionApplied, megaSignCreationInfo.isDocumentRetentionApplied) && + Objects.equals(this.expirationTime, megaSignCreationInfo.expirationTime) && + Objects.equals(this.lastEventDate, megaSignCreationInfo.lastEventDate) && Objects.equals(this.senderEmail, megaSignCreationInfo.senderEmail) && - Objects.equals(this.signatureType, megaSignCreationInfo.signatureType) && + Objects.equals(this.name, megaSignCreationInfo.name) && + Objects.equals(this.numChildren, megaSignCreationInfo.numChildren) && + Objects.equals(this.fileInfos, megaSignCreationInfo.fileInfos) && + Objects.equals(this.id, megaSignCreationInfo.id) && Objects.equals(this.state, megaSignCreationInfo.state) && - Objects.equals(this.status, megaSignCreationInfo.status) && - Objects.equals(this.vaultingInfo, megaSignCreationInfo.vaultingInfo); + Objects.equals(this.status, megaSignCreationInfo.status); } @Override public int hashCode() { - return Objects.hash(ccs, childAgreementsInfo, createdDate, expirationTime, externalId, fileInfos, firstReminderDelay, id, locale, message, name, postSignOption, reminderFrequency, securityOption, senderEmail, signatureType, state, status, vaultingInfo); + return Objects.hash(firstReminderDelay, groupId, childAgreementsInfo, signatureType, externalId, locale, message, vaultingInfo, securityOption, postSignOption, reminderFrequency, ccs, createdDate, isDocumentRetentionApplied, expirationTime, lastEventDate, senderEmail, name, numChildren, fileInfos, id, state, status); } @@ -712,25 +785,29 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class MegaSignCreationInfo {\n"); - sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n"); + sb.append(" firstReminderDelay: ").append(toIndentedString(firstReminderDelay)).append("\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); sb.append(" childAgreementsInfo: ").append(toIndentedString(childAgreementsInfo)).append("\n"); - sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); - sb.append(" expirationTime: ").append(toIndentedString(expirationTime)).append("\n"); + sb.append(" signatureType: ").append(toIndentedString(signatureType)).append("\n"); sb.append(" externalId: ").append(toIndentedString(externalId)).append("\n"); - sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); - sb.append(" firstReminderDelay: ").append(toIndentedString(firstReminderDelay)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); sb.append(" message: ").append(toIndentedString(message)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" vaultingInfo: ").append(toIndentedString(vaultingInfo)).append("\n"); + sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); sb.append(" postSignOption: ").append(toIndentedString(postSignOption)).append("\n"); sb.append(" reminderFrequency: ").append(toIndentedString(reminderFrequency)).append("\n"); - sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); + sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" isDocumentRetentionApplied: ").append(toIndentedString(isDocumentRetentionApplied)).append("\n"); + sb.append(" expirationTime: ").append(toIndentedString(expirationTime)).append("\n"); + sb.append(" lastEventDate: ").append(toIndentedString(lastEventDate)).append("\n"); sb.append(" senderEmail: ").append(toIndentedString(senderEmail)).append("\n"); - sb.append(" signatureType: ").append(toIndentedString(signatureType)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" numChildren: ").append(toIndentedString(numChildren)).append("\n"); + sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" state: ").append(toIndentedString(state)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" vaultingInfo: ").append(toIndentedString(vaultingInfo)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegaSignCreationResponse.java b/src/main/java/io/swagger/client/model/megaSigns/MegaSignCreationResponse.java index e3304df..6203e53 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/MegaSignCreationResponse.java +++ b/src/main/java/io/swagger/client/model/megaSigns/MegaSignCreationResponse.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,7 @@ * A JSON that contains the id of the newly created Mega Sign */ @ApiModel(description = "A JSON that contains the id of the newly created Mega Sign") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class MegaSignCreationResponse { @SerializedName("id") private String id = null; diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegaSignInfo.java b/src/main/java/io/swagger/client/model/megaSigns/MegaSignInfo.java new file mode 100644 index 0000000..8095c75 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/MegaSignInfo.java @@ -0,0 +1,827 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.megaSigns.ChildAgreementsInfo; +import io.swagger.client.model.megaSigns.ExternalId; +import io.swagger.client.model.megaSigns.FileInfo; +import io.swagger.client.model.megaSigns.MegaSignCcInfo; +import io.swagger.client.model.megaSigns.MegaSignSecurityOption; +import io.swagger.client.model.megaSigns.PostSignOption; +import io.swagger.client.model.megaSigns.VaultingInfo; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +/** + * MegaSignInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class MegaSignInfo { + @SerializedName("firstReminderDelay") + private Integer firstReminderDelay = null; + + @SerializedName("groupId") + private String groupId = null; + + @SerializedName("childAgreementsInfo") + private ChildAgreementsInfo childAgreementsInfo = null; + + /** + * Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system + */ + @JsonAdapter(SignatureTypeEnum.Adapter.class) + public enum SignatureTypeEnum { + ESIGN("ESIGN"), + + WRITTEN("WRITTEN"); + + private String value; + + SignatureTypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static SignatureTypeEnum fromValue(String text) { + for (SignatureTypeEnum b : SignatureTypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final SignatureTypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public SignatureTypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return SignatureTypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("signatureType") + private SignatureTypeEnum signatureType = null; + + @SerializedName("externalId") + private ExternalId externalId = null; + + @SerializedName("locale") + private String locale = null; + + @SerializedName("message") + private String message = null; + + @SerializedName("vaultingInfo") + private VaultingInfo vaultingInfo = null; + + @SerializedName("securityOption") + private MegaSignSecurityOption securityOption = null; + + @SerializedName("postSignOption") + private PostSignOption postSignOption = null; + + /** + * Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used + */ + @JsonAdapter(ReminderFrequencyEnum.Adapter.class) + public enum ReminderFrequencyEnum { + DAILY_UNTIL_SIGNED("DAILY_UNTIL_SIGNED"), + + WEEKDAILY_UNTIL_SIGNED("WEEKDAILY_UNTIL_SIGNED"), + + EVERY_OTHER_DAY_UNTIL_SIGNED("EVERY_OTHER_DAY_UNTIL_SIGNED"), + + EVERY_THIRD_DAY_UNTIL_SIGNED("EVERY_THIRD_DAY_UNTIL_SIGNED"), + + EVERY_FIFTH_DAY_UNTIL_SIGNED("EVERY_FIFTH_DAY_UNTIL_SIGNED"), + + WEEKLY_UNTIL_SIGNED("WEEKLY_UNTIL_SIGNED"); + + private String value; + + ReminderFrequencyEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ReminderFrequencyEnum fromValue(String text) { + for (ReminderFrequencyEnum b : ReminderFrequencyEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ReminderFrequencyEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ReminderFrequencyEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ReminderFrequencyEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("reminderFrequency") + private ReminderFrequencyEnum reminderFrequency = null; + + @SerializedName("ccs") + private List ccs = null; + + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("isDocumentRetentionApplied") + private Boolean isDocumentRetentionApplied = null; + + @SerializedName("expirationTime") + private Date expirationTime = null; + + @SerializedName("lastEventDate") + private Date lastEventDate = null; + + @SerializedName("senderEmail") + private String senderEmail = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("numChildren") + private Integer numChildren = null; + + @SerializedName("fileInfos") + private List fileInfos = null; + + @SerializedName("id") + private String id = null; + + /** + * State of the Megasign + */ + @JsonAdapter(StateEnum.Adapter.class) + public enum StateEnum { + PROCESS("IN_PROCESS"); + + private String value; + + StateEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static StateEnum fromValue(String text) { + for (StateEnum b : StateEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public StateEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return StateEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("state") + private StateEnum state = null; + + /** + * Status of the Megasign + */ + @JsonAdapter(StatusEnum.Adapter.class) + public enum StatusEnum { + AUTHORING("AUTHORING"), + + IN_PROCESS("IN_PROCESS"), + + CANCELLED("CANCELLED"), + + COMPLETED("COMPLETED"), + + EXPIRED("EXPIRED"), + + PREFILL("PREFILL"); + + private String value; + + StatusEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static StatusEnum fromValue(String text) { + for (StatusEnum b : StatusEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public StatusEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return StatusEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("status") + private StatusEnum status = null; + + public MegaSignInfo firstReminderDelay(Integer firstReminderDelay) { + this.firstReminderDelay = firstReminderDelay; + return this; + } + + /** + * Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT + * @return firstReminderDelay + **/ + @ApiModelProperty(value = "Integer which specifies the delay in hours before sending the first reminder.
This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.
If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.
i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT") + public Integer getFirstReminderDelay() { + return firstReminderDelay; + } + + public void setFirstReminderDelay(Integer firstReminderDelay) { + this.firstReminderDelay = firstReminderDelay; + } + + public MegaSignInfo groupId(String groupId) { + this.groupId = groupId; + return this; + } + + /** + * The unique identifier of the group to which the megasign agreement will belong to when it is created. If it is not provided during agreement creation the primary group of the creator will be used + * @return groupId + **/ + @ApiModelProperty(value = "The unique identifier of the group to which the megasign agreement will belong to when it is created. If it is not provided during agreement creation the primary group of the creator will be used") + public String getGroupId() { + return groupId; + } + + public void setGroupId(String groupId) { + this.groupId = groupId; + } + + public MegaSignInfo childAgreementsInfo(ChildAgreementsInfo childAgreementsInfo) { + this.childAgreementsInfo = childAgreementsInfo; + return this; + } + + /** + * Info corresponding to each child agreement of the megaSign + * @return childAgreementsInfo + **/ + @ApiModelProperty(value = "Info corresponding to each child agreement of the megaSign ") + public ChildAgreementsInfo getChildAgreementsInfo() { + return childAgreementsInfo; + } + + public void setChildAgreementsInfo(ChildAgreementsInfo childAgreementsInfo) { + this.childAgreementsInfo = childAgreementsInfo; + } + + public MegaSignInfo signatureType(SignatureTypeEnum signatureType) { + this.signatureType = signatureType; + return this; + } + + /** + * Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system + * @return signatureType + **/ + @ApiModelProperty(value = "Specifies the type of signature you would like to request - written or e-signature. The possible values are
ESIGN : Agreement needs to be signed electronically
, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system") + public SignatureTypeEnum getSignatureType() { + return signatureType; + } + + public void setSignatureType(SignatureTypeEnum signatureType) { + this.signatureType = signatureType; + } + + public MegaSignInfo externalId(ExternalId externalId) { + this.externalId = externalId; + return this; + } + + /** + * An arbitrary value from your system, which can be specified at sending time and then later returned or queried + * @return externalId + **/ + @ApiModelProperty(value = "An arbitrary value from your system, which can be specified at sending time and then later returned or queried") + public ExternalId getExternalId() { + return externalId; + } + + public void setExternalId(ExternalId externalId) { + this.externalId = externalId; + } + + public MegaSignInfo locale(String locale) { + this.locale = locale; + return this; + } + + /** + * The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender + * @return locale + **/ + @ApiModelProperty(value = "The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender") + public String getLocale() { + return locale; + } + + public void setLocale(String locale) { + this.locale = locale; + } + + public MegaSignInfo message(String message) { + this.message = message; + return this; + } + + /** + * An optional message to the participants, describing what is being sent or why their signature is required + * @return message + **/ + @ApiModelProperty(value = "An optional message to the participants, describing what is being sent or why their signature is required") + public String getMessage() { + return message; + } + + public void setMessage(String message) { + this.message = message; + } + + public MegaSignInfo vaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; + return this; + } + + /** + * Vaulting properties that allows Adobe Sign to securely store documents with a vault provider + * @return vaultingInfo + **/ + @ApiModelProperty(value = "Vaulting properties that allows Adobe Sign to securely store documents with a vault provider") + public VaultingInfo getVaultingInfo() { + return vaultingInfo; + } + + public void setVaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; + } + + public MegaSignInfo securityOption(MegaSignSecurityOption securityOption) { + this.securityOption = securityOption; + return this; + } + + /** + * Optional security parameters for the megasign + * @return securityOption + **/ + @ApiModelProperty(value = "Optional security parameters for the megasign") + public MegaSignSecurityOption getSecurityOption() { + return securityOption; + } + + public void setSecurityOption(MegaSignSecurityOption securityOption) { + this.securityOption = securityOption; + } + + public MegaSignInfo postSignOption(PostSignOption postSignOption) { + this.postSignOption = postSignOption; + return this; + } + + /** + * URL and associated properties for the success page the user will be taken to after completing the signing process + * @return postSignOption + **/ + @ApiModelProperty(value = "URL and associated properties for the success page the user will be taken to after completing the signing process") + public PostSignOption getPostSignOption() { + return postSignOption; + } + + public void setPostSignOption(PostSignOption postSignOption) { + this.postSignOption = postSignOption; + } + + public MegaSignInfo reminderFrequency(ReminderFrequencyEnum reminderFrequency) { + this.reminderFrequency = reminderFrequency; + return this; + } + + /** + * Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used + * @return reminderFrequency + **/ + @ApiModelProperty(value = "Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used") + public ReminderFrequencyEnum getReminderFrequency() { + return reminderFrequency; + } + + public void setReminderFrequency(ReminderFrequencyEnum reminderFrequency) { + this.reminderFrequency = reminderFrequency; + } + + public MegaSignInfo ccs(List ccs) { + this.ccs = ccs; + return this; + } + + public MegaSignInfo addCcsItem(MegaSignCcInfo ccsItem) { + if (this.ccs == null) { + this.ccs = new ArrayList(); + } + this.ccs.add(ccsItem); + return this; + } + + /** + * A list of one or more CCs that will be copied in the megasign transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file + * @return ccs + **/ + @ApiModelProperty(value = "A list of one or more CCs that will be copied in the megasign transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file ") + public List getCcs() { + return ccs; + } + + public void setCcs(List ccs) { + this.ccs = ccs; + } + + public MegaSignInfo createdDate(Date createdDate) { + this.createdDate = createdDate; + return this; + } + + /** + * Date when megasign was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return createdDate + **/ + @ApiModelProperty(value = "Date when megasign was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getCreatedDate() { + return createdDate; + } + + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } + + public MegaSignInfo isDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; + return this; + } + + /** + * Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. + * @return isDocumentRetentionApplied + **/ + @ApiModelProperty(value = "Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored.") + public Boolean isIsDocumentRetentionApplied() { + return isDocumentRetentionApplied; + } + + public void setIsDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; + } + + public MegaSignInfo expirationTime(Date expirationTime) { + this.expirationTime = expirationTime; + return this; + } + + /** + * Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. + * @return expirationTime + **/ + @ApiModelProperty(value = "Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation.") + public Date getExpirationTime() { + return expirationTime; + } + + public void setExpirationTime(Date expirationTime) { + this.expirationTime = expirationTime; + } + + public MegaSignInfo lastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; + return this; + } + + /** + * The date of the last event that occurred for this megasign. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return lastEventDate + **/ + @ApiModelProperty(value = "The date of the last event that occurred for this megasign. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getLastEventDate() { + return lastEventDate; + } + + public void setLastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; + } + + public MegaSignInfo senderEmail(String senderEmail) { + this.senderEmail = senderEmail; + return this; + } + + /** + * Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored + * @return senderEmail + **/ + @ApiModelProperty(value = "Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored") + public String getSenderEmail() { + return senderEmail; + } + + public void setSenderEmail(String senderEmail) { + this.senderEmail = senderEmail; + } + + public MegaSignInfo name(String name) { + this.name = name; + return this; + } + + /** + * The name of the agreement that will be used to identify it, in emails, website and other places + * @return name + **/ + @ApiModelProperty(value = "The name of the agreement that will be used to identify it, in emails, website and other places") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public MegaSignInfo numChildren(Integer numChildren) { + this.numChildren = numChildren; + return this; + } + + /** + * The total number of MegaSign children associated with the MegaSign parent. If provided in POST, it will be ignored. If modified in PUT, it will throw error MODIFYING_IMMUTABLE_FIELDS + * @return numChildren + **/ + @ApiModelProperty(value = "The total number of MegaSign children associated with the MegaSign parent. If provided in POST, it will be ignored. If modified in PUT, it will throw error MODIFYING_IMMUTABLE_FIELDS") + public Integer getNumChildren() { + return numChildren; + } + + public void setNumChildren(Integer numChildren) { + this.numChildren = numChildren; + } + + public MegaSignInfo fileInfos(List fileInfos) { + this.fileInfos = fileInfos; + return this; + } + + public MegaSignInfo addFileInfosItem(FileInfo fileInfosItem) { + if (this.fileInfos == null) { + this.fileInfos = new ArrayList(); + } + this.fileInfos.add(fileInfosItem); + return this; + } + + /** + * A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified + * @return fileInfos + **/ + @ApiModelProperty(value = "A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified") + public List getFileInfos() { + return fileInfos; + } + + public void setFileInfos(List fileInfos) { + this.fileInfos = fileInfos; + } + + public MegaSignInfo id(String id) { + this.id = id; + return this; + } + + /** + * The unique identifier of megasign + * @return id + **/ + @ApiModelProperty(value = "The unique identifier of megasign ") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public MegaSignInfo state(StateEnum state) { + this.state = state; + return this; + } + + /** + * State of the Megasign + * @return state + **/ + @ApiModelProperty(value = "State of the Megasign") + public StateEnum getState() { + return state; + } + + public void setState(StateEnum state) { + this.state = state; + } + + public MegaSignInfo status(StatusEnum status) { + this.status = status; + return this; + } + + /** + * Status of the Megasign + * @return status + **/ + @ApiModelProperty(value = "Status of the Megasign") + public StatusEnum getStatus() { + return status; + } + + public void setStatus(StatusEnum status) { + this.status = status; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + MegaSignInfo megaSignInfo = (MegaSignInfo) o; + return Objects.equals(this.firstReminderDelay, megaSignInfo.firstReminderDelay) && + Objects.equals(this.groupId, megaSignInfo.groupId) && + Objects.equals(this.childAgreementsInfo, megaSignInfo.childAgreementsInfo) && + Objects.equals(this.signatureType, megaSignInfo.signatureType) && + Objects.equals(this.externalId, megaSignInfo.externalId) && + Objects.equals(this.locale, megaSignInfo.locale) && + Objects.equals(this.message, megaSignInfo.message) && + Objects.equals(this.vaultingInfo, megaSignInfo.vaultingInfo) && + Objects.equals(this.securityOption, megaSignInfo.securityOption) && + Objects.equals(this.postSignOption, megaSignInfo.postSignOption) && + Objects.equals(this.reminderFrequency, megaSignInfo.reminderFrequency) && + Objects.equals(this.ccs, megaSignInfo.ccs) && + Objects.equals(this.createdDate, megaSignInfo.createdDate) && + Objects.equals(this.isDocumentRetentionApplied, megaSignInfo.isDocumentRetentionApplied) && + Objects.equals(this.expirationTime, megaSignInfo.expirationTime) && + Objects.equals(this.lastEventDate, megaSignInfo.lastEventDate) && + Objects.equals(this.senderEmail, megaSignInfo.senderEmail) && + Objects.equals(this.name, megaSignInfo.name) && + Objects.equals(this.numChildren, megaSignInfo.numChildren) && + Objects.equals(this.fileInfos, megaSignInfo.fileInfos) && + Objects.equals(this.id, megaSignInfo.id) && + Objects.equals(this.state, megaSignInfo.state) && + Objects.equals(this.status, megaSignInfo.status); + } + + @Override + public int hashCode() { + return Objects.hash(firstReminderDelay, groupId, childAgreementsInfo, signatureType, externalId, locale, message, vaultingInfo, securityOption, postSignOption, reminderFrequency, ccs, createdDate, isDocumentRetentionApplied, expirationTime, lastEventDate, senderEmail, name, numChildren, fileInfos, id, state, status); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class MegaSignInfo {\n"); + + sb.append(" firstReminderDelay: ").append(toIndentedString(firstReminderDelay)).append("\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); + sb.append(" childAgreementsInfo: ").append(toIndentedString(childAgreementsInfo)).append("\n"); + sb.append(" signatureType: ").append(toIndentedString(signatureType)).append("\n"); + sb.append(" externalId: ").append(toIndentedString(externalId)).append("\n"); + sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" vaultingInfo: ").append(toIndentedString(vaultingInfo)).append("\n"); + sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); + sb.append(" postSignOption: ").append(toIndentedString(postSignOption)).append("\n"); + sb.append(" reminderFrequency: ").append(toIndentedString(reminderFrequency)).append("\n"); + sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" isDocumentRetentionApplied: ").append(toIndentedString(isDocumentRetentionApplied)).append("\n"); + sb.append(" expirationTime: ").append(toIndentedString(expirationTime)).append("\n"); + sb.append(" lastEventDate: ").append(toIndentedString(lastEventDate)).append("\n"); + sb.append(" senderEmail: ").append(toIndentedString(senderEmail)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" numChildren: ").append(toIndentedString(numChildren)).append("\n"); + sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" state: ").append(toIndentedString(state)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegaSignMembersInfo.java b/src/main/java/io/swagger/client/model/megaSigns/MegaSignMembersInfo.java new file mode 100644 index 0000000..01053dd --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/MegaSignMembersInfo.java @@ -0,0 +1,192 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.megaSigns.CCParticipantInfo; +import io.swagger.client.model.megaSigns.DetailedParticipantSetInfo; +import io.swagger.client.model.megaSigns.SenderInfo; +import io.swagger.client.model.megaSigns.ShareParticipantInfo; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * MegaSignMembersInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class MegaSignMembersInfo { + @SerializedName("participantSets") + private List participantSets = null; + + @SerializedName("ccsInfo") + private List ccsInfo = null; + + @SerializedName("senderInfo") + private SenderInfo senderInfo = null; + + @SerializedName("sharesInfo") + private List sharesInfo = null; + + public MegaSignMembersInfo participantSets(List participantSets) { + this.participantSets = participantSets; + return this; + } + + public MegaSignMembersInfo addParticipantSetsItem(DetailedParticipantSetInfo participantSetsItem) { + if (this.participantSets == null) { + this.participantSets = new ArrayList(); + } + this.participantSets.add(participantSetsItem); + return this; + } + + /** + * Information about the participant Sets. + * @return participantSets + **/ + @ApiModelProperty(value = "Information about the participant Sets.") + public List getParticipantSets() { + return participantSets; + } + + public void setParticipantSets(List participantSets) { + this.participantSets = participantSets; + } + + public MegaSignMembersInfo ccsInfo(List ccsInfo) { + this.ccsInfo = ccsInfo; + return this; + } + + public MegaSignMembersInfo addCcsInfoItem(CCParticipantInfo ccsInfoItem) { + if (this.ccsInfo == null) { + this.ccsInfo = new ArrayList(); + } + this.ccsInfo.add(ccsInfoItem); + return this; + } + + /** + * Information of CC participants of the megaSign. + * @return ccsInfo + **/ + @ApiModelProperty(value = "Information of CC participants of the megaSign.") + public List getCcsInfo() { + return ccsInfo; + } + + public void setCcsInfo(List ccsInfo) { + this.ccsInfo = ccsInfo; + } + + public MegaSignMembersInfo senderInfo(SenderInfo senderInfo) { + this.senderInfo = senderInfo; + return this; + } + + /** + * Information of the sender of the megaSign. + * @return senderInfo + **/ + @ApiModelProperty(value = "Information of the sender of the megaSign.") + public SenderInfo getSenderInfo() { + return senderInfo; + } + + public void setSenderInfo(SenderInfo senderInfo) { + this.senderInfo = senderInfo; + } + + public MegaSignMembersInfo sharesInfo(List sharesInfo) { + this.sharesInfo = sharesInfo; + return this; + } + + public MegaSignMembersInfo addSharesInfoItem(ShareParticipantInfo sharesInfoItem) { + if (this.sharesInfo == null) { + this.sharesInfo = new ArrayList(); + } + this.sharesInfo.add(sharesInfoItem); + return this; + } + + /** + * Information of the participants with whom the megaSign has been shared. + * @return sharesInfo + **/ + @ApiModelProperty(value = "Information of the participants with whom the megaSign has been shared.") + public List getSharesInfo() { + return sharesInfo; + } + + public void setSharesInfo(List sharesInfo) { + this.sharesInfo = sharesInfo; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + MegaSignMembersInfo megaSignMembersInfo = (MegaSignMembersInfo) o; + return Objects.equals(this.participantSets, megaSignMembersInfo.participantSets) && + Objects.equals(this.ccsInfo, megaSignMembersInfo.ccsInfo) && + Objects.equals(this.senderInfo, megaSignMembersInfo.senderInfo) && + Objects.equals(this.sharesInfo, megaSignMembersInfo.sharesInfo); + } + + @Override + public int hashCode() { + return Objects.hash(participantSets, ccsInfo, senderInfo, sharesInfo); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class MegaSignMembersInfo {\n"); + + sb.append(" participantSets: ").append(toIndentedString(participantSets)).append("\n"); + sb.append(" ccsInfo: ").append(toIndentedString(ccsInfo)).append("\n"); + sb.append(" senderInfo: ").append(toIndentedString(senderInfo)).append("\n"); + sb.append(" sharesInfo: ").append(toIndentedString(sharesInfo)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegaSignRemindersResponse.java b/src/main/java/io/swagger/client/model/megaSigns/MegaSignRemindersResponse.java new file mode 100644 index 0000000..6f4ed11 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/MegaSignRemindersResponse.java @@ -0,0 +1,104 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.megaSigns.ReminderInfo; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * MegaSignRemindersResponse + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class MegaSignRemindersResponse { + @SerializedName("reminderInfoList") + private List reminderInfoList = null; + + public MegaSignRemindersResponse reminderInfoList(List reminderInfoList) { + this.reminderInfoList = reminderInfoList; + return this; + } + + public MegaSignRemindersResponse addReminderInfoListItem(ReminderInfo reminderInfoListItem) { + if (this.reminderInfoList == null) { + this.reminderInfoList = new ArrayList(); + } + this.reminderInfoList.add(reminderInfoListItem); + return this; + } + + /** + * A list of one or more reminders created on the MegaSign parent specified by the unique identifier megasignId by the user invoking the API. + * @return reminderInfoList + **/ + @ApiModelProperty(value = "A list of one or more reminders created on the MegaSign parent specified by the unique identifier megasignId by the user invoking the API.") + public List getReminderInfoList() { + return reminderInfoList; + } + + public void setReminderInfoList(List reminderInfoList) { + this.reminderInfoList = reminderInfoList; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + MegaSignRemindersResponse megaSignRemindersResponse = (MegaSignRemindersResponse) o; + return Objects.equals(this.reminderInfoList, megaSignRemindersResponse.reminderInfoList); + } + + @Override + public int hashCode() { + return Objects.hash(reminderInfoList); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class MegaSignRemindersResponse {\n"); + + sb.append(" reminderInfoList: ").append(toIndentedString(reminderInfoList)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegaSignSecurityOption.java b/src/main/java/io/swagger/client/model/megaSigns/MegaSignSecurityOption.java index 886f238..54bfd73 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/MegaSignSecurityOption.java +++ b/src/main/java/io/swagger/client/model/megaSigns/MegaSignSecurityOption.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * MegaSignSecurityOption */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class MegaSignSecurityOption { /** * The authentication method for the participants to have access to view and sign the document. @@ -97,9 +82,6 @@ public ExternalAuthenticationMethodEnum read(final JsonReader jsonReader) throws @SerializedName("externalAuthenticationMethod") private ExternalAuthenticationMethodEnum externalAuthenticationMethod = null; - @SerializedName("externalPassword") - private String externalPassword = null; - /** * The authentication method for the participants to have access to view and sign the document. */ @@ -154,6 +136,9 @@ public InternalAuthenticationMethodEnum read(final JsonReader jsonReader) throws @SerializedName("internalAuthenticationMethod") private InternalAuthenticationMethodEnum internalAuthenticationMethod = null; + @SerializedName("externalPassword") + private String externalPassword = null; + @SerializedName("internalPassword") private String internalPassword = null; @@ -178,24 +163,6 @@ public void setExternalAuthenticationMethod(ExternalAuthenticationMethodEnum ext this.externalAuthenticationMethod = externalAuthenticationMethod; } - public MegaSignSecurityOption externalPassword(String externalPassword) { - this.externalPassword = externalPassword; - return this; - } - - /** - * The secondary password that will be used to protect signing the document for internal signers. Note that Adobe Sign will never show this password to anyone, so you will need to separately communicate it to any relevant parties. This password is applied only if password protection is specified for internal signers or all signers - * @return externalPassword - **/ - @ApiModelProperty(value = "The secondary password that will be used to protect signing the document for internal signers. Note that Adobe Sign will never show this password to anyone, so you will need to separately communicate it to any relevant parties. This password is applied only if password protection is specified for internal signers or all signers") - public String getExternalPassword() { - return externalPassword; - } - - public void setExternalPassword(String externalPassword) { - this.externalPassword = externalPassword; - } - public MegaSignSecurityOption internalAuthenticationMethod(InternalAuthenticationMethodEnum internalAuthenticationMethod) { this.internalAuthenticationMethod = internalAuthenticationMethod; return this; @@ -214,6 +181,24 @@ public void setInternalAuthenticationMethod(InternalAuthenticationMethodEnum int this.internalAuthenticationMethod = internalAuthenticationMethod; } + public MegaSignSecurityOption externalPassword(String externalPassword) { + this.externalPassword = externalPassword; + return this; + } + + /** + * The secondary password that will be used to protect signing the document for internal signers. Note that Adobe Sign will never show this password to anyone, so you will need to separately communicate it to any relevant parties. This password is applied only if password protection is specified for internal signers or all signers + * @return externalPassword + **/ + @ApiModelProperty(value = "The secondary password that will be used to protect signing the document for internal signers. Note that Adobe Sign will never show this password to anyone, so you will need to separately communicate it to any relevant parties. This password is applied only if password protection is specified for internal signers or all signers") + public String getExternalPassword() { + return externalPassword; + } + + public void setExternalPassword(String externalPassword) { + this.externalPassword = externalPassword; + } + public MegaSignSecurityOption internalPassword(String internalPassword) { this.internalPassword = internalPassword; return this; @@ -261,15 +246,15 @@ public boolean equals(java.lang.Object o) { } MegaSignSecurityOption megaSignSecurityOption = (MegaSignSecurityOption) o; return Objects.equals(this.externalAuthenticationMethod, megaSignSecurityOption.externalAuthenticationMethod) && - Objects.equals(this.externalPassword, megaSignSecurityOption.externalPassword) && Objects.equals(this.internalAuthenticationMethod, megaSignSecurityOption.internalAuthenticationMethod) && + Objects.equals(this.externalPassword, megaSignSecurityOption.externalPassword) && Objects.equals(this.internalPassword, megaSignSecurityOption.internalPassword) && Objects.equals(this.openPassword, megaSignSecurityOption.openPassword); } @Override public int hashCode() { - return Objects.hash(externalAuthenticationMethod, externalPassword, internalAuthenticationMethod, internalPassword, openPassword); + return Objects.hash(externalAuthenticationMethod, internalAuthenticationMethod, externalPassword, internalPassword, openPassword); } @@ -279,8 +264,8 @@ public String toString() { sb.append("class MegaSignSecurityOption {\n"); sb.append(" externalAuthenticationMethod: ").append(toIndentedString(externalAuthenticationMethod)).append("\n"); - sb.append(" externalPassword: ").append(toIndentedString(externalPassword)).append("\n"); sb.append(" internalAuthenticationMethod: ").append(toIndentedString(internalAuthenticationMethod)).append("\n"); + sb.append(" externalPassword: ").append(toIndentedString(externalPassword)).append("\n"); sb.append(" internalPassword: ").append(toIndentedString(internalPassword)).append("\n"); sb.append(" openPassword: ").append(toIndentedString(openPassword)).append("\n"); sb.append("}"); diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegaSignStateInfo.java b/src/main/java/io/swagger/client/model/megaSigns/MegaSignStateInfo.java index 6a59f83..e3f62e7 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/MegaSignStateInfo.java +++ b/src/main/java/io/swagger/client/model/megaSigns/MegaSignStateInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,11 +27,8 @@ /** * MegaSignStateInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class MegaSignStateInfo { - @SerializedName("megaSignCancellationInfo") - private AgreementCancellationInfo megaSignCancellationInfo = null; - /** * The state to which the megaSign is to be updated. The only valid state for this variable is currently, CANCELLED */ @@ -95,23 +77,8 @@ public StateEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("state") private StateEnum state = null; - public MegaSignStateInfo megaSignCancellationInfo(AgreementCancellationInfo megaSignCancellationInfo) { - this.megaSignCancellationInfo = megaSignCancellationInfo; - return this; - } - - /** - * Cancellation information for the agreement. Mandatory while cancelling a megaSign - * @return megaSignCancellationInfo - **/ - @ApiModelProperty(value = "Cancellation information for the agreement. Mandatory while cancelling a megaSign") - public AgreementCancellationInfo getMegaSignCancellationInfo() { - return megaSignCancellationInfo; - } - - public void setMegaSignCancellationInfo(AgreementCancellationInfo megaSignCancellationInfo) { - this.megaSignCancellationInfo = megaSignCancellationInfo; - } + @SerializedName("megaSignCancellationInfo") + private AgreementCancellationInfo megaSignCancellationInfo = null; public MegaSignStateInfo state(StateEnum state) { this.state = state; @@ -131,6 +98,24 @@ public void setState(StateEnum state) { this.state = state; } + public MegaSignStateInfo megaSignCancellationInfo(AgreementCancellationInfo megaSignCancellationInfo) { + this.megaSignCancellationInfo = megaSignCancellationInfo; + return this; + } + + /** + * Cancellation information for the agreement. Mandatory while cancelling a megaSign + * @return megaSignCancellationInfo + **/ + @ApiModelProperty(value = "Cancellation information for the agreement. Mandatory while cancelling a megaSign") + public AgreementCancellationInfo getMegaSignCancellationInfo() { + return megaSignCancellationInfo; + } + + public void setMegaSignCancellationInfo(AgreementCancellationInfo megaSignCancellationInfo) { + this.megaSignCancellationInfo = megaSignCancellationInfo; + } + @Override public boolean equals(java.lang.Object o) { @@ -141,13 +126,13 @@ public boolean equals(java.lang.Object o) { return false; } MegaSignStateInfo megaSignStateInfo = (MegaSignStateInfo) o; - return Objects.equals(this.megaSignCancellationInfo, megaSignStateInfo.megaSignCancellationInfo) && - Objects.equals(this.state, megaSignStateInfo.state); + return Objects.equals(this.state, megaSignStateInfo.state) && + Objects.equals(this.megaSignCancellationInfo, megaSignStateInfo.megaSignCancellationInfo); } @Override public int hashCode() { - return Objects.hash(megaSignCancellationInfo, state); + return Objects.hash(state, megaSignCancellationInfo); } @@ -156,8 +141,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class MegaSignStateInfo {\n"); - sb.append(" megaSignCancellationInfo: ").append(toIndentedString(megaSignCancellationInfo)).append("\n"); sb.append(" state: ").append(toIndentedString(state)).append("\n"); + sb.append(" megaSignCancellationInfo: ").append(toIndentedString(megaSignCancellationInfo)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegaSignView.java b/src/main/java/io/swagger/client/model/megaSigns/MegaSignView.java index 7e6d5a5..0020aeb 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/MegaSignView.java +++ b/src/main/java/io/swagger/client/model/megaSigns/MegaSignView.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,22 +27,21 @@ /** * MegaSignView */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class MegaSignView { - @SerializedName("embeddedCode") - private String embeddedCode = null; - - @SerializedName("expiration") - private Date expiration = null; - @SerializedName("isCurrent") private Boolean isCurrent = null; + @SerializedName("embeddedCode") + private String embeddedCode = null; + /** * Name of the requested mega sign view */ @JsonAdapter(NameEnum.Adapter.class) public enum NameEnum { + ACTIVITY_REPORT("ACTIVITY_REPORT"), + AUTHORING("AUTHORING"), DOCUMENT("DOCUMENT"), @@ -68,6 +52,8 @@ public enum NameEnum { PREFILL("PREFILL"), + SIGNING("SIGNING"), + ALL("ALL"); private String value; @@ -111,45 +97,12 @@ public NameEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("name") private NameEnum name = null; + @SerializedName("expiration") + private Date expiration = null; + @SerializedName("url") private String url = null; - public MegaSignView embeddedCode(String embeddedCode) { - this.embeddedCode = embeddedCode; - return this; - } - - /** - * Embedded code of url of resource - * @return embeddedCode - **/ - @ApiModelProperty(value = "Embedded code of url of resource ") - public String getEmbeddedCode() { - return embeddedCode; - } - - public void setEmbeddedCode(String embeddedCode) { - this.embeddedCode = embeddedCode; - } - - public MegaSignView expiration(Date expiration) { - this.expiration = expiration; - return this; - } - - /** - * Expiration of user url - * @return expiration - **/ - @ApiModelProperty(value = "Expiration of user url ") - public Date getExpiration() { - return expiration; - } - - public void setExpiration(Date expiration) { - this.expiration = expiration; - } - public MegaSignView isCurrent(Boolean isCurrent) { this.isCurrent = isCurrent; return this; @@ -168,6 +121,24 @@ public void setIsCurrent(Boolean isCurrent) { this.isCurrent = isCurrent; } + public MegaSignView embeddedCode(String embeddedCode) { + this.embeddedCode = embeddedCode; + return this; + } + + /** + * Embedded code of url of resource + * @return embeddedCode + **/ + @ApiModelProperty(value = "Embedded code of url of resource ") + public String getEmbeddedCode() { + return embeddedCode; + } + + public void setEmbeddedCode(String embeddedCode) { + this.embeddedCode = embeddedCode; + } + public MegaSignView name(NameEnum name) { this.name = name; return this; @@ -186,6 +157,24 @@ public void setName(NameEnum name) { this.name = name; } + public MegaSignView expiration(Date expiration) { + this.expiration = expiration; + return this; + } + + /** + * Expiration of user url + * @return expiration + **/ + @ApiModelProperty(value = "Expiration of user url ") + public Date getExpiration() { + return expiration; + } + + public void setExpiration(Date expiration) { + this.expiration = expiration; + } + public MegaSignView url(String url) { this.url = url; return this; @@ -214,16 +203,16 @@ public boolean equals(java.lang.Object o) { return false; } MegaSignView megaSignView = (MegaSignView) o; - return Objects.equals(this.embeddedCode, megaSignView.embeddedCode) && - Objects.equals(this.expiration, megaSignView.expiration) && - Objects.equals(this.isCurrent, megaSignView.isCurrent) && + return Objects.equals(this.isCurrent, megaSignView.isCurrent) && + Objects.equals(this.embeddedCode, megaSignView.embeddedCode) && Objects.equals(this.name, megaSignView.name) && + Objects.equals(this.expiration, megaSignView.expiration) && Objects.equals(this.url, megaSignView.url); } @Override public int hashCode() { - return Objects.hash(embeddedCode, expiration, isCurrent, name, url); + return Objects.hash(isCurrent, embeddedCode, name, expiration, url); } @@ -232,10 +221,10 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class MegaSignView {\n"); - sb.append(" embeddedCode: ").append(toIndentedString(embeddedCode)).append("\n"); - sb.append(" expiration: ").append(toIndentedString(expiration)).append("\n"); sb.append(" isCurrent: ").append(toIndentedString(isCurrent)).append("\n"); + sb.append(" embeddedCode: ").append(toIndentedString(embeddedCode)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" expiration: ").append(toIndentedString(expiration)).append("\n"); sb.append(" url: ").append(toIndentedString(url)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegaSignViewInfo.java b/src/main/java/io/swagger/client/model/megaSigns/MegaSignViewInfo.java index 6d6d010..5807f86 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/MegaSignViewInfo.java +++ b/src/main/java/io/swagger/client/model/megaSigns/MegaSignViewInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,7 @@ /** * MegaSignViewInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class MegaSignViewInfo { @SerializedName("commonViewConfiguration") private CommonViewConfiguration commonViewConfiguration = null; @@ -52,6 +37,8 @@ public class MegaSignViewInfo { */ @JsonAdapter(NameEnum.Adapter.class) public enum NameEnum { + ACTIVITY_REPORT("ACTIVITY_REPORT"), + AUTHORING("AUTHORING"), DOCUMENT("DOCUMENT"), @@ -62,6 +49,8 @@ public enum NameEnum { PREFILL("PREFILL"), + SIGNING("SIGNING"), + ALL("ALL"); private String value; diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegaSignViewResponse.java b/src/main/java/io/swagger/client/model/megaSigns/MegaSignViewResponse.java index 2ba9ebd..c8c7b81 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/MegaSignViewResponse.java +++ b/src/main/java/io/swagger/client/model/megaSigns/MegaSignViewResponse.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * MegaSignViewResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class MegaSignViewResponse { @SerializedName("megaSignViewList") private List megaSignViewList = null; diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegaSigns.java b/src/main/java/io/swagger/client/model/megaSigns/MegaSigns.java index 8830198..dbb2e52 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/MegaSigns.java +++ b/src/main/java/io/swagger/client/model/megaSigns/MegaSigns.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,7 +30,7 @@ /** * MegaSigns */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class MegaSigns { @SerializedName("megaSignList") private List megaSignList = null; diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegasignEvent.java b/src/main/java/io/swagger/client/model/megaSigns/MegasignEvent.java index fb9a06f..35b17f4 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/MegasignEvent.java +++ b/src/main/java/io/swagger/client/model/megaSigns/MegasignEvent.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,79 +29,50 @@ /** * MegasignEvent */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class MegasignEvent { - @SerializedName("actingUserEmail") - private String actingUserEmail = null; - - @SerializedName("actingUserIpAddress") - private String actingUserIpAddress = null; - - @SerializedName("actingUserName") - private String actingUserName = null; - - @SerializedName("comment") - private String comment = null; - @SerializedName("date") private Date date = null; + @SerializedName("initiatingUserName") + private String initiatingUserName = null; + @SerializedName("description") private String description = null; - @SerializedName("deviceLocation") - private DeviceLocation deviceLocation = null; - - @SerializedName("devicePhoneNumber") - private String devicePhoneNumber = null; - - @SerializedName("digitalSignatureInfo") - private DigitalSignatureInfo digitalSignatureInfo = null; - - @SerializedName("initiatingUserEmail") - private String initiatingUserEmail = null; + @SerializedName("actingUserName") + private String actingUserName = null; - @SerializedName("initiatingUserName") - private String initiatingUserName = null; + @SerializedName("actingUserIpAddress") + private String actingUserIpAddress = null; @SerializedName("participantEmail") private String participantEmail = null; - @SerializedName("participantId") - private String participantId = null; - /** - * Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). + * Type of MegaSign event */ - @JsonAdapter(ParticipantRoleEnum.Adapter.class) - public enum ParticipantRoleEnum { - SIGNER("SIGNER"), - - DELEGATE_TO_SIGNER("DELEGATE_TO_SIGNER"), - - APPROVER("APPROVER"), - - DELEGATE_TO_APPROVER("DELEGATE_TO_APPROVER"), - - ACCEPTOR("ACCEPTOR"), + @JsonAdapter(TypeEnum.Adapter.class) + public enum TypeEnum { + AUTO_CANCELLED_CONVERSION_PROBLEM("AUTO_CANCELLED_CONVERSION_PROBLEM"), - DELEGATE_TO_ACCEPTOR("DELEGATE_TO_ACCEPTOR"), + CREATED("CREATED"), - FORM_FILLER("FORM_FILLER"), + EXPIRED("EXPIRED"), - DELEGATE_TO_FORM_FILLER("DELEGATE_TO_FORM_FILLER"), + EMAIL_BOUNCED("EMAIL_BOUNCED"), - CERTIFIED_RECIPIENT("CERTIFIED_RECIPIENT"), + RECALLED("RECALLED"), - DELEGATE_TO_CERTIFIED_RECIPIENT("DELEGATE_TO_CERTIFIED_RECIPIENT"), + SHARED("SHARED"), - SHARE("SHARE"), + READY_TO_VAULT("READY_TO_VAULT"), - SENDER("SENDER"); + VAULTED("VAULTED"); private String value; - ParticipantRoleEnum(String value) { + TypeEnum(String value) { this.value = value; } @@ -129,8 +85,8 @@ public String toString() { return String.valueOf(value); } - public static ParticipantRoleEnum fromValue(String text) { - for (ParticipantRoleEnum b : ParticipantRoleEnum.values()) { + public static TypeEnum fromValue(String text) { + for (TypeEnum b : TypeEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -138,48 +94,55 @@ public static ParticipantRoleEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final ParticipantRoleEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public ParticipantRoleEnum read(final JsonReader jsonReader) throws IOException { + public TypeEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return ParticipantRoleEnum.fromValue(String.valueOf(value)); + return TypeEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("participantRole") - private ParticipantRoleEnum participantRole = null; - - @SerializedName("synchronizationId") - private String synchronizationId = null; + @SerializedName("type") + private TypeEnum type = null; /** - * Type of MegaSign event + * Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). */ - @JsonAdapter(TypeEnum.Adapter.class) - public enum TypeEnum { - AUTO_CANCELLED_CONVERSION_PROBLEM("AUTO_CANCELLED_CONVERSION_PROBLEM"), + @JsonAdapter(ParticipantRoleEnum.Adapter.class) + public enum ParticipantRoleEnum { + SIGNER("SIGNER"), - CREATED("CREATED"), + DELEGATE_TO_SIGNER("DELEGATE_TO_SIGNER"), - EXPIRED("EXPIRED"), + APPROVER("APPROVER"), - EMAIL_BOUNCED("EMAIL_BOUNCED"), + DELEGATE_TO_APPROVER("DELEGATE_TO_APPROVER"), - RECALLED("RECALLED"), + ACCEPTOR("ACCEPTOR"), - SHARED("SHARED"), + DELEGATE_TO_ACCEPTOR("DELEGATE_TO_ACCEPTOR"), - VAULTED("VAULTED"); + FORM_FILLER("FORM_FILLER"), + + DELEGATE_TO_FORM_FILLER("DELEGATE_TO_FORM_FILLER"), + + CERTIFIED_RECIPIENT("CERTIFIED_RECIPIENT"), + + DELEGATE_TO_CERTIFIED_RECIPIENT("DELEGATE_TO_CERTIFIED_RECIPIENT"), + + SHARE("SHARE"), + + SENDER("SENDER"); private String value; - TypeEnum(String value) { + ParticipantRoleEnum(String value) { this.value = value; } @@ -192,8 +155,8 @@ public String toString() { return String.valueOf(value); } - public static TypeEnum fromValue(String text) { - for (TypeEnum b : TypeEnum.values()) { + public static ParticipantRoleEnum fromValue(String text) { + for (ParticipantRoleEnum b : ParticipantRoleEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -201,103 +164,58 @@ public static TypeEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final ParticipantRoleEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public TypeEnum read(final JsonReader jsonReader) throws IOException { + public ParticipantRoleEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return TypeEnum.fromValue(String.valueOf(value)); + return ParticipantRoleEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("type") - private TypeEnum type = null; + @SerializedName("participantRole") + private ParticipantRoleEnum participantRole = null; @SerializedName("vaultEventId") private String vaultEventId = null; - @SerializedName("vaultProviderName") - private String vaultProviderName = null; + @SerializedName("participantId") + private String participantId = null; @SerializedName("versionId") private String versionId = null; - public MegasignEvent actingUserEmail(String actingUserEmail) { - this.actingUserEmail = actingUserEmail; - return this; - } - - /** - * Email address of the user that created the event - * @return actingUserEmail - **/ - @ApiModelProperty(value = "Email address of the user that created the event") - public String getActingUserEmail() { - return actingUserEmail; - } - - public void setActingUserEmail(String actingUserEmail) { - this.actingUserEmail = actingUserEmail; - } - - public MegasignEvent actingUserIpAddress(String actingUserIpAddress) { - this.actingUserIpAddress = actingUserIpAddress; - return this; - } + @SerializedName("actingUserEmail") + private String actingUserEmail = null; - /** - * The IP address of the user that created the event - * @return actingUserIpAddress - **/ - @ApiModelProperty(value = "The IP address of the user that created the event") - public String getActingUserIpAddress() { - return actingUserIpAddress; - } + @SerializedName("devicePhoneNumber") + private String devicePhoneNumber = null; - public void setActingUserIpAddress(String actingUserIpAddress) { - this.actingUserIpAddress = actingUserIpAddress; - } + @SerializedName("initiatingUserEmail") + private String initiatingUserEmail = null; - public MegasignEvent actingUserName(String actingUserName) { - this.actingUserName = actingUserName; - return this; - } + @SerializedName("digitalSignatureInfo") + private DigitalSignatureInfo digitalSignatureInfo = null; - /** - * The name of the acting user - * @return actingUserName - **/ - @ApiModelProperty(value = "The name of the acting user") - public String getActingUserName() { - return actingUserName; - } + @SerializedName("vaultProviderName") + private String vaultProviderName = null; - public void setActingUserName(String actingUserName) { - this.actingUserName = actingUserName; - } + @SerializedName("comment") + private String comment = null; - public MegasignEvent comment(String comment) { - this.comment = comment; - return this; - } + @SerializedName("id") + private String id = null; - /** - * The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant - * @return comment - **/ - @ApiModelProperty(value = "The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant") - public String getComment() { - return comment; - } + @SerializedName("synchronizationId") + private String synchronizationId = null; - public void setComment(String comment) { - this.comment = comment; - } + @SerializedName("deviceLocation") + private DeviceLocation deviceLocation = null; public MegasignEvent date(Date date) { this.date = date; @@ -317,6 +235,24 @@ public void setDate(Date date) { this.date = date; } + public MegasignEvent initiatingUserName(String initiatingUserName) { + this.initiatingUserName = initiatingUserName; + return this; + } + + /** + * Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect + * @return initiatingUserName + **/ + @ApiModelProperty(value = "Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect") + public String getInitiatingUserName() { + return initiatingUserName; + } + + public void setInitiatingUserName(String initiatingUserName) { + this.initiatingUserName = initiatingUserName; + } + public MegasignEvent description(String description) { this.description = description; return this; @@ -335,112 +271,112 @@ public void setDescription(String description) { this.description = description; } - public MegasignEvent deviceLocation(DeviceLocation deviceLocation) { - this.deviceLocation = deviceLocation; + public MegasignEvent actingUserName(String actingUserName) { + this.actingUserName = actingUserName; return this; } /** - * Location of the device that generated the event (This value may be null due to limited privileges) - * @return deviceLocation + * The name of the acting user + * @return actingUserName **/ - @ApiModelProperty(value = "Location of the device that generated the event (This value may be null due to limited privileges)") - public DeviceLocation getDeviceLocation() { - return deviceLocation; + @ApiModelProperty(value = "The name of the acting user") + public String getActingUserName() { + return actingUserName; } - public void setDeviceLocation(DeviceLocation deviceLocation) { - this.deviceLocation = deviceLocation; + public void setActingUserName(String actingUserName) { + this.actingUserName = actingUserName; } - public MegasignEvent devicePhoneNumber(String devicePhoneNumber) { - this.devicePhoneNumber = devicePhoneNumber; + public MegasignEvent actingUserIpAddress(String actingUserIpAddress) { + this.actingUserIpAddress = actingUserIpAddress; return this; } /** - * Phone number from the device used when the participation is completed on a mobile phone - * @return devicePhoneNumber + * The IP address of the user that created the event + * @return actingUserIpAddress **/ - @ApiModelProperty(value = "Phone number from the device used when the participation is completed on a mobile phone") - public String getDevicePhoneNumber() { - return devicePhoneNumber; + @ApiModelProperty(value = "The IP address of the user that created the event") + public String getActingUserIpAddress() { + return actingUserIpAddress; } - public void setDevicePhoneNumber(String devicePhoneNumber) { - this.devicePhoneNumber = devicePhoneNumber; + public void setActingUserIpAddress(String actingUserIpAddress) { + this.actingUserIpAddress = actingUserIpAddress; } - public MegasignEvent digitalSignatureInfo(DigitalSignatureInfo digitalSignatureInfo) { - this.digitalSignatureInfo = digitalSignatureInfo; + public MegasignEvent participantEmail(String participantEmail) { + this.participantEmail = participantEmail; return this; } /** - * This is present for ESIGNED events when the participation is signed digitally - * @return digitalSignatureInfo + * Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to + * @return participantEmail **/ - @ApiModelProperty(value = "This is present for ESIGNED events when the participation is signed digitally") - public DigitalSignatureInfo getDigitalSignatureInfo() { - return digitalSignatureInfo; + @ApiModelProperty(value = "Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to") + public String getParticipantEmail() { + return participantEmail; } - public void setDigitalSignatureInfo(DigitalSignatureInfo digitalSignatureInfo) { - this.digitalSignatureInfo = digitalSignatureInfo; + public void setParticipantEmail(String participantEmail) { + this.participantEmail = participantEmail; } - public MegasignEvent initiatingUserEmail(String initiatingUserEmail) { - this.initiatingUserEmail = initiatingUserEmail; + public MegasignEvent type(TypeEnum type) { + this.type = type; return this; } /** - * Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect - * @return initiatingUserEmail + * Type of MegaSign event + * @return type **/ - @ApiModelProperty(value = "Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect") - public String getInitiatingUserEmail() { - return initiatingUserEmail; + @ApiModelProperty(value = "Type of MegaSign event") + public TypeEnum getType() { + return type; } - public void setInitiatingUserEmail(String initiatingUserEmail) { - this.initiatingUserEmail = initiatingUserEmail; + public void setType(TypeEnum type) { + this.type = type; } - public MegasignEvent initiatingUserName(String initiatingUserName) { - this.initiatingUserName = initiatingUserName; + public MegasignEvent participantRole(ParticipantRoleEnum participantRole) { + this.participantRole = participantRole; return this; } /** - * Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect - * @return initiatingUserName + * Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). + * @return participantRole **/ - @ApiModelProperty(value = "Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect") - public String getInitiatingUserName() { - return initiatingUserName; + @ApiModelProperty(value = "Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.).") + public ParticipantRoleEnum getParticipantRole() { + return participantRole; } - public void setInitiatingUserName(String initiatingUserName) { - this.initiatingUserName = initiatingUserName; + public void setParticipantRole(ParticipantRoleEnum participantRole) { + this.participantRole = participantRole; } - public MegasignEvent participantEmail(String participantEmail) { - this.participantEmail = participantEmail; + public MegasignEvent vaultEventId(String vaultEventId) { + this.vaultEventId = vaultEventId; return this; } /** - * Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to - * @return participantEmail + * The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null) + * @return vaultEventId **/ - @ApiModelProperty(value = "Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to") - public String getParticipantEmail() { - return participantEmail; + @ApiModelProperty(value = "The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null)") + public String getVaultEventId() { + return vaultEventId; } - public void setParticipantEmail(String participantEmail) { - this.participantEmail = participantEmail; + public void setVaultEventId(String vaultEventId) { + this.vaultEventId = vaultEventId; } public MegasignEvent participantId(String participantId) { @@ -461,76 +397,94 @@ public void setParticipantId(String participantId) { this.participantId = participantId; } - public MegasignEvent participantRole(ParticipantRoleEnum participantRole) { - this.participantRole = participantRole; + public MegasignEvent versionId(String versionId) { + this.versionId = versionId; return this; } /** - * Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). - * @return participantRole + * An ID which uniquely identifies the version of the document associated with this audit event + * @return versionId **/ - @ApiModelProperty(value = "Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.).") - public ParticipantRoleEnum getParticipantRole() { - return participantRole; + @ApiModelProperty(value = "An ID which uniquely identifies the version of the document associated with this audit event") + public String getVersionId() { + return versionId; } - public void setParticipantRole(ParticipantRoleEnum participantRole) { - this.participantRole = participantRole; + public void setVersionId(String versionId) { + this.versionId = versionId; } - public MegasignEvent synchronizationId(String synchronizationId) { - this.synchronizationId = synchronizationId; + public MegasignEvent actingUserEmail(String actingUserEmail) { + this.actingUserEmail = actingUserEmail; return this; } /** - * A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null) - * @return synchronizationId + * Email address of the user that created the event + * @return actingUserEmail **/ - @ApiModelProperty(value = "A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null)") - public String getSynchronizationId() { - return synchronizationId; + @ApiModelProperty(value = "Email address of the user that created the event") + public String getActingUserEmail() { + return actingUserEmail; } - public void setSynchronizationId(String synchronizationId) { - this.synchronizationId = synchronizationId; + public void setActingUserEmail(String actingUserEmail) { + this.actingUserEmail = actingUserEmail; } - public MegasignEvent type(TypeEnum type) { - this.type = type; + public MegasignEvent devicePhoneNumber(String devicePhoneNumber) { + this.devicePhoneNumber = devicePhoneNumber; return this; } /** - * Type of MegaSign event - * @return type + * Phone number from the device used when the participation is completed on a mobile phone + * @return devicePhoneNumber **/ - @ApiModelProperty(value = "Type of MegaSign event") - public TypeEnum getType() { - return type; + @ApiModelProperty(value = "Phone number from the device used when the participation is completed on a mobile phone") + public String getDevicePhoneNumber() { + return devicePhoneNumber; } - public void setType(TypeEnum type) { - this.type = type; + public void setDevicePhoneNumber(String devicePhoneNumber) { + this.devicePhoneNumber = devicePhoneNumber; } - public MegasignEvent vaultEventId(String vaultEventId) { - this.vaultEventId = vaultEventId; + public MegasignEvent initiatingUserEmail(String initiatingUserEmail) { + this.initiatingUserEmail = initiatingUserEmail; return this; } /** - * The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null) - * @return vaultEventId + * Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect + * @return initiatingUserEmail **/ - @ApiModelProperty(value = "The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null)") - public String getVaultEventId() { - return vaultEventId; + @ApiModelProperty(value = "Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect") + public String getInitiatingUserEmail() { + return initiatingUserEmail; } - public void setVaultEventId(String vaultEventId) { - this.vaultEventId = vaultEventId; + public void setInitiatingUserEmail(String initiatingUserEmail) { + this.initiatingUserEmail = initiatingUserEmail; + } + + public MegasignEvent digitalSignatureInfo(DigitalSignatureInfo digitalSignatureInfo) { + this.digitalSignatureInfo = digitalSignatureInfo; + return this; + } + + /** + * This is present for ESIGNED events when the participation is signed digitally + * @return digitalSignatureInfo + **/ + @ApiModelProperty(value = "This is present for ESIGNED events when the participation is signed digitally") + public DigitalSignatureInfo getDigitalSignatureInfo() { + return digitalSignatureInfo; + } + + public void setDigitalSignatureInfo(DigitalSignatureInfo digitalSignatureInfo) { + this.digitalSignatureInfo = digitalSignatureInfo; } public MegasignEvent vaultProviderName(String vaultProviderName) { @@ -551,22 +505,76 @@ public void setVaultProviderName(String vaultProviderName) { this.vaultProviderName = vaultProviderName; } - public MegasignEvent versionId(String versionId) { - this.versionId = versionId; + public MegasignEvent comment(String comment) { + this.comment = comment; return this; } /** - * An ID which uniquely identifies the version of the document associated with this audit event - * @return versionId + * The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant + * @return comment **/ - @ApiModelProperty(value = "An ID which uniquely identifies the version of the document associated with this audit event") - public String getVersionId() { - return versionId; + @ApiModelProperty(value = "The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant") + public String getComment() { + return comment; } - public void setVersionId(String versionId) { - this.versionId = versionId; + public void setComment(String comment) { + this.comment = comment; + } + + public MegasignEvent id(String id) { + this.id = id; + return this; + } + + /** + * The identifier for the event. + * @return id + **/ + @ApiModelProperty(value = "The identifier for the event.") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public MegasignEvent synchronizationId(String synchronizationId) { + this.synchronizationId = synchronizationId; + return this; + } + + /** + * A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null) + * @return synchronizationId + **/ + @ApiModelProperty(value = "A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null)") + public String getSynchronizationId() { + return synchronizationId; + } + + public void setSynchronizationId(String synchronizationId) { + this.synchronizationId = synchronizationId; + } + + public MegasignEvent deviceLocation(DeviceLocation deviceLocation) { + this.deviceLocation = deviceLocation; + return this; + } + + /** + * Location of the device that generated the event (This value may be null due to limited privileges) + * @return deviceLocation + **/ + @ApiModelProperty(value = "Location of the device that generated the event (This value may be null due to limited privileges)") + public DeviceLocation getDeviceLocation() { + return deviceLocation; + } + + public void setDeviceLocation(DeviceLocation deviceLocation) { + this.deviceLocation = deviceLocation; } @@ -579,30 +587,31 @@ public boolean equals(java.lang.Object o) { return false; } MegasignEvent megasignEvent = (MegasignEvent) o; - return Objects.equals(this.actingUserEmail, megasignEvent.actingUserEmail) && - Objects.equals(this.actingUserIpAddress, megasignEvent.actingUserIpAddress) && - Objects.equals(this.actingUserName, megasignEvent.actingUserName) && - Objects.equals(this.comment, megasignEvent.comment) && - Objects.equals(this.date, megasignEvent.date) && - Objects.equals(this.description, megasignEvent.description) && - Objects.equals(this.deviceLocation, megasignEvent.deviceLocation) && - Objects.equals(this.devicePhoneNumber, megasignEvent.devicePhoneNumber) && - Objects.equals(this.digitalSignatureInfo, megasignEvent.digitalSignatureInfo) && - Objects.equals(this.initiatingUserEmail, megasignEvent.initiatingUserEmail) && + return Objects.equals(this.date, megasignEvent.date) && Objects.equals(this.initiatingUserName, megasignEvent.initiatingUserName) && + Objects.equals(this.description, megasignEvent.description) && + Objects.equals(this.actingUserName, megasignEvent.actingUserName) && + Objects.equals(this.actingUserIpAddress, megasignEvent.actingUserIpAddress) && Objects.equals(this.participantEmail, megasignEvent.participantEmail) && - Objects.equals(this.participantId, megasignEvent.participantId) && - Objects.equals(this.participantRole, megasignEvent.participantRole) && - Objects.equals(this.synchronizationId, megasignEvent.synchronizationId) && Objects.equals(this.type, megasignEvent.type) && + Objects.equals(this.participantRole, megasignEvent.participantRole) && Objects.equals(this.vaultEventId, megasignEvent.vaultEventId) && + Objects.equals(this.participantId, megasignEvent.participantId) && + Objects.equals(this.versionId, megasignEvent.versionId) && + Objects.equals(this.actingUserEmail, megasignEvent.actingUserEmail) && + Objects.equals(this.devicePhoneNumber, megasignEvent.devicePhoneNumber) && + Objects.equals(this.initiatingUserEmail, megasignEvent.initiatingUserEmail) && + Objects.equals(this.digitalSignatureInfo, megasignEvent.digitalSignatureInfo) && Objects.equals(this.vaultProviderName, megasignEvent.vaultProviderName) && - Objects.equals(this.versionId, megasignEvent.versionId); + Objects.equals(this.comment, megasignEvent.comment) && + Objects.equals(this.id, megasignEvent.id) && + Objects.equals(this.synchronizationId, megasignEvent.synchronizationId) && + Objects.equals(this.deviceLocation, megasignEvent.deviceLocation); } @Override public int hashCode() { - return Objects.hash(actingUserEmail, actingUserIpAddress, actingUserName, comment, date, description, deviceLocation, devicePhoneNumber, digitalSignatureInfo, initiatingUserEmail, initiatingUserName, participantEmail, participantId, participantRole, synchronizationId, type, vaultEventId, vaultProviderName, versionId); + return Objects.hash(date, initiatingUserName, description, actingUserName, actingUserIpAddress, participantEmail, type, participantRole, vaultEventId, participantId, versionId, actingUserEmail, devicePhoneNumber, initiatingUserEmail, digitalSignatureInfo, vaultProviderName, comment, id, synchronizationId, deviceLocation); } @@ -611,25 +620,26 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class MegasignEvent {\n"); - sb.append(" actingUserEmail: ").append(toIndentedString(actingUserEmail)).append("\n"); - sb.append(" actingUserIpAddress: ").append(toIndentedString(actingUserIpAddress)).append("\n"); - sb.append(" actingUserName: ").append(toIndentedString(actingUserName)).append("\n"); - sb.append(" comment: ").append(toIndentedString(comment)).append("\n"); sb.append(" date: ").append(toIndentedString(date)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" deviceLocation: ").append(toIndentedString(deviceLocation)).append("\n"); - sb.append(" devicePhoneNumber: ").append(toIndentedString(devicePhoneNumber)).append("\n"); - sb.append(" digitalSignatureInfo: ").append(toIndentedString(digitalSignatureInfo)).append("\n"); - sb.append(" initiatingUserEmail: ").append(toIndentedString(initiatingUserEmail)).append("\n"); sb.append(" initiatingUserName: ").append(toIndentedString(initiatingUserName)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" actingUserName: ").append(toIndentedString(actingUserName)).append("\n"); + sb.append(" actingUserIpAddress: ").append(toIndentedString(actingUserIpAddress)).append("\n"); sb.append(" participantEmail: ").append(toIndentedString(participantEmail)).append("\n"); - sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); - sb.append(" participantRole: ").append(toIndentedString(participantRole)).append("\n"); - sb.append(" synchronizationId: ").append(toIndentedString(synchronizationId)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" participantRole: ").append(toIndentedString(participantRole)).append("\n"); sb.append(" vaultEventId: ").append(toIndentedString(vaultEventId)).append("\n"); - sb.append(" vaultProviderName: ").append(toIndentedString(vaultProviderName)).append("\n"); + sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); sb.append(" versionId: ").append(toIndentedString(versionId)).append("\n"); + sb.append(" actingUserEmail: ").append(toIndentedString(actingUserEmail)).append("\n"); + sb.append(" devicePhoneNumber: ").append(toIndentedString(devicePhoneNumber)).append("\n"); + sb.append(" initiatingUserEmail: ").append(toIndentedString(initiatingUserEmail)).append("\n"); + sb.append(" digitalSignatureInfo: ").append(toIndentedString(digitalSignatureInfo)).append("\n"); + sb.append(" vaultProviderName: ").append(toIndentedString(vaultProviderName)).append("\n"); + sb.append(" comment: ").append(toIndentedString(comment)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" synchronizationId: ").append(toIndentedString(synchronizationId)).append("\n"); + sb.append(" deviceLocation: ").append(toIndentedString(deviceLocation)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/megaSigns/MegasignEventList.java b/src/main/java/io/swagger/client/model/megaSigns/MegasignEventList.java index ae3a4a9..603b987 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/MegasignEventList.java +++ b/src/main/java/io/swagger/client/model/megaSigns/MegasignEventList.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * MegasignEventList */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class MegasignEventList { @SerializedName("events") private List events = null; diff --git a/src/main/java/io/swagger/client/model/megaSigns/MyAgreementInfo.java b/src/main/java/io/swagger/client/model/megaSigns/MyAgreementInfo.java new file mode 100644 index 0000000..87e9277 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/MyAgreementInfo.java @@ -0,0 +1,104 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.megaSigns.AccountSharerInfo; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * MyAgreementInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class MyAgreementInfo { + @SerializedName("accountSharers") + private List accountSharers = null; + + public MyAgreementInfo accountSharers(List accountSharers) { + this.accountSharers = accountSharers; + return this; + } + + public MyAgreementInfo addAccountSharersItem(AccountSharerInfo accountSharersItem) { + if (this.accountSharers == null) { + this.accountSharers = new ArrayList(); + } + this.accountSharers.add(accountSharersItem); + return this; + } + + /** + * A list of account sharer in relation to the api caller and this resource. + * @return accountSharers + **/ + @ApiModelProperty(value = "A list of account sharer in relation to the api caller and this resource.") + public List getAccountSharers() { + return accountSharers; + } + + public void setAccountSharers(List accountSharers) { + this.accountSharers = accountSharers; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + MyAgreementInfo myAgreementInfo = (MyAgreementInfo) o; + return Objects.equals(this.accountSharers, myAgreementInfo.accountSharers); + } + + @Override + public int hashCode() { + return Objects.hash(accountSharers); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class MyAgreementInfo {\n"); + + sb.append(" accountSharers: ").append(toIndentedString(accountSharers)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/Note.java b/src/main/java/io/swagger/client/model/megaSigns/Note.java new file mode 100644 index 0000000..5ffc7be --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/Note.java @@ -0,0 +1,93 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Note + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class Note { + @SerializedName("note") + private String note = null; + + public Note note(String note) { + this.note = note; + return this; + } + + /** + * Content of Note field + * @return note + **/ + @ApiModelProperty(value = "Content of Note field") + public String getNote() { + return note; + } + + public void setNote(String note) { + this.note = note; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Note note = (Note) o; + return Objects.equals(this.note, note.note); + } + + @Override + public int hashCode() { + return Objects.hash(note); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Note {\n"); + + sb.append(" note: ").append(toIndentedString(note)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/PageImageUrl.java b/src/main/java/io/swagger/client/model/megaSigns/PageImageUrl.java new file mode 100644 index 0000000..fde5b80 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/PageImageUrl.java @@ -0,0 +1,116 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * PageImageUrl + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class PageImageUrl { + @SerializedName("pageNumber") + private Integer pageNumber = null; + + @SerializedName("url") + private String url = null; + + public PageImageUrl pageNumber(Integer pageNumber) { + this.pageNumber = pageNumber; + return this; + } + + /** + * Page number within the document. + * @return pageNumber + **/ + @ApiModelProperty(value = "Page number within the document.") + public Integer getPageNumber() { + return pageNumber; + } + + public void setPageNumber(Integer pageNumber) { + this.pageNumber = pageNumber; + } + + public PageImageUrl url(String url) { + this.url = url; + return this; + } + + /** + * An image url. + * @return url + **/ + @ApiModelProperty(value = "An image url.") + public String getUrl() { + return url; + } + + public void setUrl(String url) { + this.url = url; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PageImageUrl pageImageUrl = (PageImageUrl) o; + return Objects.equals(this.pageNumber, pageImageUrl.pageNumber) && + Objects.equals(this.url, pageImageUrl.url); + } + + @Override + public int hashCode() { + return Objects.hash(pageNumber, url); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PageImageUrl {\n"); + + sb.append(" pageNumber: ").append(toIndentedString(pageNumber)).append("\n"); + sb.append(" url: ").append(toIndentedString(url)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/PageInfo.java b/src/main/java/io/swagger/client/model/megaSigns/PageInfo.java index fee33dd..5b7fb16 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/PageInfo.java +++ b/src/main/java/io/swagger/client/model/megaSigns/PageInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * PageInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class PageInfo { @SerializedName("nextCursor") private String nextCursor = null; diff --git a/src/main/java/io/swagger/client/model/megaSigns/ParticipantSecurityOption.java b/src/main/java/io/swagger/client/model/megaSigns/ParticipantSecurityOption.java new file mode 100644 index 0000000..bc59cd3 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/ParticipantSecurityOption.java @@ -0,0 +1,197 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.megaSigns.PhoneInfo; +import java.io.IOException; + +/** + * ParticipantSecurityOption + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class ParticipantSecurityOption { + @SerializedName("password") + private String password = null; + + /** + * The authentication method for the participants to have access to view and sign the document. When replacing a participant that has PASSWORD or PHONE authentication specified, you must supply a password or phone number for the new participant, and you cannot change the authentication method + */ + @JsonAdapter(AuthenticationMethodEnum.Adapter.class) + public enum AuthenticationMethodEnum { + NONE("NONE"), + + PASSWORD("PASSWORD"), + + PHONE("PHONE"), + + KBA("KBA"), + + WEB_IDENTITY("WEB_IDENTITY"), + + ADOBE_SIGN("ADOBE_SIGN"), + + GOV_ID("GOV_ID"); + + private String value; + + AuthenticationMethodEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static AuthenticationMethodEnum fromValue(String text) { + for (AuthenticationMethodEnum b : AuthenticationMethodEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final AuthenticationMethodEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public AuthenticationMethodEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return AuthenticationMethodEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("authenticationMethod") + private AuthenticationMethodEnum authenticationMethod = null; + + @SerializedName("phoneInfo") + private PhoneInfo phoneInfo = null; + + public ParticipantSecurityOption password(String password) { + this.password = password; + return this; + } + + /** + * The password required for the participant to view and sign the document. Note that AdobeSign will never show this password to anyone, so you will need to separately communicate it to any relevant parties. The password will not be returned in GET call. When replacing a participant that has PASSWORD authentication specified, you must supply a password for the new participant. + * @return password + **/ + @ApiModelProperty(value = "The password required for the participant to view and sign the document. Note that AdobeSign will never show this password to anyone, so you will need to separately communicate it to any relevant parties. The password will not be returned in GET call. When replacing a participant that has PASSWORD authentication specified, you must supply a password for the new participant.") + public String getPassword() { + return password; + } + + public void setPassword(String password) { + this.password = password; + } + + public ParticipantSecurityOption authenticationMethod(AuthenticationMethodEnum authenticationMethod) { + this.authenticationMethod = authenticationMethod; + return this; + } + + /** + * The authentication method for the participants to have access to view and sign the document. When replacing a participant that has PASSWORD or PHONE authentication specified, you must supply a password or phone number for the new participant, and you cannot change the authentication method + * @return authenticationMethod + **/ + @ApiModelProperty(value = "The authentication method for the participants to have access to view and sign the document. When replacing a participant that has PASSWORD or PHONE authentication specified, you must supply a password or phone number for the new participant, and you cannot change the authentication method") + public AuthenticationMethodEnum getAuthenticationMethod() { + return authenticationMethod; + } + + public void setAuthenticationMethod(AuthenticationMethodEnum authenticationMethod) { + this.authenticationMethod = authenticationMethod; + } + + public ParticipantSecurityOption phoneInfo(PhoneInfo phoneInfo) { + this.phoneInfo = phoneInfo; + return this; + } + + /** + * The phoneInfo required for the participant to view and sign the document + * @return phoneInfo + **/ + @ApiModelProperty(value = "The phoneInfo required for the participant to view and sign the document") + public PhoneInfo getPhoneInfo() { + return phoneInfo; + } + + public void setPhoneInfo(PhoneInfo phoneInfo) { + this.phoneInfo = phoneInfo; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ParticipantSecurityOption participantSecurityOption = (ParticipantSecurityOption) o; + return Objects.equals(this.password, participantSecurityOption.password) && + Objects.equals(this.authenticationMethod, participantSecurityOption.authenticationMethod) && + Objects.equals(this.phoneInfo, participantSecurityOption.phoneInfo); + } + + @Override + public int hashCode() { + return Objects.hash(password, authenticationMethod, phoneInfo); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ParticipantSecurityOption {\n"); + + sb.append(" password: ").append(toIndentedString(password)).append("\n"); + sb.append(" authenticationMethod: ").append(toIndentedString(authenticationMethod)).append("\n"); + sb.append(" phoneInfo: ").append(toIndentedString(phoneInfo)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/PhoneInfo.java b/src/main/java/io/swagger/client/model/megaSigns/PhoneInfo.java new file mode 100644 index 0000000..91c4e56 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/PhoneInfo.java @@ -0,0 +1,139 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * PhoneInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class PhoneInfo { + @SerializedName("countryIsoCode") + private String countryIsoCode = null; + + @SerializedName("phone") + private String phone = null; + + @SerializedName("countryCode") + private String countryCode = null; + + public PhoneInfo countryIsoCode(String countryIsoCode) { + this.countryIsoCode = countryIsoCode; + return this; + } + + /** + * The country ISO Alpha-2 code required for the participant to view and sign the document if authentication method is PHONE + * @return countryIsoCode + **/ + @ApiModelProperty(value = "The country ISO Alpha-2 code required for the participant to view and sign the document if authentication method is PHONE") + public String getCountryIsoCode() { + return countryIsoCode; + } + + public void setCountryIsoCode(String countryIsoCode) { + this.countryIsoCode = countryIsoCode; + } + + public PhoneInfo phone(String phone) { + this.phone = phone; + return this; + } + + /** + * The phone number required for the participant to view and sign the document if authentication method is PHONE. When replacing a participant that has PHONE authentication specified, you must supply a phone number for the new participant. + * @return phone + **/ + @ApiModelProperty(value = "The phone number required for the participant to view and sign the document if authentication method is PHONE. When replacing a participant that has PHONE authentication specified, you must supply a phone number for the new participant.") + public String getPhone() { + return phone; + } + + public void setPhone(String phone) { + this.phone = phone; + } + + public PhoneInfo countryCode(String countryCode) { + this.countryCode = countryCode; + return this; + } + + /** + * The numeric country calling code (ISD code) required for the participant to view and sign the document if authentication type is PHONE + * @return countryCode + **/ + @ApiModelProperty(value = "The numeric country calling code (ISD code) required for the participant to view and sign the document if authentication type is PHONE") + public String getCountryCode() { + return countryCode; + } + + public void setCountryCode(String countryCode) { + this.countryCode = countryCode; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PhoneInfo phoneInfo = (PhoneInfo) o; + return Objects.equals(this.countryIsoCode, phoneInfo.countryIsoCode) && + Objects.equals(this.phone, phoneInfo.phone) && + Objects.equals(this.countryCode, phoneInfo.countryCode); + } + + @Override + public int hashCode() { + return Objects.hash(countryIsoCode, phone, countryCode); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PhoneInfo {\n"); + + sb.append(" countryIsoCode: ").append(toIndentedString(countryIsoCode)).append("\n"); + sb.append(" phone: ").append(toIndentedString(phone)).append("\n"); + sb.append(" countryCode: ").append(toIndentedString(countryCode)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/PostSignOption.java b/src/main/java/io/swagger/client/model/megaSigns/PostSignOption.java index 15487fe..85566f4 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/PostSignOption.java +++ b/src/main/java/io/swagger/client/model/megaSigns/PostSignOption.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,31 +26,13 @@ /** * PostSignOption */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class PostSignOption { - @SerializedName("redirectDelay") - private Integer redirectDelay = null; - @SerializedName("redirectUrl") private String redirectUrl = null; - public PostSignOption redirectDelay(Integer redirectDelay) { - this.redirectDelay = redirectDelay; - return this; - } - - /** - * The delay (in seconds) before the user is taken to the success page. If this value is greater than 0, the user will first see the standard Adobe Sign success message, and then after a delay will be redirected to your success page - * @return redirectDelay - **/ - @ApiModelProperty(value = "The delay (in seconds) before the user is taken to the success page. If this value is greater than 0, the user will first see the standard Adobe Sign success message, and then after a delay will be redirected to your success page") - public Integer getRedirectDelay() { - return redirectDelay; - } - - public void setRedirectDelay(Integer redirectDelay) { - this.redirectDelay = redirectDelay; - } + @SerializedName("redirectDelay") + private Integer redirectDelay = null; public PostSignOption redirectUrl(String redirectUrl) { this.redirectUrl = redirectUrl; @@ -85,6 +52,24 @@ public void setRedirectUrl(String redirectUrl) { this.redirectUrl = redirectUrl; } + public PostSignOption redirectDelay(Integer redirectDelay) { + this.redirectDelay = redirectDelay; + return this; + } + + /** + * The delay (in seconds) before the user is taken to the success page. If this value is greater than 0, the user will first see the standard Adobe Sign success message, and then after a delay will be redirected to your success page + * @return redirectDelay + **/ + @ApiModelProperty(value = "The delay (in seconds) before the user is taken to the success page. If this value is greater than 0, the user will first see the standard Adobe Sign success message, and then after a delay will be redirected to your success page") + public Integer getRedirectDelay() { + return redirectDelay; + } + + public void setRedirectDelay(Integer redirectDelay) { + this.redirectDelay = redirectDelay; + } + @Override public boolean equals(java.lang.Object o) { @@ -95,13 +80,13 @@ public boolean equals(java.lang.Object o) { return false; } PostSignOption postSignOption = (PostSignOption) o; - return Objects.equals(this.redirectDelay, postSignOption.redirectDelay) && - Objects.equals(this.redirectUrl, postSignOption.redirectUrl); + return Objects.equals(this.redirectUrl, postSignOption.redirectUrl) && + Objects.equals(this.redirectDelay, postSignOption.redirectDelay); } @Override public int hashCode() { - return Objects.hash(redirectDelay, redirectUrl); + return Objects.hash(redirectUrl, redirectDelay); } @@ -110,8 +95,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class PostSignOption {\n"); - sb.append(" redirectDelay: ").append(toIndentedString(redirectDelay)).append("\n"); sb.append(" redirectUrl: ").append(toIndentedString(redirectUrl)).append("\n"); + sb.append(" redirectDelay: ").append(toIndentedString(redirectDelay)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/megaSigns/ReminderCreationResult.java b/src/main/java/io/swagger/client/model/megaSigns/ReminderCreationResult.java new file mode 100644 index 0000000..68b2d4d --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/ReminderCreationResult.java @@ -0,0 +1,93 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * ReminderCreationResult + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class ReminderCreationResult { + @SerializedName("id") + private String id = null; + + public ReminderCreationResult id(String id) { + this.id = id; + return this; + } + + /** + * An identifier of the reminder resource created on the server. If provided in POST or PUT, it will be ignored + * @return id + **/ + @ApiModelProperty(value = "An identifier of the reminder resource created on the server. If provided in POST or PUT, it will be ignored") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ReminderCreationResult reminderCreationResult = (ReminderCreationResult) o; + return Objects.equals(this.id, reminderCreationResult.id); + } + + @Override + public int hashCode() { + return Objects.hash(id); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ReminderCreationResult {\n"); + + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/ReminderInfo.java b/src/main/java/io/swagger/client/model/megaSigns/ReminderInfo.java new file mode 100644 index 0000000..01c72d6 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/ReminderInfo.java @@ -0,0 +1,464 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +/** + * ReminderInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class ReminderInfo { + @SerializedName("note") + private String note = null; + + @SerializedName("lastSentDate") + private Date lastSentDate = null; + + @SerializedName("nextSentDate") + private Date nextSentDate = null; + + @SerializedName("reminderId") + private String reminderId = null; + + @SerializedName("firstReminderDelay") + private Integer firstReminderDelay = null; + + @SerializedName("recipientParticipantIds") + private List recipientParticipantIds = null; + + /** + * Reminder can be sent based on when the agreement becomes available or when the reminder is created<br>AGREEMENT_AVAILABILITY: If the agreement is not available to the participant at the time of reminder creation, the reminder will be sent for the first time, only when the agreement becomes available to the participant taking the firstReminderDelay into account. Subsequent reminders will be sent based on the frequency specified. If the agreement is already available to the participant at the time of reminder creation, the first reminder will be sent after the delay specified by firstReminderDelay from the reminder creation time.<br>REMINDER_CREATION: The first reminder will be sent after the delay specified by firstReminderDelay from the reminder creation time only if the agreement is available at that time. Subsequent reminders will be triggered based on the frequency specified and will be sent only if the agreement is available at that time. For agreements in authoring state, creating reminder with startReminderCounterFrom as REMINDER_CREATION is not allowed.<br>Note : If firstReminderDelay, frequency and startReminderCounterFrom fields are not specified in POST, reminder will be sent right now if the agreement is available. If agreement is not available, an error will be thrown. Cannot be updated in a PUT + */ + @JsonAdapter(StartReminderCounterFromEnum.Adapter.class) + public enum StartReminderCounterFromEnum { + AGREEMENT_AVAILABILITY("AGREEMENT_AVAILABILITY"), + + REMINDER_CREATION("REMINDER_CREATION"); + + private String value; + + StartReminderCounterFromEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static StartReminderCounterFromEnum fromValue(String text) { + for (StartReminderCounterFromEnum b : StartReminderCounterFromEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final StartReminderCounterFromEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public StartReminderCounterFromEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return StartReminderCounterFromEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("startReminderCounterFrom") + private StartReminderCounterFromEnum startReminderCounterFrom = null; + + @SerializedName("allUnsigned") + private Boolean allUnsigned = null; + + /** + * The frequency at which reminder will be sent until the agreement is completed.<br>If frequency is not provided, the reminder will be sent once (if the agreement is available at the specified time) with the delay based on the firstReminderDelay field and will never repeat again. If the agreement is not available at that time, reminder will not be sent. Cannot be updated in a PUT + */ + @JsonAdapter(FrequencyEnum.Adapter.class) + public enum FrequencyEnum { + DAILY_UNTIL_SIGNED("DAILY_UNTIL_SIGNED"), + + WEEKDAILY_UNTIL_SIGNED("WEEKDAILY_UNTIL_SIGNED"), + + EVERY_OTHER_DAY_UNTIL_SIGNED("EVERY_OTHER_DAY_UNTIL_SIGNED"), + + EVERY_THIRD_DAY_UNTIL_SIGNED("EVERY_THIRD_DAY_UNTIL_SIGNED"), + + EVERY_FIFTH_DAY_UNTIL_SIGNED("EVERY_FIFTH_DAY_UNTIL_SIGNED"), + + WEEKLY_UNTIL_SIGNED("WEEKLY_UNTIL_SIGNED"), + + ONCE("ONCE"); + + private String value; + + FrequencyEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static FrequencyEnum fromValue(String text) { + for (FrequencyEnum b : FrequencyEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final FrequencyEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public FrequencyEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return FrequencyEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("frequency") + private FrequencyEnum frequency = null; + + /** + * Current status of the reminder. The only valid update in a PUT is from ACTIVE to CANCELED. Must be provided as ACTIVE in a POST. + */ + @JsonAdapter(StatusEnum.Adapter.class) + public enum StatusEnum { + ACTIVE("ACTIVE"), + + CANCELED("CANCELED"), + + COMPLETE("COMPLETE"); + + private String value; + + StatusEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static StatusEnum fromValue(String text) { + for (StatusEnum b : StatusEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public StatusEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return StatusEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("status") + private StatusEnum status = null; + + public ReminderInfo note(String note) { + this.note = note; + return this; + } + + /** + * An optional message sent to the recipients, describing why their participation is required + * @return note + **/ + @ApiModelProperty(value = "An optional message sent to the recipients, describing why their participation is required") + public String getNote() { + return note; + } + + public void setNote(String note) { + this.note = note; + } + + public ReminderInfo lastSentDate(Date lastSentDate) { + this.lastSentDate = lastSentDate; + return this; + } + + /** + * The date when the reminder was last sent. Only provided in GET. Cannot be provided in POST request. If provided in POST, it will be ignored. Cannot be updated in a PUT. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return lastSentDate + **/ + @ApiModelProperty(value = "The date when the reminder was last sent. Only provided in GET. Cannot be provided in POST request. If provided in POST, it will be ignored. Cannot be updated in a PUT. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getLastSentDate() { + return lastSentDate; + } + + public void setLastSentDate(Date lastSentDate) { + this.lastSentDate = lastSentDate; + } + + public ReminderInfo nextSentDate(Date nextSentDate) { + this.nextSentDate = nextSentDate; + return this; + } + + /** + * The date when the reminder is scheduled to be sent next. When provided in POST request, frequency needs to be ONCE (or not specified), startReminderCounterFrom needs to be REMINDER_CREATION (or not specified) and firstReminderDelay needs to be 0 (or not specified). Cannot be updated in a PUT. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return nextSentDate + **/ + @ApiModelProperty(value = "The date when the reminder is scheduled to be sent next. When provided in POST request, frequency needs to be ONCE (or not specified), startReminderCounterFrom needs to be REMINDER_CREATION (or not specified) and firstReminderDelay needs to be 0 (or not specified). Cannot be updated in a PUT. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getNextSentDate() { + return nextSentDate; + } + + public void setNextSentDate(Date nextSentDate) { + this.nextSentDate = nextSentDate; + } + + public ReminderInfo reminderId(String reminderId) { + this.reminderId = reminderId; + return this; + } + + /** + * An identifier of the reminder resource created on the server. If provided in POST or PUT, it will be ignored + * @return reminderId + **/ + @ApiModelProperty(value = "An identifier of the reminder resource created on the server. If provided in POST or PUT, it will be ignored") + public String getReminderId() { + return reminderId; + } + + public void setReminderId(String reminderId) { + this.reminderId = reminderId; + } + + public ReminderInfo firstReminderDelay(Integer firstReminderDelay) { + this.firstReminderDelay = firstReminderDelay; + return this; + } + + /** + * Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT + * @return firstReminderDelay + **/ + @ApiModelProperty(value = "Integer which specifies the delay in hours before sending the first reminder.
This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.
If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.
i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Cannot be updated in a PUT") + public Integer getFirstReminderDelay() { + return firstReminderDelay; + } + + public void setFirstReminderDelay(Integer firstReminderDelay) { + this.firstReminderDelay = firstReminderDelay; + } + + public ReminderInfo recipientParticipantIds(List recipientParticipantIds) { + this.recipientParticipantIds = recipientParticipantIds; + return this; + } + + public ReminderInfo addRecipientParticipantIdsItem(String recipientParticipantIdsItem) { + if (this.recipientParticipantIds == null) { + this.recipientParticipantIds = new ArrayList(); + } + this.recipientParticipantIds.add(recipientParticipantIdsItem); + return this; + } + + /** + * A list of one or more participant IDs that the reminder should be sent to. These must be sharees or cc's on the MegaSign. In order to remind any other participant who has not signed, use the allUnsigned boolean parameter. + * @return recipientParticipantIds + **/ + @ApiModelProperty(value = "A list of one or more participant IDs that the reminder should be sent to. These must be sharees or cc's on the MegaSign. In order to remind any other participant who has not signed, use the allUnsigned boolean parameter.") + public List getRecipientParticipantIds() { + return recipientParticipantIds; + } + + public void setRecipientParticipantIds(List recipientParticipantIds) { + this.recipientParticipantIds = recipientParticipantIds; + } + + public ReminderInfo startReminderCounterFrom(StartReminderCounterFromEnum startReminderCounterFrom) { + this.startReminderCounterFrom = startReminderCounterFrom; + return this; + } + + /** + * Reminder can be sent based on when the agreement becomes available or when the reminder is created<br>AGREEMENT_AVAILABILITY: If the agreement is not available to the participant at the time of reminder creation, the reminder will be sent for the first time, only when the agreement becomes available to the participant taking the firstReminderDelay into account. Subsequent reminders will be sent based on the frequency specified. If the agreement is already available to the participant at the time of reminder creation, the first reminder will be sent after the delay specified by firstReminderDelay from the reminder creation time.<br>REMINDER_CREATION: The first reminder will be sent after the delay specified by firstReminderDelay from the reminder creation time only if the agreement is available at that time. Subsequent reminders will be triggered based on the frequency specified and will be sent only if the agreement is available at that time. For agreements in authoring state, creating reminder with startReminderCounterFrom as REMINDER_CREATION is not allowed.<br>Note : If firstReminderDelay, frequency and startReminderCounterFrom fields are not specified in POST, reminder will be sent right now if the agreement is available. If agreement is not available, an error will be thrown. Cannot be updated in a PUT + * @return startReminderCounterFrom + **/ + @ApiModelProperty(value = "Reminder can be sent based on when the agreement becomes available or when the reminder is created
AGREEMENT_AVAILABILITY: If the agreement is not available to the participant at the time of reminder creation, the reminder will be sent for the first time, only when the agreement becomes available to the participant taking the firstReminderDelay into account. Subsequent reminders will be sent based on the frequency specified. If the agreement is already available to the participant at the time of reminder creation, the first reminder will be sent after the delay specified by firstReminderDelay from the reminder creation time.
REMINDER_CREATION: The first reminder will be sent after the delay specified by firstReminderDelay from the reminder creation time only if the agreement is available at that time. Subsequent reminders will be triggered based on the frequency specified and will be sent only if the agreement is available at that time. For agreements in authoring state, creating reminder with startReminderCounterFrom as REMINDER_CREATION is not allowed.
Note : If firstReminderDelay, frequency and startReminderCounterFrom fields are not specified in POST, reminder will be sent right now if the agreement is available. If agreement is not available, an error will be thrown. Cannot be updated in a PUT") + public StartReminderCounterFromEnum getStartReminderCounterFrom() { + return startReminderCounterFrom; + } + + public void setStartReminderCounterFrom(StartReminderCounterFromEnum startReminderCounterFrom) { + this.startReminderCounterFrom = startReminderCounterFrom; + } + + public ReminderInfo allUnsigned(Boolean allUnsigned) { + this.allUnsigned = allUnsigned; + return this; + } + + /** + * If true, set a reminder on all participants (non-CCs and non-sharees) that still need to sign the MegaSign agreement + * @return allUnsigned + **/ + @ApiModelProperty(value = "If true, set a reminder on all participants (non-CCs and non-sharees) that still need to sign the MegaSign agreement") + public Boolean isAllUnsigned() { + return allUnsigned; + } + + public void setAllUnsigned(Boolean allUnsigned) { + this.allUnsigned = allUnsigned; + } + + public ReminderInfo frequency(FrequencyEnum frequency) { + this.frequency = frequency; + return this; + } + + /** + * The frequency at which reminder will be sent until the agreement is completed.<br>If frequency is not provided, the reminder will be sent once (if the agreement is available at the specified time) with the delay based on the firstReminderDelay field and will never repeat again. If the agreement is not available at that time, reminder will not be sent. Cannot be updated in a PUT + * @return frequency + **/ + @ApiModelProperty(value = "The frequency at which reminder will be sent until the agreement is completed.
If frequency is not provided, the reminder will be sent once (if the agreement is available at the specified time) with the delay based on the firstReminderDelay field and will never repeat again. If the agreement is not available at that time, reminder will not be sent. Cannot be updated in a PUT") + public FrequencyEnum getFrequency() { + return frequency; + } + + public void setFrequency(FrequencyEnum frequency) { + this.frequency = frequency; + } + + public ReminderInfo status(StatusEnum status) { + this.status = status; + return this; + } + + /** + * Current status of the reminder. The only valid update in a PUT is from ACTIVE to CANCELED. Must be provided as ACTIVE in a POST. + * @return status + **/ + @ApiModelProperty(value = "Current status of the reminder. The only valid update in a PUT is from ACTIVE to CANCELED. Must be provided as ACTIVE in a POST.") + public StatusEnum getStatus() { + return status; + } + + public void setStatus(StatusEnum status) { + this.status = status; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ReminderInfo reminderInfo = (ReminderInfo) o; + return Objects.equals(this.note, reminderInfo.note) && + Objects.equals(this.lastSentDate, reminderInfo.lastSentDate) && + Objects.equals(this.nextSentDate, reminderInfo.nextSentDate) && + Objects.equals(this.reminderId, reminderInfo.reminderId) && + Objects.equals(this.firstReminderDelay, reminderInfo.firstReminderDelay) && + Objects.equals(this.recipientParticipantIds, reminderInfo.recipientParticipantIds) && + Objects.equals(this.startReminderCounterFrom, reminderInfo.startReminderCounterFrom) && + Objects.equals(this.allUnsigned, reminderInfo.allUnsigned) && + Objects.equals(this.frequency, reminderInfo.frequency) && + Objects.equals(this.status, reminderInfo.status); + } + + @Override + public int hashCode() { + return Objects.hash(note, lastSentDate, nextSentDate, reminderId, firstReminderDelay, recipientParticipantIds, startReminderCounterFrom, allUnsigned, frequency, status); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ReminderInfo {\n"); + + sb.append(" note: ").append(toIndentedString(note)).append("\n"); + sb.append(" lastSentDate: ").append(toIndentedString(lastSentDate)).append("\n"); + sb.append(" nextSentDate: ").append(toIndentedString(nextSentDate)).append("\n"); + sb.append(" reminderId: ").append(toIndentedString(reminderId)).append("\n"); + sb.append(" firstReminderDelay: ").append(toIndentedString(firstReminderDelay)).append("\n"); + sb.append(" recipientParticipantIds: ").append(toIndentedString(recipientParticipantIds)).append("\n"); + sb.append(" startReminderCounterFrom: ").append(toIndentedString(startReminderCounterFrom)).append("\n"); + sb.append(" allUnsigned: ").append(toIndentedString(allUnsigned)).append("\n"); + sb.append(" frequency: ").append(toIndentedString(frequency)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/SenderInfo.java b/src/main/java/io/swagger/client/model/megaSigns/SenderInfo.java new file mode 100644 index 0000000..71da938 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/SenderInfo.java @@ -0,0 +1,345 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.Date; + +/** + * SenderInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class SenderInfo { + @SerializedName("participantId") + private String participantId = null; + + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("hidden") + private Boolean hidden = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("self") + private Boolean self = null; + + @SerializedName("company") + private String company = null; + + @SerializedName("userId") + private String userId = null; + + @SerializedName("email") + private String email = null; + + /** + * The megaSign status with respect to the participant set. + */ + @JsonAdapter(StatusEnum.Adapter.class) + public enum StatusEnum { + CANCELLED("CANCELLED"), + + COMPLETED("COMPLETED"), + + EXPIRED("EXPIRED"), + + NOT_YET_VISIBLE("NOT_YET_VISIBLE"), + + WAITING_FOR_AUTHORING("WAITING_FOR_AUTHORING"), + + WAITING_FOR_MY_DELEGATION("WAITING_FOR_MY_DELEGATION"), + + WAITING_FOR_MY_ACCEPTANCE("WAITING_FOR_MY_ACCEPTANCE"), + + WAITING_FOR_MY_ACKNOWLEDGEMENT("WAITING_FOR_MY_ACKNOWLEDGEMENT"), + + WAITING_FOR_MY_APPROVAL("WAITING_FOR_MY_APPROVAL"), + + WAITING_FOR_MY_FORM_FILLING("WAITING_FOR_MY_FORM_FILLING"), + + WAITING_FOR_MY_SIGNATURE("WAITING_FOR_MY_SIGNATURE"), + + WAITING_FOR_OTHERS("WAITING_FOR_OTHERS"); + + private String value; + + StatusEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static StatusEnum fromValue(String text) { + for (StatusEnum b : StatusEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public StatusEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return StatusEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("status") + private StatusEnum status = null; + + public SenderInfo participantId(String participantId) { + this.participantId = participantId; + return this; + } + + /** + * The unique identifier of the sender of the megaSign. + * @return participantId + **/ + @ApiModelProperty(value = " The unique identifier of the sender of the megaSign.") + public String getParticipantId() { + return participantId; + } + + public void setParticipantId(String participantId) { + this.participantId = participantId; + } + + public SenderInfo createdDate(Date createdDate) { + this.createdDate = createdDate; + return this; + } + + /** + * The date when the sender was added. This will be returned as part of GET call but is ignored if passed as part of PUT call. + * @return createdDate + **/ + @ApiModelProperty(value = "The date when the sender was added. This will be returned as part of GET call but is ignored if passed as part of PUT call.") + public Date getCreatedDate() { + return createdDate; + } + + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } + + public SenderInfo hidden(Boolean hidden) { + this.hidden = hidden; + return this; + } + + /** + * True if the megaSign is hidden for the user that is calling the API. Only returned if self is true. + * @return hidden + **/ + @ApiModelProperty(value = "True if the megaSign is hidden for the user that is calling the API. Only returned if self is true.") + public Boolean isHidden() { + return hidden; + } + + public void setHidden(Boolean hidden) { + this.hidden = hidden; + } + + public SenderInfo name(String name) { + this.name = name; + return this; + } + + /** + * Name of the sender of the megaSign, if available. + * @return name + **/ + @ApiModelProperty(value = "Name of the sender of the megaSign, if available.") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public SenderInfo self(Boolean self) { + this.self = self; + return this; + } + + /** + * True if the sender of the megaSign is the same user that is calling the API. + * @return self + **/ + @ApiModelProperty(value = "True if the sender of the megaSign is the same user that is calling the API.") + public Boolean isSelf() { + return self; + } + + public void setSelf(Boolean self) { + this.self = self; + } + + public SenderInfo company(String company) { + this.company = company; + return this; + } + + /** + * Company of the sender of the megaSign, if available. + * @return company + **/ + @ApiModelProperty(value = "Company of the sender of the megaSign, if available.") + public String getCompany() { + return company; + } + + public void setCompany(String company) { + this.company = company; + } + + public SenderInfo userId(String userId) { + this.userId = userId; + return this; + } + + /** + * The user ID of the sender. This will be returned as part of GET call but is ignored if passed as part of PUT call. + * @return userId + **/ + @ApiModelProperty(value = "The user ID of the sender. This will be returned as part of GET call but is ignored if passed as part of PUT call.") + public String getUserId() { + return userId; + } + + public void setUserId(String userId) { + this.userId = userId; + } + + public SenderInfo email(String email) { + this.email = email; + return this; + } + + /** + * Email of the sender of the megaSign. + * @return email + **/ + @ApiModelProperty(value = "Email of the sender of the megaSign.") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + public SenderInfo status(StatusEnum status) { + this.status = status; + return this; + } + + /** + * The megaSign status with respect to the participant set. + * @return status + **/ + @ApiModelProperty(value = "The megaSign status with respect to the participant set.") + public StatusEnum getStatus() { + return status; + } + + public void setStatus(StatusEnum status) { + this.status = status; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SenderInfo senderInfo = (SenderInfo) o; + return Objects.equals(this.participantId, senderInfo.participantId) && + Objects.equals(this.createdDate, senderInfo.createdDate) && + Objects.equals(this.hidden, senderInfo.hidden) && + Objects.equals(this.name, senderInfo.name) && + Objects.equals(this.self, senderInfo.self) && + Objects.equals(this.company, senderInfo.company) && + Objects.equals(this.userId, senderInfo.userId) && + Objects.equals(this.email, senderInfo.email) && + Objects.equals(this.status, senderInfo.status); + } + + @Override + public int hashCode() { + return Objects.hash(participantId, createdDate, hidden, name, self, company, userId, email, status); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SenderInfo {\n"); + + sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" self: ").append(toIndentedString(self)).append("\n"); + sb.append(" company: ").append(toIndentedString(company)).append("\n"); + sb.append(" userId: ").append(toIndentedString(userId)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/ShareCreationInfo.java b/src/main/java/io/swagger/client/model/megaSigns/ShareCreationInfo.java new file mode 100644 index 0000000..427de7d --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/ShareCreationInfo.java @@ -0,0 +1,116 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * ShareCreationInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class ShareCreationInfo { + @SerializedName("message") + private String message = null; + + @SerializedName("email") + private String email = null; + + public ShareCreationInfo message(String message) { + this.message = message; + return this; + } + + /** + * Optional message to the sharee + * @return message + **/ + @ApiModelProperty(value = "Optional message to the sharee") + public String getMessage() { + return message; + } + + public void setMessage(String message) { + this.message = message; + } + + public ShareCreationInfo email(String email) { + this.email = email; + return this; + } + + /** + * The email address of the member with whom the agreement will be shared + * @return email + **/ + @ApiModelProperty(value = "The email address of the member with whom the agreement will be shared") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ShareCreationInfo shareCreationInfo = (ShareCreationInfo) o; + return Objects.equals(this.message, shareCreationInfo.message) && + Objects.equals(this.email, shareCreationInfo.email); + } + + @Override + public int hashCode() { + return Objects.hash(message, email); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ShareCreationInfo {\n"); + + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/ShareCreationInfoList.java b/src/main/java/io/swagger/client/model/megaSigns/ShareCreationInfoList.java new file mode 100644 index 0000000..b84cd3d --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/ShareCreationInfoList.java @@ -0,0 +1,104 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.megaSigns.ShareCreationInfo; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * ShareCreationInfoList + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class ShareCreationInfoList { + @SerializedName("shareCreationInfo") + private List shareCreationInfo = null; + + public ShareCreationInfoList shareCreationInfo(List shareCreationInfo) { + this.shareCreationInfo = shareCreationInfo; + return this; + } + + public ShareCreationInfoList addShareCreationInfoItem(ShareCreationInfo shareCreationInfoItem) { + if (this.shareCreationInfo == null) { + this.shareCreationInfo = new ArrayList(); + } + this.shareCreationInfo.add(shareCreationInfoItem); + return this; + } + + /** + * List of ShareCreationInfo + * @return shareCreationInfo + **/ + @ApiModelProperty(value = "List of ShareCreationInfo") + public List getShareCreationInfo() { + return shareCreationInfo; + } + + public void setShareCreationInfo(List shareCreationInfo) { + this.shareCreationInfo = shareCreationInfo; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ShareCreationInfoList shareCreationInfoList = (ShareCreationInfoList) o; + return Objects.equals(this.shareCreationInfo, shareCreationInfoList.shareCreationInfo); + } + + @Override + public int hashCode() { + return Objects.hash(shareCreationInfo); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ShareCreationInfoList {\n"); + + sb.append(" shareCreationInfo: ").append(toIndentedString(shareCreationInfo)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/ShareCreationResponse.java b/src/main/java/io/swagger/client/model/megaSigns/ShareCreationResponse.java new file mode 100644 index 0000000..7b57d6e --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/ShareCreationResponse.java @@ -0,0 +1,116 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * ShareCreationResponse + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class ShareCreationResponse { + @SerializedName("participantId") + private String participantId = null; + + @SerializedName("email") + private String email = null; + + public ShareCreationResponse participantId(String participantId) { + this.participantId = participantId; + return this; + } + + /** + * The unique identifier of the participant + * @return participantId + **/ + @ApiModelProperty(value = "The unique identifier of the participant") + public String getParticipantId() { + return participantId; + } + + public void setParticipantId(String participantId) { + this.participantId = participantId; + } + + public ShareCreationResponse email(String email) { + this.email = email; + return this; + } + + /** + * The email address that was requested + * @return email + **/ + @ApiModelProperty(value = "The email address that was requested") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ShareCreationResponse shareCreationResponse = (ShareCreationResponse) o; + return Objects.equals(this.participantId, shareCreationResponse.participantId) && + Objects.equals(this.email, shareCreationResponse.email); + } + + @Override + public int hashCode() { + return Objects.hash(participantId, email); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ShareCreationResponse {\n"); + + sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/ShareCreationResponseList.java b/src/main/java/io/swagger/client/model/megaSigns/ShareCreationResponseList.java new file mode 100644 index 0000000..ba50fac --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/ShareCreationResponseList.java @@ -0,0 +1,104 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.megaSigns.ShareCreationResponse; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * ShareCreationResponseList + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class ShareCreationResponseList { + @SerializedName("shareCreationResponseList") + private List shareCreationResponseList = null; + + public ShareCreationResponseList shareCreationResponseList(List shareCreationResponseList) { + this.shareCreationResponseList = shareCreationResponseList; + return this; + } + + public ShareCreationResponseList addShareCreationResponseListItem(ShareCreationResponse shareCreationResponseListItem) { + if (this.shareCreationResponseList == null) { + this.shareCreationResponseList = new ArrayList(); + } + this.shareCreationResponseList.add(shareCreationResponseListItem); + return this; + } + + /** + * List of ShareCreationResponse + * @return shareCreationResponseList + **/ + @ApiModelProperty(value = "List of ShareCreationResponse") + public List getShareCreationResponseList() { + return shareCreationResponseList; + } + + public void setShareCreationResponseList(List shareCreationResponseList) { + this.shareCreationResponseList = shareCreationResponseList; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ShareCreationResponseList shareCreationResponseList = (ShareCreationResponseList) o; + return Objects.equals(this.shareCreationResponseList, shareCreationResponseList.shareCreationResponseList); + } + + @Override + public int hashCode() { + return Objects.hash(shareCreationResponseList); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ShareCreationResponseList {\n"); + + sb.append(" shareCreationResponseList: ").append(toIndentedString(shareCreationResponseList)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/ShareParticipantInfo.java b/src/main/java/io/swagger/client/model/megaSigns/ShareParticipantInfo.java new file mode 100644 index 0000000..3606307 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/ShareParticipantInfo.java @@ -0,0 +1,231 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * ShareParticipantInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class ShareParticipantInfo { + @SerializedName("participantId") + private String participantId = null; + + @SerializedName("hidden") + private Boolean hidden = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("self") + private Boolean self = null; + + @SerializedName("sharerParticipantId") + private String sharerParticipantId = null; + + @SerializedName("company") + private String company = null; + + @SerializedName("email") + private String email = null; + + public ShareParticipantInfo participantId(String participantId) { + this.participantId = participantId; + return this; + } + + /** + * The unique identifier of the sharee participant of the megaSign. + * @return participantId + **/ + @ApiModelProperty(value = "The unique identifier of the sharee participant of the megaSign.") + public String getParticipantId() { + return participantId; + } + + public void setParticipantId(String participantId) { + this.participantId = participantId; + } + + public ShareParticipantInfo hidden(Boolean hidden) { + this.hidden = hidden; + return this; + } + + /** + * True if the megaSign parent is hidden for the user that is calling the API. Only returned if self is true. + * @return hidden + **/ + @ApiModelProperty(value = "True if the megaSign parent is hidden for the user that is calling the API. Only returned if self is true.") + public Boolean isHidden() { + return hidden; + } + + public void setHidden(Boolean hidden) { + this.hidden = hidden; + } + + public ShareParticipantInfo name(String name) { + this.name = name; + return this; + } + + /** + * Name of the sharee participant of the megaSign, if available. + * @return name + **/ + @ApiModelProperty(value = "Name of the sharee participant of the megaSign, if available.") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public ShareParticipantInfo self(Boolean self) { + this.self = self; + return this; + } + + /** + * True if the Share participant of the megaSign is the same user that is calling the API. + * @return self + **/ + @ApiModelProperty(value = "True if the Share participant of the megaSign is the same user that is calling the API.") + public Boolean isSelf() { + return self; + } + + public void setSelf(Boolean self) { + this.self = self; + } + + public ShareParticipantInfo sharerParticipantId(String sharerParticipantId) { + this.sharerParticipantId = sharerParticipantId; + return this; + } + + /** + * The unique identifier of the participant who shared the megaSign. + * @return sharerParticipantId + **/ + @ApiModelProperty(value = "The unique identifier of the participant who shared the megaSign.") + public String getSharerParticipantId() { + return sharerParticipantId; + } + + public void setSharerParticipantId(String sharerParticipantId) { + this.sharerParticipantId = sharerParticipantId; + } + + public ShareParticipantInfo company(String company) { + this.company = company; + return this; + } + + /** + * Company of the sharee participant of the megaSign, if available. + * @return company + **/ + @ApiModelProperty(value = "Company of the sharee participant of the megaSign, if available.") + public String getCompany() { + return company; + } + + public void setCompany(String company) { + this.company = company; + } + + public ShareParticipantInfo email(String email) { + this.email = email; + return this; + } + + /** + * Email of the sharee participant of the megaSign. + * @return email + **/ + @ApiModelProperty(value = "Email of the sharee participant of the megaSign.") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ShareParticipantInfo shareParticipantInfo = (ShareParticipantInfo) o; + return Objects.equals(this.participantId, shareParticipantInfo.participantId) && + Objects.equals(this.hidden, shareParticipantInfo.hidden) && + Objects.equals(this.name, shareParticipantInfo.name) && + Objects.equals(this.self, shareParticipantInfo.self) && + Objects.equals(this.sharerParticipantId, shareParticipantInfo.sharerParticipantId) && + Objects.equals(this.company, shareParticipantInfo.company) && + Objects.equals(this.email, shareParticipantInfo.email); + } + + @Override + public int hashCode() { + return Objects.hash(participantId, hidden, name, self, sharerParticipantId, company, email); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ShareParticipantInfo {\n"); + + sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); + sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" self: ").append(toIndentedString(self)).append("\n"); + sb.append(" sharerParticipantId: ").append(toIndentedString(sharerParticipantId)).append("\n"); + sb.append(" company: ").append(toIndentedString(company)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/megaSigns/URLFileInfo.java b/src/main/java/io/swagger/client/model/megaSigns/URLFileInfo.java index 021bf60..4199ef1 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/URLFileInfo.java +++ b/src/main/java/io/swagger/client/model/megaSigns/URLFileInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,35 +26,17 @@ /** * URLFileInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class URLFileInfo { - @SerializedName("mimeType") - private String mimeType = null; - @SerializedName("name") private String name = null; + @SerializedName("mimeType") + private String mimeType = null; + @SerializedName("url") private String url = null; - public URLFileInfo mimeType(String mimeType) { - this.mimeType = mimeType; - return this; - } - - /** - * The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed - * @return mimeType - **/ - @ApiModelProperty(value = "The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed") - public String getMimeType() { - return mimeType; - } - - public void setMimeType(String mimeType) { - this.mimeType = mimeType; - } - public URLFileInfo name(String name) { this.name = name; return this; @@ -88,6 +55,24 @@ public void setName(String name) { this.name = name; } + public URLFileInfo mimeType(String mimeType) { + this.mimeType = mimeType; + return this; + } + + /** + * The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed + * @return mimeType + **/ + @ApiModelProperty(value = "The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed") + public String getMimeType() { + return mimeType; + } + + public void setMimeType(String mimeType) { + this.mimeType = mimeType; + } + public URLFileInfo url(String url) { this.url = url; return this; @@ -116,14 +101,14 @@ public boolean equals(java.lang.Object o) { return false; } URLFileInfo urLFileInfo = (URLFileInfo) o; - return Objects.equals(this.mimeType, urLFileInfo.mimeType) && - Objects.equals(this.name, urLFileInfo.name) && + return Objects.equals(this.name, urLFileInfo.name) && + Objects.equals(this.mimeType, urLFileInfo.mimeType) && Objects.equals(this.url, urLFileInfo.url); } @Override public int hashCode() { - return Objects.hash(mimeType, name, url); + return Objects.hash(name, mimeType, url); } @@ -132,8 +117,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class URLFileInfo {\n"); - sb.append(" mimeType: ").append(toIndentedString(mimeType)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" mimeType: ").append(toIndentedString(mimeType)).append("\n"); sb.append(" url: ").append(toIndentedString(url)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/megaSigns/VaultingInfo.java b/src/main/java/io/swagger/client/model/megaSigns/VaultingInfo.java index c145f2e..59d84f9 100755 --- a/src/main/java/io/swagger/client/model/megaSigns/VaultingInfo.java +++ b/src/main/java/io/swagger/client/model/megaSigns/VaultingInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * VaultingInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:16.276+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") public class VaultingInfo { @SerializedName("enabled") private Boolean enabled = null; diff --git a/src/main/java/io/swagger/client/model/megaSigns/VisibilityInfo.java b/src/main/java/io/swagger/client/model/megaSigns/VisibilityInfo.java new file mode 100644 index 0000000..e633233 --- /dev/null +++ b/src/main/java/io/swagger/client/model/megaSigns/VisibilityInfo.java @@ -0,0 +1,140 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.megaSigns; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * VisibilityInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:44.788+11:00") +public class VisibilityInfo { + /** + * Specifies the visibility. The possible values are HIDE or SHOW + */ + @JsonAdapter(VisibilityEnum.Adapter.class) + public enum VisibilityEnum { + SHOW("SHOW"), + + HIDE("HIDE"); + + private String value; + + VisibilityEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static VisibilityEnum fromValue(String text) { + for (VisibilityEnum b : VisibilityEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final VisibilityEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public VisibilityEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return VisibilityEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("visibility") + private VisibilityEnum visibility = null; + + public VisibilityInfo visibility(VisibilityEnum visibility) { + this.visibility = visibility; + return this; + } + + /** + * Specifies the visibility. The possible values are HIDE or SHOW + * @return visibility + **/ + @ApiModelProperty(value = "Specifies the visibility. The possible values are HIDE or SHOW") + public VisibilityEnum getVisibility() { + return visibility; + } + + public void setVisibility(VisibilityEnum visibility) { + this.visibility = visibility; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + VisibilityInfo visibilityInfo = (VisibilityInfo) o; + return Objects.equals(this.visibility, visibilityInfo.visibility); + } + + @Override + public int hashCode() { + return Objects.hash(visibility); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class VisibilityInfo {\n"); + + sb.append(" visibility: ").append(toIndentedString(visibility)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/messageTemplates/MessageTemplate.java b/src/main/java/io/swagger/client/model/messageTemplates/MessageTemplate.java new file mode 100644 index 0000000..aec0b17 --- /dev/null +++ b/src/main/java/io/swagger/client/model/messageTemplates/MessageTemplate.java @@ -0,0 +1,163 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.messageTemplates; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Message template item + */ +@ApiModel(description = "Message template item") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:47.992+11:00") +public class MessageTemplate { + @SerializedName("name") + private String name = null; + + @SerializedName("messageTemplateId") + private String messageTemplateId = null; + + @SerializedName("text") + private String text = null; + + @SerializedName("locale") + private String locale = null; + + public MessageTemplate name(String name) { + this.name = name; + return this; + } + + /** + * Message template name + * @return name + **/ + @ApiModelProperty(value = "Message template name") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public MessageTemplate messageTemplateId(String messageTemplateId) { + this.messageTemplateId = messageTemplateId; + return this; + } + + /** + * Unique identifier of the message template + * @return messageTemplateId + **/ + @ApiModelProperty(value = "Unique identifier of the message template") + public String getMessageTemplateId() { + return messageTemplateId; + } + + public void setMessageTemplateId(String messageTemplateId) { + this.messageTemplateId = messageTemplateId; + } + + public MessageTemplate text(String text) { + this.text = text; + return this; + } + + /** + * Message template text + * @return text + **/ + @ApiModelProperty(value = "Message template text") + public String getText() { + return text; + } + + public void setText(String text) { + this.text = text; + } + + public MessageTemplate locale(String locale) { + this.locale = locale; + return this; + } + + /** + * Message template locale + * @return locale + **/ + @ApiModelProperty(value = "Message template locale") + public String getLocale() { + return locale; + } + + public void setLocale(String locale) { + this.locale = locale; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + MessageTemplate messageTemplate = (MessageTemplate) o; + return Objects.equals(this.name, messageTemplate.name) && + Objects.equals(this.messageTemplateId, messageTemplate.messageTemplateId) && + Objects.equals(this.text, messageTemplate.text) && + Objects.equals(this.locale, messageTemplate.locale); + } + + @Override + public int hashCode() { + return Objects.hash(name, messageTemplateId, text, locale); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class MessageTemplate {\n"); + + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" messageTemplateId: ").append(toIndentedString(messageTemplateId)).append("\n"); + sb.append(" text: ").append(toIndentedString(text)).append("\n"); + sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/messageTemplates/MessageTemplates.java b/src/main/java/io/swagger/client/model/messageTemplates/MessageTemplates.java new file mode 100644 index 0000000..a47ecbd --- /dev/null +++ b/src/main/java/io/swagger/client/model/messageTemplates/MessageTemplates.java @@ -0,0 +1,129 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.messageTemplates; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.messageTemplates.MessageTemplate; +import io.swagger.client.model.messageTemplates.PageInfo; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * List of message templates + */ +@ApiModel(description = "List of message templates") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:47.992+11:00") +public class MessageTemplates { + @SerializedName("messageTemplateList") + private List messageTemplateList = null; + + @SerializedName("page") + private PageInfo page = null; + + public MessageTemplates messageTemplateList(List messageTemplateList) { + this.messageTemplateList = messageTemplateList; + return this; + } + + public MessageTemplates addMessageTemplateListItem(MessageTemplate messageTemplateListItem) { + if (this.messageTemplateList == null) { + this.messageTemplateList = new ArrayList(); + } + this.messageTemplateList.add(messageTemplateListItem); + return this; + } + + /** + * An array of message template items + * @return messageTemplateList + **/ + @ApiModelProperty(value = "An array of message template items") + public List getMessageTemplateList() { + return messageTemplateList; + } + + public void setMessageTemplateList(List messageTemplateList) { + this.messageTemplateList = messageTemplateList; + } + + public MessageTemplates page(PageInfo page) { + this.page = page; + return this; + } + + /** + * Pagination information for navigating through the response + * @return page + **/ + @ApiModelProperty(value = "Pagination information for navigating through the response") + public PageInfo getPage() { + return page; + } + + public void setPage(PageInfo page) { + this.page = page; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + MessageTemplates messageTemplates = (MessageTemplates) o; + return Objects.equals(this.messageTemplateList, messageTemplates.messageTemplateList) && + Objects.equals(this.page, messageTemplates.page); + } + + @Override + public int hashCode() { + return Objects.hash(messageTemplateList, page); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class MessageTemplates {\n"); + + sb.append(" messageTemplateList: ").append(toIndentedString(messageTemplateList)).append("\n"); + sb.append(" page: ").append(toIndentedString(page)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/messageTemplates/PageInfo.java b/src/main/java/io/swagger/client/model/messageTemplates/PageInfo.java new file mode 100644 index 0000000..a5c96ed --- /dev/null +++ b/src/main/java/io/swagger/client/model/messageTemplates/PageInfo.java @@ -0,0 +1,93 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.messageTemplates; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * PageInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:47.992+11:00") +public class PageInfo { + @SerializedName("nextCursor") + private String nextCursor = null; + + public PageInfo nextCursor(String nextCursor) { + this.nextCursor = nextCursor; + return this; + } + + /** + * Used to navigate to the next page. If not returned, there are no further pages. + * @return nextCursor + **/ + @ApiModelProperty(value = "Used to navigate to the next page. If not returned, there are no further pages.") + public String getNextCursor() { + return nextCursor; + } + + public void setNextCursor(String nextCursor) { + this.nextCursor = nextCursor; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PageInfo pageInfo = (PageInfo) o; + return Objects.equals(this.nextCursor, pageInfo.nextCursor); + } + + @Override + public int hashCode() { + return Objects.hash(nextCursor); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PageInfo {\n"); + + sb.append(" nextCursor: ").append(toIndentedString(nextCursor)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/transientDocuments/TransientDocumentResponse.java b/src/main/java/io/swagger/client/model/transientDocuments/TransientDocumentResponse.java index 03fff07..b2f4345 100755 --- a/src/main/java/io/swagger/client/model/transientDocuments/TransientDocumentResponse.java +++ b/src/main/java/io/swagger/client/model/transientDocuments/TransientDocumentResponse.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * TransientDocumentResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:22.560+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:49.528+11:00") public class TransientDocumentResponse { @SerializedName("transientDocumentId") private String transientDocumentId = null; @@ -52,10 +37,10 @@ public TransientDocumentResponse transientDocumentId(String transientDocumentId) } /** - * The unique identifier of the uploaded document that can be used in an agreement or a megaSign or widget creation call + * The unique identifier of the uploaded document that can be used in an agreement or a megaSign or web form creation call * @return transientDocumentId **/ - @ApiModelProperty(value = "The unique identifier of the uploaded document that can be used in an agreement or a megaSign or widget creation call") + @ApiModelProperty(value = "The unique identifier of the uploaded document that can be used in an agreement or a megaSign or web form creation call") public String getTransientDocumentId() { return transientDocumentId; } diff --git a/src/main/java/io/swagger/client/model/users/BooleanSettingInfo.java b/src/main/java/io/swagger/client/model/users/BooleanSettingInfo.java new file mode 100644 index 0000000..6a82598 --- /dev/null +++ b/src/main/java/io/swagger/client/model/users/BooleanSettingInfo.java @@ -0,0 +1,116 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.users; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * BooleanSettingInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:51.296+11:00") +public class BooleanSettingInfo { + @SerializedName("inherited") + private Boolean inherited = null; + + @SerializedName("value") + private Boolean value = null; + + public BooleanSettingInfo inherited(Boolean inherited) { + this.inherited = inherited; + return this; + } + + /** + * True if setting is inherited from its group or account value. + * @return inherited + **/ + @ApiModelProperty(value = "True if setting is inherited from its group or account value.") + public Boolean isInherited() { + return inherited; + } + + public void setInherited(Boolean inherited) { + this.inherited = inherited; + } + + public BooleanSettingInfo value(Boolean value) { + this.value = value; + return this; + } + + /** + * Value of the setting. + * @return value + **/ + @ApiModelProperty(value = "Value of the setting.") + public Boolean isValue() { + return value; + } + + public void setValue(Boolean value) { + this.value = value; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + BooleanSettingInfo booleanSettingInfo = (BooleanSettingInfo) o; + return Objects.equals(this.inherited, booleanSettingInfo.inherited) && + Objects.equals(this.value, booleanSettingInfo.value); + } + + @Override + public int hashCode() { + return Objects.hash(inherited, value); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class BooleanSettingInfo {\n"); + + sb.append(" inherited: ").append(toIndentedString(inherited)).append("\n"); + sb.append(" value: ").append(toIndentedString(value)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/users/CommonViewConfiguration.java b/src/main/java/io/swagger/client/model/users/CommonViewConfiguration.java index 62a959f..4943a90 100755 --- a/src/main/java/io/swagger/client/model/users/CommonViewConfiguration.java +++ b/src/main/java/io/swagger/client/model/users/CommonViewConfiguration.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * CommonViewConfiguration */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:31.257+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:51.296+11:00") public class CommonViewConfiguration { @SerializedName("autoLoginUser") private Boolean autoLoginUser = null; diff --git a/src/main/java/io/swagger/client/model/users/DetailedUserInfo.java b/src/main/java/io/swagger/client/model/users/DetailedUserInfo.java index fd01c03..abce47c 100755 --- a/src/main/java/io/swagger/client/model/users/DetailedUserInfo.java +++ b/src/main/java/io/swagger/client/model/users/DetailedUserInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -37,14 +22,21 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; +import java.util.Date; /** * DetailedUserInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:31.257+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:51.296+11:00") public class DetailedUserInfo { + @SerializedName("lastName") + private String lastName = null; + + @SerializedName("initials") + private String initials = null; + /** - * Type of account to which the user belongs (null if no account) + * Type of account to which the user belongs (null if no account). If provided in POST or PUT it will be ignored. */ @JsonAdapter(AccountTypeEnum.Adapter.class) public enum AccountTypeEnum { @@ -105,35 +97,41 @@ public AccountTypeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("accountType") private AccountTypeEnum accountType = null; - @SerializedName("company") - private String company = null; + @SerializedName("locale") + private String locale = null; - @SerializedName("email") - private String email = null; + @SerializedName("title") + private String title = null; + + @SerializedName("accountId") + private String accountId = null; @SerializedName("firstName") private String firstName = null; - @SerializedName("id") - private String id = null; - - @SerializedName("initials") - private String initials = null; - @SerializedName("isAccountAdmin") private Boolean isAccountAdmin = null; - @SerializedName("lastName") - private String lastName = null; - - @SerializedName("locale") - private String locale = null; + @SerializedName("createdDate") + private Date createdDate = null; @SerializedName("phone") private String phone = null; + @SerializedName("primaryGroupId") + private String primaryGroupId = null; + + @SerializedName("company") + private String company = null; + + @SerializedName("id") + private String id = null; + + @SerializedName("email") + private String email = null; + /** - * Status of the user + * Status of the user. If provided in POST it will be ignored. */ @JsonAdapter(StatusEnum.Adapter.class) public enum StatusEnum { @@ -186,8 +184,41 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; - @SerializedName("title") - private String title = null; + public DetailedUserInfo lastName(String lastName) { + this.lastName = lastName; + return this; + } + + /** + * The last name of the user + * @return lastName + **/ + @ApiModelProperty(value = "The last name of the user") + public String getLastName() { + return lastName; + } + + public void setLastName(String lastName) { + this.lastName = lastName; + } + + public DetailedUserInfo initials(String initials) { + this.initials = initials; + return this; + } + + /** + * The initials of the user + * @return initials + **/ + @ApiModelProperty(value = "The initials of the user") + public String getInitials() { + return initials; + } + + public void setInitials(String initials) { + this.initials = initials; + } public DetailedUserInfo accountType(AccountTypeEnum accountType) { this.accountType = accountType; @@ -195,10 +226,10 @@ public DetailedUserInfo accountType(AccountTypeEnum accountType) { } /** - * Type of account to which the user belongs (null if no account) + * Type of account to which the user belongs (null if no account). If provided in POST or PUT it will be ignored. * @return accountType **/ - @ApiModelProperty(value = "Type of account to which the user belongs (null if no account)") + @ApiModelProperty(value = "Type of account to which the user belongs (null if no account). If provided in POST or PUT it will be ignored.") public AccountTypeEnum getAccountType() { return accountType; } @@ -207,40 +238,58 @@ public void setAccountType(AccountTypeEnum accountType) { this.accountType = accountType; } - public DetailedUserInfo company(String company) { - this.company = company; + public DetailedUserInfo locale(String locale) { + this.locale = locale; return this; } /** - * The name of company of the user - * @return company + * The UI locale of the user + * @return locale **/ - @ApiModelProperty(value = "The name of company of the user") - public String getCompany() { - return company; + @ApiModelProperty(value = "The UI locale of the user") + public String getLocale() { + return locale; } - public void setCompany(String company) { - this.company = company; + public void setLocale(String locale) { + this.locale = locale; } - public DetailedUserInfo email(String email) { - this.email = email; + public DetailedUserInfo title(String title) { + this.title = title; return this; } /** - * The email address of the user - * @return email + * The job title of the user + * @return title **/ - @ApiModelProperty(value = "The email address of the user") - public String getEmail() { - return email; + @ApiModelProperty(value = "The job title of the user") + public String getTitle() { + return title; } - public void setEmail(String email) { - this.email = email; + public void setTitle(String title) { + this.title = title; + } + + public DetailedUserInfo accountId(String accountId) { + this.accountId = accountId; + return this; + } + + /** + * The account id of the user + * @return accountId + **/ + @ApiModelProperty(value = "The account id of the user") + public String getAccountId() { + return accountId; + } + + public void setAccountId(String accountId) { + this.accountId = accountId; } public DetailedUserInfo firstName(String firstName) { @@ -261,148 +310,148 @@ public void setFirstName(String firstName) { this.firstName = firstName; } - public DetailedUserInfo id(String id) { - this.id = id; + public DetailedUserInfo isAccountAdmin(Boolean isAccountAdmin) { + this.isAccountAdmin = isAccountAdmin; return this; } /** - * A unique identifier of the user resource for REST APIs as issued by Sign. - * @return id + * True if the user is account admin + * @return isAccountAdmin **/ - @ApiModelProperty(value = "A unique identifier of the user resource for REST APIs as issued by Sign.") - public String getId() { - return id; + @ApiModelProperty(value = "True if the user is account admin") + public Boolean isIsAccountAdmin() { + return isAccountAdmin; } - public void setId(String id) { - this.id = id; + public void setIsAccountAdmin(Boolean isAccountAdmin) { + this.isAccountAdmin = isAccountAdmin; } - public DetailedUserInfo initials(String initials) { - this.initials = initials; + public DetailedUserInfo createdDate(Date createdDate) { + this.createdDate = createdDate; return this; } /** - * The initials of the user - * @return initials + * The date the user was created. If provided in POST or PUT it will be ignored + * @return createdDate **/ - @ApiModelProperty(value = "The initials of the user") - public String getInitials() { - return initials; + @ApiModelProperty(value = "The date the user was created. If provided in POST or PUT it will be ignored") + public Date getCreatedDate() { + return createdDate; } - public void setInitials(String initials) { - this.initials = initials; + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; } - public DetailedUserInfo isAccountAdmin(Boolean isAccountAdmin) { - this.isAccountAdmin = isAccountAdmin; + public DetailedUserInfo phone(String phone) { + this.phone = phone; return this; } /** - * True if the user is account admin - * @return isAccountAdmin + * The phone number of the user + * @return phone **/ - @ApiModelProperty(value = "True if the user is account admin") - public Boolean isIsAccountAdmin() { - return isAccountAdmin; + @ApiModelProperty(value = "The phone number of the user") + public String getPhone() { + return phone; } - public void setIsAccountAdmin(Boolean isAccountAdmin) { - this.isAccountAdmin = isAccountAdmin; + public void setPhone(String phone) { + this.phone = phone; } - public DetailedUserInfo lastName(String lastName) { - this.lastName = lastName; + public DetailedUserInfo primaryGroupId(String primaryGroupId) { + this.primaryGroupId = primaryGroupId; return this; } /** - * The last name of the user - * @return lastName + * Primary group in which the new user should be added. Default is the default group for the account the user is being added to. This will be ignored as part of PUT calls + * @return primaryGroupId **/ - @ApiModelProperty(value = "The last name of the user") - public String getLastName() { - return lastName; + @ApiModelProperty(value = "Primary group in which the new user should be added. Default is the default group for the account the user is being added to. This will be ignored as part of PUT calls") + public String getPrimaryGroupId() { + return primaryGroupId; } - public void setLastName(String lastName) { - this.lastName = lastName; + public void setPrimaryGroupId(String primaryGroupId) { + this.primaryGroupId = primaryGroupId; } - public DetailedUserInfo locale(String locale) { - this.locale = locale; + public DetailedUserInfo company(String company) { + this.company = company; return this; } /** - * The UI locale of the user - * @return locale + * The name of company of the user + * @return company **/ - @ApiModelProperty(value = "The UI locale of the user") - public String getLocale() { - return locale; + @ApiModelProperty(value = "The name of company of the user") + public String getCompany() { + return company; } - public void setLocale(String locale) { - this.locale = locale; + public void setCompany(String company) { + this.company = company; } - public DetailedUserInfo phone(String phone) { - this.phone = phone; + public DetailedUserInfo id(String id) { + this.id = id; return this; } /** - * The phone number of the user - * @return phone + * A unique identifier of the user resource for REST APIs as issued by Sign. + * @return id **/ - @ApiModelProperty(value = "The phone number of the user") - public String getPhone() { - return phone; + @ApiModelProperty(value = "A unique identifier of the user resource for REST APIs as issued by Sign.") + public String getId() { + return id; } - public void setPhone(String phone) { - this.phone = phone; + public void setId(String id) { + this.id = id; } - public DetailedUserInfo status(StatusEnum status) { - this.status = status; + public DetailedUserInfo email(String email) { + this.email = email; return this; } /** - * Status of the user - * @return status + * The email address of the user + * @return email **/ - @ApiModelProperty(value = "Status of the user") - public StatusEnum getStatus() { - return status; + @ApiModelProperty(value = "The email address of the user") + public String getEmail() { + return email; } - public void setStatus(StatusEnum status) { - this.status = status; + public void setEmail(String email) { + this.email = email; } - public DetailedUserInfo title(String title) { - this.title = title; + public DetailedUserInfo status(StatusEnum status) { + this.status = status; return this; } /** - * The job title of the user - * @return title + * Status of the user. If provided in POST it will be ignored. + * @return status **/ - @ApiModelProperty(value = "The job title of the user") - public String getTitle() { - return title; + @ApiModelProperty(value = "Status of the user. If provided in POST it will be ignored.") + public StatusEnum getStatus() { + return status; } - public void setTitle(String title) { - this.title = title; + public void setStatus(StatusEnum status) { + this.status = status; } @@ -415,23 +464,26 @@ public boolean equals(java.lang.Object o) { return false; } DetailedUserInfo detailedUserInfo = (DetailedUserInfo) o; - return Objects.equals(this.accountType, detailedUserInfo.accountType) && - Objects.equals(this.company, detailedUserInfo.company) && - Objects.equals(this.email, detailedUserInfo.email) && - Objects.equals(this.firstName, detailedUserInfo.firstName) && - Objects.equals(this.id, detailedUserInfo.id) && + return Objects.equals(this.lastName, detailedUserInfo.lastName) && Objects.equals(this.initials, detailedUserInfo.initials) && - Objects.equals(this.isAccountAdmin, detailedUserInfo.isAccountAdmin) && - Objects.equals(this.lastName, detailedUserInfo.lastName) && + Objects.equals(this.accountType, detailedUserInfo.accountType) && Objects.equals(this.locale, detailedUserInfo.locale) && + Objects.equals(this.title, detailedUserInfo.title) && + Objects.equals(this.accountId, detailedUserInfo.accountId) && + Objects.equals(this.firstName, detailedUserInfo.firstName) && + Objects.equals(this.isAccountAdmin, detailedUserInfo.isAccountAdmin) && + Objects.equals(this.createdDate, detailedUserInfo.createdDate) && Objects.equals(this.phone, detailedUserInfo.phone) && - Objects.equals(this.status, detailedUserInfo.status) && - Objects.equals(this.title, detailedUserInfo.title); + Objects.equals(this.primaryGroupId, detailedUserInfo.primaryGroupId) && + Objects.equals(this.company, detailedUserInfo.company) && + Objects.equals(this.id, detailedUserInfo.id) && + Objects.equals(this.email, detailedUserInfo.email) && + Objects.equals(this.status, detailedUserInfo.status); } @Override public int hashCode() { - return Objects.hash(accountType, company, email, firstName, id, initials, isAccountAdmin, lastName, locale, phone, status, title); + return Objects.hash(lastName, initials, accountType, locale, title, accountId, firstName, isAccountAdmin, createdDate, phone, primaryGroupId, company, id, email, status); } @@ -440,18 +492,21 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DetailedUserInfo {\n"); + sb.append(" lastName: ").append(toIndentedString(lastName)).append("\n"); + sb.append(" initials: ").append(toIndentedString(initials)).append("\n"); sb.append(" accountType: ").append(toIndentedString(accountType)).append("\n"); - sb.append(" company: ").append(toIndentedString(company)).append("\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); + sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n"); sb.append(" firstName: ").append(toIndentedString(firstName)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" initials: ").append(toIndentedString(initials)).append("\n"); sb.append(" isAccountAdmin: ").append(toIndentedString(isAccountAdmin)).append("\n"); - sb.append(" lastName: ").append(toIndentedString(lastName)).append("\n"); - sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); sb.append(" phone: ").append(toIndentedString(phone)).append("\n"); + sb.append(" primaryGroupId: ").append(toIndentedString(primaryGroupId)).append("\n"); + sb.append(" company: ").append(toIndentedString(company)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/users/PageInfo.java b/src/main/java/io/swagger/client/model/users/PageInfo.java index 5395625..0cd9531 100755 --- a/src/main/java/io/swagger/client/model/users/PageInfo.java +++ b/src/main/java/io/swagger/client/model/users/PageInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * PageInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:31.257+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:51.296+11:00") public class PageInfo { @SerializedName("nextCursor") private String nextCursor = null; diff --git a/src/main/java/io/swagger/client/model/users/SettingsInfo.java b/src/main/java/io/swagger/client/model/users/SettingsInfo.java new file mode 100644 index 0000000..3926b2d --- /dev/null +++ b/src/main/java/io/swagger/client/model/users/SettingsInfo.java @@ -0,0 +1,117 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.users; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.users.BooleanSettingInfo; +import java.io.IOException; + +/** + * SettingsInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:51.296+11:00") +public class SettingsInfo { + @SerializedName("libaryDocumentCreationVisible") + private BooleanSettingInfo libaryDocumentCreationVisible = null; + + @SerializedName("userCanSend") + private BooleanSettingInfo userCanSend = null; + + public SettingsInfo libaryDocumentCreationVisible(BooleanSettingInfo libaryDocumentCreationVisible) { + this.libaryDocumentCreationVisible = libaryDocumentCreationVisible; + return this; + } + + /** + * Can user create library documents? + * @return libaryDocumentCreationVisible + **/ + @ApiModelProperty(value = "Can user create library documents?") + public BooleanSettingInfo getLibaryDocumentCreationVisible() { + return libaryDocumentCreationVisible; + } + + public void setLibaryDocumentCreationVisible(BooleanSettingInfo libaryDocumentCreationVisible) { + this.libaryDocumentCreationVisible = libaryDocumentCreationVisible; + } + + public SettingsInfo userCanSend(BooleanSettingInfo userCanSend) { + this.userCanSend = userCanSend; + return this; + } + + /** + * Can user send agreements for signature to others? + * @return userCanSend + **/ + @ApiModelProperty(value = "Can user send agreements for signature to others?") + public BooleanSettingInfo getUserCanSend() { + return userCanSend; + } + + public void setUserCanSend(BooleanSettingInfo userCanSend) { + this.userCanSend = userCanSend; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SettingsInfo settingsInfo = (SettingsInfo) o; + return Objects.equals(this.libaryDocumentCreationVisible, settingsInfo.libaryDocumentCreationVisible) && + Objects.equals(this.userCanSend, settingsInfo.userCanSend); + } + + @Override + public int hashCode() { + return Objects.hash(libaryDocumentCreationVisible, userCanSend); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SettingsInfo {\n"); + + sb.append(" libaryDocumentCreationVisible: ").append(toIndentedString(libaryDocumentCreationVisible)).append("\n"); + sb.append(" userCanSend: ").append(toIndentedString(userCanSend)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/users/UserGroupInfo.java b/src/main/java/io/swagger/client/model/users/UserGroupInfo.java index d40556e..75da307 100755 --- a/src/main/java/io/swagger/client/model/users/UserGroupInfo.java +++ b/src/main/java/io/swagger/client/model/users/UserGroupInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -36,38 +21,117 @@ import com.google.gson.stream.JsonWriter; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.users.SettingsInfo; import java.io.IOException; +import java.util.Date; /** * UserGroupInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:31.257+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:51.296+11:00") public class UserGroupInfo { - @SerializedName("id") - private String id = null; + @SerializedName("settings") + private SettingsInfo settings = null; + + @SerializedName("createdDate") + private Date createdDate = null; @SerializedName("isGroupAdmin") private Boolean isGroupAdmin = null; + @SerializedName("isPrimaryGroup") + private Boolean isPrimaryGroup = null; + @SerializedName("name") private String name = null; - public UserGroupInfo id(String id) { - this.id = id; + @SerializedName("id") + private String id = null; + + /** + * Status of the group membership + */ + @JsonAdapter(StatusEnum.Adapter.class) + public enum StatusEnum { + ACTIVE("ACTIVE"), + + DELETED("DELETED"); + + private String value; + + StatusEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static StatusEnum fromValue(String text) { + for (StatusEnum b : StatusEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public StatusEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return StatusEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("status") + private StatusEnum status = null; + + public UserGroupInfo settings(SettingsInfo settings) { + this.settings = settings; return this; } /** - * Unique identifier of the group - * @return id + * List of some group membership settings. + * @return settings **/ - @ApiModelProperty(value = "Unique identifier of the group") - public String getId() { - return id; + @ApiModelProperty(value = "List of some group membership settings.") + public SettingsInfo getSettings() { + return settings; } - public void setId(String id) { - this.id = id; + public void setSettings(SettingsInfo settings) { + this.settings = settings; + } + + public UserGroupInfo createdDate(Date createdDate) { + this.createdDate = createdDate; + return this; + } + + /** + * Date group was created + * @return createdDate + **/ + @ApiModelProperty(value = "Date group was created") + public Date getCreatedDate() { + return createdDate; + } + + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; } public UserGroupInfo isGroupAdmin(Boolean isGroupAdmin) { @@ -88,6 +152,24 @@ public void setIsGroupAdmin(Boolean isGroupAdmin) { this.isGroupAdmin = isGroupAdmin; } + public UserGroupInfo isPrimaryGroup(Boolean isPrimaryGroup) { + this.isPrimaryGroup = isPrimaryGroup; + return this; + } + + /** + * True if the group is the user's primary group. + * @return isPrimaryGroup + **/ + @ApiModelProperty(value = "True if the group is the user's primary group.") + public Boolean isIsPrimaryGroup() { + return isPrimaryGroup; + } + + public void setIsPrimaryGroup(Boolean isPrimaryGroup) { + this.isPrimaryGroup = isPrimaryGroup; + } + public UserGroupInfo name(String name) { this.name = name; return this; @@ -106,6 +188,42 @@ public void setName(String name) { this.name = name; } + public UserGroupInfo id(String id) { + this.id = id; + return this; + } + + /** + * Unique identifier of the group + * @return id + **/ + @ApiModelProperty(value = "Unique identifier of the group") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public UserGroupInfo status(StatusEnum status) { + this.status = status; + return this; + } + + /** + * Status of the group membership + * @return status + **/ + @ApiModelProperty(value = "Status of the group membership") + public StatusEnum getStatus() { + return status; + } + + public void setStatus(StatusEnum status) { + this.status = status; + } + @Override public boolean equals(java.lang.Object o) { @@ -116,14 +234,18 @@ public boolean equals(java.lang.Object o) { return false; } UserGroupInfo userGroupInfo = (UserGroupInfo) o; - return Objects.equals(this.id, userGroupInfo.id) && + return Objects.equals(this.settings, userGroupInfo.settings) && + Objects.equals(this.createdDate, userGroupInfo.createdDate) && Objects.equals(this.isGroupAdmin, userGroupInfo.isGroupAdmin) && - Objects.equals(this.name, userGroupInfo.name); + Objects.equals(this.isPrimaryGroup, userGroupInfo.isPrimaryGroup) && + Objects.equals(this.name, userGroupInfo.name) && + Objects.equals(this.id, userGroupInfo.id) && + Objects.equals(this.status, userGroupInfo.status); } @Override public int hashCode() { - return Objects.hash(id, isGroupAdmin, name); + return Objects.hash(settings, createdDate, isGroupAdmin, isPrimaryGroup, name, id, status); } @@ -132,9 +254,13 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class UserGroupInfo {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" settings: ").append(toIndentedString(settings)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); sb.append(" isGroupAdmin: ").append(toIndentedString(isGroupAdmin)).append("\n"); + sb.append(" isPrimaryGroup: ").append(toIndentedString(isPrimaryGroup)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/users/UserGroupsInfo.java b/src/main/java/io/swagger/client/model/users/UserGroupsInfo.java index dbb2061..26a5688 100755 --- a/src/main/java/io/swagger/client/model/users/UserGroupsInfo.java +++ b/src/main/java/io/swagger/client/model/users/UserGroupsInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * UserGroupsInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:31.257+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:51.296+11:00") public class UserGroupsInfo { @SerializedName("groupInfoList") private List groupInfoList = null; diff --git a/src/main/java/io/swagger/client/model/users/UserInfo.java b/src/main/java/io/swagger/client/model/users/UserInfo.java index b6704cd..b56eea4 100755 --- a/src/main/java/io/swagger/client/model/users/UserInfo.java +++ b/src/main/java/io/swagger/client/model/users/UserInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,60 +26,45 @@ /** * UserInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:31.257+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:51.296+11:00") public class UserInfo { - @SerializedName("company") - private String company = null; - - @SerializedName("email") - private String email = null; + @SerializedName("accountId") + private String accountId = null; @SerializedName("firstName") private String firstName = null; - @SerializedName("id") - private String id = null; + @SerializedName("lastName") + private String lastName = null; @SerializedName("isAccountAdmin") private Boolean isAccountAdmin = null; - @SerializedName("lastName") - private String lastName = null; - - public UserInfo company(String company) { - this.company = company; - return this; - } + @SerializedName("company") + private String company = null; - /** - * The name of company of the user - * @return company - **/ - @ApiModelProperty(value = "The name of company of the user") - public String getCompany() { - return company; - } + @SerializedName("id") + private String id = null; - public void setCompany(String company) { - this.company = company; - } + @SerializedName("email") + private String email = null; - public UserInfo email(String email) { - this.email = email; + public UserInfo accountId(String accountId) { + this.accountId = accountId; return this; } /** - * The email address of the user - * @return email + * The account id of the user + * @return accountId **/ - @ApiModelProperty(value = "The email address of the user") - public String getEmail() { - return email; + @ApiModelProperty(value = "The account id of the user") + public String getAccountId() { + return accountId; } - public void setEmail(String email) { - this.email = email; + public void setAccountId(String accountId) { + this.accountId = accountId; } public UserInfo firstName(String firstName) { @@ -115,22 +85,22 @@ public void setFirstName(String firstName) { this.firstName = firstName; } - public UserInfo id(String id) { - this.id = id; + public UserInfo lastName(String lastName) { + this.lastName = lastName; return this; } /** - * A unique identifier of the user resource for REST APIs as issued by Sign. - * @return id + * The last name of the user + * @return lastName **/ - @ApiModelProperty(value = "A unique identifier of the user resource for REST APIs as issued by Sign.") - public String getId() { - return id; + @ApiModelProperty(value = "The last name of the user") + public String getLastName() { + return lastName; } - public void setId(String id) { - this.id = id; + public void setLastName(String lastName) { + this.lastName = lastName; } public UserInfo isAccountAdmin(Boolean isAccountAdmin) { @@ -151,22 +121,58 @@ public void setIsAccountAdmin(Boolean isAccountAdmin) { this.isAccountAdmin = isAccountAdmin; } - public UserInfo lastName(String lastName) { - this.lastName = lastName; + public UserInfo company(String company) { + this.company = company; return this; } /** - * The last name of the user - * @return lastName + * The name of company of the user + * @return company **/ - @ApiModelProperty(value = "The last name of the user") - public String getLastName() { - return lastName; + @ApiModelProperty(value = "The name of company of the user") + public String getCompany() { + return company; } - public void setLastName(String lastName) { - this.lastName = lastName; + public void setCompany(String company) { + this.company = company; + } + + public UserInfo id(String id) { + this.id = id; + return this; + } + + /** + * A unique identifier of the user resource for REST APIs as issued by Sign. + * @return id + **/ + @ApiModelProperty(value = "A unique identifier of the user resource for REST APIs as issued by Sign.") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public UserInfo email(String email) { + this.email = email; + return this; + } + + /** + * The email address of the user + * @return email + **/ + @ApiModelProperty(value = "The email address of the user") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; } @@ -179,17 +185,18 @@ public boolean equals(java.lang.Object o) { return false; } UserInfo userInfo = (UserInfo) o; - return Objects.equals(this.company, userInfo.company) && - Objects.equals(this.email, userInfo.email) && + return Objects.equals(this.accountId, userInfo.accountId) && Objects.equals(this.firstName, userInfo.firstName) && - Objects.equals(this.id, userInfo.id) && + Objects.equals(this.lastName, userInfo.lastName) && Objects.equals(this.isAccountAdmin, userInfo.isAccountAdmin) && - Objects.equals(this.lastName, userInfo.lastName); + Objects.equals(this.company, userInfo.company) && + Objects.equals(this.id, userInfo.id) && + Objects.equals(this.email, userInfo.email); } @Override public int hashCode() { - return Objects.hash(company, email, firstName, id, isAccountAdmin, lastName); + return Objects.hash(accountId, firstName, lastName, isAccountAdmin, company, id, email); } @@ -198,12 +205,13 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class UserInfo {\n"); - sb.append(" company: ").append(toIndentedString(company)).append("\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n"); sb.append(" firstName: ").append(toIndentedString(firstName)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" isAccountAdmin: ").append(toIndentedString(isAccountAdmin)).append("\n"); sb.append(" lastName: ").append(toIndentedString(lastName)).append("\n"); + sb.append(" isAccountAdmin: ").append(toIndentedString(isAccountAdmin)).append("\n"); + sb.append(" company: ").append(toIndentedString(company)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/users/UserStateInfo.java b/src/main/java/io/swagger/client/model/users/UserStateInfo.java index 25cb816..6103528 100755 --- a/src/main/java/io/swagger/client/model/users/UserStateInfo.java +++ b/src/main/java/io/swagger/client/model/users/UserStateInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * UserStateInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:31.257+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:51.296+11:00") public class UserStateInfo { @SerializedName("comment") private String comment = null; diff --git a/src/main/java/io/swagger/client/model/users/UserStatusUpdateResponse.java b/src/main/java/io/swagger/client/model/users/UserStatusUpdateResponse.java index ca8a3a6..4d7003a 100755 --- a/src/main/java/io/swagger/client/model/users/UserStatusUpdateResponse.java +++ b/src/main/java/io/swagger/client/model/users/UserStatusUpdateResponse.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * UserStatusUpdateResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:31.257+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:51.296+11:00") public class UserStatusUpdateResponse { /** * The result of the attempt to activate or deactivate the user @@ -99,9 +84,6 @@ public CodeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("code") private CodeEnum code = null; - @SerializedName("message") - private String message = null; - /** * A status value showing the result of this operation */ @@ -158,6 +140,9 @@ public StateEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("state") private StateEnum state = null; + @SerializedName("message") + private String message = null; + public UserStatusUpdateResponse code(CodeEnum code) { this.code = code; return this; @@ -176,24 +161,6 @@ public void setCode(CodeEnum code) { this.code = code; } - public UserStatusUpdateResponse message(String message) { - this.message = message; - return this; - } - - /** - * String result message if there was no error - * @return message - **/ - @ApiModelProperty(value = "String result message if there was no error") - public String getMessage() { - return message; - } - - public void setMessage(String message) { - this.message = message; - } - public UserStatusUpdateResponse state(StateEnum state) { this.state = state; return this; @@ -212,6 +179,24 @@ public void setState(StateEnum state) { this.state = state; } + public UserStatusUpdateResponse message(String message) { + this.message = message; + return this; + } + + /** + * String result message if there was no error + * @return message + **/ + @ApiModelProperty(value = "String result message if there was no error") + public String getMessage() { + return message; + } + + public void setMessage(String message) { + this.message = message; + } + @Override public boolean equals(java.lang.Object o) { @@ -223,13 +208,13 @@ public boolean equals(java.lang.Object o) { } UserStatusUpdateResponse userStatusUpdateResponse = (UserStatusUpdateResponse) o; return Objects.equals(this.code, userStatusUpdateResponse.code) && - Objects.equals(this.message, userStatusUpdateResponse.message) && - Objects.equals(this.state, userStatusUpdateResponse.state); + Objects.equals(this.state, userStatusUpdateResponse.state) && + Objects.equals(this.message, userStatusUpdateResponse.message); } @Override public int hashCode() { - return Objects.hash(code, message, state); + return Objects.hash(code, state, message); } @@ -239,8 +224,8 @@ public String toString() { sb.append("class UserStatusUpdateResponse {\n"); sb.append(" code: ").append(toIndentedString(code)).append("\n"); - sb.append(" message: ").append(toIndentedString(message)).append("\n"); sb.append(" state: ").append(toIndentedString(state)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/users/UserView.java b/src/main/java/io/swagger/client/model/users/UserView.java index 5c14e29..4963834 100755 --- a/src/main/java/io/swagger/client/model/users/UserView.java +++ b/src/main/java/io/swagger/client/model/users/UserView.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,14 +27,11 @@ /** * UserView */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:31.257+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:51.296+11:00") public class UserView { @SerializedName("embeddedCode") private String embeddedCode = null; - @SerializedName("expiration") - private Date expiration = null; - /** * Name of the requested user view */ @@ -104,6 +86,9 @@ public NameEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("name") private NameEnum name = null; + @SerializedName("expiration") + private Date expiration = null; + @SerializedName("url") private String url = null; @@ -125,24 +110,6 @@ public void setEmbeddedCode(String embeddedCode) { this.embeddedCode = embeddedCode; } - public UserView expiration(Date expiration) { - this.expiration = expiration; - return this; - } - - /** - * Expiration of user url - * @return expiration - **/ - @ApiModelProperty(value = "Expiration of user url ") - public Date getExpiration() { - return expiration; - } - - public void setExpiration(Date expiration) { - this.expiration = expiration; - } - public UserView name(NameEnum name) { this.name = name; return this; @@ -161,6 +128,24 @@ public void setName(NameEnum name) { this.name = name; } + public UserView expiration(Date expiration) { + this.expiration = expiration; + return this; + } + + /** + * Expiration of user url + * @return expiration + **/ + @ApiModelProperty(value = "Expiration of user url ") + public Date getExpiration() { + return expiration; + } + + public void setExpiration(Date expiration) { + this.expiration = expiration; + } + public UserView url(String url) { this.url = url; return this; @@ -190,14 +175,14 @@ public boolean equals(java.lang.Object o) { } UserView userView = (UserView) o; return Objects.equals(this.embeddedCode, userView.embeddedCode) && - Objects.equals(this.expiration, userView.expiration) && Objects.equals(this.name, userView.name) && + Objects.equals(this.expiration, userView.expiration) && Objects.equals(this.url, userView.url); } @Override public int hashCode() { - return Objects.hash(embeddedCode, expiration, name, url); + return Objects.hash(embeddedCode, name, expiration, url); } @@ -207,8 +192,8 @@ public String toString() { sb.append("class UserView {\n"); sb.append(" embeddedCode: ").append(toIndentedString(embeddedCode)).append("\n"); - sb.append(" expiration: ").append(toIndentedString(expiration)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" expiration: ").append(toIndentedString(expiration)).append("\n"); sb.append(" url: ").append(toIndentedString(url)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/users/UserViewInfo.java b/src/main/java/io/swagger/client/model/users/UserViewInfo.java index 25a0aa4..62525cd 100755 --- a/src/main/java/io/swagger/client/model/users/UserViewInfo.java +++ b/src/main/java/io/swagger/client/model/users/UserViewInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,7 @@ /** * UserViewInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:31.257+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:51.296+11:00") public class UserViewInfo { @SerializedName("commonViewConfiguration") private CommonViewConfiguration commonViewConfiguration = null; diff --git a/src/main/java/io/swagger/client/model/users/UserViewResponse.java b/src/main/java/io/swagger/client/model/users/UserViewResponse.java index 8cf2e08..846f6aa 100755 --- a/src/main/java/io/swagger/client/model/users/UserViewResponse.java +++ b/src/main/java/io/swagger/client/model/users/UserViewResponse.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * UserViewResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:31.257+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:51.296+11:00") public class UserViewResponse { @SerializedName("userViewList") private List userViewList = null; diff --git a/src/main/java/io/swagger/client/model/users/UsersInfo.java b/src/main/java/io/swagger/client/model/users/UsersInfo.java index 78062db..dc32339 100755 --- a/src/main/java/io/swagger/client/model/users/UsersInfo.java +++ b/src/main/java/io/swagger/client/model/users/UsersInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,31 +30,13 @@ /** * UsersInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:31.257+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:51.296+11:00") public class UsersInfo { - @SerializedName("page") - private PageInfo page = null; - @SerializedName("userInfoList") private List userInfoList = null; - public UsersInfo page(PageInfo page) { - this.page = page; - return this; - } - - /** - * Pagination information for navigating through the response - * @return page - **/ - @ApiModelProperty(value = "Pagination information for navigating through the response") - public PageInfo getPage() { - return page; - } - - public void setPage(PageInfo page) { - this.page = page; - } + @SerializedName("page") + private PageInfo page = null; public UsersInfo userInfoList(List userInfoList) { this.userInfoList = userInfoList; @@ -97,6 +64,24 @@ public void setUserInfoList(List userInfoList) { this.userInfoList = userInfoList; } + public UsersInfo page(PageInfo page) { + this.page = page; + return this; + } + + /** + * Pagination information for navigating through the response + * @return page + **/ + @ApiModelProperty(value = "Pagination information for navigating through the response") + public PageInfo getPage() { + return page; + } + + public void setPage(PageInfo page) { + this.page = page; + } + @Override public boolean equals(java.lang.Object o) { @@ -107,13 +92,13 @@ public boolean equals(java.lang.Object o) { return false; } UsersInfo usersInfo = (UsersInfo) o; - return Objects.equals(this.page, usersInfo.page) && - Objects.equals(this.userInfoList, usersInfo.userInfoList); + return Objects.equals(this.userInfoList, usersInfo.userInfoList) && + Objects.equals(this.page, usersInfo.page); } @Override public int hashCode() { - return Objects.hash(page, userInfoList); + return Objects.hash(userInfoList, page); } @@ -122,8 +107,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class UsersInfo {\n"); - sb.append(" page: ").append(toIndentedString(page)).append("\n"); sb.append(" userInfoList: ").append(toIndentedString(userInfoList)).append("\n"); + sb.append(" page: ").append(toIndentedString(page)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/webhooks/PageInfo.java b/src/main/java/io/swagger/client/model/webhooks/PageInfo.java index 2df3c1b..a84dde5 100755 --- a/src/main/java/io/swagger/client/model/webhooks/PageInfo.java +++ b/src/main/java/io/swagger/client/model/webhooks/PageInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * PageInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:53.118+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:53.405+11:00") public class PageInfo { @SerializedName("nextCursor") private String nextCursor = null; diff --git a/src/main/java/io/swagger/client/model/webhooks/UserWebhook.java b/src/main/java/io/swagger/client/model/webhooks/UserWebhook.java index 32bef00..4d44e72 100755 --- a/src/main/java/io/swagger/client/model/webhooks/UserWebhook.java +++ b/src/main/java/io/swagger/client/model/webhooks/UserWebhook.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,42 +30,98 @@ /** * UserWebhook */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:53.118+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:53.405+11:00") public class UserWebhook { - @SerializedName("applicationDisplayName") - private String applicationDisplayName = null; - - @SerializedName("applicationName") - private String applicationName = null; - - @SerializedName("id") - private String id = null; - - @SerializedName("lastModified") - private Date lastModified = null; - - @SerializedName("name") - private String name = null; - @SerializedName("resourceId") private String resourceId = null; + @SerializedName("webhookUrlInfo") + private WebhookUrlInfo webhookUrlInfo = null; + /** - * The resource for which you want to create webhook. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request. The possible values are AGREEMENT, WIDGET, MEGASIGN AND LIBRARY_DOCUMENT + * Gets or Sets webhookSubscriptionEvents */ - @JsonAdapter(ResourceTypeEnum.Adapter.class) - public enum ResourceTypeEnum { - AGREEMENT("AGREEMENT"), + @JsonAdapter(WebhookSubscriptionEventsEnum.Adapter.class) + public enum WebhookSubscriptionEventsEnum { + AGREEMENT_CREATED("AGREEMENT_CREATED"), - WIDGET("WIDGET"), + AGREEMENT_ACTION_DELEGATED("AGREEMENT_ACTION_DELEGATED"), - MEGASIGN("MEGASIGN"), + AGREEMENT_RECALLED("AGREEMENT_RECALLED"), - LIBRARY_DOCUMENT("LIBRARY_DOCUMENT"); + AGREEMENT_REJECTED("AGREEMENT_REJECTED"), + + AGREEMENT_EXPIRED("AGREEMENT_EXPIRED"), + + AGREEMENT_ACTION_COMPLETED("AGREEMENT_ACTION_COMPLETED"), + + AGREEMENT_WORKFLOW_COMPLETED("AGREEMENT_WORKFLOW_COMPLETED"), + + AGREEMENT_EMAIL_VIEWED("AGREEMENT_EMAIL_VIEWED"), + + AGREEMENT_MODIFIED("AGREEMENT_MODIFIED"), + + AGREEMENT_SHARED("AGREEMENT_SHARED"), + + AGREEMENT_READY_TO_VAULT("AGREEMENT_READY_TO_VAULT"), + + AGREEMENT_VAULTED("AGREEMENT_VAULTED"), + + AGREEMENT_ACTION_REQUESTED("AGREEMENT_ACTION_REQUESTED"), + + AGREEMENT_ACTION_REPLACED_SIGNER("AGREEMENT_ACTION_REPLACED_SIGNER"), + + AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM("AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM"), + + AGREEMENT_DOCUMENTS_DELETED("AGREEMENT_DOCUMENTS_DELETED"), + + AGREEMENT_EMAIL_BOUNCED("AGREEMENT_EMAIL_BOUNCED"), + + AGREEMENT_KBA_AUTHENTICATED("AGREEMENT_KBA_AUTHENTICATED"), + + AGREEMENT_OFFLINE_SYNC("AGREEMENT_OFFLINE_SYNC"), + + AGREEMENT_USER_ACK_AGREEMENT_MODIFIED("AGREEMENT_USER_ACK_AGREEMENT_MODIFIED"), + + AGREEMENT_UPLOADED_BY_SENDER("AGREEMENT_UPLOADED_BY_SENDER"), + + AGREEMENT_WEB_IDENTITY_AUTHENTICATED("AGREEMENT_WEB_IDENTITY_AUTHENTICATED"), + + AGREEMENT_ALL("AGREEMENT_ALL"), + + MEGASIGN_CREATED("MEGASIGN_CREATED"), + + MEGASIGN_RECALLED("MEGASIGN_RECALLED"), + + MEGASIGN_SHARED("MEGASIGN_SHARED"), + + MEGASIGN_ALL("MEGASIGN_ALL"), + + WIDGET_CREATED("WIDGET_CREATED"), + + WIDGET_MODIFIED("WIDGET_MODIFIED"), + + WIDGET_SHARED("WIDGET_SHARED"), + + WIDGET_ENABLED("WIDGET_ENABLED"), + + WIDGET_DISABLED("WIDGET_DISABLED"), + + WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM("WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM"), + + WIDGET_ALL("WIDGET_ALL"), + + LIBRARY_DOCUMENT_CREATED("LIBRARY_DOCUMENT_CREATED"), + + LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM("LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM"), + + LIBRARY_DOCUMENT_MODIFIED("LIBRARY_DOCUMENT_MODIFIED"), + + LIBRARY_DOCUMENT_ALL("LIBRARY_DOCUMENT_ALL"); private String value; - ResourceTypeEnum(String value) { + WebhookSubscriptionEventsEnum(String value) { this.value = value; } @@ -93,8 +134,8 @@ public String toString() { return String.valueOf(value); } - public static ResourceTypeEnum fromValue(String text) { - for (ResourceTypeEnum b : ResourceTypeEnum.values()) { + public static WebhookSubscriptionEventsEnum fromValue(String text) { + for (WebhookSubscriptionEventsEnum b : WebhookSubscriptionEventsEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -102,22 +143,22 @@ public static ResourceTypeEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final ResourceTypeEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final WebhookSubscriptionEventsEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public ResourceTypeEnum read(final JsonReader jsonReader) throws IOException { + public WebhookSubscriptionEventsEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return ResourceTypeEnum.fromValue(String.valueOf(value)); + return WebhookSubscriptionEventsEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("resourceType") - private ResourceTypeEnum resourceType = null; + @SerializedName("webhookSubscriptionEvents") + private List webhookSubscriptionEvents = null; /** * Scope of webhook. Can't be modified in PUT request. The possible values are ACCOUNT, GROUP, USER or RESOURCE @@ -173,18 +214,37 @@ public ScopeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("scope") private ScopeEnum scope = null; + @SerializedName("name") + private String name = null; + + @SerializedName("id") + private String id = null; + + @SerializedName("lastModified") + private Date lastModified = null; + + @SerializedName("applicationDisplayName") + private String applicationDisplayName = null; + + @SerializedName("applicationName") + private String applicationName = null; + /** - * Status of the webhook. Determines whether the webhook will be actually triggered. Default: ACTIVE, if ACTIVE, this webhook will receive event requests. If INACTIVE, this webhook will not receive event requests. Can't provide status in POST/PUT requests. + * The resource for which you want to create webhook. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request. The possible values are AGREEMENT, WIDGET, MEGASIGN AND LIBRARY_DOCUMENT */ - @JsonAdapter(StatusEnum.Adapter.class) - public enum StatusEnum { - ACTIVE("ACTIVE"), + @JsonAdapter(ResourceTypeEnum.Adapter.class) + public enum ResourceTypeEnum { + AGREEMENT("AGREEMENT"), - INACTIVE("INACTIVE"); + WIDGET("WIDGET"), + + MEGASIGN("MEGASIGN"), + + LIBRARY_DOCUMENT("LIBRARY_DOCUMENT"); private String value; - StatusEnum(String value) { + ResourceTypeEnum(String value) { this.value = value; } @@ -197,8 +257,8 @@ public String toString() { return String.valueOf(value); } - public static StatusEnum fromValue(String text) { - for (StatusEnum b : StatusEnum.values()) { + public static ResourceTypeEnum fromValue(String text) { + for (ResourceTypeEnum b : ResourceTypeEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -206,105 +266,35 @@ public static StatusEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final ResourceTypeEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public StatusEnum read(final JsonReader jsonReader) throws IOException { + public ResourceTypeEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return StatusEnum.fromValue(String.valueOf(value)); + return ResourceTypeEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("status") - private StatusEnum status = null; + @SerializedName("resourceType") + private ResourceTypeEnum resourceType = null; /** - * Gets or Sets webhookSubscriptionEvents + * Status of the webhook. Determines whether the webhook will be actually triggered. Default: ACTIVE, if ACTIVE, this webhook will receive event requests. If INACTIVE, this webhook will not receive event requests. Can't provide status in POST/PUT requests. */ - @JsonAdapter(WebhookSubscriptionEventsEnum.Adapter.class) - public enum WebhookSubscriptionEventsEnum { - AGREEMENT_CREATED("AGREEMENT_CREATED"), - - AGREEMENT_ACTION_DELEGATED("AGREEMENT_ACTION_DELEGATED"), - - AGREEMENT_RECALLED("AGREEMENT_RECALLED"), - - AGREEMENT_REJECTED("AGREEMENT_REJECTED"), - - AGREEMENT_EXPIRED("AGREEMENT_EXPIRED"), - - AGREEMENT_ACTION_COMPLETED("AGREEMENT_ACTION_COMPLETED"), - - AGREEMENT_WORKFLOW_COMPLETED("AGREEMENT_WORKFLOW_COMPLETED"), - - AGREEMENT_EMAIL_VIEWED("AGREEMENT_EMAIL_VIEWED"), - - AGREEMENT_MODIFIED("AGREEMENT_MODIFIED"), - - AGREEMENT_SHARED("AGREEMENT_SHARED"), - - AGREEMENT_VAULTED("AGREEMENT_VAULTED"), - - AGREEMENT_ACTION_REQUESTED("AGREEMENT_ACTION_REQUESTED"), - - AGREEMENT_ACTION_REPLACED_SIGNER("AGREEMENT_ACTION_REPLACED_SIGNER"), - - AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM("AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM"), - - AGREEMENT_DOCUMENTS_DELETED("AGREEMENT_DOCUMENTS_DELETED"), - - AGREEMENT_EMAIL_BOUNCED("AGREEMENT_EMAIL_BOUNCED"), - - AGREEMENT_KBA_AUTHENTICATED("AGREEMENT_KBA_AUTHENTICATED"), - - AGREEMENT_OFFLINE_SYNC("AGREEMENT_OFFLINE_SYNC"), - - AGREEMENT_USER_ACK_AGREEMENT_MODIFIED("AGREEMENT_USER_ACK_AGREEMENT_MODIFIED"), - - AGREEMENT_UPLOADED_BY_SENDER("AGREEMENT_UPLOADED_BY_SENDER"), - - AGREEMENT_WEB_IDENTITY_AUTHENTICATED("AGREEMENT_WEB_IDENTITY_AUTHENTICATED"), - - AGREEMENT_ALL("AGREEMENT_ALL"), - - MEGASIGN_CREATED("MEGASIGN_CREATED"), - - MEGASIGN_RECALLED("MEGASIGN_RECALLED"), - - MEGASIGN_SHARED("MEGASIGN_SHARED"), - - MEGASIGN_ALL("MEGASIGN_ALL"), - - WIDGET_CREATED("WIDGET_CREATED"), - - WIDGET_MODIFIED("WIDGET_MODIFIED"), - - WIDGET_SHARED("WIDGET_SHARED"), - - WIDGET_ENABLED("WIDGET_ENABLED"), - - WIDGET_DISABLED("WIDGET_DISABLED"), - - WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM("WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM"), - - WIDGET_ALL("WIDGET_ALL"), - - LIBRARY_DOCUMENT_CREATED("LIBRARY_DOCUMENT_CREATED"), - - LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM("LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM"), - - LIBRARY_DOCUMENT_MODIFIED("LIBRARY_DOCUMENT_MODIFIED"), + @JsonAdapter(StatusEnum.Adapter.class) + public enum StatusEnum { + ACTIVE("ACTIVE"), - LIBRARY_DOCUMENT_ALL("LIBRARY_DOCUMENT_ALL"); + INACTIVE("INACTIVE"); private String value; - WebhookSubscriptionEventsEnum(String value) { + StatusEnum(String value) { this.value = value; } @@ -317,8 +307,8 @@ public String toString() { return String.valueOf(value); } - public static WebhookSubscriptionEventsEnum fromValue(String text) { - for (WebhookSubscriptionEventsEnum b : WebhookSubscriptionEventsEnum.values()) { + public static StatusEnum fromValue(String text) { + for (StatusEnum b : StatusEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -326,60 +316,119 @@ public static WebhookSubscriptionEventsEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final WebhookSubscriptionEventsEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public WebhookSubscriptionEventsEnum read(final JsonReader jsonReader) throws IOException { + public StatusEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return WebhookSubscriptionEventsEnum.fromValue(String.valueOf(value)); + return StatusEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("webhookSubscriptionEvents") - private List webhookSubscriptionEvents = null; + @SerializedName("status") + private StatusEnum status = null; - @SerializedName("webhookUrlInfo") - private WebhookUrlInfo webhookUrlInfo = null; + public UserWebhook resourceId(String resourceId) { + this.resourceId = resourceId; + return this; + } - public UserWebhook applicationDisplayName(String applicationDisplayName) { - this.applicationDisplayName = applicationDisplayName; + /** + * Id of the resource type for which you want to create webhook. Provide agreementId if webhook needs to be created for an agreement. Similarly, widgetId if webhook needs to be created for a web form, megaSignId if webhook needs to be created for a megaSign and libraryDocumentId if webhook needs to be created for a library document. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request + * @return resourceId + **/ + @ApiModelProperty(value = "Id of the resource type for which you want to create webhook. Provide agreementId if webhook needs to be created for an agreement. Similarly, widgetId if webhook needs to be created for a web form, megaSignId if webhook needs to be created for a megaSign and libraryDocumentId if webhook needs to be created for a library document. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request") + public String getResourceId() { + return resourceId; + } + + public void setResourceId(String resourceId) { + this.resourceId = resourceId; + } + + public UserWebhook webhookUrlInfo(WebhookUrlInfo webhookUrlInfo) { + this.webhookUrlInfo = webhookUrlInfo; return this; } /** - * The display name of the application through which webhook is created - * @return applicationDisplayName + * Info of webhook url + * @return webhookUrlInfo **/ - @ApiModelProperty(value = "The display name of the application through which webhook is created") - public String getApplicationDisplayName() { - return applicationDisplayName; + @ApiModelProperty(value = "Info of webhook url") + public WebhookUrlInfo getWebhookUrlInfo() { + return webhookUrlInfo; } - public void setApplicationDisplayName(String applicationDisplayName) { - this.applicationDisplayName = applicationDisplayName; + public void setWebhookUrlInfo(WebhookUrlInfo webhookUrlInfo) { + this.webhookUrlInfo = webhookUrlInfo; } - public UserWebhook applicationName(String applicationName) { - this.applicationName = applicationName; + public UserWebhook webhookSubscriptionEvents(List webhookSubscriptionEvents) { + this.webhookSubscriptionEvents = webhookSubscriptionEvents; + return this; + } + + public UserWebhook addWebhookSubscriptionEventsItem(WebhookSubscriptionEventsEnum webhookSubscriptionEventsItem) { + if (this.webhookSubscriptionEvents == null) { + this.webhookSubscriptionEvents = new ArrayList(); + } + this.webhookSubscriptionEvents.add(webhookSubscriptionEventsItem); return this; } /** - * The name of the application through which webhook is created - * @return applicationName + * Determines events for which the webhook is triggered. The possible values are <br> AGREEMENT_CREATED : When an agreement is created <br>, AGREEMENT_ACTION_DELEGATED : When an agreement is delegated <br>, AGREEMENT_RECALLED : When an agreement is recalled <br>, AGREEMENT_REJECTED : When an agreement is rejected <br>, AGREEMENT_EXPIRED : When an agreement expires <br>, AGREEMENT_ACTION_COMPLETED : When an agreement action is completed <br>, AGREEMENT_WORKFLOW_COMPLETED : When an agreement workflow is completed <br>, AGREEMENT_EMAIL_VIEWED : When an agreement's email is viewed <br>, AGREEMENT_MODIFIED : When an agreement is modified <br>, AGREEMENT_SHARED : When an agreement is shared <br>, AGREEMENT_READY_TO_VAULT : When an agreement is ready to vault <br>, AGREEMENT_VAULTED : When an agreement is vaulted <br>, AGREEMENT_ACTION_REQUESTED : When an agreement action is requested <br>, AGREEMENT_ACTION_REPLACED_SIGNER : When signer is replaced for an agreement <br>, AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When an agreement is auto-cancelled due to conversion problem <br>, AGREEMENT_DOCUMENTS_DELETED : When an agreement documents are deleted <br>, AGREEMENT_EMAIL_BOUNCED : When an agreement email gets bounced <br>, AGREEMENT_KBA_AUTHENTICATED : When an agreement KBA is authenticated <br>, AGREEMENT_OFFLINE_SYNC : When an agreement is synced offline <br>, AGREEMENT_USER_ACK_AGREEMENT_MODIFIED : User Acknowledgement when an agreement is modified <br>, AGREEMENT_UPLOADED_BY_SENDER : When an agreement is uploaded by sender <br>, AGREEMENT_WEB_IDENTITY_AUTHENTICATED : When an agreement web identity is authenticated <br>, AGREEMENT_ALL : All the supported agreement events for Webhooks <br>, MEGASIGN_CREATED : When a megaSign is created <br>, MEGASIGN_RECALLED : When a megaSign is recalled <br>, MEGASIGN_SHARED : When a megaSign is shared <br>, MEGASIGN_ALL : All the supported megaSign events for Webhooks <br>, WIDGET_CREATED : When a web form is created <br>, WIDGET_MODIFIED : When a web form is modified <br>, WIDGET_SHARED : When a web form is shared <br>, WIDGET_ENABLED : When a web form is enabled <br>, WIDGET_DISABLED : When a web form is disabled <br>, WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM : When a web form is auto-cancelled due to conversion problem <br>, WIDGET_ALL : All the supported web form events for Webhooks <br>, LIBRARY_DOCUMENT_CREATED : When a library document is created <br>, LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When a library document is auto-cancelled due to conversion problem <br>, LIBRARY_DOCUMENT_MODIFIED : When a library document is modified <br>, LIBRARY_DOCUMENT_ALL : All the supported library document events for Webhooks + * @return webhookSubscriptionEvents **/ - @ApiModelProperty(value = "The name of the application through which webhook is created") - public String getApplicationName() { - return applicationName; + @ApiModelProperty(value = "Determines events for which the webhook is triggered. The possible values are
AGREEMENT_CREATED : When an agreement is created
, AGREEMENT_ACTION_DELEGATED : When an agreement is delegated
, AGREEMENT_RECALLED : When an agreement is recalled
, AGREEMENT_REJECTED : When an agreement is rejected
, AGREEMENT_EXPIRED : When an agreement expires
, AGREEMENT_ACTION_COMPLETED : When an agreement action is completed
, AGREEMENT_WORKFLOW_COMPLETED : When an agreement workflow is completed
, AGREEMENT_EMAIL_VIEWED : When an agreement's email is viewed
, AGREEMENT_MODIFIED : When an agreement is modified
, AGREEMENT_SHARED : When an agreement is shared
, AGREEMENT_READY_TO_VAULT : When an agreement is ready to vault
, AGREEMENT_VAULTED : When an agreement is vaulted
, AGREEMENT_ACTION_REQUESTED : When an agreement action is requested
, AGREEMENT_ACTION_REPLACED_SIGNER : When signer is replaced for an agreement
, AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When an agreement is auto-cancelled due to conversion problem
, AGREEMENT_DOCUMENTS_DELETED : When an agreement documents are deleted
, AGREEMENT_EMAIL_BOUNCED : When an agreement email gets bounced
, AGREEMENT_KBA_AUTHENTICATED : When an agreement KBA is authenticated
, AGREEMENT_OFFLINE_SYNC : When an agreement is synced offline
, AGREEMENT_USER_ACK_AGREEMENT_MODIFIED : User Acknowledgement when an agreement is modified
, AGREEMENT_UPLOADED_BY_SENDER : When an agreement is uploaded by sender
, AGREEMENT_WEB_IDENTITY_AUTHENTICATED : When an agreement web identity is authenticated
, AGREEMENT_ALL : All the supported agreement events for Webhooks
, MEGASIGN_CREATED : When a megaSign is created
, MEGASIGN_RECALLED : When a megaSign is recalled
, MEGASIGN_SHARED : When a megaSign is shared
, MEGASIGN_ALL : All the supported megaSign events for Webhooks
, WIDGET_CREATED : When a web form is created
, WIDGET_MODIFIED : When a web form is modified
, WIDGET_SHARED : When a web form is shared
, WIDGET_ENABLED : When a web form is enabled
, WIDGET_DISABLED : When a web form is disabled
, WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM : When a web form is auto-cancelled due to conversion problem
, WIDGET_ALL : All the supported web form events for Webhooks
, LIBRARY_DOCUMENT_CREATED : When a library document is created
, LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When a library document is auto-cancelled due to conversion problem
, LIBRARY_DOCUMENT_MODIFIED : When a library document is modified
, LIBRARY_DOCUMENT_ALL : All the supported library document events for Webhooks") + public List getWebhookSubscriptionEvents() { + return webhookSubscriptionEvents; } - public void setApplicationName(String applicationName) { - this.applicationName = applicationName; + public void setWebhookSubscriptionEvents(List webhookSubscriptionEvents) { + this.webhookSubscriptionEvents = webhookSubscriptionEvents; + } + + public UserWebhook scope(ScopeEnum scope) { + this.scope = scope; + return this; + } + + /** + * Scope of webhook. Can't be modified in PUT request. The possible values are ACCOUNT, GROUP, USER or RESOURCE + * @return scope + **/ + @ApiModelProperty(value = "Scope of webhook. Can't be modified in PUT request. The possible values are ACCOUNT, GROUP, USER or RESOURCE") + public ScopeEnum getScope() { + return scope; + } + + public void setScope(ScopeEnum scope) { + this.scope = scope; + } + + public UserWebhook name(String name) { + this.name = name; + return this; + } + + /** + * The name of the webhook + * @return name + **/ + @ApiModelProperty(value = "The name of the webhook") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; } public UserWebhook id(String id) { @@ -418,40 +467,40 @@ public void setLastModified(Date lastModified) { this.lastModified = lastModified; } - public UserWebhook name(String name) { - this.name = name; + public UserWebhook applicationDisplayName(String applicationDisplayName) { + this.applicationDisplayName = applicationDisplayName; return this; } /** - * The name of the webhook - * @return name + * The display name of the application through which webhook is created + * @return applicationDisplayName **/ - @ApiModelProperty(value = "The name of the webhook") - public String getName() { - return name; + @ApiModelProperty(value = "The display name of the application through which webhook is created") + public String getApplicationDisplayName() { + return applicationDisplayName; } - public void setName(String name) { - this.name = name; + public void setApplicationDisplayName(String applicationDisplayName) { + this.applicationDisplayName = applicationDisplayName; } - public UserWebhook resourceId(String resourceId) { - this.resourceId = resourceId; + public UserWebhook applicationName(String applicationName) { + this.applicationName = applicationName; return this; } /** - * Id of the resource type for which you want to create webhook. Provide agreementId if webhook needs to be created for an agreement. Similarly, widgetId if webhook needs to be created for a widget, megaSignId if webhook needs to be created for a megaSign and libraryDocumentId if webhook needs to be created for a library document. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request - * @return resourceId + * The name of the application through which webhook is created + * @return applicationName **/ - @ApiModelProperty(value = "Id of the resource type for which you want to create webhook. Provide agreementId if webhook needs to be created for an agreement. Similarly, widgetId if webhook needs to be created for a widget, megaSignId if webhook needs to be created for a megaSign and libraryDocumentId if webhook needs to be created for a library document. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request") - public String getResourceId() { - return resourceId; + @ApiModelProperty(value = "The name of the application through which webhook is created") + public String getApplicationName() { + return applicationName; } - public void setResourceId(String resourceId) { - this.resourceId = resourceId; + public void setApplicationName(String applicationName) { + this.applicationName = applicationName; } public UserWebhook resourceType(ResourceTypeEnum resourceType) { @@ -472,24 +521,6 @@ public void setResourceType(ResourceTypeEnum resourceType) { this.resourceType = resourceType; } - public UserWebhook scope(ScopeEnum scope) { - this.scope = scope; - return this; - } - - /** - * Scope of webhook. Can't be modified in PUT request. The possible values are ACCOUNT, GROUP, USER or RESOURCE - * @return scope - **/ - @ApiModelProperty(value = "Scope of webhook. Can't be modified in PUT request. The possible values are ACCOUNT, GROUP, USER or RESOURCE") - public ScopeEnum getScope() { - return scope; - } - - public void setScope(ScopeEnum scope) { - this.scope = scope; - } - public UserWebhook status(StatusEnum status) { this.status = status; return this; @@ -508,50 +539,6 @@ public void setStatus(StatusEnum status) { this.status = status; } - public UserWebhook webhookSubscriptionEvents(List webhookSubscriptionEvents) { - this.webhookSubscriptionEvents = webhookSubscriptionEvents; - return this; - } - - public UserWebhook addWebhookSubscriptionEventsItem(WebhookSubscriptionEventsEnum webhookSubscriptionEventsItem) { - if (this.webhookSubscriptionEvents == null) { - this.webhookSubscriptionEvents = new ArrayList(); - } - this.webhookSubscriptionEvents.add(webhookSubscriptionEventsItem); - return this; - } - - /** - * Determines events for which the webhook is triggered. The possible values are <br> AGREEMENT_CREATED : When an agreement is created <br>, AGREEMENT_ACTION_DELEGATED : When an agreement is delegated <br>, AGREEMENT_RECALLED : When an agreement is recalled <br>, AGREEMENT_REJECTED : When an agreement is rejected <br>, AGREEMENT_EXPIRED : When an agreement expires <br>, AGREEMENT_ACTION_COMPLETED : When an agreement action is completed <br>, AGREEMENT_WORKFLOW_COMPLETED : When an agreement workflow is completed <br>, AGREEMENT_EMAIL_VIEWED : When an agreement's email is viewed <br>, AGREEMENT_MODIFIED : When an agreement is modified <br>, AGREEMENT_SHARED : When an agreement is shared <br>, AGREEMENT_VAULTED : When an agreement is vaulted <br>, AGREEMENT_ACTION_REQUESTED : When an agreement action is requested <br>, AGREEMENT_ACTION_REPLACED_SIGNER : When signer is replaced for an agreement <br>, AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When an agreement is auto-cancelled due to conversion problem <br>, AGREEMENT_DOCUMENTS_DELETED : When an agreement documents are deleted <br>, AGREEMENT_EMAIL_BOUNCED : When an agreement email gets bounced <br>, AGREEMENT_KBA_AUTHENTICATED : When an agreement KBA is authenticated <br>, AGREEMENT_OFFLINE_SYNC : When an agreement is synced offline <br>, AGREEMENT_USER_ACK_AGREEMENT_MODIFIED : User Acknowledgement when an agreement is modified <br>, AGREEMENT_UPLOADED_BY_SENDER : When an agreement is uploaded by sender <br>, AGREEMENT_WEB_IDENTITY_AUTHENTICATED : When an agreement web identity is authenticated <br>, AGREEMENT_ALL : All the supported agreement events for Webhooks <br>, MEGASIGN_CREATED : When a megaSign is created <br>, MEGASIGN_RECALLED : When a megaSign is recalled <br>, MEGASIGN_SHARED : When a megaSign is shared <br>, MEGASIGN_ALL : All the supported megaSign events for Webhooks <br>, WIDGET_CREATED : When a widget is created <br>, WIDGET_MODIFIED : When a widget is modified <br>, WIDGET_SHARED : When a widget is shared <br>, WIDGET_ENABLED : When a widget is enabled <br>, WIDGET_DISABLED : When a widget is disabled <br>, WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM : When a widget is auto-cancelled due to conversion problem <br>, WIDGET_ALL : All the supported widget events for Webhooks <br>, LIBRARY_DOCUMENT_CREATED : When a library document is created <br>, LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When a library document is auto-cancelled due to conversion problem <br>, LIBRARY_DOCUMENT_MODIFIED : When a library document is modified <br>, LIBRARY_DOCUMENT_ALL : All the supported library document events for Webhooks - * @return webhookSubscriptionEvents - **/ - @ApiModelProperty(value = "Determines events for which the webhook is triggered. The possible values are
AGREEMENT_CREATED : When an agreement is created
, AGREEMENT_ACTION_DELEGATED : When an agreement is delegated
, AGREEMENT_RECALLED : When an agreement is recalled
, AGREEMENT_REJECTED : When an agreement is rejected
, AGREEMENT_EXPIRED : When an agreement expires
, AGREEMENT_ACTION_COMPLETED : When an agreement action is completed
, AGREEMENT_WORKFLOW_COMPLETED : When an agreement workflow is completed
, AGREEMENT_EMAIL_VIEWED : When an agreement's email is viewed
, AGREEMENT_MODIFIED : When an agreement is modified
, AGREEMENT_SHARED : When an agreement is shared
, AGREEMENT_VAULTED : When an agreement is vaulted
, AGREEMENT_ACTION_REQUESTED : When an agreement action is requested
, AGREEMENT_ACTION_REPLACED_SIGNER : When signer is replaced for an agreement
, AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When an agreement is auto-cancelled due to conversion problem
, AGREEMENT_DOCUMENTS_DELETED : When an agreement documents are deleted
, AGREEMENT_EMAIL_BOUNCED : When an agreement email gets bounced
, AGREEMENT_KBA_AUTHENTICATED : When an agreement KBA is authenticated
, AGREEMENT_OFFLINE_SYNC : When an agreement is synced offline
, AGREEMENT_USER_ACK_AGREEMENT_MODIFIED : User Acknowledgement when an agreement is modified
, AGREEMENT_UPLOADED_BY_SENDER : When an agreement is uploaded by sender
, AGREEMENT_WEB_IDENTITY_AUTHENTICATED : When an agreement web identity is authenticated
, AGREEMENT_ALL : All the supported agreement events for Webhooks
, MEGASIGN_CREATED : When a megaSign is created
, MEGASIGN_RECALLED : When a megaSign is recalled
, MEGASIGN_SHARED : When a megaSign is shared
, MEGASIGN_ALL : All the supported megaSign events for Webhooks
, WIDGET_CREATED : When a widget is created
, WIDGET_MODIFIED : When a widget is modified
, WIDGET_SHARED : When a widget is shared
, WIDGET_ENABLED : When a widget is enabled
, WIDGET_DISABLED : When a widget is disabled
, WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM : When a widget is auto-cancelled due to conversion problem
, WIDGET_ALL : All the supported widget events for Webhooks
, LIBRARY_DOCUMENT_CREATED : When a library document is created
, LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When a library document is auto-cancelled due to conversion problem
, LIBRARY_DOCUMENT_MODIFIED : When a library document is modified
, LIBRARY_DOCUMENT_ALL : All the supported library document events for Webhooks") - public List getWebhookSubscriptionEvents() { - return webhookSubscriptionEvents; - } - - public void setWebhookSubscriptionEvents(List webhookSubscriptionEvents) { - this.webhookSubscriptionEvents = webhookSubscriptionEvents; - } - - public UserWebhook webhookUrlInfo(WebhookUrlInfo webhookUrlInfo) { - this.webhookUrlInfo = webhookUrlInfo; - return this; - } - - /** - * Info of webhook url - * @return webhookUrlInfo - **/ - @ApiModelProperty(value = "Info of webhook url") - public WebhookUrlInfo getWebhookUrlInfo() { - return webhookUrlInfo; - } - - public void setWebhookUrlInfo(WebhookUrlInfo webhookUrlInfo) { - this.webhookUrlInfo = webhookUrlInfo; - } - @Override public boolean equals(java.lang.Object o) { @@ -562,22 +549,22 @@ public boolean equals(java.lang.Object o) { return false; } UserWebhook userWebhook = (UserWebhook) o; - return Objects.equals(this.applicationDisplayName, userWebhook.applicationDisplayName) && - Objects.equals(this.applicationName, userWebhook.applicationName) && + return Objects.equals(this.resourceId, userWebhook.resourceId) && + Objects.equals(this.webhookUrlInfo, userWebhook.webhookUrlInfo) && + Objects.equals(this.webhookSubscriptionEvents, userWebhook.webhookSubscriptionEvents) && + Objects.equals(this.scope, userWebhook.scope) && + Objects.equals(this.name, userWebhook.name) && Objects.equals(this.id, userWebhook.id) && Objects.equals(this.lastModified, userWebhook.lastModified) && - Objects.equals(this.name, userWebhook.name) && - Objects.equals(this.resourceId, userWebhook.resourceId) && + Objects.equals(this.applicationDisplayName, userWebhook.applicationDisplayName) && + Objects.equals(this.applicationName, userWebhook.applicationName) && Objects.equals(this.resourceType, userWebhook.resourceType) && - Objects.equals(this.scope, userWebhook.scope) && - Objects.equals(this.status, userWebhook.status) && - Objects.equals(this.webhookSubscriptionEvents, userWebhook.webhookSubscriptionEvents) && - Objects.equals(this.webhookUrlInfo, userWebhook.webhookUrlInfo); + Objects.equals(this.status, userWebhook.status); } @Override public int hashCode() { - return Objects.hash(applicationDisplayName, applicationName, id, lastModified, name, resourceId, resourceType, scope, status, webhookSubscriptionEvents, webhookUrlInfo); + return Objects.hash(resourceId, webhookUrlInfo, webhookSubscriptionEvents, scope, name, id, lastModified, applicationDisplayName, applicationName, resourceType, status); } @@ -586,17 +573,17 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class UserWebhook {\n"); - sb.append(" applicationDisplayName: ").append(toIndentedString(applicationDisplayName)).append("\n"); - sb.append(" applicationName: ").append(toIndentedString(applicationName)).append("\n"); + sb.append(" resourceId: ").append(toIndentedString(resourceId)).append("\n"); + sb.append(" webhookUrlInfo: ").append(toIndentedString(webhookUrlInfo)).append("\n"); + sb.append(" webhookSubscriptionEvents: ").append(toIndentedString(webhookSubscriptionEvents)).append("\n"); + sb.append(" scope: ").append(toIndentedString(scope)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" lastModified: ").append(toIndentedString(lastModified)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" resourceId: ").append(toIndentedString(resourceId)).append("\n"); + sb.append(" applicationDisplayName: ").append(toIndentedString(applicationDisplayName)).append("\n"); + sb.append(" applicationName: ").append(toIndentedString(applicationName)).append("\n"); sb.append(" resourceType: ").append(toIndentedString(resourceType)).append("\n"); - sb.append(" scope: ").append(toIndentedString(scope)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" webhookSubscriptionEvents: ").append(toIndentedString(webhookSubscriptionEvents)).append("\n"); - sb.append(" webhookUrlInfo: ").append(toIndentedString(webhookUrlInfo)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/webhooks/UserWebhooks.java b/src/main/java/io/swagger/client/model/webhooks/UserWebhooks.java index 91898dd..3a33a21 100755 --- a/src/main/java/io/swagger/client/model/webhooks/UserWebhooks.java +++ b/src/main/java/io/swagger/client/model/webhooks/UserWebhooks.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,31 +30,13 @@ /** * UserWebhooks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:53.118+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:53.405+11:00") public class UserWebhooks { - @SerializedName("page") - private PageInfo page = null; - @SerializedName("userWebhookList") private List userWebhookList = null; - public UserWebhooks page(PageInfo page) { - this.page = page; - return this; - } - - /** - * Pagination information for navigating through the response - * @return page - **/ - @ApiModelProperty(value = "Pagination information for navigating through the response") - public PageInfo getPage() { - return page; - } - - public void setPage(PageInfo page) { - this.page = page; - } + @SerializedName("page") + private PageInfo page = null; public UserWebhooks userWebhookList(List userWebhookList) { this.userWebhookList = userWebhookList; @@ -85,10 +52,10 @@ public UserWebhooks addUserWebhookListItem(UserWebhook userWebhookListItem) { } /** - * An array of widget items + * An array of web form items * @return userWebhookList **/ - @ApiModelProperty(value = "An array of widget items") + @ApiModelProperty(value = "An array of web form items") public List getUserWebhookList() { return userWebhookList; } @@ -97,6 +64,24 @@ public void setUserWebhookList(List userWebhookList) { this.userWebhookList = userWebhookList; } + public UserWebhooks page(PageInfo page) { + this.page = page; + return this; + } + + /** + * Pagination information for navigating through the response + * @return page + **/ + @ApiModelProperty(value = "Pagination information for navigating through the response") + public PageInfo getPage() { + return page; + } + + public void setPage(PageInfo page) { + this.page = page; + } + @Override public boolean equals(java.lang.Object o) { @@ -107,13 +92,13 @@ public boolean equals(java.lang.Object o) { return false; } UserWebhooks userWebhooks = (UserWebhooks) o; - return Objects.equals(this.page, userWebhooks.page) && - Objects.equals(this.userWebhookList, userWebhooks.userWebhookList); + return Objects.equals(this.userWebhookList, userWebhooks.userWebhookList) && + Objects.equals(this.page, userWebhooks.page); } @Override public int hashCode() { - return Objects.hash(page, userWebhookList); + return Objects.hash(userWebhookList, page); } @@ -122,8 +107,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class UserWebhooks {\n"); - sb.append(" page: ").append(toIndentedString(page)).append("\n"); sb.append(" userWebhookList: ").append(toIndentedString(userWebhookList)).append("\n"); + sb.append(" page: ").append(toIndentedString(page)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/webhooks/WebhookAgreementEvents.java b/src/main/java/io/swagger/client/model/webhooks/WebhookAgreementEvents.java index ed19928..eb0ce2f 100755 --- a/src/main/java/io/swagger/client/model/webhooks/WebhookAgreementEvents.java +++ b/src/main/java/io/swagger/client/model/webhooks/WebhookAgreementEvents.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,20 +26,20 @@ /** * WebhookAgreementEvents */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:53.118+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:53.405+11:00") public class WebhookAgreementEvents { @SerializedName("includeDetailedInfo") private Boolean includeDetailedInfo = null; - @SerializedName("includeDocumentsInfo") - private Boolean includeDocumentsInfo = null; - @SerializedName("includeParticipantsInfo") private Boolean includeParticipantsInfo = null; @SerializedName("includeSignedDocuments") private Boolean includeSignedDocuments = null; + @SerializedName("includeDocumentsInfo") + private Boolean includeDocumentsInfo = null; + public WebhookAgreementEvents includeDetailedInfo(Boolean includeDetailedInfo) { this.includeDetailedInfo = includeDetailedInfo; return this; @@ -73,24 +58,6 @@ public void setIncludeDetailedInfo(Boolean includeDetailedInfo) { this.includeDetailedInfo = includeDetailedInfo; } - public WebhookAgreementEvents includeDocumentsInfo(Boolean includeDocumentsInfo) { - this.includeDocumentsInfo = includeDocumentsInfo; - return this; - } - - /** - * Determines whether document info will be returned in the response payload - * @return includeDocumentsInfo - **/ - @ApiModelProperty(value = "Determines whether document info will be returned in the response payload") - public Boolean isIncludeDocumentsInfo() { - return includeDocumentsInfo; - } - - public void setIncludeDocumentsInfo(Boolean includeDocumentsInfo) { - this.includeDocumentsInfo = includeDocumentsInfo; - } - public WebhookAgreementEvents includeParticipantsInfo(Boolean includeParticipantsInfo) { this.includeParticipantsInfo = includeParticipantsInfo; return this; @@ -127,6 +94,24 @@ public void setIncludeSignedDocuments(Boolean includeSignedDocuments) { this.includeSignedDocuments = includeSignedDocuments; } + public WebhookAgreementEvents includeDocumentsInfo(Boolean includeDocumentsInfo) { + this.includeDocumentsInfo = includeDocumentsInfo; + return this; + } + + /** + * Determines whether document info will be returned in the response payload + * @return includeDocumentsInfo + **/ + @ApiModelProperty(value = "Determines whether document info will be returned in the response payload") + public Boolean isIncludeDocumentsInfo() { + return includeDocumentsInfo; + } + + public void setIncludeDocumentsInfo(Boolean includeDocumentsInfo) { + this.includeDocumentsInfo = includeDocumentsInfo; + } + @Override public boolean equals(java.lang.Object o) { @@ -138,14 +123,14 @@ public boolean equals(java.lang.Object o) { } WebhookAgreementEvents webhookAgreementEvents = (WebhookAgreementEvents) o; return Objects.equals(this.includeDetailedInfo, webhookAgreementEvents.includeDetailedInfo) && - Objects.equals(this.includeDocumentsInfo, webhookAgreementEvents.includeDocumentsInfo) && Objects.equals(this.includeParticipantsInfo, webhookAgreementEvents.includeParticipantsInfo) && - Objects.equals(this.includeSignedDocuments, webhookAgreementEvents.includeSignedDocuments); + Objects.equals(this.includeSignedDocuments, webhookAgreementEvents.includeSignedDocuments) && + Objects.equals(this.includeDocumentsInfo, webhookAgreementEvents.includeDocumentsInfo); } @Override public int hashCode() { - return Objects.hash(includeDetailedInfo, includeDocumentsInfo, includeParticipantsInfo, includeSignedDocuments); + return Objects.hash(includeDetailedInfo, includeParticipantsInfo, includeSignedDocuments, includeDocumentsInfo); } @@ -155,9 +140,9 @@ public String toString() { sb.append("class WebhookAgreementEvents {\n"); sb.append(" includeDetailedInfo: ").append(toIndentedString(includeDetailedInfo)).append("\n"); - sb.append(" includeDocumentsInfo: ").append(toIndentedString(includeDocumentsInfo)).append("\n"); sb.append(" includeParticipantsInfo: ").append(toIndentedString(includeParticipantsInfo)).append("\n"); sb.append(" includeSignedDocuments: ").append(toIndentedString(includeSignedDocuments)).append("\n"); + sb.append(" includeDocumentsInfo: ").append(toIndentedString(includeDocumentsInfo)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/webhooks/WebhookConditionalParams.java b/src/main/java/io/swagger/client/model/webhooks/WebhookConditionalParams.java index 7f50702..59a1f82 100755 --- a/src/main/java/io/swagger/client/model/webhooks/WebhookConditionalParams.java +++ b/src/main/java/io/swagger/client/model/webhooks/WebhookConditionalParams.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,54 +30,36 @@ /** * WebhookConditionalParams */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:53.118+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:53.405+11:00") public class WebhookConditionalParams { - @SerializedName("webhookAgreementEvents") - private WebhookAgreementEvents webhookAgreementEvents = null; - - @SerializedName("webhookLibraryDocumentEvents") - private WebhookLibraryDocumentEvents webhookLibraryDocumentEvents = null; - - @SerializedName("webhookMegaSignEvents") - private WebhookMegaSignEvents webhookMegaSignEvents = null; - @SerializedName("webhookWidgetEvents") private WebhookWidgetEvents webhookWidgetEvents = null; - public WebhookConditionalParams webhookAgreementEvents(WebhookAgreementEvents webhookAgreementEvents) { - this.webhookAgreementEvents = webhookAgreementEvents; - return this; - } + @SerializedName("webhookMegaSignEvents") + private WebhookMegaSignEvents webhookMegaSignEvents = null; - /** - * Conditional parameters for webhook agreement events - * @return webhookAgreementEvents - **/ - @ApiModelProperty(value = "Conditional parameters for webhook agreement events") - public WebhookAgreementEvents getWebhookAgreementEvents() { - return webhookAgreementEvents; - } + @SerializedName("webhookLibraryDocumentEvents") + private WebhookLibraryDocumentEvents webhookLibraryDocumentEvents = null; - public void setWebhookAgreementEvents(WebhookAgreementEvents webhookAgreementEvents) { - this.webhookAgreementEvents = webhookAgreementEvents; - } + @SerializedName("webhookAgreementEvents") + private WebhookAgreementEvents webhookAgreementEvents = null; - public WebhookConditionalParams webhookLibraryDocumentEvents(WebhookLibraryDocumentEvents webhookLibraryDocumentEvents) { - this.webhookLibraryDocumentEvents = webhookLibraryDocumentEvents; + public WebhookConditionalParams webhookWidgetEvents(WebhookWidgetEvents webhookWidgetEvents) { + this.webhookWidgetEvents = webhookWidgetEvents; return this; } /** - * Conditional parameters for webhook library document events - * @return webhookLibraryDocumentEvents + * Conditional parameters for webhook web form events + * @return webhookWidgetEvents **/ - @ApiModelProperty(value = "Conditional parameters for webhook library document events") - public WebhookLibraryDocumentEvents getWebhookLibraryDocumentEvents() { - return webhookLibraryDocumentEvents; + @ApiModelProperty(value = "Conditional parameters for webhook web form events") + public WebhookWidgetEvents getWebhookWidgetEvents() { + return webhookWidgetEvents; } - public void setWebhookLibraryDocumentEvents(WebhookLibraryDocumentEvents webhookLibraryDocumentEvents) { - this.webhookLibraryDocumentEvents = webhookLibraryDocumentEvents; + public void setWebhookWidgetEvents(WebhookWidgetEvents webhookWidgetEvents) { + this.webhookWidgetEvents = webhookWidgetEvents; } public WebhookConditionalParams webhookMegaSignEvents(WebhookMegaSignEvents webhookMegaSignEvents) { @@ -113,22 +80,40 @@ public void setWebhookMegaSignEvents(WebhookMegaSignEvents webhookMegaSignEvents this.webhookMegaSignEvents = webhookMegaSignEvents; } - public WebhookConditionalParams webhookWidgetEvents(WebhookWidgetEvents webhookWidgetEvents) { - this.webhookWidgetEvents = webhookWidgetEvents; + public WebhookConditionalParams webhookLibraryDocumentEvents(WebhookLibraryDocumentEvents webhookLibraryDocumentEvents) { + this.webhookLibraryDocumentEvents = webhookLibraryDocumentEvents; return this; } /** - * Conditional parameters for webhook widget events - * @return webhookWidgetEvents + * Conditional parameters for webhook library document events + * @return webhookLibraryDocumentEvents **/ - @ApiModelProperty(value = "Conditional parameters for webhook widget events") - public WebhookWidgetEvents getWebhookWidgetEvents() { - return webhookWidgetEvents; + @ApiModelProperty(value = "Conditional parameters for webhook library document events") + public WebhookLibraryDocumentEvents getWebhookLibraryDocumentEvents() { + return webhookLibraryDocumentEvents; } - public void setWebhookWidgetEvents(WebhookWidgetEvents webhookWidgetEvents) { - this.webhookWidgetEvents = webhookWidgetEvents; + public void setWebhookLibraryDocumentEvents(WebhookLibraryDocumentEvents webhookLibraryDocumentEvents) { + this.webhookLibraryDocumentEvents = webhookLibraryDocumentEvents; + } + + public WebhookConditionalParams webhookAgreementEvents(WebhookAgreementEvents webhookAgreementEvents) { + this.webhookAgreementEvents = webhookAgreementEvents; + return this; + } + + /** + * Conditional parameters for webhook agreement events + * @return webhookAgreementEvents + **/ + @ApiModelProperty(value = "Conditional parameters for webhook agreement events") + public WebhookAgreementEvents getWebhookAgreementEvents() { + return webhookAgreementEvents; + } + + public void setWebhookAgreementEvents(WebhookAgreementEvents webhookAgreementEvents) { + this.webhookAgreementEvents = webhookAgreementEvents; } @@ -141,15 +126,15 @@ public boolean equals(java.lang.Object o) { return false; } WebhookConditionalParams webhookConditionalParams = (WebhookConditionalParams) o; - return Objects.equals(this.webhookAgreementEvents, webhookConditionalParams.webhookAgreementEvents) && - Objects.equals(this.webhookLibraryDocumentEvents, webhookConditionalParams.webhookLibraryDocumentEvents) && + return Objects.equals(this.webhookWidgetEvents, webhookConditionalParams.webhookWidgetEvents) && Objects.equals(this.webhookMegaSignEvents, webhookConditionalParams.webhookMegaSignEvents) && - Objects.equals(this.webhookWidgetEvents, webhookConditionalParams.webhookWidgetEvents); + Objects.equals(this.webhookLibraryDocumentEvents, webhookConditionalParams.webhookLibraryDocumentEvents) && + Objects.equals(this.webhookAgreementEvents, webhookConditionalParams.webhookAgreementEvents); } @Override public int hashCode() { - return Objects.hash(webhookAgreementEvents, webhookLibraryDocumentEvents, webhookMegaSignEvents, webhookWidgetEvents); + return Objects.hash(webhookWidgetEvents, webhookMegaSignEvents, webhookLibraryDocumentEvents, webhookAgreementEvents); } @@ -158,10 +143,10 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class WebhookConditionalParams {\n"); - sb.append(" webhookAgreementEvents: ").append(toIndentedString(webhookAgreementEvents)).append("\n"); - sb.append(" webhookLibraryDocumentEvents: ").append(toIndentedString(webhookLibraryDocumentEvents)).append("\n"); - sb.append(" webhookMegaSignEvents: ").append(toIndentedString(webhookMegaSignEvents)).append("\n"); sb.append(" webhookWidgetEvents: ").append(toIndentedString(webhookWidgetEvents)).append("\n"); + sb.append(" webhookMegaSignEvents: ").append(toIndentedString(webhookMegaSignEvents)).append("\n"); + sb.append(" webhookLibraryDocumentEvents: ").append(toIndentedString(webhookLibraryDocumentEvents)).append("\n"); + sb.append(" webhookAgreementEvents: ").append(toIndentedString(webhookAgreementEvents)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/webhooks/WebhookCreationResponse.java b/src/main/java/io/swagger/client/model/webhooks/WebhookCreationResponse.java index c9d7f33..42712f6 100755 --- a/src/main/java/io/swagger/client/model/webhooks/WebhookCreationResponse.java +++ b/src/main/java/io/swagger/client/model/webhooks/WebhookCreationResponse.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,7 @@ * A JSON that contains the id of the newly created webhook */ @ApiModel(description = "A JSON that contains the id of the newly created webhook") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:53.118+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:53.405+11:00") public class WebhookCreationResponse { @SerializedName("id") private String id = null; diff --git a/src/main/java/io/swagger/client/model/webhooks/WebhookInfo.java b/src/main/java/io/swagger/client/model/webhooks/WebhookInfo.java index 975ee35..5a04e8c 100755 --- a/src/main/java/io/swagger/client/model/webhooks/WebhookInfo.java +++ b/src/main/java/io/swagger/client/model/webhooks/WebhookInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -46,45 +31,104 @@ /** * WebhookInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:53.118+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:53.405+11:00") public class WebhookInfo { - @SerializedName("applicationDisplayName") - private String applicationDisplayName = null; + @SerializedName("resourceId") + private String resourceId = null; - @SerializedName("applicationName") - private String applicationName = null; + @SerializedName("webhookUrlInfo") + private WebhookUrlInfo webhookUrlInfo = null; + + @SerializedName("webhookConditionalParams") + private WebhookConditionalParams webhookConditionalParams = null; @SerializedName("created") private Date created = null; - @SerializedName("id") - private String id = null; - - @SerializedName("lastModified") - private Date lastModified = null; - - @SerializedName("name") - private String name = null; - - @SerializedName("resourceId") - private String resourceId = null; - /** - * The resource for which you want to create webhook. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request. The possible values are AGREEMENT, WIDGET, MEGASIGN AND LIBRARY_DOCUMENT + * Gets or Sets webhookSubscriptionEvents */ - @JsonAdapter(ResourceTypeEnum.Adapter.class) - public enum ResourceTypeEnum { - AGREEMENT("AGREEMENT"), + @JsonAdapter(WebhookSubscriptionEventsEnum.Adapter.class) + public enum WebhookSubscriptionEventsEnum { + AGREEMENT_CREATED("AGREEMENT_CREATED"), - WIDGET("WIDGET"), + AGREEMENT_ACTION_DELEGATED("AGREEMENT_ACTION_DELEGATED"), - MEGASIGN("MEGASIGN"), + AGREEMENT_RECALLED("AGREEMENT_RECALLED"), - LIBRARY_DOCUMENT("LIBRARY_DOCUMENT"); + AGREEMENT_REJECTED("AGREEMENT_REJECTED"), + + AGREEMENT_EXPIRED("AGREEMENT_EXPIRED"), + + AGREEMENT_ACTION_COMPLETED("AGREEMENT_ACTION_COMPLETED"), + + AGREEMENT_WORKFLOW_COMPLETED("AGREEMENT_WORKFLOW_COMPLETED"), + + AGREEMENT_EMAIL_VIEWED("AGREEMENT_EMAIL_VIEWED"), + + AGREEMENT_MODIFIED("AGREEMENT_MODIFIED"), + + AGREEMENT_SHARED("AGREEMENT_SHARED"), + + AGREEMENT_READY_TO_VAULT("AGREEMENT_READY_TO_VAULT"), + + AGREEMENT_VAULTED("AGREEMENT_VAULTED"), + + AGREEMENT_ACTION_REQUESTED("AGREEMENT_ACTION_REQUESTED"), + + AGREEMENT_ACTION_REPLACED_SIGNER("AGREEMENT_ACTION_REPLACED_SIGNER"), + + AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM("AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM"), + + AGREEMENT_DOCUMENTS_DELETED("AGREEMENT_DOCUMENTS_DELETED"), + + AGREEMENT_EMAIL_BOUNCED("AGREEMENT_EMAIL_BOUNCED"), + + AGREEMENT_KBA_AUTHENTICATED("AGREEMENT_KBA_AUTHENTICATED"), + + AGREEMENT_OFFLINE_SYNC("AGREEMENT_OFFLINE_SYNC"), + + AGREEMENT_USER_ACK_AGREEMENT_MODIFIED("AGREEMENT_USER_ACK_AGREEMENT_MODIFIED"), + + AGREEMENT_UPLOADED_BY_SENDER("AGREEMENT_UPLOADED_BY_SENDER"), + + AGREEMENT_WEB_IDENTITY_AUTHENTICATED("AGREEMENT_WEB_IDENTITY_AUTHENTICATED"), + + AGREEMENT_ALL("AGREEMENT_ALL"), + + MEGASIGN_CREATED("MEGASIGN_CREATED"), + + MEGASIGN_RECALLED("MEGASIGN_RECALLED"), + + MEGASIGN_SHARED("MEGASIGN_SHARED"), + + MEGASIGN_ALL("MEGASIGN_ALL"), + + WIDGET_CREATED("WIDGET_CREATED"), + + WIDGET_MODIFIED("WIDGET_MODIFIED"), + + WIDGET_SHARED("WIDGET_SHARED"), + + WIDGET_ENABLED("WIDGET_ENABLED"), + + WIDGET_DISABLED("WIDGET_DISABLED"), + + WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM("WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM"), + + WIDGET_ALL("WIDGET_ALL"), + + LIBRARY_DOCUMENT_CREATED("LIBRARY_DOCUMENT_CREATED"), + + LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM("LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM"), + + LIBRARY_DOCUMENT_MODIFIED("LIBRARY_DOCUMENT_MODIFIED"), + + LIBRARY_DOCUMENT_ALL("LIBRARY_DOCUMENT_ALL"); private String value; - ResourceTypeEnum(String value) { + WebhookSubscriptionEventsEnum(String value) { this.value = value; } @@ -97,8 +141,8 @@ public String toString() { return String.valueOf(value); } - public static ResourceTypeEnum fromValue(String text) { - for (ResourceTypeEnum b : ResourceTypeEnum.values()) { + public static WebhookSubscriptionEventsEnum fromValue(String text) { + for (WebhookSubscriptionEventsEnum b : WebhookSubscriptionEventsEnum.values()) { if (String.valueOf(b.value).equals(text)) { return b; } @@ -106,22 +150,25 @@ public static ResourceTypeEnum fromValue(String text) { return null; } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final ResourceTypeEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final WebhookSubscriptionEventsEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public ResourceTypeEnum read(final JsonReader jsonReader) throws IOException { + public WebhookSubscriptionEventsEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return ResourceTypeEnum.fromValue(String.valueOf(value)); + return WebhookSubscriptionEventsEnum.fromValue(String.valueOf(value)); } } } - @SerializedName("resourceType") - private ResourceTypeEnum resourceType = null; + @SerializedName("webhookSubscriptionEvents") + private List webhookSubscriptionEvents = null; + + @SerializedName("applicationDisplayName") + private String applicationDisplayName = null; /** * Scope of webhook. Can't be modified in PUT request. The possible values are ACCOUNT, GROUP, USER or RESOURCE @@ -177,6 +224,15 @@ public ScopeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("scope") private ScopeEnum scope = null; + @SerializedName("name") + private String name = null; + + @SerializedName("id") + private String id = null; + + @SerializedName("lastModified") + private Date lastModified = null; + /** * The state in which the webhook should be created */ @@ -225,6 +281,63 @@ public StateEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("state") private StateEnum state = null; + @SerializedName("applicationName") + private String applicationName = null; + + /** + * The resource for which you want to create webhook. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request. The possible values are AGREEMENT, WIDGET, MEGASIGN AND LIBRARY_DOCUMENT + */ + @JsonAdapter(ResourceTypeEnum.Adapter.class) + public enum ResourceTypeEnum { + AGREEMENT("AGREEMENT"), + + WIDGET("WIDGET"), + + MEGASIGN("MEGASIGN"), + + LIBRARY_DOCUMENT("LIBRARY_DOCUMENT"); + + private String value; + + ResourceTypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ResourceTypeEnum fromValue(String text) { + for (ResourceTypeEnum b : ResourceTypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ResourceTypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ResourceTypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ResourceTypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("resourceType") + private ResourceTypeEnum resourceType = null; + /** * Status of the webhook. Determines whether the webhook will be actually triggered. Default: ACTIVE, if ACTIVE, this webhook will receive event requests. If INACTIVE, this webhook will not receive event requests. Can't provide status in POST/PUT requests. */ @@ -275,166 +388,58 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; - @SerializedName("webhookConditionalParams") - private WebhookConditionalParams webhookConditionalParams = null; + public WebhookInfo resourceId(String resourceId) { + this.resourceId = resourceId; + return this; + } - /** - * Gets or Sets webhookSubscriptionEvents - */ - @JsonAdapter(WebhookSubscriptionEventsEnum.Adapter.class) - public enum WebhookSubscriptionEventsEnum { - AGREEMENT_CREATED("AGREEMENT_CREATED"), - - AGREEMENT_ACTION_DELEGATED("AGREEMENT_ACTION_DELEGATED"), - - AGREEMENT_RECALLED("AGREEMENT_RECALLED"), - - AGREEMENT_REJECTED("AGREEMENT_REJECTED"), - - AGREEMENT_EXPIRED("AGREEMENT_EXPIRED"), - - AGREEMENT_ACTION_COMPLETED("AGREEMENT_ACTION_COMPLETED"), - - AGREEMENT_WORKFLOW_COMPLETED("AGREEMENT_WORKFLOW_COMPLETED"), - - AGREEMENT_EMAIL_VIEWED("AGREEMENT_EMAIL_VIEWED"), - - AGREEMENT_MODIFIED("AGREEMENT_MODIFIED"), - - AGREEMENT_SHARED("AGREEMENT_SHARED"), - - AGREEMENT_VAULTED("AGREEMENT_VAULTED"), - - AGREEMENT_ACTION_REQUESTED("AGREEMENT_ACTION_REQUESTED"), - - AGREEMENT_ACTION_REPLACED_SIGNER("AGREEMENT_ACTION_REPLACED_SIGNER"), - - AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM("AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM"), - - AGREEMENT_DOCUMENTS_DELETED("AGREEMENT_DOCUMENTS_DELETED"), - - AGREEMENT_EMAIL_BOUNCED("AGREEMENT_EMAIL_BOUNCED"), - - AGREEMENT_KBA_AUTHENTICATED("AGREEMENT_KBA_AUTHENTICATED"), - - AGREEMENT_OFFLINE_SYNC("AGREEMENT_OFFLINE_SYNC"), - - AGREEMENT_USER_ACK_AGREEMENT_MODIFIED("AGREEMENT_USER_ACK_AGREEMENT_MODIFIED"), - - AGREEMENT_UPLOADED_BY_SENDER("AGREEMENT_UPLOADED_BY_SENDER"), - - AGREEMENT_WEB_IDENTITY_AUTHENTICATED("AGREEMENT_WEB_IDENTITY_AUTHENTICATED"), - - AGREEMENT_ALL("AGREEMENT_ALL"), - - MEGASIGN_CREATED("MEGASIGN_CREATED"), - - MEGASIGN_RECALLED("MEGASIGN_RECALLED"), - - MEGASIGN_SHARED("MEGASIGN_SHARED"), - - MEGASIGN_ALL("MEGASIGN_ALL"), - - WIDGET_CREATED("WIDGET_CREATED"), - - WIDGET_MODIFIED("WIDGET_MODIFIED"), - - WIDGET_SHARED("WIDGET_SHARED"), - - WIDGET_ENABLED("WIDGET_ENABLED"), - - WIDGET_DISABLED("WIDGET_DISABLED"), - - WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM("WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM"), - - WIDGET_ALL("WIDGET_ALL"), - - LIBRARY_DOCUMENT_CREATED("LIBRARY_DOCUMENT_CREATED"), - - LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM("LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM"), - - LIBRARY_DOCUMENT_MODIFIED("LIBRARY_DOCUMENT_MODIFIED"), - - LIBRARY_DOCUMENT_ALL("LIBRARY_DOCUMENT_ALL"); - - private String value; - - WebhookSubscriptionEventsEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static WebhookSubscriptionEventsEnum fromValue(String text) { - for (WebhookSubscriptionEventsEnum b : WebhookSubscriptionEventsEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final WebhookSubscriptionEventsEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public WebhookSubscriptionEventsEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return WebhookSubscriptionEventsEnum.fromValue(String.valueOf(value)); - } - } + /** + * Id of the resource type for which you want to create webhook. Provide agreementId if webhook needs to be created for an agreement. Similarly, widgetId if webhook needs to be created for a web form, megaSignId if webhook needs to be created for a megaSign and libraryDocumentId if webhook needs to be created for a library document. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request + * @return resourceId + **/ + @ApiModelProperty(value = "Id of the resource type for which you want to create webhook. Provide agreementId if webhook needs to be created for an agreement. Similarly, widgetId if webhook needs to be created for a web form, megaSignId if webhook needs to be created for a megaSign and libraryDocumentId if webhook needs to be created for a library document. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request") + public String getResourceId() { + return resourceId; } - @SerializedName("webhookSubscriptionEvents") - private List webhookSubscriptionEvents = null; - - @SerializedName("webhookUrlInfo") - private WebhookUrlInfo webhookUrlInfo = null; + public void setResourceId(String resourceId) { + this.resourceId = resourceId; + } - public WebhookInfo applicationDisplayName(String applicationDisplayName) { - this.applicationDisplayName = applicationDisplayName; + public WebhookInfo webhookUrlInfo(WebhookUrlInfo webhookUrlInfo) { + this.webhookUrlInfo = webhookUrlInfo; return this; } /** - * The display name of the application through which webhook is created - * @return applicationDisplayName + * Info of webhook url + * @return webhookUrlInfo **/ - @ApiModelProperty(value = "The display name of the application through which webhook is created") - public String getApplicationDisplayName() { - return applicationDisplayName; + @ApiModelProperty(value = "Info of webhook url") + public WebhookUrlInfo getWebhookUrlInfo() { + return webhookUrlInfo; } - public void setApplicationDisplayName(String applicationDisplayName) { - this.applicationDisplayName = applicationDisplayName; + public void setWebhookUrlInfo(WebhookUrlInfo webhookUrlInfo) { + this.webhookUrlInfo = webhookUrlInfo; } - public WebhookInfo applicationName(String applicationName) { - this.applicationName = applicationName; + public WebhookInfo webhookConditionalParams(WebhookConditionalParams webhookConditionalParams) { + this.webhookConditionalParams = webhookConditionalParams; return this; } /** - * The name of the application through which webhook is created - * @return applicationName + * Conditions which webhook creator can specify for the payload while creating or updating a webhook + * @return webhookConditionalParams **/ - @ApiModelProperty(value = "The name of the application through which webhook is created") - public String getApplicationName() { - return applicationName; + @ApiModelProperty(value = "Conditions which webhook creator can specify for the payload while creating or updating a webhook") + public WebhookConditionalParams getWebhookConditionalParams() { + return webhookConditionalParams; } - public void setApplicationName(String applicationName) { - this.applicationName = applicationName; + public void setWebhookConditionalParams(WebhookConditionalParams webhookConditionalParams) { + this.webhookConditionalParams = webhookConditionalParams; } public WebhookInfo created(Date created) { @@ -455,112 +460,120 @@ public void setCreated(Date created) { this.created = created; } - public WebhookInfo id(String id) { - this.id = id; + public WebhookInfo webhookSubscriptionEvents(List webhookSubscriptionEvents) { + this.webhookSubscriptionEvents = webhookSubscriptionEvents; + return this; + } + + public WebhookInfo addWebhookSubscriptionEventsItem(WebhookSubscriptionEventsEnum webhookSubscriptionEventsItem) { + if (this.webhookSubscriptionEvents == null) { + this.webhookSubscriptionEvents = new ArrayList(); + } + this.webhookSubscriptionEvents.add(webhookSubscriptionEventsItem); return this; } /** - * The unique identifier of the webhook. Will only be returned in GET request. Can't be modified in PUT request - * @return id + * Determines events for which the webhook is triggered. The possible values are <br> AGREEMENT_CREATED : When an agreement is created <br>, AGREEMENT_ACTION_DELEGATED : When an agreement is delegated <br>, AGREEMENT_RECALLED : When an agreement is recalled <br>, AGREEMENT_REJECTED : When an agreement is rejected <br>, AGREEMENT_EXPIRED : When an agreement expires <br>, AGREEMENT_ACTION_COMPLETED : When an agreement action is completed <br>, AGREEMENT_WORKFLOW_COMPLETED : When an agreement workflow is completed <br>, AGREEMENT_EMAIL_VIEWED : When an agreement's email is viewed <br>, AGREEMENT_MODIFIED : When an agreement is modified <br>, AGREEMENT_SHARED : When an agreement is shared <br>, AGREEMENT_READY_TO_VAULT : When an agreement is ready to vault <br>, AGREEMENT_VAULTED : When an agreement is vaulted <br>, AGREEMENT_ACTION_REQUESTED : When an agreement action is requested <br>, AGREEMENT_ACTION_REPLACED_SIGNER : When signer is replaced for an agreement <br>, AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When an agreement is auto-cancelled due to conversion problem <br>, AGREEMENT_DOCUMENTS_DELETED : When an agreement documents are deleted <br>, AGREEMENT_EMAIL_BOUNCED : When an agreement email gets bounced <br>, AGREEMENT_KBA_AUTHENTICATED : When an agreement KBA is authenticated <br>, AGREEMENT_OFFLINE_SYNC : When an agreement is synced offline <br>, AGREEMENT_USER_ACK_AGREEMENT_MODIFIED : User Acknowledgement when an agreement is modified <br>, AGREEMENT_UPLOADED_BY_SENDER : When an agreement is uploaded by sender <br>, AGREEMENT_WEB_IDENTITY_AUTHENTICATED : When an agreement web identity is authenticated <br>, AGREEMENT_ALL : All the supported agreement events for Webhooks <br>, MEGASIGN_CREATED : When a megaSign is created <br>, MEGASIGN_RECALLED : When a megaSign is recalled <br>, MEGASIGN_SHARED : When a megaSign is shared <br>, MEGASIGN_ALL : All the supported megaSign events for Webhooks <br>, WIDGET_CREATED : When a web form is created <br>, WIDGET_MODIFIED : When a web form is modified <br>, WIDGET_SHARED : When a web form is shared <br>, WIDGET_ENABLED : When a web form is enabled <br>, WIDGET_DISABLED : When a web form is disabled <br>, WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM : When a web form is auto-cancelled due to conversion problem <br>, WIDGET_ALL : All the supported web form events for Webhooks <br>, LIBRARY_DOCUMENT_CREATED : When a library document is created <br>, LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When a library document is auto-cancelled due to conversion problem <br>, LIBRARY_DOCUMENT_MODIFIED : When a library document is modified <br>, LIBRARY_DOCUMENT_ALL : All the supported library document events for Webhooks + * @return webhookSubscriptionEvents **/ - @ApiModelProperty(value = "The unique identifier of the webhook. Will only be returned in GET request. Can't be modified in PUT request") - public String getId() { - return id; + @ApiModelProperty(value = "Determines events for which the webhook is triggered. The possible values are
AGREEMENT_CREATED : When an agreement is created
, AGREEMENT_ACTION_DELEGATED : When an agreement is delegated
, AGREEMENT_RECALLED : When an agreement is recalled
, AGREEMENT_REJECTED : When an agreement is rejected
, AGREEMENT_EXPIRED : When an agreement expires
, AGREEMENT_ACTION_COMPLETED : When an agreement action is completed
, AGREEMENT_WORKFLOW_COMPLETED : When an agreement workflow is completed
, AGREEMENT_EMAIL_VIEWED : When an agreement's email is viewed
, AGREEMENT_MODIFIED : When an agreement is modified
, AGREEMENT_SHARED : When an agreement is shared
, AGREEMENT_READY_TO_VAULT : When an agreement is ready to vault
, AGREEMENT_VAULTED : When an agreement is vaulted
, AGREEMENT_ACTION_REQUESTED : When an agreement action is requested
, AGREEMENT_ACTION_REPLACED_SIGNER : When signer is replaced for an agreement
, AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When an agreement is auto-cancelled due to conversion problem
, AGREEMENT_DOCUMENTS_DELETED : When an agreement documents are deleted
, AGREEMENT_EMAIL_BOUNCED : When an agreement email gets bounced
, AGREEMENT_KBA_AUTHENTICATED : When an agreement KBA is authenticated
, AGREEMENT_OFFLINE_SYNC : When an agreement is synced offline
, AGREEMENT_USER_ACK_AGREEMENT_MODIFIED : User Acknowledgement when an agreement is modified
, AGREEMENT_UPLOADED_BY_SENDER : When an agreement is uploaded by sender
, AGREEMENT_WEB_IDENTITY_AUTHENTICATED : When an agreement web identity is authenticated
, AGREEMENT_ALL : All the supported agreement events for Webhooks
, MEGASIGN_CREATED : When a megaSign is created
, MEGASIGN_RECALLED : When a megaSign is recalled
, MEGASIGN_SHARED : When a megaSign is shared
, MEGASIGN_ALL : All the supported megaSign events for Webhooks
, WIDGET_CREATED : When a web form is created
, WIDGET_MODIFIED : When a web form is modified
, WIDGET_SHARED : When a web form is shared
, WIDGET_ENABLED : When a web form is enabled
, WIDGET_DISABLED : When a web form is disabled
, WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM : When a web form is auto-cancelled due to conversion problem
, WIDGET_ALL : All the supported web form events for Webhooks
, LIBRARY_DOCUMENT_CREATED : When a library document is created
, LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When a library document is auto-cancelled due to conversion problem
, LIBRARY_DOCUMENT_MODIFIED : When a library document is modified
, LIBRARY_DOCUMENT_ALL : All the supported library document events for Webhooks") + public List getWebhookSubscriptionEvents() { + return webhookSubscriptionEvents; } - public void setId(String id) { - this.id = id; + public void setWebhookSubscriptionEvents(List webhookSubscriptionEvents) { + this.webhookSubscriptionEvents = webhookSubscriptionEvents; } - public WebhookInfo lastModified(Date lastModified) { - this.lastModified = lastModified; + public WebhookInfo applicationDisplayName(String applicationDisplayName) { + this.applicationDisplayName = applicationDisplayName; return this; } /** - * Timestamp when the webhook was last updated. Will only be returned in GET request. Can't be modified in PUT request - * @return lastModified + * The display name of the application through which webhook is created + * @return applicationDisplayName **/ - @ApiModelProperty(value = "Timestamp when the webhook was last updated. Will only be returned in GET request. Can't be modified in PUT request") - public Date getLastModified() { - return lastModified; + @ApiModelProperty(value = "The display name of the application through which webhook is created") + public String getApplicationDisplayName() { + return applicationDisplayName; } - public void setLastModified(Date lastModified) { - this.lastModified = lastModified; + public void setApplicationDisplayName(String applicationDisplayName) { + this.applicationDisplayName = applicationDisplayName; } - public WebhookInfo name(String name) { - this.name = name; + public WebhookInfo scope(ScopeEnum scope) { + this.scope = scope; return this; } /** - * The name of the webhook - * @return name + * Scope of webhook. Can't be modified in PUT request. The possible values are ACCOUNT, GROUP, USER or RESOURCE + * @return scope **/ - @ApiModelProperty(value = "The name of the webhook") - public String getName() { - return name; + @ApiModelProperty(value = "Scope of webhook. Can't be modified in PUT request. The possible values are ACCOUNT, GROUP, USER or RESOURCE") + public ScopeEnum getScope() { + return scope; } - public void setName(String name) { - this.name = name; + public void setScope(ScopeEnum scope) { + this.scope = scope; } - public WebhookInfo resourceId(String resourceId) { - this.resourceId = resourceId; + public WebhookInfo name(String name) { + this.name = name; return this; } /** - * Id of the resource type for which you want to create webhook. Provide agreementId if webhook needs to be created for an agreement. Similarly, widgetId if webhook needs to be created for a widget, megaSignId if webhook needs to be created for a megaSign and libraryDocumentId if webhook needs to be created for a library document. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request - * @return resourceId + * The name of the webhook + * @return name **/ - @ApiModelProperty(value = "Id of the resource type for which you want to create webhook. Provide agreementId if webhook needs to be created for an agreement. Similarly, widgetId if webhook needs to be created for a widget, megaSignId if webhook needs to be created for a megaSign and libraryDocumentId if webhook needs to be created for a library document. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request") - public String getResourceId() { - return resourceId; + @ApiModelProperty(value = "The name of the webhook") + public String getName() { + return name; } - public void setResourceId(String resourceId) { - this.resourceId = resourceId; + public void setName(String name) { + this.name = name; } - public WebhookInfo resourceType(ResourceTypeEnum resourceType) { - this.resourceType = resourceType; + public WebhookInfo id(String id) { + this.id = id; return this; } /** - * The resource for which you want to create webhook. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request. The possible values are AGREEMENT, WIDGET, MEGASIGN AND LIBRARY_DOCUMENT - * @return resourceType + * The unique identifier of the webhook. Will only be returned in GET request. Can't be modified in PUT request + * @return id **/ - @ApiModelProperty(value = "The resource for which you want to create webhook. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request. The possible values are AGREEMENT, WIDGET, MEGASIGN AND LIBRARY_DOCUMENT") - public ResourceTypeEnum getResourceType() { - return resourceType; + @ApiModelProperty(value = "The unique identifier of the webhook. Will only be returned in GET request. Can't be modified in PUT request") + public String getId() { + return id; } - public void setResourceType(ResourceTypeEnum resourceType) { - this.resourceType = resourceType; + public void setId(String id) { + this.id = id; } - public WebhookInfo scope(ScopeEnum scope) { - this.scope = scope; + public WebhookInfo lastModified(Date lastModified) { + this.lastModified = lastModified; return this; } /** - * Scope of webhook. Can't be modified in PUT request. The possible values are ACCOUNT, GROUP, USER or RESOURCE - * @return scope + * Timestamp when the webhook was last updated. Will only be returned in GET request. Can't be modified in PUT request + * @return lastModified **/ - @ApiModelProperty(value = "Scope of webhook. Can't be modified in PUT request. The possible values are ACCOUNT, GROUP, USER or RESOURCE") - public ScopeEnum getScope() { - return scope; + @ApiModelProperty(value = "Timestamp when the webhook was last updated. Will only be returned in GET request. Can't be modified in PUT request") + public Date getLastModified() { + return lastModified; } - public void setScope(ScopeEnum scope) { - this.scope = scope; + public void setLastModified(Date lastModified) { + this.lastModified = lastModified; } public WebhookInfo state(StateEnum state) { @@ -581,84 +594,58 @@ public void setState(StateEnum state) { this.state = state; } - public WebhookInfo status(StatusEnum status) { - this.status = status; - return this; - } - - /** - * Status of the webhook. Determines whether the webhook will be actually triggered. Default: ACTIVE, if ACTIVE, this webhook will receive event requests. If INACTIVE, this webhook will not receive event requests. Can't provide status in POST/PUT requests. - * @return status - **/ - @ApiModelProperty(value = "Status of the webhook. Determines whether the webhook will be actually triggered. Default: ACTIVE, if ACTIVE, this webhook will receive event requests. If INACTIVE, this webhook will not receive event requests. Can't provide status in POST/PUT requests.") - public StatusEnum getStatus() { - return status; - } - - public void setStatus(StatusEnum status) { - this.status = status; - } - - public WebhookInfo webhookConditionalParams(WebhookConditionalParams webhookConditionalParams) { - this.webhookConditionalParams = webhookConditionalParams; + public WebhookInfo applicationName(String applicationName) { + this.applicationName = applicationName; return this; } /** - * Conditions which webhook creator can specify for the payload while creating or updating a webhook - * @return webhookConditionalParams + * The name of the application through which webhook is created + * @return applicationName **/ - @ApiModelProperty(value = "Conditions which webhook creator can specify for the payload while creating or updating a webhook") - public WebhookConditionalParams getWebhookConditionalParams() { - return webhookConditionalParams; - } - - public void setWebhookConditionalParams(WebhookConditionalParams webhookConditionalParams) { - this.webhookConditionalParams = webhookConditionalParams; + @ApiModelProperty(value = "The name of the application through which webhook is created") + public String getApplicationName() { + return applicationName; } - public WebhookInfo webhookSubscriptionEvents(List webhookSubscriptionEvents) { - this.webhookSubscriptionEvents = webhookSubscriptionEvents; - return this; + public void setApplicationName(String applicationName) { + this.applicationName = applicationName; } - public WebhookInfo addWebhookSubscriptionEventsItem(WebhookSubscriptionEventsEnum webhookSubscriptionEventsItem) { - if (this.webhookSubscriptionEvents == null) { - this.webhookSubscriptionEvents = new ArrayList(); - } - this.webhookSubscriptionEvents.add(webhookSubscriptionEventsItem); + public WebhookInfo resourceType(ResourceTypeEnum resourceType) { + this.resourceType = resourceType; return this; } /** - * Determines events for which the webhook is triggered. The possible values are <br> AGREEMENT_CREATED : When an agreement is created <br>, AGREEMENT_ACTION_DELEGATED : When an agreement is delegated <br>, AGREEMENT_RECALLED : When an agreement is recalled <br>, AGREEMENT_REJECTED : When an agreement is rejected <br>, AGREEMENT_EXPIRED : When an agreement expires <br>, AGREEMENT_ACTION_COMPLETED : When an agreement action is completed <br>, AGREEMENT_WORKFLOW_COMPLETED : When an agreement workflow is completed <br>, AGREEMENT_EMAIL_VIEWED : When an agreement's email is viewed <br>, AGREEMENT_MODIFIED : When an agreement is modified <br>, AGREEMENT_SHARED : When an agreement is shared <br>, AGREEMENT_VAULTED : When an agreement is vaulted <br>, AGREEMENT_ACTION_REQUESTED : When an agreement action is requested <br>, AGREEMENT_ACTION_REPLACED_SIGNER : When signer is replaced for an agreement <br>, AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When an agreement is auto-cancelled due to conversion problem <br>, AGREEMENT_DOCUMENTS_DELETED : When an agreement documents are deleted <br>, AGREEMENT_EMAIL_BOUNCED : When an agreement email gets bounced <br>, AGREEMENT_KBA_AUTHENTICATED : When an agreement KBA is authenticated <br>, AGREEMENT_OFFLINE_SYNC : When an agreement is synced offline <br>, AGREEMENT_USER_ACK_AGREEMENT_MODIFIED : User Acknowledgement when an agreement is modified <br>, AGREEMENT_UPLOADED_BY_SENDER : When an agreement is uploaded by sender <br>, AGREEMENT_WEB_IDENTITY_AUTHENTICATED : When an agreement web identity is authenticated <br>, AGREEMENT_ALL : All the supported agreement events for Webhooks <br>, MEGASIGN_CREATED : When a megaSign is created <br>, MEGASIGN_RECALLED : When a megaSign is recalled <br>, MEGASIGN_SHARED : When a megaSign is shared <br>, MEGASIGN_ALL : All the supported megaSign events for Webhooks <br>, WIDGET_CREATED : When a widget is created <br>, WIDGET_MODIFIED : When a widget is modified <br>, WIDGET_SHARED : When a widget is shared <br>, WIDGET_ENABLED : When a widget is enabled <br>, WIDGET_DISABLED : When a widget is disabled <br>, WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM : When a widget is auto-cancelled due to conversion problem <br>, WIDGET_ALL : All the supported widget events for Webhooks <br>, LIBRARY_DOCUMENT_CREATED : When a library document is created <br>, LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When a library document is auto-cancelled due to conversion problem <br>, LIBRARY_DOCUMENT_MODIFIED : When a library document is modified <br>, LIBRARY_DOCUMENT_ALL : All the supported library document events for Webhooks - * @return webhookSubscriptionEvents + * The resource for which you want to create webhook. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request. The possible values are AGREEMENT, WIDGET, MEGASIGN AND LIBRARY_DOCUMENT + * @return resourceType **/ - @ApiModelProperty(value = "Determines events for which the webhook is triggered. The possible values are
AGREEMENT_CREATED : When an agreement is created
, AGREEMENT_ACTION_DELEGATED : When an agreement is delegated
, AGREEMENT_RECALLED : When an agreement is recalled
, AGREEMENT_REJECTED : When an agreement is rejected
, AGREEMENT_EXPIRED : When an agreement expires
, AGREEMENT_ACTION_COMPLETED : When an agreement action is completed
, AGREEMENT_WORKFLOW_COMPLETED : When an agreement workflow is completed
, AGREEMENT_EMAIL_VIEWED : When an agreement's email is viewed
, AGREEMENT_MODIFIED : When an agreement is modified
, AGREEMENT_SHARED : When an agreement is shared
, AGREEMENT_VAULTED : When an agreement is vaulted
, AGREEMENT_ACTION_REQUESTED : When an agreement action is requested
, AGREEMENT_ACTION_REPLACED_SIGNER : When signer is replaced for an agreement
, AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When an agreement is auto-cancelled due to conversion problem
, AGREEMENT_DOCUMENTS_DELETED : When an agreement documents are deleted
, AGREEMENT_EMAIL_BOUNCED : When an agreement email gets bounced
, AGREEMENT_KBA_AUTHENTICATED : When an agreement KBA is authenticated
, AGREEMENT_OFFLINE_SYNC : When an agreement is synced offline
, AGREEMENT_USER_ACK_AGREEMENT_MODIFIED : User Acknowledgement when an agreement is modified
, AGREEMENT_UPLOADED_BY_SENDER : When an agreement is uploaded by sender
, AGREEMENT_WEB_IDENTITY_AUTHENTICATED : When an agreement web identity is authenticated
, AGREEMENT_ALL : All the supported agreement events for Webhooks
, MEGASIGN_CREATED : When a megaSign is created
, MEGASIGN_RECALLED : When a megaSign is recalled
, MEGASIGN_SHARED : When a megaSign is shared
, MEGASIGN_ALL : All the supported megaSign events for Webhooks
, WIDGET_CREATED : When a widget is created
, WIDGET_MODIFIED : When a widget is modified
, WIDGET_SHARED : When a widget is shared
, WIDGET_ENABLED : When a widget is enabled
, WIDGET_DISABLED : When a widget is disabled
, WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM : When a widget is auto-cancelled due to conversion problem
, WIDGET_ALL : All the supported widget events for Webhooks
, LIBRARY_DOCUMENT_CREATED : When a library document is created
, LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM : When a library document is auto-cancelled due to conversion problem
, LIBRARY_DOCUMENT_MODIFIED : When a library document is modified
, LIBRARY_DOCUMENT_ALL : All the supported library document events for Webhooks") - public List getWebhookSubscriptionEvents() { - return webhookSubscriptionEvents; + @ApiModelProperty(value = "The resource for which you want to create webhook. Need to specify only if scope is 'RESOURCE'. Can't be modified in PUT request. The possible values are AGREEMENT, WIDGET, MEGASIGN AND LIBRARY_DOCUMENT") + public ResourceTypeEnum getResourceType() { + return resourceType; } - public void setWebhookSubscriptionEvents(List webhookSubscriptionEvents) { - this.webhookSubscriptionEvents = webhookSubscriptionEvents; + public void setResourceType(ResourceTypeEnum resourceType) { + this.resourceType = resourceType; } - public WebhookInfo webhookUrlInfo(WebhookUrlInfo webhookUrlInfo) { - this.webhookUrlInfo = webhookUrlInfo; + public WebhookInfo status(StatusEnum status) { + this.status = status; return this; } /** - * Info of webhook url - * @return webhookUrlInfo + * Status of the webhook. Determines whether the webhook will be actually triggered. Default: ACTIVE, if ACTIVE, this webhook will receive event requests. If INACTIVE, this webhook will not receive event requests. Can't provide status in POST/PUT requests. + * @return status **/ - @ApiModelProperty(value = "Info of webhook url") - public WebhookUrlInfo getWebhookUrlInfo() { - return webhookUrlInfo; + @ApiModelProperty(value = "Status of the webhook. Determines whether the webhook will be actually triggered. Default: ACTIVE, if ACTIVE, this webhook will receive event requests. If INACTIVE, this webhook will not receive event requests. Can't provide status in POST/PUT requests.") + public StatusEnum getStatus() { + return status; } - public void setWebhookUrlInfo(WebhookUrlInfo webhookUrlInfo) { - this.webhookUrlInfo = webhookUrlInfo; + public void setStatus(StatusEnum status) { + this.status = status; } @@ -671,25 +658,25 @@ public boolean equals(java.lang.Object o) { return false; } WebhookInfo webhookInfo = (WebhookInfo) o; - return Objects.equals(this.applicationDisplayName, webhookInfo.applicationDisplayName) && - Objects.equals(this.applicationName, webhookInfo.applicationName) && + return Objects.equals(this.resourceId, webhookInfo.resourceId) && + Objects.equals(this.webhookUrlInfo, webhookInfo.webhookUrlInfo) && + Objects.equals(this.webhookConditionalParams, webhookInfo.webhookConditionalParams) && Objects.equals(this.created, webhookInfo.created) && + Objects.equals(this.webhookSubscriptionEvents, webhookInfo.webhookSubscriptionEvents) && + Objects.equals(this.applicationDisplayName, webhookInfo.applicationDisplayName) && + Objects.equals(this.scope, webhookInfo.scope) && + Objects.equals(this.name, webhookInfo.name) && Objects.equals(this.id, webhookInfo.id) && Objects.equals(this.lastModified, webhookInfo.lastModified) && - Objects.equals(this.name, webhookInfo.name) && - Objects.equals(this.resourceId, webhookInfo.resourceId) && - Objects.equals(this.resourceType, webhookInfo.resourceType) && - Objects.equals(this.scope, webhookInfo.scope) && Objects.equals(this.state, webhookInfo.state) && - Objects.equals(this.status, webhookInfo.status) && - Objects.equals(this.webhookConditionalParams, webhookInfo.webhookConditionalParams) && - Objects.equals(this.webhookSubscriptionEvents, webhookInfo.webhookSubscriptionEvents) && - Objects.equals(this.webhookUrlInfo, webhookInfo.webhookUrlInfo); + Objects.equals(this.applicationName, webhookInfo.applicationName) && + Objects.equals(this.resourceType, webhookInfo.resourceType) && + Objects.equals(this.status, webhookInfo.status); } @Override public int hashCode() { - return Objects.hash(applicationDisplayName, applicationName, created, id, lastModified, name, resourceId, resourceType, scope, state, status, webhookConditionalParams, webhookSubscriptionEvents, webhookUrlInfo); + return Objects.hash(resourceId, webhookUrlInfo, webhookConditionalParams, created, webhookSubscriptionEvents, applicationDisplayName, scope, name, id, lastModified, state, applicationName, resourceType, status); } @@ -698,20 +685,20 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class WebhookInfo {\n"); - sb.append(" applicationDisplayName: ").append(toIndentedString(applicationDisplayName)).append("\n"); - sb.append(" applicationName: ").append(toIndentedString(applicationName)).append("\n"); + sb.append(" resourceId: ").append(toIndentedString(resourceId)).append("\n"); + sb.append(" webhookUrlInfo: ").append(toIndentedString(webhookUrlInfo)).append("\n"); + sb.append(" webhookConditionalParams: ").append(toIndentedString(webhookConditionalParams)).append("\n"); sb.append(" created: ").append(toIndentedString(created)).append("\n"); + sb.append(" webhookSubscriptionEvents: ").append(toIndentedString(webhookSubscriptionEvents)).append("\n"); + sb.append(" applicationDisplayName: ").append(toIndentedString(applicationDisplayName)).append("\n"); + sb.append(" scope: ").append(toIndentedString(scope)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" lastModified: ").append(toIndentedString(lastModified)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" resourceId: ").append(toIndentedString(resourceId)).append("\n"); - sb.append(" resourceType: ").append(toIndentedString(resourceType)).append("\n"); - sb.append(" scope: ").append(toIndentedString(scope)).append("\n"); sb.append(" state: ").append(toIndentedString(state)).append("\n"); + sb.append(" applicationName: ").append(toIndentedString(applicationName)).append("\n"); + sb.append(" resourceType: ").append(toIndentedString(resourceType)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" webhookConditionalParams: ").append(toIndentedString(webhookConditionalParams)).append("\n"); - sb.append(" webhookSubscriptionEvents: ").append(toIndentedString(webhookSubscriptionEvents)).append("\n"); - sb.append(" webhookUrlInfo: ").append(toIndentedString(webhookUrlInfo)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/webhooks/WebhookLibraryDocumentEvents.java b/src/main/java/io/swagger/client/model/webhooks/WebhookLibraryDocumentEvents.java index 92b3a54..e0b5a9f 100755 --- a/src/main/java/io/swagger/client/model/webhooks/WebhookLibraryDocumentEvents.java +++ b/src/main/java/io/swagger/client/model/webhooks/WebhookLibraryDocumentEvents.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * WebhookLibraryDocumentEvents */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:53.118+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:53.405+11:00") public class WebhookLibraryDocumentEvents { @SerializedName("includeDetailedInfo") private Boolean includeDetailedInfo = null; diff --git a/src/main/java/io/swagger/client/model/webhooks/WebhookMegaSignEvents.java b/src/main/java/io/swagger/client/model/webhooks/WebhookMegaSignEvents.java index bdf8882..7aad619 100755 --- a/src/main/java/io/swagger/client/model/webhooks/WebhookMegaSignEvents.java +++ b/src/main/java/io/swagger/client/model/webhooks/WebhookMegaSignEvents.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * WebhookMegaSignEvents */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:53.118+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:53.405+11:00") public class WebhookMegaSignEvents { @SerializedName("includeDetailedInfo") private Boolean includeDetailedInfo = null; diff --git a/src/main/java/io/swagger/client/model/webhooks/WebhookStateInfo.java b/src/main/java/io/swagger/client/model/webhooks/WebhookStateInfo.java index c542b62..85cfdc9 100755 --- a/src/main/java/io/swagger/client/model/webhooks/WebhookStateInfo.java +++ b/src/main/java/io/swagger/client/model/webhooks/WebhookStateInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * WebhookStateInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:53.118+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:53.405+11:00") public class WebhookStateInfo { /** * The state to which the webhook should be changed to diff --git a/src/main/java/io/swagger/client/model/webhooks/WebhookUrlInfo.java b/src/main/java/io/swagger/client/model/webhooks/WebhookUrlInfo.java index 2435e12..68f963e 100755 --- a/src/main/java/io/swagger/client/model/webhooks/WebhookUrlInfo.java +++ b/src/main/java/io/swagger/client/model/webhooks/WebhookUrlInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * WebhookUrlInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:53.118+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:53.405+11:00") public class WebhookUrlInfo { @SerializedName("url") private String url = null; diff --git a/src/main/java/io/swagger/client/model/webhooks/WebhookWidgetEvents.java b/src/main/java/io/swagger/client/model/webhooks/WebhookWidgetEvents.java index 719a903..ac6279f 100755 --- a/src/main/java/io/swagger/client/model/webhooks/WebhookWidgetEvents.java +++ b/src/main/java/io/swagger/client/model/webhooks/WebhookWidgetEvents.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,17 +26,17 @@ /** * WebhookWidgetEvents */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:49:53.118+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:53.405+11:00") public class WebhookWidgetEvents { @SerializedName("includeDetailedInfo") private Boolean includeDetailedInfo = null; - @SerializedName("includeDocumentsInfo") - private Boolean includeDocumentsInfo = null; - @SerializedName("includeParticipantsInfo") private Boolean includeParticipantsInfo = null; + @SerializedName("includeDocumentsInfo") + private Boolean includeDocumentsInfo = null; + public WebhookWidgetEvents includeDetailedInfo(Boolean includeDetailedInfo) { this.includeDetailedInfo = includeDetailedInfo; return this; @@ -70,24 +55,6 @@ public void setIncludeDetailedInfo(Boolean includeDetailedInfo) { this.includeDetailedInfo = includeDetailedInfo; } - public WebhookWidgetEvents includeDocumentsInfo(Boolean includeDocumentsInfo) { - this.includeDocumentsInfo = includeDocumentsInfo; - return this; - } - - /** - * Determines whether document info will be returned in the response payload - * @return includeDocumentsInfo - **/ - @ApiModelProperty(value = "Determines whether document info will be returned in the response payload") - public Boolean isIncludeDocumentsInfo() { - return includeDocumentsInfo; - } - - public void setIncludeDocumentsInfo(Boolean includeDocumentsInfo) { - this.includeDocumentsInfo = includeDocumentsInfo; - } - public WebhookWidgetEvents includeParticipantsInfo(Boolean includeParticipantsInfo) { this.includeParticipantsInfo = includeParticipantsInfo; return this; @@ -106,6 +73,24 @@ public void setIncludeParticipantsInfo(Boolean includeParticipantsInfo) { this.includeParticipantsInfo = includeParticipantsInfo; } + public WebhookWidgetEvents includeDocumentsInfo(Boolean includeDocumentsInfo) { + this.includeDocumentsInfo = includeDocumentsInfo; + return this; + } + + /** + * Determines whether document info will be returned in the response payload + * @return includeDocumentsInfo + **/ + @ApiModelProperty(value = "Determines whether document info will be returned in the response payload") + public Boolean isIncludeDocumentsInfo() { + return includeDocumentsInfo; + } + + public void setIncludeDocumentsInfo(Boolean includeDocumentsInfo) { + this.includeDocumentsInfo = includeDocumentsInfo; + } + @Override public boolean equals(java.lang.Object o) { @@ -117,13 +102,13 @@ public boolean equals(java.lang.Object o) { } WebhookWidgetEvents webhookWidgetEvents = (WebhookWidgetEvents) o; return Objects.equals(this.includeDetailedInfo, webhookWidgetEvents.includeDetailedInfo) && - Objects.equals(this.includeDocumentsInfo, webhookWidgetEvents.includeDocumentsInfo) && - Objects.equals(this.includeParticipantsInfo, webhookWidgetEvents.includeParticipantsInfo); + Objects.equals(this.includeParticipantsInfo, webhookWidgetEvents.includeParticipantsInfo) && + Objects.equals(this.includeDocumentsInfo, webhookWidgetEvents.includeDocumentsInfo); } @Override public int hashCode() { - return Objects.hash(includeDetailedInfo, includeDocumentsInfo, includeParticipantsInfo); + return Objects.hash(includeDetailedInfo, includeParticipantsInfo, includeDocumentsInfo); } @@ -133,8 +118,8 @@ public String toString() { sb.append("class WebhookWidgetEvents {\n"); sb.append(" includeDetailedInfo: ").append(toIndentedString(includeDetailedInfo)).append("\n"); - sb.append(" includeDocumentsInfo: ").append(toIndentedString(includeDocumentsInfo)).append("\n"); sb.append(" includeParticipantsInfo: ").append(toIndentedString(includeParticipantsInfo)).append("\n"); + sb.append(" includeDocumentsInfo: ").append(toIndentedString(includeDocumentsInfo)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/AccountSharerInfo.java b/src/main/java/io/swagger/client/model/widgets/AccountSharerInfo.java new file mode 100644 index 0000000..f822f33 --- /dev/null +++ b/src/main/java/io/swagger/client/model/widgets/AccountSharerInfo.java @@ -0,0 +1,221 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.widgets; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * AccountSharerInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") +public class AccountSharerInfo { + /** + * Gets or Sets permissions + */ + @JsonAdapter(PermissionsEnum.Adapter.class) + public enum PermissionsEnum { + VIEW("VIEW"), + + SEND("SEND"), + + MODIFY("MODIFY"); + + private String value; + + PermissionsEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static PermissionsEnum fromValue(String text) { + for (PermissionsEnum b : PermissionsEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final PermissionsEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public PermissionsEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return PermissionsEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("permissions") + private List permissions = null; + + @SerializedName("fullName") + private String fullName = null; + + @SerializedName("userId") + private String userId = null; + + @SerializedName("email") + private String email = null; + + public AccountSharerInfo permissions(List permissions) { + this.permissions = permissions; + return this; + } + + public AccountSharerInfo addPermissionsItem(PermissionsEnum permissionsItem) { + if (this.permissions == null) { + this.permissions = new ArrayList(); + } + this.permissions.add(permissionsItem); + return this; + } + + /** + * A list of permissions given for this account sharing. + * @return permissions + **/ + @ApiModelProperty(value = "A list of permissions given for this account sharing.") + public List getPermissions() { + return permissions; + } + + public void setPermissions(List permissions) { + this.permissions = permissions; + } + + public AccountSharerInfo fullName(String fullName) { + this.fullName = fullName; + return this; + } + + /** + * Full name of this account sharer. + * @return fullName + **/ + @ApiModelProperty(value = "Full name of this account sharer.") + public String getFullName() { + return fullName; + } + + public void setFullName(String fullName) { + this.fullName = fullName; + } + + public AccountSharerInfo userId(String userId) { + this.userId = userId; + return this; + } + + /** + * A unique identifier of the user resource for REST APIs as issued by Sign. + * @return userId + **/ + @ApiModelProperty(value = "A unique identifier of the user resource for REST APIs as issued by Sign.") + public String getUserId() { + return userId; + } + + public void setUserId(String userId) { + this.userId = userId; + } + + public AccountSharerInfo email(String email) { + this.email = email; + return this; + } + + /** + * The email address of the user + * @return email + **/ + @ApiModelProperty(value = "The email address of the user") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + AccountSharerInfo accountSharerInfo = (AccountSharerInfo) o; + return Objects.equals(this.permissions, accountSharerInfo.permissions) && + Objects.equals(this.fullName, accountSharerInfo.fullName) && + Objects.equals(this.userId, accountSharerInfo.userId) && + Objects.equals(this.email, accountSharerInfo.email); + } + + @Override + public int hashCode() { + return Objects.hash(permissions, fullName, userId, email); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class AccountSharerInfo {\n"); + + sb.append(" permissions: ").append(toIndentedString(permissions)).append("\n"); + sb.append(" fullName: ").append(toIndentedString(fullName)).append("\n"); + sb.append(" userId: ").append(toIndentedString(userId)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/widgets/BasicDocumentsImageUrlsInfo.java b/src/main/java/io/swagger/client/model/widgets/BasicDocumentsImageUrlsInfo.java new file mode 100644 index 0000000..9a0a73b --- /dev/null +++ b/src/main/java/io/swagger/client/model/widgets/BasicDocumentsImageUrlsInfo.java @@ -0,0 +1,104 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.widgets; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.widgets.DocumentImageUrlsInfo; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * BasicDocumentsImageUrlsInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") +public class BasicDocumentsImageUrlsInfo { + @SerializedName("documentsImageUrlsInfo") + private List documentsImageUrlsInfo = null; + + public BasicDocumentsImageUrlsInfo documentsImageUrlsInfo(List documentsImageUrlsInfo) { + this.documentsImageUrlsInfo = documentsImageUrlsInfo; + return this; + } + + public BasicDocumentsImageUrlsInfo addDocumentsImageUrlsInfoItem(DocumentImageUrlsInfo documentsImageUrlsInfoItem) { + if (this.documentsImageUrlsInfo == null) { + this.documentsImageUrlsInfo = new ArrayList(); + } + this.documentsImageUrlsInfo.add(documentsImageUrlsInfoItem); + return this; + } + + /** + * A list of original document image URLs info. + * @return documentsImageUrlsInfo + **/ + @ApiModelProperty(value = "A list of original document image URLs info.") + public List getDocumentsImageUrlsInfo() { + return documentsImageUrlsInfo; + } + + public void setDocumentsImageUrlsInfo(List documentsImageUrlsInfo) { + this.documentsImageUrlsInfo = documentsImageUrlsInfo; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + BasicDocumentsImageUrlsInfo basicDocumentsImageUrlsInfo = (BasicDocumentsImageUrlsInfo) o; + return Objects.equals(this.documentsImageUrlsInfo, basicDocumentsImageUrlsInfo.documentsImageUrlsInfo); + } + + @Override + public int hashCode() { + return Objects.hash(documentsImageUrlsInfo); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class BasicDocumentsImageUrlsInfo {\n"); + + sb.append(" documentsImageUrlsInfo: ").append(toIndentedString(documentsImageUrlsInfo)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/widgets/CCParticipantInfo.java b/src/main/java/io/swagger/client/model/widgets/CCParticipantInfo.java index 3bffd91..4fbaf6f 100755 --- a/src/main/java/io/swagger/client/model/widgets/CCParticipantInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/CCParticipantInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,54 +26,60 @@ /** * CCParticipantInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class CCParticipantInfo { - @SerializedName("company") - private String company = null; + @SerializedName("participantId") + private String participantId = null; - @SerializedName("email") - private String email = null; + @SerializedName("hidden") + private Boolean hidden = null; @SerializedName("name") private String name = null; - @SerializedName("participantId") - private String participantId = null; + @SerializedName("self") + private Boolean self = null; - public CCParticipantInfo company(String company) { - this.company = company; + @SerializedName("company") + private String company = null; + + @SerializedName("email") + private String email = null; + + public CCParticipantInfo participantId(String participantId) { + this.participantId = participantId; return this; } /** - * Company of the CC participant, if available. - * @return company + * The unique identifier of the CC participant of the web form. + * @return participantId **/ - @ApiModelProperty(value = "Company of the CC participant, if available.") - public String getCompany() { - return company; + @ApiModelProperty(value = " The unique identifier of the CC participant of the web form.") + public String getParticipantId() { + return participantId; } - public void setCompany(String company) { - this.company = company; + public void setParticipantId(String participantId) { + this.participantId = participantId; } - public CCParticipantInfo email(String email) { - this.email = email; + public CCParticipantInfo hidden(Boolean hidden) { + this.hidden = hidden; return this; } /** - * Email of the CC participant of the widget - * @return email + * True if the web form is hidden for the user that is calling the API. Only returned if self is true. + * @return hidden **/ - @ApiModelProperty(value = "Email of the CC participant of the widget") - public String getEmail() { - return email; + @ApiModelProperty(value = "True if the web form is hidden for the user that is calling the API. Only returned if self is true.") + public Boolean isHidden() { + return hidden; } - public void setEmail(String email) { - this.email = email; + public void setHidden(Boolean hidden) { + this.hidden = hidden; } public CCParticipantInfo name(String name) { @@ -109,22 +100,58 @@ public void setName(String name) { this.name = name; } - public CCParticipantInfo participantId(String participantId) { - this.participantId = participantId; + public CCParticipantInfo self(Boolean self) { + this.self = self; return this; } /** - * The unique identifier of the CC participant of the widget. - * @return participantId + * True if the CC participant of the web form is the same user that is calling the API. + * @return self **/ - @ApiModelProperty(value = " The unique identifier of the CC participant of the widget.") - public String getParticipantId() { - return participantId; + @ApiModelProperty(value = "True if the CC participant of the web form is the same user that is calling the API.") + public Boolean isSelf() { + return self; } - public void setParticipantId(String participantId) { - this.participantId = participantId; + public void setSelf(Boolean self) { + this.self = self; + } + + public CCParticipantInfo company(String company) { + this.company = company; + return this; + } + + /** + * Company of the CC participant, if available. + * @return company + **/ + @ApiModelProperty(value = "Company of the CC participant, if available.") + public String getCompany() { + return company; + } + + public void setCompany(String company) { + this.company = company; + } + + public CCParticipantInfo email(String email) { + this.email = email; + return this; + } + + /** + * Email of the CC participant of the web form + * @return email + **/ + @ApiModelProperty(value = "Email of the CC participant of the web form") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; } @@ -137,15 +164,17 @@ public boolean equals(java.lang.Object o) { return false; } CCParticipantInfo ccParticipantInfo = (CCParticipantInfo) o; - return Objects.equals(this.company, ccParticipantInfo.company) && - Objects.equals(this.email, ccParticipantInfo.email) && + return Objects.equals(this.participantId, ccParticipantInfo.participantId) && + Objects.equals(this.hidden, ccParticipantInfo.hidden) && Objects.equals(this.name, ccParticipantInfo.name) && - Objects.equals(this.participantId, ccParticipantInfo.participantId); + Objects.equals(this.self, ccParticipantInfo.self) && + Objects.equals(this.company, ccParticipantInfo.company) && + Objects.equals(this.email, ccParticipantInfo.email); } @Override public int hashCode() { - return Objects.hash(company, email, name, participantId); + return Objects.hash(participantId, hidden, name, self, company, email); } @@ -154,10 +183,12 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class CCParticipantInfo {\n"); + sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); + sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" self: ").append(toIndentedString(self)).append("\n"); sb.append(" company: ").append(toIndentedString(company)).append("\n"); sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/CommonViewConfiguration.java b/src/main/java/io/swagger/client/model/widgets/CommonViewConfiguration.java index af3b7c0..b6f6491 100755 --- a/src/main/java/io/swagger/client/model/widgets/CommonViewConfiguration.java +++ b/src/main/java/io/swagger/client/model/widgets/CommonViewConfiguration.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,17 +26,17 @@ /** * CommonViewConfiguration */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class CommonViewConfiguration { @SerializedName("autoLoginUser") private Boolean autoLoginUser = null; - @SerializedName("locale") - private String locale = null; - @SerializedName("noChrome") private Boolean noChrome = null; + @SerializedName("locale") + private String locale = null; + public CommonViewConfiguration autoLoginUser(Boolean autoLoginUser) { this.autoLoginUser = autoLoginUser; return this; @@ -70,24 +55,6 @@ public void setAutoLoginUser(Boolean autoLoginUser) { this.autoLoginUser = autoLoginUser; } - public CommonViewConfiguration locale(String locale) { - this.locale = locale; - return this; - } - - /** - * Message template locale - * @return locale - **/ - @ApiModelProperty(value = "Message template locale") - public String getLocale() { - return locale; - } - - public void setLocale(String locale) { - this.locale = locale; - } - public CommonViewConfiguration noChrome(Boolean noChrome) { this.noChrome = noChrome; return this; @@ -106,6 +73,24 @@ public void setNoChrome(Boolean noChrome) { this.noChrome = noChrome; } + public CommonViewConfiguration locale(String locale) { + this.locale = locale; + return this; + } + + /** + * Message template locale + * @return locale + **/ + @ApiModelProperty(value = "Message template locale") + public String getLocale() { + return locale; + } + + public void setLocale(String locale) { + this.locale = locale; + } + @Override public boolean equals(java.lang.Object o) { @@ -117,13 +102,13 @@ public boolean equals(java.lang.Object o) { } CommonViewConfiguration commonViewConfiguration = (CommonViewConfiguration) o; return Objects.equals(this.autoLoginUser, commonViewConfiguration.autoLoginUser) && - Objects.equals(this.locale, commonViewConfiguration.locale) && - Objects.equals(this.noChrome, commonViewConfiguration.noChrome); + Objects.equals(this.noChrome, commonViewConfiguration.noChrome) && + Objects.equals(this.locale, commonViewConfiguration.locale); } @Override public int hashCode() { - return Objects.hash(autoLoginUser, locale, noChrome); + return Objects.hash(autoLoginUser, noChrome, locale); } @@ -133,8 +118,8 @@ public String toString() { sb.append("class CommonViewConfiguration {\n"); sb.append(" autoLoginUser: ").append(toIndentedString(autoLoginUser)).append("\n"); - sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); sb.append(" noChrome: ").append(toIndentedString(noChrome)).append("\n"); + sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/DetailedParticipantInfo.java b/src/main/java/io/swagger/client/model/widgets/DetailedParticipantInfo.java index 9204048..d17d90d 100755 --- a/src/main/java/io/swagger/client/model/widgets/DetailedParticipantInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/DetailedParticipantInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -38,138 +23,128 @@ import io.swagger.annotations.ApiModelProperty; import io.swagger.client.model.widgets.ParticipantSecurityOption; import java.io.IOException; +import java.util.Date; /** * DetailedParticipantInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class DetailedParticipantInfo { - @SerializedName("company") - private String company = null; + @SerializedName("createdDate") + private Date createdDate = null; - @SerializedName("email") - private String email = null; + @SerializedName("hidden") + private Boolean hidden = null; + + @SerializedName("name") + private String name = null; - @SerializedName("fax") - private String fax = null; + @SerializedName("self") + private Boolean self = null; + + @SerializedName("company") + private String company = null; @SerializedName("id") private String id = null; - @SerializedName("name") - private String name = null; + @SerializedName("userId") + private String userId = null; - @SerializedName("privateMessage") - private String privateMessage = null; + @SerializedName("email") + private String email = null; @SerializedName("securityOption") private ParticipantSecurityOption securityOption = null; - @SerializedName("self") - private Boolean self = null; - - /** - * The status of the participant. This cannot be changed as part of the PUT call. New participants will be ignored if added with a REPLACED status. - */ - @JsonAdapter(StatusEnum.Adapter.class) - public enum StatusEnum { - REPLACED("REPLACED"), - - ACTIVE("ACTIVE"); - - private String value; - - StatusEnum(String value) { - this.value = value; - } + public DetailedParticipantInfo createdDate(Date createdDate) { + this.createdDate = createdDate; + return this; + } - public String getValue() { - return value; - } + /** + * The date when the participant was added. This will be returned as part of GET call but is ignored if passed as part of PUT call. + * @return createdDate + **/ + @ApiModelProperty(value = "The date when the participant was added. This will be returned as part of GET call but is ignored if passed as part of PUT call.") + public Date getCreatedDate() { + return createdDate; + } - @Override - public String toString() { - return String.valueOf(value); - } + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } - public static StatusEnum fromValue(String text) { - for (StatusEnum b : StatusEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } + public DetailedParticipantInfo hidden(Boolean hidden) { + this.hidden = hidden; + return this; + } - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public StatusEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return StatusEnum.fromValue(String.valueOf(value)); - } - } + /** + * True if the agreement is hidden for the user that is calling the API. Only returned if self is true. Ignored (not required) if modifying a participant (PUT). + * @return hidden + **/ + @ApiModelProperty(value = "True if the agreement is hidden for the user that is calling the API. Only returned if self is true. Ignored (not required) if modifying a participant (PUT).") + public Boolean isHidden() { + return hidden; } - @SerializedName("status") - private StatusEnum status = null; + public void setHidden(Boolean hidden) { + this.hidden = hidden; + } - public DetailedParticipantInfo company(String company) { - this.company = company; + public DetailedParticipantInfo name(String name) { + this.name = name; return this; } /** - * The company of the participant, if available. This cannot be changed as part of the PUT call. - * @return company + * The name of the participant, if available. This cannot be changed as part of the PUT call. + * @return name **/ - @ApiModelProperty(value = "The company of the participant, if available. This cannot be changed as part of the PUT call.") - public String getCompany() { - return company; + @ApiModelProperty(value = "The name of the participant, if available. This cannot be changed as part of the PUT call.") + public String getName() { + return name; } - public void setCompany(String company) { - this.company = company; + public void setName(String name) { + this.name = name; } - public DetailedParticipantInfo email(String email) { - this.email = email; + public DetailedParticipantInfo self(Boolean self) { + this.self = self; return this; } /** - * Email of the participant. In case of modifying a participant set (PUT) this is a required field. In case of GET, this is the required field and will always be returned unless it is a fax workflow (legacy agreements) that were created using fax as input - * @return email + * True if this participant is the same user that is calling the API. Returned as part of Get. Ignored (not required) if modifying a participant set (PUT). + * @return self **/ - @ApiModelProperty(value = "Email of the participant. In case of modifying a participant set (PUT) this is a required field. In case of GET, this is the required field and will always be returned unless it is a fax workflow (legacy agreements) that were created using fax as input") - public String getEmail() { - return email; + @ApiModelProperty(value = "True if this participant is the same user that is calling the API. Returned as part of Get. Ignored (not required) if modifying a participant set (PUT).") + public Boolean isSelf() { + return self; } - public void setEmail(String email) { - this.email = email; + public void setSelf(Boolean self) { + this.self = self; } - public DetailedParticipantInfo fax(String fax) { - this.fax = fax; + public DetailedParticipantInfo company(String company) { + this.company = company; return this; } /** - * Fax of the participant. New Agreements can not be created with fax option. This is only returned for legacy agreements created with fax as participants - * @return fax + * The company of the participant, if available. This cannot be changed as part of the PUT call. + * @return company **/ - @ApiModelProperty(value = "Fax of the participant. New Agreements can not be created with fax option. This is only returned for legacy agreements created with fax as participants") - public String getFax() { - return fax; + @ApiModelProperty(value = "The company of the participant, if available. This cannot be changed as part of the PUT call.") + public String getCompany() { + return company; } - public void setFax(String fax) { - this.fax = fax; + public void setCompany(String company) { + this.company = company; } public DetailedParticipantInfo id(String id) { @@ -190,40 +165,40 @@ public void setId(String id) { this.id = id; } - public DetailedParticipantInfo name(String name) { - this.name = name; + public DetailedParticipantInfo userId(String userId) { + this.userId = userId; return this; } /** - * The name of the participant, if available. This cannot be changed as part of the PUT call. - * @return name + * The user ID of the participant. This will be returned as part of GET call but is ignored if passed as part of PUT call. + * @return userId **/ - @ApiModelProperty(value = "The name of the participant, if available. This cannot be changed as part of the PUT call.") - public String getName() { - return name; + @ApiModelProperty(value = "The user ID of the participant. This will be returned as part of GET call but is ignored if passed as part of PUT call.") + public String getUserId() { + return userId; } - public void setName(String name) { - this.name = name; + public void setUserId(String userId) { + this.userId = userId; } - public DetailedParticipantInfo privateMessage(String privateMessage) { - this.privateMessage = privateMessage; + public DetailedParticipantInfo email(String email) { + this.email = email; return this; } /** - * The private message of the participant, if available. This cannot be changed as part of the PUT call. - * @return privateMessage + * Email of the participant. In case of modifying a participant set (PUT) this is a required field. In case of GET, this is the required field and will always be returned unless it is a fax workflow (legacy agreements) that were created using fax as input + * @return email **/ - @ApiModelProperty(value = "The private message of the participant, if available. This cannot be changed as part of the PUT call.") - public String getPrivateMessage() { - return privateMessage; + @ApiModelProperty(value = "Email of the participant. In case of modifying a participant set (PUT) this is a required field. In case of GET, this is the required field and will always be returned unless it is a fax workflow (legacy agreements) that were created using fax as input") + public String getEmail() { + return email; } - public void setPrivateMessage(String privateMessage) { - this.privateMessage = privateMessage; + public void setEmail(String email) { + this.email = email; } public DetailedParticipantInfo securityOption(ParticipantSecurityOption securityOption) { @@ -244,42 +219,6 @@ public void setSecurityOption(ParticipantSecurityOption securityOption) { this.securityOption = securityOption; } - public DetailedParticipantInfo self(Boolean self) { - this.self = self; - return this; - } - - /** - * True if this participant is the same user that is calling the API. Returned as part of Get. Ignored (not required) if modifying a participant set (PUT). - * @return self - **/ - @ApiModelProperty(value = "True if this participant is the same user that is calling the API. Returned as part of Get. Ignored (not required) if modifying a participant set (PUT).") - public Boolean isSelf() { - return self; - } - - public void setSelf(Boolean self) { - this.self = self; - } - - public DetailedParticipantInfo status(StatusEnum status) { - this.status = status; - return this; - } - - /** - * The status of the participant. This cannot be changed as part of the PUT call. New participants will be ignored if added with a REPLACED status. - * @return status - **/ - @ApiModelProperty(value = "The status of the participant. This cannot be changed as part of the PUT call. New participants will be ignored if added with a REPLACED status.") - public StatusEnum getStatus() { - return status; - } - - public void setStatus(StatusEnum status) { - this.status = status; - } - @Override public boolean equals(java.lang.Object o) { @@ -290,20 +229,20 @@ public boolean equals(java.lang.Object o) { return false; } DetailedParticipantInfo detailedParticipantInfo = (DetailedParticipantInfo) o; - return Objects.equals(this.company, detailedParticipantInfo.company) && - Objects.equals(this.email, detailedParticipantInfo.email) && - Objects.equals(this.fax, detailedParticipantInfo.fax) && - Objects.equals(this.id, detailedParticipantInfo.id) && + return Objects.equals(this.createdDate, detailedParticipantInfo.createdDate) && + Objects.equals(this.hidden, detailedParticipantInfo.hidden) && Objects.equals(this.name, detailedParticipantInfo.name) && - Objects.equals(this.privateMessage, detailedParticipantInfo.privateMessage) && - Objects.equals(this.securityOption, detailedParticipantInfo.securityOption) && Objects.equals(this.self, detailedParticipantInfo.self) && - Objects.equals(this.status, detailedParticipantInfo.status); + Objects.equals(this.company, detailedParticipantInfo.company) && + Objects.equals(this.id, detailedParticipantInfo.id) && + Objects.equals(this.userId, detailedParticipantInfo.userId) && + Objects.equals(this.email, detailedParticipantInfo.email) && + Objects.equals(this.securityOption, detailedParticipantInfo.securityOption); } @Override public int hashCode() { - return Objects.hash(company, email, fax, id, name, privateMessage, securityOption, self, status); + return Objects.hash(createdDate, hidden, name, self, company, id, userId, email, securityOption); } @@ -312,15 +251,15 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DetailedParticipantInfo {\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" self: ").append(toIndentedString(self)).append("\n"); sb.append(" company: ").append(toIndentedString(company)).append("\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" fax: ").append(toIndentedString(fax)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" privateMessage: ").append(toIndentedString(privateMessage)).append("\n"); + sb.append(" userId: ").append(toIndentedString(userId)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); - sb.append(" self: ").append(toIndentedString(self)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/DetailedWidgetParticipantSetInfo.java b/src/main/java/io/swagger/client/model/widgets/DetailedWidgetParticipantSetInfo.java index d7120b4..ab8110f 100755 --- a/src/main/java/io/swagger/client/model/widgets/DetailedWidgetParticipantSetInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/DetailedWidgetParticipantSetInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -37,6 +22,7 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import io.swagger.client.model.widgets.DetailedParticipantInfo; +import io.swagger.client.model.widgets.ProviderParticipantSetInfo; import java.io.IOException; import java.util.ArrayList; import java.util.List; @@ -44,16 +30,10 @@ /** * DetailedWidgetParticipantSetInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class DetailedWidgetParticipantSetInfo { - @SerializedName("id") - private String id = null; - - @SerializedName("memberInfos") - private List memberInfos = null; - - @SerializedName("order") - private Integer order = null; + @SerializedName("providerParticipantSetInfo") + private ProviderParticipantSetInfo providerParticipantSetInfo = null; /** * Role assumed by all participants in the set (signer, approver etc.). This cannot be changed as part of the PUT call. @@ -125,6 +105,51 @@ public RoleEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("role") private RoleEnum role = null; + @SerializedName("id") + private String id = null; + + @SerializedName("memberInfos") + private List memberInfos = null; + + @SerializedName("order") + private Integer order = null; + + public DetailedWidgetParticipantSetInfo providerParticipantSetInfo(ProviderParticipantSetInfo providerParticipantSetInfo) { + this.providerParticipantSetInfo = providerParticipantSetInfo; + return this; + } + + /** + * Represents the attributes related to a unknown participant's provider. + * @return providerParticipantSetInfo + **/ + @ApiModelProperty(value = "Represents the attributes related to a unknown participant's provider.") + public ProviderParticipantSetInfo getProviderParticipantSetInfo() { + return providerParticipantSetInfo; + } + + public void setProviderParticipantSetInfo(ProviderParticipantSetInfo providerParticipantSetInfo) { + this.providerParticipantSetInfo = providerParticipantSetInfo; + } + + public DetailedWidgetParticipantSetInfo role(RoleEnum role) { + this.role = role; + return this; + } + + /** + * Role assumed by all participants in the set (signer, approver etc.). This cannot be changed as part of the PUT call. + * @return role + **/ + @ApiModelProperty(value = "Role assumed by all participants in the set (signer, approver etc.). This cannot be changed as part of the PUT call.") + public RoleEnum getRole() { + return role; + } + + public void setRole(RoleEnum role) { + this.role = role; + } + public DetailedWidgetParticipantSetInfo id(String id) { this.id = id; return this; @@ -187,24 +212,6 @@ public void setOrder(Integer order) { this.order = order; } - public DetailedWidgetParticipantSetInfo role(RoleEnum role) { - this.role = role; - return this; - } - - /** - * Role assumed by all participants in the set (signer, approver etc.). This cannot be changed as part of the PUT call. - * @return role - **/ - @ApiModelProperty(value = "Role assumed by all participants in the set (signer, approver etc.). This cannot be changed as part of the PUT call.") - public RoleEnum getRole() { - return role; - } - - public void setRole(RoleEnum role) { - this.role = role; - } - @Override public boolean equals(java.lang.Object o) { @@ -215,15 +222,16 @@ public boolean equals(java.lang.Object o) { return false; } DetailedWidgetParticipantSetInfo detailedWidgetParticipantSetInfo = (DetailedWidgetParticipantSetInfo) o; - return Objects.equals(this.id, detailedWidgetParticipantSetInfo.id) && + return Objects.equals(this.providerParticipantSetInfo, detailedWidgetParticipantSetInfo.providerParticipantSetInfo) && + Objects.equals(this.role, detailedWidgetParticipantSetInfo.role) && + Objects.equals(this.id, detailedWidgetParticipantSetInfo.id) && Objects.equals(this.memberInfos, detailedWidgetParticipantSetInfo.memberInfos) && - Objects.equals(this.order, detailedWidgetParticipantSetInfo.order) && - Objects.equals(this.role, detailedWidgetParticipantSetInfo.role); + Objects.equals(this.order, detailedWidgetParticipantSetInfo.order); } @Override public int hashCode() { - return Objects.hash(id, memberInfos, order, role); + return Objects.hash(providerParticipantSetInfo, role, id, memberInfos, order); } @@ -232,10 +240,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DetailedWidgetParticipantSetInfo {\n"); + sb.append(" providerParticipantSetInfo: ").append(toIndentedString(providerParticipantSetInfo)).append("\n"); + sb.append(" role: ").append(toIndentedString(role)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" memberInfos: ").append(toIndentedString(memberInfos)).append("\n"); sb.append(" order: ").append(toIndentedString(order)).append("\n"); - sb.append(" role: ").append(toIndentedString(role)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/DigitalSignatureInfo.java b/src/main/java/io/swagger/client/model/widgets/DigitalSignatureInfo.java index 1ac9768..3f518f0 100755 --- a/src/main/java/io/swagger/client/model/widgets/DigitalSignatureInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/DigitalSignatureInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,16 +26,34 @@ /** * DigitalSignatureInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class DigitalSignatureInfo { + @SerializedName("name") + private String name = null; + @SerializedName("company") private String company = null; @SerializedName("email") private String email = null; - @SerializedName("name") - private String name = null; + public DigitalSignatureInfo name(String name) { + this.name = name; + return this; + } + + /** + * Name captured during digital signing + * @return name + **/ + @ApiModelProperty(value = "Name captured during digital signing") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } public DigitalSignatureInfo company(String company) { this.company = company; @@ -88,24 +91,6 @@ public void setEmail(String email) { this.email = email; } - public DigitalSignatureInfo name(String name) { - this.name = name; - return this; - } - - /** - * Name captured during digital signing - * @return name - **/ - @ApiModelProperty(value = "Name captured during digital signing") - public String getName() { - return name; - } - - public void setName(String name) { - this.name = name; - } - @Override public boolean equals(java.lang.Object o) { @@ -116,14 +101,14 @@ public boolean equals(java.lang.Object o) { return false; } DigitalSignatureInfo digitalSignatureInfo = (DigitalSignatureInfo) o; - return Objects.equals(this.company, digitalSignatureInfo.company) && - Objects.equals(this.email, digitalSignatureInfo.email) && - Objects.equals(this.name, digitalSignatureInfo.name); + return Objects.equals(this.name, digitalSignatureInfo.name) && + Objects.equals(this.company, digitalSignatureInfo.company) && + Objects.equals(this.email, digitalSignatureInfo.email); } @Override public int hashCode() { - return Objects.hash(company, email, name); + return Objects.hash(name, company, email); } @@ -132,9 +117,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DigitalSignatureInfo {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" company: ").append(toIndentedString(company)).append("\n"); sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/DisplayParticipantInfo.java b/src/main/java/io/swagger/client/model/widgets/DisplayParticipantInfo.java index bb4fd69..b57f0d7 100755 --- a/src/main/java/io/swagger/client/model/widgets/DisplayParticipantInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/DisplayParticipantInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,16 +26,34 @@ /** * DisplayParticipantInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class DisplayParticipantInfo { + @SerializedName("fullName") + private String fullName = null; + @SerializedName("company") private String company = null; @SerializedName("email") private String email = null; - @SerializedName("fullName") - private String fullName = null; + public DisplayParticipantInfo fullName(String fullName) { + this.fullName = fullName; + return this; + } + + /** + * Displays the full name of the user, if available. + * @return fullName + **/ + @ApiModelProperty(value = "Displays the full name of the user, if available. ") + public String getFullName() { + return fullName; + } + + public void setFullName(String fullName) { + this.fullName = fullName; + } public DisplayParticipantInfo company(String company) { this.company = company; @@ -88,24 +91,6 @@ public void setEmail(String email) { this.email = email; } - public DisplayParticipantInfo fullName(String fullName) { - this.fullName = fullName; - return this; - } - - /** - * Displays the full name of the user, if available. - * @return fullName - **/ - @ApiModelProperty(value = "Displays the full name of the user, if available. ") - public String getFullName() { - return fullName; - } - - public void setFullName(String fullName) { - this.fullName = fullName; - } - @Override public boolean equals(java.lang.Object o) { @@ -116,14 +101,14 @@ public boolean equals(java.lang.Object o) { return false; } DisplayParticipantInfo displayParticipantInfo = (DisplayParticipantInfo) o; - return Objects.equals(this.company, displayParticipantInfo.company) && - Objects.equals(this.email, displayParticipantInfo.email) && - Objects.equals(this.fullName, displayParticipantInfo.fullName); + return Objects.equals(this.fullName, displayParticipantInfo.fullName) && + Objects.equals(this.company, displayParticipantInfo.company) && + Objects.equals(this.email, displayParticipantInfo.email); } @Override public int hashCode() { - return Objects.hash(company, email, fullName); + return Objects.hash(fullName, company, email); } @@ -132,9 +117,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DisplayParticipantInfo {\n"); + sb.append(" fullName: ").append(toIndentedString(fullName)).append("\n"); sb.append(" company: ").append(toIndentedString(company)).append("\n"); sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" fullName: ").append(toIndentedString(fullName)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/DisplayWidgetParticipantSetInfo.java b/src/main/java/io/swagger/client/model/widgets/DisplayWidgetParticipantSetInfo.java index 89cd55b..73350a4 100755 --- a/src/main/java/io/swagger/client/model/widgets/DisplayWidgetParticipantSetInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/DisplayWidgetParticipantSetInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * DisplayWidgetParticipantSetInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class DisplayWidgetParticipantSetInfo { @SerializedName("displayUserSetMemberInfos") private List displayUserSetMemberInfos = null; diff --git a/src/main/java/io/swagger/client/model/widgets/Document.java b/src/main/java/io/swagger/client/model/widgets/Document.java index bd5e7cf..d92dcae 100755 --- a/src/main/java/io/swagger/client/model/widgets/Document.java +++ b/src/main/java/io/swagger/client/model/widgets/Document.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -37,12 +22,22 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; +import java.util.Date; /** * Document */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class Document { + @SerializedName("numPages") + private Integer numPages = null; + + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("name") + private String name = null; + @SerializedName("id") private String id = null; @@ -52,11 +47,59 @@ public class Document { @SerializedName("mimeType") private String mimeType = null; - @SerializedName("name") - private String name = null; + public Document numPages(Integer numPages) { + this.numPages = numPages; + return this; + } - @SerializedName("numPages") - private Integer numPages = null; + /** + * Number of pages in the document + * @return numPages + **/ + @ApiModelProperty(value = "Number of pages in the document") + public Integer getNumPages() { + return numPages; + } + + public void setNumPages(Integer numPages) { + this.numPages = numPages; + } + + public Document createdDate(Date createdDate) { + this.createdDate = createdDate; + return this; + } + + /** + * The date the document was created + * @return createdDate + **/ + @ApiModelProperty(value = "The date the document was created") + public Date getCreatedDate() { + return createdDate; + } + + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } + + public Document name(String name) { + this.name = name; + return this; + } + + /** + * Name of the original document uploaded. This is returned in GET but not accepted back in PUT + * @return name + **/ + @ApiModelProperty(value = "Name of the original document uploaded. This is returned in GET but not accepted back in PUT") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } public Document id(String id) { this.id = id; @@ -112,42 +155,6 @@ public void setMimeType(String mimeType) { this.mimeType = mimeType; } - public Document name(String name) { - this.name = name; - return this; - } - - /** - * Name of the original document uploaded. This is returned in GET but not accepted back in PUT - * @return name - **/ - @ApiModelProperty(value = "Name of the original document uploaded. This is returned in GET but not accepted back in PUT") - public String getName() { - return name; - } - - public void setName(String name) { - this.name = name; - } - - public Document numPages(Integer numPages) { - this.numPages = numPages; - return this; - } - - /** - * Number of pages in the document - * @return numPages - **/ - @ApiModelProperty(value = "Number of pages in the document") - public Integer getNumPages() { - return numPages; - } - - public void setNumPages(Integer numPages) { - this.numPages = numPages; - } - @Override public boolean equals(java.lang.Object o) { @@ -158,16 +165,17 @@ public boolean equals(java.lang.Object o) { return false; } Document document = (Document) o; - return Objects.equals(this.id, document.id) && - Objects.equals(this.label, document.label) && - Objects.equals(this.mimeType, document.mimeType) && + return Objects.equals(this.numPages, document.numPages) && + Objects.equals(this.createdDate, document.createdDate) && Objects.equals(this.name, document.name) && - Objects.equals(this.numPages, document.numPages); + Objects.equals(this.id, document.id) && + Objects.equals(this.label, document.label) && + Objects.equals(this.mimeType, document.mimeType); } @Override public int hashCode() { - return Objects.hash(id, label, mimeType, name, numPages); + return Objects.hash(numPages, createdDate, name, id, label, mimeType); } @@ -176,11 +184,12 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class Document {\n"); + sb.append(" numPages: ").append(toIndentedString(numPages)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" label: ").append(toIndentedString(label)).append("\n"); sb.append(" mimeType: ").append(toIndentedString(mimeType)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" numPages: ").append(toIndentedString(numPages)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/DocumentImageUrls.java b/src/main/java/io/swagger/client/model/widgets/DocumentImageUrls.java index cf3c236..59e7cff 100755 --- a/src/main/java/io/swagger/client/model/widgets/DocumentImageUrls.java +++ b/src/main/java/io/swagger/client/model/widgets/DocumentImageUrls.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,8 +29,14 @@ /** * DocumentImageUrls */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class DocumentImageUrls { + @SerializedName("imageURLs") + private List imageURLs = null; + + @SerializedName("imagesAvailable") + private Boolean imagesAvailable = null; + /** * ImageSize corresponding to the imageUrl returned */ @@ -110,30 +101,6 @@ public ImageSizeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("imageSize") private ImageSizeEnum imageSize = null; - @SerializedName("imageURLs") - private List imageURLs = null; - - @SerializedName("imagesAvailable") - private Boolean imagesAvailable = null; - - public DocumentImageUrls imageSize(ImageSizeEnum imageSize) { - this.imageSize = imageSize; - return this; - } - - /** - * ImageSize corresponding to the imageUrl returned - * @return imageSize - **/ - @ApiModelProperty(value = "ImageSize corresponding to the imageUrl returned ") - public ImageSizeEnum getImageSize() { - return imageSize; - } - - public void setImageSize(ImageSizeEnum imageSize) { - this.imageSize = imageSize; - } - public DocumentImageUrls imageURLs(List imageURLs) { this.imageURLs = imageURLs; return this; @@ -178,6 +145,24 @@ public void setImagesAvailable(Boolean imagesAvailable) { this.imagesAvailable = imagesAvailable; } + public DocumentImageUrls imageSize(ImageSizeEnum imageSize) { + this.imageSize = imageSize; + return this; + } + + /** + * ImageSize corresponding to the imageUrl returned + * @return imageSize + **/ + @ApiModelProperty(value = "ImageSize corresponding to the imageUrl returned ") + public ImageSizeEnum getImageSize() { + return imageSize; + } + + public void setImageSize(ImageSizeEnum imageSize) { + this.imageSize = imageSize; + } + @Override public boolean equals(java.lang.Object o) { @@ -188,14 +173,14 @@ public boolean equals(java.lang.Object o) { return false; } DocumentImageUrls documentImageUrls = (DocumentImageUrls) o; - return Objects.equals(this.imageSize, documentImageUrls.imageSize) && - Objects.equals(this.imageURLs, documentImageUrls.imageURLs) && - Objects.equals(this.imagesAvailable, documentImageUrls.imagesAvailable); + return Objects.equals(this.imageURLs, documentImageUrls.imageURLs) && + Objects.equals(this.imagesAvailable, documentImageUrls.imagesAvailable) && + Objects.equals(this.imageSize, documentImageUrls.imageSize); } @Override public int hashCode() { - return Objects.hash(imageSize, imageURLs, imagesAvailable); + return Objects.hash(imageURLs, imagesAvailable, imageSize); } @@ -204,9 +189,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DocumentImageUrls {\n"); - sb.append(" imageSize: ").append(toIndentedString(imageSize)).append("\n"); sb.append(" imageURLs: ").append(toIndentedString(imageURLs)).append("\n"); sb.append(" imagesAvailable: ").append(toIndentedString(imagesAvailable)).append("\n"); + sb.append(" imageSize: ").append(toIndentedString(imageSize)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/DocumentImageUrlsInfo.java b/src/main/java/io/swagger/client/model/widgets/DocumentImageUrlsInfo.java index f5c449a..b58b869 100755 --- a/src/main/java/io/swagger/client/model/widgets/DocumentImageUrlsInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/DocumentImageUrlsInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,31 +29,13 @@ /** * DocumentImageUrlsInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class DocumentImageUrlsInfo { - @SerializedName("documentId") - private String documentId = null; - @SerializedName("documentImageUrlsList") private List documentImageUrlsList = null; - public DocumentImageUrlsInfo documentId(String documentId) { - this.documentId = documentId; - return this; - } - - /** - * Id of the document - * @return documentId - **/ - @ApiModelProperty(value = "Id of the document") - public String getDocumentId() { - return documentId; - } - - public void setDocumentId(String documentId) { - this.documentId = documentId; - } + @SerializedName("documentId") + private String documentId = null; public DocumentImageUrlsInfo documentImageUrlsList(List documentImageUrlsList) { this.documentImageUrlsList = documentImageUrlsList; @@ -96,6 +63,24 @@ public void setDocumentImageUrlsList(List documentImageUrlsLi this.documentImageUrlsList = documentImageUrlsList; } + public DocumentImageUrlsInfo documentId(String documentId) { + this.documentId = documentId; + return this; + } + + /** + * Id of the document + * @return documentId + **/ + @ApiModelProperty(value = "Id of the document") + public String getDocumentId() { + return documentId; + } + + public void setDocumentId(String documentId) { + this.documentId = documentId; + } + @Override public boolean equals(java.lang.Object o) { @@ -106,13 +91,13 @@ public boolean equals(java.lang.Object o) { return false; } DocumentImageUrlsInfo documentImageUrlsInfo = (DocumentImageUrlsInfo) o; - return Objects.equals(this.documentId, documentImageUrlsInfo.documentId) && - Objects.equals(this.documentImageUrlsList, documentImageUrlsInfo.documentImageUrlsList); + return Objects.equals(this.documentImageUrlsList, documentImageUrlsInfo.documentImageUrlsList) && + Objects.equals(this.documentId, documentImageUrlsInfo.documentId); } @Override public int hashCode() { - return Objects.hash(documentId, documentImageUrlsList); + return Objects.hash(documentImageUrlsList, documentId); } @@ -121,8 +106,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class DocumentImageUrlsInfo {\n"); - sb.append(" documentId: ").append(toIndentedString(documentId)).append("\n"); sb.append(" documentImageUrlsList: ").append(toIndentedString(documentImageUrlsList)).append("\n"); + sb.append(" documentId: ").append(toIndentedString(documentId)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/DocumentUrl.java b/src/main/java/io/swagger/client/model/widgets/DocumentUrl.java new file mode 100644 index 0000000..5590b5d --- /dev/null +++ b/src/main/java/io/swagger/client/model/widgets/DocumentUrl.java @@ -0,0 +1,93 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.widgets; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * DocumentUrl + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") +public class DocumentUrl { + @SerializedName("url") + private String url = null; + + public DocumentUrl url(String url) { + this.url = url; + return this; + } + + /** + * Secure URL of the document + * @return url + **/ + @ApiModelProperty(value = "Secure URL of the document") + public String getUrl() { + return url; + } + + public void setUrl(String url) { + this.url = url; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + DocumentUrl documentUrl = (DocumentUrl) o; + return Objects.equals(this.url, documentUrl.url); + } + + @Override + public int hashCode() { + return Objects.hash(url); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class DocumentUrl {\n"); + + sb.append(" url: ").append(toIndentedString(url)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/widgets/FetchedWidgetInfo.java b/src/main/java/io/swagger/client/model/widgets/FetchedWidgetInfo.java new file mode 100644 index 0000000..356a6be --- /dev/null +++ b/src/main/java/io/swagger/client/model/widgets/FetchedWidgetInfo.java @@ -0,0 +1,646 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.widgets; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.widgets.FileInfo; +import io.swagger.client.model.widgets.SecurityOption; +import io.swagger.client.model.widgets.VaultingInfo; +import io.swagger.client.model.widgets.WidgetAdditionalParticipationSetInfo; +import io.swagger.client.model.widgets.WidgetCcInfo; +import io.swagger.client.model.widgets.WidgetInActiveInfo; +import io.swagger.client.model.widgets.WidgetParticipantSetInfo; +import io.swagger.client.model.widgets.WidgetRedirectionInfo; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +/** + * FetchedWidgetInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") +public class FetchedWidgetInfo { + @SerializedName("additionalParticipantSetsInfo") + private List additionalParticipantSetsInfo = null; + + @SerializedName("creatorEmail") + private String creatorEmail = null; + + @SerializedName("groupId") + private String groupId = null; + + @SerializedName("locale") + private String locale = null; + + @SerializedName("vaultingInfo") + private VaultingInfo vaultingInfo = null; + + @SerializedName("securityOption") + private SecurityOption securityOption = null; + + @SerializedName("widgetParticipantSetInfo") + private WidgetParticipantSetInfo widgetParticipantSetInfo = null; + + @SerializedName("widgetInActiveInfo") + private WidgetInActiveInfo widgetInActiveInfo = null; + + @SerializedName("ccs") + private List ccs = null; + + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("isDocumentRetentionApplied") + private Boolean isDocumentRetentionApplied = null; + + @SerializedName("lastEventDate") + private Date lastEventDate = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("completionInfo") + private WidgetRedirectionInfo completionInfo = null; + + @SerializedName("authFailureInfo") + private WidgetRedirectionInfo authFailureInfo = null; + + @SerializedName("fileInfos") + private List fileInfos = null; + + @SerializedName("id") + private String id = null; + + /** + * The state in which the web form should land. For example in order to create a web form in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the web form can be obtained from GET /widgets/ID + */ + @JsonAdapter(StateEnum.Adapter.class) + public enum StateEnum { + DRAFT("DRAFT"), + + ACTIVE("ACTIVE"), + + AUTHORING("AUTHORING"); + + private String value; + + StateEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static StateEnum fromValue(String text) { + for (StateEnum b : StateEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public StateEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return StateEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("state") + private StateEnum state = null; + + /** + * Status of the Web Form. If provided in POST, it will simply be ignored + */ + @JsonAdapter(StatusEnum.Adapter.class) + public enum StatusEnum { + DRAFT("DRAFT"), + + AUTHORING("AUTHORING"), + + ACTIVE("ACTIVE"), + + DOCUMENTS_NOT_YET_PROCESSED("DOCUMENTS_NOT_YET_PROCESSED"), + + DISABLED("DISABLED"), + + DISCARDED("DISCARDED"); + + private String value; + + StatusEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static StatusEnum fromValue(String text) { + for (StatusEnum b : StatusEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public StatusEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return StatusEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("status") + private StatusEnum status = null; + + public FetchedWidgetInfo additionalParticipantSetsInfo(List additionalParticipantSetsInfo) { + this.additionalParticipantSetsInfo = additionalParticipantSetsInfo; + return this; + } + + public FetchedWidgetInfo addAdditionalParticipantSetsInfoItem(WidgetAdditionalParticipationSetInfo additionalParticipantSetsInfoItem) { + if (this.additionalParticipantSetsInfo == null) { + this.additionalParticipantSetsInfo = new ArrayList(); + } + this.additionalParticipantSetsInfo.add(additionalParticipantSetsInfoItem); + return this; + } + + /** + * List of all the participants in the web form except web form signer + * @return additionalParticipantSetsInfo + **/ + @ApiModelProperty(value = "List of all the participants in the web form except web form signer") + public List getAdditionalParticipantSetsInfo() { + return additionalParticipantSetsInfo; + } + + public void setAdditionalParticipantSetsInfo(List additionalParticipantSetsInfo) { + this.additionalParticipantSetsInfo = additionalParticipantSetsInfo; + } + + public FetchedWidgetInfo creatorEmail(String creatorEmail) { + this.creatorEmail = creatorEmail; + return this; + } + + /** + * Email of web form creator. Only returned in GET response. Cannot be provided in POST/PUT request. If provided in POST, it will simply be ignored + * @return creatorEmail + **/ + @ApiModelProperty(value = "Email of web form creator. Only returned in GET response. Cannot be provided in POST/PUT request. If provided in POST, it will simply be ignored") + public String getCreatorEmail() { + return creatorEmail; + } + + public void setCreatorEmail(String creatorEmail) { + this.creatorEmail = creatorEmail; + } + + public FetchedWidgetInfo groupId(String groupId) { + this.groupId = groupId; + return this; + } + + /** + * The ID of the group to which the widget belongs to. If not provided during creation, primary group of the creator will be used + * @return groupId + **/ + @ApiModelProperty(value = "The ID of the group to which the widget belongs to. If not provided during creation, primary group of the creator will be used") + public String getGroupId() { + return groupId; + } + + public void setGroupId(String groupId) { + this.groupId = groupId; + } + + public FetchedWidgetInfo locale(String locale) { + this.locale = locale; + return this; + } + + /** + * The locale associated with this web form - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the web form creator + * @return locale + **/ + @ApiModelProperty(value = "The locale associated with this web form - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the web form creator") + public String getLocale() { + return locale; + } + + public void setLocale(String locale) { + this.locale = locale; + } + + public FetchedWidgetInfo vaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; + return this; + } + + /** + * Vaulting properties that allows Adobe Sign to securely store documents with a vault provider + * @return vaultingInfo + **/ + @ApiModelProperty(value = "Vaulting properties that allows Adobe Sign to securely store documents with a vault provider") + public VaultingInfo getVaultingInfo() { + return vaultingInfo; + } + + public void setVaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; + } + + public FetchedWidgetInfo securityOption(SecurityOption securityOption) { + this.securityOption = securityOption; + return this; + } + + /** + * Secondary security parameters for the web form + * @return securityOption + **/ + @ApiModelProperty(value = "Secondary security parameters for the web form") + public SecurityOption getSecurityOption() { + return securityOption; + } + + public void setSecurityOption(SecurityOption securityOption) { + this.securityOption = securityOption; + } + + public FetchedWidgetInfo widgetParticipantSetInfo(WidgetParticipantSetInfo widgetParticipantSetInfo) { + this.widgetParticipantSetInfo = widgetParticipantSetInfo; + return this; + } + + /** + * Represents web form participant for whom email should not be provided + * @return widgetParticipantSetInfo + **/ + @ApiModelProperty(value = "Represents web form participant for whom email should not be provided") + public WidgetParticipantSetInfo getWidgetParticipantSetInfo() { + return widgetParticipantSetInfo; + } + + public void setWidgetParticipantSetInfo(WidgetParticipantSetInfo widgetParticipantSetInfo) { + this.widgetParticipantSetInfo = widgetParticipantSetInfo; + } + + public FetchedWidgetInfo widgetInActiveInfo(WidgetInActiveInfo widgetInActiveInfo) { + this.widgetInActiveInfo = widgetInActiveInfo; + return this; + } + + /** + * The custom message which will be displayed to the user or the URL to which user will be redirected when the web form is accessed in a disabled state. This can only be specified in PUT request + * @return widgetInActiveInfo + **/ + @ApiModelProperty(value = "The custom message which will be displayed to the user or the URL to which user will be redirected when the web form is accessed in a disabled state. This can only be specified in PUT request") + public WidgetInActiveInfo getWidgetInActiveInfo() { + return widgetInActiveInfo; + } + + public void setWidgetInActiveInfo(WidgetInActiveInfo widgetInActiveInfo) { + this.widgetInActiveInfo = widgetInActiveInfo; + } + + public FetchedWidgetInfo ccs(List ccs) { + this.ccs = ccs; + return this; + } + + public FetchedWidgetInfo addCcsItem(WidgetCcInfo ccsItem) { + if (this.ccs == null) { + this.ccs = new ArrayList(); + } + this.ccs.add(ccsItem); + return this; + } + + /** + * A list of one or more email addresses that you want to copy on this transaction. The email addresses will each receive an email when the final agreement created through web form is signed. The email addresses will also receive a copy of the document, attached as a PDF file + * @return ccs + **/ + @ApiModelProperty(value = "A list of one or more email addresses that you want to copy on this transaction. The email addresses will each receive an email when the final agreement created through web form is signed. The email addresses will also receive a copy of the document, attached as a PDF file") + public List getCcs() { + return ccs; + } + + public void setCcs(List ccs) { + this.ccs = ccs; + } + + public FetchedWidgetInfo createdDate(Date createdDate) { + this.createdDate = createdDate; + return this; + } + + /** + * Date when web form was created. If provided in POST, it will simply be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return createdDate + **/ + @ApiModelProperty(value = "Date when web form was created. If provided in POST, it will simply be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getCreatedDate() { + return createdDate; + } + + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; + } + + public FetchedWidgetInfo isDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; + return this; + } + + /** + * Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. + * @return isDocumentRetentionApplied + **/ + @ApiModelProperty(value = "Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored.") + public Boolean isIsDocumentRetentionApplied() { + return isDocumentRetentionApplied; + } + + public void setIsDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; + } + + public FetchedWidgetInfo lastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; + return this; + } + + /** + * The date of the last event that occurred for this web form. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return lastEventDate + **/ + @ApiModelProperty(value = "The date of the last event that occurred for this web form. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getLastEventDate() { + return lastEventDate; + } + + public void setLastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; + } + + public FetchedWidgetInfo name(String name) { + this.name = name; + return this; + } + + /** + * The name of the web form that will be used to identify it, in emails, website and other places + * @return name + **/ + @ApiModelProperty(value = "The name of the web form that will be used to identify it, in emails, website and other places") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public FetchedWidgetInfo completionInfo(WidgetRedirectionInfo completionInfo) { + this.completionInfo = completionInfo; + return this; + } + + /** + * URL and associated properties for the success page the web form signer will be taken to after performing desired action on the web form + * @return completionInfo + **/ + @ApiModelProperty(value = "URL and associated properties for the success page the web form signer will be taken to after performing desired action on the web form") + public WidgetRedirectionInfo getCompletionInfo() { + return completionInfo; + } + + public void setCompletionInfo(WidgetRedirectionInfo completionInfo) { + this.completionInfo = completionInfo; + } + + public FetchedWidgetInfo authFailureInfo(WidgetRedirectionInfo authFailureInfo) { + this.authFailureInfo = authFailureInfo; + return this; + } + + /** + * URL and associated properties for the error page the web form signer will be taken after failing to authenticate + * @return authFailureInfo + **/ + @ApiModelProperty(value = "URL and associated properties for the error page the web form signer will be taken after failing to authenticate") + public WidgetRedirectionInfo getAuthFailureInfo() { + return authFailureInfo; + } + + public void setAuthFailureInfo(WidgetRedirectionInfo authFailureInfo) { + this.authFailureInfo = authFailureInfo; + } + + public FetchedWidgetInfo fileInfos(List fileInfos) { + this.fileInfos = fileInfos; + return this; + } + + public FetchedWidgetInfo addFileInfosItem(FileInfo fileInfosItem) { + if (this.fileInfos == null) { + this.fileInfos = new ArrayList(); + } + this.fileInfos.add(fileInfosItem); + return this; + } + + /** + * A list of one or more files (or references to files) that will be used to create the web form. If more than one file is provided, they will be combined before the web form is created. Library documents are not permitted. Note: Only one of the four parameters in every FileInfo object must be specified + * @return fileInfos + **/ + @ApiModelProperty(value = "A list of one or more files (or references to files) that will be used to create the web form. If more than one file is provided, they will be combined before the web form is created. Library documents are not permitted. Note: Only one of the four parameters in every FileInfo object must be specified") + public List getFileInfos() { + return fileInfos; + } + + public void setFileInfos(List fileInfos) { + this.fileInfos = fileInfos; + } + + public FetchedWidgetInfo id(String id) { + this.id = id; + return this; + } + + /** + * A resource identifier that can be used to uniquely identify the web form in other apis. If provided in POST, it will simply be ignored + * @return id + **/ + @ApiModelProperty(value = "A resource identifier that can be used to uniquely identify the web form in other apis. If provided in POST, it will simply be ignored") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public FetchedWidgetInfo state(StateEnum state) { + this.state = state; + return this; + } + + /** + * The state in which the web form should land. For example in order to create a web form in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the web form can be obtained from GET /widgets/ID + * @return state + **/ + @ApiModelProperty(value = "The state in which the web form should land. For example in order to create a web form in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the web form can be obtained from GET /widgets/ID") + public StateEnum getState() { + return state; + } + + public void setState(StateEnum state) { + this.state = state; + } + + public FetchedWidgetInfo status(StatusEnum status) { + this.status = status; + return this; + } + + /** + * Status of the Web Form. If provided in POST, it will simply be ignored + * @return status + **/ + @ApiModelProperty(value = "Status of the Web Form. If provided in POST, it will simply be ignored") + public StatusEnum getStatus() { + return status; + } + + public void setStatus(StatusEnum status) { + this.status = status; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FetchedWidgetInfo fetchedWidgetInfo = (FetchedWidgetInfo) o; + return Objects.equals(this.additionalParticipantSetsInfo, fetchedWidgetInfo.additionalParticipantSetsInfo) && + Objects.equals(this.creatorEmail, fetchedWidgetInfo.creatorEmail) && + Objects.equals(this.groupId, fetchedWidgetInfo.groupId) && + Objects.equals(this.locale, fetchedWidgetInfo.locale) && + Objects.equals(this.vaultingInfo, fetchedWidgetInfo.vaultingInfo) && + Objects.equals(this.securityOption, fetchedWidgetInfo.securityOption) && + Objects.equals(this.widgetParticipantSetInfo, fetchedWidgetInfo.widgetParticipantSetInfo) && + Objects.equals(this.widgetInActiveInfo, fetchedWidgetInfo.widgetInActiveInfo) && + Objects.equals(this.ccs, fetchedWidgetInfo.ccs) && + Objects.equals(this.createdDate, fetchedWidgetInfo.createdDate) && + Objects.equals(this.isDocumentRetentionApplied, fetchedWidgetInfo.isDocumentRetentionApplied) && + Objects.equals(this.lastEventDate, fetchedWidgetInfo.lastEventDate) && + Objects.equals(this.name, fetchedWidgetInfo.name) && + Objects.equals(this.completionInfo, fetchedWidgetInfo.completionInfo) && + Objects.equals(this.authFailureInfo, fetchedWidgetInfo.authFailureInfo) && + Objects.equals(this.fileInfos, fetchedWidgetInfo.fileInfos) && + Objects.equals(this.id, fetchedWidgetInfo.id) && + Objects.equals(this.state, fetchedWidgetInfo.state) && + Objects.equals(this.status, fetchedWidgetInfo.status); + } + + @Override + public int hashCode() { + return Objects.hash(additionalParticipantSetsInfo, creatorEmail, groupId, locale, vaultingInfo, securityOption, widgetParticipantSetInfo, widgetInActiveInfo, ccs, createdDate, isDocumentRetentionApplied, lastEventDate, name, completionInfo, authFailureInfo, fileInfos, id, state, status); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FetchedWidgetInfo {\n"); + + sb.append(" additionalParticipantSetsInfo: ").append(toIndentedString(additionalParticipantSetsInfo)).append("\n"); + sb.append(" creatorEmail: ").append(toIndentedString(creatorEmail)).append("\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); + sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); + sb.append(" vaultingInfo: ").append(toIndentedString(vaultingInfo)).append("\n"); + sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); + sb.append(" widgetParticipantSetInfo: ").append(toIndentedString(widgetParticipantSetInfo)).append("\n"); + sb.append(" widgetInActiveInfo: ").append(toIndentedString(widgetInActiveInfo)).append("\n"); + sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" isDocumentRetentionApplied: ").append(toIndentedString(isDocumentRetentionApplied)).append("\n"); + sb.append(" lastEventDate: ").append(toIndentedString(lastEventDate)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" completionInfo: ").append(toIndentedString(completionInfo)).append("\n"); + sb.append(" authFailureInfo: ").append(toIndentedString(authFailureInfo)).append("\n"); + sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" state: ").append(toIndentedString(state)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/widgets/FileInfo.java b/src/main/java/io/swagger/client/model/widgets/FileInfo.java index fe72821..fd67b5f 100755 --- a/src/main/java/io/swagger/client/model/widgets/FileInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/FileInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -43,51 +28,51 @@ /** * FileInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class FileInfo { - @SerializedName("document") - private Document document = null; - @SerializedName("transientDocumentId") private String transientDocumentId = null; + @SerializedName("document") + private Document document = null; + @SerializedName("urlFileInfo") private URLFileInfo urlFileInfo = null; - public FileInfo document(Document document) { - this.document = document; + public FileInfo transientDocumentId(String transientDocumentId) { + this.transientDocumentId = transientDocumentId; return this; } /** - * A document that is associated with the widget. This field cannot be provided in POST call. In case of GET call, this is the only field returned in the response - * @return document + * ID for a transient document that will be added to the web form + * @return transientDocumentId **/ - @ApiModelProperty(value = "A document that is associated with the widget. This field cannot be provided in POST call. In case of GET call, this is the only field returned in the response") - public Document getDocument() { - return document; + @ApiModelProperty(value = "ID for a transient document that will be added to the web form") + public String getTransientDocumentId() { + return transientDocumentId; } - public void setDocument(Document document) { - this.document = document; + public void setTransientDocumentId(String transientDocumentId) { + this.transientDocumentId = transientDocumentId; } - public FileInfo transientDocumentId(String transientDocumentId) { - this.transientDocumentId = transientDocumentId; + public FileInfo document(Document document) { + this.document = document; return this; } /** - * ID for a transient document that will be added to the widget - * @return transientDocumentId + * A document that is associated with the web form. This field cannot be provided in POST call. In case of GET call, this is the only field returned in the response + * @return document **/ - @ApiModelProperty(value = "ID for a transient document that will be added to the widget") - public String getTransientDocumentId() { - return transientDocumentId; + @ApiModelProperty(value = "A document that is associated with the web form. This field cannot be provided in POST call. In case of GET call, this is the only field returned in the response") + public Document getDocument() { + return document; } - public void setTransientDocumentId(String transientDocumentId) { - this.transientDocumentId = transientDocumentId; + public void setDocument(Document document) { + this.document = document; } public FileInfo urlFileInfo(URLFileInfo urlFileInfo) { @@ -118,14 +103,14 @@ public boolean equals(java.lang.Object o) { return false; } FileInfo fileInfo = (FileInfo) o; - return Objects.equals(this.document, fileInfo.document) && - Objects.equals(this.transientDocumentId, fileInfo.transientDocumentId) && + return Objects.equals(this.transientDocumentId, fileInfo.transientDocumentId) && + Objects.equals(this.document, fileInfo.document) && Objects.equals(this.urlFileInfo, fileInfo.urlFileInfo); } @Override public int hashCode() { - return Objects.hash(document, transientDocumentId, urlFileInfo); + return Objects.hash(transientDocumentId, document, urlFileInfo); } @@ -134,8 +119,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class FileInfo {\n"); - sb.append(" document: ").append(toIndentedString(document)).append("\n"); sb.append(" transientDocumentId: ").append(toIndentedString(transientDocumentId)).append("\n"); + sb.append(" document: ").append(toIndentedString(document)).append("\n"); sb.append(" urlFileInfo: ").append(toIndentedString(urlFileInfo)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/widgets/MyAgreementInfo.java b/src/main/java/io/swagger/client/model/widgets/MyAgreementInfo.java new file mode 100644 index 0000000..180a919 --- /dev/null +++ b/src/main/java/io/swagger/client/model/widgets/MyAgreementInfo.java @@ -0,0 +1,104 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.widgets; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.widgets.AccountSharerInfo; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * MyAgreementInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") +public class MyAgreementInfo { + @SerializedName("accountSharers") + private List accountSharers = null; + + public MyAgreementInfo accountSharers(List accountSharers) { + this.accountSharers = accountSharers; + return this; + } + + public MyAgreementInfo addAccountSharersItem(AccountSharerInfo accountSharersItem) { + if (this.accountSharers == null) { + this.accountSharers = new ArrayList(); + } + this.accountSharers.add(accountSharersItem); + return this; + } + + /** + * A list of account sharer in relation to the api caller and this resource. + * @return accountSharers + **/ + @ApiModelProperty(value = "A list of account sharer in relation to the api caller and this resource.") + public List getAccountSharers() { + return accountSharers; + } + + public void setAccountSharers(List accountSharers) { + this.accountSharers = accountSharers; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + MyAgreementInfo myAgreementInfo = (MyAgreementInfo) o; + return Objects.equals(this.accountSharers, myAgreementInfo.accountSharers); + } + + @Override + public int hashCode() { + return Objects.hash(accountSharers); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class MyAgreementInfo {\n"); + + sb.append(" accountSharers: ").append(toIndentedString(accountSharers)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/widgets/Note.java b/src/main/java/io/swagger/client/model/widgets/Note.java index 17de58e..f088a36 100755 --- a/src/main/java/io/swagger/client/model/widgets/Note.java +++ b/src/main/java/io/swagger/client/model/widgets/Note.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * Note */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class Note { @SerializedName("note") private String note = null; diff --git a/src/main/java/io/swagger/client/model/widgets/PageImageUrl.java b/src/main/java/io/swagger/client/model/widgets/PageImageUrl.java index 00b3508..d97f149 100755 --- a/src/main/java/io/swagger/client/model/widgets/PageImageUrl.java +++ b/src/main/java/io/swagger/client/model/widgets/PageImageUrl.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * PageImageUrl */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class PageImageUrl { @SerializedName("pageNumber") private Integer pageNumber = null; diff --git a/src/main/java/io/swagger/client/model/widgets/PageInfo.java b/src/main/java/io/swagger/client/model/widgets/PageInfo.java index e42de99..cb38608 100755 --- a/src/main/java/io/swagger/client/model/widgets/PageInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/PageInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * PageInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class PageInfo { @SerializedName("nextCursor") private String nextCursor = null; diff --git a/src/main/java/io/swagger/client/model/widgets/ParticipantSecurityOption.java b/src/main/java/io/swagger/client/model/widgets/ParticipantSecurityOption.java index c7edc65..0372bef 100755 --- a/src/main/java/io/swagger/client/model/widgets/ParticipantSecurityOption.java +++ b/src/main/java/io/swagger/client/model/widgets/ParticipantSecurityOption.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,10 +27,13 @@ /** * ParticipantSecurityOption */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class ParticipantSecurityOption { + @SerializedName("password") + private String password = null; + /** - * The authentication method for the participants to have access to view and sign the document. When replacing a participant that has PASSWORD or PHONE authentication specified, you must supply a password or phone number for the new participant, and you cannot change the authentication method + * The authentication method for the participants to have access to view and sign the document. When replacing a participant that has PASSWORD or PHONE authentication specified, you must supply a password or phone number for the new participant, and you cannot change the authentication method. For unknown participants, only email based authentication is allowed. Hence, only ‘NONE’ authenticaiton method is permitted */ @JsonAdapter(AuthenticationMethodEnum.Adapter.class) public enum AuthenticationMethodEnum { @@ -104,30 +92,9 @@ public AuthenticationMethodEnum read(final JsonReader jsonReader) throws IOExcep @SerializedName("authenticationMethod") private AuthenticationMethodEnum authenticationMethod = null; - @SerializedName("password") - private String password = null; - @SerializedName("phoneInfo") private PhoneInfo phoneInfo = null; - public ParticipantSecurityOption authenticationMethod(AuthenticationMethodEnum authenticationMethod) { - this.authenticationMethod = authenticationMethod; - return this; - } - - /** - * The authentication method for the participants to have access to view and sign the document. When replacing a participant that has PASSWORD or PHONE authentication specified, you must supply a password or phone number for the new participant, and you cannot change the authentication method - * @return authenticationMethod - **/ - @ApiModelProperty(value = "The authentication method for the participants to have access to view and sign the document. When replacing a participant that has PASSWORD or PHONE authentication specified, you must supply a password or phone number for the new participant, and you cannot change the authentication method") - public AuthenticationMethodEnum getAuthenticationMethod() { - return authenticationMethod; - } - - public void setAuthenticationMethod(AuthenticationMethodEnum authenticationMethod) { - this.authenticationMethod = authenticationMethod; - } - public ParticipantSecurityOption password(String password) { this.password = password; return this; @@ -146,6 +113,24 @@ public void setPassword(String password) { this.password = password; } + public ParticipantSecurityOption authenticationMethod(AuthenticationMethodEnum authenticationMethod) { + this.authenticationMethod = authenticationMethod; + return this; + } + + /** + * The authentication method for the participants to have access to view and sign the document. When replacing a participant that has PASSWORD or PHONE authentication specified, you must supply a password or phone number for the new participant, and you cannot change the authentication method. For unknown participants, only email based authentication is allowed. Hence, only ‘NONE’ authenticaiton method is permitted + * @return authenticationMethod + **/ + @ApiModelProperty(value = "The authentication method for the participants to have access to view and sign the document. When replacing a participant that has PASSWORD or PHONE authentication specified, you must supply a password or phone number for the new participant, and you cannot change the authentication method. For unknown participants, only email based authentication is allowed. Hence, only ‘NONE’ authenticaiton method is permitted") + public AuthenticationMethodEnum getAuthenticationMethod() { + return authenticationMethod; + } + + public void setAuthenticationMethod(AuthenticationMethodEnum authenticationMethod) { + this.authenticationMethod = authenticationMethod; + } + public ParticipantSecurityOption phoneInfo(PhoneInfo phoneInfo) { this.phoneInfo = phoneInfo; return this; @@ -174,14 +159,14 @@ public boolean equals(java.lang.Object o) { return false; } ParticipantSecurityOption participantSecurityOption = (ParticipantSecurityOption) o; - return Objects.equals(this.authenticationMethod, participantSecurityOption.authenticationMethod) && - Objects.equals(this.password, participantSecurityOption.password) && + return Objects.equals(this.password, participantSecurityOption.password) && + Objects.equals(this.authenticationMethod, participantSecurityOption.authenticationMethod) && Objects.equals(this.phoneInfo, participantSecurityOption.phoneInfo); } @Override public int hashCode() { - return Objects.hash(authenticationMethod, password, phoneInfo); + return Objects.hash(password, authenticationMethod, phoneInfo); } @@ -190,8 +175,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ParticipantSecurityOption {\n"); - sb.append(" authenticationMethod: ").append(toIndentedString(authenticationMethod)).append("\n"); sb.append(" password: ").append(toIndentedString(password)).append("\n"); + sb.append(" authenticationMethod: ").append(toIndentedString(authenticationMethod)).append("\n"); sb.append(" phoneInfo: ").append(toIndentedString(phoneInfo)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/widgets/ParticipantSetMemberInfo.java b/src/main/java/io/swagger/client/model/widgets/ParticipantSetMemberInfo.java index f7003d3..e4fc758 100755 --- a/src/main/java/io/swagger/client/model/widgets/ParticipantSetMemberInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/ParticipantSetMemberInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,24 +27,45 @@ /** * ParticipantSetMemberInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class ParticipantSetMemberInfo { + @SerializedName("id") + private String id = null; + @SerializedName("email") private String email = null; @SerializedName("securityOption") private ParticipantSecurityOption securityOption = null; + public ParticipantSetMemberInfo id(String id) { + this.id = id; + return this; + } + + /** + * The unique identifier of the participant. This will be ignored as part of POST or PUT calls. The Id might be null in draft state + * @return id + **/ + @ApiModelProperty(value = "The unique identifier of the participant. This will be ignored as part of POST or PUT calls. The Id might be null in draft state") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + public ParticipantSetMemberInfo email(String email) { this.email = email; return this; } /** - * Email of the participant + * Email of the participant. It should be blank for the unknown participants. * @return email **/ - @ApiModelProperty(value = "Email of the participant") + @ApiModelProperty(value = "Email of the participant. It should be blank for the unknown participants.") public String getEmail() { return email; } @@ -96,13 +102,14 @@ public boolean equals(java.lang.Object o) { return false; } ParticipantSetMemberInfo participantSetMemberInfo = (ParticipantSetMemberInfo) o; - return Objects.equals(this.email, participantSetMemberInfo.email) && + return Objects.equals(this.id, participantSetMemberInfo.id) && + Objects.equals(this.email, participantSetMemberInfo.email) && Objects.equals(this.securityOption, participantSetMemberInfo.securityOption); } @Override public int hashCode() { - return Objects.hash(email, securityOption); + return Objects.hash(id, email, securityOption); } @@ -111,6 +118,7 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ParticipantSetMemberInfo {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); sb.append("}"); diff --git a/src/main/java/io/swagger/client/model/widgets/PersonalizedSigningViewConfiguration.java b/src/main/java/io/swagger/client/model/widgets/PersonalizedSigningViewConfiguration.java new file mode 100644 index 0000000..62081e6 --- /dev/null +++ b/src/main/java/io/swagger/client/model/widgets/PersonalizedSigningViewConfiguration.java @@ -0,0 +1,163 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.widgets; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.Date; + +/** + * PersonalizedSigningViewConfiguration + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") +public class PersonalizedSigningViewConfiguration { + @SerializedName("comment") + private String comment = null; + + @SerializedName("expiration") + private Date expiration = null; + + @SerializedName("email") + private String email = null; + + @SerializedName("reusable") + private Boolean reusable = null; + + public PersonalizedSigningViewConfiguration comment(String comment) { + this.comment = comment; + return this; + } + + /** + * Comment describing how the API caller established the signer's identity - will appear in the audit trail + * @return comment + **/ + @ApiModelProperty(value = "Comment describing how the API caller established the signer's identity - will appear in the audit trail") + public String getComment() { + return comment; + } + + public void setComment(String comment) { + this.comment = comment; + } + + public PersonalizedSigningViewConfiguration expiration(Date expiration) { + this.expiration = expiration; + return this; + } + + /** + * Expiration date for the personalization of this web form. After this date, the identity of the signer will not be assumed by Adobe Sign. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2022-02-25T18:46:19Z represents UTC time + * @return expiration + **/ + @ApiModelProperty(value = "Expiration date for the personalization of this web form. After this date, the identity of the signer will not be assumed by Adobe Sign. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2022-02-25T18:46:19Z represents UTC time") + public Date getExpiration() { + return expiration; + } + + public void setExpiration(Date expiration) { + this.expiration = expiration; + } + + public PersonalizedSigningViewConfiguration email(String email) { + this.email = email; + return this; + } + + /** + * The email address of the person who will be receiving this web form + * @return email + **/ + @ApiModelProperty(value = "The email address of the person who will be receiving this web form") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + public PersonalizedSigningViewConfiguration reusable(Boolean reusable) { + this.reusable = reusable; + return this; + } + + /** + * Should the intended signer be allowed to sign this web form more than once + * @return reusable + **/ + @ApiModelProperty(value = "Should the intended signer be allowed to sign this web form more than once") + public Boolean isReusable() { + return reusable; + } + + public void setReusable(Boolean reusable) { + this.reusable = reusable; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PersonalizedSigningViewConfiguration personalizedSigningViewConfiguration = (PersonalizedSigningViewConfiguration) o; + return Objects.equals(this.comment, personalizedSigningViewConfiguration.comment) && + Objects.equals(this.expiration, personalizedSigningViewConfiguration.expiration) && + Objects.equals(this.email, personalizedSigningViewConfiguration.email) && + Objects.equals(this.reusable, personalizedSigningViewConfiguration.reusable); + } + + @Override + public int hashCode() { + return Objects.hash(comment, expiration, email, reusable); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PersonalizedSigningViewConfiguration {\n"); + + sb.append(" comment: ").append(toIndentedString(comment)).append("\n"); + sb.append(" expiration: ").append(toIndentedString(expiration)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append(" reusable: ").append(toIndentedString(reusable)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/widgets/PhoneInfo.java b/src/main/java/io/swagger/client/model/widgets/PhoneInfo.java index ce83002..202f5a5 100755 --- a/src/main/java/io/swagger/client/model/widgets/PhoneInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/PhoneInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,30 +26,33 @@ /** * PhoneInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class PhoneInfo { - @SerializedName("countryCode") - private String countryCode = null; + @SerializedName("countryIsoCode") + private String countryIsoCode = null; @SerializedName("phone") private String phone = null; - public PhoneInfo countryCode(String countryCode) { - this.countryCode = countryCode; + @SerializedName("countryCode") + private String countryCode = null; + + public PhoneInfo countryIsoCode(String countryIsoCode) { + this.countryIsoCode = countryIsoCode; return this; } /** - * The numeric country calling code (ISD code) required for the participant to view and sign the document if authentication type is PHONE - * @return countryCode + * The country ISO Alpha-2 code required for the participant to view and sign the document if authentication method is PHONE + * @return countryIsoCode **/ - @ApiModelProperty(value = "The numeric country calling code (ISD code) required for the participant to view and sign the document if authentication type is PHONE") - public String getCountryCode() { - return countryCode; + @ApiModelProperty(value = "The country ISO Alpha-2 code required for the participant to view and sign the document if authentication method is PHONE") + public String getCountryIsoCode() { + return countryIsoCode; } - public void setCountryCode(String countryCode) { - this.countryCode = countryCode; + public void setCountryIsoCode(String countryIsoCode) { + this.countryIsoCode = countryIsoCode; } public PhoneInfo phone(String phone) { @@ -85,6 +73,24 @@ public void setPhone(String phone) { this.phone = phone; } + public PhoneInfo countryCode(String countryCode) { + this.countryCode = countryCode; + return this; + } + + /** + * The numeric country calling code (ISD code) required for the participant to view and sign the document if authentication type is PHONE + * @return countryCode + **/ + @ApiModelProperty(value = "The numeric country calling code (ISD code) required for the participant to view and sign the document if authentication type is PHONE") + public String getCountryCode() { + return countryCode; + } + + public void setCountryCode(String countryCode) { + this.countryCode = countryCode; + } + @Override public boolean equals(java.lang.Object o) { @@ -95,13 +101,14 @@ public boolean equals(java.lang.Object o) { return false; } PhoneInfo phoneInfo = (PhoneInfo) o; - return Objects.equals(this.countryCode, phoneInfo.countryCode) && - Objects.equals(this.phone, phoneInfo.phone); + return Objects.equals(this.countryIsoCode, phoneInfo.countryIsoCode) && + Objects.equals(this.phone, phoneInfo.phone) && + Objects.equals(this.countryCode, phoneInfo.countryCode); } @Override public int hashCode() { - return Objects.hash(countryCode, phone); + return Objects.hash(countryIsoCode, phone, countryCode); } @@ -110,8 +117,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class PhoneInfo {\n"); - sb.append(" countryCode: ").append(toIndentedString(countryCode)).append("\n"); + sb.append(" countryIsoCode: ").append(toIndentedString(countryIsoCode)).append("\n"); sb.append(" phone: ").append(toIndentedString(phone)).append("\n"); + sb.append(" countryCode: ").append(toIndentedString(countryCode)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/ProviderParticipantSetInfo.java b/src/main/java/io/swagger/client/model/widgets/ProviderParticipantSetInfo.java new file mode 100644 index 0000000..c7e6019 --- /dev/null +++ b/src/main/java/io/swagger/client/model/widgets/ProviderParticipantSetInfo.java @@ -0,0 +1,116 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.widgets; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * ProviderParticipantSetInfo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") +public class ProviderParticipantSetInfo { + @SerializedName("actionRequired") + private Boolean actionRequired = null; + + @SerializedName("actionDescription") + private String actionDescription = null; + + public ProviderParticipantSetInfo actionRequired(Boolean actionRequired) { + this.actionRequired = actionRequired; + return this; + } + + /** + * It indicates whether it is mandatory or not for the provider participant to provide the details for the unknown participant + * @return actionRequired + **/ + @ApiModelProperty(value = "It indicates whether it is mandatory or not for the provider participant to provide the details for the unknown participant") + public Boolean isActionRequired() { + return actionRequired; + } + + public void setActionRequired(Boolean actionRequired) { + this.actionRequired = actionRequired; + } + + public ProviderParticipantSetInfo actionDescription(String actionDescription) { + this.actionDescription = actionDescription; + return this; + } + + /** + * The description for the provider participant who is responsible to provide details like name, email for the unknown participant. + * @return actionDescription + **/ + @ApiModelProperty(value = "The description for the provider participant who is responsible to provide details like name, email for the unknown participant.") + public String getActionDescription() { + return actionDescription; + } + + public void setActionDescription(String actionDescription) { + this.actionDescription = actionDescription; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ProviderParticipantSetInfo providerParticipantSetInfo = (ProviderParticipantSetInfo) o; + return Objects.equals(this.actionRequired, providerParticipantSetInfo.actionRequired) && + Objects.equals(this.actionDescription, providerParticipantSetInfo.actionDescription); + } + + @Override + public int hashCode() { + return Objects.hash(actionRequired, actionDescription); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ProviderParticipantSetInfo {\n"); + + sb.append(" actionRequired: ").append(toIndentedString(actionRequired)).append("\n"); + sb.append(" actionDescription: ").append(toIndentedString(actionDescription)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/widgets/SecurityOption.java b/src/main/java/io/swagger/client/model/widgets/SecurityOption.java index 17d1de9..988b453 100755 --- a/src/main/java/io/swagger/client/model/widgets/SecurityOption.java +++ b/src/main/java/io/swagger/client/model/widgets/SecurityOption.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * SecurityOption */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class SecurityOption { @SerializedName("openPassword") private String openPassword = null; diff --git a/src/main/java/io/swagger/client/model/widgets/SenderInfo.java b/src/main/java/io/swagger/client/model/widgets/SenderInfo.java index 3ad3ac8..b4a0a26 100755 --- a/src/main/java/io/swagger/client/model/widgets/SenderInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/SenderInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -37,61 +22,89 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; +import java.util.Date; /** * SenderInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class SenderInfo { + @SerializedName("participantId") + private String participantId = null; + + @SerializedName("createdDate") + private Date createdDate = null; + + @SerializedName("hidden") + private Boolean hidden = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("self") + private Boolean self = null; + @SerializedName("company") private String company = null; + @SerializedName("userId") + private String userId = null; + @SerializedName("email") private String email = null; - @SerializedName("name") - private String name = null; + public SenderInfo participantId(String participantId) { + this.participantId = participantId; + return this; + } - @SerializedName("participantId") - private String participantId = null; + /** + * The unique identifier of the creator of the web form. + * @return participantId + **/ + @ApiModelProperty(value = " The unique identifier of the creator of the web form.") + public String getParticipantId() { + return participantId; + } - @SerializedName("self") - private Boolean self = null; + public void setParticipantId(String participantId) { + this.participantId = participantId; + } - public SenderInfo company(String company) { - this.company = company; + public SenderInfo createdDate(Date createdDate) { + this.createdDate = createdDate; return this; } /** - * Company of the creator, if available. - * @return company + * The date when the sender was added. This will be returned as part of GET call but is ignored if passed as part of PUT call. + * @return createdDate **/ - @ApiModelProperty(value = "Company of the creator, if available.") - public String getCompany() { - return company; + @ApiModelProperty(value = "The date when the sender was added. This will be returned as part of GET call but is ignored if passed as part of PUT call.") + public Date getCreatedDate() { + return createdDate; } - public void setCompany(String company) { - this.company = company; + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; } - public SenderInfo email(String email) { - this.email = email; + public SenderInfo hidden(Boolean hidden) { + this.hidden = hidden; return this; } /** - * Email of the creator of the widget. - * @return email + * True if the web form is hidden for the user that is calling the API. Only returned if self is true. + * @return hidden **/ - @ApiModelProperty(value = "Email of the creator of the widget.") - public String getEmail() { - return email; + @ApiModelProperty(value = "True if the web form is hidden for the user that is calling the API. Only returned if self is true.") + public Boolean isHidden() { + return hidden; } - public void setEmail(String email) { - this.email = email; + public void setHidden(Boolean hidden) { + this.hidden = hidden; } public SenderInfo name(String name) { @@ -112,40 +125,76 @@ public void setName(String name) { this.name = name; } - public SenderInfo participantId(String participantId) { - this.participantId = participantId; + public SenderInfo self(Boolean self) { + this.self = self; return this; } /** - * The unique identifier of the creator of the widget. - * @return participantId + * True if the creator of the web form is the same user that is calling the API. + * @return self **/ - @ApiModelProperty(value = " The unique identifier of the creator of the widget.") - public String getParticipantId() { - return participantId; + @ApiModelProperty(value = "True if the creator of the web form is the same user that is calling the API.") + public Boolean isSelf() { + return self; } - public void setParticipantId(String participantId) { - this.participantId = participantId; + public void setSelf(Boolean self) { + this.self = self; } - public SenderInfo self(Boolean self) { - this.self = self; + public SenderInfo company(String company) { + this.company = company; return this; } /** - * True if the creator of the widget is the same user that is calling the API. - * @return self + * Company of the creator, if available. + * @return company **/ - @ApiModelProperty(value = "True if the creator of the widget is the same user that is calling the API.") - public Boolean isSelf() { - return self; + @ApiModelProperty(value = "Company of the creator, if available.") + public String getCompany() { + return company; } - public void setSelf(Boolean self) { - this.self = self; + public void setCompany(String company) { + this.company = company; + } + + public SenderInfo userId(String userId) { + this.userId = userId; + return this; + } + + /** + * The user ID of the sender. This will be returned as part of GET call but is ignored if passed as part of PUT call. + * @return userId + **/ + @ApiModelProperty(value = "The user ID of the sender. This will be returned as part of GET call but is ignored if passed as part of PUT call.") + public String getUserId() { + return userId; + } + + public void setUserId(String userId) { + this.userId = userId; + } + + public SenderInfo email(String email) { + this.email = email; + return this; + } + + /** + * Email of the creator of the web form. + * @return email + **/ + @ApiModelProperty(value = "Email of the creator of the web form.") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; } @@ -158,16 +207,19 @@ public boolean equals(java.lang.Object o) { return false; } SenderInfo senderInfo = (SenderInfo) o; - return Objects.equals(this.company, senderInfo.company) && - Objects.equals(this.email, senderInfo.email) && + return Objects.equals(this.participantId, senderInfo.participantId) && + Objects.equals(this.createdDate, senderInfo.createdDate) && + Objects.equals(this.hidden, senderInfo.hidden) && Objects.equals(this.name, senderInfo.name) && - Objects.equals(this.participantId, senderInfo.participantId) && - Objects.equals(this.self, senderInfo.self); + Objects.equals(this.self, senderInfo.self) && + Objects.equals(this.company, senderInfo.company) && + Objects.equals(this.userId, senderInfo.userId) && + Objects.equals(this.email, senderInfo.email); } @Override public int hashCode() { - return Objects.hash(company, email, name, participantId, self); + return Objects.hash(participantId, createdDate, hidden, name, self, company, userId, email); } @@ -176,11 +228,14 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class SenderInfo {\n"); - sb.append(" company: ").append(toIndentedString(company)).append("\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); + sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); + sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" self: ").append(toIndentedString(self)).append("\n"); + sb.append(" company: ").append(toIndentedString(company)).append("\n"); + sb.append(" userId: ").append(toIndentedString(userId)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/ShareCreationInfo.java b/src/main/java/io/swagger/client/model/widgets/ShareCreationInfo.java index 57a87b0..9a9eb63 100755 --- a/src/main/java/io/swagger/client/model/widgets/ShareCreationInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/ShareCreationInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,31 +26,13 @@ /** * ShareCreationInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class ShareCreationInfo { - @SerializedName("email") - private String email = null; - @SerializedName("message") private String message = null; - public ShareCreationInfo email(String email) { - this.email = email; - return this; - } - - /** - * The email address of the member with whom the agreement will be shared - * @return email - **/ - @ApiModelProperty(value = "The email address of the member with whom the agreement will be shared") - public String getEmail() { - return email; - } - - public void setEmail(String email) { - this.email = email; - } + @SerializedName("email") + private String email = null; public ShareCreationInfo message(String message) { this.message = message; @@ -85,6 +52,24 @@ public void setMessage(String message) { this.message = message; } + public ShareCreationInfo email(String email) { + this.email = email; + return this; + } + + /** + * The email address of the member with whom the agreement will be shared + * @return email + **/ + @ApiModelProperty(value = "The email address of the member with whom the agreement will be shared") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + @Override public boolean equals(java.lang.Object o) { @@ -95,13 +80,13 @@ public boolean equals(java.lang.Object o) { return false; } ShareCreationInfo shareCreationInfo = (ShareCreationInfo) o; - return Objects.equals(this.email, shareCreationInfo.email) && - Objects.equals(this.message, shareCreationInfo.message); + return Objects.equals(this.message, shareCreationInfo.message) && + Objects.equals(this.email, shareCreationInfo.email); } @Override public int hashCode() { - return Objects.hash(email, message); + return Objects.hash(message, email); } @@ -110,8 +95,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ShareCreationInfo {\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/ShareCreationInfoList.java b/src/main/java/io/swagger/client/model/widgets/ShareCreationInfoList.java index d555d89..b8bfb65 100755 --- a/src/main/java/io/swagger/client/model/widgets/ShareCreationInfoList.java +++ b/src/main/java/io/swagger/client/model/widgets/ShareCreationInfoList.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * ShareCreationInfoList */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class ShareCreationInfoList { @SerializedName("shareCreationInfo") private List shareCreationInfo = null; diff --git a/src/main/java/io/swagger/client/model/widgets/ShareCreationResponse.java b/src/main/java/io/swagger/client/model/widgets/ShareCreationResponse.java index 07940a3..95bed8c 100755 --- a/src/main/java/io/swagger/client/model/widgets/ShareCreationResponse.java +++ b/src/main/java/io/swagger/client/model/widgets/ShareCreationResponse.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,31 +26,13 @@ /** * ShareCreationResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class ShareCreationResponse { - @SerializedName("email") - private String email = null; - @SerializedName("participantId") private String participantId = null; - public ShareCreationResponse email(String email) { - this.email = email; - return this; - } - - /** - * The email address that was requested - * @return email - **/ - @ApiModelProperty(value = "The email address that was requested") - public String getEmail() { - return email; - } - - public void setEmail(String email) { - this.email = email; - } + @SerializedName("email") + private String email = null; public ShareCreationResponse participantId(String participantId) { this.participantId = participantId; @@ -85,6 +52,24 @@ public void setParticipantId(String participantId) { this.participantId = participantId; } + public ShareCreationResponse email(String email) { + this.email = email; + return this; + } + + /** + * The email address that was requested + * @return email + **/ + @ApiModelProperty(value = "The email address that was requested") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + @Override public boolean equals(java.lang.Object o) { @@ -95,13 +80,13 @@ public boolean equals(java.lang.Object o) { return false; } ShareCreationResponse shareCreationResponse = (ShareCreationResponse) o; - return Objects.equals(this.email, shareCreationResponse.email) && - Objects.equals(this.participantId, shareCreationResponse.participantId); + return Objects.equals(this.participantId, shareCreationResponse.participantId) && + Objects.equals(this.email, shareCreationResponse.email); } @Override public int hashCode() { - return Objects.hash(email, participantId); + return Objects.hash(participantId, email); } @@ -110,8 +95,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ShareCreationResponse {\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/ShareCreationResponseList.java b/src/main/java/io/swagger/client/model/widgets/ShareCreationResponseList.java index 2ee1e01..7674d26 100755 --- a/src/main/java/io/swagger/client/model/widgets/ShareCreationResponseList.java +++ b/src/main/java/io/swagger/client/model/widgets/ShareCreationResponseList.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * ShareCreationResponseList */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class ShareCreationResponseList { @SerializedName("shareCreationResponseList") private List shareCreationResponseList = null; diff --git a/src/main/java/io/swagger/client/model/widgets/ShareParticipantInfo.java b/src/main/java/io/swagger/client/model/widgets/ShareParticipantInfo.java index ba914c0..f0bbffd 100755 --- a/src/main/java/io/swagger/client/model/widgets/ShareParticipantInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/ShareParticipantInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,57 +26,63 @@ /** * ShareParticipantInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class ShareParticipantInfo { - @SerializedName("company") - private String company = null; + @SerializedName("participantId") + private String participantId = null; - @SerializedName("email") - private String email = null; + @SerializedName("hidden") + private Boolean hidden = null; @SerializedName("name") private String name = null; - @SerializedName("participantId") - private String participantId = null; + @SerializedName("self") + private Boolean self = null; @SerializedName("sharerParticipantId") private String sharerParticipantId = null; - public ShareParticipantInfo company(String company) { - this.company = company; + @SerializedName("company") + private String company = null; + + @SerializedName("email") + private String email = null; + + public ShareParticipantInfo participantId(String participantId) { + this.participantId = participantId; return this; } /** - * Company of the sharee participant of the widget, if available. - * @return company + * The unique identifier of the sharee participant of the web form. + * @return participantId **/ - @ApiModelProperty(value = "Company of the sharee participant of the widget, if available.") - public String getCompany() { - return company; + @ApiModelProperty(value = "The unique identifier of the sharee participant of the web form.") + public String getParticipantId() { + return participantId; } - public void setCompany(String company) { - this.company = company; + public void setParticipantId(String participantId) { + this.participantId = participantId; } - public ShareParticipantInfo email(String email) { - this.email = email; + public ShareParticipantInfo hidden(Boolean hidden) { + this.hidden = hidden; return this; } /** - * Email of the sharee participant of the widget. - * @return email + * True if the web form is hidden for the user that is calling the API. Only returned if self is true. + * @return hidden **/ - @ApiModelProperty(value = "Email of the sharee participant of the widget.") - public String getEmail() { - return email; + @ApiModelProperty(value = "True if the web form is hidden for the user that is calling the API. Only returned if self is true.") + public Boolean isHidden() { + return hidden; } - public void setEmail(String email) { - this.email = email; + public void setHidden(Boolean hidden) { + this.hidden = hidden; } public ShareParticipantInfo name(String name) { @@ -100,10 +91,10 @@ public ShareParticipantInfo name(String name) { } /** - * Name of the sharee participant of the widget, if available. + * Name of the sharee participant of the web form, if available. * @return name **/ - @ApiModelProperty(value = "Name of the sharee participant of the widget, if available.") + @ApiModelProperty(value = "Name of the sharee participant of the web form, if available.") public String getName() { return name; } @@ -112,22 +103,22 @@ public void setName(String name) { this.name = name; } - public ShareParticipantInfo participantId(String participantId) { - this.participantId = participantId; + public ShareParticipantInfo self(Boolean self) { + this.self = self; return this; } /** - * The unique identifier of the sharee participant of the widget. - * @return participantId + * True if the Share participant of the web form is the same user that is calling the API. + * @return self **/ - @ApiModelProperty(value = "The unique identifier of the sharee participant of the widget.") - public String getParticipantId() { - return participantId; + @ApiModelProperty(value = "True if the Share participant of the web form is the same user that is calling the API.") + public Boolean isSelf() { + return self; } - public void setParticipantId(String participantId) { - this.participantId = participantId; + public void setSelf(Boolean self) { + this.self = self; } public ShareParticipantInfo sharerParticipantId(String sharerParticipantId) { @@ -136,10 +127,10 @@ public ShareParticipantInfo sharerParticipantId(String sharerParticipantId) { } /** - * The unique identifier of the participant who shared the widget. + * The unique identifier of the participant who shared the web form. * @return sharerParticipantId **/ - @ApiModelProperty(value = "The unique identifier of the participant who shared the widget.") + @ApiModelProperty(value = "The unique identifier of the participant who shared the web form.") public String getSharerParticipantId() { return sharerParticipantId; } @@ -148,6 +139,42 @@ public void setSharerParticipantId(String sharerParticipantId) { this.sharerParticipantId = sharerParticipantId; } + public ShareParticipantInfo company(String company) { + this.company = company; + return this; + } + + /** + * Company of the sharee participant of the web form, if available. + * @return company + **/ + @ApiModelProperty(value = "Company of the sharee participant of the web form, if available.") + public String getCompany() { + return company; + } + + public void setCompany(String company) { + this.company = company; + } + + public ShareParticipantInfo email(String email) { + this.email = email; + return this; + } + + /** + * Email of the sharee participant of the web form. + * @return email + **/ + @ApiModelProperty(value = "Email of the sharee participant of the web form.") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + @Override public boolean equals(java.lang.Object o) { @@ -158,16 +185,18 @@ public boolean equals(java.lang.Object o) { return false; } ShareParticipantInfo shareParticipantInfo = (ShareParticipantInfo) o; - return Objects.equals(this.company, shareParticipantInfo.company) && - Objects.equals(this.email, shareParticipantInfo.email) && + return Objects.equals(this.participantId, shareParticipantInfo.participantId) && + Objects.equals(this.hidden, shareParticipantInfo.hidden) && Objects.equals(this.name, shareParticipantInfo.name) && - Objects.equals(this.participantId, shareParticipantInfo.participantId) && - Objects.equals(this.sharerParticipantId, shareParticipantInfo.sharerParticipantId); + Objects.equals(this.self, shareParticipantInfo.self) && + Objects.equals(this.sharerParticipantId, shareParticipantInfo.sharerParticipantId) && + Objects.equals(this.company, shareParticipantInfo.company) && + Objects.equals(this.email, shareParticipantInfo.email); } @Override public int hashCode() { - return Objects.hash(company, email, name, participantId, sharerParticipantId); + return Objects.hash(participantId, hidden, name, self, sharerParticipantId, company, email); } @@ -176,11 +205,13 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ShareParticipantInfo {\n"); - sb.append(" company: ").append(toIndentedString(company)).append("\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); + sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" self: ").append(toIndentedString(self)).append("\n"); sb.append(" sharerParticipantId: ").append(toIndentedString(sharerParticipantId)).append("\n"); + sb.append(" company: ").append(toIndentedString(company)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/URLFileInfo.java b/src/main/java/io/swagger/client/model/widgets/URLFileInfo.java index b7a7c1d..b10e314 100755 --- a/src/main/java/io/swagger/client/model/widgets/URLFileInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/URLFileInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,35 +26,17 @@ /** * URLFileInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class URLFileInfo { - @SerializedName("mimeType") - private String mimeType = null; - @SerializedName("name") private String name = null; + @SerializedName("mimeType") + private String mimeType = null; + @SerializedName("url") private String url = null; - public URLFileInfo mimeType(String mimeType) { - this.mimeType = mimeType; - return this; - } - - /** - * The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed - * @return mimeType - **/ - @ApiModelProperty(value = "The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed") - public String getMimeType() { - return mimeType; - } - - public void setMimeType(String mimeType) { - this.mimeType = mimeType; - } - public URLFileInfo name(String name) { this.name = name; return this; @@ -88,6 +55,24 @@ public void setName(String name) { this.name = name; } + public URLFileInfo mimeType(String mimeType) { + this.mimeType = mimeType; + return this; + } + + /** + * The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed + * @return mimeType + **/ + @ApiModelProperty(value = "The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed") + public String getMimeType() { + return mimeType; + } + + public void setMimeType(String mimeType) { + this.mimeType = mimeType; + } + public URLFileInfo url(String url) { this.url = url; return this; @@ -116,14 +101,14 @@ public boolean equals(java.lang.Object o) { return false; } URLFileInfo urLFileInfo = (URLFileInfo) o; - return Objects.equals(this.mimeType, urLFileInfo.mimeType) && - Objects.equals(this.name, urLFileInfo.name) && + return Objects.equals(this.name, urLFileInfo.name) && + Objects.equals(this.mimeType, urLFileInfo.mimeType) && Objects.equals(this.url, urLFileInfo.url); } @Override public int hashCode() { - return Objects.hash(mimeType, name, url); + return Objects.hash(name, mimeType, url); } @@ -132,8 +117,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class URLFileInfo {\n"); - sb.append(" mimeType: ").append(toIndentedString(mimeType)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" mimeType: ").append(toIndentedString(mimeType)).append("\n"); sb.append(" url: ").append(toIndentedString(url)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/widgets/UserWidget.java b/src/main/java/io/swagger/client/model/widgets/UserWidget.java index d3b2f9a..704c714 100755 --- a/src/main/java/io/swagger/client/model/widgets/UserWidget.java +++ b/src/main/java/io/swagger/client/model/widgets/UserWidget.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,16 +27,13 @@ /** * UserWidget */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class UserWidget { - @SerializedName("id") - private String id = null; - @SerializedName("hidden") private Boolean hidden = null; - @SerializedName("javascript") - private String javascript = null; + @SerializedName("groupId") + private String groupId = null; @SerializedName("modifiedDate") private Date modifiedDate = null; @@ -59,8 +41,17 @@ public class UserWidget { @SerializedName("name") private String name = null; + @SerializedName("id") + private String id = null; + + @SerializedName("javascript") + private String javascript = null; + + @SerializedName("url") + private String url = null; + /** - * The widget status (AUTHORING, ACTIVE, DRAFT, DISABLED) + * The web form status (AUTHORING, ACTIVE, DRAFT, DISABLED) */ @JsonAdapter(StatusEnum.Adapter.class) public enum StatusEnum { @@ -113,27 +104,6 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; - @SerializedName("url") - private String url = null; - - public UserWidget id(String id) { - this.id = id; - return this; - } - - /** - * The unique identifier of a widget - * @return id - **/ - @ApiModelProperty(value = "The unique identifier of a widget") - public String getId() { - return id; - } - - public void setId(String id) { - this.id = id; - } - public UserWidget hidden(Boolean hidden) { this.hidden = hidden; return this; @@ -152,22 +122,22 @@ public void setHidden(Boolean hidden) { this.hidden = hidden; } - public UserWidget javascript(String javascript) { - this.javascript = javascript; + public UserWidget groupId(String groupId) { + this.groupId = groupId; return this; } /** - * The embedded javascript code of the widget - * @return javascript + * Unique identifier of the group + * @return groupId **/ - @ApiModelProperty(value = "The embedded javascript code of the widget") - public String getJavascript() { - return javascript; + @ApiModelProperty(value = "Unique identifier of the group") + public String getGroupId() { + return groupId; } - public void setJavascript(String javascript) { - this.javascript = javascript; + public void setGroupId(String groupId) { + this.groupId = groupId; } public UserWidget modifiedDate(Date modifiedDate) { @@ -176,10 +146,10 @@ public UserWidget modifiedDate(Date modifiedDate) { } /** - * The date on which the widget was last modified. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * The date on which the web form was last modified. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time * @return modifiedDate **/ - @ApiModelProperty(value = "The date on which the widget was last modified. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + @ApiModelProperty(value = "The date on which the web form was last modified. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") public Date getModifiedDate() { return modifiedDate; } @@ -194,10 +164,10 @@ public UserWidget name(String name) { } /** - * The name of the widget. + * The name of the web form. * @return name **/ - @ApiModelProperty(value = "The name of the widget.") + @ApiModelProperty(value = "The name of the web form.") public String getName() { return name; } @@ -206,22 +176,40 @@ public void setName(String name) { this.name = name; } - public UserWidget status(StatusEnum status) { - this.status = status; + public UserWidget id(String id) { + this.id = id; return this; } /** - * The widget status (AUTHORING, ACTIVE, DRAFT, DISABLED) - * @return status + * The unique identifier of a web form + * @return id **/ - @ApiModelProperty(value = "The widget status (AUTHORING, ACTIVE, DRAFT, DISABLED)") - public StatusEnum getStatus() { - return status; + @ApiModelProperty(value = "The unique identifier of a web form") + public String getId() { + return id; } - public void setStatus(StatusEnum status) { - this.status = status; + public void setId(String id) { + this.id = id; + } + + public UserWidget javascript(String javascript) { + this.javascript = javascript; + return this; + } + + /** + * The embedded javascript code of the web form + * @return javascript + **/ + @ApiModelProperty(value = "The embedded javascript code of the web form") + public String getJavascript() { + return javascript; + } + + public void setJavascript(String javascript) { + this.javascript = javascript; } public UserWidget url(String url) { @@ -230,10 +218,10 @@ public UserWidget url(String url) { } /** - * The hosted url of the widget + * The hosted url of the web form * @return url **/ - @ApiModelProperty(value = "The hosted url of the widget") + @ApiModelProperty(value = "The hosted url of the web form") public String getUrl() { return url; } @@ -242,6 +230,24 @@ public void setUrl(String url) { this.url = url; } + public UserWidget status(StatusEnum status) { + this.status = status; + return this; + } + + /** + * The web form status (AUTHORING, ACTIVE, DRAFT, DISABLED) + * @return status + **/ + @ApiModelProperty(value = "The web form status (AUTHORING, ACTIVE, DRAFT, DISABLED)") + public StatusEnum getStatus() { + return status; + } + + public void setStatus(StatusEnum status) { + this.status = status; + } + @Override public boolean equals(java.lang.Object o) { @@ -252,18 +258,19 @@ public boolean equals(java.lang.Object o) { return false; } UserWidget userWidget = (UserWidget) o; - return Objects.equals(this.id, userWidget.id) && - Objects.equals(this.hidden, userWidget.hidden) && - Objects.equals(this.javascript, userWidget.javascript) && + return Objects.equals(this.hidden, userWidget.hidden) && + Objects.equals(this.groupId, userWidget.groupId) && Objects.equals(this.modifiedDate, userWidget.modifiedDate) && Objects.equals(this.name, userWidget.name) && - Objects.equals(this.status, userWidget.status) && - Objects.equals(this.url, userWidget.url); + Objects.equals(this.id, userWidget.id) && + Objects.equals(this.javascript, userWidget.javascript) && + Objects.equals(this.url, userWidget.url) && + Objects.equals(this.status, userWidget.status); } @Override public int hashCode() { - return Objects.hash(id, hidden, javascript, modifiedDate, name, status, url); + return Objects.hash(hidden, groupId, modifiedDate, name, id, javascript, url, status); } @@ -272,13 +279,14 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class UserWidget {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); - sb.append(" javascript: ").append(toIndentedString(javascript)).append("\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); sb.append(" modifiedDate: ").append(toIndentedString(modifiedDate)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" javascript: ").append(toIndentedString(javascript)).append("\n"); sb.append(" url: ").append(toIndentedString(url)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/UserWidgets.java b/src/main/java/io/swagger/client/model/widgets/UserWidgets.java index 561a2bc..bcae532 100755 --- a/src/main/java/io/swagger/client/model/widgets/UserWidgets.java +++ b/src/main/java/io/swagger/client/model/widgets/UserWidgets.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,31 +30,13 @@ /** * UserWidgets */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class UserWidgets { - @SerializedName("page") - private PageInfo page = null; - @SerializedName("userWidgetList") private List userWidgetList = null; - public UserWidgets page(PageInfo page) { - this.page = page; - return this; - } - - /** - * Pagination information for navigating through the response - * @return page - **/ - @ApiModelProperty(value = "Pagination information for navigating through the response") - public PageInfo getPage() { - return page; - } - - public void setPage(PageInfo page) { - this.page = page; - } + @SerializedName("page") + private PageInfo page = null; public UserWidgets userWidgetList(List userWidgetList) { this.userWidgetList = userWidgetList; @@ -85,10 +52,10 @@ public UserWidgets addUserWidgetListItem(UserWidget userWidgetListItem) { } /** - * An array of widget items + * An array of web form items * @return userWidgetList **/ - @ApiModelProperty(value = "An array of widget items") + @ApiModelProperty(value = "An array of web form items") public List getUserWidgetList() { return userWidgetList; } @@ -97,6 +64,24 @@ public void setUserWidgetList(List userWidgetList) { this.userWidgetList = userWidgetList; } + public UserWidgets page(PageInfo page) { + this.page = page; + return this; + } + + /** + * Pagination information for navigating through the response + * @return page + **/ + @ApiModelProperty(value = "Pagination information for navigating through the response") + public PageInfo getPage() { + return page; + } + + public void setPage(PageInfo page) { + this.page = page; + } + @Override public boolean equals(java.lang.Object o) { @@ -107,13 +92,13 @@ public boolean equals(java.lang.Object o) { return false; } UserWidgets userWidgets = (UserWidgets) o; - return Objects.equals(this.page, userWidgets.page) && - Objects.equals(this.userWidgetList, userWidgets.userWidgetList); + return Objects.equals(this.userWidgetList, userWidgets.userWidgetList) && + Objects.equals(this.page, userWidgets.page); } @Override public int hashCode() { - return Objects.hash(page, userWidgetList); + return Objects.hash(userWidgetList, page); } @@ -122,8 +107,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class UserWidgets {\n"); - sb.append(" page: ").append(toIndentedString(page)).append("\n"); sb.append(" userWidgetList: ").append(toIndentedString(userWidgetList)).append("\n"); + sb.append(" page: ").append(toIndentedString(page)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/VaultingInfo.java b/src/main/java/io/swagger/client/model/widgets/VaultingInfo.java index ac9e672..6f4c304 100755 --- a/src/main/java/io/swagger/client/model/widgets/VaultingInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/VaultingInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * VaultingInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class VaultingInfo { @SerializedName("enabled") private Boolean enabled = null; diff --git a/src/main/java/io/swagger/client/model/widgets/VisibilityInfo.java b/src/main/java/io/swagger/client/model/widgets/VisibilityInfo.java index 1e85ae5..3389f72 100755 --- a/src/main/java/io/swagger/client/model/widgets/VisibilityInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/VisibilityInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * VisibilityInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class VisibilityInfo { /** * Specifies the visibility. The possible values are HIDE or SHOW diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetAdditionalParticipationSetInfo.java b/src/main/java/io/swagger/client/model/widgets/WidgetAdditionalParticipationSetInfo.java index 1f2b400..311fbfb 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetAdditionalParticipationSetInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetAdditionalParticipationSetInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -37,6 +22,7 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import io.swagger.client.model.widgets.ParticipantSetMemberInfo; +import io.swagger.client.model.widgets.ProviderParticipantSetInfo; import java.io.IOException; import java.util.ArrayList; import java.util.List; @@ -44,16 +30,13 @@ /** * WidgetAdditionalParticipationSetInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetAdditionalParticipationSetInfo { - @SerializedName("memberInfos") - private List memberInfos = null; - - @SerializedName("order") - private Integer order = null; + @SerializedName("providerParticipantSetInfo") + private ProviderParticipantSetInfo providerParticipantSetInfo = null; /** - * Role assumed by all participants in the set (signer, approver, etc.) Widget First Participant will only have roles - Signer, Approver, Acceptor and Form Filler + * Role assumed by all participants in the set (signer, approver, etc.) Web Form First Participant will only have roles - Signer, Approver, Acceptor and Form Filler */ @JsonAdapter(RoleEnum.Adapter.class) public enum RoleEnum { @@ -118,6 +101,48 @@ public RoleEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("role") private RoleEnum role = null; + @SerializedName("memberInfos") + private List memberInfos = null; + + @SerializedName("order") + private Integer order = null; + + public WidgetAdditionalParticipationSetInfo providerParticipantSetInfo(ProviderParticipantSetInfo providerParticipantSetInfo) { + this.providerParticipantSetInfo = providerParticipantSetInfo; + return this; + } + + /** + * Represents all the attributes related to the unknown participant and its provider. If it is defined then the participant will be treated as an unknown participant. + * @return providerParticipantSetInfo + **/ + @ApiModelProperty(value = "Represents all the attributes related to the unknown participant and its provider. If it is defined then the participant will be treated as an unknown participant.") + public ProviderParticipantSetInfo getProviderParticipantSetInfo() { + return providerParticipantSetInfo; + } + + public void setProviderParticipantSetInfo(ProviderParticipantSetInfo providerParticipantSetInfo) { + this.providerParticipantSetInfo = providerParticipantSetInfo; + } + + public WidgetAdditionalParticipationSetInfo role(RoleEnum role) { + this.role = role; + return this; + } + + /** + * Role assumed by all participants in the set (signer, approver, etc.) Web Form First Participant will only have roles - Signer, Approver, Acceptor and Form Filler + * @return role + **/ + @ApiModelProperty(value = "Role assumed by all participants in the set (signer, approver, etc.) Web Form First Participant will only have roles - Signer, Approver, Acceptor and Form Filler") + public RoleEnum getRole() { + return role; + } + + public void setRole(RoleEnum role) { + this.role = role; + } + public WidgetAdditionalParticipationSetInfo memberInfos(List memberInfos) { this.memberInfos = memberInfos; return this; @@ -132,10 +157,10 @@ public WidgetAdditionalParticipationSetInfo addMemberInfosItem(ParticipantSetMem } /** - * Array of ParticipantInfo objects, containing participant-specific data (email, e.g.) for all the additional participants in the widget + * Array of ParticipantInfo objects, containing participant-specific data (email, e.g.) for all the additional participants in the web form. If the email of the participant is unknown at the time of web form creation, the email should be left empty, * @return memberInfos **/ - @ApiModelProperty(value = "Array of ParticipantInfo objects, containing participant-specific data (email, e.g.) for all the additional participants in the widget") + @ApiModelProperty(value = "Array of ParticipantInfo objects, containing participant-specific data (email, e.g.) for all the additional participants in the web form. If the email of the participant is unknown at the time of web form creation, the email should be left empty, ") public List getMemberInfos() { return memberInfos; } @@ -150,10 +175,10 @@ public WidgetAdditionalParticipationSetInfo order(Integer order) { } /** - * Index indicating position at which signing group needs to sign. Additional participant to sign at first place is assigned a index of 1. Widget participant should not have any order specified. Widget participant should not have any email address and and can not have phone authentication applied. Different signingOrder specified in input should form a valid consecutive increasing sequence of integers. Otherwise signingOrder will be considered invalid + * Index indicating position at which signing group needs to sign. Additional participant to sign at first place is assigned a index of 1. Web Form participant should not have any order specified. Web Form participant should not have any email address and and can not have phone authentication applied. Different signingOrder specified in input should form a valid consecutive increasing sequence of integers. Otherwise signingOrder will be considered invalid, * @return order **/ - @ApiModelProperty(value = "Index indicating position at which signing group needs to sign. Additional participant to sign at first place is assigned a index of 1. Widget participant should not have any order specified. Widget participant should not have any email address and and can not have phone authentication applied. Different signingOrder specified in input should form a valid consecutive increasing sequence of integers. Otherwise signingOrder will be considered invalid") + @ApiModelProperty(value = "Index indicating position at which signing group needs to sign. Additional participant to sign at first place is assigned a index of 1. Web Form participant should not have any order specified. Web Form participant should not have any email address and and can not have phone authentication applied. Different signingOrder specified in input should form a valid consecutive increasing sequence of integers. Otherwise signingOrder will be considered invalid,") public Integer getOrder() { return order; } @@ -162,24 +187,6 @@ public void setOrder(Integer order) { this.order = order; } - public WidgetAdditionalParticipationSetInfo role(RoleEnum role) { - this.role = role; - return this; - } - - /** - * Role assumed by all participants in the set (signer, approver, etc.) Widget First Participant will only have roles - Signer, Approver, Acceptor and Form Filler - * @return role - **/ - @ApiModelProperty(value = "Role assumed by all participants in the set (signer, approver, etc.) Widget First Participant will only have roles - Signer, Approver, Acceptor and Form Filler") - public RoleEnum getRole() { - return role; - } - - public void setRole(RoleEnum role) { - this.role = role; - } - @Override public boolean equals(java.lang.Object o) { @@ -190,14 +197,15 @@ public boolean equals(java.lang.Object o) { return false; } WidgetAdditionalParticipationSetInfo widgetAdditionalParticipationSetInfo = (WidgetAdditionalParticipationSetInfo) o; - return Objects.equals(this.memberInfos, widgetAdditionalParticipationSetInfo.memberInfos) && - Objects.equals(this.order, widgetAdditionalParticipationSetInfo.order) && - Objects.equals(this.role, widgetAdditionalParticipationSetInfo.role); + return Objects.equals(this.providerParticipantSetInfo, widgetAdditionalParticipationSetInfo.providerParticipantSetInfo) && + Objects.equals(this.role, widgetAdditionalParticipationSetInfo.role) && + Objects.equals(this.memberInfos, widgetAdditionalParticipationSetInfo.memberInfos) && + Objects.equals(this.order, widgetAdditionalParticipationSetInfo.order); } @Override public int hashCode() { - return Objects.hash(memberInfos, order, role); + return Objects.hash(providerParticipantSetInfo, role, memberInfos, order); } @@ -206,9 +214,10 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class WidgetAdditionalParticipationSetInfo {\n"); + sb.append(" providerParticipantSetInfo: ").append(toIndentedString(providerParticipantSetInfo)).append("\n"); + sb.append(" role: ").append(toIndentedString(role)).append("\n"); sb.append(" memberInfos: ").append(toIndentedString(memberInfos)).append("\n"); sb.append(" order: ").append(toIndentedString(order)).append("\n"); - sb.append(" role: ").append(toIndentedString(role)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetAgreement.java b/src/main/java/io/swagger/client/model/widgets/WidgetAgreement.java index 48ad12d..fe6ca49 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetAgreement.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetAgreement.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,28 +30,86 @@ /** * WidgetAgreement */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetAgreement { + @SerializedName("hidden") + private Boolean hidden = null; + @SerializedName("displayDate") private Date displayDate = null; + @SerializedName("groupId") + private String groupId = null; + + @SerializedName("esign") + private Boolean esign = null; + + @SerializedName("name") + private String name = null; + @SerializedName("displayParticipantSetInfos") private List displayParticipantSetInfos = null; + @SerializedName("latestVersionId") + private String latestVersionId = null; + @SerializedName("id") private String id = null; - @SerializedName("esign") - private Boolean esign = null; + /** + * The kind of agreement + */ + @JsonAdapter(TypeEnum.Adapter.class) + public enum TypeEnum { + AGREEMENT("AGREEMENT"), + + MEGASIGN_CHILD("MEGASIGN_CHILD"), + + WIDGET_INSTANCE("WIDGET_INSTANCE"); - @SerializedName("hidden") - private Boolean hidden = null; + private String value; - @SerializedName("latestVersionId") - private String latestVersionId = null; + TypeEnum(String value) { + this.value = value; + } - @SerializedName("name") - private String name = null; + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static TypeEnum fromValue(String text) { + for (TypeEnum b : TypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public TypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return TypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("type") + private TypeEnum type = null; + + @SerializedName("parentId") + private String parentId = null; /** * The current status of the document from the perspective of the originator @@ -160,6 +203,24 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; + public WidgetAgreement hidden(Boolean hidden) { + this.hidden = hidden; + return this; + } + + /** + * True if agreement is hidden for the user + * @return hidden + **/ + @ApiModelProperty(value = "True if agreement is hidden for the user") + public Boolean isHidden() { + return hidden; + } + + public void setHidden(Boolean hidden) { + this.hidden = hidden; + } + public WidgetAgreement displayDate(Date displayDate) { this.displayDate = displayDate; return this; @@ -178,48 +239,22 @@ public void setDisplayDate(Date displayDate) { this.displayDate = displayDate; } - public WidgetAgreement displayParticipantSetInfos(List displayParticipantSetInfos) { - this.displayParticipantSetInfos = displayParticipantSetInfos; - return this; - } - - public WidgetAgreement addDisplayParticipantSetInfosItem(DisplayWidgetParticipantSetInfo displayParticipantSetInfosItem) { - if (this.displayParticipantSetInfos == null) { - this.displayParticipantSetInfos = new ArrayList(); - } - this.displayParticipantSetInfos.add(displayParticipantSetInfosItem); + public WidgetAgreement groupId(String groupId) { + this.groupId = groupId; return this; } /** - * The most relevant current user set for the agreement. It is typically the next signer if the agreement is from the current user, or the sender if received from another user - * @return displayParticipantSetInfos + * Unique identifier of the group + * @return groupId **/ - @ApiModelProperty(value = "The most relevant current user set for the agreement. It is typically the next signer if the agreement is from the current user, or the sender if received from another user") - public List getDisplayParticipantSetInfos() { - return displayParticipantSetInfos; + @ApiModelProperty(value = "Unique identifier of the group") + public String getGroupId() { + return groupId; } - public void setDisplayParticipantSetInfos(List displayParticipantSetInfos) { - this.displayParticipantSetInfos = displayParticipantSetInfos; - } - - public WidgetAgreement id(String id) { - this.id = id; - return this; - } - - /** - * The unique identifier of the agreement.If provided in POST, it will simply be ignored - * @return id - **/ - @ApiModelProperty(value = "The unique identifier of the agreement.If provided in POST, it will simply be ignored") - public String getId() { - return id; - } - - public void setId(String id) { - this.id = id; + public void setGroupId(String groupId) { + this.groupId = groupId; } public WidgetAgreement esign(Boolean esign) { @@ -240,22 +275,48 @@ public void setEsign(Boolean esign) { this.esign = esign; } - public WidgetAgreement hidden(Boolean hidden) { - this.hidden = hidden; + public WidgetAgreement name(String name) { + this.name = name; return this; } /** - * True if agreement is hidden for the user - * @return hidden + * Name of the Agreement + * @return name **/ - @ApiModelProperty(value = "True if agreement is hidden for the user") - public Boolean isHidden() { - return hidden; + @ApiModelProperty(value = "Name of the Agreement") + public String getName() { + return name; } - public void setHidden(Boolean hidden) { - this.hidden = hidden; + public void setName(String name) { + this.name = name; + } + + public WidgetAgreement displayParticipantSetInfos(List displayParticipantSetInfos) { + this.displayParticipantSetInfos = displayParticipantSetInfos; + return this; + } + + public WidgetAgreement addDisplayParticipantSetInfosItem(DisplayWidgetParticipantSetInfo displayParticipantSetInfosItem) { + if (this.displayParticipantSetInfos == null) { + this.displayParticipantSetInfos = new ArrayList(); + } + this.displayParticipantSetInfos.add(displayParticipantSetInfosItem); + return this; + } + + /** + * The most relevant current user set for the agreement. It is typically the next signer if the agreement is from the current user, or the sender if received from another user + * @return displayParticipantSetInfos + **/ + @ApiModelProperty(value = "The most relevant current user set for the agreement. It is typically the next signer if the agreement is from the current user, or the sender if received from another user") + public List getDisplayParticipantSetInfos() { + return displayParticipantSetInfos; + } + + public void setDisplayParticipantSetInfos(List displayParticipantSetInfos) { + this.displayParticipantSetInfos = displayParticipantSetInfos; } public WidgetAgreement latestVersionId(String latestVersionId) { @@ -276,22 +337,58 @@ public void setLatestVersionId(String latestVersionId) { this.latestVersionId = latestVersionId; } - public WidgetAgreement name(String name) { - this.name = name; + public WidgetAgreement id(String id) { + this.id = id; return this; } /** - * Name of the Agreement - * @return name + * The unique identifier of the agreement.If provided in POST, it will simply be ignored + * @return id **/ - @ApiModelProperty(value = "Name of the Agreement") - public String getName() { - return name; + @ApiModelProperty(value = "The unique identifier of the agreement.If provided in POST, it will simply be ignored") + public String getId() { + return id; } - public void setName(String name) { - this.name = name; + public void setId(String id) { + this.id = id; + } + + public WidgetAgreement type(TypeEnum type) { + this.type = type; + return this; + } + + /** + * The kind of agreement + * @return type + **/ + @ApiModelProperty(value = "The kind of agreement") + public TypeEnum getType() { + return type; + } + + public void setType(TypeEnum type) { + this.type = type; + } + + public WidgetAgreement parentId(String parentId) { + this.parentId = parentId; + return this; + } + + /** + * The parent id of a megaSign child *OR* the originating id of a widget agreement instance + * @return parentId + **/ + @ApiModelProperty(value = "The parent id of a megaSign child *OR* the originating id of a widget agreement instance") + public String getParentId() { + return parentId; + } + + public void setParentId(String parentId) { + this.parentId = parentId; } public WidgetAgreement status(StatusEnum status) { @@ -322,19 +419,22 @@ public boolean equals(java.lang.Object o) { return false; } WidgetAgreement widgetAgreement = (WidgetAgreement) o; - return Objects.equals(this.displayDate, widgetAgreement.displayDate) && - Objects.equals(this.displayParticipantSetInfos, widgetAgreement.displayParticipantSetInfos) && - Objects.equals(this.id, widgetAgreement.id) && + return Objects.equals(this.hidden, widgetAgreement.hidden) && + Objects.equals(this.displayDate, widgetAgreement.displayDate) && + Objects.equals(this.groupId, widgetAgreement.groupId) && Objects.equals(this.esign, widgetAgreement.esign) && - Objects.equals(this.hidden, widgetAgreement.hidden) && - Objects.equals(this.latestVersionId, widgetAgreement.latestVersionId) && Objects.equals(this.name, widgetAgreement.name) && + Objects.equals(this.displayParticipantSetInfos, widgetAgreement.displayParticipantSetInfos) && + Objects.equals(this.latestVersionId, widgetAgreement.latestVersionId) && + Objects.equals(this.id, widgetAgreement.id) && + Objects.equals(this.type, widgetAgreement.type) && + Objects.equals(this.parentId, widgetAgreement.parentId) && Objects.equals(this.status, widgetAgreement.status); } @Override public int hashCode() { - return Objects.hash(displayDate, displayParticipantSetInfos, id, esign, hidden, latestVersionId, name, status); + return Objects.hash(hidden, displayDate, groupId, esign, name, displayParticipantSetInfos, latestVersionId, id, type, parentId, status); } @@ -343,13 +443,16 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class WidgetAgreement {\n"); + sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); sb.append(" displayDate: ").append(toIndentedString(displayDate)).append("\n"); - sb.append(" displayParticipantSetInfos: ").append(toIndentedString(displayParticipantSetInfos)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); sb.append(" esign: ").append(toIndentedString(esign)).append("\n"); - sb.append(" hidden: ").append(toIndentedString(hidden)).append("\n"); - sb.append(" latestVersionId: ").append(toIndentedString(latestVersionId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" displayParticipantSetInfos: ").append(toIndentedString(displayParticipantSetInfos)).append("\n"); + sb.append(" latestVersionId: ").append(toIndentedString(latestVersionId)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" parentId: ").append(toIndentedString(parentId)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetAgreements.java b/src/main/java/io/swagger/client/model/widgets/WidgetAgreements.java index bea3cd6..78992f9 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetAgreements.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetAgreements.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -45,31 +30,13 @@ /** * WidgetAgreements */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetAgreements { - @SerializedName("page") - private PageInfo page = null; - @SerializedName("userAgreementList") private List userAgreementList = null; - public WidgetAgreements page(PageInfo page) { - this.page = page; - return this; - } - - /** - * Pagination information for navigating through the response - * @return page - **/ - @ApiModelProperty(value = "Pagination information for navigating through the response") - public PageInfo getPage() { - return page; - } - - public void setPage(PageInfo page) { - this.page = page; - } + @SerializedName("page") + private PageInfo page = null; public WidgetAgreements userAgreementList(List userAgreementList) { this.userAgreementList = userAgreementList; @@ -97,6 +64,24 @@ public void setUserAgreementList(List userAgreementList) { this.userAgreementList = userAgreementList; } + public WidgetAgreements page(PageInfo page) { + this.page = page; + return this; + } + + /** + * Pagination information for navigating through the response + * @return page + **/ + @ApiModelProperty(value = "Pagination information for navigating through the response") + public PageInfo getPage() { + return page; + } + + public void setPage(PageInfo page) { + this.page = page; + } + @Override public boolean equals(java.lang.Object o) { @@ -107,13 +92,13 @@ public boolean equals(java.lang.Object o) { return false; } WidgetAgreements widgetAgreements = (WidgetAgreements) o; - return Objects.equals(this.page, widgetAgreements.page) && - Objects.equals(this.userAgreementList, widgetAgreements.userAgreementList); + return Objects.equals(this.userAgreementList, widgetAgreements.userAgreementList) && + Objects.equals(this.page, widgetAgreements.page); } @Override public int hashCode() { - return Objects.hash(page, userAgreementList); + return Objects.hash(userAgreementList, page); } @@ -122,8 +107,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class WidgetAgreements {\n"); - sb.append(" page: ").append(toIndentedString(page)).append("\n"); sb.append(" userAgreementList: ").append(toIndentedString(userAgreementList)).append("\n"); + sb.append(" page: ").append(toIndentedString(page)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetCcInfo.java b/src/main/java/io/swagger/client/model/widgets/WidgetCcInfo.java index 05193ad..3049a62 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetCcInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetCcInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * WidgetCcInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetCcInfo { @SerializedName("email") private String email = null; @@ -52,10 +37,10 @@ public WidgetCcInfo email(String email) { } /** - * Email of the CC participant of the widget + * Email of the CC participant of the web form * @return email **/ - @ApiModelProperty(value = "Email of the CC participant of the widget") + @ApiModelProperty(value = "Email of the CC participant of the web form") public String getEmail() { return email; } diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetCreationInfoV6.java b/src/main/java/io/swagger/client/model/widgets/WidgetCreationInfoV6.java index 474caa2..f3fa967 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetCreationInfoV6.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetCreationInfoV6.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -52,25 +37,52 @@ /** * WidgetCreationInfoV6 */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetCreationInfoV6 { @SerializedName("additionalParticipantSetsInfo") private List additionalParticipantSetsInfo = null; - @SerializedName("authFailureInfo") - private WidgetRedirectionInfo authFailureInfo = null; + @SerializedName("creatorEmail") + private String creatorEmail = null; + + @SerializedName("groupId") + private String groupId = null; + + @SerializedName("locale") + private String locale = null; + + @SerializedName("vaultingInfo") + private VaultingInfo vaultingInfo = null; + + @SerializedName("securityOption") + private SecurityOption securityOption = null; + + @SerializedName("widgetParticipantSetInfo") + private WidgetParticipantSetInfo widgetParticipantSetInfo = null; + + @SerializedName("widgetInActiveInfo") + private WidgetInActiveInfo widgetInActiveInfo = null; @SerializedName("ccs") private List ccs = null; - @SerializedName("completionInfo") - private WidgetRedirectionInfo completionInfo = null; - @SerializedName("createdDate") private Date createdDate = null; - @SerializedName("creatorEmail") - private String creatorEmail = null; + @SerializedName("isDocumentRetentionApplied") + private Boolean isDocumentRetentionApplied = null; + + @SerializedName("lastEventDate") + private Date lastEventDate = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("completionInfo") + private WidgetRedirectionInfo completionInfo = null; + + @SerializedName("authFailureInfo") + private WidgetRedirectionInfo authFailureInfo = null; @SerializedName("fileInfos") private List fileInfos = null; @@ -78,17 +90,8 @@ public class WidgetCreationInfoV6 { @SerializedName("id") private String id = null; - @SerializedName("locale") - private String locale = null; - - @SerializedName("name") - private String name = null; - - @SerializedName("securityOption") - private SecurityOption securityOption = null; - /** - * The state in which the widget should land. For example in order to create a widget in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the widget can be obtained from GET /widgets/ID + * The state in which the web form should land. For example in order to create a web form in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the web form can be obtained from GET /widgets/ID */ @JsonAdapter(StateEnum.Adapter.class) public enum StateEnum { @@ -140,7 +143,7 @@ public StateEnum read(final JsonReader jsonReader) throws IOException { private StateEnum state = null; /** - * Status of the Widget. If provided in POST, it will simply be ignored + * Status of the Web Form. If provided in POST, it will simply be ignored */ @JsonAdapter(StatusEnum.Adapter.class) public enum StatusEnum { @@ -197,15 +200,6 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; - @SerializedName("vaultingInfo") - private VaultingInfo vaultingInfo = null; - - @SerializedName("widgetInActiveInfo") - private WidgetInActiveInfo widgetInActiveInfo = null; - - @SerializedName("widgetParticipantSetInfo") - private WidgetParticipantSetInfo widgetParticipantSetInfo = null; - public WidgetCreationInfoV6 additionalParticipantSetsInfo(List additionalParticipantSetsInfo) { this.additionalParticipantSetsInfo = additionalParticipantSetsInfo; return this; @@ -220,10 +214,10 @@ public WidgetCreationInfoV6 addAdditionalParticipantSetsInfoItem(WidgetAdditiona } /** - * List of all the participants in the widget except widget signer + * List of all the participants in the web form except web form signer * @return additionalParticipantSetsInfo **/ - @ApiModelProperty(value = "List of all the participants in the widget except widget signer") + @ApiModelProperty(value = "List of all the participants in the web form except web form signer") public List getAdditionalParticipantSetsInfo() { return additionalParticipantSetsInfo; } @@ -232,164 +226,210 @@ public void setAdditionalParticipantSetsInfo(List ccs) { - this.ccs = ccs; + public WidgetCreationInfoV6 groupId(String groupId) { + this.groupId = groupId; return this; } - public WidgetCreationInfoV6 addCcsItem(WidgetCcInfo ccsItem) { - if (this.ccs == null) { - this.ccs = new ArrayList(); - } - this.ccs.add(ccsItem); + /** + * The ID of the group to which the widget belongs to. If not provided during creation, primary group of the creator will be used + * @return groupId + **/ + @ApiModelProperty(value = "The ID of the group to which the widget belongs to. If not provided during creation, primary group of the creator will be used") + public String getGroupId() { + return groupId; + } + + public void setGroupId(String groupId) { + this.groupId = groupId; + } + + public WidgetCreationInfoV6 locale(String locale) { + this.locale = locale; return this; } /** - * A list of one or more email addresses that you want to copy on this transaction. The email addresses will each receive an email when the final agreement created through widget is signed. The email addresses will also receive a copy of the document, attached as a PDF file - * @return ccs + * The locale associated with this web form - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the web form creator + * @return locale **/ - @ApiModelProperty(value = "A list of one or more email addresses that you want to copy on this transaction. The email addresses will each receive an email when the final agreement created through widget is signed. The email addresses will also receive a copy of the document, attached as a PDF file") - public List getCcs() { - return ccs; + @ApiModelProperty(value = "The locale associated with this web form - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the web form creator") + public String getLocale() { + return locale; } - public void setCcs(List ccs) { - this.ccs = ccs; + public void setLocale(String locale) { + this.locale = locale; } - public WidgetCreationInfoV6 completionInfo(WidgetRedirectionInfo completionInfo) { - this.completionInfo = completionInfo; + public WidgetCreationInfoV6 vaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; return this; } /** - * URL and associated properties for the success page the widget signer will be taken to after performing desired action on the widget - * @return completionInfo + * Vaulting properties that allows Adobe Sign to securely store documents with a vault provider + * @return vaultingInfo **/ - @ApiModelProperty(value = "URL and associated properties for the success page the widget signer will be taken to after performing desired action on the widget") - public WidgetRedirectionInfo getCompletionInfo() { - return completionInfo; + @ApiModelProperty(value = "Vaulting properties that allows Adobe Sign to securely store documents with a vault provider") + public VaultingInfo getVaultingInfo() { + return vaultingInfo; } - public void setCompletionInfo(WidgetRedirectionInfo completionInfo) { - this.completionInfo = completionInfo; + public void setVaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; } - public WidgetCreationInfoV6 createdDate(Date createdDate) { - this.createdDate = createdDate; + public WidgetCreationInfoV6 securityOption(SecurityOption securityOption) { + this.securityOption = securityOption; return this; } /** - * Date when widget was created. If provided in POST, it will simply be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time - * @return createdDate + * Secondary security parameters for the web form + * @return securityOption **/ - @ApiModelProperty(value = "Date when widget was created. If provided in POST, it will simply be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") - public Date getCreatedDate() { - return createdDate; + @ApiModelProperty(value = "Secondary security parameters for the web form") + public SecurityOption getSecurityOption() { + return securityOption; } - public void setCreatedDate(Date createdDate) { - this.createdDate = createdDate; + public void setSecurityOption(SecurityOption securityOption) { + this.securityOption = securityOption; } - public WidgetCreationInfoV6 creatorEmail(String creatorEmail) { - this.creatorEmail = creatorEmail; + public WidgetCreationInfoV6 widgetParticipantSetInfo(WidgetParticipantSetInfo widgetParticipantSetInfo) { + this.widgetParticipantSetInfo = widgetParticipantSetInfo; return this; } /** - * Email of widget creator. Only returned in GET response. Cannot be provided in POST/PUT request. If provided in POST, it will simply be ignored - * @return creatorEmail + * Represents web form participant for whom email should not be provided + * @return widgetParticipantSetInfo **/ - @ApiModelProperty(value = "Email of widget creator. Only returned in GET response. Cannot be provided in POST/PUT request. If provided in POST, it will simply be ignored") - public String getCreatorEmail() { - return creatorEmail; + @ApiModelProperty(value = "Represents web form participant for whom email should not be provided") + public WidgetParticipantSetInfo getWidgetParticipantSetInfo() { + return widgetParticipantSetInfo; } - public void setCreatorEmail(String creatorEmail) { - this.creatorEmail = creatorEmail; + public void setWidgetParticipantSetInfo(WidgetParticipantSetInfo widgetParticipantSetInfo) { + this.widgetParticipantSetInfo = widgetParticipantSetInfo; } - public WidgetCreationInfoV6 fileInfos(List fileInfos) { - this.fileInfos = fileInfos; + public WidgetCreationInfoV6 widgetInActiveInfo(WidgetInActiveInfo widgetInActiveInfo) { + this.widgetInActiveInfo = widgetInActiveInfo; return this; } - public WidgetCreationInfoV6 addFileInfosItem(FileInfo fileInfosItem) { - if (this.fileInfos == null) { - this.fileInfos = new ArrayList(); + /** + * The custom message which will be displayed to the user or the URL to which user will be redirected when the web form is accessed in a disabled state. This can only be specified in PUT request + * @return widgetInActiveInfo + **/ + @ApiModelProperty(value = "The custom message which will be displayed to the user or the URL to which user will be redirected when the web form is accessed in a disabled state. This can only be specified in PUT request") + public WidgetInActiveInfo getWidgetInActiveInfo() { + return widgetInActiveInfo; + } + + public void setWidgetInActiveInfo(WidgetInActiveInfo widgetInActiveInfo) { + this.widgetInActiveInfo = widgetInActiveInfo; + } + + public WidgetCreationInfoV6 ccs(List ccs) { + this.ccs = ccs; + return this; + } + + public WidgetCreationInfoV6 addCcsItem(WidgetCcInfo ccsItem) { + if (this.ccs == null) { + this.ccs = new ArrayList(); } - this.fileInfos.add(fileInfosItem); + this.ccs.add(ccsItem); return this; } /** - * A list of one or more files (or references to files) that will be used to create the widget. If more than one file is provided, they will be combined before the widget is created. Library documents are not permitted. Note: Only one of the four parameters in every FileInfo object must be specified - * @return fileInfos + * A list of one or more email addresses that you want to copy on this transaction. The email addresses will each receive an email when the final agreement created through web form is signed. The email addresses will also receive a copy of the document, attached as a PDF file + * @return ccs **/ - @ApiModelProperty(value = "A list of one or more files (or references to files) that will be used to create the widget. If more than one file is provided, they will be combined before the widget is created. Library documents are not permitted. Note: Only one of the four parameters in every FileInfo object must be specified") - public List getFileInfos() { - return fileInfos; + @ApiModelProperty(value = "A list of one or more email addresses that you want to copy on this transaction. The email addresses will each receive an email when the final agreement created through web form is signed. The email addresses will also receive a copy of the document, attached as a PDF file") + public List getCcs() { + return ccs; } - public void setFileInfos(List fileInfos) { - this.fileInfos = fileInfos; + public void setCcs(List ccs) { + this.ccs = ccs; } - public WidgetCreationInfoV6 id(String id) { - this.id = id; + public WidgetCreationInfoV6 createdDate(Date createdDate) { + this.createdDate = createdDate; return this; } /** - * A resource identifier that can be used to uniquely identify the widget in other apis. If provided in POST, it will simply be ignored - * @return id + * Date when web form was created. If provided in POST, it will simply be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return createdDate **/ - @ApiModelProperty(value = "A resource identifier that can be used to uniquely identify the widget in other apis. If provided in POST, it will simply be ignored") - public String getId() { - return id; + @ApiModelProperty(value = "Date when web form was created. If provided in POST, it will simply be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getCreatedDate() { + return createdDate; } - public void setId(String id) { - this.id = id; + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; } - public WidgetCreationInfoV6 locale(String locale) { - this.locale = locale; + public WidgetCreationInfoV6 isDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; return this; } /** - * The locale associated with this widget - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the widget creator - * @return locale + * Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. + * @return isDocumentRetentionApplied **/ - @ApiModelProperty(value = "The locale associated with this widget - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the widget creator") - public String getLocale() { - return locale; + @ApiModelProperty(value = "Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored.") + public Boolean isIsDocumentRetentionApplied() { + return isDocumentRetentionApplied; } - public void setLocale(String locale) { - this.locale = locale; + public void setIsDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; + } + + public WidgetCreationInfoV6 lastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; + return this; + } + + /** + * The date of the last event that occurred for this web form. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return lastEventDate + **/ + @ApiModelProperty(value = "The date of the last event that occurred for this web form. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getLastEventDate() { + return lastEventDate; + } + + public void setLastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; } public WidgetCreationInfoV6 name(String name) { @@ -398,10 +438,10 @@ public WidgetCreationInfoV6 name(String name) { } /** - * The name of the widget that will be used to identify it, in emails, website and other places + * The name of the web form that will be used to identify it, in emails, website and other places * @return name **/ - @ApiModelProperty(value = "The name of the widget that will be used to identify it, in emails, website and other places") + @ApiModelProperty(value = "The name of the web form that will be used to identify it, in emails, website and other places") public String getName() { return name; } @@ -410,112 +450,120 @@ public void setName(String name) { this.name = name; } - public WidgetCreationInfoV6 securityOption(SecurityOption securityOption) { - this.securityOption = securityOption; + public WidgetCreationInfoV6 completionInfo(WidgetRedirectionInfo completionInfo) { + this.completionInfo = completionInfo; return this; } /** - * Secondary security parameters for the widget - * @return securityOption + * URL and associated properties for the success page the web form signer will be taken to after performing desired action on the web form + * @return completionInfo **/ - @ApiModelProperty(value = "Secondary security parameters for the widget") - public SecurityOption getSecurityOption() { - return securityOption; + @ApiModelProperty(value = "URL and associated properties for the success page the web form signer will be taken to after performing desired action on the web form") + public WidgetRedirectionInfo getCompletionInfo() { + return completionInfo; } - public void setSecurityOption(SecurityOption securityOption) { - this.securityOption = securityOption; + public void setCompletionInfo(WidgetRedirectionInfo completionInfo) { + this.completionInfo = completionInfo; } - public WidgetCreationInfoV6 state(StateEnum state) { - this.state = state; + public WidgetCreationInfoV6 authFailureInfo(WidgetRedirectionInfo authFailureInfo) { + this.authFailureInfo = authFailureInfo; return this; } /** - * The state in which the widget should land. For example in order to create a widget in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the widget can be obtained from GET /widgets/ID - * @return state + * URL and associated properties for the error page the web form signer will be taken after failing to authenticate + * @return authFailureInfo **/ - @ApiModelProperty(value = "The state in which the widget should land. For example in order to create a widget in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the widget can be obtained from GET /widgets/ID") - public StateEnum getState() { - return state; + @ApiModelProperty(value = "URL and associated properties for the error page the web form signer will be taken after failing to authenticate") + public WidgetRedirectionInfo getAuthFailureInfo() { + return authFailureInfo; } - public void setState(StateEnum state) { - this.state = state; + public void setAuthFailureInfo(WidgetRedirectionInfo authFailureInfo) { + this.authFailureInfo = authFailureInfo; } - public WidgetCreationInfoV6 status(StatusEnum status) { - this.status = status; + public WidgetCreationInfoV6 fileInfos(List fileInfos) { + this.fileInfos = fileInfos; + return this; + } + + public WidgetCreationInfoV6 addFileInfosItem(FileInfo fileInfosItem) { + if (this.fileInfos == null) { + this.fileInfos = new ArrayList(); + } + this.fileInfos.add(fileInfosItem); return this; } /** - * Status of the Widget. If provided in POST, it will simply be ignored - * @return status + * A list of one or more files (or references to files) that will be used to create the web form. If more than one file is provided, they will be combined before the web form is created. Library documents are not permitted. Note: Only one of the four parameters in every FileInfo object must be specified + * @return fileInfos **/ - @ApiModelProperty(value = "Status of the Widget. If provided in POST, it will simply be ignored") - public StatusEnum getStatus() { - return status; + @ApiModelProperty(value = "A list of one or more files (or references to files) that will be used to create the web form. If more than one file is provided, they will be combined before the web form is created. Library documents are not permitted. Note: Only one of the four parameters in every FileInfo object must be specified") + public List getFileInfos() { + return fileInfos; } - public void setStatus(StatusEnum status) { - this.status = status; + public void setFileInfos(List fileInfos) { + this.fileInfos = fileInfos; } - public WidgetCreationInfoV6 vaultingInfo(VaultingInfo vaultingInfo) { - this.vaultingInfo = vaultingInfo; + public WidgetCreationInfoV6 id(String id) { + this.id = id; return this; } /** - * Vaulting properties that allows Adobe Sign to securely store documents with a vault provider - * @return vaultingInfo + * A resource identifier that can be used to uniquely identify the web form in other apis. If provided in POST, it will simply be ignored + * @return id **/ - @ApiModelProperty(value = "Vaulting properties that allows Adobe Sign to securely store documents with a vault provider") - public VaultingInfo getVaultingInfo() { - return vaultingInfo; + @ApiModelProperty(value = "A resource identifier that can be used to uniquely identify the web form in other apis. If provided in POST, it will simply be ignored") + public String getId() { + return id; } - public void setVaultingInfo(VaultingInfo vaultingInfo) { - this.vaultingInfo = vaultingInfo; + public void setId(String id) { + this.id = id; } - public WidgetCreationInfoV6 widgetInActiveInfo(WidgetInActiveInfo widgetInActiveInfo) { - this.widgetInActiveInfo = widgetInActiveInfo; + public WidgetCreationInfoV6 state(StateEnum state) { + this.state = state; return this; } /** - * The custom message which will be displayed to the user or the URL to which user will be redirected when the widget is accessed in a disabled state. This can only be specified in PUT request - * @return widgetInActiveInfo + * The state in which the web form should land. For example in order to create a web form in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the web form can be obtained from GET /widgets/ID + * @return state **/ - @ApiModelProperty(value = "The custom message which will be displayed to the user or the URL to which user will be redirected when the widget is accessed in a disabled state. This can only be specified in PUT request") - public WidgetInActiveInfo getWidgetInActiveInfo() { - return widgetInActiveInfo; + @ApiModelProperty(value = "The state in which the web form should land. For example in order to create a web form in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the web form can be obtained from GET /widgets/ID") + public StateEnum getState() { + return state; } - public void setWidgetInActiveInfo(WidgetInActiveInfo widgetInActiveInfo) { - this.widgetInActiveInfo = widgetInActiveInfo; + public void setState(StateEnum state) { + this.state = state; } - public WidgetCreationInfoV6 widgetParticipantSetInfo(WidgetParticipantSetInfo widgetParticipantSetInfo) { - this.widgetParticipantSetInfo = widgetParticipantSetInfo; + public WidgetCreationInfoV6 status(StatusEnum status) { + this.status = status; return this; } /** - * Represents widget participant for whom email should not be provided - * @return widgetParticipantSetInfo + * Status of the Web Form. If provided in POST, it will simply be ignored + * @return status **/ - @ApiModelProperty(value = "Represents widget participant for whom email should not be provided") - public WidgetParticipantSetInfo getWidgetParticipantSetInfo() { - return widgetParticipantSetInfo; + @ApiModelProperty(value = "Status of the Web Form. If provided in POST, it will simply be ignored") + public StatusEnum getStatus() { + return status; } - public void setWidgetParticipantSetInfo(WidgetParticipantSetInfo widgetParticipantSetInfo) { - this.widgetParticipantSetInfo = widgetParticipantSetInfo; + public void setStatus(StatusEnum status) { + this.status = status; } @@ -529,26 +577,29 @@ public boolean equals(java.lang.Object o) { } WidgetCreationInfoV6 widgetCreationInfoV6 = (WidgetCreationInfoV6) o; return Objects.equals(this.additionalParticipantSetsInfo, widgetCreationInfoV6.additionalParticipantSetsInfo) && - Objects.equals(this.authFailureInfo, widgetCreationInfoV6.authFailureInfo) && + Objects.equals(this.creatorEmail, widgetCreationInfoV6.creatorEmail) && + Objects.equals(this.groupId, widgetCreationInfoV6.groupId) && + Objects.equals(this.locale, widgetCreationInfoV6.locale) && + Objects.equals(this.vaultingInfo, widgetCreationInfoV6.vaultingInfo) && + Objects.equals(this.securityOption, widgetCreationInfoV6.securityOption) && + Objects.equals(this.widgetParticipantSetInfo, widgetCreationInfoV6.widgetParticipantSetInfo) && + Objects.equals(this.widgetInActiveInfo, widgetCreationInfoV6.widgetInActiveInfo) && Objects.equals(this.ccs, widgetCreationInfoV6.ccs) && - Objects.equals(this.completionInfo, widgetCreationInfoV6.completionInfo) && Objects.equals(this.createdDate, widgetCreationInfoV6.createdDate) && - Objects.equals(this.creatorEmail, widgetCreationInfoV6.creatorEmail) && + Objects.equals(this.isDocumentRetentionApplied, widgetCreationInfoV6.isDocumentRetentionApplied) && + Objects.equals(this.lastEventDate, widgetCreationInfoV6.lastEventDate) && + Objects.equals(this.name, widgetCreationInfoV6.name) && + Objects.equals(this.completionInfo, widgetCreationInfoV6.completionInfo) && + Objects.equals(this.authFailureInfo, widgetCreationInfoV6.authFailureInfo) && Objects.equals(this.fileInfos, widgetCreationInfoV6.fileInfos) && Objects.equals(this.id, widgetCreationInfoV6.id) && - Objects.equals(this.locale, widgetCreationInfoV6.locale) && - Objects.equals(this.name, widgetCreationInfoV6.name) && - Objects.equals(this.securityOption, widgetCreationInfoV6.securityOption) && Objects.equals(this.state, widgetCreationInfoV6.state) && - Objects.equals(this.status, widgetCreationInfoV6.status) && - Objects.equals(this.vaultingInfo, widgetCreationInfoV6.vaultingInfo) && - Objects.equals(this.widgetInActiveInfo, widgetCreationInfoV6.widgetInActiveInfo) && - Objects.equals(this.widgetParticipantSetInfo, widgetCreationInfoV6.widgetParticipantSetInfo); + Objects.equals(this.status, widgetCreationInfoV6.status); } @Override public int hashCode() { - return Objects.hash(additionalParticipantSetsInfo, authFailureInfo, ccs, completionInfo, createdDate, creatorEmail, fileInfos, id, locale, name, securityOption, state, status, vaultingInfo, widgetInActiveInfo, widgetParticipantSetInfo); + return Objects.hash(additionalParticipantSetsInfo, creatorEmail, groupId, locale, vaultingInfo, securityOption, widgetParticipantSetInfo, widgetInActiveInfo, ccs, createdDate, isDocumentRetentionApplied, lastEventDate, name, completionInfo, authFailureInfo, fileInfos, id, state, status); } @@ -558,21 +609,24 @@ public String toString() { sb.append("class WidgetCreationInfoV6 {\n"); sb.append(" additionalParticipantSetsInfo: ").append(toIndentedString(additionalParticipantSetsInfo)).append("\n"); - sb.append(" authFailureInfo: ").append(toIndentedString(authFailureInfo)).append("\n"); + sb.append(" creatorEmail: ").append(toIndentedString(creatorEmail)).append("\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); + sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); + sb.append(" vaultingInfo: ").append(toIndentedString(vaultingInfo)).append("\n"); + sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); + sb.append(" widgetParticipantSetInfo: ").append(toIndentedString(widgetParticipantSetInfo)).append("\n"); + sb.append(" widgetInActiveInfo: ").append(toIndentedString(widgetInActiveInfo)).append("\n"); sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n"); - sb.append(" completionInfo: ").append(toIndentedString(completionInfo)).append("\n"); sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); - sb.append(" creatorEmail: ").append(toIndentedString(creatorEmail)).append("\n"); + sb.append(" isDocumentRetentionApplied: ").append(toIndentedString(isDocumentRetentionApplied)).append("\n"); + sb.append(" lastEventDate: ").append(toIndentedString(lastEventDate)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" completionInfo: ").append(toIndentedString(completionInfo)).append("\n"); + sb.append(" authFailureInfo: ").append(toIndentedString(authFailureInfo)).append("\n"); sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); sb.append(" state: ").append(toIndentedString(state)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" vaultingInfo: ").append(toIndentedString(vaultingInfo)).append("\n"); - sb.append(" widgetInActiveInfo: ").append(toIndentedString(widgetInActiveInfo)).append("\n"); - sb.append(" widgetParticipantSetInfo: ").append(toIndentedString(widgetParticipantSetInfo)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetCreationResponse.java b/src/main/java/io/swagger/client/model/widgets/WidgetCreationResponse.java index 99d910d..ceae30b 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetCreationResponse.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetCreationResponse.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,7 +27,7 @@ * A JSON object describing the widget */ @ApiModel(description = "A JSON object describing the widget") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetCreationResponse { @SerializedName("id") private String id = null; @@ -53,10 +38,10 @@ public WidgetCreationResponse id(String id) { } /** - * The unique identifier of widget which can be used to retrieve the data entered by the signers. + * The unique identifier of web form which can be used to retrieve the data entered by the signers. * @return id **/ - @ApiModelProperty(value = "The unique identifier of widget which can be used to retrieve the data entered by the signers.") + @ApiModelProperty(value = "The unique identifier of web form which can be used to retrieve the data entered by the signers.") public String getId() { return id; } diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetDocuments.java b/src/main/java/io/swagger/client/model/widgets/WidgetDocuments.java index d1c1ff2..2b823fa 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetDocuments.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetDocuments.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * WidgetDocuments */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetDocuments { @SerializedName("documents") private List documents = null; diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetEvent.java b/src/main/java/io/swagger/client/model/widgets/WidgetEvent.java index 85cd330..b11c5e8 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetEvent.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetEvent.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,46 +29,81 @@ /** * WidgetEvent */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetEvent { - @SerializedName("actingUserEmail") - private String actingUserEmail = null; + @SerializedName("date") + private Date date = null; - @SerializedName("actingUserIpAddress") - private String actingUserIpAddress = null; + @SerializedName("initiatingUserName") + private String initiatingUserName = null; + + @SerializedName("description") + private String description = null; @SerializedName("actingUserName") private String actingUserName = null; - @SerializedName("comment") - private String comment = null; + @SerializedName("actingUserIpAddress") + private String actingUserIpAddress = null; - @SerializedName("date") - private Date date = null; + @SerializedName("participantEmail") + private String participantEmail = null; - @SerializedName("description") - private String description = null; + /** + * Type of web form event + */ + @JsonAdapter(TypeEnum.Adapter.class) + public enum TypeEnum { + AUTO_CANCELLED_CONVERSION_PROBLEM("AUTO_CANCELLED_CONVERSION_PROBLEM"), + + ACTIVATED("ACTIVATED"), + + CREATED("CREATED"), + + DEACTIVATED("DEACTIVATED"), + + MODIFIED("MODIFIED"); - @SerializedName("deviceLocation") - private WidgetEventDeviceLocation deviceLocation = null; + private String value; - @SerializedName("devicePhoneNumber") - private String devicePhoneNumber = null; + TypeEnum(String value) { + this.value = value; + } - @SerializedName("digitalSignatureInfo") - private DigitalSignatureInfo digitalSignatureInfo = null; + public String getValue() { + return value; + } - @SerializedName("initiatingUserEmail") - private String initiatingUserEmail = null; + @Override + public String toString() { + return String.valueOf(value); + } - @SerializedName("initiatingUserName") - private String initiatingUserName = null; + public static TypeEnum fromValue(String text) { + for (TypeEnum b : TypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } - @SerializedName("participantEmail") - private String participantEmail = null; + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } - @SerializedName("participantId") - private String participantId = null; + @Override + public TypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return TypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("type") + private TypeEnum type = null; /** * Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). @@ -155,108 +175,94 @@ public ParticipantRoleEnum read(final JsonReader jsonReader) throws IOException @SerializedName("participantRole") private ParticipantRoleEnum participantRole = null; - @SerializedName("synchronizationId") - private String synchronizationId = null; + @SerializedName("vaultEventId") + private String vaultEventId = null; - /** - * Type of widget event - */ - @JsonAdapter(TypeEnum.Adapter.class) - public enum TypeEnum { - AUTO_CANCELLED_CONVERSION_PROBLEM("AUTO_CANCELLED_CONVERSION_PROBLEM"), - - ACTIVATED("ACTIVATED"), - - CREATED("CREATED"), - - DEACTIVATED("DEACTIVATED"), - - MODIFIED("MODIFIED"); + @SerializedName("participantId") + private String participantId = null; - private String value; + @SerializedName("versionId") + private String versionId = null; - TypeEnum(String value) { - this.value = value; - } + @SerializedName("actingUserEmail") + private String actingUserEmail = null; - public String getValue() { - return value; - } + @SerializedName("devicePhoneNumber") + private String devicePhoneNumber = null; - @Override - public String toString() { - return String.valueOf(value); - } + @SerializedName("initiatingUserEmail") + private String initiatingUserEmail = null; - public static TypeEnum fromValue(String text) { - for (TypeEnum b : TypeEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } + @SerializedName("digitalSignatureInfo") + private DigitalSignatureInfo digitalSignatureInfo = null; - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } + @SerializedName("vaultProviderName") + private String vaultProviderName = null; - @Override - public TypeEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return TypeEnum.fromValue(String.valueOf(value)); - } - } - } + @SerializedName("comment") + private String comment = null; - @SerializedName("type") - private TypeEnum type = null; + @SerializedName("id") + private String id = null; - @SerializedName("vaultEventId") - private String vaultEventId = null; + @SerializedName("synchronizationId") + private String synchronizationId = null; - @SerializedName("vaultProviderName") - private String vaultProviderName = null; + @SerializedName("deviceLocation") + private WidgetEventDeviceLocation deviceLocation = null; - @SerializedName("versionId") - private String versionId = null; + public WidgetEvent date(Date date) { + this.date = date; + return this; + } - public WidgetEvent actingUserEmail(String actingUserEmail) { - this.actingUserEmail = actingUserEmail; + /** + * The date of the audit event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return date + **/ + @ApiModelProperty(value = "The date of the audit event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getDate() { + return date; + } + + public void setDate(Date date) { + this.date = date; + } + + public WidgetEvent initiatingUserName(String initiatingUserName) { + this.initiatingUserName = initiatingUserName; return this; } /** - * Email address of the user that created the event - * @return actingUserEmail + * Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect + * @return initiatingUserName **/ - @ApiModelProperty(value = "Email address of the user that created the event") - public String getActingUserEmail() { - return actingUserEmail; + @ApiModelProperty(value = "Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect") + public String getInitiatingUserName() { + return initiatingUserName; } - public void setActingUserEmail(String actingUserEmail) { - this.actingUserEmail = actingUserEmail; + public void setInitiatingUserName(String initiatingUserName) { + this.initiatingUserName = initiatingUserName; } - public WidgetEvent actingUserIpAddress(String actingUserIpAddress) { - this.actingUserIpAddress = actingUserIpAddress; + public WidgetEvent description(String description) { + this.description = description; return this; } /** - * The IP address of the user that created the event - * @return actingUserIpAddress + * A description of the audit event + * @return description **/ - @ApiModelProperty(value = "The IP address of the user that created the event") - public String getActingUserIpAddress() { - return actingUserIpAddress; + @ApiModelProperty(value = "A description of the audit event") + public String getDescription() { + return description; } - public void setActingUserIpAddress(String actingUserIpAddress) { - this.actingUserIpAddress = actingUserIpAddress; + public void setDescription(String description) { + this.description = description; } public WidgetEvent actingUserName(String actingUserName) { @@ -277,292 +283,292 @@ public void setActingUserName(String actingUserName) { this.actingUserName = actingUserName; } - public WidgetEvent comment(String comment) { - this.comment = comment; + public WidgetEvent actingUserIpAddress(String actingUserIpAddress) { + this.actingUserIpAddress = actingUserIpAddress; return this; } /** - * The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant - * @return comment + * The IP address of the user that created the event + * @return actingUserIpAddress **/ - @ApiModelProperty(value = "The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant") - public String getComment() { - return comment; + @ApiModelProperty(value = "The IP address of the user that created the event") + public String getActingUserIpAddress() { + return actingUserIpAddress; } - public void setComment(String comment) { - this.comment = comment; + public void setActingUserIpAddress(String actingUserIpAddress) { + this.actingUserIpAddress = actingUserIpAddress; } - public WidgetEvent date(Date date) { - this.date = date; + public WidgetEvent participantEmail(String participantEmail) { + this.participantEmail = participantEmail; return this; } /** - * The date of the audit event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time - * @return date + * Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to + * @return participantEmail **/ - @ApiModelProperty(value = "The date of the audit event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") - public Date getDate() { - return date; + @ApiModelProperty(value = "Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to") + public String getParticipantEmail() { + return participantEmail; } - public void setDate(Date date) { - this.date = date; + public void setParticipantEmail(String participantEmail) { + this.participantEmail = participantEmail; } - public WidgetEvent description(String description) { - this.description = description; + public WidgetEvent type(TypeEnum type) { + this.type = type; return this; } /** - * A description of the audit event - * @return description + * Type of web form event + * @return type **/ - @ApiModelProperty(value = "A description of the audit event") - public String getDescription() { - return description; + @ApiModelProperty(value = "Type of web form event") + public TypeEnum getType() { + return type; } - public void setDescription(String description) { - this.description = description; + public void setType(TypeEnum type) { + this.type = type; } - public WidgetEvent deviceLocation(WidgetEventDeviceLocation deviceLocation) { - this.deviceLocation = deviceLocation; + public WidgetEvent participantRole(ParticipantRoleEnum participantRole) { + this.participantRole = participantRole; return this; } /** - * Location of the device that generated the event (This value may be null due to limited privileges) - * @return deviceLocation + * Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). + * @return participantRole **/ - @ApiModelProperty(value = "Location of the device that generated the event (This value may be null due to limited privileges)") - public WidgetEventDeviceLocation getDeviceLocation() { - return deviceLocation; + @ApiModelProperty(value = "Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.).") + public ParticipantRoleEnum getParticipantRole() { + return participantRole; } - public void setDeviceLocation(WidgetEventDeviceLocation deviceLocation) { - this.deviceLocation = deviceLocation; + public void setParticipantRole(ParticipantRoleEnum participantRole) { + this.participantRole = participantRole; } - public WidgetEvent devicePhoneNumber(String devicePhoneNumber) { - this.devicePhoneNumber = devicePhoneNumber; + public WidgetEvent vaultEventId(String vaultEventId) { + this.vaultEventId = vaultEventId; return this; } /** - * Phone number from the device used when the participation is completed on a mobile phone - * @return devicePhoneNumber + * The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null) + * @return vaultEventId **/ - @ApiModelProperty(value = "Phone number from the device used when the participation is completed on a mobile phone") - public String getDevicePhoneNumber() { - return devicePhoneNumber; + @ApiModelProperty(value = "The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null)") + public String getVaultEventId() { + return vaultEventId; } - public void setDevicePhoneNumber(String devicePhoneNumber) { - this.devicePhoneNumber = devicePhoneNumber; + public void setVaultEventId(String vaultEventId) { + this.vaultEventId = vaultEventId; } - public WidgetEvent digitalSignatureInfo(DigitalSignatureInfo digitalSignatureInfo) { - this.digitalSignatureInfo = digitalSignatureInfo; + public WidgetEvent participantId(String participantId) { + this.participantId = participantId; return this; } /** - * This is present for ESIGNED events when the participation is signed digitally - * @return digitalSignatureInfo + * The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to + * @return participantId **/ - @ApiModelProperty(value = "This is present for ESIGNED events when the participation is signed digitally") - public DigitalSignatureInfo getDigitalSignatureInfo() { - return digitalSignatureInfo; + @ApiModelProperty(value = "The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to") + public String getParticipantId() { + return participantId; } - public void setDigitalSignatureInfo(DigitalSignatureInfo digitalSignatureInfo) { - this.digitalSignatureInfo = digitalSignatureInfo; + public void setParticipantId(String participantId) { + this.participantId = participantId; } - public WidgetEvent initiatingUserEmail(String initiatingUserEmail) { - this.initiatingUserEmail = initiatingUserEmail; + public WidgetEvent versionId(String versionId) { + this.versionId = versionId; return this; } /** - * Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect - * @return initiatingUserEmail + * An ID which uniquely identifies the version of the document associated with this audit event + * @return versionId **/ - @ApiModelProperty(value = "Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect") - public String getInitiatingUserEmail() { - return initiatingUserEmail; + @ApiModelProperty(value = "An ID which uniquely identifies the version of the document associated with this audit event") + public String getVersionId() { + return versionId; } - public void setInitiatingUserEmail(String initiatingUserEmail) { - this.initiatingUserEmail = initiatingUserEmail; + public void setVersionId(String versionId) { + this.versionId = versionId; } - public WidgetEvent initiatingUserName(String initiatingUserName) { - this.initiatingUserName = initiatingUserName; + public WidgetEvent actingUserEmail(String actingUserEmail) { + this.actingUserEmail = actingUserEmail; return this; } /** - * Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect - * @return initiatingUserName + * Email address of the user that created the event + * @return actingUserEmail **/ - @ApiModelProperty(value = "Full name of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect") - public String getInitiatingUserName() { - return initiatingUserName; + @ApiModelProperty(value = "Email address of the user that created the event") + public String getActingUserEmail() { + return actingUserEmail; } - public void setInitiatingUserName(String initiatingUserName) { - this.initiatingUserName = initiatingUserName; + public void setActingUserEmail(String actingUserEmail) { + this.actingUserEmail = actingUserEmail; } - public WidgetEvent participantEmail(String participantEmail) { - this.participantEmail = participantEmail; + public WidgetEvent devicePhoneNumber(String devicePhoneNumber) { + this.devicePhoneNumber = devicePhoneNumber; return this; } /** - * Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to - * @return participantEmail + * Phone number from the device used when the participation is completed on a mobile phone + * @return devicePhoneNumber **/ - @ApiModelProperty(value = "Email address of the user that is the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to") - public String getParticipantEmail() { - return participantEmail; + @ApiModelProperty(value = "Phone number from the device used when the participation is completed on a mobile phone") + public String getDevicePhoneNumber() { + return devicePhoneNumber; } - public void setParticipantEmail(String participantEmail) { - this.participantEmail = participantEmail; + public void setDevicePhoneNumber(String devicePhoneNumber) { + this.devicePhoneNumber = devicePhoneNumber; } - public WidgetEvent participantId(String participantId) { - this.participantId = participantId; + public WidgetEvent initiatingUserEmail(String initiatingUserEmail) { + this.initiatingUserEmail = initiatingUserEmail; return this; } /** - * The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to - * @return participantId + * Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect + * @return initiatingUserEmail **/ - @ApiModelProperty(value = "The unique identifier of the participant for the event. This may be different than the acting user for certain event types. For example, for a DELEGATION event, this is the user who was delegated to") - public String getParticipantId() { - return participantId; + @ApiModelProperty(value = "Email address of the user that initiated the event on behalf of the acting user when the account is shared. Will be empty if there is no account sharing in effect") + public String getInitiatingUserEmail() { + return initiatingUserEmail; } - public void setParticipantId(String participantId) { - this.participantId = participantId; + public void setInitiatingUserEmail(String initiatingUserEmail) { + this.initiatingUserEmail = initiatingUserEmail; } - public WidgetEvent participantRole(ParticipantRoleEnum participantRole) { - this.participantRole = participantRole; + public WidgetEvent digitalSignatureInfo(DigitalSignatureInfo digitalSignatureInfo) { + this.digitalSignatureInfo = digitalSignatureInfo; return this; } /** - * Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.). - * @return participantRole + * This is present for ESIGNED events when the participation is signed digitally + * @return digitalSignatureInfo **/ - @ApiModelProperty(value = "Role assumed by all participants in the participant set the participant belongs to (signer, approver etc.).") - public ParticipantRoleEnum getParticipantRole() { - return participantRole; + @ApiModelProperty(value = "This is present for ESIGNED events when the participation is signed digitally") + public DigitalSignatureInfo getDigitalSignatureInfo() { + return digitalSignatureInfo; } - public void setParticipantRole(ParticipantRoleEnum participantRole) { - this.participantRole = participantRole; + public void setDigitalSignatureInfo(DigitalSignatureInfo digitalSignatureInfo) { + this.digitalSignatureInfo = digitalSignatureInfo; } - public WidgetEvent synchronizationId(String synchronizationId) { - this.synchronizationId = synchronizationId; + public WidgetEvent vaultProviderName(String vaultProviderName) { + this.vaultProviderName = vaultProviderName; return this; } /** - * A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null) - * @return synchronizationId + * Name of the vault provider for the vault event (if vaulted, otherwise null) + * @return vaultProviderName **/ - @ApiModelProperty(value = "A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null)") - public String getSynchronizationId() { - return synchronizationId; + @ApiModelProperty(value = "Name of the vault provider for the vault event (if vaulted, otherwise null)") + public String getVaultProviderName() { + return vaultProviderName; } - public void setSynchronizationId(String synchronizationId) { - this.synchronizationId = synchronizationId; + public void setVaultProviderName(String vaultProviderName) { + this.vaultProviderName = vaultProviderName; } - public WidgetEvent type(TypeEnum type) { - this.type = type; + public WidgetEvent comment(String comment) { + this.comment = comment; return this; } /** - * Type of widget event - * @return type + * The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant + * @return comment **/ - @ApiModelProperty(value = "Type of widget event") - public TypeEnum getType() { - return type; + @ApiModelProperty(value = "The event comment. For RECALLED or REJECTED, the reason given by the user that initiates the event. For DELEGATE or SHARE, the message from the acting user to the participant") + public String getComment() { + return comment; } - public void setType(TypeEnum type) { - this.type = type; + public void setComment(String comment) { + this.comment = comment; } - public WidgetEvent vaultEventId(String vaultEventId) { - this.vaultEventId = vaultEventId; + public WidgetEvent id(String id) { + this.id = id; return this; } /** - * The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null) - * @return vaultEventId + * The identifier for the event. + * @return id **/ - @ApiModelProperty(value = "The identifier assigned by the vault provider for the vault event (if vaulted, otherwise null)") - public String getVaultEventId() { - return vaultEventId; + @ApiModelProperty(value = "The identifier for the event.") + public String getId() { + return id; } - public void setVaultEventId(String vaultEventId) { - this.vaultEventId = vaultEventId; + public void setId(String id) { + this.id = id; } - public WidgetEvent vaultProviderName(String vaultProviderName) { - this.vaultProviderName = vaultProviderName; + public WidgetEvent synchronizationId(String synchronizationId) { + this.synchronizationId = synchronizationId; return this; } /** - * Name of the vault provider for the vault event (if vaulted, otherwise null) - * @return vaultProviderName + * A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null) + * @return synchronizationId **/ - @ApiModelProperty(value = "Name of the vault provider for the vault event (if vaulted, otherwise null)") - public String getVaultProviderName() { - return vaultProviderName; + @ApiModelProperty(value = "A unique identifier linking offline events to synchronization events (specified for offline signing events and synchronization events, else null)") + public String getSynchronizationId() { + return synchronizationId; } - public void setVaultProviderName(String vaultProviderName) { - this.vaultProviderName = vaultProviderName; + public void setSynchronizationId(String synchronizationId) { + this.synchronizationId = synchronizationId; } - public WidgetEvent versionId(String versionId) { - this.versionId = versionId; + public WidgetEvent deviceLocation(WidgetEventDeviceLocation deviceLocation) { + this.deviceLocation = deviceLocation; return this; } /** - * An ID which uniquely identifies the version of the document associated with this audit event - * @return versionId + * Location of the device that generated the event (This value may be null due to limited privileges) + * @return deviceLocation **/ - @ApiModelProperty(value = "An ID which uniquely identifies the version of the document associated with this audit event") - public String getVersionId() { - return versionId; + @ApiModelProperty(value = "Location of the device that generated the event (This value may be null due to limited privileges)") + public WidgetEventDeviceLocation getDeviceLocation() { + return deviceLocation; } - public void setVersionId(String versionId) { - this.versionId = versionId; + public void setDeviceLocation(WidgetEventDeviceLocation deviceLocation) { + this.deviceLocation = deviceLocation; } @@ -575,30 +581,31 @@ public boolean equals(java.lang.Object o) { return false; } WidgetEvent widgetEvent = (WidgetEvent) o; - return Objects.equals(this.actingUserEmail, widgetEvent.actingUserEmail) && - Objects.equals(this.actingUserIpAddress, widgetEvent.actingUserIpAddress) && - Objects.equals(this.actingUserName, widgetEvent.actingUserName) && - Objects.equals(this.comment, widgetEvent.comment) && - Objects.equals(this.date, widgetEvent.date) && - Objects.equals(this.description, widgetEvent.description) && - Objects.equals(this.deviceLocation, widgetEvent.deviceLocation) && - Objects.equals(this.devicePhoneNumber, widgetEvent.devicePhoneNumber) && - Objects.equals(this.digitalSignatureInfo, widgetEvent.digitalSignatureInfo) && - Objects.equals(this.initiatingUserEmail, widgetEvent.initiatingUserEmail) && + return Objects.equals(this.date, widgetEvent.date) && Objects.equals(this.initiatingUserName, widgetEvent.initiatingUserName) && + Objects.equals(this.description, widgetEvent.description) && + Objects.equals(this.actingUserName, widgetEvent.actingUserName) && + Objects.equals(this.actingUserIpAddress, widgetEvent.actingUserIpAddress) && Objects.equals(this.participantEmail, widgetEvent.participantEmail) && - Objects.equals(this.participantId, widgetEvent.participantId) && - Objects.equals(this.participantRole, widgetEvent.participantRole) && - Objects.equals(this.synchronizationId, widgetEvent.synchronizationId) && Objects.equals(this.type, widgetEvent.type) && + Objects.equals(this.participantRole, widgetEvent.participantRole) && Objects.equals(this.vaultEventId, widgetEvent.vaultEventId) && + Objects.equals(this.participantId, widgetEvent.participantId) && + Objects.equals(this.versionId, widgetEvent.versionId) && + Objects.equals(this.actingUserEmail, widgetEvent.actingUserEmail) && + Objects.equals(this.devicePhoneNumber, widgetEvent.devicePhoneNumber) && + Objects.equals(this.initiatingUserEmail, widgetEvent.initiatingUserEmail) && + Objects.equals(this.digitalSignatureInfo, widgetEvent.digitalSignatureInfo) && Objects.equals(this.vaultProviderName, widgetEvent.vaultProviderName) && - Objects.equals(this.versionId, widgetEvent.versionId); + Objects.equals(this.comment, widgetEvent.comment) && + Objects.equals(this.id, widgetEvent.id) && + Objects.equals(this.synchronizationId, widgetEvent.synchronizationId) && + Objects.equals(this.deviceLocation, widgetEvent.deviceLocation); } @Override public int hashCode() { - return Objects.hash(actingUserEmail, actingUserIpAddress, actingUserName, comment, date, description, deviceLocation, devicePhoneNumber, digitalSignatureInfo, initiatingUserEmail, initiatingUserName, participantEmail, participantId, participantRole, synchronizationId, type, vaultEventId, vaultProviderName, versionId); + return Objects.hash(date, initiatingUserName, description, actingUserName, actingUserIpAddress, participantEmail, type, participantRole, vaultEventId, participantId, versionId, actingUserEmail, devicePhoneNumber, initiatingUserEmail, digitalSignatureInfo, vaultProviderName, comment, id, synchronizationId, deviceLocation); } @@ -607,25 +614,26 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class WidgetEvent {\n"); - sb.append(" actingUserEmail: ").append(toIndentedString(actingUserEmail)).append("\n"); - sb.append(" actingUserIpAddress: ").append(toIndentedString(actingUserIpAddress)).append("\n"); - sb.append(" actingUserName: ").append(toIndentedString(actingUserName)).append("\n"); - sb.append(" comment: ").append(toIndentedString(comment)).append("\n"); sb.append(" date: ").append(toIndentedString(date)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" deviceLocation: ").append(toIndentedString(deviceLocation)).append("\n"); - sb.append(" devicePhoneNumber: ").append(toIndentedString(devicePhoneNumber)).append("\n"); - sb.append(" digitalSignatureInfo: ").append(toIndentedString(digitalSignatureInfo)).append("\n"); - sb.append(" initiatingUserEmail: ").append(toIndentedString(initiatingUserEmail)).append("\n"); sb.append(" initiatingUserName: ").append(toIndentedString(initiatingUserName)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" actingUserName: ").append(toIndentedString(actingUserName)).append("\n"); + sb.append(" actingUserIpAddress: ").append(toIndentedString(actingUserIpAddress)).append("\n"); sb.append(" participantEmail: ").append(toIndentedString(participantEmail)).append("\n"); - sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); - sb.append(" participantRole: ").append(toIndentedString(participantRole)).append("\n"); - sb.append(" synchronizationId: ").append(toIndentedString(synchronizationId)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" participantRole: ").append(toIndentedString(participantRole)).append("\n"); sb.append(" vaultEventId: ").append(toIndentedString(vaultEventId)).append("\n"); - sb.append(" vaultProviderName: ").append(toIndentedString(vaultProviderName)).append("\n"); + sb.append(" participantId: ").append(toIndentedString(participantId)).append("\n"); sb.append(" versionId: ").append(toIndentedString(versionId)).append("\n"); + sb.append(" actingUserEmail: ").append(toIndentedString(actingUserEmail)).append("\n"); + sb.append(" devicePhoneNumber: ").append(toIndentedString(devicePhoneNumber)).append("\n"); + sb.append(" initiatingUserEmail: ").append(toIndentedString(initiatingUserEmail)).append("\n"); + sb.append(" digitalSignatureInfo: ").append(toIndentedString(digitalSignatureInfo)).append("\n"); + sb.append(" vaultProviderName: ").append(toIndentedString(vaultProviderName)).append("\n"); + sb.append(" comment: ").append(toIndentedString(comment)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" synchronizationId: ").append(toIndentedString(synchronizationId)).append("\n"); + sb.append(" deviceLocation: ").append(toIndentedString(deviceLocation)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetEventDeviceLocation.java b/src/main/java/io/swagger/client/model/widgets/WidgetEventDeviceLocation.java index 1e2e1bb..351fa29 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetEventDeviceLocation.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetEventDeviceLocation.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,7 +26,7 @@ /** * WidgetEventDeviceLocation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetEventDeviceLocation { @SerializedName("latitude") private Float latitude = null; diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetEventList.java b/src/main/java/io/swagger/client/model/widgets/WidgetEventList.java index 1c873d8..49bf036 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetEventList.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetEventList.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * WidgetEventList */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetEventList { @SerializedName("events") private List events = null; diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetInActiveInfo.java b/src/main/java/io/swagger/client/model/widgets/WidgetInActiveInfo.java index 33d8730..bba5756 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetInActiveInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetInActiveInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,48 +26,48 @@ /** * WidgetInActiveInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetInActiveInfo { - @SerializedName("message") - private String message = null; - @SerializedName("redirectUrl") private String redirectUrl = null; - public WidgetInActiveInfo message(String message) { - this.message = message; + @SerializedName("message") + private String message = null; + + public WidgetInActiveInfo redirectUrl(String redirectUrl) { + this.redirectUrl = redirectUrl; return this; } /** - * Display this custom message to the user when the widget is accessed. Note that this can contain wiki markup to include clickable links in the message. This is required if redirectUrl is not provided. Both message and redirectUrl cannot be specified. - * @return message + * Redirect the user to this URL when the web form is accessed. This is required if message is not provided. Both message and redirectUrl cannot be specified. + * @return redirectUrl **/ - @ApiModelProperty(value = "Display this custom message to the user when the widget is accessed. Note that this can contain wiki markup to include clickable links in the message. This is required if redirectUrl is not provided. Both message and redirectUrl cannot be specified.") - public String getMessage() { - return message; + @ApiModelProperty(value = "Redirect the user to this URL when the web form is accessed. This is required if message is not provided. Both message and redirectUrl cannot be specified.") + public String getRedirectUrl() { + return redirectUrl; } - public void setMessage(String message) { - this.message = message; + public void setRedirectUrl(String redirectUrl) { + this.redirectUrl = redirectUrl; } - public WidgetInActiveInfo redirectUrl(String redirectUrl) { - this.redirectUrl = redirectUrl; + public WidgetInActiveInfo message(String message) { + this.message = message; return this; } /** - * Redirect the user to this URL when the widget is accessed. This is required if message is not provided. Both message and redirectUrl cannot be specified. - * @return redirectUrl + * Display this custom message to the user when the web form is accessed. Note that this can contain wiki markup to include clickable links in the message. This is required if redirectUrl is not provided. Both message and redirectUrl cannot be specified. + * @return message **/ - @ApiModelProperty(value = "Redirect the user to this URL when the widget is accessed. This is required if message is not provided. Both message and redirectUrl cannot be specified.") - public String getRedirectUrl() { - return redirectUrl; + @ApiModelProperty(value = "Display this custom message to the user when the web form is accessed. Note that this can contain wiki markup to include clickable links in the message. This is required if redirectUrl is not provided. Both message and redirectUrl cannot be specified.") + public String getMessage() { + return message; } - public void setRedirectUrl(String redirectUrl) { - this.redirectUrl = redirectUrl; + public void setMessage(String message) { + this.message = message; } @@ -95,13 +80,13 @@ public boolean equals(java.lang.Object o) { return false; } WidgetInActiveInfo widgetInActiveInfo = (WidgetInActiveInfo) o; - return Objects.equals(this.message, widgetInActiveInfo.message) && - Objects.equals(this.redirectUrl, widgetInActiveInfo.redirectUrl); + return Objects.equals(this.redirectUrl, widgetInActiveInfo.redirectUrl) && + Objects.equals(this.message, widgetInActiveInfo.message); } @Override public int hashCode() { - return Objects.hash(message, redirectUrl); + return Objects.hash(redirectUrl, message); } @@ -110,8 +95,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class WidgetInActiveInfo {\n"); - sb.append(" message: ").append(toIndentedString(message)).append("\n"); sb.append(" redirectUrl: ").append(toIndentedString(redirectUrl)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetInfo.java b/src/main/java/io/swagger/client/model/widgets/WidgetInfo.java index e3dee6f..ce3965a 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -52,25 +37,52 @@ /** * WidgetInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetInfo { @SerializedName("additionalParticipantSetsInfo") private List additionalParticipantSetsInfo = null; - @SerializedName("authFailureInfo") - private WidgetRedirectionInfo authFailureInfo = null; + @SerializedName("creatorEmail") + private String creatorEmail = null; + + @SerializedName("groupId") + private String groupId = null; + + @SerializedName("locale") + private String locale = null; + + @SerializedName("vaultingInfo") + private VaultingInfo vaultingInfo = null; + + @SerializedName("securityOption") + private SecurityOption securityOption = null; + + @SerializedName("widgetParticipantSetInfo") + private WidgetParticipantSetInfo widgetParticipantSetInfo = null; + + @SerializedName("widgetInActiveInfo") + private WidgetInActiveInfo widgetInActiveInfo = null; @SerializedName("ccs") private List ccs = null; - @SerializedName("completionInfo") - private WidgetRedirectionInfo completionInfo = null; - @SerializedName("createdDate") private Date createdDate = null; - @SerializedName("creatorEmail") - private String creatorEmail = null; + @SerializedName("isDocumentRetentionApplied") + private Boolean isDocumentRetentionApplied = null; + + @SerializedName("lastEventDate") + private Date lastEventDate = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("completionInfo") + private WidgetRedirectionInfo completionInfo = null; + + @SerializedName("authFailureInfo") + private WidgetRedirectionInfo authFailureInfo = null; @SerializedName("fileInfos") private List fileInfos = null; @@ -78,17 +90,8 @@ public class WidgetInfo { @SerializedName("id") private String id = null; - @SerializedName("locale") - private String locale = null; - - @SerializedName("name") - private String name = null; - - @SerializedName("securityOption") - private SecurityOption securityOption = null; - /** - * The state in which the widget should land. For example in order to create a widget in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the widget can be obtained from GET /widgets/ID + * The state in which the web form should land. For example in order to create a web form in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the web form can be obtained from GET /widgets/ID */ @JsonAdapter(StateEnum.Adapter.class) public enum StateEnum { @@ -140,7 +143,7 @@ public StateEnum read(final JsonReader jsonReader) throws IOException { private StateEnum state = null; /** - * Status of the Widget. If provided in POST, it will simply be ignored + * Status of the Web Form. If provided in POST, it will simply be ignored */ @JsonAdapter(StatusEnum.Adapter.class) public enum StatusEnum { @@ -197,15 +200,6 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; - @SerializedName("vaultingInfo") - private VaultingInfo vaultingInfo = null; - - @SerializedName("widgetInActiveInfo") - private WidgetInActiveInfo widgetInActiveInfo = null; - - @SerializedName("widgetParticipantSetInfo") - private WidgetParticipantSetInfo widgetParticipantSetInfo = null; - public WidgetInfo additionalParticipantSetsInfo(List additionalParticipantSetsInfo) { this.additionalParticipantSetsInfo = additionalParticipantSetsInfo; return this; @@ -220,10 +214,10 @@ public WidgetInfo addAdditionalParticipantSetsInfoItem(WidgetAdditionalParticipa } /** - * List of all the participants in the widget except widget signer + * List of all the participants in the web form except web form signer * @return additionalParticipantSetsInfo **/ - @ApiModelProperty(value = "List of all the participants in the widget except widget signer") + @ApiModelProperty(value = "List of all the participants in the web form except web form signer") public List getAdditionalParticipantSetsInfo() { return additionalParticipantSetsInfo; } @@ -232,164 +226,210 @@ public void setAdditionalParticipantSetsInfo(List ccs) { - this.ccs = ccs; + public WidgetInfo groupId(String groupId) { + this.groupId = groupId; return this; } - public WidgetInfo addCcsItem(WidgetCcInfo ccsItem) { - if (this.ccs == null) { - this.ccs = new ArrayList(); - } - this.ccs.add(ccsItem); + /** + * The ID of the group to which the widget belongs to. If not provided during creation, primary group of the creator will be used + * @return groupId + **/ + @ApiModelProperty(value = "The ID of the group to which the widget belongs to. If not provided during creation, primary group of the creator will be used") + public String getGroupId() { + return groupId; + } + + public void setGroupId(String groupId) { + this.groupId = groupId; + } + + public WidgetInfo locale(String locale) { + this.locale = locale; return this; } /** - * A list of one or more email addresses that you want to copy on this transaction. The email addresses will each receive an email when the final agreement created through widget is signed. The email addresses will also receive a copy of the document, attached as a PDF file - * @return ccs + * The locale associated with this web form - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the web form creator + * @return locale **/ - @ApiModelProperty(value = "A list of one or more email addresses that you want to copy on this transaction. The email addresses will each receive an email when the final agreement created through widget is signed. The email addresses will also receive a copy of the document, attached as a PDF file") - public List getCcs() { - return ccs; + @ApiModelProperty(value = "The locale associated with this web form - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the web form creator") + public String getLocale() { + return locale; } - public void setCcs(List ccs) { - this.ccs = ccs; + public void setLocale(String locale) { + this.locale = locale; } - public WidgetInfo completionInfo(WidgetRedirectionInfo completionInfo) { - this.completionInfo = completionInfo; + public WidgetInfo vaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; return this; } /** - * URL and associated properties for the success page the widget signer will be taken to after performing desired action on the widget - * @return completionInfo + * Vaulting properties that allows Adobe Sign to securely store documents with a vault provider + * @return vaultingInfo **/ - @ApiModelProperty(value = "URL and associated properties for the success page the widget signer will be taken to after performing desired action on the widget") - public WidgetRedirectionInfo getCompletionInfo() { - return completionInfo; + @ApiModelProperty(value = "Vaulting properties that allows Adobe Sign to securely store documents with a vault provider") + public VaultingInfo getVaultingInfo() { + return vaultingInfo; } - public void setCompletionInfo(WidgetRedirectionInfo completionInfo) { - this.completionInfo = completionInfo; + public void setVaultingInfo(VaultingInfo vaultingInfo) { + this.vaultingInfo = vaultingInfo; } - public WidgetInfo createdDate(Date createdDate) { - this.createdDate = createdDate; + public WidgetInfo securityOption(SecurityOption securityOption) { + this.securityOption = securityOption; return this; } /** - * Date when widget was created. If provided in POST, it will simply be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time - * @return createdDate + * Secondary security parameters for the web form + * @return securityOption **/ - @ApiModelProperty(value = "Date when widget was created. If provided in POST, it will simply be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") - public Date getCreatedDate() { - return createdDate; + @ApiModelProperty(value = "Secondary security parameters for the web form") + public SecurityOption getSecurityOption() { + return securityOption; } - public void setCreatedDate(Date createdDate) { - this.createdDate = createdDate; + public void setSecurityOption(SecurityOption securityOption) { + this.securityOption = securityOption; } - public WidgetInfo creatorEmail(String creatorEmail) { - this.creatorEmail = creatorEmail; + public WidgetInfo widgetParticipantSetInfo(WidgetParticipantSetInfo widgetParticipantSetInfo) { + this.widgetParticipantSetInfo = widgetParticipantSetInfo; return this; } /** - * Email of widget creator. Only returned in GET response. Cannot be provided in POST/PUT request. If provided in POST, it will simply be ignored - * @return creatorEmail + * Represents web form participant for whom email should not be provided + * @return widgetParticipantSetInfo **/ - @ApiModelProperty(value = "Email of widget creator. Only returned in GET response. Cannot be provided in POST/PUT request. If provided in POST, it will simply be ignored") - public String getCreatorEmail() { - return creatorEmail; + @ApiModelProperty(value = "Represents web form participant for whom email should not be provided") + public WidgetParticipantSetInfo getWidgetParticipantSetInfo() { + return widgetParticipantSetInfo; } - public void setCreatorEmail(String creatorEmail) { - this.creatorEmail = creatorEmail; + public void setWidgetParticipantSetInfo(WidgetParticipantSetInfo widgetParticipantSetInfo) { + this.widgetParticipantSetInfo = widgetParticipantSetInfo; } - public WidgetInfo fileInfos(List fileInfos) { - this.fileInfos = fileInfos; + public WidgetInfo widgetInActiveInfo(WidgetInActiveInfo widgetInActiveInfo) { + this.widgetInActiveInfo = widgetInActiveInfo; return this; } - public WidgetInfo addFileInfosItem(FileInfo fileInfosItem) { - if (this.fileInfos == null) { - this.fileInfos = new ArrayList(); + /** + * The custom message which will be displayed to the user or the URL to which user will be redirected when the web form is accessed in a disabled state. This can only be specified in PUT request + * @return widgetInActiveInfo + **/ + @ApiModelProperty(value = "The custom message which will be displayed to the user or the URL to which user will be redirected when the web form is accessed in a disabled state. This can only be specified in PUT request") + public WidgetInActiveInfo getWidgetInActiveInfo() { + return widgetInActiveInfo; + } + + public void setWidgetInActiveInfo(WidgetInActiveInfo widgetInActiveInfo) { + this.widgetInActiveInfo = widgetInActiveInfo; + } + + public WidgetInfo ccs(List ccs) { + this.ccs = ccs; + return this; + } + + public WidgetInfo addCcsItem(WidgetCcInfo ccsItem) { + if (this.ccs == null) { + this.ccs = new ArrayList(); } - this.fileInfos.add(fileInfosItem); + this.ccs.add(ccsItem); return this; } /** - * A list of one or more files (or references to files) that will be used to create the widget. If more than one file is provided, they will be combined before the widget is created. Library documents are not permitted. Note: Only one of the four parameters in every FileInfo object must be specified - * @return fileInfos + * A list of one or more email addresses that you want to copy on this transaction. The email addresses will each receive an email when the final agreement created through web form is signed. The email addresses will also receive a copy of the document, attached as a PDF file + * @return ccs **/ - @ApiModelProperty(value = "A list of one or more files (or references to files) that will be used to create the widget. If more than one file is provided, they will be combined before the widget is created. Library documents are not permitted. Note: Only one of the four parameters in every FileInfo object must be specified") - public List getFileInfos() { - return fileInfos; + @ApiModelProperty(value = "A list of one or more email addresses that you want to copy on this transaction. The email addresses will each receive an email when the final agreement created through web form is signed. The email addresses will also receive a copy of the document, attached as a PDF file") + public List getCcs() { + return ccs; } - public void setFileInfos(List fileInfos) { - this.fileInfos = fileInfos; + public void setCcs(List ccs) { + this.ccs = ccs; } - public WidgetInfo id(String id) { - this.id = id; + public WidgetInfo createdDate(Date createdDate) { + this.createdDate = createdDate; return this; } /** - * A resource identifier that can be used to uniquely identify the widget in other apis. If provided in POST, it will simply be ignored - * @return id + * Date when web form was created. If provided in POST, it will simply be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return createdDate **/ - @ApiModelProperty(value = "A resource identifier that can be used to uniquely identify the widget in other apis. If provided in POST, it will simply be ignored") - public String getId() { - return id; + @ApiModelProperty(value = "Date when web form was created. If provided in POST, it will simply be ignored. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getCreatedDate() { + return createdDate; } - public void setId(String id) { - this.id = id; + public void setCreatedDate(Date createdDate) { + this.createdDate = createdDate; } - public WidgetInfo locale(String locale) { - this.locale = locale; + public WidgetInfo isDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; return this; } /** - * The locale associated with this widget - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the widget creator - * @return locale + * Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. + * @return isDocumentRetentionApplied **/ - @ApiModelProperty(value = "The locale associated with this widget - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the widget creator") - public String getLocale() { - return locale; + @ApiModelProperty(value = "Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored.") + public Boolean isIsDocumentRetentionApplied() { + return isDocumentRetentionApplied; } - public void setLocale(String locale) { - this.locale = locale; + public void setIsDocumentRetentionApplied(Boolean isDocumentRetentionApplied) { + this.isDocumentRetentionApplied = isDocumentRetentionApplied; + } + + public WidgetInfo lastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; + return this; + } + + /** + * The date of the last event that occurred for this web form. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return lastEventDate + **/ + @ApiModelProperty(value = "The date of the last event that occurred for this web form. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getLastEventDate() { + return lastEventDate; + } + + public void setLastEventDate(Date lastEventDate) { + this.lastEventDate = lastEventDate; } public WidgetInfo name(String name) { @@ -398,10 +438,10 @@ public WidgetInfo name(String name) { } /** - * The name of the widget that will be used to identify it, in emails, website and other places + * The name of the web form that will be used to identify it, in emails, website and other places * @return name **/ - @ApiModelProperty(value = "The name of the widget that will be used to identify it, in emails, website and other places") + @ApiModelProperty(value = "The name of the web form that will be used to identify it, in emails, website and other places") public String getName() { return name; } @@ -410,112 +450,120 @@ public void setName(String name) { this.name = name; } - public WidgetInfo securityOption(SecurityOption securityOption) { - this.securityOption = securityOption; + public WidgetInfo completionInfo(WidgetRedirectionInfo completionInfo) { + this.completionInfo = completionInfo; return this; } /** - * Secondary security parameters for the widget - * @return securityOption + * URL and associated properties for the success page the web form signer will be taken to after performing desired action on the web form + * @return completionInfo **/ - @ApiModelProperty(value = "Secondary security parameters for the widget") - public SecurityOption getSecurityOption() { - return securityOption; + @ApiModelProperty(value = "URL and associated properties for the success page the web form signer will be taken to after performing desired action on the web form") + public WidgetRedirectionInfo getCompletionInfo() { + return completionInfo; } - public void setSecurityOption(SecurityOption securityOption) { - this.securityOption = securityOption; + public void setCompletionInfo(WidgetRedirectionInfo completionInfo) { + this.completionInfo = completionInfo; } - public WidgetInfo state(StateEnum state) { - this.state = state; + public WidgetInfo authFailureInfo(WidgetRedirectionInfo authFailureInfo) { + this.authFailureInfo = authFailureInfo; return this; } /** - * The state in which the widget should land. For example in order to create a widget in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the widget can be obtained from GET /widgets/ID - * @return state + * URL and associated properties for the error page the web form signer will be taken after failing to authenticate + * @return authFailureInfo **/ - @ApiModelProperty(value = "The state in which the widget should land. For example in order to create a widget in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the widget can be obtained from GET /widgets/ID") - public StateEnum getState() { - return state; + @ApiModelProperty(value = "URL and associated properties for the error page the web form signer will be taken after failing to authenticate") + public WidgetRedirectionInfo getAuthFailureInfo() { + return authFailureInfo; } - public void setState(StateEnum state) { - this.state = state; + public void setAuthFailureInfo(WidgetRedirectionInfo authFailureInfo) { + this.authFailureInfo = authFailureInfo; } - public WidgetInfo status(StatusEnum status) { - this.status = status; + public WidgetInfo fileInfos(List fileInfos) { + this.fileInfos = fileInfos; + return this; + } + + public WidgetInfo addFileInfosItem(FileInfo fileInfosItem) { + if (this.fileInfos == null) { + this.fileInfos = new ArrayList(); + } + this.fileInfos.add(fileInfosItem); return this; } /** - * Status of the Widget. If provided in POST, it will simply be ignored - * @return status + * A list of one or more files (or references to files) that will be used to create the web form. If more than one file is provided, they will be combined before the web form is created. Library documents are not permitted. Note: Only one of the four parameters in every FileInfo object must be specified + * @return fileInfos **/ - @ApiModelProperty(value = "Status of the Widget. If provided in POST, it will simply be ignored") - public StatusEnum getStatus() { - return status; + @ApiModelProperty(value = "A list of one or more files (or references to files) that will be used to create the web form. If more than one file is provided, they will be combined before the web form is created. Library documents are not permitted. Note: Only one of the four parameters in every FileInfo object must be specified") + public List getFileInfos() { + return fileInfos; } - public void setStatus(StatusEnum status) { - this.status = status; + public void setFileInfos(List fileInfos) { + this.fileInfos = fileInfos; } - public WidgetInfo vaultingInfo(VaultingInfo vaultingInfo) { - this.vaultingInfo = vaultingInfo; + public WidgetInfo id(String id) { + this.id = id; return this; } /** - * Vaulting properties that allows Adobe Sign to securely store documents with a vault provider - * @return vaultingInfo + * A resource identifier that can be used to uniquely identify the web form in other apis. If provided in POST, it will simply be ignored + * @return id **/ - @ApiModelProperty(value = "Vaulting properties that allows Adobe Sign to securely store documents with a vault provider") - public VaultingInfo getVaultingInfo() { - return vaultingInfo; + @ApiModelProperty(value = "A resource identifier that can be used to uniquely identify the web form in other apis. If provided in POST, it will simply be ignored") + public String getId() { + return id; } - public void setVaultingInfo(VaultingInfo vaultingInfo) { - this.vaultingInfo = vaultingInfo; + public void setId(String id) { + this.id = id; } - public WidgetInfo widgetInActiveInfo(WidgetInActiveInfo widgetInActiveInfo) { - this.widgetInActiveInfo = widgetInActiveInfo; + public WidgetInfo state(StateEnum state) { + this.state = state; return this; } /** - * The custom message which will be displayed to the user or the URL to which user will be redirected when the widget is accessed in a disabled state. This can only be specified in PUT request - * @return widgetInActiveInfo + * The state in which the web form should land. For example in order to create a web form in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the web form can be obtained from GET /widgets/ID + * @return state **/ - @ApiModelProperty(value = "The custom message which will be displayed to the user or the URL to which user will be redirected when the widget is accessed in a disabled state. This can only be specified in PUT request") - public WidgetInActiveInfo getWidgetInActiveInfo() { - return widgetInActiveInfo; + @ApiModelProperty(value = "The state in which the web form should land. For example in order to create a web form in DRAFT state, field should be DRAFT. The state field will never get returned in GET /widgets/{ID} and will be ignored if provided in PUT /widgets/{ID} call. The eventual status of the web form can be obtained from GET /widgets/ID") + public StateEnum getState() { + return state; } - public void setWidgetInActiveInfo(WidgetInActiveInfo widgetInActiveInfo) { - this.widgetInActiveInfo = widgetInActiveInfo; + public void setState(StateEnum state) { + this.state = state; } - public WidgetInfo widgetParticipantSetInfo(WidgetParticipantSetInfo widgetParticipantSetInfo) { - this.widgetParticipantSetInfo = widgetParticipantSetInfo; + public WidgetInfo status(StatusEnum status) { + this.status = status; return this; } /** - * Represents widget participant for whom email should not be provided - * @return widgetParticipantSetInfo + * Status of the Web Form. If provided in POST, it will simply be ignored + * @return status **/ - @ApiModelProperty(value = "Represents widget participant for whom email should not be provided") - public WidgetParticipantSetInfo getWidgetParticipantSetInfo() { - return widgetParticipantSetInfo; + @ApiModelProperty(value = "Status of the Web Form. If provided in POST, it will simply be ignored") + public StatusEnum getStatus() { + return status; } - public void setWidgetParticipantSetInfo(WidgetParticipantSetInfo widgetParticipantSetInfo) { - this.widgetParticipantSetInfo = widgetParticipantSetInfo; + public void setStatus(StatusEnum status) { + this.status = status; } @@ -529,26 +577,29 @@ public boolean equals(java.lang.Object o) { } WidgetInfo widgetInfo = (WidgetInfo) o; return Objects.equals(this.additionalParticipantSetsInfo, widgetInfo.additionalParticipantSetsInfo) && - Objects.equals(this.authFailureInfo, widgetInfo.authFailureInfo) && + Objects.equals(this.creatorEmail, widgetInfo.creatorEmail) && + Objects.equals(this.groupId, widgetInfo.groupId) && + Objects.equals(this.locale, widgetInfo.locale) && + Objects.equals(this.vaultingInfo, widgetInfo.vaultingInfo) && + Objects.equals(this.securityOption, widgetInfo.securityOption) && + Objects.equals(this.widgetParticipantSetInfo, widgetInfo.widgetParticipantSetInfo) && + Objects.equals(this.widgetInActiveInfo, widgetInfo.widgetInActiveInfo) && Objects.equals(this.ccs, widgetInfo.ccs) && - Objects.equals(this.completionInfo, widgetInfo.completionInfo) && Objects.equals(this.createdDate, widgetInfo.createdDate) && - Objects.equals(this.creatorEmail, widgetInfo.creatorEmail) && + Objects.equals(this.isDocumentRetentionApplied, widgetInfo.isDocumentRetentionApplied) && + Objects.equals(this.lastEventDate, widgetInfo.lastEventDate) && + Objects.equals(this.name, widgetInfo.name) && + Objects.equals(this.completionInfo, widgetInfo.completionInfo) && + Objects.equals(this.authFailureInfo, widgetInfo.authFailureInfo) && Objects.equals(this.fileInfos, widgetInfo.fileInfos) && Objects.equals(this.id, widgetInfo.id) && - Objects.equals(this.locale, widgetInfo.locale) && - Objects.equals(this.name, widgetInfo.name) && - Objects.equals(this.securityOption, widgetInfo.securityOption) && Objects.equals(this.state, widgetInfo.state) && - Objects.equals(this.status, widgetInfo.status) && - Objects.equals(this.vaultingInfo, widgetInfo.vaultingInfo) && - Objects.equals(this.widgetInActiveInfo, widgetInfo.widgetInActiveInfo) && - Objects.equals(this.widgetParticipantSetInfo, widgetInfo.widgetParticipantSetInfo); + Objects.equals(this.status, widgetInfo.status); } @Override public int hashCode() { - return Objects.hash(additionalParticipantSetsInfo, authFailureInfo, ccs, completionInfo, createdDate, creatorEmail, fileInfos, id, locale, name, securityOption, state, status, vaultingInfo, widgetInActiveInfo, widgetParticipantSetInfo); + return Objects.hash(additionalParticipantSetsInfo, creatorEmail, groupId, locale, vaultingInfo, securityOption, widgetParticipantSetInfo, widgetInActiveInfo, ccs, createdDate, isDocumentRetentionApplied, lastEventDate, name, completionInfo, authFailureInfo, fileInfos, id, state, status); } @@ -558,21 +609,24 @@ public String toString() { sb.append("class WidgetInfo {\n"); sb.append(" additionalParticipantSetsInfo: ").append(toIndentedString(additionalParticipantSetsInfo)).append("\n"); - sb.append(" authFailureInfo: ").append(toIndentedString(authFailureInfo)).append("\n"); + sb.append(" creatorEmail: ").append(toIndentedString(creatorEmail)).append("\n"); + sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n"); + sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); + sb.append(" vaultingInfo: ").append(toIndentedString(vaultingInfo)).append("\n"); + sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); + sb.append(" widgetParticipantSetInfo: ").append(toIndentedString(widgetParticipantSetInfo)).append("\n"); + sb.append(" widgetInActiveInfo: ").append(toIndentedString(widgetInActiveInfo)).append("\n"); sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n"); - sb.append(" completionInfo: ").append(toIndentedString(completionInfo)).append("\n"); sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n"); - sb.append(" creatorEmail: ").append(toIndentedString(creatorEmail)).append("\n"); + sb.append(" isDocumentRetentionApplied: ").append(toIndentedString(isDocumentRetentionApplied)).append("\n"); + sb.append(" lastEventDate: ").append(toIndentedString(lastEventDate)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" completionInfo: ").append(toIndentedString(completionInfo)).append("\n"); + sb.append(" authFailureInfo: ").append(toIndentedString(authFailureInfo)).append("\n"); sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" securityOption: ").append(toIndentedString(securityOption)).append("\n"); sb.append(" state: ").append(toIndentedString(state)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" vaultingInfo: ").append(toIndentedString(vaultingInfo)).append("\n"); - sb.append(" widgetInActiveInfo: ").append(toIndentedString(widgetInActiveInfo)).append("\n"); - sb.append(" widgetParticipantSetInfo: ").append(toIndentedString(widgetParticipantSetInfo)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetMembersInfo.java b/src/main/java/io/swagger/client/model/widgets/WidgetMembersInfo.java index 5632504..fbf6afc 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetMembersInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetMembersInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -47,91 +32,91 @@ /** * WidgetMembersInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetMembersInfo { - @SerializedName("additionalParticipantSets") - private List additionalParticipantSets = null; - @SerializedName("ccsInfo") private List ccsInfo = null; - @SerializedName("creatorInfo") - private SenderInfo creatorInfo = null; + @SerializedName("additionalParticipantSets") + private List additionalParticipantSets = null; + + @SerializedName("widgetParticipantSet") + private DetailedWidgetParticipantSetInfo widgetParticipantSet = null; @SerializedName("sharesInfo") private List sharesInfo = null; - @SerializedName("widgetParticipantSet") - private DetailedWidgetParticipantSetInfo widgetParticipantSet = null; + @SerializedName("creatorInfo") + private SenderInfo creatorInfo = null; - public WidgetMembersInfo additionalParticipantSets(List additionalParticipantSets) { - this.additionalParticipantSets = additionalParticipantSets; + public WidgetMembersInfo ccsInfo(List ccsInfo) { + this.ccsInfo = ccsInfo; return this; } - public WidgetMembersInfo addAdditionalParticipantSetsItem(DetailedWidgetParticipantSetInfo additionalParticipantSetsItem) { - if (this.additionalParticipantSets == null) { - this.additionalParticipantSets = new ArrayList(); + public WidgetMembersInfo addCcsInfoItem(CCParticipantInfo ccsInfoItem) { + if (this.ccsInfo == null) { + this.ccsInfo = new ArrayList(); } - this.additionalParticipantSets.add(additionalParticipantSetsItem); + this.ccsInfo.add(ccsInfoItem); return this; } /** - * Information about the widget additional participant Sets - * @return additionalParticipantSets + * Information of CC participants of the web form. + * @return ccsInfo **/ - @ApiModelProperty(value = "Information about the widget additional participant Sets") - public List getAdditionalParticipantSets() { - return additionalParticipantSets; + @ApiModelProperty(value = "Information of CC participants of the web form.") + public List getCcsInfo() { + return ccsInfo; } - public void setAdditionalParticipantSets(List additionalParticipantSets) { - this.additionalParticipantSets = additionalParticipantSets; + public void setCcsInfo(List ccsInfo) { + this.ccsInfo = ccsInfo; } - public WidgetMembersInfo ccsInfo(List ccsInfo) { - this.ccsInfo = ccsInfo; + public WidgetMembersInfo additionalParticipantSets(List additionalParticipantSets) { + this.additionalParticipantSets = additionalParticipantSets; return this; } - public WidgetMembersInfo addCcsInfoItem(CCParticipantInfo ccsInfoItem) { - if (this.ccsInfo == null) { - this.ccsInfo = new ArrayList(); + public WidgetMembersInfo addAdditionalParticipantSetsItem(DetailedWidgetParticipantSetInfo additionalParticipantSetsItem) { + if (this.additionalParticipantSets == null) { + this.additionalParticipantSets = new ArrayList(); } - this.ccsInfo.add(ccsInfoItem); + this.additionalParticipantSets.add(additionalParticipantSetsItem); return this; } /** - * Information of CC participants of the widget. - * @return ccsInfo + * Information about the web form additional participant Sets + * @return additionalParticipantSets **/ - @ApiModelProperty(value = "Information of CC participants of the widget.") - public List getCcsInfo() { - return ccsInfo; + @ApiModelProperty(value = "Information about the web form additional participant Sets") + public List getAdditionalParticipantSets() { + return additionalParticipantSets; } - public void setCcsInfo(List ccsInfo) { - this.ccsInfo = ccsInfo; + public void setAdditionalParticipantSets(List additionalParticipantSets) { + this.additionalParticipantSets = additionalParticipantSets; } - public WidgetMembersInfo creatorInfo(SenderInfo creatorInfo) { - this.creatorInfo = creatorInfo; + public WidgetMembersInfo widgetParticipantSet(DetailedWidgetParticipantSetInfo widgetParticipantSet) { + this.widgetParticipantSet = widgetParticipantSet; return this; } /** - * Information of the creator of the widget. - * @return creatorInfo + * Information about the web form participant Set + * @return widgetParticipantSet **/ - @ApiModelProperty(value = "Information of the creator of the widget.") - public SenderInfo getCreatorInfo() { - return creatorInfo; + @ApiModelProperty(value = "Information about the web form participant Set") + public DetailedWidgetParticipantSetInfo getWidgetParticipantSet() { + return widgetParticipantSet; } - public void setCreatorInfo(SenderInfo creatorInfo) { - this.creatorInfo = creatorInfo; + public void setWidgetParticipantSet(DetailedWidgetParticipantSetInfo widgetParticipantSet) { + this.widgetParticipantSet = widgetParticipantSet; } public WidgetMembersInfo sharesInfo(List sharesInfo) { @@ -148,10 +133,10 @@ public WidgetMembersInfo addSharesInfoItem(ShareParticipantInfo sharesInfoItem) } /** - * Information of the participants with whom the widget has been shared. + * Information of the participants with whom the web form has been shared. * @return sharesInfo **/ - @ApiModelProperty(value = "Information of the participants with whom the widget has been shared.") + @ApiModelProperty(value = "Information of the participants with whom the web form has been shared.") public List getSharesInfo() { return sharesInfo; } @@ -160,22 +145,22 @@ public void setSharesInfo(List sharesInfo) { this.sharesInfo = sharesInfo; } - public WidgetMembersInfo widgetParticipantSet(DetailedWidgetParticipantSetInfo widgetParticipantSet) { - this.widgetParticipantSet = widgetParticipantSet; + public WidgetMembersInfo creatorInfo(SenderInfo creatorInfo) { + this.creatorInfo = creatorInfo; return this; } /** - * Information about the widget participant Set - * @return widgetParticipantSet + * Information of the creator of the web form. + * @return creatorInfo **/ - @ApiModelProperty(value = "Information about the widget participant Set") - public DetailedWidgetParticipantSetInfo getWidgetParticipantSet() { - return widgetParticipantSet; + @ApiModelProperty(value = "Information of the creator of the web form.") + public SenderInfo getCreatorInfo() { + return creatorInfo; } - public void setWidgetParticipantSet(DetailedWidgetParticipantSetInfo widgetParticipantSet) { - this.widgetParticipantSet = widgetParticipantSet; + public void setCreatorInfo(SenderInfo creatorInfo) { + this.creatorInfo = creatorInfo; } @@ -188,16 +173,16 @@ public boolean equals(java.lang.Object o) { return false; } WidgetMembersInfo widgetMembersInfo = (WidgetMembersInfo) o; - return Objects.equals(this.additionalParticipantSets, widgetMembersInfo.additionalParticipantSets) && - Objects.equals(this.ccsInfo, widgetMembersInfo.ccsInfo) && - Objects.equals(this.creatorInfo, widgetMembersInfo.creatorInfo) && + return Objects.equals(this.ccsInfo, widgetMembersInfo.ccsInfo) && + Objects.equals(this.additionalParticipantSets, widgetMembersInfo.additionalParticipantSets) && + Objects.equals(this.widgetParticipantSet, widgetMembersInfo.widgetParticipantSet) && Objects.equals(this.sharesInfo, widgetMembersInfo.sharesInfo) && - Objects.equals(this.widgetParticipantSet, widgetMembersInfo.widgetParticipantSet); + Objects.equals(this.creatorInfo, widgetMembersInfo.creatorInfo); } @Override public int hashCode() { - return Objects.hash(additionalParticipantSets, ccsInfo, creatorInfo, sharesInfo, widgetParticipantSet); + return Objects.hash(ccsInfo, additionalParticipantSets, widgetParticipantSet, sharesInfo, creatorInfo); } @@ -206,11 +191,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class WidgetMembersInfo {\n"); - sb.append(" additionalParticipantSets: ").append(toIndentedString(additionalParticipantSets)).append("\n"); sb.append(" ccsInfo: ").append(toIndentedString(ccsInfo)).append("\n"); - sb.append(" creatorInfo: ").append(toIndentedString(creatorInfo)).append("\n"); - sb.append(" sharesInfo: ").append(toIndentedString(sharesInfo)).append("\n"); + sb.append(" additionalParticipantSets: ").append(toIndentedString(additionalParticipantSets)).append("\n"); sb.append(" widgetParticipantSet: ").append(toIndentedString(widgetParticipantSet)).append("\n"); + sb.append(" sharesInfo: ").append(toIndentedString(sharesInfo)).append("\n"); + sb.append(" creatorInfo: ").append(toIndentedString(creatorInfo)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetParticipantSetInfo.java b/src/main/java/io/swagger/client/model/widgets/WidgetParticipantSetInfo.java index d3ea527..ca3bd56 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetParticipantSetInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetParticipantSetInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,13 +29,10 @@ /** * WidgetParticipantSetInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetParticipantSetInfo { - @SerializedName("memberInfos") - private List memberInfos = null; - /** - * Role assumed by all participants in the set (signer, approver, etc.) Widget First Participant will only have roles - Signer, Approver, Acceptor and Form Filler + * Role assumed by all participants in the set (signer, approver, etc.) Web Form First Participant will only have roles - Signer, Approver, Acceptor and Form Filler */ @JsonAdapter(RoleEnum.Adapter.class) public enum RoleEnum { @@ -115,6 +97,27 @@ public RoleEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("role") private RoleEnum role = null; + @SerializedName("memberInfos") + private List memberInfos = null; + + public WidgetParticipantSetInfo role(RoleEnum role) { + this.role = role; + return this; + } + + /** + * Role assumed by all participants in the set (signer, approver, etc.) Web Form First Participant will only have roles - Signer, Approver, Acceptor and Form Filler + * @return role + **/ + @ApiModelProperty(value = "Role assumed by all participants in the set (signer, approver, etc.) Web Form First Participant will only have roles - Signer, Approver, Acceptor and Form Filler") + public RoleEnum getRole() { + return role; + } + + public void setRole(RoleEnum role) { + this.role = role; + } + public WidgetParticipantSetInfo memberInfos(List memberInfos) { this.memberInfos = memberInfos; return this; @@ -129,10 +132,10 @@ public WidgetParticipantSetInfo addMemberInfosItem(ParticipantSetMemberInfo memb } /** - * Array of ParticipantInfo objects, containing participant - specific data (email, e.g.). All participants in the array belong to the same set. Currently we are supporting only one member in the set. Since the email of the widget signer is unknown at the time of widget creation, the email should be left empty and its optional security options should be provided. + * Array of ParticipantInfo objects, containing participant - specific data (email, e.g.). All participants in the array belong to the same set. Currently we are supporting only one member in the set. Since the email of the web form signer is unknown at the time of web form creation, the email should be left empty and its optional security options should be provided. * @return memberInfos **/ - @ApiModelProperty(value = "Array of ParticipantInfo objects, containing participant - specific data (email, e.g.). All participants in the array belong to the same set. Currently we are supporting only one member in the set. Since the email of the widget signer is unknown at the time of widget creation, the email should be left empty and its optional security options should be provided. ") + @ApiModelProperty(value = "Array of ParticipantInfo objects, containing participant - specific data (email, e.g.). All participants in the array belong to the same set. Currently we are supporting only one member in the set. Since the email of the web form signer is unknown at the time of web form creation, the email should be left empty and its optional security options should be provided. ") public List getMemberInfos() { return memberInfos; } @@ -141,24 +144,6 @@ public void setMemberInfos(List memberInfos) { this.memberInfos = memberInfos; } - public WidgetParticipantSetInfo role(RoleEnum role) { - this.role = role; - return this; - } - - /** - * Role assumed by all participants in the set (signer, approver, etc.) Widget First Participant will only have roles - Signer, Approver, Acceptor and Form Filler - * @return role - **/ - @ApiModelProperty(value = "Role assumed by all participants in the set (signer, approver, etc.) Widget First Participant will only have roles - Signer, Approver, Acceptor and Form Filler") - public RoleEnum getRole() { - return role; - } - - public void setRole(RoleEnum role) { - this.role = role; - } - @Override public boolean equals(java.lang.Object o) { @@ -169,13 +154,13 @@ public boolean equals(java.lang.Object o) { return false; } WidgetParticipantSetInfo widgetParticipantSetInfo = (WidgetParticipantSetInfo) o; - return Objects.equals(this.memberInfos, widgetParticipantSetInfo.memberInfos) && - Objects.equals(this.role, widgetParticipantSetInfo.role); + return Objects.equals(this.role, widgetParticipantSetInfo.role) && + Objects.equals(this.memberInfos, widgetParticipantSetInfo.memberInfos); } @Override public int hashCode() { - return Objects.hash(memberInfos, role); + return Objects.hash(role, memberInfos); } @@ -184,8 +169,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class WidgetParticipantSetInfo {\n"); - sb.append(" memberInfos: ").append(toIndentedString(memberInfos)).append("\n"); sb.append(" role: ").append(toIndentedString(role)).append("\n"); + sb.append(" memberInfos: ").append(toIndentedString(memberInfos)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetRedirectionInfo.java b/src/main/java/io/swagger/client/model/widgets/WidgetRedirectionInfo.java index 9d76f6a..862c933 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetRedirectionInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetRedirectionInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -41,51 +26,51 @@ /** * WidgetRedirectionInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetRedirectionInfo { - @SerializedName("deframe") - private Boolean deframe = null; - @SerializedName("delay") private Integer delay = null; + @SerializedName("deframe") + private Boolean deframe = null; + @SerializedName("url") private String url = null; - public WidgetRedirectionInfo deframe(Boolean deframe) { - this.deframe = deframe; + public WidgetRedirectionInfo delay(Integer delay) { + this.delay = delay; return this; } /** - * If deframe is false, the resultant page will be shown inside the widget frame. If deframe is true, the resultant page will be shown in the full browser window. Note that in the case of embedded widgets, browser security restrictions do not permit automatic redirection in the full browser window, so if deframe is true the user will instead just see a link to the success page. We recommend this scenario be avoided - in other words, setting deframe to false is recommended for embedded widgets - * @return deframe + * The delay (in seconds) before the user is taken to the resultant page. If this value is greater than 0, the user will first see the standard Adobe Sign result message, and then after a delay will be redirected to your resultant page. Note that this parameter has no effect for embedded web forms when deframe is true + * @return delay **/ - @ApiModelProperty(value = "If deframe is false, the resultant page will be shown inside the widget frame. If deframe is true, the resultant page will be shown in the full browser window. Note that in the case of embedded widgets, browser security restrictions do not permit automatic redirection in the full browser window, so if deframe is true the user will instead just see a link to the success page. We recommend this scenario be avoided - in other words, setting deframe to false is recommended for embedded widgets") - public Boolean isDeframe() { - return deframe; + @ApiModelProperty(value = "The delay (in seconds) before the user is taken to the resultant page. If this value is greater than 0, the user will first see the standard Adobe Sign result message, and then after a delay will be redirected to your resultant page. Note that this parameter has no effect for embedded web forms when deframe is true") + public Integer getDelay() { + return delay; } - public void setDeframe(Boolean deframe) { - this.deframe = deframe; + public void setDelay(Integer delay) { + this.delay = delay; } - public WidgetRedirectionInfo delay(Integer delay) { - this.delay = delay; + public WidgetRedirectionInfo deframe(Boolean deframe) { + this.deframe = deframe; return this; } /** - * The delay (in seconds) before the user is taken to the resultant page. If this value is greater than 0, the user will first see the standard Adobe Sign result message, and then after a delay will be redirected to your resultant page. Note that this parameter has no effect for embedded widgets when deframe is true - * @return delay + * If deframe is false, the resultant page will be shown inside the web form frame. If deframe is true, the resultant page will be shown in the full browser window. Note that in the case of embedded web forms, browser security restrictions do not permit automatic redirection in the full browser window, so if deframe is true the user will instead just see a link to the success page. We recommend this scenario be avoided - in other words, setting deframe to false is recommended for embedded web forms + * @return deframe **/ - @ApiModelProperty(value = "The delay (in seconds) before the user is taken to the resultant page. If this value is greater than 0, the user will first see the standard Adobe Sign result message, and then after a delay will be redirected to your resultant page. Note that this parameter has no effect for embedded widgets when deframe is true") - public Integer getDelay() { - return delay; + @ApiModelProperty(value = "If deframe is false, the resultant page will be shown inside the web form frame. If deframe is true, the resultant page will be shown in the full browser window. Note that in the case of embedded web forms, browser security restrictions do not permit automatic redirection in the full browser window, so if deframe is true the user will instead just see a link to the success page. We recommend this scenario be avoided - in other words, setting deframe to false is recommended for embedded web forms") + public Boolean isDeframe() { + return deframe; } - public void setDelay(Integer delay) { - this.delay = delay; + public void setDeframe(Boolean deframe) { + this.deframe = deframe; } public WidgetRedirectionInfo url(String url) { @@ -94,10 +79,10 @@ public WidgetRedirectionInfo url(String url) { } /** - * A publicly accessible url to which the user will be sent after successfully completing the widget. If the URL you provide includes information that allows you to identify the specific transaction, such as your own unique identifier, you can use the browser request to this URL as a callback to notify you that this transaction is completed. In addition, Adobe Sign will append a documentKey parameter to the URL which will contain the Adobe Sign DocumentKey for this signed widget, but only if the sender is the same as the API key user. Your application can use this value to get the form data for this widget + * A publicly accessible url to which the user will be sent after successfully completing the web form. If the URL you provide includes information that allows you to identify the specific transaction, such as your own unique identifier, you can use the browser request to this URL as a callback to notify you that this transaction is completed. In addition, Adobe Sign will append a documentKey parameter to the URL which will contain the Adobe Sign DocumentKey for this signed web form, but only if the sender is the same as the API key user. Your application can use this value to get the form data for this web form * @return url **/ - @ApiModelProperty(value = "A publicly accessible url to which the user will be sent after successfully completing the widget. If the URL you provide includes information that allows you to identify the specific transaction, such as your own unique identifier, you can use the browser request to this URL as a callback to notify you that this transaction is completed. In addition, Adobe Sign will append a documentKey parameter to the URL which will contain the Adobe Sign DocumentKey for this signed widget, but only if the sender is the same as the API key user. Your application can use this value to get the form data for this widget") + @ApiModelProperty(value = "A publicly accessible url to which the user will be sent after successfully completing the web form. If the URL you provide includes information that allows you to identify the specific transaction, such as your own unique identifier, you can use the browser request to this URL as a callback to notify you that this transaction is completed. In addition, Adobe Sign will append a documentKey parameter to the URL which will contain the Adobe Sign DocumentKey for this signed web form, but only if the sender is the same as the API key user. Your application can use this value to get the form data for this web form") public String getUrl() { return url; } @@ -116,14 +101,14 @@ public boolean equals(java.lang.Object o) { return false; } WidgetRedirectionInfo widgetRedirectionInfo = (WidgetRedirectionInfo) o; - return Objects.equals(this.deframe, widgetRedirectionInfo.deframe) && - Objects.equals(this.delay, widgetRedirectionInfo.delay) && + return Objects.equals(this.delay, widgetRedirectionInfo.delay) && + Objects.equals(this.deframe, widgetRedirectionInfo.deframe) && Objects.equals(this.url, widgetRedirectionInfo.url); } @Override public int hashCode() { - return Objects.hash(deframe, delay, url); + return Objects.hash(delay, deframe, url); } @@ -132,8 +117,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class WidgetRedirectionInfo {\n"); - sb.append(" deframe: ").append(toIndentedString(deframe)).append("\n"); sb.append(" delay: ").append(toIndentedString(delay)).append("\n"); + sb.append(" deframe: ").append(toIndentedString(deframe)).append("\n"); sb.append(" url: ").append(toIndentedString(url)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetStateInfo.java b/src/main/java/io/swagger/client/model/widgets/WidgetStateInfo.java index cea11d7..6777d5a 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetStateInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetStateInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,10 +27,13 @@ /** * WidgetStateInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetStateInfo { + @SerializedName("widgetInActiveInfo") + private WidgetInActiveInfo widgetInActiveInfo = null; + /** - * State of the Widget + * State of the Web Form */ @JsonAdapter(StateEnum.Adapter.class) public enum StateEnum { @@ -98,43 +86,40 @@ public StateEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("state") private StateEnum state = null; - @SerializedName("widgetInActiveInfo") - private WidgetInActiveInfo widgetInActiveInfo = null; - - public WidgetStateInfo state(StateEnum state) { - this.state = state; + public WidgetStateInfo widgetInActiveInfo(WidgetInActiveInfo widgetInActiveInfo) { + this.widgetInActiveInfo = widgetInActiveInfo; return this; } /** - * State of the Widget - * @return state + * The custom message which will be displayed to the user or the URL to which user will be redirected when the web form is accessed in a disabled state. This can only be specified in PUT request + * @return widgetInActiveInfo **/ - @ApiModelProperty(value = "State of the Widget") - public StateEnum getState() { - return state; + @ApiModelProperty(value = "The custom message which will be displayed to the user or the URL to which user will be redirected when the web form is accessed in a disabled state. This can only be specified in PUT request") + public WidgetInActiveInfo getWidgetInActiveInfo() { + return widgetInActiveInfo; } - public void setState(StateEnum state) { - this.state = state; + public void setWidgetInActiveInfo(WidgetInActiveInfo widgetInActiveInfo) { + this.widgetInActiveInfo = widgetInActiveInfo; } - public WidgetStateInfo widgetInActiveInfo(WidgetInActiveInfo widgetInActiveInfo) { - this.widgetInActiveInfo = widgetInActiveInfo; + public WidgetStateInfo state(StateEnum state) { + this.state = state; return this; } /** - * The custom message which will be displayed to the user or the URL to which user will be redirected when the widget is accessed in a disabled state. This can only be specified in PUT request - * @return widgetInActiveInfo + * State of the Web Form + * @return state **/ - @ApiModelProperty(value = "The custom message which will be displayed to the user or the URL to which user will be redirected when the widget is accessed in a disabled state. This can only be specified in PUT request") - public WidgetInActiveInfo getWidgetInActiveInfo() { - return widgetInActiveInfo; + @ApiModelProperty(value = "State of the Web Form") + public StateEnum getState() { + return state; } - public void setWidgetInActiveInfo(WidgetInActiveInfo widgetInActiveInfo) { - this.widgetInActiveInfo = widgetInActiveInfo; + public void setState(StateEnum state) { + this.state = state; } @@ -147,13 +132,13 @@ public boolean equals(java.lang.Object o) { return false; } WidgetStateInfo widgetStateInfo = (WidgetStateInfo) o; - return Objects.equals(this.state, widgetStateInfo.state) && - Objects.equals(this.widgetInActiveInfo, widgetStateInfo.widgetInActiveInfo); + return Objects.equals(this.widgetInActiveInfo, widgetStateInfo.widgetInActiveInfo) && + Objects.equals(this.state, widgetStateInfo.state); } @Override public int hashCode() { - return Objects.hash(state, widgetInActiveInfo); + return Objects.hash(widgetInActiveInfo, state); } @@ -162,8 +147,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class WidgetStateInfo {\n"); - sb.append(" state: ").append(toIndentedString(state)).append("\n"); sb.append(" widgetInActiveInfo: ").append(toIndentedString(widgetInActiveInfo)).append("\n"); + sb.append(" state: ").append(toIndentedString(state)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetView.java b/src/main/java/io/swagger/client/model/widgets/WidgetView.java index ccb87bb..aec9f18 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetView.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetView.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,19 +27,16 @@ /** * WidgetView */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetView { - @SerializedName("embeddedCode") - private String embeddedCode = null; - - @SerializedName("expiration") - private Date expiration = null; - @SerializedName("isCurrent") private Boolean isCurrent = null; + @SerializedName("embeddedCode") + private String embeddedCode = null; + /** - * Name of the requested widget view + * Name of the requested web form view */ @JsonAdapter(NameEnum.Adapter.class) public enum NameEnum { @@ -111,79 +93,82 @@ public NameEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("name") private NameEnum name = null; + @SerializedName("expiration") + private Date expiration = null; + @SerializedName("url") private String url = null; - public WidgetView embeddedCode(String embeddedCode) { - this.embeddedCode = embeddedCode; + public WidgetView isCurrent(Boolean isCurrent) { + this.isCurrent = isCurrent; return this; } /** - * Embedded code of url of resource - * @return embeddedCode + * True if this view is the current view + * @return isCurrent **/ - @ApiModelProperty(value = "Embedded code of url of resource ") - public String getEmbeddedCode() { - return embeddedCode; + @ApiModelProperty(value = "True if this view is the current view") + public Boolean isIsCurrent() { + return isCurrent; } - public void setEmbeddedCode(String embeddedCode) { - this.embeddedCode = embeddedCode; + public void setIsCurrent(Boolean isCurrent) { + this.isCurrent = isCurrent; } - public WidgetView expiration(Date expiration) { - this.expiration = expiration; + public WidgetView embeddedCode(String embeddedCode) { + this.embeddedCode = embeddedCode; return this; } /** - * Expiration of user url - * @return expiration + * Embedded code of url of resource + * @return embeddedCode **/ - @ApiModelProperty(value = "Expiration of user url ") - public Date getExpiration() { - return expiration; + @ApiModelProperty(value = "Embedded code of url of resource ") + public String getEmbeddedCode() { + return embeddedCode; } - public void setExpiration(Date expiration) { - this.expiration = expiration; + public void setEmbeddedCode(String embeddedCode) { + this.embeddedCode = embeddedCode; } - public WidgetView isCurrent(Boolean isCurrent) { - this.isCurrent = isCurrent; + public WidgetView name(NameEnum name) { + this.name = name; return this; } /** - * True if this view is the current view - * @return isCurrent + * Name of the requested web form view + * @return name **/ - @ApiModelProperty(value = "True if this view is the current view") - public Boolean isIsCurrent() { - return isCurrent; + @ApiModelProperty(value = "Name of the requested web form view") + public NameEnum getName() { + return name; } - public void setIsCurrent(Boolean isCurrent) { - this.isCurrent = isCurrent; + public void setName(NameEnum name) { + this.name = name; } - public WidgetView name(NameEnum name) { - this.name = name; + public WidgetView expiration(Date expiration) { + this.expiration = expiration; return this; } /** - * Name of the requested widget view - * @return name + * Expiration of user url + * @return expiration **/ - @ApiModelProperty(value = "Name of the requested widget view") - public NameEnum getName() { - return name; + @ApiModelProperty(value = "Expiration of user url ") + public Date getExpiration() { + return expiration; } - public void setName(NameEnum name) { - this.name = name; + public void setExpiration(Date expiration) { + this.expiration = expiration; } public WidgetView url(String url) { @@ -214,16 +199,16 @@ public boolean equals(java.lang.Object o) { return false; } WidgetView widgetView = (WidgetView) o; - return Objects.equals(this.embeddedCode, widgetView.embeddedCode) && - Objects.equals(this.expiration, widgetView.expiration) && - Objects.equals(this.isCurrent, widgetView.isCurrent) && + return Objects.equals(this.isCurrent, widgetView.isCurrent) && + Objects.equals(this.embeddedCode, widgetView.embeddedCode) && Objects.equals(this.name, widgetView.name) && + Objects.equals(this.expiration, widgetView.expiration) && Objects.equals(this.url, widgetView.url); } @Override public int hashCode() { - return Objects.hash(embeddedCode, expiration, isCurrent, name, url); + return Objects.hash(isCurrent, embeddedCode, name, expiration, url); } @@ -232,10 +217,10 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class WidgetView {\n"); - sb.append(" embeddedCode: ").append(toIndentedString(embeddedCode)).append("\n"); - sb.append(" expiration: ").append(toIndentedString(expiration)).append("\n"); sb.append(" isCurrent: ").append(toIndentedString(isCurrent)).append("\n"); + sb.append(" embeddedCode: ").append(toIndentedString(embeddedCode)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" expiration: ").append(toIndentedString(expiration)).append("\n"); sb.append(" url: ").append(toIndentedString(url)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetViewInfo.java b/src/main/java/io/swagger/client/model/widgets/WidgetViewInfo.java index e280b9e..9e32701 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetViewInfo.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetViewInfo.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -37,18 +22,19 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import io.swagger.client.model.widgets.CommonViewConfiguration; +import io.swagger.client.model.widgets.PersonalizedSigningViewConfiguration; import java.io.IOException; /** * WidgetViewInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetViewInfo { @SerializedName("commonViewConfiguration") private CommonViewConfiguration commonViewConfiguration = null; /** - * Name of the requested widget view + * Name of the requested web form view */ @JsonAdapter(NameEnum.Adapter.class) public enum NameEnum { @@ -105,6 +91,9 @@ public NameEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("name") private NameEnum name = null; + @SerializedName("personalizedSigningViewConfiguration") + private PersonalizedSigningViewConfiguration personalizedSigningViewConfiguration = null; + public WidgetViewInfo commonViewConfiguration(CommonViewConfiguration commonViewConfiguration) { this.commonViewConfiguration = commonViewConfiguration; return this; @@ -129,10 +118,10 @@ public WidgetViewInfo name(NameEnum name) { } /** - * Name of the requested widget view + * Name of the requested web form view * @return name **/ - @ApiModelProperty(value = "Name of the requested widget view") + @ApiModelProperty(value = "Name of the requested web form view") public NameEnum getName() { return name; } @@ -141,6 +130,24 @@ public void setName(NameEnum name) { this.name = name; } + public WidgetViewInfo personalizedSigningViewConfiguration(PersonalizedSigningViewConfiguration personalizedSigningViewConfiguration) { + this.personalizedSigningViewConfiguration = personalizedSigningViewConfiguration; + return this; + } + + /** + * Personalized SIGNING view configuration + * @return personalizedSigningViewConfiguration + **/ + @ApiModelProperty(value = "Personalized SIGNING view configuration") + public PersonalizedSigningViewConfiguration getPersonalizedSigningViewConfiguration() { + return personalizedSigningViewConfiguration; + } + + public void setPersonalizedSigningViewConfiguration(PersonalizedSigningViewConfiguration personalizedSigningViewConfiguration) { + this.personalizedSigningViewConfiguration = personalizedSigningViewConfiguration; + } + @Override public boolean equals(java.lang.Object o) { @@ -152,12 +159,13 @@ public boolean equals(java.lang.Object o) { } WidgetViewInfo widgetViewInfo = (WidgetViewInfo) o; return Objects.equals(this.commonViewConfiguration, widgetViewInfo.commonViewConfiguration) && - Objects.equals(this.name, widgetViewInfo.name); + Objects.equals(this.name, widgetViewInfo.name) && + Objects.equals(this.personalizedSigningViewConfiguration, widgetViewInfo.personalizedSigningViewConfiguration); } @Override public int hashCode() { - return Objects.hash(commonViewConfiguration, name); + return Objects.hash(commonViewConfiguration, name, personalizedSigningViewConfiguration); } @@ -168,6 +176,7 @@ public String toString() { sb.append(" commonViewConfiguration: ").append(toIndentedString(commonViewConfiguration)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" personalizedSigningViewConfiguration: ").append(toIndentedString(personalizedSigningViewConfiguration)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/swagger/client/model/widgets/WidgetViews.java b/src/main/java/io/swagger/client/model/widgets/WidgetViews.java index 0bebead..c632e65 100755 --- a/src/main/java/io/swagger/client/model/widgets/WidgetViews.java +++ b/src/main/java/io/swagger/client/model/widgets/WidgetViews.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * WidgetViews */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:01.583+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:55.369+11:00") public class WidgetViews { @SerializedName("widgetViewList") private List widgetViewList = null; @@ -63,10 +48,10 @@ public WidgetViews addWidgetViewListItem(WidgetView widgetViewListItem) { } /** - * List of widget views + * List of web form views * @return widgetViewList **/ - @ApiModelProperty(value = "List of widget views") + @ApiModelProperty(value = "List of web form views") public List getWidgetViewList() { return widgetViewList; } diff --git a/src/main/java/io/swagger/client/model/workflows/CCsListInfoDescription.java b/src/main/java/io/swagger/client/model/workflows/CCsListInfoDescription.java new file mode 100644 index 0000000..1fe9dc9 --- /dev/null +++ b/src/main/java/io/swagger/client/model/workflows/CCsListInfoDescription.java @@ -0,0 +1,264 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.workflows; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * CCsListInfoDescription + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") +public class CCsListInfoDescription { + @SerializedName("minListCount") + private Integer minListCount = null; + + @SerializedName("visible") + private Boolean visible = null; + + @SerializedName("editable") + private Boolean editable = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("defaultValues") + private List defaultValues = null; + + @SerializedName("maxListCount") + private Integer maxListCount = null; + + @SerializedName("label") + private String label = null; + + @SerializedName("required") + private Boolean required = null; + + public CCsListInfoDescription minListCount(Integer minListCount) { + this.minListCount = minListCount; + return this; + } + + /** + * minimum number of entries allowed in the current CC list + * @return minListCount + **/ + @ApiModelProperty(value = "minimum number of entries allowed in the current CC list") + public Integer getMinListCount() { + return minListCount; + } + + public void setMinListCount(Integer minListCount) { + this.minListCount = minListCount; + } + + public CCsListInfoDescription visible(Boolean visible) { + this.visible = visible; + return this; + } + + /** + * Whether current field is visible or not. If visible attribute for this field is false then this field should not be shown in the agreement creation page using this workflow + * @return visible + **/ + @ApiModelProperty(value = "Whether current field is visible or not. If visible attribute for this field is false then this field should not be shown in the agreement creation page using this workflow") + public Boolean isVisible() { + return visible; + } + + public void setVisible(Boolean visible) { + this.visible = visible; + } + + public CCsListInfoDescription editable(Boolean editable) { + this.editable = editable; + return this; + } + + /** + * Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation + * @return editable + **/ + @ApiModelProperty(value = "Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation") + public Boolean isEditable() { + return editable; + } + + public void setEditable(Boolean editable) { + this.editable = editable; + } + + public CCsListInfoDescription name(String name) { + this.name = name; + return this; + } + + /** + * Name of the current CC list + * @return name + **/ + @ApiModelProperty(value = "Name of the current CC list") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public CCsListInfoDescription defaultValues(List defaultValues) { + this.defaultValues = defaultValues; + return this; + } + + public CCsListInfoDescription addDefaultValuesItem(String defaultValuesItem) { + if (this.defaultValues == null) { + this.defaultValues = new ArrayList(); + } + this.defaultValues.add(defaultValuesItem); + return this; + } + + /** + * An array of default emails that will be used if no input is provided for this list element. + * @return defaultValues + **/ + @ApiModelProperty(value = "An array of default emails that will be used if no input is provided for this list element.") + public List getDefaultValues() { + return defaultValues; + } + + public void setDefaultValues(List defaultValues) { + this.defaultValues = defaultValues; + } + + public CCsListInfoDescription maxListCount(Integer maxListCount) { + this.maxListCount = maxListCount; + return this; + } + + /** + * maximum number of entries allowed in the current CC list + * @return maxListCount + **/ + @ApiModelProperty(value = "maximum number of entries allowed in the current CC list") + public Integer getMaxListCount() { + return maxListCount; + } + + public void setMaxListCount(Integer maxListCount) { + this.maxListCount = maxListCount; + } + + public CCsListInfoDescription label(String label) { + this.label = label; + return this; + } + + /** + * A display text for the workflow user that can be used for the current CC list + * @return label + **/ + @ApiModelProperty(value = "A display text for the workflow user that can be used for the current CC list") + public String getLabel() { + return label; + } + + public void setLabel(String label) { + this.label = label; + } + + public CCsListInfoDescription required(Boolean required) { + this.required = required; + return this; + } + + /** + * Whether this field is required or optional + * @return required + **/ + @ApiModelProperty(value = "Whether this field is required or optional") + public Boolean isRequired() { + return required; + } + + public void setRequired(Boolean required) { + this.required = required; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CCsListInfoDescription ccsListInfoDescription = (CCsListInfoDescription) o; + return Objects.equals(this.minListCount, ccsListInfoDescription.minListCount) && + Objects.equals(this.visible, ccsListInfoDescription.visible) && + Objects.equals(this.editable, ccsListInfoDescription.editable) && + Objects.equals(this.name, ccsListInfoDescription.name) && + Objects.equals(this.defaultValues, ccsListInfoDescription.defaultValues) && + Objects.equals(this.maxListCount, ccsListInfoDescription.maxListCount) && + Objects.equals(this.label, ccsListInfoDescription.label) && + Objects.equals(this.required, ccsListInfoDescription.required); + } + + @Override + public int hashCode() { + return Objects.hash(minListCount, visible, editable, name, defaultValues, maxListCount, label, required); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CCsListInfoDescription {\n"); + + sb.append(" minListCount: ").append(toIndentedString(minListCount)).append("\n"); + sb.append(" visible: ").append(toIndentedString(visible)).append("\n"); + sb.append(" editable: ").append(toIndentedString(editable)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" defaultValues: ").append(toIndentedString(defaultValues)).append("\n"); + sb.append(" maxListCount: ").append(toIndentedString(maxListCount)).append("\n"); + sb.append(" label: ").append(toIndentedString(label)).append("\n"); + sb.append(" required: ").append(toIndentedString(required)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/workflows/ExpirationFieldInfoDescription.java b/src/main/java/io/swagger/client/model/workflows/ExpirationFieldInfoDescription.java new file mode 100644 index 0000000..8ac2411 --- /dev/null +++ b/src/main/java/io/swagger/client/model/workflows/ExpirationFieldInfoDescription.java @@ -0,0 +1,185 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.workflows; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * ExpirationFieldInfoDescription + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") +public class ExpirationFieldInfoDescription { + @SerializedName("maxDays") + private Integer maxDays = null; + + @SerializedName("visible") + private Boolean visible = null; + + @SerializedName("defaultValue") + private String defaultValue = null; + + @SerializedName("editable") + private Boolean editable = null; + + @SerializedName("required") + private Boolean required = null; + + public ExpirationFieldInfoDescription maxDays(Integer maxDays) { + this.maxDays = maxDays; + return this; + } + + /** + * Maximum number of days for agreement expiration + * @return maxDays + **/ + @ApiModelProperty(value = "Maximum number of days for agreement expiration") + public Integer getMaxDays() { + return maxDays; + } + + public void setMaxDays(Integer maxDays) { + this.maxDays = maxDays; + } + + public ExpirationFieldInfoDescription visible(Boolean visible) { + this.visible = visible; + return this; + } + + /** + * Whether current field is visible or not. If visible attribute for this field is false then this field should not be visible in the agreement creation UI using this workflow to user + * @return visible + **/ + @ApiModelProperty(value = "Whether current field is visible or not. If visible attribute for this field is false then this field should not be visible in the agreement creation UI using this workflow to user") + public Boolean isVisible() { + return visible; + } + + public void setVisible(Boolean visible) { + this.visible = visible; + } + + public ExpirationFieldInfoDescription defaultValue(String defaultValue) { + this.defaultValue = defaultValue; + return this; + } + + /** + * default value of the field if input for this field is not provided and this field is required + * @return defaultValue + **/ + @ApiModelProperty(value = "default value of the field if input for this field is not provided and this field is required") + public String getDefaultValue() { + return defaultValue; + } + + public void setDefaultValue(String defaultValue) { + this.defaultValue = defaultValue; + } + + public ExpirationFieldInfoDescription editable(Boolean editable) { + this.editable = editable; + return this; + } + + /** + * Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation + * @return editable + **/ + @ApiModelProperty(value = "Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation") + public Boolean isEditable() { + return editable; + } + + public void setEditable(Boolean editable) { + this.editable = editable; + } + + public ExpirationFieldInfoDescription required(Boolean required) { + this.required = required; + return this; + } + + /** + * Whether this field is required or optional + * @return required + **/ + @ApiModelProperty(value = "Whether this field is required or optional") + public Boolean isRequired() { + return required; + } + + public void setRequired(Boolean required) { + this.required = required; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ExpirationFieldInfoDescription expirationFieldInfoDescription = (ExpirationFieldInfoDescription) o; + return Objects.equals(this.maxDays, expirationFieldInfoDescription.maxDays) && + Objects.equals(this.visible, expirationFieldInfoDescription.visible) && + Objects.equals(this.defaultValue, expirationFieldInfoDescription.defaultValue) && + Objects.equals(this.editable, expirationFieldInfoDescription.editable) && + Objects.equals(this.required, expirationFieldInfoDescription.required); + } + + @Override + public int hashCode() { + return Objects.hash(maxDays, visible, defaultValue, editable, required); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ExpirationFieldInfoDescription {\n"); + + sb.append(" maxDays: ").append(toIndentedString(maxDays)).append("\n"); + sb.append(" visible: ").append(toIndentedString(visible)).append("\n"); + sb.append(" defaultValue: ").append(toIndentedString(defaultValue)).append("\n"); + sb.append(" editable: ").append(toIndentedString(editable)).append("\n"); + sb.append(" required: ").append(toIndentedString(required)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/workflows/FileInfosDescription.java b/src/main/java/io/swagger/client/model/workflows/FileInfosDescription.java new file mode 100644 index 0000000..3e8f8b8 --- /dev/null +++ b/src/main/java/io/swagger/client/model/workflows/FileInfosDescription.java @@ -0,0 +1,173 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.workflows; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.workflows.WorkflowLibraryDocument; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * FileInfosDescription + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") +public class FileInfosDescription { + @SerializedName("name") + private String name = null; + + @SerializedName("workflowLibraryDocumentSelectorList") + private List workflowLibraryDocumentSelectorList = null; + + @SerializedName("label") + private String label = null; + + @SerializedName("required") + private Boolean required = null; + + public FileInfosDescription name(String name) { + this.name = name; + return this; + } + + /** + * Name of the fileInfo element + * @return name + **/ + @ApiModelProperty(value = "Name of the fileInfo element") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public FileInfosDescription workflowLibraryDocumentSelectorList(List workflowLibraryDocumentSelectorList) { + this.workflowLibraryDocumentSelectorList = workflowLibraryDocumentSelectorList; + return this; + } + + public FileInfosDescription addWorkflowLibraryDocumentSelectorListItem(WorkflowLibraryDocument workflowLibraryDocumentSelectorListItem) { + if (this.workflowLibraryDocumentSelectorList == null) { + this.workflowLibraryDocumentSelectorList = new ArrayList(); + } + this.workflowLibraryDocumentSelectorList.add(workflowLibraryDocumentSelectorListItem); + return this; + } + + /** + * A list of workflow library documents out of which one workflow library document can be selected with this fileInfo object + * @return workflowLibraryDocumentSelectorList + **/ + @ApiModelProperty(value = "A list of workflow library documents out of which one workflow library document can be selected with this fileInfo object") + public List getWorkflowLibraryDocumentSelectorList() { + return workflowLibraryDocumentSelectorList; + } + + public void setWorkflowLibraryDocumentSelectorList(List workflowLibraryDocumentSelectorList) { + this.workflowLibraryDocumentSelectorList = workflowLibraryDocumentSelectorList; + } + + public FileInfosDescription label(String label) { + this.label = label; + return this; + } + + /** + * Display label of this field for external users + * @return label + **/ + @ApiModelProperty(value = "Display label of this field for external users") + public String getLabel() { + return label; + } + + public void setLabel(String label) { + this.label = label; + } + + public FileInfosDescription required(Boolean required) { + this.required = required; + return this; + } + + /** + * Whether this field is required or optional + * @return required + **/ + @ApiModelProperty(value = "Whether this field is required or optional") + public Boolean isRequired() { + return required; + } + + public void setRequired(Boolean required) { + this.required = required; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FileInfosDescription fileInfosDescription = (FileInfosDescription) o; + return Objects.equals(this.name, fileInfosDescription.name) && + Objects.equals(this.workflowLibraryDocumentSelectorList, fileInfosDescription.workflowLibraryDocumentSelectorList) && + Objects.equals(this.label, fileInfosDescription.label) && + Objects.equals(this.required, fileInfosDescription.required); + } + + @Override + public int hashCode() { + return Objects.hash(name, workflowLibraryDocumentSelectorList, label, required); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FileInfosDescription {\n"); + + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" workflowLibraryDocumentSelectorList: ").append(toIndentedString(workflowLibraryDocumentSelectorList)).append("\n"); + sb.append(" label: ").append(toIndentedString(label)).append("\n"); + sb.append(" required: ").append(toIndentedString(required)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/workflows/LocaleFieldInfoDescription.java b/src/main/java/io/swagger/client/model/workflows/LocaleFieldInfoDescription.java new file mode 100644 index 0000000..d9a0a57 --- /dev/null +++ b/src/main/java/io/swagger/client/model/workflows/LocaleFieldInfoDescription.java @@ -0,0 +1,195 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.workflows; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * LocaleFieldInfoDescription + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") +public class LocaleFieldInfoDescription { + @SerializedName("visible") + private Boolean visible = null; + + @SerializedName("defaultValue") + private String defaultValue = null; + + @SerializedName("editable") + private Boolean editable = null; + + @SerializedName("required") + private Boolean required = null; + + @SerializedName("availableLocales") + private List availableLocales = null; + + public LocaleFieldInfoDescription visible(Boolean visible) { + this.visible = visible; + return this; + } + + /** + * Whether current field is visible or not. If visible attribute for this field is false then this field should not be visible in the agreement creation UI using this workflow to user + * @return visible + **/ + @ApiModelProperty(value = "Whether current field is visible or not. If visible attribute for this field is false then this field should not be visible in the agreement creation UI using this workflow to user") + public Boolean isVisible() { + return visible; + } + + public void setVisible(Boolean visible) { + this.visible = visible; + } + + public LocaleFieldInfoDescription defaultValue(String defaultValue) { + this.defaultValue = defaultValue; + return this; + } + + /** + * default value of the field if input for this field is not provided and this field is required + * @return defaultValue + **/ + @ApiModelProperty(value = "default value of the field if input for this field is not provided and this field is required") + public String getDefaultValue() { + return defaultValue; + } + + public void setDefaultValue(String defaultValue) { + this.defaultValue = defaultValue; + } + + public LocaleFieldInfoDescription editable(Boolean editable) { + this.editable = editable; + return this; + } + + /** + * Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation + * @return editable + **/ + @ApiModelProperty(value = "Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation") + public Boolean isEditable() { + return editable; + } + + public void setEditable(Boolean editable) { + this.editable = editable; + } + + public LocaleFieldInfoDescription required(Boolean required) { + this.required = required; + return this; + } + + /** + * Whether this field is required or optional + * @return required + **/ + @ApiModelProperty(value = "Whether this field is required or optional") + public Boolean isRequired() { + return required; + } + + public void setRequired(Boolean required) { + this.required = required; + } + + public LocaleFieldInfoDescription availableLocales(List availableLocales) { + this.availableLocales = availableLocales; + return this; + } + + public LocaleFieldInfoDescription addAvailableLocalesItem(String availableLocalesItem) { + if (this.availableLocales == null) { + this.availableLocales = new ArrayList(); + } + this.availableLocales.add(availableLocalesItem); + return this; + } + + /** + * Which locales can be chosen for this workflow + * @return availableLocales + **/ + @ApiModelProperty(value = "Which locales can be chosen for this workflow") + public List getAvailableLocales() { + return availableLocales; + } + + public void setAvailableLocales(List availableLocales) { + this.availableLocales = availableLocales; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LocaleFieldInfoDescription localeFieldInfoDescription = (LocaleFieldInfoDescription) o; + return Objects.equals(this.visible, localeFieldInfoDescription.visible) && + Objects.equals(this.defaultValue, localeFieldInfoDescription.defaultValue) && + Objects.equals(this.editable, localeFieldInfoDescription.editable) && + Objects.equals(this.required, localeFieldInfoDescription.required) && + Objects.equals(this.availableLocales, localeFieldInfoDescription.availableLocales); + } + + @Override + public int hashCode() { + return Objects.hash(visible, defaultValue, editable, required, availableLocales); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LocaleFieldInfoDescription {\n"); + + sb.append(" visible: ").append(toIndentedString(visible)).append("\n"); + sb.append(" defaultValue: ").append(toIndentedString(defaultValue)).append("\n"); + sb.append(" editable: ").append(toIndentedString(editable)).append("\n"); + sb.append(" required: ").append(toIndentedString(required)).append("\n"); + sb.append(" availableLocales: ").append(toIndentedString(availableLocales)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/workflows/MergeFieldInfoDescription.java b/src/main/java/io/swagger/client/model/workflows/MergeFieldInfoDescription.java new file mode 100644 index 0000000..93de319 --- /dev/null +++ b/src/main/java/io/swagger/client/model/workflows/MergeFieldInfoDescription.java @@ -0,0 +1,208 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.workflows; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * MergeFieldInfoDescription + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") +public class MergeFieldInfoDescription { + @SerializedName("fieldName") + private String fieldName = null; + + @SerializedName("visible") + private Boolean visible = null; + + @SerializedName("defaultValue") + private String defaultValue = null; + + @SerializedName("displayName") + private String displayName = null; + + @SerializedName("editable") + private Boolean editable = null; + + @SerializedName("required") + private Boolean required = null; + + public MergeFieldInfoDescription fieldName(String fieldName) { + this.fieldName = fieldName; + return this; + } + + /** + * Name of the custom field in this workflow + * @return fieldName + **/ + @ApiModelProperty(value = "Name of the custom field in this workflow") + public String getFieldName() { + return fieldName; + } + + public void setFieldName(String fieldName) { + this.fieldName = fieldName; + } + + public MergeFieldInfoDescription visible(Boolean visible) { + this.visible = visible; + return this; + } + + /** + * Whether current field should be visible on agreement creation page. If visible attribute for this field is false then this field should not be shown on the agreement creation page using this workflow + * @return visible + **/ + @ApiModelProperty(value = "Whether current field should be visible on agreement creation page. If visible attribute for this field is false then this field should not be shown on the agreement creation page using this workflow") + public Boolean isVisible() { + return visible; + } + + public void setVisible(Boolean visible) { + this.visible = visible; + } + + public MergeFieldInfoDescription defaultValue(String defaultValue) { + this.defaultValue = defaultValue; + return this; + } + + /** + * default value of the field if input for this field is not provided and this field is required + * @return defaultValue + **/ + @ApiModelProperty(value = "default value of the field if input for this field is not provided and this field is required") + public String getDefaultValue() { + return defaultValue; + } + + public void setDefaultValue(String defaultValue) { + this.defaultValue = defaultValue; + } + + public MergeFieldInfoDescription displayName(String displayName) { + this.displayName = displayName; + return this; + } + + /** + * The display text that can be shown for this custom field + * @return displayName + **/ + @ApiModelProperty(value = "The display text that can be shown for this custom field") + public String getDisplayName() { + return displayName; + } + + public void setDisplayName(String displayName) { + this.displayName = displayName; + } + + public MergeFieldInfoDescription editable(Boolean editable) { + this.editable = editable; + return this; + } + + /** + * Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation + * @return editable + **/ + @ApiModelProperty(value = "Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation") + public Boolean isEditable() { + return editable; + } + + public void setEditable(Boolean editable) { + this.editable = editable; + } + + public MergeFieldInfoDescription required(Boolean required) { + this.required = required; + return this; + } + + /** + * Whether this field is required or optional + * @return required + **/ + @ApiModelProperty(value = "Whether this field is required or optional") + public Boolean isRequired() { + return required; + } + + public void setRequired(Boolean required) { + this.required = required; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + MergeFieldInfoDescription mergeFieldInfoDescription = (MergeFieldInfoDescription) o; + return Objects.equals(this.fieldName, mergeFieldInfoDescription.fieldName) && + Objects.equals(this.visible, mergeFieldInfoDescription.visible) && + Objects.equals(this.defaultValue, mergeFieldInfoDescription.defaultValue) && + Objects.equals(this.displayName, mergeFieldInfoDescription.displayName) && + Objects.equals(this.editable, mergeFieldInfoDescription.editable) && + Objects.equals(this.required, mergeFieldInfoDescription.required); + } + + @Override + public int hashCode() { + return Objects.hash(fieldName, visible, defaultValue, displayName, editable, required); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class MergeFieldInfoDescription {\n"); + + sb.append(" fieldName: ").append(toIndentedString(fieldName)).append("\n"); + sb.append(" visible: ").append(toIndentedString(visible)).append("\n"); + sb.append(" defaultValue: ").append(toIndentedString(defaultValue)).append("\n"); + sb.append(" displayName: ").append(toIndentedString(displayName)).append("\n"); + sb.append(" editable: ").append(toIndentedString(editable)).append("\n"); + sb.append(" required: ").append(toIndentedString(required)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/workflows/PasswordFieldInfoDescription.java b/src/main/java/io/swagger/client/model/workflows/PasswordFieldInfoDescription.java new file mode 100644 index 0000000..69c6598 --- /dev/null +++ b/src/main/java/io/swagger/client/model/workflows/PasswordFieldInfoDescription.java @@ -0,0 +1,208 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.workflows; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * PasswordFieldInfoDescription + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") +public class PasswordFieldInfoDescription { + @SerializedName("visible") + private Boolean visible = null; + + @SerializedName("defaultValue") + private String defaultValue = null; + + @SerializedName("editable") + private Boolean editable = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("label") + private String label = null; + + @SerializedName("required") + private Boolean required = null; + + public PasswordFieldInfoDescription visible(Boolean visible) { + this.visible = visible; + return this; + } + + /** + * Whether password info field is visible on agreement creation page + * @return visible + **/ + @ApiModelProperty(value = "Whether password info field is visible on agreement creation page") + public Boolean isVisible() { + return visible; + } + + public void setVisible(Boolean visible) { + this.visible = visible; + } + + public PasswordFieldInfoDescription defaultValue(String defaultValue) { + this.defaultValue = defaultValue; + return this; + } + + /** + * Default value of the password info field + * @return defaultValue + **/ + @ApiModelProperty(value = "Default value of the password info field") + public String getDefaultValue() { + return defaultValue; + } + + public void setDefaultValue(String defaultValue) { + this.defaultValue = defaultValue; + } + + public PasswordFieldInfoDescription editable(Boolean editable) { + this.editable = editable; + return this; + } + + /** + * Default value of the password info field + * @return editable + **/ + @ApiModelProperty(value = "Default value of the password info field") + public Boolean isEditable() { + return editable; + } + + public void setEditable(Boolean editable) { + this.editable = editable; + } + + public PasswordFieldInfoDescription name(String name) { + this.name = name; + return this; + } + + /** + * Name of password field + * @return name + **/ + @ApiModelProperty(value = "Name of password field") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public PasswordFieldInfoDescription label(String label) { + this.label = label; + return this; + } + + /** + * Label of password field + * @return label + **/ + @ApiModelProperty(value = "Label of password field") + public String getLabel() { + return label; + } + + public void setLabel(String label) { + this.label = label; + } + + public PasswordFieldInfoDescription required(Boolean required) { + this.required = required; + return this; + } + + /** + * Whether this field is required or optional + * @return required + **/ + @ApiModelProperty(value = "Whether this field is required or optional") + public Boolean isRequired() { + return required; + } + + public void setRequired(Boolean required) { + this.required = required; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PasswordFieldInfoDescription passwordFieldInfoDescription = (PasswordFieldInfoDescription) o; + return Objects.equals(this.visible, passwordFieldInfoDescription.visible) && + Objects.equals(this.defaultValue, passwordFieldInfoDescription.defaultValue) && + Objects.equals(this.editable, passwordFieldInfoDescription.editable) && + Objects.equals(this.name, passwordFieldInfoDescription.name) && + Objects.equals(this.label, passwordFieldInfoDescription.label) && + Objects.equals(this.required, passwordFieldInfoDescription.required); + } + + @Override + public int hashCode() { + return Objects.hash(visible, defaultValue, editable, name, label, required); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PasswordFieldInfoDescription {\n"); + + sb.append(" visible: ").append(toIndentedString(visible)).append("\n"); + sb.append(" defaultValue: ").append(toIndentedString(defaultValue)).append("\n"); + sb.append(" editable: ").append(toIndentedString(editable)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" label: ").append(toIndentedString(label)).append("\n"); + sb.append(" required: ").append(toIndentedString(required)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/workflows/RecipientsListInfoDescription.java b/src/main/java/io/swagger/client/model/workflows/RecipientsListInfoDescription.java new file mode 100644 index 0000000..0e146f0 --- /dev/null +++ b/src/main/java/io/swagger/client/model/workflows/RecipientsListInfoDescription.java @@ -0,0 +1,351 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.workflows; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * RecipientsListInfoDescription + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") +public class RecipientsListInfoDescription { + @SerializedName("allowSender") + private Boolean allowSender = null; + + @SerializedName("minListCount") + private Integer minListCount = null; + + @SerializedName("visible") + private Boolean visible = null; + + /** + * authentication method for the current recipient list to have access to view and sign the document + */ + @JsonAdapter(AuthenticationMethodEnum.Adapter.class) + public enum AuthenticationMethodEnum { + NONE("NONE"), + + KBA("KBA"), + + PASSWORD("PASSWORD"), + + WEB_IDENTITY("WEB_IDENTITY"); + + private String value; + + AuthenticationMethodEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static AuthenticationMethodEnum fromValue(String text) { + for (AuthenticationMethodEnum b : AuthenticationMethodEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final AuthenticationMethodEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public AuthenticationMethodEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return AuthenticationMethodEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("authenticationMethod") + private AuthenticationMethodEnum authenticationMethod = null; + + @SerializedName("allowfax") + private Boolean allowfax = null; + + @SerializedName("defaultValue") + private String defaultValue = null; + + @SerializedName("editable") + private Boolean editable = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("maxListCount") + private Integer maxListCount = null; + + @SerializedName("label") + private String label = null; + + public RecipientsListInfoDescription allowSender(Boolean allowSender) { + this.allowSender = allowSender; + return this; + } + + /** + * whether sender is allowed as a recipient + * @return allowSender + **/ + @ApiModelProperty(value = "whether sender is allowed as a recipient") + public Boolean isAllowSender() { + return allowSender; + } + + public void setAllowSender(Boolean allowSender) { + this.allowSender = allowSender; + } + + public RecipientsListInfoDescription minListCount(Integer minListCount) { + this.minListCount = minListCount; + return this; + } + + /** + * minimum number of entries allowed in the current recipient list + * @return minListCount + **/ + @ApiModelProperty(value = "minimum number of entries allowed in the current recipient list") + public Integer getMinListCount() { + return minListCount; + } + + public void setMinListCount(Integer minListCount) { + this.minListCount = minListCount; + } + + public RecipientsListInfoDescription visible(Boolean visible) { + this.visible = visible; + return this; + } + + /** + * Whether current field is visible. If visible attribute for this field is false then this field should not be shown in the agreement creation UI using this workflow to user + * @return visible + **/ + @ApiModelProperty(value = "Whether current field is visible. If visible attribute for this field is false then this field should not be shown in the agreement creation UI using this workflow to user") + public Boolean isVisible() { + return visible; + } + + public void setVisible(Boolean visible) { + this.visible = visible; + } + + public RecipientsListInfoDescription authenticationMethod(AuthenticationMethodEnum authenticationMethod) { + this.authenticationMethod = authenticationMethod; + return this; + } + + /** + * authentication method for the current recipient list to have access to view and sign the document + * @return authenticationMethod + **/ + @ApiModelProperty(value = "authentication method for the current recipient list to have access to view and sign the document") + public AuthenticationMethodEnum getAuthenticationMethod() { + return authenticationMethod; + } + + public void setAuthenticationMethod(AuthenticationMethodEnum authenticationMethod) { + this.authenticationMethod = authenticationMethod; + } + + public RecipientsListInfoDescription allowfax(Boolean allowfax) { + this.allowfax = allowfax; + return this; + } + + /** + * whether fax is allowed or not + * @return allowfax + **/ + @ApiModelProperty(value = "whether fax is allowed or not") + public Boolean isAllowfax() { + return allowfax; + } + + public void setAllowfax(Boolean allowfax) { + this.allowfax = allowfax; + } + + public RecipientsListInfoDescription defaultValue(String defaultValue) { + this.defaultValue = defaultValue; + return this; + } + + /** + * A default email or fax number + * @return defaultValue + **/ + @ApiModelProperty(value = "A default email or fax number") + public String getDefaultValue() { + return defaultValue; + } + + public void setDefaultValue(String defaultValue) { + this.defaultValue = defaultValue; + } + + public RecipientsListInfoDescription editable(Boolean editable) { + this.editable = editable; + return this; + } + + /** + * Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation + * @return editable + **/ + @ApiModelProperty(value = "Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation") + public Boolean isEditable() { + return editable; + } + + public void setEditable(Boolean editable) { + this.editable = editable; + } + + public RecipientsListInfoDescription name(String name) { + this.name = name; + return this; + } + + /** + * Name of the current RecipientInfo list + * @return name + **/ + @ApiModelProperty(value = "Name of the current RecipientInfo list") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public RecipientsListInfoDescription maxListCount(Integer maxListCount) { + this.maxListCount = maxListCount; + return this; + } + + /** + * maximum number of entries allowed in the current recipient list + * @return maxListCount + **/ + @ApiModelProperty(value = "maximum number of entries allowed in the current recipient list") + public Integer getMaxListCount() { + return maxListCount; + } + + public void setMaxListCount(Integer maxListCount) { + this.maxListCount = maxListCount; + } + + public RecipientsListInfoDescription label(String label) { + this.label = label; + return this; + } + + /** + * A display text for the workflow user that can be used for the current recipients list + * @return label + **/ + @ApiModelProperty(value = "A display text for the workflow user that can be used for the current recipients list") + public String getLabel() { + return label; + } + + public void setLabel(String label) { + this.label = label; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RecipientsListInfoDescription recipientsListInfoDescription = (RecipientsListInfoDescription) o; + return Objects.equals(this.allowSender, recipientsListInfoDescription.allowSender) && + Objects.equals(this.minListCount, recipientsListInfoDescription.minListCount) && + Objects.equals(this.visible, recipientsListInfoDescription.visible) && + Objects.equals(this.authenticationMethod, recipientsListInfoDescription.authenticationMethod) && + Objects.equals(this.allowfax, recipientsListInfoDescription.allowfax) && + Objects.equals(this.defaultValue, recipientsListInfoDescription.defaultValue) && + Objects.equals(this.editable, recipientsListInfoDescription.editable) && + Objects.equals(this.name, recipientsListInfoDescription.name) && + Objects.equals(this.maxListCount, recipientsListInfoDescription.maxListCount) && + Objects.equals(this.label, recipientsListInfoDescription.label); + } + + @Override + public int hashCode() { + return Objects.hash(allowSender, minListCount, visible, authenticationMethod, allowfax, defaultValue, editable, name, maxListCount, label); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class RecipientsListInfoDescription {\n"); + + sb.append(" allowSender: ").append(toIndentedString(allowSender)).append("\n"); + sb.append(" minListCount: ").append(toIndentedString(minListCount)).append("\n"); + sb.append(" visible: ").append(toIndentedString(visible)).append("\n"); + sb.append(" authenticationMethod: ").append(toIndentedString(authenticationMethod)).append("\n"); + sb.append(" allowfax: ").append(toIndentedString(allowfax)).append("\n"); + sb.append(" defaultValue: ").append(toIndentedString(defaultValue)).append("\n"); + sb.append(" editable: ").append(toIndentedString(editable)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" maxListCount: ").append(toIndentedString(maxListCount)).append("\n"); + sb.append(" label: ").append(toIndentedString(label)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/workflows/UserWorkflow.java b/src/main/java/io/swagger/client/model/workflows/UserWorkflow.java index fd45511..968ccf3 100755 --- a/src/main/java/io/swagger/client/model/workflows/UserWorkflow.java +++ b/src/main/java/io/swagger/client/model/workflows/UserWorkflow.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -42,23 +27,17 @@ /** * UserWorkflow */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:09.914+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") public class UserWorkflow { + @SerializedName("scopeId") + private String scopeId = null; + @SerializedName("created") private Date created = null; - @SerializedName("description") - private String description = null; - @SerializedName("displayName") private String displayName = null; - @SerializedName("id") - private String id = null; - - @SerializedName("name") - private String name = null; - /** * The workflow scope (ACCOUNT or GROUP or OTHER) */ @@ -109,8 +88,14 @@ public ScopeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("scope") private ScopeEnum scope = null; - @SerializedName("scopeId") - private String scopeId = null; + @SerializedName("name") + private String name = null; + + @SerializedName("description") + private String description = null; + + @SerializedName("id") + private String id = null; /** * The workflow status (ACTIVE or DRAFT or INACTIVE or OTHER) @@ -164,40 +149,40 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; - public UserWorkflow created(Date created) { - this.created = created; + public UserWorkflow scopeId(String scopeId) { + this.scopeId = scopeId; return this; } /** - * The date on which the workflow was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time - * @return created + * Identifier of scope. Currently it is applicable for scope GROUP only and the value will be groupId. + * @return scopeId **/ - @ApiModelProperty(value = "The date on which the workflow was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") - public Date getCreated() { - return created; + @ApiModelProperty(value = "Identifier of scope. Currently it is applicable for scope GROUP only and the value will be groupId.") + public String getScopeId() { + return scopeId; } - public void setCreated(Date created) { - this.created = created; + public void setScopeId(String scopeId) { + this.scopeId = scopeId; } - public UserWorkflow description(String description) { - this.description = description; + public UserWorkflow created(Date created) { + this.created = created; return this; } /** - * Description provided for this workflow at the time of its creation - * @return description + * The date on which the workflow was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return created **/ - @ApiModelProperty(value = "Description provided for this workflow at the time of its creation") - public String getDescription() { - return description; + @ApiModelProperty(value = "The date on which the workflow was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getCreated() { + return created; } - public void setDescription(String description) { - this.description = description; + public void setCreated(Date created) { + this.created = created; } public UserWorkflow displayName(String displayName) { @@ -218,22 +203,22 @@ public void setDisplayName(String displayName) { this.displayName = displayName; } - public UserWorkflow id(String id) { - this.id = id; + public UserWorkflow scope(ScopeEnum scope) { + this.scope = scope; return this; } /** - * The unique identifier of a workflow - * @return id + * The workflow scope (ACCOUNT or GROUP or OTHER) + * @return scope **/ - @ApiModelProperty(value = "The unique identifier of a workflow") - public String getId() { - return id; + @ApiModelProperty(value = "The workflow scope (ACCOUNT or GROUP or OTHER)") + public ScopeEnum getScope() { + return scope; } - public void setId(String id) { - this.id = id; + public void setScope(ScopeEnum scope) { + this.scope = scope; } public UserWorkflow name(String name) { @@ -254,40 +239,40 @@ public void setName(String name) { this.name = name; } - public UserWorkflow scope(ScopeEnum scope) { - this.scope = scope; + public UserWorkflow description(String description) { + this.description = description; return this; } /** - * The workflow scope (ACCOUNT or GROUP or OTHER) - * @return scope + * Description provided for this workflow at the time of its creation + * @return description **/ - @ApiModelProperty(value = "The workflow scope (ACCOUNT or GROUP or OTHER)") - public ScopeEnum getScope() { - return scope; + @ApiModelProperty(value = "Description provided for this workflow at the time of its creation") + public String getDescription() { + return description; } - public void setScope(ScopeEnum scope) { - this.scope = scope; + public void setDescription(String description) { + this.description = description; } - public UserWorkflow scopeId(String scopeId) { - this.scopeId = scopeId; + public UserWorkflow id(String id) { + this.id = id; return this; } /** - * Identifier of scope. Currently it is applicable for scope GROUP only and the value will be groupId. - * @return scopeId + * The unique identifier of a workflow + * @return id **/ - @ApiModelProperty(value = "Identifier of scope. Currently it is applicable for scope GROUP only and the value will be groupId.") - public String getScopeId() { - return scopeId; + @ApiModelProperty(value = "The unique identifier of a workflow") + public String getId() { + return id; } - public void setScopeId(String scopeId) { - this.scopeId = scopeId; + public void setId(String id) { + this.id = id; } public UserWorkflow status(StatusEnum status) { @@ -318,19 +303,19 @@ public boolean equals(java.lang.Object o) { return false; } UserWorkflow userWorkflow = (UserWorkflow) o; - return Objects.equals(this.created, userWorkflow.created) && - Objects.equals(this.description, userWorkflow.description) && + return Objects.equals(this.scopeId, userWorkflow.scopeId) && + Objects.equals(this.created, userWorkflow.created) && Objects.equals(this.displayName, userWorkflow.displayName) && - Objects.equals(this.id, userWorkflow.id) && - Objects.equals(this.name, userWorkflow.name) && Objects.equals(this.scope, userWorkflow.scope) && - Objects.equals(this.scopeId, userWorkflow.scopeId) && + Objects.equals(this.name, userWorkflow.name) && + Objects.equals(this.description, userWorkflow.description) && + Objects.equals(this.id, userWorkflow.id) && Objects.equals(this.status, userWorkflow.status); } @Override public int hashCode() { - return Objects.hash(created, description, displayName, id, name, scope, scopeId, status); + return Objects.hash(scopeId, created, displayName, scope, name, description, id, status); } @@ -339,13 +324,13 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class UserWorkflow {\n"); + sb.append(" scopeId: ").append(toIndentedString(scopeId)).append("\n"); sb.append(" created: ").append(toIndentedString(created)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); sb.append(" displayName: ").append(toIndentedString(displayName)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" scope: ").append(toIndentedString(scope)).append("\n"); - sb.append(" scopeId: ").append(toIndentedString(scopeId)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/swagger/client/model/workflows/UserWorkflows.java b/src/main/java/io/swagger/client/model/workflows/UserWorkflows.java index 27f48cb..c674771 100755 --- a/src/main/java/io/swagger/client/model/workflows/UserWorkflows.java +++ b/src/main/java/io/swagger/client/model/workflows/UserWorkflows.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -44,7 +29,7 @@ /** * UserWorkflows */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-03-11T15:50:09.914+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") public class UserWorkflows { @SerializedName("userWorkflowList") private List userWorkflowList = null; diff --git a/src/main/java/io/swagger/client/model/workflows/WorkflowDefaultParams.java b/src/main/java/io/swagger/client/model/workflows/WorkflowDefaultParams.java new file mode 100644 index 0000000..05c8095 --- /dev/null +++ b/src/main/java/io/swagger/client/model/workflows/WorkflowDefaultParams.java @@ -0,0 +1,162 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.workflows; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * WorkflowDefaultParams + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") +public class WorkflowDefaultParams { + @SerializedName("visible") + private Boolean visible = null; + + @SerializedName("defaultValue") + private String defaultValue = null; + + @SerializedName("editable") + private Boolean editable = null; + + @SerializedName("required") + private Boolean required = null; + + public WorkflowDefaultParams visible(Boolean visible) { + this.visible = visible; + return this; + } + + /** + * Whether current field is visible or not. If visible attribute for this field is false then this field should not be visible in the agreement creation UI using this workflow to user + * @return visible + **/ + @ApiModelProperty(value = "Whether current field is visible or not. If visible attribute for this field is false then this field should not be visible in the agreement creation UI using this workflow to user") + public Boolean isVisible() { + return visible; + } + + public void setVisible(Boolean visible) { + this.visible = visible; + } + + public WorkflowDefaultParams defaultValue(String defaultValue) { + this.defaultValue = defaultValue; + return this; + } + + /** + * default value of the field if input for this field is not provided and this field is required + * @return defaultValue + **/ + @ApiModelProperty(value = "default value of the field if input for this field is not provided and this field is required") + public String getDefaultValue() { + return defaultValue; + } + + public void setDefaultValue(String defaultValue) { + this.defaultValue = defaultValue; + } + + public WorkflowDefaultParams editable(Boolean editable) { + this.editable = editable; + return this; + } + + /** + * Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation + * @return editable + **/ + @ApiModelProperty(value = "Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation") + public Boolean isEditable() { + return editable; + } + + public void setEditable(Boolean editable) { + this.editable = editable; + } + + public WorkflowDefaultParams required(Boolean required) { + this.required = required; + return this; + } + + /** + * Whether this field is required or optional + * @return required + **/ + @ApiModelProperty(value = "Whether this field is required or optional") + public Boolean isRequired() { + return required; + } + + public void setRequired(Boolean required) { + this.required = required; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + WorkflowDefaultParams workflowDefaultParams = (WorkflowDefaultParams) o; + return Objects.equals(this.visible, workflowDefaultParams.visible) && + Objects.equals(this.defaultValue, workflowDefaultParams.defaultValue) && + Objects.equals(this.editable, workflowDefaultParams.editable) && + Objects.equals(this.required, workflowDefaultParams.required); + } + + @Override + public int hashCode() { + return Objects.hash(visible, defaultValue, editable, required); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class WorkflowDefaultParams {\n"); + + sb.append(" visible: ").append(toIndentedString(visible)).append("\n"); + sb.append(" defaultValue: ").append(toIndentedString(defaultValue)).append("\n"); + sb.append(" editable: ").append(toIndentedString(editable)).append("\n"); + sb.append(" required: ").append(toIndentedString(required)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/workflows/WorkflowDescription.java b/src/main/java/io/swagger/client/model/workflows/WorkflowDescription.java new file mode 100644 index 0000000..b21f7cb --- /dev/null +++ b/src/main/java/io/swagger/client/model/workflows/WorkflowDescription.java @@ -0,0 +1,623 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.workflows; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import io.swagger.client.model.workflows.CCsListInfoDescription; +import io.swagger.client.model.workflows.ExpirationFieldInfoDescription; +import io.swagger.client.model.workflows.FileInfosDescription; +import io.swagger.client.model.workflows.LocaleFieldInfoDescription; +import io.swagger.client.model.workflows.MergeFieldInfoDescription; +import io.swagger.client.model.workflows.PasswordFieldInfoDescription; +import io.swagger.client.model.workflows.RecipientsListInfoDescription; +import io.swagger.client.model.workflows.WorkflowDefaultParams; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +/** + * WorkflowDescription + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") +public class WorkflowDescription { + @SerializedName("scopeId") + private String scopeId = null; + + @SerializedName("messageInfo") + private WorkflowDefaultParams messageInfo = null; + + @SerializedName("created") + private Date created = null; + + @SerializedName("displayName") + private String displayName = null; + + @SerializedName("description") + private String description = null; + + @SerializedName("mergeFieldsInfo") + private List mergeFieldsInfo = null; + + @SerializedName("agreementNameInfo") + private WorkflowDefaultParams agreementNameInfo = null; + + @SerializedName("passwordInfo") + private PasswordFieldInfoDescription passwordInfo = null; + + @SerializedName("authoringInfo") + private WorkflowDefaultParams authoringInfo = null; + + @SerializedName("recipientsListInfo") + private List recipientsListInfo = null; + + /** + * The workflow scope (ACCOUNT or GROUP or OTHER) + */ + @JsonAdapter(ScopeEnum.Adapter.class) + public enum ScopeEnum { + ACCOUNT("ACCOUNT"), + + GROUP("GROUP"); + + private String value; + + ScopeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ScopeEnum fromValue(String text) { + for (ScopeEnum b : ScopeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ScopeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ScopeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ScopeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("scope") + private ScopeEnum scope = null; + + @SerializedName("expirationInfo") + private ExpirationFieldInfoDescription expirationInfo = null; + + @SerializedName("name") + private String name = null; + + @SerializedName("modified") + private Date modified = null; + + @SerializedName("fileInfos") + private List fileInfos = null; + + @SerializedName("localeInfo") + private LocaleFieldInfoDescription localeInfo = null; + + @SerializedName("ccsListInfo") + private List ccsListInfo = null; + + /** + * The workflow status (ACTIVE or DRAFT or INACTIVE or OTHER) + */ + @JsonAdapter(StatusEnum.Adapter.class) + public enum StatusEnum { + ACTIVE("ACTIVE"), + + DRAFT("DRAFT"), + + HIDDEN("HIDDEN"); + + private String value; + + StatusEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static StatusEnum fromValue(String text) { + for (StatusEnum b : StatusEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public StatusEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return StatusEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("status") + private StatusEnum status = null; + + public WorkflowDescription scopeId(String scopeId) { + this.scopeId = scopeId; + return this; + } + + /** + * Identifier of scope. Currently it is applicable for scope GROUP only and the value will be groupId. + * @return scopeId + **/ + @ApiModelProperty(value = "Identifier of scope. Currently it is applicable for scope GROUP only and the value will be groupId.") + public String getScopeId() { + return scopeId; + } + + public void setScopeId(String scopeId) { + this.scopeId = scopeId; + } + + public WorkflowDescription messageInfo(WorkflowDefaultParams messageInfo) { + this.messageInfo = messageInfo; + return this; + } + + /** + * Information about message field in DocumentCreationInfo input field in the agreement creation request when using the API which creates an agreement in a workflow + * @return messageInfo + **/ + @ApiModelProperty(value = "Information about message field in DocumentCreationInfo input field in the agreement creation request when using the API which creates an agreement in a workflow") + public WorkflowDefaultParams getMessageInfo() { + return messageInfo; + } + + public void setMessageInfo(WorkflowDefaultParams messageInfo) { + this.messageInfo = messageInfo; + } + + public WorkflowDescription created(Date created) { + this.created = created; + return this; + } + + /** + * The day on which the workflow was created + * @return created + **/ + @ApiModelProperty(value = "The day on which the workflow was created") + public Date getCreated() { + return created; + } + + public void setCreated(Date created) { + this.created = created; + } + + public WorkflowDescription displayName(String displayName) { + this.displayName = displayName; + return this; + } + + /** + * The display name of the workflow. + * @return displayName + **/ + @ApiModelProperty(value = "The display name of the workflow.") + public String getDisplayName() { + return displayName; + } + + public void setDisplayName(String displayName) { + this.displayName = displayName; + } + + public WorkflowDescription description(String description) { + this.description = description; + return this; + } + + /** + * Description provided for this workflow at the time of its creation + * @return description + **/ + @ApiModelProperty(value = "Description provided for this workflow at the time of its creation") + public String getDescription() { + return description; + } + + public void setDescription(String description) { + this.description = description; + } + + public WorkflowDescription mergeFieldsInfo(List mergeFieldsInfo) { + this.mergeFieldsInfo = mergeFieldsInfo; + return this; + } + + public WorkflowDescription addMergeFieldsInfoItem(MergeFieldInfoDescription mergeFieldsInfoItem) { + if (this.mergeFieldsInfo == null) { + this.mergeFieldsInfo = new ArrayList(); + } + this.mergeFieldsInfo.add(mergeFieldsInfoItem); + return this; + } + + /** + * Information about customFieldInfos in DocumentCreationInfo input field in the agreement creation request when using the API which creates an agreement in a workflow + * @return mergeFieldsInfo + **/ + @ApiModelProperty(value = "Information about customFieldInfos in DocumentCreationInfo input field in the agreement creation request when using the API which creates an agreement in a workflow") + public List getMergeFieldsInfo() { + return mergeFieldsInfo; + } + + public void setMergeFieldsInfo(List mergeFieldsInfo) { + this.mergeFieldsInfo = mergeFieldsInfo; + } + + public WorkflowDescription agreementNameInfo(WorkflowDefaultParams agreementNameInfo) { + this.agreementNameInfo = agreementNameInfo; + return this; + } + + /** + * Information about name field in DocumentCreationInfo input field in the agreement creation request when using the API which creates an agreement in a workflow + * @return agreementNameInfo + **/ + @ApiModelProperty(value = "Information about name field in DocumentCreationInfo input field in the agreement creation request when using the API which creates an agreement in a workflow") + public WorkflowDefaultParams getAgreementNameInfo() { + return agreementNameInfo; + } + + public void setAgreementNameInfo(WorkflowDefaultParams agreementNameInfo) { + this.agreementNameInfo = agreementNameInfo; + } + + public WorkflowDescription passwordInfo(PasswordFieldInfoDescription passwordInfo) { + this.passwordInfo = passwordInfo; + return this; + } + + /** + * Information about openPassword field in SecurityOptions input field in the agreement creation request when using the API which creates an agreement in a workflow + * @return passwordInfo + **/ + @ApiModelProperty(value = "Information about openPassword field in SecurityOptions input field in the agreement creation request when using the API which creates an agreement in a workflow") + public PasswordFieldInfoDescription getPasswordInfo() { + return passwordInfo; + } + + public void setPasswordInfo(PasswordFieldInfoDescription passwordInfo) { + this.passwordInfo = passwordInfo; + } + + public WorkflowDescription authoringInfo(WorkflowDefaultParams authoringInfo) { + this.authoringInfo = authoringInfo; + return this; + } + + /** + * Information about authoringRequested field in SendDocumentInteractiveOptions input field in the agreement creation request when using the API which creates an agreement in a workflow + * @return authoringInfo + **/ + @ApiModelProperty(value = "Information about authoringRequested field in SendDocumentInteractiveOptions input field in the agreement creation request when using the API which creates an agreement in a workflow") + public WorkflowDefaultParams getAuthoringInfo() { + return authoringInfo; + } + + public void setAuthoringInfo(WorkflowDefaultParams authoringInfo) { + this.authoringInfo = authoringInfo; + } + + public WorkflowDescription recipientsListInfo(List recipientsListInfo) { + this.recipientsListInfo = recipientsListInfo; + return this; + } + + public WorkflowDescription addRecipientsListInfoItem(RecipientsListInfoDescription recipientsListInfoItem) { + if (this.recipientsListInfo == null) { + this.recipientsListInfo = new ArrayList(); + } + this.recipientsListInfo.add(recipientsListInfoItem); + return this; + } + + /** + * Information about RecepientsInfo input field in the agreement creation request when using the API which creates an agreement in a workflow + * @return recipientsListInfo + **/ + @ApiModelProperty(value = "Information about RecepientsInfo input field in the agreement creation request when using the API which creates an agreement in a workflow") + public List getRecipientsListInfo() { + return recipientsListInfo; + } + + public void setRecipientsListInfo(List recipientsListInfo) { + this.recipientsListInfo = recipientsListInfo; + } + + public WorkflowDescription scope(ScopeEnum scope) { + this.scope = scope; + return this; + } + + /** + * The workflow scope (ACCOUNT or GROUP or OTHER) + * @return scope + **/ + @ApiModelProperty(value = "The workflow scope (ACCOUNT or GROUP or OTHER)") + public ScopeEnum getScope() { + return scope; + } + + public void setScope(ScopeEnum scope) { + this.scope = scope; + } + + public WorkflowDescription expirationInfo(ExpirationFieldInfoDescription expirationInfo) { + this.expirationInfo = expirationInfo; + return this; + } + + /** + * Information about daysUntilSigningDeadline field in DocumentCreationInfo input field in the agreement creation request when using the API which creates an agreement in a workflow + * @return expirationInfo + **/ + @ApiModelProperty(value = "Information about daysUntilSigningDeadline field in DocumentCreationInfo input field in the agreement creation request when using the API which creates an agreement in a workflow") + public ExpirationFieldInfoDescription getExpirationInfo() { + return expirationInfo; + } + + public void setExpirationInfo(ExpirationFieldInfoDescription expirationInfo) { + this.expirationInfo = expirationInfo; + } + + public WorkflowDescription name(String name) { + this.name = name; + return this; + } + + /** + * The name of the workflow. + * @return name + **/ + @ApiModelProperty(value = "The name of the workflow.") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public WorkflowDescription modified(Date modified) { + this.modified = modified; + return this; + } + + /** + * The day on which the workflow was last modified + * @return modified + **/ + @ApiModelProperty(value = "The day on which the workflow was last modified") + public Date getModified() { + return modified; + } + + public void setModified(Date modified) { + this.modified = modified; + } + + public WorkflowDescription fileInfos(List fileInfos) { + this.fileInfos = fileInfos; + return this; + } + + public WorkflowDescription addFileInfosItem(FileInfosDescription fileInfosItem) { + if (this.fileInfos == null) { + this.fileInfos = new ArrayList(); + } + this.fileInfos.add(fileInfosItem); + return this; + } + + /** + * Information about FileInfo input field in the agreement creation request when using the API which creates an agreement in a workflow + * @return fileInfos + **/ + @ApiModelProperty(value = "Information about FileInfo input field in the agreement creation request when using the API which creates an agreement in a workflow") + public List getFileInfos() { + return fileInfos; + } + + public void setFileInfos(List fileInfos) { + this.fileInfos = fileInfos; + } + + public WorkflowDescription localeInfo(LocaleFieldInfoDescription localeInfo) { + this.localeInfo = localeInfo; + return this; + } + + /** + * Information about locale field in DocumentCreationInfo input field in the agreement creation request when using the API which creates an agreement in a workflow + * @return localeInfo + **/ + @ApiModelProperty(value = "Information about locale field in DocumentCreationInfo input field in the agreement creation request when using the API which creates an agreement in a workflow") + public LocaleFieldInfoDescription getLocaleInfo() { + return localeInfo; + } + + public void setLocaleInfo(LocaleFieldInfoDescription localeInfo) { + this.localeInfo = localeInfo; + } + + public WorkflowDescription ccsListInfo(List ccsListInfo) { + this.ccsListInfo = ccsListInfo; + return this; + } + + public WorkflowDescription addCcsListInfoItem(CCsListInfoDescription ccsListInfoItem) { + if (this.ccsListInfo == null) { + this.ccsListInfo = new ArrayList(); + } + this.ccsListInfo.add(ccsListInfoItem); + return this; + } + + /** + * Information about CCList input field in the agreement creation request when using the API which creates an agreement in a workflow + * @return ccsListInfo + **/ + @ApiModelProperty(value = "Information about CCList input field in the agreement creation request when using the API which creates an agreement in a workflow") + public List getCcsListInfo() { + return ccsListInfo; + } + + public void setCcsListInfo(List ccsListInfo) { + this.ccsListInfo = ccsListInfo; + } + + public WorkflowDescription status(StatusEnum status) { + this.status = status; + return this; + } + + /** + * The workflow status (ACTIVE or DRAFT or INACTIVE or OTHER) + * @return status + **/ + @ApiModelProperty(value = "The workflow status (ACTIVE or DRAFT or INACTIVE or OTHER)") + public StatusEnum getStatus() { + return status; + } + + public void setStatus(StatusEnum status) { + this.status = status; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + WorkflowDescription workflowDescription = (WorkflowDescription) o; + return Objects.equals(this.scopeId, workflowDescription.scopeId) && + Objects.equals(this.messageInfo, workflowDescription.messageInfo) && + Objects.equals(this.created, workflowDescription.created) && + Objects.equals(this.displayName, workflowDescription.displayName) && + Objects.equals(this.description, workflowDescription.description) && + Objects.equals(this.mergeFieldsInfo, workflowDescription.mergeFieldsInfo) && + Objects.equals(this.agreementNameInfo, workflowDescription.agreementNameInfo) && + Objects.equals(this.passwordInfo, workflowDescription.passwordInfo) && + Objects.equals(this.authoringInfo, workflowDescription.authoringInfo) && + Objects.equals(this.recipientsListInfo, workflowDescription.recipientsListInfo) && + Objects.equals(this.scope, workflowDescription.scope) && + Objects.equals(this.expirationInfo, workflowDescription.expirationInfo) && + Objects.equals(this.name, workflowDescription.name) && + Objects.equals(this.modified, workflowDescription.modified) && + Objects.equals(this.fileInfos, workflowDescription.fileInfos) && + Objects.equals(this.localeInfo, workflowDescription.localeInfo) && + Objects.equals(this.ccsListInfo, workflowDescription.ccsListInfo) && + Objects.equals(this.status, workflowDescription.status); + } + + @Override + public int hashCode() { + return Objects.hash(scopeId, messageInfo, created, displayName, description, mergeFieldsInfo, agreementNameInfo, passwordInfo, authoringInfo, recipientsListInfo, scope, expirationInfo, name, modified, fileInfos, localeInfo, ccsListInfo, status); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class WorkflowDescription {\n"); + + sb.append(" scopeId: ").append(toIndentedString(scopeId)).append("\n"); + sb.append(" messageInfo: ").append(toIndentedString(messageInfo)).append("\n"); + sb.append(" created: ").append(toIndentedString(created)).append("\n"); + sb.append(" displayName: ").append(toIndentedString(displayName)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append(" mergeFieldsInfo: ").append(toIndentedString(mergeFieldsInfo)).append("\n"); + sb.append(" agreementNameInfo: ").append(toIndentedString(agreementNameInfo)).append("\n"); + sb.append(" passwordInfo: ").append(toIndentedString(passwordInfo)).append("\n"); + sb.append(" authoringInfo: ").append(toIndentedString(authoringInfo)).append("\n"); + sb.append(" recipientsListInfo: ").append(toIndentedString(recipientsListInfo)).append("\n"); + sb.append(" scope: ").append(toIndentedString(scope)).append("\n"); + sb.append(" expirationInfo: ").append(toIndentedString(expirationInfo)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" modified: ").append(toIndentedString(modified)).append("\n"); + sb.append(" fileInfos: ").append(toIndentedString(fileInfos)).append("\n"); + sb.append(" localeInfo: ").append(toIndentedString(localeInfo)).append("\n"); + sb.append(" ccsListInfo: ").append(toIndentedString(ccsListInfo)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/swagger/client/model/workflows/WorkflowLibraryDocument.java b/src/main/java/io/swagger/client/model/workflows/WorkflowLibraryDocument.java new file mode 100644 index 0000000..be078f0 --- /dev/null +++ b/src/main/java/io/swagger/client/model/workflows/WorkflowLibraryDocument.java @@ -0,0 +1,294 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.model.workflows; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +/** + * WorkflowLibraryDocument + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-11-06T13:23:59.041+11:00") +public class WorkflowLibraryDocument { + /** + * Gets or Sets templateTypes + */ + @JsonAdapter(TemplateTypesEnum.Adapter.class) + public enum TemplateTypesEnum { + DOCUMENT("DOCUMENT"), + + FORM_FIELD_LAYER("FORM_FIELD_LAYER"); + + private String value; + + TemplateTypesEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static TemplateTypesEnum fromValue(String text) { + for (TemplateTypesEnum b : TemplateTypesEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final TemplateTypesEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public TemplateTypesEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return TemplateTypesEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("templateTypes") + private List templateTypes = null; + + /** + * Specifies who should have access to this library document. GLOBAL sharing is a restricted operation. + */ + @JsonAdapter(SharingModeEnum.Adapter.class) + public enum SharingModeEnum { + USER("USER"), + + GROUP("GROUP"), + + ACCOUNT("ACCOUNT"), + + GLOBAL("GLOBAL"); + + private String value; + + SharingModeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static SharingModeEnum fromValue(String text) { + for (SharingModeEnum b : SharingModeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final SharingModeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public SharingModeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return SharingModeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("sharingMode") + private SharingModeEnum sharingMode = null; + + @SerializedName("modifiedDate") + private Date modifiedDate = null; + + @SerializedName("workflowLibDoc") + private String workflowLibDoc = null; + + @SerializedName("label") + private String label = null; + + public WorkflowLibraryDocument templateTypes(List templateTypes) { + this.templateTypes = templateTypes; + return this; + } + + public WorkflowLibraryDocument addTemplateTypesItem(TemplateTypesEnum templateTypesItem) { + if (this.templateTypes == null) { + this.templateTypes = new ArrayList(); + } + this.templateTypes.add(templateTypesItem); + return this; + } + + /** + * A list of one or more library template types + * @return templateTypes + **/ + @ApiModelProperty(value = "A list of one or more library template types") + public List getTemplateTypes() { + return templateTypes; + } + + public void setTemplateTypes(List templateTypes) { + this.templateTypes = templateTypes; + } + + public WorkflowLibraryDocument sharingMode(SharingModeEnum sharingMode) { + this.sharingMode = sharingMode; + return this; + } + + /** + * Specifies who should have access to this library document. GLOBAL sharing is a restricted operation. + * @return sharingMode + **/ + @ApiModelProperty(value = "Specifies who should have access to this library document. GLOBAL sharing is a restricted operation.") + public SharingModeEnum getSharingMode() { + return sharingMode; + } + + public void setSharingMode(SharingModeEnum sharingMode) { + this.sharingMode = sharingMode; + } + + public WorkflowLibraryDocument modifiedDate(Date modifiedDate) { + this.modifiedDate = modifiedDate; + return this; + } + + /** + * The date on which the library document was last modified. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time + * @return modifiedDate + **/ + @ApiModelProperty(value = "The date on which the library document was last modified. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time") + public Date getModifiedDate() { + return modifiedDate; + } + + public void setModifiedDate(Date modifiedDate) { + this.modifiedDate = modifiedDate; + } + + public WorkflowLibraryDocument workflowLibDoc(String workflowLibDoc) { + this.workflowLibDoc = workflowLibDoc; + return this; + } + + /** + * An id of the workflow library document that can be provided as an input file in the custom workflow agreement creation request + * @return workflowLibDoc + **/ + @ApiModelProperty(value = "An id of the workflow library document that can be provided as an input file in the custom workflow agreement creation request") + public String getWorkflowLibDoc() { + return workflowLibDoc; + } + + public void setWorkflowLibDoc(String workflowLibDoc) { + this.workflowLibDoc = workflowLibDoc; + } + + public WorkflowLibraryDocument label(String label) { + this.label = label; + return this; + } + + /** + * A display text for this form for workflow users + * @return label + **/ + @ApiModelProperty(value = "A display text for this form for workflow users") + public String getLabel() { + return label; + } + + public void setLabel(String label) { + this.label = label; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + WorkflowLibraryDocument workflowLibraryDocument = (WorkflowLibraryDocument) o; + return Objects.equals(this.templateTypes, workflowLibraryDocument.templateTypes) && + Objects.equals(this.sharingMode, workflowLibraryDocument.sharingMode) && + Objects.equals(this.modifiedDate, workflowLibraryDocument.modifiedDate) && + Objects.equals(this.workflowLibDoc, workflowLibraryDocument.workflowLibDoc) && + Objects.equals(this.label, workflowLibraryDocument.label); + } + + @Override + public int hashCode() { + return Objects.hash(templateTypes, sharingMode, modifiedDate, workflowLibDoc, label); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class WorkflowLibraryDocument {\n"); + + sb.append(" templateTypes: ").append(toIndentedString(templateTypes)).append("\n"); + sb.append(" sharingMode: ").append(toIndentedString(sharingMode)).append("\n"); + sb.append(" modifiedDate: ").append(toIndentedString(modifiedDate)).append("\n"); + sb.append(" workflowLibDoc: ").append(toIndentedString(workflowLibDoc)).append("\n"); + sb.append(" label: ").append(toIndentedString(label)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/test/java/io/swagger/client/api/AccountsApiTest.java b/src/test/java/io/swagger/client/api/AccountsApiTest.java new file mode 100644 index 0000000..1efa6e7 --- /dev/null +++ b/src/test/java/io/swagger/client/api/AccountsApiTest.java @@ -0,0 +1,53 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.api; + +import io.swagger.client.model.ApiException; +import io.swagger.client.model.accounts.Account; +import org.junit.Test; +import org.junit.Ignore; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * API tests for AccountsApi + */ +@Ignore +public class AccountsApiTest { + + private final AccountsApi api = new AccountsApi(); + + + /** + * Retrieves the information for an account. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getAccountTest() throws ApiException { + String authorization = null; + String accountId = null; + String xApiUser = null; + Account response = api.getAccount(authorization, accountId, xApiUser); + + // TODO: test validations + } + +} diff --git a/src/test/java/io/swagger/client/api/AgreementsApiTest.java b/src/test/java/io/swagger/client/api/AgreementsApiTest.java index a7e2d97..037101d 100755 --- a/src/test/java/io/swagger/client/api/AgreementsApiTest.java +++ b/src/test/java/io/swagger/client/api/AgreementsApiTest.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -46,10 +31,12 @@ import io.swagger.client.model.agreements.DetailedParticipantSetInfo; import io.swagger.client.model.agreements.DocumentUrl; import io.swagger.client.model.agreements.DocumentsImageUrlsInfo; +import io.swagger.client.model.agreements.FetchedAgreementInfo; import io.swagger.client.model.agreements.FormFieldMergeInfo; import io.swagger.client.model.agreements.FormFieldPostInfo; import io.swagger.client.model.agreements.FormFieldPutInfo; import io.swagger.client.model.agreements.MembersInfo; +import io.swagger.client.model.agreements.MyAgreementInfo; import io.swagger.client.model.agreements.Note; import io.swagger.client.model.agreements.ParticipantSecurityOption; import io.swagger.client.model.agreements.ReminderCreationResult; @@ -57,8 +44,10 @@ import io.swagger.client.model.agreements.RemindersResponse; import io.swagger.client.model.agreements.ShareCreationInfoList; import io.swagger.client.model.agreements.ShareCreationResponseList; +import io.swagger.client.model.agreements.SignerIdentityReportInfo; import io.swagger.client.model.agreements.SigningUrlResponse; import io.swagger.client.model.agreements.UserAgreements; +import io.swagger.client.model.agreements.VaultEventInfo; import io.swagger.client.model.agreements.VisibilityInfo; import org.junit.Test; import org.junit.Ignore; @@ -88,12 +77,12 @@ public class AgreementsApiTest { @Test public void addTemplateFieldsToAgreementTest() throws ApiException { String authorization = null; - String ifMatch = null; String agreementId = null; FormFieldPostInfo formFieldPostInfo = null; String xApiUser = null; String xOnBehalfOfUser = null; - AgreementFormFields response = api.addTemplateFieldsToAgreement(authorization, ifMatch, agreementId, formFieldPostInfo, xApiUser, xOnBehalfOfUser); + String ifMatch = null; + AgreementFormFields response = api.addTemplateFieldsToAgreement(authorization, agreementId, formFieldPostInfo, xApiUser, xOnBehalfOfUser, ifMatch); // TODO: test validations } @@ -197,6 +186,25 @@ public void createShareOnAgreementTest() throws ApiException { // TODO: test validations } + /** + * Retrieves the signer identity report of an agreement identified by agreementId. + * + * PDF file stream containing signer identify information + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void createSignerIdentityReportTest() throws ApiException { + String authorization = null; + String agreementId = null; + String xApiUser = null; + SignerIdentityReportInfo signerIdentityReportInfo = null; + byte[] response = api.createSignerIdentityReport(authorization, agreementId, xApiUser, signerIdentityReportInfo); + + // TODO: test validations + } + /** * Deletes all the documents of an agreement. * @@ -208,11 +216,11 @@ public void createShareOnAgreementTest() throws ApiException { @Test public void deleteDocumentsTest() throws ApiException { String authorization = null; - String ifMatch = null; String agreementId = null; String xApiUser = null; String xOnBehalfOfUser = null; - api.deleteDocuments(authorization, ifMatch, agreementId, xApiUser, xOnBehalfOfUser); + String ifMatch = null; + api.deleteDocuments(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifMatch); // TODO: test validations } @@ -232,7 +240,25 @@ public void getAgreementInfoTest() throws ApiException { String xApiUser = null; String xOnBehalfOfUser = null; String ifNoneMatch = null; - AgreementInfo response = api.getAgreementInfo(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + FetchedAgreementInfo response = api.getAgreementInfo(authorization, agreementId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + + // TODO: test validations + } + + /** + * Retrieves the agreement information related to the api caller + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getAgreementInfoForUserTest() throws ApiException { + String authorization = null; + String agreementId = null; + String xApiUser = null; + MyAgreementInfo response = api.getAgreementInfoForUser(authorization, agreementId, xApiUser); // TODO: test validations } @@ -312,7 +338,8 @@ public void getAgreementSecurityOptionsForParticipationTest() throws ApiExceptio String participantId = null; String ifNoneMatch = null; String xApiUser = null; - ParticipantSecurityOption response = api.getAgreementSecurityOptionsForParticipation(authorization, agreementId, participantSetId, participantId, ifNoneMatch, xApiUser); + String xOnBehalfOfUser = null; + ParticipantSecurityOption response = api.getAgreementSecurityOptionsForParticipation(authorization, agreementId, participantSetId, participantId, ifNoneMatch, xApiUser, xOnBehalfOfUser); // TODO: test validations } @@ -331,10 +358,11 @@ public void getAgreementsTest() throws ApiException { String xApiUser = null; String xOnBehalfOfUser = null; String externalId = null; + String groupId = null; Boolean showHiddenAgreements = null; String cursor = null; Integer pageSize = null; - UserAgreements response = api.getAgreements(authorization, xApiUser, xOnBehalfOfUser, externalId, showHiddenAgreements, cursor, pageSize); + UserAgreements response = api.getAgreements(authorization, xApiUser, xOnBehalfOfUser, externalId, groupId, showHiddenAgreements, cursor, pageSize); // TODO: test validations } @@ -655,7 +683,8 @@ public void getSigningUrlTest() throws ApiException { String agreementId = null; String xApiUser = null; String ifNoneMatch = null; - SigningUrlResponse response = api.getSigningUrl(authorization, agreementId, xApiUser, ifNoneMatch); + Integer expiry = null; + SigningUrlResponse response = api.getSigningUrl(authorization, agreementId, xApiUser, ifNoneMatch, expiry); // TODO: test validations } @@ -671,13 +700,13 @@ public void getSigningUrlTest() throws ApiException { @Test public void rejectAgreementForParticipationTest() throws ApiException { String authorization = null; - String ifMatch = null; String agreementId = null; String participantSetId = null; String participantId = null; AgreementRejectionInfo agreementRejectionInfo = null; + String ifMatch = null; String xApiUser = null; - api.rejectAgreementForParticipation(authorization, ifMatch, agreementId, participantSetId, participantId, agreementRejectionInfo, xApiUser); + api.rejectAgreementForParticipation(authorization, agreementId, participantSetId, participantId, agreementRejectionInfo, ifMatch, xApiUser); // TODO: test validations } @@ -693,12 +722,12 @@ public void rejectAgreementForParticipationTest() throws ApiException { @Test public void updateAgreementTest() throws ApiException { String authorization = null; - String ifMatch = null; String agreementId = null; AgreementInfo agreementInfo = null; String xApiUser = null; String xOnBehalfOfUser = null; - api.updateAgreement(authorization, ifMatch, agreementId, agreementInfo, xApiUser, xOnBehalfOfUser); + String ifMatch = null; + api.updateAgreement(authorization, agreementId, agreementInfo, xApiUser, xOnBehalfOfUser, ifMatch); // TODO: test validations } @@ -714,12 +743,12 @@ public void updateAgreementTest() throws ApiException { @Test public void updateAgreementMergeInfoTest() throws ApiException { String authorization = null; - String ifMatch = null; String agreementId = null; FormFieldMergeInfo formFieldMergeInfo = null; String xApiUser = null; String xOnBehalfOfUser = null; - api.updateAgreementMergeInfo(authorization, ifMatch, agreementId, formFieldMergeInfo, xApiUser, xOnBehalfOfUser); + String ifMatch = null; + api.updateAgreementMergeInfo(authorization, agreementId, formFieldMergeInfo, xApiUser, xOnBehalfOfUser, ifMatch); // TODO: test validations } @@ -776,13 +805,14 @@ public void updateAgreementReminderTest() throws ApiException { @Test public void updateAgreementSecurityOptionsForParticipationTest() throws ApiException { String authorization = null; - String ifMatch = null; String agreementId = null; String participantSetId = null; String participantId = null; ParticipantSecurityOption participantSecurityOption = null; + String ifMatch = null; String xApiUser = null; - api.updateAgreementSecurityOptionsForParticipation(authorization, ifMatch, agreementId, participantSetId, participantId, participantSecurityOption, xApiUser); + String xOnBehalfOfUser = null; + api.updateAgreementSecurityOptionsForParticipation(authorization, agreementId, participantSetId, participantId, participantSecurityOption, ifMatch, xApiUser, xOnBehalfOfUser); // TODO: test validations } @@ -798,12 +828,32 @@ public void updateAgreementSecurityOptionsForParticipationTest() throws ApiExcep @Test public void updateAgreementStateTest() throws ApiException { String authorization = null; - String ifMatch = null; String agreementId = null; AgreementStateInfo agreementStateInfo = null; String xApiUser = null; String xOnBehalfOfUser = null; - api.updateAgreementState(authorization, ifMatch, agreementId, agreementStateInfo, xApiUser, xOnBehalfOfUser); + String ifMatch = null; + api.updateAgreementState(authorization, agreementId, agreementStateInfo, xApiUser, xOnBehalfOfUser, ifMatch); + + // TODO: test validations + } + + /** + * Complete the vaulting process and update the agreement as vaulted. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void updateAgreementVaultedTest() throws ApiException { + String authorization = null; + String agreementId = null; + VaultEventInfo vaultEventInfo = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + api.updateAgreementVaulted(authorization, agreementId, vaultEventInfo, xApiUser, xOnBehalfOfUser); // TODO: test validations } @@ -839,12 +889,12 @@ public void updateAgreementVisibilityTest() throws ApiException { @Test public void updateFormFieldsTest() throws ApiException { String authorization = null; - String ifMatch = null; String agreementId = null; FormFieldPutInfo formFieldPutInfo = null; String xApiUser = null; String xOnBehalfOfUser = null; - AgreementFormFields response = api.updateFormFields(authorization, ifMatch, agreementId, formFieldPutInfo, xApiUser, xOnBehalfOfUser); + String ifMatch = null; + AgreementFormFields response = api.updateFormFields(authorization, agreementId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, ifMatch); // TODO: test validations } @@ -860,13 +910,13 @@ public void updateFormFieldsTest() throws ApiException { @Test public void updateParticipantSetTest() throws ApiException { String authorization = null; - String ifMatch = null; String agreementId = null; String participantSetId = null; DetailedParticipantSetInfo detailedParticipantSetInfo = null; String xApiUser = null; String xOnBehalfOfUser = null; - api.updateParticipantSet(authorization, ifMatch, agreementId, participantSetId, detailedParticipantSetInfo, xApiUser, xOnBehalfOfUser); + String ifMatch = null; + api.updateParticipantSet(authorization, agreementId, participantSetId, detailedParticipantSetInfo, xApiUser, xOnBehalfOfUser, ifMatch); // TODO: test validations } diff --git a/src/test/java/io/swagger/client/api/BaseUrisApiTest.java b/src/test/java/io/swagger/client/api/BaseUrisApiTest.java index f8450de..a531661 100755 --- a/src/test/java/io/swagger/client/api/BaseUrisApiTest.java +++ b/src/test/java/io/swagger/client/api/BaseUrisApiTest.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) diff --git a/src/test/java/io/swagger/client/api/GroupsApiTest.java b/src/test/java/io/swagger/client/api/GroupsApiTest.java index b301535..bb3b86f 100755 --- a/src/test/java/io/swagger/client/api/GroupsApiTest.java +++ b/src/test/java/io/swagger/client/api/GroupsApiTest.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -30,6 +15,7 @@ import io.swagger.client.model.ApiException; import io.swagger.client.model.groups.DetailedGroupInfo; +import io.swagger.client.model.groups.GroupCreationResponse; import io.swagger.client.model.groups.GroupUsersInfo; import io.swagger.client.model.groups.GroupsInfo; import org.junit.Test; @@ -49,6 +35,42 @@ public class GroupsApiTest { private final GroupsApi api = new GroupsApi(); + /** + * Creates a new group in an account. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void createGroupTest() throws ApiException { + String authorization = null; + DetailedGroupInfo detailedGroupInfo = null; + String xApiUser = null; + GroupCreationResponse response = api.createGroup(authorization, detailedGroupInfo, xApiUser); + + // TODO: test validations + } + + /** + * Delete an existing group. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void deleteGroupTest() throws ApiException { + String authorization = null; + String groupId = null; + String xApiUser = null; + api.deleteGroup(authorization, groupId, xApiUser); + + // TODO: test validations + } + /** * Retrieves detailed information about the group. * @@ -106,4 +128,23 @@ public void getUsersInGroupTest() throws ApiException { // TODO: test validations } + /** + * Update an existing group. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void modifyGroupTest() throws ApiException { + String authorization = null; + String groupId = null; + DetailedGroupInfo detailedGroupInfo = null; + String xApiUser = null; + api.modifyGroup(authorization, groupId, detailedGroupInfo, xApiUser); + + // TODO: test validations + } + } diff --git a/src/test/java/io/swagger/client/api/LibraryDocumentsApiTest.java b/src/test/java/io/swagger/client/api/LibraryDocumentsApiTest.java index 7c2210a..72e24c3 100755 --- a/src/test/java/io/swagger/client/api/LibraryDocumentsApiTest.java +++ b/src/test/java/io/swagger/client/api/LibraryDocumentsApiTest.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -30,15 +15,20 @@ import io.swagger.client.model.ApiException; import io.swagger.client.model.libraryDocuments.DocumentImageUrlsInfo; +import io.swagger.client.model.libraryDocuments.DocumentUrl; import io.swagger.client.model.libraryDocuments.Documents; +import io.swagger.client.model.libraryDocuments.FormFieldPutInfo; import io.swagger.client.model.libraryDocuments.LibraryDocumentCreationInfoV6; import io.swagger.client.model.libraryDocuments.LibraryDocumentCreationResponse; import io.swagger.client.model.libraryDocuments.LibraryDocumentEventList; +import io.swagger.client.model.libraryDocuments.LibraryDocumentFormFields; import io.swagger.client.model.libraryDocuments.LibraryDocumentInfo; +import io.swagger.client.model.libraryDocuments.LibraryDocumentMembersInfo; import io.swagger.client.model.libraryDocuments.LibraryDocumentStateInfo; import io.swagger.client.model.libraryDocuments.LibraryDocumentViewResponse; import io.swagger.client.model.libraryDocuments.LibraryDocuments; import io.swagger.client.model.libraryDocuments.LibraryViewInfo; +import io.swagger.client.model.libraryDocuments.MyAgreementInfo; import io.swagger.client.model.libraryDocuments.Note; import io.swagger.client.model.libraryDocuments.VisibilityInfo; import org.junit.Test; @@ -98,6 +88,26 @@ public void createLibraryDocumentViewTest() throws ApiException { // TODO: test validations } + /** + * Retrieves information of members (creator) of the library document. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getAllLibraryDocumentMembersTest() throws ApiException { + String authorization = null; + String libraryDocumentId = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + String ifNoneMatch = null; + LibraryDocumentMembersInfo response = api.getAllLibraryDocumentMembers(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + + // TODO: test validations + } + /** * Retrieves the combined document associated with a library document. * @@ -175,7 +185,49 @@ public void getFormDataTest() throws ApiException { String xApiUser = null; String xOnBehalfOfUser = null; String ifNoneMatch = null; - byte[] response = api.getFormData(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + String cursor = null; + Integer pageSize = null; + byte[] response = api.getFormData(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, cursor, pageSize); + + // TODO: test validations + } + + /** + * Retrieves details of form fields of a library document. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getFormFieldsTest() throws ApiException { + String authorization = null; + String libraryDocumentId = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + String ifNoneMatch = null; + LibraryDocumentFormFields response = api.getFormFields(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + + // TODO: test validations + } + + /** + * Retrieves url of all visible pages of all the documents associated with a library document. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getLibraryCombinedDocumentUrlTest() throws ApiException { + String authorization = null; + String libraryDocumentId = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + Boolean attachAuditReport = null; + DocumentUrl response = api.getLibraryCombinedDocumentUrl(authorization, libraryDocumentId, xApiUser, xOnBehalfOfUser, attachAuditReport); // TODO: test validations } @@ -236,11 +288,10 @@ public void getLibraryDocumentImageUrlsTest() throws ApiException { String documentId = null; String xApiUser = null; String xOnBehalfOfUser = null; - String ifNoneMatch = null; String imageSizes = null; Integer startPage = null; Integer endPage = null; - DocumentImageUrlsInfo response = api.getLibraryDocumentImageUrls(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch, imageSizes, startPage, endPage); + DocumentImageUrlsInfo response = api.getLibraryDocumentImageUrls(authorization, libraryDocumentId, documentId, xApiUser, xOnBehalfOfUser, imageSizes, startPage, endPage); // TODO: test validations } @@ -265,6 +316,24 @@ public void getLibraryDocumentInfoTest() throws ApiException { // TODO: test validations } + /** + * Retrieves the library document information related to the api caller + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getLibraryDocumentInfoForUserTest() throws ApiException { + String authorization = null; + String libraryDocumentId = null; + String xApiUser = null; + MyAgreementInfo response = api.getLibraryDocumentInfoForUser(authorization, libraryDocumentId, xApiUser); + + // TODO: test validations + } + /** * Retrieves the latest note of a library document for the API user. * @@ -297,10 +366,32 @@ public void getLibraryDocumentsTest() throws ApiException { String authorization = null; String xApiUser = null; String xOnBehalfOfUser = null; + String groupId = null; Boolean showHiddenLibraryDocuments = null; String cursor = null; Integer pageSize = null; - LibraryDocuments response = api.getLibraryDocuments(authorization, xApiUser, xOnBehalfOfUser, showHiddenLibraryDocuments, cursor, pageSize); + LibraryDocuments response = api.getLibraryDocuments(authorization, xApiUser, xOnBehalfOfUser, groupId, showHiddenLibraryDocuments, cursor, pageSize); + + // TODO: test validations + } + + /** + * Updates details of form fields of a library document. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void updateFormFieldsTest() throws ApiException { + String authorization = null; + String libraryDocumentId = null; + FormFieldPutInfo formFieldPutInfo = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + String ifNoneMatch = null; + LibraryDocumentFormFields response = api.updateFormFields(authorization, libraryDocumentId, formFieldPutInfo, xApiUser, xOnBehalfOfUser, ifNoneMatch); // TODO: test validations } @@ -316,12 +407,12 @@ public void getLibraryDocumentsTest() throws ApiException { @Test public void updateLibraryDocumentTest() throws ApiException { String authorization = null; - String ifMatch = null; String libraryDocumentId = null; LibraryDocumentInfo libraryDocumentInfo = null; String xApiUser = null; String xOnBehalfOfUser = null; - api.updateLibraryDocument(authorization, ifMatch, libraryDocumentId, libraryDocumentInfo, xApiUser, xOnBehalfOfUser); + String ifMatch = null; + api.updateLibraryDocument(authorization, libraryDocumentId, libraryDocumentInfo, xApiUser, xOnBehalfOfUser, ifMatch); // TODO: test validations } @@ -349,7 +440,7 @@ public void updateLibraryDocumentNoteForApiUserTest() throws ApiException { /** * Updates the library document's state. * - * Currently state can be changed from AUTHORING to ACTIVE. + * Currently state can be changed from AUTHORING to ACTIVE, AUTHORING to REMOVED or ACTIVE to REMOVED * * @throws ApiException * if the Api call fails @@ -357,12 +448,12 @@ public void updateLibraryDocumentNoteForApiUserTest() throws ApiException { @Test public void updateLibraryDocumentStateTest() throws ApiException { String authorization = null; - String ifMatch = null; String libraryDocumentId = null; LibraryDocumentStateInfo libraryDocumentStateInfo = null; String xApiUser = null; String xOnBehalfOfUser = null; - api.updateLibraryDocumentState(authorization, ifMatch, libraryDocumentId, libraryDocumentStateInfo, xApiUser, xOnBehalfOfUser); + String ifMatch = null; + api.updateLibraryDocumentState(authorization, libraryDocumentId, libraryDocumentStateInfo, xApiUser, xOnBehalfOfUser, ifMatch); // TODO: test validations } diff --git a/src/test/java/io/swagger/client/api/MegaSignsApiTest.java b/src/test/java/io/swagger/client/api/MegaSignsApiTest.java index 871e1b9..fd805f3 100755 --- a/src/test/java/io/swagger/client/api/MegaSignsApiTest.java +++ b/src/test/java/io/swagger/client/api/MegaSignsApiTest.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -29,14 +14,28 @@ package io.swagger.client.api; import io.swagger.client.model.ApiException; +import io.swagger.client.model.megaSigns.AgreementDocuments; +import io.swagger.client.model.megaSigns.BasicDocumentsImageUrlsInfo; +import io.swagger.client.model.megaSigns.DocumentUrl; +import io.swagger.client.model.megaSigns.FetchedMegaSignInfo; import io.swagger.client.model.megaSigns.MegaSignChildAgreements; import io.swagger.client.model.megaSigns.MegaSignCreationInfo; import io.swagger.client.model.megaSigns.MegaSignCreationResponse; +import io.swagger.client.model.megaSigns.MegaSignInfo; +import io.swagger.client.model.megaSigns.MegaSignMembersInfo; +import io.swagger.client.model.megaSigns.MegaSignRemindersResponse; import io.swagger.client.model.megaSigns.MegaSignStateInfo; import io.swagger.client.model.megaSigns.MegaSignViewInfo; import io.swagger.client.model.megaSigns.MegaSignViewResponse; import io.swagger.client.model.megaSigns.MegaSigns; import io.swagger.client.model.megaSigns.MegasignEventList; +import io.swagger.client.model.megaSigns.MyAgreementInfo; +import io.swagger.client.model.megaSigns.Note; +import io.swagger.client.model.megaSigns.ReminderCreationResult; +import io.swagger.client.model.megaSigns.ReminderInfo; +import io.swagger.client.model.megaSigns.ShareCreationInfoList; +import io.swagger.client.model.megaSigns.ShareCreationResponseList; +import io.swagger.client.model.megaSigns.VisibilityInfo; import org.junit.Test; import org.junit.Ignore; @@ -73,6 +72,66 @@ public void createMegaSignTest() throws ApiException { // TODO: test validations } + /** + * Creates a reminder on the specified participants of the MegaSign parent. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void createReminderOnMegaSignTest() throws ApiException { + String authorization = null; + String megaSignId = null; + ReminderInfo reminderInfo = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + ReminderCreationResult response = api.createReminderOnMegaSign(authorization, megaSignId, reminderInfo, xApiUser, xOnBehalfOfUser); + + // TODO: test validations + } + + /** + * Share a MegaSign parent and all the child agreements with someone. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void createShareOnMegaSignTest() throws ApiException { + String authorization = null; + String megaSignId = null; + ShareCreationInfoList shareCreationInfoList = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + ShareCreationResponseList response = api.createShareOnMegaSign(authorization, megaSignId, shareCreationInfoList, xApiUser, xOnBehalfOfUser); + + // TODO: test validations + } + + /** + * Retrieves detailed member info along with IDs for different types of participants associated with the MegaSign parent agreement. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getAllMegaSignMembersTest() throws ApiException { + String authorization = null; + String megaSignId = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + String ifNoneMatch = null; + MegaSignMembersInfo response = api.getAllMegaSignMembers(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + + // TODO: test validations + } + /** * Retrieves the file stream of the original childAgreementsInfoFile that was uploaded by sender while creating the MegaSign. * @@ -114,6 +173,47 @@ public void getEventsTest() throws ApiException { // TODO: test validations } + /** + * Retrieves the IDs of the documents associated with a MegaSign parent agreement. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getMegaSignAllDocumentsTest() throws ApiException { + String authorization = null; + String megaSignId = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + String ifNoneMatch = null; + AgreementDocuments response = api.getMegaSignAllDocuments(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + + // TODO: test validations + } + + /** + * Retrieves image urls of all visible pages of a document associated with a MegaSign parent agreement. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getMegaSignAllDocumentsImageUrlsTest() throws ApiException { + String authorization = null; + String megaSignId = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + String imageSizes = null; + Boolean showImageAvailabilityOnly = null; + BasicDocumentsImageUrlsInfo response = api.getMegaSignAllDocumentsImageUrls(authorization, megaSignId, xApiUser, xOnBehalfOfUser, imageSizes, showImageAvailabilityOnly); + + // TODO: test validations + } + /** * Get all the child agreements of the specified MegaSign parent agreement. * @@ -156,6 +256,47 @@ public void getMegaSignCombinedDocumentTest() throws ApiException { // TODO: test validations } + /** + * Retrieves url of all visible pages of all the documents associated with the MegaSign parent agreement. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getMegaSignCombinedDocumentUrlTest() throws ApiException { + String authorization = null; + String megaSignId = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + Boolean attachAuditReport = null; + DocumentUrl response = api.getMegaSignCombinedDocumentUrl(authorization, megaSignId, xApiUser, xOnBehalfOfUser, attachAuditReport); + + // TODO: test validations + } + + /** + * Retrieves the file stream of a document of a MegaSign parent agreement. + * + * Raw stream of the file + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getMegaSignDocumentInfoTest() throws ApiException { + String authorization = null; + String megaSignId = null; + String documentId = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + String ifNoneMatch = null; + byte[] response = api.getMegaSignDocumentInfo(authorization, megaSignId, documentId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + + // TODO: test validations + } + /** * Retrieves data entered by recipients into interactive form fields at the time they signed the child agreements of the specified MegaSign agreement * @@ -190,7 +331,84 @@ public void getMegaSignInfoTest() throws ApiException { String xApiUser = null; String xOnBehalfOfUser = null; String ifNoneMatch = null; - MegaSignCreationInfo response = api.getMegaSignInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + FetchedMegaSignInfo response = api.getMegaSignInfo(authorization, megaSignId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + + // TODO: test validations + } + + /** + * Retrieves the MegaSign parent agreement information related to the api caller + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getMegaSignInfoForUserTest() throws ApiException { + String authorization = null; + String megaSignId = null; + String xApiUser = null; + MyAgreementInfo response = api.getMegaSignInfoForUser(authorization, megaSignId, xApiUser); + + // TODO: test validations + } + + /** + * Retrieves the latest note of a MegaSign parent agreement for the user. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getMegaSignNoteForUserTest() throws ApiException { + String authorization = null; + String megaSignId = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + Note response = api.getMegaSignNoteForUser(authorization, megaSignId, xApiUser, xOnBehalfOfUser); + + // TODO: test validations + } + + /** + * Retrieves a specific reminder given the reminder id for the specified MegaSign parent agreement. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getMegaSignReminderTest() throws ApiException { + String authorization = null; + String megaSignId = null; + String reminderId = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + ReminderInfo response = api.getMegaSignReminder(authorization, megaSignId, reminderId, xApiUser, xOnBehalfOfUser); + + // TODO: test validations + } + + /** + * Retrieves the reminders of the specified MegaSign parent agreement. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getMegaSignRemindersTest() throws ApiException { + String authorization = null; + String megaSignId = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + String status = null; + MegaSignRemindersResponse response = api.getMegaSignReminders(authorization, megaSignId, xApiUser, xOnBehalfOfUser, status); // TODO: test validations } @@ -228,9 +446,73 @@ public void getMegaSignsTest() throws ApiException { String authorization = null; String xApiUser = null; String xOnBehalfOfUser = null; + Boolean showHiddenMegaSigns = null; String cursor = null; Integer pageSize = null; - MegaSigns response = api.getMegaSigns(authorization, xApiUser, xOnBehalfOfUser, cursor, pageSize); + String groupId = null; + MegaSigns response = api.getMegaSigns(authorization, xApiUser, xOnBehalfOfUser, showHiddenMegaSigns, cursor, pageSize, groupId); + + // TODO: test validations + } + + /** + * Update the expirationTime on an existing megaSign parent and all the child agreements that are already out for signature. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void updateMegaSignTest() throws ApiException { + String authorization = null; + String megaSignId = null; + MegaSignInfo megaSignInfo = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + String ifMatch = null; + api.updateMegaSign(authorization, megaSignId, megaSignInfo, xApiUser, xOnBehalfOfUser, ifMatch); + + // TODO: test validations + } + + /** + * Updates the latest note of a MegaSign parent agreement for the user. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void updateMegaSignNoteForUserTest() throws ApiException { + String authorization = null; + String megaSignId = null; + Note note = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + api.updateMegaSignNoteForUser(authorization, megaSignId, note, xApiUser, xOnBehalfOfUser); + + // TODO: test validations + } + + /** + * Updates an existing reminder for a MegaSign parent agreement. + * + * You can only update an ACTIVE reminder, and can only update the status to 'CANCELED', update reminderParticipantIds, update allUnsigned or update note. + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void updateMegaSignReminderTest() throws ApiException { + String authorization = null; + String megaSignId = null; + String reminderId = null; + ReminderInfo reminderInfo = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + api.updateMegaSignReminder(authorization, megaSignId, reminderId, reminderInfo, xApiUser, xOnBehalfOfUser); // TODO: test validations } @@ -246,12 +528,32 @@ public void getMegaSignsTest() throws ApiException { @Test public void updateMegaSignStateTest() throws ApiException { String authorization = null; - String ifMatch = null; String megaSignId = null; MegaSignStateInfo megaSignStateInfo = null; String xApiUser = null; String xOnBehalfOfUser = null; - api.updateMegaSignState(authorization, ifMatch, megaSignId, megaSignStateInfo, xApiUser, xOnBehalfOfUser); + String ifMatch = null; + api.updateMegaSignState(authorization, megaSignId, megaSignStateInfo, xApiUser, xOnBehalfOfUser, ifMatch); + + // TODO: test validations + } + + /** + * Updates the visibility of a MegaSign. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void updateMegaSignVisibilityTest() throws ApiException { + String authorization = null; + String megaSignId = null; + VisibilityInfo visibilityInfo = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + api.updateMegaSignVisibility(authorization, megaSignId, visibilityInfo, xApiUser, xOnBehalfOfUser); // TODO: test validations } diff --git a/src/test/java/io/swagger/client/api/MessageTemplatesApiTest.java b/src/test/java/io/swagger/client/api/MessageTemplatesApiTest.java new file mode 100644 index 0000000..87e47d4 --- /dev/null +++ b/src/test/java/io/swagger/client/api/MessageTemplatesApiTest.java @@ -0,0 +1,57 @@ +/* + * + * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + * + * OpenAPI spec version: 6.0.0 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package io.swagger.client.api; + +import io.swagger.client.model.ApiException; +import io.swagger.client.model.messageTemplates.MessageTemplates; +import org.junit.Test; +import org.junit.Ignore; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * API tests for MessageTemplatesApi + */ +@Ignore +public class MessageTemplatesApiTest { + + private final MessageTemplatesApi api = new MessageTemplatesApi(); + + + /** + * Retrieves a list of message templates applicable to the current user. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getMessageTemplatesTest() throws ApiException { + String authorization = null; + String locale = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + String groupId = null; + String cursor = null; + Integer pageSize = null; + MessageTemplates response = api.getMessageTemplates(authorization, locale, xApiUser, xOnBehalfOfUser, groupId, cursor, pageSize); + + // TODO: test validations + } + +} diff --git a/src/test/java/io/swagger/client/api/TransientDocumentsApiTest.java b/src/test/java/io/swagger/client/api/TransientDocumentsApiTest.java index bc307c4..50d875b 100755 --- a/src/test/java/io/swagger/client/api/TransientDocumentsApiTest.java +++ b/src/test/java/io/swagger/client/api/TransientDocumentsApiTest.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) diff --git a/src/test/java/io/swagger/client/api/UsersApiTest.java b/src/test/java/io/swagger/client/api/UsersApiTest.java index 942f6c5..e44ae46 100755 --- a/src/test/java/io/swagger/client/api/UsersApiTest.java +++ b/src/test/java/io/swagger/client/api/UsersApiTest.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) diff --git a/src/test/java/io/swagger/client/api/WebhooksApiTest.java b/src/test/java/io/swagger/client/api/WebhooksApiTest.java index 3dc0cc0..0b9c9dc 100755 --- a/src/test/java/io/swagger/client/api/WebhooksApiTest.java +++ b/src/test/java/io/swagger/client/api/WebhooksApiTest.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -53,7 +38,7 @@ public class WebhooksApiTest { /** * Creates a webhook. * - * This is a primary endpoint which is used to create a new webhook. A webhook can only be created in ACTIVE state. Currently, webhooks are supported at four scopes - Account, Group, User and Resource. <br/> <br/> Before creating a webhook successfully at any of these scopes, Adobe Sign <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobeio/adobeio-documentation/master/sign/webhooks.md#verificationofintentofthewebhookurl'>verifies</a> that the webhook URL that is provided in the registration request really intends to receive notifications and is a valid URL. <br/>There is a defined mechanism for this validation where Adobe Sign makes an HTTPS GET request to the webhook URL. This request has a custom HTTP header X-AdobeSign-ClientId. The value of this header is the client ID of the application that is requesting to create the webhook. To register a webhook successfully, the webhook URL must respond to this verification request with an HTTPS 2XX response code, and also it must send back the same client ID value in one of the following two ways:<ol><li>In a custom response header, X-AdobeSign-ClientId. This is the same header which was passed in the request, and can be echoed back in the response.</li><li> In the JSON response body of the response with the key of xAdobeSignClientId and its value being the same client ID that was sent in the request. </li></ol><p>On successful registration, Adobe Sign sends a success response (any HTTPS 2XX code) to your client app with the unique webhook identifier and a Location header, which contains the URL of the webhook resource created in Adobe Sign.<br/> To learn more, please refer <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobeio/adobeio-documentation/master/sign/webhooks.md'>Webhooks in Adobe Sign Guide</a>.</p> + * This is a primary endpoint which is used to create a new webhook. A webhook can only be created in ACTIVE state. Currently, webhooks are supported at four scopes - Account, Group, User and Resource. <br/> <br/> Before creating a webhook successfully at any of these scopes, Adobe Sign <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks.md#verificationofintentofthewebhookurl'>verifies</a> that the webhook URL that is provided in the registration request really intends to receive notifications and is a valid URL. <br/>There is a defined mechanism for this validation where Adobe Sign makes an HTTPS GET request to the webhook URL. This request has a custom HTTP header X-AdobeSign-ClientId. The value of this header is the client ID of the application that is requesting to create the webhook. To register a webhook successfully, the webhook URL must respond to this verification request with an HTTPS 2XX response code, and also it must send back the same client ID value in one of the following two ways:<ol><li>In a custom response header, X-AdobeSign-ClientId. This is the same header which was passed in the request, and can be echoed back in the response.</li><li> In the JSON response body of the response with the key of xAdobeSignClientId and its value being the same client ID that was sent in the request. </li></ol><p>On successful registration, Adobe Sign sends a success response (any HTTPS 2XX code) to your client app with the unique webhook identifier and a Location header, which contains the URL of the webhook resource created in Adobe Sign.<br/> To learn more, please refer <a href='https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks.md'>Webhooks in Adobe Sign Guide</a>.</p> * * @throws ApiException * if the Api call fails @@ -80,11 +65,11 @@ public void createWebhookTest() throws ApiException { @Test public void deleteWebhookTest() throws ApiException { String authorization = null; - String ifMatch = null; String webhookId = null; String xApiUser = null; String xOnBehalfOfUser = null; - api.deleteWebhook(authorization, ifMatch, webhookId, xApiUser, xOnBehalfOfUser); + String ifMatch = null; + api.deleteWebhook(authorization, webhookId, xApiUser, xOnBehalfOfUser, ifMatch); // TODO: test validations } @@ -143,12 +128,12 @@ public void getWebhooksTest() throws ApiException { @Test public void updateWebhookTest() throws ApiException { String authorization = null; - String ifMatch = null; String webhookId = null; WebhookInfo webhookInfo = null; String xApiUser = null; String xOnBehalfOfUser = null; - api.updateWebhook(authorization, ifMatch, webhookId, webhookInfo, xApiUser, xOnBehalfOfUser); + String ifMatch = null; + api.updateWebhook(authorization, webhookId, webhookInfo, xApiUser, xOnBehalfOfUser, ifMatch); // TODO: test validations } @@ -164,12 +149,12 @@ public void updateWebhookTest() throws ApiException { @Test public void updateWebhookStateTest() throws ApiException { String authorization = null; - String ifMatch = null; String webhookId = null; WebhookStateInfo webhookStateInfo = null; String xApiUser = null; String xOnBehalfOfUser = null; - api.updateWebhookState(authorization, ifMatch, webhookId, webhookStateInfo, xApiUser, xOnBehalfOfUser); + String ifMatch = null; + api.updateWebhookState(authorization, webhookId, webhookStateInfo, xApiUser, xOnBehalfOfUser, ifMatch); // TODO: test validations } diff --git a/src/test/java/io/swagger/client/api/WidgetsApiTest.java b/src/test/java/io/swagger/client/api/WidgetsApiTest.java index 2520d1a..26a9a2f 100755 --- a/src/test/java/io/swagger/client/api/WidgetsApiTest.java +++ b/src/test/java/io/swagger/client/api/WidgetsApiTest.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -29,7 +14,11 @@ package io.swagger.client.api; import io.swagger.client.model.ApiException; +import io.swagger.client.model.widgets.BasicDocumentsImageUrlsInfo; import io.swagger.client.model.widgets.DetailedWidgetParticipantSetInfo; +import io.swagger.client.model.widgets.DocumentUrl; +import io.swagger.client.model.widgets.FetchedWidgetInfo; +import io.swagger.client.model.widgets.MyAgreementInfo; import io.swagger.client.model.widgets.Note; import io.swagger.client.model.widgets.ParticipantSecurityOption; import io.swagger.client.model.widgets.ShareCreationInfoList; @@ -40,7 +29,6 @@ import io.swagger.client.model.widgets.WidgetCreationInfoV6; import io.swagger.client.model.widgets.WidgetCreationResponse; import io.swagger.client.model.widgets.WidgetDocuments; -import io.swagger.client.model.widgets.WidgetDocumentsImageUrlsInfo; import io.swagger.client.model.widgets.WidgetEventList; import io.swagger.client.model.widgets.WidgetInfo; import io.swagger.client.model.widgets.WidgetMembersInfo; @@ -65,7 +53,7 @@ public class WidgetsApiTest { /** - * Share a widget with someone. + * Share a web form with someone. * * * @@ -85,9 +73,9 @@ public void createShareOnWidgetTest() throws ApiException { } /** - * Creates a widget and and returns the widgetId in the response to the client. + * Creates a web form and and returns the widgetId in the response to the client. * - * This is a primary endpoint which is used to create a new widget. You can create a widget in one of the 3 mentioned states: a) <b>DRAFT</b> - to incrementally build the widget, b) <b>AUTHORING</b> - to add/edit form fields in the widget, c) <b>ACTIVE</b> - to immediately host the widget. You can use the PUT /widgets/{widgetId}/state endpoint to transition a widget between the above mentioned states. An allowed transition would follow the any of the following sequences: DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. + * This is a primary endpoint which is used to create a new web form. You can create a web form in one of the 3 mentioned states: a) <b>DRAFT</b> - to incrementally build the web form, b) <b>AUTHORING</b> - to add/edit form fields in the web form, c) <b>ACTIVE</b> - to immediately host the web form. You can use the PUT /widgets/{widgetId}/state endpoint to transition a web form between the above mentioned states. An allowed transition would follow the any of the following sequences: DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. * * @throws ApiException * if the Api call fails @@ -124,7 +112,7 @@ public void getAllWidgetMembersTest() throws ApiException { } /** - * Retrieves the events information for a widget. + * Retrieves the events information for a web form. * * * @@ -144,7 +132,7 @@ public void getEventsTest() throws ApiException { } /** - * Retrieves the participant set of a widget identified by widgetId in the path. + * Retrieves the participant set of a web form identified by widgetId in the path. * * * @@ -165,7 +153,7 @@ public void getParticipantSetTest() throws ApiException { } /** - * Retrieves agreements for the widget. + * Retrieves agreements for the web form. * * * @@ -187,7 +175,7 @@ public void getWidgetAgreementsTest() throws ApiException { } /** - * Retrieves image urls of all visible pages of a document associated with a widget. + * Retrieves image urls of all visible pages of a document associated with a web form. * * * @@ -200,16 +188,15 @@ public void getWidgetAllDocumentsImageUrlsTest() throws ApiException { String widgetId = null; String xApiUser = null; String xOnBehalfOfUser = null; - String ifNoneMatch = null; String imageSizes = null; Boolean showImageAvailabilityOnly = null; - WidgetDocumentsImageUrlsInfo response = api.getWidgetAllDocumentsImageUrls(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch, imageSizes, showImageAvailabilityOnly); + BasicDocumentsImageUrlsInfo response = api.getWidgetAllDocumentsImageUrls(authorization, widgetId, xApiUser, xOnBehalfOfUser, imageSizes, showImageAvailabilityOnly); // TODO: test validations } /** - * Retrieves the audit trail of a widget identified by widgetId. + * Retrieves the audit trail of a web form identified by widgetId. * * * @@ -229,7 +216,7 @@ public void getWidgetAuditTrailTest() throws ApiException { } /** - * Retrieves a single combined PDF document for the documents associated with a widget. + * Retrieves a single combined PDF document for the documents associated with a web form. * * * @@ -252,7 +239,27 @@ public void getWidgetCombinedDocumentTest() throws ApiException { } /** - * Retrieves the file stream of a document of a widget. + * Retrieves url of all visible pages of all the documents associated with a web form. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getWidgetCombinedDocumentUrlTest() throws ApiException { + String authorization = null; + String widgetId = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + Boolean attachAuditReport = null; + DocumentUrl response = api.getWidgetCombinedDocumentUrl(authorization, widgetId, xApiUser, xOnBehalfOfUser, attachAuditReport); + + // TODO: test validations + } + + /** + * Retrieves the file stream of a document of a web form. * * * @@ -273,7 +280,7 @@ public void getWidgetDocumentInfoTest() throws ApiException { } /** - * Retrieves the IDs of the documents associated with widget. + * Retrieves the IDs of the documents associated with web form. * * * @@ -295,7 +302,7 @@ public void getWidgetDocumentsTest() throws ApiException { } /** - * Retrieves data entered by the user into interactive form fields at the time they signed the widget + * Retrieves data entered by the user into interactive form fields at the time they signed the web form * * CSV file stream containing form data information * @@ -314,7 +321,7 @@ public void getWidgetFormDataTest() throws ApiException { } /** - * Retrieves the details of a widget. + * Retrieves the details of a web form. * * * @@ -328,13 +335,31 @@ public void getWidgetInfoTest() throws ApiException { String xApiUser = null; String xOnBehalfOfUser = null; String ifNoneMatch = null; - WidgetCreationInfoV6 response = api.getWidgetInfo(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + FetchedWidgetInfo response = api.getWidgetInfo(authorization, widgetId, xApiUser, xOnBehalfOfUser, ifNoneMatch); + + // TODO: test validations + } + + /** + * Retrieves the web form information related to the api caller + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getWidgetInfoForUserTest() throws ApiException { + String authorization = null; + String widgetId = null; + String xApiUser = null; + MyAgreementInfo response = api.getWidgetInfoForUser(authorization, widgetId, xApiUser); // TODO: test validations } /** - * Retrieves the latest note of a widget for the API user. + * Retrieves the latest note of a web form for the API user. * * * @@ -368,13 +393,14 @@ public void getWidgetSecurityOptionsForParticipationTest() throws ApiException { String participantId = null; String ifNoneMatch = null; String xApiUser = null; - ParticipantSecurityOption response = api.getWidgetSecurityOptionsForParticipation(authorization, widgetId, participantSetId, participantId, ifNoneMatch, xApiUser); + String xOnBehalfOfUser = null; + ParticipantSecurityOption response = api.getWidgetSecurityOptionsForParticipation(authorization, widgetId, participantSetId, participantId, ifNoneMatch, xApiUser, xOnBehalfOfUser); // TODO: test validations } /** - * Retrieves the requested views for a widget. + * Retrieves the requested views for a web form. * * * @@ -394,7 +420,7 @@ public void getWidgetViewTest() throws ApiException { } /** - * Retrieves widgets for a user. + * Retrieves web forms for a user. * * * @@ -406,16 +432,17 @@ public void getWidgetsTest() throws ApiException { String authorization = null; String xApiUser = null; String xOnBehalfOfUser = null; + String groupId = null; Boolean showHiddenWidgets = null; String cursor = null; Integer pageSize = null; - UserWidgets response = api.getWidgets(authorization, xApiUser, xOnBehalfOfUser, showHiddenWidgets, cursor, pageSize); + UserWidgets response = api.getWidgets(authorization, xApiUser, xOnBehalfOfUser, groupId, showHiddenWidgets, cursor, pageSize); // TODO: test validations } /** - * Updates a widget. + * Updates a web form. * * * @@ -425,18 +452,18 @@ public void getWidgetsTest() throws ApiException { @Test public void updateWidgetTest() throws ApiException { String authorization = null; - String ifMatch = null; String widgetId = null; WidgetInfo widgetInfo = null; String xApiUser = null; String xOnBehalfOfUser = null; - api.updateWidget(authorization, ifMatch, widgetId, widgetInfo, xApiUser, xOnBehalfOfUser); + String ifMatch = null; + api.updateWidget(authorization, widgetId, widgetInfo, xApiUser, xOnBehalfOfUser, ifMatch); // TODO: test validations } /** - * Updates the latest note of a widget for the API user. + * Updates the latest note of a web form for the API user. * * * @@ -466,21 +493,22 @@ public void updateWidgetNoteForApiUserTest() throws ApiException { @Test public void updateWidgetSecurityOptionsForParticipationTest() throws ApiException { String authorization = null; - String ifMatch = null; String widgetId = null; String participantSetId = null; String participantId = null; ParticipantSecurityOption participantSecurityOption = null; + String ifMatch = null; String xApiUser = null; - api.updateWidgetSecurityOptionsForParticipation(authorization, ifMatch, widgetId, participantSetId, participantId, participantSecurityOption, xApiUser); + String xOnBehalfOfUser = null; + api.updateWidgetSecurityOptionsForParticipation(authorization, widgetId, participantSetId, participantId, participantSecurityOption, ifMatch, xApiUser, xOnBehalfOfUser); // TODO: test validations } /** - * Updates the state of a widget identified by widgetId in the path. + * Updates the state of a web form identified by widgetId in the path. * - * This endpoint can be used by creator of the widget to transition between the states of widget. An allowed transition would follow any of the following sequence : DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. + * This endpoint can be used by creator of the web form to transition between the states of web form. An allowed transition would follow any of the following sequence : DRAFT->AUTHORING->ACTIVE, ACTIVE<->INACTIVE, DRAFT->CANCELLED. * * @throws ApiException * if the Api call fails @@ -488,18 +516,18 @@ public void updateWidgetSecurityOptionsForParticipationTest() throws ApiExceptio @Test public void updateWidgetStateTest() throws ApiException { String authorization = null; - String ifMatch = null; String widgetId = null; WidgetStateInfo widgetStateInfo = null; String xApiUser = null; String xOnBehalfOfUser = null; - api.updateWidgetState(authorization, ifMatch, widgetId, widgetStateInfo, xApiUser, xOnBehalfOfUser); + String ifMatch = null; + api.updateWidgetState(authorization, widgetId, widgetStateInfo, xApiUser, xOnBehalfOfUser, ifMatch); // TODO: test validations } /** - * Updates the visibility of widget. + * Updates the visibility of web form. * * * diff --git a/src/test/java/io/swagger/client/api/WorkflowsApiTest.java b/src/test/java/io/swagger/client/api/WorkflowsApiTest.java index 958bf0b..db933fc 100755 --- a/src/test/java/io/swagger/client/api/WorkflowsApiTest.java +++ b/src/test/java/io/swagger/client/api/WorkflowsApiTest.java @@ -1,18 +1,3 @@ -/** -* Copyright 2019 Adobe Systems Incorporated. All rights reserved. -* This file is licensed to you under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. You may obtain a copy -* of the License at http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software distributed under -* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS -* OF ANY KIND, either express or implied. See the License for the specific language -* governing permissions and limitations under the License. -* -* -**/ - - /* * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) @@ -30,6 +15,7 @@ import io.swagger.client.model.ApiException; import io.swagger.client.model.workflows.UserWorkflows; +import io.swagger.client.model.workflows.WorkflowDescription; import org.junit.Test; import org.junit.Ignore; @@ -47,6 +33,26 @@ public class WorkflowsApiTest { private final WorkflowsApi api = new WorkflowsApi(); + /** + * Retrieves the details of a workflow. + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getWorkflowInfoTest() throws ApiException { + String authorization = null; + String workflowId = null; + String xApiUser = null; + String xOnBehalfOfUser = null; + String groupId = null; + WorkflowDescription response = api.getWorkflowInfo(authorization, workflowId, xApiUser, xOnBehalfOfUser, groupId); + + // TODO: test validations + } + /** * Retrieves workflows for a user. * @@ -59,10 +65,11 @@ public class WorkflowsApiTest { public void getWorkflowsTest() throws ApiException { String authorization = null; String xApiUser = null; + String xOnBehalfOfUser = null; + String groupId = null; Boolean includeDraftWorkflows = null; Boolean includeInactiveWorkflows = null; - String groupId = null; - UserWorkflows response = api.getWorkflows(authorization, xApiUser, includeDraftWorkflows, includeInactiveWorkflows, groupId); + UserWorkflows response = api.getWorkflows(authorization, xApiUser, xOnBehalfOfUser, groupId, includeDraftWorkflows, includeInactiveWorkflows); // TODO: test validations }