@wix/auto_sdk_papyrus_documents 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,115 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { RawHttpResponse, CreateDocumentOptions, GetDocumentOptions, DeleteDocumentResponse, UpdateDocumentOptions, UpdateDocumentResponse, DownloadDocumentOptions, DownloadDocumentResponse, DownloadDocumentApplicationErrors, GetDownloadUrlOptions, GetDownloadUrlResponse, DownloadDocumentSourceOptions, DownloadDocumentSourceResponse, DownloadDocumentSourceApplicationErrors, DocumentCreatedEnvelope, DocumentDeletedEnvelope, DocumentRenderDelayedEnvelope, DocumentRenderFailedEnvelope, DocumentRenderedEnvelope, DocumentUpdatedEnvelope, DocumentQuery, QueryDocumentOptions, typedQueryDocument, DocumentsQueryBuilder } from './index.typings.js';
+export { AccountInfo, AccountInfoMetadata, ActionEvent, BackgroundSetting, BaseEventMetadata, CommonQueryWithEntityContext, ContentDisposition, ContentDispositionWithLiterals, CreateDocumentRequest, CreateDocumentResponse, CursorPaging, Cursors, DebugOptions, DeleteDocumentByExternalIdRequest, DeleteDocumentByExternalIdResponse, DeleteDocumentRequest, Document, DocumentContent, DocumentFile, DocumentQuerySpec, DocumentRenderDelayed, DocumentRenderFailed, DocumentRendered, DocumentsQueryResult, DomainEvent, DomainEventBodyOneOf, DownloadDocumentRequest, DownloadDocumentSourceRequest, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, FocalPoint, Format, FormatWithLiterals, GetCachedHtmlRequest, GetDocumentRequest, GetDocumentResponse, GetDownloadPageRequest, GetDownloadUrlOptionsDocumentOneOf, GetDownloadUrlRequest, GetDownloadUrlRequestDocumentOneOf, GetRendererInfoRequest, GetRendererInfoResponse, HeadersEntry, IdentificationData, IdentificationDataIdOneOf, ImageSetting, MessageEnvelope, PageOverflow, PageOverflowWithLiterals, PageSettings, Paging, PagingMetadataV2, PaperSize, PaperSizeWithLiterals, QueryDocumentRequest, QueryDocumentResponse, QueryV2, QueryV2PagingMethodOneOf, RedirectToDocumentRequest, RenderDelayedEventConfig, RenderDocumentByIdRequest, RenderDocumentRequest, RenderFormat, RenderFormatWithLiterals, RenderStatus, RenderStatusWithLiterals, RequestedFields, RequestedFieldsWithLiterals, ResizeOption, ResizeOptionWithLiterals, RestoreInfo, SelectSetting, SettingsGroup, SortOrder, SortOrderWithLiterals, Sorting, TemplateSettings, TemplateSettingsOverride, TextContent, TextSetting, UpdateDocumentRequest, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WixMpClientVersion, WixMpClientVersionWithLiterals, utils } from './index.typings.js';
+
+declare function getDownloadPage$1(httpClient: HttpClient): GetDownloadPageSignature;
+interface GetDownloadPageSignature {
+    /**
+     * Get Document.
+     */
+    (file: string | null): Promise<RawHttpResponse>;
+}
+declare function redirectToDocument$1(httpClient: HttpClient): RedirectToDocumentSignature;
+interface RedirectToDocumentSignature {
+    /**
+     * Get Document.
+     */
+    (file: string | null): Promise<RawHttpResponse>;
+}
+declare function createDocument$1(httpClient: HttpClient): CreateDocumentSignature;
+interface CreateDocumentSignature {
+    /**
+     * Creates a new Document
+     * @returns The created Document
+     */
+    (options?: CreateDocumentOptions): Promise<Document>;
+}
+declare function getDocument$1(httpClient: HttpClient): GetDocumentSignature;
+interface GetDocumentSignature {
+    /**
+     * Get Document.
+     * @param - ID of the Document to retrieve
+     * @returns The retrieved Document
+     */
+    (documentId: string, options?: GetDocumentOptions): Promise<Document>;
+}
+declare function deleteDocument$1(httpClient: HttpClient): DeleteDocumentSignature;
+interface DeleteDocumentSignature {
+    /**
+     * Deletes Document.
+     * @param - ID of the Document to delete
+     */
+    (documentId: string): Promise<DeleteDocumentResponse>;
+}
+declare function updateDocument$1(httpClient: HttpClient): UpdateDocumentSignature;
+interface UpdateDocumentSignature {
+    /**
+     * Updates Document. Currently supports only render_status, file_id and static_url updates.
+     * @param - Document ID.
+     */
+    (_id: string | null, options?: UpdateDocumentOptions): Promise<UpdateDocumentResponse>;
+}
+declare function downloadDocument$1(httpClient: HttpClient): DownloadDocumentSignature;
+interface DownloadDocumentSignature {
+    /**
+     * Downloads document.
+     * @param - ID of the Document to retrieve
+     */
+    (documentId: string, options?: DownloadDocumentOptions): Promise<DownloadDocumentResponse & {
+        __applicationErrorsType?: DownloadDocumentApplicationErrors;
+    }>;
+}
+declare function getDownloadUrl$1(httpClient: HttpClient): GetDownloadUrlSignature;
+interface GetDownloadUrlSignature {
+    /**
+     * Resolves document download url.
+     */
+    (options?: GetDownloadUrlOptions): Promise<GetDownloadUrlResponse>;
+}
+declare function downloadDocumentSource$1(httpClient: HttpClient): DownloadDocumentSourceSignature;
+interface DownloadDocumentSourceSignature {
+    /**
+     * Downloads document.
+     * @param - ID of the Document to retrieve
+     */
+    (documentId: string, options?: DownloadDocumentSourceOptions): Promise<DownloadDocumentSourceResponse & {
+        __applicationErrorsType?: DownloadDocumentSourceApplicationErrors;
+    }>;
+}
+declare const onDocumentCreated$1: EventDefinition<DocumentCreatedEnvelope, "wix.papyrus.v1.document_created">;
+declare const onDocumentDeleted$1: EventDefinition<DocumentDeletedEnvelope, "wix.papyrus.v1.document_deleted">;
+declare const onDocumentRenderDelayed$1: EventDefinition<DocumentRenderDelayedEnvelope, "wix.papyrus.v1.document_document_render_delayed">;
+declare const onDocumentRenderFailed$1: EventDefinition<DocumentRenderFailedEnvelope, "wix.papyrus.v1.document_document_render_failed">;
+declare const onDocumentRendered$1: EventDefinition<DocumentRenderedEnvelope, "wix.papyrus.v1.document_document_rendered">;
+declare const onDocumentUpdated$1: EventDefinition<DocumentUpdatedEnvelope, "wix.papyrus.v1.document_updated">;
+
+declare function customQueryDocument(httpClient: HttpClient): {
+    (query: DocumentQuery, options?: QueryDocumentOptions): ReturnType<typeof typedQueryDocument>;
+    (options?: QueryDocumentOptions): DocumentsQueryBuilder;
+};
+declare const getDownloadPage: MaybeContext<BuildRESTFunction<typeof getDownloadPage$1> & typeof getDownloadPage$1>;
+declare const redirectToDocument: MaybeContext<BuildRESTFunction<typeof redirectToDocument$1> & typeof redirectToDocument$1>;
+declare const createDocument: MaybeContext<BuildRESTFunction<typeof createDocument$1> & typeof createDocument$1>;
+declare const getDocument: MaybeContext<BuildRESTFunction<typeof getDocument$1> & typeof getDocument$1>;
+declare const deleteDocument: MaybeContext<BuildRESTFunction<typeof deleteDocument$1> & typeof deleteDocument$1>;
+declare const updateDocument: MaybeContext<BuildRESTFunction<typeof updateDocument$1> & typeof updateDocument$1>;
+declare const downloadDocument: MaybeContext<BuildRESTFunction<typeof downloadDocument$1> & typeof downloadDocument$1>;
+declare const getDownloadUrl: MaybeContext<BuildRESTFunction<typeof getDownloadUrl$1> & typeof getDownloadUrl$1>;
+declare const downloadDocumentSource: MaybeContext<BuildRESTFunction<typeof downloadDocumentSource$1> & typeof downloadDocumentSource$1>;
+declare const queryDocument: MaybeContext<BuildRESTFunction<typeof customQueryDocument> & typeof customQueryDocument>;
+/** */
+declare const onDocumentCreated: BuildEventDefinition<typeof onDocumentCreated$1> & typeof onDocumentCreated$1;
+/** */
+declare const onDocumentDeleted: BuildEventDefinition<typeof onDocumentDeleted$1> & typeof onDocumentDeleted$1;
+/**
+ * Event is sent after specific time if configured and RenderStatus is ACCEPTED/RENDERING.
+ */
+declare const onDocumentRenderDelayed: BuildEventDefinition<typeof onDocumentRenderDelayed$1> & typeof onDocumentRenderDelayed$1;
+/** */
+declare const onDocumentRenderFailed: BuildEventDefinition<typeof onDocumentRenderFailed$1> & typeof onDocumentRenderFailed$1;
+/** */
+declare const onDocumentRendered: BuildEventDefinition<typeof onDocumentRendered$1> & typeof onDocumentRendered$1;
+/** */
+declare const onDocumentUpdated: BuildEventDefinition<typeof onDocumentUpdated$1> & typeof onDocumentUpdated$1;
+
+export { CreateDocumentOptions, DeleteDocumentResponse, DocumentCreatedEnvelope, DocumentDeletedEnvelope, DocumentQuery, DocumentRenderDelayedEnvelope, DocumentRenderFailedEnvelope, DocumentRenderedEnvelope, DocumentUpdatedEnvelope, DocumentsQueryBuilder, DownloadDocumentApplicationErrors, DownloadDocumentOptions, DownloadDocumentResponse, DownloadDocumentSourceApplicationErrors, DownloadDocumentSourceOptions, DownloadDocumentSourceResponse, GetDocumentOptions, GetDownloadUrlOptions, GetDownloadUrlResponse, QueryDocumentOptions, RawHttpResponse, UpdateDocumentOptions, UpdateDocumentResponse, createDocument, deleteDocument, downloadDocument, downloadDocumentSource, getDocument, getDownloadPage, getDownloadUrl, onDocumentCreated, onDocumentDeleted, onDocumentRenderDelayed, onDocumentRenderFailed, onDocumentRendered, onDocumentUpdated, queryDocument, redirectToDocument, updateDocument };