@altravia/openapi
Version:
Official OpenApi NodeJS Client
86 lines • 2.65 kB
TypeScript
import { AxiosInstance } from "axios";
import { Environment, Service } from "..";
import { Callback } from "../types";
interface SummaryVisura {
nome_visura: string;
nome_categoria: string;
hash_visura: string;
}
interface Visura {
nome_visura: string;
nome_categoria: string;
json_struttura: Jsonstruttura;
ricerca: string;
prezzo_visura: number;
prezzo_ricerca: number;
hash_visura: string;
fornitori: any[];
}
interface Jsonstruttura {
campi: any;
validazione: string;
istruzioni: string;
istruzioni_ricerca: string;
}
interface Richiesta {
_id?: string;
state?: number;
hash_visura?: string;
nome?: string;
ricerca?: boolean;
id_ricerca?: string;
prezzo_visura: number;
prezzo_ricerca: number;
indice_ricerca?: string;
stato_richiesta: string;
email_target?: string;
timestamp_creation?: number;
timestamp_last_update?: number;
owner?: string;
callback_data?: false | any;
ricerche?: any;
esito?: Esito;
}
interface Esito {
codice: string;
info: string;
}
interface RichiestaDocumento {
nome: string;
dimensione: number;
file: string;
}
export declare type Transaction = 'open' | 'close';
export declare class Visengine implements Service {
client: AxiosInstance;
readonly service = "visengine";
readonly baseUrl = "visengine2.altravia.com";
environment: Environment;
lastVisura?: any;
constructor(client: AxiosInstance, environment: Environment);
listServices(): Promise<SummaryVisura[]>;
getServiceDescription(hash: string): Promise<Visura>;
listRequests(): Promise<Richiesta[]>;
getRequest(id: string): Promise<any>;
/**
*
* @param options the options of a specific visura
* @param callback optional: a callback object to ping when the visura is ready
* @param transaction whether to close the request now or in the future with an optional PUT request
* @returns
*/
createRequest(hash: string, json_visura: any, options?: any, callback?: Callback, email_target?: string, transaction?: Transaction, test?: boolean): Promise<any>;
/**
*
* @param updatedFields un oggetto chiave-valore dei campi della visura che si vogliono aggiornare:
* `{'$0': ...nuovi_valori, '$3': ...nuovi_valori}`
*/
updateRequest(id: string, updatedFields: {
[key: string]: any;
}, transaction?: Transaction): Promise<any>;
getDocument(id: string): Promise<RichiestaDocumento>;
get url(): string;
getTransactionStatus(t: Transaction): 0 | 1;
}
export {};
//# sourceMappingURL=Visengine.d.ts.map