@wix/auto_sdk_crm_notes 1.0.0

package/build/cjs/meta.d.ts

@@ -0,0 +1,236 @@
+import { CreateNoteRequest as CreateNoteRequest$1, CreateNoteResponse as CreateNoteResponse$1, GetNoteRequest as GetNoteRequest$1, GetNoteResponse as GetNoteResponse$1, UpdateNoteRequest as UpdateNoteRequest$1, UpdateNoteResponse as UpdateNoteResponse$1, DeleteNoteRequest as DeleteNoteRequest$1, DeleteNoteResponse as DeleteNoteResponse$1, QueryNotesRequest as QueryNotesRequest$1, QueryNotesResponse as QueryNotesResponse$1 } from './index.typings.js';
+import '@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;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createNote(): __PublicMethodMetaInfo<'POST', {}, CreateNoteRequest$1, CreateNoteRequest, CreateNoteResponse$1, CreateNoteResponse>;
+declare function getNote(): __PublicMethodMetaInfo<'GET', {
+    noteId: string;
+}, GetNoteRequest$1, GetNoteRequest, GetNoteResponse$1, GetNoteResponse>;
+declare function updateNote(): __PublicMethodMetaInfo<'PATCH', {
+    noteId: string;
+}, UpdateNoteRequest$1, UpdateNoteRequest, UpdateNoteResponse$1, UpdateNoteResponse>;
+declare function deleteNote(): __PublicMethodMetaInfo<'DELETE', {
+    noteId: string;
+}, DeleteNoteRequest$1, DeleteNoteRequest, DeleteNoteResponse$1, DeleteNoteResponse>;
+declare function queryNotes(): __PublicMethodMetaInfo<'POST', {}, QueryNotesRequest$1, QueryNotesRequest, QueryNotesResponse$1, QueryNotesResponse>;
+
+export { type __PublicMethodMetaInfo, createNote, deleteNote, getNote, queryNotes, updateNote };

package/build/cjs/meta.js

@@ -0,0 +1,301 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// meta.ts
+var meta_exports = {};
+__export(meta_exports, {
+  createNote: () => createNote2,
+  deleteNote: () => deleteNote2,
+  getNote: () => getNote2,
+  queryNotes: () => queryNotes2,
+  updateNote: () => updateNote2
+});
+module.exports = __toCommonJS(meta_exports);
+
+// src/crm-notes-v2-note-notes.http.ts
+var import_rest_modules = require("@wix/sdk-runtime/rest-modules");
+var import_timestamp = require("@wix/sdk-runtime/transformations/timestamp");
+var import_timestamp2 = require("@wix/sdk-runtime/transformations/timestamp");
+var import_field_mask = require("@wix/sdk-runtime/transformations/field-mask");
+var import_transform_paths = require("@wix/sdk-runtime/transformations/transform-paths");
+var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
+function resolveWixCrmNotesV2NotesUrl(opts) {
+  const domainToMappings = {
+    "manage._base_domain_": [
+      {
+        srcPath: "/_api/notes-app/v2/notes",
+        destPath: "/v2/notes"
+      }
+    ],
+    "www.wixapis.com": [
+      {
+        srcPath: "/crm/notes/v2/notes",
+        destPath: "/v2/notes"
+      }
+    ],
+    _: [
+      {
+        srcPath: "/_api/notes-app/v2/notes",
+        destPath: "/v2/notes"
+      }
+    ],
+    "*.dev.wix-code.com": [
+      {
+        srcPath: "/_api/notes-app/v2/notes",
+        destPath: "/v2/notes"
+      }
+    ]
+  };
+  return (0, import_rest_modules2.resolveUrl)(Object.assign(opts, { domainToMappings }));
+}
+var PACKAGE_NAME = "@wix/auto_sdk_crm_notes";
+function createNote(payload) {
+  function __createNote({ host }) {
+    const serializedData = (0, import_transform_paths.transformPaths)(payload, [
+      {
+        transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
+        paths: [{ path: "note.createdDate" }, { path: "note.updatedDate" }]
+      }
+    ]);
+    const metadata = {
+      entityFqdn: "wix.crm.notes.v2.note",
+      method: "POST",
+      methodFqn: "wix.crm.notes.v2.Notes.CreateNote",
+      packageName: PACKAGE_NAME,
+      url: resolveWixCrmNotesV2NotesUrl({
+        protoPath: "/v2/notes",
+        data: serializedData,
+        host
+      }),
+      data: serializedData,
+      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
+        {
+          transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
+          paths: [{ path: "note.createdDate" }, { path: "note.updatedDate" }]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __createNote;
+}
+function getNote(payload) {
+  function __getNote({ host }) {
+    const metadata = {
+      entityFqdn: "wix.crm.notes.v2.note",
+      method: "GET",
+      methodFqn: "wix.crm.notes.v2.Notes.GetNote",
+      packageName: PACKAGE_NAME,
+      url: resolveWixCrmNotesV2NotesUrl({
+        protoPath: "/v2/notes/{noteId}",
+        data: payload,
+        host
+      }),
+      params: (0, import_rest_modules.toURLSearchParams)(payload),
+      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
+        {
+          transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
+          paths: [{ path: "note.createdDate" }, { path: "note.updatedDate" }]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __getNote;
+}
+function updateNote(payload) {
+  function __updateNote({ host }) {
+    const serializedData = (0, import_transform_paths.transformPaths)(payload, [
+      {
+        transformFn: import_field_mask.transformSDKFieldMaskToRESTFieldMask,
+        paths: [{ path: "mask" }]
+      },
+      {
+        transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
+        paths: [{ path: "note.createdDate" }, { path: "note.updatedDate" }]
+      }
+    ]);
+    const metadata = {
+      entityFqdn: "wix.crm.notes.v2.note",
+      method: "PATCH",
+      methodFqn: "wix.crm.notes.v2.Notes.UpdateNote",
+      packageName: PACKAGE_NAME,
+      url: resolveWixCrmNotesV2NotesUrl({
+        protoPath: "/v2/notes/{note.id}",
+        data: serializedData,
+        host
+      }),
+      data: serializedData,
+      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
+        {
+          transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
+          paths: [{ path: "note.createdDate" }, { path: "note.updatedDate" }]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __updateNote;
+}
+function deleteNote(payload) {
+  function __deleteNote({ host }) {
+    const metadata = {
+      entityFqdn: "wix.crm.notes.v2.note",
+      method: "DELETE",
+      methodFqn: "wix.crm.notes.v2.Notes.DeleteNote",
+      packageName: PACKAGE_NAME,
+      url: resolveWixCrmNotesV2NotesUrl({
+        protoPath: "/v2/notes/{noteId}",
+        data: payload,
+        host
+      }),
+      params: (0, import_rest_modules.toURLSearchParams)(payload)
+    };
+    return metadata;
+  }
+  return __deleteNote;
+}
+function queryNotes(payload) {
+  function __queryNotes({ host }) {
+    const metadata = {
+      entityFqdn: "wix.crm.notes.v2.note",
+      method: "POST",
+      methodFqn: "wix.crm.notes.v2.Notes.QueryNotes",
+      packageName: PACKAGE_NAME,
+      url: resolveWixCrmNotesV2NotesUrl({
+        protoPath: "/v2/notes/query",
+        data: payload,
+        host
+      }),
+      data: payload,
+      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
+        {
+          transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "notes.createdDate" },
+            { path: "notes.updatedDate" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __queryNotes;
+}
+
+// src/crm-notes-v2-note-notes.meta.ts
+function createNote2() {
+  const payload = {};
+  const getRequestOptions = createNote(payload);
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "POST",
+    path: "/v2/notes",
+    pathParams: {},
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+function getNote2() {
+  const payload = { noteId: ":noteId" };
+  const getRequestOptions = getNote(payload);
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "GET",
+    path: "/v2/notes/{noteId}",
+    pathParams: { noteId: "noteId" },
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+function updateNote2() {
+  const payload = { note: { id: ":noteId" } };
+  const getRequestOptions = updateNote(payload);
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "PATCH",
+    path: "/v2/notes/{note.id}",
+    pathParams: { noteId: "noteId" },
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+function deleteNote2() {
+  const payload = { noteId: ":noteId" };
+  const getRequestOptions = deleteNote(payload);
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "DELETE",
+    path: "/v2/notes/{noteId}",
+    pathParams: { noteId: "noteId" },
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+function queryNotes2() {
+  const payload = {};
+  const getRequestOptions = queryNotes(payload);
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "POST",
+    path: "/v2/notes/query",
+    pathParams: {},
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createNote,
+  deleteNote,
+  getNote,
+  queryNotes,
+  updateNote
+});
+//# sourceMappingURL=meta.js.map

package/build/cjs/meta.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../meta.ts","../../src/crm-notes-v2-note-notes.http.ts","../../src/crm-notes-v2-note-notes.meta.ts"],"sourcesContent":["export * from './src/crm-notes-v2-note-notes.meta.js';\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformSDKTimestampToRESTTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformSDKFieldMaskToRESTFieldMask } from '@wix/sdk-runtime/transformations/field-mask';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixCrmNotesV2NotesUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'manage._base_domain_': [\n      {\n        srcPath: '/_api/notes-app/v2/notes',\n        destPath: '/v2/notes',\n      },\n    ],\n    'www.wixapis.com': [\n      {\n        srcPath: '/crm/notes/v2/notes',\n        destPath: '/v2/notes',\n      },\n    ],\n    _: [\n      {\n        srcPath: '/_api/notes-app/v2/notes',\n        destPath: '/v2/notes',\n      },\n    ],\n    '*.dev.wix-code.com': [\n      {\n        srcPath: '/_api/notes-app/v2/notes',\n        destPath: '/v2/notes',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_crm_notes';\n\n/** Creates a new note associated with a specific contact. */\nexport function createNote(payload: object): RequestOptionsFactory<any> {\n  function __createNote({ host }: any) {\n    const serializedData = transformPaths(payload, [\n      {\n        transformFn: transformSDKTimestampToRESTTimestamp,\n        paths: [{ path: 'note.createdDate' }, { path: 'note.updatedDate' }],\n      },\n    ]);\n    const metadata = {\n      entityFqdn: 'wix.crm.notes.v2.note',\n      method: 'POST' as any,\n      methodFqn: 'wix.crm.notes.v2.Notes.CreateNote',\n      packageName: PACKAGE_NAME,\n      url: resolveWixCrmNotesV2NotesUrl({\n        protoPath: '/v2/notes',\n        data: serializedData,\n        host,\n      }),\n      data: serializedData,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'note.createdDate' }, { path: 'note.updatedDate' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __createNote;\n}\n\n/** Retrieves a note by ID. */\nexport function getNote(payload: object): RequestOptionsFactory<any> {\n  function __getNote({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.crm.notes.v2.note',\n      method: 'GET' as any,\n      methodFqn: 'wix.crm.notes.v2.Notes.GetNote',\n      packageName: PACKAGE_NAME,\n      url: resolveWixCrmNotesV2NotesUrl({\n        protoPath: '/v2/notes/{noteId}',\n        data: payload,\n        host,\n      }),\n      params: toURLSearchParams(payload),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'note.createdDate' }, { path: 'note.updatedDate' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __getNote;\n}\n\n/**\n * Updates a note.\n *\n * This method supports partial updates.\n * To prevent conflicting changes, the current revision must be passed when updating the note.\n */\nexport function updateNote(payload: object): RequestOptionsFactory<any> {\n  function __updateNote({ host }: any) {\n    const serializedData = transformPaths(payload, [\n      {\n        transformFn: transformSDKFieldMaskToRESTFieldMask,\n        paths: [{ path: 'mask' }],\n      },\n      {\n        transformFn: transformSDKTimestampToRESTTimestamp,\n        paths: [{ path: 'note.createdDate' }, { path: 'note.updatedDate' }],\n      },\n    ]);\n    const metadata = {\n      entityFqdn: 'wix.crm.notes.v2.note',\n      method: 'PATCH' as any,\n      methodFqn: 'wix.crm.notes.v2.Notes.UpdateNote',\n      packageName: PACKAGE_NAME,\n      url: resolveWixCrmNotesV2NotesUrl({\n        protoPath: '/v2/notes/{note.id}',\n        data: serializedData,\n        host,\n      }),\n      data: serializedData,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'note.createdDate' }, { path: 'note.updatedDate' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __updateNote;\n}\n\n/** Deletes a note. */\nexport function deleteNote(payload: object): RequestOptionsFactory<any> {\n  function __deleteNote({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.crm.notes.v2.note',\n      method: 'DELETE' as any,\n      methodFqn: 'wix.crm.notes.v2.Notes.DeleteNote',\n      packageName: PACKAGE_NAME,\n      url: resolveWixCrmNotesV2NotesUrl({\n        protoPath: '/v2/notes/{noteId}',\n        data: payload,\n        host,\n      }),\n      params: toURLSearchParams(payload),\n    };\n\n    return metadata;\n  }\n\n  return __deleteNote;\n}\n\n/**\n * Retrieves a list of up to 1,000 notes given the provided filtering, paging, and sorting.\n *\n * <blockquote class=\"important\">\n *\n * __Important:__\n * 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.\n *\n * </blockquote>\n *\n * By default, notes are sorted by created date in descending order.\n *\n * 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.\n *\n * 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).\n */\nexport function queryNotes(payload: object): RequestOptionsFactory<any> {\n  function __queryNotes({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.crm.notes.v2.note',\n      method: 'POST' as any,\n      methodFqn: 'wix.crm.notes.v2.Notes.QueryNotes',\n      packageName: PACKAGE_NAME,\n      url: resolveWixCrmNotesV2NotesUrl({\n        protoPath: '/v2/notes/query',\n        data: payload,\n        host,\n      }),\n      data: payload,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [\n              { path: 'notes.createdDate' },\n              { path: 'notes.updatedDate' },\n            ],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __queryNotes;\n}\n","import * as ambassadorWixCrmNotesV2Note from './crm-notes-v2-note-notes.http.js';\nimport * as ambassadorWixCrmNotesV2NoteTypes from './crm-notes-v2-note-notes.types.js';\nimport * as ambassadorWixCrmNotesV2NoteUniversalTypes from './crm-notes-v2-note-notes.universal.js';\n\nexport type __PublicMethodMetaInfo<\n  K = string,\n  M = unknown,\n  T = unknown,\n  S = unknown,\n  Q = unknown,\n  R = unknown\n> = {\n  getUrl: (context: any) => string;\n  httpMethod: K;\n  path: string;\n  pathParams: M;\n  __requestType: T;\n  __originalRequestType: S;\n  __responseType: Q;\n  __originalResponseType: R;\n};\n\nexport function createNote(): __PublicMethodMetaInfo<\n  'POST',\n  {},\n  ambassadorWixCrmNotesV2NoteUniversalTypes.CreateNoteRequest,\n  ambassadorWixCrmNotesV2NoteTypes.CreateNoteRequest,\n  ambassadorWixCrmNotesV2NoteUniversalTypes.CreateNoteResponse,\n  ambassadorWixCrmNotesV2NoteTypes.CreateNoteResponse\n> {\n  const payload = {} as any;\n\n  const getRequestOptions = ambassadorWixCrmNotesV2Note.createNote(payload);\n\n  const getUrl = (context: any): string => {\n    const { url } = getRequestOptions(context);\n    return url!;\n  };\n\n  return {\n    getUrl,\n    httpMethod: 'POST',\n    path: '/v2/notes',\n    pathParams: {},\n    __requestType: null as any,\n    __originalRequestType: null as any,\n    __responseType: null as any,\n    __originalResponseType: null as any,\n  };\n}\n\nexport function getNote(): __PublicMethodMetaInfo<\n  'GET',\n  { noteId: string },\n  ambassadorWixCrmNotesV2NoteUniversalTypes.GetNoteRequest,\n  ambassadorWixCrmNotesV2NoteTypes.GetNoteRequest,\n  ambassadorWixCrmNotesV2NoteUniversalTypes.GetNoteResponse,\n  ambassadorWixCrmNotesV2NoteTypes.GetNoteResponse\n> {\n  const payload = { noteId: ':noteId' } as any;\n\n  const getRequestOptions = ambassadorWixCrmNotesV2Note.getNote(payload);\n\n  const getUrl = (context: any): string => {\n    const { url } = getRequestOptions(context);\n    return url!;\n  };\n\n  return {\n    getUrl,\n    httpMethod: 'GET',\n    path: '/v2/notes/{noteId}',\n    pathParams: { noteId: 'noteId' },\n    __requestType: null as any,\n    __originalRequestType: null as any,\n    __responseType: null as any,\n    __originalResponseType: null as any,\n  };\n}\n\nexport function updateNote(): __PublicMethodMetaInfo<\n  'PATCH',\n  { noteId: string },\n  ambassadorWixCrmNotesV2NoteUniversalTypes.UpdateNoteRequest,\n  ambassadorWixCrmNotesV2NoteTypes.UpdateNoteRequest,\n  ambassadorWixCrmNotesV2NoteUniversalTypes.UpdateNoteResponse,\n  ambassadorWixCrmNotesV2NoteTypes.UpdateNoteResponse\n> {\n  const payload = { note: { id: ':noteId' } } as any;\n\n  const getRequestOptions = ambassadorWixCrmNotesV2Note.updateNote(payload);\n\n  const getUrl = (context: any): string => {\n    const { url } = getRequestOptions(context);\n    return url!;\n  };\n\n  return {\n    getUrl,\n    httpMethod: 'PATCH',\n    path: '/v2/notes/{note.id}',\n    pathParams: { noteId: 'noteId' },\n    __requestType: null as any,\n    __originalRequestType: null as any,\n    __responseType: null as any,\n    __originalResponseType: null as any,\n  };\n}\n\nexport function deleteNote(): __PublicMethodMetaInfo<\n  'DELETE',\n  { noteId: string },\n  ambassadorWixCrmNotesV2NoteUniversalTypes.DeleteNoteRequest,\n  ambassadorWixCrmNotesV2NoteTypes.DeleteNoteRequest,\n  ambassadorWixCrmNotesV2NoteUniversalTypes.DeleteNoteResponse,\n  ambassadorWixCrmNotesV2NoteTypes.DeleteNoteResponse\n> {\n  const payload = { noteId: ':noteId' } as any;\n\n  const getRequestOptions = ambassadorWixCrmNotesV2Note.deleteNote(payload);\n\n  const getUrl = (context: any): string => {\n    const { url } = getRequestOptions(context);\n    return url!;\n  };\n\n  return {\n    getUrl,\n    httpMethod: 'DELETE',\n    path: '/v2/notes/{noteId}',\n    pathParams: { noteId: 'noteId' },\n    __requestType: null as any,\n    __originalRequestType: null as any,\n    __responseType: null as any,\n    __originalResponseType: null as any,\n  };\n}\n\nexport function queryNotes(): __PublicMethodMetaInfo<\n  'POST',\n  {},\n  ambassadorWixCrmNotesV2NoteUniversalTypes.QueryNotesRequest,\n  ambassadorWixCrmNotesV2NoteTypes.QueryNotesRequest,\n  ambassadorWixCrmNotesV2NoteUniversalTypes.QueryNotesResponse,\n  ambassadorWixCrmNotesV2NoteTypes.QueryNotesResponse\n> {\n  const payload = {} as any;\n\n  const getRequestOptions = ambassadorWixCrmNotesV2Note.queryNotes(payload);\n\n  const getUrl = (context: any): string => {\n    const { url } = getRequestOptions(context);\n    return url!;\n  };\n\n  return {\n    getUrl,\n    httpMethod: 'POST',\n    path: '/v2/notes/query',\n    pathParams: {},\n    __requestType: null as any,\n    __originalRequestType: null as any,\n    __responseType: null as any,\n    __originalResponseType: null as any,\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA,oBAAAA;AAAA,EAAA,kBAAAC;AAAA,EAAA,eAAAC;AAAA,EAAA,kBAAAC;AAAA,EAAA,kBAAAC;AAAA;AAAA;;;ACAA,0BAAkC;AAClC,uBAAqD;AACrD,IAAAC,oBAAqD;AACrD,wBAAqD;AACrD,6BAA+B;AAC/B,IAAAC,uBAA2B;AAI3B,SAAS,6BACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAGd,SAAS,WAAW,SAA6C;AACtE,WAAS,aAAa,EAAE,KAAK,GAAQ;AACnC,UAAM,qBAAiB,uCAAe,SAAS;AAAA,MAC7C;AAAA,QACE,aAAa;AAAA,QACb,OAAO,CAAC,EAAE,MAAM,mBAAmB,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAAA,MACpE;AAAA,IACF,CAAC;AACD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,KAAK,6BAA6B;AAAA,QAChC,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,mBAAmB,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAAA,QACpE;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGO,SAAS,QAAQ,SAA6C;AACnE,WAAS,UAAU,EAAE,KAAK,GAAQ;AAChC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,KAAK,6BAA6B;AAAA,QAChC,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACA,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,mBAAmB,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAAA,QACpE;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAQO,SAAS,WAAW,SAA6C;AACtE,WAAS,aAAa,EAAE,KAAK,GAAQ;AACnC,UAAM,qBAAiB,uCAAe,SAAS;AAAA,MAC7C;AAAA,QACE,aAAa;AAAA,QACb,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC;AAAA,MAC1B;AAAA,MACA;AAAA,QACE,aAAa;AAAA,QACb,OAAO,CAAC,EAAE,MAAM,mBAAmB,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAAA,MACpE;AAAA,IACF,CAAC;AACD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,KAAK,6BAA6B;AAAA,QAChC,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACA,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,mBAAmB,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAAA,QACpE;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGO,SAAS,WAAW,SAA6C;AACtE,WAAS,aAAa,EAAE,KAAK,GAAQ;AACnC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,KAAK,6BAA6B;AAAA,QAChC,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,IACnC;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAkBO,SAAS,WAAW,SAA6C;AACtE,WAAS,aAAa,EAAE,KAAK,GAAQ;AACnC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,KAAK,6BAA6B;AAAA,QAChC,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACA,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,oBAAoB;AAAA,YAC5B,EAAE,MAAM,oBAAoB;AAAA,UAC9B;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ACrMO,SAASC,cAOd;AACA,QAAM,UAAU,CAAC;AAEjB,QAAM,oBAAgD,WAAW,OAAO;AAExE,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,CAAC;AAAA,IACb,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;AAEO,SAASC,WAOd;AACA,QAAM,UAAU,EAAE,QAAQ,UAAU;AAEpC,QAAM,oBAAgD,QAAQ,OAAO;AAErE,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,EAAE,QAAQ,SAAS;AAAA,IAC/B,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;AAEO,SAASC,cAOd;AACA,QAAM,UAAU,EAAE,MAAM,EAAE,IAAI,UAAU,EAAE;AAE1C,QAAM,oBAAgD,WAAW,OAAO;AAExE,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,EAAE,QAAQ,SAAS;AAAA,IAC/B,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;AAEO,SAASC,cAOd;AACA,QAAM,UAAU,EAAE,QAAQ,UAAU;AAEpC,QAAM,oBAAgD,WAAW,OAAO;AAExE,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,EAAE,QAAQ,SAAS;AAAA,IAC/B,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;AAEO,SAASC,cAOd;AACA,QAAM,UAAU,CAAC;AAEjB,QAAM,oBAAgD,WAAW,OAAO;AAExE,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,CAAC;AAAA,IACb,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;","names":["createNote","deleteNote","getNote","queryNotes","updateNote","import_timestamp","import_rest_modules","payload","createNote","getNote","updateNote","deleteNote","queryNotes"]}

package/build/es/index.d.mts

@@ -0,0 +1,85 @@
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { Note, UpdateNote, QueryNotesOptions, NotesQueryBuilder, NoteCreatedEnvelope, NoteDeletedEnvelope, NoteUpdatedEnvelope } from './index.typings.mjs';
+export { ActionEvent, BaseEventMetadata, CreateNoteRequest, CreateNoteResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteNoteRequest, DeleteNoteResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, GetNoteRequest, GetNoteResponse, IdentificationData, IdentificationDataIdOneOf, MessageEnvelope, NoteSource, NoteType, NoteTypeWithLiterals, NotesQueryResult, QueryNotesApplicationErrors, QueryNotesRequest, QueryNotesResponse, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, SourceType, SourceTypeWithLiterals, UpdateNoteRequest, UpdateNoteResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.mjs';
+
+declare function createNote$1(httpClient: HttpClient): CreateNoteSignature;
+interface CreateNoteSignature {
+    /**
+     * Creates a new note associated with a specific contact.
+     * @param - Note to create.
+     * @returns Created note.
+     */
+    (note: NonNullablePaths<Note, `contactId`, 2>): Promise<NonNullablePaths<Note, `type` | `source.sourceType`, 3>>;
+}
+declare function getNote$1(httpClient: HttpClient): GetNoteSignature;
+interface GetNoteSignature {
+    /**
+     * Retrieves a note by ID.
+     * @param - Note ID.
+     * @returns Retrieved note.
+     */
+    (noteId: string): Promise<NonNullablePaths<Note, `type` | `source.sourceType`, 3>>;
+}
+declare function updateNote$1(httpClient: HttpClient): UpdateNoteSignature;
+interface UpdateNoteSignature {
+    /**
+     * Updates a note.
+     *
+     * This method supports partial updates.
+     * To prevent conflicting changes, the current revision must be passed when updating the note.
+     * @param - Note ID.
+     * @returns Updated note.
+     */
+    (_id: string, note: NonNullablePaths<UpdateNote, `revision`, 2>): Promise<NonNullablePaths<Note, `type` | `source.sourceType`, 3>>;
+}
+declare function deleteNote$1(httpClient: HttpClient): DeleteNoteSignature;
+interface DeleteNoteSignature {
+    /**
+     * Deletes a note.
+     * @param - Note ID.
+     */
+    (noteId: string): Promise<void>;
+}
+declare function queryNotes$1(httpClient: HttpClient): QueryNotesSignature;
+interface QueryNotesSignature {
+    /**
+     * 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).
+     */
+    (options?: QueryNotesOptions): NotesQueryBuilder;
+}
+declare const onNoteCreated$1: EventDefinition<NoteCreatedEnvelope, "wix.crm.notes.v2.note_created">;
+declare const onNoteDeleted$1: EventDefinition<NoteDeletedEnvelope, "wix.crm.notes.v2.note_deleted">;
+declare const onNoteUpdated$1: EventDefinition<NoteUpdatedEnvelope, "wix.crm.notes.v2.note_updated">;
+
+declare const createNote: MaybeContext<BuildRESTFunction<typeof createNote$1> & typeof createNote$1>;
+declare const getNote: MaybeContext<BuildRESTFunction<typeof getNote$1> & typeof getNote$1>;
+declare const updateNote: MaybeContext<BuildRESTFunction<typeof updateNote$1> & typeof updateNote$1>;
+declare const deleteNote: MaybeContext<BuildRESTFunction<typeof deleteNote$1> & typeof deleteNote$1>;
+declare const queryNotes: MaybeContext<BuildRESTFunction<typeof queryNotes$1> & typeof queryNotes$1>;
+/**
+ * Triggered when a note is created.
+ */
+declare const onNoteCreated: BuildEventDefinition<typeof onNoteCreated$1>;
+/**
+ * Triggered when a note is deleted.
+ */
+declare const onNoteDeleted: BuildEventDefinition<typeof onNoteDeleted$1>;
+/**
+ * Triggered when a note is updated.
+ */
+declare const onNoteUpdated: BuildEventDefinition<typeof onNoteUpdated$1>;
+
+export { Note, NoteCreatedEnvelope, NoteDeletedEnvelope, NoteUpdatedEnvelope, NotesQueryBuilder, QueryNotesOptions, UpdateNote, createNote, deleteNote, getNote, onNoteCreated, onNoteDeleted, onNoteUpdated, queryNotes, updateNote };