repzo 1.0.247 → 1.0.248

package/lib/types/index.d.ts

@@ -4970,11 +4970,7 @@ export declare namespace Service {
             score?: number;
             is_completed?: boolean;
             forms_v2?: {
-                form_id: StringId | {
-                    _id: StringId;
-                    name: string;
-                    local_name?: string;
-                };
+                form_id: StringId | Pick<FormV2.Data, "_id" | "name" | "local_name">;
                 form_activity_id?: StringId;
                 completion_required_for_dunning?: boolean;
                 score_required_for_dunning?: boolean;
@@ -14203,235 +14199,6 @@ export declare namespace Service {
             current_granularity?: Granularity;
         }
     }
-    namespace FormV2 {
-        export interface Visibility {
-            operator: "and" | "or";
-            conditions: {
-                division_id: string;
-                field_id: string;
-                type: "Boolean" | "List" | "YesNo";
-                custom_list?: string | CustomList.Data;
-                operator: "lte" | "lt" | "gte" | "gt" | "eq" | "ne" | "in" | "nin";
-                value: any[];
-            }[];
-        }
-        export const fieldType_enums: readonly ["Text", "String", "Phone", "Email", "Date", "Number", "List", "Separator", "Heading", "Media", "Signature", "DateTime", "YesNo", "ProductBarcodeScan", "BarcodeScan", "GeoPoint"];
-        export type FormV2FieldType = (typeof fieldType_enums)[number];
-        interface FieldPrintSettings {
-            three_inch: {
-                grid_column?: 1 | 2;
-                alignment?: "right" | "left" | "center";
-                border_width?: number;
-                label_font_size?: number;
-                value_font_size?: number;
-                media_height?: number | string;
-                media_width?: number | string;
-                align_media?: "right" | "left" | "center";
-                label_value_spacing?: number;
-                is_hidden?: boolean;
-            };
-        }
-        interface UsedField {
-            code: string;
-            key: string;
-            data_type: AvailableField.Data["data_type"];
-            field_type: "template_field" | "source_attribute" | "activity_attribute";
-            label: string;
-            isArray?: boolean;
-            formula_key: string;
-            field_id?: string;
-            example_value: AvailableField.Data["data_type"];
-            manipulator_function?: string;
-            lookup?: {
-                from?: string;
-                localField?: string;
-                foreignField?: string;
-                as?: string;
-                select?: string;
-                unwind?: boolean;
-                filter?: {
-                    input?: string;
-                    as: string;
-                    cond: any;
-                };
-            };
-        }
-        export interface Field {
-            _id?: string;
-            name: string;
-            local_name?: string;
-            description?: string;
-            local_description?: string;
-            type: FormV2FieldType;
-            isArray?: boolean;
-            isRequired?: boolean;
-            disabled?: boolean;
-            formula_key?: string;
-            scoring_enabled?: boolean;
-            required_for_completion?: boolean;
-            visibility?: Visibility;
-            default_value?: any[];
-            custom_list?: string | CustomList.Data;
-            is_na_allowed?: boolean;
-            score_accumulator_type?: "max" | "sum";
-            yes_score?: number;
-            no_score?: number;
-            na_score?: number;
-            exist_score?: number;
-            media?: (string | MediaDoc)[];
-            invisible: boolean;
-            parent_field?: string;
-            custom_list_element?: string;
-            force_live_photo?: boolean;
-            min?: number;
-            max?: number;
-            is_integer?: boolean;
-            styles?: "check_list" | "toggle_yes_no_na" | "toggle_yes_no" | "buttons";
-            field_print_settings?: FieldPrintSettings;
-            is_calculated_field?: boolean;
-            formula?: string;
-            used_fields?: UsedField[];
-        }
-        interface Division {
-            _id: string;
-            name: string;
-            local_name?: string;
-            description?: string;
-            local_description?: string;
-            disabled?: boolean;
-            min_questions_to_answer_for_completion?: number;
-            min_score_for_completion?: number;
-            visibility?: Visibility;
-            fields: Field[];
-        }
-        interface PrintSettings {
-            three_inch: {
-                grid_columns?: 1 | 2;
-                logo_height?: number | string;
-                logo_width?: number | string;
-                align_logo?: "right" | "left" | "center";
-                space_y?: number;
-            };
-            A_four: {
-                banner_media?: string;
-                banner_height: number;
-                banner_width: number;
-                align_banner: "right" | "left" | "center";
-                header_label_font_size: number;
-                header_value_font_size: number;
-                align_header: "right" | "left" | "center";
-                division_name_font_size: number;
-                align_division: "right" | "left" | "center";
-                grid_columns: 1 | 2 | 3 | 4;
-                space_y: number;
-                field_label_size: number;
-                field_value_size: number;
-                footer_media?: string;
-                align_footer_media: "right" | "left" | "center";
-                footer_media_height: number;
-                footer_media_width: number;
-                footer_details: string;
-                align_footer_details: "right" | "left" | "center";
-                compressed_media_size: "original" | "small" | "medium" | "large" | "extra";
-                view_custom_list_element: boolean;
-            };
-        }
-        export interface Data {
-            _id: string;
-            disabled: boolean;
-            name: string;
-            local_name?: string;
-            description?: string;
-            local_description?: string;
-            copied_from?: string;
-            scoring_enabled?: boolean;
-            completion_rules_enabled?: boolean;
-            min_questions_to_answer_for_completion?: number;
-            min_score_for_completion?: number;
-            divisions: Division[];
-            company_namespace: string[];
-            print_settings?: PrintSettings;
-            createdAt: Date;
-            updatedAt: Date;
-        }
-        export {};
-    }
-    namespace ActivityFormV2Result {
-        const fieldType_enums: readonly ["Text", "String", "Phone", "Email", "Date", "Number", "List", "Separator", "Heading", "Media", "Signature", "DateTime", "YesNo", "ProductBarcodeScan", "BarcodeScan", "GeoPoint"];
-        type FormV2FieldType = (typeof fieldType_enums)[number];
-        interface FieldResult {
-            _id?: string;
-            field_id: string;
-            name: string;
-            type: FormV2FieldType;
-            isArray?: boolean;
-            isRequired?: boolean;
-            custom_list?: string;
-            formula_key?: string;
-            is_calculated_field?: boolean;
-            calculation_status?: "success" | "failed";
-            calculation_error?: any[];
-            score?: number;
-            is_completed?: boolean;
-            result: string[] | number[] | ["yes"] | ["no"] | ["na"] | [] | {
-                coordinates: [number, number];
-                type: "Point";
-            }[] | {
-                _id: string;
-                value: string | number;
-                type: "Number" | "String";
-                score?: number;
-            }[];
-        }
-        interface DivisionResult {
-            _id: string;
-            division_id: string;
-            name: string;
-            score?: number;
-            is_completed?: boolean;
-            fields: FieldResult[];
-        }
-        interface Data {
-            _id: string;
-            creator: AdminOrRepOrTenantOrClient;
-            editor?: AdminOrRepOrTenantOrClient;
-            serial_number: SerialNumber;
-            teams: string[];
-            tags: string[];
-            time: number;
-            client?: string;
-            client_name?: string;
-            visit?: string;
-            visit_id?: string;
-            route?: string;
-            workorder?: string;
-            sync_id: string;
-            geo_tag?: GeoTag;
-            geoPoint?: GeoPoint;
-            platform?: string;
-            version_name?: string;
-            battery_level?: number;
-            device_brand?: string;
-            device_os?: string;
-            device_os_version?: string;
-            device_model?: string;
-            identifier?: number;
-            device_id?: string;
-            device_unique_id?: string;
-            network_state?: number;
-            time_zone?: string;
-            job_start_time?: number;
-            job_end_time?: number;
-            job_duration?: number;
-            form_id: string;
-            results: DivisionResult[];
-            score?: number;
-            is_completed: boolean;
-            company_namespace: string[];
-            createdAt: Date;
-            updatedAt: Date;
-        }
-    }
     namespace ActivityItemStatus {
         type ItemStatus = "current_user" | "non_user" | "generic_user" | "competitor_user" | "other";
         interface Item {
@@ -17722,6 +17489,393 @@ export declare namespace Service {
             type Result = Data;
         }
     }
+    namespace FormV2 {
+        export interface Visibility {
+            operator: "and" | "or";
+            conditions: {
+                division_id: string;
+                field_id: string;
+                type: "Boolean" | "List" | "YesNo";
+                custom_list?: string | CustomList.Data;
+                operator: "lte" | "lt" | "gte" | "gt" | "eq" | "ne" | "in" | "nin";
+                value: any[];
+            }[];
+        }
+        export const fieldType_enums: readonly ["Text", "String", "Phone", "Email", "Date", "Number", "List", "Separator", "Heading", "Media", "Signature", "DateTime", "YesNo", "ProductBarcodeScan", "BarcodeScan", "GeoPoint"];
+        export type FormV2FieldType = (typeof fieldType_enums)[number];
+        interface FieldPrintSettings {
+            three_inch: {
+                grid_column?: 1 | 2;
+                alignment?: "right" | "left" | "center";
+                border_width?: number;
+                label_font_size?: number;
+                value_font_size?: number;
+                media_height?: number | string;
+                media_width?: number | string;
+                align_media?: "right" | "left" | "center";
+                label_value_spacing?: number;
+                is_hidden?: boolean;
+            };
+        }
+        interface UsedField {
+            code: string;
+            key: string;
+            data_type: AvailableField.Data["data_type"];
+            field_type: "template_field" | "source_attribute" | "activity_attribute";
+            label: string;
+            isArray?: boolean;
+            formula_key: string;
+            field_id?: string;
+            example_value: AvailableField.Data["data_type"];
+            manipulator_function?: string;
+            lookup?: {
+                from?: string;
+                localField?: string;
+                foreignField?: string;
+                as?: string;
+                select?: string;
+                unwind?: boolean;
+                filter?: {
+                    input?: string;
+                    as: string;
+                    cond: any;
+                };
+            };
+        }
+        export interface Field {
+            _id?: string;
+            name: string;
+            local_name?: string;
+            description?: string;
+            local_description?: string;
+            type: FormV2FieldType;
+            isArray?: boolean;
+            isRequired?: boolean;
+            disabled?: boolean;
+            formula_key?: string;
+            scoring_enabled?: boolean;
+            required_for_completion?: boolean;
+            visibility?: Visibility;
+            default_value?: any[];
+            custom_list?: string | CustomList.Data;
+            is_na_allowed?: boolean;
+            score_accumulator_type?: "max" | "sum";
+            yes_score?: number;
+            no_score?: number;
+            na_score?: number;
+            exist_score?: number;
+            media?: (string | MediaDoc)[];
+            invisible: boolean;
+            parent_field?: string;
+            custom_list_element?: string;
+            force_live_photo?: boolean;
+            min?: number;
+            max?: number;
+            is_integer?: boolean;
+            styles?: "check_list" | "toggle_yes_no_na" | "toggle_yes_no" | "buttons";
+            field_print_settings?: FieldPrintSettings;
+            is_calculated_field?: boolean;
+            formula?: string;
+            used_fields?: UsedField[];
+        }
+        interface Division {
+            _id: string;
+            name: string;
+            local_name?: string;
+            description?: string;
+            local_description?: string;
+            disabled?: boolean;
+            min_questions_to_answer_for_completion?: number;
+            min_score_for_completion?: number;
+            visibility?: Visibility;
+            fields: Field[];
+        }
+        interface PrintSettings {
+            three_inch: {
+                grid_columns?: 1 | 2;
+                logo_height?: number | string;
+                logo_width?: number | string;
+                align_logo?: "right" | "left" | "center";
+                space_y?: number;
+            };
+            A_four: {
+                banner_media?: string | MediaDoc;
+                banner_height: number;
+                banner_width: number;
+                align_banner: "right" | "left" | "center";
+                header_label_font_size: number;
+                header_value_font_size: number;
+                align_header: "right" | "left" | "center";
+                division_name_font_size: number;
+                align_division: "right" | "left" | "center";
+                grid_columns: 1 | 2 | 3 | 4;
+                space_y: number;
+                field_label_size: number;
+                field_value_size: number;
+                footer_media?: string | MediaDoc;
+                align_footer_media: "right" | "left" | "center";
+                footer_media_height: number;
+                footer_media_width: number;
+                footer_details: string;
+                align_footer_details: "right" | "left" | "center";
+                compressed_media_size: "original" | "small" | "medium" | "large" | "extra";
+                view_custom_list_element: boolean;
+            };
+        }
+        export interface Data {
+            _id: string;
+            disabled: boolean;
+            name: string;
+            local_name?: string;
+            description?: string;
+            local_description?: string;
+            copied_from?: string;
+            scoring_enabled?: boolean;
+            completion_rules_enabled?: boolean;
+            min_questions_to_answer_for_completion?: number;
+            min_score_for_completion?: number;
+            divisions: Division[];
+            company_namespace: string[];
+            print_settings?: PrintSettings;
+            createdAt: Date;
+            updatedAt: Date;
+        }
+        export interface CreateBody {
+            disabled?: boolean;
+            name: string;
+            local_name?: string;
+            description?: string;
+            local_description?: string;
+            copied_from?: string;
+            scoring_enabled?: boolean;
+            completion_rules_enabled?: boolean;
+            min_questions_to_answer_for_completion?: number;
+            min_score_for_completion?: number;
+            divisions: Division[];
+            company_namespace?: string[];
+            print_settings?: PrintSettings;
+        }
+        export type UpdateBody = Partial<Data>;
+        export type PopulatedDoc = Data & {
+            presentation_populated?: CLMPresentation.Data;
+            sequence_populated?: Pick<CLMSequence.Data, "position" | "_id" | "product" | "presentation">[];
+            photo_media_populated?: PopulatedMediaStorage & {
+                ContentLength?: number;
+            };
+        };
+        type PopulatedKeys = "custom_list" | "media" | "banner_media" | "footer_media";
+        type SortingKeys = "_id" | "position" | "updatedAt";
+        export namespace Find {
+            type Params = DefaultPaginationQueryParams & {
+                sortBy?: {
+                    field: SortingKeys;
+                    type: "asc" | "desc";
+                }[];
+                populatedKeys?: PopulatedKeys | PopulatedKeys[];
+                _id?: StringId | StringId[];
+                search?: string;
+                name?: string;
+                scoring_enabled?: boolean | boolean[];
+                completion_rules_enabled?: boolean | boolean[];
+                disabled?: boolean;
+            };
+            interface Result extends DefaultPaginationResult {
+                data: PopulatedDoc[];
+            }
+        }
+        export namespace Get {
+            type ID = string;
+            type Params = {
+                populatedKeys?: PopulatedKeys[];
+            };
+            type Result = PopulatedDoc & {
+                can_edit_types?: boolean;
+            };
+        }
+        export namespace Create {
+            type Body = CreateBody;
+            type Result = Data;
+        }
+        export namespace Update {
+            type ID = StringId;
+            type Body = UpdateBody;
+            type Result = Data;
+        }
+        export namespace Remove {
+            type ID = string;
+            type Result = Data;
+        }
+        export {};
+    }
+    namespace ActivityFormV2Result {
+        export const fieldType_enums: readonly ["Text", "String", "Phone", "Email", "Date", "Number", "List", "Separator", "Heading", "Media", "Signature", "DateTime", "YesNo", "ProductBarcodeScan", "BarcodeScan", "GeoPoint"];
+        export type FormV2FieldType = (typeof fieldType_enums)[number];
+        export interface FieldResult {
+            _id?: string;
+            field_id: string;
+            name: string;
+            type: FormV2FieldType;
+            isArray?: boolean;
+            isRequired?: boolean;
+            custom_list?: string;
+            formula_key?: string;
+            is_calculated_field?: boolean;
+            calculation_status?: "success" | "failed";
+            calculation_error?: any[];
+            score?: number;
+            is_completed?: boolean;
+            result: string[] | number[] | ["yes"] | ["no"] | ["na"] | [] | {
+                coordinates: [number, number];
+                type: "Point";
+            }[] | {
+                _id: string;
+                value: string | number;
+                type: "Number" | "String";
+                score?: number;
+            }[];
+        }
+        export interface DivisionResult {
+            _id?: string;
+            division_id: string;
+            name: string;
+            score?: number;
+            is_completed?: boolean;
+            fields: FieldResult[];
+        }
+        export interface Data {
+            _id: StringId;
+            creator: AdminOrRepOrTenantOrClient;
+            editor?: AdminOrRepOrTenantOrClient;
+            serial_number: SerialNumber;
+            teams: StringId[];
+            tags: StringId[];
+            time: number;
+            client?: StringId;
+            client_name?: string;
+            visit?: StringId;
+            visit_id?: string;
+            route?: StringId;
+            workorder?: StringId;
+            sync_id: string;
+            geo_tag?: GeoTag;
+            geoPoint?: GeoPoint;
+            platform?: string;
+            version_name?: string;
+            battery_level?: number;
+            device_brand?: string;
+            device_os?: string;
+            device_os_version?: string;
+            device_model?: string;
+            identifier?: number;
+            device_id?: string;
+            device_unique_id?: string;
+            network_state?: number;
+            time_zone?: string;
+            job_start_time?: number;
+            job_end_time?: number;
+            job_duration?: number;
+            form_id: StringId;
+            results: DivisionResult[];
+            score?: number;
+            is_completed: boolean;
+            company_namespace: string[];
+            createdAt: Date;
+            updatedAt: Date;
+        }
+        export interface CreateBody {
+            creator: AdminOrRepOrTenantOrClient;
+            serial_number?: SerialNumber;
+            teams?: StringId[];
+            tags?: StringId[];
+            time?: number;
+            client?: StringId;
+            client_name?: string;
+            visit?: StringId;
+            visit_id?: string;
+            route?: StringId;
+            workorder?: StringId;
+            sync_id: string;
+            geo_tag?: GeoTag;
+            geoPoint?: GeoPoint;
+            platform?: string;
+            version_name?: string;
+            battery_level?: number;
+            device_brand?: string;
+            device_os?: string;
+            device_os_version?: string;
+            device_model?: string;
+            identifier?: number;
+            device_id?: string;
+            device_unique_id?: string;
+            network_state?: number;
+            time_zone?: string;
+            job_start_time?: number;
+            job_end_time?: number;
+            job_duration?: number;
+            form_id: StringId;
+            results: DivisionResult[];
+            score?: number;
+            is_completed?: boolean;
+            company_namespace?: string[];
+        }
+        export type UpdateBody = Partial<Data>;
+        export type PopulatedDoc = Data & {
+            presentation_populated?: CLMPresentation.Data;
+            sequence_populated?: Pick<CLMSequence.Data, "position" | "_id" | "product" | "presentation">[];
+            photo_media_populated?: PopulatedMediaStorage & {
+                ContentLength?: number;
+            };
+        };
+        type PopulatedKeys = "custom_list" | "client" | "workorder" | "visit" | "route" | "form_id" | "teams" | "tags" | "media";
+        export namespace Find {
+            type Params = DefaultPaginationQueryParams & {
+                populatedKeys?: PopulatedKeys | PopulatedKeys[];
+                _id?: StringId | StringId[];
+                search?: string;
+                from_time?: number;
+                to_time?: number;
+                client?: StringId | StringId[];
+                tags?: StringId | StringId[];
+                CLIENT_TAGS?: StringId | StringId[];
+                AREA_TAGS?: StringId | StringId[];
+                form_id?: StringId | StringId[];
+                teams?: StringId | StringId[];
+                route?: StringId | StringId[];
+                is_completed?: boolean;
+                from_score?: number;
+                to_score?: number;
+                score?: number | number[];
+                "creator._id"?: StringId | StringId[];
+                "creator.type"?: Data["creator"]["type"] | Data["creator"]["type"][];
+                visit_id?: string | string[];
+                visit?: StringId | StringId[];
+                workorder?: StringId | StringId[];
+                "serial_number.formatted"?: string | string[];
+            };
+            interface Result extends DefaultPaginationResult {
+                data: PopulatedDoc[];
+            }
+        }
+        export namespace Get {
+            type ID = string;
+            type Params = {
+                populatedKeys?: PopulatedKeys[];
+            };
+            type Result = PopulatedDoc & {
+                can_edit_types?: boolean;
+            };
+        }
+        export namespace Create {
+            type Body = CreateBody;
+            type Result = Data;
+        }
+        export namespace Update {
+            type ID = StringId;
+            type Body = UpdateBody;
+            type Result = Data;
+        }
+        export {};
+    }
 }
 export type StringId = string;
 export type NameSpaces = string[];