@hapl/api-queries 0.1.147 → 0.1.148

package/dist/clients/v1/api/deal/findDeals/index.d.ts

@@ -0,0 +1,96 @@
+import { AxiosResponse, AxiosError } from 'axios';
+import { ContractStatus, Deal, DealStatus, RealtyType } from '../../../types';
+declare type ErrorData = {
+    success: false;
+    data: {
+        error: string;
+    };
+};
+declare type ResultData = {
+    ids: number[];
+    byId: Record<string, Deal>;
+    meta: {
+        total: number;
+        plannedCommissionSum: number;
+        receivedCommissionSum: number;
+    };
+};
+declare type ResultError = ErrorData['data']['error'];
+export declare type FindDealsParams = {
+    filter?: {
+        actSignedAt?: {
+            from?: string;
+            to?: string;
+        };
+        address?: string;
+        'contract.serviceRequest.curator.office'?: string;
+        'contract.serviceRequest.id'?: number;
+        'contract.serviceRequest.investBuyoutDeal.id'?: 'notnull' | number;
+        'contract.serviceRequest.realtyType'?: RealtyType;
+        'contract.signedAt'?: {
+            from?: string;
+            to?: string;
+        };
+        'contract.status'?: ContractStatus;
+        commonId?: string;
+        createdAt?: {
+            from?: string;
+            to?: string;
+        };
+        dealDoneAt?: {
+            from?: string;
+            to?: string;
+        };
+        dealSignedAt?: {
+            from?: string;
+            to?: string;
+        };
+        'expert.id'?: number;
+        'expert.supervisor.id'?: number;
+        hasPassedDate?: boolean;
+        hasPrepayment?: boolean;
+        id?: number | number[];
+        isInvestBuyout?: boolean;
+        isLawyerRequired?: boolean;
+        'lawyer.id'?: number;
+        lawyerNotRequiredReason?: string;
+        prepaidAt?: {
+            from?: string;
+            to?: string;
+        };
+        prepaymentPlannedAt?: {
+            from?: string;
+            to?: string;
+        };
+        registeredAt?: {
+            from?: string;
+            to?: string;
+        };
+        status?: DealStatus;
+        terminatedAt?: {
+            from?: string;
+            to?: string;
+        };
+        withTerminated?: boolean;
+    };
+    limits?: {
+        page?: number;
+        count: number | 'all';
+    };
+    sorting?: {
+        direction: 'asc' | 'desc';
+        type: 'commissionAt' | 'commissionPlannedAt' | 'createdAt' | 'dealDoneAt' | 'dealSignPlannedAt' | 'dealSignedAt' | 'prepaidAt' | 'prepaymentPlannedAt' | 'registerPlannedAt' | 'registeredAt' | 'terminationRequestedAt';
+    };
+};
+export declare type FindDealsHeaders = {
+    'x-auth-hc': string;
+};
+export declare type FindDealsData = AxiosResponse<ResultData>;
+export declare type FindDealsError = AxiosError<ResultError>;
+export declare type FindDealsConfig = {
+    baseURL?: string;
+    headers: FindDealsHeaders;
+    params: FindDealsParams;
+};
+export declare function findDealsRequest({ baseURL, headers, params }: FindDealsConfig): Promise<FindDealsData>;
+export {};

package/dist/clients/v1/api/index.d.ts

@@ -36,6 +36,7 @@ export * from './deal/createDealCategorizedFile';
 export * from './deal/createDealInvestPrepayment';
 export * from './deal/deleteDealCategorizedFile';
 export * from './deal/findDealCategorizedFiles';
+export * from './deal/findDeals';
 export * from './deal/setDealDoneState';
 export * from './deal/setDealPrepaymentState';
 export * from './deal/setDealRegisteredState';

package/dist/clients/v1/index.d.ts

@@ -39,6 +39,7 @@ export declare class Api {
     createDealCategorizedFile: (urlParams: api.CreateDealCategorizedFileUrlParams, body: api.CreateDealCategorizedFileBody, headers: api.CreateDealCategorizedFileHeaders) => Promise<api.CreateDealCategorizedFileData>;
     createDealInvestPrepayment: (urlParams: api.CreateDealInvestPrepaymentUrlParams, body: api.CreateDealInvestPrepaymentBody, headers: api.CreateDealInvestPrepaymentHeaders) => Promise<api.CreateDealInvestPrepaymentData>;
     findDealCategorizedFiles: (urlParams: api.FindDealCategorizedFilesUrlParams, params: api.FindDealCategorizedFilesParams, headers: api.FindDealCategorizedFilesHeaders) => Promise<api.FindDealCategorizedFilesData>;
+    findDeals: (params: api.FindDealsParams, headers: api.FindDealsHeaders) => Promise<api.FindDealsData>;
     deleteDealCategorizedFile: (urlParams: api.DeleteDealCategorizedFileUrlParams, headers: api.DeleteDealCategorizedFileHeaders) => Promise<api.DeleteDealCategorizedFileData>;
     setDealDoneState: (urlParams: api.SetDealDoneStateUrlParams, headers: api.SetDealDoneStateHeaders) => Promise<api.SetDealDoneStateData>;
     setDealPrepaymentState: (urlParams: api.SetDealPrepaymentStateUrlParams, body: api.SetDealPrepaymentStateBody, headers: api.SetDealPrepaymentStateHeaders) => Promise<api.SetDealPrepaymentStateData>;

package/dist/clients/v1/types/Deal.d.ts

@@ -23,35 +23,32 @@ export declare enum DealStatus {
     Terminated = "terminated"
 }
 export declare type Deal = {
-    id: number;
-    createdAt: string;
-    status: DealStatus;
+    buyer: Partial<Buyer> & Required<Pick<Buyer, 'id'>>;
     canBeDealDone?: boolean;
-    finalPrice: number;
     contract?: Partial<Contract> & Required<Pick<Contract, 'id'>>;
-    hasPrepayment: boolean;
-    plannedCommission: number;
+    createdAt: string;
     developerCommission: number;
-    partnerCommission: number;
-    receivedCommission: number;
-    buyer: Partial<Buyer> & Required<Pick<Buyer, 'id'>>;
+    finalPrice: number;
+    hasPrepayment: boolean;
+    id: number;
     incomes: Array<Partial<Income> & Required<Pick<Income, 'id'>>>;
     participants: Array<Partial<DealParticipant> & Required<Pick<DealParticipant, 'id'>>>;
+    partnerCommission: number;
+    plannedCommission: number;
+    receivedCommission: number;
+    status: DealStatus;
+    actSignedAt?: string;
     comment?: string;
-    lawyer?: Partial<User> & Required<Pick<User, 'id'>>;
+    commissionAt?: string;
+    commissionPlannedAt?: string;
+    dealDoneAt?: string;
+    dealSingedAt?: string;
+    dealSignPlannedAt?: string;
+    dealSignedAt?: string;
     files?: Array<Partial<File> & Required<Pick<File, 'id'>>>;
     filesInDeal?: {
         id: number;
     };
-    updatedAt?: string;
-    dealSignPlannedAt?: string;
-    commissionPlannedAt?: string;
-    registerPlannedAt?: string;
-    prepaidAt?: string;
-    registeredAt?: string;
-    dealSingedAt?: string;
-    dealDoneAt?: string;
-    terminatedAt?: string;
     invest?: {
         isInvestBuyout?: boolean;
         investBuyoutPrepaymentSum?: number;
@@ -60,4 +57,14 @@ export declare type Deal = {
             id: number;
         };
     };
+    isLawyerRequired?: string;
+    lawyer?: Partial<User> & Required<Pick<User, 'id'>>;
+    lawyerNotRequiredReason?: DealNoLawyerReason;
+    prepaidAt?: string;
+    prepaymentPlannedAt?: string;
+    registerPlannedAt?: string;
+    registeredAt?: string;
+    terminatedAt?: string;
+    terminationRequestedAt?: string;
+    updatedAt?: string;
 };

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.147",
+  "version": "0.1.148",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

package/src/clients/v1/api/deal/findDeals/index.ts

@@ -0,0 +1,105 @@
+import axios, { AxiosResponse, AxiosError, AxiosTransformer } from 'axios';
+import qs from 'qs';
+import { ContractStatus, Deal, DealStatus, RealtyType } from '../../../types';
+
+type SuccessData = {
+  success: true;
+  data: Deal[];
+  meta: { plannedCommissionSum: number; receivedCommissionSum: number };
+  pageParams: { page: number; length: number };
+};
+type ErrorData = { success: false; data: { error: string } };
+
+type ResultData = {
+  ids: number[];
+  byId: Record<string, Deal>;
+  meta: { total: number; plannedCommissionSum: number; receivedCommissionSum: number };
+};
+type ResultError = ErrorData['data']['error'];
+
+export type FindDealsParams = {
+  filter?: {
+    actSignedAt?: { from?: string; to?: string };
+    address?: string;
+    'contract.serviceRequest.curator.office'?: string;
+    'contract.serviceRequest.id'?: number;
+    'contract.serviceRequest.investBuyoutDeal.id'?: 'notnull' | number;
+    'contract.serviceRequest.realtyType'?: RealtyType;
+    'contract.signedAt'?: { from?: string; to?: string };
+    'contract.status'?: ContractStatus;
+    commonId?: string;
+    createdAt?: { from?: string; to?: string };
+    dealDoneAt?: { from?: string; to?: string };
+    dealSignedAt?: { from?: string; to?: string };
+    'expert.id'?: number;
+    'expert.supervisor.id'?: number;
+    hasPassedDate?: boolean;
+    hasPrepayment?: boolean;
+    id?: number | number[];
+    isInvestBuyout?: boolean;
+    isLawyerRequired?: boolean;
+    'lawyer.id'?: number;
+    lawyerNotRequiredReason?: string;
+    prepaidAt?: { from?: string; to?: string };
+    prepaymentPlannedAt?: { from?: string; to?: string };
+    registeredAt?: { from?: string; to?: string };
+    status?: DealStatus;
+    terminatedAt?: { from?: string; to?: string };
+    withTerminated?: boolean;
+  };
+  limits?: { page?: number; count: number | 'all' };
+  sorting?: {
+    direction: 'asc' | 'desc';
+    type:
+      | 'commissionAt'
+      | 'commissionPlannedAt'
+      | 'createdAt'
+      | 'dealDoneAt'
+      | 'dealSignPlannedAt'
+      | 'dealSignedAt'
+      | 'prepaidAt'
+      | 'prepaymentPlannedAt'
+      | 'registerPlannedAt'
+      | 'registeredAt'
+      | 'terminationRequestedAt';
+  };
+};
+
+export type FindDealsHeaders = { 'x-auth-hc': string };
+export type FindDealsData = AxiosResponse<ResultData>;
+export type FindDealsError = AxiosError<ResultError>;
+export type FindDealsConfig = {
+  baseURL?: string;
+  headers: FindDealsHeaders;
+  params: FindDealsParams;
+};
+
+export function findDealsRequest({ baseURL = 'https://clients.homeapp.ru', headers, params }: FindDealsConfig) {
+  return axios
+    .get('/api/deal', {
+      baseURL,
+      params,
+      paramsSerializer: params => qs.stringify(params, { arrayFormat: 'brackets' }),
+      headers: { Accept: 'application/json', ...headers },
+      transformResponse: [
+        ...(axios.defaults.transformResponse as AxiosTransformer[]),
+        (data: SuccessData | ErrorData): ResultData | ResultError => {
+          if (!data.success) return data.data.error;
+
+          const ids: ResultData['ids'] = [];
+          const byId: ResultData['byId'] = {};
+
+          data.data.forEach(entity => {
+            byId[entity.id] = entity;
+            ids.push(entity.id);
+          });
+
+          return { ids, byId, meta: { ...data.meta, total: data.pageParams.length } };
+        },
+      ],
+    })
+    .then((res: FindDealsData) => res)
+    .catch((err: FindDealsError) => {
+      throw err;
+    });
+}

package/src/clients/v1/api/index.ts

@@ -44,6 +44,7 @@ export * from './deal/createDealCategorizedFile';
 export * from './deal/createDealInvestPrepayment';
 export * from './deal/deleteDealCategorizedFile';
 export * from './deal/findDealCategorizedFiles';
+export * from './deal/findDeals';
 export * from './deal/setDealDoneState';
 export * from './deal/setDealPrepaymentState';
 export * from './deal/setDealRegisteredState';

package/src/clients/v1/index.ts

@@ -218,6 +218,10 @@ export class Api {
     return api.findDealCategorizedFilesRequest({ urlParams, params, headers, baseURL: this.baseURL });
   };
 
+  findDeals = (params: api.FindDealsParams, headers: api.FindDealsHeaders) => {
+    return api.findDealsRequest({ params, headers, baseURL: this.baseURL });
+  };
+
   deleteDealCategorizedFile = (
     urlParams: api.DeleteDealCategorizedFileUrlParams,
     headers: api.DeleteDealCategorizedFileHeaders

package/src/clients/v1/types/Deal.ts

@@ -27,37 +27,44 @@ export enum DealStatus {
 }
 
 export type Deal = {
-  id: number;
-  createdAt: string;
-  status: DealStatus;
+  buyer: Partial<Buyer> & Required<Pick<Buyer, 'id'>>;
   canBeDealDone?: boolean;
-  finalPrice: number;
   contract?: Partial<Contract> & Required<Pick<Contract, 'id'>>;
-  hasPrepayment: boolean;
-  plannedCommission: number;
+  createdAt: string;
   developerCommission: number;
-  partnerCommission: number;
-  receivedCommission: number;
-  buyer: Partial<Buyer> & Required<Pick<Buyer, 'id'>>;
+  finalPrice: number;
+  hasPrepayment: boolean;
+  id: number;
   incomes: Array<Partial<Income> & Required<Pick<Income, 'id'>>>;
   participants: Array<Partial<DealParticipant> & Required<Pick<DealParticipant, 'id'>>>;
+  partnerCommission: number;
+  plannedCommission: number;
+  receivedCommission: number;
+  status: DealStatus;
+  actSignedAt?: string;
   comment?: string;
-  lawyer?: Partial<User> & Required<Pick<User, 'id'>>;
-  files?: Array<Partial<File> & Required<Pick<File, 'id'>>>;
-  filesInDeal?: { id: number };
-  updatedAt?: string;
-  dealSignPlannedAt?: string;
+  commissionAt?: string;
   commissionPlannedAt?: string;
-  registerPlannedAt?: string;
-  prepaidAt?: string;
-  registeredAt?: string;
-  dealSingedAt?: string;
   dealDoneAt?: string;
-  terminatedAt?: string;
+  dealSingedAt?: string;
+  dealSignPlannedAt?: string;
+  dealSignedAt?: string;
+  files?: Array<Partial<File> & Required<Pick<File, 'id'>>>;
+  filesInDeal?: { id: number };
   invest?: {
     isInvestBuyout?: boolean;
     investBuyoutPrepaymentSum?: number;
     investBuyoutPrepaymentAt?: string;
     investSellServiceRequest?: { id: number };
   };
+  isLawyerRequired?: string;
+  lawyer?: Partial<User> & Required<Pick<User, 'id'>>;
+  lawyerNotRequiredReason?: DealNoLawyerReason;
+  prepaidAt?: string;
+  prepaymentPlannedAt?: string;
+  registerPlannedAt?: string;
+  registeredAt?: string;
+  terminatedAt?: string;
+  terminationRequestedAt?: string;
+  updatedAt?: string;
 };