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

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

@@ -0,0 +1,430 @@
+/**
+ * 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 { AcceptInvitationRequest } from '../models';
+import type { AddExistingMemberRequest } from '../models';
+import type { AddPersonRequest } from '../models';
+import type { CompanyOwnershipTransferRequest } from '../models';
+import type { InvitationMetadataResponse } from '../models';
+import type { PeopleResponse } from '../models';
+import type { ResendInvitationRequest } from '../models';
+import type { SendInvitationRequest } from '../models';
+import type { TestEmailRequest } from '../models';
+import type { UpdatePersonRequest } from '../models';
+/**
+ * PeopleApi - axios parameter creator
+ * @export
+ */
+export declare const PeopleApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {AcceptInvitationRequest} [acceptInvitationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleAcceptInvitationPost: (acceptInvitationRequest?: AcceptInvitationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {AddExistingMemberRequest} [addExistingMemberRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdAddExistingMembersPost: (companyId: string, addExistingMemberRequest?: AddExistingMemberRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdGet: (companyId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {SendInvitationRequest} [sendInvitationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdInvitePost: (companyId: string, sendInvitationRequest?: SendInvitationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdOtherCompanyMembersGet: (companyId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {CompanyOwnershipTransferRequest} [companyOwnershipTransferRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdOwnershipTransferPost: (companyId: string, companyOwnershipTransferRequest?: CompanyOwnershipTransferRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {string} personId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdPersonPersonIdDelete: (companyId: string, personId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {string} personId
+     * @param {UpdatePersonRequest} [updatePersonRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdPersonPersonIdPut: (companyId: string, personId: string, updatePersonRequest?: UpdatePersonRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {AddPersonRequest} [addPersonRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdPost: (companyId: string, addPersonRequest?: AddPersonRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {ResendInvitationRequest} [resendInvitationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdResendInvitePost: (companyId: string, resendInvitationRequest?: ResendInvitationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleInvitationMetadataTokenGet: (token: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {TestEmailRequest} [testEmailRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleTestEmailPost: (testEmailRequest?: TestEmailRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PeopleApi - functional programming interface
+ * @export
+ */
+export declare const PeopleApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {AcceptInvitationRequest} [acceptInvitationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleAcceptInvitationPost(acceptInvitationRequest?: AcceptInvitationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {AddExistingMemberRequest} [addExistingMemberRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdAddExistingMembersPost(companyId: string, addExistingMemberRequest?: AddExistingMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdGet(companyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PeopleResponse>>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {SendInvitationRequest} [sendInvitationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdInvitePost(companyId: string, sendInvitationRequest?: SendInvitationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PeopleResponse>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdOtherCompanyMembersGet(companyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PeopleResponse>>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {CompanyOwnershipTransferRequest} [companyOwnershipTransferRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdOwnershipTransferPost(companyId: string, companyOwnershipTransferRequest?: CompanyOwnershipTransferRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {string} personId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdPersonPersonIdDelete(companyId: string, personId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {string} personId
+     * @param {UpdatePersonRequest} [updatePersonRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdPersonPersonIdPut(companyId: string, personId: string, updatePersonRequest?: UpdatePersonRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PeopleResponse>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {AddPersonRequest} [addPersonRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdPost(companyId: string, addPersonRequest?: AddPersonRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PeopleResponse>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {ResendInvitationRequest} [resendInvitationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdResendInvitePost(companyId: string, resendInvitationRequest?: ResendInvitationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PeopleResponse>>;
+    /**
+     *
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleInvitationMetadataTokenGet(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvitationMetadataResponse>>;
+    /**
+     *
+     * @param {TestEmailRequest} [testEmailRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleTestEmailPost(testEmailRequest?: TestEmailRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * PeopleApi - factory interface
+ * @export
+ */
+export declare const PeopleApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @param {AcceptInvitationRequest} [acceptInvitationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleAcceptInvitationPost(acceptInvitationRequest?: AcceptInvitationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {AddExistingMemberRequest} [addExistingMemberRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdAddExistingMembersPost(companyId: string, addExistingMemberRequest?: AddExistingMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdGet(companyId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<PeopleResponse>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {SendInvitationRequest} [sendInvitationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdInvitePost(companyId: string, sendInvitationRequest?: SendInvitationRequest, options?: RawAxiosRequestConfig): AxiosPromise<PeopleResponse>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdOtherCompanyMembersGet(companyId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<PeopleResponse>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {CompanyOwnershipTransferRequest} [companyOwnershipTransferRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdOwnershipTransferPost(companyId: string, companyOwnershipTransferRequest?: CompanyOwnershipTransferRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {string} personId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdPersonPersonIdDelete(companyId: string, personId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {string} personId
+     * @param {UpdatePersonRequest} [updatePersonRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdPersonPersonIdPut(companyId: string, personId: string, updatePersonRequest?: UpdatePersonRequest, options?: RawAxiosRequestConfig): AxiosPromise<PeopleResponse>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {AddPersonRequest} [addPersonRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdPost(companyId: string, addPersonRequest?: AddPersonRequest, options?: RawAxiosRequestConfig): AxiosPromise<PeopleResponse>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {ResendInvitationRequest} [resendInvitationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleCompanyCompanyIdResendInvitePost(companyId: string, resendInvitationRequest?: ResendInvitationRequest, options?: RawAxiosRequestConfig): AxiosPromise<PeopleResponse>;
+    /**
+     *
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleInvitationMetadataTokenGet(token: string, options?: RawAxiosRequestConfig): AxiosPromise<InvitationMetadataResponse>;
+    /**
+     *
+     * @param {TestEmailRequest} [testEmailRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiPeopleTestEmailPost(testEmailRequest?: TestEmailRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * PeopleApi - object-oriented interface
+ * @export
+ * @class PeopleApi
+ * @extends {BaseAPI}
+ */
+export declare class PeopleApi extends BaseAPI {
+    /**
+     *
+     * @param {AcceptInvitationRequest} [acceptInvitationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PeopleApi
+     */
+    apiPeopleAcceptInvitationPost(acceptInvitationRequest?: AcceptInvitationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {AddExistingMemberRequest} [addExistingMemberRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PeopleApi
+     */
+    apiPeopleCompanyCompanyIdAddExistingMembersPost(companyId: string, addExistingMemberRequest?: AddExistingMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PeopleApi
+     */
+    apiPeopleCompanyCompanyIdGet(companyId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PeopleResponse[], any, {}>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {SendInvitationRequest} [sendInvitationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PeopleApi
+     */
+    apiPeopleCompanyCompanyIdInvitePost(companyId: string, sendInvitationRequest?: SendInvitationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PeopleResponse, any, {}>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PeopleApi
+     */
+    apiPeopleCompanyCompanyIdOtherCompanyMembersGet(companyId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PeopleResponse[], any, {}>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {CompanyOwnershipTransferRequest} [companyOwnershipTransferRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PeopleApi
+     */
+    apiPeopleCompanyCompanyIdOwnershipTransferPost(companyId: string, companyOwnershipTransferRequest?: CompanyOwnershipTransferRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {string} personId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PeopleApi
+     */
+    apiPeopleCompanyCompanyIdPersonPersonIdDelete(companyId: string, personId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {string} personId
+     * @param {UpdatePersonRequest} [updatePersonRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PeopleApi
+     */
+    apiPeopleCompanyCompanyIdPersonPersonIdPut(companyId: string, personId: string, updatePersonRequest?: UpdatePersonRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PeopleResponse, any, {}>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {AddPersonRequest} [addPersonRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PeopleApi
+     */
+    apiPeopleCompanyCompanyIdPost(companyId: string, addPersonRequest?: AddPersonRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PeopleResponse, any, {}>>;
+    /**
+     *
+     * @param {string} companyId
+     * @param {ResendInvitationRequest} [resendInvitationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PeopleApi
+     */
+    apiPeopleCompanyCompanyIdResendInvitePost(companyId: string, resendInvitationRequest?: ResendInvitationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PeopleResponse, any, {}>>;
+    /**
+     *
+     * @param {string} token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PeopleApi
+     */
+    apiPeopleInvitationMetadataTokenGet(token: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvitationMetadataResponse, any, {}>>;
+    /**
+     *
+     * @param {TestEmailRequest} [testEmailRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PeopleApi
+     */
+    apiPeopleTestEmailPost(testEmailRequest?: TestEmailRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+}