@agendize/js-agendize-api 1.36.0 → 1.37.0

package/dist/data/Activity.d.ts

@@ -0,0 +1,529 @@
+import { ConferenceLocationEntity, ConferenceLocationSecuredDto } from "@/data/conference/ConferenceLocation";
+export declare abstract class ActivityEntity {
+    id: string;
+    date: Date;
+    user?: {
+        id?: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    };
+    marketingConsent?: string;
+    type: 'appointment' | 'note' | 'formResult' | 'consent' | 'email' | 'emailNotification' | 'textMessageNotification' | 'conflict' | 'conferenceRegistration' | 'marketingEmail' | 'marketingTextMessage';
+    event?: 'created' | 'updated' | 'deleted';
+    updatedAttributes?: string[];
+    protected constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, marketingConsent?: string);
+    static fromActivityDto(dto: ActivityDto): ActivityEntity | undefined;
+}
+export declare enum AppointmentActivityType {
+    DELETE = "appointment-delete",
+    CREATION = "appointment-creation",
+    FORM_UPDATE = "appointment-form-update",
+    LOCATION_UPDATE = "appointment-location-update",
+    NOTE_UPDATE = "appointment-note-update",
+    RESOURCE_UPDATE = "appointment-resource-update",
+    SERVICE_UPDATE = "appointment-service-update",
+    STAFF_UPDATE = "appointment-staff-update",
+    DATES_UPDATE = "appointment-dates-update",
+    STATUS_UPDATE = "appointment-status-update",
+    END_UPDATE = "appointment-end-update",
+    START_UPDATE = "appointment-start-update",
+    CLIENT_UPDATE = "appointment-client-update"
+}
+export declare enum AppointmentActivitySourceType {
+    MANUAL = "manual",
+    WIDGET = "widget",
+    INTERNAL_WIDGET = "internalWidget",
+    EXTERNAL = "external",
+    MANUAL_PHONE = "manualPhone",
+    API = "api",
+    BACKOFFICE_WIDGET = "backofficeWidget",
+    API_MOBILE = "mobile",
+    FACEBOOK = "facebook",
+    USER = "user"
+}
+export declare class AppointmentActivityEntity extends ActivityEntity {
+    start?: Date;
+    end?: Date;
+    service?: {
+        id: string;
+        name: string;
+    };
+    resource?: {
+        id: string;
+        name: string;
+    };
+    staff?: {
+        id: string;
+        firstName?: string;
+        lastName?: string;
+    };
+    company?: {
+        id: string;
+        name: string;
+    };
+    client?: {
+        id?: string;
+        firstName?: string;
+        lastName?: string;
+        emailAddress?: string;
+    };
+    appointmentId: string;
+    location?: string;
+    notes?: string;
+    status?: string;
+    activityType?: AppointmentActivityType;
+    sourceType?: AppointmentActivitySourceType;
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, dto: AppointmentActivityDto, marketingConsent?: string);
+    static fromAppointmentDto(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, dto: AppointmentActivityDto, event?: 'created' | 'updated' | 'deleted', updatedAttributes?: AttributesUpdateType[], marketingConsent?: string): ActivityEntity | undefined;
+}
+export declare class AppointmentUpdateDatesActivityEntity extends AppointmentActivityEntity {
+    previousStart?: Date;
+    previousEnd?: Date;
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, dto: AppointmentActivityDto, marketingConsent?: string);
+}
+export declare class AppointmentUpdateStartActivityEntity extends AppointmentActivityEntity {
+    previousStart?: Date;
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, dto: AppointmentActivityDto, marketingConsent?: string);
+}
+export declare class AppointmentUpdateEndActivityEntity extends AppointmentActivityEntity {
+    previousEnd?: Date;
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, dto: AppointmentActivityDto, marketingConsent?: string);
+}
+export declare class AppointmentUpdateStatusActivityEntity extends AppointmentActivityEntity {
+    previousStatus?: string;
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, dto: AppointmentActivityDto, marketingConsent?: string);
+}
+export declare class AppointmentUpdateStaffActivityEntity extends AppointmentActivityEntity {
+    previousStaff?: {
+        id: string;
+        firstName?: string;
+        lastName?: string;
+    };
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, dto: AppointmentActivityDto, marketingConsent?: string);
+}
+export declare class AppointmentUpdateClientActivityEntity extends AppointmentActivityEntity {
+    previousClient?: {
+        id: string;
+        firstName?: string;
+        lastName?: string;
+        emailAddress?: string;
+    };
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, dto: AppointmentActivityDto, marketingConsent?: string);
+}
+export declare class AppointmentUpdateServiceActivityEntity extends AppointmentActivityEntity {
+    previousService?: {
+        id: string;
+        name: string;
+    };
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, dto: AppointmentActivityDto, marketingConsent?: string);
+}
+export declare class AppointmentUpdateResourceActivityEntity extends AppointmentActivityEntity {
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, dto: AppointmentActivityDto, marketingConsent?: string);
+}
+export declare class AppointmentUpdateNoteActivityEntity extends AppointmentActivityEntity {
+    previousNotes?: string;
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, dto: AppointmentActivityDto, marketingConsent?: string);
+}
+export declare class AppointmentUpdateLocationActivityEntity extends AppointmentActivityEntity {
+    previousLocation?: string;
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, dto: AppointmentActivityDto, marketingConsent?: string);
+}
+export declare class AppointmentUpdateFormActivityEntity extends AppointmentActivityEntity {
+    formValues?: {};
+    previousFormValues?: {};
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, dto: AppointmentActivityDto, marketingConsent?: string);
+}
+export declare class AppointmentCreationActivityEntity extends AppointmentActivityEntity {
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, dto: AppointmentActivityDto, marketingConsent?: string);
+}
+export declare class AppointmentDeletionActivityEntity extends AppointmentActivityEntity {
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, dto: AppointmentActivityDto, marketingConsent?: string);
+}
+export declare class NoteActivityEntity extends ActivityEntity {
+    body: string;
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, body: string);
+}
+export declare class FormResultActivityEntity extends ActivityEntity {
+    formId?: string;
+    formName?: string;
+    formResultId?: string;
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, formId?: string, formName?: string, formResultId?: string);
+}
+export declare class ConsentActivityEntity extends ActivityEntity {
+    note: string;
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, note: string);
+}
+export declare class Email extends ActivityEntity {
+    subject: string;
+    body: string;
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, subject: string, body: string);
+}
+export declare class EmailNotificationActivityEntity extends ActivityEntity {
+    subject: string;
+    body: string;
+    emailId: string;
+    selfLink: string;
+    companyId: string;
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, subject: string, body: string, emailId: string, selfLink: string, companyId: string);
+}
+export declare class MarketingEmailNotificationActivityEntity extends ActivityEntity {
+    subject: string;
+    body: string;
+    emailId: string;
+    selfLink?: string;
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, subject: string, body: string, emailId: string, selfLink?: string);
+}
+export declare class MarketingTextMessageNotificationActivityEntity extends ActivityEntity {
+    body: string;
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, body: string);
+}
+export declare class TextMessageNotificationActivityEntity extends ActivityEntity {
+    body: string;
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, body: string);
+}
+export declare class ConflictActivityEntity extends ActivityEntity {
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined);
+}
+export declare class ConferenceRegistrationActivityEntity extends ActivityEntity {
+    selfLink?: string;
+    numberOfSeats?: number;
+    conference?: {
+        id?: string;
+        title?: string;
+        capacity?: number;
+        waitingListEnabled?: boolean;
+    };
+    session?: {
+        id?: string;
+        start?: Date;
+        end?: Date;
+    };
+    sourceType?: "undefined" | "manuel" | "widget" | "external" | "api" | "backofficeWidget" | "mobile" | "sessionCancelled" | "conferenceCancelled";
+    source?: string;
+    status?: "accepted" | "cancelled" | "waitingList";
+    location?: ConferenceLocationEntity;
+    company?: {
+        id?: string;
+        name?: string;
+    };
+    constructor(id: string, date: Date, user: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    } | undefined, conferenceRegistration: ConferenceRegistrationActivityDto);
+}
+declare class AppointmentActivityDto {
+    id: string;
+    start?: {
+        dateTime: string;
+        timeZone: string;
+    };
+    end?: {
+        dateTime: string;
+        timeZone: string;
+    };
+    service?: {
+        id: string;
+        name: string;
+    };
+    resource?: {
+        id: string;
+        name: string;
+    };
+    staff?: {
+        id: string;
+        firstName?: string;
+        lastName?: string;
+    };
+    company?: {
+        id: string;
+        name: string;
+    };
+    client?: {
+        id?: string;
+        firstName?: string;
+        lastName?: string;
+        emailAddress?: string;
+    };
+    formValues?: {};
+    notes?: string;
+    location?: string;
+    status: string;
+    sourceType?: AppointmentActivitySourceType;
+    changeType?: AppointmentChangeTypes.START | AppointmentChangeTypes.END | AppointmentChangeTypes.STAFF | AppointmentChangeTypes.LOCATION | AppointmentChangeTypes.SERVICE | AppointmentChangeTypes.RESOURCE | AppointmentChangeTypes.FORM | AppointmentChangeTypes.STATUS | AppointmentChangeTypes.NOTES | AppointmentChangeTypes.CLIENT;
+    previousStart?: {
+        dateTime: string;
+        timeZone: string;
+    };
+    previousEnd?: {
+        dateTime: string;
+        timeZone: string;
+    };
+    previousService?: {
+        id: string;
+        name: string;
+    };
+    previousStaff?: {
+        id: string;
+        firstName?: string;
+        lastName?: string;
+    };
+    previousLocation?: string;
+    previousNotes?: string;
+    previousStatus?: string;
+    previousFormValues?: {};
+    previousClient?: {
+        id: string;
+        firstName?: string;
+        lastName?: string;
+        emailAddress?: string;
+    };
+}
+declare class ConferenceRegistrationActivityDto {
+    selfLink?: string;
+    id: string;
+    numberOfSeats?: number;
+    conference?: {
+        id?: string;
+        title?: string;
+        capacity?: number;
+        waitingListEnabled?: boolean;
+    };
+    session?: {
+        id?: string;
+        start?: {
+            dateTime: string;
+            timeZone: string;
+        };
+        end?: {
+            dateTime: string;
+            timeZone: string;
+        };
+    };
+    sourceType?: "undefined" | "manuel" | "widget" | "external" | "api" | "backofficeWidget" | "mobile" | "sessionCancelled" | "conferenceCancelled";
+    source?: string;
+    status?: "accepted" | "cancelled" | "waitingList";
+    location?: ConferenceLocationSecuredDto;
+    company?: {
+        id?: string;
+        name?: string;
+    };
+}
+export type AttributesUpdateType = 'start' | 'end' | 'staff' | 'location' | 'service' | 'resource' | 'form' | 'status' | 'notes' | string;
+export declare enum AppointmentChangeTypes {
+    START = "start",
+    END = "end",
+    STAFF = "staff",
+    LOCATION = "location",
+    SERVICE = "service",
+    RESOURCE = "resource",
+    FORM = "form",
+    STATUS = "status",
+    NOTES = "notes",
+    CLIENT = "client"
+}
+export declare class ActivityDto {
+    id: string;
+    type?: 'appointment' | 'note' | 'formResult' | 'consent' | 'email' | 'emailNotification' | 'textMessageNotification' | 'conflict' | 'conferenceRegistration' | 'marketingEmail' | 'marketingTextMessage';
+    event?: 'created' | 'updated' | 'deleted';
+    updatedAttributes?: AttributesUpdateType[];
+    date?: {
+        dateTime: string;
+        timeZone?: string;
+    };
+    user?: {
+        id: string;
+        userName?: string;
+        emailAddress?: string;
+        firstName?: string;
+        lastName?: string;
+    };
+    note?: {
+        id: string;
+        body: string;
+    };
+    appointment?: AppointmentActivityDto;
+    formResult?: {
+        id: string;
+        form: {
+            id: string;
+            name: string;
+        };
+    };
+    marketingConsent?: {
+        text: string;
+    };
+    emailNotification?: {
+        subject: string;
+        body: string;
+        selfLink: string;
+        id: string;
+        companyId: string;
+    };
+    email?: {
+        subject: string;
+        body: string;
+        selfLink: string;
+        id: string;
+        companyId: string;
+    };
+    textMessage?: {
+        body: string;
+    };
+    conferenceRegistration?: ConferenceRegistrationActivityDto;
+}
+export {};

package/dist/data/Address.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 AddressEntity {
+    street?: string;
+    otherStreet?: string;
+    zipCode?: string;
+    city?: string;
+    country?: string;
+    state?: string;
+    latitude?: number;
+    longitude?: number;
+    static fromAddressDto(dto: AddressDto): AddressEntity;
+    static toAddressDto(entity: AddressEntity): AddressDto;
+}
+export declare class AddressDto {
+    street?: string;
+    otherStreet?: string;
+    zipCode?: string;
+    zipcode?: string;
+    city?: string;
+    country?: string;
+    state?: string;
+}
+export declare class GeoLocationEntity {
+    latitude?: number;
+    longitude?: number;
+    static fromDto(dto: GeoLocationDto): GeoLocationEntity;
+    static toDto(entity: GeoLocationEntity): GeoLocationDto;
+}
+export declare class GeoLocationDto {
+    lat?: number;
+    lng?: number;
+}

package/dist/data/Attendee.d.ts

@@ -0,0 +1,59 @@
+import { BodyEntityInterface, EntityType, PublicBodyEntity, SecuredBodyEntity, SecuredEntity } from "@/data/Common";
+export declare enum AttendeeType {
+    CLIENT = "client"
+}
+export declare enum AttendeeStatus {
+    TENTATIVE = "tentative"
+}
+export type EventEntity<Type = EntityType> = (Type extends SecuredEntity ? AttendeeSecuredEntity : AttendeePublicEntity) & BodyEntityInterface;
+export declare class AttendeePublicEntity extends PublicBodyEntity {
+    id?: string;
+    client?: {
+        id: string;
+        firstName?: string;
+        lastName?: string;
+        email?: string;
+        externalId?: string;
+    };
+    status?: AttendeeStatus;
+    type: AttendeeType;
+    static fromDto(dto: AttendeePublicEntity): AttendeePublicEntity;
+}
+export declare class AttendeePublicDto {
+    id?: string;
+    client?: {
+        id: string;
+        firstName?: string;
+        lastName?: string;
+        email?: string;
+        externalId?: string;
+    };
+    status?: string;
+    type: string;
+}
+export declare class AttendeeSecuredEntity extends SecuredBodyEntity {
+    id?: string;
+    client?: {
+        id: string;
+        firstName?: string;
+        lastName?: string;
+        email?: string;
+        externalId?: string;
+    };
+    status?: AttendeeStatus;
+    type: AttendeeType;
+    static fromDto(dto: AttendeeSecuredDto): AttendeeSecuredEntity;
+    static toDto(entity: AttendeeSecuredEntity, timeZone?: string): AttendeeSecuredDto;
+}
+export declare class AttendeeSecuredDto {
+    id?: string;
+    client?: {
+        id: string;
+        firstName?: string;
+        lastName?: string;
+        email?: string;
+        externalId?: string;
+    };
+    status?: AttendeeStatus;
+    type: AttendeeType;
+}

package/dist/data/Batch.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Copyright 2023 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 BatchableApi {
+    'CONFERENCE_SPEAKER_API' = 0,
+    'EVENT' = 1
+}
+export declare class BatchRequest<T> {
+    api: BatchableApi;
+    method: 'LIST' | 'POST' | 'GET' | 'DELETE' | 'PUT' | 'PATCH';
+    body?: T;
+    queryParams?: any;
+    constructor(api: BatchableApi, method: 'LIST' | 'POST' | 'GET' | 'DELETE' | 'PUT' | 'PATCH', queryParam?: any, body?: T);
+    toBatchRequestDto(): BatchRequestDto<T>;
+}
+export declare class BatchRequestDto<T> {
+    path: string;
+    method: 'POST' | 'GET' | 'DELETE' | 'PUT' | 'PATCH';
+    body?: T;
+    name?: string;
+    headers?: string;
+}
+export declare class BatchResponseDto<T> {
+    path: string;
+    method: 'POST' | 'GET' | 'DELETE' | 'PUT' | 'PATCH';
+    body?: T;
+    status: number;
+    name?: string;
+}

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;
+}