@agendize/js-agendize-api 1.35.0 → 1.37.0

package/dist/data/Error.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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 ApiErrors {
+    UNKOWN = 0,
+    INTERNAL_ERROR = 1,
+    NOT_AUTHORIZED = 2,
+    INVALID_PARAMETER = 3,
+    UNKNOWN_ENTITY = 4,
+    INSUFFICIENT_RIGHT = 5,
+    NOT_IMPLEMENTED = 6,
+    CREDENTIAL_ERROR = 100,
+    USER_ACCOUNT_LOCKED = 101,
+    PASSWORD_POLICY_ERROR = 102,
+    STAFF_NOT_AVAILABLE = 1000,
+    MAX_APPOINTMENT_DAILY = 1001,
+    MAX_APPOINTMENT_WEEKLY = 1002,
+    APPOINTMENT_PERIOD_RULE = 1003,
+    RESOURCE_NOT_AVAILABLE = 1004,
+    DATE_NOT_AVAILABLE = 1005,
+    USER_BLOCKED = 1006,
+    ACCOUNT_NOT_FOUND = 2000,
+    ACCOUNT_DISABLED = 3003,
+    CONFERENCE_SESSION_FULL = 4000,
+    ERROR_NO_STAFF = 2300,
+    ERROR_CLIENT_LOCKED = 2303,
+    CONFERENCE_INVALID_CONFERENCE = 26001,
+    CONFERENCE_INVALID_SESSION = 26002,
+    CONFERENCE_INVALID_NUMBER_OF_SEATS = 26003,
+    CONFERENCE_INVALID_REGISTRATION = 26004,
+    CONFERENCE_INVALID_SESSION_PAST = 26005,
+    CONFERENCE_CLOSED_SESSION = 26006,
+    CONFERENCE_SESSION_CANCELLED = 26009
+}
+export declare function getErrorCode(apiName: string, dto: ErrorDto): ApiErrors;
+export declare class ErrorDto {
+    errorCode?: number;
+    reason: string;
+    code: number;
+    message: string;
+    'az-code'?: number;
+    error?: string;
+    errors?: ErrorDto[];
+}
+export declare class NotFoundError extends ErrorDto {
+    constructor(context?: string);
+}
+export declare class AgendizeError {
+    errorCode: ApiErrors;
+    e: any;
+    constructor(errorCode: ApiErrors, e?: any);
+}
+export declare function getApiErrorValueFromName(value: string): string;

package/dist/data/Event.d.ts

@@ -0,0 +1,222 @@
+import { ConsentEntity } from "./Consent";
+import { FormItemDto, FormItemEntity } from "./Form";
+import { CustomStatusDto, CustomStatusEntity } from "./CustomStatus";
+import { BodyEntityInterface, EntityType, PublicBodyEntity, SecuredBodyEntity, SecuredEntity } from "@/data/Common";
+import { LocationType, ServicePublicDto, ServicePublicEntity } from "@/data/Service";
+import { StaffPublicDto, StaffPublicEntity } from "@/data/Staff";
+import { CompanyPublicDto, CompanyPublicEntity } from "@/data/Company";
+import { ContactDto, ContactEntity } from "@/data/Contact";
+import { ActivityDto, AppointmentActivityEntity } from "@/data/Activity";
+import { AttendeeSecuredDto, AttendeeSecuredEntity } from "@/data/Attendee";
+export declare enum EventType {
+    PRO = "normal",
+    PERSO = "personal",
+    EXTERNAL = "external",
+    ICS = "ics"
+}
+export declare enum EventStatus {
+    PENDING = "pending",
+    DECLINED = "declined",
+    ACCEPTED = "accepted",
+    IN_PROGRESS = "inProgress",
+    NO_SHOW = "noShow",
+    COMPLETED = "completed",
+    CANCELLED = "cancelled",
+    PERSONAL = "personal",
+    PERSONAL_CANCELLED = "personal_cancelled",
+    EXTERNAL = "external",
+    UNDEFINED = "undefined",
+    CUSTOM = "custom",
+    PENDING_PAYMENT = "pendingPayment"
+}
+export type EventEntity<Type = EntityType> = (Type extends SecuredEntity ? EventSecuredEntity : EventPublicEntity) & BodyEntityInterface;
+export declare class EventPublicEntity extends PublicBodyEntity {
+    id?: string;
+    company: CompanyPublicEntity;
+    services: ServicePublicEntity[];
+    staffs: StaffPublicEntity[];
+    start: Date;
+    end: Date;
+    status: string;
+    customStatus?: CustomStatusEntity;
+    notes?: string;
+    contact: ContactEntity;
+    location: LocationType[];
+    locationCustom?: string;
+    form?: FormItemEntity[];
+    histories?: AppointmentActivityEntity[];
+    source?: string;
+    sourceType?: 'manual' | 'widget' | 'external' | 'manualPhone' | 'api' | 'backofficeWidget' | 'mobile' | 'facebook' | 'internalWidget' | '' | undefined;
+    onlineMeeting?: {
+        link: string;
+    };
+    cancellable?: boolean;
+    static fromDto(dto: EventPublicDto): EventPublicEntity;
+}
+export declare class EventPublicDto {
+    id: string;
+    company: CompanyPublicDto;
+    services: ServicePublicDto[];
+    staffs: StaffPublicDto[];
+    start: {
+        dateTime: string;
+        timeZone: string;
+    };
+    end: {
+        dateTime: string;
+        timeZone: string;
+    };
+    status: string;
+    customStatus?: CustomStatusEntity;
+    notes?: string;
+    client: ContactDto;
+    location: LocationType[];
+    customLocation?: string;
+    cancellable?: boolean;
+    locationLink?: string;
+    form?: FormItemDto[];
+    histories?: ActivityDto[];
+    source?: string;
+    sourceType?: 'manual' | 'widget' | 'external' | 'manualPhone' | 'api' | 'backofficeWidget' | 'mobile' | 'facebook' | 'internalWidget' | '' | undefined;
+    onlineMeeting?: {
+        link: string;
+    };
+}
+export declare class EventSecuredEntity extends SecuredBodyEntity {
+    id?: string;
+    owner?: {
+        id: string;
+        userName: string;
+    };
+    company?: {
+        id: string;
+        name?: string;
+        encryptedId?: string;
+        color?: string;
+    };
+    service?: {
+        id: string;
+        name?: string;
+        color?: string;
+        preparationDuration?: number;
+        bufferDuration?: number;
+        capacity?: number;
+    };
+    staff?: {
+        id: string;
+        firstName?: string;
+        lastName?: string;
+        phone?: string;
+        email?: string;
+        externalId?: string;
+        userId?: string;
+    };
+    client?: {
+        id: string;
+        firstName?: string;
+        lastName?: string;
+        email?: string;
+        phone?: string;
+        externalId?: string;
+    };
+    start: Date;
+    end: Date;
+    status?: string;
+    type: string;
+    source: string;
+    price?: number;
+    paid?: boolean;
+    notes?: string;
+    summary?: string;
+    form?: FormItemEntity[];
+    metaEvent?: boolean;
+    metaEventId?: string;
+    onlineMeeting?: {
+        provider: string;
+        videoLink: string;
+    };
+    parameters?: any;
+    events?: EventSecuredEntity[];
+    privacyConsent?: ConsentEntity;
+    marketingConsent?: ConsentEntity;
+    location: LocationType;
+    locationCustom?: string;
+    preparationDuration?: number;
+    bufferDuration?: number;
+    customStatus?: CustomStatusEntity;
+    securityKey?: string;
+    attendees: AttendeeSecuredEntity[];
+    constructor();
+    static fromDto(dto: EventSecuredDto, type?: EventType | string): EventSecuredEntity;
+    static toDto(entity: EventSecuredEntity, timeZone?: string): EventSecuredDto;
+}
+export declare class EventSecuredDto {
+    id?: string;
+    owner?: {
+        id: string;
+        userName: string;
+    };
+    company?: {
+        id: string;
+        name?: string;
+        color?: string;
+    };
+    service?: {
+        id: string;
+        name?: string;
+        color?: string;
+        preparationDuration?: number;
+        bufferDuration?: number;
+        capacity?: number;
+    };
+    staff?: {
+        id: string;
+        firstName?: string;
+        lastName?: string;
+        phone?: string;
+        email?: string;
+        externalId?: string;
+        userId?: string;
+    };
+    client?: {
+        id: string;
+        firstName?: string;
+        lastName?: string;
+        email?: string;
+        phone?: string;
+        externalId?: string;
+    };
+    start: {
+        dateTime: string;
+        timeZone?: string;
+    };
+    end: {
+        dateTime: string;
+        timeZone?: string;
+    };
+    status?: string;
+    type: string;
+    source: string;
+    paid?: boolean;
+    price?: number;
+    notes?: string;
+    summary?: string;
+    form?: FormItemDto[];
+    'meta-event'?: boolean;
+    metaEventId?: string;
+    onlineMeeting?: {
+        provider: string;
+        videoLink: string;
+    };
+    parameters?: any;
+    events?: EventSecuredDto[];
+    privacyConsent?: ConsentEntity;
+    marketingConsent?: ConsentEntity;
+    location: LocationType;
+    locationCustom?: string;
+    preparationDuration?: number;
+    bufferDuration?: number;
+    customStatus?: CustomStatusDto;
+    securityKey?: string;
+    attendees?: AttendeeSecuredDto[];
+}

package/dist/data/EventSearch.d.ts

@@ -0,0 +1,232 @@
+/**
+ * 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 { CustomStatusDto } from "./CustomStatus";
+import { EventSecuredEntity } from "./Event";
+import { LocationType } from "@/data/Service";
+export declare enum EventStatusId {
+    PENDING = "1",
+    DECLINED = "11",
+    ACCEPTED = "2",
+    IN_PROGRESS = "9",
+    NO_SHOW = "4",
+    COMPLETED = "10",
+    CANCELLED = "5",
+    CLIENT_CANCELLED = "12",
+    CUSTOM = "-1",
+    PENDING_PAYMENT = "14"
+}
+export declare class EventSearchEntity {
+    id?: string;
+    company?: EventSearchCompanyEntity;
+    service?: EventSearchServiceEntity;
+    staff?: EventSearchStaffEntity;
+    contact?: EventSearchContactEntity;
+    location: EventSearchLocationEntity;
+    start: Date;
+    end: Date;
+    status?: EventSearchStatusEntity;
+    conflict?: boolean;
+    conflicts?: EventSearchConflictEntity[];
+    securityKey?: string;
+    static fromEventDto(dto: EventSearchDto): EventSearchEntity;
+    static toEventEntity(searchEntity: EventSearchEntity): EventSecuredEntity;
+}
+export declare class EventSearchCompanyEntity {
+    id: string;
+    name: string;
+    timeZone?: string;
+    static fromDto(dto: EventSearchCompanyDto): EventSearchCompanyEntity;
+}
+export declare class EventSearchServiceEntity {
+    id: string;
+    name: string;
+    static fromDto(dto: EventSearchServiceDto): EventSearchServiceEntity;
+}
+export declare class EventSearchStaffEntity {
+    id: string;
+    firstName?: string;
+    lastName?: string;
+    externalId?: string;
+    userId?: string;
+    static fromDto(dto: EventSearchStaffDto): EventSearchStaffEntity;
+}
+export declare class EventSearchContactEntity {
+    id: string;
+    title?: string;
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    phone?: string;
+    reference?: string;
+    static fromDto(dto: EventSearchContactDto): EventSearchContactEntity;
+}
+export declare class EventSearchLocationEntity {
+    type: LocationType;
+    static fromDto(dto: EventSearchLocationDto): EventSearchLocationEntity;
+}
+export declare class EventSearchStatusEntity {
+    id: string;
+    standard: boolean;
+    label?: string;
+    color?: string;
+    static fromDto(dto: EventSearchStatusDto): EventSearchStatusEntity;
+}
+export declare class EventSearchConflictEntity {
+    event?: string;
+    company?: string;
+    reason: EventSearchConflictReason;
+    source: EventSearchConflictSource;
+    static fromDto(dto: EventSearchConflictDto): EventSearchConflictEntity;
+}
+export declare enum EventSearchConflictReason {
+    STAFF = "STAFF",
+    SERVICE = "SERVICE",
+    STAFF_TIME = "STAFF_TIME",
+    SERVICE_TIME = "SERVICE_TIME",
+    SERVICE_SKILL = "SERVICE_SKILL",
+    STAFF_RESCHEDULE = "STAFF_RESCHEDULE",
+    STAFF_VACATION = "STAFF_VACATION",
+    UNKNOWN = "UNKNOWN"
+}
+export declare enum EventSearchConflictSource {
+    SERVICE_NOT_AVAILABLE = "SERVICE_NOT_AVAILABLE",
+    STAFF_NOT_AVAILABLE = "STAFF_NOT_AVAILABLE",
+    UNKNOWN = "UNKNOWN"
+}
+export declare class EventSearchPageEntity {
+    items: EventSearchEntity[];
+    totalItems: number;
+    nextSyncToken?: string;
+    nextPageToken?: string;
+    static fromDto(dto: EventSearchPageDto): EventSearchPageEntity;
+}
+export interface EventSearchOption {
+    page?: number;
+    pageToken?: string;
+    orderBy?: string;
+    maxResults?: number;
+}
+export declare class EventSearchBodyEntity {
+    basicSearch?: string;
+    timeZone?: string;
+    start?: Date;
+    end?: Date;
+    companies: EventSearchBodyCompanyEntity[];
+    status?: string[];
+    conflict?: boolean;
+    cancelledOrDeclined?: boolean;
+    static fromDto(dto: EventSearchBodyDto): EventSearchBodyEntity;
+    static toDto(entity: EventSearchBodyEntity, timeZone: string): EventSearchBodyDto;
+}
+export declare class EventSearchBodyCompanyEntity {
+    companyId: string;
+    staffIds?: string[];
+    staffGroupIds?: string[];
+    serviceIds?: string[];
+    serviceGroupIds?: string[];
+    static toDto(entity: EventSearchBodyCompanyEntity): EventSearchBodyCompanyDto;
+    static fromDto(dto: EventSearchBodyCompanyDto): EventSearchBodyCompanyEntity;
+}
+export interface EventSearchConflictDto {
+    event?: string;
+    company?: string;
+    reason: string;
+    source: string;
+}
+export interface EventSearchStatusDto {
+    id: string;
+    standard: boolean;
+    label?: string;
+    color?: string;
+}
+export interface EventSearchBodyDto {
+    basicSearch?: string;
+    timeZone?: string;
+    start?: {
+        dateTime: string;
+        timeZone?: string;
+    };
+    end?: {
+        dateTime: string;
+        timeZone?: string;
+    };
+    companies: EventSearchBodyCompanyDto[];
+    status?: string[];
+    conflict?: boolean;
+    cancelledOrDeclined?: boolean;
+}
+export interface EventSearchBodyCompanyDto {
+    companyId: string;
+    staffIds?: string[];
+    staffGroupIds?: string[];
+    serviceIds?: string[];
+    serviceGroupIds?: string[];
+}
+export interface EventSearchPageDto {
+    items: EventSearchDto[];
+    totalItems: number;
+    nextSyncToken?: string;
+    nextPageToken?: string;
+}
+export declare class EventSearchCompanyDto {
+    id: string;
+    name: string;
+    timeZone?: string;
+}
+export declare class EventSearchServiceDto {
+    id: string;
+    name: string;
+}
+export declare class EventSearchStaffDto {
+    id: string;
+    firstName?: string;
+    lastName?: string;
+    externalId?: string;
+    userId?: string;
+}
+export declare class EventSearchContactDto {
+    id: string;
+    title?: string;
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    phone?: string;
+    reference?: string;
+}
+export declare class EventSearchLocationDto {
+    type: LocationType;
+}
+export declare class EventSearchDto {
+    id?: string;
+    company?: EventSearchCompanyDto;
+    service?: EventSearchServiceDto;
+    staff?: EventSearchStaffDto;
+    contact?: EventSearchContactDto;
+    location: EventSearchLocationDto;
+    startDate: {
+        dateTime: string;
+        timeZone?: string;
+    };
+    endDate: {
+        dateTime: string;
+        timeZone?: string;
+    };
+    status?: EventSearchStatusDto;
+    customStatus?: CustomStatusDto;
+    conflict?: boolean;
+    conflicts?: EventSearchConflictDto[];
+    securityKey?: string;
+}

package/dist/data/EventUpdate.d.ts

@@ -0,0 +1,9 @@
+export declare class EventUpdateEntity {
+    id: string;
+    status?: string;
+    static toEventUpdateDto(entity: EventUpdateEntity): EventUpdateDto;
+}
+export declare class EventUpdateDto {
+    id: string;
+    status?: string;
+}