@agendize/js-agendize-api 1.33.1 → 1.34.0

package/dist/data/ReportingExportBody.d.ts

@@ -0,0 +1,176 @@
+export declare class ReportingExportBodyEntity {
+    timeZone?: string;
+    fields?: ReportingExportBodyFieldsEntity;
+    filter?: ReportingExportBodyFilterEntity;
+    constructor();
+    static toReportingExportBodyDto(entity: ReportingExportBodyEntity): ReportingExportBodyDto;
+}
+export declare class ReportingExportBodyFilterEntity {
+    start?: Date;
+    end?: Date;
+    companyIds?: string[];
+    constructor();
+    static toReportingExportBodyFilterDto(entity: ReportingExportBodyFilterEntity): ReportingExportBodyFilterDto;
+}
+export declare class ReportingExportBodyFieldsEntity {
+    company?: ReportingExportBodyFieldCompanyEntity;
+    service?: ReportingExportBodyFieldServiceEntity;
+    staff?: ReportingExportBodyFieldStaffEntity;
+    client?: ReportingExportBodyFieldClientEntity;
+    appointment?: ReportingExportBodyFieldAppointmentEntity;
+    constructor();
+    static toReportingExportBodyFieldsDto(entity: ReportingExportBodyFieldsEntity): ReportingExportBodyFieldsDto;
+}
+export declare class ReportingExportBodyFieldCompanyEntity {
+    name?: boolean;
+    address?: ReportingExportBodyFieldCompanyAddressEntity;
+    email?: boolean;
+    phone?: boolean;
+    latitude?: boolean;
+    longitude?: boolean;
+    externalId?: boolean;
+    id?: boolean;
+    constructor();
+    static toReportingExportBodyFieldCompanyDto(entity: ReportingExportBodyFieldCompanyEntity): ReportingExportBodyFieldCompanyDto;
+}
+export declare class ReportingExportBodyFieldCompanyAddressEntity {
+    street?: boolean;
+    additionalStreet?: boolean;
+    zipCode?: boolean;
+    city?: boolean;
+    country?: boolean;
+    state?: boolean;
+    constructor();
+    static toReportingExportBodyFieldCompanyAddressDto(entity: ReportingExportBodyFieldCompanyAddressEntity): ReportingExportBodyFieldCompanyAddressDto;
+}
+export declare class ReportingExportBodyFieldServiceEntity {
+    name?: boolean;
+    duration?: boolean;
+    capacity?: boolean;
+    price?: boolean;
+    categoryLevel1Name?: boolean;
+    categoryLevel2Name?: boolean;
+    externalId?: boolean;
+    id?: boolean;
+    categoryLevel1ExternalId?: boolean;
+    categoryLevel1Id?: boolean;
+    categoryLevel2ExternalId?: boolean;
+    categoryLevel2Id?: boolean;
+    constructor();
+    static toReportingExportBodyFieldServiceDto(entity: ReportingExportBodyFieldServiceEntity): ReportingExportBodyFieldServiceDto;
+}
+export declare class ReportingExportBodyFieldStaffEntity {
+    firstName?: boolean;
+    lastName?: boolean;
+    email?: boolean;
+    phone?: boolean;
+    groupName?: boolean;
+    externalId?: boolean;
+    id?: boolean;
+    groupExternalId?: boolean;
+    groupId?: boolean;
+    constructor();
+    static toReportingExportBodyFieldStaffDto(entity: ReportingExportBodyFieldStaffEntity): ReportingExportBodyFieldStaffDto;
+}
+export declare class ReportingExportBodyFieldClientEntity {
+    firstName?: boolean;
+    lastName?: boolean;
+    email?: boolean;
+    phone?: boolean;
+    id?: boolean;
+    constructor();
+    static toReportingExportBodyFieldClientDto(entity: ReportingExportBodyFieldClientEntity): ReportingExportBodyFieldClientDto;
+}
+export declare class ReportingExportBodyFieldAppointmentEntity {
+    start?: boolean;
+    end?: boolean;
+    location?: boolean;
+    status?: boolean;
+    notes?: boolean;
+    customFields?: boolean;
+    sourceInterface?: boolean;
+    source?: boolean;
+    creationDate?: boolean;
+    id?: boolean;
+    constructor();
+    static toReportingExportBodyFieldAppointmentDto(entity: ReportingExportBodyFieldAppointmentEntity): ReportingExportBodyFieldAppointmentDto;
+}
+export declare class ReportingExportBodyDto {
+    timeZone?: string;
+    fields?: ReportingExportBodyFieldsDto;
+    filter?: ReportingExportBodyFilterDto;
+}
+export declare class ReportingExportBodyFilterDto {
+    start?: string;
+    end?: string;
+    companyIds?: string[];
+}
+export declare class ReportingExportBodyFieldsDto {
+    company?: ReportingExportBodyFieldCompanyDto;
+    service?: ReportingExportBodyFieldServiceDto;
+    staff?: ReportingExportBodyFieldStaffDto;
+    client?: ReportingExportBodyFieldClientDto;
+    appointment?: ReportingExportBodyFieldAppointmentDto;
+}
+export declare class ReportingExportBodyFieldCompanyDto {
+    name?: boolean;
+    address?: ReportingExportBodyFieldCompanyAddressDto;
+    email?: boolean;
+    phone?: boolean;
+    latitude?: boolean;
+    longitude?: boolean;
+    externalId?: boolean;
+    id?: boolean;
+}
+export declare class ReportingExportBodyFieldCompanyAddressDto {
+    street?: boolean;
+    additionalStreet?: boolean;
+    zipCode?: boolean;
+    city?: boolean;
+    country?: boolean;
+    state?: boolean;
+}
+export declare class ReportingExportBodyFieldServiceDto {
+    name?: boolean;
+    duration?: boolean;
+    capacity?: boolean;
+    price?: boolean;
+    categoryLevel1Name?: boolean;
+    categoryLevel2Name?: boolean;
+    externalId?: boolean;
+    id?: boolean;
+    categoryLevel1ExternalId?: boolean;
+    categoryLevel1Id?: boolean;
+    categoryLevel2ExternalId?: boolean;
+    categoryLevel2Id?: boolean;
+}
+export declare class ReportingExportBodyFieldStaffDto {
+    firstName?: boolean;
+    lastName?: boolean;
+    email?: boolean;
+    phone?: boolean;
+    groupName?: boolean;
+    externalId?: boolean;
+    id?: boolean;
+    groupExternalId?: boolean;
+    groupId?: boolean;
+}
+export declare class ReportingExportBodyFieldClientDto {
+    firstName?: boolean;
+    lastName?: boolean;
+    email?: boolean;
+    phone?: boolean;
+    id?: boolean;
+}
+export declare class ReportingExportBodyFieldAppointmentDto {
+    start?: boolean;
+    end?: boolean;
+    location?: boolean;
+    status?: boolean;
+    notes?: boolean;
+    customFields?: boolean;
+    sourceInterface?: boolean;
+    source?: boolean;
+    creationDate?: boolean;
+    id?: boolean;
+}

package/dist/data/ReportingExportResponse.d.ts

@@ -0,0 +1,20 @@
+export declare enum ExportStatus {
+    REQUESTED = "requested",
+    IN_PROGRESS = "inProgress",
+    FINISHED = "finished",
+    FAILED = "failed"
+}
+export declare class ReportingExportResponseEntity {
+    id?: string;
+    status?: ExportStatus;
+    requested?: Date;
+    static fromReportingDto(dto: ReportingExportResponseDto): ReportingExportResponseEntity;
+}
+export declare class ReportingExportResponseDto {
+    id?: string;
+    status?: ExportStatus;
+    requested?: {
+        dateTime: string;
+        timeZone: string;
+    };
+}

package/dist/data/Rights.d.ts

@@ -0,0 +1,140 @@
+/**
+ * Copyright 2022 Agendize All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at.
+ *
+ *      Http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare enum GlobalRight {
+    owner = 0,
+    accountAdministrator = 1,
+    accountAnalytics = 2,
+    chatAdministrator = 3,
+    chatOperator = 4,
+    schedulingAdministrator = 5,
+    schedulingStaff = 6,
+    testimonialsAdministrator = 7,
+    testimonialsModeration = 8,
+    accountBilling = 9,
+    accountButtons = 10,
+    accountEmails = 11,
+    accountCalls = 12,
+    accountForms = 13,
+    accountCRM = 14,
+    accountSchedulingAdministrator = 15,
+    accountSchedulingSchedule = 16,
+    accountSchedulingRead = 17,
+    queue = 18,
+    schedulingRead = 19,
+    accountDataOfficer = 20,
+    accountWorkflows = 21,
+    accountWorkingPlanning = 22,
+    schedulingTeamManager = 23,
+    accountConferenceAdministrator = 24,
+    schedulingNone = 25,
+    accountConferenceSchedule = 26,
+    accountConferenceRead = 27,
+    conferenceAdministrator = 28,
+    conferenceSchedule = 29,
+    conferenceRead = 30
+}
+export declare class RightsEntity {
+    id: string;
+    object?: RightObject;
+    scheduling?: SchedulingRight;
+    settings?: SettingsRight;
+    report?: ReportRight;
+    queue?: QueueRight;
+    form?: FormRight;
+    client?: ClientRight;
+    workflow?: WorkflowRight;
+    workingPlanning?: WorkingPlanningRight;
+    planning?: PlanningRight;
+    conference?: ConferenceRight;
+    dashboard?: DashboardRight;
+    whiteLabel?: WhiteLabelRight;
+    static fromRightsDto(dto: RightsDto): RightsEntity;
+}
+export interface RightObject {
+    type: 'company';
+    id: string;
+}
+export interface SchedulingRight {
+    appointment: string;
+    staffAppointment: string;
+}
+export interface SettingsRight {
+    company: string;
+    service: string;
+    staff: string;
+    resource: string;
+    staffCustomPeriod: string;
+    process: string;
+    widget: string;
+    notifications: string;
+    payments: string;
+    messages: string;
+    calendars: string;
+    crm: string;
+}
+export interface ReportRight {
+    report: string;
+}
+export interface QueueRight {
+    queue: string;
+}
+export interface FormRight {
+    form: string;
+}
+export interface ClientRight {
+    client: string;
+}
+export interface WorkflowRight {
+    workflow: string;
+}
+export interface WorkingPlanningRight {
+    workingPlanning: string;
+}
+export interface PlanningRight {
+    planning: string;
+}
+export interface ConferenceRight {
+    conference: string;
+    forms: string;
+    registrations: string;
+    sessions: string;
+    speakers: string;
+    tags: string;
+}
+export interface DashboardRight {
+    dashboard: string;
+}
+export interface WhiteLabelRight {
+    name: string;
+    logo: string;
+    favicon: string;
+}
+export declare class RightsDto {
+    id: string;
+    object?: RightObject;
+    scheduling?: SchedulingRight;
+    settings?: SettingsRight;
+    report?: ReportRight;
+    queue?: QueueRight;
+    form?: FormRight;
+    client?: ClientRight;
+    workflow?: WorkflowRight;
+    workingPlanning?: WorkingPlanningRight;
+    planning?: PlanningRight;
+    conference?: ConferenceRight;
+    whiteLabel?: WhiteLabelRight;
+    dashboard?: DashboardRight;
+}

package/dist/data/Service.d.ts

@@ -0,0 +1,224 @@
+/**
+ * Copyright 2022 Agendize All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at.
+ *
+ *      Http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ImageEntity } from "./Image";
+import { SettingsPeriodWorkingDto, SettingsPeriodWorkingEntity, SettingsWorkingDayDto, SettingsWorkingDayEntity } from "./WorkingHours";
+import { EntityType, PublicBodyEntity, SecuredBodyEntity, SecuredEntity } from "@/data/Common";
+import { ServiceGroupPublicDto, ServiceGroupPublicEntity } from "@/data/ServiceGroup";
+export type ServiceEntity<Type = EntityType> = Type extends SecuredEntity ? ServiceSecuredEntity : ServicePublicEntity;
+export type ServicesListEntity<Type = EntityType> = Type extends SecuredEntity ? ServicesListSecuredEntity : ServicesListPublicEntity;
+export type LocationType = "companyAddress" | "videoconference" | "phone" | "custom";
+export type LocationValue = {
+    type: LocationType;
+    value: string;
+};
+export declare class ServicePublicEntity extends PublicBodyEntity {
+    id: string;
+    name: string;
+    description?: string;
+    payable?: boolean;
+    price?: number;
+    picture?: ImageEntity;
+    readableDuration?: string;
+    duration?: number;
+    locations: LocationType[];
+    locationCustom?: string;
+    minAppointmentDate?: Date;
+    maxAppointmentDate?: Date;
+    staffs?: string[];
+    maxCancellationDelay?: number;
+    externalId?: string;
+    extendedProperties?: Map<string, any>;
+    static fromDto(dto: ServicePublicDto): ServicePublicEntity;
+}
+export declare class ServicesListPublicEntity extends PublicBodyEntity {
+    services?: ServicePublicEntity[];
+    groups?: ServiceGroupPublicEntity[];
+    static fromDto(dto: ServicesListPublicDto): ServicesListPublicEntity;
+}
+export declare class ServicePublicDto {
+    id: string;
+    name: string;
+    description?: string;
+    payable?: boolean;
+    price?: number;
+    picture?: ImageEntity;
+    readableDuration?: string;
+    duration?: number;
+    maxCancellationDelay?: number;
+    minAppointment?: string;
+    maxAppointment?: string;
+    locations: LocationType[];
+    locationCustom?: string;
+    staffs?: string[];
+    externalId?: string;
+    extendedProperties?: Map<string, any>;
+}
+export declare class ServicesListPublicDto {
+    services?: ServicePublicDto[];
+    groups?: ServiceGroupPublicDto[];
+}
+export declare enum ServiceTypeEntity {
+    DEFAULT = "default",
+    EVENT = "event"
+}
+export declare class ServiceSecuredEntity extends SecuredBodyEntity {
+    id?: string;
+    cipherId?: string;
+    company?: {
+        id: string;
+        name?: string;
+    };
+    name: string;
+    description?: string;
+    capacity: number;
+    price?: number;
+    bufferDuration?: number;
+    preparationDuration?: number;
+    validation?: 'location' | 'staff' | 'manager' | 'auto';
+    externalId?: string;
+    duration: number;
+    locations: LocationType[];
+    locationCustom?: string;
+    picture?: ImageEntity;
+    staffsSkill?: string[];
+    color?: string;
+    checkFilterColor?: string;
+    type?: ServiceTypeEntity;
+    availability?: 'public' | 'backoffice' | 'hidden' | 'disabled';
+    minAppointmentDate?: string;
+    maxAppointmentDate?: string;
+    appointmentDateScope?: string;
+    i18n?: {
+        fr?: {
+            name?: string;
+            description?: string;
+        };
+        en?: {
+            name?: string;
+            description?: string;
+        };
+        de?: {
+            name?: string;
+            description?: string;
+        };
+        pt?: {
+            name?: string;
+            description?: string;
+        };
+        es?: {
+            name?: string;
+            description?: string;
+        };
+        nl?: {
+            name?: string;
+            description?: string;
+        };
+        jp?: {
+            name?: string;
+            description?: string;
+        };
+        it?: {
+            name?: string;
+            description?: string;
+        };
+    };
+    resources?: {
+        id: string;
+        name?: string;
+        quantity?: number;
+    }[];
+    maxCancellationDelay?: number;
+    useWorkingHours: boolean;
+    workingHours: SettingsWorkingDayEntity[];
+    customWorkingHours: SettingsPeriodWorkingEntity[];
+    constructor();
+    static fromServiceDto(dto: ServiceSecuredDto): ServiceSecuredEntity;
+    static toServiceDto(entity: ServiceSecuredEntity, lang?: string): ServiceSecuredDto;
+}
+export declare class ServiceSecuredDto {
+    id?: string;
+    cipherId?: string;
+    company?: {
+        id: string;
+        name?: string;
+    };
+    name: string;
+    duration: number;
+    locations: LocationType[];
+    locationCustom?: string;
+    picture?: ImageEntity;
+    description?: string;
+    capacity: number;
+    price?: number;
+    bufferDuration?: number;
+    preparationDuration?: number;
+    validation?: 'location' | 'staff' | 'manager' | 'auto';
+    externalId?: string;
+    staff?: {
+        id: string;
+    }[];
+    color?: string;
+    availability?: 'public' | 'backoffice' | 'hidden' | 'disabled';
+    resource?: {
+        id: string;
+        name?: string;
+        quantity?: number;
+    }[];
+    bypassFreeBusyAvailabilities?: boolean;
+    minAppointmentDate?: string;
+    maxAppointmentDate?: string;
+    appointmentDateScope?: string;
+    i18n?: {
+        fr?: {
+            name?: string;
+            description?: string;
+        };
+        en?: {
+            name?: string;
+            description?: string;
+        };
+        de?: {
+            name?: string;
+            description?: string;
+        };
+        pt?: {
+            name?: string;
+            description?: string;
+        };
+        es?: {
+            name?: string;
+            description?: string;
+        };
+        nl?: {
+            name?: string;
+            description?: string;
+        };
+        jp?: {
+            name?: string;
+            description?: string;
+        };
+        it?: {
+            name?: string;
+            description?: string;
+        };
+    };
+    maxCancellationDelay?: number;
+    useWorkingHours?: boolean;
+    workingHours?: SettingsWorkingDayDto[];
+    customWorkingHours?: SettingsPeriodWorkingDto[];
+}
+export declare class ServicesListSecuredEntity extends Array<ServiceSecuredEntity> {
+}

package/dist/data/ServiceGroup.d.ts

@@ -0,0 +1,57 @@
+import { ImageEntity } from "./Image";
+import { EntityType, SecuredEntity } from "@/data/Common";
+export type ServiceGroupEntity<Type = EntityType> = Type extends SecuredEntity ? ServiceGroupSecuredEntity : ServiceGroupPublicEntity;
+export declare class ServiceGroupPublicEntity {
+    members?: {
+        id: string;
+    }[];
+    name: string;
+    id: string;
+    picture?: ImageEntity;
+    parent?: string;
+    static fromDto(dto: ServiceGroupPublicDto): ServiceGroupPublicEntity;
+}
+export declare class ServiceGroupPublicDto {
+    members?: {
+        id: string;
+    }[];
+    name: string;
+    id: string;
+    picture?: ImageEntity;
+    parent?: string;
+}
+export declare class ServiceGroupSecuredEntity {
+    id?: string;
+    name: string;
+    color: string;
+    picture?: ImageEntity;
+    members?: {
+        id: string;
+        name: string;
+    }[];
+    parent?: {
+        id?: string;
+        name?: string;
+    };
+    externalId?: string;
+    companyId: string;
+    cipherId?: string;
+    static fromServiceGroupDto(dto: ServiceGroupSecuredDto, companyId: string): ServiceGroupSecuredEntity;
+    static toServiceGroupDto(entity: ServiceGroupSecuredEntity): ServiceGroupSecuredDto;
+}
+export declare class ServiceGroupSecuredDto {
+    id?: string;
+    name: string;
+    color: string;
+    picture?: ImageEntity;
+    members?: {
+        id: string;
+        name: string;
+    }[];
+    parent?: {
+        id?: string;
+        name?: string;
+    };
+    externalId?: string;
+    cipherId?: string;
+}

package/dist/data/ServiceResource.d.ts

@@ -0,0 +1,26 @@
+import { SettingsPeriodWorkingDto, SettingsPeriodWorkingEntity } from "./WorkingHours";
+export declare class ServiceResourceEntity {
+    id?: string;
+    company: {
+        id: string;
+    };
+    name: string;
+    quantity: number;
+    availability: boolean;
+    services?: {
+        id: string;
+    }[];
+    customWorkingHours?: SettingsPeriodWorkingEntity[];
+    static fromServiceResourceDto(dto: ServiceResourceDto, companyId: string): ServiceResourceEntity;
+    static toServiceResourceDto(entity: ServiceResourceEntity): ServiceResourceDto;
+}
+export declare class ServiceResourceDto {
+    id?: string;
+    name: string;
+    quantity: number;
+    availability: boolean;
+    services?: {
+        id: string;
+    }[];
+    customWorkingHours?: SettingsPeriodWorkingDto[];
+}

package/dist/data/Settings.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Copyright 2022 Agendize All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at.
+ *
+ *      Http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare class SettingsEntity {
+    private id?;
+    calendar: {
+        useMandatoryFieldsForFreeMode: boolean;
+    };
+    internalAppointmentTitles?: string[];
+    static fromSettingsDto(organisation: string, dto: SettingsDto): SettingsEntity;
+}
+export declare class SettingsDto {
+    calendar: {
+        useMandatoryFieldsForFreeMode: boolean;
+    };
+    internalAppointmentTitles?: string[];
+}

package/dist/data/ShortPollingNotification.d.ts

@@ -0,0 +1,35 @@
+import { ShortPollingNotificationObject, ShortPollingNotificationObjectDb } from "./shortPollingNotification/ShortPollingNotificationObject";
+import { ShortPollingNotificationScope } from "@/service/secured/shortPollingNotificationSecuredService";
+export type ShortPollingNotificationType = 'event' | 'report';
+export type ShortPollingNotificationSubType = 'new' | 'update' | 'delete' | 'accept' | 'decline' | 'fail';
+export declare class ShortPollingNotificationEntity {
+    id: string;
+    type: ShortPollingNotificationType;
+    subType: ShortPollingNotificationSubType;
+    notificationObject?: ShortPollingNotificationObject;
+    date: Date;
+    static fromNotificationDto(dto: ShortPollingNotificationDto, messageOutputType?: ShortPollingNotificationSubType): ShortPollingNotificationEntity;
+}
+export declare class ShortPollingNotificationPingEntity {
+    pingScopes?: ShortPollingNotificationScope[];
+    nextSyncToken: number;
+    static fromDto(dto: ShortPollingNotificationPingDto): ShortPollingNotificationPingEntity;
+}
+export declare class ShortPollingNotificationDto {
+    type: ShortPollingNotificationType;
+    notificationObject: ShortPollingNotificationObjectDb;
+    status?: ShortPollingNotificationSubType;
+    date?: {
+        "dateTime": string;
+        "timeZone": string;
+    };
+}
+export declare class ShortPollingNotificationContainerDto {
+    items: ShortPollingNotificationDto[];
+    totalItems: number;
+    nextSyncToken: number;
+}
+export declare class ShortPollingNotificationPingDto {
+    pingScopes?: ShortPollingNotificationScope[];
+    nextSyncToken: number;
+}