@emilgroup/document-sdk 1.0.0

package/models/index.ts

@@ -0,0 +1,42 @@
+export * from './create-doc-template-request-dto';
+export * from './create-doc-template-response-class';
+export * from './create-document-request-dto';
+export * from './create-document-sync-response-class';
+export * from './create-html-template-dto';
+export * from './create-layout-request-dto';
+export * from './create-layout-response-class';
+export * from './create-presigned-post-request-dto';
+export * from './create-presigned-post-response-class';
+export * from './delete-layout-request-dto';
+export * from './delete-request-dto';
+export * from './delete-response-class';
+export * from './doc-template-class';
+export * from './document-class';
+export * from './download-document-request-dto';
+export * from './get-doc-template-request-dto';
+export * from './get-doc-template-response-class';
+export * from './get-document-download-url-response-class';
+export * from './get-layout-request-dto';
+export * from './get-layout-response-class';
+export * from './get-signed-s3-key-url-response-class';
+export * from './html-template-class';
+export * from './layout-class';
+export * from './list-doc-template-request-dto';
+export * from './list-doc-templates-response-class';
+export * from './list-documents-response-class';
+export * from './list-layouts-response-class';
+export * from './list-request-dto';
+export * from './list-search-keywords-request-dto';
+export * from './list-search-keywords-response-class';
+export * from './list-searchable-document-owners-response-class';
+export * from './list-searchable-documents-request-dto';
+export * from './list-searchable-documents-response-class';
+export * from './searchable-document-class';
+export * from './searchable-document-owner-class';
+export * from './update-doc-template-request-dto';
+export * from './update-doc-template-response-class';
+export * from './update-document-request-dto';
+export * from './update-document-response-class';
+export * from './update-html-template-dto';
+export * from './update-layout-request-dto';
+export * from './update-layout-response-class';

package/models/layout-class.ts

@@ -0,0 +1,85 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { HtmlTemplateClass } from './html-template-class';
+
+/**
+ * 
+ * @export
+ * @interface LayoutClass
+ */
+export interface LayoutClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof LayoutClass
+     */
+    'id': number;
+    /**
+     * Record owner.
+     * @type {string}
+     * @memberof LayoutClass
+     */
+    'owner': string;
+    /**
+     * Layout name.
+     * @type {string}
+     * @memberof LayoutClass
+     */
+    'name': string;
+    /**
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * @type {string}
+     * @memberof LayoutClass
+     */
+    'slug': string;
+    /**
+     * Layout style.
+     * @type {string}
+     * @memberof LayoutClass
+     */
+    'style': string;
+    /**
+     * Header Template.
+     * @type {HtmlTemplateClass}
+     * @memberof LayoutClass
+     */
+    'headerTemplate': HtmlTemplateClass;
+    /**
+     * Footer Template.
+     * @type {HtmlTemplateClass}
+     * @memberof LayoutClass
+     */
+    'footerTemplate': HtmlTemplateClass;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof LayoutClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof LayoutClass
+     */
+    'updatedAt': string;
+    /**
+     * Time at which the layout was deleted.
+     * @type {string}
+     * @memberof LayoutClass
+     */
+    'deletedAt'?: string;
+}
+

package/models/list-doc-template-request-dto.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ListDocTemplateRequestDto
+ */
+export interface ListDocTemplateRequestDto {
+    /**
+     * 
+     * @type {number}
+     * @memberof ListDocTemplateRequestDto
+     */
+    'pageSize'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ListDocTemplateRequestDto
+     */
+    'pageToken'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ListDocTemplateRequestDto
+     */
+    'filter'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ListDocTemplateRequestDto
+     */
+    'order'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ListDocTemplateRequestDto
+     */
+    'expand'?: string;
+}
+

package/models/list-doc-templates-response-class.ts

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { DocTemplateClass } from './doc-template-class';
+
+/**
+ * 
+ * @export
+ * @interface ListDocTemplatesResponseClass
+ */
+export interface ListDocTemplatesResponseClass {
+    /**
+     * The list of document templates.
+     * @type {Array<DocTemplateClass>}
+     * @memberof ListDocTemplatesResponseClass
+     */
+    'templates': Array<DocTemplateClass>;
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListDocTemplatesResponseClass
+     */
+    'nextPageToken': string;
+}
+

package/models/list-documents-response-class.ts

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { DocumentClass } from './document-class';
+
+/**
+ * 
+ * @export
+ * @interface ListDocumentsResponseClass
+ */
+export interface ListDocumentsResponseClass {
+    /**
+     * The list of documents.
+     * @type {Array<DocumentClass>}
+     * @memberof ListDocumentsResponseClass
+     */
+    'items': Array<DocumentClass>;
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListDocumentsResponseClass
+     */
+    'nextPageToken': string;
+}
+

package/models/list-layouts-response-class.ts

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { LayoutClass } from './layout-class';
+
+/**
+ * 
+ * @export
+ * @interface ListLayoutsResponseClass
+ */
+export interface ListLayoutsResponseClass {
+    /**
+     * The list of layouts.
+     * @type {Array<LayoutClass>}
+     * @memberof ListLayoutsResponseClass
+     */
+    'layouts': Array<LayoutClass>;
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListLayoutsResponseClass
+     */
+    'nextPageToken': string;
+}
+

package/models/list-request-dto.ts

@@ -0,0 +1,60 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ListRequestDto
+ */
+export interface ListRequestDto {
+    /**
+     * Page size
+     * @type {number}
+     * @memberof ListRequestDto
+     */
+    'pageSize'?: number;
+    /**
+     * Page token
+     * @type {string}
+     * @memberof ListRequestDto
+     */
+    'pageToken'?: string;
+    /**
+     * List filter
+     * @type {string}
+     * @memberof ListRequestDto
+     */
+    'filter'?: string;
+    /**
+     * Search query
+     * @type {string}
+     * @memberof ListRequestDto
+     */
+    'search'?: string;
+    /**
+     * Ordering criteria
+     * @type {string}
+     * @memberof ListRequestDto
+     */
+    'order'?: string;
+    /**
+     * Extra fields to fetch
+     * @type {string}
+     * @memberof ListRequestDto
+     */
+    'expand'?: string;
+}
+

package/models/list-search-keywords-request-dto.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ListSearchKeywordsRequestDto
+ */
+export interface ListSearchKeywordsRequestDto {
+    /**
+     * Text to search in the documents.
+     * @type {string}
+     * @memberof ListSearchKeywordsRequestDto
+     */
+    'searchText': string;
+}
+

package/models/list-search-keywords-response-class.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ListSearchKeywordsResponseClass
+ */
+export interface ListSearchKeywordsResponseClass {
+    /**
+     * Keywords used for search and to be highlighted in the document preview.
+     * @type {Array<string>}
+     * @memberof ListSearchKeywordsResponseClass
+     */
+    'keywords': Array<string>;
+}
+

package/models/list-searchable-document-owners-response-class.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { SearchableDocumentOwnerClass } from './searchable-document-owner-class';
+
+/**
+ * 
+ * @export
+ * @interface ListSearchableDocumentOwnersResponseClass
+ */
+export interface ListSearchableDocumentOwnersResponseClass {
+    /**
+     * Searchable document owners
+     * @type {Array<SearchableDocumentOwnerClass>}
+     * @memberof ListSearchableDocumentOwnersResponseClass
+     */
+    'owners': Array<SearchableDocumentOwnerClass>;
+}
+

package/models/list-searchable-documents-request-dto.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ListSearchableDocumentsRequestDto
+ */
+export interface ListSearchableDocumentsRequestDto {
+    /**
+     * Text to search in the documents.
+     * @type {string}
+     * @memberof ListSearchableDocumentsRequestDto
+     */
+    'searchText': string;
+    /**
+     * List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided).
+     * @type {string}
+     * @memberof ListSearchableDocumentsRequestDto
+     */
+    'ownerIds': string;
+}
+

package/models/list-searchable-documents-response-class.ts

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { SearchableDocumentClass } from './searchable-document-class';
+
+/**
+ * 
+ * @export
+ * @interface ListSearchableDocumentsResponseClass
+ */
+export interface ListSearchableDocumentsResponseClass {
+    /**
+     * Searchable documents that match the search criteria.
+     * @type {Array<SearchableDocumentClass>}
+     * @memberof ListSearchableDocumentsResponseClass
+     */
+    'documents': Array<SearchableDocumentClass>;
+    /**
+     * Keywords used for search and to be highlighted in the document preview.
+     * @type {Array<string>}
+     * @memberof ListSearchableDocumentsResponseClass
+     */
+    'keywords': Array<string>;
+}
+

package/models/searchable-document-class.ts

@@ -0,0 +1,72 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface SearchableDocumentClass
+ */
+export interface SearchableDocumentClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof SearchableDocumentClass
+     */
+    'id': number;
+    /**
+     * Searchable document name.
+     * @type {string}
+     * @memberof SearchableDocumentClass
+     */
+    'name': string;
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof SearchableDocumentClass
+     */
+    'ownerId': number;
+    /**
+     * Searchable document owner name.
+     * @type {string}
+     * @memberof SearchableDocumentClass
+     */
+    'ownerName': string;
+    /**
+     * Headlines (snippets) from the document.
+     * @type {Array<string>}
+     * @memberof SearchableDocumentClass
+     */
+    'headlines': Array<string>;
+    /**
+     * S3 key of the searchable document file.
+     * @type {string}
+     * @memberof SearchableDocumentClass
+     */
+    's3Key': string;
+    /**
+     * Signed URL to download the document file from S3.
+     * @type {string}
+     * @memberof SearchableDocumentClass
+     */
+    'signedS3Url': string;
+    /**
+     * Rank of the document in the search.
+     * @type {number}
+     * @memberof SearchableDocumentClass
+     */
+    'rank': number;
+}
+

package/models/searchable-document-owner-class.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface SearchableDocumentOwnerClass
+ */
+export interface SearchableDocumentOwnerClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof SearchableDocumentOwnerClass
+     */
+    'id': number;
+    /**
+     * Searchable document owner name.
+     * @type {string}
+     * @memberof SearchableDocumentOwnerClass
+     */
+    'name': string;
+}
+

package/models/update-doc-template-request-dto.ts

@@ -0,0 +1,61 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { UpdateHtmlTemplateDto } from './update-html-template-dto';
+
+/**
+ * 
+ * @export
+ * @interface UpdateDocTemplateRequestDto
+ */
+export interface UpdateDocTemplateRequestDto {
+    /**
+     * Template name.
+     * @type {string}
+     * @memberof UpdateDocTemplateRequestDto
+     */
+    'name': string;
+    /**
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * @type {string}
+     * @memberof UpdateDocTemplateRequestDto
+     */
+    'slug': string;
+    /**
+     * Unique identifier referencing the layout.
+     * @type {number}
+     * @memberof UpdateDocTemplateRequestDto
+     */
+    'layoutId': number;
+    /**
+     * Body templates.
+     * @type {UpdateHtmlTemplateDto}
+     * @memberof UpdateDocTemplateRequestDto
+     */
+    'bodyTemplate': UpdateHtmlTemplateDto;
+    /**
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * @type {string}
+     * @memberof UpdateDocTemplateRequestDto
+     */
+    'productSlug'?: string;
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof UpdateDocTemplateRequestDto
+     */
+    'id': number;
+}
+