@sfxcode/nuxt-mongocamp-server 1.7.0 → 1.9.0

package/dist/runtime/api/apis/DocumentApi.d.ts

@@ -2,7 +2,7 @@
  * mongocamp-library
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 1.7.1
+ * The version of the OpenAPI document: 1.8.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,78 +10,258 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime.js';
-import type { CountResponse, DeleteResponse, InsertResponse, MongoFindRequest, SearchRequest, UpdateRequest, UpdateResponse } from '../models/index.js';
+import { type CountResponse } from '../models/CountResponse.js';
+import { type DeleteResponse } from '../models/DeleteResponse.js';
+import { type ImportResponse } from '../models/ImportResponse.js';
+import { type InsertResponse } from '../models/InsertResponse.js';
+import { type MongoFindRequest } from '../models/MongoFindRequest.js';
+import { type SearchRequest } from '../models/SearchRequest.js';
+import { type UpdateRequest } from '../models/UpdateRequest.js';
+import { type UpdateResponse } from '../models/UpdateResponse.js';
 export interface DeleteRequest {
+    /**
+     * The name of your MongoDb Collection
+     */
     collectionName: string;
+    /**
+     * DocumentId to delete
+     */
     documentId: string;
 }
 export interface CountDocumentsRequest {
+    /**
+     * The name of your MongoDb Collection
+     */
     collectionName: string;
+    /**
+     * Filter Query like on the list of documents, by default all documents are counted
+     */
     filter?: string;
 }
 export interface DeleteManyRequest {
+    /**
+     * The name of your MongoDb Collection
+     */
     collectionName: string;
+    /**
+     *
+     */
     requestBody: {
-        [key: string]: any;
+        [key: string]: any | null;
     };
+    /**
+     * Allow an empty filter, that matches all documents of the collection
+     */
     matchAll?: boolean;
+    /**
+     * Filter Query like on the list of documents, as an alternative to the filter of the request body. Use only one of both.
+     */
     filter?: string;
 }
+export interface ExportDocumentsRequest {
+    /**
+     * The name of your MongoDb Collection
+     */
+    collectionName: string;
+    /**
+     * ndjson (one JSON document per line), json (one array) or csv
+     */
+    format?: string;
+    /**
+     * Filter Query like on the list of documents, by default all documents are exported
+     */
+    filter?: string;
+    /**
+     * Sorting like on the list of documents, a leading - sorts descending
+     */
+    sort?: Array<string>;
+    /**
+     * The fields to export, for csv they are the columns in this order
+     */
+    projection?: Array<string>;
+    /**
+     * The greatest number of documents, by default all
+     */
+    limit?: number;
+    /**
+     * relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({"$oid": ...}, {"$date": ...}, {"$numberDecimal": ...}, canonical also {"$numberInt": ...}, {"$numberLong": ...} and {"$numberDouble": ...}). Without the parameter the documents are returned as before.
+     */
+    extendedJson?: string;
+}
 export interface FindRequest {
+    /**
+     * The name of your MongoDb Collection
+     */
     collectionName: string;
+    /**
+     *
+     */
     mongoFindRequest: MongoFindRequest;
+    /**
+     * Count elements per page
+     */
     rowsPerPage?: number;
+    /**
+     * Requested page of the ResultSets
+     */
     page?: number;
+    /**
+     * relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({"$oid": ...}, {"$date": ...}, {"$numberDecimal": ...}, canonical also {"$numberInt": ...}, {"$numberLong": ...} and {"$numberDouble": ...}). Without the parameter the documents are returned as before.
+     */
+    extendedJson?: string;
 }
 export interface GetDocumentRequest {
+    /**
+     * The name of your MongoDb Collection
+     */
     collectionName: string;
+    /**
+     * DocumentId to read
+     */
     documentId: string;
+    /**
+     * relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({"$oid": ...}, {"$date": ...}, {"$numberDecimal": ...}, canonical also {"$numberInt": ...}, {"$numberLong": ...} and {"$numberDouble": ...}). Without the parameter the documents are returned as before.
+     */
+    extendedJson?: string;
+}
+export interface ImportDocumentsRequest {
+    /**
+     * The name of your MongoDb Collection
+     */
+    collectionName: string;
+    /**
+     *
+     */
+    body: string;
 }
 export interface InsertRequest {
+    /**
+     * The name of your MongoDb Collection
+     */
     collectionName: string;
+    /**
+     * JSON Representation for your Document.
+     */
     requestBody: {
-        [key: string]: any;
+        [key: string]: any | null;
     };
 }
 export interface InsertManyRequest {
+    /**
+     * The name of your MongoDb Collection
+     */
     collectionName: string;
+    /**
+     * true (default): the insert stops at the first document that fails (answer 409 for a duplicate key). false: all documents that can be stored are stored, the others are listed in `errors` of the answer.
+     */
     ordered?: boolean;
+    /**
+     *
+     */
     requestBody?: Array<{
-        [key: string]: any;
+        [key: string]: any | null;
     }>;
 }
 export interface ListDocumentsRequest {
+    /**
+     * The name of your MongoDb Collection
+     */
     collectionName: string;
+    /**
+     * MongoDB Filter Query by Default all filter
+     */
     filter?: string;
+    /**
+     * MongoDB sorting
+     */
     sort?: Array<string>;
+    /**
+     * MongoDB projection
+     */
     projection?: Array<string>;
+    /**
+     * Count elements per page
+     */
     rowsPerPage?: number;
+    /**
+     * Requested page of the ResultSets
+     */
     page?: number;
+    /**
+     * relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({"$oid": ...}, {"$date": ...}, {"$numberDecimal": ...}, canonical also {"$numberInt": ...}, {"$numberLong": ...} and {"$numberDouble": ...}). Without the parameter the documents are returned as before.
+     */
+    extendedJson?: string;
 }
 export interface SearchDocumentsRequest {
+    /**
+     * The name of your MongoDb Collection
+     */
     collectionName: string;
+    /**
+     *
+     */
     searchRequest: SearchRequest;
+    /**
+     * Count elements per page
+     */
     rowsPerPage?: number;
+    /**
+     * Requested page of the ResultSets
+     */
     page?: number;
+    /**
+     * relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({"$oid": ...}, {"$date": ...}, {"$numberDecimal": ...}, canonical also {"$numberInt": ...}, {"$numberLong": ...} and {"$numberDouble": ...}). Without the parameter the documents are returned as before.
+     */
+    extendedJson?: string;
 }
 export interface UpdateRequest {
+    /**
+     * The name of your MongoDb Collection
+     */
     collectionName: string;
+    /**
+     * DocumentId to update
+     */
     documentId: string;
+    /**
+     *
+     */
     requestBody: {
-        [key: string]: any;
+        [key: string]: any | null;
     };
 }
 export interface UpdateDocumentPartialRequest {
+    /**
+     * The name of your MongoDb Collection
+     */
     collectionName: string;
+    /**
+     * DocumentId to update
+     */
     documentId: string;
+    /**
+     *
+     */
     requestBody: {
-        [key: string]: any;
+        [key: string]: any | null;
     };
 }
 export interface UpdateManyRequest {
+    /**
+     * The name of your MongoDb Collection
+     */
     collectionName: string;
+    /**
+     *
+     */
     updateRequest: UpdateRequest;
+    /**
+     * Allow an empty filter, that matches all documents of the collection
+     */
     matchAll?: boolean;
+    /**
+     * Filter Query like on the list of documents, as an alternative to the filter of the request body. Use only one of both.
+     */
     filter?: string;
 }
 /**
@@ -130,6 +310,20 @@ export declare class DocumentApi extends runtime.BaseAPI {
      * Delete Many in Collection
      */
     deleteMany(requestParameters: DeleteManyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteResponse>;
+    /**
+     * Creates request options for exportDocuments without sending the request
+     */
+    exportDocumentsRequestOpts(requestParameters: ExportDocumentsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Download the documents of a Collection as a stream: ndjson (one JSON document per line), json (one array) or csv (a header line, nested values as JSON, a text with a comma, a quote or a line break in quotes). The documents are written while the database delivers them, the memory of the server does not depend on the size of the Collection. The columns of a csv export are the fields of `projection`, by default the fields of the first 1000 documents. With extendedJson the types of the values are explicit. A failure while the stream is running ends the stream, the status is 200 by then.
+     * Export Documents of a Collection
+     */
+    exportDocumentsRaw(requestParameters: ExportDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Download the documents of a Collection as a stream: ndjson (one JSON document per line), json (one array) or csv (a header line, nested values as JSON, a text with a comma, a quote or a line break in quotes). The documents are written while the database delivers them, the memory of the server does not depend on the size of the Collection. The columns of a csv export are the fields of `projection`, by default the fields of the first 1000 documents. With extendedJson the types of the values are explicit. A failure while the stream is running ends the stream, the status is 200 by then.
+     * Export Documents of a Collection
+     */
+    exportDocuments(requestParameters: ExportDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
     /**
      * Creates request options for find without sending the request
      */
@@ -139,14 +333,14 @@ export declare class DocumentApi extends runtime.BaseAPI {
      * Documents in Collection
      */
     findRaw(requestParameters: FindRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<{
-        [key: string]: any;
+        [key: string]: any | null;
     }>>>;
     /**
      * Alternative to GET Route for more complex queries and URL max. Length
      * Documents in Collection
      */
     find(requestParameters: FindRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<{
-        [key: string]: any;
+        [key: string]: any | null;
     }>>;
     /**
      * Creates request options for getDocument without sending the request
@@ -157,15 +351,29 @@ export declare class DocumentApi extends runtime.BaseAPI {
      * Document from Collection
      */
     getDocumentRaw(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
-        [key: string]: any;
+        [key: string]: any | null;
     }>>;
     /**
      * Get one Document from given Collection
      * Document from Collection
      */
     getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
-        [key: string]: any;
+        [key: string]: any | null;
     }>;
+    /**
+     * Creates request options for importDocuments without sending the request
+     */
+    importDocumentsRequestOpts(requestParameters: ImportDocumentsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Store the documents of the request body: one JSON document per line (NDJSON, as written by the export). A line is read like a document in the body of an insert (Extended JSON wrappers, dates). The body is read as a stream and the documents are stored in batches without ordering, a line that cannot be stored does not stop the others: the answer counts what was read, stored and failed and names the first failed lines (`errors`, `index` is the number of the line). The size of the body is limited by IMPORT_MAX_BYTES (413 above), there is no time limit.
+     * Import Documents into a Collection
+     */
+    importDocumentsRaw(requestParameters: ImportDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImportResponse>>;
+    /**
+     * Store the documents of the request body: one JSON document per line (NDJSON, as written by the export). A line is read like a document in the body of an insert (Extended JSON wrappers, dates). The body is read as a stream and the documents are stored in batches without ordering, a line that cannot be stored does not stop the others: the answer counts what was read, stored and failed and names the first failed lines (`errors`, `index` is the number of the line). The size of the body is limited by IMPORT_MAX_BYTES (413 above), there is no time limit.
+     * Import Documents into a Collection
+     */
+    importDocuments(requestParameters: ImportDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImportResponse>;
     /**
      * Creates request options for insert without sending the request
      */
@@ -203,14 +411,14 @@ export declare class DocumentApi extends runtime.BaseAPI {
      * Documents in Collection
      */
     listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<{
-        [key: string]: any;
+        [key: string]: any | null;
     }>>>;
     /**
      * Get Documents paginated from given Collection
      * Documents in Collection
      */
     listDocuments(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<{
-        [key: string]: any;
+        [key: string]: any | null;
     }>>;
     /**
      * Creates request options for searchDocuments without sending the request
@@ -221,14 +429,14 @@ export declare class DocumentApi extends runtime.BaseAPI {
      * Search Documents in Collection
      */
     searchDocumentsRaw(requestParameters: SearchDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<{
-        [key: string]: any;
+        [key: string]: any | null;
     }>>>;
     /**
      * The list of documents with the parameters in the request body: for filters that are too long for the URL (a URL of more than 2048 characters is refused by the server before the request is handled, without CORS headers). The filter is a Lucene query like in the list, the answer and the pagination headers are the same.
      * Search Documents in Collection
      */
     searchDocuments(requestParameters: SearchDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<{
-        [key: string]: any;
+        [key: string]: any | null;
     }>>;
     /**
      * Creates request options for update without sending the request