@kommerz/ts-client 1.184.1 → 1.187.0

package/dist/apis/FileDirectorySharesApi.d.ts

@@ -9,50 +9,115 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { FileShareDto, GetAllShares200Response, KommerzPageable, PublicShareDto, PublicShareListingDto } from '../models/index';
+import { type FileShareDto } from '../models/FileShareDto';
+import { type GetAllShares200Response } from '../models/GetAllShares200Response';
+import { type KommerzPageable } from '../models/KommerzPageable';
+import { type PublicShareDto } from '../models/PublicShareDto';
+import { type PublicShareListingDto } from '../models/PublicShareListingDto';
 export interface AddShareRequest {
+    /**
+     *
+     */
     fileShareDto: Omit<FileShareDto, 'key'>;
 }
 export interface DeleteShareRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface DownloadShareRequest {
+    /**
+     *
+     */
     key: string;
+    /**
+     *
+     */
     accessToken: string;
+    /**
+     * timestamp in seconds when the token expires
+     */
     expires: number;
 }
 export interface DownloadShareFileRequest {
+    /**
+     *
+     */
     key: string;
+    /**
+     *
+     */
     fileId: string;
+    /**
+     *
+     */
     accessToken: string;
+    /**
+     * timestamp in seconds when the token expires
+     */
     expires: number;
 }
 export interface GetAllSharesRequest {
+    /**
+     * Pageable query parameters
+     */
     pageable: KommerzPageable;
+    /**
+     * Filter query parameters. Operators: sim, nsim, eq, neq, leq, less, geq, gtr). Values have to be url-encoded.
+     */
     filter?: Array<string>;
 }
 export interface GetDownloadShareInfoRequest {
+    /**
+     *
+     */
     key: string;
 }
 export interface GetDownloadShareListingRequest {
+    /**
+     *
+     */
     key: string;
+    /**
+     *
+     */
     password?: string;
 }
 export interface GetShareRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface ResetShareCountersRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface UpdateShareRequest {
+    /**
+     * id of entity
+     */
     id: string;
+    /**
+     *
+     */
     fileShareDto: Omit<FileShareDto, 'key'>;
+    /**
+     * whether to force update the entity
+     */
     force?: boolean;
 }
 /**
  *
  */
 export declare class FileDirectorySharesApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for addShare without sending the request
+     */
+    addShareRequestOpts(requestParameters: AddShareRequest): Promise<runtime.RequestOpts>;
     /**
      * add a share
      */
@@ -61,6 +126,10 @@ export declare class FileDirectorySharesApi extends runtime.BaseAPI {
      * add a share
      */
     addShare(requestParameters: AddShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileShareDto>;
+    /**
+     * Creates request options for deleteShare without sending the request
+     */
+    deleteShareRequestOpts(requestParameters: DeleteShareRequest): Promise<runtime.RequestOpts>;
     /**
      * delete a single share
      */
@@ -69,22 +138,34 @@ export declare class FileDirectorySharesApi extends runtime.BaseAPI {
      * delete a single share
      */
     deleteShare(requestParameters: DeleteShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for downloadShare without sending the request
+     */
+    downloadShareRequestOpts(requestParameters: DownloadShareRequest): Promise<runtime.RequestOpts>;
     /**
      * download a share
      */
-    downloadShareRaw(requestParameters: DownloadShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    downloadShareRaw(requestParameters: DownloadShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<runtime.HttpFile>>;
     /**
      * download a share
      */
-    downloadShare(requestParameters: DownloadShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    downloadShare(requestParameters: DownloadShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.HttpFile>;
+    /**
+     * Creates request options for downloadShareFile without sending the request
+     */
+    downloadShareFileRequestOpts(requestParameters: DownloadShareFileRequest): Promise<runtime.RequestOpts>;
     /**
      * download a single file
      */
-    downloadShareFileRaw(requestParameters: DownloadShareFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    downloadShareFileRaw(requestParameters: DownloadShareFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<runtime.HttpFile>>;
     /**
      * download a single file
      */
-    downloadShareFile(requestParameters: DownloadShareFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    downloadShareFile(requestParameters: DownloadShareFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.HttpFile>;
+    /**
+     * Creates request options for getAllShares without sending the request
+     */
+    getAllSharesRequestOpts(requestParameters: GetAllSharesRequest): Promise<runtime.RequestOpts>;
     /**
      * get all directory shares
      */
@@ -93,6 +174,10 @@ export declare class FileDirectorySharesApi extends runtime.BaseAPI {
      * get all directory shares
      */
     getAllShares(requestParameters: GetAllSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllShares200Response>;
+    /**
+     * Creates request options for getDownloadShareInfo without sending the request
+     */
+    getDownloadShareInfoRequestOpts(requestParameters: GetDownloadShareInfoRequest): Promise<runtime.RequestOpts>;
     /**
      * get download share info
      */
@@ -101,6 +186,10 @@ export declare class FileDirectorySharesApi extends runtime.BaseAPI {
      * get download share info
      */
     getDownloadShareInfo(requestParameters: GetDownloadShareInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PublicShareDto>;
+    /**
+     * Creates request options for getDownloadShareListing without sending the request
+     */
+    getDownloadShareListingRequestOpts(requestParameters: GetDownloadShareListingRequest): Promise<runtime.RequestOpts>;
     /**
      * get download share file listing
      */
@@ -109,6 +198,10 @@ export declare class FileDirectorySharesApi extends runtime.BaseAPI {
      * get download share file listing
      */
     getDownloadShareListing(requestParameters: GetDownloadShareListingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PublicShareListingDto>;
+    /**
+     * Creates request options for getShare without sending the request
+     */
+    getShareRequestOpts(requestParameters: GetShareRequest): Promise<runtime.RequestOpts>;
     /**
      * read one result
      */
@@ -117,6 +210,10 @@ export declare class FileDirectorySharesApi extends runtime.BaseAPI {
      * read one result
      */
     getShare(requestParameters: GetShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileShareDto>;
+    /**
+     * Creates request options for resetShareCounters without sending the request
+     */
+    resetShareCountersRequestOpts(requestParameters: ResetShareCountersRequest): Promise<runtime.RequestOpts>;
     /**
      * Reset file share counters
      */
@@ -125,6 +222,10 @@ export declare class FileDirectorySharesApi extends runtime.BaseAPI {
      * Reset file share counters
      */
     resetShareCounters(requestParameters: ResetShareCountersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileShareDto>;
+    /**
+     * Creates request options for updateShare without sending the request
+     */
+    updateShareRequestOpts(requestParameters: UpdateShareRequest): Promise<runtime.RequestOpts>;
     /**
      * Update a share
      */