@rasadov/lumoar-sdk 1.0.5 → 1.0.7

package/dist/api.d.ts

@@ -43,53 +43,53 @@ export type AuditLogEntity = typeof AuditLogEntity[keyof typeof AuditLogEntity];
 /**
  *
  * @export
- * @interface AuditLogResponse
+ * @interface AuditLogSchema
  */
-export interface AuditLogResponse {
+export interface AuditLogSchema {
     /**
      *
      * @type {string}
-     * @memberof AuditLogResponse
+     * @memberof AuditLogSchema
      */
     'company_id': string;
     /**
      *
      * @type {AuditLogAction}
-     * @memberof AuditLogResponse
+     * @memberof AuditLogSchema
      */
     'action': AuditLogAction;
     /**
      *
      * @type {AuditLogEntity}
-     * @memberof AuditLogResponse
+     * @memberof AuditLogSchema
      */
     'entity_type': AuditLogEntity;
     /**
      *
      * @type {string}
-     * @memberof AuditLogResponse
+     * @memberof AuditLogSchema
      */
     'entity_id': string;
     /**
      *
      * @type {string}
-     * @memberof AuditLogResponse
-     */
-    'entity_name': string;
-    /**
-     *
-     * @type {string}
-     * @memberof AuditLogResponse
+     * @memberof AuditLogSchema
      */
     'timestamp': string;
     /**
      *
      * @type {{ [key: string]: any; }}
-     * @memberof AuditLogResponse
+     * @memberof AuditLogSchema
      */
     'details': {
         [key: string]: any;
     } | null;
+    /**
+     *
+     * @type {UserBase}
+     * @memberof AuditLogSchema
+     */
+    'user': UserBase;
 }
 /**
  * Authentication success response schema. Attributes:     - access_token: str     - token_type: str     - user_id: str     - role: str
@@ -624,6 +624,37 @@ export declare const ComplianceGoal: {
     readonly Soc2: "SOC2";
 };
 export type ComplianceGoal = typeof ComplianceGoal[keyof typeof ComplianceGoal];
+/**
+ *
+ * @export
+ * @interface ControlBase
+ */
+export interface ControlBase {
+    /**
+     *
+     * @type {string}
+     * @memberof ControlBase
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ControlBase
+     */
+    'status'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ControlBase
+     */
+    'note'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ControlBase
+     */
+    'updated_at'?: string | null;
+}
 /**
  *
  * @export
@@ -650,12 +681,6 @@ export interface ControlWithEvidences {
      * @memberof ControlWithEvidences
      */
     'id': string;
-    /**
-     *
-     * @type {FrameworkControlsBase}
-     * @memberof ControlWithEvidences
-     */
-    'framework_control': FrameworkControlsBase;
     /**
      *
      * @type {string}
@@ -674,6 +699,12 @@ export interface ControlWithEvidences {
      * @memberof ControlWithEvidences
      */
     'updated_at'?: string | null;
+    /**
+     *
+     * @type {FrameworkControlsBase}
+     * @memberof ControlWithEvidences
+     */
+    'data': FrameworkControlsBase;
     /**
      *
      * @type {Array<EvidenceBase>}
@@ -693,12 +724,6 @@ export interface ControlWithRelationships {
      * @memberof ControlWithRelationships
      */
     'id': string;
-    /**
-     *
-     * @type {FrameworkControlsBase}
-     * @memberof ControlWithRelationships
-     */
-    'framework_control': FrameworkControlsBase;
     /**
      *
      * @type {string}
@@ -717,6 +742,12 @@ export interface ControlWithRelationships {
      * @memberof ControlWithRelationships
      */
     'updated_at'?: string | null;
+    /**
+     *
+     * @type {FrameworkControlsBase}
+     * @memberof ControlWithRelationships
+     */
+    'data': FrameworkControlsBase;
     /**
      *
      * @type {CompanyInDBBase}
@@ -1061,6 +1092,63 @@ export interface LoginSchema {
      */
     'turnstile_token': string;
 }
+/**
+ *
+ * @export
+ * @interface PaginationResponseAuditLogSchema
+ */
+export interface PaginationResponseAuditLogSchema {
+    /**
+     *
+     * @type {Array<AuditLogSchema>}
+     * @memberof PaginationResponseAuditLogSchema
+     */
+    'items': Array<AuditLogSchema>;
+    /**
+     *
+     * @type {number}
+     * @memberof PaginationResponseAuditLogSchema
+     */
+    'total': number;
+}
+/**
+ *
+ * @export
+ * @interface PaginationResponseCompanyInDBBase
+ */
+export interface PaginationResponseCompanyInDBBase {
+    /**
+     *
+     * @type {Array<CompanyInDBBase>}
+     * @memberof PaginationResponseCompanyInDBBase
+     */
+    'items': Array<CompanyInDBBase>;
+    /**
+     *
+     * @type {number}
+     * @memberof PaginationResponseCompanyInDBBase
+     */
+    'total': number;
+}
+/**
+ *
+ * @export
+ * @interface PaginationResponsePolicyRead
+ */
+export interface PaginationResponsePolicyRead {
+    /**
+     *
+     * @type {Array<PolicyRead>}
+     * @memberof PaginationResponsePolicyRead
+     */
+    'items': Array<PolicyRead>;
+    /**
+     *
+     * @type {number}
+     * @memberof PaginationResponsePolicyRead
+     */
+    'total': number;
+}
 /**
  *
  * @export
@@ -1301,7 +1389,7 @@ export interface UpdateControlSchema {
      * @type {ControlStatus}
      * @memberof UpdateControlSchema
      */
-    'status'?: ControlStatus | null;
+    'status': ControlStatus;
     /**
      *
      * @type {string}
@@ -1531,8 +1619,8 @@ export declare const AuditLogsApiAxiosParamCreator: (configuration?: Configurati
      *
      * @summary List Audit Logs
      * @param {string} companyId
-     * @param {number} page
-     * @param {number} elements
+     * @param {number} [page]
+     * @param {number} [elements]
      * @param {AuditLogEntity | null} [entityType]
      * @param {AuditLogAction | null} [action]
      * @param {string | null} [startDate]
@@ -1542,7 +1630,7 @@ export declare const AuditLogsApiAxiosParamCreator: (configuration?: Configurati
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listAuditLogsV1AuditLogsListGet: (companyId: string, page: number, elements: number, entityType?: AuditLogEntity | null, action?: AuditLogAction | null, startDate?: string | null, endDate?: string | null, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    listAuditLogsV1AuditLogsListGet: (companyId: string, page?: number, elements?: number, entityType?: AuditLogEntity | null, action?: AuditLogAction | null, startDate?: string | null, endDate?: string | null, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * AuditLogsApi - functional programming interface
@@ -1553,8 +1641,8 @@ export declare const AuditLogsApiFp: (configuration?: Configuration) => {
      *
      * @summary List Audit Logs
      * @param {string} companyId
-     * @param {number} page
-     * @param {number} elements
+     * @param {number} [page]
+     * @param {number} [elements]
      * @param {AuditLogEntity | null} [entityType]
      * @param {AuditLogAction | null} [action]
      * @param {string | null} [startDate]
@@ -1564,7 +1652,7 @@ export declare const AuditLogsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listAuditLogsV1AuditLogsListGet(companyId: string, page: number, elements: number, entityType?: AuditLogEntity | null, action?: AuditLogAction | null, startDate?: string | null, endDate?: string | null, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AuditLogResponse>>>;
+    listAuditLogsV1AuditLogsListGet(companyId: string, page?: number, elements?: number, entityType?: AuditLogEntity | null, action?: AuditLogAction | null, startDate?: string | null, endDate?: string | null, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseAuditLogSchema>>;
 };
 /**
  * AuditLogsApi - factory interface
@@ -1575,8 +1663,8 @@ export declare const AuditLogsApiFactory: (configuration?: Configuration, basePa
      *
      * @summary List Audit Logs
      * @param {string} companyId
-     * @param {number} page
-     * @param {number} elements
+     * @param {number} [page]
+     * @param {number} [elements]
      * @param {AuditLogEntity | null} [entityType]
      * @param {AuditLogAction | null} [action]
      * @param {string | null} [startDate]
@@ -1586,7 +1674,7 @@ export declare const AuditLogsApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listAuditLogsV1AuditLogsListGet(companyId: string, page: number, elements: number, entityType?: AuditLogEntity | null, action?: AuditLogAction | null, startDate?: string | null, endDate?: string | null, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<AuditLogResponse>>;
+    listAuditLogsV1AuditLogsListGet(companyId: string, page?: number, elements?: number, entityType?: AuditLogEntity | null, action?: AuditLogAction | null, startDate?: string | null, endDate?: string | null, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseAuditLogSchema>;
 };
 /**
  * AuditLogsApi - object-oriented interface
@@ -1599,8 +1687,8 @@ export declare class AuditLogsApi extends BaseAPI {
      *
      * @summary List Audit Logs
      * @param {string} companyId
-     * @param {number} page
-     * @param {number} elements
+     * @param {number} [page]
+     * @param {number} [elements]
      * @param {AuditLogEntity | null} [entityType]
      * @param {AuditLogAction | null} [action]
      * @param {string | null} [startDate]
@@ -1611,7 +1699,7 @@ export declare class AuditLogsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof AuditLogsApi
      */
-    listAuditLogsV1AuditLogsListGet(companyId: string, page: number, elements: number, entityType?: AuditLogEntity | null, action?: AuditLogAction | null, startDate?: string | null, endDate?: string | null, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuditLogResponse[], any, {}>>;
+    listAuditLogsV1AuditLogsListGet(companyId: string, page?: number, elements?: number, entityType?: AuditLogEntity | null, action?: AuditLogAction | null, startDate?: string | null, endDate?: string | null, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponseAuditLogSchema, any, {}>>;
 }
 /**
  * AuthApi - axios parameter creator
@@ -2057,25 +2145,14 @@ export declare const CompanyApiAxiosParamCreator: (configuration?: Configuration
     getCompanyV1CompanyGetCompanyIdGet: (companyId: string, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
-     * @summary Get Controls
+     * @summary Get Company With Controls
      * @param {string} companyId
      * @param {string} [authorization]
      * @param {string} [sessionId]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getControlsV1CompanyControlsCompanyIdGet: (companyId: string, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Get Policies
-     * @param {number} [page]
-     * @param {number} [elements]
-     * @param {string} [authorization]
-     * @param {string} [sessionId]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPoliciesV1CompanyPoliciesGet: (page?: number, elements?: number, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getCompanyWithControlsV1CompanyControlsCompanyIdGet: (companyId: string, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Update Company
@@ -2112,7 +2189,7 @@ export declare const CompanyApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getCompaniesV1CompanyListGet(page?: number, elements?: number, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CompanyInDBBase>>>;
+    getCompaniesV1CompanyListGet(page?: number, elements?: number, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseCompanyInDBBase>>;
     /**
      *
      * @summary Get Company
@@ -2125,25 +2202,14 @@ export declare const CompanyApiFp: (configuration?: Configuration) => {
     getCompanyV1CompanyGetCompanyIdGet(companyId: string, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompanyWithRoles>>;
     /**
      *
-     * @summary Get Controls
+     * @summary Get Company With Controls
      * @param {string} companyId
      * @param {string} [authorization]
      * @param {string} [sessionId]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getControlsV1CompanyControlsCompanyIdGet(companyId: string, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompanyWithControls>>;
-    /**
-     *
-     * @summary Get Policies
-     * @param {number} [page]
-     * @param {number} [elements]
-     * @param {string} [authorization]
-     * @param {string} [sessionId]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPoliciesV1CompanyPoliciesGet(page?: number, elements?: number, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PolicyRead>>>;
+    getCompanyWithControlsV1CompanyControlsCompanyIdGet(companyId: string, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompanyWithControls>>;
     /**
      *
      * @summary Update Company
@@ -2180,7 +2246,7 @@ export declare const CompanyApiFactory: (configuration?: Configuration, basePath
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getCompaniesV1CompanyListGet(page?: number, elements?: number, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CompanyInDBBase>>;
+    getCompaniesV1CompanyListGet(page?: number, elements?: number, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseCompanyInDBBase>;
     /**
      *
      * @summary Get Company
@@ -2193,25 +2259,14 @@ export declare const CompanyApiFactory: (configuration?: Configuration, basePath
     getCompanyV1CompanyGetCompanyIdGet(companyId: string, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<CompanyWithRoles>;
     /**
      *
-     * @summary Get Controls
+     * @summary Get Company With Controls
      * @param {string} companyId
      * @param {string} [authorization]
      * @param {string} [sessionId]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getControlsV1CompanyControlsCompanyIdGet(companyId: string, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<CompanyWithControls>;
-    /**
-     *
-     * @summary Get Policies
-     * @param {number} [page]
-     * @param {number} [elements]
-     * @param {string} [authorization]
-     * @param {string} [sessionId]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPoliciesV1CompanyPoliciesGet(page?: number, elements?: number, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<PolicyRead>>;
+    getCompanyWithControlsV1CompanyControlsCompanyIdGet(companyId: string, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<CompanyWithControls>;
     /**
      *
      * @summary Update Company
@@ -2252,7 +2307,7 @@ export declare class CompanyApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof CompanyApi
      */
-    getCompaniesV1CompanyListGet(page?: number, elements?: number, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CompanyInDBBase[], any, {}>>;
+    getCompaniesV1CompanyListGet(page?: number, elements?: number, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponseCompanyInDBBase, any, {}>>;
     /**
      *
      * @summary Get Company
@@ -2266,7 +2321,7 @@ export declare class CompanyApi extends BaseAPI {
     getCompanyV1CompanyGetCompanyIdGet(companyId: string, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CompanyWithRoles, any, {}>>;
     /**
      *
-     * @summary Get Controls
+     * @summary Get Company With Controls
      * @param {string} companyId
      * @param {string} [authorization]
      * @param {string} [sessionId]
@@ -2274,19 +2329,7 @@ export declare class CompanyApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof CompanyApi
      */
-    getControlsV1CompanyControlsCompanyIdGet(companyId: string, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CompanyWithControls, any, {}>>;
-    /**
-     *
-     * @summary Get Policies
-     * @param {number} [page]
-     * @param {number} [elements]
-     * @param {string} [authorization]
-     * @param {string} [sessionId]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof CompanyApi
-     */
-    getPoliciesV1CompanyPoliciesGet(page?: number, elements?: number, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PolicyRead[], any, {}>>;
+    getCompanyWithControlsV1CompanyControlsCompanyIdGet(companyId: string, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CompanyWithControls, any, {}>>;
     /**
      *
      * @summary Update Company
@@ -2349,7 +2392,7 @@ export declare const ControlsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateControlV1ControlsUpdatePatch(updateControlSchema: UpdateControlSchema, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetControl>>;
+    updateControlV1ControlsUpdatePatch(updateControlSchema: UpdateControlSchema, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ControlBase>>;
 };
 /**
  * ControlsApi - factory interface
@@ -2375,7 +2418,7 @@ export declare const ControlsApiFactory: (configuration?: Configuration, basePat
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateControlV1ControlsUpdatePatch(updateControlSchema: UpdateControlSchema, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetControl>;
+    updateControlV1ControlsUpdatePatch(updateControlSchema: UpdateControlSchema, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<ControlBase>;
 };
 /**
  * ControlsApi - object-oriented interface
@@ -2405,7 +2448,7 @@ export declare class ControlsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ControlsApi
      */
-    updateControlV1ControlsUpdatePatch(updateControlSchema: UpdateControlSchema, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetControl, any, {}>>;
+    updateControlV1ControlsUpdatePatch(updateControlSchema: UpdateControlSchema, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ControlBase, any, {}>>;
 }
 /**
  * EvidenceApi - axios parameter creator
@@ -3055,7 +3098,7 @@ export declare const PoliciesApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getCompanyPoliciesV1PoliciesCompanyCompanyIdGet(companyId: string, page?: number, elements?: number, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PolicyRead>>>;
+    getCompanyPoliciesV1PoliciesCompanyCompanyIdGet(companyId: string, page?: number, elements?: number, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponsePolicyRead>>;
     /**
      *
      * @summary Get Policy
@@ -3112,7 +3155,7 @@ export declare const PoliciesApiFactory: (configuration?: Configuration, basePat
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getCompanyPoliciesV1PoliciesCompanyCompanyIdGet(companyId: string, page?: number, elements?: number, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<PolicyRead>>;
+    getCompanyPoliciesV1PoliciesCompanyCompanyIdGet(companyId: string, page?: number, elements?: number, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponsePolicyRead>;
     /**
      *
      * @summary Get Policy
@@ -3174,7 +3217,7 @@ export declare class PoliciesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    getCompanyPoliciesV1PoliciesCompanyCompanyIdGet(companyId: string, page?: number, elements?: number, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PolicyRead[], any, {}>>;
+    getCompanyPoliciesV1PoliciesCompanyCompanyIdGet(companyId: string, page?: number, elements?: number, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponsePolicyRead, any, {}>>;
     /**
      *
      * @summary Get Policy