@simplyhomes/sos-sdk
Version:
TypeScript SDK for Simply Homes SoS API v4
83 lines • 5.25 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 { V4RenovationUserRelationsCreateRelRenovationUserBodyDto, V4RenovationUserRelationsCreateRelRenovationUserResponseDto, V4RenovationUserRelationsDeleteRelRenovationUserResponseDto } from '../models/index';
export interface V4RenovationUserRelationsControllerCreateRelRenovationUserV4Request {
v4RenovationUserRelationsCreateRelRenovationUserBodyDto: V4RenovationUserRelationsCreateRelRenovationUserBodyDto;
}
export interface V4RenovationUserRelationsControllerDeleteRelRenovationUserV4Request {
renovationId: number;
userId: string;
}
/**
* RelRenovationUsersAPIV4Api - interface
*
* @export
* @interface RelRenovationUsersAPIV4ApiInterface
*/
export interface RelRenovationUsersAPIV4ApiInterface {
/**
* Create a new relationship between a renovation and a user
* @summary Create a new rel-renovation-user
* @param {V4RenovationUserRelationsCreateRelRenovationUserBodyDto} v4RenovationUserRelationsCreateRelRenovationUserBodyDto
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RelRenovationUsersAPIV4ApiInterface
*/
v4RenovationUserRelationsControllerCreateRelRenovationUserV4Raw(requestParameters: V4RenovationUserRelationsControllerCreateRelRenovationUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationUserRelationsCreateRelRenovationUserResponseDto>>;
/**
* Create a new relationship between a renovation and a user
* Create a new rel-renovation-user
*/
v4RenovationUserRelationsControllerCreateRelRenovationUserV4(requestParameters: V4RenovationUserRelationsControllerCreateRelRenovationUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationUserRelationsCreateRelRenovationUserResponseDto>;
/**
* Remove the relationship between a renovation and a user
* @summary Delete a specific rel-renovation-user by renovationId and userId
* @param {number} renovationId The unique identifier of the renovation
* @param {string} userId The unique identifier of the user
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RelRenovationUsersAPIV4ApiInterface
*/
v4RenovationUserRelationsControllerDeleteRelRenovationUserV4Raw(requestParameters: V4RenovationUserRelationsControllerDeleteRelRenovationUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationUserRelationsDeleteRelRenovationUserResponseDto>>;
/**
* Remove the relationship between a renovation and a user
* Delete a specific rel-renovation-user by renovationId and userId
*/
v4RenovationUserRelationsControllerDeleteRelRenovationUserV4(requestParameters: V4RenovationUserRelationsControllerDeleteRelRenovationUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationUserRelationsDeleteRelRenovationUserResponseDto>;
}
/**
*
*/
export declare class RelRenovationUsersAPIV4Api extends runtime.BaseAPI implements RelRenovationUsersAPIV4ApiInterface {
/**
* Create a new relationship between a renovation and a user
* Create a new rel-renovation-user
*/
v4RenovationUserRelationsControllerCreateRelRenovationUserV4Raw(requestParameters: V4RenovationUserRelationsControllerCreateRelRenovationUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationUserRelationsCreateRelRenovationUserResponseDto>>;
/**
* Create a new relationship between a renovation and a user
* Create a new rel-renovation-user
*/
v4RenovationUserRelationsControllerCreateRelRenovationUserV4(requestParameters: V4RenovationUserRelationsControllerCreateRelRenovationUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationUserRelationsCreateRelRenovationUserResponseDto>;
/**
* Remove the relationship between a renovation and a user
* Delete a specific rel-renovation-user by renovationId and userId
*/
v4RenovationUserRelationsControllerDeleteRelRenovationUserV4Raw(requestParameters: V4RenovationUserRelationsControllerDeleteRelRenovationUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4RenovationUserRelationsDeleteRelRenovationUserResponseDto>>;
/**
* Remove the relationship between a renovation and a user
* Delete a specific rel-renovation-user by renovationId and userId
*/
v4RenovationUserRelationsControllerDeleteRelRenovationUserV4(requestParameters: V4RenovationUserRelationsControllerDeleteRelRenovationUserV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4RenovationUserRelationsDeleteRelRenovationUserResponseDto>;
}
//# sourceMappingURL=RelRenovationUsersAPIV4Api.d.ts.map