@agendize/js-agendize-api 1.28.0

package/dist/data/CRMSettings.d.ts

@@ -0,0 +1,35 @@
+import { AdditionalFieldsDto, AdditionalFieldsEntity } from "./Contact";
+export declare enum ContactMatchingType {
+    EMAIL = "emailAddress",
+    PHONE = "phoneNumber",
+    REF = "clientReference"
+}
+export declare class CRMSettingsEntity {
+    account: string;
+    additionalFields: AdditionalFieldsEntity;
+    contactPropertyMatching: ContactMatchingType;
+    locationFiltering: boolean;
+    locationAppointmentFiltering: boolean;
+    fieldColumns: String[];
+    sync: CRMSettingsSyncEntity;
+    constructor(account: string);
+    static fromCRMSettingsDTO(account: string, dto: CRMSettingsDTO): CRMSettingsEntity;
+}
+export declare class CRMSettingsSyncEntity {
+    clientLookup: boolean;
+    createNewClient: boolean;
+    constructor();
+    static fromCRMSettingsSyncDto(dto: CRMSettingsSyncDto): CRMSettingsSyncEntity;
+}
+export declare class CRMSettingsDTO {
+    additionalFields?: AdditionalFieldsDto;
+    contactPropertyMatching?: ContactMatchingType;
+    locationFiltering?: boolean;
+    locationAppointmentFiltering?: boolean;
+    fieldColumns?: String[];
+    sync?: CRMSettingsSyncDto;
+}
+export declare class CRMSettingsSyncDto {
+    clientLookup?: boolean;
+    createNewClient?: boolean;
+}

package/dist/data/Calendar.d.ts

@@ -0,0 +1,78 @@
+import { CalendarWorkingDayDto, CalendarWorkingDayEntity } from "./WorkingHours";
+import { CalendarsDto } from "@/service/secured/calendarSecuredService";
+/**
+ * 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 CalendarsEntity {
+    users: CalendarEntity[];
+    static fromDto(dto: CalendarsDto): CalendarsEntity;
+}
+export declare class CalendarEntity {
+    id?: string;
+    companies: CalendarCompanyEntity[];
+    anonymous: boolean;
+    static fromCalendarDto(dto: CalendarDto, timeZone: string, vacations: VacationDto[]): CalendarEntity;
+}
+export declare class CalendarCompanyEntity {
+    companyId: string;
+    staffId: string;
+    ics: string[];
+    workingHours: CalendarWorkingDayEntity[];
+    static fromCalendarCompanyDto(dto: CalendarCompanyDto, timeZone: string): CalendarCompanyEntity;
+}
+export declare class CalendarTeamEntity {
+    id: string;
+    name: string;
+    company: string;
+    managers?: string[];
+    members?: string[];
+    static fromDto(dto: CalendarTeamDto | CalendarTeamLightDto): CalendarTeamEntity;
+    static fromLightDto(dto: CalendarTeamLightDto): CalendarTeamEntity;
+}
+export declare class CalendarDto {
+    userId: string;
+    companies: CalendarCompanyDto[];
+}
+export declare class CalendarTeamDto {
+    id: string;
+    name: string;
+    company: string;
+    managers?: CalendarTeamManagerDto[];
+    members?: CalendarTeamMemberDto[];
+}
+export declare class CalendarTeamLightDto {
+    i: string;
+    n: string;
+    c: string;
+    m?: CalendarTeamManagerDto[];
+    g?: CalendarTeamMemberDto[];
+}
+export declare class CalendarTeamMemberDto {
+    id: string;
+}
+export declare class CalendarTeamManagerDto {
+    id: string;
+}
+export declare class CalendarCompanyDto {
+    companyId: string;
+    staffId: string;
+    ics: string[];
+    workingHours: CalendarWorkingDayDto[];
+}
+export declare class VacationDto {
+    ownerId: string;
+    start: number;
+    end: number;
+}

package/dist/data/Changelog.d.ts

@@ -0,0 +1,20 @@
+export declare class ChangeEntity {
+    fieldName: string;
+    oldValue: string;
+    newValue: string;
+}
+declare class ChangeDto {
+    fieldName: string;
+    oldValue: string;
+    newValue: string;
+}
+export declare class ChangelogEntity {
+    id: string;
+    changes: ChangeEntity[];
+    static fromChangelogDto(dto: ChangelogDto): ChangelogEntity;
+}
+export declare class ChangelogDto {
+    id: string;
+    changes: ChangeDto[];
+}
+export {};

package/dist/data/Common.d.ts

@@ -0,0 +1,15 @@
+declare type EntityType = PublicEntity | SecuredEntity;
+declare type PublicEntity = 'Public';
+declare type SecuredEntity = 'Secured';
+export type { EntityType, PublicEntity, SecuredEntity };
+declare class BodyEntity<EntityType> {
+    bodyEntityType: EntityType;
+    constructor(type: EntityType);
+}
+declare class PublicBodyEntity extends BodyEntity<PublicEntity> {
+    constructor();
+}
+declare class SecuredBodyEntity extends BodyEntity<SecuredEntity> {
+    constructor();
+}
+export { BodyEntity, PublicBodyEntity, SecuredBodyEntity };

package/dist/data/CommonEnum.d.ts

@@ -0,0 +1,44 @@
+import { ContactEntity } from "./Contact";
+export declare class CommonEnum {
+    static getEnumValues(enumValues: any): string[];
+}
+export declare enum Gender {
+    male = 0,
+    female = 1,
+    other = 2
+}
+export declare enum Title {
+    none = 0,
+    mr = 1,
+    mrs = 2,
+    dr = 3
+}
+export declare enum Language {
+    fr = 0,
+    en = 1,
+    es = 2,
+    de = 3,
+    it = 4,
+    jp = 5,
+    pt = 6,
+    nl = 7
+}
+export declare enum NotificationType {
+    all = 0,
+    email = 1,
+    sms = 2,
+    none = 3
+}
+export declare enum PromoteFieldKey {
+    MISC1 = 0,
+    MISC2 = 1,
+    MISC3 = 2,
+    MISC4 = 3,
+    MISC5 = 4,
+    MISC6 = 5,
+    MISC7 = 6,
+    MISC8 = 7,
+    MISC9 = 8,
+    MISC10 = 9
+}
+export declare function valuePromoteFieldFromContact(fieldKey: string, contact: ContactEntity): string;

package/dist/data/Company.d.ts

@@ -0,0 +1,157 @@
+/**
+ * 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 { AddressDto, AddressEntity, GeoLocationDto, GeoLocationEntity } from "./Address";
+import { SettingsWorkingDayDto, SettingsWorkingDayEntity } from "./WorkingHours";
+import { EntityType, PublicBodyEntity, SecuredBodyEntity, SecuredEntity } from "./Common";
+export type CompanyEntity<Type = EntityType> = Type extends SecuredEntity ? CompanySecuredEntity : CompanyPublicEntity;
+export declare enum CompanyContactMatchingType {
+    EMAIL = "SEARCH_BY_EMAIL",
+    PHONE = "SEARCH_BY_PHONE",
+    REF = "SEARCH_BY_REF"
+}
+export declare class CompanyPublicEntity extends PublicBodyEntity {
+    id?: string;
+    name: string;
+    picture?: ImageEntity;
+    address?: AddressEntity;
+    phone?: string;
+    email?: string;
+    description?: string;
+    instagramLink?: string;
+    twitterLink?: string;
+    facebookLink?: string;
+    linkedInLink?: string;
+    websiteLink?: string;
+    timeZone?: string;
+    currency?: {
+        iso?: string;
+        symbol?: string;
+    };
+    workingHours?: SettingsWorkingDayEntity[];
+    headerBackgroundColor?: string;
+    displayPrice?: boolean;
+    randomStaff?: boolean;
+    scheduledItems?: 'staff-service' | 'service-staff' | 'service' | string;
+    enableWhiteLabel?: boolean;
+    extendedProperties?: Map<string, any>;
+    accountId: string;
+    crmBindKey?: CompanyContactMatchingType | string;
+    toDto(): CompanyPublicDto;
+    static fromDto(dto: CompanyPublicDto): CompanyPublicEntity;
+}
+export declare class CompanyPublicDto {
+    id?: string;
+    name: string;
+    address?: AddressDto;
+    picture?: ImageEntity;
+    phone?: string;
+    email?: string;
+    description?: string;
+    currency?: {
+        iso?: string;
+        symbol?: string;
+    };
+    headerBackgroundColor?: string;
+    displayPrice?: boolean;
+    randomStaff?: boolean;
+    scheduledItems?: 'staff-service' | 'service-staff' | 'service' | string;
+    crmBindKey?: CompanyContactMatchingType | string;
+    socialMedias?: {
+        instagramLink?: string;
+        twitterLink?: string;
+        facebookPageLink?: string;
+        linkedInLink?: string;
+    };
+    websiteLink?: string;
+    timeZone?: string;
+    workingHours?: SettingsWorkingDayDto[];
+    extendedProperties?: Map<string, any>;
+    enableWhiteLabel?: boolean;
+    accountId: string;
+}
+export declare class CompanySecuredEntity extends SecuredBodyEntity {
+    id?: string;
+    name: string;
+    picture?: ImageEntity;
+    address?: AddressEntity;
+    geolocation?: GeoLocationEntity;
+    phone?: string;
+    email?: string;
+    description?: string;
+    instagramLink?: string;
+    twitterLink?: string;
+    facebookLink?: string;
+    linkedInLink?: string;
+    websiteLink?: string;
+    timeZone?: string;
+    currency?: string;
+    workingHours?: SettingsWorkingDayEntity[];
+    encryptedId?: string;
+    owner: {
+        id: string;
+        userName: string;
+    };
+    photo?: ImageEntity;
+    externalId?: string;
+    vacations?: {
+        endDate: Date;
+        startDate: Date;
+    }[];
+    externalCalendars?: {
+        address: string;
+        type: string;
+    }[];
+    pmrAccess?: boolean;
+    static toDto(entity: CompanySecuredEntity): CompanySecuredDto;
+}
+export declare class CompanySecuredDto {
+    id?: string;
+    encryptedId?: string;
+    owner: {
+        id: string;
+        userName: string;
+    };
+    name: string;
+    address?: AddressEntity;
+    geolocation?: GeoLocationDto;
+    photo?: ImageEntity;
+    picture?: ImageEntity;
+    phone?: string;
+    email?: string;
+    description?: string;
+    socialMedias?: {
+        instagramLink?: string;
+        twitteLink?: string;
+        facebookPageLink?: string;
+        linkedInLink?: string;
+    };
+    websiteLink?: string;
+    timeZone?: string;
+    externalId?: string;
+    currency?: string;
+    workingHours?: SettingsWorkingDayDto[];
+    vacations?: {
+        endDate: string;
+        startDate: string;
+    }[];
+    externalCalendars?: {
+        address: string;
+        type: string;
+    }[];
+    pmrAccess?: boolean;
+    static fromDto(dto: CompanySecuredDto): CompanySecuredEntity;
+}

package/dist/data/CompanyPerformance.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 CompanyPerformanceEntity {
+    appointmentMade: number;
+    appointmentCancel: number;
+    appointmentFinish: number;
+    static fromCompanyPerformanceDto(dto: CompanyPerformanceDto): CompanyPerformanceEntity;
+}
+export declare class CompanyPerformanceDto {
+    appointmentMade: number;
+    appointmentCancel: number;
+    appointmentFinish: number;
+}

package/dist/data/Connector.d.ts

@@ -0,0 +1,26 @@
+export declare class ConnectorEntity {
+    name: string;
+    service: string;
+    provider: string;
+    status: 'available' | 'installed' | 'disabled';
+    type: 'calendar' | 'contacts' | 'visio' | 'unknown';
+    description: string;
+    title: string;
+    logoUrl: string;
+    initializeLink: string;
+    revokeLink: string;
+    constructor();
+    static fromDto(dto: ConnectorDto): ConnectorEntity;
+}
+export declare class ConnectorDto {
+    name?: string;
+    service?: string;
+    provider?: string;
+    status?: 'available' | 'installed' | 'disabled';
+    type?: 'calendar' | 'contacts' | 'visio';
+    description?: string;
+    title?: string;
+    logoUrl?: string;
+    initializeLink?: string;
+    revokeLink?: string;
+}

package/dist/data/Consent.d.ts

@@ -0,0 +1,4 @@
+export declare class ConsentEntity {
+    text: string;
+    constructor(text: string);
+}

package/dist/data/Contact.d.ts

@@ -0,0 +1,202 @@
+/**
+ * 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 { ConsentEntity } from "./Consent";
+import { AddressDto, AddressEntity } from "./Address";
+import { PromoteFieldKey } from "./CommonEnum";
+export declare class ContactEntity {
+    id?: string;
+    owner?: {
+        userName: string;
+    };
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    emailAddresses?: ContactEmailAddressEntity[];
+    phone?: string;
+    phoneNumbers?: ContactPhoneNumberEntity[];
+    picture?: ImageEntity;
+    externalId?: string;
+    marketingConsent?: ConsentEntity;
+    marketingOptins?: {
+        email?: {
+            enabled: boolean;
+        };
+    };
+    title?: string;
+    gender?: string;
+    tags?: ContactTagEntity[];
+    companyName?: string;
+    jobTitle?: string;
+    address?: AddressEntity;
+    birthDate?: string;
+    language?: string;
+    languageSpoken?: string;
+    languageUnderstood?: string[];
+    additionalFieldsTitle?: string;
+    additionalFields?: ContactAdditionalFieldEntity[];
+    creationDate?: Date;
+    timeZone?: string;
+    fax?: string;
+    notification?: string;
+    reminder?: string;
+    description?: string;
+    isExternal?: boolean;
+    static fromContactDto(dto: ContactDto, isExternal?: boolean): ContactEntity;
+    static toContactDto(entity: ContactEntity): ContactDto;
+}
+export declare class ContactAdvancedSearchEntity {
+    firstName?: string;
+    lastName?: string;
+    externalId?: string;
+    email?: string;
+    phone?: string;
+    zipcode?: string;
+    emailMarketing?: boolean;
+    blocked?: boolean;
+    tags?: ContactTagEntity[];
+    activityDateMin?: string;
+    activityDateMax?: string;
+    showAnonymized?: boolean;
+    constructor();
+    get countFilter(): number;
+    static toDto(entity: ContactAdvancedSearchEntity): ContactAdvancedSearchDto;
+}
+export declare class ContactAdvancedSearchDto {
+    firstName?: string;
+    lastName?: string;
+    externalId?: string;
+    email?: string;
+    phone?: string;
+    zipcode?: string;
+    emailMarketing?: boolean;
+    blocked?: boolean;
+    tags?: ContactTagEntity[];
+    activityDateMin?: string;
+    activityDateMax?: string;
+    showAnonymized?: boolean;
+}
+export declare class ContactPhoneNumberEntity {
+    number: string;
+    primary?: boolean;
+    mobile?: boolean;
+    static fromContactPhoneNumberDto(dto: ContactPhoneNumberDto): ContactPhoneNumberEntity;
+    static toContactPhoneNumberDto(entity: ContactPhoneNumberEntity): ContactPhoneNumberDto;
+}
+export declare class ContactEmailAddressEntity {
+    email: string;
+    primary?: boolean;
+    static fromContactEmailAddressDto(dto: ContactEmailAddressDto): ContactEmailAddressEntity;
+    static toContactEmailAddressDto(entity: ContactEmailAddressEntity): ContactEmailAddressDto;
+}
+export declare class ContactTagEntity {
+    id?: string;
+    tag: string;
+    color?: string;
+    textColor?: string;
+    static fromContactTagDto(dto: ContactTagDto): ContactTagEntity;
+    static toContactTagDto(entity: ContactTagEntity): ContactTagDto;
+}
+export declare class AdditionalFieldsEntity {
+    title?: string;
+    fields?: ContactAdditionalFieldEntity[];
+    static fromAdditionalFieldsDto(dto: AdditionalFieldsDto): AdditionalFieldsEntity;
+    static toAdditionalFieldsDto(entity: AdditionalFieldsEntity): AdditionalFieldsDto;
+}
+export declare class ContactAdditionalFieldEntity {
+    id: string;
+    name: string;
+    mandatory: boolean;
+    value?: string;
+    static fromContactAdditionalFieldDto(dto: ContactAdditionalFieldDto): ContactAdditionalFieldEntity;
+    static toContactAdditionalFieldDto(entity: ContactAdditionalFieldEntity): ContactAdditionalFieldDto;
+}
+export declare class ContactDto {
+    id?: string;
+    owner?: {
+        userName: string;
+    };
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    emailAddresses?: ContactEmailAddressDto[];
+    phone?: string;
+    phoneNumbers?: ContactPhoneNumberDto[];
+    picture?: ImageEntity;
+    externalId?: string;
+    marketingConsent?: ConsentEntity;
+    marketingOptins?: {
+        email?: {
+            enabled: boolean;
+        };
+    };
+    title?: string;
+    gender?: string;
+    tags?: ContactTagDto[];
+    companyName?: string;
+    jobTitle?: string;
+    address?: AddressDto;
+    birthDate?: string;
+    language?: string;
+    languageSpoken?: string;
+    languageUnderstood?: string[];
+    additionalFieldsTitle?: string;
+    additionalFields?: ContactAdditionalFieldDto[];
+    creationDate?: string;
+    timeZone?: string;
+    fax?: string;
+    notificationType?: string;
+    reminderType?: string;
+    description?: string;
+}
+export declare class ContactPhoneNumberDto {
+    number: string;
+    primary?: boolean;
+    mobile?: boolean;
+}
+export declare class ContactEmailAddressDto {
+    email: string;
+    primary?: boolean;
+}
+export declare class ContactTagDto {
+    id?: string;
+    tag: string;
+    color?: string;
+}
+export declare class ContactAdditionalFieldDto {
+    id: string;
+    name: string;
+    mandatory: boolean;
+    value?: string;
+}
+export declare class AdditionalFieldsDto {
+    title?: string;
+    fields?: ContactAdditionalFieldDto[];
+}
+export declare class PromoteFieldEntity {
+    id: string;
+    fieldKey: PromoteFieldKey;
+    account: string;
+    index: number;
+    static fromPromoteFieldDto(dto: PromoteFieldDto): PromoteFieldEntity;
+    static toPromoteFieldDto(entity: PromoteFieldEntity): PromoteFieldDto;
+}
+export declare class PromoteFieldDto {
+    id: string;
+    fieldKey: PromoteFieldKey;
+    account: string;
+    index: number;
+}

package/dist/data/CustomStatus.d.ts

@@ -0,0 +1,16 @@
+export declare class CustomStatusEntity {
+    id?: string;
+    name?: string;
+    description?: string;
+    color?: string;
+    native?: boolean;
+    static fromCustomStatusDto(dto: CustomStatusDto): CustomStatusEntity;
+    static toCustomStatusDto(entity: CustomStatusEntity): CustomStatusDto;
+}
+export declare class CustomStatusDto {
+    id?: string;
+    name?: string;
+    description?: string;
+    color?: string;
+    native?: boolean;
+}

package/dist/data/Employee.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 { UserEntity } from "./User";
+import { StaffEntity } from "./Staff";
+export declare class EmployeeEntity {
+    user?: {
+        user?: UserEntity;
+        staffs?: StaffEntity[];
+    };
+    staff?: StaffEntity;
+    private constructor();
+    static fromUserEntity(user: UserEntity, staffs?: StaffEntity[]): EmployeeEntity;
+    static fromStaffEntity(staff: StaffEntity): EmployeeEntity;
+}