@agendize/js-agendize-api 1.28.0

package/dist/data/Service.d.ts

@@ -0,0 +1,213 @@
+/**
+ * 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 declare class ServicePublicEntity extends PublicBodyEntity {
+    id: string;
+    name: string;
+    description?: string;
+    payable?: boolean;
+    price?: number;
+    picture?: ImageEntity;
+    readableDuration?: string;
+    duration?: number;
+    locations: ('companyAddress' | 'videoconference' | 'phone' | 'custom')[];
+    locationCustom?: string;
+    staffs?: string[];
+    maxCancellationDelay?: number;
+    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;
+    locations: ('companyAddress' | 'videoconference' | 'phone' | 'custom')[];
+    locationCustom?: string;
+    staffs?: 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: ('companyAddress' | 'videoconference' | 'phone' | 'custom')[];
+    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): ServiceSecuredDto;
+}
+export declare class ServiceSecuredDto {
+    id?: string;
+    cipherId?: string;
+    company?: {
+        id: string;
+        name?: string;
+    };
+    name: string;
+    duration: number;
+    locations: ('companyAddress' | 'videoconference' | 'phone' | 'custom')[];
+    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,12 @@
+export declare class SettingsEntity {
+    private id?;
+    calendar: {
+        useMandatoryFieldsForFreeMode: boolean;
+    };
+    static fromSettingsDto(organisation: string, dto: SettingsDto): SettingsEntity;
+}
+export declare class SettingsDto {
+    calendar: {
+        useMandatoryFieldsForFreeMode: boolean;
+    };
+}

package/dist/data/ShortPollingNotification.d.ts

@@ -0,0 +1,25 @@
+import { ShortPollingNotificationObject, ShortPollingNotificationObjectDb } from "./shortPollingNotification/ShortPollingNotificationObject";
+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 ShortPollingNotificationDto {
+    type: ShortPollingNotificationType;
+    notificationObject: ShortPollingNotificationObjectDb;
+    status?: ShortPollingNotificationSubType;
+    date?: {
+        "dateTime": string;
+        "timeZone": string;
+    };
+}
+export declare class ShortPollingNotificationContainerDto {
+    items: ShortPollingNotificationDto[];
+    totalItems: number;
+    nextSyncToken: number;
+}

package/dist/data/Shortener.d.ts

@@ -0,0 +1,8 @@
+export declare class ShortenerEntity {
+    url: string;
+    static fromShortenerDto(dto: ShortenerDto): ShortenerEntity;
+}
+export declare class ShortenerDto {
+    shortAddress: string;
+    longAddress: string;
+}

package/dist/data/Staff.d.ts

@@ -0,0 +1,115 @@
+/**
+ * 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 { FormItemEntity } from "./Form";
+import { EntityType, PublicBodyEntity, SecuredBodyEntity, SecuredEntity } from "@/data/Common";
+export type StaffEntity<Type = EntityType> = Type extends SecuredEntity ? StaffSecuredEntity : StaffPublicEntity;
+export declare class StaffPublicEntity extends PublicBodyEntity {
+    id: string;
+    name: string;
+    firstName?: string;
+    lastName?: string;
+    picture?: ImageEntity;
+    extendedProperties?: Map<string, any>;
+    static fromDto(dto: StaffPublicDto): StaffPublicEntity;
+}
+export declare class StaffPublicDto {
+    id: string;
+    name: string;
+    firstName?: string;
+    lastName?: string;
+    picture?: ImageEntity;
+    extendedProperties?: Map<string, any>;
+}
+export declare class StaffSecuredEntity extends SecuredBodyEntity {
+    id?: string;
+    cipherId?: string;
+    userId?: string;
+    company?: {
+        id: string;
+        name?: string;
+    };
+    firstName?: string;
+    lastName?: string;
+    gender?: string;
+    title?: string;
+    email?: string;
+    phone?: string;
+    otherPhone?: string;
+    description?: string;
+    vacations?: {
+        startDate?: Date;
+        endDate?: Date;
+    }[];
+    role?: string;
+    workingHours?: SettingsWorkingDayEntity[];
+    customWorkingHours?: SettingsPeriodWorkingEntity[];
+    picture?: ImageEntity;
+    servicesSkill?: string[];
+    color?: string;
+    availableForWidget: boolean;
+    externalId?: string;
+    additionalFields?: FormItemEntity[];
+    externalCalendars?: {
+        url: string;
+    }[];
+    calendarLink?: {
+        mineType: string;
+        url: string;
+    };
+    fullName(): string;
+    static fromStaffDto(dto: StaffSecuredDto): StaffSecuredEntity;
+    static toStaffDto(entity: StaffSecuredEntity): StaffSecuredDto;
+}
+export declare class StaffSecuredDto {
+    id?: string;
+    cipherId?: string;
+    company?: {
+        id: string;
+        name?: string;
+    };
+    firstName?: string;
+    lastName?: string;
+    gender?: string;
+    title?: string;
+    email?: string;
+    phone?: string;
+    otherPhone?: string;
+    description?: string;
+    vacations?: {
+        startDate?: string;
+        endDate?: string;
+    }[];
+    role?: string;
+    workingHours?: SettingsWorkingDayDto[];
+    customWorkingHours?: SettingsPeriodWorkingDto[];
+    picture?: ImageEntity;
+    services?: {
+        id: string;
+    }[];
+    color?: string;
+    availableForWidget: boolean;
+    externalId?: string;
+    additionalFields?: FormItemEntity[];
+    externalCalendars?: {
+        url: string;
+    }[];
+    calendarLink?: {
+        mineType: string;
+        url: string;
+    };
+}

package/dist/data/StaffForms.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.
+ */
+import { FormItemEntity } from "./Form";
+export declare class StaffFormsEntity {
+    id: string;
+    mobilePhoneMandatory: boolean;
+    otherPhoneMandatory: boolean;
+    emailMandatory: boolean;
+    descriptionMandatory: boolean;
+    lastnameMandatory: boolean;
+    titleMandatory: boolean;
+    firstnameMandatory: boolean;
+    genderMandatory: boolean;
+    title?: string;
+    fields?: FormItemEntity[];
+    static fromStaffFormsDto(dto: StaffFormsDto, account: string): StaffFormsEntity;
+}
+export declare class StaffFormsDto {
+    'mobilePhone-mandatory': boolean;
+    'otherPhone-mandatory': boolean;
+    'email-mandatory': boolean;
+    'description-mandatory': boolean;
+    'lastname-mandatory': boolean;
+    'title-mandatory': boolean;
+    'firstname-mandatory': boolean;
+    'gender-mandatory': boolean;
+    title?: string;
+    fields?: FormItemEntity[];
+}

package/dist/data/StaffGroup.d.ts

@@ -0,0 +1,58 @@
+import { SettingsWorkingDayDto, SettingsWorkingDayEntity } from "./WorkingHours";
+import { EntityType, SecuredEntity } from "@/data/Common";
+export type StaffGroupEntity<Type = EntityType> = Type extends SecuredEntity ? StaffGroupSecuredEntity : StaffGroupPublicEntity;
+export declare class StaffGroupPublicEntity {
+    id: string;
+    name: string;
+    members: {
+        id: string;
+    }[];
+    constructor();
+    static fromDto(dto: StaffGroupPublicDto): StaffGroupPublicEntity;
+}
+export declare class StaffGroupPublicDto {
+    id?: string;
+    name?: string;
+    members?: {
+        id: string;
+    }[];
+}
+export declare class StaffGroupSecuredEntity {
+    id?: string;
+    name: string;
+    color: string;
+    members?: {
+        id: string;
+        firstName: string;
+        lastName: string;
+    }[];
+    managers?: {
+        id: string;
+        firstName: string;
+        lastName: string;
+    }[];
+    workingHours?: SettingsWorkingDayEntity[];
+    externalId?: string;
+    companyId: string;
+    cipherId?: string;
+    static fromStaffGroupDto(dto: StaffGroupSecuredDto, companyId: string): StaffGroupSecuredEntity;
+    static toStaffGroupDto(entity: StaffGroupSecuredEntity): StaffGroupSecuredDto;
+}
+export declare class StaffGroupSecuredDto {
+    id?: string;
+    name: string;
+    color: string;
+    members?: {
+        id: string;
+        firstName: string;
+        lastName: string;
+    }[];
+    managers?: {
+        id: string;
+        firstName: string;
+        lastName: string;
+    }[];
+    workingHours?: SettingsWorkingDayDto[];
+    externalId?: string;
+    cipherId?: string;
+}

package/dist/data/User.d.ts

@@ -0,0 +1,84 @@
+/**
+ * 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 { GlobalRight } from "./Rights";
+export declare class UserEntity {
+    id?: string;
+    firstName?: string;
+    lastName?: string;
+    picture?: ImageEntity;
+    anonymous: boolean;
+    color?: string;
+    login?: string;
+    checkFilterColor?: string;
+    companies?: {
+        companyId?: string;
+        companyName?: string;
+        staffIds?: string[];
+        role?: string;
+        rights?: GlobalRight[];
+    }[];
+    staffIds?: string[];
+    accounts?: {
+        id?: string;
+        email?: string;
+        name?: string;
+    }[];
+    static fromUserDto(dto: UserDto | UserLightDto): UserEntity;
+    static fromUserLightDto(dto: UserLightDto): UserEntity;
+}
+export declare class UserDto {
+    id?: string;
+    firstName: string;
+    lastName: string;
+    picture?: ImageEntity;
+    login?: string;
+    companies?: [
+        {
+            companyId?: string;
+            companyName?: string;
+            staffIds?: string[];
+            role?: string;
+            rights?: GlobalRight[];
+        }
+    ];
+    accounts?: [
+        {
+            id?: string;
+            email?: string;
+            name?: string;
+        }
+    ];
+}
+export declare class UserLightDto {
+    i?: string;
+    f: string;
+    l: string;
+    p?: {
+        u: string;
+        m: string;
+    };
+    e?: string;
+    c?: [
+        {
+            i?: string;
+            n?: string;
+            s?: string[];
+            r?: string;
+            a?: GlobalRight[];
+        }
+    ];
+}

package/dist/data/WidgetUrlCipher.d.ts

@@ -0,0 +1,23 @@
+export declare class WidgetUrlCipherEntity {
+    cipherUrl: string;
+    shortenerUrl: string;
+    static fromWidgetUrlCipherDto(dto: WidgetUrlCipherDto): WidgetUrlCipherEntity;
+}
+export declare class WidgetUrlCipherDto {
+    cipherUrl: string;
+    shortenerUrl: string;
+}
+export declare class WidgetUrlCipherInputEntity {
+    url: string;
+    shortener: boolean;
+    numberOfAllowedAppointments?: number;
+    unencryptedParameters?: string;
+    constructor(url: string);
+    static toWidgetUrlCipherInputDto(entity: WidgetUrlCipherInputEntity): WidgetUrlCipherInputDto;
+}
+export declare class WidgetUrlCipherInputDto {
+    url: string;
+    shortener?: boolean;
+    numberOfAllowedAppointments?: number;
+    unencryptedParameters?: string;
+}