@kommerz/ts-client 1.184.1 → 1.186.0

package/dist/apis/TenantsApi.d.ts

@@ -9,51 +9,125 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateTenantRequest, FileDto, KommerzPageable, ListAllTenants200Response, TenantDto, TenantInvitationDto } from '../models/index';
+import { type CreateTenantRequest } from '../models/CreateTenantRequest';
+import { type FileDto } from '../models/FileDto';
+import { type KommerzPageable } from '../models/KommerzPageable';
+import { type ListAllTenants200Response } from '../models/ListAllTenants200Response';
+import { type TenantDto } from '../models/TenantDto';
+import { type TenantInvitationDto } from '../models/TenantInvitationDto';
+import { type TenantOwnerAdditionDto } from '../models/TenantOwnerAdditionDto';
 export interface CreateTenantOperationRequest {
+    /**
+     *
+     */
     createTenantRequest: CreateTenantRequest;
 }
 export interface DeleteLogoRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface DownloadLogoRequest {
+    /**
+     * id of entity
+     */
     id: string;
+    /**
+     * type of returned file
+     */
     target: DownloadLogoTargetEnum;
 }
 export interface GetTenantRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface ListAllTenantsRequest {
+    /**
+     * 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 TenantMailInviteRequest {
+    /**
+     * id of entity
+     */
     id: string;
+    /**
+     *
+     */
     tenantInvitationDto: TenantInvitationDto;
 }
 export interface TenantRequestDeleteRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
+export interface TenantRequestOwnerAdditionRequest {
+    /**
+     * id of entity
+     */
+    id: string;
+    /**
+     *
+     */
+    tenantOwnerAdditionDto: TenantOwnerAdditionDto;
+}
 export interface UpdateHandleRequest {
+    /**
+     * id of entity
+     */
     id: string;
+    /**
+     *
+     */
     body: string;
 }
 export interface UpdateLogoRequest {
+    /**
+     * id of entity
+     */
     id: string;
+    /**
+     *
+     */
     file?: Blob;
 }
 export interface UpdateTenantRequest {
+    /**
+     * id of entity
+     */
     id: string;
+    /**
+     *
+     */
     tenantDto: Omit<TenantDto, 'logo' | 'shortId'>;
 }
 export interface UploadLogoRequest {
+    /**
+     * id of entity
+     */
     id: string;
+    /**
+     *
+     */
     file?: Blob;
 }
 /**
  *
  */
 export declare class TenantsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createTenant without sending the request
+     */
+    createTenantRequestOpts(requestParameters: CreateTenantOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Create a new tenant
      */
@@ -62,6 +136,10 @@ export declare class TenantsApi extends runtime.BaseAPI {
      * Create a new tenant
      */
     createTenant(requestParameters: CreateTenantOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantDto>;
+    /**
+     * Creates request options for deleteLogo without sending the request
+     */
+    deleteLogoRequestOpts(requestParameters: DeleteLogoRequest): Promise<runtime.RequestOpts>;
     /**
      * delete tenant logo
      */
@@ -70,14 +148,22 @@ export declare class TenantsApi extends runtime.BaseAPI {
      * delete tenant logo
      */
     deleteLogo(requestParameters: DeleteLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for downloadLogo without sending the request
+     */
+    downloadLogoRequestOpts(requestParameters: DownloadLogoRequest): Promise<runtime.RequestOpts>;
     /**
      * download the tenant logo
      */
-    downloadLogoRaw(requestParameters: DownloadLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    downloadLogoRaw(requestParameters: DownloadLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<runtime.HttpFile>>;
     /**
      * download the tenant logo
      */
-    downloadLogo(requestParameters: DownloadLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    downloadLogo(requestParameters: DownloadLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.HttpFile>;
+    /**
+     * Creates request options for getTenant without sending the request
+     */
+    getTenantRequestOpts(requestParameters: GetTenantRequest): Promise<runtime.RequestOpts>;
     /**
      * get tenant by id
      */
@@ -86,6 +172,10 @@ export declare class TenantsApi extends runtime.BaseAPI {
      * get tenant by id
      */
     getTenant(requestParameters: GetTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantDto>;
+    /**
+     * Creates request options for listAllTenants without sending the request
+     */
+    listAllTenantsRequestOpts(requestParameters: ListAllTenantsRequest): Promise<runtime.RequestOpts>;
     /**
      * list tenants
      */
@@ -94,6 +184,10 @@ export declare class TenantsApi extends runtime.BaseAPI {
      * list tenants
      */
     listAllTenants(requestParameters: ListAllTenantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAllTenants200Response>;
+    /**
+     * Creates request options for tenantMailInvite without sending the request
+     */
+    tenantMailInviteRequestOpts(requestParameters: TenantMailInviteRequest): Promise<runtime.RequestOpts>;
     /**
      * invite to tenant with e-mail
      */
@@ -102,6 +196,10 @@ export declare class TenantsApi extends runtime.BaseAPI {
      * invite to tenant with e-mail
      */
     tenantMailInvite(requestParameters: TenantMailInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for tenantRequestDelete without sending the request
+     */
+    tenantRequestDeleteRequestOpts(requestParameters: TenantRequestDeleteRequest): Promise<runtime.RequestOpts>;
     /**
      * request tenant deletion
      */
@@ -110,6 +208,24 @@ export declare class TenantsApi extends runtime.BaseAPI {
      * request tenant deletion
      */
     tenantRequestDelete(requestParameters: TenantRequestDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for tenantRequestOwnerAddition without sending the request
+     */
+    tenantRequestOwnerAdditionRequestOpts(requestParameters: TenantRequestOwnerAdditionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Sends an e-mail to the requesting owner. The new owner is added once the requesting owner approves it via /ui/tenants-owner-addition/v1/approval. The existing owners stay owners.
+     * request adding a tenant owner
+     */
+    tenantRequestOwnerAdditionRaw(requestParameters: TenantRequestOwnerAdditionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Sends an e-mail to the requesting owner. The new owner is added once the requesting owner approves it via /ui/tenants-owner-addition/v1/approval. The existing owners stay owners.
+     * request adding a tenant owner
+     */
+    tenantRequestOwnerAddition(requestParameters: TenantRequestOwnerAdditionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for updateHandle without sending the request
+     */
+    updateHandleRequestOpts(requestParameters: UpdateHandleRequest): Promise<runtime.RequestOpts>;
     /**
      * update a tenant handle
      */
@@ -118,6 +234,10 @@ export declare class TenantsApi extends runtime.BaseAPI {
      * update a tenant handle
      */
     updateHandle(requestParameters: UpdateHandleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantDto>;
+    /**
+     * Creates request options for updateLogo without sending the request
+     */
+    updateLogoRequestOpts(requestParameters: UpdateLogoRequest): Promise<runtime.RequestOpts>;
     /**
      * update a tenant logo
      */
@@ -126,6 +246,10 @@ export declare class TenantsApi extends runtime.BaseAPI {
      * update a tenant logo
      */
     updateLogo(requestParameters: UpdateLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileDto>;
+    /**
+     * Creates request options for updateTenant without sending the request
+     */
+    updateTenantRequestOpts(requestParameters: UpdateTenantRequest): Promise<runtime.RequestOpts>;
     /**
      * Update tenant by id
      */
@@ -134,6 +258,10 @@ export declare class TenantsApi extends runtime.BaseAPI {
      * Update tenant by id
      */
     updateTenant(requestParameters: UpdateTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantDto>;
+    /**
+     * Creates request options for uploadLogo without sending the request
+     */
+    uploadLogoRequestOpts(requestParameters: UploadLogoRequest): Promise<runtime.RequestOpts>;
     /**
      * upload a tenant logo
      */