@s-corp-biz/biz-entity-api 1.6.0-development.3

package/lib/api/family-api.d.ts

@@ -0,0 +1,247 @@
+/**
+ * biz-entity-api
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { AddFamilyMemberRequest } from '../models';
+import type { FamilyMemberResponse } from '../models';
+import type { JoinFamilyByCompanyRequest } from '../models';
+import type { SharedFamilyInfoResponse } from '../models';
+/**
+ * FamilyApi - axios parameter creator
+ * @export
+ */
+export declare const FamilyApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {string} companyId
+     * @param {JoinFamilyByCompanyRequest} [joinFamilyByCompanyRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyCompanyCompanyIdJoinPost: (companyId: string, joinFamilyByCompanyRequest?: JoinFamilyByCompanyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyFamilyMembersUserIdGet: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} headUserId
+     * @param {string} memberUserIdToRemove
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyMembersHeadUserIdMemberUserIdToRemoveDelete: (headUserId: string, memberUserIdToRemove: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {AddFamilyMemberRequest} [addFamilyMemberRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyMembersPermissionPut: (addFamilyMemberRequest?: AddFamilyMemberRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {AddFamilyMemberRequest} [addFamilyMemberRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyMembersPost: (addFamilyMemberRequest?: AddFamilyMemberRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyMyMembersGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilySharedWithMeGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * FamilyApi - functional programming interface
+ * @export
+ */
+export declare const FamilyApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {string} companyId
+     * @param {JoinFamilyByCompanyRequest} [joinFamilyByCompanyRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyCompanyCompanyIdJoinPost(companyId: string, joinFamilyByCompanyRequest?: JoinFamilyByCompanyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FamilyMemberResponse>>;
+    /**
+     *
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyFamilyMembersUserIdGet(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<FamilyMemberResponse>>>;
+    /**
+     *
+     * @param {string} headUserId
+     * @param {string} memberUserIdToRemove
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyMembersHeadUserIdMemberUserIdToRemoveDelete(headUserId: string, memberUserIdToRemove: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @param {AddFamilyMemberRequest} [addFamilyMemberRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyMembersPermissionPut(addFamilyMemberRequest?: AddFamilyMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FamilyMemberResponse>>;
+    /**
+     *
+     * @param {AddFamilyMemberRequest} [addFamilyMemberRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyMembersPost(addFamilyMemberRequest?: AddFamilyMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FamilyMemberResponse>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyMyMembersGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<FamilyMemberResponse>>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilySharedWithMeGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SharedFamilyInfoResponse>>>;
+};
+/**
+ * FamilyApi - factory interface
+ * @export
+ */
+export declare const FamilyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @param {string} companyId
+     * @param {JoinFamilyByCompanyRequest} [joinFamilyByCompanyRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyCompanyCompanyIdJoinPost(companyId: string, joinFamilyByCompanyRequest?: JoinFamilyByCompanyRequest, options?: RawAxiosRequestConfig): AxiosPromise<FamilyMemberResponse>;
+    /**
+     *
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyFamilyMembersUserIdGet(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<FamilyMemberResponse>>;
+    /**
+     *
+     * @param {string} headUserId
+     * @param {string} memberUserIdToRemove
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyMembersHeadUserIdMemberUserIdToRemoveDelete(headUserId: string, memberUserIdToRemove: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @param {AddFamilyMemberRequest} [addFamilyMemberRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyMembersPermissionPut(addFamilyMemberRequest?: AddFamilyMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<FamilyMemberResponse>;
+    /**
+     *
+     * @param {AddFamilyMemberRequest} [addFamilyMemberRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyMembersPost(addFamilyMemberRequest?: AddFamilyMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<FamilyMemberResponse>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilyMyMembersGet(options?: RawAxiosRequestConfig): AxiosPromise<Array<FamilyMemberResponse>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiFamilySharedWithMeGet(options?: RawAxiosRequestConfig): AxiosPromise<Array<SharedFamilyInfoResponse>>;
+};
+/**
+ * FamilyApi - object-oriented interface
+ * @export
+ * @class FamilyApi
+ * @extends {BaseAPI}
+ */
+export declare class FamilyApi extends BaseAPI {
+    /**
+     *
+     * @param {string} companyId
+     * @param {JoinFamilyByCompanyRequest} [joinFamilyByCompanyRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FamilyApi
+     */
+    apiFamilyCompanyCompanyIdJoinPost(companyId: string, joinFamilyByCompanyRequest?: JoinFamilyByCompanyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FamilyMemberResponse, any, {}>>;
+    /**
+     *
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FamilyApi
+     */
+    apiFamilyFamilyMembersUserIdGet(userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FamilyMemberResponse[], any, {}>>;
+    /**
+     *
+     * @param {string} headUserId
+     * @param {string} memberUserIdToRemove
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FamilyApi
+     */
+    apiFamilyMembersHeadUserIdMemberUserIdToRemoveDelete(headUserId: string, memberUserIdToRemove: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @param {AddFamilyMemberRequest} [addFamilyMemberRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FamilyApi
+     */
+    apiFamilyMembersPermissionPut(addFamilyMemberRequest?: AddFamilyMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FamilyMemberResponse, any, {}>>;
+    /**
+     *
+     * @param {AddFamilyMemberRequest} [addFamilyMemberRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FamilyApi
+     */
+    apiFamilyMembersPost(addFamilyMemberRequest?: AddFamilyMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FamilyMemberResponse, any, {}>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FamilyApi
+     */
+    apiFamilyMyMembersGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FamilyMemberResponse[], any, {}>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FamilyApi
+     */
+    apiFamilySharedWithMeGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SharedFamilyInfoResponse[], any, {}>>;
+}