@api-client/core 0.8.22 → 0.9.0

package/build/src/runtime/store/AppSdk.d.ts

@@ -1,213 +0,0 @@
-import { SdkBase, ISdkRequestOptions } from './SdkBase.js';
-import { IBatchDeleteResult, IBatchReadResult, IBatchUpdateResult, IDeleteRecord, IListOptions, IListResponse, IPatchInfo, IPatchRevision, IQueryResponse, IRevertResponse } from '../../models/store/Backend.js';
-import { AppRequest, IAppRequest } from '../../models/AppRequest.js';
-import { AppProject, IAppProject } from '../../models/AppProject.js';
-import { Sdk } from './Sdk.js';
-/**
- * SDK for the Application HTTP requests.
- */
-export declare class AppRequestsSdk extends SdkBase {
-    /**
-     * Adds a single HTTP request to the app.
-     *
-     * @param value The HTTP request to add.
-     * @param appId The application id for which to create the request.
-     * @param request Optional request options
-     * @returns The created AppRequest with updated server-side properties.
-     */
-    create(value: IAppRequest | AppRequest, appId: string, request?: ISdkRequestOptions): Promise<IAppRequest>;
-    /**
-     * Lists application requests.
-     *
-     * @param appId The application id to which lists the requests.
-     * @param options List query options.
-     * @param request Optional request options
-     * @returns The list response with `AppRequest`s
-     */
-    list(appId: string, options?: IListOptions, request?: ISdkRequestOptions): Promise<IListResponse<IAppRequest>>;
-    /**
-     * Creates a number of `AppRequest`s in a batch operation.
-     *
-     * @param values The `AppRequest`s list to insert.
-     * @param appId The application id generating these requests.
-     * @param request Optional request options
-     * @returns The ordered list of created requests.
-     */
-    createBatch(values: (IAppRequest | AppRequest)[], appId: string, request?: ISdkRequestOptions): Promise<IBatchUpdateResult<IAppRequest>>;
-    /**
-     * Reads `AppRequest`s in a batch operation.
-     *
-     * @param keys The list of request keys to read.
-     * @param appId The application id that generated the app requests.
-     * @param request Optional HTTP request options
-     * @returns The ordered list of results. The undefined/null value means the object couldn't be read (does not exists or no access).
-     */
-    readBatch(keys: string[], appId: string, request?: ISdkRequestOptions): Promise<IBatchReadResult<IAppRequest>>;
-    /**
-     * Deletes `AppRequest`s in a batch operation.
-     *
-     * @param keys The list of request keys to delete.
-     * @param appId The application id that generated the app requests.
-     * @param request Optional HTTP request options
-     * @returns A delete record for each request or null/undefined when couldn't delete the record.
-     */
-    deleteBatch(keys: string[], appId: string, request?: ISdkRequestOptions): Promise<IBatchDeleteResult>;
-    /**
-     * Restores previously deleted `AppRequest`s.
-     *
-     * @param keys The list of keys of deleted records.
-     * @param appId The application id that generated the app requests.
-     * @param request Optional HTTP request options
-     * @returns The ordered list of the restored requests. An item can be null/undefined when the service couldn't restore the request.
-     */
-    undeleteBatch(keys: string[], appId: string, request?: ISdkRequestOptions): Promise<IRevertResponse<IAppRequest>>;
-    /**
-     * Reads a single AppRequest entry from the store.
-     *
-     * @param key The key of the request to read.
-     * @param appId The application id that created this entry.
-     * @param request Optional request options
-     * @returns The stored AppRequest.
-     */
-    read(key: string, appId: string, request?: ISdkRequestOptions): Promise<IAppRequest>;
-    /**
-     * Deletes a single AppRequest.
-     *
-     * @param key The key of the AppRequest to delete.
-     * @param appId The application id that created this entry.
-     * @param request Optional request options
-     * @returns The delete record for the request.
-     */
-    delete(key: string, appId: string, request?: ISdkRequestOptions): Promise<IDeleteRecord>;
-    /**
-     * Patches an app request in the store.
-     *
-     * @param key The key of the request to patch
-     * @param appId The application id that created this entry.
-     * @param value The JSON patch to be processed.
-     * @param request Optional HTTP request options.
-     * @returns The JSON patch to revert the change using the `@api-client/json` library
-     */
-    patch(key: string, appId: string, value: IPatchInfo, request?: ISdkRequestOptions): Promise<IPatchRevision>;
-    /**
-     * Performs a full-text search on the stored documents.
-     *
-     * @param appId The application id that created documents.
-     * @param options Regular query options with required "query" property
-     * @param request Optional HTTP request options.
-     * @returns The list of documents with the indexes where the query was found.
-     */
-    query(appId: string, options: IListOptions, request?: ISdkRequestOptions): Promise<IQueryResponse<IAppRequest>>;
-}
-/**
- * SDK for the Application projects.
- */
-export declare class AppProjectsSdk extends SdkBase {
-    /**
-     * Adds a single project to the app.
-     *
-     * @param value The project to add.
-     * @param appId The application id for which to create the project.
-     * @param request Optional request options
-     * @returns The created project with updated server-side properties.
-     */
-    create(value: IAppProject | AppProject, appId: string, request?: ISdkRequestOptions): Promise<IAppProject>;
-    /**
-     * Lists application projects.
-     *
-     * @param appId The application id to which lists the projects.
-     * @param options List query options.
-     * @param request Optional request options
-     * @returns The list response with `AppProject`s
-     */
-    list(appId: string, options?: IListOptions, request?: ISdkRequestOptions): Promise<IListResponse<IAppProject>>;
-    /**
-     * Creates a number of `AppProject`s in a batch operation.
-     *
-     * @param values The `AppProject`s list to insert.
-     * @param appId The application id generating these projects.
-     * @param request Optional request options
-     * @returns The ordered list of created projects.
-     */
-    createBatch(values: (IAppProject | AppProject)[], appId: string, request?: ISdkRequestOptions): Promise<IBatchUpdateResult<IAppProject>>;
-    /**
-     * Reads `AppProject`s in a batch operation.
-     *
-     * @param keys The list of project keys to read.
-     * @param appId The application id that generated the app projects.
-     * @param request Optional HTTP request options
-     * @returns The ordered list of results. The undefined/null value means the object couldn't be read (does not exists or no access).
-     */
-    readBatch(keys: string[], appId: string, request?: ISdkRequestOptions): Promise<IBatchReadResult<IAppProject>>;
-    /**
-     * Deletes `AppProject`s in a batch operation.
-     *
-     * @param keys The list of project keys to delete.
-     * @param appId The application id that generated the app projects.
-     * @param request Optional HTTP request options
-     * @returns A delete record for each project or null/undefined when couldn't delete the record.
-     */
-    deleteBatch(keys: string[], appId: string, request?: ISdkRequestOptions): Promise<IBatchDeleteResult>;
-    /**
-     * Restores previously deleted `AppProject`s.
-     *
-     * @param keys The list of keys of deleted records.
-     * @param appId The application id that generated the app projects.
-     * @param request Optional HTTP request options
-     * @returns The ordered list of the restored projects. An item can be null/undefined when the service couldn't restore the project.
-     */
-    undeleteBatch(keys: string[], appId: string, request?: ISdkRequestOptions): Promise<IRevertResponse<IAppProject>>;
-    /**
-     * Reads a single AppProject entry from the store.
-     *
-     * @param key The key of the project to read.
-     * @param appId The application id that created this entry.
-     * @param request Optional request options
-     * @returns The stored AppProject.
-     */
-    read(key: string, appId: string, request?: ISdkRequestOptions): Promise<IAppProject>;
-    /**
-     * Deletes a single `AppProject`.
-     *
-     * @param key The key of the `AppProject` to delete.
-     * @param appId The application id that created this entry.
-     * @param request Optional request options
-     * @returns The delete record for the project.
-     */
-    delete(key: string, appId: string, request?: ISdkRequestOptions): Promise<IDeleteRecord>;
-    /**
-     * Patches an app project in the store.
-     *
-     * @param key The key of the project to patch
-     * @param value The JSON patch to be processed.
-     * @param request Optional request options.
-     * @returns The JSON patch to revert the change using the `@api-client/json` library
-     */
-    patch(key: string, appId: string, value: IPatchInfo, request?: ISdkRequestOptions): Promise<IPatchRevision>;
-    /**
-     * Performs a full-text search on the stored documents.
-     *
-     * @param appId The application id that created documents.
-     * @param options Regular query options with required "query" property
-     * @param request Optional HTTP request options.
-     * @returns The list of documents with the indexes where the query was found.
-     */
-    query(appId: string, options: IListOptions, request?: ISdkRequestOptions): Promise<IQueryResponse<IAppProject>>;
-}
-/**
- * Sdk used by the HTTP Client.
- */
-export declare class AppSdk extends SdkBase {
-    requests: AppRequestsSdk;
-    projects: AppProjectsSdk;
-    constructor(sdk: Sdk);
-    /**
-     * Performs a full-text search on all supported application documents.
-     *
-     * @param appId The application id that created documents.
-     * @param options Regular query options with required "query" property
-     * @param request Optional HTTP request options.
-     * @returns The list of documents with the indexes where the query was found.
-     */
-    query(appId: string, options: IListOptions, request?: ISdkRequestOptions): Promise<IQueryResponse<IAppProject | IAppRequest>>;
-}