@agendize/js-agendize-api 1.28.0

package/dist/data/PrivacyPolicy.d.ts

@@ -0,0 +1,43 @@
+export declare class PrivacyPolicyEntity {
+    id?: string;
+    privateData: {
+        consentMode: string;
+        consentText?: ConsentTextEntity;
+    };
+    marketing: {
+        consentMode: string;
+        consentText?: ConsentTextEntity;
+    };
+    static fromPrivacyPolicyDto(dto: PrivacyPolicyDto, ownerId: string): PrivacyPolicyEntity;
+}
+export declare class ConsentTextEntity {
+    EN?: string;
+    FR?: string;
+    ES?: string;
+    DE?: string;
+    IT?: string;
+    PT?: string;
+    NL?: string;
+    JP?: string;
+    static fromConsentTextDto(dto: ConsentTextDto): ConsentTextEntity;
+}
+export declare class PrivacyPolicyDto {
+    privateData: {
+        consentMode: string;
+        consentText?: ConsentTextDto;
+    };
+    marketing: {
+        consentMode: string;
+        consentText?: ConsentTextDto;
+    };
+}
+export declare class ConsentTextDto {
+    EN?: string;
+    FR?: string;
+    ES?: string;
+    DE?: string;
+    IT?: string;
+    PT?: string;
+    NL?: string;
+    JP?: string;
+}

package/dist/data/Queue.d.ts

@@ -0,0 +1,54 @@
+import { EntityType, PublicBodyEntity, SecuredBodyEntity, SecuredEntity } from "@/data/Common";
+import { FormBuilderPublicDto, FormBuilderPublicEntity, FormDtoOptionParser } from "@/data/Form";
+export type QueueEntity<Type = EntityType> = Type extends SecuredEntity ? QueueSecuredEntity : QueuePublicEntity;
+export declare class QueuePublicEntity extends PublicBodyEntity {
+    name: string;
+    welcomeMessage?: string;
+    thanksMessage?: string;
+    saveClient: boolean;
+    sendSms: boolean;
+    textSms?: string;
+    form?: FormBuilderPublicEntity;
+    static fromQueueDto(dto: QueuePublicDto, options?: FormDtoOptionParser): QueuePublicEntity;
+}
+export declare class QueuePublicDto {
+    name: string;
+    welcomeMessage?: string;
+    thanksMessage?: string;
+    saveClient: boolean;
+    sendSms: boolean;
+    textSms?: string;
+    form?: FormBuilderPublicDto;
+}
+export declare class QueueSecuredEntity extends SecuredBodyEntity {
+    id: string;
+    author: string;
+    name: string;
+    welcomeMessage: string;
+    thankMessage: string;
+    company: {
+        id: string;
+        name?: string;
+    };
+    form?: {
+        id: string;
+        name?: string;
+    };
+    static fromQueueDto(dto: QueueDto): QueueSecuredEntity;
+    static toQueueDto(entity: QueueSecuredEntity): QueueDto;
+}
+export declare class QueueDto {
+    id: string;
+    author: string;
+    name: string;
+    welcomeMessage: string;
+    thankMessage: string;
+    company?: {
+        id: string;
+        name?: string;
+    };
+    form?: {
+        id: string;
+        name?: string;
+    };
+}

package/dist/data/QueueRegistration.d.ts

@@ -0,0 +1,101 @@
+/**
+ * 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 { ContactEntity } from "./Contact";
+import { EntityType, PublicBodyEntity, SecuredBodyEntity, SecuredEntity } from "@/data/Common";
+import { FormItemDto, FormItemEntity } from "@/data/Form";
+export type QueueRegistrationEntity<Type = EntityType> = Type extends SecuredEntity ? QueueRegistrationSecuredEntity : QueueRegistrationPublicEntity;
+export type QueueRegistrationResultEntity<Type = EntityType> = Type extends SecuredEntity ? QueueRegistrationResultSecuredEntity : QueueRegistrationResultPublicEntity;
+export declare class QueueRegistrationPublicEntity extends PublicBodyEntity {
+    firstname: string;
+    lastname: string;
+    phone?: string;
+    formResult?: Array<FormItemEntity>;
+    dataConsent?: string;
+    marketingConsent?: string;
+    static toDto(entity: QueueRegistrationPublicEntity): QueueRegistrationPublicDto;
+}
+export declare class QueueRegistrationPublicDto {
+    firstname: string;
+    lastname: string;
+    phone?: string;
+    formResult?: Array<FormItemDto>;
+    dataConsent?: string;
+    marketingConsent?: string;
+}
+export declare class QueueRegistrationResultPublicEntity extends PublicBodyEntity {
+    id: string;
+    numInQueue: number;
+    nbPeopleAhead: number;
+    averageDurationTime: number;
+    static fromDto(dto: QueueRegistrationResultPublicDto): QueueRegistrationResultPublicEntity;
+}
+export declare class QueueRegistrationResultPublicDto {
+    id: string;
+    numInQueue: number;
+    nbPeopleAhead: number;
+    averageDurationTime: number;
+}
+export declare enum QueueRegistrationStatus {
+    REGISTERED = "registered",
+    NO_SHOW = "noShow",
+    IN_PROGRESS = "inProgress",
+    FINISHED = "finished"
+}
+export declare class QueueRegistrationSecuredEntity extends SecuredBodyEntity {
+    id?: string;
+    owner?: {
+        id?: string;
+        userName?: string;
+    };
+    client?: ContactEntity;
+    registeredDate?: Date;
+    status?: QueueRegistrationStatus | undefined;
+    rank?: number;
+    startedDate?: Date;
+    finishedDate?: Date;
+    static fromQueueRegistrationDto(dto: QueueRegistrationDto): QueueRegistrationSecuredEntity;
+    static toQueueRegistrationDto(entity: QueueRegistrationSecuredEntity): QueueRegistrationDto;
+}
+export declare class QueueRegistrationDto {
+    id?: string;
+    owner?: {
+        id?: string;
+        userName?: string;
+    };
+    client?: {
+        id?: string;
+        firstName?: string;
+        lastName?: string;
+        email?: string;
+        phone?: string;
+    };
+    registered?: {
+        dateTime: string;
+        timeZone?: string;
+    };
+    status?: QueueRegistrationStatus;
+    rank?: number;
+    started?: {
+        dateTime: string;
+        timeZone?: string;
+    };
+    finished?: {
+        dateTime: string;
+        timeZone?: string;
+    };
+}
+export declare class QueueRegistrationResultSecuredEntity extends SecuredBodyEntity {
+}

package/dist/data/Reporting.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 ReportsEntity {
+    id: string;
+    token: string;
+    dashboards?: ReportDashboardEntity[];
+    static fromDto(dto: ReportsDto): ReportsEntity;
+}
+export declare class ReportDashboardEntity {
+    id: string;
+    name?: string;
+    subTitle?: string;
+}
+export declare class ReportDashboardDto {
+    id: string;
+    name?: string;
+    subTitle?: string;
+}
+export declare class ReportsDto {
+    id: string;
+    token: string;
+    dashboards?: ReportDashboardDto[];
+}
+export declare class ReportDashboardFilter {
+    companies: string[];
+    staffs: string[];
+    dateMin?: string;
+    dateMax?: string;
+}

package/dist/data/ReportingExportBody.d.ts

@@ -0,0 +1,170 @@
+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;
+    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;
+    id?: boolean;
+}

package/dist/data/ReportingExportResponse.d.ts

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

package/dist/data/Rights.d.ts

@@ -0,0 +1,123 @@
+/**
+ * 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
+}
+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;
+    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;
+}
+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;
+}