@simplyhomes/sos-sdk
Version:
TypeScript SDK for Simply Homes SoS API v4
83 lines • 4.96 kB
TypeScript
/**
* API v4
* Swagger documentation for API v4
*
* The version of the OpenAPI document: 4.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 * as runtime from '../runtime';
import type { V4LeasingUserRelationsCreateRelLeasingUserBodyDto, V4LeasingUserRelationsCreateRelLeasingUserResponseDto, V4LeasingUserRelationsDeleteRelLeasingUserResponseDto } from '../models/index';
export interface V4LeasingUserRelationsControllerCreateRelLeasingUserV4Request {
v4LeasingUserRelationsCreateRelLeasingUserBodyDto: V4LeasingUserRelationsCreateRelLeasingUserBodyDto;
}
export interface V4LeasingUserRelationsControllerDeleteRelLeasingUserV4Request {
leasingId: number;
userId: string;
}
/**
* RelLeasingUsersAPIV4Api - interface
*
* @export
* @interface RelLeasingUsersAPIV4ApiInterface
*/
export interface RelLeasingUsersAPIV4ApiInterface {
/**
* Create a new relationship between a leasing and a user
* @summary Create a new rel-leasing-user
* @param {V4LeasingUserRelationsCreateRelLeasingUserBodyDto} v4LeasingUserRelationsCreateRelLeasingUserBodyDto
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RelLeasingUsersAPIV4ApiInterface
*/
v4LeasingUserRelationsControllerCreateRelLeasingUserV4Raw(requestParameters: V4LeasingUserRelationsControllerCreateRelLeasingUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeasingUserRelationsCreateRelLeasingUserResponseDto>>;
/**
* Create a new relationship between a leasing and a user
* Create a new rel-leasing-user
*/
v4LeasingUserRelationsControllerCreateRelLeasingUserV4(requestParameters: V4LeasingUserRelationsControllerCreateRelLeasingUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeasingUserRelationsCreateRelLeasingUserResponseDto>;
/**
* Remove the relationship between a leasing and a user
* @summary Delete a specific rel-leasing-user by leasingId and userId
* @param {number} leasingId The unique identifier of the leasing
* @param {string} userId The unique identifier of the user
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RelLeasingUsersAPIV4ApiInterface
*/
v4LeasingUserRelationsControllerDeleteRelLeasingUserV4Raw(requestParameters: V4LeasingUserRelationsControllerDeleteRelLeasingUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeasingUserRelationsDeleteRelLeasingUserResponseDto>>;
/**
* Remove the relationship between a leasing and a user
* Delete a specific rel-leasing-user by leasingId and userId
*/
v4LeasingUserRelationsControllerDeleteRelLeasingUserV4(requestParameters: V4LeasingUserRelationsControllerDeleteRelLeasingUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeasingUserRelationsDeleteRelLeasingUserResponseDto>;
}
/**
*
*/
export declare class RelLeasingUsersAPIV4Api extends runtime.BaseAPI implements RelLeasingUsersAPIV4ApiInterface {
/**
* Create a new relationship between a leasing and a user
* Create a new rel-leasing-user
*/
v4LeasingUserRelationsControllerCreateRelLeasingUserV4Raw(requestParameters: V4LeasingUserRelationsControllerCreateRelLeasingUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeasingUserRelationsCreateRelLeasingUserResponseDto>>;
/**
* Create a new relationship between a leasing and a user
* Create a new rel-leasing-user
*/
v4LeasingUserRelationsControllerCreateRelLeasingUserV4(requestParameters: V4LeasingUserRelationsControllerCreateRelLeasingUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeasingUserRelationsCreateRelLeasingUserResponseDto>;
/**
* Remove the relationship between a leasing and a user
* Delete a specific rel-leasing-user by leasingId and userId
*/
v4LeasingUserRelationsControllerDeleteRelLeasingUserV4Raw(requestParameters: V4LeasingUserRelationsControllerDeleteRelLeasingUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4LeasingUserRelationsDeleteRelLeasingUserResponseDto>>;
/**
* Remove the relationship between a leasing and a user
* Delete a specific rel-leasing-user by leasingId and userId
*/
v4LeasingUserRelationsControllerDeleteRelLeasingUserV4(requestParameters: V4LeasingUserRelationsControllerDeleteRelLeasingUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4LeasingUserRelationsDeleteRelLeasingUserResponseDto>;
}
//# sourceMappingURL=RelLeasingUsersAPIV4Api.d.ts.map