liferay-headless-rest-client/dist/clients/digital-signature-rest-v1.0/types.gen.d.ts

A collection of Headless Clients used in Liferay Portal

export type DsDocument={assignTabsToDSRecipientId?:string;data?:string;fileEntryExternalReferenceCode?:string;fileExtension?:string;id?:string;name?:string;transformPDFFields?:boolean;uri?:string;readonly'x-class-name'?:string;};export type DsEnvelope={readonly dateCreated?:string;readonly dateModified?:string;dsDocument?:Array<DsDocument>;dsRecipient?:Array<DsRecipient>;emailBlurb?:string;emailSubject?:string;id?:string;name?:string;senderEmailAddress?:string;siteId?:number;status?:string;readonly'x-class-name'?:string;};export type DsRecipient={dsClientUserId?:string;emailAddress?:string;id?:string;name?:string;status?:string;tabs?:{[key:string]:unknown;};readonly'x-class-name'?:string;};export type Facet={facetCriteria?:string;facetValues?:Array<FacetValue>;};export type FacetValue={numberOfOccurrences?:number;term?:string;};export type PageDsEnvelope={items?:Array<DsEnvelope>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;};export type DsEnvelopeSignatureUrl={url?:string;readonly'x-class-name'?:string;};export type DsRecipientViewDefinition={authenticationMethod?:string;dsClientUserId?:string;emailAddress?:string;returnURL?:string;userName?:string;readonly'x-class-name'?:string;};export type GetSiteDsEnvelopeData={body?:never;path:{siteId:string;dsEnvelopeId:string;};query?:never;url:'/o/digital-signature-rest/v1.0/sites/{siteId}/ds-envelopes/{dsEnvelopeId}';};export type GetSiteDsEnvelopeResponses={default:DsEnvelope;};export type GetSiteDsEnvelopeResponse=GetSiteDsEnvelopeResponses[keyof GetSiteDsEnvelopeResponses];export type GetSiteDsEnvelopesPageData={body?:never;path:{siteId:string;};query?:{fromDate?:string;keywords?:string;order?:string;page?:string;pageSize?:string;status?:string;nestedFields?:string;};url:'/o/digital-signature-rest/v1.0/sites/{siteId}/ds-envelopes';};export type GetSiteDsEnvelopesPageResponses={default:PageDsEnvelope;};export type GetSiteDsEnvelopesPageResponse=GetSiteDsEnvelopesPageResponses[keyof GetSiteDsEnvelopesPageResponses];export type PostSiteDsEnvelopeData={body?:DsEnvelope;path:{siteId:string;};query?:never;url:'/o/digital-signature-rest/v1.0/sites/{siteId}/ds-envelopes';};export type PostSiteDsEnvelopeResponses={default:DsEnvelope;};export type PostSiteDsEnvelopeResponse=PostSiteDsEnvelopeResponses[keyof PostSiteDsEnvelopeResponses];export type PostSiteDsEnvelopeBatchData={body?:{[key:string]:unknown;};path:{siteId:string;};query?:{callbackURL?:string;};url:'/o/digital-signature-rest/v1.0/sites/{siteId}/ds-envelopes/batch';};export type PostSiteDsEnvelopeBatchResponses={default:unknown;};export type PostSiteDsEnvelopesPageExportBatchData={body?:never;path:{siteId:string;};query?:{fromDate?:string;keywords?:string;order?:string;status?:string;callbackURL?:string;contentType?:string;fieldNames?:string;};url:'/o/digital-signature-rest/v1.0/sites/{siteId}/ds-envelopes/export-batch';};export type PostSiteDsEnvelopesPageExportBatchResponses={default:unknown;};export type PostSiteDsRecipientViewDefinitionData={body?:DsRecipientViewDefinition;path:{siteId:string;dsEnvelopeId:string;};query?:never;url:'/o/digital-signature-rest/v1.0/sites/{siteId}/ds-recipient-view-definition/{dsEnvelopeId}';};export type PostSiteDsRecipientViewDefinitionResponses={default:DsEnvelopeSignatureUrl;};export type PostSiteDsRecipientViewDefinitionResponse=PostSiteDsRecipientViewDefinitionResponses[keyof PostSiteDsRecipientViewDefinitionResponses];export type ClientOptions={baseUrl:'http://localhost:8080'|(string&{});};