@cbm-common/cbm-types 0.0.1 → 0.0.3

package/src/lib/types/app/domain/models/company.domain.model.d.ts

@@ -0,0 +1,354 @@
+export declare namespace CbmCompanyModel {
+    enum EStatus {
+        SUSPENDED = "suspended",
+        ACTIVE = "active",
+        INACTIVE = "inactive",
+        PENDING = "pending"
+    }
+    namespace EStatus {
+        function fromString(value: string): EStatus;
+        function toString(value: EStatus): TStatus;
+    }
+    type TStatus = `${EStatus}`;
+    interface ListParams {
+        page: number;
+        size: number;
+        deleted?: boolean;
+        status?: TStatus;
+        date_end?: number;
+        date_begin?: number;
+        filter?: string;
+        country_id?: string;
+    }
+    interface ListResponse {
+        success: boolean;
+        pageNum: number;
+        pageSize: number;
+        items: ListResponse.Item[];
+        pages: number;
+        total: number;
+    }
+    namespace ListResponse {
+        interface Item {
+            _id: string;
+            country_id?: string;
+            NIF?: string;
+            business_name?: string;
+            address?: string;
+            trade_name?: string;
+            status?: string;
+            readonly?: boolean;
+            created_at?: number;
+            created_user?: string;
+            updated_at?: number;
+            updated_user?: string;
+            branches?: Item.Branch[];
+            mandatory_accounting?: boolean;
+            withholding_agent?: boolean;
+            special_taxpayer?: boolean;
+            artisanal_qualification?: boolean;
+            default_account_plan?: boolean;
+            account_template_id?: string;
+            special_taxpayer_number?: string | null;
+            artisanal_qualification_number?: string | null;
+            enabled?: boolean;
+            deleted?: boolean;
+            manager_name?: string;
+            accountant_name?: string;
+            email?: string;
+            regime_id?: string;
+            expiration_signature_date?: number;
+            regime?: Item.Regime;
+            regime_name?: string;
+            withholding_agent_number?: string;
+            country_name?: string;
+            country_code?: string;
+            contry_short_name?: string;
+        }
+        namespace Item {
+            interface Branch {
+                _id: string;
+                company_id?: string;
+                identification_number?: string;
+                trade_name?: string;
+                address?: string;
+                email?: string;
+                cellphone?: string;
+                phone?: string;
+                environment?: number;
+                enabled?: boolean;
+                created_at?: number;
+                created_user?: string;
+                updated_at?: number;
+                updated_user?: string;
+                logo?: string;
+                disabled_at?: number;
+                disabled_reason?: string;
+                disabled_user?: string;
+                enabled_at?: number;
+                enabled_user?: string;
+                reading: boolean;
+                transaction: boolean;
+            }
+            interface Regime {
+                regime_code?: string;
+                regime_name?: string;
+            }
+            interface FileSignature {
+                url?: string;
+                name?: string;
+                mimetype?: string;
+            }
+        }
+    }
+    interface ListAllParams {
+        filter?: string;
+    }
+    interface ListAllResponse {
+        success: boolean;
+        data: ListAllResponse.Data[];
+    }
+    namespace ListAllResponse {
+        interface Data {
+            _id: string;
+            country_id?: string;
+            NIF?: string;
+            business_name?: string;
+            address?: string;
+            trade_name?: string;
+            status?: string;
+            readonly?: boolean;
+            created_at?: number;
+            created_user?: string;
+            updated_at?: number;
+            updated_user?: string;
+        }
+    }
+    interface GetOneResponse {
+        success: boolean;
+        data: GetOneResponse.Data;
+    }
+    namespace GetOneResponse {
+        interface Data {
+            _id: string;
+            country_id: string;
+            NIF: string;
+            business_name: string;
+            address: string;
+            trade_name: string;
+            status: string;
+            readonly: boolean;
+            created_at: number;
+            created_user: string;
+            email: string;
+            artisanal_qualification: boolean;
+            mandatory_accounting: boolean;
+            regime_id: string;
+            special_taxpayer: boolean;
+            updated_at: number;
+            updated_user: string;
+            withholding_agent: boolean;
+            special_taxpayer_number: string;
+            withholding_agent_number: string;
+            deleted: boolean;
+            file_signature: Data.FileSignature;
+            password_signature: string;
+            expiration_signature_date: number;
+            artisanal_qualification_number: string;
+            manager_name: string;
+            regime_name: string;
+            count_branches: number;
+            regime: Data.Regime;
+            subscription: Data.Subscription;
+            default_account_plan: boolean;
+            account_template_id: string;
+            enabled: boolean;
+            contry_short_name: string;
+            country_code: string;
+            country_name: string;
+        }
+        namespace Data {
+            interface Regime {
+                regime_code: string;
+                regime_name: string;
+            }
+            interface FileSignature {
+                mimetype: string;
+                name: string;
+                url: string;
+            }
+            interface Subscription {
+                _id: string;
+                subscription_id: string;
+                company_id: string;
+                user_id: string;
+                code?: string;
+                type_support: string;
+                begin_date: number;
+                end_date: number;
+                count_users: number;
+                count_storage: number;
+                count_branch_read: number;
+                count_branch_transactional: number;
+                used_users: number;
+                used_storage: number;
+                used_branch_read: number;
+                used_branch_transactional: number;
+                status: string;
+                enabled?: boolean;
+                deleted: boolean;
+                created_at?: number;
+                created_user?: string;
+                updated_at?: number;
+                updated_user?: string;
+                subscription_module_count: number;
+                expiration_day: string;
+                available_branch_transactional: number;
+                available_branch_read: number;
+                available_users: number;
+            }
+            interface Branch {
+                _id: string;
+                company_id?: string;
+                identification_number?: string;
+                trade_name?: string;
+                address?: string;
+                email?: string;
+                cellphone?: string;
+                phone?: string;
+                environment?: number;
+                enabled?: boolean;
+                created_at?: number;
+                created_user?: string;
+                updated_at?: number;
+                updated_user?: string;
+            }
+            interface Subscription {
+                _id: string;
+                code?: string;
+                name?: string;
+                life_year?: number;
+                method_pay?: string;
+                collection_method?: string;
+                enabled?: boolean;
+                created_at?: number;
+                created_user?: string;
+                updated_at?: number;
+                updated_user?: string;
+            }
+        }
+    }
+    interface GetInfoResponse {
+        success: boolean;
+        data: GetInfoResponse.Data;
+    }
+    namespace GetInfoResponse {
+        interface Data {
+            _id: string;
+            NIF?: string;
+            business_name?: string;
+            status?: TStatus;
+            count_branches?: number;
+            subscription_code?: string;
+            count_branches_allowed?: number;
+            count_users_allowed?: number;
+            count_users?: number;
+            count_modules?: number;
+            created_at?: number;
+            created_user?: string;
+            updated_at?: number;
+            updated_user?: string;
+        }
+    }
+    interface SaveBody {
+        NIF: string;
+        business_name: string;
+        address: string;
+        trade_name: string;
+        status?: string;
+        readonly?: boolean;
+        default_account_plan: boolean;
+        account_template_id?: string;
+        email?: string;
+        mandatory_accounting?: boolean;
+        withholding_agent?: boolean;
+        special_taxpayer?: boolean;
+        artisanal_qualification?: boolean;
+        withholding_agent_number?: string;
+        special_taxpayer_number?: string;
+        artisanal_qualification_number?: string;
+        manager_name?: string;
+        accountant_name?: string;
+        regime_id?: string;
+        regime_code?: string;
+        regime_name?: string;
+        branches?: SaveBody.Data[];
+        country_id: string;
+        country_name: string;
+        country_code: string;
+        contry_short_name: string;
+    }
+    namespace SaveBody {
+        interface Data {
+            identification_number?: string;
+            trade_name?: string;
+            address?: string;
+            email?: string;
+            cellphone?: string;
+            phone?: string;
+            environment?: number;
+        }
+    }
+    interface UpdateBody {
+        NIF?: string;
+        business_name?: string;
+        address?: string;
+        trade_name?: string;
+        default_account_plan?: boolean;
+        account_template_id?: string;
+        email?: string;
+        status?: string;
+        readonly?: boolean;
+        mandatory_accounting?: boolean;
+        withholding_agent?: boolean;
+        special_taxpayer?: boolean;
+        artisanal_qualification?: boolean;
+        withholding_agent_number?: string;
+        special_taxpayer_number?: string;
+        artisanal_qualification_number?: string;
+        manager_name?: string;
+        accountant_name?: string;
+        regime_id?: string;
+        regime_code?: string;
+        regime_name?: string;
+        branches?: BranchParams.Data[];
+        password_signature?: string;
+        type?: string;
+    }
+    namespace BranchParams {
+        interface Data {
+            identification_number?: string;
+            trade_name?: string;
+            address?: string;
+            email?: string;
+            cellphone?: string;
+            phone?: string;
+            environment?: number;
+        }
+    }
+    interface BulkBody {
+        tax_iva_id: string;
+    }
+    interface ChangeStatusBody {
+        status: TStatus;
+    }
+    interface ConfirmResponse {
+        success: boolean;
+        message: string;
+        data?: any;
+    }
+    interface UploadFileSignatureRequest {
+        id: string;
+        password: string;
+    }
+}

package/src/lib/types/app/domain/models/document-reference.domain.model.d.ts

@@ -0,0 +1,204 @@
+export declare namespace CbmDocumentReferenceModel {
+    interface Translation {
+        event: string;
+        translation: string;
+    }
+    interface ListParams {
+        collection_origin_name?: string;
+        collection_origin_id?: string;
+        collection_destination_name?: string;
+        collection_destination_id?: string;
+        start_date?: number;
+        end_date?: number;
+    }
+    interface ListResponse {
+        success: boolean;
+        data: ListResponse.Data[];
+    }
+    namespace ListResponse {
+        interface Data {
+            _id: string;
+            collection_origin_name: string;
+            collection_origin_id: string;
+            collection_destination_name: string;
+            collection_destination_id: string;
+            type: string;
+            type_record?: string;
+            document_origin_name: string;
+            document_origin_number: number;
+            document_origin_date: number;
+            document_destination_name: string;
+            document_destination_number: number;
+            document_destination_date: number;
+            beneficiary_number?: string;
+            beneficiary_name?: string;
+            deleted: boolean;
+            created_at: number;
+            created_user: string;
+            event?: string;
+        }
+    }
+    interface GetOneResponse {
+        success: boolean;
+        data: GetOneResponse.Data;
+    }
+    namespace GetOneResponse {
+        interface Data {
+            _id: string;
+            collection_origin_name?: string;
+            collection_origin_id?: string;
+            collection_destination_name?: string;
+            type?: string;
+            type_record?: string;
+            document_origin_name?: string;
+            document_origin_number?: string;
+            document_origin_date?: number;
+            document_destination_name?: string;
+            document_destination_number?: string;
+            document_destination_date?: number;
+            beneficiary_number?: string;
+            beneficiary_name?: string;
+            created_at?: number;
+            created_user?: string;
+        }
+    }
+    interface SaveBody {
+        collection_origin_name: string;
+        collection_origin_id: string;
+        collection_destination_name?: string;
+        collection_destination_id?: string;
+        type: string;
+        type_record: string;
+        document_origin_name: string;
+        document_origin_number: string;
+        document_origin_date: number;
+        document_destination_name: string;
+        document_destination_number: string;
+        document_destination_date: number;
+        beneficiary_number?: string;
+        beneficiary_name?: string;
+    }
+    interface SaveManyBody {
+        data: SaveManyBody.Data[];
+    }
+    namespace SaveManyBody {
+        interface Data {
+            collection_origin_name: string;
+            collection_origin_id: string;
+            collection_destination_name?: string;
+            collection_destination_id?: string;
+            type: string;
+            type_record: string;
+            document_origin_name: string;
+            document_origin_number: string;
+            document_origin_date: number;
+            document_destination_name: string;
+            document_destination_number: string;
+            document_destination_date: number;
+            beneficiary_number?: string;
+            beneficiary_name?: string;
+        }
+    }
+    interface RelationshipTreeParams {
+        collection_origin_id: string;
+        collection_origin_name: string;
+        event_module_origin: string;
+    }
+    interface RelationshipTreeResponse {
+        event_module_origin: string;
+        collection_origin_name: string;
+        collection_origin_id: string;
+        event_module_destination?: string;
+        collection_destination_name?: string;
+        collection_destination_id?: string;
+        type: string;
+        document_origin_name: string;
+        document_origin_number: string;
+        document_origin_date: number;
+        document_destination_name?: string;
+        document_destination_number?: string;
+        document_destination_date?: number;
+        deleted: boolean;
+        created_at: number;
+        created_user: string;
+        documents?: RelationshipTreeResponse.Document[];
+        origin?: boolean;
+    }
+    namespace RelationshipTreeResponse {
+        interface Document {
+            event_module_origin: string;
+            collection_origin_name: string;
+            collection_origin_id: string;
+            event_module_destination?: string;
+            collection_destination_name?: string;
+            collection_destination_id?: string;
+            type: string;
+            document_origin_name: string;
+            document_origin_number: string;
+            document_origin_date: number;
+            document_destination_name?: string;
+            document_destination_number?: string;
+            document_destination_date?: number;
+            deleted: boolean;
+            created_at: number;
+            created_user: string;
+            documents?: Document[];
+            father?: boolean;
+        }
+    }
+    interface ParentTreeParams {
+        collection_destination_id: string;
+        collection_destination_name: string;
+        event_module_destination: string;
+    }
+    interface ParentTreeResponse {
+        _id: string;
+        event_module_origin: string;
+        collection_origin_name: string;
+        collection_origin_id: string;
+        event_module_destination: string;
+        collection_destination_name: string;
+        collection_destination_id: string;
+        type: string;
+        document_origin_name: string;
+        document_origin_number: string;
+        document_origin_date: number;
+        document_destination_name: string;
+        document_destination_number: string;
+        deleted: boolean;
+        created_at: number;
+        created_user: string;
+        documents?: ParentTreeResponse.Document[];
+        origin?: boolean;
+    }
+    namespace ParentTreeResponse {
+        interface Document {
+            _id: string;
+            event_module_origin: string;
+            collection_origin_name: string;
+            collection_origin_id: string;
+            event_module_destination: string;
+            collection_destination_name: string;
+            collection_destination_id: string;
+            type: string;
+            document_origin_name: string;
+            document_origin_number: string;
+            document_origin_date: number;
+            document_destination_name: string;
+            document_destination_number: string;
+            document_destination_date?: number;
+            deleted: boolean;
+            created_at: number;
+            created_user: string;
+            documents?: Document[];
+        }
+    }
+    interface ValidationBeforeSaveParams {
+        collection_origin_id: string;
+    }
+    interface ConfirmResponse {
+        success: boolean;
+        message: string;
+        data?: any;
+    }
+}

package/src/lib/types/app/domain/models/group.domain.model.d.ts

@@ -0,0 +1,78 @@
+export declare namespace CbmGroupModel {
+    interface ListParams {
+        enabled?: boolean;
+        name?: string;
+        group_id?: string;
+    }
+    interface ListResponse {
+        success: boolean;
+        data: ListResponse.Data[];
+    }
+    namespace ListResponse {
+        interface Data {
+            _id: string;
+            company_id?: string;
+            group_id?: string;
+            initial?: boolean;
+            level?: number;
+            name?: string;
+            enabled?: boolean;
+            created_user?: string;
+            created_at?: number;
+            disabled_reason?: string;
+            updated_at?: number;
+            updated_user?: string;
+        }
+    }
+    interface ListAsTreeParams {
+        name?: string;
+    }
+    interface ListAsTreeResponse {
+        success: boolean;
+        data: ListAsTreeResponse.Children;
+    }
+    namespace ListAsTreeResponse {
+        type Children = Child[];
+        interface Child {
+            label: string;
+            value: Group | Category;
+            children?: Children;
+        }
+        interface Group {
+            _id: string;
+            company_id?: string;
+            group_id?: string;
+            initial?: boolean;
+            level?: number;
+            name?: string;
+            enabled?: boolean;
+            deleted?: boolean;
+            created_user?: string;
+            created_at?: number;
+            disabled_reason?: string;
+            updated_at?: number;
+            updated_user?: string;
+        }
+        interface Category {
+            _id: string;
+            company_id?: string;
+            group_id?: string;
+            name?: string;
+            nomenclature?: string;
+            last_number?: number;
+            separator?: string;
+            enabled?: boolean;
+            deleted?: boolean;
+            created_user?: string;
+            created_at?: number;
+            updated_at?: number;
+            updated_user?: string;
+            goods_receipts_account_id?: string;
+            income_account_id?: string;
+            inventory_account_id?: string;
+            cost_account_id?: string;
+            discount_account_id?: string;
+            return_account_id?: string;
+        }
+    }
+}