@vectorize-io/vectorize-client
Version:
Client for the Vectorize API
72 lines (71 loc) • 2.57 kB
TypeScript
/**
* Vectorize API
* API for Vectorize services (Beta)
*
* The version of the OpenAPI document: 0.1.2
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Configuration for DocuSign connector
* @export
* @interface DOCUSIGNConfig
*/
export interface DOCUSIGNConfig {
/**
* Envelope Statuses. Filter envelopes by status
* @type {Array<string>}
* @memberof DOCUSIGNConfig
*/
envelopeStatuses?: DOCUSIGNConfigEnvelopeStatusesEnum;
/**
* Created From Date. Include envelopes created on or after this date. Example: Enter start date (YYYY-MM-DD)
* @type {Date}
* @memberof DOCUSIGNConfig
*/
fromDate: Date;
/**
* Created To Date. Include envelopes that were last updated up to this date. Example: Enter end date (YYYY-MM-DD)
* @type {Date}
* @memberof DOCUSIGNConfig
*/
toDate?: Date;
/**
* Max Envelopes. Leave blank for no limit, or specify a maximum number. Example: Enter maximum number of documents to retrieve (leave blank for no limit)
* @type {number}
* @memberof DOCUSIGNConfig
*/
maxDocuments?: number;
/**
* Search Text. Filter envelopes containing this text in the email subject, sender, body, or custom fields. Example: Enter text to search within envelope content
* @type {string}
* @memberof DOCUSIGNConfig
*/
searchText?: string;
}
/**
* @export
*/
export declare const DOCUSIGNConfigEnvelopeStatusesEnum: {
readonly Completed: "completed";
readonly Correct: "correct";
readonly Created: "created";
readonly Declined: "declined";
readonly Delivered: "delivered";
readonly Sent: "sent";
readonly Signed: "signed";
readonly Voided: "voided";
readonly All: "all";
};
export type DOCUSIGNConfigEnvelopeStatusesEnum = typeof DOCUSIGNConfigEnvelopeStatusesEnum[keyof typeof DOCUSIGNConfigEnvelopeStatusesEnum];
/**
* Check if a given object implements the DOCUSIGNConfig interface.
*/
export declare function instanceOfDOCUSIGNConfig(value: object): value is DOCUSIGNConfig;
export declare function DOCUSIGNConfigFromJSON(json: any): DOCUSIGNConfig;
export declare function DOCUSIGNConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): DOCUSIGNConfig;
export declare function DOCUSIGNConfigToJSON(json: any): DOCUSIGNConfig;
export declare function DOCUSIGNConfigToJSONTyped(value?: DOCUSIGNConfig | null, ignoreDiscriminator?: boolean): any;