@wix/auto_sdk_crm_notes 1.0.0

package/build/cjs/index.typings.d.ts

@@ -0,0 +1,662 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+/** A note contains textual information associated with a contact. */
+interface Note {
+    /**
+     * Note ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the note is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the note.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the note was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the note was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Contact ID associated with the note.
+     * @format GUID
+     * @immutable
+     */
+    contactId?: string | null;
+    /**
+     * Note text.
+     * @maxLength 2048
+     */
+    text?: string | null;
+    /**
+     * Note type for organizing notes by their purpose.
+     *
+     * Default: `NOT_SET`
+     */
+    type?: NoteTypeWithLiterals;
+    /**
+     * Information about who created the note.
+     * @readonly
+     */
+    source?: NoteSource;
+}
+declare enum NoteType {
+    /** Unknown note type. */
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    /** Note doesn't have a specific classification. */
+    NOT_SET = "NOT_SET",
+    /** Note is a summary of a meeting related to the contact. */
+    MEETING_SUMMARY = "MEETING_SUMMARY",
+    /** Note is a summary of a call related to the contact. */
+    CALL_SUMMARY = "CALL_SUMMARY"
+}
+/** @enumType */
+type NoteTypeWithLiterals = NoteType | 'UNKNOWN_TYPE' | 'NOT_SET' | 'MEETING_SUMMARY' | 'CALL_SUMMARY';
+interface NoteSource {
+    /**
+     * Note creator.
+     * @readonly
+     */
+    sourceType?: SourceTypeWithLiterals;
+    /**
+     * App ID, if the note was created by an app.
+     * @format GUID
+     * @readonly
+     */
+    appId?: string | null;
+    /**
+     * User ID, if the note was created by a Wix user.
+     * @format GUID
+     * @readonly
+     */
+    userId?: string | null;
+}
+/** Note creator. */
+declare enum SourceType {
+    UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
+    APP = "APP",
+    USER = "USER"
+}
+/** @enumType */
+type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'APP' | 'USER';
+interface CreateNoteRequest {
+    /** Note to create. */
+    note: Note;
+}
+interface CreateNoteResponse {
+    /** Created note. */
+    note?: Note;
+}
+interface GetNoteRequest {
+    /**
+     * Note ID.
+     * @format GUID
+     */
+    noteId: string;
+}
+interface GetNoteResponse {
+    /** Retrieved note. */
+    note?: Note;
+}
+interface UpdateNoteRequest {
+    /** Note to update. */
+    note: Note;
+}
+interface UpdateNoteResponse {
+    /** Updated note. */
+    note?: Note;
+}
+interface DeleteNoteRequest {
+    /**
+     * Note ID.
+     * @format GUID
+     */
+    noteId: string;
+}
+interface DeleteNoteResponse {
+}
+interface QueryNotesRequest {
+    /**
+     * WQL query object.
+     *
+     * For more information, see [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language).
+     */
+    query?: CursorQuery;
+    /**
+     * Contact ID to retrieve notes for. Required when not using cursor pagination.
+     * @format GUID
+     */
+    contactId?: string | null;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Number of items to load.
+     * @max 1000
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface QueryNotesResponse {
+    /** Retrieved notes. */
+    notes?: Note[];
+    /** Paging information. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+/** @docsIgnore */
+type QueryNotesApplicationErrors = {
+    code?: 'MISSING_CONTACT_ID';
+    description?: string;
+    data?: Record<string, any>;
+};
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+interface NoteCreatedEnvelope {
+    entity: Note;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a note is created.
+ * @permissionScope Read Members and Contacts - all read permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
+ * @permissionScope Manage Notes
+ * @permissionScopeId SCOPE.DC-CRM.MANAGE-NOTES
+ * @permissionScope Manage Members and Contacts - all permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
+ * @permissionScope Read Notes
+ * @permissionScopeId SCOPE.DC-CRM.READ-NOTES
+ * @permissionId CRM_NOTES.NOTE_READ
+ * @webhook
+ * @eventType wix.crm.notes.v2.note_created
+ * @serviceIdentifier wix.crm.notes.v2.Notes
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onNoteCreated(handler: (event: NoteCreatedEnvelope) => void | Promise<void>): void;
+interface NoteDeletedEnvelope {
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a note is deleted.
+ * @permissionScope Read Members and Contacts - all read permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
+ * @permissionScope Manage Notes
+ * @permissionScopeId SCOPE.DC-CRM.MANAGE-NOTES
+ * @permissionScope Manage Members and Contacts - all permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
+ * @permissionScope Read Notes
+ * @permissionScopeId SCOPE.DC-CRM.READ-NOTES
+ * @permissionId CRM_NOTES.NOTE_READ
+ * @webhook
+ * @eventType wix.crm.notes.v2.note_deleted
+ * @serviceIdentifier wix.crm.notes.v2.Notes
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onNoteDeleted(handler: (event: NoteDeletedEnvelope) => void | Promise<void>): void;
+interface NoteUpdatedEnvelope {
+    entity: Note;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a note is updated.
+ * @permissionScope Read Members and Contacts - all read permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
+ * @permissionScope Manage Notes
+ * @permissionScopeId SCOPE.DC-CRM.MANAGE-NOTES
+ * @permissionScope Manage Members and Contacts - all permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
+ * @permissionScope Read Notes
+ * @permissionScopeId SCOPE.DC-CRM.READ-NOTES
+ * @permissionId CRM_NOTES.NOTE_READ
+ * @webhook
+ * @eventType wix.crm.notes.v2.note_updated
+ * @serviceIdentifier wix.crm.notes.v2.Notes
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onNoteUpdated(handler: (event: NoteUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Creates a new note associated with a specific contact.
+ * @param note - Note to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField note
+ * @requiredField note.contactId
+ * @permissionId CRM_NOTES.NOTE_CREATE
+ * @applicableIdentity APP
+ * @returns Created note.
+ * @fqn wix.crm.notes.v2.Notes.CreateNote
+ */
+declare function createNote(note: NonNullablePaths<Note, `contactId`, 2>): Promise<NonNullablePaths<Note, `type` | `source.sourceType`, 3>>;
+/**
+ * Retrieves a note by ID.
+ * @param noteId - Note ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField noteId
+ * @permissionId CRM_NOTES.NOTE_READ
+ * @applicableIdentity APP
+ * @returns Retrieved note.
+ * @fqn wix.crm.notes.v2.Notes.GetNote
+ */
+declare function getNote(noteId: string): Promise<NonNullablePaths<Note, `type` | `source.sourceType`, 3>>;
+/**
+ * Updates a note.
+ *
+ * This method supports partial updates.
+ * To prevent conflicting changes, the current revision must be passed when updating the note.
+ * @param _id - Note ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField note
+ * @requiredField note.revision
+ * @permissionId CRM_NOTES.NOTE_UPDATE
+ * @applicableIdentity APP
+ * @returns Updated note.
+ * @fqn wix.crm.notes.v2.Notes.UpdateNote
+ */
+declare function updateNote(_id: string, note: NonNullablePaths<UpdateNote, `revision`, 2>): Promise<NonNullablePaths<Note, `type` | `source.sourceType`, 3>>;
+interface UpdateNote {
+    /**
+     * Note ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the note is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the note.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the note was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the note was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Contact ID associated with the note.
+     * @format GUID
+     * @immutable
+     */
+    contactId?: string | null;
+    /**
+     * Note text.
+     * @maxLength 2048
+     */
+    text?: string | null;
+    /**
+     * Note type for organizing notes by their purpose.
+     *
+     * Default: `NOT_SET`
+     */
+    type?: NoteTypeWithLiterals;
+    /**
+     * Information about who created the note.
+     * @readonly
+     */
+    source?: NoteSource;
+}
+/**
+ * Deletes a note.
+ * @param noteId - Note ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField noteId
+ * @permissionId CRM_NOTES.NOTE_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.crm.notes.v2.Notes.DeleteNote
+ */
+declare function deleteNote(noteId: string): Promise<void>;
+/**
+ * Retrieves a list of up to 1,000 notes given the provided filtering, paging, and sorting.
+ *
+ * <blockquote class="important">
+ *
+ * __Important:__
+ * When making the first query request without a cursor, the `contactId` field is required. For subsequent requests using cursor pagination, `contactId` becomes optional as the cursor contains the context from the previous query.
+ *
+ * </blockquote>
+ *
+ * By default, notes are sorted by created date in descending order.
+ *
+ * Refer to [*Notes: Supported Filters and Sorting*](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/notes/notes-v2/supported-filters-and-sorting) for a complete list of supported filters and sorting options.
+ *
+ * To learn about working with *Query* endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging).
+ * @public
+ * @documentationMaturity preview
+ * @permissionId CRM_NOTES.NOTE_READ
+ * @applicableIdentity APP
+ * @fqn wix.crm.notes.v2.Notes.QueryNotes
+ */
+declare function queryNotes(options?: QueryNotesOptions): NotesQueryBuilder;
+interface QueryNotesOptions {
+    /**
+     * Contact ID to retrieve notes for. Required when not using cursor pagination.
+     * @format GUID
+     */
+    contactId?: string | null | undefined;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface NotesQueryResult extends QueryCursorResult {
+    items: Note[];
+    query: NotesQueryBuilder;
+    next: () => Promise<NotesQueryResult>;
+    prev: () => Promise<NotesQueryResult>;
+}
+interface NotesQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'contactId' | 'type', value: any) => NotesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_createdDate' | '_updatedDate' | 'type', value: any) => NotesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => NotesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => NotesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_createdDate' | '_updatedDate', value: any) => NotesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => NotesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_createdDate' | '_updatedDate', value: any[]) => NotesQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'contactId' | 'type', value: any) => NotesQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_createdDate' | '_updatedDate', value: boolean) => NotesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate'>) => NotesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_createdDate' | '_updatedDate'>) => NotesQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => NotesQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => NotesQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<NotesQueryResult>;
+}
+
+export { type ActionEvent, type BaseEventMetadata, type CreateNoteRequest, type CreateNoteResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteNoteRequest, type DeleteNoteResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type GetNoteRequest, type GetNoteResponse, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type Note, type NoteCreatedEnvelope, type NoteDeletedEnvelope, type NoteSource, NoteType, type NoteTypeWithLiterals, type NoteUpdatedEnvelope, type NotesQueryBuilder, type NotesQueryResult, type QueryNotesApplicationErrors, type QueryNotesOptions, type QueryNotesRequest, type QueryNotesResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, SourceType, type SourceTypeWithLiterals, type UpdateNote, type UpdateNoteRequest, type UpdateNoteResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createNote, deleteNote, getNote, onNoteCreated, onNoteDeleted, onNoteUpdated, queryNotes, updateNote };